chutney 3.12.4 → 3.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bef0309c872b30a632afd0d944493cc0ecba7e5eb5348e470ede52b44cad857
-  data.tar.gz: 30c86c817bc8167157bcbb1679ee619908d5d505e52e856e12d294fa0b7c9ed6
+  metadata.gz: 3c21346027cfc0954890e1e287dbf282e76567e58267f9da730d2132d0ae83e1
+  data.tar.gz: d0a823dcd25b1bccc00bc873444f079e1be6421aad287c624a26fd3b6e11dac2
 SHA512:
-  metadata.gz: e97e7afee0915e9fcd16f2af9f713a0fa31832cdf01dab3a57c351d09592c54f27a57c0f053667d82e707f1a94be41ca1fc1e12deb3640c687b25f752a704a28
-  data.tar.gz: c62aacc66844003019511c285a7ab2bf5728383dcaf2c19b2e3f2859e1a2395a4d7b8690e8b619f1967a0ed677727a928f8177c8023b20d03aec94ed613c8cd0
+  metadata.gz: 77880b9602738619b732d6eeee96a05cab06177c159fce4b0a150af9684d166e65314408548edaf42cc735cb93eef88164338ec32561210c19a9cabe3a22ab38
+  data.tar.gz: 3e650442d104bd17c8cdffbc5956291e9cb288a4b0fbca34cbdb0dc6c6b7413e8ed40bff9d4272e48aebc6062bb459c89f627f08fa29660fbc1e279f967bf5dd

data/chutney.gemspec

@@ -48,7 +48,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'amatch', '>= 0.4', '< 0.7'
+  spec.add_dependency 'amatch', '>= 0.4', '< 0.8'
   spec.add_dependency 'cuke_modeler', '~> 3.26'
   spec.add_dependency 'i18n', '>= 1.8.2', '< 1.15.0'
   spec.add_dependency 'fast-mcp', '~> 1.5'

data/config/chutney_defaults.yml

@@ -12,6 +12,8 @@ AvoidSplatStepsInBackground:
   Enabled: true
 AvoidSplatStepsInScenarios:
   Enabled: true
+AvoidTags:
+  Enabled: false
 AvoidTypographersQuotes:
   Enabled: true
 BackgroundDoesMoreThanSetup:
@@ -74,6 +76,9 @@ TooManyTags:
 TooLongStep:
   Enabled: true
   MaxLength: 80
+TooShortTag:
+  Enabled: true
+  MinLength: 2
 UniqueScenarioNames:
   Enabled: true
 UnknownVariable:

data/docs/usage/rules.md

@@ -19,6 +19,8 @@ Chutney enforces its rules with the linters. These are:
 
 [AvoidSplatStepsInScenarios](https://github.com/BillyRuffian/chutney/blob/master/features/avoid_splat_steps_in_scenarios.feature): The Scenario contains a splat step. It should only contain named steps.
 
+[AvoidTags](https://github.com/BillyRuffian/chutney/blob/master/features/avoid_tags.feature): The Feature file contains tags to avoid.
+
 [AvoidTypographersQuotes](https://github.com/BillyRuffian/chutney/blob/master/features/avoid_typographers_quotes.feature): Cutting and pasting from Word documents? Is that pasting in curly-quotes instead of neutral ones you would type on a keyboard? Are you sure that's what you want?
 
 [BackgroundDoesMoreThanSetup](https://github.com/BillyRuffian/chutney/blob/master/features/background_does_more_than_setup.feature): Background in feature files should only do setup activity and so they should only contain `Given` steps.

data/lib/chutney/linter/avoid_tags.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Chutney
+  # service class to lint for avoiding tags
+  class AvoidTags < Linter
+    def lint
+      return if feature.nil?
+
+      feature_tags = tags_for(feature)
+      feature_tags_to_avoid_found = feature_tags & tags_to_avoid
+
+      unless feature_tags_to_avoid_found.empty?
+        feature_tags_to_avoid_found = feature_tags_to_avoid_found.map { |tag| tag.prepend('@') }
+        add_issue(I18n.t('linters.avoid_tags', tags: feature_tags_to_avoid_found.join(', ')), feature)
+      end
+
+      scenarios do |_feature, scenario|
+        scenario_tags = tags_for(scenario)
+        scenario_tags_to_avoid_found = scenario_tags & tags_to_avoid
+
+        unless scenario_tags_to_avoid_found.empty?
+          scenario_tags_to_avoid_found = scenario_tags_to_avoid_found.map { |tag| tag.prepend('@') }
+          add_issue(I18n.t('linters.avoid_tags', tags: scenario_tags_to_avoid_found.join(', ')), feature, scenario)
+        end
+      end
+    end
+
+    def tags_to_avoid
+      tags_to_avoid = configuration['Tags'] || []
+
+      return [] unless tags_to_avoid.is_a?(Array)
+
+      tags_to_avoid
+    end
+  end
+end

data/lib/chutney/linter/same_scenario.rb

@@ -13,7 +13,7 @@ module Chutney
 
     def lint # rubocop:disable Metrics/MethodLength
       scenarios do |feature, scenario|
-        text = background ? background.steps.map(&:to_s).join("\n").concat("\n") : ''
+        text = background ? background.steps.join("\n").concat("\n") : ''
         text += scenario
                 .steps
                 .map { |step| "#{step.text} #{child_text(step)}" }
@@ -23,16 +23,16 @@ module Chutney
       end
 
       SameScenario.dictionary.filter { |_k, v| v.size > 1 }
-                  .each_value do |v|
-                    v[1...].each_with_index do |problem, index|
-                      add_issue(I18n.t('linters.same_scenario',
-                                       feature: problem[:feature].name,
-                                       scenario: problem[:scenario].name,
-                                       original_feature: v.first[:feature].name,
-                                       original_scenario: v.first[:scenario].name),
-                                problem[:feature], problem[:scenario], nil)
-                      v.delete_at(index + 1)
-                    end
+                             .each_value do |v|
+        v[1...].each_with_index do |problem, index|
+          add_issue(I18n.t('linters.same_scenario',
+                           feature: problem[:feature].name,
+                           scenario: problem[:scenario].name,
+                           original_feature: v.first[:feature].name,
+                           original_scenario: v.first[:scenario].name),
+                    problem[:feature], problem[:scenario], nil)
+          v.delete_at(index + 1)
+        end
       end
     end
 

data/lib/chutney/linter/too_short_tag.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Chutney
+  # service class to lint for tags that are too short, such as @t
+  class TooShortTag < Linter
+    def lint
+      scenarios do |feature, scenario|
+        tags = tags_for(feature) + tags_for(scenario)
+        next unless tags.any? { |tag| tag.length < min_length }
+
+        add_issue(
+          I18n.t('linters.too_short_tag', min_length:, tags:),
+          feature
+        )
+      end
+    end
+
+    def min_length
+      configuration['MinLength']&.to_i || 2
+    end
+  end
+end

data/lib/chutney/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Chutney
-  VERSION = '3.12.4'
+  VERSION = '3.14.0'
 end

data/lib/chutney.rb

@@ -11,6 +11,7 @@ require 'chutney/linter/avoid_outline_for_single_example'
 require 'chutney/linter/avoid_scripting'
 require 'chutney/linter/avoid_splat_steps_in_background'
 require 'chutney/linter/avoid_splat_steps_in_scenarios'
+require 'chutney/linter/avoid_tags'
 require 'chutney/linter/avoid_typographers_quotes'
 require 'chutney/linter/background_does_more_than_setup'
 require 'chutney/linter/background_requires_multiple_scenarios'
@@ -40,6 +41,7 @@ require 'chutney/linter/too_long_step'
 require 'chutney/linter/too_many_different_tags'
 require 'chutney/linter/too_many_steps'
 require 'chutney/linter/too_many_tags'
+require 'chutney/linter/too_short_tag'
 require 'chutney/linter/unique_scenario_names'
 require 'chutney/linter/unknown_variable'
 require 'chutney/linter/unused_variable'

data/lib/config/locales/en.yml

@@ -19,6 +19,8 @@ en:
       The Background contains a splat step. It should only contain named steps.
     avoid_splat_steps_in_scenarios: >-
       The Scenario contains a splat step. It should only contain named steps.
+    avoid_tags: >-
+      The following tags are not allowed: %{tags}.
     avoid_typographers_quotes: >-
       You are using typographers quotation marks (curly quotes).
       Make sure you intend to use this character and not a neutral quote
@@ -108,6 +110,8 @@ en:
       There are too many steps in this feature. There are %{count} and the maximum is %{max}.
     too_many_tags: >-
       There are too many tags in this feature. There are %{count} and the maximum is %{max}.
+    too_short_tag: >-
+      Your tag is too short: %{tags}. The minimum length of a tag is %{min_length}. Tags should have meaning.
     unique_scenario_names: >-
       The scenario name '%{name}' is duplicated, first used at line %{line}, column %{column}.
     unknown_variable: >-

data/usechutney.com.site/site/src/docs/rules/avoid-tags.md

@@ -0,0 +1,38 @@
+# Avoid Tags
+
+Sometimes you just need a tag for you... maybe to filter your scenarios for focused testing?... or maybe you've got some fancy after hook to help with debugging? 
+Whatever the reason, you probably didn't mean to commit that to source. 
+
+AvoidTags helps prevent the accidental commit of tags by warning you if you have any tags in your feature file which match a configurable list of tags to avoid.
+
+## Configuration
+
+```yaml
+AvoidTags:
+  Enabled: true
+  Tags:
+    - MyFancyDebugTag
+```
+
+## Bad
+
+```gherkin
+@MyFancyDebugTag
+Scenario: Log in with valid credentials
+  Given I have visited the website
+  And I have logged in
+  And I have viewed sale items
+  When I view special offers
+  Then I will see my discount code
+```
+
+## Good
+
+```gherkin
+Scenario: Log in with valid credentials
+  Given I have visited the website
+  And I have logged in
+  And I have viewed sale items
+  When I view special offers
+  Then I will see my discount code
+```

data/usechutney.com.site/site/src/docs/rules/index.page.md

@@ -36,6 +36,7 @@
 * [Too Many Different Tags](/docs/rules/too-many-different-tags)
 * [Too Many Steps](/docs/rules/too-many-steps)
 * [Too Many Tags](/docs/rules/too-many-tags)
+* [Too Short Tag](/docs/rules/too_short_tag)
 * [Unique Scenario Names](/docs/rules/unique-scenario-names)
 * [Unknown Variable](/docs/rules/unknown-variable)
 * [Unused Variable](/docs/rules/unused-variable)

data/usechutney.com.site/site/src/docs/rules/too_short_tag.page.md

@@ -0,0 +1,25 @@
+# Too Short Tag
+
+If you have used a tag that is too short, you have probably done it while locally testing. This is a bad practice because it makes your tests harder to read and maintain.
+
+It is much better to use tags that relate to the test, such as a ticket number to connect the development work you are testing
+
+## Bad
+
+```gherkin
+@t
+Scenario: Log in with valid credentials
+Given I have visited the website
+When I log in with "user1" and "pass1"
+Then I will see my account
+```
+
+## Good
+
+```gherkin
+@QE-0001
+Scenario: Log in with valid credentials
+  Given I have visited the website
+  When I log in with "user1" and "pass1"
+  Then I will see my account
+```

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chutney
 version: !ruby/object:Gem::Version
-  version: 3.12.4
+  version: 3.14.0
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
@@ -10,7 +10,7 @@ authors:
 - John Gluck
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amatch
@@ -21,7 +21,7 @@ dependencies:
         version: '0.4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -31,7 +31,7 @@ dependencies:
         version: '0.4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: cuke_modeler
   requirement: !ruby/object:Gem::Requirement
@@ -183,6 +183,7 @@ files:
 - lib/chutney/linter/avoid_scripting.rb
 - lib/chutney/linter/avoid_splat_steps_in_background.rb
 - lib/chutney/linter/avoid_splat_steps_in_scenarios.rb
+- lib/chutney/linter/avoid_tags.rb
 - lib/chutney/linter/avoid_typographers_quotes.rb
 - lib/chutney/linter/background_does_more_than_setup.rb
 - lib/chutney/linter/background_requires_multiple_scenarios.rb
@@ -212,6 +213,7 @@ files:
 - lib/chutney/linter/too_many_different_tags.rb
 - lib/chutney/linter/too_many_steps.rb
 - lib/chutney/linter/too_many_tags.rb
+- lib/chutney/linter/too_short_tag.rb
 - lib/chutney/linter/unique_scenario_names.rb
 - lib/chutney/linter/unknown_variable.rb
 - lib/chutney/linter/unused_variable.rb
@@ -250,6 +252,7 @@ files:
 - usechutney.com.site/site/src/docs/rules/avoid-scripting.page.md
 - usechutney.com.site/site/src/docs/rules/avoid-splat-steps-in-background.page.md
 - usechutney.com.site/site/src/docs/rules/avoid-splat-steps-in-scenarios.page.md
+- usechutney.com.site/site/src/docs/rules/avoid-tags.md
 - usechutney.com.site/site/src/docs/rules/avoid-typographers-quotes.page.md
 - usechutney.com.site/site/src/docs/rules/background-does-more-than-setup.page.md
 - usechutney.com.site/site/src/docs/rules/background-requires-multiple-scenarios.page.md
@@ -280,6 +283,7 @@ files:
 - usechutney.com.site/site/src/docs/rules/too-many-different-tags.page.md
 - usechutney.com.site/site/src/docs/rules/too-many-steps.page.md
 - usechutney.com.site/site/src/docs/rules/too-many-tags.page.md
+- usechutney.com.site/site/src/docs/rules/too_short_tag.page.md
 - usechutney.com.site/site/src/docs/rules/unique-scenario-names.page.md
 - usechutney.com.site/site/src/docs/rules/unknown-variable.page.md
 - usechutney.com.site/site/src/docs/rules/unused-variable.page.md
@@ -311,7 +315,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.10
 specification_version: 4
 summary: A linter for multi-lingual Gherkin
 test_files: []