cuke_iterations 0.0.1 → 0.0.2

data/Gemfile

@@ -3,7 +3,7 @@ source "http://rubygems.org"
 group :development do
   gem 'rake', '>= 0.9.2'
   gem 'rspec'
-  gem 'rspec-expectations', :git => "git://github.com/rspec/rspec-expectations.git"
+  gem 'rspec-expectations'
 end
 
 gemspec

data/Gemfile.lock

@@ -1,30 +1,25 @@
-GIT
-  remote: git://github.com/rspec/rspec-expectations.git
-  revision: 0b63bf446ce84a613875417121980492571bfa90
-  specs:
-    rspec-expectations (2.6.0)
-      diff-lcs (~> 1.1.2)
-
 PATH
   remote: .
   specs:
-    cuke_iterations (0.0.1)
+    cuke_iterations (0.0.2)
       gherkin
 
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.1.2)
-    gherkin (2.4.11)
+    diff-lcs (1.1.3)
+    gherkin (2.7.6)
       json (>= 1.4.6)
-    json (1.5.3)
-    rake (0.9.2)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-mocks (2.6.0)
+    json (1.6.5)
+    rake (0.9.2.2)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
 
 PLATFORMS
   ruby
@@ -33,4 +28,4 @@ DEPENDENCIES
   cuke_iterations!
   rake (>= 0.9.2)
   rspec
-  rspec-expectations!
+  rspec-expectations

data/README.md

@@ -48,12 +48,10 @@ android:
   - ! '@iphone_only'
 ```
 
-At present, you *must* specify all tags that are to be included.  Excluded tags have priority over included ones (e.g. an `@iphone_only` scenario would not be included in the `android` iteration, even if it had the `@mobile` tag.
+If you specify an empty array for `include_tags`, then all scenarios will be included.  Excluded tags have priority over included ones (e.g. an `@iphone_only` scenario would not be included in the `android` iteration, even if it had the `@mobile` tag.
 
 ### Running it
 
-`cd features`
-
 With defaults:
 `cuke_iterations`
 
@@ -62,7 +60,7 @@ To see other options:
 
 ### What did it do?
 
-First, it created a set of empty directories under the `iterations` folder - one for each iteration that you defined.  You should add this folder to your source-control ignore list (unless you're using Git which doesn't track empty folders).
+First, it created a set of empty directories under the `iterations` folder inside your features folder - one for each iteration that you defined.  You should add this folder to your source-control ignore list (unless you're using Git which doesn't track empty folders).
 
 Next, it created a run file for Cucumber.  If you didn't specify a filename it will be called `run.txt`.  Definitely add this to your source-control ignore list.
 
@@ -70,7 +68,7 @@ Next, it created a run file for Cucumber.  If you didn't specify a filename it w
 
 `cucumber @run.txt`
 
-Note we haven't told Cucumber about our `features` folder like we normally would.  This also means it doesn't know about your `support` or `step_definitions` folders, so make sure to add those to the command-line as well.
+Note we haven't told Cucumber about our `features` folder like we normally would.  If you're not using the conventional Cucumber folder structure, then you will need to explicitly require your `support` and `step_definitions` folders.
 
 ### Use the iterations inside your scenarios
 

data/bin/cuke_iterations

@@ -5,23 +5,18 @@ require 'cuke_iterations'
 require 'trollop'
 require 'fileutils'
 
+include CukeIterations
+
 opts = Trollop::options do
+  opt :features_dir, "Features directory", :default => 'features'
   opt :iteration_file, "Iterations file to use", :default => 'cuke_iterations.yml'
   opt :out, "Name of runfile to write", :default => 'run.txt'
 end
 
-Trollop::die "Couldn't find iterations file '#{opts[:iteration_file]}'" unless File.exist?(opts[:iteration_file])
-iterations = YAML.load(File.read(opts[:iteration_file]))
+features_dir = opts[:features_dir]
+Trollop::die "Couldn't find features dir '#{features_dir}'" unless Dir.exist?(features_dir)
 
-all_scenarios = []
-features = CukeIterations::CukeParser.parse_features(Dir.getwd)
-iterations.each do |iteration_name, iteration|
-  iteration_dir = File.join('iterations', iteration_name, '..', '..')
-  FileUtils.mkdir_p iteration_dir
+iteration_file = IterationFileFinder.new.find(features_dir, opts[:iteration_file])
 
-  CukeIterations::ScenarioListGenerator.for_iteration(features, iteration).each do |scenario|
-    all_scenarios << File.join(iteration_dir, scenario[:filename] + ":#{scenario[:line]}")
-  end
-end
+ScenarioFileWriter.new.write_scenarios(features_dir, iteration_file, opts[:out])
 
-File.open(opts[:out], 'w') {|f| f.puts all_scenarios}

data/changelog.md

@@ -0,0 +1,7 @@
+## [v0.0.2](https://github.com/jmerrifield/cuke_iterations/compare/v0.0.1...v0.0.2)
+
+* Deal with feature files that live in subdirectories of the `features` folder ([#1](https://github.com/jmerrifield/cuke_iterations/issues/1))
+* Default to including all tags if none are specified ([#2](https://github.com/jmerrifield/cuke_iterations/issues/2))
+* Don't require that we run from inside `features`, assume we're at the root and look for features in `features`, unless overridden by the `-f` parameter.
+
+## [v0.0.1](https://github.com/jmerrifield/cuke_iterations/tree/v0.0.1)

data/lib/cuke_iterations.rb

@@ -1,7 +1,11 @@
 $:.push File.expand_path("../cuke_iterations", __FILE__)
 
+require 'fileutils'
+
 require 'version'
+require 'cucumber_helper'
 require 'cuke_parser'
+require 'iteration_file_finder'
 require 'scenario_extracting_formatter'
+require 'scenario_file_writer'
 require 'scenario_list_generator'
-require 'cucumber_helper'

data/lib/cuke_iterations/cuke_parser.rb

@@ -1,4 +1,5 @@
 require 'gherkin'
+require 'pathname'
 
 module CukeIterations
   class CukeParser
@@ -11,11 +12,16 @@ module CukeIterations
           text = File.open(feature_file, 'r') { |f| f.read }
           parser.parse(text, __FILE__, __LINE__-1)
 
-          scenarios << formatter.discovered_scenarios.each {|s| s[:filename] = File.basename(feature_file)}
+          scenarios << formatter.discovered_scenarios.each {|s| s[:filename] = relative_path(feature_file, dir)}
         end
 
         scenarios.flatten
       end
+
+      private
+      def relative_path(file, base_dir)
+        Pathname.new(file).relative_path_from(Pathname.new(base_dir)).to_s
+      end
     end
   end
 end

data/lib/cuke_iterations/iteration_file_finder.rb

@@ -0,0 +1,17 @@
+module CukeIterations
+  class IterationFileFinder
+    def find(features_dir, iteration_file = 'cuke_iterations.yml')
+      raise 'features_dir cannot be nil' unless features_dir
+
+      iteration_file_locations = [
+          iteration_file,
+          File.join(features_dir, iteration_file)
+      ]
+
+      location = iteration_file_locations.select { |location| File.exist? location }.first
+
+      raise "Couldn't find iterations file, tried the following: #{iteration_file_locations.join(', ')}" unless location
+      location
+    end
+  end
+end

data/lib/cuke_iterations/scenario_file_writer.rb

@@ -0,0 +1,20 @@
+module CukeIterations
+  class ScenarioFileWriter
+    def write_scenarios(features_dir, iteration_file, out_file)
+      iterations = YAML.load(File.read(iteration_file))
+
+      all_scenarios = []
+      features = CukeParser.parse_features(features_dir)
+      iterations.each do |iteration_name, iteration|
+        iteration_dir = File.join(features_dir, 'iterations', iteration_name, '..', '..')
+        FileUtils.mkdir_p iteration_dir
+
+        ScenarioListGenerator.for_iteration(features, iteration).each do |scenario|
+          all_scenarios << File.join(iteration_dir, scenario[:filename] + ":#{scenario[:line]}")
+        end
+      end
+
+      File.open(out_file, 'w') { |f| f.puts all_scenarios }
+    end
+  end
+end

data/lib/cuke_iterations/scenario_list_generator.rb

@@ -1,12 +1,24 @@
 module CukeIterations
   class ScenarioListGenerator
     class << self
-      def for_iteration(parsed_features, iteration)
-        parsed_features.select do |f|
-          next if (f[:tags] & iteration[:exclude_tags]).any?
-          (f[:tags] & iteration[:include_tags]).any?
+      def for_iteration(scenarios, iteration_info)
+        scenarios.select do |s|
+          next if is_excluded?(s, iteration_info)
+          is_included_by_tag?(s, iteration_info) || no_include_tags_specified?(iteration_info)
         end
       end
+
+      def no_include_tags_specified?(iteration)
+        iteration[:include_tags] == []
+      end
+
+      def is_included_by_tag?(scenario, iteration)
+        (scenario[:tags] & iteration[:include_tags]).any?
+      end
+
+      def is_excluded?(scenario, iteration)
+        (scenario[:tags] & iteration[:exclude_tags]).any?
+      end
     end
   end
 end

data/lib/cuke_iterations/version.rb

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

data/spec/cuke_parser_spec.rb

@@ -13,10 +13,10 @@ describe "Extracting scenarios" do
       {filename: 'cuking_rocks.feature', line: 10},
       {filename: 'cuking_rocks.feature', line: 21},
       {filename: 'cuking_rocks.feature', line: 22},
-      {filename: 'i_love_cukes.feature', line: 4},
-      {filename: 'i_love_cukes.feature', line: 15},
-      {filename: 'i_love_cukes.feature', line: 16},
-      {filename: 'i_love_cukes.feature', line: 25},
+      {filename: 'subdirectory/i_love_cukes.feature', line: 4},
+      {filename: 'subdirectory/i_love_cukes.feature', line: 15},
+      {filename: 'subdirectory/i_love_cukes.feature', line: 16},
+      {filename: 'subdirectory/i_love_cukes.feature', line: 25},
     ]
 
     parsed_files_with_lines = @parsed_features.map{|x| {filename: x[:filename], line: x[:line]}}
@@ -24,7 +24,7 @@ describe "Extracting scenarios" do
   end
 
   it "should read scenario-level tags" do
-    @parsed_features.should include filename: 'i_love_cukes.feature',
+    @parsed_features.should include filename: 'subdirectory/i_love_cukes.feature',
       line: 4,
       tags: ['@tag1', '@tag2']
   end
@@ -36,7 +36,7 @@ describe "Extracting scenarios" do
   end
 
   it "should read scenario-level tags on example rows" do
-    @parsed_features.should include filename: 'i_love_cukes.feature',
+    @parsed_features.should include filename: 'subdirectory/i_love_cukes.feature',
       line: 15,
       tags: ['@tag3', '@tag4']
   end
@@ -48,7 +48,7 @@ describe "Extracting scenarios" do
   end
 
   it "should read example-group tags on example rows" do
-    @parsed_features.should include filename: 'i_love_cukes.feature',
+    @parsed_features.should include filename: 'subdirectory/i_love_cukes.feature',
       line: 25,
       tags: ['@tag5', '@tag6', '@tag7', '@tag8']
   end

data/spec/scenario_list_generator_spec.rb

@@ -9,6 +9,18 @@ describe "Scenario list generator" do
     ]
   end
 
+  it "should include all non-excluded scenarios if no include tags are specified" do
+    iteration = {
+        name: "iphone",
+        include_tags: [],
+        exclude_tags: ['@tag8']
+    }
+
+    list = ScenarioListGenerator.for_iteration(@parsed_features, iteration)
+
+    list.should =~ [@test1, @test2]
+  end
+
   it "should include the scenarios that have tags specified in the iteration" do
     iteration = {
         name: "iphone",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cuke_iterations
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-27 00:00:00.000000000Z
+date: 2012-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin
-  requirement: &2155927060 !ruby/object:Gem::Requirement
+  requirement: &70344800299600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2155927060
+  version_requirements: *70344800299600
 description: Run your Cucumber features multiple times within one Cucumber invocation
 email:
 - jon@jmerrifield.com
@@ -37,20 +37,24 @@ files:
 - README.md
 - Rakefile
 - bin/cuke_iterations
+- changelog.md
 - cuke_iterations.gemspec
 - example/features/cuke_iterations.yml
 - example/features/cuking_rocks.feature
-- example/features/i_love_cukes.feature
+- example/features/subdirectory/i_love_cukes.feature
 - example/features/support/env.rb
 - example/features/support/hooks.rb
 - lib/cuke_iterations.rb
 - lib/cuke_iterations/cucumber_helper.rb
 - lib/cuke_iterations/cuke_parser.rb
+- lib/cuke_iterations/iteration_file_finder.rb
 - lib/cuke_iterations/scenario_extracting_formatter.rb
+- lib/cuke_iterations/scenario_file_writer.rb
 - lib/cuke_iterations/scenario_list_generator.rb
 - lib/cuke_iterations/version.rb
 - lib/trollop.rb
 - spec/cuke_parser_spec.rb
+- spec/scenario_file_writer_spec.rb
 - spec/scenario_list_generator_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jmerrifield/cuke_iterations
@@ -73,11 +77,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: cuke_iterations
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Multiple iterations for Cucumber features
 test_files:
 - spec/cuke_parser_spec.rb
+- spec/scenario_file_writer_spec.rb
 - spec/scenario_list_generator_spec.rb
 - spec/spec_helper.rb