judges 0.17.0 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fde2252d089419bf5cb20dabc6368db3b70b7a7e6fb116624b3ec2f04811544
-  data.tar.gz: 80accd532717b42f176b2bcfc9510610e1dc43d9396ed670196782b923ef2c70
+  metadata.gz: 8830243b63e62d966d91e5d59b768039df5da4441d83b1ba0c89fb920a782d36
+  data.tar.gz: 9f4fbc2cbe61760e6931f193cb92dd2fd764953ed7598c004476ed29de0e2e94
 SHA512:
-  metadata.gz: 3bbdd338bea78fe3d8890b7f581d80081828e3391b738fdbf7a507751f5fab1897764e13dea952ecb5fa2c210c2baa577fb72b1b4d5b6e3994aec49d78eea1b4
-  data.tar.gz: 1e514af2b34b531fbdc70337d3183aeb54d47f8127cda4145ce735724dc7a029e237e09b3c445876c413c1e3c0c660015c648bceef20661fb8b430e00d739692
+  metadata.gz: 1843faa46e6a55657226e8a34d32242e069bff03325330ca48ec6026ecefe792781f2647dce0c1fe3c0f21e9e139f23e32d0402ddc8a9b2045b12e8edac0c570
+  data.tar.gz: e94b241263ce9b6fd1891312b38359481567ea9568fe76c0143d6680a8f4cab231ee46adc0ebca0c0b2a193c01a38991a74c874cab0798c47b5d38b23ada96b7

data/.github/workflows/copyrights.yml

@@ -27,4 +27,4 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v4
-      - uses: yegor256/copyrights-action@0.0.4
+      - uses: yegor256/copyrights-action@0.0.5

data/.rubocop.yml

@@ -28,6 +28,8 @@ AllCops:
   SuggestExtensions: false
   NewCops: enable
 
+Metrics/ParameterLists:
+  Enabled: false
 Style/GlobalVars:
   Enabled: false
 Metrics/MethodLength:

data/Gemfile

@@ -25,6 +25,7 @@ gemspec
 
 gem 'cucumber', '9.2.0', require: false
 gem 'minitest', '5.24.1', require: false
+gem 'minitest-reporters', '1.7.1', require: false
 gem 'net-ping', '2.0.8', require: false
 gem 'rake', '13.2.1', require: false
 gem 'random-port', '~>0.0', require: false

data/Gemfile.lock

@@ -46,6 +46,7 @@ GEM
       tzinfo (~> 2.0)
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
+    ansi (1.5.0)
     ast (2.4.2)
     backtrace (0.4.0)
     base64 (0.2.0)
@@ -122,6 +123,11 @@ GEM
     loog (0.5.2)
     mini_mime (1.1.5)
     minitest (5.24.1)
+    minitest-reporters (1.7.1)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
     moments (0.3.0)
     multi_test (1.1.0)
     mutex_m (0.2.0)
@@ -174,7 +180,7 @@ GEM
       zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.2.1)
-    random-port (0.7.0)
+    random-port (0.7.1)
     rdoc (6.7.0)
       psych (>= 4.0.0)
     regexp_parser (2.9.2)
@@ -261,6 +267,7 @@ DEPENDENCIES
   cucumber (= 9.2.0)
   judges!
   minitest (= 5.24.1)
+  minitest-reporters (= 1.7.1)
   net-ping (= 2.0.8)
   rake (= 13.2.1)
   random-port (~> 0.0)

data/README.md

@@ -34,6 +34,8 @@ global variables available to it:
 Every `.yml` file must be formatted as such:
 
 ```yaml
+before:
+  - abc
 category: slow
 runs: 1
 skip: false
@@ -60,6 +62,9 @@ which then may be turned on via the `--category` command line flag.
 The `runs` (default: `1`) is the number of times the `.rb` script should
 be executed. After each execution, all expected XPath expressions are validated.
 
+The `before` (default: `[]`) is a list of judges that must be executed before
+the current one.
+
 ## How to contribute
 
 Read

data/features/test.feature

@@ -118,3 +118,26 @@ Feature: Test
     Then I run bin/judges with "test --enable bad mine"
     Then Stdout contains "Testing mine/bad/bad.yml"
     And Exit code is not zero
+
+  Scenario: Test with a pre-condition
+    Given I make a temp directory
+    Then I have a "mine/first/first.rb" file with content:
+    """
+    n = $fb.insert
+    n.foo = 42
+    """
+    Then I have a "mine/second/second.rb" file with content:
+    """
+    n = $fb.insert
+    n.foo = 55
+    """
+    Then I have a "mine/second/second.yml" file with content:
+    """
+    ---
+    before:
+      - first
+    expected:
+      - /fb[count(f)=2]
+    """
+    Then I run bin/judges with "test mine"
+    And Exit code is zero

data/judges.gemspec

@@ -26,7 +26,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.17.0'
+  s.version = '0.18.1'
   s.license = 'MIT'
   s.summary = 'Command-Line Tool for a Factbase'
   s.description =

data/lib/judges/baza.rb

@@ -28,14 +28,17 @@ require 'base64'
 require_relative '../judges'
 require_relative '../judges/elapsed'
 
-# Baza.
+# Interface to the API of zerocracy.com.
+#
+# You make an instance of this class and then call one of its methods.
+# The object will make HTTP request to www.zerocracy.com and interpret the
+# results returned.
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 class Judges::Baza
-  # rubocop:disable Metrics/ParameterLists
   def initialize(host, port, token, ssl: true, timeout: 30, retries: 3, loog: Loog::NULL)
-    # rubocop:enable Metrics/ParameterLists
     @host = host
     @port = port
     @ssl = ssl
@@ -45,6 +48,11 @@ class Judges::Baza
     @retries = retries
   end
 
+  # Push factbase to the server.
+  # @param [String] name The name of the job on the server
+  # @param [Bytes] data The data to push to the server (binary)
+  # @param [Array<String>] meta List of metas, possibly empty
+  # @return [Integer] Job ID on the server
   def push(name, data, meta)
     id = 0
     hdrs = headers.merge(
@@ -72,6 +80,9 @@ class Judges::Baza
     id
   end
 
+  # Pull factbase from the server.
+  # @param [Integer] id The ID of the job on the server
+  # @return [Bytes] Binary data pulled
   def pull(id)
     data = 0
     elapsed(@loog) do
@@ -101,6 +112,8 @@ class Judges::Baza
   end
 
   # The job with this ID is finished already?
+  # @param [Integer] id The ID of the job on the server
+  # @return [Boolean] TRUE if the job is already finished
   def finished?(id)
     finished = false
     elapsed(@loog) do
@@ -119,6 +132,8 @@ class Judges::Baza
   end
 
   # Lock the name.
+  # @param [String] name The name of the job on the server
+  # @param [String] owner The owner of the lock (any string)
   def lock(name, owner)
     elapsed(@loog) do
       with_retries(max_tries: @retries) do
@@ -134,6 +149,8 @@ class Judges::Baza
   end
 
   # Unlock the name.
+  # @param [String] name The name of the job on the server
+  # @param [String] owner The owner of the lock (any string)
   def unlock(name, owner)
     elapsed(@loog) do
       with_retries(max_tries: @retries) do
@@ -148,6 +165,9 @@ class Judges::Baza
     end
   end
 
+  # Get the ID of the job by the name.
+  # @param [String] name The name of the job on the server
+  # @return [Integer] The ID of the job on the server
   def recent(name)
     job = 0
     elapsed(@loog) do
@@ -165,6 +185,9 @@ class Judges::Baza
     job
   end
 
+  # Check whether the name of the job exists on the server.
+  # @param [String] name The name of the job on the server
+  # @return [Boolean] TRUE if such name exists
   def name_exists?(name)
     exists = 0
     elapsed(@loog) do
@@ -225,6 +248,8 @@ class Judges::Baza
       msg +=
         ', most probably you are trying to reach a wrong server, which doesn\'t ' \
         'have the URL that it is expected to have'
+    when 0
+      msg += ', most likely an internal error'
     end
     raise msg
   end

data/lib/judges/commands/eval.rb

@@ -25,7 +25,11 @@ require_relative '../../judges'
 require_relative '../../judges/impex'
 require_relative '../../judges/elapsed'
 
-# Eval.
+# The +eval+ command.
+#
+# This class is instantiated by the +bin/judge+ command line interface. You
+# are not supposed to instantiate it yourself.
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT

data/lib/judges/commands/import.rb

@@ -27,7 +27,11 @@ require_relative '../../judges/impex'
 require_relative '../../judges/to_rel'
 require_relative '../../judges/elapsed'
 
-# Import.
+# The +import+ command.
+#
+# This class is instantiated by the +bin/judge+ command line interface. You
+# are not supposed to instantiate it yourself.
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT

data/lib/judges/commands/inspect.rb

@@ -23,7 +23,11 @@
 require_relative '../../judges'
 require_relative '../../judges/impex'
 
-# Inspect.
+# The +inspect+ command.
+#
+# This class is instantiated by the +bin/judge+ command line interface. You
+# are not supposed to instantiate it yourself.
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT

data/lib/judges/commands/join.rb

@@ -24,7 +24,11 @@ require_relative '../../judges'
 require_relative '../../judges/impex'
 require_relative '../../judges/elapsed'
 
-# Join.
+# The +join+ command.
+#
+# This class is instantiated by the +bin/judge+ command line interface. You
+# are not supposed to instantiate it yourself.
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT

data/lib/judges/commands/print.rb

@@ -28,7 +28,11 @@ require_relative '../../judges'
 require_relative '../../judges/impex'
 require_relative '../../judges/elapsed'
 
-# Update.
+# The +print+ command.
+#
+# This class is instantiated by the +bin/judge+ command line interface. You
+# are not supposed to instantiate it yourself.
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT

data/lib/judges/commands/pull.rb

@@ -26,7 +26,11 @@ require_relative '../../judges'
 require_relative '../../judges/impex'
 require_relative '../../judges/baza'
 
-# Pull.
+# The +pull+ command.
+#
+# This class is instantiated by the +bin/judge+ command line interface. You
+# are not supposed to instantiate it yourself.
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
@@ -49,7 +53,7 @@ class Judges::Pull
     elapsed(@loog) do
       if baza.name_exists?(name)
         baza.lock(name, opts['owner'])
-        fb.import(baza.pull(wait(baza, baza.recent(name), opts['wait'])))
+        fb.import(baza.pull(wait(name, baza, baza.recent(name), opts['wait'])))
         Judges::Impex.new(@loog, args[1]).export(fb)
         throw :"Pulled #{fb.size} facts by the name '#{name}'"
       else
@@ -60,14 +64,15 @@ class Judges::Pull
 
   private
 
-  def wait(baza, id, limit)
+  def wait(name, baza, id, limit)
     raise 'Waiting time is nil' if limit.nil?
     start = Time.now
     loop do
       break if baza.finished?(id)
       sleep 1
-      raise 'Time is over, the job is still not finished' if Time.now - start > limit
-      @loog.debug("Still waiting for the job ##{id} to finish... (#{format('%.2f', Time.now - start)}s already)")
+      raise "Time is over, the job ##{id} ('#{name}') is still not finished" if Time.now - start > limit
+      lapsed = Time.now - start
+      @loog.debug("Still waiting for the job ##{id} ('#{name}') to finish... (#{format('%.2f', lapsed)}s already)")
     end
     id
   end

data/lib/judges/commands/push.rb

@@ -26,7 +26,11 @@ require_relative '../../judges'
 require_relative '../../judges/impex'
 require_relative '../../judges/baza'
 
-# Push.
+# The +push+ command.
+#
+# This class is instantiated by the +bin/judge+ command line interface. You
+# are not supposed to instantiate it yourself.
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT

data/lib/judges/commands/test.rb

@@ -32,7 +32,11 @@ require_relative '../../judges/options'
 require_relative '../../judges/categories'
 require_relative '../../judges/elapsed'
 
-# Test.
+# The +test+ command.
+#
+# This class is instantiated by the +bin/judge+ command line interface. You
+# are not supposed to instantiate it yourself.
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
@@ -46,18 +50,19 @@ class Judges::Test
     dir = args[0]
     @loog.info("Testing judges in #{dir.to_rel}...")
     errors = []
-    judges = 0
+    tested = 0
     tests = 0
     visible = []
+    judges = Judges::Judges.new(dir, opts['lib'], @loog)
     elapsed(@loog) do
-      Judges::Judges.new(dir, opts['lib'], @loog).each_with_index do |p, i|
-        visible << p.name
-        next unless include?(opts, p.name)
-        @loog.info("\n👉 Testing #{p.script} (##{i}) in #{p.dir.to_rel}...")
-        p.tests.each do |f|
+      judges.each_with_index do |judge, i|
+        visible << judge.name
+        next unless include?(opts, judge.name)
+        @loog.info("\n👉 Testing #{judge.script} (##{i}) in #{judge.dir.to_rel}...")
+        judge.tests.each do |f|
           tname = File.basename(f).gsub(/\.yml$/, '')
-          visible << "  #{p.name}/#{tname}"
-          next unless include?(opts, p.name, tname)
+          visible << "  #{judge.name}/#{tname}"
+          next unless include?(opts, judge.name, tname)
           yaml = YAML.load_file(f, permitted_classes: [Time])
           if yaml['skip']
             @loog.info("Skippped #{f.to_rel}")
@@ -69,25 +74,32 @@ class Judges::Test
           end
           @loog.info("🛠️ Testing #{f.to_rel}:")
           begin
-            test_one(opts, p, tname, yaml)
+            fb = Factbase.new
+            prepare(fb, yaml)
+            yaml['before']&.each do |n|
+              j = judges.get(n)
+              @loog.info("Running #{j.script} judge as a pre-condition...")
+              test_one(fb, opts, j, n, yaml, assert: false)
+            end
+            test_one(fb, opts, judge, tname, yaml)
             tests += 1
           rescue StandardError => e
             @loog.warn(Backtrace.new(e))
             errors << f
           end
         end
-        judges += 1
+        tested += 1
       end
-      throw :'👍 No judges tested' if judges.zero?
-      throw :"👍 All #{judges} judge(s) but no tests passed" if tests.zero?
-      throw :"👍 All #{judges} judge(s) and #{tests} tests passed" if errors.empty?
-      throw :"❌ #{judges} judge(s) tested, #{errors.size} of them failed"
+      throw :'👍 No judges tested' if tested.zero?
+      throw :"👍 All #{tested} judge(s) but no tests passed" if tests.zero?
+      throw :"👍 All #{tested} judge(s) and #{tests} tests passed" if errors.empty?
+      throw :"❌ #{tested} judge(s) tested, #{errors.size} of them failed"
     end
     unless errors.empty?
       raise "#{errors.size} tests failed" unless opts['quiet']
       @loog.debug('Not failing the build with tests failures, due to the --quiet option')
     end
-    return unless judges.zero? || tests.zero?
+    return unless tested.zero? || tests.zero?
     if opts['judge'].nil?
       raise 'There are seems to be no judges' unless opts['quiet']
       @loog.debug('Not failing the build with no judges tested, due to the --quiet option')
@@ -106,8 +118,7 @@ class Judges::Test
     judges.any? { |n| n.match?(%r{^#{name}(/#{tre})?$}) }
   end
 
-  def test_one(opts, judge, tname, yaml)
-    fb = Factbase.new
+  def prepare(fb, yaml)
     inputs = yaml['input']
     inputs&.each do |i|
       f = fb.insert
@@ -121,12 +132,16 @@ class Judges::Test
         end
       end
     end
+  end
+
+  def test_one(fb, opts, judge, tname, yaml, assert: true)
     options = Judges::Options.new(opts['option']) + Judges::Options.new(yaml['options'])
     runs = opts['runs'] || yaml['runs'] || 1
     (1..runs).each do |r|
       fbx = fb
       fbx = Factbase::Looged.new(fb, @loog) if opts['log']
       judge.run(fbx, {}, {}, options)
+      next unless assert
       assert(judge, tname, fb, yaml) if r == runs || opts['assert_once'].is_a?(FalseClass)
     end
   end

data/lib/judges/commands/trim.rb

@@ -25,7 +25,11 @@ require_relative '../../judges'
 require_relative '../../judges/impex'
 require_relative '../../judges/elapsed'
 
-# Trim.
+# The +trim+ command.
+#
+# This class is instantiated by the +bin/judge+ command line interface. You
+# are not supposed to instantiate it yourself.
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT

data/lib/judges/commands/update.rb

@@ -30,7 +30,11 @@ require_relative '../../judges/options'
 require_relative '../../judges/impex'
 require_relative '../../judges/elapsed'
 
-# Update.
+# The +update+ command.
+#
+# This class is instantiated by the +bin/judge+ command line interface. You
+# are not supposed to instantiate it yourself.
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT

data/lib/judges/judges.rb

@@ -34,8 +34,16 @@ class Judges::Judges
     @loog = loog
   end
 
+  # Get one judge by name.
+  # @return [Judge]
+  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)
+  end
+
   # Iterate over them all.
-  # @yield [Pack]
+  # @yield [Judge]
   def each
     Dir.glob(File.join(@dir, '**/*.rb')).each do |f|
       d = File.dirname(File.absolute_path(f))
@@ -44,7 +52,7 @@ class Judges::Judges
   end
 
   # Iterate over them all.
-  # @yield [(Pack, Integer)]
+  # @yield [(Judge, Integer)]
   def each_with_index
     idx = 0
     each do |p|

data/lib/judges.rb

@@ -25,5 +25,5 @@
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 module Judges
-  VERSION = '0.17.0'
+  VERSION = '0.18.1'
 end

data/test/commands/test_test.rb

@@ -88,6 +88,32 @@ class TestTest < Minitest::Test
     end
   end
 
+  def test_with_before
+    Dir.mktmpdir do |d|
+      home = File.join(d, 'judges')
+      FileUtils.mkdir_p(File.join(home, 'first'))
+      File.write(File.join(d, 'judges/first/the-first.rb'), 'x = $fb.size; $fb.insert.foo = x')
+      FileUtils.mkdir_p(File.join(home, 'second'))
+      File.write(File.join(d, 'judges/second/the-second.rb'), '$fb.insert.bar = 55')
+      File.write(
+        File.join(d, 'judges/second/something.yml'),
+        <<-YAML
+        input:
+          -
+            hi: 42
+        before:
+          - first
+        expected:
+          - /fb[count(f)=3]
+          - /fb/f[hi=42]
+          - /fb/f[foo=1]
+          - /fb/f[bar=55]
+        YAML
+      )
+      Judges::Test.new(Loog::NULL).run({}, [home])
+    end
+  end
+
   def test_one_judge_negative
     Dir.mktmpdir do |d|
       File.write(File.join(d, 'foo.rb'), '')

data/test/test__helper.rb

@@ -29,3 +29,6 @@ require 'simplecov-cobertura'
 SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
 
 require 'minitest/autorun'
+
+require 'minitest/reporters'
+Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new]

data/test/test_judges.rb

@@ -30,7 +30,7 @@ require_relative '../lib/judges/judges'
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
-class TestPacks < Minitest::Test
+class TestJudges < Minitest::Test
   def test_basic
     Dir.mktmpdir do |d|
       File.write(File.join(d, 'foo.rb'), 'hey')
@@ -44,4 +44,14 @@ class TestPacks < Minitest::Test
       assert_equal(1, found)
     end
   end
+
+  def test_get_one
+    Dir.mktmpdir do |d|
+      f = File.join(d, 'boo/foo.rb')
+      FileUtils.mkdir_p(File.dirname(f))
+      File.write(f, 'hey')
+      j = Judges::Judges.new(d, nil, Loog::NULL).get('boo')
+      assert_equal('foo.rb', j.script)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: judges
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.1
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-12 00:00:00.000000000 Z
+date: 2024-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace