gherkin_checker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4711b2c3890a6a9afec7106533d5aa5819b7ace4c99e449a00584a7573083ee1
+  data.tar.gz: 113c6415dd7d8b49ebc7549ad27c5eeb441872aa7b7d736f9a2bd015a73ca578
+SHA512:
+  metadata.gz: 2bef2f8db640cea542bf432b387d005cb571c684a20692766a8ea616d0ca92c995cb61936c0226ba3055a319b0b776e1afd297e475930b3685e6bb5e1d9e83d4
+  data.tar.gz: 115dce1ae49277fca57e56b694dc96e5e1127d7e4918e021e71c7f8894dc4352b3502917e528c6c09fe305484e27947031a8334fd923cae156ecc7126d142adf

data/README.md

@@ -0,0 +1,39 @@
+# 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.
+
+## 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 to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GherkinChecker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/gherkin_checker/blob/main/CODE_OF_CONDUCT.md).

data/exe/gherkin_checker

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "gherkin_checker"
+
+# Initialize the checker with default config or custom path if provided
+checker = GherkinChecker::Checker.new("gherkin_checker.yml")
+
+# Run the check and print the results
+errors = 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

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

data/lib/gherkin_checker.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "find"
+require "yaml"
+
+require_relative "gherkin_checker/version"
+
+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."
+        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")
+
+      puts @one_of_tag_groups.inspect
+      puts @must_be_tags.inspect
+    end
+
+    def check_feature_files
+      errors = []
+      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")
+
+          puts scenario_valid?(lines, index)
+
+          next if scenario_valid?(lines, index)
+
+          errors << {
+            file: file,
+            line: index + 1,
+            scenario: line.strip
+          }
+        end
+      end
+      errors
+    end
+
+    private
+
+    def scenario_valid?(lines, index)
+      one_of_tags?(lines, index) && must_be_tags?(lines, index)
+    end
+
+    def one_of_tags?(lines, start_line)
+      return false if @one_of_tag_groups.nil?
+
+      @one_of_tag_groups.all? do |tag_group|
+        tag_group.any? { |tag| lines[0...start_line].reverse.any? { |line| line.include?(tag) } }
+      end
+    end
+
+    def must_be_tags?(lines, start_line)
+      return false if @must_be_tags.nil?
+
+      @must_be_tags.all? { |tag| lines[0...start_line].reverse.any? { |line| line.include?(tag) } }
+    end
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: gherkin_checker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dikakoko
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-02 00:00:00.000000000 Z
+dependencies: []
+description: Checking .feature files
+email:
+- dikakoko@icloud.com
+executables:
+- gherkin_checker
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- exe/gherkin_checker
+- lib/gherkin_checker.rb
+- lib/gherkin_checker/version.rb
+homepage: https://github.com/yourusername/feature_tag_checker
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: A gem to validate mandatory tags in .feature files
+test_files: []