ffast 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c7eee39cf27764a49009037c603ebd8f9afe0b8f0d78ac651c2bdee1d65f329
-  data.tar.gz: '09eefe65daeeb37ed5d49120cbee73018303156df11f25daa5258ce310a1be89'
+  metadata.gz: a8e1cdbb944bd8939745c07350aaa66e4ff3e9e3313802ca23aaa7fbd33b742d
+  data.tar.gz: fcd59e90fedc893492aa791e129d18a8b2e2e72e72b8ca61be6be8fd3e4ad6b7
 SHA512:
-  metadata.gz: 163730827f44a4d9a5491b47f96e6d3f10d883921710b5fa2e6f9573a586e71ff84460710288b3388ef209c90744f01d7dfc03ca5f5daff5a62c2179e3da43c5
-  data.tar.gz: 0ecc89dd396c151c07fcf6bc9de52c3dc183909bb29498715f2e703124db75e03847894a3d7394e79b9beabee750fa13db23d74bcc95b68a721553d6f5b8c46b
+  metadata.gz: f33ebcf4e4275e783d75a761b78fc54a70f789f89ea735011a5a5628c7d2f8630271e29436aa1d3a15418f4186fc42764fad3ca5d72ef69bf2ccc860424299a3
+  data.tar.gz: ab1c3275a3415aba183ac6e558284d4f30bb5e462454758808df430059f077eb141f18a8ec725ad7738e1e9e3fd350688d674f6691a4d6165e17f039db34c653

data/README.md

@@ -319,18 +319,29 @@ You can use `search_file` and pass the path for search for expressions inside
 files.
 
 ```ruby
-Fast.search_file('file.rb', expression)
+Fast.search_file(expression, 'file.rb')
 ```
 
 It's simple combination of `Fast.ast_from_file` with `Fast.search`.
 
+
+## Fast.capture_file
+
+You can also use `Fast.capture_file` that is similar but return only the
+captures:
+
+```ruby
+ Fast.capture_file('(class (const nil $_))', 'lib/fast.rb')
+ # => [:Rewriter, :ExpressionParser, :Find, :FindString, ...]
+```
+
 ## Fast.ruby_files_from(arguments)
 
 You'll be probably looking for multiple ruby files, then this method fetches
 all internal `.rb` files 
 
 ```ruby
-Fast.ruby_files_from(['lib']) # => ["lib/fast.rb"]
+Fast.ruby_files_from('lib') # => ["lib/fast.rb"]
 ```
 
 ## `fast` in the command line
@@ -423,7 +434,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 On the console we have a few functions like `s` and `code` to make it easy ;)
 
-$ bin/console
+    $ bin/console
 
 ```ruby
 code("a = 1") # => s(:lvasgn, s(:int, 1))

data/bin/fast-experiment

@@ -13,9 +13,7 @@ experiment_files.each(&method(:require))
 experiments = []
 
 if arguments.any?
-  while arguments.any? && !(File.exist?(arguments.first) || Dir.exist?(arguments.first))
-    experiments << arguments.shift
-  end
+  experiments << arguments.shift while arguments.any? && !(File.exist?(arguments.first) || Dir.exist?(arguments.first))
   experiments.map! { |name| Fast.experiments[name] }
 else
   experiments = Fast.experiments.values

data/docs/pry-integration.md

@@ -0,0 +1,27 @@
+
+You can create a custom command in pry to reuse fast in any session.
+
+Start simply dropping it on your `.pryrc`:
+
+```ruby
+Pry::Commands.block_command "fast", "Fast search" do |expression, file|
+  require "fast"
+	files = Fast.ruby_files_from(file || '.')
+  files.each do |f|
+     results = Fast.search_file(expression, f)
+		 next if results.nil? || results.empty?
+     output.puts Fast.highlight("# #{f}")
+
+     results.each do |result|
+       output.puts Fast.highlight(result)
+     end
+  end
+end
+```
+
+And use it in the console:
+
+`pry
+fast '(def match?)' lib/fast.rb`
+```
+

data/examples/build_stubbed_and_let_it_be_experiment.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'fast'
+require 'open3'
+require 'ostruct'
+require 'fileutils'
+
+# Usage instructions:
+# 1. Add the following to your project's Gemfile: gem 'ffast' (yes, two "f"s)
+# 2. Copy this file to your Rails project root directory
+# 3. Run: bundle exec ruby build_stubbed_and_let_it_be_experiment.rb
+
+# List of spec files you want to experiment with. One per line.
+FILE_NAMES = %w[
+  # spec/model/foo_spec.rb
+  # spec/model/bar_spec.rb
+]
+
+def execute_rspec(file_name)
+  rspec_command = "bin/spring rspec --fail-fast --format progress #{file_name}"
+  stdout_str, stderr_str, status = Open3.capture3(rspec_command)
+  execution_time = /Finished in (.*?) seconds/.match(stdout_str)[1]
+  print stderr_str.gsub(/Running via Spring preloader.*?$/, '').chomp unless status.success?
+  OpenStruct.new(success: status.success?, execution_time: execution_time)
+end
+
+def delete_temp_files(original_file_name)
+  file_path = File.dirname(original_file_name)
+  file_name = File.basename(original_file_name)
+  Dir.glob("#{file_path}/experiment*#{file_name}").each { |file| File.delete(file)}
+end
+
+FILE_NAMES.each do |original_file_name|
+  Fast.experiment('RSpec/ReplaceCreateWithBuildStubbed') do
+    lookup original_file_name
+    search '(block (send nil let (sym _)) (args) $(send nil create))'
+    edit { |_, (create)| replace(create.loc.selector, 'build_stubbed') }
+    policy { |experiment_file_name| execute_rspec(experiment_file_name) }
+  end.run
+
+  Fast.experiment('RSpec/LetItBe') do
+    lookup original_file_name
+    search '(block $(send nil let! (sym _)) (args) (send nil create))'
+    edit { |_, (let)| replace(let.loc.selector, 'let_it_be') }
+    policy { |experiment_file_name| execute_rspec(experiment_file_name) }
+  end.run
+
+  delete_temp_files(original_file_name)
+end
+
+

data/lib/fast.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'fileutils'
+
 # suppress output to avoid parser gem warnings'
 def suppress_output
   original_stdout = $stdout.clone
@@ -21,7 +23,7 @@ end
 module Fast
   LITERAL = {
     '...' => ->(node) { node&.children&.any? },
-    '_'   => ->(node) { !node.nil? },
+    '_' => ->(node) { !node.nil? },
     'nil' => nil
   }.freeze
 
@@ -55,7 +57,7 @@ module Fast
     \\\d                  # find using captured expression
     |
     %\d                   # find using binded argument
-  /x
+  /x.freeze
 
   class << self
     def match?(ast, search, *args)
@@ -85,6 +87,11 @@ module Fast
       search node, pattern
     end
 
+    def capture_file(pattern, file)
+      node = ast_from_file(file)
+      capture node, pattern
+    end
+
     def search(node, pattern)
       if (match = Fast.match?(node, pattern))
         yield node, match if block_given?
@@ -93,7 +100,7 @@ module Fast
         node.children
           .grep(Parser::AST::Node)
           .flat_map { |e| search(e, pattern) }
-          .compact.uniq.flatten
+          .compact.flatten
       end
     end
 
@@ -577,6 +584,7 @@ module Fast
 
     def initialize(name, &block)
       @name = name
+      puts "\nStarting experiment: #{name}"
       instance_exec(&block)
     end
 
@@ -609,17 +617,63 @@ module Fast
     end
   end
 
+  # Suggest possible combinations of occurrences to replace.
+  class ExperimentCombinations
+    attr_reader :combinations
+
+    def initialize(round:, occurrences_count:, ok_experiments:, fail_experiments:)
+      @round = round
+      @ok_experiments = ok_experiments
+      @fail_experiments = fail_experiments
+      @occurrences_count = occurrences_count
+    end
+
+    def generate_combinations
+      case @round
+      when 1
+        individual_replacements
+      when 2
+        all_ok_replacements_combined
+      else
+        ok_replacements_pair_combinations
+      end
+    end
+
+    # Replace a single occurrence at each iteration and identify which
+    # individual replacements work.
+    def individual_replacements
+      (1..@occurrences_count).to_a
+    end
+
+    # After identifying all individual replacements that work, try combining all
+    # of them.
+    def all_ok_replacements_combined
+      [@ok_experiments.uniq.sort]
+    end
+
+    # Combining all successful individual replacements has failed. Lets divide
+    # and conquer.
+    def ok_replacements_pair_combinations
+      @ok_experiments
+        .combination(2)
+        .map { |e| e.flatten.uniq.sort }
+        .uniq - @fail_experiments - @ok_experiments
+    end
+  end
+
   # Encapsulate the join of an Experiment with an specific file.
   # This is important to coordinate and regulate multiple experiments in the same file.
   # It can track successfull experiments and failures and suggest new combinations to keep replacing the file.
   class ExperimentFile
     attr_reader :ok_experiments, :fail_experiments, :experiment
+
     def initialize(file, experiment)
       @file = file
       @ast = Fast.ast_from_file(file) if file
       @experiment = experiment
       @ok_experiments = []
       @fail_experiments = []
+      @round = 0
     end
 
     def search
@@ -677,33 +731,34 @@ module Fast
       filename
     end
 
-    def suggest_combinations
-      if @ok_experiments.empty? && @fail_experiments.empty?
-        (1..search_cases.size).to_a
-      else
-        @ok_experiments
-          .combination(2)
-          .map { |e| e.flatten.uniq.sort }
-          .uniq - @fail_experiments - @ok_experiments
-      end
-    end
-
     def done!
       count_executed_combinations = @fail_experiments.size + @ok_experiments.size
-      puts "Done with #{@file} after #{count_executed_combinations}"
+      puts "Done with #{@file} after #{count_executed_combinations} combinations"
       return unless perfect_combination = @ok_experiments.last # rubocop:disable Lint/AssignmentInCondition
 
+      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}`
     end
 
+    def build_combinations
+      @round += 1
+      ExperimentCombinations.new(
+        round: @round,
+        occurrences_count: search_cases.size,
+        ok_experiments: @ok_experiments,
+        fail_experiments: @fail_experiments
+      ).generate_combinations
+    end
+
     def run
-      while (combinations = suggest_combinations).any?
-        if combinations.size > 50
-          puts "Ignoring #{@file} because it have #{combinations.size} possible combinations"
+      while (combinations = build_combinations).any?
+        if combinations.size > 1000
+          puts "Ignoring #{@file} because it has #{combinations.size} possible combinations"
           break
         end
-        puts "#{@file} - Possible combinations: #{combinations.inspect}"
+        puts "#{@file} - Round #{@round} - Possible combinations: #{combinations.inspect}"
         while combination = combinations.shift # rubocop:disable Lint/AssignmentInCondition
           run_partial_replacement_with(combination)
         end
@@ -711,28 +766,23 @@ module Fast
       done!
     end
 
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/AbcSize
-    def run_partial_replacement_with(combination)
-      puts "#{@file} applying partial replacement with: #{combination}"
+    def run_partial_replacement_with(combination) # rubocop:disable Metrics/AbcSize
       content = partial_replace(*combination)
       experimental_file = experimental_filename(combination)
-      puts `diff #{experimental_file} #{@file}`
-      if experimental_file == IO.read(@file)
-        raise 'Returned the same file thinking:'
-      end
 
       File.open(experimental_file, 'w+') { |f| f.puts content }
 
-      if experiment.ok_if.call(experimental_file)
+      raise 'No changes were made to the file.' if FileUtils.compare_file(@file, experimental_file)
+
+      result = experiment.ok_if.call(experimental_file)
+
+      if result.success
         ok_with(combination)
-        puts "✅ #{combination} #{experimental_file}"
+        puts "✅ #{experimental_file} - Combination: #{combination} - Time: #{result.execution_time}s"
       else
         failed_with(combination)
-        puts "🔴 #{combination} #{experimental_file}"
+        puts "🔴 #{experimental_file} - Combination: #{combination}"
       end
     end
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/fast/version.rb

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

data/mkdocs.yml

@@ -17,5 +17,6 @@ nav:
   - Introduction: index.md
   - Syntax: syntax.md
   - Command Line: command_line.md
+  - Pry Integration: pry-integration.md
   - Experiments: experiments.md
   - Code Similarity: similarity_tutorial.md

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffast
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Jônatas Davi Paganini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-22 00:00:00.000000000 Z
+date: 2019-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coderay
@@ -205,8 +205,10 @@ files:
 - docs/command_line.md
 - docs/experiments.md
 - docs/index.md
+- docs/pry-integration.md
 - docs/similarity_tutorial.md
 - docs/syntax.md
+- examples/build_stubbed_and_let_it_be_experiment.rb
 - examples/experimental_replacement.rb
 - examples/find_usage.rb
 - examples/let_it_be_experiment.rb