cuke_cataloger 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 827609d20ecbc5d2e4d2786e742a1ba7f8f72a9a
-  data.tar.gz: 0942116e5fc16b864b8a257b0cdad895084cbf68
+  metadata.gz: 30eaf9d9662dd4487ca55a63d56c3911c852e1d8
+  data.tar.gz: 42302cb72e6d57fd83afb9494b8b88fc0400f137
 SHA512:
-  metadata.gz: 3e628724c39985b33ef58610f5b09312166bf40e0bc0f3dae780b6e481d21741e3d6c70ac7e5a9449765350c3708a6eaba2ba961871515384d7f55a1f452f8d1
-  data.tar.gz: 92632d986a95cf0449f3763a05f44dc07ebf6167a69a5e6896d71662e4d190cc591c576882f51293fe1b7ca547d6bb46ab4b2d965681d90f00b1bad4fcf6b42a
+  metadata.gz: 0b9adbdc69989580d77ca66d151287c248c5cb55983c73fa51f9c91a345cc1d7290591de2190d7bde6050d26e89173ef1ba639511850d4a7e22d48ce68297d98
+  data.tar.gz: 89ffe919e0773c884908785a116e90460e037f70e2330f16c86e724fb3ef4139a6b000c2a55e73913ffe387f4365d6a4f9fc033a23d2e7e9ef37177a7a43f19e

data/.travis.yml

@@ -1,12 +1,32 @@
+os:
+  - linux
+  - osx
+
 language: ruby
 rvm:
   - 1.8.7
   - 1.9.3
   - 2.2.2
+  - 2.4.0
+
+matrix:
+  exclude:
+    # Travis does not provide 1.8.7 on OSX
+  - rvm: 1.8.7
+    os: osx
+    # Rake 11.x does not support Ruby 1.8.7
+  - rvm: 1.8.7
+    gemfile: testing/gemfiles/rake11.gemfile
+    # Rake 12.x does not support Ruby 1.8.7
+  - rvm: 1.8.7
+    gemfile: testing/gemfiles/rake12.gemfile
 
 gemfile:
   - testing/gemfiles/cuke_modeler0.gemfile
   - testing/gemfiles/cuke_modeler1.gemfile
+  - testing/gemfiles/rake10.gemfile
+  - testing/gemfiles/rake11.gemfile
+  - testing/gemfiles/rake12.gemfile
 
 # todo - Remove this once TravisCI fixes their bundler issue (https://github.com/alphagov/govuk_template/pull/186)
 before_install:

data/Gemfile

@@ -19,4 +19,4 @@ if RUBY_VERSION =~ /^1\./
   gem 'term-ansicolor', '< 1.4' # The 'term-ansicolor' gem requires Ruby 2.x on/after this version
 end
 
-gem 'cuke_modeler', '~> 1.0'
+gem 'cuke_modeler', '< 2.0'

data/History.md

@@ -1,5 +1,12 @@
 # Release history
 
+### Version 1.4.0 / 2017-04-18
+
+- Both cataloging and validation can now be used without including outline rows, if desired.
+
+- The column header used for outline row ids is now configurable.
+
+
 ### Version 1.3.1 / 2017-01-11
 
 - Bug fix: Added missing shebang line to the gem's executable file.

data/README.md

@@ -2,8 +2,9 @@
 
 
 [![Gem Version](https://badge.fury.io/rb/cuke_cataloger.svg)](http://badge.fury.io/rb/cuke_cataloger)
-[![Build Status](https://travis-ci.org/enkessler/cuke_cataloger.svg?branch=master)](https://travis-ci.org/enkessler/cuke_cataloger)
-[![Coverage Status](https://coveralls.io/repos/enkessler/cuke_cataloger/badge.svg?branch=master&service=github)](https://coveralls.io/github/enkessler/cuke_cataloger?branch=master)
+[![Build Status](https://travis-ci.org/enkessler/cuke_cataloger.svg?branch=dev)](https://travis-ci.org/enkessler/cuke_cataloger)
+[![Build status](https://ci.appveyor.com/api/projects/status/9a7gw3r5ddfugtf0/branch/dev?svg=true)](https://ci.appveyor.com/project/enkessler/cuke-cataloger/branch/dev)
+[![Coverage Status](https://coveralls.io/repos/enkessler/cuke_cataloger/badge.svg?branch=dev&service=github)](https://coveralls.io/github/enkessler/cuke_cataloger?branch=dev)
 [![Code Climate](https://codeclimate.com/github/enkessler/cuke_cataloger/badges/gpa.svg)](https://codeclimate.com/github/enkessler/cuke_cataloger)
 [![Project License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/enkessler/cuke_cataloger/blob/master/LICENSE.txt)
 
@@ -30,11 +31,12 @@ In addition to using the provided classes in any regular Ruby script, the gem's
 
 ### Command Line
 
-    cuke_cataloger catalog_test_cases [--location=LOCATION] [--prefix=PREFIX]
+    cuke_cataloger catalog_test_cases [--location=LOCATION] [--prefix=PREFIX][--[no-]row-id] [--id-column-name=ID_COLUMN_NAME]
 
 and
 
-    cuke_cataloger validate_test_cases [--location=LOCATION] [--prefix=PREFIX] [--file=FILE]
+    cuke_cataloger validate_test_cases [--location=LOCATION] [--prefix=PREFIX] [--[no-]row-id] [--id-column-name=ID_COLUMN_NAME] [--file=FILE]
+
 
 ### Rake Task
 
@@ -76,6 +78,33 @@ The the validating functionality scans a given directory for any problems relate
 
 The above example would result in a report called `validation_results.txt` being generated for any test in the `tests` directory that had problems related to their id (e.g. did not have an id tag, had the same id tag as another test, etc.), based up the id prefix `@my_prefix_`.
 
+
+### Shallow cataloging
+
+The cataloging and validation process can be limited to the test level instead of also checking individual rows in outlines.
+
+`cuke_cataloger catalog_test_cases --no-row-id`
+
+`cuke_cataloger validate_test_cases --no-row-id`
+
+`Rake::Task['tag_tests'].invoke('./features','@test_case_', false)  # 3rd argument is the row flag`
+
+`Rake::Task['validate_tests'].invoke('./features','@test_case_',nil, false)  # 4th argument is the row flag`
+
+
+### Custom id column name
+
+By default, the cataloging and validation process uses `test_case_id` as the column name for outline rows but an alternative name can be provided.
+
+`cuke_cataloger catalog_test_cases --id-column-name my_special_column_id`
+
+`cuke_cataloger validate_test_cases --id-column-name my_special_column_id`
+
+`Rake::Task['tag_tests'].invoke('./features','@test_case_', true, 'my_special_column_id')  # 4th argument is the id column name`
+
+`Rake::Task['validate_tests'].invoke('./features','@test_case_',nil, true, 'my_special_column_id')  # 5th argument is the id column name`
+
+
 ## Contributing
 
 1. Fork it `http://github.com/<my-github-username>/cuke_cataloger/fork`

data/appveyor.yml

@@ -0,0 +1,69 @@
+version: '1.0.{build}'
+
+environment:
+  matrix:
+    - RUBY_VERSION: 187-x64
+      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler0.gemfile
+    - RUBY_VERSION: 193-x64
+      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler0.gemfile
+    - RUBY_VERSION: 200-x64
+      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler0.gemfile
+    - RUBY_VERSION: 21-x64
+      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler0.gemfile
+    - RUBY_VERSION: 22-x64
+      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler0.gemfile
+
+    - RUBY_VERSION: 187-x64
+      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler1.gemfile
+    - RUBY_VERSION: 193-x64
+      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler1.gemfile
+    - RUBY_VERSION: 200-x64
+      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler1.gemfile
+    - RUBY_VERSION: 21-x64
+      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler1.gemfile
+    - RUBY_VERSION: 22-x64
+      BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler1.gemfile
+
+    - RUBY_VERSION: 187-x64
+      BUNDLE_GEMFILE: testing/gemfiles/rake10.gemfile
+    - RUBY_VERSION: 193-x64
+      BUNDLE_GEMFILE: testing/gemfiles/rake10.gemfile
+    - RUBY_VERSION: 200-x64
+      BUNDLE_GEMFILE: testing/gemfiles/rake10.gemfile
+    - RUBY_VERSION: 21-x64
+      BUNDLE_GEMFILE: testing/gemfiles/rake10.gemfile
+    - RUBY_VERSION: 22-x64
+      BUNDLE_GEMFILE: testing/gemfiles/rake10.gemfile
+
+    - RUBY_VERSION: 193-x64
+      BUNDLE_GEMFILE: testing/gemfiles/rake11.gemfile
+    - RUBY_VERSION: 200-x64
+      BUNDLE_GEMFILE: testing/gemfiles/rake11.gemfile
+    - RUBY_VERSION: 21-x64
+      BUNDLE_GEMFILE: testing/gemfiles/rake11.gemfile
+    - RUBY_VERSION: 22-x64
+      BUNDLE_GEMFILE: testing/gemfiles/rake11.gemfile
+
+    - RUBY_VERSION: 193-x64
+      BUNDLE_GEMFILE: testing/gemfiles/rake12.gemfile
+    - RUBY_VERSION: 200-x64
+      BUNDLE_GEMFILE: testing/gemfiles/rake12.gemfile
+    - RUBY_VERSION: 21-x64
+      BUNDLE_GEMFILE: testing/gemfiles/rake12.gemfile
+    - RUBY_VERSION: 22-x64
+      BUNDLE_GEMFILE: testing/gemfiles/rake12.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

data/bin/cuke_cataloger

@@ -10,23 +10,29 @@ class CLI < Thor
   desc 'catalog_test_cases', 'Catalog the test cases in LOCATION with an id based on PREFIX'
   option :location, :default => '.'
   option :prefix, :default => '@test_case_'
+  option :row_id, :type => :boolean, :default => true
+  option :id_column_name, :default => 'test_case_id'
 
   def catalog_test_cases
     puts "Tagging tests in '#{options[:location]}' with tag '#{options[:prefix]}'\n"
+    puts "Including outline rows\n" if options[:row_id]
 
     tagger = CukeCataloger::UniqueTestCaseTagger.new
-    tagger.tag_tests(options[:location], options[:prefix])
+    tagger.tag_tests(options[:location], options[:prefix], {}, options[:row_id], options[:id_column_name])
   end
 
   desc 'validate_test_cases', 'Validate the test cases in LOCATION with an id based on PREFIX. Will output the report to FILE, if provided.'
   option :location, :default => '.'
   option :prefix, :default => '@test_case_'
+  option :row_id, :type => :boolean, :default => true
+  option :id_column_name, :default => 'test_case_id'
   option :file
 
   def validate_test_cases
     puts "Validating tests in '#{options[:location]}' with tag '#{options[:prefix]}'\n"
+    puts "Including outline rows\n" if options[:row_id]
 
-    results = CukeCataloger::UniqueTestCaseTagger.new.validate_test_ids(options[:location], options[:prefix])
+    results = CukeCataloger::UniqueTestCaseTagger.new.validate_test_ids(options[:location], options[:prefix], options[:row_id], options[:id_column_name])
     report_text = "Validation Results\nProblems found: #{results.count}\n\n"
 
 

data/cuke_cataloger.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'cuke_modeler', '>= 0.2', '< 2.0'
   spec.add_runtime_dependency 'cql', '~>1.0', '>= 1.0.1'
-  spec.add_runtime_dependency 'rake', '< 12.0'
+  spec.add_runtime_dependency 'rake', '< 13.0'
   spec.add_runtime_dependency 'thor', '~> 0.0'
 
   spec.add_development_dependency 'bundler', '~> 1.5'

data/lib/cuke_cataloger.rb

@@ -14,24 +14,30 @@ module CukeCataloger
   def self.create_tasks
 
     desc 'Add unique id tags to tests in the given directory'
-    task 'tag_tests', [:directory, :prefix] do |t, args|
+    task 'tag_tests', [:directory, :prefix, :row_id, :id_column_name] do |t, args|
       location = args[:directory] || '.'
       prefix = args[:prefix] || '@test_case_'
+      tag_rows = args[:row_id].nil? ? true : args[:row_id]
+      id_column_name = args[:id_column_name] || 'test_case_id'
 
       puts "Tagging tests in '#{location}' with tag '#{prefix}'\n"
+      puts "Including outline rows\n" if tag_rows
 
       tagger = CukeCataloger::UniqueTestCaseTagger.new
-      tagger.tag_tests(location, prefix)
+      tagger.tag_tests(location, prefix, {}, tag_rows, id_column_name)
     end
 
     desc 'Scan tests in the given directory for id problems'
-    task 'validate_tests', [:directory, :prefix, :out_file] do |t, args|
+    task 'validate_tests', [:directory, :prefix, :out_file, :row_id, :id_column_name] do |t, args|
       location = args[:directory] || '.'
       prefix = args[:prefix] || '@test_case_'
+      tag_rows = args[:row_id].nil? ? true : args[:row_id]
+      id_column_name = args[:id_column_name] || 'test_case_id'
 
       puts "Validating tests in '#{location}' with tag '#{prefix}'\n"
+      puts "Including outline rows\n" if tag_rows
 
-      results = CukeCataloger::UniqueTestCaseTagger.new.validate_test_ids(location, prefix)
+      results = CukeCataloger::UniqueTestCaseTagger.new.validate_test_ids(location, prefix, tag_rows, id_column_name)
       report_text = "Validation Results\nProblems found: #{results.count}\n\n"
 
 

data/lib/cuke_cataloger/unique_test_case_tagger.rb

@@ -13,7 +13,7 @@ module CukeCataloger
       @tag_location = :adjacent
     end
 
-    def tag_tests(feature_directory, tag_prefix, explicit_indexes = {})
+    def tag_tests(feature_directory, tag_prefix, explicit_indexes = {}, tag_rows = true, id_column_name = 'test_case_id')
       warn("This script will potentially rewrite all of your feature files. Please be patient and remember to tip your source control system.")
 
       @known_id_tags = {}
@@ -21,7 +21,7 @@ module CukeCataloger
       set_id_tag(tag_prefix)
       set_test_suite_model(feature_directory)
 
-      @start_indexes = merge_indexes(default_start_indexes(determine_known_ids(feature_directory, tag_prefix)), explicit_indexes)
+      @start_indexes = merge_indexes(default_start_indexes(determine_known_ids(feature_directory, tag_prefix, id_column_name)), explicit_indexes)
       @next_index = @start_indexes[:primary]
 
       # Analysis and output
@@ -30,14 +30,14 @@ module CukeCataloger
           when test.is_a?(CukeModeler::Scenario)
             process_scenario(test)
           when test.is_a?(CukeModeler::Outline)
-            process_outline(test)
+            process_outline(test, tag_rows, id_column_name)
           else
             raise("Unknown test type: #{test.class.to_s}")
         end
       end
     end
 
-    def scan_for_tagged_tests(feature_directory, tag_prefix)
+    def scan_for_tagged_tests(feature_directory, tag_prefix, id_column_name = 'test_case_id')
       @results = []
       @known_id_tags = {}
 
@@ -49,9 +49,9 @@ module CukeCataloger
 
         if test.is_a?(CukeModeler::Outline)
           test.examples.each do |example|
-            if has_id_parameter?(example)
+            if has_id_parameter?(example, id_column_name)
               example_rows_for(example).each do |row|
-                add_to_results(row) if has_row_id?(row)
+                add_to_results(row) if has_row_id?(row, id_column_name)
               end
             end
           end
@@ -61,7 +61,7 @@ module CukeCataloger
       @results
     end
 
-    def validate_test_ids(feature_directory, tag_prefix)
+    def validate_test_ids(feature_directory, tag_prefix, tag_rows = true, id_column_name = 'test_case_id')
       @results = []
       @known_id_tags = {}
 
@@ -69,19 +69,19 @@ module CukeCataloger
       set_test_suite_model(feature_directory)
 
       @features.each { |feature| validate_feature(feature) }
-      @tests.each { |test| validate_test(test) }
+      @tests.each { |test| validate_test(test, tag_rows, id_column_name) }
 
       @results
     end
 
-    def determine_known_ids(feature_directory, tag_prefix)
+    def determine_known_ids(feature_directory, tag_prefix, id_column_name = 'test_case_id')
       known_ids = []
 
-      found_tagged_objects = scan_for_tagged_tests(feature_directory, tag_prefix).collect { |result| result[:object] }
+      found_tagged_objects = scan_for_tagged_tests(feature_directory, tag_prefix, id_column_name).collect { |result| result[:object] }
 
       found_tagged_objects.each do |element|
         if element.is_a?(CukeModeler::Row)
-          row_id = row_id_for(element)
+          row_id = row_id_for(element, id_column_name)
           known_ids << row_id if well_formed_sub_id?(row_id)
         else
           known_ids << test_id_for(element)
@@ -121,17 +121,17 @@ module CukeCataloger
       check_for_feature_level_test_tag(feature)
     end
 
-    def validate_test(test)
+    def validate_test(test, tag_rows, id_column_name)
       check_for_missing_test_tag(test)
       check_for_multiple_test_id_tags(test)
       check_for_duplicated_test_id_tags(test)
 
       if test.is_a?(CukeModeler::Outline)
-        check_for_missing_id_columns(test)
-        check_for_missing_row_tags(test)
-        check_for_duplicated_row_tags(test)
-        check_for_mismatched_row_tags(test)
-        check_for_malformed_row_tags(test)
+        check_for_missing_id_columns(test, id_column_name) if tag_rows
+        check_for_missing_row_tags(test, id_column_name) if tag_rows
+        check_for_duplicated_row_tags(test, id_column_name) if tag_rows
+        check_for_mismatched_row_tags(test, id_column_name) if tag_rows
+        check_for_malformed_row_tags(test, id_column_name) if tag_rows
       end
     end
 
@@ -170,42 +170,42 @@ module CukeCataloger
       add_to_results(test, :missing_tag) unless has_id_tag?(test)
     end
 
-    def check_for_missing_id_columns(test)
+    def check_for_missing_id_columns(test, id_column_name)
       test.examples.each do |example|
-        add_to_results(example, :missing_id_column) unless has_id_column?(example)
+        add_to_results(example, :missing_id_column) unless has_id_column?(example, id_column_name)
       end
     end
 
-    def check_for_duplicated_row_tags(test)
-      validate_rows(test, :duplicate_row_id, false, :has_duplicate_row_id?)
+    def check_for_duplicated_row_tags(test, id_column_name)
+      validate_rows(test, :duplicate_row_id, false, :has_duplicate_row_id?, id_column_name)
     end
 
-    def check_for_missing_row_tags(test)
-      validate_rows(test, :missing_row_id, true, :has_row_id?)
+    def check_for_missing_row_tags(test, id_column_name)
+      validate_rows(test, :missing_row_id, true, :has_row_id?, id_column_name)
     end
 
-    def check_for_mismatched_row_tags(test)
-      validate_rows(test, :mismatched_row_id, true, :has_matching_id?)
+    def check_for_mismatched_row_tags(test, id_column_name)
+      validate_rows(test, :mismatched_row_id, true, :has_matching_id?, id_column_name)
     end
 
-    def check_for_malformed_row_tags(test)
+    def check_for_malformed_row_tags(test, id_column_name)
       test.examples.each do |example|
-        if has_id_column?(example)
+        if has_id_column?(example, id_column_name)
           example_rows_for(example).each do |row|
-            add_to_results(row, :malformed_sub_id) if (has_row_id?(row) && !well_formed_sub_id?(row_id_for(row)))
+            add_to_results(row, :malformed_sub_id) if (has_row_id?(row, id_column_name) && !well_formed_sub_id?(row_id_for(row, id_column_name)))
           end
         end
       end
     end
 
-    def validate_rows(test, rule, desired, row_check)
+    def validate_rows(test, rule, desired, row_check, id_column_name)
       test.examples.each do |example|
-        if has_id_column?(example)
+        if has_id_column?(example, id_column_name)
           example_rows_for(example).each do |row|
             if desired
-              add_to_results(row, rule) unless self.send(row_check, row)
+              add_to_results(row, rule) unless self.send(row_check, row, id_column_name)
             else
-              add_to_results(row, rule) if self.send(row_check, row)
+              add_to_results(row, rule) if self.send(row_check, row, id_column_name)
             end
           end
         end
@@ -216,10 +216,12 @@ module CukeCataloger
       apply_tag_if_needed(test)
     end
 
-    def process_outline(test)
+    def process_outline(test, tag_rows, id_column_name)
       apply_tag_if_needed(test)
-      update_parameters_if_needed(test)
-      update_rows_if_needed(test, determine_next_sub_id(test))
+      if tag_rows
+        update_parameters_if_needed(test, id_column_name)
+        update_rows_if_needed(test, determine_next_sub_id(test), id_column_name)
+      end
     end
 
     def apply_tag_if_needed(test)
@@ -235,12 +237,12 @@ module CukeCataloger
       !!fast_id_tag_for(test)
     end
 
-    def has_id_column?(example)
-      example.parameters.any? { |param| param =~ /test_case_id/ }
+    def has_id_column?(example, id_column_name)
+      example.parameters.any? { |param| param == id_column_name }
     end
 
-    def row_id_for(row)
-      id_index = determine_row_id_cell_index(row)
+    def row_id_for(row, id_column_name)
+      id_index = determine_row_id_cell_index(row, id_column_name)
 
       if id_index
         cell_value = row.cells[id_index]
@@ -250,16 +252,16 @@ module CukeCataloger
       end
     end
 
-    def has_row_id?(row)
-      !!row_id_for(row)
+    def has_row_id?(row, id_column_name)
+      !!row_id_for(row, id_column_name)
     end
 
     def well_formed_sub_id?(id)
       !!(id =~ SUB_ID_PATTERN)
     end
 
-    def has_matching_id?(row)
-      row_id = row_id_for(row)
+    def has_matching_id?(row, id_column_name)
+      row_id = row_id_for(row, id_column_name)
 
       # A lack of id counts as 'matching'
       return true if row_id.nil?
@@ -275,12 +277,12 @@ module CukeCataloger
       end
     end
 
-    def has_duplicate_row_id?(row)
-      row_id = row_id_for(row)
+    def has_duplicate_row_id?(row, id_column_name)
+      row_id = row_id_for(row, id_column_name)
 
       return false unless row_id && well_formed_sub_id?(row_id)
 
-      existing_ids = determine_used_sub_ids(row.get_ancestor(:test))
+      existing_ids = determine_used_sub_ids(row.get_ancestor(:test), id_column_name)
       matching_ids = existing_ids.select { |id| id == row_id[/\d+$/] }
 
       matching_ids.count > 1
@@ -293,11 +295,11 @@ module CukeCataloger
       explicit_index ? explicit_index : 1
     end
 
-    def determine_used_sub_ids(test)
+    def determine_used_sub_ids(test, id_column_name)
       ids = test.examples.collect do |example|
-        if has_id_parameter?(example)
+        if has_id_parameter?(example, id_column_name)
           example_rows_for(example).collect do |row|
-            row_id_for(row)
+            row_id_for(row, id_column_name)
           end
         else
           []
@@ -312,8 +314,8 @@ module CukeCataloger
       ids
     end
 
-    def determine_row_id_cell_index(row)
-      row.get_ancestor(:example).parameters.index { |param| param =~ /test_case_id/ }
+    def determine_row_id_cell_index(row, id_column_name)
+      row.get_ancestor(:example).parameters.index { |param| param =~ /#{id_column_name}/ }
     end
 
     def tag_test(test, tag, padding_string = '  ')
@@ -338,26 +340,26 @@ module CukeCataloger
       end
     end
 
-    def update_parameters_if_needed(test)
+    def update_parameters_if_needed(test, id_column_name)
       feature_file = test.get_ancestor(:feature_file)
       file_path = feature_file.path
       index_adjustment = @file_line_increases[file_path]
       method_for_rows = Gem.loaded_specs['cuke_modeler'].version.version[/^0/] ? :row_elements : :rows
 
       test.examples.each do |example|
-        unless has_id_parameter?(example)
+        unless has_id_parameter?(example, id_column_name)
           parameter_line_index = (example.send(method_for_rows).first.source_line - 1) + index_adjustment
 
           file_lines = File.readlines(file_path)
 
-          new_parameter = 'test_case_id'.ljust(parameter_spacing(example))
+          new_parameter = id_column_name.ljust(parameter_spacing(example, id_column_name))
           update_parameter_row(file_lines, parameter_line_index, new_parameter)
           File.open(file_path, 'w') { |file| file.print file_lines.join }
         end
       end
     end
 
-    def update_rows_if_needed(test, sub_id)
+    def update_rows_if_needed(test, sub_id, id_column_name)
       feature_file = test.get_ancestor(:feature_file)
       file_path = feature_file.path
       index_adjustment = @file_line_increases[file_path]
@@ -369,12 +371,12 @@ module CukeCataloger
 
       test.examples.each do |example|
         example.send(method_for_rows)[1..(example.send(method_for_rows).count - 1)].each do |row|
-          unless has_row_id?(row)
-            row_id = "#{tag_index}-#{sub_id}".ljust(parameter_spacing(example))
+          unless has_row_id?(row, id_column_name)
+            row_id = "#{tag_index}-#{sub_id}".ljust(parameter_spacing(example, id_column_name))
 
             row_line_index = (row.source_line - 1) + index_adjustment
 
-            update_value_row(file_lines, row_line_index, row, row_id)
+            update_value_row(file_lines, row_line_index, row, row_id, id_column_name)
             sub_id += 1
           end
         end
@@ -429,32 +431,31 @@ module CukeCataloger
       fast_id_tag_for(test).match(/#{@tag_prefix}(.*)/)[1]
     end
 
-    def has_id_parameter?(example)
-      #todo - make the id column name configurable
-      example.parameters.any? { |parameter| parameter == 'test_case_id' }
+    def has_id_parameter?(example, id_column_name)
+      example.parameters.any? { |parameter| parameter == id_column_name }
     end
 
     def update_parameter_row(file_lines, line_index, parameter)
       append_row!(file_lines, line_index, " #{parameter} |")
     end
 
-    def update_value_row(file_lines, line_index, row, row_id)
+    def update_value_row(file_lines, line_index, row, row_id, id_column_name)
       case
-        when needs_adding?(row)
+        when needs_adding?(row, id_column_name)
           append_row!(file_lines, line_index, " #{row_id} |")
-        when needs_filled_in?(row)
-          fill_in_row(file_lines, line_index, row, row_id)
+        when needs_filled_in?(row, id_column_name)
+          fill_in_row(file_lines, line_index, row, row_id, id_column_name)
         else
           raise("Don't know how to update row")
       end
     end
 
-    def needs_adding?(row)
-      !has_id_parameter?(row.get_ancestor(:example))
+    def needs_adding?(row, id_column_name)
+      !has_id_parameter?(row.get_ancestor(:example), id_column_name)
     end
 
-    def needs_filled_in?(row)
-      has_id_parameter?(row.get_ancestor(:example))
+    def needs_filled_in?(row, id_column_name)
+      has_id_parameter?(row.get_ancestor(:example), id_column_name)
     end
 
     def replace_row!(file_lines, line_index, new_line)
@@ -514,13 +515,13 @@ module CukeCataloger
       }
     end
 
-    def parameter_spacing(example)
+    def parameter_spacing(example, id_column_name)
       test = example.get_ancestor(:test)
       test_id = fast_id_tag_for(test)[/\d+$/]
       row_count = test.examples.reduce(0) { |sum, example| sum += example.rows.count }
 
       max_id_length = test_id.length + 1 + row_count.to_s.length
-      param_length = 'test_case_id'.length
+      param_length = id_column_name.length
 
       [param_length, max_id_length].max
     end
@@ -539,11 +540,11 @@ module CukeCataloger
       indentation
     end
 
-    def fill_in_row(file_lines, line_index, row, row_id)
+    def fill_in_row(file_lines, line_index, row, row_id, id_column_name)
       old_row = file_lines[line_index]
       sections = file_lines[line_index].split('|', -1)
 
-      replacement_index = determine_row_id_cell_index(row)
+      replacement_index = determine_row_id_cell_index(row, id_column_name)
       sections[replacement_index + 1] = " #{row_id} "
 
       new_row = sections.join('|')

data/lib/cuke_cataloger/version.rb

@@ -1,3 +1,3 @@
 module CukeCataloger
-  VERSION = '1.3.1'
+  VERSION = '1.4.0'
 end

data/testing/cucumber/features/executable.feature

@@ -5,7 +5,7 @@ Feature: Cataloging executable
 
   Scenario: Cataloging test cases
 
-  Note: By default, cataloging will be done in the current directory using the '@test_case_' prefix
+  Note: By default, cataloging will be done in the current directory using the '@test_case_' prefix and outline rows will also be cataloged.
 
     Given the cuke_cataloger executable is available
     And there are test cases in the "." directory that have not been cataloged with "@test_case_"
@@ -20,9 +20,10 @@ Feature: Cataloging executable
     And there are test cases in the "tests" directory that have not been cataloged with "@foo"
     When the following command is executed:
     """
-    cuke_cataloger catalog_test_cases --location <path_to>/tests --prefix @foo
+    cuke_cataloger catalog_test_cases --location <path_to>/tests --prefix @foo --no-row-id
     """
-    Then all of the test cases in the "tests" directory will be cataloged with "@foo"
+    Then all of the scenarios and outlines in the "tests" directory will be cataloged with "@foo"
+    But outline rows in the "tests" directory are not cataloged
 
   Scenario: Validating test cases
 

data/testing/cucumber/step_definitions/verification_steps.rb

@@ -171,6 +171,25 @@ Then(/^all of the test cases in the "([^"]*)" directory will be cataloged with "
   verify_no_results
 end
 
+Then(/^all of the scenarios and outlines in the "([^"]*)" directory will be cataloged with "([^"]*)"$/) do |target_directory, prefix|
+  target_directory = "#{FIXTURE_DIRECTORY}/#{target_directory}"
+  @expected_prefix = prefix
+  tag_rows = false
+
+  @test_results = CukeCataloger::UniqueTestCaseTagger.new.validate_test_ids(target_directory, @expected_prefix, tag_rows)
+
+  verify_no_results
+end
+
+But(/^outline rows in the "([^"]*)" directory are not cataloged$/) do |target_directory|
+  target_directory = "#{FIXTURE_DIRECTORY}/#{target_directory}"
+  tag_rows = true
+
+  @test_results = CukeCataloger::UniqueTestCaseTagger.new.validate_test_ids(target_directory, @expected_prefix, tag_rows)
+
+  expect(@test_results.collect { |result| result[:problem] }).to include(:missing_id_column)
+end
+
 Then(/^a validation report for the "([^"]*)" directory with prefix "([^"]*)" is output to the console$/) do |target_directory, prefix|
   expect(@output).to include("Validating tests in '#{target_directory}' with tag '#{prefix}'")
   expect(@output).to include("Validation Results")

data/testing/fixtures/tests/foo.feature

@@ -2,3 +2,10 @@ Feature: Foo
 
   Scenario: Test 1
     * a step
+
+  Scenario Outline: Test 2
+    * a step
+  Examples:
+    | param | value |
+    | a     | b     |
+    | c     | d     |

data/testing/gemfiles/rake10.gemfile

@@ -0,0 +1,21 @@
+source 'https://rubygems.org'
+
+gemspec :path => "../../"
+
+
+# cuke_cataloger can play with pretty much any version of these but they all play differently with Ruby
+if RUBY_VERSION =~ /^1\.8/
+  gem 'cucumber', '< 1.3.0'
+  gem 'gherkin', '< 2.12.0'
+elsif RUBY_VERSION =~ /^1\./
+  gem 'cucumber', '< 2.0.0'
+end
+
+if RUBY_VERSION =~ /^1\./
+  gem 'tins', '< 1.7' # The 'tins' 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 'term-ansicolor', '< 1.4' # The 'term-ansicolor' gem requires Ruby 2.x on/after this version
+end
+
+gem 'cuke_modeler', '< 2.0'
+gem 'rake', '~> 10.0'

data/testing/gemfiles/rake11.gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gemspec :path => "../../"
+
+
+# Rake 11.x does not work with Ruby 1.8.x
+gem 'rake', '~> 11.0'
+
+if RUBY_VERSION =~ /^1\./
+  gem 'cucumber', '< 2.0.0'
+  gem 'tins', '< 1.7' # The 'tins' 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 'term-ansicolor', '< 1.4' # The 'term-ansicolor' gem requires Ruby 2.x on/after this version
+end
+
+gem 'cuke_modeler', '< 2.0'

data/testing/gemfiles/rake12.gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gemspec :path => "../../"
+
+
+# Rake 12.x does not work with Ruby 1.8.x
+gem 'rake', '~> 12.0'
+
+if RUBY_VERSION =~ /^1\./
+  gem 'cucumber', '< 2.0.0'
+  gem 'tins', '< 1.7' # The 'tins' 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 'term-ansicolor', '< 1.4' # The 'term-ansicolor' gem requires Ruby 2.x on/after this version
+end
+
+gem 'cuke_modeler', '< 2.0'

data/testing/rspec/spec/cuke_cataloger_spec.rb

@@ -1,3 +1,7 @@
+require "#{File.dirname(__FILE__)}/spec_helper"
+require 'rubygems/mock_gem_ui'
+
+
 describe 'the gem' do
 
   here = File.dirname(__FILE__)
@@ -8,4 +12,11 @@ describe 'the gem' do
     expect(gemspec.executables).to include('cuke_cataloger')
   end
 
+  it 'validates cleanly' do
+    mock_ui = Gem::MockGemUi.new
+    Gem::DefaultUserInteraction.use_ui(mock_ui) { gemspec.validate }
+
+    expect(mock_ui.error).to_not match(/warn/i)
+  end
+
 end

data/testing/rspec/spec/spec_helper.rb

@@ -3,15 +3,18 @@ unless RUBY_VERSION.to_s < '1.9.0'
   SimpleCov.command_name('cuke_cataloger-cucumber')
 end
 
+here = File.dirname(__FILE__)
+
 
 require 'cuke_cataloger'
 
+require 'tempfile'
 
 RSpec.configure do |config|
   config.before(:all) do
-    here = File.dirname(__FILE__)
     @default_file_directory = "#{here}/temp_files"
     @default_test_file_directory = "#{here}/test_files"
+    @lib_directory = "#{here}/../../../lib"
   end
 
   config.before(:each) do

data/testing/rspec/spec/unique_test_case_tagger_integration_spec.rb

@@ -81,6 +81,42 @@ describe 'UniqueTestCaseTagger, Integration' do
       expect(@tagger.instance_variable_get(:@known_id_tags)).to_not include(0)
       expect(@tagger.instance_variable_get(:@known_id_tags)).to_not include(1)
     end
+
+    it 'does not count id like values that are not in the specified id column' do
+      input_file = Tempfile.new(['foo', '.feature'])
+
+      text = "Feature:
+
+                @test_case_1
+                Scenario:
+                  * a step
+
+                @test_case_2
+                Scenario Outline:
+                  * a step with a <param>
+                  Examples: with rows
+                    | param   | test_case_id | foobar |
+                    | value 1 | 2-1          | 2-4    |
+                  Examples: without rows
+                    | param   | test_case_id | foobar |
+                    | value 1 | 2-2          | 2-5    |
+                    | value 2 | 2-3          | 2-6    |
+
+                @test_case_3
+                Scenario:
+                  * a step"
+
+      input_file.write(text)
+      input_file.close
+      temp_directory = input_file.path.match(/(.*)\/foo.*\.feature/)[1]
+
+
+      result = @tagger.determine_known_ids(temp_directory, '@test_case_', 'foobar')
+
+
+      expect(result).to_not include('2-1', '2-2', '2-3')
+    end
+
   end
 
 end

data/testing/rspec/spec/unique_test_case_tagger_unit_spec.rb

@@ -24,8 +24,8 @@ describe 'UniqueTestCaseTagger, Unit' do
       expect(@tagger).to respond_to(:validate_test_ids)
     end
 
-    it 'requires a directory and tag prefix when validating' do
-      expect(@tagger.method(:validate_test_ids).arity).to eq(2)
+    it 'validates based on a directory, tag prefix, and optional row tagging flag' do
+      expect(@tagger.method(:validate_test_ids).arity).to eq(-3)
     end
 
     it 'returns validation results' do
@@ -38,8 +38,8 @@ describe 'UniqueTestCaseTagger, Unit' do
       expect(@tagger).to respond_to(:scan_for_tagged_tests)
     end
 
-    it 'requires a directory and tag prefix when validating' do
-      expect(@tagger.method(:scan_for_tagged_tests).arity).to eq(2)
+    it 'validates based on a directory, tag prefix, and optional column name' do
+      expect(@tagger.method(:scan_for_tagged_tests).arity).to eq(-3)
     end
 
     it 'returns scanning results' do
@@ -52,8 +52,8 @@ describe 'UniqueTestCaseTagger, Unit' do
       expect(@tagger).to respond_to(:determine_known_ids)
     end
 
-    it 'requires a directory and tag prefix when determining used indexes' do
-      expect(@tagger.method(:determine_known_ids).arity).to eq(2)
+    it 'determines used indexes based on a directory, tag prefix, and optional column name' do
+      expect(@tagger.method(:determine_known_ids).arity).to eq(-3)
     end
   end
 

data/todo.txt

@@ -0,0 +1,4 @@
+# todo - point build/code quality/coverage tags at the dev branch
+# todo - Add better test coverage (rake tasks, cli, etc.)
+# todo - Use features as documentation
+# todo - Use the cuketagger gem for tagging

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuke_cataloger
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Eric Kessler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-11 00:00:00.000000000 Z
+date: 2017-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cuke_modeler
@@ -56,14 +56,14 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -179,6 +179,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- appveyor.yml
 - bin/cuke_cataloger
 - cuke_cataloger.gemspec
 - lib/cuke_cataloger.rb
@@ -199,10 +200,14 @@ files:
 - testing/fixtures/tests/foo.feature
 - testing/gemfiles/cuke_modeler0.gemfile
 - testing/gemfiles/cuke_modeler1.gemfile
+- testing/gemfiles/rake10.gemfile
+- testing/gemfiles/rake11.gemfile
+- testing/gemfiles/rake12.gemfile
 - testing/rspec/spec/cuke_cataloger_spec.rb
 - testing/rspec/spec/spec_helper.rb
 - testing/rspec/spec/unique_test_case_tagger_integration_spec.rb
 - testing/rspec/spec/unique_test_case_tagger_unit_spec.rb
+- todo.txt
 homepage: https://github.com/enkessler/cuke_cataloger
 licenses:
 - MIT
@@ -223,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A tool to give every Cucumber test a unique id