ffast 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36aaca199777feb62d91a6e052c038f4a971ab20fd37f1adcb7b0c8d3a90553b
-  data.tar.gz: 0ab405982443936ecaad957b43100496dce63d213e2a61c840b3002028c245e8
+  metadata.gz: 5e62b5be6bf84eabaa2ed601696164c248a6969cc504343f636b1d487bb4fbf2
+  data.tar.gz: a86d3f27396de8cb9aa097c02d1baf19c39ad7090f03b5894e1eddb087150f6b
 SHA512:
-  metadata.gz: 32a5615982972c2e13582a8279cf94043a3a571044a6b1a04fee253f04c7ff93733eab4fca22f2878dc3e16d519cb3d78f06adafbe4b6bb998a72bea97929bc6
-  data.tar.gz: 277f3082ab12c310be88c1bda1d8fa57be86bae02ddc39c8c5adb6e49704aec036c801abe6d6f18527f23996d560bd95d199cb6c0209c72474acc1c031600bc0
+  metadata.gz: 4a2a7db73282e36fd8ece6d9d78b55eb52e98227e5be77d77058a82ae97af634e94de7dd5f98640a844739956f5e8c5bf9f2fd91e88971d21da6a762cf69fdbb
+  data.tar.gz: 635bd2bb2a9e26975731fa4096f7980281ef929d2ae13d54f8f4897e8695d6e824deb15ed4cea6e6df9114191e99e210510a5878dc703910b711e1a17c446a68

data/bin/fast-experiment

@@ -4,6 +4,7 @@
 $LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
 
 require 'fast'
+require 'fast/experiment'
 require 'coderay'
 
 arguments = ARGV

data/lib/fast.rb

@@ -69,7 +69,7 @@ module Fast
       Matcher.new(ast, search, *args).match?
     end
 
-    def replace(ast, search, replacement)
+    def replace(ast, search, &replacement)
       buffer = Parser::Source::Buffer.new('replacement')
       buffer.source = ast.loc.expression.source
       to_replace = search(ast, search)
@@ -82,9 +82,9 @@ module Fast
       rewriter.rewrite(buffer, ast)
     end
 
-    def replace_file(file, search, replacement)
+    def replace_file(file, search, &replacement)
       ast = ast_from_file(file)
-      replace(ast, search, replacement)
+      replace(ast, search, &replacement)
     end
 
     def search_file(pattern, file)
@@ -152,13 +152,6 @@ module Fast
     def expression(string)
       ExpressionParser.new(string).parse
     end
-
-    def experiment(name, &block)
-      @experiments ||= {}
-      @experiments[name] = Experiment.new(name, &block)
-    end
-
-    attr_reader :experiments
     attr_accessor :debugging
 
     def debug
@@ -540,7 +533,6 @@ module Fast
       end
     end
 
-    # rubocop:disable Metrics/AbcSize
     def match?(ast = @ast, fast = @fast)
       head, *tail = fast
       return false unless head.match?(ast)
@@ -555,8 +547,6 @@ module Fast
       end && find_captures
     end
 
-    # rubocop:enable Metrics/AbcSize
-
     def prepare_token(token)
       case token
       when Fast::FindWithCapture
@@ -582,224 +572,4 @@ module Fast
       end
     end
   end
-
-  # You can define experiments and build experimental files to improve some code in
-  # an automated way. Let's create a hook to check if a `before` or `after` block
-  # is useless in a specific spec:
-  #
-  # ```ruby
-  # Fast.experiment("RSpec/RemoveUselessBeforeAfterHook") do
-  #   lookup 'some_spec.rb'
-  #   search "(block (send nil {before after}))"
-  #   edit {|node| remove(node.loc.expression) }
-  #   policy {|new_file| system("bin/spring rspec --fail-fast #{new_file}") }
-  # end
-  # ```
-  class Experiment
-    attr_writer :files
-    attr_reader :name, :replacement, :expression, :files_or_folders, :ok_if
-
-    def initialize(name, &block)
-      @name = name
-      puts "\nStarting experiment: #{name}"
-      instance_exec(&block)
-    end
-
-    def run_with(file)
-      ExperimentFile.new(file, self).run
-    end
-
-    def search(expression)
-      @expression = expression
-    end
-
-    def edit(&block)
-      @replacement = block
-    end
-
-    def lookup(files_or_folders)
-      @files_or_folders = files_or_folders
-    end
-
-    def policy(&block)
-      @ok_if = block
-    end
-
-    def files
-      @files ||= Fast.ruby_files_from(@files_or_folders)
-    end
-
-    def run
-      files.map(&method(:run_with))
-    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
-      experiment.expression
-    end
-
-    def experimental_filename(combination)
-      parts = @file.split('/')
-      dir = parts[0..-2]
-      filename = "experiment_#{[*combination].join('_')}_#{parts[-1]}"
-      File.join(*dir, filename)
-    end
-
-    def ok_with(combination)
-      @ok_experiments << combination
-      return unless combination.is_a?(Array)
-
-      combination.each do |element|
-        @ok_experiments.delete(element)
-      end
-    end
-
-    def failed_with(combination)
-      @fail_experiments << combination
-    end
-
-    def search_cases
-      Fast.search(@ast, experiment.expression) || []
-    end
-
-    # rubocop:disable Metrics/AbcSize
-    # rubocop:disable Metrics/MethodLength
-    def partial_replace(*indices)
-      replacement = experiment.replacement
-      new_content = Fast.replace_file @file, experiment.expression, ->(node, *captures) do # rubocop:disable Style/Lambda
-        if indices.nil? || indices.empty? || indices.include?(match_index)
-          if replacement.parameters.length == 1
-            instance_exec node, &replacement
-          else
-            instance_exec node, *captures, &replacement
-          end
-        end
-      end
-      return unless new_content
-
-      write_experiment_file(indices, new_content)
-      new_content
-    end
-    # rubocop:enable Metrics/AbcSize
-    # rubocop:enable Metrics/MethodLength
-
-    def write_experiment_file(index, new_content)
-      filename = experimental_filename(index)
-      File.open(filename, 'w+') { |f| f.puts new_content }
-      filename
-    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
-
-      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 = build_combinations).any?
-        if combinations.size > 1000
-          puts "Ignoring #{@file} because it has #{combinations.size} possible combinations"
-          break
-        end
-        puts "#{@file} - Round #{@round} - Possible combinations: #{combinations.inspect}"
-        while combination = combinations.shift # rubocop:disable Lint/AssignmentInCondition
-          run_partial_replacement_with(combination)
-        end
-      end
-      done!
-    end
-
-    def run_partial_replacement_with(combination) # rubocop:disable Metrics/AbcSize
-      content = partial_replace(*combination)
-      experimental_file = experimental_filename(combination)
-
-      File.open(experimental_file, 'w+') { |f| f.puts content }
-
-      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 "✅ #{experimental_file} - Combination: #{combination} - Time: #{result.execution_time}s"
-      else
-        failed_with(combination)
-        puts "🔴 #{experimental_file} - Combination: #{combination}"
-      end
-    end
-  end
 end

data/lib/fast/cli.rb

@@ -117,9 +117,7 @@ module Fast
     end
 
     def debug(*info)
-      return unless @debug
-
-      puts info
+      puts(info) if debug_mode?
     end
 
     def report(result, file)

data/lib/fast/experiment.rb

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+
+require 'fast'
+
+module Fast
+  class << self
+    # Fast.experiment is a shortcut to define new experiments and allow them to
+    # work together in experiment combinantions.
+    #
+    # The following experiment look into `spec` folder and try to remove
+    # `before` and `after` blocks on testing code. Sometimes they're not
+    # effective and we can avoid the hard work of do it manually.
+    #
+    # If the spec does not fail, it keeps the change.
+    #
+    #  Fast.experiment("RSpec/RemoveUselessBeforeAfterHook") do
+    #    lookup 'spec'
+    #    search "(block (send nil {before after}))"
+    #    edit { |node| remove(node.loc.expression) }
+    #    policy { |new_file| system("rspec --fail-fast #{new_file}") }
+    #  end
+    def experiment(name, &block)
+      @experiments ||= {}
+      @experiments[name] = Experiment.new(name, &block)
+    end
+
+    attr_reader :experiments
+  end
+
+  # You can define experiments and build experimental files to improve some code in
+  # an automated way. Let's create a hook to check if a `before` or `after` block
+  # is useless in a specific spec:
+  #
+  # ```ruby
+  # Fast.experiment("RSpec/RemoveUselessBeforeAfterHook") do
+  #   lookup 'some_spec.rb'
+  #   search "(block (send nil {before after}))"
+  #   edit {|node| remove(node.loc.expression) }
+  #   policy {|new_file| system("bin/spring rspec --fail-fast #{new_file}") }
+  # end
+  # ```
+  class Experiment
+    attr_writer :files
+    attr_reader :name, :replacement, :expression, :files_or_folders, :ok_if
+
+    def initialize(name, &block)
+      @name = name
+      puts "\nStarting experiment: #{name}"
+      instance_exec(&block)
+    end
+
+    def run_with(file)
+      ExperimentFile.new(file, self).run
+    end
+
+    def search(expression)
+      @expression = expression
+    end
+
+    def edit(&block)
+      @replacement = block
+    end
+
+    def lookup(files_or_folders)
+      @files_or_folders = files_or_folders
+    end
+
+    def policy(&block)
+      @ok_if = block
+    end
+
+    def files
+      @files ||= Fast.ruby_files_from(@files_or_folders)
+    end
+
+    def run
+      files.map(&method(:run_with))
+    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
+      experiment.expression
+    end
+
+    def experimental_filename(combination)
+      parts = @file.split('/')
+      dir = parts[0..-2]
+      filename = "experiment_#{[*combination].join('_')}_#{parts[-1]}"
+      File.join(*dir, filename)
+    end
+
+    def ok_with(combination)
+      @ok_experiments << combination
+      return unless combination.is_a?(Array)
+
+      combination.each do |element|
+        @ok_experiments.delete(element)
+      end
+    end
+
+    def failed_with(combination)
+      @fail_experiments << combination
+    end
+
+    def search_cases
+      Fast.search(@ast, experiment.expression) || []
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
+    def partial_replace(*indices)
+      replacement = experiment.replacement
+      new_content = Fast.replace_file @file, experiment.expression do |node, *captures|
+        if indices.nil? || indices.empty? || indices.include?(match_index)
+          if replacement.parameters.length == 1
+            instance_exec node, &replacement
+          else
+            instance_exec node, *captures, &replacement
+          end
+        end
+      end
+      return unless new_content
+
+      write_experiment_file(indices, new_content)
+      new_content
+    end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
+
+    def write_experiment_file(index, new_content)
+      filename = experimental_filename(index)
+      File.open(filename, 'w+') { |f| f.puts new_content }
+      filename
+    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
+
+      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 = build_combinations).any?
+        if combinations.size > 1000
+          puts "Ignoring #{@file} because it has #{combinations.size} possible combinations"
+          break
+        end
+        puts "#{@file} - Round #{@round} - Possible combinations: #{combinations.inspect}"
+        while combination = combinations.shift # rubocop:disable Lint/AssignmentInCondition
+          run_partial_replacement_with(combination)
+        end
+      end
+      done!
+    end
+
+    def run_partial_replacement_with(combination) # rubocop:disable Metrics/AbcSize
+      content = partial_replace(*combination)
+      experimental_file = experimental_filename(combination)
+
+      File.open(experimental_file, 'w+') { |f| f.puts content }
+
+      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 "✅ #{experimental_file} - Combination: #{combination} - Time: #{result.execution_time}s"
+      else
+        failed_with(combination)
+        puts "🔴 #{experimental_file} - Combination: #{combination}"
+      end
+    end
+  end
+end

data/lib/fast/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffast
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Jônatas Davi Paganini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-24 00:00:00.000000000 Z
+date: 2019-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: astrolabe
@@ -235,6 +235,7 @@ files:
 - fast.gemspec
 - lib/fast.rb
 - lib/fast/cli.rb
+- lib/fast/experiment.rb
 - lib/fast/version.rb
 - mkdocs.yml
 homepage: https://jonatas.github.io/fast/