cuke_cataloger 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 574e7e5f5cb470529c0e545dee407f89e341ba2e
-  data.tar.gz: b2c082b82da4209fb75fd45baed7ce98b7c4bbe8
+  metadata.gz: 7ca57a9cc7f55a7db0a69cac22642da17b709b24
+  data.tar.gz: 8ee177287198378826095b0356578e1d66d18180
 SHA512:
-  metadata.gz: 663b06f1515ac03d009001a2489d0bfbc8fbaae5b2567a8db1b10abbaf8db5b24e3d3a37d9d5b38b5de5490def11094ddc644efedbc35d4acd9bc419d654867f
-  data.tar.gz: a341cfdd22f16abb4cb7775fb994f23cd4becca8ce7163d74637ee4a868206e7bfa337befec5b4bfbd32268cc35dda87e510e5d8bedde4c5cfd0336b6c91096c
+  metadata.gz: 4d3ebc2a6c56845d242414f29ef9e865b0e815ebcbfe2a75479940d0c7cd4e8a8e31549412c973a121c64cb484995be152546048335b9f0c7ae74e8653bc6f77
+  data.tar.gz: 68845af1ed68b6868cef1efd224008afcf6f4b2b12e2f3d5113d7fdfb3e91379220c1c5d8bae9770b01156e43b1ce77216a59c11a151071505a613f50794f12f

data/History.md

@@ -1,5 +1,14 @@
 # Release history
 
+### Version 1.3.0 / 2017-01-09
+
+- Bug fix: Replaced non-Ruby 1.8.x compatible code so that the gem now correctly works with older versions of Ruby.
+
+- Added an executable file for the gem so that it can be used without having to use Rake tasks.
+
+- A basic cataloging location and prefix is used by default so that specifying these values will not be necessary in many cases.
+
+
 ### Version 1.2.0 / 2016-10-02
 
 - The gem now declares version limits on all of its dependencies.

data/README.md

@@ -8,7 +8,7 @@
 [![Project License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/enkessler/cuke_cataloger/blob/master/LICENSE.txt)
 
 
-The cuke_cataloger gem is a convenient way to provide a unique id to every test case in your Cucumber test suite. 
+The cuke_cataloger gem is a convenient way to provide a unique id to every test case in your Cucumber test suite.
 
 ## Installation
 
@@ -26,7 +26,19 @@ Or install it yourself as:
 
 ## Usage
 
-The simplest way to use this gem is to include the Rake tasks that it provides in your project. Just require the gem
+In addition to using the provided classes in any regular Ruby script, the gem's functionality can be accessed through the command line or through the provided Rake tasks.
+
+### Command Line
+
+    cuke_cataloger catalog_test_cases [--location=LOCATION] [--prefix=PREFIX]
+
+and
+
+    cuke_cataloger validate_test_cases [--location=LOCATION] [--prefix=PREFIX] [--file=FILE]
+
+### Rake Task
+
+Require the gem
 
     require 'cuke_cataloger'
 
@@ -40,28 +52,34 @@ If you want the tasks to be created in a certain namespace, simply call the crea
       CukeCataloger.create_tasks
     end
 
-The classes used to tag and validate tests could also be used directly in other scripts if you want to do something more complex than the functionality provided by the two predefined Rake tasks.
+This will create tasks that can then be invoked in the usual manner:
+
+    rake tag_tests['path/to/your/tests','@test_case_']
+
+and
+
+    rake validate_tests['path/to/your/tests','@test_case_','validation_results.txt']
   
 ### Adding ids to tests
 
-The tag_tests task will add an id tag to every scenario (and an id column to every outline) in a test suite. To do this, it needs to be provided a directory in which the tests are located and a prefix upon which to base the tagging scheme.
+The the tagging functionality will add an id tag to every scenario (and an id column to every outline) in a test suite. It can be given a directory in which the tests are located and a prefix upon which to base the tagging scheme but, if not given that information, it will use the current directory and a prefix of `@test_case_`.
 
-    rake tag_tests['path/to/your/tests','@test_case_']
+    rake tag_tests['path/to/your/tests','@my_prefix_']
 
-The above example would result in the tags @test_case_1, @test_case_2, @test_case_3, etc. being added to every test in the given directory.
+The above example would result in the tags `@my_prefix_1`, `@my_prefix_2`, `@my_prefix_3`, etc. being added to every test in the `tests` directory.
 
 ### Validating test ids
 
-The validate_tests task scans a given directory for any problems related to id tags and generates a report detailing its results. To do this, it needs to be provided a directory in which the tests are located and a prefix upon which to base the tagging scheme. It can optionally take a file location to which it should output its report instead of printing it to the console.
+The the validating functionality scans a given directory for any problems related to id tags and generates a report detailing its results. It can be given a directory in which the tests are located and a prefix upon which to base the tagging scheme, as well as a file location to which it should output its report but, if not given that information, it will use the current directory and a prefix of `@test_case_` and it will output the report to the console. 
 
-    rake validate_tests['path/to/your/tests','@test_case_','validation_results.txt']
+    rake validate_tests['path/to/your/tests','@my_prefix_','validation_results.txt']
 
-The above example would result in a report called 'validation_results.txt' being generated for any test had problems related to their id (e.g. did not have an id tag, had the same id tag as another test, etc.).
+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_`.
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/cuke_cataloger/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
+1. Fork it `http://github.com/<my-github-username>/cuke_cataloger/fork`
+2. Create your feature branch (off of the development branch) `git checkout -b my-new-feature`
+3. Commit your changes `git commit -am 'Add some feature'`
+4. Push to the branch `git push origin my-new-feature`
 5. Create new Pull Request

data/bin/cuke_cataloger

@@ -0,0 +1,59 @@
+require 'thor'
+require 'cuke_cataloger'
+
+
+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_'
+
+  def catalog_test_cases
+    puts "Tagging tests in '#{options[:location]}' with tag '#{options[:prefix]}'\n"
+
+    tagger = CukeCataloger::UniqueTestCaseTagger.new
+    tagger.tag_tests(options[:location], options[:prefix])
+  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 :file
+
+  def validate_test_cases
+    puts "Validating tests in '#{options[:location]}' with tag '#{options[:prefix]}'\n"
+
+    results = CukeCataloger::UniqueTestCaseTagger.new.validate_test_ids(options[:location], options[:prefix])
+    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
+
+    if options[:file]
+      puts "Problems found: #{results.count}"
+      File.open(options[:file], 'w') { |file| file.write(report_text) }
+    else
+      puts report_text
+    end
+  end
+
+end
+
+
+CLI.start(ARGV)

data/cuke_cataloger.gemspec

@@ -21,6 +21,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 'thor', '~> 0.0'
 
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'cucumber', '< 3.0'

data/lib/cuke_cataloger.rb

@@ -9,22 +9,29 @@ 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] do |t, args|
-      puts "Tagging tests in '#{args[:directory]}' with tag '#{args[:prefix]}'\n"
+      location = args[:directory] || '.'
+      prefix = args[:prefix] || '@test_case_'
+
+      puts "Tagging tests in '#{location}' with tag '#{prefix}'\n"
 
       tagger = CukeCataloger::UniqueTestCaseTagger.new
-      tagger.tag_tests(args[:directory], args[:prefix])
+      tagger.tag_tests(location, prefix)
     end
 
     desc 'Scan tests in the given directory for id problems'
     task 'validate_tests', [:directory, :prefix, :out_file] do |t, args|
-      puts "Validating tests in '#{args[:directory]}' with tag '#{args[:prefix]}'\n"
+      location = args[:directory] || '.'
+      prefix = args[:prefix] || '@test_case_'
+
+      puts "Validating tests in '#{location}' with tag '#{prefix}'\n"
 
-      results = CukeCataloger::UniqueTestCaseTagger.new.validate_test_ids(args[:directory], args[:prefix])
+      results = CukeCataloger::UniqueTestCaseTagger.new.validate_test_ids(location, prefix)
       report_text = "Validation Results\nProblems found: #{results.count}\n\n"
 
 
@@ -48,7 +55,7 @@ module CukeCataloger
 
       if args[:out_file]
         puts "Problems found: #{results.count}"
-        File.write(args[:out_file], report_text)
+        File.open(args[:out_file], 'w') { |file| file.write(report_text) }
       else
         puts report_text
       end

data/lib/cuke_cataloger/version.rb

@@ -1,3 +1,3 @@
 module CukeCataloger
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/testing/cucumber/features/executable.feature

@@ -0,0 +1,44 @@
+Feature: Cataloging executable
+
+  Cataloging functionality can be used directly from the command line.
+
+
+  Scenario: Cataloging test cases
+
+  Note: By default, cataloging will be done in the current directory using the '@test_case_' prefix
+
+    Given the cuke_cataloger executable is available
+    And there are test cases in the "." directory that have not been cataloged with "@test_case_"
+    When the following command is executed:
+    """
+    cuke_cataloger catalog_test_cases
+    """
+    Then all of the test cases in the "." directory will be cataloged with "@test_case_"
+
+  Scenario: Specifying cataloging options
+    Given the cuke_cataloger executable is available
+    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
+    """
+    Then all of the test cases in the "tests" directory will be cataloged with "@foo"
+
+  Scenario: Validating test cases
+
+  Note: By default, validation will be done in the current directory using the '@test_case_' prefix
+
+    Given the cuke_cataloger executable is available
+    When the following command is executed:
+    """
+    cuke_cataloger validate_test_cases
+    """
+    Then a validation report for the "." directory with prefix "@test_case_" is output to the console
+
+  Scenario: Specifying validation options
+    Given the cuke_cataloger executable is available
+    When the following command is executed:
+    """
+    cuke_cataloger validate_test_cases --location <path_to>/tests  --prefix @foo --file <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

@@ -26,3 +26,17 @@ When(/^the existing ids are determined$/) do
 
   @ids_found = CukeCataloger::UniqueTestCaseTagger.new.determine_known_ids(@directory.path, @tag_prefix)
 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")
+  end
+
+  command.sub!('<path_to>', FIXTURE_DIRECTORY)
+  command = "bundle exec ruby #{@executable_directory}/#{command}"
+
+  Dir.chdir(FIXTURE_DIRECTORY) do
+    @output = `#{command}`
+  end
+end

data/testing/cucumber/step_definitions/setup_steps.rb

@@ -54,3 +54,16 @@ end
 And(/^the tag location is unspecified$/) do
   @above_or_below = nil
 end
+
+Given(/^the cuke_cataloger executable is available$/) do
+  @executable_directory = "#{PROJECT_ROOT}/bin"
+end
+
+And(/^there are test cases in the "([^"]*)" directory that have not been cataloged with "([^"]*)"$/) do |target_directory, prefix|
+  target_directory = "#{FIXTURE_DIRECTORY}/#{target_directory}"
+
+  @test_results = CukeCataloger::UniqueTestCaseTagger.new.validate_test_ids(target_directory, prefix)
+
+  # 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

data/testing/cucumber/step_definitions/verification_steps.rb

@@ -162,3 +162,27 @@ And(/^the resulting second file is:$/) do |expected_text|
 
   expect(actual_text).to eq(expected_text)
 end
+
+Then(/^all of the test cases in the "([^"]*)" directory will be cataloged with "([^"]*)"$/) do |target_directory, prefix|
+  target_directory = "#{FIXTURE_DIRECTORY}/#{target_directory}"
+
+  @test_results = CukeCataloger::UniqueTestCaseTagger.new.validate_test_ids(target_directory, prefix)
+
+  verify_no_results
+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")
+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}"
+
+  expect(@output).to include("Validating tests in '#{target_directory}' with tag '#{prefix}'")
+  expect(@output).to include("Problems found:")
+
+  expect(File.exists?(filename)).to be true
+  expect(File.read(filename)).to include('Validation Results')
+end

data/testing/cucumber/support/env.rb

@@ -5,18 +5,33 @@ end
 
 require 'cuke_cataloger'
 
+here = File.dirname(__FILE__)
 
 DEFAULT_FEATURE_FILE_NAME = 'test_feature'
-DEFAULT_FILE_DIRECTORY = "#{File.dirname(__FILE__)}/../temp_files"
-
+DEFAULT_FILE_DIRECTORY = "#{here}/../temp_files"
+PROJECT_ROOT = "#{here}/../../.."
+FIXTURE_DIRECTORY = "#{here}/../../fixtures"
 
 Before do
-  @default_feature_file_name = DEFAULT_FEATURE_FILE_NAME
-  @default_file_directory = DEFAULT_FILE_DIRECTORY
+  begin
+    @default_feature_file_name = DEFAULT_FEATURE_FILE_NAME
+    @default_file_directory = DEFAULT_FILE_DIRECTORY
 
-  FileUtils.mkdir(@default_file_directory)
+    FileUtils.mkdir(@default_file_directory)
+  rescue => e
+    puts "Error caught in before hook!"
+    puts "Type: #{e.class}"
+    puts "Message: #{e.message}"
+  end
 end
 
 After do
-  FileUtils.remove_dir(@default_file_directory, true)
+  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

data/testing/fixtures/tests/foo.feature

@@ -0,0 +1,4 @@
+Feature: Foo
+
+  Scenario: Test 1
+    * a step

data/testing/rspec/spec/cuke_cataloger_spec.rb

@@ -0,0 +1,11 @@
+describe 'the gem' do
+
+  here = File.dirname(__FILE__)
+
+  let(:gemspec) { eval(File.read "#{here}/../../../cuke_cataloger.gemspec") }
+
+  it 'has an executable' do
+    expect(gemspec.executables).to include('cuke_cataloger')
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuke_cataloger
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Eric Kessler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-02 00:00:00.000000000 Z
+date: 2017-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cuke_modeler
@@ -64,6 +64,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -152,7 +166,8 @@ description: Scans existing Cucumber tests and updates them to include an id tag
   is unique for the test suite.
 email:
 - morrow748@gmail.com
-executables: []
+executables:
+- cuke_cataloger
 extensions: []
 extra_rdoc_files: []
 files:
@@ -164,10 +179,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/cuke_cataloger
 - cuke_cataloger.gemspec
 - lib/cuke_cataloger.rb
 - lib/cuke_cataloger/unique_test_case_tagger.rb
 - lib/cuke_cataloger/version.rb
+- testing/cucumber/features/executable.feature
 - testing/cucumber/features/formatting.feature
 - testing/cucumber/features/tag_indexing.feature
 - testing/cucumber/features/test_case_scanning.feature
@@ -179,8 +196,10 @@ files:
 - testing/cucumber/step_definitions/verification_steps.rb
 - testing/cucumber/support/env.rb
 - testing/cucumber/support/transforms.rb
+- testing/fixtures/tests/foo.feature
 - testing/gemfiles/cuke_modeler0.gemfile
 - testing/gemfiles/cuke_modeler1.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
@@ -204,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: A tool to give every Cucumber test a unique id