parser development, added support for multiple elements #106
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #106 +/- ##
==========================================
+ Coverage 96.67% 98.34% +1.66%
==========================================
Files 42 46 +4
Lines 1054 1327 +273
==========================================
+ Hits 1019 1305 +286
+ Misses 35 22 -13 ☔ View full report in Codecov by Sentry. |
ronaldtse
reviewed
Jun 22, 2024
| module Asciidoc | ||
| module Admonition | ||
| def admonition_type | ||
| str('NOTE') | str('TIP') | str('EDITOR') | |
There was a problem hiding this comment.
In the future we want to allow defining "profiles" or "dialects" because Metanorma uses a special set that is not supported by the base language.
There was a problem hiding this comment.
Can be cleanly overriden by subclassing and:
def admonition_type
super | str("SOMETHING") | str("SOMETHING2")
end| ).as(:positional) | ||
| end | ||
|
|
||
| def attribute_list |
There was a problem hiding this comment.
This looks arbitrarily limiting. Worse to worse please split those cases into separate methods with documentation.
| (ulist_item >> newline.maybe).repeat(1) | ||
| end | ||
|
|
||
| def definition_list(delimiter = "::") |
There was a problem hiding this comment.
Just FYI the delimiter can be any number of colon signs.
| @line_break = options.fetch(:line_break, "\n") | ||
| end | ||
|
|
||
| def to_adoc |
| adoc = "#{@first_name}" | ||
| adoc << " #{@middle_name}" if @middle_name | ||
| adoc << " #{@last_name.to_s}" | ||
| adoc << " <#{@email}>\n" if @email |
There was a problem hiding this comment.
This would make the code much more unreadable; this code returns a single line.
| to_hash.each do |key, value| | ||
| adoc << ":#{key}: #{value}\n" | ||
| end | ||
| adoc |
There was a problem hiding this comment.
Why not just:
to_hash.map do |key, value|
":#{key}: #{value}"
end.join("\n")
metanorma#15 done metanorma#16 added cross_references parser + transformer metanorma#25 done metanorma#31 missing parser code for parsing inline ellements in text metanorma#36 created parser for attribute list for further use metanorma#37 done parser for definition lists - moved some code from lib/coradoc/parser/asciidoc/content.rb info appropriate files like block.rb, list.rb, paragraph.rb, table.rb - created parser rules for comments, include + Coradoc::Element classes - created parser rules for attribute list, comments, admonition - created rspec for attribute list - created parser rules for definition list, with the goal of it replacing glossaries rules - created parser rules for bold / highlight / italic, cross_reference - created transformer rules for attribute list, comments, include, text elements, inlines - fixed some things required for round-trip, for example to_adoc method in Coradoc::Element::TextElement now outputs all the information - created parslet rule called "text_formatted", it's purpose will be to handle parsing inline elements within the text, that's still WIP - fixed some minor bugs that popped out during development of other things, for example olist_item parsing collided with sidebar block delimiter (****) - changed maybe to repeat(0) in multiple methods in Parser::Asciidoc::Section, this way instead of sometimes returning an empty string they always return an array even if it has 0 elements, this should allow to decrease number of transformer rules Co-authored-by: hmdne <[email protected]>
xyz65535
changed the title
fixed failed rake in ruby 3.4
hmdne
added a commit
to hmdne/coradoc
that referenced
this pull request
Jul 1, 2024
This corrects metanorma#106
hmdne
added a commit
to hmdne/coradoc
that referenced
this pull request
Jul 1, 2024
This corrects metanorma#106 Co-authored-by: xyz65535 <[email protected]>
ronaldtse
pushed a commit
that referenced
this pull request
Jul 1, 2024
This corrects #106 Co-authored-by: xyz65535 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Details:
lib/coradoc/parser/asciidoc/content.rbinfo appropriate files likeblock.rb,list.rb,paragraph.rb,table.rbCoradoc::Elementclassesto_adocmethod inCoradoc::Element::TextElementnow outputs all the informationtext_formatted, it's purpose will be to handle parsing inline elements within the text, that's still WIPolist_itemparsing collided with sidebar block delimiter (****)repeat(0)in multiple methods inParser::Asciidoc::Section, this way instead of sometimes returning an empty string they always return an array even if it has 0 elements, this should allow to decrease number of transformer rulesMetanorma PR checklist