node_mutation 1.0.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f708082625b70a33be17a520d51fab328979f7640f6125f7cec8a4f8c0fa348c
-  data.tar.gz: 71219747c6be37cb7282658c5dc6087f33ac63ed195de48ab29f2aa79347ea85
+  metadata.gz: 16d1f6952b16d815e9cee50df011c99075ffd17bc17531efc8b6a99c39909d4a
+  data.tar.gz: 3f558c1b9e171310775fec6ccdb3a1fe0321aa0ce94b23ec8c861e3ae496dd31
 SHA512:
-  metadata.gz: 74f6fdb99bec0cd69ae0310ebc728661981ab7e7c41624e2409238426095cfec7576f1905d49f7e9d25393723b9c43dbe6ebf9c72730df38a19308e68682fc49
-  data.tar.gz: d2323af8c25e3a69779848be92594075970eb3c22b6c26fc411bc95710f51c9d37881a32c4196b3330eb28544d05dcbf72ef45521bce2e61025ea1ab5681eaae
+  metadata.gz: 7221a70883e380a9f88dda96db69890349dde212580f63fac75d02a71bb558587d4ccf7e6b33547b0b44846ee493fd7ed924e13eb7cc414b27979c3fb354876e
+  data.tar.gz: 7d1cc7ab27508b202589d22bd6affc07345d19ad12701b7a3aea2d9bc06125a43e17870f787a539a16faaf1ed7db14a13c28b4b8a46d0afaa3b1d2fe701c4ef8

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # NodeMutation
 
+## 1.2.1 (2022-07-22)
+
+* Fix `child_node_range` for const name
+* Update `parser_node_ext` to 0.4.0
+
+## 1.2.0 (2022-07-02)
+
+* Return new source instead of writing file
+* Revert Add erb engine
+* Revert Add `ReplaceErbStmtWithExprAction`
+
+## 1.1.0 (2022-07-02)
+
+* Add erb engine
+* Add `ReplaceErbStmtWithExprAction`
+
 ## 1.0.0 (2022-07-01)
 
 * Initial release

data/Gemfile

@@ -13,5 +13,4 @@ gem "parser"
 gem "parser_node_ext"
 gem "guard"
 gem "guard-rspec"
-gem "fakefs", require: 'fakefs/safe'
 gem "pp"

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    node_mutation (1.0.0)
+    node_mutation (1.2.1)
       activesupport
+      erubis
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.3)
+    activesupport (7.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -16,7 +17,7 @@ GEM
     coderay (1.1.3)
     concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
-    fakefs (1.8.0)
+    erubis (2.7.0)
     ffi (1.15.5)
     formatador (1.1.0)
     guard (2.18.0)
@@ -33,21 +34,21 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    i18n (1.10.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.8)
     method_source (1.0.0)
-    minitest (5.16.1)
+    minitest (5.16.2)
     nenv (0.3.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
     parser (3.1.2.0)
       ast (~> 2.4.1)
-    parser_node_ext (0.2.0)
+    parser_node_ext (0.4.0)
       parser
     pp (0.3.0)
       prettyprint
@@ -74,7 +75,7 @@ GEM
     rspec-support (3.11.0)
     shellany (0.0.1)
     thor (1.2.1)
-    tzinfo (2.0.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
 
 PLATFORMS
@@ -82,7 +83,6 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  fakefs
   guard
   guard-rspec
   node_mutation!

data/README.md

@@ -25,7 +25,7 @@ Or install it yourself as:
 ```ruby
 require 'node_mutation'
 
-mutation = NodeMutation.new(file_path, source)
+mutation = NodeMutation.new(source)
 ```
 
 2. call the rewrite apis:
@@ -54,7 +54,13 @@ mutation.wrap node, with: 'module Foo'
 3. process actions and write the new source code to file:
 
 ```ruby
-mutation.process
+result = mutation.process
+# if it makes any change to the source
+result.affected?
+# if any action is conflicted
+result.conflicted
+# return the new source if it is affected
+result.new_source
 ```
 
 ## Write Adapter

data/lib/node_mutation/action/wrap_action.rb

@@ -2,7 +2,7 @@
 
 # WrapAction to wrap node within a block, class or module.
 #
-# Note: if WrapAction is conflicted with another action (begin_pos and end_pos are overlapped),
+# Note: if WrapAction is conflicted with another action (start and end are overlapped),
 # we have to put those 2 actions into 2 within_file scopes.
 class NodeMutation::WrapAction < NodeMutation::Action
   # Initialize a WrapAction.

data/lib/node_mutation/action.rb

@@ -70,7 +70,7 @@ class NodeMutation::Action
     after_line_is_blank = lines[end_line] == ''
 
     if lines.length > 1 && before_line_is_blank && after_line_is_blank
-      @end_pos += "\n".length
+      @end += "\n".length
     end
   end
 

data/lib/node_mutation/engine/erb.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require 'erubis'
+
+module NodeMutation::Engine
+  ERUBY_EXPR_SPLITTER = ';  ;'
+  ERUBY_STMT_SPLITTER = ';   ;'
+
+  class Erb
+    class << self
+      # convert erb to ruby code.
+      #
+      # @param source [String] erb source code.
+      # @return [String] ruby source code.
+      def encode(source)
+        Erubis.new(source.gsub('-%>', '%>'), escape: false, trim: false).src
+      end
+
+      # convert ruby code to erb.
+      #
+      # @param source [String] ruby source code.
+      # @return [String] erb source code.
+      def decode(source)
+        source = decode_ruby_stmt(source)
+        source = decode_ruby_output(source)
+        source = decode_html_output(source)
+        source = remove_erubis_buf(source)
+      end
+
+      private
+
+      def decode_ruby_stmt(source)
+        source.gsub(/#{ERUBY_STMT_SPLITTER}(.+?)#{ERUBY_STMT_SPLITTER}/mo) { "<%#{Regexp.last_match(1)}%>" }
+      end
+
+      def decode_ruby_output(source)
+        source.gsub(/@output_buffer.append=\((.+?)\);#{ERUBY_EXPR_SPLITTER}/mo) {
+          "<%=#{Regexp.last_match(1)}%>"
+        }.gsub(/@output_buffer.append= (.+?)\s+(do|\{)(\s*\|[^|]*\|)?\s*#{ERUBY_EXPR_SPLITTER}/mo) { |m|
+          "<%=#{m.sub('@output_buffer.append= ', '').sub(ERUBY_EXPR_SPLITTER, '')}%>"
+        }
+      end
+
+      def decode_html_output(source)
+        source.gsub(/@output_buffer.safe_append='(.+?)'.freeze;/m) { reverse_escape_text(Regexp.last_match(1)) }
+              .gsub(
+                /@output_buffer.safe_append=\((.+?)\);#{ERUBY_EXPR_SPLITTER}/mo
+              ) { reverse_escape_text(Regexp.last_match(1)) }
+              .gsub(
+                /@output_buffer.safe_append=(.+?)\s+(do|\{)(\s*\|[^|]*\|)?\s*#{ERUBY_EXPR_SPLITTER}/mo
+              ) { reverse_escape_text(Regexp.last_match(1)) }
+      end
+
+      def remove_erubis_buf(source)
+        source
+          .sub('@output_buffer = output_buffer || ActionView::OutputBuffer.new;', '')
+          .sub('@output_buffer.to_s', '')
+      end
+
+      def reverse_escape_text(source)
+        source.gsub("\\\\", "\\").gsub("\\'", "'")
+      end
+    end
+  end
+
+  # borrowed from rails
+  class Erubis < ::Erubis::Eruby
+    BLOCK_EXPR = /\s+(do|\{)(\s*\|[^|]*\|)?\s*\Z/
+    def add_preamble(src)
+      @newline_pending = 0
+      src << '@output_buffer = output_buffer || ActionView::OutputBuffer.new;'
+    end
+
+    def add_text(src, text)
+      return if text.empty?
+
+      if text == "\n"
+        @newline_pending += 1
+      else
+        src << "@output_buffer.safe_append='"
+        src << ("\n" * @newline_pending) if @newline_pending > 0
+        src << escape_text(text)
+        src << "'.freeze;"
+
+        @newline_pending = 0
+      end
+    end
+
+    # Erubis toggles <%= and <%== behavior when escaping is enabled.
+    # We override to always treat <%== as escaped.
+    def add_expr(src, code, indicator)
+      case indicator
+      when '=='
+        add_expr_escaped(src, code)
+      else
+        super
+      end
+    end
+
+    def add_expr_literal(src, code)
+      flush_newline_if_pending(src)
+      if BLOCK_EXPR.match?(code)
+        src << '@output_buffer.append= ' << code << ERUBY_EXPR_SPLITTER
+      else
+        src << '@output_buffer.append=(' << code << ');' << ERUBY_EXPR_SPLITTER
+      end
+    end
+
+    def add_expr_escaped(src, code)
+      flush_newline_if_pending(src)
+      if BLOCK_EXPR.match?(code)
+        src << '@output_buffer.safe_append= ' << code << ERUBY_EXPR_SPLITTER
+      else
+        src << '@output_buffer.safe_append=(' << code << ');' << ERUBY_EXPR_SPLITTER
+      end
+    end
+
+    def add_stmt(src, code)
+      flush_newline_if_pending(src)
+      if code != "\n" && code != ''
+        index =
+          case code
+          when /\A(\s*)\r?\n/
+            Regexp.last_match(1).length
+          when /\A(\s+)/
+            Regexp.last_match(1).end_with?(' ') ? Regexp.last_match(1).length - 1 : Regexp.last_match(1).length
+          else
+            0
+          end
+        code.insert(index, ERUBY_STMT_SPLITTER)
+        code.insert(-1, ERUBY_STMT_SPLITTER[0...-1])
+      end
+      super
+    end
+
+    def add_postamble(src)
+      flush_newline_if_pending(src)
+      src << '@output_buffer.to_s'
+    end
+
+    def flush_newline_if_pending(src)
+      if @newline_pending > 0
+        src << "@output_buffer.safe_append='#{"\n" * @newline_pending}'.freeze;"
+        @newline_pending = 0
+      end
+    end
+  end
+end

data/lib/node_mutation/engine.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module NodeMutation::Engine
+  # Engine defines how to encode / decode other files (like erb).
+  autoload :Erb, 'node_mutation/engine/erb'
+end

data/lib/node_mutation/parser_adapter.rb

@@ -77,7 +77,7 @@ class NodeMutation::ParserAdapter < NodeMutation::Adapter
         start: node.arguments.first.loc.expression.begin_pos,
         end: node.arguments.last.loc.expression.end_pos
       )
-    when %i[class name], %i[def name], %i[defs name]
+    when %i[class name], %i[const name], %i[def name], %i[defs name]
       OpenStruct.new(start: node.loc.name.begin_pos, end: node.loc.name.end_pos)
     when %i[defs dot]
       OpenStruct.new(start: node.loc.operator.begin_pos, end: node.loc.operator.end_pos) if node.loc.operator
@@ -171,4 +171,4 @@ class NodeMutation::ParserAdapter < NodeMutation::Adapter
       return child_node
     end
   end
-end
+end

data/lib/node_mutation/result.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class NodeMutation::Result
+  def initialize(options)
+    @options = options
+  end
+
+  def affected?
+    @options[:affected]
+  end
+
+  def conflicted?
+    @options[:conflicted]
+  end
+
+  def new_source
+    @options[:new_source]
+  end
+end

data/lib/node_mutation/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class NodeMutation
-  VERSION = "1.0.0"
+  VERSION = "1.2.1"
 end

data/lib/node_mutation.rb

@@ -9,7 +9,7 @@ class NodeMutation
   class MethodNotSupported < StandardError; end
   class ConflictActionError < StandardError; end
 
-  KEEPING_RUNNING = 1
+  KEEP_RUNNING = 1
   THROW_ERROR = 2
 
   autoload :Adapter, "node_mutation/adapter"
@@ -22,9 +22,9 @@ class NodeMutation
   autoload :RemoveAction, 'node_mutation/action/remove_action'
   autoload :PrependAction, 'node_mutation/action/prepend_action'
   autoload :ReplaceAction, 'node_mutation/action/replace_action'
-  autoload :ReplaceErbStmtWithExprAction, 'node_mutation/action/replace_erb_stmt_with_expr_action'
   autoload :ReplaceWithAction, 'node_mutation/action/replace_with_action'
   autoload :WrapAction, 'node_mutation/action/wrap_action'
+  autoload :Result, 'node_mutation/result'
 
   attr_reader :actions
 
@@ -47,18 +47,16 @@ class NodeMutation
   end
 
   # Get the strategy
-  # @return [Integer] current strategy, could be {NodeMutation::KEEPING_RUNNING} or {NodeMutation::THROW_ERROR},
-  # by default is {NodeMutation::KEEPING_RUNNING}
+  # @return [Integer] current strategy, could be {NodeMutation::KEEP_RUNNING} or {NodeMutation::THROW_ERROR},
+  # by default is {NodeMutation::KEEP_RUNNING}
   def self.strategy
     @strategy ||= KEEP_RUNNING
   end
 
   # Initialize a NodeMutation.
-  # @param file_path [String] file path
-  # @param source [String] source of the file
-  def initialize(file_path, source)
-    @file_path = file_path
-    @source = +source
+  # @param source [String] file source
+  def initialize(source)
+    @source = source
     @actions = []
   end
 
@@ -169,8 +167,8 @@ class NodeMutation
   # source code of the ast node is
   #     assert(object.empty?)
   # then we call
-  #     replace :message, with: 'assert_empty'
-  #     replace :arguments, with: '{{arguments.first.receiver}}'
+  #     mutation.replace(node, :message, with: 'assert_empty')
+  #     mutation.replace(node, :arguments, with: '{{arguments.first.receiver}}')
   # the source code will be rewritten to
   #     assert_empty(object)
   def replace(node, *selectors, with:)
@@ -219,21 +217,25 @@ class NodeMutation
   # if strategy is set to KEEP_RUNNING.
   # @return {{conflict: Boolean}} if actions are conflicted
   def process
-    conflict_actions = []
-    if @actions.length > 0
-      @actions.sort_by! { |action| [action.start, action.end] }
-      conflict_actions = get_conflict_actions
-      if conflict_actions.size > 0 && NodeMutation.strategy == THROW_ERROR
-        raise ConflictActionError, "mutation actions are conflicted"
-      end
-      @actions.reverse_each do |action|
-        @source[action.start...action.end] = action.new_code
-      end
-      @actions = []
+    if @actions.length == 0
+      return NodeMutation::Result.new(affected: false)
+    end
 
-      File.write(@file_path, @source)
+    conflict_actions = []
+    source = +@source
+    @actions.sort_by! { |action| [action.start, action.end] }
+    conflict_actions = get_conflict_actions
+    if conflict_actions.size > 0 && NodeMutation.strategy == THROW_ERROR
+      raise ConflictActionError, "mutation actions are conflicted"
+    end
+    @actions.reverse_each do |action|
+      source[action.start...action.end] = action.new_code
     end
-    OpenStruct.new(conflict: !conflict_actions.empty?)
+    NodeMutation::Result.new(
+      affected: true,
+      conflicted: !conflict_actions.empty?,
+      new_source: source
+    )
   end
 
   private

data/node_mutation.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   spec.add_dependency "activesupport"
+  spec.add_dependency "erubis"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

data/sig/node_mutation/result.rbs

@@ -0,0 +1,9 @@
+class NodeMutation::Result
+  def initialize: (source: String) -> NodeMutation::Result
+
+  def affected?: () -> bool
+
+  def conflicted?: () -> bool
+
+  def new_source: () -> String
+end

data/sig/node_mutation.rbs

@@ -7,7 +7,7 @@ module NodeMutation[T]
   class ConflictActionError < StandardError
   end
 
-  KEEPING_RUNNING: Integer
+  KEEP_RUNNING: Integer
 
   THROW_ERROR: Integer
 
@@ -19,7 +19,7 @@ module NodeMutation[T]
 
   def self.strategry: () -> Integer
 
-  def initialize: (file_path: String, source: String) -> NodeMutation
+  def initialize: (source: String) -> NodeMutation
 
   def append: (node: T, code: String) -> void
 
@@ -39,5 +39,5 @@ module NodeMutation[T]
 
   def wrap: (node: T, with: String) -> void
 
-  def process: () -> void
+  def process: () -> NodeMutation::Result
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: node_mutation
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-01 00:00:00.000000000 Z
+date: 2022-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ast node mutation apis
 email:
 - flyerhzm@gmail.com
@@ -51,11 +65,15 @@ files:
 - lib/node_mutation/action/replace_with_action.rb
 - lib/node_mutation/action/wrap_action.rb
 - lib/node_mutation/adapter.rb
+- lib/node_mutation/engine.rb
+- lib/node_mutation/engine/erb.rb
 - lib/node_mutation/parser_adapter.rb
+- lib/node_mutation/result.rb
 - lib/node_mutation/version.rb
 - node_mutation.gemspec
 - sig/node_mutation.rbs
 - sig/node_mutation/adapter.rbs
+- sig/node_mutation/result.rbs
 homepage: https://github.com/xinminlabs/node-mutation-ruby
 licenses: []
 metadata: