judges 0.42.0 → 0.42.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af0d2479c169453b9879f770a4dffbe7530f15665941200658d9255490a36db8
-  data.tar.gz: 99aa6fe32517235bae4c0a8841658e40cf41d589b75bf1da1f160c12a27a5452
+  metadata.gz: '08d3de03e1b95604d047cef9fc57b854df50472735347fa9eefdb760ade40b2f'
+  data.tar.gz: cfabae3261cdbbfe3a0960f30bde15705c2934f9acbba96032832fb88b1e69d1
 SHA512:
-  metadata.gz: 339dd1173c591e66b517c1665fef77e9c279f9286364abc964ef725275857f90d973cdedf7895da3ba25b48a07e1d71a532b0d7dd193f967490a67c9263c19a5
-  data.tar.gz: 24b25cd92ef031e7459aa5c12f77a4ac88359795a58c878d387840e5ce94f4a011f624db305104c95a867c7397b6fb0c17e6fede0d9ccacfbdc71637cc583cd7
+  metadata.gz: 83c656135bbaae9ee295b8022ec3a6105fb2be8f9fecbac23cb28c1402d72260ae03872eb887fbe1224a989e7bf41512724b01d3687a9c78673757ded36927f3
+  data.tar.gz: 11df07fc1c6049286aaac01f7af3c3fe6dc75cad176b3907dd2cb006f7ecc9936ea49b43949143874e42a7590fbc08662eec4f8013b792e808ee0be6736923da

data/.github/workflows/typos.yml

@@ -0,0 +1,19 @@
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+---
+# yamllint disable rule:line-length
+name: typos
+'on':
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  typos:
+    timeout-minutes: 15
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: crate-ci/typos@v1.32.0

data/.gitignore

@@ -1,8 +1,8 @@
-*.gem
-.DS_Store
 .bundle/
+.DS_Store
 .idea/
 .yardoc/
+*.gem
 coverage/
 doc/
 node_modules/

data/Gemfile.lock

@@ -73,14 +73,14 @@ GEM
     cucumber-tag-expressions (6.1.2)
     date (3.4.1)
     decoor (0.0.1)
-    diff-lcs (1.6.1)
+    diff-lcs (1.6.2)
     docile (1.4.1)
     elapsed (0.0.1)
       loog (> 0)
       tago (> 0)
     ethon (0.16.0)
       ffi (>= 1.15.0)
-    factbase (0.10.1)
+    factbase (0.10.2)
       backtrace (~> 0.4)
       decoor (~> 0.0)
       json (~> 2.7)
@@ -113,13 +113,14 @@ GEM
       ostruct
     hashdiff (1.1.2)
     iri (0.10.0)
-    json (2.11.3)
-    language_server-protocol (3.17.0.4)
+    json (2.12.0)
+    language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
-    loog (0.6.0)
+    loog (0.6.1)
+      logger (~> 1.0)
     mini_mime (1.1.5)
-    mini_portile2 (2.8.8)
+    mini_portile2 (2.8.9)
     minitest (5.25.5)
     minitest-reporters (1.7.1)
       ansi
@@ -157,11 +158,11 @@ GEM
       ast (~> 2.4.1)
       racc
     prism (1.4.0)
-    psych (5.2.3)
+    psych (5.2.6)
       date
       stringio
     public_suffix (6.0.2)
-    qbash (0.4.0)
+    qbash (0.4.5)
       backtrace (> 0)
       elapsed (> 0)
       loog (> 0)
@@ -176,7 +177,7 @@ GEM
     regexp_parser (2.10.0)
     retries (0.0.5)
     rexml (3.4.1)
-    rubocop (1.75.4)
+    rubocop (1.75.6)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)

data/README.md

@@ -12,7 +12,7 @@
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/judges/blob/master/LICENSE.txt)
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fyegor256%2Fjudges.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fyegor256%2Fjudges?ref=badge_shield&issueType=license)
 
-A command line tool and a Ruby gem for running so called judges against a
+A command line tool and a Ruby gem for running so-called judges against a
 [factbase](https://github.com/yegor256/factbase).
 
 Every "judge" is a directory with a single `.rb` file and a number
@@ -64,10 +64,10 @@ via the command line `--option` flag of the `update` command; and `expected` is
 an array of XPath expressions that must be present in the XML of the Factbase
 when the test is finished.
 
-The `category` (default: `[]`) may have one or an array of categories,
+The `category` (default: `[]`) may have one category or an array of categories,
 which then may be turned on via the `--category` command line flag.
 
-The `repeat` (default: `1`) makes `input` to be repeated multiple times
+The `repeat` (default: `1`) makes the `input` to be repeated multiple times
 (mostly useful for speed measuring on big data inputs).
 
 The `runs` (default: `1`) is the number of times the `.rb` script should

data/REUSE.toml

@@ -4,10 +4,17 @@
 version = 1
 [[annotations]]
 path = [
+    ".DS_Store",
+    ".gitattributes",
+    ".gitignore",
+    ".pdd",
     "**.json",
     "**.md",
     "**.png",
     "**.txt",
+    "**/.DS_Store",
+    "**/.gitignore",
+    "**/.pdd",
     "**/*.csv",
     "**/*.jpg",
     "**/*.json",
@@ -17,15 +24,8 @@ path = [
     "**/*.svg",
     "**/*.txt",
     "**/*.vm",
-    "**/.DS_Store",
-    "**/.gitignore",
-    "**/.pdd",
     "**/CNAME",
     "**/Gemfile.lock",
-    ".DS_Store",
-    ".gitattributes",
-    ".gitignore",
-    ".pdd",
     "Gemfile.lock",
     "README.md",
     "renovate.json",

data/features/test.feature

@@ -16,9 +16,9 @@ Feature: Test
     And Exit code is zero
 
   Scenario: Factbase version can be set
-    When I run bin/judges with "--factbase 0.10.1 --verbose test --judge guess ./fixtures"
+    When I run bin/judges with "--factbase 0.10.2 --verbose test --judge guess ./fixtures"
     Then Exit code is zero
-    And Stdout contains "Factbase version to be used: '0.10.1'"
+    And Stdout contains "Factbase version to be used: '0.10.2'"
 
   Scenario: Simple test of no judges
     Given I run bin/judges with "test --judge absent_for_sure ./fixtures"

data/judges.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
   s.required_ruby_version = '>=3.2'
   s.name = 'judges'
-  s.version = '0.42.0'
+  s.version = '0.42.1'
   s.license = 'MIT'
   s.summary = 'Command-Line Tool for a Factbase'
   s.description =

data/lib/judges/commands/eval.rb

@@ -16,10 +16,16 @@ require_relative '../../judges/impex'
 # Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
 # License:: MIT
 class Judges::Eval
+  # Initialize.
+  # @param [Loog] loog Logging facility
   def initialize(loog)
     @loog = loog
   end
 
+  # Run the eval command.
+  # @param [Hash] opts Command line options (start with '--')
+  # @param [Array] args List of command line arguments
+  # @raise [RuntimeError] If not exactly two arguments provided
   def run(opts, args)
     raise 'Exactly two arguments required' unless args.size == 2
     impex = Judges::Impex.new(@loog, args[0])

data/lib/judges/commands/import.rb

@@ -18,10 +18,16 @@ require_relative '../../judges/to_rel'
 # Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
 # License:: MIT
 class Judges::Import
+  # Initialize.
+  # @param [Loog] loog Logging facility
   def initialize(loog)
     @loog = loog
   end
 
+  # Run the import command.
+  # @param [Hash] opts Command line options (start with '--')
+  # @param [Array] args List of command line arguments
+  # @raise [RuntimeError] If not exactly two arguments provided or file not found
   def run(opts, args)
     raise 'Exactly two arguments required' unless args.size == 2
     raise "File not found #{args[0].to_rel}" unless File.exist?(args[0])

data/lib/judges/commands/inspect.rb

@@ -15,10 +15,16 @@ require_relative '../../judges/impex'
 # Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
 # License:: MIT
 class Judges::Inspect
+  # Initialize.
+  # @param [Loog] loog Logging facility
   def initialize(loog)
     @loog = loog
   end
 
+  # Run the inspect command.
+  # @param [Hash] _opts Command line options (not used)
+  # @param [Array] args List of command line arguments
+  # @raise [RuntimeError] If no arguments provided
   def run(_opts, args)
     raise 'At lease one argument required' if args.empty?
     fb = Judges::Impex.new(@loog, args[0]).import

data/lib/judges/commands/join.rb

@@ -16,10 +16,16 @@ require_relative '../../judges/impex'
 # Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
 # License:: MIT
 class Judges::Join
+  # Initialize.
+  # @param [Loog] loog Logging facility
   def initialize(loog)
     @loog = loog
   end
 
+  # Run the join command.
+  # @param [Hash] _opts Command line options (not used)
+  # @param [Array] args List of command line arguments
+  # @raise [RuntimeError] If not exactly two arguments provided
   def run(_opts, args)
     raise 'Exactly two arguments required' unless args.size == 2
     master = Judges::Impex.new(@loog, args[0])

data/lib/judges/commands/print.rb

@@ -23,6 +23,8 @@ require_relative '../../judges/impex'
 # Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
 # License:: MIT
 class Judges::Print
+  # Initialize.
+  # @param [Loog] loog Logging facility
   def initialize(loog)
     @loog = loog
   end

data/lib/judges/commands/pull.rb

@@ -19,6 +19,8 @@ require_relative '../../judges/impex'
 # Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
 # License:: MIT
 class Judges::Pull
+  # Initialize.
+  # @param [Loog] loog Logging facility
   def initialize(loog)
     @loog = loog
   end

data/lib/judges/commands/push.rb

@@ -19,6 +19,8 @@ require_relative '../../judges/impex'
 # Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
 # License:: MIT
 class Judges::Push
+  # Initialize.
+  # @param [Loog] loog Logging facility
   def initialize(loog)
     @loog = loog
   end

data/lib/judges/commands/test.rb

@@ -23,6 +23,8 @@ require_relative '../../judges/categories'
 # Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
 # License:: MIT
 class Judges::Test
+  # Initialize.
+  # @param [Loog] loog Logging facility
   def initialize(loog)
     @loog = loog
   end
@@ -51,11 +53,11 @@ class Judges::Test
           next unless include?(opts, judge.name, tname)
           yaml = YAML.load_file(f, permitted_classes: [Time])
           if yaml['skip']
-            @loog.info("Skippped #{f.to_rel}")
+            @loog.info("Skipped #{f.to_rel}")
             next
           end
           unless Judges::Categories.new(opts['enable'], opts['disable']).ok?(yaml['category'])
-            @loog.info("Skippped #{f.to_rel} because of its category")
+            @loog.info("Skipped #{f.to_rel} because of its category")
             next
           end
           @loog.info("🛠️ Testing #{f.to_rel}:")
@@ -122,8 +124,8 @@ class Judges::Test
   def include?(opts, name, tname = nil)
     judges = opts['judge'] || []
     return true if judges.empty?
-    tre = tname.nil? ? '.+' : tname
-    judges.any? { |n| n.match?(%r{^#{name}(/#{tre})?$}) }
+    re = tname.nil? ? '.+' : tname
+    judges.any? { |n| n.match?(%r{^#{name}(/#{re})?$}) }
   end
 
   def prepare(fb, yaml)

data/lib/judges/commands/trim.rb

@@ -17,6 +17,8 @@ require_relative '../../judges/impex'
 # Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
 # License:: MIT
 class Judges::Trim
+  # Initialize.
+  # @param [Loog] loog Logging facility
   def initialize(loog)
     @loog = loog
   end

data/lib/judges/commands/update.rb

@@ -26,6 +26,8 @@ require_relative '../../judges/to_rel'
 # Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
 # License:: MIT
 class Judges::Update
+  # Initialize.
+  # @param [Loog] loog Logging facility
   def initialize(loog)
     @loog = loog
     @start = Time.now
@@ -94,7 +96,7 @@ class Judges::Update
   # @param [Factbase] fb The factbase
   # @param [Churn] churn The churn
   # @param [Array<String>] errors List of errors
-  # @param [Time] start Whe we started
+  # @param [Time] start When we started
   # @param [Integer] cycles How many cycles
   def summarize(fb, churn, errors, start, cycles)
     before = fb.query('(eq what "judges-summary")').each.to_a

data/lib/judges/impex.rb

@@ -14,11 +14,17 @@ require_relative '../judges/to_rel'
 # Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
 # License:: MIT
 class Judges::Impex
+  # Initialize.
+  # @param [Loog] loog Logging facility
+  # @param [String] file File path for import/export operations
   def initialize(loog, file)
     @loog = loog
     @file = file
   end
 
+  # Import factbase from file.
+  # @param [Boolean] strict Whether to raise error if file doesn't exist
+  # @return [Factbase] The imported factbase
   def import(strict: true)
     fb = Factbase.new
     if File.exist?(@file)
@@ -33,6 +39,9 @@ class Judges::Impex
     fb
   end
 
+  # Import factbase from file into existing factbase.
+  # @param [Factbase] fb The factbase to import into
+  # @raise [RuntimeError] If file doesn't exist
   def import_to(fb)
     raise "The factbase is absent at #{@file.to_rel}" unless File.exist?(@file)
     elapsed(@loog, level: Logger::INFO) do
@@ -41,6 +50,8 @@ class Judges::Impex
     end
   end
 
+  # Export factbase to file.
+  # @param [Factbase] fb The factbase to export
   def export(fb)
     elapsed(@loog, level: Logger::INFO) do
       FileUtils.mkdir_p(File.dirname(@file))

data/lib/judges/judges.rb

@@ -26,6 +26,13 @@ require_relative 'judge'
 # Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
 # License:: MIT
 class Judges::Judges
+  # Initialize.
+  # @param [String] dir Directory containing judges
+  # @param [String] lib Library directory
+  # @param [Loog] loog Logging facility
+  # @param [Time] start Start time
+  # @param [String] shuffle Prefix for names of judges to shuffle
+  # @param [Array<String>] boost Names of judges to boost in priority
   def initialize(dir, lib, loog, start: Time.now, shuffle: '', boost: [])
     @dir = dir
     @lib = lib
@@ -36,15 +43,18 @@ class Judges::Judges
   end
 
   # Get one judge by name.
-  # @return [Judge]
+  # @param [String] name The name of the judge
+  # @return [Judge] The judge object
+  # @raise [RuntimeError] If judge doesn't exist
   def get(name)
     d = File.absolute_path(File.join(@dir, name))
     raise "Judge #{name} doesn't exist in #{@dir}" unless File.exist?(d)
     Judges::Judge.new(d, @lib, @loog, start: @start)
   end
 
-  # Iterate over them all.
-  # @yield [Judge]
+  # Iterate over all judges.
+  # @yield [Judge] Yields each judge
+  # @return [Enumerator] If no block given
   def each(&)
     return to_enum(__method__) unless block_given?
     list =
@@ -77,8 +87,9 @@ class Judges::Judges
     ret.each(&)
   end
 
-  # Iterate over them all, with an index.
-  # @yield [(Judge, Integer)]
+  # Iterate over all judges with index.
+  # @yield [Judge, Integer] Yields each judge with its index
+  # @return [Integer] The total count of judges
   def each_with_index
     idx = 0
     each do |p|

data/lib/judges/options.rb

@@ -17,10 +17,15 @@ class Judges::Options
     @pairs = pairs
   end
 
+  # Check if options are empty.
+  # @return [Boolean] true if no options are set
   def empty?
     to_h.empty?
   end
 
+  # Merge with another Options object.
+  # @param [Judges::Options] other The other options to merge
+  # @return [Judges::Options] A new Options object with merged values
   def +(other)
     h = to_h
     other.to_h.each do |k, v|
@@ -38,6 +43,8 @@ class Judges::Options
     end.sort.join("\n")
   end
 
+  # Convert options to hash.
+  # @return [Hash] The options as a hash with symbol keys
   def to_h
     @to_h ||=
       begin

data/lib/judges/to_rel.rb

@@ -11,6 +11,7 @@ require 'pathname'
 # License:: MIT
 class Object
   # Generates a relative name of a file (to the current dir).
+  # @return [String] Relative path to the file with optional quotes if it contains spaces
   def to_rel
     s = File.absolute_path(to_s)
     p = Pathname.new(s).relative_path_from(Dir.getwd)

data/lib/judges.rb

@@ -8,5 +8,5 @@
 # Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
 # License:: MIT
 module Judges
-  VERSION = '0.42.0' unless const_defined?(:VERSION)
+  VERSION = '0.42.1' unless const_defined?(:VERSION)
 end