cuke_slicer 1.0.0 → 2.0.0

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+
+script: bundle exec rake cuke_slicer:ci_build

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cuke_slicer.gemspec
 gemspec
+
+gem 'coveralls', require: false, :group => :development

data/History.rdoc

@@ -0,0 +1,11 @@
+=== Version 2.0.0 / 2015-07-08
+
+* When slicing a directory, the test cases returned can now be provided as model objects in addition to the
+  previous 'file_path:line_number' format.
+
+* Major performance increase
+
+
+=== Version 1.0.0 / 2015-04-01
+
+* Initial release

data/README.md

@@ -1,5 +1,18 @@
 # CukeSlicer
 
+<a href="http://badge.fury.io/rb/cuke_slicer"><img src="https://badge.fury.io/rb/cuke_slicer.svg" alt="Gem Version"></a>
+
+<a href='https://gemnasium.com/grange-insurance/cuke_slicer'><img src="https://gemnasium.com/grange-insurance/cuke_slicer.svg" alt="Dependency Status" /></a>
+
+<a href='https://github.com/grange-insurance/cuke_slicer/blob/master/LICENSE.txt'><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="Project License" /></a>
+
+<a href="https://travis-ci.org/grange-insurance/cuke_slicer"><img src="https://travis-ci.org/grange-insurance/cuke_slicer.svg" alt="Build Status"></a>
+
+<a href='https://coveralls.io/r/grange-insurance/cuke_slicer'><img src='https://coveralls.io/repos/grange-insurance/cuke_slicer/badge.svg' alt='Coverage Status' /></a>
+
+<a href="https://codeclimate.com/github/grange-insurance/cuke_slicer"><img src="https://codeclimate.com/github/grange-insurance/cuke_slicer/badges/gpa.svg" alt="Code Quality" /></a>
+
+
 The cuke_slicer gem provides an easy and programmatic way to divide a Cucumber test suite into granular test
 cases that can then be dealt with on an individual basis. Often this means handing them off to a distributed
 testing system in order to parallelize test execution.
@@ -33,7 +46,7 @@ Or install it yourself as:
                included_paths: [/test_directory/]}
 
     # Use the slicer to find all tests matching those filters
-    found_tests = CukeSlicer::Slicer.new.slice(test_directory, filters)
+    found_tests = CukeSlicer::Slicer.new.slice(test_directory, filters, :file_line)
 
 
     # Arrange the sliced pieces to suit your particular needs. In this case, we will dump them

data/Rakefile

@@ -1,49 +1,53 @@
-require "bundler/gem_tasks"
-require 'cucumber/rake/task'
-require 'rspec/core/rake_task'
-
-
-def set_cucumber_options(options)
-  ENV['CUCUMBER_OPTS'] = options
-end
-
-def combine_options(set_1, set_2)
-  set_2 ? "#{set_1} #{set_2}" : set_1
-end
-
-
-namespace 'cuke_slicer' do
-
-  task :clear_coverage do
-    puts 'Clearing old code coverage results...'
-
-    # Remove previous coverage results so that they don't get merged in the new results
-    code_coverage_directory = File.join(File.dirname(__FILE__), 'coverage')
-    FileUtils.remove_dir(code_coverage_directory, true) if File.exists?(code_coverage_directory)
-  end
-
-  namespace 'cucumber' do
-    desc 'Run all Cucumber tests for the gem'
-    task :tests, [:command_options] do |t, args|
-      set_cucumber_options(combine_options('-t ~@wip -t ~@off', args[:command_options]))
-    end
-    Cucumber::Rake::Task.new(:tests)
-  end
-
-  namespace 'rspec' do
-    desc 'Run all RSpec tests for the gem'
-    RSpec::Core::RakeTask.new(:specs, :command_options) do |t, args|
-      t.rspec_opts = combine_options('--tag ~wip', args[:command_options])
-    end
-  end
-
-  desc 'Run all tests for the gem'
-  task :test_everything, [:command_options] => :clear_coverage do |t, args|
-    Rake::Task['cuke_slicer:rspec:specs'].invoke(args[:command_options])
-    Rake::Task['cuke_slicer:cucumber:tests'].invoke(args[:command_options])
-  end
-
-end
-
-
-task :default => 'cuke_slicer:test_everything'
+require "bundler/gem_tasks"
+require 'cucumber/rake/task'
+require 'rspec/core/rake_task'
+require 'coveralls/rake/task'
+
+
+def set_cucumber_options(options)
+  ENV['CUCUMBER_OPTS'] = options
+end
+
+def combine_options(set_1, set_2)
+  set_2 ? "#{set_1} #{set_2}" : set_1
+end
+
+
+namespace 'cuke_slicer' do
+
+  task :clear_coverage do
+    puts 'Clearing old code coverage results...'
+
+    # Remove previous coverage results so that they don't get merged in the new results
+    code_coverage_directory = File.join(File.dirname(__FILE__), 'coverage')
+    FileUtils.remove_dir(code_coverage_directory, true) if File.exists?(code_coverage_directory)
+  end
+
+  namespace 'cucumber' do
+    desc 'Run all Cucumber tests for the gem'
+    task :tests, [:command_options] do |t, args|
+      set_cucumber_options(combine_options('-t ~@wip -t ~@off', args[:command_options]))
+    end
+    Cucumber::Rake::Task.new(:tests)
+  end
+
+  namespace 'rspec' do
+    desc 'Run all RSpec tests for the gem'
+    RSpec::Core::RakeTask.new(:specs, :command_options) do |t, args|
+      t.rspec_opts = combine_options('--tag ~wip', args[:command_options])
+    end
+  end
+
+  desc 'Run all tests for the gem'
+  task :test_everything, [:command_options] => :clear_coverage do |t, args|
+    Rake::Task['cuke_slicer:rspec:specs'].invoke(args[:command_options])
+    Rake::Task['cuke_slicer:cucumber:tests'].invoke(args[:command_options])
+  end
+
+  Coveralls::RakeTask.new
+  task :ci_build => [:clear_coverage, :test_everything, 'coveralls:push']
+
+end
+
+
+task :default => 'cuke_slicer:test_everything'

data/cuke_slicer.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["morrow748@gmail.com"]
   spec.summary       = %q{A gem for extracting test cases from a Cucumber test suite.}
   spec.description   = spec.summary
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/grange-insurance/cuke_slicer"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/features/step_definitions/action_steps.rb

@@ -7,16 +7,17 @@ When(/^test cases are extracted from "([^"]*)"$/) do |target|
   filters[:excluded_paths] = @excluded_path_filters if @excluded_path_filters
   filters[:included_paths] = @included_path_filters if @included_path_filters
 
-  @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", filters, &@custom_filter)
+  @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", filters, :file_line, &@custom_filter)
 end
 
 When(/^test cases are extracted from it$/) do
   @output ||= {}
   filters = {}
   target = @targets.first
+  @output_type ||= :file_line
 
   begin
-    @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", filters)
+    @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", filters, @output_type)
   rescue ArgumentError => e
     @error_raised = e
   end
@@ -27,7 +28,7 @@ When(/^test cases are extracted from them$/) do
   filters = {}
 
   @targets.each do |target|
-    @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", filters)
+    @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", filters, :file_line)
   end
 end
 
@@ -37,7 +38,7 @@ When(/^test cases are extracted from "([^"]*)" using the following exclusive tag
 
   options[:excluded_tags] = filters.raw.flatten.collect { |filter| process_filter(filter) }
 
-  @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", options)
+  @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", options, :file_line)
 end
 
 When(/^test cases are extracted from "([^"]*)" using the following inclusive tag filters:$/) do |target, filters|
@@ -46,7 +47,7 @@ When(/^test cases are extracted from "([^"]*)" using the following inclusive tag
 
   options[:included_tags] = filters.raw.flatten.collect { |filter| process_filter(filter) }
 
-  @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", options)
+  @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", options, :file_line)
 end
 
 When(/^test cases are extracted from "([^"]*)" using the following inclusive path filters:$/) do |target, filters|
@@ -55,7 +56,7 @@ When(/^test cases are extracted from "([^"]*)" using the following inclusive pat
 
   options[:included_paths] = filters.raw.flatten.collect { |filter| process_filter(filter) }
 
-  @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", options)
+  @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", options, :file_line)
 end
 
 When(/^test cases are extracted from "([^"]*)" using the following exclusive path filters:$/) do |target, filters|
@@ -64,7 +65,7 @@ When(/^test cases are extracted from "([^"]*)" using the following exclusive pat
 
   options[:excluded_paths] = filters.raw.flatten.collect { |filter| process_filter(filter) }
 
-  @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", options)
+  @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", options, :file_line)
 end
 
 When(/^test cases are extracted from "([^"]*)" using the following custom filter:$/) do |target, filter_block|
@@ -72,7 +73,7 @@ When(/^test cases are extracted from "([^"]*)" using the following custom filter
 
   custom_filter = eval("Proc.new #{filter_block}")
 
-  @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", &custom_filter)
+  @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", :file_line, &custom_filter)
 end
 
 When(/^test cases are extracted from "([^"]*)" using "([^"]*)"$/) do |target, included_tag_filters|
@@ -81,7 +82,7 @@ When(/^test cases are extracted from "([^"]*)" using "([^"]*)"$/) do |target, in
 
   options[:included_tags] = eval("[#{included_tag_filters}]")
 
-  @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", options)
+  @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", options, :file_line)
 end
 
 def process_filter(filter)
@@ -91,7 +92,7 @@ end
 
 When(/^it tries to extract test cases using an unknown filter type$/) do
   begin
-    @slicer.slice(@default_file_directory, {unknown_filter: 'foo'})
+    @slicer.slice(@default_file_directory, {unknown_filter: 'foo'}, :file_line)
   rescue ArgumentError => e
     @error_raised = e
   end
@@ -99,7 +100,7 @@ end
 
 When(/^it tries to extract test cases using an invalid filter$/) do
   begin
-    @slicer.slice(@default_file_directory, {included_tags: 7})
+    @slicer.slice(@default_file_directory, {included_tags: 7}, :file_line)
   rescue ArgumentError => e
     @error_raised = e
   end

data/features/step_definitions/setup_steps.rb

@@ -77,3 +77,27 @@ end
 Given(/^a slicer$/) do
   @slicer = CukeSlicer::Slicer.new
 end
+
+And(/^the test cases are to be extracted as objects$/) do
+  @output_type = :test_object
+end
+
+And(/^an invalid output option$/) do
+  @output_type = :invalid_option
+end
+
+Given(/^a test suite to extract from$/) do
+  @test_directory ||= @default_file_directory
+
+  @targets ||= []
+  @targets << @default_feature_file_name
+
+
+  test_suite = "Feature: Test feature
+
+                   @tag
+                   Scenario: Test scenario
+                     * some step"
+
+  File.write("#{@test_directory}/#{@default_feature_file_name}", test_suite)
+end

data/features/step_definitions/verification_steps.rb

@@ -45,3 +45,14 @@ Then(/^an error indicating that the filter is invalid will be triggered$/) do
   expect(@error_raised).to_not be_nil
   expect(@error_raised.message).to match(/invalid filter/i)
 end
+
+Then(/^the test cases are provided as objects$/) do
+  @output.values.flatten.each do |output|
+    expect(output).to be_a(CukeModeler::Scenario).or be_a(CukeModeler::Row)
+  end
+end
+
+Then(/^an error indicating that the output type is invalid will be triggered$/) do
+  expect(@error_raised).to_not be_nil
+  expect(@error_raised.message).to match(/Invalid Output Format/i)
+end

data/features/test_case_extraction.feature

@@ -1,6 +1,6 @@
 Feature: Test case extraction
 
-  Test cases can be extracted from a source file or directory as a collection of 'file:line' items that
+  Test cases can be extracted from a source file or directory as a collection of 'file:line' items or objects that
   can then be conveniently arranged for consumption by some other tool (e.g. Cucumber).
 
 
@@ -76,3 +76,9 @@ Feature: Test case extraction
     And the directory "test_directory/empty_directory"
     When test cases are extracted from "test_directory"
     Then no test cases are found
+
+  Scenario: Extracting objects
+    Given a test suite to extract from
+    And the test cases are to be extracted as objects
+    When test cases are extracted from it
+    Then the test cases are provided as objects

data/features/validation.feature

@@ -54,3 +54,9 @@ Feature: Validation
     When test cases are extracted from "test_directory"
     Then the following test cases are found
       | path/to/test_directory/a_test.feature:3 |
+
+  Scenario: Invalid output type are not allowed
+    Given a test suite to extract from
+    And an invalid output option
+    When test cases are extracted from it
+    Then an error indicating that the output type is invalid will be triggered

data/lib/cuke_slicer.rb

@@ -1,10 +1,10 @@
-require 'cuke_modeler'
-
-require "cuke_slicer/version"
-require "cuke_slicer/slicer"
-
-
-# Top level module under which the gem code lives.
-module CukeSlicer
-  # Your code goes here...
-end
+require 'cuke_modeler'
+
+require "cuke_slicer/version"
+require "cuke_slicer/slicer"
+
+
+# Top level module under which the gem code lives.
+module CukeSlicer
+  # Your code goes here...
+end

data/lib/cuke_slicer/collections/nested_tag_collection.rb

@@ -0,0 +1,27 @@
+require "cuke_slicer/helpers/helpers"
+
+
+module CukeSlicer
+  class NestedTagCollection
+
+    include Helpers
+
+
+    def initialize collection
+      self.nested_collection = collection
+    end
+
+    def validate
+      nested_collection.each do |element|
+        raise(ArgumentError, "Tag filters cannot be nested more than one level deep.") if element.is_a?(Array)
+        raise(ArgumentError, "Filter '#{element}' must be a String or Regexp. Got #{element.class}") unless str_regex?(element)
+      end
+    end
+
+
+    private
+
+    attr_accessor :nested_collection
+
+  end
+end

data/lib/cuke_slicer/collections/path_collection.rb

@@ -0,0 +1,26 @@
+require "cuke_slicer/helpers/helpers"
+
+
+module CukeSlicer
+  class PathCollection
+
+    include Helpers
+
+
+    def initialize filter_values
+      self.filter_values = filter_values
+    end
+
+    def validate
+      filter_values.each do |val|
+        raise(ArgumentError, "Filter '#{val}' must be a String or Regexp. Got #{val.class}") unless str_regex?(val)
+      end
+    end
+
+
+    private
+
+    attr_accessor :filter_values
+
+  end
+end

data/lib/cuke_slicer/collections/tag_collection.rb

@@ -0,0 +1,28 @@
+require "cuke_slicer/helpers/helpers"
+require "cuke_slicer/collections/nested_tag_collection"
+
+
+module CukeSlicer
+  class TagCollection
+
+    include Helpers
+
+
+    def initialize parameters
+      self.filter_values = parameters
+    end
+
+    def validate
+      filter_values.each do |val|
+        raise(ArgumentError, "Filter '#{val}' must be a String, Regexp, or Array. Got #{val.class}") unless str_regex_arr?(val)
+        NestedTagCollection.new(val).validate if val.is_a?(Array)
+      end
+    end
+
+
+    private
+
+    attr_accessor :filter_values
+
+  end
+end

data/lib/cuke_slicer/extractors/directory_extractor.rb

@@ -0,0 +1,17 @@
+module CukeSlicer
+  class DirectoryExtractor
+
+    def extract(target, filters, format, &block)
+      Array.new.tap do |test_cases|
+        target.feature_files.each do |feature_file|
+          test_cases.concat(FileExtractor.new.extract(feature_file, filters, format, &block))
+        end
+
+        target.directories.each do |directory|
+          test_cases.concat(extract(directory, filters, format, &block))
+        end
+      end
+    end
+
+  end
+end