judges 0.18.0 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01de840b5ca098985b5b4cbdc1ea16d96237d3bbed4617971662f5628fad46bf
-  data.tar.gz: e502a04924b0186921fbbc2026e4f7d78eed0ee47ec2f6cdfcfb01c65e092050
+  metadata.gz: 8830243b63e62d966d91e5d59b768039df5da4441d83b1ba0c89fb920a782d36
+  data.tar.gz: 9f4fbc2cbe61760e6931f193cb92dd2fd764953ed7598c004476ed29de0e2e94
 SHA512:
-  metadata.gz: 38e602fda2bc3a1cce738e1633094d7dc0bc8a50fb43ff97e1e28d4da36752bbdb56fac51f98a2cec884b7a3245b701566c7500d817f4a242fbfb0c28cd9b62d
-  data.tar.gz: d9d5761f6384e7898da2cbab0b39a659d22f91a1af61a834f52c038f0162b8ebf08f576a8ea846b9a3818fb5f822c6d018552478d979365fa0226955f7cdc5d3
+  metadata.gz: 1843faa46e6a55657226e8a34d32242e069bff03325330ca48ec6026ecefe792781f2647dce0c1fe3c0f21e9e139f23e32d0402ddc8a9b2045b12e8edac0c570
+  data.tar.gz: e94b241263ce9b6fd1891312b38359481567ea9568fe76c0143d6680a8f4cab231ee46adc0ebca0c0b2a193c01a38991a74c874cab0798c47b5d38b23ada96b7

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.18.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,7 +28,12 @@ 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
@@ -43,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(
@@ -70,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
@@ -99,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
@@ -117,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
@@ -132,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
@@ -146,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
@@ -163,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

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

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
@@ -71,6 +75,7 @@ class Judges::Test
           @loog.info("🛠️ Testing #{f.to_rel}:")
           begin
             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...")
@@ -113,7 +118,7 @@ class Judges::Test
     judges.any? { |n| n.match?(%r{^#{name}(/#{tre})?$}) }
   end
 
-  def test_one(fb, opts, judge, tname, yaml, assert: true)
+  def prepare(fb, yaml)
     inputs = yaml['input']
     inputs&.each do |i|
       f = fb.insert
@@ -127,6 +132,9 @@ 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|

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.rb

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

data/test/commands/test_test.rb

@@ -92,25 +92,22 @@ class TestTest < Minitest::Test
     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'), '$fb.insert.foo = 42')
+      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.foo = 55')
-      File.write(
-        File.join(d, 'judges/first/something.yml'),
-        <<-YAML
-        input: []
-        expected:
-          - /fb[count(f)=1]
-        YAML
-      )
+      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: []
+        input:
+          -
+            hi: 42
         before:
           - first
         expected:
-          - /fb[count(f)=2]
+          - /fb[count(f)=3]
+          - /fb/f[hi=42]
+          - /fb/f[foo=1]
+          - /fb/f[bar=55]
         YAML
       )
       Judges::Test.new(Loog::NULL).run({}, [home])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: judges
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.18.1
 platform: ruby
 authors:
 - Yegor Bugayenko