node_mutation 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 181790d29f44cf36742b7666a2b687c0befdd6ff70e30f21a3edcaf6c05ba2d6
-  data.tar.gz: 898ee69b167c2b6b12b2c3ddb196514deac6084c3b3066e7e634c5b9876dc0a8
+  metadata.gz: c27aac4f89bdddee8f7298469d2f26ad17f38c8ed6eb4e76bf4d7af0ea729f98
+  data.tar.gz: da1d0b9a9b830890583d88b0b74cca800eb991c4eb86e9b232eabd75678538b0
 SHA512:
-  metadata.gz: 0ad795cc5d87cb7e37d225d503946bb7afcd49a04de356306d3d9424845d98a7223812fc35f38122e954b38b9a446523d05033186ba312a4bccfc8492c131f83
-  data.tar.gz: 1dff8c627b676e4e3b7d333229abb1e1a5eb92871089a9b23c2ee96e872bd47121928d9e6e3b56e7b47b0d97c9bac7104c06991d42c2e414eb7d149c12042203
+  metadata.gz: 12d58838fec06d87e0ffad8fce9a1879221726fa57cf15e0e3c4d08541d7a7ef0fff0249601814edc9bad95e73cc5eac46a9f91a55816fee8c3773b0e397b74e
+  data.tar.gz: '02870efef507899a92a021a8532c175c0ba230815f76eba8391421b97cd628697a035b31bd17110564aa1c273f78db795a7f1a9d775742917abce56ee703efee'

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # NodeMutation
 
+## 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

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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    node_mutation (1.1.0)
+    node_mutation (1.2.0)
       activesupport
       erubis
 
@@ -18,7 +18,6 @@ GEM
     concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
     erubis (2.7.0)
-    fakefs (1.8.0)
     ffi (1.15.5)
     formatador (1.1.0)
     guard (2.18.0)
@@ -84,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)
+mutation = NodeMutation.new(source)
 ```
 
 2. call the rewrite apis:
@@ -45,8 +45,6 @@ mutation.prepend node, '{{arguments.first}}.include FactoryGirl::Syntax::Methods
 mutation.remove(node: Node)
 # replace child node of the ast node with new code
 mutation.replace node, :message, with: 'test'
-# replace erb stmt node with expr code
-replace_erb_stmt_with_expr node
 # replace the ast node with new code
 mutation.replace_with node, 'create {{arguments}}'
 # wrap node within a block, class or module
@@ -56,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/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.1.0"
+  VERSION = "1.2.0"
 end

data/lib/node_mutation.rb

@@ -22,10 +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 :Engine, 'node_mutation/engine'
+  autoload :Result, 'node_mutation/result'
 
   attr_reader :actions
 
@@ -55,9 +54,9 @@ class NodeMutation
   end
 
   # Initialize a NodeMutation.
-  # @param file_path [String] file path
-  def initialize(file_path)
-    @file_path = file_path
+  # @param source [String] file source
+  def initialize(source)
+    @source = source
     @actions = []
   end
 
@@ -176,21 +175,6 @@ class NodeMutation
     @actions << ReplaceAction.new(node, *selectors, with: with).process
   end
 
-  # Replace erb stmt node with expr code.
-  # @param node [Node] ast node
-  # @example
-  # source code of the ast node is
-  #     <% form_for post do |f| %>
-  #     <% end %>
-  # then we call
-  #     replace_erb_stmt_with_expr(node)
-  # the source code will be rewritten to
-  #   # <%= form_for post do |f| %>
-  #   # <% end %>
-  def replace_erb_stmt_with_expr(node)
-    @actions << ReplaceErbStmtWithExprAction.new(node).process
-  end
-
   # Replace source code of the ast node with new code.
   # @param node [Node] ast node
   # @param code [String] code need to be replaced with.
@@ -233,43 +217,29 @@ class NodeMutation
   # if strategy is set to KEEP_RUNNING.
   # @return {{conflict: Boolean}} if actions are conflicted
   def process
-    conflict_actions = []
-    if @actions.length > 0
-      source = +read_source(@file_path)
-      @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
 
-      write_source(@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
-    OpenStruct.new(conflict: !conflict_actions.empty?)
+    @actions.reverse_each do |action|
+      source[action.start...action.end] = action.new_code
+    end
+    NodeMutation::Result.new(
+      affected: true,
+      conflicted: !conflict_actions.empty?,
+      new_source: source
+    )
   end
 
   private
 
-  # Read file source.
-  # @param file_path [String] file path
-  # @return [String] file source
-  def read_source(file_path)
-    source = File.read(file_path, encoding: 'UTF-8')
-    source = Engine::Erb.encode(source) if /\.erb$/.match?(file_path)
-    source
-  end
-
-  # Write file source to file.
-  # @param file_path [String] file path
-  # @param source [String] file source
-  def write_source(file_path, source)
-    source = Engine::ERB.decode(source) if /\.erb/.match?(file_path)
-    File.write(file_path, source.gsub(/ +\n/, "\n"))
-  end
-
   # It changes source code from bottom to top, and it can change source code twice at the same time,
   # So if there is an overlap between two actions, it removes the conflict actions and operate them in the next loop.
   def get_conflict_actions

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

@@ -19,7 +19,7 @@ module NodeMutation[T]
 
   def self.strategry: () -> Integer
 
-  def initialize: (file_path: String) -> NodeMutation
+  def initialize: (source: String) -> NodeMutation
 
   def append: (node: T, code: String) -> void
 
@@ -35,11 +35,9 @@ module NodeMutation[T]
 
   def replace: (node: T, *selectors: Array[String], with: String) -> void
 
-  def replace_erb_stmt_with_expr: (node: T) -> void
-
   def replace_with: (node: T, code: String) -> void
 
   def wrap: (node: T, with: String) -> void
 
-  def process: () -> void
+  def process: () -> NodeMutation::Result
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: node_mutation
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Richard Huang
@@ -62,17 +62,18 @@ files:
 - lib/node_mutation/action/prepend_action.rb
 - lib/node_mutation/action/remove_action.rb
 - lib/node_mutation/action/replace_action.rb
-- lib/node_mutation/action/replace_erb_stmt_with_expr_action.rb
 - 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:

data/lib/node_mutation/action/replace_erb_stmt_with_expr_action.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-# ReplaceErbStmtWithExprAction to replace erb stmt code to expr,
-# @example
-#   e.g. <% form_for ... %> => <%= form_for ... %>.
-class NodeMutation::ReplaceErbStmtWithExprAction < NodeMutation::Action
-  # Initialize a ReplaceErbStmtWithExprAction.
-  #
-  # @param node [Synvert::Core::Rewriter::Node]
-  def initialize(node)
-    super(node, nil)
-  end
-
-  # The new erb expr code.
-  #
-  # @return [String] new code.
-  def new_code
-    NodeMutation.adapter.file_content(@node)[@start...@end]
-      .sub(NodeMutation::Engine::ERUBY_STMT_SPLITTER, '@output_buffer.append= ')
-      .sub(NodeMutation::Engine::ERUBY_STMT_SPLITTER, NodeMutation::Engine::ERUBY_EXPR_SPLITTER)
-  end
-
-  private
-
-  # Calculate the begin the end positions.
-  def calculate_position
-    node_start = NodeMutation.adapter.get_start(@node)
-    node_source = NodeMutation.adapter.get_source(@node)
-    file_content = NodeMutation.adapter.file_content(@node)
-
-    whitespace_index = node_start
-    while file_content[whitespace_index -= 1] == ' '
-    end
-    @start = whitespace_index - NodeMutation::Engine::ERUBY_STMT_SPLITTER.length + 1
-
-    at_index = node_start + node_source.index('do')
-    while file_content[at_index += 1] != '@'
-    end
-    @end = at_index
-  end
-end