parser 2.7.1.1 → 3.0.2.0

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

@@ -7,7 +7,7 @@ module Parser
     #
     # Actions are arranged in a tree and get combined so that:
     #   children are strictly contained by their parent
-    #   sibblings all disjoint from one another
+    #   sibblings all disjoint from one another and ordered
     #   only actions with replacement==nil may have children
     #
     class TreeRewriter::Action
@@ -41,15 +41,54 @@ module Parser
         reps = []
         reps << [@range.begin, @insert_before] unless @insert_before.empty?
         reps << [@range, @replacement] if @replacement
-        reps.concat(@children.sort_by(&:range).flat_map(&:ordered_replacements))
+        reps.concat(@children.flat_map(&:ordered_replacements))
         reps << [@range.end, @insert_after] unless @insert_after.empty?
         reps
       end
 
+      def nested_actions
+        actions = []
+        actions << [:wrap, @range, @insert_before, @insert_after] if !@insert_before.empty? ||
+                                                                     !@insert_after.empty?
+        actions << [:replace, @range, @replacement] if @replacement
+        actions.concat(@children.flat_map(&:nested_actions))
+      end
+
       def insertion?
         !insert_before.empty? || !insert_after.empty? || (replacement && !replacement.empty?)
       end
 
+      ##
+      # A root action has its range set to the whole source range, even
+      # though it typically do not act on that range.
+      # This method returns the action as if it was a child action with
+      # its range contracted.
+      # @return [Action]
+      def contract
+        raise 'Empty actions can not be contracted' if empty?
+        return self if insertion?
+        range = @range.with(
+          begin_pos: children.first.range.begin_pos,
+          end_pos: children.last.range.end_pos,
+        )
+        with(range: range)
+      end
+
+      ##
+      # @return [Action] that has been moved to the given source_buffer and with the given offset
+      # No check is done on validity of resulting range.
+      def moved(source_buffer, offset)
+        moved_range = ::Parser::Source::Range.new(
+          source_buffer,
+          @range.begin_pos + offset,
+          @range.end_pos + offset
+        )
+        with(
+          range: moved_range,
+          children: children.map { |child| child.moved(source_buffer, offset) }
+        )
+      end
+
       protected
 
       attr_reader :children
@@ -69,24 +108,24 @@ module Parser
       end
 
       def place_in_hierarchy(action)
-        family = @children.group_by { |child| child.relationship_with(action) }
+        family = analyse_hierarchy(action)
 
         if family[:fusible]
-          fuse_deletions(action, family[:fusible], [*family[:sibbling], *family[:child]])
+          fuse_deletions(action, family[:fusible], [*family[:sibbling_left], *family[:child], *family[:sibbling_right]])
         else
           extra_sibbling = if family[:parent]  # action should be a descendant of one of the children
-            family[:parent][0].do_combine(action)
+            family[:parent].do_combine(action)
           elsif family[:child]                 # or it should become the parent of some of the children,
             action.with(children: family[:child], enforcer: @enforcer)
               .combine_children(action.children)
           else                                 # or else it should become an additional child
             action
           end
-          with(children: [*family[:sibbling], extra_sibbling])
+          with(children: [*family[:sibbling_left], extra_sibbling, *family[:sibbling_right]])
         end
       end
 
-      # Assumes more_children all contained within @range
+      # 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)
@@ -100,22 +139,76 @@ module Parser
         without_fusible.do_combine(fused_deletion)
       end
 
-      # Returns what relationship self should have with `action`; either of
-      #   :sibbling, :parent, :child, :fusible or raises a CloberingError
-      # In case of equal range, returns :parent
-      def relationship_with(action)
-        if action.range == @range || @range.contains?(action.range)
-          :parent
-        elsif @range.contained?(action.range)
-          :child
-        elsif @range.disjoint?(action.range)
-          :sibbling
-        elsif !action.insertion? && !insertion?
-          @enforcer.call(:crossing_deletions) { {range: action.range, conflict: @range} }
-          :fusible
+      # Similar to @children.bsearch_index || size
+      # except allows for a starting point
+      # and `bsearch_index` is only Ruby 2.3+
+      def bsearch_child_index(from = 0)
+        size = @children.size
+        (from...size).bsearch { |i| yield @children[i] } || size
+      end
+
+      # Returns the children in a hierarchy with respect to `action`:
+      #   :sibbling_left, sibbling_right (for those that are disjoint from `action`)
+      #   :parent (in case one of our children contains `action`)
+      #   :child (in case `action` strictly contains some of our children)
+      #   :fusible (in case `action` overlaps some children but they can be fused in one deletion)
+      #   or raises a `CloberingError`
+      # In case a child has equal range to `action`, it is returned as `:parent`
+      # Reminder: an empty range 1...1 is considered disjoint from 1...10
+      def analyse_hierarchy(action)
+        r = action.range
+        # left_index is the index of the first child that isn't completely to the left of action
+        left_index = bsearch_child_index { |child| child.range.end_pos > r.begin_pos }
+        # right_index is the index of the first child that is completely on the right of action
+        start = left_index == 0 ? 0 : left_index - 1  # See "corner case" below for reason of -1
+        right_index = bsearch_child_index(start) { |child| child.range.begin_pos >= r.end_pos }
+        center = right_index - left_index
+        case center
+        when 0
+          # All children are disjoint from action, nothing else to do
+        when -1
+          # Corner case: if a child has empty range == action's range
+          # then it will appear to be both disjoint and to the left of action,
+          # as well as disjoint and to the right of action.
+          # Since ranges are equal, we return it as parent
+          left_index -= 1  # Fix indices, as otherwise this child would be
+          right_index += 1 # considered as a sibbling (both left and right!)
+          parent = @children[left_index]
         else
-          @enforcer.call(:crossing_insertions) { {range: action.range, conflict: @range} }
+          overlap_left = @children[left_index].range.begin_pos <=> r.begin_pos
+          overlap_right = @children[right_index-1].range.end_pos <=> r.end_pos
+
+          # For one child to be the parent of action, we must have:
+          if center == 1 && overlap_left <= 0 && overlap_right >= 0
+            parent = @children[left_index]
+          else
+            # Otherwise consider all non disjoint elements (center) to be contained...
+            contained = @children[left_index...right_index]
+            fusible = check_fusible(action,
+              (contained.shift if overlap_left < 0),  # ... but check first and last one
+              (contained.pop if overlap_right > 0)    # ... for overlaps
+            )
+          end
+        end
+
+        {
+          parent: parent,
+          sibbling_left: @children[0...left_index],
+          sibbling_right: @children[right_index...@children.size],
+          fusible: fusible,
+          child: contained,
+        }
+      end
+
+      # @param [Array(Action | nil)] fusible
+      def check_fusible(action, *fusible)
+        fusible.compact!
+        return if fusible.empty?
+        fusible.each do |child|
+          kind = action.insertion? || child.insertion? ? :crossing_insertions : :crossing_deletions
+          @enforcer.call(kind) { {range: action.range, conflict: child.range} }
         end
+        fusible
       end
 
       # Assumes action.range == range && action.children.empty?

data/lib/parser/static_environment.rb

@@ -51,6 +51,10 @@ module Parser
     def declared_forward_args?
       declared?(FORWARD_ARGS)
     end
+
+    def empty?
+      @stack.empty?
+    end
   end
 
 end

data/lib/parser/tree_rewriter.rb

@@ -28,8 +28,7 @@ module Parser
   #     EOF
   #
   #     ast           = Parser::CurrentRuby.parse code
-  #     buffer        = Parser::Source::Buffer.new('(example)')
-  #     buffer.source = code
+  #     buffer        = Parser::Source::Buffer.new('(example)', source: code)
   #     rewriter      = RemoveDo.new
   #
   #     # Rewrite the AST, returns a String with the new form.

data/lib/parser/variables_stack.rb

@@ -8,6 +8,10 @@ module Parser
       push
     end
 
+    def empty?
+      @stack.empty?
+    end
+
     def push
       @stack << Set.new
     end

data/lib/parser/version.rb

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

data/parser.gemspec

@@ -20,31 +20,16 @@ Gem::Specification.new do |spec|
     'source_code_uri' => "https://github.com/whitequark/parser/tree/v#{spec.version}"
   }
 
-  spec.files         = `git ls-files`.split + %w(
-                          lib/parser/lexer.rb
-                          lib/parser/ruby18.rb
-                          lib/parser/ruby19.rb
-                          lib/parser/ruby20.rb
-                          lib/parser/ruby21.rb
-                          lib/parser/ruby22.rb
-                          lib/parser/ruby23.rb
-                          lib/parser/ruby24.rb
-                          lib/parser/ruby25.rb
-                          lib/parser/ruby26.rb
-                          lib/parser/ruby27.rb
-                          lib/parser/macruby.rb
-                          lib/parser/rubymotion.rb
-                       )
+  spec.files         = Dir['bin/*', 'lib/**/*.rb', 'parser.gemspec', 'LICENSE.txt']
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^test/})
   spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_dependency             'ast',       '~> 2.4.0'
+  spec.add_dependency             'ast',       '~> 2.4.1'
 
   spec.add_development_dependency 'bundler',   '>= 1.15', '< 3.0.0'
-  spec.add_development_dependency 'rake',      '~> 10.0'
+  spec.add_development_dependency 'rake',      '~> 13.0.1'
   spec.add_development_dependency 'racc',      '= 1.4.15'
   spec.add_development_dependency 'cliver',    '~> 0.3.2'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parser
 version: !ruby/object:Gem::Version
-  version: 2.7.1.1
+  version: 3.0.2.0
 platform: ruby
 authors:
 - whitequark
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-14 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ast
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.4.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: racc
   requirement: !ruby/object:Gem::Requirement
@@ -165,23 +165,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- ".yardopts"
-- CHANGELOG.md
-- CONTRIBUTING.md
-- Gemfile
 - LICENSE.txt
-- README.md
-- Rakefile
 - bin/ruby-parse
 - bin/ruby-rewrite
-- ci/run_rubocop_specs
-- doc/AST_FORMAT.md
-- doc/CUSTOMIZATION.md
-- doc/INTERNALS.md
-- doc/css/.gitkeep
-- doc/css/common.css
 - lib/gauntlet_parser.rb
 - lib/parser.rb
 - lib/parser/all.rb
@@ -198,39 +184,29 @@ files:
 - lib/parser/diagnostic.rb
 - lib/parser/diagnostic/engine.rb
 - lib/parser/lexer.rb
-- lib/parser/lexer.rl
 - lib/parser/lexer/dedenter.rb
 - lib/parser/lexer/explanation.rb
 - lib/parser/lexer/literal.rb
 - lib/parser/lexer/stack_state.rb
 - lib/parser/macruby.rb
-- lib/parser/macruby.y
 - lib/parser/max_numparam_stack.rb
 - lib/parser/messages.rb
 - lib/parser/meta.rb
 - lib/parser/rewriter.rb
 - lib/parser/ruby18.rb
-- lib/parser/ruby18.y
 - lib/parser/ruby19.rb
-- lib/parser/ruby19.y
 - lib/parser/ruby20.rb
-- lib/parser/ruby20.y
 - lib/parser/ruby21.rb
-- lib/parser/ruby21.y
 - lib/parser/ruby22.rb
-- lib/parser/ruby22.y
 - lib/parser/ruby23.rb
-- lib/parser/ruby23.y
 - lib/parser/ruby24.rb
-- lib/parser/ruby24.y
 - lib/parser/ruby25.rb
-- lib/parser/ruby25.y
 - lib/parser/ruby26.rb
-- lib/parser/ruby26.y
 - lib/parser/ruby27.rb
-- lib/parser/ruby27.y
+- lib/parser/ruby28.rb
+- lib/parser/ruby30.rb
+- lib/parser/ruby31.rb
 - lib/parser/rubymotion.rb
-- lib/parser/rubymotion.y
 - lib/parser/runner.rb
 - lib/parser/runner/ruby_parse.rb
 - lib/parser/runner/ruby_rewrite.rb
@@ -246,6 +222,7 @@ files:
 - lib/parser/source/map/heredoc.rb
 - lib/parser/source/map/index.rb
 - lib/parser/source/map/keyword.rb
+- lib/parser/source/map/method_definition.rb
 - lib/parser/source/map/objc_kwarg.rb
 - lib/parser/source/map/operator.rb
 - lib/parser/source/map/rescue_body.rb
@@ -263,44 +240,15 @@ files:
 - lib/parser/variables_stack.rb
 - lib/parser/version.rb
 - parser.gemspec
-- test/bug_163/fixtures/input.rb
-- test/bug_163/fixtures/output.rb
-- test/bug_163/rewriter.rb
-- test/helper.rb
-- test/parse_helper.rb
-- test/racc_coverage_helper.rb
-- test/test_base.rb
-- test/test_current.rb
-- test/test_diagnostic.rb
-- test/test_diagnostic_engine.rb
-- test/test_encoding.rb
-- test/test_lexer.rb
-- test/test_lexer_stack_state.rb
-- test/test_parse_helper.rb
-- test/test_parser.rb
-- test/test_runner_parse.rb
-- test/test_runner_rewrite.rb
-- test/test_source_buffer.rb
-- test/test_source_comment.rb
-- test/test_source_comment_associator.rb
-- test/test_source_map.rb
-- test/test_source_range.rb
-- test/test_source_rewriter.rb
-- test/test_source_rewriter_action.rb
-- test/test_source_tree_rewriter.rb
-- test/test_static_environment.rb
-- test/using_tree_rewriter/fixtures/input.rb
-- test/using_tree_rewriter/fixtures/output.rb
-- test/using_tree_rewriter/using_tree_rewriter.rb
 homepage: https://github.com/whitequark/parser
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/whitequark/parser/issues
-  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: 
+  changelog_uri: https://github.com/whitequark/parser/blob/v3.0.2.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/parser/3.0.2.0
+  source_code_uri: https://github.com/whitequark/parser/tree/v3.0.2.0
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -316,36 +264,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A Ruby parser written in pure Ruby.
-test_files:
-- test/bug_163/fixtures/input.rb
-- test/bug_163/fixtures/output.rb
-- test/bug_163/rewriter.rb
-- test/helper.rb
-- test/parse_helper.rb
-- test/racc_coverage_helper.rb
-- test/test_base.rb
-- test/test_current.rb
-- test/test_diagnostic.rb
-- test/test_diagnostic_engine.rb
-- test/test_encoding.rb
-- test/test_lexer.rb
-- test/test_lexer_stack_state.rb
-- test/test_parse_helper.rb
-- test/test_parser.rb
-- test/test_runner_parse.rb
-- test/test_runner_rewrite.rb
-- test/test_source_buffer.rb
-- test/test_source_comment.rb
-- test/test_source_comment_associator.rb
-- test/test_source_map.rb
-- test/test_source_range.rb
-- test/test_source_rewriter.rb
-- test/test_source_rewriter_action.rb
-- test/test_source_tree_rewriter.rb
-- test/test_static_environment.rb
-- test/using_tree_rewriter/fixtures/input.rb
-- test/using_tree_rewriter/fixtures/output.rb
-- test/using_tree_rewriter/using_tree_rewriter.rb
+test_files: []