ffast 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d07f3e9f3161db325a672703937f6c25aeacf21f76e835fd1547d34437a62a13
-  data.tar.gz: 1faf3b9d8e3bbbc6ee9b859fc5ae5779bca6750b7e510667502359db779d0e46
+  metadata.gz: 18d062e72ef849cb0b6533af8c6dc37a6612036faead3c53e1d0427a001e8f24
+  data.tar.gz: 55b4dfdd79ee4b789fa7652760fb3516a49f68b7503d827042b78c5101fecee6
 SHA512:
-  metadata.gz: 2945758fe9f1a818ec8154acb3585959c2b76c557d92ddcc14fc396b13394da8607924db5e3a84d579826e77951d5a41c8c003a2a055e653e1897475fa146ed0
-  data.tar.gz: 6637f8426a03b2ff25b4975a0887f6d11428155764029e94956d875d85625b7ee15d17eb5c5c30876c7e70cdd3f027e1228946084a18abd362935acf62352766
+  metadata.gz: 813ca8cbe0bad2ce3f6dce1477820b68c00ac06021a3fd4263df9ea5634a6510ae0cac6cd178ffc8342b31bf7e956522a482d809dbcbe3500a488b6bc609a78a
+  data.tar.gz: 7fb04918062ca0f972622fe69e8d6bb77631b1e7df9ba9aa5b1e37385c0cdbcd802324d6e46801a89e53d4f30b7fe92edf51ad3eba0252cf6fce5183c76f60de

data/docs/ideas.md

@@ -0,0 +1,80 @@
+# Ideas I want to build with Fast
+
+I don't have all the time I need to develop all the ideas I have to build
+around this tool, so here is a dump of a few brainstormings:
+
+## Inline target code
+
+I started [fast-inline](https://github.com/jonatas/fast-inline) that can be
+useful to try to see how much every library is used in a project.
+
+My idea is try to inline some specific method call to understand if it makes
+sense to have an entire library in the stock.
+
+Understanding dependencies and how the code works can be a first step to get an
+"algorithm as a service". Instead of loading everything from the library, it
+would facilitate the cherry pick of only the proper dependencies necessaries to
+run the code you have and not the code that is overloading the project.
+
+## Neo4J adapter
+
+Easy pipe fast results to Neo4J. It would facilitate to explore more complex
+scenarios and combine data from other sources.
+
+## Git adapter
+
+Add extra tags to nodes with information from Git.
+
+* Revision
+* Author
+* Date
+
+Tag every node with the proper author.
+
+## Ast Diff
+
+Allow to compare and return a summary of differences between two trees.
+
+It would be useful to identify renamings or other small changes, like only
+changes in comments that does not affect the file and possibly be ignored for
+some operations like run or not run tests.
+
+## Transition synapses
+
+Following the previous idea, it would be great if we can understand the
+transition synapses and make it easily available to catch up with previous
+learnings.
+
+https://github.com/jonatas/chewy-diff/blob/master/lib/chewy/diff.rb
+
+This example, shows adds and removals from specific node targets between two
+different files.
+
+If we start tracking AST transition synapses and associating with "Fixes" or
+"Reverts" we can predict introduction of new bugs by inpecting if the
+introduction of new patterns that can be possibly reverted or improved.
+
+## Fast Rewriter with pure strings
+
+As the AST rewriter adopts a custom block that needs to implement ruby code,
+we can expand the a query language for rewriting files without need to take the
+custom Ruby block.
+
+Example:
+
+```ruby
+Fast.gsub_expression('remove(@expression)') # (node) => { remove(node.location.expression) }
+```
+
+And later we can bind it in the command line to allow implement custom
+replacements without need to write a ruby file.
+
+```
+fast (def my_target_method) lib spec --rewrite "remove(@expression)"
+```
+
+or
+
+```
+fast (def my_target_method) lib spec --rewrite "replace(@name, 'renamed_method')"
+```

data/docs/research.md

@@ -0,0 +1,93 @@
+
+# Research
+
+I love to research about codebase as data and prototyping ideas several times
+doesn't fit in simple [shortcuts](/shortcuts).
+
+Here is my first research that worth sharing:
+
+## Combining Runtime metadata with AST complex searches
+
+This example covers how to find RSpec `allow` combined with `and_return` missing
+the `with` clause specifying the nested parameters.
+
+Here is the [gist](https://gist.github.com/jonatas/c1e580dcb74e20d4f2df4632ceb084ef)
+if you want to go straight and run it.
+
+Scenario for simple example:
+
+Given I have the following class:
+
+```ruby
+class Account
+  def withdraw(value)
+    if @total >= value
+      @total -= value
+      :ok
+    else
+      :not_allowed
+    end
+  end
+end
+```
+
+And I'm testing it with `allow` and some possibilities:
+
+```ruby
+# bad
+allow(Account).to receive(:withdraw).and_return(:ok)
+# good
+allow(Account).to receive(:withdraw).with(100).and_return(:ok)
+```
+
+**Objective:** find all bad cases of **any** class that does not respect the method
+parameters signature.
+
+First, let's understand the method signature of a method:
+
+```ruby
+Account.instance_method(:withdraw).parameters
+# => [[:req, :value]]
+```
+
+Now, we can build a small script to use the node pattern to match the proper
+specs that are using such pattern and later visit their method signatures.
+
+
+```ruby
+Fast.class_eval do
+  # Captures class and method name when find syntax like:
+  # `allow(...).to receive(...)` that does not end with `.with(...)`
+  pattern_with_captures = <<~FAST
+  (send (send nil allow (const nil $_)) to
+    (send (send nil receive (sym $_)) !with))
+  FAST
+
+  pattern = expression(pattern_with_captures.tr('$',''))
+
+  ruby_files_from('spec').each do |file|
+    results = search_file(pattern, file) || [] rescue next
+    results.each do |n|
+      clazz, method = capture(n, pattern_with_captures)
+      if klazz = Object.const_get(clazz.to_s) rescue nil
+        if klazz.respond_to?(method)
+          params = klazz.method(method).parameters
+          if params.any?{|e|e.first == :req}
+            code = n.loc.expression
+            range = [code.first_line, code.last_line].uniq.join(",")
+            boom_message = "BOOM! #{clazz}.#{method} does not include the REQUIRED parameters!"
+            puts boom_message, "#{file}:#{range}", code.source
+          end
+        end
+      end
+    end
+  end
+end
+```
+
+!!! hint "Preload your environment **before** run the script"
+
+    Keep in mind that you should run it with your environment preloaded otherwise it
+    will skip the classes.
+    You can add elses for `const_get` and `respond_to` and report weird cases if
+    your environment is not preloading properly.

data/docs/shortcuts.md

@@ -11,6 +11,70 @@ first param is not a shortcut. It should start with `.`.
 I'm building several researches and I'll make the examples open here to show
 several interesting cases in action.
 
+## List your fast shortcuts
+
+As the interface is very rudimentar, let's build a shortcut to print what
+shortcuts are available. This is a good one to your `$HOME/Fastfile`:
+
+```ruby
+# List all shortcut with comments
+Fast.shortcut :shortcuts do
+  fast_files.each do |file|
+    lines = File.readlines(file).map{|line|line.chomp.gsub(/\s*#/,'').strip}
+    result = capture_file('(send ... shortcut $(sym _', file)
+    result = [result] unless result.is_a?Array
+    result.each do |capture|
+      target = capture.loc.expression
+      puts "fast .#{target.source[1..-1].ljust(30)} # #{lines[target.line-2]}"
+    end
+  end
+end
+```
+
+And using it on `fast` project that loads both `~/Fastfile` and the Fastfile from the project:
+
+```
+fast .version       # Let's say you'd like to show the version that is over the version file
+fast .parser        # Simple shortcut that I used often to show how the expression parser works
+fast .bump_version  # Use `fast .bump_version` to rewrite the version file
+fast .shortcuts     # List all shortcut with comments
+```
+
+## Search for references
+
+I always miss bringing something simple as `grep keyword` where I can leave a simple string and it can
+search in all types of nodes and report interesting things about it.
+
+Let's consider a very flexible search that can target any code related to some
+keyword. Considering that we're talking about code indentifiers:
+
+
+```ruby
+# Search all references about some keyword or regular expression
+Fast.shortcut(:ref) do
+  require 'fast/cli'
+  Kernel.class_eval do
+    def matches_args? identifier
+      search = ARGV.last
+      regex = Regexp.new(search, Regexp::IGNORECASE)
+      case identifier
+      when Symbol, String
+        regex.match?(identifier) || identifier.to_s.include?(search)
+      when Astrolabe::Node
+        regex.match?(identifier.to_sexp)
+      end
+    end
+  end
+  pattern = <<~FAST
+    {
+      ({class def sym str} #matches_args?)'
+      ({const send} nil #matches_args?)'
+    }
+  FAST
+  Fast::Cli.run!([pattern, '.', '--parallel'])
+end
+```
+
 ## Rails: Show validations from models
 
 If the shortcut does not define a block, it works as a holder for arguments from
@@ -73,35 +137,6 @@ module Fast
 end
 ```
 
-## List Shortcuts
-
-As the interface is very rudimentar, let's build a shortcut to print what
-shortcuts are available. This is a good one to your `$HOME/Fastfile`:
-
-```ruby
-# List all shortcut with comments
-Fast.shortcut :shortcuts do
-  fast_files.each do |file|
-    lines = File.readlines(file).map{|line|line.chomp.gsub(/\s*#/,'').strip}
-    result = capture_file('(send ... shortcut $(sym _', file)
-    result = [result] unless result.is_a?Array
-    result.each do |capture|
-      target = capture.loc.expression
-      puts "fast .#{target.source[1..-1].ljust(30)} # #{lines[target.line-2]}"
-    end
-  end
-end
-```
-
-And using it on `fast` project that loads both `~/Fastfile` and the Fastfile from the project:
-
-```
-fast .version       # Let's say you'd like to show the version that is over the version file
-fast .parser        # Simple shortcut that I used often to show how the expression parser works
-fast .bump_version  # Use `fast .bump_version` to rewrite the version file
-fast .shortcuts     # List all shortcut with comments
-```
-
 ## RSpec: Find unused shared contexts
 
 If you build shared contexts often, probably you can forget some left overs.

data/fast.gemspec

@@ -28,12 +28,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'coderay'
   spec.add_dependency 'parallel'
   spec.add_dependency 'parser'
-  spec.add_dependency 'pry'
 
   spec.add_development_dependency 'bundler'
   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 'rake'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-its', '~> 1.2'

data/lib/fast.rb

@@ -226,14 +226,15 @@ module Fast
     # @param files can be file paths or directories.
     # When the argument is a folder, it recursively fetches all `.rb` files from it.
     def ruby_files_from(*files)
-      directories = files.select(&File.method(:directory?))
+      dir_filter = File.method(:directory?)
+      directories = files.select(&dir_filter)
 
       if directories.any?
         files -= directories
         files |= directories.flat_map { |dir| Dir["#{dir}/**/*.rb"] }
         files.uniq!
       end
-      files
+      files.reject(&dir_filter)
     end
 
     # Extracts a node pattern expression from a given node supressing identifiers and primitive types.

data/lib/fast/version.rb

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

data/mkdocs.yml

@@ -22,4 +22,6 @@ nav:
   - 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.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Jônatas Davi Paganini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-29 00:00:00.000000000 Z
+date: 2020-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: astrolabe
@@ -67,13 +67,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: guard-livereload
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-livereload
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -243,7 +243,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/FUNDING.yml"
 - ".gitignore"
 - ".projections.json"
 - ".rspec"
@@ -264,8 +263,10 @@ files:
 - 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

data/.github/FUNDING.yml

@@ -1,3 +0,0 @@
-# These are supported funding model platforms
-
-github: [jonatas]