ffast 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18d062e72ef849cb0b6533af8c6dc37a6612036faead3c53e1d0427a001e8f24
-  data.tar.gz: 55b4dfdd79ee4b789fa7652760fb3516a49f68b7503d827042b78c5101fecee6
+  metadata.gz: 3942d57d80b4c4a1cd1c8ff40f18cc56508a51f4b6cae53480536f7c36a60b05
+  data.tar.gz: b60976ea570cf722ae6face8541881c6a1231b2d645727f25231a05c9f33f7ee
 SHA512:
-  metadata.gz: 813ca8cbe0bad2ce3f6dce1477820b68c00ac06021a3fd4263df9ea5634a6510ae0cac6cd178ffc8342b31bf7e956522a482d809dbcbe3500a488b6bc609a78a
-  data.tar.gz: 7fb04918062ca0f972622fe69e8d6bb77631b1e7df9ba9aa5b1e37385c0cdbcd802324d6e46801a89e53d4f30b7fe92edf51ad3eba0252cf6fce5183c76f60de
+  metadata.gz: c4df11570f2b2cc164dbd43815a37443541c98c955d6c84ea0b24564fd03b8534cf73479844393ecd72c794231ad40baf678784f9863a8f90c157ac8477f3c9d
+  data.tar.gz: d9481952776fc77d251a3c9f518f41e20d672298e9ff01b53b8673a0c0bc38f4919e4dd7234365e8044f5cef8e0738823d847900bea790f9796e6d8554342a06

data/.rubocop.yml

@@ -8,11 +8,114 @@ AllCops:
   Exclude:
     - 'tmp/**/*'
     - 'examples/*'
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.6
 
 Layout/LineLength:
   Enabled: false
 
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: false
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: false
+
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+
+Lint/DuplicateElsifCondition:
+  Enabled: false
+
+Lint/DuplicateRescueException:
+  Enabled: false
+
+Lint/EmptyConditionalBody:
+  Enabled: false
+
+Lint/FloatComparison:
+  Enabled: false
+
+Lint/MissingSuper:
+  Enabled: false
+
+Lint/OutOfRangeRegexpRef:
+  Enabled: false
+
+Lint/SelfAssignment:
+  Enabled: false
+
+Lint/TopLevelReturnWithArgument:
+  Enabled: false
+
+Lint/UnreachableLoop:
+  Enabled: false
+
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: false
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: false
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/AccessorGrouping:
+  Enabled: false
+
+Style/ArrayCoercion:
+  Enabled: false
+
+Style/BisectedAttrAccessor:
+  Enabled: true
+
+Style/CaseLikeIf:
+  Enabled: true
+
+Style/ExplicitBlockArgument:
+  Enabled: false
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/GlobalStdStream:
+  Enabled: false
+
+Style/HashAsLastArrayItem:
+  Enabled: false
+
+Style/HashLikeCase:
+  Enabled: true
+
+Style/OptionalBooleanParameter:
+  Enabled: true
+
+Style/RedundantAssignment:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Style/SingleArgumentDig:
+  Enabled: true
+
+Style/StringConcatenation:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: false
+
+Style/RedundantRegexpEscape:
+  Enabled: false
+
+Style/SlicingWithRange:
+  Enabled: true
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'

data/.sourcelevel.yml

@@ -0,0 +1,2 @@
+pull_requests:
+  comments: false

data/.travis.yml

@@ -6,7 +6,7 @@ env:
 rvm:
   - 2.6.3
 before_install:
-  gem install bundler -v 1.16.1
+  gem install bundler -v 2.1.4
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - chmod +x ./cc-test-reporter

data/README.md

@@ -32,7 +32,7 @@ The current version of Fast covers the following token elements:
     to build custom rules.
 - `.<method-name>` - will call `<method-name>` from the `node`
 
-The syntax is inspired by the [RuboCop Node Pattern](https://github.com/bbatsov/rubocop/blob/master/lib/rubocop/node_pattern.rb).
+The syntax is inspired by the [RuboCop Node Pattern](https://github.com/rubocop-hq/rubocop-ast/blob/master/lib/rubocop/ast/node_pattern.rb).
 
 ## Installation
 

data/docs/videos.md

@@ -1,6 +1,10 @@
 # Videos
 
-- Grepping Ruby code like a boss: [RubyConf Brazil 2019 (Portuguese)](https://www.eventials.com/locaweb/jonatas-paganini-live-coding-grepping-ruby-code-like-a-boss/#_=_)
+- [Ruby Kaigi TakeOut 2020: Grepping Ruby code like a boss](https://www.youtube.com/watch?v=YzcYXB4L2so&feature=youtu.be&t=11855)
+
+<iframe width="560" height="315" src="https://www.youtube.com/embed/YzcYXB4L2so?start=11855" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+
+Also, similar livecoding session at [RubyConf Brazil 2019 (Portuguese)](https://www.eventials.com/locaweb/jonatas-paganini-live-coding-grepping-ruby-code-like-a-boss/#_=_).
 
 - Introduction to [inline code](https://www.youtube.com/watch?v=KQXglNLUv7o).
 <iframe width="560" height="315" src="https://www.youtube.com/embed/KQXglNLUv7o" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

data/fast.gemspec

@@ -7,7 +7,7 @@ require 'fast/version'
 Gem::Specification.new do |spec|
   spec.name          = 'ffast'
   spec.version       = Fast::VERSION
-  spec.required_ruby_version = '>= 2.3'
+  spec.required_ruby_version = '>= 2.6'
   spec.authors       = ['Jônatas Davi Paganini']
   spec.email         = ['jonatasdp@gmail.com']
   spec.homepage      = 'https://jonatas.github.io/fast/'
@@ -34,11 +34,12 @@ Gem::Specification.new do |spec|
   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 'rubocop'
   spec.add_development_dependency 'rubocop-performance'
   spec.add_development_dependency 'rubocop-rspec'
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov', '~> 0.10', '< 0.18'
 end

data/lib/fast.rb

@@ -67,18 +67,86 @@ module Fast
     %\d                   # bind extra arguments to the expression
   /x.freeze
 
+  # Set some convention methods from file.
+  class Node < Astrolabe::Node
+    # @return [String] with path of the file or simply buffer name.
+    def buffer_name
+      expression.source_buffer.name
+    end
+
+    # @return [Parser::Source::Range] from the expression
+    def expression
+      location.expression
+    end
+
+    # @return [String] with the content of the #expression
+    def source
+      expression.source
+    end
+
+    # @return [Boolean] true if a file exists with the #buffer_name
+    def from_file?
+      File.exist?(buffer_name)
+    end
+
+    # @return [Array<String>] with authors from the current expression range
+    def blame_authors
+      `git blame -L #{expression.first_line},#{expression.last_line} #{buffer_name}`.lines.map do |line|
+        line.split('(')[1].split(/\d+/).first.strip
+      end
+    end
+
+    # @return [String] with the first element from #blame_authors
+    def author
+      blame_authors.first
+    end
+
+    # Search recursively into a node and its children using a pattern.
+    # @param [String] pattern
+    # @param [Array] *args extra arguments to interpolate in the pattern.
+    # @return [Array<Fast::Node>>] with files and results
+    def search(pattern, *args)
+      Fast.search(pattern, self, *args)
+    end
+
+    # Captures elements from search recursively
+    # @param [String] pattern
+    # @param [Array] *args extra arguments to interpolate in the pattern.
+    # @return [Array<Fast::Node>>] with files and results
+    def capture(pattern, *args)
+      Fast.capture(pattern, self, *args)
+    end
+  end
+
+  # Custom builder allow us to set a buffer name for each Node
+  class Builder < Astrolabe::Builder
+    attr_writer :buffer_name
+    # Generates {Node} from the given information.
+    #
+    # @return [Node] the generated node
+    def n(type, children, source_map)
+      Node.new(type, children, location: source_map, buffer_name: @buffer_name)
+    end
+  end
+
   class << self
-    # @return [Astrolabe::Node] from the parsed content
+    # @return [Fast::Node] from the parsed content
     # @example
     #   Fast.ast("1") # => s(:int, 1)
     #   Fast.ast("a.b") # => s(:send, s(:send, nil, :a), :b)
     def ast(content, buffer_name: '(string)')
       buffer = Parser::Source::Buffer.new(buffer_name)
       buffer.source = content
-      Parser::CurrentRuby.new(Astrolabe::Builder.new).parse(buffer)
+      Parser::CurrentRuby.new(builder_for(buffer_name)).parse(buffer)
+    end
+
+    def builder_for(buffer_name)
+      builder = Builder.new
+      builder.buffer_name = buffer_name
+      builder
     end
 
-    # @return [Astrolabe::Node] parsed from file content
+    # @return [Fast::Node] parsed from file content
     # caches the content based on the filename.
     # @example
     #   Fast.ast_from_file("example.rb") # => s(...)
@@ -96,7 +164,7 @@ module Fast
     end
 
     # Search with pattern directly on file
-    # @return [Array<Astrolabe::Node>] that matches the pattern
+    # @return [Array<Fast::Node>] that matches the pattern
     def search_file(pattern, file)
       node = ast_from_file(file)
       return [] unless node
@@ -107,7 +175,7 @@ module Fast
     # Search with pattern on a directory or multiple files
     # @param [String] pattern
     # @param [Array<String>] *locations where to search. Default is '.'
-    # @return [Hash<String,Array<Astrolabe::Node>>] with files and results
+    # @return [Hash<String,Array<Fast::Node>>] with files and results
     def search_all(pattern, locations = ['.'], parallel: true, on_result: nil)
       group_results(build_grouped_search(:search_file, pattern, on_result),
                     locations, parallel: parallel)
@@ -241,7 +309,7 @@ module Fast
     # Useful to index abstract patterns or similar code structure.
     # @see https://jonatas.github.io/fast/similarity_tutorial/
     # @return [String] with an pattern to search from it.
-    # @param node [Astrolabe::Node]
+    # @param node [Fast::Node]
     # @example
     #   Fast.expression_from(Fast.ast('1')) # => '(int _)'
     #   Fast.expression_from(Fast.ast('a = 1')) # => '(lvasgn _ (int _))'
@@ -250,7 +318,7 @@ module Fast
       case node
       when Parser::AST::Node
         children_expression = node.children.map(&method(:expression_from)).join(' ')
-        "(#{node.type}#{' ' + children_expression if node.children.any?})"
+        "(#{node.type}#{" #{children_expression}" if node.children.any?})"
       when nil, 'nil'
         'nil'
       when Symbol, String, Numeric
@@ -305,14 +373,14 @@ module Fast
       when '{' then Any.new(parse_until_peek('}'))
       when '[' then All.new(parse_until_peek(']'))
       when /^"/ then FindString.new(token[1..-2])
-      when /^#\w/ then MethodCall.new(token[1..-1])
-      when /^\.\w[\w\d_]+\?/ then InstanceMethodCall.new(token[1..-1])
+      when /^#\w/ then MethodCall.new(token[1..])
+      when /^\.\w[\w\d_]+\?/ then InstanceMethodCall.new(token[1..])
       when '$' then Capture.new(parse)
       when '!' then (@tokens.any? ? Not.new(parse) : Find.new(token))
       when '?' then Maybe.new(parse)
       when '^' then Parent.new(parse)
       when '\\' then FindWithCapture.new(parse)
-      when /^%\d/ then FindFromArgument.new(token[1..-1])
+      when /^%\d/ then FindFromArgument.new(token[1..])
       else Find.new(token)
       end
     end

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,11 @@ 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
@@ -81,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'
@@ -116,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
 
@@ -195,7 +209,13 @@ module Fast
     # Report results using the actual options binded from command line.
     # @see Fast.report
     def report(file, result)
-      Fast.report(result, file: file, show_sexp: @show_sexp, headless: @headless, colorize: @colorize)
+      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.
@@ -206,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
 

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.select(&File.method(:exists?))]
+      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.9'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffast
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Jônatas Davi Paganini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
+date: 2020-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: astrolabe
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !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
@@ -224,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
@@ -247,6 +267,7 @@ files:
 - ".projections.json"
 - ".rspec"
 - ".rubocop.yml"
+- ".sourcelevel.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Fastfile
@@ -286,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
@@ -303,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:
   - - ">="