parser 1.2.0 → 1.3.0

data/lib/parser/source/rewriter.rb

@@ -0,0 +1,89 @@
+module Parser
+  module Source
+
+    class Rewriter
+      attr_accessor :diagnostics
+
+      def initialize(source_buffer)
+        @diagnostics = Diagnostic::Engine.new
+        @diagnostics.consumer = lambda do |diag|
+          $stderr.puts diag.render
+        end
+
+        @source_buffer = source_buffer
+        @queue         = []
+        @clobber       = 0
+      end
+
+      def remove(range)
+        append Rewriter::Action.new(range, "")
+      end
+
+      def insert_before(range, content)
+        append Rewriter::Action.new(range.begin, content)
+      end
+
+      def insert_after(range, content)
+        append Rewriter::Action.new(range.end, content)
+      end
+
+      def replace(range, content)
+        append Rewriter::Action.new(range, content)
+      end
+
+      def process
+        adjustment = 0
+        source     = @source_buffer.source.dup
+
+        @queue.sort_by { |action| action.range.begin_pos }.
+               each do |action|
+          begin_pos = action.range.begin_pos + adjustment
+          end_pos   = begin_pos + action.range.length
+
+          source[begin_pos...end_pos] = action.replacement
+
+          adjustment += (action.replacement.length - action.range.length)
+        end
+
+        source
+      end
+
+      private
+
+      def append(action)
+        if (clobber_action = clobbered?(action.range))
+          # cannot replace 3 characters with "foobar"
+          diagnostic = Diagnostic.new(:error,
+                                      "cannot #{action}",
+                                      action.range)
+          @diagnostics.process(diagnostic)
+
+          # clobbered by: remove 3 characters
+          diagnostic = Diagnostic.new(:note,
+                                      "clobbered by: #{clobber_action}",
+                                      clobber_action.range)
+          @diagnostics.process(diagnostic)
+        else
+          clobber(action.range)
+
+          @queue << action
+        end
+
+        self
+      end
+
+      def clobber(range)
+        @clobber |= (2 ** range.size - 1) << range.begin_pos
+      end
+
+      def clobbered?(range)
+        if @clobber & ((2 ** range.size - 1) << range.begin_pos) != 0
+          @queue.find do |action|
+            action.range.to_a & range.to_a
+          end
+        end
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,27 @@
+module Parser
+  module Source
+
+    class Rewriter::Action
+      attr_reader :range, :replacement
+
+      def initialize(range, replacement="")
+        @range, @replacement = range, replacement
+
+        freeze
+      end
+
+      def to_s
+        if @range.length == 0 && @replacement.empty?
+          "do nothing"
+        elsif @range.length == 0
+          "insert #{@replacement.inspect}"
+        elsif @replacement.empty?
+          "remove #{@range.length} character(s)"
+        else
+          "replace #{@range.length} character(s) with #{@replacement.inspect}"
+        end
+      end
+    end
+
+  end
+end

data/lib/parser/version.rb

@@ -1,3 +1,3 @@
 module Parser
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/parser.gemspec

@@ -35,4 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'json_pure' # for coveralls on 1.9.2
 
   spec.add_development_dependency 'simplecov-sublime-ruby-coverage'
+
+  spec.add_development_dependency 'github-markup'
+  spec.add_development_dependency 'yard'
 end

data/test/parse_helper.rb

@@ -175,7 +175,7 @@ module ParseHelper
 
       if (match = SOURCE_MAP_DESCRIPTION_RE.match(line))
         begin_pos        = match[1].length
-        end_pos          = begin_pos + match[2].length - 1
+        end_pos          = begin_pos + match[2].length
         source_map_field = match[3]
 
         if match[5]

data/test/test_diagnostic.rb

@@ -5,8 +5,8 @@ class TestDiagnostic < MiniTest::Unit::TestCase
     @buffer = Parser::Source::Buffer.new('(string)')
     @buffer.source = "if (this is some bad code + bugs)"
 
-    @range1 = Parser::Source::Range.new(@buffer, 0, 1) # if
-    @range2 = Parser::Source::Range.new(@buffer, 4, 7) # this
+    @range1 = Parser::Source::Range.new(@buffer, 0, 2) # if
+    @range2 = Parser::Source::Range.new(@buffer, 4, 8) # this
   end
 
   def test_verifies_levels
@@ -29,11 +29,11 @@ class TestDiagnostic < MiniTest::Unit::TestCase
   end
 
   def test_render
-    location = Parser::Source::Range.new(@buffer, 26, 26)
+    location = Parser::Source::Range.new(@buffer, 26, 27)
 
     highlights = [
-      Parser::Source::Range.new(@buffer, 21, 24),
-      Parser::Source::Range.new(@buffer, 28, 31)
+      Parser::Source::Range.new(@buffer, 21, 25),
+      Parser::Source::Range.new(@buffer, 28, 32)
     ]
 
     diag  = Parser::Diagnostic.new(:error, "code far too bad",

data/test/test_parse_helper.rb

@@ -25,29 +25,29 @@ class TestParseHelper < MiniTest::Unit::TestCase
   end
 
   def test_parse_mapsation_description
-    assert_equal [[0, 3, 'expr', [], '~~~~ expr']],
+    assert_equal [[0, 4, 'expr', [], '~~~~ expr']],
                  parse_maps('~~~~ expr')
 
-    assert_equal [[0, 3, 'expr', [], '^~~~ expr']],
+    assert_equal [[0, 4, 'expr', [], '^~~~ expr']],
                  parse_maps('^~~~ expr')
 
-    assert_equal [[0, 3, 'expr', [], '^^^^ expr']],
+    assert_equal [[0, 4, 'expr', [], '^^^^ expr']],
                  parse_maps('^^^^ expr')
 
-    assert_equal [[2, 2, 'op', [], '  ^ op']],
+    assert_equal [[2, 3, 'op', [], '  ^ op']],
                  parse_maps('  ^ op')
 
-    assert_equal [[2, 2, 'op', ['foo'], '  ~ op (foo)']],
+    assert_equal [[2, 3, 'op', ['foo'], '  ~ op (foo)']],
                  parse_maps('  ~ op (foo)')
 
-    assert_equal [[2, 3, 'op', ['foo', 'bar'], '  ~~ op (foo.bar)']],
+    assert_equal [[2, 4, 'op', ['foo', 'bar'], '  ~~ op (foo.bar)']],
                  parse_maps('  ~~ op (foo.bar)')
 
-    assert_equal [[2, 3, 'op', ['foo/2', 'bar'], '  ~~ op (foo/2.bar)']],
+    assert_equal [[2, 4, 'op', ['foo/2', 'bar'], '  ~~ op (foo/2.bar)']],
                  parse_maps('  ~~ op (foo/2.bar)')
 
-    assert_equal [[0, 3, 'expr', [], '~~~~ expr'],
-                  [5, 6, 'op', ['str', 'e_h'], '     ~~ op (str.e_h)']],
+    assert_equal [[0, 4, 'expr', [], '~~~~ expr'],
+                  [5, 7, 'op', ['str', 'e_h'], '     ~~ op (str.e_h)']],
                  parse_maps(%{
                             |~~~~ expr
                             |     ~~ op (str.e_h)

data/test/test_source_range.rb

@@ -14,7 +14,7 @@ class TestSourceRange < MiniTest::Unit::TestCase
   end
 
   def test_size
-    sr = Parser::Source::Range.new(@sfile, 1, 2)
+    sr = Parser::Source::Range.new(@sfile, 1, 3)
     assert_equal 2, sr.size
   end
 
@@ -41,7 +41,7 @@ class TestSourceRange < MiniTest::Unit::TestCase
     sr = Parser::Source::Range.new(@sfile, 7, 8)
     assert_equal 0, sr.begin.column
     assert_equal 1, sr.end.column
-    assert_equal 0..1, sr.column_range
+    assert_equal 0...1, sr.column_range
   end
 
   def test_begin_end

data/test/test_source_rewriter.rb

@@ -0,0 +1,81 @@
+require 'helper'
+
+class TestSourceRewriter < MiniTest::Unit::TestCase
+  def setup
+    @buf = Parser::Source::Buffer.new('(rewriter)')
+    @buf.source = 'foo bar baz'
+
+    @rewriter = Parser::Source::Rewriter.new(@buf)
+  end
+
+  def range(from, len)
+    Parser::Source::Range.new(@buf, from, from + len)
+  end
+
+  def test_remove
+    assert_equal 'foo  baz',
+                 @rewriter.
+                    remove(range(4, 3)).
+                    process
+  end
+
+  def test_insert_before
+    assert_equal 'foo quux bar baz',
+                 @rewriter.
+                    insert_before(range(4, 3), 'quux ').
+                    process
+  end
+
+  def test_insert_after
+    assert_equal 'foo bar quux baz',
+                 @rewriter.
+                    insert_after(range(4, 3), ' quux').
+                    process
+  end
+
+  def test_replace
+    assert_equal 'foo quux baz',
+                 @rewriter.
+                    replace(range(4, 3), 'quux').
+                    process
+  end
+
+  def test_composing_asc
+    assert_equal 'foo---bar---baz',
+                 @rewriter.
+                    replace(range(3, 1), '---').
+                    replace(range(7, 1), '---').
+                    process
+  end
+
+  def test_composing_desc
+    assert_equal 'foo---bar---baz',
+                 @rewriter.
+                    replace(range(7, 1), '---').
+                    replace(range(3, 1), '---').
+                    process
+  end
+
+  def test_clobber
+    diagnostics = []
+    @rewriter.diagnostics.consumer = lambda do |diag|
+      diagnostics << diag
+    end
+
+    @rewriter.
+      replace(range(3, 1), '---').
+      remove(range(3, 1))
+
+    assert_equal 2, diagnostics.count
+
+    assert_equal :error, diagnostics.first.level
+    assert_equal "cannot remove 1 character(s)",
+                 diagnostics.first.message
+    assert_equal range(3, 1), diagnostics.first.location
+
+    assert_equal :note, diagnostics.last.level
+    assert_equal "clobbered by: replace 1 character(s) with \"---\"",
+                 diagnostics.last.message
+    assert_equal range(3, 1), diagnostics.last.location
+  end
+end

data/test/test_source_rewriter_action.rb

@@ -0,0 +1,44 @@
+require 'helper'
+
+class TestSourceRewriterAction < MiniTest::Unit::TestCase
+  def setup
+    @buf = Parser::Source::Buffer.new('(rewriter_action)')
+    @buf.source = 'foo bar baz'
+  end
+
+  def range(from, len)
+    Parser::Source::Range.new(@buf, from, from + len)
+  end
+
+  def action(range, replacement)
+    Parser::Source::Rewriter::Action.new(range, replacement)
+  end
+
+  def test_accessors
+    action = action(range(1, 10), "foo")
+
+    assert action.frozen?
+    assert_equal range(1, 10), action.range
+    assert_equal "foo",        action.replacement
+  end
+
+  def test_to_s_replace
+    action = action(range(3, 1), "foo")
+    assert_equal "replace 1 character(s) with \"foo\"", action.to_s
+  end
+
+  def test_to_s_insert
+    action = action(range(3, 0), "foo")
+    assert_equal "insert \"foo\"", action.to_s
+  end
+
+  def test_to_s_remove
+    action = action(range(3, 2), "")
+    assert_equal "remove 2 character(s)", action.to_s
+  end
+
+  def test_to_s_nop
+    action = action(range(3, 0), "")
+    assert_equal "do nothing", action.to_s
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parser
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Peter Zotov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-25 00:00:00.000000000 Z
+date: 2013-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ast
@@ -150,6 +150,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Ruby parser written in pure Ruby.
 email:
 - whitequark@whitequark.org
@@ -160,7 +188,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .jrubyrc
 - .travis.yml
+- .yardopts
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -185,6 +215,7 @@ files:
 - lib/parser/lexer/explanation.rb
 - lib/parser/lexer/literal.rb
 - lib/parser/lexer/stack_state.rb
+- lib/parser/rewriter.rb
 - lib/parser/ruby18.y
 - lib/parser/ruby19.y
 - lib/parser/ruby20.y
@@ -207,6 +238,8 @@ files:
 - lib/parser/source/map/ternary.rb
 - lib/parser/source/map/variable.rb
 - lib/parser/source/range.rb
+- lib/parser/source/rewriter.rb
+- lib/parser/source/rewriter/action.rb
 - lib/parser/static_environment.rb
 - lib/parser/syntax_error.rb
 - lib/parser/version.rb
@@ -224,6 +257,8 @@ files:
 - test/test_parser.rb
 - test/test_source_buffer.rb
 - test/test_source_range.rb
+- test/test_source_rewriter.rb
+- test/test_source_rewriter_action.rb
 - test/test_static_environment.rb
 - lib/parser/lexer.rb
 - lib/parser/ruby18.rb
@@ -268,4 +303,7 @@ test_files:
 - test/test_parser.rb
 - test/test_source_buffer.rb
 - test/test_source_range.rb
+- test/test_source_rewriter.rb
+- test/test_source_rewriter_action.rb
 - test/test_static_environment.rb
+has_rdoc: