gherkin_checker 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4711b2c3890a6a9afec7106533d5aa5819b7ace4c99e449a00584a7573083ee1
-  data.tar.gz: 113c6415dd7d8b49ebc7549ad27c5eeb441872aa7b7d736f9a2bd015a73ca578
+  metadata.gz: b6e75527842d4edd3ba0a9b366fc61ef604607cebc78fb1f46ff7d74cb8b2acd
+  data.tar.gz: 4b58b609c8c60043fce92b276c0a4eae5fc4649ef2c8e0192000d25e4fbbdc01
 SHA512:
-  metadata.gz: 2bef2f8db640cea542bf432b387d005cb571c684a20692766a8ea616d0ca92c995cb61936c0226ba3055a319b0b776e1afd297e475930b3685e6bb5e1d9e83d4
-  data.tar.gz: 115dce1ae49277fca57e56b694dc96e5e1127d7e4918e021e71c7f8894dc4352b3502917e528c6c09fe305484e27947031a8334fd923cae156ecc7126d142adf
+  metadata.gz: 1fbf801b604bfb6288be8b6300e0aae13588a5faff0e03f165e09d2748653570a3fa0c1932cbfcfc8438e292c561f9525ea9b3459239695dea5f7ba4584294ff
+  data.tar.gz: 40c710475a69b523b18fb792deef53526da51e61eb7c2ad7861f691b3fd2899e23ec3a1e40025539395e9db77d2391b99c36d5847b0fc3a0caa2e76188dd8fa7

data/README.md

@@ -1,8 +1,6 @@
 # GherkinChecker
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gherkin_checker`. To experiment with that code, run `bin/console` for an interactive prompt.
+.feature file checker
 
 ## Installation
 

data/exe/gherkin_checker

@@ -7,13 +7,5 @@ require "gherkin_checker"
 checker = GherkinChecker::Checker.new("gherkin_checker.yml")
 
 # Run the check and print the results
-errors = checker.check_feature_files
+checker.check_feature_files
 
-if errors.empty?
-  puts "All scenarios have the required tags."
-else
-  puts "The following scenarios have the required tags:"
-  errors.each do |error|
-    puts "#{error[:file]}: Line #{error[:line]} - #{error[:character]}"
-  end
-end

data/lib/gherkin_checker/version.rb

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

data/lib/gherkin_checker.rb

@@ -2,6 +2,7 @@
 
 require "find"
 require "yaml"
+require "set"
 
 require_relative "gherkin_checker/version"
 
@@ -9,22 +10,26 @@ module GherkinChecker
   # Checker class
   class Checker
     def initialize(config_file = "gherkin_checker.yml")
-      puts config_file.inspect
-      system("ls -l")
-      system("cat #{config_file}")
-
       unless File.exist?(config_file)
-        puts "Error: Configuration file #{config_file} not found."
+        log_message("Error: Configuration file #{config_file} not found.", level: :error)
         exit(1) # Exit with a status of 1 to indicate an error
       end
 
       @config = YAML.load_file(config_file)
-      @feature_files_path = @config["feature_files_path"] || "./features"
-      @one_of_tag_groups = @config.dig("mandatory_tags", "one_of")
-      @must_be_tags = @config.dig("mandatory_tags", "must_be")
+      if @config
+        @skip_check = false
+      else
+        log_message("Warning: The gherkin_checker.yml not define", level: :warn)
+        @skip_check = true
+      end
+
+      @feature_files_path = @config&.key?("feature_files_path") ? @config.fetch("feature_files_path") : "./features"
+      @one_of_tags = @config.dig("mandatory_tags", "one_of") if @config
+      @must_be_tags = @config.dig("mandatory_tags", "must_be") if @config
 
-      puts @one_of_tag_groups.inspect
-      puts @must_be_tags.inspect
+      # Flags to ensure warnings are only printed once
+      @one_of_tags_warning_shown = false
+      @must_be_tags_warning_shown = false
     end
 
     def check_feature_files
@@ -32,42 +37,171 @@ module GherkinChecker
       Find.find(@feature_files_path) do |file|
         next unless File.extname(file) == ".feature"
 
-        lines = File.readlines(file)
-        lines.each_with_index do |line, index|
-          next unless line.strip.start_with?("Scenario", "Scenario Outline")
+        errors += check_one_of_tags(file)
+        errors += check_must_be_tags(file)
+      end
+
+      report_errors(errors)
+    end
 
-          puts scenario_valid?(lines, index)
+    private
 
-          next if scenario_valid?(lines, index)
+    def check_one_of_tags(file)
+      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]
+        file_line = data[:file_line]
+        scenario = data[:scenario]
+
+        if is_tags_nil
           errors << {
-            file: file,
-            line: index + 1,
-            scenario: line.strip
+            check: :one_of_tags,
+            file_line: file_line,
+            scenario: scenario,
+            tags: tags
           }
         end
+
+        next if is_tags_nil
+
+        next if @one_of_tags.any? { |tag| tags.include?(tag) }
+
+        errors << {
+          check: :one_of_tags,
+          file_line: file_line,
+          scenario: scenario,
+          tags: tags
+        }
       end
+
       errors
     end
 
-    private
+    def check_must_be_tags(file)
+      return log_must_be_tags_warning if @must_be_tags.nil?
 
-    def scenario_valid?(lines, index)
-      one_of_tags?(lines, index) && must_be_tags?(lines, index)
+      errors = []
+      extract_scenarios_with_tags(file).each do |data|
+        is_tags_nil = data[:tags].nil?
+        tags = data[:tags]
+        file_line = data[:file_line]
+        scenario = data[:scenario]
+
+        if is_tags_nil
+          errors << {
+            check: :must_be_tags,
+            file_line: file_line,
+            scenario: scenario,
+            tags: tags
+          }
+        end
+
+        next if is_tags_nil
+
+        next if @must_be_tags.all? { |item| tags.include?(item) }
+
+        errors << {
+          check: :must_be_tags,
+          file_line: file_line,
+          scenario: scenario,
+          tags: tags
+        }
+      end
+
+      errors
+    end
+
+    def log_one_of_tags_warning
+      return [] if @one_of_tags_warning_shown
+
+      log_message("Warning: Optional tags not set in 'gherkin_checker.yml'.", level: :warn) unless @skip_check
+      @one_of_tags_warning_shown = true
+      [] # Return an empty array to maintain consistency
     end
 
-    def one_of_tags?(lines, start_line)
-      return false if @one_of_tag_groups.nil?
+    def log_must_be_tags_warning
+      return [] if @must_be_tags_warning_shown
 
-      @one_of_tag_groups.all? do |tag_group|
-        tag_group.any? { |tag| lines[0...start_line].reverse.any? { |line| line.include?(tag) } }
+      log_message("Warning: Mandatory tags not set in 'gherkin_checker.yml'.", level: :warn) unless @skip_check
+      @must_be_tags_warning_shown = true
+      [] # Return an empty array to maintain consistency
+    end
+
+    def report_errors(errors)
+      if errors.empty?
+        if @skip_check
+          log_message("Skip gherkin checking", level: :warn)
+        else
+          log_message("All scenarios have the required tags.")
+        end
+      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)
+        end
       end
     end
 
-    def must_be_tags?(lines, start_line)
-      return false if @must_be_tags.nil?
+    # Define a method to log messages with different levels
+    def log_message(message, level: :info)
+      # Define color codes
+      colors = {
+        debug: "\e[36m", # Cyan
+        info: "\e[32m", # Green
+        warn: "\e[33m", # Yellow
+        error: "\e[31m", # Red
+        fatal: "\e[35m", # Magenta
+        reset: "\e[0m" # Reset to default color
+      }
+
+      color = colors[level] || colors[:reset]
+
+      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
+          }
+          current_tags = [] # Reset tags for next scenario
+        end
+      end
 
-      @must_be_tags.all? { |tag| lines[0...start_line].reverse.any? { |line| line.include?(tag) } }
+      scenarios
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gherkin_checker
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Dikakoko
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-02 00:00:00.000000000 Z
+date: 2024-11-04 00:00:00.000000000 Z
 dependencies: []
 description: Checking .feature files
 email:
@@ -22,7 +22,7 @@ files:
 - exe/gherkin_checker
 - lib/gherkin_checker.rb
 - lib/gherkin_checker/version.rb
-homepage: https://github.com/yourusername/feature_tag_checker
+homepage: https://github.com/dikako/gherkin_checker
 licenses:
 - MIT
 metadata:
@@ -45,5 +45,5 @@ requirements: []
 rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
-summary: A gem to validate mandatory tags in .feature files
+summary: ".feature files checkers"
 test_files: []