gherkin_checker 1.1.7 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af1d00423b58e69f554f26634ab6d36955195a6a2087d4dfba2aeba2fcc10fdb
-  data.tar.gz: 3e253b3da7e0a0da2262888c7f3e445884c70b6f5121fd2a89b8f7ddb4b0f9e5
+  metadata.gz: 187d4e241a76c4044dc0f41c640c4b3b5022508614482d6c6369dd72b4c9888a
+  data.tar.gz: 3e679ba099d82061788ae12270bb0d73f15673289e089ca35436a2d0418934d3
 SHA512:
-  metadata.gz: 931a0ce81cf6f9c2f2a5ed577507e801cc4410ea5fb1a2e43dece9546f8b51dc61719d1b4a58328a430abe98306d9b05e02562bede7f5c84e742b8f9d9535956
-  data.tar.gz: 939fb42bcf8b869dac12ce7da9af5c9245978adbe4a5672d984c4d3694bf40e437ac9144eba4387a6fc8d764aac48d7531797056bb47d32ac828fa922dcb56ca
+  metadata.gz: 9184c1441b70cd8f8f8f6db7a1499b3f6cf476556e762a5f3b1318235e9a0ed1bf3dfbc7417aa6b1ff42f78ec4d1ca9ee278bd4edaec7bbfd57821063cea99fe
+  data.tar.gz: 3ba183a3a7af38e70823945f7228ac21311f3462b7d4f5be8c18047263b0f8f8e6d977ae560b61113c02148f0acb7a9dbc29b7b0b84cc87d22c6bc49b1846d25

data/README.md

@@ -1,22 +1,44 @@
-# GherkinChecker
+# gherkin_checker
 
-.feature file checker
+**GherkinChecker** is a tool for validating and enforcing rules on Gherkin `.feature` files. It allows users to set custom tag and structure requirements for feature files to maintain consistency and quality in test scenarios.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Install the gem and add it to your application's Gemfile by running:
 
-Install the gem and add to the application's Gemfile by executing:
+```sh
+gem install gherkin_checker
+````
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+## Usage
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+After successful installation, navigate to your project repository and create a configuration file named gherkin_checker.yml. Define your custom rules for Gherkin checking within this file. Below is a sample configuration format:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```yaml
+feature_files_path: '{to/your/path}'
+mandatory_tags:
+  must_be:
+    - "Text1"
+  one_of:
+    - "Text2"
+    - "Text3"
+    - "Text4"
+```
 
-## Usage
+**Configuration Parameters**
+
+- **feature_files_path**: Specifies the path to the directory containing Gherkin feature files.
+- **mandatory_tags**:
+    - **must_be**: Tags that must be present in every feature file.
+    - **one_of**: Tags where at least one must be present in each feature file.
+
+To run Gherkin Checker on your project, execute the following command in the terminal:
+
+```sh
+gherkin_checker
+````
 
-TODO: Write usage instructions here
+This command will check your feature files according to the rules defined in gherkin_checker.yml and provide feedback based on any discrepancies found.
 
 ## Development
 
@@ -26,7 +48,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gherkin_checker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/gherkin_checker/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/dikako/gherkin_checker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/gherkin_checker/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/gherkin_checker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GherkinChecker
-  VERSION = "1.1.7"
+  VERSION = "1.2.0"
 end

data/lib/gherkin_checker.rb

@@ -2,7 +2,7 @@
 
 require "find"
 require "yaml"
-require "set"
+require "gherkin/parser"
 
 require_relative "gherkin_checker/version"
 
@@ -50,18 +50,20 @@ module GherkinChecker
       return log_one_of_tags_warning if @one_of_tags.nil?
 
       errors = []
-      extract_scenarios_with_tags(file).each do |data|
-        is_tags_nil = data[:tags].nil?
-        tags = data[:tags]
+      extract_scenario_data(file).each do |data|
+        is_tags_nil = data[:scenario_tags].nil?
+        tags = data[:scenario_tags]
         file_line = data[:file_line]
-        scenario = data[:scenario]
+        scenario = data[:scenario_name]
+        error = data[:error]
 
         if is_tags_nil
           errors << {
             check: :one_of_tags,
             file_line: file_line,
-            scenario: scenario,
-            tags: tags
+            scenario_name: scenario,
+            scenario_tags: tags,
+            error: error
           }
         end
 
@@ -72,8 +74,9 @@ module GherkinChecker
         errors << {
           check: :one_of_tags,
           file_line: file_line,
-          scenario: scenario,
-          tags: tags
+          scenario_name: scenario,
+          scenario_tags: tags,
+          error: error
         }
       end
 
@@ -84,18 +87,20 @@ module GherkinChecker
       return log_must_be_tags_warning if @must_be_tags.nil?
 
       errors = []
-      extract_scenarios_with_tags(file).each do |data|
-        is_tags_nil = data[:tags].nil?
-        tags = data[:tags]
+      extract_scenario_data(file).each do |data|
+        is_tags_nil = data[:scenario_tags].nil?
+        tags = data[:scenario_tags]
         file_line = data[:file_line]
-        scenario = data[:scenario]
+        scenario = data[:scenario_name]
+        error = data[:error]
 
         if is_tags_nil
           errors << {
             check: :must_be_tags,
             file_line: file_line,
-            scenario: scenario,
-            tags: tags
+            scenario_name: scenario,
+            scenario_tags: tags,
+            error: error
           }
         end
 
@@ -106,8 +111,9 @@ module GherkinChecker
         errors << {
           check: :must_be_tags,
           file_line: file_line,
-          scenario: scenario,
-          tags: tags
+          scenario_name: scenario,
+          scenario_tags: tags,
+          error: error
         }
       end
 
@@ -140,20 +146,25 @@ module GherkinChecker
       else
         log_message("Gherkin Checker found Error:", level: :error)
         errors.each do |error|
-          tags = error[:tags]
-          tags = error[:tags].nil? ? "Tagging not set" : "Just found '#{tags}'"
-
-          message = case error[:check]
-                    when :one_of_tags
-                      "one_of_tags '#{@one_of_tags}' not found!, #{tags}"
-                    when :must_be_tags
-                      "must_be_tags '#{@must_be_tags}' not found!, #{tags}"
-                    else
-                      "error undefined"
-                    end
-
-          # Log error to console
-          log_message("#{error[:file_line]}: #{error[:scenario]} - #{message}", level: :error)
+          error_message = error[:error]
+          if error_message.nil?
+            scenario_tags = error[:scenario_tags]
+            tags = scenario_tags
+            tags = scenario_tags.nil? ? "Tagging not set" : "Just found '#{tags}'"
+
+            message = case error[:check]
+                      when :one_of_tags
+                        "one_of_tags '#{@one_of_tags}' not found!, #{tags}"
+                      when :must_be_tags
+                        "must_be_tags '#{@must_be_tags}' not found!, #{tags}"
+                      else
+                        "error undefined"
+                      end
+
+            log_message("#{error[:file_line]}: #{error[:scenario_name]} - #{message}", level: :error)
+          else
+            log_message("Error: #{error_message}", level: :error)
+          end
         end
       end
     end
@@ -175,33 +186,48 @@ module GherkinChecker
       puts "#{color}#{message}#{colors[:reset]}"
     end
 
-    def extract_scenarios_with_tags(file)
-      scenarios = []
-      current_tags = []
-
-      lines = File.readlines(file)
-
-      lines.each_with_index do |line, index|
-        # Remove leading/trailing whitespace
-        line.strip!
-
-        if line.start_with?("@")
-          # Capture tags if line contains tags
-          current_tags = line.scan(/@(\w+)/).flatten
-        elsif line.start_with?("Scenario:", "Scenario Outline:")
-          # Capture scenario names
-          scenario_name = line.sub(/^Scenario(?: Outline)?:\s*/, "").strip
-          # Store scenario with current tags (nil if no tags), then reset tags for next scenario
-          scenarios << {
-            file_line: "#{file}:#{index + 1}",
-            scenario: scenario_name,
-            tags: current_tags.empty? ? nil : current_tags.dup
+    def extract_scenario_data(file)
+      gherkin_parser = Gherkin::Parser.new
+      scenario_data = []
+
+      begin
+        content = File.read(file)
+        document = gherkin_parser.parse(content)
+        feature = document.feature
+        feature_name = feature.name
+        feature_tags = feature.tags.map(&:name)
+
+        feature.children.each do |child|
+          raise "Error: read scenario data" unless child.respond_to?(:scenario) && child.scenario
+
+          scenario = child.scenario
+          scenario_name = scenario.name
+          scenario_tags = scenario.tags.map(&:name)
+          scenario_tags = scenario_tags.map { |tag| tag.delete_prefix("@") }
+          location_line = scenario.location.line
+          location_column = scenario.location.column
+
+          scenario_data << {
+            feature_name: feature_name,
+            feature_tags: feature_tags,
+            file_line: "#{file}:#{location_line}:#{location_column}",
+            scenario_name: scenario_name,
+            scenario_tags: scenario_tags,
+            error: nil
           }
-          current_tags = [] # Reset tags for next scenario
         end
+      rescue StandardError => e
+        scenario_data << {
+          feature_name: nil,
+          feature_tags: nil,
+          file_line: nil,
+          scenario_name: nil,
+          scenario_tags: nil,
+          error: e.message
+        }
       end
 
-      scenarios
+      scenario_data
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: gherkin_checker
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.2.0
 platform: ruby
 authors:
 - Dikakoko
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-04 00:00:00.000000000 Z
+date: 2025-07-25 00:00:00.000000000 Z
 dependencies: []
 description: Checking .feature files
 email:
@@ -28,7 +27,6 @@ licenses:
 metadata:
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/dikako/gherkin_checker
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -36,15 +34,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: ".feature files checkers"
 test_files: []