ffast 0.1.5 → 0.2.0

data/lib/fast/cli.rb

@@ -36,12 +36,16 @@ 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, colorize: true)
+  def report(result, show_link: false, show_sexp: false, file: nil, headless: false, bodyless: false, colorize: true) # rubocop:disable Metrics/ParameterLists
     if file
       line = result.loc.expression.line if result.is_a?(Parser::AST::Node)
-      puts(highlight("# #{file}:#{line}", colorize: colorize)) unless headless
+      if show_link
+        puts(result.link)
+      elsif !headless
+        puts(highlight("# #{file}:#{line}", colorize: colorize))
+      end
     end
-    puts highlight(result, show_sexp: show_sexp, colorize: colorize)
+    puts(highlight(result, show_sexp: show_sexp, colorize: colorize)) unless bodyless
   end
 
   # Command Line Interface for Fast
@@ -69,6 +73,15 @@ module Fast
           @show_sexp = true
         end
 
+        opts.on('--link', 'Print link to repository URL instead of code') do
+          require 'fast/git'
+          @show_link = true
+        end
+
+        opts.on('-p', '--parallel', 'Paralelize search') do
+          @parallel = true
+        end
+
         opts.on('--captures', 'Print only captures of the patterns and skip node results') do
           @captures = true
         end
@@ -77,6 +90,10 @@ module Fast
           @headless = true
         end
 
+        opts.on('--bodyless', 'Print results without the code details') do
+          @bodyless = true
+        end
+
         opts.on('--pry', 'Jump into a pry session with results') do
           @pry = true
           require 'pry'
@@ -112,12 +129,13 @@ module Fast
     end
 
     def replace_args_with_shortcut(args)
-      shortcut = find_shortcut args.first[1..-1]
+      shortcut = find_shortcut args.first[1..]
+
       if shortcut.single_run_with_block?
         shortcut.run
         exit
       else
-        args.one? ? shortcut.args : shortcut.merge_args(args[1..-1])
+        args.one? ? shortcut.args : shortcut.merge_args(args[1..])
       end
     end
 
@@ -129,6 +147,8 @@ module Fast
 
     # Show help or search for node patterns
     def run!
+      raise 'pry and parallel options are incompatible :(' if @parallel && @pry
+
       if @help || @files.empty? && @pattern.nil?
         puts option_parser.help
       else
@@ -137,6 +157,7 @@ module Fast
     end
 
     # Create fast expression from node pattern using the command line
+    # @return [Array<Fast::Find>] with the expression from string.
     def expression
       Fast.expression(@pattern)
     end
@@ -146,24 +167,29 @@ module Fast
     # If capture option is enabled it will only print the captures, otherwise it
     # prints all the results.
     def search
-      if debug_mode?
-        Fast.debug { execute_search }
-      else
-        execute_search do |file, results|
-          results.each do |result|
-            binding.pry if @pry # rubocop:disable Lint/Debugger
-            report(result, file)
-          end
+      return Fast.debug(&method(:execute_search)) if debug_mode?
+
+      execute_search do |file, results|
+        results.each do |result|
+          binding.pry if @pry # rubocop:disable Lint/Debugger
+          report(file, result)
         end
       end
     end
 
-    def execute_search
-      method_name = @captures ? :capture_all : :search_all
-      (Fast.public_send(method_name, expression, @files) || []).each do |file, results|
-        results = [results] unless results.is_a?(Array)
-        yield file, results
-      end
+    # Executes search for all files yielding the results
+    # @yieldparam [String, Array] with file and respective search results
+    def execute_search(&on_result)
+      Fast.public_send(search_method_name,
+                       expression,
+                       @files,
+                       parallel: parallel?,
+                       on_result: on_result)
+    end
+
+    # @return [Symbol] with `:capture_all` or `:search_all` depending the command line options
+    def search_method_name
+      @captures ? :capture_all : :search_all
     end
 
     # @return [Boolean] true when "-d" or "--debug" option is passed
@@ -176,10 +202,20 @@ module Fast
       puts(info) if debug_mode?
     end
 
+    def parallel?
+      @parallel == true
+    end
+
     # 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, colorize: @colorize)
+    def report(file, result)
+      Fast.report(result,
+                  file: file,
+                  show_link: @show_link,
+                  show_sexp: @show_sexp,
+                  headless: @headless,
+                  bodyless: @bodyless,
+                  colorize: @colorize)
     end
 
     # Find shortcut by name. Preloads all `Fastfiles` before start.
@@ -190,7 +226,6 @@ module Fast
       Fast.load_fast_files!
 
       shortcut = Fast.shortcuts[name] || Fast.shortcuts[name.to_sym]
-
       shortcut || exit_shortcut_not_found(name)
     end
 
@@ -198,7 +233,10 @@ module Fast
     # Prints available shortcuts as extra help and exit with code 1.
     def exit_shortcut_not_found(name)
       puts "Shortcut \033[1m#{name}\033[0m not found :("
-      puts "Available shortcuts are: #{Fast.shortcuts.keys.join(', ')}." if Fast.shortcuts.any?
+      if Fast.shortcuts.any?
+        puts "Available shortcuts are: #{Fast.shortcuts.keys.join(', ')}."
+        Fast.load_fast_files!
+      end
       exit 1
     end
   end

data/lib/fast/experiment.rb

@@ -290,7 +290,7 @@ module Fast
       Fast.search(experiment.expression, @ast) || []
     end
 
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+    # rubocop:disable Metrics/MethodLength
     #
     # Execute partial replacements generating new file with the
     # content replaced.
@@ -312,7 +312,6 @@ module Fast
       new_content
     end
 
-    # rubocop:enable Metrics/AbcSize
     # rubocop:enable Metrics/MethodLength
 
     # Write new file name depending on the combination

data/lib/fast/git.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+# Git plugin for Fast::Node.
+# It allows to easily access metadata from current file.
+module Fast
+  # This is not required by default, so to use it, you should require it first.
+  #
+  #  @example
+  #    require 'fast/git'
+  #    Fast.ast_from_file('lib/fast.rb').git_log.first.author.name # => "Jonatas Davi Paganini"
+  class Node < Astrolabe::Node
+    # @return [Git::Base] from current directory
+    def git
+      require 'git' unless defined? Git
+      Git.open('.')
+    end
+
+    # @return [Git::Object::Blob] from current #buffer_name
+    def git_blob
+      return unless from_file?
+
+      git.gblob(buffer_name)
+    end
+
+    # @return [Git::Log] from the current #git_blob
+    #  buffer-name
+    def git_log
+      git_blob.log
+    end
+
+    # @return [Git::Object::Commit]
+    def last_commit
+      git_log.first
+    end
+
+    # @return [String] with last commit SHA
+    def sha
+      last_commit.sha
+    end
+
+    # @return [String] with remote URL
+    def remote_url
+      git.remote.url
+    end
+
+    # Given #remote_url is "git@github.com:namespace/project.git"
+    # Or #remote_url is "https://github.com/namespace/project.git"
+    # @return [String] "https://github.com/namespace/project"
+    def project_url
+      return remote_url.gsub(/\.git$/, '') if remote_url.start_with?('https')
+
+      remote_url
+        .gsub('git@', 'https://')
+        .gsub(/:(\w)/, '/\\1')
+        .gsub(/\.git$/, '')
+    end
+
+    def file
+      buffer_name.gsub("#{Dir.pwd}/", '')
+    end
+
+    # @return
+    def line_range
+      lines.map { |l| "L#{l}" }.join('-')
+    end
+
+    # @return [Array] with lines range
+    def lines
+      exp = loc.expression
+      first_line = exp.first_line
+      last_line = exp.last_line
+      [first_line, last_line].uniq
+    end
+
+    # @return [Integer] lines of code from current block
+    def lines_of_code
+      lines.last - lines.first + 1
+    end
+
+    # @return [String] a markdown link with #md_link_description and #link
+    def md_link(text = md_link_description)
+      "[#{text}](#{link})"
+    end
+
+    # @return [String] with the source cutting arguments from method calls to be
+    # able to create a markdown link without parens.
+    def md_link_description
+      source[/([^\r\(]+)\(/, 1] || source
+    end
+
+    # @return [String] with formatted repositorym link
+    def link
+      "#{project_url}/blob/master/#{buffer_name}##{line_range}"
+    end
+
+    # @return [String] with permanent link to the actual commit
+    def permalink
+      "#{project_url}/blob/#{sha}/#{buffer_name}##{line_range}"
+    end
+  end
+end

data/lib/fast/shortcut.rb

@@ -54,19 +54,16 @@ module Fast
       @block && @args.nil?
     end
 
-    def options
-      @args.select { |arg| arg.start_with? '-' }
-    end
-
-    def params
-      @args - options
-    end
-
     # Merge extra arguments from input returning a new arguments array keeping
     # the options from previous alias and replacing the files with the
     # @param [Array] extra_args
     def merge_args(extra_args)
-      [params[0], *options, *extra_args]
+      all_args = (@args + extra_args).uniq
+      options = all_args.select { |arg| arg.start_with? '-' }
+      files = extra_args.select(&File.method(:exists?))
+      command = (@args - options - files).first
+
+      [command, *options, *files]
     end
 
     # If the shortcut was defined with a single block and no extra arguments, it

data/lib/fast/version.rb

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

data/mkdocs.yml

@@ -18,5 +18,10 @@ nav:
   - Syntax: syntax.md
   - Command Line: command_line.md
   - Experiments: experiments.md
+  - Shortcuts: shortcuts.md
   - Code Similarity: similarity_tutorial.md
   - Pry Integration: pry-integration.md
+  - Editors' Integration: editors-integration.md
+  - Research: research.md
+  - Ideas: ideas.md
+  - Videos: videos.md

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffast
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Jônatas Davi Paganini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-18 00:00:00.000000000 Z
+date: 2020-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: astrolabe
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: parser
+  name: parallel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,20 +122,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -210,16 +238,22 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
 description: Allow you to search for code using node pattern syntax.
 email:
 - jonatasdp@gmail.com
@@ -233,6 +267,7 @@ files:
 - ".projections.json"
 - ".rspec"
 - ".rubocop.yml"
+- ".sourcelevel.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Fastfile
@@ -247,11 +282,16 @@ files:
 - bin/fast-experiment
 - bin/setup
 - docs/command_line.md
+- docs/editors-integration.md
 - docs/experiments.md
+- docs/ideas.md
 - docs/index.md
 - docs/pry-integration.md
+- docs/research.md
+- docs/shortcuts.md
 - docs/similarity_tutorial.md
 - docs/syntax.md
+- docs/videos.md
 - examples/build_stubbed_and_let_it_be_experiment.rb
 - examples/experimental_replacement.rb
 - examples/find_usage.rb
@@ -267,6 +307,7 @@ files:
 - lib/fast.rb
 - lib/fast/cli.rb
 - lib/fast/experiment.rb
+- lib/fast/git.rb
 - lib/fast/rewriter.rb
 - lib/fast/shortcut.rb
 - lib/fast/version.rb
@@ -284,7 +325,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="