rspec-search-and-destroy 0.0.3 → 0.0.4

data/README.md

@@ -13,7 +13,7 @@ debug.
 First, add the appropriate hooks in your `spec_helper.rb`:
 
 ```ruby
-require 'rspec-sad'
+require 'rspec-search-and-destroy'
 
 RSpec.configure do |config|
   RSpecSearchAndDestroy.configure(config)

data/bin/rspec-sad

@@ -1,21 +1,13 @@
 #!/usr/bin/env ruby
 
-require 'rspec-sad'
-
+require 'rspec-search-and-destroy'
 require 'rspec-search-and-destroy/binary_chop_example_selector'
 require 'rspec-search-and-destroy/rspec_driver'
 require 'rspec-search-and-destroy/bisector'
+require 'rspec-search-and-destroy/io_output'
 
 include RSpecSearchAndDestroy
 
-class TTYOutput
-  def found(causal_example, failed_example)
-    puts "Culprit found"
-    puts "Run    #{causal_example[:location]}"
-    puts "Before #{failed_example[:location]}"
-  end
-end
-
 require 'optparse'
 
 driver_options = {}
@@ -35,8 +27,7 @@ BANNER
 end
 option_parser.parse!
 
-
-output = TTYOutput.new
+output = IOOutput.new
 selector = BinaryChopExampleSelector.new
 driver = RSpecDriver.new(driver_options)
 

data/features/support/steps.rb

@@ -1,6 +1,6 @@
 Given(/^a configured spec\/spec_helper\.rb$/) do
   config = <<CONFIG
-require 'rspec-sad'
+require 'rspec-search-and-destroy'
 
 RSpec.configure do |config|
   RSpecSearchAndDestroy.configure(config)

data/lib/rspec-search-and-destroy/bisection_progress.rb

@@ -0,0 +1,41 @@
+class BisectionProgress
+  attr_reader :iteration, :enabled_examples, :total_examples, :start_time
+
+  def initialize(attributes = {})
+    @iteration = attributes.fetch(:iteration) { 1 }
+    @enabled_examples = attributes.fetch(:enabled_examples)
+    @total_examples = attributes.fetch(:total_examples)
+    @time_provider = attributes.fetch(:time_provider) { Time }
+    @start_time = attributes.fetch(:start_time) { @time_provider.now }
+  end
+
+  def next_iteration(enabled_examples)
+    self.class.new(iteration: iteration + 1,
+                   enabled_examples: enabled_examples,
+                   total_examples: total_examples,
+                   time_provider: @time_provider,
+                   start_time: start_time)
+  end
+
+  def run_time
+    @time_provider.now - @start_time
+  end
+
+  def ==(other)
+    values.map do |v|
+      self.send(v) == other.send(v)
+    end.all?
+  end
+
+  def hash
+    values.map do |v|
+      self.send(v).hash
+    end.reduce(:^)
+  end
+
+  private
+
+  def values
+    [:iteration, :enabled_examples, :total_examples]
+  end
+end

data/lib/rspec-search-and-destroy/bisector.rb

@@ -1,3 +1,5 @@
+require_relative 'bisection_progress'
+
 module RSpecSearchAndDestroy
   class Bisector
     attr_reader :output, :selector, :executor
@@ -8,7 +10,7 @@ module RSpecSearchAndDestroy
       @executor = executor
     end
 
-    def bisect(causal_examples, failed_example)
+    def bisect(causal_examples, failed_example, progress = nil)
       case causal_examples.size
       when 1
         output.found(causal_examples.first, failed_example)
@@ -19,17 +21,22 @@ module RSpecSearchAndDestroy
       end
 
       enabled, disabled = selector.enable_set(causal_examples)
-
       to_run = enabled + [failed_example]
-      executor.run_examples(to_run)
 
+      progress =
+        if progress
+          progress.next_iteration(enabled.size)
+        else
+          BisectionProgress.new(total_examples: causal_examples.size,
+                                enabled_examples: enabled.size)
+        end
+      output.progress(progress)
+
+      executor.run_examples(to_run)
       results = executor.load_run_results
 
-      if results.failed?
-        bisect(enabled, failed_example)
-      else
-        bisect(disabled, failed_example)
-      end
+      next_set = results.failed? ? enabled : disabled
+      bisect(next_set, failed_example, progress)
     end
   end
 end

data/lib/rspec-search-and-destroy/io_output.rb

@@ -0,0 +1,47 @@
+class IOOutput
+  attr_reader :io
+
+  SEPARATOR = "-" * 20
+
+  def initialize(io = STDOUT)
+    @io = io
+  end
+
+  def found(causal_example, failed_example)
+    io.puts <<FOUND
+#{SEPARATOR}
+Culprit found
+Run    #{causal_example[:location]}
+Before #{failed_example[:location]}
+FOUND
+  end
+
+  def progress(state)
+    run_time = Duration.new(state.run_time)
+
+    io.puts <<PROGRESS
+#{SEPARATOR}
+Iteration #{state.iteration}
+#{state.enabled_examples} / #{state.total_examples} examples enabled
+Running for #{run_time}
+PROGRESS
+  end
+
+  private
+
+  class Duration
+    attr_reader :hours, :minutes, :seconds
+
+    def initialize(duration_as_seconds)
+      total_seconds = duration_as_seconds.to_f.ceil.to_i
+
+      @seconds = total_seconds % 60
+      @minutes = (total_seconds / 60) % 60
+      @hours = total_seconds / (60 * 60)
+    end
+
+    def to_s
+      "%02d:%02d:%02d" % [hours, minutes, seconds]
+    end
+  end
+end

data/lib/rspec-search-and-destroy/version.rb

@@ -1,3 +1,3 @@
 module RSpecSearchAndDestroy
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/bisector_spec.rb

@@ -1,14 +1,15 @@
 require 'spec_helper'
 require 'rspec-search-and-destroy/bisector.rb'
+require 'rspec-search-and-destroy/binary_chop_example_selector.rb'
 
 describe RSpecSearchAndDestroy::Bisector do
   subject(:bisector) do
     RSpecSearchAndDestroy::Bisector.new(output, selector, executor)
   end
 
-  let(:output)   { double("output") }
+  let(:output)   { double("output").as_null_object }
   let(:selector) { double("selector") }
-  let(:executor) { double("executor") }
+  let(:executor) { double("executor").as_null_object }
 
   let(:failing_example) { double("failing example") }
 
@@ -34,7 +35,7 @@ describe RSpecSearchAndDestroy::Bisector do
   end
 
   context "when executing examples" do
-    let(:potential_causes) { 2.times.map {|i| double("potential example #{i}")} }
+    let(:potential_causes) { build_examples(2) }
     let(:enabled_examples) { [potential_causes.first] }
     let(:disabled_examples) { [potential_causes.last] }
 
@@ -46,7 +47,6 @@ describe RSpecSearchAndDestroy::Bisector do
       # they are just needed to prevent failure
       results = double("results", :failed? => true)
       executor.stub(:load_run_results).and_return(results)
-      output.stub(:found)
     end
 
     it "executes enabled examples" do
@@ -75,7 +75,6 @@ describe RSpecSearchAndDestroy::Bisector do
 
     context "when the executed tests fail" do
       before do
-        executor.stub(:run_examples)
         results = double("results", :failed? => true)
         executor.stub(:load_run_results).and_return(results)
       end
@@ -90,7 +89,6 @@ describe RSpecSearchAndDestroy::Bisector do
 
     context "when the executed tests do not fail" do
       before do
-        executor.stub(:run_examples)
         results = double("results", :failed? => false)
         executor.stub(:load_run_results).and_return(results)
       end
@@ -103,4 +101,36 @@ describe RSpecSearchAndDestroy::Bisector do
       end
     end
   end
+
+  context "when reporting progress" do
+    let(:potential_causes) { build_examples(3) }
+    let(:selector) { RSpecSearchAndDestroy::BinaryChopExampleSelector.new }
+
+    before do
+      results = double("results", :failed? => false)
+      executor.stub(:load_run_results).and_return(results)
+    end
+
+    it "reports once for each iteration" do
+      progress_1 = BisectionProgress.new(iteration: 1,
+                                         total_examples: 3,
+                                         enabled_examples: 1)
+
+      progress_2 = BisectionProgress.new(iteration: 2,
+                                         total_examples: 3,
+                                         enabled_examples: 1)
+
+      expect(output).to receive(:progress)
+        .with(progress_1).ordered
+
+      expect(output).to receive(:progress)
+        .with(progress_2).ordered
+
+      bisector.bisect(potential_causes, failing_example)
+    end
+  end
+
+  def build_examples(count)
+    count.times.map {|i| double("potential example #{i}")}
+  end
 end

data/spec/io_output_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'rspec-search-and-destroy/io_output.rb'
+
+module RSpecSearchAndDestroy
+  describe IOOutput do
+    let(:output) { IOOutput.new(io) }
+    let(:io) { StringIO.new }
+    subject(:string) { io.string }
+
+    context "when reporting the culprit" do
+      let(:causal_example) { {location: "cause location"} }
+      let(:failed_example) { {location: "fail location"} }
+
+      before do
+        output.found(causal_example, failed_example)
+      end
+
+      it "includes the example that causes the problem" do
+        expect(string).to match /Run\s+cause location/
+      end
+
+      it "includes the example that fails" do
+        expect(string).to match /Before\s+fail location/
+      end
+    end
+
+    context "when reporting progress" do
+      let(:progress) do
+        BisectionProgress.new(iteration: 5,
+                              enabled_examples: 54,
+                              total_examples: 999)
+      end
+
+      before do
+        output.progress(progress)
+      end
+
+      it "includes the current iteration" do
+        expect(string).to match /Iteration 5/
+      end
+
+      it "includes the number of enabled examples" do
+        expect(string).to match /54.*examples/
+      end
+
+      it "includes the total number of examples" do
+        expect(string).to match /999.*examples/
+      end
+
+      it "includes the running time" do
+        expect(string).to match /Running for \d{2}:\d{2}:\d{2}/
+      end
+    end
+  end
+end

data/spec/rspec_example_ordering_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'rspec-sad'
+require 'rspec-search-and-destroy'
 
 describe RSpecSearchAndDestroy::ReorderAndFilter do
   subject(:ordering_block) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-search-and-destroy
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-08 00:00:00.000000000 Z
+date: 2013-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -98,9 +98,11 @@ files:
 - features/running_rspec_without_sad.feature
 - features/support/env.rb
 - features/support/steps.rb
-- lib/rspec-sad.rb
+- lib/rspec-search-and-destroy.rb
 - lib/rspec-search-and-destroy/binary_chop_example_selector.rb
+- lib/rspec-search-and-destroy/bisection_progress.rb
 - lib/rspec-search-and-destroy/bisector.rb
+- lib/rspec-search-and-destroy/io_output.rb
 - lib/rspec-search-and-destroy/location_source.rb
 - lib/rspec-search-and-destroy/order_formatter.rb
 - lib/rspec-search-and-destroy/reorder_and_filter.rb
@@ -110,6 +112,7 @@ files:
 - rspec-search-and-destroy.gemspec
 - spec/binary_chop_example_selector_spec.rb
 - spec/bisector_spec.rb
+- spec/io_output_spec.rb
 - spec/rspec_example_ordering_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/shepmaster/rspec-search-and-destroy
@@ -147,5 +150,6 @@ test_files:
 - features/support/steps.rb
 - spec/binary_chop_example_selector_spec.rb
 - spec/bisector_spec.rb
+- spec/io_output_spec.rb
 - spec/rspec_example_ordering_spec.rb
 - spec/spec_helper.rb