cuke_slicer 1.0.0 → 2.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c69098207d6d5580577ecad5469270b5cbec21138e66739d74815ed0a4442ab3
+  data.tar.gz: 5dd474604bdddeddf0f02ffebec61b6af2a9319f48bc8b8e10f37a94cb7459d0
+SHA512:
+  metadata.gz: 213337d4665b2c5b329c9335fde6afc0af9dbe4031a626eb45eba6acce31924f1df00cbb83a55cfd756dabea379b06c515a4633ff5ee3657170f8e4520acce5d
+  data.tar.gz: cd6e817e1a30de5700bb11f47435a08af612cc7fb218bf07e1f8522d21a3f00eb1578423cb56fbeff136fd38cc36cec310774cbf2a8a223a27ebef202026fe4a

data/.gitignore

@@ -20,3 +20,5 @@ tmp
 *.o
 *.a
 mkmf.log
+.idea/*
+

data/.travis.yml

@@ -0,0 +1,33 @@
+os:
+  - linux
+  - osx
+
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
+  - jruby-9.1.7.0
+
+gemfile:
+  - gemfiles/cuke_modeler0.gemfile
+  - gemfiles/cuke_modeler1.gemfile
+  - gemfiles/cuke_modeler2.gemfile
+  - gemfiles/cuke_modeler3.gemfile
+
+matrix:
+  exclude:
+    # Travis does not provide 1.9.3 on OSX
+    - rvm: 1.9.3
+      os: osx
+    # Ruby 2.3.x for OSX is currently broken on TravisCI and is no longer a supported Ruby version, anyway.
+    - rvm: 2.3.8
+      os: osx
+    # cuke_modeler 3.x has a minimum Ruby version of 2.3
+    - rvm: 1.9.3
+      gemfile: gemfiles/cuke_modeler3.gemfile
+
+
+script: bundle exec rake cuke_slicer:ci_build

data/CHANGELOG.md

@@ -0,0 +1,67 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+Nothing yet...
+
+## [2.2.0] - 2021-01-07
+
+### Added
+ - Ruby 3.x is now supported
+
+## [2.1.0] - 2020-06-22
+
+### Added
+ - Added support for `cuke_modeler` 2.x and 3.x
+
+## [2.0.3] - 2019-05-01
+
+### Added
+
+ - Add dependency version limits to Ruby, which was previously unbound. Previously unofficially supported Ruby versions (1.9.3 - 2.x) are now officially supported.
+
+
+## [2.0.2] - 2016-11-19
+
+### Added
+
+ -  The gem now declares version limits for all of its dependencies.
+
+
+## [2.0.1] - 2016-11-08 (yanked)
+
+### Added
+
+ - Works with both 0.x and 1.x versions of the 'cuke_modeler' gem.
+
+
+## [2.0.0] - 2015-07-08
+
+### Added
+
+ - 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.
+
+### Changed
+
+ -  Major performance increase
+
+
+## [1.0.0] - 2015-04-01
+
+### Added
+
+ - Initial release
+
+[Unreleased]: https://github.com/enkessler/cuke_slicer/compare/v2.2.0...HEAD
+[2.2.0]: https://github.com/enkessler/cuke_slicer/compare/v2.1.0...v2.2.0
+[2.1.0]: https://github.com/enkessler/cuke_slicer/compare/v2.0.3...v2.1.0
+[2.0.3]: https://github.com/enkessler/cuke_slicer/compare/v2.0.2...v2.0.3
+[2.0.2]: https://github.com/enkessler/cuke_slicer/compare/v2.0.1...v2.0.2
+[2.0.1]: https://github.com/enkessler/cuke_slicer/compare/v2.0.0...v2.0.1
+[2.0.0]: https://github.com/enkessler/cuke_slicer/compare/v1.0.0...v2.0.0
+[1.0.0]: https://github.com/enkessler/cuke_slicer/compare/1c6e64b963d97f9037f1dc1ebcb6f8f9966f3b71...v1.0.0

data/LICENSE.txt

@@ -1,4 +1,5 @@
-Copyright (c) 2015 Grange Insurance
+Copyright (c) 2015-2019 Grange Insurance
+Copyright (c) 2020 Eric Kessler
 
 MIT License
 

data/README.md

@@ -1,3 +1,20 @@
+Basic stuff:
+[![Gem Version](https://badge.fury.io/rb/cuke_slicer.svg)](https://rubygems.org/gems/cuke_slicer)
+[![Project License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/mit-license.php)
+[![Downloads](https://img.shields.io/gem/dt/cuke_slicer.svg)](https://rubygems.org/gems/cuke_slicer)
+
+User stuff:
+[![Yard Docs](http://img.shields.io/badge/Documentation-API-blue.svg)](https://www.rubydoc.info/gems/cuke_slicer)
+
+Developer stuff:
+[![Build Status](https://travis-ci.org/enkessler/cuke_slicer.svg)](https://travis-ci.org/enkessler/cuke_slicer)
+[![Build status](https://ci.appveyor.com/api/projects/status/706c8x5ug897wq3x?svg=true)](https://ci.appveyor.com/project/enkessler/cuke-slicer)
+[![Coverage Status](https://coveralls.io/repos/github/enkessler/cuke_slicer/badge.svg)](https://coveralls.io/github/enkessler/cuke_slicer)
+[![Maintainability](https://codeclimate.com/github/enkessler/cuke_slicer/badges/gpa.svg)](https://codeclimate.com/github/enkessler/cuke_slicer/maintainability)
+
+---
+
+
 # CukeSlicer
 
 The cuke_slicer gem provides an easy and programmatic way to divide a Cucumber test suite into granular test
@@ -33,7 +50,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,85 @@
-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 'rake'
+require 'racatt'
+require 'coveralls/rake/task'
+require 'rainbow'
+
+
+Rainbow.enabled = true
+
+namespace 'racatt' do
+  Racatt.create_tasks
+end
+
+
+namespace 'cuke_slicer' do
+
+  desc 'Removes the current code coverage data'
+  task :clear_coverage do
+    code_coverage_directory = "#{File.dirname(__FILE__)}/coverage"
+
+    FileUtils.remove_dir(code_coverage_directory, true)
+  end
+
+  desc 'Check documentation with RDoc'
+  task :check_documentation do
+    output = `rdoc lib -C`
+    puts output
+
+    if output =~ /100.00% documented/
+      puts Rainbow('All code documented').green
+    else
+      raise Rainbow('Parts of the gem are undocumented').red
+    end
+  end
+
+  desc 'Check documentation with RDoc'
+  task :check_for_outdated_dependencies do
+    output = `bundle outdated`
+    puts output
+
+    if output =~ /requested/
+      raise Rainbow('Some dependencies are out of date!').red
+    else
+      puts Rainbow('All direct dependencies up to date!').green
+    end
+  end
+
+  desc 'Run all of the tests'
+  task :test_everything => [:clear_coverage] do
+    rspec_args = '--tag ~@wip --pattern "spec/**/*_spec.rb" --force-color'
+
+    cucumber_version = Gem.loaded_specs['cucumber'].version.version
+
+    if cucumber_version =~ /^[123]\./
+      cucumber_args = 'features -f progress -t ~@wip --color'
+    else
+      cucumber_args = "features -f progress -t 'not @wip' --color"
+    end
+
+    Rake::Task['racatt:test_everything'].invoke(rspec_args, cucumber_args)
+  end
+
+  # creates coveralls:push task
+  Coveralls::RakeTask.new
+
+  desc 'The task that CI will run. Do not run locally.'
+  task :ci_build => ['cuke_slicer:test_everything', 'coveralls:push']
+
+  desc 'Check that things look good before trying to release'
+  task :prerelease_check do
+    begin
+      Rake::Task['cuke_slicer:test_everything'].invoke
+      Rake::Task['cuke_slicer:check_documentation'].invoke
+    rescue => e
+      puts Rainbow("Something isn't right!").red
+      raise e
+    end
+
+    puts Rainbow('All is well. :)').green
+  end
+
+end
+
+
+task :default => 'cuke_slicer:test_everything'

data/appveyor.yml

@@ -0,0 +1,81 @@
+version: '1.0.{build}'
+
+environment:
+  matrix:
+
+    - RUBY_VERSION: 193
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler0.gemfile
+      # AppVeyor does not have a 64-bit Ruby 1.9.3
+    - RUBY_VERSION: 23
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler0.gemfile
+    - RUBY_VERSION: 23-x64
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler0.gemfile
+    - RUBY_VERSION: 24
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler0.gemfile
+    - RUBY_VERSION: 24-x64
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler0.gemfile
+    - RUBY_VERSION: 25
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler0.gemfile
+    - RUBY_VERSION: 25-x64
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler0.gemfile
+
+    - RUBY_VERSION: 193
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler1.gemfile
+      # AppVeyor does not have a 64-bit Ruby 1.9.3
+    - RUBY_VERSION: 23
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler1.gemfile
+    - RUBY_VERSION: 23-x64
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler1.gemfile
+    - RUBY_VERSION: 24
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler1.gemfile
+    - RUBY_VERSION: 24-x64
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler1.gemfile
+    - RUBY_VERSION: 25
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler1.gemfile
+    - RUBY_VERSION: 25-x64
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler1.gemfile
+
+    - RUBY_VERSION: 193
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler2.gemfile
+      # AppVeyor does not have a 64-bit Ruby 1.9.3
+    - RUBY_VERSION: 23
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler2.gemfile
+    - RUBY_VERSION: 23-x64
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler2.gemfile
+    - RUBY_VERSION: 24
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler2.gemfile
+    - RUBY_VERSION: 24-x64
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler2.gemfile
+    - RUBY_VERSION: 25
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler2.gemfile
+    - RUBY_VERSION: 25-x64
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler2.gemfile
+
+      # CukeModeler 3.x requires at least Ruby 2.3
+    - RUBY_VERSION: 23
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler3.gemfile
+    - RUBY_VERSION: 23-x64
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler3.gemfile
+    - RUBY_VERSION: 24
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler3.gemfile
+    - RUBY_VERSION: 24-x64
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler3.gemfile
+    - RUBY_VERSION: 25
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler3.gemfile
+    - RUBY_VERSION: 25-x64
+      BUNDLE_GEMFILE: gemfiles/cuke_modeler3.gemfile
+
+
+install:
+  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
+  - bundle install
+
+build: off
+
+before_test:
+  - ruby -v
+  - gem -v
+  - bundle -v
+
+test_script:
+  - bundle exec rake cuke_slicer:ci_build

data/cuke_slicer.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Eric Kessler"]
   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.description   = %q{Slices a Cucumber test suite into the smallest possible executable pieces (i.e. scenarios and individual outline example rows. These pieces can then be more easily used for running tests in parallel.}
+  spec.homepage      = "https://github.com/enkessler/cuke_slicer"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -18,11 +18,17 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "cuke_modeler"
+  spec.required_ruby_version = '>= 1.9.3', '< 4.0'
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency "cuke_modeler", "< 4.0"
+
+  spec.add_development_dependency 'bundler', '< 3.0'
+  spec.add_development_dependency 'rake', '< 13.0.0'
   spec.add_development_dependency "rspec", '~> 3.0'
-  spec.add_development_dependency "cucumber"
-  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency 'cucumber', '< 5.0.0'
+  spec.add_development_dependency 'simplecov', '<= 0.16.1' # Coveralls gem does not support any newer version than this
+  spec.add_development_dependency "racatt", '~> 1.0'
+  spec.add_development_dependency 'coveralls', '< 1.0.0'
+  spec.add_development_dependency 'rainbow', '< 4.0.0'
+
 end

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