parser 2.6.0.0 → 3.1.0.0

data/lib/parser/source/tree_rewriter.rb

@@ -117,6 +117,71 @@ 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.
+      # This action is atomic in that it won't change the receiver
+      # unless it succeeds.
+      #
+      # @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
+
+      ##
+      # 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`.
       #
@@ -185,28 +250,62 @@ module Parser
       # @return [String]
       #
       def process
-        source     = @source_buffer.source.dup
-        adjustment = 0
+        source     = @source_buffer.source
 
+        chunks = []
+        last_end = 0
         @action_root.ordered_replacements.each do |range, replacement|
-          begin_pos = range.begin_pos + adjustment
-          end_pos   = begin_pos + range.length
-
-          source[begin_pos...end_pos] = replacement
-
-          adjustment += replacement.length - range.length
+          chunks << source[last_end...range.begin_pos] << replacement
+          last_end = range.end_pos
         end
+        chunks << source[last_end...source.length]
+        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
 
-        source
+      ##
+      # 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,
-      # 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?
@@ -231,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
@@ -256,8 +360,34 @@ module Parser
 
       extend Deprecation
 
+      protected
+
+      attr_reader :action_root
+
       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
@@ -266,14 +396,14 @@ module Parser
 
       def combine(range, attributes)
         range = check_range_validity(range)
-        action = TreeRewriter::Action.new(range, @enforcer, attributes)
+        action = TreeRewriter::Action.new(range, @enforcer, **attributes)
         @action_root = @action_root.combine(action)
         self
       end
 
       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
@@ -281,7 +411,7 @@ module Parser
       def enforce_policy(event)
         return if @policy[event] == :accept
         return unless (values = yield)
-        trigger_policy(event, values)
+        trigger_policy(event, **values)
       end
 
       POLICY_TO_LEVEL = {warn: :warning, raise: :error}.freeze

data/lib/parser/static_environment.rb

@@ -3,6 +3,9 @@
 module Parser
 
   class StaticEnvironment
+    FORWARD_ARGS = :FORWARD_ARGS
+    ANONYMOUS_BLOCKARG = :ANONYMOUS_BLOCKARG
+
     def initialize
       reset
     end
@@ -41,6 +44,26 @@ module Parser
     def declared?(name)
       @variables.include?(name.to_sym)
     end
+
+    def declare_forward_args
+      declare(FORWARD_ARGS)
+    end
+
+    def declared_forward_args?
+      declared?(FORWARD_ARGS)
+    end
+
+    def declare_anonymous_blockarg
+      declare(ANONYMOUS_BLOCKARG)
+    end
+
+    def declared_anonymous_blockarg?
+      declared?(ANONYMOUS_BLOCKARG)
+    end
+
+    def empty?
+      @stack.empty?
+    end
   end
 
 end

data/lib/parser/tree_rewriter.rb

@@ -27,12 +27,12 @@ module Parser
   #     end
   #     EOF
   #
-  #     buffer        = Parser::Source::Buffer.new('(example)')
-  #     buffer.source = code
+  #     ast           = Parser::CurrentRuby.parse code
+  #     buffer        = Parser::Source::Buffer.new('(example)', source: code)
   #     rewriter      = RemoveDo.new
   #
   #     # Rewrite the AST, returns a String with the new form.
-  #     puts rewriter.rewrite(buffer)
+  #     puts rewriter.rewrite(buffer, ast)
   #
   # This would result in the following Ruby code:
   #

data/lib/parser/variables_stack.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Parser
+
+  class VariablesStack
+    def initialize
+      @stack = []
+      push
+    end
+
+    def empty?
+      @stack.empty?
+    end
+
+    def push
+      @stack << Set.new
+    end
+
+    def pop
+      @stack.pop
+    end
+
+    def reset
+      @stack.clear
+    end
+
+    def declare(name)
+      @stack.last << name.to_sym
+    end
+
+    def declared?(name)
+      @stack.last.include?(name.to_sym)
+    end
+  end
+
+end

data/lib/parser/version.rb

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

data/lib/parser.rb

@@ -46,6 +46,7 @@ module Parser
     require 'parser/source/map/variable'
     require 'parser/source/map/keyword'
     require 'parser/source/map/definition'
+    require 'parser/source/map/method_definition'
     require 'parser/source/map/send'
     require 'parser/source/map/index'
     require 'parser/source/map/condition'
@@ -73,6 +74,9 @@ module Parser
   end
 
   require 'parser/context'
+  require 'parser/max_numparam_stack'
+  require 'parser/current_arg_stack'
+  require 'parser/variables_stack'
 
   require 'parser/base'
 

data/parser.gemspec

@@ -13,31 +13,24 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/whitequark/parser'
   spec.license       = 'MIT'
 
-  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/macruby.rb
-                          lib/parser/rubymotion.rb
-                       )
+  spec.metadata = {
+    'bug_tracker_uri' => 'https://github.com/whitequark/parser/issues',
+    'changelog_uri' => "https://github.com/whitequark/parser/blob/v#{spec.version}/CHANGELOG.md",
+    'documentation_uri' => "https://www.rubydoc.info/gems/parser/#{spec.version}",
+    'source_code_uri' => "https://github.com/whitequark/parser/tree/v#{spec.version}"
+  }
+
+  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'
-  spec.add_development_dependency 'rake',      '~> 10.0'
-  spec.add_development_dependency 'racc',      '= 1.4.14'
+  spec.add_development_dependency 'bundler',   '>= 1.15', '< 3.0.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'
 
   spec.add_development_dependency 'yard'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parser
 version: !ruby/object:Gem::Version
-  version: 2.6.0.0
+  version: 3.1.0.0
 platform: ruby
 authors:
 - whitequark
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-01-16 00:00:00.000000000 Z
+date: 2022-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ast
@@ -16,56 +16,62 @@ 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
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.15'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.15'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     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
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.4.14
+        version: 1.4.15
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.4.14
+        version: 1.4.15
 - !ruby/object:Gem::Dependency
   name: cliver
   requirement: !ruby/object:Gem::Requirement
@@ -159,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
@@ -187,40 +179,34 @@ files:
 - lib/parser/color.rb
 - lib/parser/context.rb
 - lib/parser/current.rb
+- lib/parser/current_arg_stack.rb
 - lib/parser/deprecation.rb
 - 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/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
@@ -236,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
@@ -250,41 +237,18 @@ files:
 - lib/parser/static_environment.rb
 - lib/parser/syntax_error.rb
 - lib/parser/tree_rewriter.rb
+- 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_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: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/whitequark/parser/issues
+  changelog_uri: https://github.com/whitequark/parser/blob/v3.1.0.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/parser/3.1.0.0
+  source_code_uri: https://github.com/whitequark/parser/tree/v3.1.0.0
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -299,37 +263,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.3
+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_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: []

data/.gitignore

@@ -1,32 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-lib/bundler/man
-pkg
-rdoc
-yardoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.output
-.ruby-version
-.ruby-gemset
-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/macruby.rb
-lib/parser/rubymotion.rb