cuke_cataloger 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30eaf9d9662dd4487ca55a63d56c3911c852e1d8
-  data.tar.gz: 42302cb72e6d57fd83afb9494b8b88fc0400f137
+  metadata.gz: 7105dd4739cfcf77b2b055b427aa21584899e4e9
+  data.tar.gz: f05a36d1ab015534957dfcd679fd2385bdbe4793
 SHA512:
-  metadata.gz: 0b9adbdc69989580d77ca66d151287c248c5cb55983c73fa51f9c91a345cc1d7290591de2190d7bde6050d26e89173ef1ba639511850d4a7e22d48ce68297d98
-  data.tar.gz: 89ffe919e0773c884908785a116e90460e037f70e2330f16c86e724fb3ef4139a6b000c2a55e73913ffe387f4365d6a4f9fc033a23d2e7e9ef37177a7a43f19e
+  metadata.gz: 6269a07d0f33bbb791d1b6ea77e26b0aa8366370b84cf26ba0b97e32a2979018680697cf1ff3ad60c4445bb1281f8ba1bab647769be3897b0643045ffe7252e2
+  data.tar.gz: 05f2f4163333b9ae0e548324edeb6e648a145979289c8135dfce8334afba7ed2bb407d1ba43e830de1481741c6d29f55111b235cbb6b5776ee488949baf847b2

data/.simplecov

@@ -1,8 +1,7 @@
 SimpleCov.start do
   root File.dirname(__FILE__)
 
-  add_filter '/features/'
-  add_filter '/spec/'
+  add_filter '/testing/'
 
   merge_timeout 300
 end

data/.travis.yml

@@ -6,8 +6,9 @@ language: ruby
 rvm:
   - 1.8.7
   - 1.9.3
-  - 2.2.2
+  - 2.3.3
   - 2.4.0
+  - jruby-9.1.7.0
 
 matrix:
   exclude:

data/Gemfile

@@ -1,4 +1,4 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cuke_cataloger.gemspec
 gemspec

data/History.md

@@ -1,5 +1,10 @@
 # Release history
 
+### Version 1.4.1 / 2017-07-09
+
+- Improved documentation
+
+
 ### Version 1.4.0 / 2017-04-18
 
 - Both cataloging and validation can now be used without including outline rows, if desired.

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Eric Kessler
+Copyright (c) 2014-2017 Eric Kessler
 
 MIT License
 

data/README.md

@@ -1,16 +1,67 @@
-# CukeCataloger
-
-
-[![Gem Version](https://badge.fury.io/rb/cuke_cataloger.svg)](http://badge.fury.io/rb/cuke_cataloger)
+[![Gem Version](https://badge.fury.io/rb/cuke_cataloger.svg)](https://rubygems.org/gems/cuke_cataloger)
+[![Dependency Status](https://gemnasium.com/enkessler/cuke_cataloger.svg)](https://gemnasium.com/enkessler/cuke_cataloger)
 [![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)
+[![Coverage Status](https://coveralls.io/repos/github/enkessler/cuke_cataloger/badge.svg?branch=dev)](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)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/cuke_cataloger)
+[![Inline docs](http://inch-ci.org/github/enkessler/cuke_cataloger.svg?branch=dev)](https://inch-ci.org/github/enkessler/cuke_cataloger?branch=dev)
 [![Project License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/enkessler/cuke_cataloger/blob/master/LICENSE.txt)
 
 
+# CukeCataloger
+
+
 The cuke_cataloger gem is a convenient way to provide a unique id to every test case in your Cucumber test suite.
 
+Turn your features from this
+
+````
+Feature:
+
+  Scenario:
+    * a step
+    
+  Scenario Outline:
+    * a step
+  Examples:
+    | param 1 |
+    | value 1 |
+  Examples: 
+    | param 1 |
+    | value 1 |
+    | value 2 |
+
+  Scenario:
+    * a step
+````
+
+into this!
+
+````
+Feature:
+
+  @test_case_1
+  Scenario:
+    * a step
+    
+  @test_case_2
+  Scenario Outline:
+    * a step
+  Examples:
+    | param 1 | test_case_id |
+    | value 1 | 2-1          |
+  Examples: 
+    | param 1 | test_case_id |
+    | value 1 | 2-2          |
+    | value 2 | 2-3          |
+
+  @test_case_3
+  Scenario:
+    * a step
+````
+
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/appveyor.yml

@@ -2,55 +2,44 @@ version: '1.0.{build}'
 
 environment:
   matrix:
-    - RUBY_VERSION: 187-x64
+    - RUBY_VERSION: 193
       BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler0.gemfile
-    - RUBY_VERSION: 193-x64
+      # AppVeyor does not have a 64-bit Ruby 1.9.3
+    - RUBY_VERSION: 23
       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
+    - RUBY_VERSION: 23-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
+    - RUBY_VERSION: 193
       BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler1.gemfile
-    - RUBY_VERSION: 21-x64
+      # AppVeyor does not have a 64-bit Ruby 1.9.3
+    - RUBY_VERSION: 23
       BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler1.gemfile
-    - RUBY_VERSION: 22-x64
+    - RUBY_VERSION: 23-x64
       BUNDLE_GEMFILE: testing/gemfiles/cuke_modeler1.gemfile
 
-    - RUBY_VERSION: 187-x64
+    - RUBY_VERSION: 193
       BUNDLE_GEMFILE: testing/gemfiles/rake10.gemfile
-    - RUBY_VERSION: 193-x64
+      # AppVeyor does not have a 64-bit Ruby 1.9.3
+    - RUBY_VERSION: 23
       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
+    - RUBY_VERSION: 23-x64
       BUNDLE_GEMFILE: testing/gemfiles/rake10.gemfile
 
-    - RUBY_VERSION: 193-x64
+    - RUBY_VERSION: 193
       BUNDLE_GEMFILE: testing/gemfiles/rake11.gemfile
-    - RUBY_VERSION: 200-x64
+      # AppVeyor does not have a 64-bit Ruby 1.9.3
+    - RUBY_VERSION: 23
       BUNDLE_GEMFILE: testing/gemfiles/rake11.gemfile
-    - RUBY_VERSION: 21-x64
-      BUNDLE_GEMFILE: testing/gemfiles/rake11.gemfile
-    - RUBY_VERSION: 22-x64
+    - RUBY_VERSION: 23-x64
       BUNDLE_GEMFILE: testing/gemfiles/rake11.gemfile
 
-    - RUBY_VERSION: 193-x64
-      BUNDLE_GEMFILE: testing/gemfiles/rake12.gemfile
-    - RUBY_VERSION: 200-x64
+    - RUBY_VERSION: 193
       BUNDLE_GEMFILE: testing/gemfiles/rake12.gemfile
-    - RUBY_VERSION: 21-x64
+      # AppVeyor does not have a 64-bit Ruby 1.9.3
+    - RUBY_VERSION: 23
       BUNDLE_GEMFILE: testing/gemfiles/rake12.gemfile
-    - RUBY_VERSION: 22-x64
+    - RUBY_VERSION: 23-x64
       BUNDLE_GEMFILE: testing/gemfiles/rake12.gemfile
 
 

data/bin/cuke_cataloger

@@ -33,26 +33,7 @@ class CLI < Thor
     puts "Including outline rows\n" if options[:row_id]
 
     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"
-
-
-    results_by_category = Hash.new { |hash, key| hash[key] = [] }
-
-    results.each do |result|
-      results_by_category[result[:problem]] << result
-    end
-
-    results_by_category.keys.each do |problem_category|
-      report_text << "#{problem_category} problems: #{results_by_category[problem_category].count}\n"
-    end
-
-    results_by_category.keys.each do |problem_category|
-      report_text << "\n\n#{problem_category} problems (#{results_by_category[problem_category].count}):\n"
-
-      results_by_category[problem_category].each do |result|
-        report_text << "#{result[:test]}\n"
-      end
-    end
+    report_text = CukeCataloger::TextReportFormatter.new.format_data(results)
 
     if options[:file]
       puts "Problems found: #{results.count}"

data/lib/cuke_cataloger.rb

@@ -2,71 +2,14 @@ require 'rake'
 require 'cuke_modeler'
 require 'cql'
 
-require 'cuke_cataloger/version'
-require 'cuke_cataloger/unique_test_case_tagger'
-
-module CukeCataloger
-
-  extend Rake::DSL
-
-  # todo - test these better
-
-  def self.create_tasks
-
-    desc 'Add unique id tags to tests in the given directory'
-    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, {}, tag_rows, id_column_name)
-    end
-
-    desc 'Scan tests in the given directory for id problems'
-    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, tag_rows, id_column_name)
-      report_text = "Validation Results\nProblems found: #{results.count}\n\n"
+# The top level namespace used by this gem
 
+module CukeCataloger
+end
 
-      results_by_category = Hash.new { |hash, key| hash[key] = [] }
-
-      results.each do |result|
-        results_by_category[result[:problem]] << result
-      end
-
-      results_by_category.keys.each do |problem_category|
-        report_text << "#{problem_category} problems: #{results_by_category[problem_category].count}\n"
-      end
-
-      results_by_category.keys.each do |problem_category|
-        report_text << "\n\n#{problem_category} problems (#{results_by_category[problem_category].count}):\n"
-
-        results_by_category[problem_category].each do |result|
-          report_text << "#{result[:test]}\n"
-        end
-      end
-
-      if args[:out_file]
-        puts "Problems found: #{results.count}"
-        File.open(args[:out_file], 'w') { |file| file.write(report_text) }
-      else
-        puts report_text
-      end
-    end
-
-  end
 
-end
+require 'cuke_cataloger/version'
+require 'cuke_cataloger/unique_test_case_tagger'
+require 'cuke_cataloger/rake_tasks'
+require 'cuke_cataloger/formatters/text_report_formatter'

data/lib/cuke_cataloger/formatters/text_report_formatter.rb

@@ -0,0 +1,33 @@
+module CukeCataloger
+
+  # Not a part of the public API. Subject to change at any time.
+  class TextReportFormatter
+
+    # Formats validation results into a readable text report
+    def format_data(data)
+      report_text = "Validation Results\nProblems found: #{data.count}\n\n"
+
+
+      results_by_category = Hash.new { |hash, key| hash[key] = [] }
+
+      data.each do |result|
+        results_by_category[result[:problem]] << result
+      end
+
+      results_by_category.keys.each do |problem_category|
+        report_text << "#{problem_category} problems: #{results_by_category[problem_category].count}\n"
+      end
+
+      results_by_category.keys.each do |problem_category|
+        report_text << "\n\n#{problem_category} problems (#{results_by_category[problem_category].count}):\n"
+
+        results_by_category[problem_category].each do |result|
+          report_text << "#{result[:test]}\n"
+        end
+      end
+
+      report_text
+    end
+
+  end
+end

data/lib/cuke_cataloger/rake_tasks.rb

@@ -0,0 +1,46 @@
+module CukeCataloger
+
+  extend Rake::DSL
+
+
+  # Adds the gem's provided Rake tasks to the namespace from which the method is called
+  def self.create_tasks
+
+    desc 'Add unique id tags to tests in the given directory'
+    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, {}, tag_rows, id_column_name)
+    end
+
+    desc 'Scan tests in the given directory for id problems'
+    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, tag_rows, id_column_name)
+      report_text = CukeCataloger::TextReportFormatter.new.format_data(results)
+
+      if args[:out_file]
+        puts "Problems found: #{results.count}"
+        File.open(args[:out_file], 'w') { |file| file.write(report_text) }
+      else
+        puts report_text
+      end
+    end
+
+  end
+
+end

data/lib/cuke_cataloger/unique_test_case_tagger.rb

@@ -1,10 +1,17 @@
 module CukeCataloger
+
+  # A tagger that handles test case cataloging.
+
   class UniqueTestCaseTagger
 
-    SUB_ID_PATTERN = /^\d+\-\d+$/
-    SUB_ID_MATCH_PATTERN = /^\d+\-(\d+)$/
+    # The pattern of a sub id
+    SUB_ID_PATTERN = /^\d+\-\d+$/  # Not a part of the public API. Subject to change at any time.
 
+    # The pattern of a sub id, with id capture
+    SUB_ID_MATCH_PATTERN = /^\d+\-(\d+)$/   # Not a part of the public API. Subject to change at any time.
 
+
+    # Where the id tag should be placed, relative to the other tags on the test
     attr_accessor :tag_location
 
 
@@ -13,6 +20,7 @@ module CukeCataloger
       @tag_location = :adjacent
     end
 
+    # Adds id tags based on *tag_prefix* to the tests found in *feature_directory*
     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.")
 
@@ -37,6 +45,7 @@ module CukeCataloger
       end
     end
 
+    # Finds existing id tags and their associated tests in *feature_directory* based on *tag_prefix*
     def scan_for_tagged_tests(feature_directory, tag_prefix, id_column_name = 'test_case_id')
       @results = []
       @known_id_tags = {}
@@ -61,6 +70,7 @@ module CukeCataloger
       @results
     end
 
+    # Checks for cataloging problems in *feature_directory* based on *tag_prefix*
     def validate_test_ids(feature_directory, tag_prefix, tag_rows = true, id_column_name = 'test_case_id')
       @results = []
       @known_id_tags = {}
@@ -74,6 +84,7 @@ module CukeCataloger
       @results
     end
 
+    # Finds existing id tags in *feature_directory* based on *tag_prefix*
     def determine_known_ids(feature_directory, tag_prefix, id_column_name = 'test_case_id')
       known_ids = []
 
@@ -198,6 +209,7 @@ module CukeCataloger
       end
     end
 
+    # Checks the rows of the given test for the given problem
     def validate_rows(test, rule, desired, row_check, id_column_name)
       test.examples.each do |example|
         if has_id_column?(example, id_column_name)
@@ -435,10 +447,12 @@ module CukeCataloger
       example.parameters.any? { |parameter| parameter == id_column_name }
     end
 
+    # Adds an id column to the given parameter row
     def update_parameter_row(file_lines, line_index, parameter)
       append_row!(file_lines, line_index, " #{parameter} |")
     end
 
+    # Adds an id to the given value row
     def update_value_row(file_lines, line_index, row, row_id, id_column_name)
       case
         when needs_adding?(row, id_column_name)
@@ -458,16 +472,19 @@ module CukeCataloger
       has_id_parameter?(row.get_ancestor(:example), id_column_name)
     end
 
+    # Replaces the indicated line of text with the provided line of tet
     def replace_row!(file_lines, line_index, new_line)
       file_lines[line_index] = new_line
     end
 
+    # Adds text to the beginning of the given line (with whitespace loss)
     def prepend_row!(file_lines, line_index, string)
       old_row = file_lines[line_index]
       new_row = string + old_row.lstrip
       file_lines[line_index] = new_row
     end
 
+    # Adds text to the end of the given line (with whitespace loss)
     def append_row!(file_lines, line_index, string)
       old_row = file_lines[line_index]
       trailing_bits = old_row[/\s*$/]
@@ -509,6 +526,7 @@ module CukeCataloger
       default_indexes
     end
 
+    # Merges the given index sets (of the shape {:primary => Integer, :sub => Hash}) into a new one
     def merge_indexes(set1, set2)
       set1.merge(set2) { |key, set1_value, set2_value|
         key == :sub ? set1_value.merge(set2_value) : set2_value
@@ -540,8 +558,9 @@ module CukeCataloger
       indentation
     end
 
+    # Adds an id to the given value row (which has a column for an id but no value for it)
     def fill_in_row(file_lines, line_index, row, row_id, id_column_name)
-      old_row = file_lines[line_index]
+      old_row = file_lines[line_index] # todo - Dead line of code?
       sections = file_lines[line_index].split('|', -1)
 
       replacement_index = determine_row_id_cell_index(row, id_column_name)

data/lib/cuke_cataloger/version.rb

@@ -1,3 +1,4 @@
 module CukeCataloger
-  VERSION = '1.4.0'
+  # The current version of the gem
+  VERSION = '1.4.1'
 end

data/testing/cucumber/features/cataloging_tasks.feature

@@ -0,0 +1,48 @@
+Feature: Cataloging tasks
+
+  Cataloging functionality can be invoked using Rake tasks that are provided by this gem.
+
+
+  Background: Rake task availability
+    * the Rake tasks provided by the gem have been loaded
+
+
+  Scenario: Cataloging test cases
+
+  Note: By default, cataloging will be done in the current directory using the '@test_case_' prefix and outline rows will also be cataloged.
+
+    Given there are test cases in the "." directory that have not been cataloged with "@test_case_"
+    When the following task is invoked:
+    """
+    tag_tests
+    """
+    Then all of the test cases in the "." directory will be cataloged with "@test_case_"
+
+  Scenario: Specifying cataloging options
+
+  Note: Due to the implementation of teh Rake tasks, not all options can be used from the command line. Some options only work when invoking the task within other code.
+
+    Given there are test cases in the "tests" directory that have not been cataloged with "@foo"
+    When the following code is run:
+    """
+    Rake::Task['tag_tests'].invoke('<path_to>/tests','@foo', false)
+    """
+    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
+
+  Note: By default, validation will be done in the current directory using the '@test_case_' prefix
+
+    When the following task is invoked:
+    """
+    validate_tests
+    """
+    Then a validation report for the "." directory with prefix "@test_case_" is output to the console
+
+  Scenario: Specifying validation options
+    When the following task is invoked:
+    """
+    validate_tests['<path_to>/tests','@foo','<path_to>/foo.txt']
+    """
+    Then a validation report for the "tests" directory with prefix "@foo" is output to "foo.txt"

data/testing/cucumber/step_definitions/action_steps.rb

@@ -30,7 +30,7 @@ end
 When(/^the following command is executed:$/) do |command|
   if command =~ /--file /
     output_file_name = command.match(/--file <path_to>\/(.*)\.txt/)[1]
-    command.sub!(/--file <path_to>\/(.*)\.txt/, "--file #{DEFAULT_FILE_DIRECTORY}/#{output_file_name}.txt")
+    command.sub!(/--file <path_to>\/(.*)\.txt/, "--file #{@root_test_directory}/#{output_file_name}.txt")
   end
 
   command.sub!('<path_to>', FIXTURE_DIRECTORY)
@@ -40,3 +40,19 @@ When(/^the following command is executed:$/) do |command|
     @output = `#{command}`
   end
 end
+
+When(/^the following task is invoked:$/) do |command|
+  command.sub!('<path_to>/tests', "#{FIXTURE_DIRECTORY}/tests")
+  command.sub!('<path_to>/foo', "#{@root_test_directory}/foo")
+  command = "bundle exec rake #{command}"
+
+  Dir.chdir(FIXTURE_DIRECTORY) do
+    @output = `#{command}`
+  end
+end
+
+When(/^the following code is run:$/) do |code_text|
+  code_text.sub!('<path_to>', FIXTURE_DIRECTORY)
+
+  eval(code_text)
+end

data/testing/cucumber/step_definitions/setup_steps.rb

@@ -1,13 +1,13 @@
 Given /^the following feature file(?: "([^"]*)")?:$/ do |file_name, file_text|
-  @test_directory = @default_file_directory
+  @test_directory = @root_test_directory
   @files_created ||= 0
   @feature_files ||= []
 
-  file_name ||= "#{@default_feature_file_name}_#{@files_created + 1}.feature"
-  file_path = "#{@test_directory}/#{file_name}"
-  @feature_files << file_path
+  file_name ||= "test_feature_#{@files_created + 1}"
+  file_name = File.basename(file_name, '.feature')
 
-  File.open(file_path, 'w') { |file| file.write file_text }
+  file_path = CukeCataloger::FileHelper.create_feature_file(:directory => @test_directory, :name => file_name, :text => file_text)
+  @feature_files << file_path
 
   @files_created += 1
 end
@@ -27,15 +27,17 @@ And(/^a start index of "([^"]*)" for testcase "([^"]*)"$/) do |sub_index, parent
 end
 
 Given(/^a feature file$/) do
-  @test_directory = @default_file_directory
+  @test_directory = @root_test_directory
   @files_created ||= 0
   @feature_files ||= []
 
-  file_name ||= "#{@default_feature_file_name}_#{@files_created + 1}.feature"
-  file_path = "#{@test_directory}/#{file_name}"
-  @feature_files << file_path
+  file_name = "test_feature_#{@files_created + 1}.feature"
+  file_name = File.basename(file_name, '.feature')
 
-  File.open(file_path, 'w') { |file| file.write "Feature:\nScenario Outline:\n* a step\nExamples:\n| param 1 |\n| value 1 |" }
+  file_text = "Feature:\nScenario Outline:\n* a step\nExamples:\n| param 1 |\n| value 1 |"
+
+  file_path = CukeCataloger::FileHelper.create_feature_file(:directory => @test_directory, :name => file_name, :text => file_text)
+  @feature_files << file_path
 
   @files_created += 1
 end
@@ -67,3 +69,8 @@ And(/^there are test cases in the "([^"]*)" directory that have not been catalog
   # Making sure that there is work to be done, thus avoiding false positives
   expect(@test_results.select { |test_result| test_result[:problem] == :missing_tag }).to_not be_empty
 end
+
+Given(/^the Rake tasks provided by the gem have been loaded$/) do
+  File.open("#{FIXTURE_DIRECTORY}/Rakefile", 'a') { |file| file.puts 'CukeCataloger.create_tasks' }
+  CukeCataloger.create_tasks
+end

data/testing/cucumber/step_definitions/verification_steps.rb

@@ -116,14 +116,18 @@ def verify_category_results(category, results)
 end
 
 def verify_results(results)
-  expect(@test_results.collect { |test_result| test_result[:test] }).to match_array(process_results(results))
+  actual = @test_results.collect { |test_result| test_result[:test] }
+  expected = process_expected_results(results)
+
+  expect(actual).to match_array(expected)
 end
 
-def process_results(results)
+def process_expected_results(results)
   results = results.raw.flatten
-  results.collect { |test_path| test_path.sub('path/to', @default_file_directory) }
+  results.collect { |test_path| test_path.sub('path/to', @root_test_directory) }
 end
 
+
 Then(/^the resulting first file is:$/) do |expected_text|
   file_name = @feature_files[0]
 
@@ -197,7 +201,7 @@ end
 
 Then(/^a validation report for the "([^"]*)" directory with prefix "([^"]*)" is output to "([^"]*)"$/) do |target_directory, prefix, filename|
   target_directory = "#{FIXTURE_DIRECTORY}/#{target_directory}"
-  filename = "#{DEFAULT_FILE_DIRECTORY}/#{filename}"
+  filename = "#{@root_test_directory}/#{filename}"
 
   expect(@output).to include("Validating tests in '#{target_directory}' with tag '#{prefix}'")
   expect(@output).to include("Problems found:")

data/testing/cucumber/support/env.rb

@@ -3,21 +3,18 @@ unless RUBY_VERSION.to_s < '1.9.0'
   SimpleCov.command_name('cuke_cataloger-cucumber')
 end
 
+
 require 'cuke_cataloger'
 
 here = File.dirname(__FILE__)
+require "#{here}/../../file_helper"
 
-DEFAULT_FEATURE_FILE_NAME = 'test_feature'
-DEFAULT_FILE_DIRECTORY = "#{here}/../temp_files"
 PROJECT_ROOT = "#{here}/../../.."
 FIXTURE_DIRECTORY = "#{here}/../../fixtures"
 
 Before do
   begin
-    @default_feature_file_name = DEFAULT_FEATURE_FILE_NAME
-    @default_file_directory = DEFAULT_FILE_DIRECTORY
-
-    FileUtils.mkdir(@default_file_directory)
+    @root_test_directory = CukeCataloger::FileHelper.create_directory
   rescue => e
     puts "Error caught in before hook!"
     puts "Type: #{e.class}"
@@ -28,10 +25,16 @@ end
 After do
   begin
     `git checkout HEAD -- #{FIXTURE_DIRECTORY}`
-    FileUtils.remove_dir(@default_file_directory, true)
   rescue => e
     puts "Error caught in before hook!"
     puts "Type: #{e.class}"
     puts "Message: #{e.message}"
   end
 end
+
+
+at_exit {
+  CukeCataloger::FileHelper.created_directories.each do |dir_path|
+    FileUtils.remove_entry(dir_path, true)
+  end
+}

data/testing/file_helper.rb

@@ -0,0 +1,39 @@
+module CukeCataloger
+  module FileHelper
+
+    class << self
+
+      def create_feature_file(options = {})
+        options[:text] ||= 'Feature:'
+        options[:name] ||= 'test_file'
+
+        create_file(:text => options[:text], :name => options[:name], :extension => '.feature', :directory => options[:directory])
+      end
+
+      def create_file(options = {})
+        options[:text] ||= ''
+        options[:name] ||= 'test_file'
+        options[:extension] ||= '.txt'
+        options[:directory] ||= create_directory
+
+        file_path = "#{options[:directory]}/#{options[:name]}#{options[:extension]}"
+        File.open(file_path, 'w') { |file| file.write(options[:text]) }
+
+        file_path
+      end
+
+      def created_directories
+        @created_directories ||= []
+      end
+
+      def create_directory
+        new_dir = Dir::mktmpdir
+        created_directories << new_dir
+
+        new_dir
+      end
+
+    end
+
+  end
+end

data/testing/fixtures/Rakefile

@@ -0,0 +1,19 @@
+unless RUBY_VERSION.to_s < '1.9.0'
+  require 'simplecov'
+  require 'securerandom'
+
+  SimpleCov.start do
+    root File.dirname(__FILE__) + '/../..'
+
+    # Every test process will need its own unique name or else they will override each others' coverage data
+    command_name("cuke_cataloger-fixtures-#{SecureRandom.uuid}")
+
+    add_filter '/testing/'
+
+    merge_timeout 300
+  end
+
+end
+
+
+require 'cuke_cataloger'

data/testing/rspec/spec/spec_helper.rb

@@ -4,24 +4,20 @@ unless RUBY_VERSION.to_s < '1.9.0'
 end
 
 here = File.dirname(__FILE__)
-
+require "#{here}/../../file_helper"
 
 require 'cuke_cataloger'
 
-require 'tempfile'
 
 RSpec.configure do |config|
   config.before(:all) do
-    @default_file_directory = "#{here}/temp_files"
-    @default_test_file_directory = "#{here}/test_files"
     @lib_directory = "#{here}/../../../lib"
   end
 
-  config.before(:each) do
-    FileUtils.mkpath(@default_file_directory)
+  config.after(:all) do
+    CukeCataloger::FileHelper.created_directories.each do |dir_path|
+      FileUtils.remove_entry(dir_path, true)
+    end
   end
 
-  config.after(:each) do
-    FileUtils.remove_dir(@default_file_directory, true)
-  end
 end

data/testing/rspec/spec/unique_test_case_tagger_integration_spec.rb

@@ -20,7 +20,7 @@ describe 'UniqueTestCaseTagger, Integration' do
       # Using ids that are not used for memory allocation by Ruby since they are used for predefined constants.
       @tagger.instance_variable_set(:@known_id_tags, {0 => '123', 2 => '456'})
 
-      @tagger.tag_tests(@default_file_directory, '')
+      Dir.mktmpdir { |path| @tagger.tag_tests(path, '') }
 
       expect(@tagger.instance_variable_get(:@known_id_tags)).to_not include(0)
       expect(@tagger.instance_variable_get(:@known_id_tags)).to_not include(1)
@@ -39,7 +39,7 @@ describe 'UniqueTestCaseTagger, Integration' do
       # Using ids that are not used for memory allocation by Ruby since they are used for predefined constants.
       @tagger.instance_variable_set(:@known_id_tags, {0 => '123', 2 => '456'})
 
-      @tagger.validate_test_ids(@default_file_directory, '')
+      Dir.mktmpdir { |path| @tagger.validate_test_ids(path, '') }
 
       expect(@tagger.instance_variable_get(:@known_id_tags)).to_not include(0)
       expect(@tagger.instance_variable_get(:@known_id_tags)).to_not include(1)
@@ -58,7 +58,7 @@ describe 'UniqueTestCaseTagger, Integration' do
       # Using ids that are not used for memory allocation by Ruby since they are used for predefined constants.
       @tagger.instance_variable_set(:@known_id_tags, {0 => '123', 2 => '456'})
 
-      @tagger.scan_for_tagged_tests(@default_file_directory, '')
+      Dir.mktmpdir { |path| @tagger.scan_for_tagged_tests(path, '') }
 
       expect(@tagger.instance_variable_get(:@known_id_tags)).to_not include(0)
       expect(@tagger.instance_variable_get(:@known_id_tags)).to_not include(1)
@@ -76,14 +76,14 @@ describe 'UniqueTestCaseTagger, Integration' do
       # Using ids that are not used for memory allocation by Ruby since they are used for predefined constants.
       @tagger.instance_variable_set(:@known_id_tags, {0 => '123', 2 => '456'})
 
-      @tagger.determine_known_ids(@default_file_directory, '')
+      Dir.mktmpdir { |path| @tagger.determine_known_ids(path, '') }
 
       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'])
+      test_directory = CukeCataloger::FileHelper.create_directory
 
       text = "Feature:
 
@@ -106,12 +106,10 @@ describe 'UniqueTestCaseTagger, Integration' do
                 Scenario:
                   * a step"
 
-      input_file.write(text)
-      input_file.close
-      temp_directory = input_file.path.match(/(.*)\/foo.*\.feature/)[1]
+      CukeCataloger::FileHelper.create_feature_file(:directory => test_directory, :text => text)
 
 
-      result = @tagger.determine_known_ids(temp_directory, '@test_case_', 'foobar')
+      result = @tagger.determine_known_ids(test_directory, '@test_case_', 'foobar')
 
 
       expect(result).to_not include('2-1', '2-2', '2-3')

data/testing/rspec/spec/unique_test_case_tagger_unit_spec.rb

@@ -29,7 +29,9 @@ describe 'UniqueTestCaseTagger, Unit' do
     end
 
     it 'returns validation results' do
-      expect(@tagger.validate_test_ids(@default_file_directory, '')).to be_a_kind_of(Array)
+      results = Dir.mktmpdir { |path| @tagger.validate_test_ids(path, '') }
+
+      expect(results).to be_a_kind_of(Array)
     end
   end
 
@@ -43,7 +45,9 @@ describe 'UniqueTestCaseTagger, Unit' do
     end
 
     it 'returns scanning results' do
-      expect(@tagger.scan_for_tagged_tests(@default_file_directory, '')).to be_a_kind_of(Array)
+      results = Dir.mktmpdir { |path| @tagger.scan_for_tagged_tests(path, '') }
+
+      expect(results).to be_a_kind_of(Array)
     end
   end
 

data/todo.txt

@@ -2,3 +2,4 @@
 # todo - Add better test coverage (rake tasks, cli, etc.)
 # todo - Use features as documentation
 # todo - Use the cuketagger gem for tagging
+# todo - document functionality/add functionality for changing added tag location/column location

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuke_cataloger
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Eric Kessler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-18 00:00:00.000000000 Z
+date: 2017-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cuke_modeler
@@ -183,8 +183,11 @@ files:
 - bin/cuke_cataloger
 - cuke_cataloger.gemspec
 - lib/cuke_cataloger.rb
+- lib/cuke_cataloger/formatters/text_report_formatter.rb
+- lib/cuke_cataloger/rake_tasks.rb
 - lib/cuke_cataloger/unique_test_case_tagger.rb
 - lib/cuke_cataloger/version.rb
+- testing/cucumber/features/cataloging_tasks.feature
 - testing/cucumber/features/executable.feature
 - testing/cucumber/features/formatting.feature
 - testing/cucumber/features/tag_indexing.feature
@@ -197,6 +200,8 @@ files:
 - testing/cucumber/step_definitions/verification_steps.rb
 - testing/cucumber/support/env.rb
 - testing/cucumber/support/transforms.rb
+- testing/file_helper.rb
+- testing/fixtures/Rakefile
 - testing/fixtures/tests/foo.feature
 - testing/gemfiles/cuke_modeler0.gemfile
 - testing/gemfiles/cuke_modeler1.gemfile