psych-comments 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba5e728c57571dade021e0eddcd6518b9a3aadfb015d084136371ec5fd2b7742
-  data.tar.gz: a10c10213b15b1751d3b140a14faae0add32ec1cc4b3c17ffb08da55dd19ef6b
+  metadata.gz: 818bc094529602b346feec2de45c209a97846747142399a673984b27cf311153
+  data.tar.gz: c20108df72182dbe158485de105ab764c5e6f6e5f6bc9f0fe714d3fb8bdd717a
 SHA512:
-  metadata.gz: 4f891304d71be4e3e4649a53fb64c2a84a108e41f3d34e7420da2a14ba8660b94e762032dc939f1dba94f0e054ff0538b723d805122ce21e96dfc5d29058a4c7
-  data.tar.gz: 2971dd17da1740003f85a6fb9789369677f1ee110b803a71340ad8134c94ea0f09c30606536f38f844de8cc5bf78dcfa71d1fed1d08060ff808dcc8a97715c43
+  metadata.gz: c21f780021ef4b2f86ef7c090624c8d06f252922ce6539998edb5768b310536aa412c61a6d8e33370f58401560bbca92d8006dfc7ee3ca80d3efb398598e1370
+  data.tar.gz: 77fd723a8d83a8a8071ea87e60548efa88be32f5c88cb242c52548df56950e8c3ba0a29fccfd0e5c7b7ff29c4be8ca8d39b492f0d0cbed3f24e506fc8adfeb98

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.1.1] - 2022-08-25
+
+- Parser: distinguish comments before a bullet `- ` and after it
+- Emitter: various improvements
+
 ## [0.1.0] - 2022-08-24
 
 - Initial release

data/lib/psych/comments/emitter.rb

@@ -16,7 +16,7 @@ module Psych
         end
       end
 
-      module_function def stringify_adjust_scalar(node, indent = 0)
+      module_function def stringify_adjust_scalar(node, indent_str = 0)
         node2 = Psych::Nodes::Scalar.new(node.value, nil, nil, node.plain, node.quoted, node.style)
         if node.tag
           if node.style == Psych::Nodes::Scalar::PLAIN
@@ -30,7 +30,7 @@ module Psych
         if node.style == Psych::Nodes::Scalar::DOUBLE_QUOTED || node.style == Psych::Nodes::Scalar::SINGLE_QUOTED || node.style == Psych::Nodes::Scalar::PLAIN
           s = s.gsub(/\s*\n\s*/, " ")
         else
-          s = s.gsub(/\n/, "\n#{INDENT * indent}")
+          s = s.gsub(/\n/, "\n#{indent_str}")
         end
         s.gsub(/\n\s+$/, "\n")
       end
@@ -108,8 +108,7 @@ module Psych
           @comment_lookahead.shift
         else
           node.leading_comments.each do |comment|
-            print comment
-            newline!
+            emit_comment(comment)
           end
         end
         if has_anchor(node)
@@ -130,7 +129,7 @@ module Psych
           if node.is_a?(Psych::Nodes::Alias)
             print "*#{node.anchor}"
           else
-            print stringify_adjust_scalar(node, @indent)
+            print stringify_adjust_scalar(node, INDENT * @indent)
           end
         when Psych::Nodes::Mapping
           set_flow(flow?(node)) do
@@ -155,14 +154,12 @@ module Psych
                 emit(key)
                 print ":"
                 space!
-                if single_line(value)
-                  emit(value)
-                elsif has_bullet(value)
+                if single_line?(value) || has_bullet(value)
                   emit(value)
                 else
-                  @indent += 1
-                  emit(value)
-                  @indent -= 1
+                  indented do
+                    emit(value)
+                  end
                 end
                 newline!
               end
@@ -188,8 +185,12 @@ module Psych
                 emit_lookahead_comments(subnode) unless @flow
                 print "- "
                 @state = :pseudo_indent
-                indented do
+                if single_line?(subnode)
                   emit(subnode)
+                else
+                  indented do
+                    emit(subnode)
+                  end
                 end
                 newline!
               end
@@ -204,7 +205,7 @@ module Psych
           unless node.implicit
             newline!
             print "---"
-            newline!
+            space!
           end
           set_tagmap(node) do
             emit(node.root)
@@ -212,8 +213,8 @@ module Psych
           unless node.implicit_end
             newline!
             print "..."
-            newline!
           end
+          newline!
         when Psych::Nodes::Stream
           node.children.each do |subnode|
             emit(subnode)
@@ -221,18 +222,26 @@ module Psych
         else
           raise TypeError, node
         end
+        node.trailing_comments.each do |comment|
+          emit_comment(comment)
+        end
       end
 
       def emit_lookahead_comments(node)
+        return if node.equal?(@comment_lookahead[0])
+
         node.leading_comments.each do |comment|
-          print comment
-          newline!
+          emit_comment(comment)
         end
         @comment_lookahead.push(node)
-        case node
-        when Psych::Nodes::Mapping, Psych::Nodes::Sequence
-          emit_lookahead_comments(node.children[0]) unless flow?(node)
+      end
+
+      def emit_comment(comment)
+        unless /\A#[^\r\n]*\z/.match?(comment)
+          raise ArgumentError, "Invalid comment: #{comment.inspect}"
         end
+        print comment
+        newline!
       end
 
       def indented(&block)
@@ -253,12 +262,20 @@ module Psych
         end
       end
 
+      def single_line?(node)
+        flow?(node) && node.leading_comments.empty? && node.trailing_comments.empty?
+      end
+
       def flow?(node)
         case node
+        when Psych::Nodes::Scalar, Psych::Nodes::Alias
+          true
         when Psych::Nodes::Mapping
           @flow || node.style == Psych::Nodes::Mapping::FLOW || node.children.empty?
         when Psych::Nodes::Sequence
           @flow || node.style == Psych::Nodes::Sequence::FLOW || node.children.empty?
+        else
+          false
         end
       end
 

data/lib/psych/comments/parsing.rb

@@ -4,6 +4,7 @@ module Psych
       def initialize(text)
         @lines = text.lines.to_a
         @last = [0, 0]
+        @bullet_owner = nil
       end
 
       def sublines(sl, sc, el, ec)
@@ -25,7 +26,20 @@ module Psych
       def read_comments(line, column)
         s = sublines(*@last, line, column)
         @last = [line, column]
-        s.scan(/#.*?$/)
+        comments = []
+        s.scan(/-|#.*?$/) do |token|
+          case token
+          when "-"
+            if @bullet_owner
+              @bullet_owner.leading_comments.push(*comments)
+              comments = []
+            end
+          else
+            comments << token
+          end
+        end
+        @bullet_owner = nil
+        comments
       end
 
       def visit(node)
@@ -35,8 +49,11 @@ module Psych
           @last = [node.end_line, node.end_column]
         when Psych::Nodes::Sequence, Psych::Nodes::Mapping
           has_delim = /[\[{]/.match?(char_at(node.start_line, node.start_column))
+          has_bullet = node.is_a?(Psych::Nodes::Sequence) && !has_delim
+          # Special-case on `- #foo\n  bar: baz`
           node.leading_comments.push(*read_comments(node.start_line, node.start_column)) if has_delim
           node.children.each do |subnode|
+            @bullet_owner = subnode if has_bullet
             visit(subnode)
           end
           if has_delim

data/lib/psych/comments/version.rb

@@ -2,6 +2,6 @@
 
 module Psych
   module Comments
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: psych-comments
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Masaki Hara
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-24 00:00:00.000000000 Z
+date: 2022-08-25 00:00:00.000000000 Z
 dependencies: []
 description: Brings comment-aware YAML parsing to Psych
 email: