psych-pure 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62e40e29dab03fe116feadefc2a62967ec840deb52bee18bff89ae1318bf4d02
-  data.tar.gz: 3f5612a277682bbef3a698e03cc3bde6e9da02dc3f3024d9978aff34af8a624c
+  metadata.gz: 3b495922e35ffc07633da357273f8df93cc949fff0582eb5d6bf6d05c1e3ea19
+  data.tar.gz: 4a42f95af624a0712a49ea6dddd3ab5d0e382f65fb48a4d5a6e8fcbdf0195f39
 SHA512:
-  metadata.gz: 5be228176e34e4e908e1ea6af1cebbf41b59fa311de3e4a5abec21aefd9e6028f87473714b9e2c0ccf554bec1a379986b9323744c94ebdf9144cdc08d9116991
-  data.tar.gz: 4ba02fec03109e76b40883918d1d46125bdd8c1afb9d486a5af2decb868ebc6c967229dda3758e6281b5df709a89b2e6f704d747bad7f307d748861aba580b98
+  metadata.gz: fd5c511ad9ba206d9d7f012a80cb0924c07f3b9b0b0e860d296404ec7b4a39a5bc5cd1391ae207e213ba4b19d197dc341550bab944a4c384164e30021fdde9d0
+  data.tar.gz: 92bbc9e614dbd526792c45dca5cb1e5b38e463f2def07e47bc8b419f97236dce6823ef6b2303036a8db59c755e463e34a47254052b36688a3eb9824062043830

data/CHANGELOG.md

@@ -6,6 +6,17 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [0.2.0] - 2025-11-11
+
+- Add `sequence_indent` option to `Psych::Pure.dump` to control whether sequence elements contained within mapping elements are indented.
+- Properly handle mutation methods on loaded objects that mutate in place.
+
+## [0.1.4] - 2025-11-10
+
+- Fix up comment handling preceding sequence elements.
+- Properly update hashes in mutation methods that are loaded through `Psych::Pure.load`.
+- Properly raise syntax errors when the parser does not finish.
+
 ## [0.1.3] - 2025-10-24
 
 - Fix up roundtripping when using `<<` inside mappings.
@@ -31,7 +42,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 - 🎉 Initial release. 🎉
 
-[unreleased]: https://github.com/kddnewton/psych-pure/compare/v0.1.3...HEAD
+[unreleased]: https://github.com/kddnewton/psych-pure/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/kddnewton/psych-pure/compare/v0.1.4...v0.2.0
+[0.1.4]: https://github.com/kddnewton/psych-pure/compare/v0.1.3...v0.1.4
 [0.1.3]: https://github.com/kddnewton/psych-pure/compare/v0.1.2...v0.1.3
 [0.1.2]: https://github.com/kddnewton/psych-pure/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/kddnewton/psych-pure/compare/v0.1.0...v0.1.1

data/lib/psych/pure/version.rb

@@ -2,6 +2,6 @@
 
 module Psych
   module Pure
-    VERSION = "0.1.3"
+    VERSION = "0.2.0"
   end
 end

data/lib/psych/pure.rb

@@ -176,6 +176,20 @@ module Psych
       def trailing_comment(comment)
         @trailing << comment
       end
+
+      # Execute the given block without the leading comments being visible. This
+      # is used when a node has already handled its child nodes' leading
+      # comments, so they should not be processed again.
+      def without_leading
+        leading = @leading
+
+        begin
+          @leading = []
+          yield
+        ensure
+          @leading = leading
+        end
+      end
     end
 
     # Wraps a Ruby object with its node from the source input.
@@ -187,15 +201,37 @@ module Psych
       # rely on the source formatting, and need to format it ourselves.
       attr_reader :dirty
 
-      def initialize(object, psych_node, dirty = false)
+      def initialize(object, psych_node)
         super(object)
         @psych_node = psych_node
-        @dirty = dirty
+        @dirty = false
       end
 
-      def replace(psych_node)
-        @psych_node = psych_node
-        @dirty = true
+      def initialize_clone(obj, freeze: nil)
+        super
+        @psych_node = obj.psych_node.dup
+      end
+
+      def initialize_dup(obj)
+        super
+        @psych_node = obj.psych_node.dup
+      end
+
+      # Effectively implement the same method_missing as SimpleDelegator, but
+      # additionally track whether or not the object has been mutated.
+      ruby2_keywords def method_missing(name, *args, &block)
+        takes_block = false
+        target = self.__getobj__ { takes_block = true }
+
+        if !takes_block && target_respond_to?(target, name, false)
+          previous = target.dup
+          result = target.__send__(name, *args, &block)
+
+          @dirty = true unless previous.eql?(target)
+          result
+        else
+          super(name, *args, &block)
+        end
       end
     end
 
@@ -209,7 +245,11 @@ module Psych
           @value_node = value_node
         end
 
-        def replace(value_node)
+        def replace_key(key_node)
+          @key_node = key_node
+        end
+
+        def replace_value(value_node)
           @value_node = value_node
         end
       end
@@ -217,49 +257,245 @@ module Psych
       # The node associated with the hash.
       attr_reader :psych_node
 
+      # The list of key/value pairs within the hash.
+      attr_reader :psych_keys
+
       def initialize(object, psych_node)
         super(object)
         @psych_node = psych_node
         @psych_keys = []
       end
 
-      def psych_keys
-        @psych_keys.map do |psych_key|
-          [psych_key.key_node, psych_key.value_node]
-        end
+      def set!(key_node, value_node)
+        @psych_keys << PsychKey.new(key_node, value_node)
+        __getobj__[key_node.__getobj__] = value_node
+      end
+
+      def join!(key_node, value_node)
+        @psych_keys << PsychKey.new(key_node, value_node)
+        merge!(value_node)
+      end
+
+      def psych_assocs
+        @psych_keys.map { |psych_key| [psych_key.key_node, psych_key.value_node] }
+      end
+
+      # Override Hash mutation methods to keep @psych_keys in sync.
+
+      def initialize_clone(obj, freeze: nil)
+        super
+        @psych_keys = obj.psych_keys.map(&:dup)
+      end
+
+      def initialize_dup(obj)
+        super
+        @psych_keys = obj.psych_keys.map(&:dup)
       end
 
       def []=(key, value)
-        if begin
-          @psych_keys.none? do |psych_key|
-            key_node = psych_key.key_node
-            key_node_inner =
-              if key_node.is_a?(LoadedHash) || key_node.is_a?(LoadedObject)
-                key_node.__getobj__
-              else
-                key_node
-              end
+        super(key, value)
 
-            if key_node_inner.eql?(key)
-              psych_key.replace(value)
-              true
+        if (psych_key = @psych_keys.reverse_each.find { |psych_key| psych_compare?(psych_key.key_node, key) })
+          psych_key.replace_value(value)
+        else
+          @psych_keys << PsychKey.new(key, value)
+        end
+
+        value
+      end
+
+      alias store []=
+
+      def clear
+        super
+        @psych_keys.clear
+
+        self
+      end
+
+      def compact!
+        mutated = false
+        @psych_keys.each do |psych_key|
+          if psych_unwrap(psych_key.value_node).nil?
+            mutated = true
+            delete(psych_unwrap(psych_key.key_node))
+          end
+        end
+
+        self if mutated
+      end
+
+      def compact
+        dup.compact!
+      end
+
+      def delete(key)
+        result = super
+        psych_delete(key)
+
+        result
+      end
+
+      def delete_if(&block)
+        super do |key, value|
+          yield(key, psych_unwrap(value)).tap do |result|
+            psych_delete(key) if result
+          end
+        end
+
+        self
+      end
+
+      def except(*keys)
+        dup.delete_if { |key, _| keys.include?(key) }
+      end
+
+      def filter!(&block)
+        mutated = false
+        super do |key, value|
+          yield(key, psych_unwrap(value)).tap do |result|
+            unless result
+              psych_delete(key)
+              mutated = true
             end
           end
-        end then
-          @psych_keys << PsychKey.new(key, value)
         end
 
-        super(key, value)
+        self if mutated
       end
 
-      def set!(key_node, value_node)
-        @psych_keys << PsychKey.new(key_node, value_node)
-        __getobj__[key_node.__getobj__] = value_node
+      def filter(&block)
+        dup.filter!(&block)
       end
 
-      def join!(key_node, value_node)
-        @psych_keys << PsychKey.new(key_node, value_node)
-        merge!(value_node)
+      def invert
+        result = LoadedHash.new({}, @psych_node)
+        each { |key, value| result[psych_unwrap(value)] = key }
+        result
+      end
+
+      def keep_if(&block)
+        super do |key, value|
+          yield(key, psych_unwrap(value)).tap do |result|
+            psych_delete(key) unless result
+          end
+        end
+
+        self
+      end
+
+      alias select! keep_if
+
+      def merge!(*others)
+        super
+        others.each do |other|
+          other.each do |key, value|
+            psych_delete(key)
+            @psych_keys << PsychKey.new(key, value)
+          end
+        end
+
+        self
+      end
+
+      alias update merge!
+
+      def merge(*others)
+        dup.merge!(*others)
+      end
+
+      def reject!(&block)
+        mutated = false
+        super do |key, value|
+          yield(key, psych_unwrap(value)).tap do |result|
+            if result
+              psych_delete(key)
+              mutated = true
+            end
+          end
+        end
+
+        self if mutated
+      end
+
+      def reject(&block)
+        dup.reject!(&block)
+      end
+
+      def replace(other)
+        super
+
+        @psych_keys.clear
+        other.each { |key, value| @psych_keys << PsychKey.new(key, value) }
+
+        self
+      end
+
+      def shift
+        unless empty?
+          key, value = super
+          psych_delete(key)
+
+          [key, value]
+        end
+      end
+
+      def slice(*keys)
+        dup.select! { |key, _| keys.include?(key) }
+      end
+
+      def transform_keys!(&block)
+        super do |key|
+          yield(key).tap do |result|
+            @psych_keys
+              .reverse_each
+              .find { |psych_key| psych_compare?(psych_key.key_node, key) }
+              &.replace_key(result)
+          end
+        end
+
+        self
+      end
+
+      def transform_keys(&block)
+        dup.transform_keys!(&block)
+      end
+
+      def transform_values!(&block)
+        super do |value|
+          yield(psych_unwrap(value)).tap do |result|
+            @psych_keys
+              .reverse_each
+              .find { |psych_key| psych_compare?(psych_key.value_node, value) }
+              &.replace_value(result)
+          end
+        end
+      end
+
+      def transform_values(&block)
+        dup.transform_values!(&block)
+      end
+
+      private
+
+      def psych_compare?(psych_node, value)
+        if compare_by_identity?
+          psych_unwrap(psych_node).equal?(value)
+        else
+          psych_unwrap(psych_node).eql?(value)
+        end
+      end
+
+      def psych_delete(key)
+        @psych_keys.reject! { |psych_key| psych_compare?(psych_key.key_node, key) }
+      end
+
+      def psych_unwrap(node)
+        if node.is_a?(LoadedHash) || node.is_a?(LoadedObject)
+          node.__getobj__
+        else
+          node
+        end
       end
     end
 
@@ -762,9 +998,7 @@ module Psych
         @source = Source.new(yaml)
         @comments = {} if comments
 
-        raise_syntax_error("Parser failed to complete") unless parse_l_yaml_stream
-        raise_syntax_error("Parser finished before end of input") unless @scanner.eos?
-
+        parse_l_yaml_stream
         @comments = nil if comments
         true
       end
@@ -1261,11 +1495,8 @@ module Psych
       #   b-comment
       def parse_s_b_comment
         try do
-          try do
-            if parse_s_separate_in_line
-              parse_c_nb_comment_text(true)
-              true
-            end
+          if parse_s_separate_in_line
+            parse_c_nb_comment_text(true)
           end
 
           parse_b_comment
@@ -2064,12 +2295,9 @@ module Psych
           if parse_ns_flow_seq_entry(n, c)
             parse_s_separate(n, c)
 
-            try do
-              if match(",")
-                parse_s_separate(n, c)
-                parse_ns_s_flow_seq_entries(n, c)
-                true
-              end
+            if match(",")
+              parse_s_separate(n, c)
+              parse_ns_s_flow_seq_entries(n, c)
             end
 
             true
@@ -3195,34 +3423,32 @@ module Psych
       def parse_l_yaml_stream
         events_push_flush_properties(StreamStart.new(Location.point(@source, @scanner.pos)))
 
-        if try {
-          if parse_l_document_prefix
-            @document_start_event = DocumentStart.new(Location.point(@source, @scanner.pos))
-            @tag_directives = @document_start_event.tag_directives
-            @document_end_event = nil
+        star { parse_l_document_prefix }
+        @document_start_event = DocumentStart.new(Location.point(@source, @scanner.pos))
+        @tag_directives = @document_start_event.tag_directives
+        @document_end_event = nil
+        parse_l_any_document
 
-            parse_l_any_document
-            star do
-              try do
-                if parse_l_document_suffix
-                  star { parse_l_document_prefix }
-                  parse_l_any_document
-                  true
-                end
-              end ||
-              try do
-                if parse_l_document_prefix
-                  parse_l_explicit_document
-                  true
-                end
-              end
+        star do
+          try do
+            if parse_l_document_suffix
+              star { parse_l_document_prefix }
+              parse_l_any_document
+              true
+            end
+          end ||
+          try do
+            if parse_l_document_prefix
+              parse_l_explicit_document
+              true
             end
           end
-        } then
-          document_end_event_flush
-          events_push_flush_properties(StreamEnd.new(Location.point(@source, @scanner.pos)))
-          true
         end
+
+        raise_syntax_error("Parser finished before end of input") unless @scanner.eos?
+        document_end_event_flush
+        events_push_flush_properties(StreamEnd.new(Location.point(@source, @scanner.pos)))
+        true
       end
 
       # ------------------------------------------------------------------------
@@ -3298,6 +3524,9 @@ module Psych
 
       # Represents the nil value.
       class NilNode < Node
+        def accept(visitor)
+          raise "Visiting NilNode is not supported"
+        end
       end
 
       # Represents a generic object that is not matched by any of the other node
@@ -3352,8 +3581,9 @@ module Psych
       # The visitor is responsible for walking the tree and generating the YAML
       # output.
       class Visitor
-        def initialize(q)
+        def initialize(q, sequence_indent: false)
           @q = q
+          @sequence_indent = sequence_indent
         end
 
         # Visit an AliasNode.
@@ -3468,12 +3698,38 @@ module Psych
             @q.breakable
           end
 
-          @q.seplist(contents, -> { @q.breakable }) do |element|
+          current_line = nil
+          contents.each_with_index do |element, index|
+            psych_node = element.psych_node
+            leading = psych_node&.comments&.leading
+
+            if index > 0
+              @q.breakable
+
+              if current_line && psych_node
+                start_line = (leading&.first || psych_node).start_line
+                @q.breakable if start_line - current_line >= 2
+              end
+            end
+
+            current_line = psych_node&.end_line
+            visit_leading_comments(leading) if leading&.any?
+
+            if psych_node && (trailing = psych_node.comments.trailing).any?
+              current_line = trailing.last.end_line
+            end
+
             @q.text("-")
             next if element.is_a?(NilNode)
 
             @q.text(" ")
-            @q.nest(2) { visit(element) }
+            @q.nest(2) do
+              if psych_node
+                psych_node.comments.without_leading { visit(element) }
+              else
+                visit(element)
+              end
+            end
           end
 
           @q.current_group.break
@@ -3544,6 +3800,11 @@ module Psych
             elsif inlined || value.anchor || value.tag || value.value.empty?
               @q.text(" ")
               @q.nest(2) { visit(value) }
+            elsif @sequence_indent
+              @q.nest(2) do
+                @q.breakable
+                visit(value)
+              end
             else
               @q.breakable
               visit(value)
@@ -3629,23 +3890,29 @@ module Psych
           end
         end
 
+        # Visit the leading comments for a node, printing them out with proper
+        # line breaks.
+        def visit_leading_comments(comments)
+          line = nil
+
+          comments.each do |comment|
+            while line && line < comment.start_line
+              @q.breakable
+              line += 1
+            end
+
+            @q.text(comment.value)
+            line = comment.end_line
+          end
+
+          @q.breakable
+        end
+
         # Print out the leading and trailing comments of a node, as well as
         # yielding the value of the node to the block.
         def with_comments(node)
           if (comments = node.psych_node&.comments) && (leading = comments.leading).any?
-            line = nil
-
-            leading.each do |comment|
-              while line && line < comment.start_line
-                @q.breakable
-                line += 1
-              end
-
-              @q.text(comment.value)
-              line = comment.end_line
-            end
-
-            @q.breakable
+            visit_leading_comments(leading)
           end
 
           yield node.value
@@ -3767,7 +4034,7 @@ module Psych
             q.text(" ")
           end
 
-          node.accept(Visitor.new(q))
+          node.accept(Visitor.new(q, sequence_indent: @options.fetch(:sequence_indent, false)))
           q.breakable
           q.current_group.break
           q.flush
@@ -3835,7 +4102,7 @@ module Psych
             when Hash
               contents =
                 if base_object.is_a?(LoadedHash)
-                  base_object.psych_keys.flat_map { |(key, value)| [dump(key), dump(value)] }
+                  base_object.psych_assocs.flat_map { |(key, value)| [dump(key), dump(value)] }
                 else
                   object.flat_map { |key, value| [dump(key), dump(value)] }
                 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: psych-pure
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-24 00:00:00.000000000 Z
+date: 2025-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -113,7 +113,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/kddnewton/psych-pure/issues
-  changelog_uri: https://github.com/kddnewton/psych-pure/blob/v0.1.3/CHANGELOG.md
+  changelog_uri: https://github.com/kddnewton/psych-pure/blob/v0.2.0/CHANGELOG.md
   source_code_uri: https://github.com/kddnewton/psych-pure
   rubygems_mfa_required: 'true'
 post_install_message: