parser 2.7.1.0 → 2.7.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46184af7a1e0d843e62e720cd7795bb196972603e588eed69f47791b3c799288
-  data.tar.gz: 1a9d809fc7443fb09deb3a36ea19ad418ff56119040b14a292c9ed8d112d1f29
+  metadata.gz: fb7c9797808fcd8920ef34ccce6dae7f416d0fe3084a863fa3fec7fa30b086fc
+  data.tar.gz: 828a937688a35e277c7d435197ca2d023458de366a8e94fbaa67bdd6d3a04145
 SHA512:
-  metadata.gz: 9a91995ac131a4048976358a7bce1bd09b09893bb0b13fa39f2128c47fb0b1179f830a4adbb766df768bfbd2f89a1c5a5ee437dc1433ccaf5ad2307ff7c09d77
-  data.tar.gz: 4fe835bc9fe1ff030d57e9a4d9a4657a0d244db23bac3c117e8f78bfc51d9dc330f51257e04c8ba5ef737d3feab11152db2e1ecde1e8b136d4fcc4f253ed549d
+  metadata.gz: 679bc103f3d8b2663a1ec2de6c3acac41c90c1d738b40bf4b5ed945b8e3f51e22359caa0789e55009f3bd2c45ac832d00182db9ba9be1f43b18e6fe0e0508278
+  data.tar.gz: b4f4d29766e23ca406644fb578e2134f28a9983d765d4aa45117dcb5a9ee012f27c2b8b65eccf11b7e3818b1543a62cc0483aa510a51352bc2260ad0fd650acd

data/.travis.yml

@@ -2,8 +2,8 @@ dist: trusty
 language: ruby
 matrix:
   include:
-    - name: 2.4.9 / Parser tests
-      rvm: 2.4.9
+    - name: 2.4.10 / Parser tests
+      rvm: 2.4.10
       script: bundle exec rake test_cov
     - name: 2.5.8 / Parser tests
       rvm: 2.5.8

data/CHANGELOG.md

@@ -1,9 +1,16 @@
 Changelog
 =========
 
-Not released (2020-04-03)
+Not released (2020-04-15)
 -------------------------
 
+Features implemented:
+ * Add Source::Range#eql? and hash (#675) (Marc-André Lafortune)
+ * Source::TreeRewriter: Add #merge, #merge! and #empty? (#674) (Marc-André Lafortune)
+
+v2.7.1.0 (2020-04-03)
+---------------------
+
 API modifications:
  * Bump ruby versions to 2.4.10, 2.5.8, 2.6.6, 2.7.1. (#665) (Ilya Bylich)
 

data/lib/parser/source/range.rb

@@ -298,6 +298,15 @@ module Parser
         (@end_pos <=> other.end_pos)
       end
 
+      alias_method :eql?, :==
+
+      ##
+      # Support for Ranges be used in as Hash indices and in Sets.
+      #
+      def hash
+        [@source_buffer, @begin_pos, @end_pos].hash
+      end
+
       ##
       # @return [String] a human-readable representation of this range.
       #

data/lib/parser/source/tree_rewriter.rb

@@ -117,6 +117,43 @@ module Parser
         @action_root = TreeRewriter::Action.new(all_encompassing_range, @enforcer)
       end
 
+      ##
+      # Returns true iff no (non trivial) update has been recorded
+      #
+      # @return [Boolean]
+      #
+      def empty?
+        @action_root.empty?
+      end
+
+      ##
+      # Merges the updates of argument with the receiver.
+      # Policies of the receiver are used.
+      #
+      # @param [Rewriter] with
+      # @return [Rewriter] self
+      # @raise [ClobberingError] when clobbering is detected
+      #
+      def merge!(with)
+        raise 'TreeRewriter are not for the same source_buffer' unless
+          source_buffer == with.source_buffer
+
+        @action_root = @action_root.combine(with.action_root)
+        self
+      end
+
+      ##
+      # Returns a new rewriter that consists of the updates of the received
+      # and the given argument. Policies of the receiver are used.
+      #
+      # @param [Rewriter] with
+      # @return [Rewriter] merge of receiver and argument
+      # @raise [ClobberingError] when clobbering is detected
+      #
+      def merge(with)
+        dup.merge!(with)
+      end
+
       ##
       # Replaces the code of the source range `range` with `content`.
       #
@@ -203,10 +240,9 @@ module Parser
       ##
       # Provides a protected block where a sequence of multiple rewrite actions
       # are handled atomically. If any of the actions failed by clobbering,
-      # all the actions are rolled back.
+      # all the actions are rolled back. Transactions can be nested.
       #
       # @raise [RuntimeError] when no block is passed
-      # @raise [RuntimeError] when already in a transaction
       #
       def transaction
         unless block_given?
@@ -256,6 +292,10 @@ module Parser
 
       extend Deprecation
 
+      protected
+
+      attr_reader :action_root
+
       private
 
       ACTIONS = %i[accept warn raise].freeze

data/lib/parser/source/tree_rewriter/action.rb

@@ -25,12 +25,18 @@ module Parser
         freeze
       end
 
-      # Assumes action.children.empty?
       def combine(action)
-        return self unless action.insertion? || action.replacement # Ignore empty action
+        return self if action.empty? # Ignore empty action
         do_combine(action)
       end
 
+      def empty?
+        @insert_before.empty? &&
+          @insert_after.empty? &&
+          @children.empty? &&
+          (@replacement == nil || (@replacement.empty? && @range.empty?))
+      end
+
       def ordered_replacements
         reps = []
         reps << [@range.begin, @insert_before] unless @insert_before.empty?
@@ -46,9 +52,11 @@ module Parser
 
       protected
 
-      def with(range: @range, children: @children, insert_before: @insert_before, replacement: @replacement, insert_after: @insert_after)
+      attr_reader :children
+
+      def with(range: @range, enforcer: @enforcer, children: @children, insert_before: @insert_before, replacement: @replacement, insert_after: @insert_after)
         children = swallow(children) if replacement
-        self.class.new(range, @enforcer, children: children, insert_before: insert_before, replacement: replacement, insert_after: insert_after)
+        self.class.new(range, enforcer, children: children, insert_before: insert_before, replacement: replacement, insert_after: insert_after)
       end
 
       # Assumes range.contains?(action.range) && action.children.empty?
@@ -69,7 +77,8 @@ module Parser
           extra_sibbling = if family[:parent]  # action should be a descendant of one of the children
             family[:parent][0].do_combine(action)
           elsif family[:child]                 # or it should become the parent of some of the children,
-            action.with(children: family[:child])
+            action.with(children: family[:child], enforcer: @enforcer)
+              .combine_children(action.children)
           else                                 # or else it should become an additional child
             action
           end
@@ -77,6 +86,13 @@ module Parser
         end
       end
 
+      # Assumes more_children all contained within @range
+      def combine_children(more_children)
+        more_children.inject(self) do |parent, new_child|
+          parent.place_in_hierarchy(new_child)
+        end
+      end
+
       def fuse_deletions(action, fusible, other_sibblings)
         without_fusible = with(children: other_sibblings)
         fused_range = [action, *fusible].map(&:range).inject(:join)
@@ -109,7 +125,7 @@ module Parser
           insert_before: "#{action.insert_before}#{insert_before}",
           replacement: action.replacement || @replacement,
           insert_after: "#{insert_after}#{action.insert_after}",
-        )
+        ).combine_children(action.children)
       end
 
       def call_enforcer_for_merge(action)

data/lib/parser/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Parser
-  VERSION = '2.7.1.0'
+  VERSION = '2.7.1.1'
 end

data/test/test_source_range.rb

@@ -169,4 +169,19 @@ class TestSourceRange < Minitest::Test
     assert_equal 1, sr3.begin_pos
     assert_equal 4, sr3.end_pos
   end
+
+  def test_eql_and_hash
+    assert_equal false, @sr1_3.eql?(@sr3_3)
+    assert @sr1_3.hash != @sr3_3.hash
+
+    also_1_3 = @sr3_3.with(begin_pos: 1)
+    assert_equal true, @sr1_3.eql?(also_1_3)
+    assert_equal @sr1_3.hash, also_1_3.hash
+
+    buf2 = Parser::Source::Buffer.new('(string)')
+    buf2.source = "foobar\nbaz"
+    from_other_buf = Parser::Source::Range.new(buf2, 1, 3)
+    assert_equal false, @sr1_3.eql?(from_other_buf)
+    assert @sr1_3.hash != from_other_buf.hash
+  end
 end

data/test/test_source_tree_rewriter.rb

@@ -8,8 +8,10 @@ class TestSourceTreeRewriter < Minitest::Test
     @buf.source = 'puts(:hello, :world)'
 
     @hello = range(5, 6)
+    @ll = range(7, 2)
     @comma_space = range(11,2)
     @world = range(13,6)
+    @whole = range(0, @buf.source.length)
   end
 
   def range(from, len)
@@ -17,11 +19,11 @@ class TestSourceTreeRewriter < Minitest::Test
   end
 
   # Returns either:
-  #  - String (Normal operation)
+  #  - yield rewriter
   #  - [diagnostic, ...] (Diagnostics)
   #  - Parser::ClobberingError
   #
-  def apply(actions, **policy)
+  def build(actions, **policy)
     diagnostics = []
     diags = -> { diagnostics.flatten.map(&:strip).join("\n") }
     rewriter = Parser::Source::TreeRewriter.new(@buf, **policy)
@@ -30,7 +32,7 @@ class TestSourceTreeRewriter < Minitest::Test
       rewriter.public_send(action, range, *args)
     end
     if diagnostics.empty?
-      rewriter.process
+      yield rewriter
     else
       diags.call
     end
@@ -38,6 +40,15 @@ class TestSourceTreeRewriter < Minitest::Test
     [::Parser::ClobberingError, diags.call]
   end
 
+  # Returns either:
+  #  - String (Normal operation)
+  #  - [diagnostic, ...] (Diagnostics)
+  #  - Parser::ClobberingError
+  #
+  def apply(actions, **policy)
+    build(actions, **policy) { |rewriter| rewriter.process }
+  end
+
   # Expects ordered actions to be grouped together
   def check_actions(expected, grouped_actions, **policy)
     grouped_actions.permutation do |sequence|
@@ -170,4 +181,73 @@ DIAGNOSTIC
     rewriter = Parser::Source::TreeRewriter.new(@buf)
     assert_raises(IndexError) { rewriter.insert_before(range(0, 100), 'hola') }
   end
+
+  def test_empty
+    rewriter = Parser::Source::TreeRewriter.new(@buf)
+    assert_equal true, rewriter.empty?
+
+    # This is a trivial wrap
+    rewriter.wrap(range(2,3), '', '')
+    assert_equal true, rewriter.empty?
+
+    # This is a trivial deletion
+    rewriter.remove(range(2,0))
+    assert_equal true, rewriter.empty?
+
+    rewriter.remove(range(2,3))
+    assert_equal false, rewriter.empty?
+  end
+
+  # splits array into two groups, yield all such possible pairs of groups
+  # each_split([1, 2, 3, 4]) yields [1, 2], [3, 4];
+  #                            then [1, 3], [2, 4]
+  #                                 ...
+  #                     and finally [3, 4], [1, 2]
+  def each_split(array)
+    n = array.size
+    first_split_size = n.div(2)
+    splitting = (0...n).to_set
+    splitting.to_a.combination(first_split_size) do |indices|
+      yield array.values_at(*indices),
+            array.values_at(*(splitting - indices))
+    end
+  end
+
+  # Checks that `actions+extra` give the same result when
+  # made in order or from subgroups that are later merged.
+  # The `extra` actions are always added at the end of the second group.
+  #
+  def check_all_merge_possibilities(actions, extra, **policy)
+    expected = apply(actions + extra, **policy)
+
+    each_split(actions) do |actions_1, actions_2|
+      build(actions_1, **policy) do |rewriter_1|
+        build(actions_2 + extra, **policy) do |rewriter_2|
+          result = rewriter_1.merge(rewriter_2).process
+          assert_equal(expected, result,
+            "Group 1: #{actions_1.inspect}\n\n" +
+            "Group 2: #{(actions_2 + extra).inspect}"
+          )
+        end
+      end
+    end
+  end
+
+  def test_merge
+    check_all_merge_possibilities([
+      [:wrap, @whole, '<', '>'],
+      [:replace, @comma_space, ' => '],
+      [:wrap, @hello, '!', '!'],
+      # Following two wraps must have same value as they
+      # will be applied in different orders...
+      [:wrap, @hello.join(@world), '{', '}'],
+      [:wrap, @hello.join(@world), '{', '}'],
+      [:remove, @ll],
+      [:replace, @world, ':everybody'],
+      [:wrap, @world, '[', ']']
+    ],
+    [ # ... but this one is always going to be applied last (extra)
+      [:wrap, @hello.join(@world), '@', '@'],
+    ])
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parser
 version: !ruby/object:Gem::Version
-  version: 2.7.1.0
+  version: 2.7.1.1
 platform: ruby
 authors:
 - whitequark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-03 00:00:00.000000000 Z
+date: 2020-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ast
@@ -297,9 +297,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/whitequark/parser/issues
-  changelog_uri: https://github.com/whitequark/parser/blob/v2.7.1.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/parser/2.7.1.0
-  source_code_uri: https://github.com/whitequark/parser/tree/v2.7.1.0
+  changelog_uri: https://github.com/whitequark/parser/blob/v2.7.1.1/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/parser/2.7.1.1
+  source_code_uri: https://github.com/whitequark/parser/tree/v2.7.1.1
 post_install_message: 
 rdoc_options: []
 require_paths: