judges 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be8151f228edd7b8c45f0fcf1f566e8585fae93ce87bcb7f56ca6f452a1b67ca
-  data.tar.gz: 99e20604a1f8a78a0c5dbf4080522aab725a7e82df5cb87d3b456962636aad10
+  metadata.gz: 8eed10a2293bdfe6ddfc33e7623d7eb8f905428f60fd002c55e7eb75afdcd96f
+  data.tar.gz: df6b6941021d0c4fbcdb22d4608d41365ca7e537104eda09909f56cb4dd8dd3d
 SHA512:
-  metadata.gz: 2df81af8fd18810e54c05fc3631a2e38037d45e49a7f87cd4e9e8592155b155b81671ad5641e3923886e86752fa3be8c5f7926f2ce539d48ccfac714269f44d4
-  data.tar.gz: 6fd2568f060510bc0b0600cc9d186d622025a7f886085bf5993bc3388f246c283c2c08c785199d609fd7a4729eb949a27a829d199785d43334addbdcd7f51248
+  metadata.gz: 07a943829af24cf0388303f9804f8b476449e3feea10ec3fa3703278ffb96e3b8c7a342d06e611e99168a8711397c380fdb70e8504fecaa22be48a6db0627550
+  data.tar.gz: 605f4d9c1598a4950098837ae6d8a8a432b882d1d4da75f93df78e530a584101642fbed0eb76d3df728f7dae4adbe30fb86c517ded6c16ff13f907b89ee4f797

data/Gemfile.lock

@@ -9,14 +9,15 @@ PATH
       iri (~> 0.8)
       loog (~> 0.2)
       nokogiri (~> 1.10)
+      retries (~> 0.0)
       typhoeus (~> 1.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.1.3.3)
-      actionview (= 7.1.3.3)
-      activesupport (= 7.1.3.3)
+    actionpack (7.1.3.4)
+      actionview (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       nokogiri (>= 1.8.5)
       racc
       rack (>= 2.2.4)
@@ -24,13 +25,13 @@ GEM
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    actionview (7.1.3.3)
-      activesupport (= 7.1.3.3)
+    actionview (7.1.3.4)
+      activesupport (= 7.1.3.4)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activesupport (7.1.3.3)
+    activesupport (7.1.3.4)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -84,7 +85,7 @@ GEM
     erubi (1.12.0)
     ethon (0.16.0)
       ffi (>= 1.15.0)
-    factbase (0.0.41)
+    factbase (0.0.42)
       json (~> 2.7)
       loog (~> 0.2)
       nokogiri (~> 1.10)
@@ -153,9 +154,9 @@ GEM
     rails-html-sanitizer (1.6.0)
       loofah (~> 2.21)
       nokogiri (~> 1.14)
-    railties (7.1.3.3)
-      actionpack (= 7.1.3.3)
-      activesupport (= 7.1.3.3)
+    railties (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
       irb
       rackup (>= 1.0.0)
       rake (>= 12.2)
@@ -168,6 +169,7 @@ GEM
     regexp_parser (2.9.2)
     reline (0.5.8)
       io-console (~> 0.5)
+    retries (0.0.5)
     rexml (3.2.8)
       strscan (>= 3.0.9)
     rspec-core (3.13.0)

data/bin/judges

@@ -155,9 +155,9 @@ class App
     c.desc 'The IP/hostname of the server'
     c.flag([:host], default_value: 'www.zerocracy.com')
     c.desc 'The TCP port number of the server'
-    c.flag([:port], default_value: 443)
+    c.flag([:port], default_value: 443, type: Integer)
     c.desc 'Connection and read time in seconds'
-    c.flag([:timeout], default_value: 30)
+    c.flag([:timeout], default_value: 30, type: Integer)
     c.desc 'Shall SSL be used?'
     c.switch([:ssl], default_value: true)
     c.action do |global, options, args|
@@ -170,12 +170,14 @@ class App
   command :pull do |c|
     c.desc 'Authentication token'
     c.flag([:token])
+    c.desc 'How many seconds to wait'
+    c.flag([:wait], default_value: 10 * 60, arg_name: '<seconds>', type: Integer)
     c.desc 'The IP/hostname of the server'
     c.flag([:host], default_value: 'www.zerocracy.com')
     c.desc 'The TCP port number of the server'
-    c.flag([:port], default_value: 443)
+    c.flag([:port], default_value: 443, type: Integer)
     c.desc 'Connection and read time in seconds'
-    c.flag([:timeout], default_value: 30)
+    c.flag([:timeout], default_value: 30, type: Integer)
     c.desc 'Shall SSL be used?'
     c.switch([:ssl], default_value: true)
     c.action do |global, options, args|

data/features/pull.feature

@@ -4,7 +4,7 @@ Feature: Pull
   Scenario: Pull a small factbase
     Given We are online
     Given I make a temp directory
-    Then I run bin/judges with "--verbose pull --token 00000000-0000-0000-0000-000000000000 simple simple.fb"
+    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"

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.3.0'
+  s.version = '0.5.0'
   s.license = 'MIT'
   s.summary = 'Command-Line Tool for a Factbase'
   s.description =
@@ -42,13 +42,14 @@ Gem::Specification.new do |s|
   s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
-  s.add_runtime_dependency 'backtrace', '~> 0.3'
+  s.add_runtime_dependency 'backtrace', '~>0.3'
   s.add_runtime_dependency 'concurrent-ruby', '1.2.3'
   s.add_runtime_dependency 'factbase', '~>0.0'
   s.add_runtime_dependency 'gli', '~>2.21'
   s.add_runtime_dependency 'iri', '~>0.8'
   s.add_runtime_dependency 'loog', '~>0.2'
-  s.add_runtime_dependency 'nokogiri', '~> 1.10'
+  s.add_runtime_dependency 'nokogiri', '~>1.10'
+  s.add_runtime_dependency 'retries', '~>0.0'
   s.add_runtime_dependency 'typhoeus', '~>1.3'
   s.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/judges/baza.rb

@@ -21,6 +21,7 @@
 # SOFTWARE.
 
 require 'typhoeus'
+require 'retries'
 require 'iri'
 require 'loog'
 require_relative '../judges'
@@ -45,17 +46,20 @@ class Judges::Baza
   def push(name, data)
     id = 0
     elapsed(@loog) do
-      ret = Typhoeus::Request.put(
-        home.append('push').append(name).to_s,
-        body: data,
-        headers: headers.merge(
-          'Content-Type' => 'application/octet-stream',
-          'Content-Length' => data.size
-        ),
-        connecttimeout: @timeout,
-        timeout: @timeout
-      )
-      check_code(ret)
+      ret = with_retries do
+        checked(
+          Typhoeus::Request.put(
+            home.append('push').append(name).to_s,
+            body: data,
+            headers: headers.merge(
+              'Content-Type' => 'application/octet-stream',
+              'Content-Length' => data.size
+            ),
+            connecttimeout: @timeout,
+            timeout: @timeout
+          )
+        )
+      end
       id = ret.body.to_i
       throw :"Pushed #{data.size} bytes to #{@host}, job ID is ##{id}"
     end
@@ -79,7 +83,7 @@ class Judges::Baza
             f.write(chunk)
           end
           request.run
-          check_code(request.response)
+          checked(request.response)
         end
         data = File.binread(file)
         throw :"Pulled #{data.size} bytes of job ##{id} factbase at #{@host}"
@@ -92,11 +96,14 @@ class Judges::Baza
   def finished?(id)
     finished = false
     elapsed(@loog) do
-      ret = Typhoeus::Request.get(
-        home.append('finished').append(id).to_s,
-        headers:
-      )
-      check_code(ret)
+      ret = with_retries do
+        checked(
+          Typhoeus::Request.get(
+            home.append('finished').append(id).to_s,
+            headers:
+          )
+        )
+      end
       finished = ret.body == 'yes'
       throw :"The job ##{id} is #{finished ? '' : 'not yet '}finished at #{@host}"
     end
@@ -106,11 +113,14 @@ class Judges::Baza
   def recent(name)
     job = 0
     elapsed(@loog) do
-      ret = Typhoeus::Request.get(
-        home.append('recent').append("#{name}.txt").to_s,
-        headers:
-      )
-      check_code(ret)
+      ret = with_retries do
+        checked(
+          Typhoeus::Request.get(
+            home.append('recent').append("#{name}.txt").to_s,
+            headers:
+          )
+        )
+      end
       job = ret.body.to_i
       throw :"The recent \"#{name}\" job's ID is ##{job} at #{@host}"
     end
@@ -120,11 +130,12 @@ class Judges::Baza
   def name_exists?(name)
     exists = 0
     elapsed(@loog) do
-      ret = Typhoeus::Request.get(
-        home.append('exists').append(name).to_s,
-        headers:
+      ret = checked(
+        Typhoeus::Request.get(
+          home.append('exists').append(name).to_s,
+          headers:
+        )
       )
-      check_code(ret)
       exists = ret.body == 'yes'
       throw :"The name \"#{name}\" #{exists ? 'exists' : "doesn't exist"} at #{@host}"
     end
@@ -148,14 +159,14 @@ class Judges::Baza
       .scheme(@ssl ? 'https' : 'http')
   end
 
-  def check_code(ret, allowed = [200])
+  def checked(ret, allowed = [200])
     allowed = [allowed] unless allowed.is_a?(Array)
     mtd = (ret.request.original_options[:method] || '???').upcase
     url = ret.effective_url
     log = "#{mtd} #{url} -> #{ret.code}"
     if allowed.include?(ret.code)
       @loog.debug(log)
-      return
+      return ret
     end
     @loog.debug("#{log}\n  #{(ret.headers || {}).map { |k, v| "#{k}: #{v}" }.join("\n  ")}")
     msg =

data/lib/judges/commands/pull.rb

@@ -47,7 +47,7 @@ class Judges::Pull
     name = args[0]
     elapsed(@loog) do
       if baza.name_exists?(name)
-        fb.import(baza.pull(wait(baza, baza.recent(name))))
+        fb.import(baza.pull(wait(baza, baza.recent(name), opts['wait'])))
         Judges::Impex.new(@loog, args[1]).export(fb)
         throw :"Pulled #{fb.size} facts by the name '#{name}'"
       else
@@ -58,12 +58,14 @@ class Judges::Pull
 
   private
 
-  def wait(baza, id)
+  def wait(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 > 10 * 60
+      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)")
     end
     id
   end

data/lib/judges/commands/test.rb

@@ -69,7 +69,7 @@ class Judges::Test
           end
           @loog.info("🛠️ Testing #{f.to_rel}:")
           begin
-            test_one(opts, p, yaml)
+            test_one(opts, p, tname, yaml)
             tests += 1
           rescue StandardError => e
             @loog.warn(Backtrace.new(e))
@@ -106,7 +106,7 @@ class Judges::Test
     judges.any? { |n| n.match?(%r{^#{name}(/#{tre})?$}) }
   end
 
-  def test_one(opts, judge, yaml)
+  def test_one(opts, judge, tname, yaml)
     fb = Factbase.new
     inputs = yaml['input']
     inputs&.each do |i|
@@ -127,7 +127,7 @@ class Judges::Test
     return if xpaths.nil?
     xml = Nokogiri::XML.parse(Factbase::ToXML.new(fb).xml)
     xpaths.each do |xp|
-      raise "#{judge.script} doesn't match '#{xp}':\n#{xml}" if xml.xpath(xp).empty?
+      raise "#{judge.name}/#{tname} doesn't match '#{xp}':\n#{xml}" if xml.xpath(xp).empty?
     end
   end
 end

data/lib/judges/commands/update.rb

@@ -56,9 +56,9 @@ class Judges::Update
         if c > 1
           @loog.info("\n\nStarting cycle ##{c}#{opts['max-cycles'] ? " (out of #{opts['max-cycles']})" : ''}...")
         end
-        diff = cycle(opts, judges, fb, options)
+        churn = cycle(opts, judges, fb, options)
         impex.export(fb)
-        if diff.zero?
+        if churn.zero?
           @loog.info("The update cycle ##{c} has made no changes to the factbase, let's stop")
           break
         end
@@ -66,36 +66,52 @@ class Judges::Update
           @loog.info("Too many cycles already, as set by --max-cycles=#{opts['max-cycles']}, breaking")
           break
         end
-        @loog.info(
-          "By #{diff.abs} fact(s) the factbase " \
-          "#{diff.positive? ? 'increased' : 'decreased'} " \
-          "its size at the cycle ##{c}"
-        )
+        @loog.info("At the cycle #{c}, the factbase was modified by #{churn} fact(s)")
       end
       throw :"Update finished in #{c} cycle(s), #{format('+%d', fb.size - before)} fact(s)"
     end
   end
 
+  # How many facts were modified.
+  class Churn
+    attr_reader :added, :removed
+
+    def initialize(added, removed)
+      @added = added
+      @removed = removed
+    end
+
+    def to_s
+      "#{@added}/-#{@removed}"
+    end
+
+    def zero?
+      @added.zero? && @removed.zero?
+    end
+
+    def +(other)
+      Churn.new(@added + other.added, @removed + other.removed)
+    end
+  end
+
   private
 
+  # Run all judges in a full cycle, one by one.
+  # @return [Churn] How many modifications have been made
   def cycle(opts, judges, fb, options)
     errors = []
-    diff = 0
+    churn = Churn.new(0, 0)
     global = {}
     elapsed(@loog) do
       done = judges.each_with_index do |p, i|
-        local = {}
         @loog.info("\n👉 Running #{p.name} (##{i}) at #{p.dir.to_rel}...")
-        before = fb.size
-        begin
-          p.run(fb, global, local, options)
-        rescue StandardError, SyntaxError => e
-          @loog.warn(Backtrace.new(e))
-          errors << p.script
+        elapsed(@loog) do
+          churn += one_judge(fb, p, global, options)
+          throw :"👍 The judge #{p.name} modified #{churn} facts\n"
         end
-        after = fb.size
-        @loog.info("👍 The judge #{p.dir.to_rel} added #{after - before} facts") if after > before
-        diff += after - before
+      rescue StandardError, SyntaxError => e
+        @loog.warn(Backtrace.new(e))
+        errors << p.script
       end
       throw :"👍 #{done} judge(s) processed" if errors.empty?
       throw :"❌ #{done} judge(s) processed with #{errors.size} errors"
@@ -104,6 +120,21 @@ class Judges::Update
       raise "Failed to update correctly (#{errors.size} errors)" unless opts['quiet']
       @loog.info('Not failing because of the --quiet flag provided')
     end
-    diff
+    churn
+  end
+
+  # Run a single judge.
+  # @return [Churn] How many modifications have been made
+  def one_judge(fb, judge, global, options)
+    local = {}
+    before = fb.size
+    judge.run(fb, global, local, options)
+    after = fb.size
+    diff = after - before
+    if diff.positive?
+      Churn.new(diff, 0)
+    else
+      Churn.new(0, -diff)
+    end
   end
 end

data/lib/judges.rb

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

data/test/commands/test_pull.rb

@@ -47,7 +47,8 @@ class TestPull < Minitest::Test
           'token' => '000',
           'host' => 'example.org',
           'port' => 80,
-          'ssl' => false
+          'ssl' => false,
+          'wait' => 10
         },
         ['foo', file]
       )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: judges
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-04 00:00:00.000000000 Z
+date: 2024-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: retries
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement