ffast 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd904f00cff76125f3b6b79455b1fda97040acbe1e631d4842a26d5e126defde
-  data.tar.gz: 426d0dfd4d17fe9e491921ae431f75d28c683da1bf6f37e27d64d9808ff86f0a
+  metadata.gz: 97309977be2dabc51b9113ee555aa7fe94d21a52426bb7386bf1133696fc4b81
+  data.tar.gz: 5851dd6da013f0561803b73d7c44a96b35960a8323399d012718eb712cf42b43
 SHA512:
-  metadata.gz: 773ec583e5c2dc7edf71d519ed0a09ace7f3714b85483f78a4ace150a85479a6cfcef20cf3724f5105204b3f26a4fb4f2a8e4040aebf366f049a3d11a7e84fcf
-  data.tar.gz: 2da3d58ad7036f74e245de58e654d736cc0f97f30bf116934166b1393132f3820e4b55f40039b99ea1589369dd650b694d874763fc36fd995bd521498b5e8257
+  metadata.gz: 192e53811678fac65eb03d87145be85971079b832f0675c80d0644e1686765995aa591e955adcb7fad31f28b0a8a2cdea0cfeaee7db9fee9067f19a36f65fd5b
+  data.tar.gz: 024c2b9a6db910e16516bf54b71f9857af40edec50c180488c312e82b177968f13e9b11d795036ffdc0541e2413b55e2efd016f0a383b06265fc7d28f99dc01f

data/examples/simple_rewriter.rb

@@ -0,0 +1,6 @@
+
+rewriter = Fast::Rewriter.new
+rewriter.ast = Fast.ast("a = 1")
+rewriter.search ='(lvasgn _ ...)'
+rewriter.replacement =  -> (node) { replace(node.location.name, 'variable_renamed') }
+puts rewriter.rewrite!

data/lib/fast.rb

@@ -2,6 +2,7 @@
 
 require 'fileutils'
 require 'astrolabe/builder'
+require_relative 'fast/rewriter'
 
 # suppress output to avoid parser gem warnings'
 def suppress_output
@@ -94,34 +95,11 @@ module Fast
       Matcher.new(pattern, ast, *args).match?
     end
 
-    # Replaces content based on a pattern.
-    # @param [Astrolabe::Node] ast with the current AST to search.
-    # @param [String] pattern with the expression to be targeting nodes.
-    # @param [Proc] replacement gives the [Rewriter] context in the block.
-    # @example
-    #   Fast.replace?(Fast.ast("a = 1"),"lvasgn") do |node|
-    #     replace(node.location.name, 'variable_renamed')
-    #   end # => variable_renamed = 1
-    # @return [String] with the new source code after apply the replacement
-    # @see Fast::Rewriter
-    def replace(pattern, ast, source = nil, &replacement)
-      buffer = Parser::Source::Buffer.new('replacement')
-      buffer.source = source || ast.loc.expression.source
-      to_replace = search(pattern, ast)
-      types = to_replace.grep(Parser::AST::Node).map(&:type).uniq
-
-      rewriter = Rewriter.new
-      rewriter.buffer = buffer
-      rewriter.search = pattern
-      rewriter.replacement = replacement
-      rewriter.replace_on(*types)
-      rewriter.rewrite(buffer, ast)
-    end
-
     # Search with pattern directly on file
     # @return [Array<Astrolabe::Node>] that matches the pattern
     def search_file(pattern, file)
       node = ast_from_file(file)
+      return [] if node.nil?
       search pattern, node
     end
 
@@ -150,21 +128,6 @@ module Fast
         .inject(&:merge!)
     end
 
-    # Replaces the source of an {Fast#ast_from_file} with
-    # and the same source if the pattern does not match.
-    def replace_file(pattern, file, &replacement)
-      ast = ast_from_file(file)
-      replace(pattern, ast, IO.read(file), &replacement)
-    end
-
-    # Combines #replace_file output overriding the file if the output is different
-    # from the original file content.
-    def rewrite_file(pattern, file, &replacement)
-      previous_content = IO.read(file)
-      content = replace_file(pattern, file, &replacement)
-      File.open(file, 'w+') { |f| f.puts content } if content != previous_content
-    end
-
     # Capture elements from searches in files. Keep in mind you need to use `$`
     # in the pattern to make it work.
     # @return [Array<Object>] captured from the pattern matched in the file
@@ -269,58 +232,6 @@ module Fast
     end
   end
 
-  # Rewriter encapsulates {Rewriter#match_index} to allow
-  # {ExperimentFile.partial_replace} in a {Fast::ExperimentFile}.
-  # @see https://www.rubydoc.info/github/whitequark/parser/Parser/TreeRewriter
-  # @note the standalone class needs to combines {Rewriter#replace_on} to properly generate the `on_<node-type>` methods depending on the expression being used.
-  # @example Simple Rewriter
-  #    ast = Fast.ast("a = 1")
-  #    buffer = Parser::Source::Buffer.new('replacement')
-  #    buffer.source = ast.loc.expression.source
-  #    rewriter = Rewriter.new buffer
-  #    rewriter.search ='(lvasgn _ ...)'
-  #    rewriter.replacement =  -> (node) { replace(node.location.name, 'variable_renamed') }
-  #    rewriter.replace_on(:lvasgn)
-  #    rewriter.rewrite(buffer, ast) # => "variable_renamed = 1"
-  class Rewriter < Parser::TreeRewriter
-    # @return [Integer] with occurrence index
-    attr_reader :match_index
-    attr_accessor :buffer, :search, :replacement
-    def initialize(*args)
-      super
-      @match_index = 0
-    end
-
-    def match?(node)
-      Fast.match?(search, node)
-    end
-
-    # Generate methods for all affected types.
-    # @see Fast.replace
-    def replace_on(*types)
-      types.map do |type|
-        self.class.send :define_method, "on_#{type}" do |node|
-          if captures = match?(node) # rubocop:disable Lint/AssignmentInCondition
-            @match_index += 1
-            execute_replacement(node, captures)
-          end
-          super(node)
-        end
-      end
-    end
-
-    # Execute {#replacement} block
-    # @param [Astrolabe::Node] node that will be yield in the replacement block
-    # @param [Array<Object>, nil] captures are yield if {#replacement} take second argument.
-    def execute_replacement(node, captures)
-      if replacement.parameters.length == 1
-        instance_exec node, &replacement
-      else
-        instance_exec node, captures, &replacement
-      end
-    end
-  end
-
   # ExpressionParser empowers the AST search in Ruby.
   # All classes inheriting Fast::Find have a grammar shortcut that is processed here.
   #

data/lib/fast/cli.rb

@@ -14,13 +14,17 @@ module Fast
 
   # Highligh some source code based on the node.
   # Useful for printing code with syntax highlight.
-  def highlight(node, show_sexp: false)
+  # @param show_sexp [Boolean] prints node expression instead of code
+  # @param colorize [Boolean] skips `CodeRay` processing when false.
+  def highlight(node, show_sexp: false, colorize: true)
     output =
       if node.respond_to?(:loc) && !show_sexp
         node.loc.expression.source
       else
         node
       end
+    return output unless colorize
+
     CodeRay.scan(output, :ruby).term
   end
 
@@ -32,12 +36,12 @@ module Fast
   # @param headless [Boolean] Skip printing the file name and line before content
   # @example
   #   Fast.highlight(Fast.search(...))
-  def report(result, show_sexp: false, file: nil, headless: false)
+  def report(result, show_sexp: false, file: nil, headless: false, colorize: true)
     if file
       line = result.loc.expression.line if result.is_a?(Parser::AST::Node)
-      puts(highlight("# #{file}:#{line}")) unless headless
+      puts(highlight("# #{file}:#{line}", colorize: colorize)) unless headless
     end
-    puts highlight(result, show_sexp: show_sexp)
+    puts highlight(result, show_sexp: show_sexp, colorize: colorize)
   end
 
   # Command Line Interface for Fast
@@ -47,6 +51,7 @@ module Fast
       args = replace_args_with_shortcut(args) if args.first&.start_with?('.')
 
       @pattern, *@files = args.reject { |arg| arg.start_with? '-' }
+      @colorize = STDOUT.isatty
 
       option_parser.parse! args
 
@@ -91,6 +96,10 @@ module Fast
           debug "Looking for code similar to #{@pattern}"
         end
 
+        opts.on('--no-color', 'Disable color output') do
+          @colorize = false
+        end
+
         opts.on_tail('--version', 'Show version') do
           puts Fast::VERSION
           exit
@@ -170,7 +179,7 @@ module Fast
     # Report results using the actual options binded from command line.
     # @see Fast.report
     def report(result, file)
-      Fast.report(result, file: file, show_sexp: @show_sexp, headless: @headless)
+      Fast.report(result, file: file, show_sexp: @show_sexp, headless: @headless, colorize: @colorize)
     end
 
     # Find shortcut by name. Preloads all `Fastfiles` before start.

data/lib/fast/rewriter.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+# Rewriter loads a set of methods related to automated replacement using
+# expressions and custom blocks of code.
+module Fast
+  class << self
+    # Replaces content based on a pattern.
+    # @param [Astrolabe::Node] ast with the current AST to search.
+    # @param [String] pattern with the expression to be targeting nodes.
+    # @param [Proc] replacement gives the [Rewriter] context in the block.
+    # @example
+    #   Fast.replace?(Fast.ast("a = 1"),"lvasgn") do |node|
+    #     replace(node.location.name, 'variable_renamed')
+    #   end # => variable_renamed = 1
+    # @return [String] with the new source code after apply the replacement
+    # @see Fast::Rewriter
+    def replace(pattern, ast, source = nil, &replacement)
+      rewriter_for(pattern, ast, source, &replacement).rewrite!
+    end
+
+    # @return [Fast::Rewriter]
+    def rewriter_for(pattern, ast, source = nil, &replacement)
+      rewriter = Rewriter.new
+      rewriter.source = source
+      rewriter.ast = ast
+      rewriter.search = pattern
+      rewriter.replacement = replacement
+      rewriter
+    end
+
+    # Replaces the source of an {Fast#ast_from_file} with
+    # and the same source if the pattern does not match.
+    def replace_file(pattern, file, &replacement)
+      ast = ast_from_file(file)
+      replace(pattern, ast, IO.read(file), &replacement)
+    end
+
+    # Combines #replace_file output overriding the file if the output is different
+    # from the original file content.
+    def rewrite_file(pattern, file, &replacement)
+      previous_content = IO.read(file)
+      content = replace_file(pattern, file, &replacement)
+      File.open(file, 'w+') { |f| f.puts content } if content != previous_content
+    end
+  end
+
+  # Rewriter encapsulates {Rewriter#match_index} to allow
+  # {ExperimentFile.partial_replace} in a {Fast::ExperimentFile}.
+  # @see https://www.rubydoc.info/github/whitequark/parser/Parser/TreeRewriter
+  # @note the standalone class needs to combines {Rewriter#replace_on} to properly generate the `on_<node-type>` methods depending on the expression being used.
+  # @example Simple Rewriter
+  #    rewriter = Rewriter.new buffer
+  #    rewriter.ast = Fast.ast("a = 1")
+  #    rewriter.search ='(lvasgn _ ...)'
+  #    rewriter.replacement =  -> (node) { replace(node.location.name, 'variable_renamed') }
+  #    rewriter.rewrite! # => "variable_renamed = 1"
+  class Rewriter < Parser::TreeRewriter
+    # @return [Integer] with occurrence index
+    attr_reader :match_index
+    attr_accessor :search, :replacement, :source, :ast
+    def initialize(*_args)
+      super()
+      @match_index = 0
+    end
+
+    def rewrite!
+      replace_on(*types)
+      rewrite(buffer, ast)
+    end
+
+    def buffer
+      buffer = Parser::Source::Buffer.new('replacement')
+      buffer.source = source || ast.loc.expression.source
+      buffer
+    end
+
+    # @return [Array<Symbol>] with all types that matches
+    def types
+      Fast.search(search, ast).grep(Parser::AST::Node).map(&:type).uniq
+    end
+
+    def match?(node)
+      Fast.match?(search, node)
+    end
+
+    # Generate methods for all affected types.
+    # @see Fast.replace
+    def replace_on(*types)
+      types.map do |type|
+        self.class.send :define_method, "on_#{type}" do |node|
+          if captures = match?(node) # rubocop:disable Lint/AssignmentInCondition
+            @match_index += 1
+            execute_replacement(node, captures)
+          end
+          super(node)
+        end
+      end
+    end
+
+    # Execute {#replacement} block
+    # @param [Astrolabe::Node] node that will be yield in the replacement block
+    # @param [Array<Object>, nil] captures are yield if {#replacement} take second argument.
+    def execute_replacement(node, captures)
+      if replacement.parameters.length == 1
+        instance_exec node, &replacement
+      else
+        instance_exec node, captures, &replacement
+      end
+    end
+  end
+end

data/lib/fast/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fast
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffast
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Jônatas Davi Paganini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-28 00:00:00.000000000 Z
+date: 2019-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: astrolabe
@@ -259,6 +259,7 @@ files:
 - examples/method_complexity.rb
 - examples/search_duplicated.rb
 - examples/similarity_research.rb
+- examples/simple_rewriter.rb
 - experiments/let_it_be_experiment.rb
 - experiments/remove_useless_hook.rb
 - experiments/replace_create_with_build_stubbed.rb
@@ -266,6 +267,7 @@ files:
 - lib/fast.rb
 - lib/fast/cli.rb
 - lib/fast/experiment.rb
+- lib/fast/rewriter.rb
 - lib/fast/shortcut.rb
 - lib/fast/version.rb
 - mkdocs.yml