feat: protect_curly() #76

maelle · 2022-09-15T11:23:57Z

I'll be happy to learn while working on this PR 😸

maelle · 2022-09-15T11:26:42Z

R/asis-nodes.R

+   xml2::xml_find_all(body, i, ns = ns)
+}
+
+fix_curly <- function(curly) {


clearly my regex level is not on par with this file 😅

I call BS on this comment! I have never known how to work with the regmatches and gregexpr functions and I commend your ability to do this!

I can't even remember how I got it to work tbh 😹

R/asis-nodes.R

zkamvar

This looks good! It works as it says on the tin and will catch most of the cases. I'm also thinking that this could be generalised into a function that can take a generic opening pattern and closing pattern to give a specific label so that people can extend it for their own purposes.

There are a couple of cases where the solution at this stage would produce undesired results:

If attributes are split across lines, it will only find the first line:
```
[a span with attributes]{.span-with-attributes 
style='color: red;'}
```
The solution is to search one of the following siblings of the nodes for a closing brace as I've done in pegboard.
Images with alt text will be captured
```
![caption](img.png){alt='alternative text for the image'}
```
I'm not sure what the solution to this might be, but I suspect we would need to extract this alt text and put it in an attribute.

I'd be happy to try my hand at this, but I'm also happy to merge this as an "in progress" feature before I make an update to CRAN in a couple of months.

tests/testthat/test-asis-nodes.R

zkamvar · 2022-09-15T18:15:23Z

R/asis-nodes.R

+   xml2::xml_find_all(body, i, ns = ns)
+}
+
+fix_curly <- function(curly) {


I call BS on this comment! I have never known how to work with the regmatches and gregexpr functions and I commend your ability to do this!

R/asis-nodes.R

inst/extdata/basic-curly.md

R/asis-nodes.R

Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>

NAMESPACE

R/attr-nodes.R

maelle · 2022-09-16T09:52:07Z

R/attr-nodes.R

+        glue::glue("./{close_xpath}"),
+        ns
+      )
+      xml2::xml_text(not_closed) <- paste(


should I add a test for the md -> xml + protect_curly() -> md round? If so is there an example?

Yes, we should absolutely test this to make sure nothing on the xslt side suddenly changes. I think the easiest way to do this would be to use a file in a temporary directory and check the snapshot of the file:

tinkr/tests/testthat/test-class-yarn.R

Lines 53 to 63 in a577e9b

test_that("a yarn object can be written back to markdown", {

tmpdir <- withr::local_tempdir()

scarf1 <- withr::local_file(file.path(tmpdir, "yarn.md"))

scarf2 <- withr::local_file(file.path(tmpdir, "yarn.Rmd"))

y1 <- yarn$new(pathmd)

y2 <- yarn$new(pathrmd)

y1$write(scarf1)

y2$write(scarf2)

expect_snapshot_file(scarf1)

expect_snapshot_file(scarf2)

})

Also, this is a clever solution 🤩! I had not thought about smashing together text into a text node separated by a newline like this! I always made them separate text nodes, but this solution solves so many problems.

I was not sure whether it was a clever or lazy solution to be honest 😂

zkamvar

YES! Thank you for the quick changes. The only thing left is the tests!

zkamvar · 2022-09-16T16:46:52Z

R/attr-nodes.R

+        glue::glue("./{close_xpath}"),
+        ns
+      )
+      xml2::xml_text(not_closed) <- paste(


Yes, we should absolutely test this to make sure nothing on the xslt side suddenly changes. I think the easiest way to do this would be to use a file in a temporary directory and check the snapshot of the file:

tinkr/tests/testthat/test-class-yarn.R

Lines 53 to 63 in a577e9b

test_that("a yarn object can be written back to markdown", {

tmpdir <- withr::local_tempdir()

scarf1 <- withr::local_file(file.path(tmpdir, "yarn.md"))

scarf2 <- withr::local_file(file.path(tmpdir, "yarn.Rmd"))

y1 <- yarn$new(pathmd)

y2 <- yarn$new(pathrmd)

y1$write(scarf1)

y2$write(scarf2)

expect_snapshot_file(scarf1)

expect_snapshot_file(scarf2)

})

Also, this is a clever solution 🤩! I had not thought about smashing together text into a text node separated by a newline like this! I always made them separate text nodes, but this solution solves so many problems.

inst/extdata/basic-curly.md

zkamvar · 2022-09-16T16:50:24Z

tests/testthat/_snaps/attr-nodes.md

+          <text curly="true" alt="a picture of a dog">{#dog alt="a picture
+      of a dog"}</text>
+          <text/>
+          <softbreak/>
+        </paragraph>


I think this softbreak was originally between the text nodes, but I think it's benign

R/attr-nodes.R

NEWS.md

maelle · 2022-09-20T08:53:47Z

tests/testthat/_snaps/attr-nodes/yarn.md

+
+![a pretty kitten](https://placekitten.com/200/300){#kitteh alt='a picture of a kitten'}
+
+![a pretty puppy](https://placedog.net/200/300){#dog alt="a picture


missing space at the end.

maelle · 2022-09-20T08:53:54Z

tests/testthat/_snaps/attr-nodes/yarn.md

+of a dog"}
+
+
+\[a span with attributes\]{.span-with-attributes


is this escaping expected?

Unfortunately, yes: r-lib/commonmark#20

I'm going to try to implement this today. It should be a matter of backtracking and finding the square braces that were not escaped in the original document and then tagging them with 'asis' tags.

Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>

maelle · 2022-09-20T08:57:22Z

tests/testthat/_snaps/attr-nodes/yarn.Rmd

+
+\[a span with attributes\]{.span-with-attributes
+style='color: red;'}
+


why so many new lines

I believe it's because of the <softbreak>: https://github.com/ropensci/tinkr/pull/76/files/3e133e5f6e6b35befef6d8fad20df6d87f8ad549?w=0#r973214227. I guess I was wrong in calling it benign -_-

zkamvar

I'm happy to merge this for now given the current limitations and then work on fixing the unescaped square braces.

zkamvar · 2022-09-20T13:37:23Z

tests/testthat/_snaps/attr-nodes/yarn.Rmd

+
+\[a span with attributes\]{.span-with-attributes
+style='color: red;'}
+


I believe it's because of the <softbreak>: https://github.com/ropensci/tinkr/pull/76/files/3e133e5f6e6b35befef6d8fad20df6d87f8ad549?w=0#r973214227. I guess I was wrong in calling it benign -_-

zkamvar · 2022-09-20T13:42:25Z

tests/testthat/_snaps/attr-nodes/yarn.md

+of a dog"}
+
+
+\[a span with attributes\]{.span-with-attributes


Unfortunately, yes: r-lib/commonmark#20

I'm going to try to implement this today. It should be a matter of backtracking and finding the square braces that were not escaped in the original document and then tagging them with 'asis' tags.

maelle · 2022-09-20T14:09:17Z

So I'll let you finish this PR? Alternatively I can work on it again later this week. Thank you!!

zkamvar · 2022-09-20T18:53:17Z

I've opened #78 to fix the unescaped braces issue, and I think the extra space is a minor issue that we can fix before the CRAN release, so I'm going to merge this.

feat: protect_curly()

7d69a06

maelle commented Sep 15, 2022

View reviewed changes

R/asis-nodes.R Outdated Show resolved Hide resolved

g

1cf9cb8

maelle requested a review from zkamvar September 15, 2022 11:36

zkamvar reviewed Sep 15, 2022

View reviewed changes

maelle and others added 3 commits September 16, 2022 10:21

Update tests/testthat/test-asis-nodes.R

5da2373

Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>

Update inst/extdata/basic-curly.md

1700a65

Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>

Update R/asis-nodes.R

d6c686e

Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>

maelle mentioned this pull request Sep 16, 2022

Generalize protect_curly() to other opening/closing things #77

Open

maelle added 2 commits September 16, 2022 11:07

extract alt text

0ba060a

several lines

aeb1a89

maelle commented Sep 16, 2022

View reviewed changes

NAMESPACE Show resolved Hide resolved

maelle commented Sep 16, 2022

View reviewed changes

R/attr-nodes.R Show resolved Hide resolved

maelle commented Sep 16, 2022

View reviewed changes

maelle added 2 commits September 16, 2022 11:52

rm comment

fe7d6cc

1 more test

6b603af

maelle requested a review from zkamvar September 16, 2022 10:00

zkamvar reviewed Sep 16, 2022

View reviewed changes

maelle added 2 commits September 20, 2022 10:37

doc

b708ab1

add test

3e133e5

maelle commented Sep 20, 2022

View reviewed changes

Update NEWS.md

631a99d

Co-authored-by: Zhian N. Kamvar <zkamvar@gmail.com>

maelle requested a review from zkamvar September 20, 2022 08:56

maelle commented Sep 20, 2022

View reviewed changes

zkamvar approved these changes Sep 20, 2022

View reviewed changes

zkamvar merged commit b87da44 into main Sep 20, 2022

zkamvar deleted the curly branch September 20, 2022 18:53

zkamvar mentioned this pull request Sep 20, 2022

protect_curly() introduces extra newlines #79

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: protect_curly() #76

feat: protect_curly() #76

maelle commented Sep 15, 2022

maelle Sep 15, 2022

zkamvar Sep 15, 2022

maelle Sep 16, 2022

zkamvar left a comment

zkamvar Sep 15, 2022

maelle Sep 16, 2022

zkamvar Sep 16, 2022

maelle Sep 20, 2022

zkamvar left a comment

zkamvar Sep 16, 2022

zkamvar Sep 16, 2022

maelle Sep 20, 2022

maelle Sep 20, 2022

zkamvar Sep 20, 2022

maelle Sep 20, 2022

zkamvar Sep 20, 2022

zkamvar left a comment

zkamvar Sep 20, 2022

zkamvar Sep 20, 2022

maelle commented Sep 20, 2022

zkamvar commented Sep 20, 2022

	test_that("a yarn object can be written back to markdown", {
	tmpdir <- withr::local_tempdir()
	scarf1 <- withr::local_file(file.path(tmpdir, "yarn.md"))
	scarf2 <- withr::local_file(file.path(tmpdir, "yarn.Rmd"))
	y1 <- yarn$new(pathmd)
	y2 <- yarn$new(pathrmd)
	y1$write(scarf1)
	y2$write(scarf2)
	expect_snapshot_file(scarf1)
	expect_snapshot_file(scarf2)
	})


		![a pretty kitten](https://placekitten.com/200/300){#kitteh alt='a picture of a kitten'}

		![a pretty puppy](https://placedog.net/200/300){#dog alt="a picture


		\[a span with attributes\]{.span-with-attributes
		style='color: red;'}

feat: protect_curly() #76

feat: protect_curly() #76

Conversation

maelle commented Sep 15, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zkamvar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zkamvar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zkamvar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maelle commented Sep 20, 2022

zkamvar commented Sep 20, 2022