parser 2.4.0.2 → 2.5.0.0

data/lib/parser/runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'benchmark'
 require 'find'
 require 'optparse'
@@ -176,9 +178,7 @@ module Parser
 
     def process_fragments
       @fragments.each_with_index do |fragment, index|
-        if fragment.respond_to? :force_encoding
-          fragment = fragment.dup.force_encoding(@parser.default_encoding)
-        end
+        fragment = fragment.dup.force_encoding(@parser.default_encoding)
 
         buffer = Source::Buffer.new("(fragment:#{index})")
         buffer.source = fragment
@@ -189,10 +189,7 @@ module Parser
 
     def process_files
       @files.each do |filename|
-        source = File.read(filename)
-        if source.respond_to? :force_encoding
-          source.force_encoding(@parser.default_encoding)
-        end
+        source = File.read(filename).force_encoding(@parser.default_encoding)
 
         buffer = Parser::Source::Buffer.new(filename)
 

data/lib/parser/runner/ruby_parse.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'parser/runner'
 require 'parser/lexer/explanation'
+require 'json'
 
 module Parser
 
@@ -94,6 +97,7 @@ module Parser
 
       @locate = false
       @emit_ruby = false
+      @emit_json = false
     end
 
     private
@@ -118,6 +122,10 @@ module Parser
       opts.on '--emit-ruby', 'Emit S-expressions as valid Ruby code' do
         @emit_ruby = true
       end
+      
+      opts.on '--emit-json', 'Emit S-expressions as valid JSON' do
+        @emit_json = true
+      end
     end
 
     def process_all_input
@@ -136,6 +144,8 @@ module Parser
       elsif !@benchmark
         if @emit_ruby
           puts ast.inspect
+        elsif @emit_json
+          puts JSON.generate(ast.to_sexp_array)
         else
           puts ast.to_s
         end

data/lib/parser/runner/ruby_rewrite.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'parser/runner'
 require 'tempfile'
 

data/lib/parser/source/buffer.rb

@@ -1,4 +1,5 @@
 # encoding: ascii-8bit
+# frozen_string_literal: true
 
 module Parser
   module Source
@@ -28,7 +29,7 @@ module Parser
       # @api private
       #
       ENCODING_RE =
-        /\#.*coding\s*[:=]\s*
+        /\A\#\s*(en)?coding\s*[:=]\s*
           (
             # Special-case: there's a UTF8-MAC encoding.
             (utf8-mac)
@@ -63,7 +64,7 @@ module Parser
         end
 
         if (result = ENCODING_RE.match(encoding_line))
-          Encoding.find(result[2] || result[3] || result[5])
+          Encoding.find(result[3] || result[4] || result[6])
         else
           nil
         end
@@ -156,13 +157,11 @@ module Parser
       # @return [String]
       #
       def source=(input)
-        if defined?(Encoding)
-          input = input.dup if input.frozen?
-          input = self.class.reencode_string(input)
+        input = input.dup if input.frozen?
+        input = self.class.reencode_string(input)
 
-          unless input.valid_encoding?
-            raise EncodingError, "invalid byte sequence in #{input.encoding.name}"
-          end
+        unless input.valid_encoding?
+          raise EncodingError, "invalid byte sequence in #{input.encoding.name}"
         end
 
         self.raw_source = input
@@ -182,8 +181,7 @@ module Parser
 
         @source = input.gsub("\r\n".freeze, "\n".freeze).freeze
 
-        if defined?(Encoding) &&
-           !@source.ascii_only? &&
+        if !@source.ascii_only? &&
            @source.encoding != Encoding::UTF_32LE &&
            @source.encoding != Encoding::BINARY
           @slice_source = @source.encode(Encoding::UTF_32LE)
@@ -246,7 +244,7 @@ module Parser
       def source_lines
         @lines ||= begin
           lines = @source.lines.to_a
-          lines << '' if @source.end_with?("\n".freeze)
+          lines << ''.dup if @source.end_with?("\n".freeze)
 
           lines.each do |line|
             line.chomp!("\n".freeze)
@@ -288,6 +286,13 @@ module Parser
         end
       end
 
+      ##
+      # @return [Range] A range covering the whole source
+      #
+      def source_range
+        @source_range ||= Range.new(self, 0, source.size)
+      end
+
       ##
       # Number of last line in the buffer
       #
@@ -312,19 +317,9 @@ module Parser
         @line_begins
       end
 
-      if [].respond_to?(:bsearch)
-        def line_for(position)
-          # Fast O(log n) variant for Ruby >=2.0.
-          line_begins.bsearch do |line, line_begin|
-            line_begin <= position
-          end
-        end
-      else
-        def line_for(position)
-          # Slower O(n) variant for Ruby <2.0.
-          line_begins.find do |line, line_begin|
-            line_begin <= position
-          end
+      def line_for(position)
+        line_begins.bsearch do |line, line_begin|
+          line_begin <= position
         end
       end
     end

data/lib/parser/source/comment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Parser
   module Source
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Parser
   module Source
 

data/lib/parser/source/map.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Parser
   module Source
 

data/lib/parser/source/map/collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Parser
   module Source
 

data/lib/parser/source/map/condition.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Parser
   module Source
 

data/lib/parser/source/map/constant.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Parser
   module Source
 

data/lib/parser/source/map/definition.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Parser
   module Source
 

data/lib/parser/source/map/for.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Parser
   module Source
 

data/lib/parser/source/map/heredoc.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Parser
   module Source
 

data/lib/parser/source/map/keyword.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Parser
   module Source
 

data/lib/parser/source/map/objc_kwarg.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Parser
   module Source
 

data/lib/parser/source/map/operator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Parser
   module Source
 

data/lib/parser/source/map/rescue_body.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Parser
   module Source
 

data/lib/parser/source/map/send.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Parser
   module Source
 

data/lib/parser/source/map/ternary.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Parser
   module Source
 

data/lib/parser/source/map/variable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Parser
   module Source
 

data/lib/parser/source/range.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Parser
   module Source
 
@@ -22,6 +24,8 @@ module Parser
     # @api public
     #
     class Range
+      include Comparable
+
       attr_reader :source_buffer
       attr_reader :begin_pos, :end_pos
 
@@ -49,7 +53,7 @@ module Parser
       #   of this range.
       #
       def begin
-        Range.new(@source_buffer, @begin_pos, @begin_pos)
+        with(end_pos: @begin_pos)
       end
 
       ##
@@ -57,7 +61,7 @@ module Parser
       #   of this range.
       #
       def end
-        Range.new(@source_buffer, @end_pos, @end_pos)
+        with(begin_pos: @end_pos)
       end
 
       ##
@@ -165,12 +169,30 @@ module Parser
         [@source_buffer.name, line, column + 1].join(':')
       end
 
+      ##
+      # @param [Hash] Endpoint(s) to change, any combination of :begin_pos or :end_pos
+      # @return [Range] the same range as this range but with the given end point(s) changed
+      # to the given value(s).
+      #
+      def with(begin_pos: @begin_pos, end_pos: @end_pos)
+        Range.new(@source_buffer, begin_pos, end_pos)
+      end
+
+      ##
+      # @param [Hash] Endpoint(s) to change, any combination of :begin_pos or :end_pos
+      # @return [Range] the same range as this range but with the given end point(s) adjusted
+      # by the given amount(s)
+      #
+      def adjust(begin_pos: 0, end_pos: 0)
+        Range.new(@source_buffer, @begin_pos + begin_pos, @end_pos + end_pos)
+      end
+
       ##
       # @param [Integer] new_size
       # @return [Range] a range beginning at the same point as this range and length `new_size`.
       #
       def resize(new_size)
-        Range.new(@source_buffer, @begin_pos, @begin_pos + new_size)
+        with(end_pos: @begin_pos + new_size)
       end
 
       ##
@@ -197,19 +219,66 @@ module Parser
       end
 
       ##
+      # Return `true` iff this range and `other` are disjoint.
+      #
+      # Two ranges must be one and only one of ==, disjoint?, contains?, contained? or crossing?
+      #
       # @param [Range] other
-      # @return [Boolean] `true` if this range and `other` do not overlap
+      # @return [Boolean]
       #
       def disjoint?(other)
-        @begin_pos >= other.end_pos || other.begin_pos >= @end_pos
+        if empty? && other.empty?
+          @begin_pos != other.begin_pos
+        else
+          @begin_pos >= other.end_pos || other.begin_pos >= @end_pos
+        end
       end
 
       ##
+      # Return `true` iff this range is not disjoint from `other`.
+      #
       # @param [Range] other
       # @return [Boolean] `true` if this range and `other` overlap
       #
       def overlaps?(other)
-        @begin_pos < other.end_pos && other.begin_pos < @end_pos
+        !disjoint?(other)
+      end
+
+      ##
+      # Returns true iff this range contains (strictly) `other`.
+      #
+      # Two ranges must be one and only one of ==, disjoint?, contains?, contained? or crossing?
+      #
+      # @param [Range] other
+      # @return [Boolean]
+      #
+      def contains?(other)
+        (other.begin_pos <=> @begin_pos) + (@end_pos <=> other.end_pos) >= (other.empty? ? 2 : 1)
+      end
+
+      ##
+      # Return `other.contains?(self)`
+      #
+      # Two ranges must be one and only one of ==, disjoint?, contains?, contained? or crossing?
+      #
+      # @param [Range] other
+      # @return [Boolean]
+      #
+      def contained?(other)
+        other.contains?(self)
+      end
+
+      ##
+      # Returns true iff both ranges intersect and also have different elements from one another.
+      #
+      # Two ranges must be one and only one of ==, disjoint?, contains?, contained? or crossing?
+      #
+      # @param [Range] other
+      # @return [Boolean]
+      #
+      def crossing?(other)
+        return false unless overlaps?(other)
+        (@begin_pos <=> other.begin_pos) * (@end_pos <=> other.end_pos) == 1
       end
 
       ##
@@ -220,14 +289,13 @@ module Parser
       end
 
       ##
-      # Compares ranges.
-      # @return [Boolean]
+      # Compare ranges, first by begin_pos, then by end_pos.
       #
-      def ==(other)
-        other.is_a?(Range) &&
-          @source_buffer == other.source_buffer &&
-          @begin_pos     == other.begin_pos     &&
-          @end_pos       == other.end_pos
+      def <=>(other)
+        return nil unless other.is_a?(::Parser::Source::Range) &&
+          @source_buffer == other.source_buffer
+        (@begin_pos <=> other.begin_pos).nonzero? ||
+        (@end_pos <=> other.end_pos)
       end
 
       ##

data/lib/parser/source/rewriter.rb

@@ -1,18 +1,23 @@
+# frozen_string_literal: true
+
 module Parser
   module Source
 
     ##
-    # {Rewriter} performs the heavy lifting in the source rewriting process.
-    # It schedules code updates to be performed in the correct order and
-    # verifies that no two updates _clobber_ each other, that is, attempt to
-    # modify the same section of code. (However, if two updates modify the
-    # same section in exactly the same way, they are merged.)
+    # {Rewriter} is deprecated. Use {TreeRewriter} instead.
     #
-    # If it is detected that one update clobbers another one, an `:error` and
-    # a `:note` diagnostics describing both updates are generated and passed to
-    # the diagnostic engine. After that, an exception is raised.
+    # TreeRewriter has simplified semantics, and customizable policies
+    # with regards to clobbering. Please read the documentation.
     #
-    # The default diagnostic engine consumer simply prints the diagnostics to `stderr`.
+    # Keep in mind:
+    # - Rewriter was discarding the `end_pos` of the given range for `insert_before`,
+    #   and the `begin_pos` for `insert_after`. These are meaningful in TreeRewriter.
+    # - TreeRewriter's wrap/insert_before/insert_after are multiple by default, while
+    #   Rewriter would raise clobbering errors if the non '_multi' version was called.
+    # - The TreeRewriter policy closest to Rewriter's behavior is:
+    #       different_replacements: :raise,
+    #       swallowed_insertions: :raise,
+    #       overlapping_deletions: :accept
     #
     # @!attribute [r] source_buffer
     #  @return [Source::Buffer]
@@ -21,6 +26,7 @@ module Parser
     #  @return [Diagnostic::Engine]
     #
     # @api public
+    # @deprecated Use {TreeRewriter}
     #
     class Rewriter
       attr_reader :source_buffer
@@ -28,8 +34,10 @@ module Parser
 
       ##
       # @param [Source::Buffer] source_buffer
+      # @deprecated Use {TreeRewriter}
       #
       def initialize(source_buffer)
+        self.class.warn_of_deprecation
         @diagnostics = Diagnostic::Engine.new
         @diagnostics.consumer = lambda do |diag|
           $stderr.puts diag.render
@@ -54,6 +62,7 @@ module Parser
       # @param [Range] range
       # @return [Rewriter] self
       # @raise [ClobberingError] when clobbering is detected
+      # @deprecated Use {TreeRewriter#remove}
       #
       def remove(range)
         append Rewriter::Action.new(range, ''.freeze)
@@ -66,11 +75,27 @@ module Parser
       # @param [String] content
       # @return [Rewriter] self
       # @raise [ClobberingError] when clobbering is detected
+      # @deprecated Use {TreeRewriter#insert_before}
       #
       def insert_before(range, content)
         append Rewriter::Action.new(range.begin, content)
       end
 
+      ##
+      # Inserts new code before and after the given source range.
+      #
+      # @param [Range] range
+      # @param [String] before
+      # @param [String] after
+      # @return [Rewriter] self
+      # @raise [ClobberingError] when clobbering is detected
+      # @deprecated Use {TreeRewriter#wrap}
+      #
+      def wrap(range, before, after)
+        append Rewriter::Action.new(range.begin, before)
+        append Rewriter::Action.new(range.end, after)
+      end
+
       ##
       # Inserts new code before the given source range by allowing other
       # insertions at the same position.
@@ -87,6 +112,7 @@ module Parser
       # @param [String] content
       # @return [Rewriter] self
       # @raise [ClobberingError] when clobbering is detected
+      # @deprecated Use {TreeRewriter#insert_before}
       #
       def insert_before_multi(range, content)
         @insert_before_multi_order -= 1
@@ -100,6 +126,7 @@ module Parser
       # @param [String] content
       # @return [Rewriter] self
       # @raise [ClobberingError] when clobbering is detected
+      # @deprecated Use {TreeRewriter#insert_after}
       #
       def insert_after(range, content)
         append Rewriter::Action.new(range.end, content)
@@ -121,6 +148,7 @@ module Parser
       # @param [String] content
       # @return [Rewriter] self
       # @raise [ClobberingError] when clobbering is detected
+      # @deprecated Use {TreeRewriter#insert_after}
       #
       def insert_after_multi(range, content)
         @insert_after_multi_order += 1
@@ -134,6 +162,7 @@ module Parser
       # @param [String] content
       # @return [Rewriter] self
       # @raise [ClobberingError] when clobbering is detected
+      # @deprecated Use {TreeRewriter#replace}
       #
       def replace(range, content)
         append Rewriter::Action.new(range, content)
@@ -144,6 +173,7 @@ module Parser
       # modified source as a new string.
       #
       # @return [String]
+      # @deprecated Use {TreeRewriter#process}
       #
       def process
         if in_transaction?
@@ -181,6 +211,7 @@ module Parser
       #
       # @raise [RuntimeError] when no block is passed
       # @raise [RuntimeError] when already in a transaction
+      # @deprecated Use {TreeRewriter#transaction}
       #
       def transaction
         unless block_given?
@@ -392,7 +423,7 @@ module Parser
       end
 
       def merge_replacements(actions)
-        result    = ''
+        result    = ''.dup
         prev_act  = nil
 
         actions.each do |act|
@@ -469,6 +500,13 @@ module Parser
       def adjacent?(range1, range2)
         range1.begin_pos <= range2.end_pos && range2.begin_pos <= range1.end_pos
       end
+
+      DEPRECATION_WARNING = [
+        'Parser::Source::Rewriter is deprecated.',
+        'Please update your code to use Parser::Source::TreeRewriter instead'
+      ].join("\n").freeze
+
+      extend Deprecation
     end
 
   end