synvert-core 0.63.1 → 1.0.1

data/lib/synvert/core/rewriter/action/insert_action.rb

@@ -3,23 +3,32 @@
 module Synvert::Core
   # InsertAction to add code to the node.
   class Rewriter::InsertAction < Rewriter::Action
-    def initialize(instance, code, at:, to: nil)
+    # Initialize an InsertAction.
+    #
+    # @param instance [Synvert::Core::Rewriter::Instance]
+    # @param code [String] to be inserted
+    # @param at [String] position to insert, beginning or end
+    # @param to [<Symbol|String>] name of child node
+    def initialize(instance, code, at: 'end', to: nil)
       super(instance, code)
       @at = at
       @to = to
     end
 
-    def calculate_position
-      node_range = @to ? @node.child_node_range(@to) : @node.loc.expression
-      @begin_pos = @at == 'end' ? node_range.end_pos : node_range.begin_pos
-      @end_pos = @begin_pos
-    end
-
     # The rewritten source code.
     #
     # @return [String] rewritten code.
     def rewritten_code
       rewritten_source
     end
+
+    private
+
+    # Calculate the begin and end positions.
+    def calculate_position
+      node_range = @to ? @node.child_node_range(@to) : @node.loc.expression
+      @begin_pos = @at == 'end' ? node_range.end_pos : node_range.begin_pos
+      @end_pos = @begin_pos
+    end
   end
 end

data/lib/synvert/core/rewriter/action/insert_after_action.rb

@@ -3,13 +3,14 @@
 module Synvert::Core
   # InsertAfterAction to insert code next to the node.
   class Rewriter::InsertAfterAction < Rewriter::Action
+    private
+
+    # Calculate the begin and end positions.
     def calculate_position
       @begin_pos = @node.loc.expression.end_pos
       @end_pos = @begin_pos
     end
 
-    private
-
     # Indent of the node.
     #
     # @param node [Parser::AST::Node]

data/lib/synvert/core/rewriter/action/prepend_action.rb

@@ -3,8 +3,11 @@
 module Synvert::Core
   # PrependAction to prepend code to the top of node body.
   class Rewriter::PrependAction < Rewriter::Action
+    private
+
     DO_LENGTH = ' do'.length
 
+    # Calculate the begin and end positions.
     def calculate_position
       @begin_pos =
         case @node.type
@@ -26,8 +29,6 @@ module Synvert::Core
       @end_pos = @begin_pos
     end
 
-    private
-
     # Indent of the node.
     #
     # @param node [Parser::AST::Node]

data/lib/synvert/core/rewriter/action/remove_action.rb

@@ -3,13 +3,21 @@
 module Synvert::Core
   # RemoveAction to remove current node.
   class Rewriter::RemoveAction < Rewriter::Action
+    # Initialize a RemoveAction.
+    #
+    # @param instance [Synvert::Core::Rewriter::RemoveAction]
     def initialize(instance)
       super(instance, nil)
     end
 
-    # Begin position of code to replace.
-    #
-    # @return [Integer] begin position.
+    # The rewritten code, always empty string.
+    def rewritten_code
+      ''
+    end
+
+    private
+
+    # Calculate the begin the end positions.
     def calculate_position
       if take_whole_line?
         @begin_pos = start_index
@@ -23,22 +31,20 @@ module Synvert::Core
       end
     end
 
-    # The rewritten code, always empty string.
-    def rewritten_code
-      ''
-    end
-
-    private
-
+    # Check if the source code of current node takes the whole line.
+    #
+    # @return [Boolean]
     def take_whole_line?
       @node.to_source == file_source[start_index...end_index].strip
     end
 
+    # Get the start position of the line
     def start_index
       index = file_source[0..@node.loc.expression.begin_pos].rindex("\n")
       index ? index + "\n".length : @node.loc.expression.begin_pos
     end
 
+    # Get the end position of the line
     def end_index
       index = file_source[@node.loc.expression.end_pos..-1].index("\n")
       index ? @node.loc.expression.end_pos + index + "\n".length : @node.loc.expression.end_pos

data/lib/synvert/core/rewriter/action/replace_action.rb

@@ -3,21 +3,31 @@
 module Synvert::Core
   # ReplaceAction to replace child node with code.
   class Rewriter::ReplaceAction < Rewriter::Action
+    # Initailize a ReplaceAction.
+    #
+    # @param instance [Synvert::Core::Rewriter::Instance]
+    # @param selectors [Array<Symbol|String>] used to select child nodes
+    # @param with [String] the new code
     def initialize(instance, *selectors, with:)
       super(instance, with)
       @selectors = selectors
     end
 
-    def calculate_position
-      @begin_pos = @selectors.map { |selector| @node.child_node_range(selector).begin_pos }.min
-      @end_pos = @selectors.map { |selector| @node.child_node_range(selector).end_pos }.max
-    end
-
     # The rewritten source code.
     #
     # @return [String] rewritten code.
     def rewritten_code
       rewritten_source
     end
+
+    private
+
+    # Calculate the begin the end positions.
+    def calculate_position
+      @begin_pos = @selectors.map { |selector| @node.child_node_range(selector).begin_pos }
+                             .min
+      @end_pos = @selectors.map { |selector| @node.child_node_range(selector).end_pos }
+                           .max
+    end
   end
 end

data/lib/synvert/core/rewriter/action/replace_erb_stmt_with_expr_action.rb

@@ -2,12 +2,28 @@
 
 module Synvert::Core
   # ReplaceErbStmtWithExprAction to replace erb stmt code to expr,
+  # @example
   #   e.g. <% form_for ... %> => <%= form_for ... %>.
   class Rewriter::ReplaceErbStmtWithExprAction < Rewriter::Action
-    def initialize(instance, code = nil)
-      super
+    # Initialize a ReplaceErbStmtWithExprAction.
+    #
+    # @param instance [Synvert::Core::Rewriter::Instance]
+    def initialize(instance)
+      super(instance, nil)
+    end
+
+    # The rewritten erb expr code.
+    #
+    # @return [String] rewritten code.
+    def rewritten_code
+      @node.loc.expression.source_buffer.source[begin_pos...end_pos]
+           .sub(Engine::ERUBY_STMT_SPLITTER, '@output_buffer.append= ')
+           .sub(Engine::ERUBY_STMT_SPLITTER, Engine::ERUBY_EXPR_SPLITTER)
     end
 
+    private
+
+    # Calculate the begin the end positions.
     def calculate_position
       node_begin_pos = @node.loc.expression.begin_pos
       while @node.loc.expression.source_buffer.source[node_begin_pos -= 1] == ' '
@@ -20,14 +36,5 @@ module Synvert::Core
       end
       @end_pos = node_begin_pos
     end
-
-    # The rewritten erb expr code.
-    #
-    # @return [String] rewritten code.
-    def rewritten_code
-      @node.loc.expression.source_buffer.source[begin_pos...end_pos]
-        .sub(Engine::ERUBY_STMT_SPLITTER, '@output_buffer.append= ')
-        .sub(Engine::ERUBY_STMT_SPLITTER, Engine::ERUBY_EXPR_SPLITTER)
-    end
   end
 end

data/lib/synvert/core/rewriter/action/replace_with_action.rb

@@ -3,11 +3,6 @@
 module Synvert::Core
   # ReplaceWithAction to replace code.
   class Rewriter::ReplaceWithAction < Rewriter::Action
-    def calculate_position
-      @begin_pos = @node.loc.expression.begin_pos
-      @end_pos = @node.loc.expression.end_pos
-    end
-
     # The rewritten source code with proper indent.
     #
     # @return [String] rewritten code.
@@ -25,6 +20,12 @@ module Synvert::Core
 
     private
 
+    # Calculate the begin the end positions.
+    def calculate_position
+      @begin_pos = @node.loc.expression.begin_pos
+      @end_pos = @node.loc.expression.end_pos
+    end
+
     # Indent of the node
     #
     # @return [String] n times whitesphace

data/lib/synvert/core/rewriter/action/wrap_action.rb

@@ -6,23 +6,32 @@ module Synvert::Core
   # Note: if WrapAction is conflicted with another action (begin_pos and end_pos are overlapped),
   # we have to put those 2 actions into 2 within_file scopes.
   class Rewriter::WrapAction < Rewriter::Action
+    # Initialize a WrapAction.
+    #
+    # @param instance [Synvert::Core::Rewriter::WrapAction]
+    # @param with [String] new code to wrap
+    # @param indent [Integer, nil] number of whitespaces
     def initialize(instance, with:, indent: nil)
       super(instance, with)
       @indent = indent || @node.column
     end
 
-    def calculate_position
-      @begin_pos = @node.loc.expression.begin_pos
-      @end_pos = @node.loc.expression.end_pos
-    end
-
     # The rewritten source code.
     #
     # @return [String] rewritten code.
     def rewritten_code
       "#{@code}\n#{' ' * @indent}" +
-      @node.to_source.split("\n").map { |line| "  #{line}" }.join("\n") +
-      "\n#{' ' * @indent}end"
+        @node.to_source.split("\n").map { |line| "  #{line}" }
+             .join("\n") +
+        "\n#{' ' * @indent}end"
+    end
+
+    private
+
+    # Calculate the begin the end positions.
+    def calculate_position
+      @begin_pos = @node.loc.expression.begin_pos
+      @end_pos = @node.loc.expression.end_pos
     end
   end
 end

data/lib/synvert/core/rewriter/action.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Synvert::Core
-  # Action defines rewriter action, add, replace or remove code.
+  # Action defines rewriter action, insert, replace or delete code.
   class Rewriter::Action
     DEFAULT_INDENT = 2
 
@@ -14,31 +14,28 @@ module Synvert::Core
     # Initialize an action.
     #
     # @param instance [Synvert::Core::Rewriter::Instance]
-    # @param code [String] new code to add, replace or remove.
+    # @param code [String] new code to insert, replace or delete.
     def initialize(instance, code)
       @instance = instance
       @code = code
       @node = @instance.current_node
     end
 
+    # Calculate begin and end positions, and return self.
+    #
+    # @return [Synvert::Core::Rewriter::Action] self
     def process
       calculate_position
       self
     end
 
-    # Line number of current node.
-    #
-    # @return [Integer] line number.
-    def line
-      @node.loc.expression.line
-    end
-
     # The rewritten source code with proper indent.
     #
     # @return [String] rewritten code.
     def rewritten_code
       if rewritten_source.split("\n").length > 1
-        "\n\n" + rewritten_source.split("\n").map { |line| indent(@node) + line }.join("\n")
+        "\n\n" + rewritten_source.split("\n").map { |line| indent(@node) + line }
+                                 .join("\n")
       else
         "\n" + indent(@node) + rewritten_source
       end
@@ -46,6 +43,13 @@ module Synvert::Core
 
     protected
 
+    # Calculate the begin the end positions.
+    #
+    # @abstract
+    def calculate_position
+      raise NotImplementedError, 'must be implemented by subclasses'
+    end
+
     # The rewritten source code.
     #
     # @return [String] rewritten source code.
@@ -53,12 +57,14 @@ module Synvert::Core
       @rewritten_source ||= @node.rewritten_source(@code)
     end
 
+    # Squeeze spaces from source code.
     def squeeze_spaces
       if file_source[@begin_pos - 1] == ' ' && file_source[@end_pos] == ' '
         @begin_pos -= 1
       end
     end
 
+    # Squeeze empty lines from source code.
     def squeeze_lines
       lines = file_source.split("\n")
       begin_line = @node.loc.expression.first_line
@@ -71,6 +77,9 @@ module Synvert::Core
       end
     end
 
+    # Remove unused comma.
+    # e.g. `foobar(foo, bar)`, if we remove `foo`, the comma should also be removed,
+    # the code should be changed to `foobar(bar)`.
     def remove_comma
       if ',' == file_source[@begin_pos - 1]
         @begin_pos -= 1
@@ -83,6 +92,9 @@ module Synvert::Core
       end
     end
 
+    # Return file source.
+    #
+    # @return [String]
     def file_source
       @file_source ||= @instance.file_source
     end

data/lib/synvert/core/rewriter/any_value.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Synvert::Core
+  # A new type to match any value.
   class Rewriter::AnyValue
   end
 end

data/lib/synvert/core/rewriter/condition/if_exist_condition.rb

@@ -3,7 +3,11 @@
 module Synvert::Core
   # IfExistCondition checks if matching node exists in the node children.
   class Rewriter::IfExistCondition < Rewriter::Condition
+    private
+
     # check if any child node matches the rules.
+    #
+    # @return [Boolean]
     def match?
       match = false
       @instance.current_node.recursive_children do |child_node|

data/lib/synvert/core/rewriter/condition/if_only_exist_condition.rb

@@ -3,7 +3,11 @@
 module Synvert::Core
   # IfOnlyExistCondition checks if node has only one child node and the child node matches rules.
   class Rewriter::IfOnlyExistCondition < Rewriter::Condition
+    private
+
     # check if only have one child node and the child node matches rules.
+    #
+    # @return [Boolean]
     def match?
       @instance.current_node.body.size == 1 && @instance.current_node.body.first.match?(@rules)
     end

data/lib/synvert/core/rewriter/condition/unless_exist_condition.rb

@@ -3,7 +3,11 @@
 module Synvert::Core
   # UnlessExistCondition checks if matching node doesn't exist in the node children.
   class Rewriter::UnlessExistCondition < Rewriter::Condition
+    private
+
     # check if none of child node matches the rules.
+    #
+    # return [Boolean]
     def match?
       match = false
       @instance.current_node.recursive_children do |child_node|

data/lib/synvert/core/rewriter/condition.rb

@@ -3,12 +3,11 @@
 module Synvert::Core
   # Condition checks if rules matches.
   class Rewriter::Condition
-    # Initialize a condition.
+    # Initialize a Condition.
     #
     # @param instance [Synvert::Core::Rewriter::Instance]
     # @param rules [Hash]
-    # @param block [Block]
-    # @return [Synvert::Core::Rewriter::Condition]
+    # @yield run when condition matches
     def initialize(instance, rules, &block)
       @instance = instance
       @rules = rules
@@ -19,5 +18,14 @@ module Synvert::Core
     def process
       @instance.instance_eval(&@block) if match?
     end
+
+    protected
+
+    # Check if condition matches
+    #
+    # @abstract
+    def match?
+      raise NotImplementedError, 'must be implemented by subclasses'
+    end
   end
 end

data/lib/synvert/core/rewriter/gem_spec.rb

@@ -3,12 +3,16 @@
 module Synvert::Core
   # GemSpec checks and compares gem version.
   class Rewriter::GemSpec
+    # @!attribute [r] name
+    #   @return [String] the name of gem_spec
+    # @!attribute [r] version
+    #   @return [String] the version of gem_spec
     attr_reader :name, :version
 
-    # Initialize a gem_spec.
+    # Initialize a GemSpec.
     #
     # @param name [String] gem name
-    # @param version [String] gem version, e.g. '~> 2.0.0',
+    # @param version [String] gem version, e.g. '~> 2.0.0'
     def initialize(name, version)
       @name = name
       @version = version
@@ -17,7 +21,6 @@ module Synvert::Core
     # Check if the specified gem version in Gemfile.lock matches gem_spec comparator.
     #
     # @return [Boolean] true if matches, otherwise false.
-    # @raise [Synvert::Core::GemfileLockNotFound] raise if Gemfile.lock does not exist.
     def match?
       gemfile_lock_path = File.expand_path(File.join(Configuration.path, 'Gemfile.lock'))
 

data/lib/synvert/core/rewriter/helper.rb

@@ -24,7 +24,7 @@ module Synvert::Core
 
     # Add arguments with parenthesis if necessary.
     #
-    # @return [String] return `({{arguments}})` if node.arguments present, otherwise return nothing.
+    # @return [String] return (!{{arguments}}) if node.arguments present, otherwise return nothing.
     #
     # @example
     #
@@ -65,7 +65,9 @@ module Synvert::Core
     #
     #   strip_brackets("(1..100)") #=> "1..100"
     def strip_brackets(code)
-      code.sub(/^\((.*)\)$/) { Regexp.last_match(1) }.sub(/^\[(.*)\]$/) { Regexp.last_match(1) }.sub(/^{(.*)}$/) {
+      code.sub(/^\((.*)\)$/) { Regexp.last_match(1) }
+          .sub(/^\[(.*)\]$/) { Regexp.last_match(1) }
+          .sub(/^{(.*)}$/) {
         Regexp.last_match(1).strip
       }
     end
@@ -73,7 +75,7 @@ module Synvert::Core
     # Reject some keys from hash node.
     #
     # @param hash_node [Parser::AST::Node]
-    # @param keys [Array] keys should be rejected from the hash.
+    # @param keys [Array<String, Symbol>] keys should be rejected from the hash.
     # @return [String] source of of the hash node after rejecting some keys.
     #
     # @example
@@ -81,7 +83,8 @@ module Synvert::Core
     #   hash_node = Parser::CurrentRuby.parse("{ key1: 'value1', key2: 'value2' }")
     #   reject_keys_from_hash(hash_node, :key1) => "key2: 'value2'"
     def reject_keys_from_hash(hash_node, *keys)
-      hash_node.children.reject { |pair_node| keys.include?(pair_node.key.to_value) }.map(&:to_source).join(', ')
+      hash_node.children.reject { |pair_node| keys.include?(pair_node.key.to_value) }
+               .map(&:to_source).join(', ')
     end
   end
 end