cuke_slicer 1.0.0 → 2.2.0

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/gemfiles/cuke_modeler0.gemfile

@@ -0,0 +1,28 @@
+# Older Rubies on Windows cannot securely connect to RubyGems anymore (https://github.com/rubygems/rubygems/issues/2330)
+if (RbConfig::CONFIG['host_os'] =~ /mswin|msys|mingw32/) && (RUBY_VERSION =~ /^1\./)
+  source 'http://rubygems.org'
+else
+  source 'https://rubygems.org'
+end
+
+gemspec :path => "../"
+
+# Using the most recent release of the 0.x series in order to have all of the bug fixes.
+gem 'cuke_modeler', '0.4.1'
+
+if RUBY_VERSION =~ /^1\./
+  gem 'cucumber', '< 3.0.0' # Ruby 1.9.x support dropped after this version
+  gem 'ffi', '< 1.9.15' # The 'ffi' gem requires Ruby 2.x on/after this version
+  gem 'json', '< 2.0' # The 'json' gem drops pre-Ruby 2.x support on/after this version
+  gem 'mime-types', '< 3.0.0' # The 'mime-types' gem requires Ruby 2.x on/after this version
+  gem 'rainbow', '< 3.0' # The 'rainbow' gem requires Ruby 2.x on/after this version
+  gem 'rake', '< 12.3.0' # The 'rake' gem requires Ruby 2.x on/after this version
+  gem 'rest-client', '< 2.0' # The 'rainbow' gem requires Ruby 2.x on/after this version
+  gem 'simplecov-html', '< 0.11.0' # The 'simplecov-html' gem requires Ruby 2.x on/after this version
+  gem 'thor', '< 1.0' # The 'thor' gem requires Ruby 2.x on/after this version
+  gem 'tins', '< 1.7' # The 'tins' gem requires Ruby 2.x on/after this version
+  gem 'term-ansicolor', '< 1.4' # The 'term-ansicolor' gem requires Ruby 2.x on/after this version
+  gem 'unf_ext', '< 0.0.7.3' # The 'unf_ext' gem requires Ruby 2.x on/after this version
+else
+  gem 'cucumber', '< 4.0.0' # Cucumber 4.x switches to needing the `cucumber-gherkin` gem, which is incompatible with `cuke_modeler` 0.x
+end

data/gemfiles/cuke_modeler1.gemfile

@@ -0,0 +1,29 @@
+# Older Rubies on Windows cannot securely connect to RubyGems anymore (https://github.com/rubygems/rubygems/issues/2330)
+if (RbConfig::CONFIG['host_os'] =~ /mswin|msys|mingw32/) && (RUBY_VERSION =~ /^1\./)
+  source 'http://rubygems.org'
+else
+  source 'https://rubygems.org'
+end
+
+gemspec :path => "../"
+
+# The version of CukeModeler being tested
+gem 'cuke_modeler', '~> 1.0'
+
+
+if RUBY_VERSION =~ /^1\./
+  gem 'cucumber', '< 3.0.0' # Ruby 1.9.x support dropped after this version
+  gem 'ffi', '< 1.9.15' # The 'ffi' gem requires Ruby 2.x on/after this version
+  gem 'json', '< 2.0' # The 'json' gem drops pre-Ruby 2.x support on/after this version
+  gem 'mime-types', '< 3.0.0' # The 'mime-types' gem requires Ruby 2.x on/after this version
+  gem 'rainbow', '< 3.0' # The 'rainbow' gem requires Ruby 2.x on/after this version
+  gem 'rake', '< 12.3.0' # The 'rake' gem requires Ruby 2.x on/after this version
+  gem 'rest-client', '< 2.0' # The 'rainbow' gem requires Ruby 2.x on/after this version
+  gem 'simplecov-html', '< 0.11.0' # The 'simplecov-html' gem requires Ruby 2.x on/after this version
+  gem 'thor', '< 1.0' # The 'thor' gem requires Ruby 2.x on/after this version
+  gem 'tins', '< 1.7' # The 'tins' gem requires Ruby 2.x on/after this version
+  gem 'term-ansicolor', '< 1.4' # The 'term-ansicolor' gem requires Ruby 2.x on/after this version
+  gem 'unf_ext', '< 0.0.7.3' # The 'unf_ext' gem requires Ruby 2.x on/after this version
+else
+  gem 'cucumber', '< 4.0.0' # Cucumber 4.x switches to needing the `cucumber-gherkin` gem, which is incompatible with `cuke_modeler` 1.x
+end

data/gemfiles/cuke_modeler2.gemfile

@@ -0,0 +1,29 @@
+# Older Rubies on Windows cannot securely connect to RubyGems anymore (https://github.com/rubygems/rubygems/issues/2330)
+if (RbConfig::CONFIG['host_os'] =~ /mswin|msys|mingw32/) && (RUBY_VERSION =~ /^1\./)
+  source 'http://rubygems.org'
+else
+  source 'https://rubygems.org'
+end
+
+gemspec :path => "../"
+
+# The version of CukeModeler being tested
+gem 'cuke_modeler', '~> 2.0'
+
+
+if RUBY_VERSION =~ /^1\./
+  gem 'cucumber', '< 3.0.0' # Ruby 1.9.x support dropped after this version
+  gem 'ffi', '< 1.9.15' # The 'ffi' gem requires Ruby 2.x on/after this version
+  gem 'json', '< 2.0' # The 'json' gem drops pre-Ruby 2.x support on/after this version
+  gem 'mime-types', '< 3.0.0' # The 'mime-types' gem requires Ruby 2.x on/after this version
+  gem 'rainbow', '< 3.0' # The 'rainbow' gem requires Ruby 2.x on/after this version
+  gem 'rake', '< 12.3.0' # The 'rake' gem requires Ruby 2.x on/after this version
+  gem 'rest-client', '< 2.0' # The 'rainbow' gem requires Ruby 2.x on/after this version
+  gem 'simplecov-html', '< 0.11.0' # The 'simplecov-html' gem requires Ruby 2.x on/after this version
+  gem 'thor', '< 1.0' # The 'thor' gem requires Ruby 2.x on/after this version
+  gem 'tins', '< 1.7' # The 'tins' gem requires Ruby 2.x on/after this version
+  gem 'term-ansicolor', '< 1.4' # The 'term-ansicolor' gem requires Ruby 2.x on/after this version
+  gem 'unf_ext', '< 0.0.7.3' # The 'unf_ext' gem requires Ruby 2.x on/after this version
+else
+  gem 'cucumber', '< 4.0.0' # Cucumber 4.x switches to needing the `cucumber-gherkin` gem, which is incompatible with `cuke_modeler` 2.x
+end

data/gemfiles/cuke_modeler3.gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec :path => "../"
+
+# The version of CukeModeler being tested
+gem 'cuke_modeler', '~> 3.0'
+
+gem 'cucumber', '2.2.0' # `cucumber` 4.x does not currently work on JRuby
+
+if RUBY_VERSION =~ /^2\.[1234]/
+  gem 'activesupport', '< 6.0' # `activesupport` 6.x requires at least Ruby 2.5
+end

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,29 @@
+require "cuke_slicer/helpers/helpers"
+
+
+# Internal helper module that is not part of the public API. Subject to change at any time.
+# :nodoc: all
+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,28 @@
+require "cuke_slicer/helpers/helpers"
+
+
+# Internal helper module that is not part of the public API. Subject to change at any time.
+# :nodoc: all
+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,30 @@
+require "cuke_slicer/helpers/helpers"
+require "cuke_slicer/collections/nested_tag_collection"
+
+
+# Internal helper module that is not part of the public API. Subject to change at any time.
+# :nodoc: all
+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,19 @@
+# Internal helper module that is not part of the public API. Subject to change at any time.
+# :nodoc: all
+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

data/lib/cuke_slicer/extractors/file_extractor.rb

@@ -0,0 +1,34 @@
+require "cuke_slicer/helpers/matching_helpers"
+require "cuke_slicer/helpers/filter_helpers"
+require "cuke_slicer/helpers/extraction_helpers"
+
+
+# Internal helper module that is not part of the public API. Subject to change at any time.
+# :nodoc: all
+module CukeSlicer
+  class FileExtractor
+
+    include ExtractionHelpers
+
+
+    def extract(target, filters, format, &block)
+      Array.new.tap do |test_cases|
+        unless target.feature.nil?
+          tests = target.feature.tests
+
+          runnable_elements = extract_runnable_elements(extract_runnable_block_elements(tests, filters, &block))
+
+          runnable_elements.each do |element|
+            case
+              when format == :file_line
+                test_cases << "#{element.get_ancestor(:feature_file).path}:#{element.source_line}"
+              when format == :test_object
+                test_cases << element
+            end
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/cuke_slicer/filters/filter_set.rb

@@ -0,0 +1,44 @@
+require "cuke_slicer/helpers/helpers"
+require "cuke_slicer/collections/tag_collection"
+require "cuke_slicer/collections/path_collection"
+
+
+# Internal helper module that is not part of the public API. Subject to change at any time.
+# :nodoc: all
+module CukeSlicer
+  class FilterSet
+
+    include Helpers
+
+
+    def initialize filter_type, filter_value
+      self.filter_type = filter_type
+      self.filter_value = filter_value
+    end
+
+    def validate
+      block_unknown
+      block_invalid
+
+      if filter_value.is_a?(Array)
+        TagCollection.new(filter_value).validate if is_tag?(filter_type)
+        PathCollection.new(filter_value).validate if is_path?(filter_type)
+      end
+    end
+
+
+    private
+
+
+    def block_unknown
+      raise(ArgumentError, "Unknown filter '#{filter_type}'") unless CukeSlicer::Slicer.known_filters.include?(filter_type)
+    end
+
+    def block_invalid
+      raise(ArgumentError, "Invalid filter '#{filter_value}'. Must be a String, Regexp, or Array thereof. Got #{filter_value.class}") unless str_regex_arr?(filter_value)
+    end
+
+    attr_accessor :filter_type, :filter_value
+
+  end
+end

data/lib/cuke_slicer/helpers/extraction_helpers.rb

@@ -0,0 +1,44 @@
+# Internal helper module that is not part of the public API. Subject to change at any time.
+# :nodoc: all
+module CukeSlicer
+  module ExtractionHelpers
+
+    include FilterHelpers
+
+
+    def extract_runnable_block_elements(things, filters, &block)
+      Array.new.tap do |elements|
+        things.each do |thing|
+          if thing.is_a?(CukeModeler::Outline)
+            elements.concat(thing.examples)
+          else
+            elements << thing
+          end
+        end
+
+        filter_excluded_paths(elements, filters[:excluded_paths])
+        filter_included_paths(elements, filters[:included_paths])
+        filter_excluded_tags(elements, filters[:excluded_tags])
+        filter_included_tags(elements, filters[:included_tags])
+
+        apply_custom_filter(elements, &block)
+      end
+    end
+
+    def extract_runnable_elements(things)
+      method_for_row_models = Gem.loaded_specs['cuke_modeler'].version.version[/^0/] ? :row_elements : :rows
+
+      Array.new.tap do |elements|
+        things.each do |thing|
+          if thing.is_a?(CukeModeler::Example)
+            # Slicing in order to remove the parameter row element
+            elements.concat(thing.send(method_for_row_models).slice(1, thing.rows.count))
+          else
+            elements << thing
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/cuke_slicer/helpers/filter_helpers.rb

@@ -0,0 +1,62 @@
+# Internal helper module that is not part of the public API. Subject to change at any time.
+# :nodoc: all
+module CukeSlicer
+  module FilterHelpers
+
+    include MatchingHelpers
+
+
+    def apply_custom_filter(elements, &block)
+      if block
+        elements.reject! do |element|
+          block.call(element)
+        end
+      end
+    end
+
+    def filter_excluded_tags(elements, filters)
+      if filters
+        filters = [filters] unless filters.is_a?(Array)
+
+        unless filters.empty?
+          elements.reject! do |element|
+            matching_tag?(element, filters)
+          end
+        end
+      end
+    end
+
+    def filter_included_tags(elements, filters)
+      if filters
+        filters = [filters] unless filters.is_a?(Array)
+
+        elements.keep_if do |element|
+          matching_tag?(element, filters)
+        end
+      end
+    end
+
+    def filter_excluded_paths(elements, filters)
+      if filters
+        filters = [filters] unless filters.is_a?(Array)
+
+        elements.reject! do |element|
+          matching_path?(element, filters)
+        end
+      end
+    end
+
+    def filter_included_paths(elements, filters)
+      if filters
+        filters = [filters] unless filters.is_a?(Array)
+
+        unless filters.empty?
+          elements.keep_if do |element|
+            matching_path?(element, filters)
+          end
+        end
+      end
+    end
+
+  end
+end