rspec-bisect 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38940973e6003e17ff03d56726279191d9af09cc
-  data.tar.gz: 0b8e43a67e09a6d25f070ef62a85222cea27909b
+  metadata.gz: 3ae26473ff4df0634a51d1cb149db8de1df9a5f0
+  data.tar.gz: d0c40d6ca08d91bbbfedb30616e6c7f2529f9881
 SHA512:
-  metadata.gz: 941276fbcd9fb96e271095d6ee8d07fffdc46c3a1e4cb4368c1e2c23bb5539883b65ab88d9fdec52af46a72672506f60f3a1e80e578f3f3b5ac507442b9e3306
-  data.tar.gz: d5af173c24f9320302cab01327db0b44061f5c654dd80aeec31b7485d2ebd3f465ac5894af6988ec3909e53313aa24aea538e61b95215f166f68bd37267d399b
+  metadata.gz: 4d8e886acfb232845c89347698189aacf22480101c7c0812ca8434702b4060fee8b79ec8b0b5599f39e07601944323f7fb807212dd3a7122ca4aea3d02cdca78
+  data.tar.gz: fbd35cf90b3794d4559d397c6342b82b96673ee50b3c53253e353b21dbbd498b18c41f8e248c0339ad81058d56dcaa9dabddaaae933def8ad579f3c701380f6f

data/.gitignore

@@ -17,4 +17,8 @@ mkmf.log
 .idea
 
 # Compiled gems
-*.gem
+*.gem
+
+# Bundled Gems
+vendor
+

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/bin/rspec-bisect

@@ -1,136 +1,8 @@
 #!/usr/bin/env ruby
 
-require 'json'
-require 'colorize'
-require 'optparse'
-require 'ruby-progressbar'
+require 'rspec/bisect'
 
-@options = {}
-def options
-  @options
-end
-
-OptionParser.new do |opts|
-  opts.banner = 'Usage: rspec-bisect [options]'
-
-  opts.on('-s', '--seed N', Integer, 'Seed that causes order dependencies') do |s|
-    options[:seed] = s
-  end
-
-  opts.on('--help', 'Show this message') do
-    puts opts
-    exit
-  end
-end.parse!
-
-if options[:seed].nil?
-  puts 'Running tests with no seed'
-else
-  puts "Running tests with seed #{options[:seed]}"
-end
-
-def rspec_seed_argument
-  options[:seed].nil? ? '' : "--seed #{options[:seed]}"
-end
-
-result = `rspec --format json #{rspec_seed_argument}`
-parsed = JSON.parse result
-
-examples = parsed['examples']
-failure_count = parsed['summary']['failure_count']
-if failure_count > 0
-  puts "#{failure_count} failing test#{failure_count > 1 ? 's' : ''}.".red
-else
-  puts 'No failing tests.'.green
-end
-
-failing_examples = examples.select { |e| e['status'] == 'failed' }
-
-def examples_as_rspec_params(examples)
-  examples.map { |e| "#{e['file_path']}:#{e['line_number']}" }.join ' '
-end
-
-def run_examples_command(examples)
-  "rspec #{examples_as_rspec_params(examples)} #{rspec_seed_argument}"
-end
-
-def run_examples(examples)
-  `#{run_examples_command(examples)}`
-end
-
-def last_command_passed?
-  $?.exitstatus == 0
-end
-
-def last_command_failed?
-  not last_command_passed?
-end
-
-def progress_bar(additional_options)
-  ProgressBar.create({format: '%t |%w>%i| %c/%C |%e'}.merge(additional_options))
-end
-
-dependent_examples_progress = progress_bar title: 'Detecting Dependent Examples',
-                                           total: failing_examples.size
-
-order_dependent_examples = failing_examples.select do |example|
-  run_examples([example])
-  passed = last_command_passed?
-  dependent_examples_progress.increment
-  passed
-end
-
-if order_dependent_examples.size > 0
-  puts "Order dependenc#{ order_dependent_examples.size > 1 ? 'ies' : 'y'} detected:"
-  order_dependent_examples.each do |example|
-    puts "\t#{example['full_description']}".red
-  end
-else
-  puts 'No order dependencies.'.green
-end
-
-order_dependent_examples.each do |example|
-  puts
-  puts "Culprits for #{example['full_description']}:"
-
-  culprit_progress = progress_bar title: 'Determining culprits',
-                                  total: nil,
-                                  format: '%t |%i| %c potential culprits'
-
-  culprits = examples.take_while do |e|
-    example['file_path'] != e['file_path'] ||
-        example['line_number'] != e['line_number']
-  end
-
-  culprit_progress.progress = culprits.size
-
-  culprit_count_theory = 1
-  while culprits.size > culprit_count_theory
-    found_useless_group = false
-    culprits.each_slice(culprits.size / (culprit_count_theory + 1)) do |excluded_culprits|
-      culprit_progress.progress = culprits.size
-
-      culprit_group = culprits - excluded_culprits
-      run_examples culprit_group + [example]
-
-      culprit_progress.progress = culprits.size
-      if last_command_failed?
-        culprits = culprit_group
-
-        found_useless_group = true
-        break
-      end
-    end
-
-    culprit_count_theory += 1 unless found_useless_group
-  end
-
-  culprit_progress.stop
-
-  culprits.each { |candidate| puts candidate['full_description'].green }
-
-  puts example['full_description'].red
-
-  puts (run_examples_command culprits + [example]).red
-end
+include RSpec::Bisect::Reporters
+reporter = ConsoleReporter.new
 
+RSpec::Bisect::Runner.new(reporter: reporter).execute!

data/lib/rspec/bisect.rb

@@ -1,6 +1,9 @@
-require "rspec/bisect/version"
+require 'rspec/bisect/version'
+require 'rspec/bisect/runner'
+require 'rspec/bisect/reporters'
+require 'rspec/bisect/result'
 
-module Rspec
+module RSpec
   module Bisect
     # Your code goes here...
   end

data/lib/rspec/bisect/reporters.rb

@@ -0,0 +1,2 @@
+require 'rspec/bisect/reporters/reporter'
+require 'rspec/bisect/reporters/console_reporter'

data/lib/rspec/bisect/reporters/console_reporter.rb

@@ -0,0 +1,23 @@
+require 'colorize'
+
+module RSpec
+  module Bisect
+    module Reporters
+      class ConsoleReporter
+        include Reporter
+
+        def report(text)
+          puts text
+        end
+
+        def report_success(text)
+          report text.green
+        end
+
+        def report_failure(text)
+          report text.red
+        end
+      end
+    end
+  end
+end

data/lib/rspec/bisect/reporters/reporter.rb

@@ -0,0 +1,45 @@
+module RSpec
+  module Bisect
+    module Reporters
+      module Reporter
+        def seed(seed)
+          if seed.nil?
+            report 'Running tests with no seed'
+          else
+            report "Running tests with seed #{seed}"
+          end
+        end
+
+        def failing_tests(failure_count)
+          if failure_count > 0
+            report_failure "#{failure_count} failing test#{failure_count > 1 ? 's' : ''}.".red
+          else
+            report_success 'No failing tests.'
+          end
+        end
+
+        def order_dependent_examples(examples)
+          if examples.size > 0
+            report "Order dependenc#{ examples.size > 1 ? 'ies' : 'y'} detected:"
+            examples.each do |example|
+              report_failure "\t#{example['full_description']}"
+            end
+          else
+            report_success 'No order dependencies.'
+          end
+        end
+
+        def determining_culprits(example)
+          report ''
+          report "Culprits for #{example['full_description']}:"
+        end
+
+        def culprits(culprits, example)
+          culprits.each { |culprit| puts culprit['full_description'].green }
+
+          report_failure example['full_description']
+        end
+      end
+    end
+  end
+end

data/lib/rspec/bisect/result.rb

@@ -0,0 +1,19 @@
+module RSpec
+  module Bisect
+    class Result < Struct.new(:result_string)
+      class ParserError < StandardError; end
+
+      def as_json
+        parsed_lines = result_string.split("\n").lazy.map do |line|
+          begin
+            JSON.parse line
+          rescue JSON::ParserError
+            #ignored
+          end
+        end
+        parsed_result = parsed_lines.reject { |result| result.nil? }.first
+        parsed_result || raise(ParserError.new('Could not parse json'))
+      end
+    end
+  end
+end

data/lib/rspec/bisect/runner.rb

@@ -0,0 +1,130 @@
+require 'json'
+require 'optparse'
+require 'ruby-progressbar'
+
+module RSpec
+  module Bisect
+    class Runner
+      attr_accessor :reporter,
+                    :result_parser
+
+      def initialize(reporter: reporter, result_parser: result_parser)
+        self.reporter = reporter
+        self.result_parser = result_parser
+      end
+
+      def execute!
+        @options = {}
+        def options
+          @options
+        end
+
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: rspec-bisect [options]'
+
+          opts.on('-s', '--seed N', Integer, 'Seed that causes order dependencies') do |s|
+            options[:seed] = s
+          end
+
+          opts.on('--help', 'Show this message') do
+            puts opts
+            exit
+          end
+        end.parse!
+
+        reporter.seed options[:seed]
+
+        def rspec_seed_argument
+          options[:seed].nil? ? '' : "--seed #{options[:seed]}"
+        end
+
+        result = Result.new `rspec --format json #{rspec_seed_argument}`
+        parsed = result.as_json
+
+        examples = parsed['examples']
+        failure_count = parsed['summary']['failure_count']
+        reporter.failing_tests failure_count
+
+        failing_examples = examples.select { |e| e['status'] == 'failed' }
+
+        def examples_as_rspec_params(examples)
+          examples.map { |e| "#{e['file_path']}:#{e['line_number']}" }.join ' '
+        end
+
+        def run_examples_command(examples)
+          "rspec #{examples_as_rspec_params(examples)} #{rspec_seed_argument}"
+        end
+
+        def run_examples(examples)
+          `#{run_examples_command(examples)}`
+        end
+
+        def last_command_passed?
+          $?.exitstatus == 0
+        end
+
+        def last_command_failed?
+          not last_command_passed?
+        end
+
+        def progress_bar(additional_options)
+          ProgressBar.create({format: '%t |%w>%i| %c/%C |%e'}.merge(additional_options))
+        end
+
+        dependent_examples_progress = progress_bar title: 'Detecting Dependent Examples',
+                                                   total: failing_examples.size
+
+        order_dependent_examples = failing_examples.select do |example|
+          run_examples([example])
+          passed = last_command_passed?
+          dependent_examples_progress.increment
+          passed
+        end
+
+        reporter.order_dependent_examples order_dependent_examples
+
+        order_dependent_examples.each do |example|
+          reporter.determining_culprits example
+
+          culprit_progress = progress_bar title: 'Determining culprits',
+                                          total: nil,
+                                          format: '%t |%i| %c potential culprits'
+
+          culprits = examples.take_while do |e|
+            example['file_path'] != e['file_path'] ||
+                example['line_number'] != e['line_number']
+          end
+
+          culprit_progress.progress = culprits.size
+
+          culprit_count_theory = 1
+          while culprits.size > culprit_count_theory
+            found_useless_group = false
+            culprits.each_slice(culprits.size / (culprit_count_theory + 1)) do |excluded_culprits|
+              culprit_progress.progress = culprits.size
+
+              culprit_group = culprits - excluded_culprits
+              run_examples culprit_group + [example]
+
+              culprit_progress.progress = culprits.size
+              if last_command_failed?
+                culprits = culprit_group
+
+                found_useless_group = true
+                break
+              end
+            end
+
+            culprit_count_theory += 1 unless found_useless_group
+          end
+
+          culprit_progress.stop
+
+          reporter.culprits culprits, example
+
+          reporter.report_failure run_examples_command culprits + [example]
+        end
+      end
+    end
+  end
+end

data/lib/rspec/bisect/version.rb

@@ -1,5 +1,5 @@
 module Rspec
   module Bisect
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

data/rspec-bisect.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "cucumber", "1.3.17"
   spec.add_development_dependency "aruba", "0.6.1"
-  spec.add_dependency "rspec", "~> 3"
+  spec.add_dependency "rspec", "> 2.12"
   spec.add_dependency "colorize", "0.7.3"
   spec.add_dependency "ruby-progressbar", "1.6.1"
 end

data/spec/lib/rspec/bisect/result_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+require 'json'
+require 'rspec/bisect/result'
+
+describe RSpec::Bisect::Result do
+  describe '#as_json' do
+    subject { described_class.new(result).as_json }
+
+    context 'with one line of json' do
+      let(:result) { { some: 'json' }.to_json }
+
+      it { is_expected.to eq({'some' => 'json'}) }
+    end
+
+    context 'with deprecation warnings' do
+      let(:result) do
+        "Don't use should, use expect instead
+        {\"some\": \"json\"}"
+      end
+
+      it { is_expected.to eq({'some' => 'json'}) }
+    end
+
+    context 'with bad output after json' do
+      let(:result) do
+        "{\"some\": \"json\"}
+        Something else to mess up our code..."
+      end
+
+      it { is_expected.to eq({'some' => 'json'}) }
+    end
+
+    context 'with no json' do
+      let(:result) do
+        "There's no json here
+        Go away"
+      end
+
+      it 'raises an exception' do
+        expect { subject }.to raise_error(RSpec::Bisect::Result::ParserError, 'Could not parse json')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,89 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-bisect
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Shelby Doolittle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-31 00:00:00.000000000 Z
+date: 2015-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,16 +70,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '2.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '2.12'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +118,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -133,8 +134,15 @@ files:
 - features/step_definitions/rspec-bisect_steps.rb
 - features/support/env.rb
 - lib/rspec/bisect.rb
+- lib/rspec/bisect/reporters.rb
+- lib/rspec/bisect/reporters/console_reporter.rb
+- lib/rspec/bisect/reporters/reporter.rb
+- lib/rspec/bisect/result.rb
+- lib/rspec/bisect/runner.rb
 - lib/rspec/bisect/version.rb
 - rspec-bisect.gemspec
+- spec/lib/rspec/bisect/result_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/shelbyd/rspec-bisect
 licenses:
 - MIT
@@ -169,4 +177,6 @@ test_files:
 - features/no_tests.feature
 - features/step_definitions/rspec-bisect_steps.rb
 - features/support/env.rb
+- spec/lib/rspec/bisect/result_spec.rb
+- spec/spec_helper.rb
 has_rdoc: