judges 0.20.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1661542d2bb953029d98b55aee247ee5067488e67e7fa4debd8a35d7278bce55
-  data.tar.gz: 79803f9f17983970b404abd8c8619e08ad3d5587156f4cedd477f295c98ab2bb
+  metadata.gz: 17df0b6c88dd19b576bc701737985db26986e9818eb3c87b36180be92fca54f6
+  data.tar.gz: 48ef9ea5656a6bd78264f0b1f7021555ffa92eaf5be71d311d60e59ab0d3c0c8
 SHA512:
-  metadata.gz: 60bc48ba4d2532ce4d7960d132a5bc59674794c6b8495ada4852ea83745cdd6cdf1064ff9f76440573c34564c73057a19306f55b23fdddd783bd240517f23099
-  data.tar.gz: 528812bef0c9f6ba6225210a1130cfd03aea5816eb7c75da99adf323aaf09932cb18d6c0e9e057096212e353b85bf551a65b3144ba86504ff2d1930cdc1dcdaa
+  metadata.gz: 722ef79a6af057ba1f4cf37860212b6a3c08f7aff838dfb4e8034e7970e27c4efe98e66da9c774e45707999b9e70966eacd19e4a1478a54a798d12b1d03b662b
+  data.tar.gz: c9551f302a6f0f02ef81e4a2ef5631c98bc2ad08a39982563749b29867d0bf06258a5e7a167179f70f899031cf2ffe097a014e9480a0a767192915d68f78479a

data/.github/workflows/copyrights.yml

@@ -21,7 +21,11 @@
 name: copyrights
 'on':
   push:
+    branches:
+      - master
   pull_request:
+    branches:
+      - master
 jobs:
   copyrights:
     runs-on: ubuntu-22.04

data/.github/workflows/xcop.yml

@@ -19,9 +19,13 @@
 # SOFTWARE.
 ---
 name: xcop
-on:
+'on':
   push:
+    branches:
+      - master
   pull_request:
+    branches:
+      - master
 jobs:
   xcop:
     runs-on: ubuntu-22.04

data/.rubocop.yml

@@ -58,3 +58,7 @@ Naming/MethodParameterName:
   MinNameLength: 2
 Layout/EndOfLine:
   EnforcedStyle: lf
+Layout/MultilineAssignmentLayout:
+  Enabled: true
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent

data/Gemfile

@@ -30,7 +30,7 @@ gem 'net-ping', '2.0.8', require: false
 gem 'rake', '13.2.1', require: false
 gem 'random-port', '~>0.0', require: false
 gem 'rspec-rails', '6.1.3', require: false
-gem 'rubocop', '1.65.0', require: false
+gem 'rubocop', '1.65.1', require: false
 gem 'rubocop-performance', '1.21.1', require: false
 gem 'rubocop-rspec', '3.0.3', require: false
 gem 'simplecov', '0.22.0', require: false

data/Gemfile.lock

@@ -71,7 +71,7 @@ GEM
       multi_test (~> 1.1)
       sys-uname (~> 1.2)
     cucumber-ci-environment (10.0.1)
-    cucumber-core (13.0.2)
+    cucumber-core (13.0.3)
       cucumber-gherkin (>= 27, < 28)
       cucumber-messages (>= 20, < 23)
       cucumber-tag-expressions (> 5, < 7)
@@ -85,12 +85,12 @@ GEM
     cucumber-tag-expressions (6.1.0)
     decoor (0.0.1)
     diff-lcs (1.5.1)
-    docile (1.4.0)
+    docile (1.4.1)
     drb (2.2.1)
     erubi (1.13.0)
     ethon (0.16.0)
       ffi (>= 1.15.0)
-    factbase (0.2.0)
+    factbase (0.2.1)
       backtrace (> 0)
       decoor (> 0)
       json (~> 2.7)
@@ -120,7 +120,7 @@ GEM
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
-    loog (0.5.2)
+    loog (0.5.3)
     mini_mime (1.1.5)
     minitest (5.24.1)
     minitest-reporters (1.7.1)
@@ -132,19 +132,19 @@ GEM
     multi_test (1.1.0)
     mutex_m (0.2.0)
     net-ping (2.0.8)
-    nokogiri (1.16.6-aarch64-linux)
+    nokogiri (1.16.7-aarch64-linux)
       racc (~> 1.4)
-    nokogiri (1.16.6-arm-linux)
+    nokogiri (1.16.7-arm-linux)
       racc (~> 1.4)
-    nokogiri (1.16.6-arm64-darwin)
+    nokogiri (1.16.7-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.6-x64-mingw-ucrt)
+    nokogiri (1.16.7-x64-mingw-ucrt)
       racc (~> 1.4)
-    nokogiri (1.16.6-x86-linux)
+    nokogiri (1.16.7-x86-linux)
       racc (~> 1.4)
-    nokogiri (1.16.6-x86_64-darwin)
+    nokogiri (1.16.7-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.6-x86_64-linux)
+    nokogiri (1.16.7-x86_64-linux)
       racc (~> 1.4)
     others (0.0.3)
     parallel (1.25.1)
@@ -153,8 +153,8 @@ GEM
       racc
     psych (5.1.2)
       stringio
-    public_suffix (6.0.0)
-    racc (1.8.0)
+    public_suffix (6.0.1)
+    racc (1.8.1)
     rack (3.1.7)
     rack-session (2.0.0)
       rack (>= 3.0.0)
@@ -187,7 +187,7 @@ GEM
     reline (0.5.9)
       io-console (~> 0.5)
     retries (0.0.5)
-    rexml (3.3.2)
+    rexml (3.3.4)
       strscan
     rspec-core (3.13.0)
       rspec-support (~> 3.13.0)
@@ -206,7 +206,7 @@ GEM
       rspec-mocks (~> 3.13)
       rspec-support (~> 3.13)
     rspec-support (3.13.1)
-    rubocop (1.65.0)
+    rubocop (1.65.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -252,7 +252,7 @@ GEM
     webrick (1.8.1)
     yaml (0.3.0)
     yard (0.9.36)
-    zeitwerk (2.6.16)
+    zeitwerk (2.6.17)
 
 PLATFORMS
   aarch64-linux
@@ -272,7 +272,7 @@ DEPENDENCIES
   rake (= 13.2.1)
   random-port (~> 0.0)
   rspec-rails (= 6.1.3)
-  rubocop (= 1.65.0)
+  rubocop (= 1.65.1)
   rubocop-performance (= 1.21.1)
   rubocop-rspec (= 3.0.3)
   simplecov (= 0.22.0)
@@ -281,4 +281,4 @@ DEPENDENCIES
   yard (= 0.9.36)
 
 BUNDLED WITH
-   2.5.6
+   2.5.16

data/README.md

@@ -48,6 +48,9 @@ options:
   max: 100
 expected:
   - /fb[count(f)=1]
+after:
+  - first.rb
+  - second.rb
 ```
 
 Here, the `input` is an array of facts to be placed into the Factbase before
@@ -65,6 +68,10 @@ 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.
 
+The `after` (default: `[]`) is a list of relative file names
+of Ruby scripts that are executed after the judge
+(`$fb` and `$loog` are passed into them).
+
 ## How to contribute
 
 Read

data/bin/judges

@@ -32,7 +32,15 @@ Encoding.default_internal = Encoding::UTF_8
 
 class JudgesGLI extend GLI::App
 
-  loog = Loog::REGULAR
+  def self.run_it(cmd, ruby)
+    cmd.action do |global, options, args|
+      require_relative "../lib/judges/commands/#{ruby}"
+      @@loog.debug("Running '#{ruby}' command...")
+      Object.const_get("Judges::#{ruby.capitalize}").new(@@loog).run(options, args)
+    end
+  end
+
+  @@loog = Loog::REGULAR
 
   program_desc('Automated executor of judges for a factbase')
 
@@ -48,13 +56,13 @@ class JudgesGLI extend GLI::App
 
   pre do |global, command, options, args|
     if global[:verbose]
-      loog = Loog::VERBOSE
+      @@loog = Loog::VERBOSE
     end
-    loog.debug("Judges #{Judges::VERSION}")
-    loog.debug("Factbase #{Factbase::VERSION}")
-    loog.debug("Ruby: #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}")
-    loog.debug("Current directory: #{Dir.getwd}")
-    loog.debug("Time: #{Time.now.utc.iso8601}")
+    @@loog.debug("Judges #{Judges::VERSION}")
+    @@loog.debug("Factbase #{Factbase::VERSION}")
+    @@loog.debug("Ruby: #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}")
+    @@loog.debug("Current directory: #{Dir.getwd}")
+    @@loog.debug("Time: #{Time.now.utc.iso8601}")
     true
   end
 
@@ -72,44 +80,29 @@ class JudgesGLI extend GLI::App
     c.switch([:summary], default_value: false)
     c.desc 'Use default logging facility'
     c.switch([:log], default_value: true)
-    c.action do |global, options, args|
-      require_relative '../lib/judges/commands/update'
-      Judges::Update.new(loog).run(options, args)
-    end
+    run_it(c, 'update')
   end
 
   desc 'Evaluate a single Ruby expression on the factbase'
   command :eval do |c|
-    c.action do |global, options, args|
-      require_relative '../lib/judges/commands/eval'
-      Judges::Eval.new(loog).run(options, args)
-    end
+    run_it(c, 'eval')
   end
 
   desc 'Join two factbases'
   command :join do |c|
-    c.action do |global, options, args|
-      require_relative '../lib/judges/commands/join'
-      Judges::Join.new(loog).run(options, args)
-    end
+    run_it(c, 'join')
   end
 
   desc 'Import YAML into a factbase'
   command :import do |c|
-    c.action do |global, options, args|
-      require_relative '../lib/judges/commands/import'
-      Judges::Import.new(loog).run(options, args)
-    end
+    run_it(c, 'import')
   end
 
   desc 'Remove the facts that are too old'
   command :trim do |c|
     c.desc 'Only the facts that match the expression are deleted'
     c.flag([:query], default_value: '(never)')
-    c.action do |global, options, args|
-      require_relative '../lib/judges/commands/trim'
-      Judges::Trim.new(loog).run(options, args)
-    end
+    run_it(c, 'trim')
   end
 
   desc 'Print the factbase into a human-readable format (YAML, JSON, etc.)'
@@ -128,18 +121,12 @@ class JudgesGLI extend GLI::App
     c.flag([:hidden], default_value: '_id,_time,_version')
     c.desc 'Print even if target file already exists and is older than the factbase'
     c.switch([:force], default_value: false)
-    c.action do |global, options, args|
-      require_relative '../lib/judges/commands/print'
-      Judges::Print.new(loog).run(options, args)
-    end
+    run_it(c, 'print')
   end
 
   desc 'Inspect the factbase and print all its possible meta-data'
   command :inspect do |c|
-    c.action do |global, options, args|
-      require_relative '../lib/judges/commands/inspect'
-      Judges::Inspect.new(loog).run(options, args)
-    end
+    run_it(c, 'inspect')
   end
 
   desc 'Run automated tests for all judges'
@@ -160,10 +147,7 @@ class JudgesGLI extend GLI::App
     c.switch([:quiet], default_value: false)
     c.desc 'Use default logging facility'
     c.switch([:log], default_value: true)
-    c.action do |global, options, args|
-      require_relative '../lib/judges/commands/test'
-      Judges::Test.new(loog).run(options, args)
-    end
+    run_it(c, 'test')
   end
 
   desc 'Push the factbase to the server'
@@ -184,10 +168,9 @@ class JudgesGLI extend GLI::App
     c.flag([:meta], type: String, multiple: true)
     c.desc 'How many times to retry'
     c.flag([:retries], type: Integer, default_value: 3)
-    c.action do |global, options, args|
-      require_relative '../lib/judges/commands/push'
-      Judges::Push.new(loog).run(options, args)
-    end
+    c.desc 'Turn on the package compression'
+    c.switch([:zip], default_value: true)
+    run_it(c, 'push')
   end
 
   desc 'Pull the factbase from the server'
@@ -208,10 +191,7 @@ class JudgesGLI extend GLI::App
     c.flag([:owner], default_value: 'default', type: String)
     c.desc 'How many times to retry'
     c.flag([:retries], type: Integer, default_value: 3)
-    c.action do |global, options, args|
-      require_relative '../lib/judges/commands/pull'
-      Judges::Pull.new(loog).run(options, args)
-    end
+    run_it(c, 'pull')
   end
 end
 

data/features/pull.feature

@@ -1,12 +1,10 @@
 Feature: Pull
   I want to pull a factbase
 
-  Scenario: Pull a small factbase
+  Scenario: Pull a small factbase, which is absent on the server
     Given We are online
     Given I make a temp directory
-    Then I run bin/judges with "--verbose pull --token 00000000-0000-0000-0000-000000000000 --wait=15 simple simple.fb"
-    Then Stdout contains "Pulled"
-    And Exit code is zero
-    Then I run bin/judges with "inspect simple.fb"
+    Then I run bin/judges with "--verbose pull --token 00000000-0000-0000-0000-000000000000 --wait=15 {FAKE-NAME} simple.fb"
+    Then Stdout contains "doesn't exist at www.zerocracy.com"
     And Exit code is zero
 

data/features/push.feature

@@ -6,6 +6,6 @@ Feature: Push
     Given I make a temp directory
     Then I run bin/judges with "--verbose eval simple.fb '(0..1000).each { $fb.insert.foo = 42 }'"
     And Exit code is zero
-    Then I run bin/judges with "push --token 00000000-0000-0000-0000-000000000000 --meta a:b --meta foo:bar --meta=pages_url:https://zerocracy.github.io/zerocracy.html --meta=duration:1055  simple simple.fb"
+    Then I run bin/judges with "push --token 00000000-0000-0000-0000-000000000000 --meta a:b --meta foo:bar --meta=pages_url:https://zerocracy.github.io/zerocracy.html --meta=duration:1055 {FAKE-NAME} simple.fb"
     Then Stdout contains "Pushed"
     And Exit code is zero

data/features/step_definitions/steps.rb

@@ -23,6 +23,7 @@
 require 'tmpdir'
 require 'net/ping'
 require 'English'
+require 'securerandom'
 
 Before do
   @cwd = Dir.pwd
@@ -52,6 +53,7 @@ end
 
 When(%r{^I run bin/judges with "([^"]*)"$}) do |arg|
   home = File.join(File.dirname(__FILE__), '../..')
+  arg.gsub!('{FAKE-NAME}') { "fake#{SecureRandom.hex(8)}" }
   cmd = "ruby -I#{home}/lib #{home}/bin/judges #{arg}"
   cmd = "GLI_DEBUG=true #{cmd}" unless Gem.win_platform?
   @stdout = `#{cmd} 2>&1`

data/features/test.feature

@@ -28,14 +28,14 @@ Feature: Test
 
   Scenario: Simple test of a few judges, with a lib
     Given I make a temp directory
-    Then I have a "myjudges/myjudge/simple_judge.rb" file with content:
+    Then I have a "myjudges/good/good.rb" file with content:
     """
       $valve.enter('boom', 'some reason') do
         n = $fb.insert
         n.foo = $foo
       end
     """
-    Then I have a "myjudges/myjudge/good.yml" file with content:
+    Then I have a "myjudges/good/good.yml" file with content:
     """
     ---
     category: good
@@ -51,7 +51,7 @@ Feature: Test
 
   Scenario: Simple test with many runs
     Given I make a temp directory
-    Then I have a "foo/simple.rb" file with content:
+    Then I have a "foo/foo.rb" file with content:
     """
       n = $fb.insert
       n.foo = $fb.size
@@ -70,7 +70,7 @@ Feature: Test
 
   Scenario: Simple test with many runs and many asserts
     Given I make a temp directory
-    Then I have a "foo/simple.rb" file with content:
+    Then I have a "foo/foo.rb" file with content:
     """
       n = $fb.insert
       n.foo = $fb.size
@@ -141,3 +141,25 @@ Feature: Test
     """
     Then I run bin/judges with "test mine"
     And Exit code is zero
+
+  Scenario: Test with a post-assert
+    Given I make a temp directory
+    Then I have a "mine/foo/foo.rb" file with content:
+    """
+    n = $fb.insert
+    n.foo = 42
+    """
+    Then I have a "mine/foo/assert.rb" file with content:
+    """
+    raise unless $fb.size == 1
+    """
+    Then I have a "mine/foo/simple.yml" file with content:
+    """
+    ---
+    expected:
+      - /fb[count(f)=1]
+    after:
+      - assert.rb
+    """
+    Then I run bin/judges with "test mine"
+    And Exit code is zero

data/features/update.feature

@@ -3,7 +3,7 @@ Feature: Update
 
   Scenario: Simple run of a few judges
     Given I make a temp directory
-    Then I have a "simple/simple_judge.rb" file with content:
+    Then I have a "simple/simple.rb" file with content:
     """
       n = $fb.insert
       n.kind = 'yes!'
@@ -17,7 +17,7 @@ Feature: Update
 
   Scenario: Simple run of a few judges, with a lib
     Given I make a temp directory
-    Then I have a "mine/judge1/simple_judge.rb" file with content:
+    Then I have a "mine/judge1/judge1.rb" file with content:
     """
       $valve.enter('boom', 'for no particular reason') do
         n = $fb.insert
@@ -35,7 +35,7 @@ Feature: Update
 
   Scenario: The update fails when a bug in a judge
     Given I make a temp directory
-    Then I have a "mine/judge1/broken.rb" file with content:
+    Then I have a "mine/broken/broken.rb" file with content:
     """
     a < 1
     """
@@ -45,7 +45,7 @@ Feature: Update
 
   Scenario: The update fails when a broken Ruby syntax in a judge
     Given I make a temp directory
-    Then I have a "mine/judge1/broken.rb" file with content:
+    Then I have a "mine/broken/broken.rb" file with content:
     """
     invalid$ruby$syntax$here
     """

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.20.0'
+  s.version = '0.22.0'
   s.license = 'MIT'
   s.summary = 'Command-Line Tool for a Factbase'
   s.description =

data/lib/judges/baza.rb

@@ -38,7 +38,7 @@ require_relative '../judges/elapsed'
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 class Judges::Baza
-  def initialize(host, port, token, ssl: true, timeout: 30, retries: 3, loog: Loog::NULL)
+  def initialize(host, port, token, ssl: true, timeout: 30, retries: 3, loog: Loog::NULL, compression: true)
     @host = host
     @port = port
     @ssl = ssl
@@ -46,6 +46,7 @@ class Judges::Baza
     @timeout = timeout
     @loog = loog
     @retries = retries
+    @compression = compression
   end
 
   # Push factbase to the server.
@@ -62,18 +63,22 @@ class Judges::Baza
     unless meta.empty?
       hdrs = hdrs.merge('X-Zerocracy-Meta' => meta.map { |v| Base64.encode64(v).gsub("\n", '') }.join(' '))
     end
+    params = {
+      connecttimeout: @timeout,
+      timeout: @timeout,
+      body: data,
+      headers: hdrs
+    }
     elapsed(@loog) do
-      ret = with_retries(max_tries: @retries) do
-        checked(
-          Typhoeus::Request.put(
-            home.append('push').append(name).to_s,
-            body: data,
-            headers: hdrs,
-            connecttimeout: @timeout,
-            timeout: @timeout
+      ret =
+        with_retries(max_tries: @retries) do
+          checked(
+            Typhoeus::Request.put(
+              home.append('push').append(name).to_s,
+              @compression ? zipped(params) : params
+            )
           )
-        )
-      end
+        end
       id = ret.body.to_i
       throw :"Pushed #{data.size} bytes to #{@host}, job ID is ##{id}"
     end
@@ -117,20 +122,63 @@ class Judges::Baza
   def finished?(id)
     finished = false
     elapsed(@loog) do
-      ret = with_retries(max_tries: @retries) do
-        checked(
-          Typhoeus::Request.get(
-            home.append('finished').append(id).to_s,
-            headers:
+      ret =
+        with_retries(max_tries: @retries) do
+          checked(
+            Typhoeus::Request.get(
+              home.append('finished').append(id).to_s,
+              headers:
+            )
           )
-        )
-      end
+        end
       finished = ret.body == 'yes'
       throw :"The job ##{id} is #{finished ? '' : 'not yet '}finished at #{@host}"
     end
     finished
   end
 
+  # Read and return the stdout of the job.
+  # @param [Integer] id The ID of the job on the server
+  # @return [String] The stdout, as a text
+  def stdout(id)
+    stdout = ''
+    elapsed(@loog) do
+      ret =
+        with_retries(max_tries: @retries) do
+          checked(
+            Typhoeus::Request.get(
+              home.append('stdout').append(id).to_s,
+              headers:
+            )
+          )
+        end
+      ret.body
+      throw :"The stdout of the job ##{id} has #{stdout.split("\n")} lines"
+    end
+    stdout
+  end
+
+  # Read and return the exit code of the job.
+  # @param [Integer] id The ID of the job on the server
+  # @return [Integer] The exit code
+  def exit_code(id)
+    code = 0
+    elapsed(@loog) do
+      ret =
+        with_retries(max_tries: @retries) do
+          checked(
+            Typhoeus::Request.get(
+              home.append('exit').append(id).to_s,
+              headers:
+            )
+          )
+        end
+      code = ret.body.to_i
+      throw :"The exit code of the job ##{id} is #{code}"
+    end
+    code
+  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)
@@ -171,14 +219,15 @@ class Judges::Baza
   def recent(name)
     job = 0
     elapsed(@loog) do
-      ret = with_retries(max_tries: @retries) do
-        checked(
-          Typhoeus::Request.get(
-            home.append('recent').append("#{name}.txt").to_s,
-            headers:
+      ret =
+        with_retries(max_tries: @retries) do
+          checked(
+            Typhoeus::Request.get(
+              home.append('recent').append("#{name}.txt").to_s,
+              headers:
+            )
           )
-        )
-      end
+        end
       job = ret.body.to_i
       throw :"The recent \"#{name}\" job's ID is ##{job} at #{@host}"
     end
@@ -191,14 +240,15 @@ class Judges::Baza
   def name_exists?(name)
     exists = 0
     elapsed(@loog) do
-      ret = with_retries(max_tries: @retries) do
-        checked(
-          Typhoeus::Request.get(
-            home.append('exists').append(name).to_s,
-            headers:
+      ret =
+        with_retries(max_tries: @retries) do
+          checked(
+            Typhoeus::Request.get(
+              home.append('exists').append(name).to_s,
+              headers:
+            )
           )
-        )
-      end
+        end
       exists = ret.body == 'yes'
       throw :"The name \"#{name}\" #{exists ? 'exists' : "doesn't exist"} at #{@host}"
     end
@@ -215,6 +265,27 @@ class Judges::Baza
     }
   end
 
+  def zipped(params)
+    body = gzip(params.fetch(:body))
+    headers = params
+      .fetch(:headers)
+      .merge({
+        'Content-Type' => 'application/zip',
+        'Content-Encoding' => 'gzip',
+        'Content-Length' => body.size
+      })
+    params.merge(body:, headers:)
+  end
+
+  def gzip(data)
+    ''.dup.tap do |result|
+      io = StringIO.new(result)
+      gz = Zlib::GzipWriter.new(io)
+      gz.write(data)
+      gz.close
+    end
+  end
+
   def home
     Iri.new('')
       .host(@host)