parser 2.7.1.3 → 3.0.1.0

data/lib/parser/runner.rb

@@ -37,7 +37,7 @@ module Parser
 
     private
 
-    LEGACY_MODES = %i[lambda procarg0 encoding index arg_inside_procarg0].freeze
+    LEGACY_MODES = %i[lambda procarg0 encoding index arg_inside_procarg0 forward_arg kwargs match_pattern].freeze
 
     def runner_name
       raise NotImplementedError, "implement #{self.class}##{__callee__}"
@@ -113,9 +113,9 @@ module Parser
         @parser_class = Parser::Ruby27
       end
 
-      opts.on '--28', 'Parse as Ruby 2.8 would' do
-        require 'parser/ruby28'
-        @parser_class = Parser::Ruby28
+      opts.on '--30', 'Parse as Ruby 3.0 would' do
+        require 'parser/ruby30'
+        @parser_class = Parser::Ruby30
       end
 
       opts.on '--mac', 'Parse as MacRuby 0.12 would' do

data/lib/parser/source/buffer.rb

@@ -114,8 +114,7 @@ module Parser
         @slice_source = nil
 
         # Cache for fast lookup
-        @line_for_position   = {}
-        @column_for_position = {}
+        @line_index_for_position = {}
 
         self.source = source if source
       end
@@ -207,9 +206,10 @@ module Parser
       # @return [[Integer, Integer]] `[line, column]`
       #
       def decompose_position(position)
-        line_no, line_begin = line_for(position)
+        line_index = line_index_for_position(position)
+        line_begin = line_begins[line_index]
 
-        [ @first_line + line_no, position - line_begin ]
+        [ @first_line + line_index , position - line_begin ]
       end
 
       ##
@@ -220,10 +220,7 @@ module Parser
       # @api private
       #
       def line_for_position(position)
-        @line_for_position[position] ||= begin
-          line_no, _ = line_for(position)
-          @first_line + line_no
-        end
+        line_index_for_position(position) + @first_line
       end
 
       ##
@@ -234,10 +231,8 @@ module Parser
       # @api private
       #
       def column_for_position(position)
-        @column_for_position[position] ||= begin
-          _, line_begin = line_for(position)
-          position - line_begin
-        end
+        line_index = line_index_for_position(position)
+        position - line_begins[line_index]
       end
 
       ##
@@ -278,15 +273,13 @@ module Parser
       # @raise  [IndexError] if `lineno` is out of bounds
       #
       def line_range(lineno)
-        index = lineno - @first_line + 1
-        if index <= 0 || index > line_begins.size
+        index = lineno - @first_line
+        if index < 0 || index + 1 >= line_begins.size
           raise IndexError, 'Parser::Source::Buffer: range for line ' \
             "#{lineno} requested, valid line numbers are #{@first_line}.." \
-            "#{@first_line + line_begins.size - 1}"
-        elsif index == line_begins.size
-          Range.new(self, line_begins[-index][1], @source.size)
+            "#{@first_line + line_begins.size - 2}"
         else
-          Range.new(self, line_begins[-index][1], line_begins[-index - 1][1] - 1)
+          Range.new(self, line_begins[index], line_begins[index + 1] - 1)
         end
       end
 
@@ -303,27 +296,57 @@ module Parser
       # @return [Integer]
       #
       def last_line
-        line_begins.size + @first_line - 1
+        line_begins.size + @first_line - 2
+      end
+
+      # :nodoc:
+      def freeze
+        source_lines; line_begins; source_range # build cache
+        super
+      end
+
+      # :nodoc:
+      def inspect
+        "#<#{self.class} #{name}>"
       end
 
       private
 
+      # @returns [0, line_begin_of_line_1, ..., source.size + 1]
       def line_begins
-        unless @line_begins
-          @line_begins, index = [ [ 0, 0 ] ], 0
-
+        @line_begins ||= begin
+          begins = [0]
+          index = 0
           while index = @source.index("\n".freeze, index)
             index += 1
-            @line_begins.unshift [ @line_begins.length, index ]
+            begins << index
           end
+          begins << @source.size + 1
+          begins
         end
+      end
 
-        @line_begins
+      # @returns 0-based line index of position
+      def line_index_for_position(position)
+        @line_index_for_position[position] || begin
+          index = bsearch(line_begins, position) - 1
+          @line_index_for_position[position] = index unless @line_index_for_position.frozen?
+          index
+        end
       end
 
-      def line_for(position)
-        line_begins.bsearch do |line, line_begin|
-          line_begin <= position
+      if Array.method_defined?(:bsearch_index) # RUBY_VERSION >= 2.3
+        def bsearch(line_begins, position)
+          line_begins.bsearch_index do |line_begin|
+            position < line_begin
+          end || line_begins.size - 1 # || only for out of bound values
+        end
+      else
+        def bsearch(line_begins, position)
+          @line_range ||= 0...line_begins.size
+          @line_range.bsearch do |i|
+            position < line_begins[i]
+          end || line_begins.size - 1 # || only for out of bound values
         end
       end
     end

data/lib/parser/source/comment.rb

@@ -10,7 +10,7 @@ module Parser
     #  @return [String]
     #
     # @!attribute [r] location
-    #  @return [Parser::Source::Map]
+    #  @return [Parser::Source::Range]
     #
     # @api public
     #

data/lib/parser/source/comment/associator.rb

@@ -107,7 +107,7 @@ module Parser
 
       private
 
-      POSTFIX_TYPES = Set[:if, :while, :while_post, :until, :until_post].freeze
+      POSTFIX_TYPES = Set[:if, :while, :while_post, :until, :until_post, :masgn].freeze
       def children_in_source_order(node)
         if POSTFIX_TYPES.include?(node.type)
           # All these types have either nodes with expressions, or `nil`

data/lib/parser/source/map/{endless_definition.rb → method_definition.rb}

@@ -3,19 +3,21 @@
 module Parser
   module Source
 
-    class Map::EndlessDefinition < Map
+    class Map::MethodDefinition < Map
       attr_reader :keyword
       attr_reader :operator
       attr_reader :name
+      attr_reader :end
       attr_reader :assignment
 
-      def initialize(keyword_l, operator_l, name_l, assignment_l, body_l)
+      def initialize(keyword_l, operator_l, name_l, end_l, assignment_l, body_l)
         @keyword  = keyword_l
         @operator = operator_l
         @name     = name_l
+        @end      = end_l
         @assignment = assignment_l
 
-        super(@keyword.join(body_l))
+        super(@keyword.join(end_l || body_l))
       end
     end
 

data/lib/parser/source/range.rb

@@ -13,7 +13,7 @@ module Parser
     #        ^^
     #
     # @!attribute [r] source_buffer
-    #  @return [Parser::Diagnostic::Engine]
+    #  @return [Parser::Source::Buffer]
     #
     # @!attribute [r] begin_pos
     #  @return [Integer] index of the first character in the range
@@ -112,11 +112,11 @@ module Parser
       # @raise RangeError
       #
       def column_range
-        if self.begin.line != self.end.line
+        if line != last_line
           raise RangeError, "#{self.inspect} spans more than one line"
         end
 
-        self.begin.column...self.end.column
+        column...last_column
       end
 
       ##

data/lib/parser/source/tree_rewriter.rb

@@ -129,6 +129,8 @@ module Parser
       ##
       # Merges the updates of argument with the receiver.
       # Policies of the receiver are used.
+      # This action is atomic in that it won't change the receiver
+      # unless it succeeds.
       #
       # @param [Rewriter] with
       # @return [Rewriter] self
@@ -154,6 +156,32 @@ module Parser
         dup.merge!(with)
       end
 
+      ##
+      # For special cases where one needs to merge a rewriter attached to a different source_buffer
+      # or that needs to be offset. Policies of the receiver are used.
+      #
+      # @param [TreeRewriter] rewriter from different source_buffer
+      # @param [Integer] offset
+      # @return [Rewriter] self
+      # @raise [IndexError] if action ranges (once offset) don't fit the current buffer
+      #
+      def import!(foreign_rewriter, offset: 0)
+        return self if foreign_rewriter.empty?
+
+        contracted = foreign_rewriter.action_root.contract
+        merge_effective_range = ::Parser::Source::Range.new(
+          @source_buffer,
+          contracted.range.begin_pos + offset,
+          contracted.range.end_pos + offset,
+        )
+        check_range_validity(merge_effective_range)
+
+        merge_with = contracted.moved(@source_buffer, offset)
+
+        @action_root = @action_root.combine(merge_with)
+        self
+      end
+
       ##
       # Replaces the code of the source range `range` with `content`.
       #
@@ -234,6 +262,44 @@ module Parser
         chunks.join
       end
 
+      ##
+      # Returns a representation of the rewriter as an ordered list of replacements.
+      #
+      #     rewriter.as_replacements # => [ [1...1, '('],
+      #                                     [2...4, 'foo'],
+      #                                     [5...6, ''],
+      #                                     [6...6, '!'],
+      #                                     [10...10, ')'],
+      #                                   ]
+      #
+      # This representation is sufficient to recreate the result of `process` but it is
+      # not sufficient to recreate completely the rewriter for further merging/actions.
+      # See `as_nested_actions`
+      #
+      # @return [Array<Range, String>] an ordered list of pairs of range & replacement
+      #
+      def as_replacements
+        @action_root.ordered_replacements
+      end
+
+      ##
+      # Returns a representation of the rewriter as nested insertions (:wrap) and replacements.
+      #
+      #     rewriter.as_actions # =>[ [:wrap, 1...10, '(', ')'],
+      #                               [:wrap, 2...6, '', '!'],  # aka "insert_after"
+      #                               [:replace, 2...4, 'foo'],
+      #                               [:replace, 5...6, ''],  # aka "removal"
+      #                             ],
+      #
+      # Contrary to `as_replacements`, this representation is sufficient to recreate exactly
+      # the rewriter.
+      #
+      # @return [Array<(Symbol, Range, String{, String})>]
+      #
+      def as_nested_actions
+        @action_root.nested_actions
+      end
+
       ##
       # Provides a protected block where a sequence of multiple rewrite actions
       # are handled atomically. If any of the actions failed by clobbering,
@@ -264,6 +330,11 @@ module Parser
         @in_transaction
       end
 
+      # :nodoc:
+      def inspect
+        "#<#{self.class} #{source_buffer.name}: #{action_summary}>"
+      end
+
       ##
       # @api private
       # @deprecated Use insert_after or wrap
@@ -295,6 +366,28 @@ module Parser
 
       private
 
+      def action_summary
+        replacements = as_replacements
+        case replacements.size
+        when 0 then return 'empty'
+        when 1..3 then #ok
+        else
+          replacements = replacements.first(3)
+          suffix = '…'
+        end
+        parts = replacements.map do |(range, str)|
+          if str.empty? # is this a deletion?
+            "-#{range.to_range}"
+          elsif range.size == 0 # is this an insertion?
+            "+#{str.inspect}@#{range.begin_pos}"
+          else # it is a replacement
+            "^#{str.inspect}@#{range.to_range}"
+          end
+        end
+        parts << suffix if suffix
+        parts.join(', ')
+      end
+
       ACTIONS = %i[accept warn raise].freeze
       def check_policy_validity
         invalid = @policy.values - ACTIONS
@@ -310,7 +403,7 @@ module Parser
 
       def check_range_validity(range)
         if range.begin_pos < 0 || range.end_pos > @source_buffer.source.size
-          raise IndexError, "The range #{range} is outside the bounds of the source"
+          raise IndexError, "The range #{range.to_range} is outside the bounds of the source"
         end
         range
       end

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

@@ -46,10 +46,49 @@ module Parser
         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

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/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.3'
+  VERSION = '3.0.1.0'
 end

data/parser.gemspec

@@ -20,29 +20,13 @@ 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/ruby28.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',      '~> 13.0.1'