synvert-core 0.15.1 → 0.18.0

data/lib/synvert/core/rewriter.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Synvert::Core
   # Rewriter is the top level namespace in a snippet.
@@ -42,7 +42,14 @@ module Synvert::Core
     autoload :RubyVersion, 'synvert/core/rewriter/ruby_version'
     autoload :GemSpec, 'synvert/core/rewriter/gem_spec'
 
-    class <<self
+    class << self
+      # Execute the temporary rewriter without group and name.
+      #
+      # @param block [Block] a block defines the behaviors of the rewriter.
+      def execute(&block)
+        Rewriter.new('', '', &block).process
+      end
+
       # Register a rewriter with its group and name.
       #
       # @param group [String] the rewriter group.
@@ -65,7 +72,7 @@ module Synvert::Core
         if exist? group, name
           rewriters[group][name]
         else
-          raise RewriterNotFound.new "Rewriter #{group} #{name} not found"
+          raise RewriterNotFound, "Rewriter #{group} #{name} not found"
         end
       end
 
@@ -82,7 +89,7 @@ module Synvert::Core
           rewriter.process
           rewriter
         else
-          raise RewriterNotFound.new "Rewriter #{group}/#{name} not found"
+          raise RewriterNotFound, "Rewriter #{group}/#{name} not found"
         end
       end
 
@@ -112,7 +119,7 @@ module Synvert::Core
         rewriters.clear
       end
 
-    private
+      private
 
       def rewriters
         @rewriters ||= {}
@@ -151,14 +158,14 @@ module Synvert::Core
     # Process the rewriter.
     # It will call the block.
     def process
-      self.instance_eval &@block
+      instance_eval &@block
     end
 
     # Process rewriter with sandbox mode.
     # It will call the block but doesn't change any file.
     def process_with_sandbox
       @sandbox = true
-      self.process
+      process
       @sandbox = false
     end
 
@@ -178,7 +185,7 @@ module Synvert::Core
     #
     # @param description [String] rewriter description.
     # @return rewriter description.
-    def description(description=nil)
+    def description(description = nil)
       if description
         @description = description
       else
@@ -208,17 +215,16 @@ module Synvert::Core
     # @param file_pattern [String] pattern to find files, e.g. spec/**/*_spec.rb
     # @param options [Hash] instance options.
     # @param block [Block] the block to rewrite code in the matching files.
-    def within_files(file_pattern, options={}, &block)
+    def within_files(file_pattern, options = {}, &block)
       return if @sandbox
 
-      if (!@ruby_version || @ruby_version.match?) &&
-        (!@gem_spec || @gem_spec.match?)
+      if (!@ruby_version || @ruby_version.match?) && (!@gem_spec || @gem_spec.match?)
         Rewriter::Instance.new(self, file_pattern, options, &block).process
       end
     end
 
     # Parse within_file dsl, it finds a specifiled file.
-    alias_method :within_file, :within_files
+    alias within_file within_files
 
     # Parses add_file dsl, it adds a new file.
     #
@@ -262,7 +268,7 @@ module Synvert::Core
     # @param name [String] helper method name.
     # @param block [Block] helper method block.
     def helper_method(name, &block)
-      @helpers << {name: name, block: block}
+      @helpers << { name: name, block: block }
     end
 
     # Parse todo dsl, it sets todo of the rewriter.
@@ -270,7 +276,7 @@ module Synvert::Core
     #
     # @param todo_list [String] rewriter todo.
     # @return [String] rewriter todo.
-    def todo(todo=nil)
+    def todo(todo = nil)
       if todo
         @todo = todo
       else

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

@@ -1,16 +1,17 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Synvert::Core
   # Action defines rewriter action, add, replace or remove code.
   class Rewriter::Action
-    DEFAULT_OPTIONS = { autoindent: true }
+    DEFAULT_OPTIONS = { autoindent: true }.freeze
+    DEFAULT_INDENT = 2
 
     # Initialize an action.
     #
     # @param instance [Synvert::Core::Rewriter::Instance]
     # @param code [String] new code to add, replace or remove.
     # @param options [Hash] action options, it includes :autoindent.
-    def initialize(instance, code, options={})
+    def initialize(instance, code, options = {})
       @instance = instance
       @code = code
       @options = DEFAULT_OPTIONS.merge(options)
@@ -29,9 +30,7 @@ module Synvert::Core
     # @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
@@ -45,4 +44,3 @@ module Synvert::Core
     end
   end
 end
-

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

@@ -1,8 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Synvert::Core
-  # AppendWithAction to append code to the bottom of node body.
+  # AppendAction to append code to the bottom of node body.
   class Rewriter::AppendAction < Rewriter::Action
+    END_LENGTH = "\nend".length
+
     # Begin position to append code.
     #
     # @return [Integer] begin position.
@@ -10,7 +12,7 @@ module Synvert::Core
       if :begin == @node.type
         @node.loc.expression.end_pos
       else
-        @node.loc.expression.end_pos - @node.indent - 4
+        @node.loc.expression.end_pos - @node.indent - END_LENGTH
       end
     end
 
@@ -21,15 +23,15 @@ module Synvert::Core
       begin_pos
     end
 
-  private
+    private
 
     # Indent of the node.
     #
     # @param node [Parser::AST::Node]
     # @return [String] n times whitesphace
     def indent(node)
-      if [:block, :class].include? node.type
-        ' ' * (node.indent + 2)
+      if %i[block class].include? node.type
+        ' ' * (node.indent + DEFAULT_INDENT)
       else
         ' ' * node.indent
       end

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

@@ -1,13 +1,26 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Synvert::Core
   # InsertAction to insert code to the top of node body.
   class Rewriter::InsertAction < Rewriter::Action
+    DO_LENGTH = ' do'.length
+
     # Begin position to insert code.
     #
     # @return [Integer] begin position.
     def begin_pos
-      insert_position(@node)
+      case @node.type
+      when :block
+        if @node.children[1].children.empty?
+          @node.children[0].loc.expression.end_pos + DO_LENGTH
+        else
+          @node.children[1].loc.expression.end_pos
+        end
+      when :class
+        @node.children[1] ? @node.children[1].loc.expression.end_pos : @node.children[0].loc.expression.end_pos
+      else
+        @node.children.last.loc.expression.end_pos
+      end
     end
 
     # End position, always same to begin position.
@@ -17,29 +30,15 @@ module Synvert::Core
       begin_pos
     end
 
-  private
-
-    # Insert position.
-    #
-    # @return [Integer] insert position.
-    def insert_position(node)
-      case node.type
-      when :block
-        node.children[1].children.empty? ? node.children[0].loc.expression.end_pos + 3 : node.children[1].loc.expression.end_pos
-      when :class
-        node.children[1] ? node.children[1].loc.expression.end_pos : node.children[0].loc.expression.end_pos
-      else
-        node.children.last.loc.expression.end_pos
-      end
-    end
+    private
 
     # Indent of the node.
     #
     # @param node [Parser::AST::Node]
     # @return [String] n times whitesphace
     def indent(node)
-      if [:block, :class].include? node.type
-        ' ' * (node.indent + 2)
+      if %i[block class].include? node.type
+        ' ' * (node.indent + DEFAULT_INDENT)
       else
         ' ' * node.indent
       end

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Synvert::Core
   # InsertAfterAction to insert code next to the node.
@@ -17,7 +17,7 @@ module Synvert::Core
       begin_pos
     end
 
-  private
+    private
 
     # Indent of the node.
     #

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

@@ -1,9 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Synvert::Core
   # RemoveAction to remove code.
   class Rewriter::RemoveAction < Rewriter::Action
-    def initialize(instance, code=nil)
+    def initialize(instance, code = nil)
       super
     end
 

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

@@ -1,10 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Synvert::Core
   # ReplaceErbStmtWithExprAction to replace erb stmt code to expr,
   #   e.g. <% form_for ... %> => <%= form_for ... %>.
   class Rewriter::ReplaceErbStmtWithExprAction < Rewriter::Action
-    def initialize(instance, code=nil)
+    def initialize(instance, code = nil)
       super
     end
 
@@ -23,7 +23,7 @@ module Synvert::Core
     # @return [Integer] end position.
     def end_pos
       node_begin_pos = @node.loc.expression.begin_pos
-      node_begin_pos += @node.loc.expression.source.index "do"
+      node_begin_pos += @node.loc.expression.source.index 'do'
       while @node.loc.expression.source_buffer.source[node_begin_pos += 1] != '@'
       end
       node_begin_pos
@@ -33,7 +33,8 @@ module Synvert::Core
     #
     # @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= ")
+      @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

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Synvert::Core
   # ReplaceWithAction to replace code.
@@ -23,16 +23,18 @@ module Synvert::Core
     def rewritten_code
       if rewritten_source.split("\n").length > 1
         new_code = []
-        rewritten_source.split("\n").each_with_index { |line, index|
-          new_code << (index == 0 || !@options[:autoindent] ? line : indent(@node) + line)
-        }
+        rewritten_source
+          .split("\n")
+          .each_with_index { |line, index|
+            new_code << (index == 0 || !@options[:autoindent] ? line : indent(@node) + line)
+          }
         new_code.join("\n")
       else
         rewritten_source
       end
     end
 
-  private
+    private
 
     # Indent of the node
     #

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Synvert::Core
   # Condition checks if rules matches.

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Synvert::Core
   # IfExistCondition checks if matching node exists in the node children.
@@ -7,7 +7,7 @@ module Synvert::Core
     def match?
       match = false
       @instance.current_node.recursive_children do |child_node|
-        match = match || (child_node && child_node.match?(@rules))
+        match ||= (child_node&.match?(@rules))
       end
       match
     end

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

@@ -1,12 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Synvert::Core
   # IfExistCondition checks if node has only one child node and the child node matches rules.
   class Rewriter::IfOnlyExistCondition < Rewriter::Condition
     # check if only have one child node and the child node matches rules.
     def match?
-      @instance.current_node.body.size == 1 &&
-        @instance.current_node.body.first.match?(@rules)
+      @instance.current_node.body.size == 1 && @instance.current_node.body.first.match?(@rules)
     end
   end
 end

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Synvert::Core
   # UnlessExistCondition checks if matching node doesn't exist in the node children.
@@ -7,7 +7,7 @@ module Synvert::Core
     def match?
       match = false
       @instance.current_node.recursive_children do |child_node|
-        match = match || (child_node && child_node.match?(@rules))
+        match ||= (child_node&.match?(@rules))
       end
       !match
     end

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

@@ -1,9 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Synvert::Core
   # GemSpec checks and compares gem version.
   class Rewriter::GemSpec
-    OPERATORS = {eq: '==', lt: '<', gt: '>', lte: '<=', gte: '>=', ne: '!='}
+    OPERATORS = { eq: '==', lt: '<', gt: '>', lte: '<=', gte: '>=', ne: '!=' }.freeze
 
     # Initialize a gem_spec.
     #
@@ -27,15 +27,15 @@ module Synvert::Core
     # @raise [Synvert::Core::GemfileLockNotFound] raise if Gemfile.lock does not exist.
     def match?
       gemfile_lock_path = File.join(Configuration.instance.get(:path), 'Gemfile.lock')
-      if File.exists? gemfile_lock_path
-        parser = Bundler::LockfileParser.new(File.read(gemfile_lock_path))
-        if spec = parser.specs.find { |spec| spec.name == @name }
-          Gem::Version.new(spec.version).send(OPERATORS[@operator], @version)
-        else
-          false
-        end
+
+      # if Gemfile.lock does not exist, just ignore this check
+      return true unless File.exist?(gemfile_lock_path)
+
+      parser = Bundler::LockfileParser.new(File.read(gemfile_lock_path))
+      if spec = parser.specs.find { |spec| spec.name == @name }
+        Gem::Version.new(spec.version).send(OPERATORS[@operator], @version)
       else
-        raise GemfileLockNotFound.new 'Gemfile.lock does not exist'
+        false
       end
     end
   end

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

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Synvert::Core
   # Rewriter::Helper provides some helper methods to make it easier to write a snippet.
@@ -34,9 +34,9 @@ module Synvert::Core
     #   if current_node has argument, it returns "({{arguments}})"
     def add_arguments_with_parenthesis_if_necessary
       if node.arguments.size > 0
-        "({{arguments}})"
+        '({{arguments}})'
       else
-        ""
+        ''
       end
     end
 
@@ -65,9 +65,7 @@ module Synvert::Core
     #
     #   strip_brackets("(1..100)") #=> "1..100"
     def strip_brackets(code)
-      code.sub(/^\((.*)\)$/) { $1 }
-          .sub(/^\[(.*)\]$/) { $1 }
-          .sub(/^{(.*)}$/) { $1 }
+      code.sub(/^\((.*)\)$/) { $1 }.sub(/^\[(.*)\]$/) { $1 }.sub(/^{(.*)}$/) { $1 }
     end
   end
 end