chutney 3.12.3 → 3.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60a3a93f0607331e34bd1af294bd142a0922041f75a896fea010344b6a34e814
-  data.tar.gz: 7162f57716f199229576ab04d14ec73a526cc694435c88d356257423e6792e20
+  metadata.gz: 8f2cf6323ca7856c5f58637ddc7ea3a4dd74222099a0dcb0a9b0768d95569bb5
+  data.tar.gz: bae06f03776f2c4d0be16f2a5bbd2f142e0a1259822076801924e0c02ee11e09
 SHA512:
-  metadata.gz: fcd4b9f4c1016813b51318f4ac8485e49dcf908e433290dcf70c644bfecedbea6acf8a6763b56cac824af6b8737dd6c9f6bd25dcec8ec983b487894b3d775cfb
-  data.tar.gz: b472494d26b2e532259aed6962a492a466da78435df5a0a8e3bda15b7d04504c05f27320fc288a7ba0b586ea348f9860f578b9635d0a9131eae9b4d1e59c935a
+  metadata.gz: 2c9461d317783650437e56da8bada9a15e3cf28974d6f28aec466c28b7fd066ec7eda520cfb2f419710c81b6f78ab94e8cb3aa403dcd28fa0f725d9aa03c19e6
+  data.tar.gz: 6e313a2aab39d318b2415c5d50e4df6a9ba373b4d00d07525dea132c3ea4d2610a5fea0469439d81d6cc6f513f6972a5a2356af35cbd647e76469981a6e86e71

data/.circleci/config.yml

@@ -4,7 +4,7 @@ version: 2.1
 jobs:
   build:
     docker:
-      - image: cimg/ruby:3.2
+      - image: cimg/ruby:3.4
     steps:
       - checkout
       - run: bundle install

data/config/chutney_defaults.yml

@@ -74,6 +74,9 @@ TooManyTags:
 TooLongStep:
   Enabled: true
   MaxLength: 80
+TooShortTag:
+  Enabled: true
+  MinLength: 2
 UniqueScenarioNames:
   Enabled: true
 UnknownVariable:

data/lib/chutney/linter/same_scenario.rb

@@ -11,28 +11,28 @@ module Chutney
       @dictionary ||= Hash.new { |hash, key| hash[key] = [] }
     end
 
-    def lint
+    def lint # rubocop:disable Metrics/MethodLength
       scenarios do |feature, scenario|
         text = background ? background.steps.map(&:to_s).join("\n").concat("\n") : ''
         text += scenario
-               .steps
-               .map { |step| "#{step.text} #{child_text(step)}" }
-               .join("\n") + example_text(scenario)
+                .steps
+                .map { |step| "#{step.text} #{child_text(step)}" }
+                .join("\n") + example_text(scenario)
         digest = Digest::SHA2.hexdigest(text)
         SameScenario.dictionary[digest] << { scenario:, feature: }
       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
+                    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/linter/use_background.rb

@@ -30,13 +30,19 @@ module Chutney
       result
     end
 
-    def expanded_steps(&block)
+    def expanded_steps(&)
       scenarios do |_feature, scenario|
         next unless scenario.steps
 
         prototypes = [render_step(scenario.steps.first)]
-        prototypes = expand_examples(scenario.examples, prototypes) if scenario.is_a? CukeModeler::Outline
-        prototypes.each(&block)
+
+        # only expand further if this is a Scenario Outline and we are dealing
+        # with a Given step with substitutions
+        if scenario.is_a?(CukeModeler::Outline) && prototypes.any? { |prototype| prototype =~ /<.*>/ }
+          prototypes = expand_examples(scenario.examples, prototypes)
+        end
+
+        prototypes.each(&)
       end
     end
 

data/lib/chutney/version.rb

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

data/lib/chutney.rb

@@ -40,6 +40,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

@@ -108,6 +108,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/assets/robots.txt

@@ -0,0 +1,2 @@
+User-agent: *
+Allow: /

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.3
+  version: 3.13.0
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
@@ -10,7 +10,7 @@ authors:
 - John Gluck
 bindir: exe
 cert_chain: []
-date: 2026-01-19 00:00:00.000000000 Z
+date: 2026-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amatch
@@ -212,6 +212,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
@@ -223,7 +224,6 @@ files:
 - lib/chutney/lsp/server.rb
 - lib/chutney/version.rb
 - lib/config/locales/en.yml
-- spec/chutney_mcp_spec.rb
 - spec/chutney_spec.rb
 - spec/spec_helper.rb
 - usechutney.com.site/.gitignore
@@ -235,6 +235,7 @@ files:
 - usechutney.com.site/site/assets/favicons/favicon.ico
 - usechutney.com.site/site/assets/favicons/site.webmanifest
 - usechutney.com.site/site/assets/mr_pickle.png
+- usechutney.com.site/site/assets/robots.txt
 - usechutney.com.site/site/assets/styles.css
 - usechutney.com.site/site/src/about.page.md
 - usechutney.com.site/site/src/docs/configuration.page.md
@@ -280,6 +281,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 +313,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.4
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A linter for multi-lingual Gherkin
 test_files: []