cuke_slicer 1.0.0 → 2.0.0

data/lib/cuke_slicer/version.rb

@@ -1,4 +1,4 @@
 module CukeSlicer
   # The current version for the gem.
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end

data/spec/slicer_integration_spec.rb

@@ -3,74 +3,93 @@ require 'spec_helper'
 
 describe 'Slicer, Integration' do
 
-  let!(:clazz) { CukeSlicer::Slicer }
+  let(:clazz) { CukeSlicer::Slicer }
   let(:slicer) { clazz.new }
   let(:test_file) { "#{@default_file_directory}/a_test.feature" }
+  let(:test_file_text) { "Feature: Test feature
 
-  before(:each) do
-    file_text = "Feature: Test feature
-
-                   @tag
-                   Scenario: Test scenario
-                     * some step"
+                          @tag
+                          Scenario: Test scenario
+                            * some step" }
 
-    File.open(test_file, 'w') { |file| file.write(file_text) }
+  before(:each) do
+    File.write(test_file, test_file_text)
   end
 
 
   describe 'slicing' do
 
-    it 'slicing returns a collection of test cases' do
-      slice_output = slicer.slice(test_file)
+    describe 'output' do
 
-      expect(slice_output).to be_an(Array)
-      expect(slice_output).to_not be_empty
+      it 'slicing returns a collection of test source lines' do
+        slice_output = slicer.slice(test_file, :file_line)
 
-      slice_output.each do |test_case|
-        # Test cases come in 'file_path:line_number' format
-        expect(test_case).to match(/^.+:\d+$/)
+        expect(slice_output).to be_an(Array)
+        expect(slice_output).to_not be_empty
+
+        slice_output.each do |test_case|
+          # Test cases come in 'file_path:line_number' format
+          expect(test_case).to match(/^.+:\d+$/)
+        end
       end
+
+      it 'slicing returns a collection of test objects' do
+        slice_output = slicer.slice(test_file, :test_object)
+
+        expect(slice_output).to be_an(Array)
+        expect(slice_output).to_not be_empty
+
+        slice_output.each do |test_case|
+          # Test cases come as test objects
+          expect(test_case).to be_a(CukeModeler::Scenario).or be_a(CukeModeler::Row)
+        end
+      end
+
+      it 'complains if told to provide output in an unknown format' do
+        expect { slicer.slice(test_file, :bad_option) }.to raise_error(ArgumentError, /Invalid Output Format/)
+      end
+
     end
 
     it 'can slice without being provided filters' do
-      expect { slicer.slice(test_file) }.to_not raise_error
+      expect { slicer.slice(test_file, :file_line) }.to_not raise_error
     end
 
     it 'uses the custom filter, if provided' do
-      expect { |test_block| slicer.slice(@default_file_directory, &test_block) }.to yield_control
-      expect { slicer.slice(@default_file_directory) }.to_not raise_error
+      expect { |test_block| slicer.slice(@default_file_directory, :file_line, &test_block) }.to yield_control
+      expect { slicer.slice(@default_file_directory, :file_line) }.to_not raise_error
     end
 
     it 'can slice an empty feature file' do
       File.open(test_file, 'w') { |file| file.write('') }
 
-      expect { slicer.slice(test_file) }.to_not raise_error
+      expect { slicer.slice(test_file, :file_line) }.to_not raise_error
     end
 
     it 'can slice a feature that has no tests' do
       File.open(test_file, 'w') { |file| file.write('Feature: Empty feature') }
 
-      expect { slicer.slice(test_file) }.to_not raise_error
+      expect { slicer.slice(test_file, :file_line) }.to_not raise_error
     end
 
     it 'can slice a directory that contains non-feature files' do
       File.open("#{@default_file_directory}/not_a_feature.file", 'w') { |file| file.write('foobar') }
 
-      expect { slicer.slice(@default_file_directory) }.to_not raise_error
+      expect { slicer.slice(@default_file_directory, :file_line) }.to_not raise_error
     end
 
 
     describe 'target validation' do
 
       it 'complains if told to slice a non-existent location' do
-        expect { slicer.slice('does/not/exist') }.to raise_error(ArgumentError, /does not exist/)
-        expect { slicer.slice(nil) }.to raise_error(ArgumentError, /does not exist/)
+        expect { slicer.slice('does/not/exist', :file_line) }.to raise_error(ArgumentError, /does not exist/)
+        expect { slicer.slice(nil, :file_line) }.to raise_error(ArgumentError, /does not exist/)
       end
 
       it 'complains if told to slice an incorrectly formatted feature file' do
         File.open(test_file, 'w') { |file| file.write('foobar') }
 
-        expect { slicer.slice(test_file) }.to raise_error(ArgumentError, /syntax.*lexing problem.*#{test_file}/i)
+        expect { slicer.slice(test_file, :file_line) }.to raise_error(ArgumentError, /syntax.*lexing problem.*#{test_file}/i)
       end
 
     end
@@ -84,13 +103,13 @@ describe 'Slicer, Integration' do
       filters = clazz.known_filters
 
       filters.each do |filter|
-        not_provided = slicer.slice(test_file)
+        not_provided = slicer.slice(test_file, :file_line)
 
         case
           when filter.to_s =~ /path/
-            nothing_provided = slicer.slice(test_file, filter => [])
+            nothing_provided = slicer.slice(test_file, {filter => []}, :file_line)
           when filter.to_s =~ /tag/
-            nothing_provided = slicer.slice(test_file, filter => [])
+            nothing_provided = slicer.slice(test_file, {filter => []}, :file_line)
           else
             raise(ArgumentError, "Unknown filter '#{filter}'")
         end
@@ -114,7 +133,7 @@ describe 'Slicer, Integration' do
       expect(applied_filters.keys).to match_array(filters)
 
 
-      expect { @slice_output = slicer.slice(@default_file_directory, applied_filters, &block_filter) }.to_not raise_error
+      expect { @slice_output = slicer.slice(@default_file_directory, applied_filters, :file_line, &block_filter) }.to_not raise_error
       expect(@slice_output).to be_an(Array)
       expect(@slice_output).to_not be_empty
     end
@@ -126,11 +145,11 @@ describe 'Slicer, Integration' do
         path_filter_types = clazz.known_filters.select { |filter| filter.to_s =~ /path/ }
 
         path_filter_types.each do |filter|
-          expect { slicer.slice(@default_file_directory, filter => '@some_value') }.to_not raise_error
-          expect { slicer.slice(@default_file_directory, filter => /some_pattern/) }.to_not raise_error
-          expect { slicer.slice(@default_file_directory, filter => ['@some_value', /some_pattern/]) }.to_not raise_error
-          expect { slicer.slice(@default_file_directory, filter => :something_else) }.to raise_error(ArgumentError, /must be a/i)
-          expect { slicer.slice(@default_file_directory, filter => [:something_else]) }.to raise_error(ArgumentError, /must be a/i)
+          expect { slicer.slice(@default_file_directory, {filter => '@some_value'}, :file_line) }.to_not raise_error
+          expect { slicer.slice(@default_file_directory, {filter => /some_pattern/}, :file_line)}.to_not raise_error
+          expect { slicer.slice(@default_file_directory, {filter => ['@some_value', /some_pattern/]}, :file_line)}.to_not raise_error
+          expect { slicer.slice(@default_file_directory, {filter => :something_else}, :file_line) }.to raise_error(ArgumentError, /must be a/i)
+          expect { slicer.slice(@default_file_directory, {filter => [:something_else]}, :file_line) }.to raise_error(ArgumentError, /must be a/i)
         end
       end
 
@@ -138,13 +157,13 @@ describe 'Slicer, Integration' do
         tag_filter_types = clazz.known_filters.select { |filter| filter.to_s =~ /tag/ }
 
         tag_filter_types.each do |filter|
-          expect { slicer.slice(@default_file_directory, filter => '@some_value') }.to_not raise_error
-          expect { slicer.slice(@default_file_directory, filter => /some_pattern/) }.to_not raise_error
-          expect { slicer.slice(@default_file_directory, filter => ['@some_value', /some_pattern/]) }.to_not raise_error
-          expect { slicer.slice(@default_file_directory, filter => ['@some_value', [/nested_pattern/]]) }.to_not raise_error
-          expect { slicer.slice(@default_file_directory, filter => ['@some_value', [/nested_pattern/, :bad_value]]) }.to raise_error(ArgumentError, /must be a/i)
-          expect { slicer.slice(@default_file_directory, filter => :something_else) }.to raise_error(ArgumentError, /must be a/i)
-          expect { slicer.slice(@default_file_directory, filter => [:something_else]) }.to raise_error(ArgumentError, /must be a/i)
+          expect { slicer.slice(@default_file_directory, {filter => '@some_value'}, :file_line) }.to_not raise_error
+          expect { slicer.slice(@default_file_directory, {filter => /some_pattern/}, :file_line) }.to_not raise_error
+          expect { slicer.slice(@default_file_directory, {filter => ['@some_value', /some_pattern/]}, :file_line) }.to_not raise_error
+          expect { slicer.slice(@default_file_directory, {filter => ['@some_value', [/nested_pattern/]]}, :file_line) }.to_not raise_error
+          expect { slicer.slice(@default_file_directory, {filter => ['@some_value', [/nested_pattern/, :bad_value]]}, :file_line) }.to raise_error(ArgumentError, /must be a/i)
+          expect { slicer.slice(@default_file_directory, {filter => :something_else}, :file_line) }.to raise_error(ArgumentError, /must be a/i)
+          expect { slicer.slice(@default_file_directory, {filter => [:something_else]}, :file_line) }.to raise_error(ArgumentError, /must be a/i)
         end
       end
 
@@ -152,8 +171,8 @@ describe 'Slicer, Integration' do
         tag_filter_types = clazz.known_filters.select { |filter| filter.to_s =~ /tag/ }
 
         tag_filter_types.each do |filter|
-          expect { slicer.slice(@default_file_directory, filter => ['@some_value', [/nested_pattern/]]) }.to_not raise_error
-          expect { slicer.slice(@default_file_directory, filter => ['@some_value', [/nested_pattern/, ['way_too_nested']]]) }.to raise_error(ArgumentError, /cannot.* nested/i)
+          expect { slicer.slice(@default_file_directory, {filter => ['@some_value', [/nested_pattern/]]}, :file_line) }.to_not raise_error
+          expect { slicer.slice(@default_file_directory, {filter => ['@some_value', [/nested_pattern/, ['way_too_nested']]]}, :file_line) }.to raise_error(ArgumentError, /cannot.* nested/i)
         end
       end
 
@@ -161,11 +180,63 @@ describe 'Slicer, Integration' do
         unknown_filter_type = :unknown_filter
         options = {unknown_filter_type => 'foo'}
 
-        expect { slicer.slice(@default_file_directory, options) }.to raise_error(ArgumentError, /unknown filter.*#{unknown_filter_type}/i)
+        expect { slicer.slice(@default_file_directory, options, :file_line) }.to raise_error(ArgumentError, /unknown filter.*#{unknown_filter_type}/i)
       end
 
     end
 
   end
 
+  describe "bugs that we don't want to happen again" do
+
+
+    # As a nested directory structure was being traversed for slicing, the extraction algorithm was mangling the
+    # current file path such that it would sometimes attempt to search non-existent locations. Sometimes this
+    # resulted in an exception and sometimes this resulted in files getting silently skipped over.
+
+
+    it 'can handle a realistically nested directory structure' do
+      root_directory = @default_file_directory
+
+      # Outer 'before' hook already makes a root level feature file
+      expected_tests = ["#{test_file}:4"]
+
+      # Adding a nested directory
+      nested_directory_1 = "#{root_directory}/nested_directory_1"
+      FileUtils.mkpath(nested_directory_1)
+      test_file = "#{nested_directory_1}/nested_file_1.feature"
+      File.write(test_file, test_file_text)
+      expected_tests << "#{test_file}:4"
+      test_file = "#{nested_directory_1}/nested_file_2.feature"
+      File.write(test_file, test_file_text)
+      expected_tests << "#{test_file}:4"
+
+      # And another one
+      nested_directory_2 = "#{root_directory}/nested_directory_2"
+      FileUtils.mkpath(nested_directory_2)
+      test_file = "#{nested_directory_2}/nested_file_1.feature"
+      File.write(test_file, test_file_text)
+      expected_tests << "#{test_file}:4"
+      test_file = "#{nested_directory_2}/nested_file_2.feature"
+      File.write(test_file, test_file_text)
+      expected_tests << "#{test_file}:4"
+
+      # And one of them has another directory inside of it
+      doubly_nested_directory = "#{nested_directory_1}/doubly_nested_directory"
+      FileUtils.mkpath(doubly_nested_directory)
+      test_file = "#{doubly_nested_directory}/doubly_nested_file_1.feature"
+      File.write(test_file, test_file_text)
+      expected_tests << "#{test_file}:4"
+      test_file = "#{doubly_nested_directory}/doubly_nested_file_2.feature"
+      File.write(test_file, test_file_text)
+      expected_tests << "#{test_file}:4"
+
+
+      # No problems, no missed files
+      expect { @slice_output = slicer.slice(root_directory, :file_line) }.to_not raise_error
+      expect(@slice_output).to match_array(expected_tests)
+    end
+
+  end
+
 end

data/spec/slicer_unit_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 
 describe 'Slicer, Unit' do
 
-  let!(:clazz) { CukeSlicer::Slicer }
+  let(:clazz) { CukeSlicer::Slicer }
   let(:slicer) { clazz.new }
 
 
@@ -15,8 +15,8 @@ describe 'Slicer, Unit' do
     expect(slicer).to respond_to(:slice)
   end
 
-  it 'needs something to slice up and can optionally have applicable filters' do
-    expect(slicer.method(:slice).arity).to eq(-2)
+  it 'needs something to slice up, an output format, and can optionally have applicable filters' do
+    expect(slicer.method(:slice).arity).to eq(-3)
   end
 
   it 'knows what slice filters are available for use' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cuke_slicer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-01 00:00:00.000000000 Z
+date: 2015-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cuke_modeler
@@ -116,7 +116,9 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .simplecov
+- .travis.yml
 - Gemfile
+- History.rdoc
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -130,13 +132,23 @@ files:
 - features/test_case_filtering.feature
 - features/validation.feature
 - lib/cuke_slicer.rb
+- lib/cuke_slicer/collections/nested_tag_collection.rb
+- lib/cuke_slicer/collections/path_collection.rb
+- lib/cuke_slicer/collections/tag_collection.rb
+- lib/cuke_slicer/extractors/directory_extractor.rb
+- lib/cuke_slicer/extractors/file_extractor.rb
+- lib/cuke_slicer/filters/filter_set.rb
+- lib/cuke_slicer/helpers/extraction_helpers.rb
+- lib/cuke_slicer/helpers/filter_helpers.rb
+- lib/cuke_slicer/helpers/helpers.rb
+- lib/cuke_slicer/helpers/matching_helpers.rb
 - lib/cuke_slicer/slicer.rb
 - lib/cuke_slicer/version.rb
 - spec/cuke_slicer_spec.rb
 - spec/slicer_integration_spec.rb
 - spec/slicer_unit_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/grange-insurance/cuke_slicer
 licenses:
 - MIT
 post_install_message: 
@@ -149,21 +161,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1021242189
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1021242189
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.28
 signing_key: 
 specification_version: 3
 summary: A gem for extracting test cases from a Cucumber test suite.
@@ -180,3 +186,4 @@ test_files:
 - spec/slicer_integration_spec.rb
 - spec/slicer_unit_spec.rb
 - spec/spec_helper.rb
+has_rdoc: