ffast 0.2.0 → 0.2.3

data/fast.gemspec

@@ -17,29 +17,46 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(test|spec|experiments|examples|features|docs|assets|stylesheets|site)/})
   end
 
+  spec.post_install_message = <<~THANKS
+
+    ==========================================================
+    Yay! Thanks for installing
+
+       ___       __  ___
+      |__   /\  /__`  |
+      |    /~~\ .__/  |
+
+    To interactive learn about the gem in the terminal use:
+
+    fast .intro
+
+    More docs at: https://jonatas.github.io/fast/
+    ==========================================================
+
+  THANKS
+
   spec.bindir        = 'bin'
   spec.executables   = %w[fast fast-experiment]
   spec.require_paths = %w[lib experiments]
 
-  spec.add_dependency 'astrolabe'
   spec.add_dependency 'coderay'
   spec.add_dependency 'parallel'
-  spec.add_dependency 'parser'
+  spec.add_dependency 'pg_query'
 
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'git'
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-livereload'
   spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'git'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rspec-its', '~> 1.2'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-its'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-performance'
   spec.add_development_dependency 'rubocop-rspec'
-  spec.add_development_dependency 'simplecov', '~> 0.10', '< 0.18'
+  spec.add_development_dependency 'simplecov'
 end

data/lib/fast/cli.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require 'fast'
+require 'fast/source'
 require 'fast/version'
+require 'fast/sql'
 require 'coderay'
 require 'optparse'
 require 'ostruct'
@@ -16,50 +18,90 @@ module Fast
   # Useful for printing code with syntax highlight.
   # @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
+  # @param level [Integer] defines the max depth to print the AST.
+  def highlight(node, show_sexp: false, colorize: true, sql: false, level: nil)
+      output =
+        if node.respond_to?(:loc) && !show_sexp
+          if level
+            Fast.fold_source(node, level: level)
+          else
+            wrap_source_range(node).source
+          end
+        elsif show_sexp && level && Fast.ast_node?(node)
+          Fast.fold_ast(node, level: level).to_s
+        elsif show_sexp
+          node.to_s
+        else
+          node
       end
     return output unless colorize
 
-    CodeRay.scan(output, :ruby).term
+    CodeRay.scan(output, sql ? :sql : :ruby).term
+  end
+
+  # Fixes initial spaces to print the line since the beginning
+  # and fixes end of the expression including heredoc strings.
+  def wrap_source_range(node)
+    expression = node.loc.expression
+    Fast::Source.range(
+      expression.source_buffer,
+      first_position_from_expression(node),
+      last_position_from_expression(node) || expression.end_pos
+    )
+  end
+
+  # If a method call contains a heredoc, it should print the STR around it too.
+  def last_position_from_expression(node)
+    internal_heredoc = node.each_descendant(:str).select { |n| n.loc.respond_to?(:heredoc_end) }
+    internal_heredoc.map { |n| n.loc.heredoc_end.end_pos }.max if internal_heredoc.any?
+  end
+
+  # If a node is the first on it's line, print since the beginning of the line
+  # to show the proper whitespaces for identing the next lines of the code.
+  def first_position_from_expression(node)
+    expression = node.loc.expression
+    if node.respond_to?(:parent) && node.parent && node.parent.loc.expression.line != expression.line
+      expression.begin_pos - expression.column
+    else
+      expression.begin_pos
+    end
   end
 
   # Combines {.highlight} with files printing file name in the head with the
   # source line.
-  # @param result [Astrolabe::Node]
+  # @param result [Fast::Node]
   # @param show_sexp [Boolean] Show string expression instead of source
   # @param file [String] Show the file name and result line before content
   # @param headless [Boolean] Skip printing the file name and line before content
+  # @param level [Integer] Skip exploring deep branches of AST when showing sexp
   # @example
-  #   Fast.highlight(Fast.search(...))
-  def report(result, show_link: false, show_sexp: false, file: nil, headless: false, bodyless: false, colorize: true) # rubocop:disable Metrics/ParameterLists
+  #   Fast.report(result, file: 'file.rb')
+  def report(result, show_link: false, show_permalink: false, show_sexp: false, file: nil, headless: false, bodyless: false, colorize: true, level: nil) # rubocop:disable Metrics/ParameterLists
     if file
-      line = result.loc.expression.line if result.is_a?(Parser::AST::Node)
+      line = result.loc.expression.line if Fast.ast_node?(result) && result.respond_to?(:loc)
       if show_link
         puts(result.link)
+      elsif show_permalink
+        puts(result.permalink)
       elsif !headless
         puts(highlight("# #{file}:#{line}", colorize: colorize))
       end
     end
-    puts(highlight(result, show_sexp: show_sexp, colorize: colorize)) unless bodyless
+    puts(highlight(result, show_sexp: show_sexp, colorize: colorize, level: level)) unless bodyless
   end
 
   # Command Line Interface for Fast
   class Cli # rubocop:disable Metrics/ClassLength
-    attr_reader :pattern, :show_sexp, :pry, :from_code, :similar, :help
+    attr_reader :pattern, :show_sexp, :pry, :from_code, :similar, :help, :level
     def initialize(args)
-      args = replace_args_with_shortcut(args) if args.first&.start_with?('.')
-
-      @pattern, *@files = args.reject { |arg| arg.start_with? '-' }
+      args = args.dup
+      args = replace_args_with_shortcut(args) if shortcut_name_from(args)
       @colorize = STDOUT.isatty
-
       option_parser.parse! args
+      @pattern, @files = extract_pattern_and_files(args)
 
-      @files = [*@files].reject { |arg| arg.start_with?('-') }
+      @sql ||= @files.any? && @files.all? { |file| file.end_with?('.sql') }
+      require 'fast/sql' if @sql
     end
 
     def option_parser # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
@@ -69,19 +111,32 @@ module Fast
           @debug = true
         end
 
+        opts.on('-l', '--level LEVELS', 'Maximum depth to print the AST') do |level|
+          @level = level.to_i
+        end
+
         opts.on('--ast', 'Print AST instead of code') do
           @show_sexp = true
         end
 
-        opts.on('--link', 'Print link to repository URL instead of code') do
+        opts.on('--link', 'Print link to repository URL') do
           require 'fast/git'
           @show_link = true
         end
 
+        opts.on('--permalink', 'Print permalink to repository URL') do
+          require 'fast/git'
+          @show_permalink = true
+        end
+
         opts.on('-p', '--parallel', 'Paralelize search') do
           @parallel = true
         end
 
+        opts.on("--sql", "Use SQL instead of Ruby") do
+          @sql = true
+        end
+
         opts.on('--captures', 'Print only captures of the patterns and skip node results') do
           @captures = true
         end
@@ -99,24 +154,18 @@ module Fast
           require 'pry'
         end
 
-        opts.on('-c', '--code', 'Create a pattern from code example') do
-          if @pattern
-            @from_code = true
-            @pattern = Fast.ast(@pattern).to_sexp
-            debug 'Expression from AST:', @pattern
-          end
-        end
-
         opts.on('-s', '--similar', 'Search for similar code.') do
           @similar = true
-          @pattern = Fast.expression_from(Fast.ast(@pattern))
-          debug "Looking for code similar to #{@pattern}"
         end
 
         opts.on('--no-color', 'Disable color output') do
           @colorize = false
         end
 
+        opts.on('--from-code', 'From code') do
+          @from_code = true
+        end
+
         opts.on_tail('--version', 'Show version') do
           puts Fast::VERSION
           exit
@@ -129,13 +178,14 @@ module Fast
     end
 
     def replace_args_with_shortcut(args)
-      shortcut = find_shortcut args.first[1..]
+      shortcut_name = shortcut_name_from(args)
+      shortcut = find_shortcut(shortcut_name)
 
       if shortcut.single_run_with_block?
         shortcut.run
         exit
       else
-        args.one? ? shortcut.args : shortcut.merge_args(args[1..])
+        shortcut.args
       end
     end
 
@@ -151,6 +201,25 @@ module Fast
 
       if @help || @files.empty? && @pattern.nil?
         puts option_parser.help
+        return
+      end
+
+      if @similar
+        ast = Fast.public_send( @sql ? :parse_sql : :ast, @pattern)
+        @pattern = Fast.expression_from(ast)
+        debug "Search similar to #{@pattern}"
+      elsif @from_code
+        ast = Fast.public_send( @sql ? :parse_sql : :ast, @pattern)
+        @pattern = ast.to_sexp
+        if @sql
+          @pattern.gsub!(/\b-\b/,'_')
+        end
+        debug "Search from code to #{@pattern}"
+      end
+
+      if @files.empty?
+        ast ||= Fast.public_send( @sql ? :parse_sql : :ast, @pattern)
+        puts Fast.highlight(ast, show_sexp: @show_sexp, colorize: @colorize, sql: @sql, level: @level)
       else
         search
       end
@@ -181,7 +250,7 @@ module Fast
     # @yieldparam [String, Array] with file and respective search results
     def execute_search(&on_result)
       Fast.public_send(search_method_name,
-                       expression,
+                       @pattern,
                        @files,
                        parallel: parallel?,
                        on_result: on_result)
@@ -212,21 +281,43 @@ module Fast
       Fast.report(result,
                   file: file,
                   show_link: @show_link,
+                  show_permalink: @show_permalink,
                   show_sexp: @show_sexp,
                   headless: @headless,
                   bodyless: @bodyless,
-                  colorize: @colorize)
+                  colorize: @colorize,
+                  level: @level)
+    end
+
+    def shortcut_name_from(args)
+      command = args.find { |arg| !arg.start_with?('-') }
+      return unless command&.start_with?('.')
+
+      command[1..]
+    end
+
+    def extract_pattern_and_files(args)
+      return [nil, []] if args.empty?
+
+      files_start = args.index { |arg| File.exist?(arg) || File.directory?(arg) }
+      if files_start
+        [args[0...files_start].join(' '), args[files_start..]]
+      else
+        [args.join(' '), []]
+      end
     end
 
     # Find shortcut by name. Preloads all `Fastfiles` before start.
     # @param name [String]
-    # @return [Fast::Shortcut]
     def find_shortcut(name)
-      require 'fast/shortcut'
-      Fast.load_fast_files!
+      unless defined? Fast::Shortcut
+        require 'fast/shortcut'
+        Fast.load_fast_files!
+      end
 
-      shortcut = Fast.shortcuts[name] || Fast.shortcuts[name.to_sym]
-      shortcut || exit_shortcut_not_found(name)
+      shortcut = Fast.shortcuts[name.to_sym]
+      exit_shortcut_not_found(name) unless shortcut
+      shortcut
     end
 
     # Exit process with warning message bolding the shortcut that was not found.

data/lib/fast/experiment.rb

@@ -91,6 +91,7 @@ module Fast
   class Experiment
     attr_writer :files
     attr_reader :name, :replacement, :expression, :files_or_folders, :ok_if
+    attr_accessor :autoclean
 
     def initialize(name, &block)
       @name = name
@@ -137,6 +138,10 @@ module Fast
     def run
       files.map(&method(:run_with))
     end
+
+    def autoclean?
+      !!@autoclean
+    end
   end
 
   # Suggest possible combinations of occurrences to replace.
@@ -285,7 +290,7 @@ module Fast
       @fail_experiments << combination
     end
 
-    # @return [Array<Astrolabe::Node>]
+    # @return [Array<Fast::Node>]
     def search_cases
       Fast.search(experiment.expression, @ast) || []
     end
@@ -323,15 +328,25 @@ module Fast
       filename
     end
 
+    def cleanup_generated_files!
+      Dir.glob(File.join(File.dirname(@file), "experiment_*_#{File.basename(@file)}")).each do |generated_file|
+        File.delete(generated_file) if File.exist?(generated_file)
+      end
+    end
+
     def done!
       count_executed_combinations = @fail_experiments.size + @ok_experiments.size
       puts "Done with #{@file} after #{count_executed_combinations} combinations"
-      return unless perfect_combination = @ok_experiments.last # rubocop:disable Lint/AssignmentInCondition
+      unless perfect_combination = @ok_experiments.last # rubocop:disable Lint/AssignmentInCondition
+        cleanup_generated_files! if experiment.autoclean?
+        return
+      end
 
       puts 'The following changes were applied to the file:'
       `diff #{experimental_filename(perfect_combination)} #{@file}`
       puts "mv #{experimental_filename(perfect_combination)} #{@file}"
       `mv #{experimental_filename(perfect_combination)} #{@file}`
+      cleanup_generated_files! if experiment.autoclean?
     end
 
     # Increase the `@round` by 1 to {ExperimentCombinations#generate_combinations}.
@@ -346,6 +361,7 @@ module Fast
     end
 
     def run
+      cleanup_generated_files! if experiment.autoclean?
       while (combinations = build_combinations).any?
         if combinations.size > 1000
           puts "Ignoring #{@file} because it has #{combinations.size} possible combinations"
@@ -378,6 +394,7 @@ module Fast
       else
         failed_with(combination)
         puts "🔴 #{experimental_file} - Combination: #{combination}"
+        File.delete(experimental_file) if experiment.autoclean? && File.exist?(experimental_file)
       end
     end
   end

data/lib/fast/git.rb

@@ -8,7 +8,7 @@ module Fast
   #  @example
   #    require 'fast/git'
   #    Fast.ast_from_file('lib/fast.rb').git_log.first.author.name # => "Jonatas Davi Paganini"
-  class Node < Astrolabe::Node
+  class Node
     # @return [Git::Base] from current directory
     def git
       require 'git' unless defined? Git