rspec-search-and-destroy 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.3"
+script: cucumber

data/bin/rspec-sad

@@ -3,6 +3,10 @@
 $LOAD_PATH << "$PWD/../lib/"
 require 'rspec-sad'
 
+require 'rspec-search-and-destroy/binary_chop_example_selector'
+require 'rspec-search-and-destroy/rspec_driver'
+require 'rspec-search-and-destroy/bisector'
+
 include RSpecSearchAndDestroy
 
 class TTYOutput

data/features/before_all_blocks_are_disabled.feature

@@ -0,0 +1,41 @@
+Feature: `before(:all)` blocks are disabled when all of the examples are also disabled
+
+Scenario: Run it
+  Given a file named "spec/spec_helper.rb" with:
+    """ruby
+    require 'rspec-sad'
+
+    RSpec.configure do |config|
+      RSpecSearchAndDestroy.configure(config)
+    end
+    """
+  And a file named "spec/before_all_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    describe 'Tests that have before :all' do
+      context do
+        before(:all) { puts 'example 1 - before :all' }
+        it 'leaves bad global state' do
+          $global_state = true
+          expect($global_state).to be true
+        end
+      end
+
+      context do
+        before(:all) { puts 'example 2 - before :all' }
+        it do
+          expect(true).to be true
+        end
+      end
+
+      context do
+        before(:all) { puts 'example 3 - before :all' }
+        it 'relies on global state' do
+          expect($global_state).to be false
+        end
+      end
+    end
+    """
+  When I run `rspec-sad`
+  Then the output should contain "example 2 - before :all" 1 time

data/features/bisecting_a_single_file.feature

@@ -0,0 +1,34 @@
+Feature: Bisecting a single file
+
+Scenario: Run it
+  Given a file named "spec/spec_helper.rb" with:
+    """ruby
+    require 'rspec-sad'
+
+    RSpec.configure do |config|
+      RSpecSearchAndDestroy.configure(config)
+    end
+    """
+  And a file named "spec/single_file_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    describe "Tests that fail when run in a specific order" do
+      it "leaves bad global state" do
+        $global_state = true
+        expect($global_state).to be true
+      end
+
+      it "just takes up space" do
+        expect(true).to be true
+      end
+
+      it "fails when run last" do
+        expect($global_state).to be false
+      end
+    end
+    """
+  When I run `rspec-sad`
+  Then the output should contain "Culprit found"
+  And the output should contain "Run    ./spec/single_file_spec.rb:4"
+  And the output should contain "Before ./spec/single_file_spec.rb:13"

data/features/bisecting_multiple_files.feature

@@ -0,0 +1,46 @@
+Feature: Bisecting multiple files
+
+Scenario: Run it
+  Given a file named "spec/spec_helper.rb" with:
+    """ruby
+    require 'rspec-sad'
+
+    RSpec.configure do |config|
+      RSpecSearchAndDestroy.configure(config)
+    end
+    """
+  And a file named "spec/file_1_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    describe 'group 1' do
+      it '1 - sets bad global state' do
+        $global_state = true
+        expect($global_state).to be_true
+      end
+    end
+    """
+  And a file named "spec/file_2_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    describe 'group 2' do
+      it '2 - just takes up space' do
+        expect(true).to be_true
+      end
+    end
+    """
+  And a file named "spec/file_3_spec.rb" with:
+    """ruby
+    require 'spec_helper'
+
+    describe 'group 3' do
+      it '3 - fails because of global state' do
+        expect($global_state).to be_false
+      end
+    end
+    """
+  When I run `rspec-sad`
+  Then the output should contain "Culprit found"
+  And the output should contain "Run    ./spec/file_1_spec.rb:4"
+  And the output should contain "Before ./spec/file_3_spec.rb:4"

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/features/support/steps.rb

@@ -0,0 +1,4 @@
+Then(/^the output should contain "(.*?)" (\d+) times?$/) do |expected_output, expected_count|
+  actual_count = all_output.scan(expected_output).length
+  expect(actual_count).to eql expected_count.to_i
+end

data/lib/rspec-sad.rb

@@ -1,9 +1,8 @@
-require "rspec-search-and-destroy/version"
-require "rspec-search-and-destroy/bisector"
-require "rspec-search-and-destroy/binary_chop_example_selector"
+require 'rspec-search-and-destroy/version'
 
-require 'rspec'
-require 'rspec/core/formatters/base_formatter'
+require 'rspec-search-and-destroy/order_formatter'
+require 'rspec-search-and-destroy/location_source'
+require 'rspec-search-and-destroy/reorder_and_filter'
 
 module RSpecSearchAndDestroy
   def self.configure(config)
@@ -12,146 +11,9 @@ module RSpecSearchAndDestroy
     source = LocationSource.new
     if source.enabled?
       ordering = ReorderAndFilter.new(source)
-      config.order_examples(&ordering.block)
-    end
-  end
-
-  class OrderFormatter < RSpec::Core::Formatters::BaseFormatter
-    def stop
-      File.open(filename, 'wb') do |f|
-        Marshal.dump(results, f)
-      end
-
-      super
-    end
-
-    private
-
-    def filename
-      ENV['RSPEC_SAD_RESULTS'] or raise "No result filename provided"
-    end
-
-    def results
-      examples.map do |e|
-        {
-          location: e.location,
-          failed: !!e.exception
-        }
-      end
-    end
-  end
-
-  class LocationSource
-    def enabled?
-      filename && File.exist?(filename)
-    end
-
-    def example_locations_to_run
-      raise "LocationSource is not currently enabled" unless enabled?
-
-      File.open(filename, 'rb') do |f|
-        Marshal.load(f)
-      end
-    end
-
-    private
-
-    def filename
-      ENV['RSPEC_SAD_EXAMPLES']
-    end
-  end
-
-  class ReorderAndFilter
-    attr_reader :source
-
-    def initialize(source)
-      @source = source
-    end
-
-    def block
-      lambda do |examples|
-        locations = source.example_locations_to_run
-
-        enabled_examples = examples.select do |e|
-          locations.include? e.location
-        end
-
-        enabled_examples.sort_by do |e|
-          locations.index(e.location)
-        end
-      end
-    end
-  end
 
-  class RSpecResults
-    attr_reader :results
-
-    def initialize(results)
-      @results = results
-    end
-
-    def causal_examples
-      results.slice(0, failure_index)
-    end
-
-    def failed_example
-      results[failure_index]
-    end
-
-    def failed?
-      results.find {|result| result[:failed] }
-    end
-
-    private
-
-    def failure_index
-      @failure_index ||= results.find_index { |r| r[:failed] }
-    end
-  end
-
-  class RSpecDriver
-    RESULT_FILE = '/tmp/example-results'
-    EXAMPLE_FILE = '/tmp/examples-to-run'
-
-    def load_run_results
-      File.open(RESULT_FILE, 'rb') do |f|
-        RSpecResults.new(Marshal.load(f))
-      end
-    end
-
-    def initial_run
-      cleanup
-      run_rspec
-    end
-
-    def run_examples(examples)
-      locations = examples.map {|x| x[:location]}
-
-      File.open(EXAMPLE_FILE, 'wb') do |f|
-        Marshal.dump(locations, f)
-      end
-
-      run_rspec
-    end
-
-    def cleanup
-      [EXAMPLE_FILE, RESULT_FILE].each do |fname|
-        File.delete(fname) if File.exist? fname
-      end
-    end
-
-    private
-
-    def run_rspec
-      env = {
-        "RSPEC_SAD_EXAMPLES" => EXAMPLE_FILE,
-        "RSPEC_SAD_RESULTS" => RESULT_FILE
-      }
-      cmd = "rspec"
-
-      success = system(env, cmd)
-
-      raise "unable to run command: #{cmd}" if success.nil?
+      config.files_or_directories_to_run = source.example_locations_to_run
+      config.order_examples(&ordering.block)
     end
   end
 end

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

@@ -0,0 +1,21 @@
+module RSpecSearchAndDestroy
+  class LocationSource
+    def enabled?
+      filename && File.exist?(filename)
+    end
+
+    def example_locations_to_run
+      raise "LocationSource is not currently enabled" unless enabled?
+
+      File.open(filename, 'rb') do |f|
+        Marshal.load(f)
+      end
+    end
+
+    private
+
+    def filename
+      ENV['RSPEC_SAD_EXAMPLES']
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require 'rspec/core/formatters/base_formatter'
+
+module RSpecSearchAndDestroy
+  class OrderFormatter < RSpec::Core::Formatters::BaseFormatter
+    def stop
+      File.open(filename, 'wb') do |f|
+        Marshal.dump(results, f)
+      end
+
+      super
+    end
+
+    private
+
+    def filename
+      ENV['RSPEC_SAD_RESULTS'] or raise "No result filename provided"
+    end
+
+    def results
+      examples.map do |e|
+        {
+          location: e.location,
+          failed: !!e.exception
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module RSpecSearchAndDestroy
+  class ReorderAndFilter
+    attr_reader :source
+
+    def initialize(source)
+      @source = source
+    end
+
+    def block
+      lambda do |examples|
+        locations = source.example_locations_to_run
+
+        enabled_examples = examples.select do |e|
+          locations.include? e.location
+        end
+
+        enabled_examples.sort_by do |e|
+          locations.index(e.location)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+require_relative 'rspec_results'
+
+module RSpecSearchAndDestroy
+  class RSpecDriver
+    RESULT_FILE = '/tmp/example-results'
+    EXAMPLE_FILE = '/tmp/examples-to-run'
+
+    def load_run_results
+      unless File.exist? RESULT_FILE
+        raise <<ERR
+The RSpec result file was not created. Please ensure that SAD is
+added to your RSpec configuration.
+ERR
+      end
+
+      File.open(RESULT_FILE, 'rb') do |f|
+        RSpecResults.new(Marshal.load(f))
+      end
+    end
+
+    def initial_run
+      cleanup
+      run_rspec
+    end
+
+    def run_examples(examples)
+      locations = examples.map {|x| x[:location]}
+
+      File.open(EXAMPLE_FILE, 'wb') do |f|
+        Marshal.dump(locations, f)
+      end
+
+      run_rspec
+    end
+
+    def cleanup
+      [EXAMPLE_FILE, RESULT_FILE].each do |fname|
+        File.delete(fname) if File.exist? fname
+      end
+    end
+
+    private
+
+    def run_rspec
+      env = {
+        "RSPEC_SAD_EXAMPLES" => EXAMPLE_FILE,
+        "RSPEC_SAD_RESULTS" => RESULT_FILE
+      }
+      cmd = "rspec"
+
+      success = system(env, cmd)
+
+      raise "unable to run command: #{cmd}" if success.nil?
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module RSpecSearchAndDestroy
+  class RSpecResults
+    attr_reader :results
+
+    def initialize(results)
+      @results = results
+    end
+
+    def causal_examples
+      results.slice(0, failure_index)
+    end
+
+    def failed_example
+      results[failure_index]
+    end
+
+    def failed?
+      results.find {|result| result[:failed] }
+    end
+
+    private
+
+    def failure_index
+      @failure_index ||= results.find_index { |r| r[:failed] }
+    end
+  end
+end

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

@@ -1,3 +1,3 @@
 module RSpecSearchAndDestroy
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/rspec-search-and-destroy.gemspec

@@ -5,6 +5,7 @@ require 'rspec-search-and-destroy/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "rspec-search-and-destroy"
+  gem.license       = 'MIT'
   gem.version       = RSpecSearchAndDestroy::VERSION
   gem.authors       = ["Jake Goulding"]
   gem.email         = ["jake.goulding@gmail.com"]
@@ -17,5 +18,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency('rspec', '>= 2.14.0')
+  gem.add_dependency('rspec', '~> 2.12')
+
+  gem.add_development_dependency('rspec', '~> 2.14')
+  gem.add_development_dependency('aruba')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-search-and-destroy
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,56 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-24 00:00:00.000000000 Z
+date: 2013-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: '2.12'
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: '0'
 description: ! 'Finds RSpec test ordering bugs '
 email:
 - jake.goulding@gmail.com
@@ -37,16 +69,25 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/rspec-sad
-- examples/spec/bad_ordering_spec.rb
-- examples/spec/spec_helper.rb
+- features/before_all_blocks_are_disabled.feature
+- features/bisecting_a_single_file.feature
+- features/bisecting_multiple_files.feature
+- features/support/env.rb
+- features/support/steps.rb
 - lib/rspec-sad.rb
 - lib/rspec-search-and-destroy/binary_chop_example_selector.rb
 - lib/rspec-search-and-destroy/bisector.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
+- lib/rspec-search-and-destroy/rspec_driver.rb
+- lib/rspec-search-and-destroy/rspec_results.rb
 - lib/rspec-search-and-destroy/version.rb
 - rspec-search-and-destroy.gemspec
 - spec/binary_chop_example_selector_spec.rb
@@ -54,7 +95,8 @@ files:
 - spec/rspec_example_ordering_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/shepmaster/rspec-search-and-destroy
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -78,6 +120,11 @@ signing_key:
 specification_version: 3
 summary: Finds RSpec test ordering bugs
 test_files:
+- features/before_all_blocks_are_disabled.feature
+- features/bisecting_a_single_file.feature
+- features/bisecting_multiple_files.feature
+- features/support/env.rb
+- features/support/steps.rb
 - spec/binary_chop_example_selector_spec.rb
 - spec/bisector_spec.rb
 - spec/rspec_example_ordering_spec.rb

data/examples/spec/bad_ordering_spec.rb

@@ -1,16 +0,0 @@
-require 'spec_helper'
-
-describe "Tests that fail when run in a specific order" do
-  it "leaves bad global state" do
-    $fail_next = true
-    expect($fail_next).to be_true
-  end
-
-  it "just takes up space" do
-    expect(true).to be_true
-  end
-
-  it "fails when run last" do
-    expect($fail_next).to be_false
-  end
-end

data/examples/spec/spec_helper.rb

@@ -1,15 +0,0 @@
-require 'rspec-sad'
-
-RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
-
-  config.color = true
-  config.formatter = 'documentation'
-
-  # For this example, run in an order that is guaranteed to be bad
-  config.order = 'default'
-
-  RSpecSearchAndDestroy.configure(config)
-end