cuke_cataloger 1.6.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5093a2a855885a82d1979dbd2aae635006b0ff3dbcfece5e82cd46f65e8b6763
-  data.tar.gz: b7e5e60c3cea900f3d24c085733af68365f067bd5f691345c3dbd06242c39604
+  metadata.gz: eb3fd5cae38ab765ef2915d216509608ce7bbf28767baf54b370bf19eff41c90
+  data.tar.gz: 040f1d882042efd4a4da63f8fbcbaa0d1b37ad3e3126b54a3beb809088dfa419
 SHA512:
-  metadata.gz: e1d7fb2ac7d4bcd05c127fc4a776f3a00e2e329d431b667320af0cc70a17aa86da75517c570a4895ae90a29c87be3a67ee9ed38b1201e6293b708dd4f8172f97
-  data.tar.gz: 24023c7622767652754aa65dd3880754606b1c44cf440fdc07952a1c0cae973f80cf43992eaaf9119748d051bfd992d86fc48d18e6ab590d6b4dfb80c3d875ac
+  metadata.gz: e57370bfb86b86f211c93641f0fba504279570612502d2dfce5d790c1c6061b93b2b4489bcacc4d206f51e9e748d0942633faba01a54cff1bf3ad785310cdd83
+  data.tar.gz: 3a48e9559901b71336a48adb65172de4d739975b3c883859ed5f184647ecc5bfb5ad2f703eb1b3f46697956e99224ecfd55b48efe9cef59783cce3392772c521

data/CHANGELOG.md

@@ -8,6 +8,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Nothing yet...
 
+## [2.0.0] - 2022-02-05
+
+### Added
+
+ - Added support for Ruby 3.x
+
+### Removed
+
+  - Removed support for some older versions of the gem's dependencies:
+    - Ruby 1.x
+    - Rake 0.x
+    - CukeModeler 0.x
+
+### Fixed
+
+ - Test case IDs are no longer erroneously detected if a tag only partially matches the ID pattern. For example, the 
+   gem would incorrectly identify `@test_case_123_plus_more` as an ID tag even though it was not one.
+ - Cataloging tests now correctly handles tests that are nested in rules. Previously, the presence of a `Rule` 
+   keyword would cause new ID tags to be placed on the wrong lines in the cataloged file.  
+
+
 ## [1.6.0] - 2020-06-21
 
 ### Added
@@ -24,7 +45,8 @@ Nothing yet...
 ## [1.5.0] - 2018-09-09
 
 ### Added
-  - The default cataloging prefix used by the Rake tasks is now also the default prefix used by the various object based methods.
+  - The default cataloging prefix used by the Rake tasks is now also the default prefix used by the various object 
+    based methods.
 
 ## [1.4.1] - 2017-07-09
 
@@ -46,7 +68,8 @@ Nothing yet...
 
 ### Added
   - 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.
+  - A basic cataloging location and prefix is used by default so that specifying these values will not be necessary in 
+    many cases.
 
 ### Fixed
   - Replaced non-Ruby 1.8.x compatible code so that the gem now correctly works with older versions of Ruby.
@@ -68,7 +91,8 @@ Nothing yet...
 - Initial release
 
 
-[Unreleased]: https://github.com/enkessler/cuke_cataloger/compare/v1.6.0...HEAD
+[Unreleased]: https://github.com/enkessler/cuke_cataloger/compare/v2.0.0...HEAD
+[2.0.0]: https://github.com/enkessler/cuke_cataloger/compare/v1.6.0...v2.0.0
 [1.6.0]: https://github.com/enkessler/cuke_cataloger/compare/v1.5.0...v1.6.0
 [1.5.0]: https://github.com/enkessler/cuke_cataloger/compare/v1.4.1...v1.5.0
 [1.4.1]: https://github.com/enkessler/cuke_cataloger/compare/v1.4.0...v1.4.1

data/LICENSE.txt

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

data/README.md

@@ -4,15 +4,14 @@ Basic stuff:
 [![Downloads](https://img.shields.io/gem/dt/cuke_cataloger.svg)](https://rubygems.org/gems/cuke_cataloger)
 
 User stuff:
-[![Cucumber Docs](http://img.shields.io/badge/Documentation-Features-green.svg)](https://jam.cucumber.io/p/98c11df9-4a7b-4b86-9700-7833ac93aa3e/cuke_cataloger/documents/branch/master/)
+[![Cucumber Docs](http://img.shields.io/badge/Documentation-Features-green.svg)](https://github.com/enkessler/cuke_cataloger/tree/master/testing/cucumber/features)
 [![Yard Docs](http://img.shields.io/badge/Documentation-API-blue.svg)](https://www.rubydoc.info/gems/cuke_cataloger)
 
 Developer stuff:
-[![Build Status](https://travis-ci.org/enkessler/cuke_cataloger.svg)](https://travis-ci.org/enkessler/cuke_cataloger)
-[![Build status](https://ci.appveyor.com/api/projects/status/9a7gw3r5ddfugtf0?svg=true)](https://ci.appveyor.com/project/enkessler/cuke-cataloger)
-[![Coverage Status](https://coveralls.io/repos/github/enkessler/cuke_cataloger/badge.svg)](https://coveralls.io/github/enkessler/cuke_cataloger)
+[![Build Status](https://github.com/enkessler/cuke_cataloger/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/enkessler/cuke_cataloger/actions/workflows/ci.yml?query=branch%3Amaster)
+[![Coverage Status](https://coveralls.io/repos/github/enkessler/cuke_cataloger/badge.svg?branch=master)](https://coveralls.io/github/enkessler/cuke_cataloger?branch=master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/662f0e7aa69bf9725515/maintainability)](https://codeclimate.com/github/enkessler/cuke_cataloger/maintainability)
-[![Inline docs](http://inch-ci.org/github/enkessler/cuke_cataloger.svg)](https://inch-ci.org/github/enkessler/cuke_cataloger)
+[![Inline docs](http://inch-ci.org/github/enkessler/cuke_cataloger.svg?branch=master)](https://inch-ci.org/github/enkessler/cuke_cataloger)
 
 
 ---
@@ -164,11 +163,12 @@ By default, the cataloging and validation process uses `test_case_id` as the col
 
 `Rake::Task['validate_tests'].invoke('./features','@test_case_',nil, true, 'my_special_column_id')  # 5th argument is the id column name`
 
+For more information and usage examples, see the documentation [here](https://github.com/enkessler/cuke_cataloger/tree/master/testing/cucumber/features).
 
-## Contributing
+## Development and 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`
-5. Create new Pull Request
+See [CONTRIBUTING.md](https://github.com/enkessler/cuke_cataloger/blob/master/CONTRIBUTING.md)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/cuke_cataloger.gemspec

@@ -1,33 +1,53 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cuke_cataloger/version'
 
-Gem::Specification.new do |spec|
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength - Gemspecs inherently have a lot of lines
   spec.name          = 'cuke_cataloger'
   spec.version       = CukeCataloger::VERSION
   spec.authors       = ['Eric Kessler']
   spec.email         = ['morrow748@gmail.com']
   spec.summary       = 'A tool to give every Cucumber test a unique id'
-  spec.description   = 'Scans existing Cucumber tests and updates them to include an id tag that is unique for the test suite.'
+  spec.description   = ['Scans existing Cucumber tests and updates them to include an id tag that is unique for the ',
+                        'test suite.'].join
   spec.homepage      = 'https://github.com/enkessler/cuke_cataloger'
   spec.license       = 'MIT'
+  spec.metadata      = {
+    'bug_tracker_uri'   => 'https://github.com/enkessler/cuke_cataloger/issues',
+    'changelog_uri'     => 'https://github.com/enkessler/cuke_cataloger/blob/master/CHANGELOG.md',
+    'documentation_uri' => 'https://www.rubydoc.info/gems/cuke_cataloger',
+    'homepage_uri'      => 'https://github.com/enkessler/cuke_cataloger',
+    'source_code_uri'   => 'https://github.com/enkessler/cuke_cataloger'
+  }
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('', __dir__)) do
+    source_controlled_files = `git ls-files -z`.split("\x0")
+    source_controlled_files.keep_if { |file| file =~ %r{^(lib|exe|testing/cucumber/features)} }
+    source_controlled_files + ['README.md', 'LICENSE.txt', 'CHANGELOG.md', 'cuke_cataloger.gemspec']
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'cuke_modeler', '>= 0.2', '< 4.0'
+  spec.required_ruby_version = '>= 2.0', '< 4.0'
+
+  spec.add_runtime_dependency 'cuke_modeler', '>= 1.0', '< 4.0'
   spec.add_runtime_dependency 'cql', '>= 1.0.1', '< 2.0'
-  spec.add_runtime_dependency 'rake', '< 14.0'
+  spec.add_runtime_dependency 'rake', '>=10.0', '< 14.0'
   spec.add_runtime_dependency 'thor', '< 2.0'
 
-  spec.add_development_dependency "bundler", '< 3'
+  spec.add_development_dependency 'childprocess', '< 5.0'
+  spec.add_development_dependency 'ffi', '< 2.0' # This is an invisible dependency for the `childprocess` gem on Windows
+  spec.add_development_dependency 'bundler', '< 3'
   spec.add_development_dependency 'cucumber', '< 4.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'racatt', '~> 1.0'
-  spec.add_development_dependency 'simplecov', '< 1.0'
-  spec.add_development_dependency 'coveralls', '< 1.0'
+  spec.add_development_dependency 'simplecov', '~> 0.18'
+  spec.add_development_dependency 'simplecov-lcov', '< 1.0'
   spec.add_development_dependency 'rainbow', '< 4.0.0'
+  spec.add_development_dependency 'rubocop', '<= 0.50.0' # RuboCop can not lint against Ruby 2.0 after this version
+  spec.add_development_dependency 'yard', '< 1.0'
+  spec.add_development_dependency 'pry', '< 0.14'
 end

data/exe/cuke_cataloger

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+require 'thor'
+require 'cuke_cataloger'
+
+# The Command Line Interface for the gem
+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 # rubocop:disable Metrics/AbcSize - Seems to be reporting high for some reason
+    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], {}, 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 # rubocop:disable Metrics/AbcSize - Seems to be reporting high for some reason
+    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],
+                                                                        options[:row_id],
+                                                                        options[:id_column_name])
+    report_text = CukeCataloger::TextReportFormatter.new.format_data(results)
+
+    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/lib/cuke_cataloger/formatters/text_report_formatter.rb

@@ -1,3 +1,6 @@
+# TODO: have better testing so that this can be safely refactored
+# rubocop:disable Metrics/AbcSize - Not going to mess with this, given how little testing is present
+
 module CukeCataloger
 
   # Not a part of the public API. Subject to change at any time.
@@ -14,11 +17,11 @@ module CukeCataloger
         results_by_category[result[:problem]] << result
       end
 
-      results_by_category.keys.each do |problem_category|
+      results_by_category.each_key do |problem_category|
         report_text << "#{problem_category} problems: #{results_by_category[problem_category].count}\n"
       end
 
-      results_by_category.keys.each do |problem_category|
+      results_by_category.each_key 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|
@@ -31,3 +34,5 @@ module CukeCataloger
 
   end
 end
+
+# rubocop:enable Metrics/AbcSize

data/lib/cuke_cataloger/rake_tasks.rb

@@ -1,3 +1,8 @@
+# TODO: have better testing so that this can be safely refactored
+# rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/LineLength, Metrics/MethodLength, Metrics/PerceivedComplexity - Not going to mess with this, given how little testing is present
+
+
+# The top level namespace used by this gem
 module CukeCataloger
 
   extend Rake::DSL
@@ -5,9 +10,8 @@ module CukeCataloger
 
   # 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|
+    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]
@@ -21,7 +25,7 @@ module CukeCataloger
     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|
+    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]
@@ -40,7 +44,8 @@ module CukeCataloger
         puts report_text
       end
     end
-
   end
 
 end
+
+# rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/LineLength, Metrics/MethodLength, Metrics/PerceivedComplexity