spinach 0.10.1 → 0.12.0

data/lib/spinach/orderers/random.rb

@@ -0,0 +1,35 @@
+require 'digest'
+
+module Spinach
+  module Orderers
+    class Random
+      attr_reader :seed
+
+      def initialize(seed:)
+        @seed = seed.to_s
+      end
+
+      # Output the randomization seed in the report summary.
+      #
+      # @param [IO] io
+      #   Output buffer for report.
+      #
+      # @api public
+      def attach_summary(io)
+        io.puts("Randomized with seed #{seed}\n\n")
+      end
+
+      # Returns a reordered version of the provided array
+      #
+      # @param [Array] items
+      #   Items to order
+      #
+      # @api public
+      def order(items)
+        items.sort_by do |item|
+          Digest::MD5.hexdigest(seed + item.ordering_id)
+        end
+      end
+    end
+  end
+end

data/lib/spinach/orderers.rb

@@ -0,0 +1,2 @@
+require_relative 'orderers/default'
+require_relative 'orderers/random'

data/lib/spinach/reporter/progress.rb

@@ -8,7 +8,7 @@ module Spinach
     class Progress < Reporter
       include Reporting
 
-      # Initialitzes the runner
+      # Initializes the reporter
       #
       # @param [Hash] options
       #  Sets a custom output buffer by setting options[:output]

data/lib/spinach/reporter/reporting.rb

@@ -221,7 +221,9 @@ module Spinach
         error_summary      = format_summary(:red,    error_steps,      'Error')
 
         out.puts "Steps Summary: #{successful_summary}, #{pending_summary}, #{undefined_summary}, #{failed_summary}, #{error_summary}\n\n"
-        out.puts "Finished in #{Time.now - @start_time} seconds" if @start_time
+        out.puts "Finished in #{Time.now - @start_time} seconds\n\n" if @start_time
+
+        @orderer.attach_summary(out) if @orderer
       end
     end
   end

data/lib/spinach/reporter/stdout.rb

@@ -8,7 +8,7 @@ module Spinach
     class Stdout < Reporter
       include Reporting
 
-      # Initialitzes the runner
+      # Initializes the reporter
       #
       # @param [Hash] options
       #  Sets a custom output buffer by setting options[:output]

data/lib/spinach/reporter.rb

@@ -10,6 +10,7 @@ module Spinach
     def initialize(options = {})
       @errors = []
       @options = options
+      @orderer = options[:orderer]
       @undefined_features = []
       @successful_steps = []
       @undefined_steps = []

data/lib/spinach/runner/feature_runner.rb

@@ -1,18 +1,20 @@
 require_relative '../tags_matcher'
+require 'spinach/orderers/default'
 
 module Spinach
   class Runner
     # A feature runner handles a particular feature run.
     #
     class FeatureRunner
-      attr_reader :feature
+      attr_reader :feature, :orderer
 
       # @param [GherkinRuby::AST::Feature] feature
       #   The feature to run.
       #
       # @api public
-      def initialize(feature)
+      def initialize(feature, orderer: Spinach::Orderers::Default.new)
         @feature = feature
+        @orderer = orderer
       end
 
       # @return [String]
@@ -80,7 +82,7 @@ module Spinach
       end
 
       def scenarios_to_run
-        feature.scenarios.select do |scenario|
+        unordered_scenarios = feature.scenarios.select do |scenario|
           has_a_tag_that_will_be_run = TagsMatcher.match(feature_tags + scenario.tags)
           on_a_line_that_will_be_run = if feature.run_every_scenario?
                                          true
@@ -90,6 +92,8 @@ module Spinach
 
           has_a_tag_that_will_be_run && on_a_line_that_will_be_run
         end
+
+        orderer.order(unordered_scenarios)
       end
     end
   end

data/lib/spinach/runner.rb

@@ -30,10 +30,10 @@ module Spinach
     def initialize(filenames, options = {})
       @filenames = filenames
 
-      @step_definitions_path = options.delete(:step_definitions_path ) ||
+      @step_definitions_path = options.delete(:step_definitions_path) ||
         Spinach.config.step_definitions_path
 
-      @support_path = options.delete(:support_path ) ||
+      @support_path = options.delete(:support_path) ||
         Spinach.config.support_path
     end
 
@@ -42,7 +42,9 @@ module Spinach
     # @api public
     def init_reporters
       Spinach.config[:reporter_classes].each do |reporter_class|
-        reporter = Support.constantize(reporter_class).new(Spinach.config.reporter_options)
+        reporter_options = default_reporter_options.merge(Spinach.config.reporter_options)
+        reporter         = Support.constantize(reporter_class).new(reporter_options)
+
         reporter.bind
       end
     end
@@ -58,24 +60,12 @@ module Spinach
       require_frameworks
       init_reporters
 
-      features = filenames.map do |filename|
-        file, *lines = filename.split(":") # little more complex than just a "filename"
-
-        # FIXME Feature should be instantiated directly, not through an unrelated class method
-        feature          = Parser.open_file(file).parse
-        feature.filename = file
-
-        feature.lines_to_run = lines if lines.any?
-
-        feature
-      end
-
       suite_passed = true
 
       Spinach.hooks.run_before_run
 
-      features.each do |feature|
-        feature_passed = FeatureRunner.new(feature).run
+      features_to_run.each do |feature|
+        feature_passed = FeatureRunner.new(feature, orderer: orderer).run
         suite_passed &&= feature_passed
 
         break if fail_fast? && !feature_passed
@@ -139,11 +129,44 @@ module Spinach
       support_files + step_definition_files
     end
 
+    # The orderer for this run.
+    #
+    # @api public
+    def orderer
+      @orderer ||= Support.constantize(Spinach.config[:orderer_class]).new(
+        seed: Spinach.config.seed
+      )
+    end
+
+    # Default initialization options for the reporter
+    #
+    def default_reporter_options
+      {orderer: orderer}
+    end
+
     private
 
     def fail_fast?
       Spinach.config.fail_fast
     end
+
+    def features_to_run
+      unordered_features = filenames.reduce([]) do |features, filename|
+        file, *lines = filename.split(":") # little more complex than just a "filename"
+
+        # FIXME Feature should be instantiated directly, not through an unrelated class method
+        feature          = Parser.open_file(file).parse
+        feature.filename = file
+
+        feature.lines_to_run = lines if lines.any?
+
+        features << feature if TagsMatcher.match_feature(feature)
+
+        features
+      end
+
+      orderer.order(unordered_features)
+    end
   end
 end
 

data/lib/spinach/scenario.rb

@@ -9,5 +9,15 @@ module Spinach
       @tags    = []
       @lines   = []
     end
+
+    # Identifier used by orderers.
+    #
+    # Needs to involve the relative file path and line number so that the
+    # ordering a seed generates is stable across both runs and machines.
+    #
+    # @api public
+    def ordering_id
+      "#{feature.ordering_id}:#{lines.first}"
+    end
   end
 end

data/lib/spinach/tags_matcher.rb

@@ -6,9 +6,9 @@ module Spinach
     class << self
 
       # Matches an array of tags (e.g. of a scenario) against the tags present
-      # in Spinach' runtime options.
+      # in Spinach's runtime options.
       #
-      # Spinach' tag option is an array which consists of (possibly) multiple
+      # Spinach's tag option is an array which consists of (possibly) multiple
       # arrays containing tags provided by the user running the features and
       # scenarios. Each of these arrays is considered a tag group.
       #
@@ -23,6 +23,15 @@ module Spinach
         }
       end
 
+      # Matches the tags of a feature (and its scenarios) against the tags present
+      # in Spinach's runtime options.
+      #
+      # A feature matches when, for any of its scenarios, the combination of the
+      # feature's tags and that scenario's tags match the configured tags.
+      def match_feature(feature)
+        feature.scenarios.any? { |scenario| match(feature.tags + scenario.tags) }
+      end
+
       private
 
       def tag_groups

data/lib/spinach/version.rb

@@ -1,4 +1,4 @@
 module Spinach
   # Spinach version.
-  VERSION = "0.10.1"
+  VERSION = "0.12.0"
 end

data/lib/spinach.rb

@@ -9,6 +9,7 @@ require_relative 'spinach/parser'
 require_relative 'spinach/dsl'
 require_relative 'spinach/feature_steps'
 require_relative 'spinach/reporter'
+require_relative 'spinach/orderers'
 require_relative 'spinach/cli'
 require_relative 'spinach/generators'
 require_relative 'spinach/auditor'

data/spinach.gemspec

@@ -3,8 +3,7 @@ require File.expand_path('../lib/spinach/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Josep Jaume Rey", "Josep M. Bach", "Oriol Gual", "Marc Divins Castellvi"]
-  gem.email         = ["info@codegram.com", "josep.m.bach@gmail.com",
-    "oriolgual@gmail.com", "josepjaume@gmail.com", "marcdivc@gmail.com"]
+  gem.email         = ["josep.m.bach@gmail.com", "oriolgual@gmail.com", "josepjaume@gmail.com", "marcdivc@gmail.com"]
   gem.description   = %q{Spinach is a BDD framework on top of gherkin}
   gem.summary       = %q{Spinach is a BDD framework on top of gherkin}
   gem.homepage      = "http://github.com/codegram/spinach"
@@ -12,17 +11,17 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'gherkin-ruby', '>= 0.3.2'
   gem.add_runtime_dependency 'colorize'
-  gem.add_runtime_dependency 'json'
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'mocha', '~> 1.0'
+  gem.add_development_dependency 'mocha', "~> 1.5.0"
   gem.add_development_dependency 'sinatra'
   gem.add_development_dependency 'capybara'
   gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'simplecov'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'minitest', '< 5.0'
   gem.add_development_dependency 'fakefs', ">= 0.5.2"
 
+  gem.required_ruby_version = Gem::Requirement.new(">= 2.4".freeze)
+
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/test/spinach/cli_test.rb

@@ -89,6 +89,40 @@ tags:
       end
     end
 
+    describe 'rand' do
+      let(:config) { Spinach::Config.new }
+
+      before do
+        Spinach.stubs(:config).returns(config)
+        Spinach::Cli.new(%w(--rand)).options
+      end
+
+      it 'uses the Random orderer' do
+        config.orderer_class.must_equal 'Spinach::Orderers::Random'
+      end
+
+      it 'sets a numeric seed' do
+        config.seed.must_equal config.seed.to_i
+      end
+    end
+
+    describe 'seed' do
+      let(:config) { Spinach::Config.new }
+
+      before do
+        Spinach.stubs(:config).returns(config)
+        Spinach::Cli.new(%w(--seed 42)).options
+      end
+
+      it 'uses the random orderer' do
+        config.orderer_class.must_equal 'Spinach::Orderers::Random'
+      end
+
+      it 'sets the seed' do
+        config.seed.must_equal 42
+      end
+    end
+
     describe 'features_path' do
       %w{-f --features_path}.each do |opt|
         it 'sets the given features_path' do
@@ -242,14 +276,14 @@ tags:
       describe 'the feature really exists' do
         it 'runs the feature' do
           cli = Spinach::Cli.new(['features/some_feature.feature'])
-          File.stubs(:exists?).returns(true)
+          File.stubs(:exist?).returns(true)
           cli.feature_files.must_equal ['features/some_feature.feature']
         end
       end
 
       it 'it fails if the feature does not exist' do
         cli = Spinach::Cli.new(['features/some_feature.feature'])
-        File.stubs(:exists?).returns(false)
+        File.stubs(:exist?).returns(false)
         cli.expects(:fail!).with('features/some_feature.feature could not be found')
 
         cli.feature_files
@@ -259,7 +293,7 @@ tags:
     describe 'when a particular feature list is passed with line' do
       it 'returns the feature with the line number' do
         cli = Spinach::Cli.new(['features/some_feature.feature:10'])
-        File.stubs(:exists?).returns(true)
+        File.stubs(:exist?).returns(true)
 
         cli.feature_files.must_equal ['features/some_feature.feature:10']
       end
@@ -268,7 +302,7 @@ tags:
     describe "when a particular feature list is passed with multiple lines" do
       it "returns the feature with the line numbers" do
         cli = Spinach::Cli.new(['features/some_feature.feature:10:20'])
-        File.stubs(:exists?).returns(true)
+        File.stubs(:exist?).returns(true)
 
         cli.feature_files.must_equal ["features/some_feature.feature:10:20"]
       end
@@ -303,7 +337,7 @@ tags:
           Dir.expects(:glob).with('path/to/features/**/*.feature')
           .returns(['several features'])
 
-          File.stubs(:exists?).returns(true)
+          File.stubs(:exist?).returns(true)
 
           cli.feature_files.must_equal ['several features', 'some_feature.feature']
         end

data/test/spinach/config_test.rb

@@ -27,6 +27,28 @@ describe Spinach::Config do
    end
  end
 
+ describe '#orderer_class' do
+   it 'returns a default' do
+     subject[:orderer_class].must_equal "Spinach::Orderers::Default"
+   end
+
+   it 'can be overwritten' do
+     subject[:orderer_class] = "MyOwnOrderer"
+     subject[:orderer_class].must_equal "MyOwnOrderer"
+   end
+ end
+
+ describe '#seed' do
+   it 'has a default' do
+     subject[:seed].must_be_kind_of Integer
+   end
+
+   it 'can be overwritten' do
+     subject[:seed] = 54321
+     subject[:seed].must_equal 54321
+   end
+ end
+
  describe '#step_definitions_path' do
    it 'returns a default' do
      subject[:step_definitions_path].must_be_kind_of String

data/test/spinach/dsl_test.rb

@@ -157,7 +157,7 @@ describe Spinach::DSL do
         end
 
         @feature.new.step_location_for('I say goodbye').first.must_include '/dsl_test.rb'
-        @feature.new.step_location_for('I say goodbye').last.must_be_kind_of Fixnum
+        @feature.new.step_location_for('I say goodbye').last.must_be_kind_of Integer
       end
     end
   end

data/test/spinach/feature_test.rb

@@ -29,5 +29,15 @@ module Spinach
         end
       end
     end
+
+    describe "#ordering_id" do
+      subject { Feature.new }
+
+      before { subject.filename = "features/foo/bar.feature" }
+
+      it 'is the filename' do
+        subject.ordering_id.must_equal "features/foo/bar.feature"
+      end
+    end
   end
 end

data/test/spinach/generators/feature_generator_test.rb

@@ -71,7 +71,7 @@ Feature: Cheezburger can I has
         in_current_dir do
           subject.store
           File.directory?("features/steps/").must_equal true
-          File.exists?("features/steps/cheezburger_can_i_has.rb").must_equal true
+          File.exist?("features/steps/cheezburger_can_i_has.rb").must_equal true
           File.read("features/steps/cheezburger_can_i_has.rb").strip.must_equal(
             subject.generate.strip
           )

data/test/spinach/hooks_test.rb

@@ -108,7 +108,7 @@ describe Spinach::Hooks do
         subject.on_tag('screenshot') do
           assertion = true
         end
-        subject.run_before_scenario(scenario)
+        subject.run_before_scenario(scenario, step_definitions)
         assertion.wont_equal true
       end
     end

data/test/spinach/orderers/default_test.rb

@@ -0,0 +1,31 @@
+require_relative '../../test_helper'
+
+describe Spinach::Orderers::Default do
+  let(:orderer) { Spinach::Orderers::Default.new }
+
+  describe "#attach_summary" do
+    let(:io) { StringIO.new }
+
+    it 'appends nothing' do
+      contents_before_running = io.string.dup
+
+      orderer.attach_summary(io)
+
+      io.string.must_equal contents_before_running
+    end
+  end
+
+  describe "#order" do
+    let(:items) { Array(1..10) }
+
+    it "doesn't change the order of the items" do
+      orderer.order(items).must_equal items
+    end
+  end
+
+  describe "#initialize" do
+    it "can be provided options without raising an error" do
+      Spinach::Orderers::Default.new(seed: "seed")
+    end
+  end
+end

data/test/spinach/orderers/random_test.rb

@@ -0,0 +1,39 @@
+require_relative '../../test_helper'
+
+describe Spinach::Orderers::Random do
+  let(:orderer) { Spinach::Orderers::Random.new(seed: Spinach.config.seed) }
+
+  describe "#attach_summary" do
+    let(:io) { StringIO.new }
+
+    it 'appends the seed' do
+      orderer.attach_summary(io)
+
+      io.string.must_match /Randomized\ with\ seed\ #{orderer.seed}/
+    end
+  end
+
+  describe "#order" do
+    Identifiable = Struct.new(:ordering_id)
+
+    let(:items) { (1..10).map { |n| Identifiable.new(n.to_s) } }
+
+    it "randomizes the items" do
+      orderer.order(items).wont_equal items
+    end
+
+    it "always randomizes items the same way with the same seed" do
+      orderer.order(items).must_equal orderer.order(items)
+    end
+  end
+
+  describe "#initialize" do
+    it "requires a seed parameter" do
+      proc {
+        Spinach::Orderers::Random.new
+      }.must_raise ArgumentError
+
+      Spinach::Orderers::Random.new(seed: 4)
+    end
+  end
+end

data/test/spinach/reporter_test.rb

@@ -89,8 +89,8 @@ module Spinach
 
         it "binds a callback around every scenario" do
           @reporter.expects(:around_scenario_run)
-          Spinach.hooks.run_around_scenario(anything) do
-            yield
+          Spinach.hooks.run_around_scenario(anything) do |&block|
+            block.call
           end
         end
 

data/test/spinach/runner_test.rb

@@ -65,7 +65,10 @@ describe Spinach::Runner do
         config.reporter_options = {backtrace: true}
         reporter = stub
         reporter.stubs(:bind)
-        Spinach::Reporter::Stdout.expects(new: reporter).with(backtrace: true)
+        Spinach::Reporter::Stdout.expects(new: reporter).with(
+          backtrace: true,
+          **runner.default_reporter_options
+        )
         runner.init_reporters
       end
     end
@@ -74,15 +77,21 @@ describe Spinach::Runner do
   describe '#run' do
     before(:each) do
       @feature_runner = stub
+      @feature_runner.stubs(:run).returns(true)
+
       filenames.each do |filename|
-        Spinach::Parser.stubs(:open_file).with(filename).returns parser = stub
-        parser.stubs(:parse).returns feature = Spinach::Feature.new
+        parser = stub
+        Spinach::Parser.stubs(:open_file).with(filename).returns(parser)
+
+        feature = Spinach::Feature.new
+        feature.scenarios << Spinach::Scenario.new(feature)
+        parser.stubs(:parse).returns(feature)
+
         Spinach::Runner::FeatureRunner.stubs(:new).
           with(feature, anything).
           returns(@feature_runner)
       end
 
-      @feature_runner.stubs(:run).returns(true)
       runner.stubs(required_files: [])
     end
 
@@ -130,12 +139,18 @@ describe Spinach::Runner do
       let(:runner) { Spinach::Runner.new(filenames) }
 
       before(:each) do
+        parser = stub
+        Spinach::Parser.stubs(:open_file).with(filename).returns(parser)
+
+        @feature = Spinach::Feature.new
+        @feature.scenarios << Spinach::Scenario.new(@feature)
+        parser.stubs(:parse).returns(@feature)
+
         @feature_runner = stub
-        Spinach::Parser.stubs(:open_file).with(filename).returns parser = stub
-        parser.stubs(:parse).returns @feature = Spinach::Feature.new
         Spinach::Runner::FeatureRunner.stubs(:new).
           with(@feature, anything).
           returns(@feature_runner)
+
         runner.stubs(required_files: [])
       end
 
@@ -171,8 +186,13 @@ describe Spinach::Runner do
 
       before(:each) do
         filenames.each_with_index do |filename, i|
-          Spinach::Parser.stubs(:open_file).with(filename).returns parser = stub
-          parser.stubs(:parse).returns feature = Spinach::Feature.new
+          parser = stub
+          Spinach::Parser.stubs(:open_file).with(filename).returns(parser)
+
+          feature = Spinach::Feature.new
+          feature.scenarios << Spinach::Scenario.new(feature)
+          parser.stubs(:parse).returns(feature)
+
           Spinach::Runner::FeatureRunner.stubs(:new).
             with(feature, anything).
             returns(feature_runners[i])

data/test/spinach/scenario_test.rb

@@ -2,5 +2,19 @@ require 'test_helper'
 
 module Spinach
   describe Scenario do
+    describe "#ordering_id" do
+      let(:feature) { Feature.new }
+
+      subject { Scenario.new(feature) }
+
+      before do
+        feature.filename = "features/foo/bar.feature"
+        subject.lines    = Array(4..12)
+      end
+
+      it 'is the filename and starting line number' do
+        subject.ordering_id.must_equal "features/foo/bar.feature:4"
+      end
+    end
   end
 end

data/test/test_helper.rb

@@ -1,19 +1,6 @@
-require 'simplecov'
-require 'coveralls'
-
-SimpleCov.formatter = Coveralls::SimpleCov::Formatter
-if ENV['CI'] && !defined?(Rubinius)
-  require 'simplecov'
-
-  SimpleCov.start do
-    add_filter '/test/'
-    add_filter '/features/'
-  end
-end
-
 require 'minitest/autorun'
 require 'minitest/spec'
-require 'mocha/mini_test'
+require 'mocha/minitest'
 require 'ostruct'
 require 'stringio'
 require 'pry'