judges 0.28.1 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 341626c0bc376f735ba16fccda467dfb3fe1fa9d8b4740e1a61704538cf989c8
-  data.tar.gz: d1ca8113d163559cc8df9e073c40dc54e02aae046f57793f8e983c92d880b0c7
+  metadata.gz: ef7c67730c179f98b6f395fbad9be1df9229984b380c52ac6c64767b74ce241e
+  data.tar.gz: bf6b63a2acd86e3c8b411f069367aebaed64f5c36a85997038bf31f19cded3c1
 SHA512:
-  metadata.gz: 2cc1c7207eae7e3cc59be1c634cc821f55c527f51014f1164f473c1d34d861302e596cf394900e869cd0304fbb5593eb9e333ffb87db6409dbbb999e6d372890
-  data.tar.gz: e8d9ff08a6238b2bf580bf7c45ce47330f62d3d3174ad52e44a3fa2289aaf22bb1cfe69997fed2bcd0719c029f4597cc375cc48e09cb017b72deee67b3736689
+  metadata.gz: e8c2dd385af7ec0e2f80080e27ddec8479812521efe16ae754726adfce6593c62396fae72d6a635ed9e925aa1dee1f2382f0cdedde24abcfb1a805da925f23f4
+  data.tar.gz: 4597927deaf3e416a86083a2aab8db341469c604aa935e145119da1ad7bbb83319ffceaa6ac50778d33cada2cf5cd5209a5227aa5826c2febb4726b7efc36c28

data/Gemfile.lock

@@ -15,6 +15,7 @@ PATH
       others (~> 0)
       retries (~> 0)
       tago (~> 0)
+      timeout (~> 0)
       typhoeus (~> 1.3)
 
 GEM
@@ -195,7 +196,7 @@ GEM
     rack (3.1.8)
     rack-session (2.0.0)
       rack (>= 3.0.0)
-    rack-test (2.1.0)
+    rack-test (2.2.0)
       rack (>= 1.3)
     rackup (2.2.1)
       rack (>= 3)
@@ -274,6 +275,7 @@ GEM
       ffi (~> 1.1)
     tago (0.0.2)
     thor (1.3.2)
+    timeout (0.4.3)
     typhoeus (1.4.1)
       ethon (>= 0.9.0)
     tzinfo (2.0.6)

data/bin/judges

@@ -72,6 +72,8 @@ class JudgesGLI extend GLI::App
     c.flag([:o, :option], multiple: true, arg_name: '<key=value>')
     c.desc 'The location of a Ruby library (directory with .rb files to include)'
     c.flag([:lib])
+    c.desc 'Maximum time in seconds to spend on every judge (forcefully terminate if over time)'
+    c.flag([:'timeout'], default_value: 30, type: Integer)
     c.desc 'Maximum number of update cycles to run'
     c.flag([:'max-cycles'], default_value: 8, type: Integer)
     c.desc 'Stay quiet even if some judges fail'

data/features/update.feature

@@ -15,6 +15,19 @@ Feature: Update
     Then Stdout contains "Update finished in 3 cycle(s), modified 3/0 fact(s)"
     And Exit code is zero
 
+  Scenario: Simple run with a timeout for a judge
+    Given I make a temp directory
+    Then I have a "slow/slow.rb" file with content:
+    """
+      sleep(10)
+      $fb.insert.foo = 1
+    """
+    Then I run bin/judges with "--verbose update --timeout 1 --quiet . foo.fb"
+    Then Stdout contains "timed out"
+    Then Stdout contains "1 judge(s) processed"
+    Then Stdout contains "Update finished in 1 cycle(s), modified 0/0 fact(s)"
+    And Exit code is zero
+
   Scenario: Simple run of a few judges, with a lib
     Given I make a temp directory
     Then I have a "mine/judge1/judge1.rb" file with content:

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.28.1'
+  s.version = '0.29.0'
   s.license = 'MIT'
   s.summary = 'Command-Line Tool for a Factbase'
   s.description =
@@ -55,6 +55,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'others', '~>0'
   s.add_dependency 'retries', '~>0'
   s.add_dependency 'tago', '~>0'
+  s.add_dependency 'timeout', '~>0'
   s.add_dependency 'typhoeus', '~>1.3'
   s.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/judges/commands/update.rb

@@ -24,6 +24,7 @@ require 'backtrace'
 require 'elapsed'
 require 'factbase/looged'
 require 'tago'
+require 'timeout'
 require_relative '../../judges'
 require_relative '../../judges/to_rel'
 require_relative '../../judges/judges'
@@ -45,6 +46,7 @@ class Judges::Update
   end
 
   # Run it (it is supposed to be called by the +bin/judges+ script.
+  #
   # @param [Hash] opts Command line options (start with '--')
   # @param [Array] args List of command line arguments
   def run(opts, args)
@@ -117,9 +119,9 @@ class Judges::Update
         judges.each_with_index do |p, i|
           @loog.info("\n👉 Running #{p.name} (##{i}) at #{p.dir.to_rel} (#{start.ago} already)...")
           elapsed(@loog, level: Logger::INFO) do
-            c = one_judge(fb, p, global, options)
+            c = one_judge(opts, fb, p, global, options)
             churn += c
-            throw :"👍 The judge #{p.name} modified #{c} facts out of #{fb.size}"
+            throw :"👍 The '#{p.name}' judge modified #{c} facts out of #{fb.size}"
           end
         rescue StandardError, SyntaxError => e
           @loog.warn(Backtrace.new(e))
@@ -136,11 +138,23 @@ class Judges::Update
   end
 
   # Run a single judge.
+  #
+  # @param [Hash] opts The command line options
+  # @param [Factbase] fb The factbase
+  # @param [Judges::Judge] judge The judge
+  # @param [Hash] global Global options
+  # @param [Judges::Options] options The options
   # @return [Churn] How many modifications have been made
-  def one_judge(fb, judge, global, options)
+  def one_judge(opts, fb, judge, global, options)
     local = {}
     before = fb.size
-    judge.run(fb, global, local, options)
+    begin
+      Timeout.timeout(opts['timeout']) do
+        judge.run(fb, global, local, options)
+      end
+    rescue Timeout::Error => e
+      throw :"👎 The '#{judge.name}' judge timed out: #{e.message}"
+    end
     after = fb.size
     diff = after - before
     if diff.positive?

data/lib/judges/judge.rb

@@ -67,7 +67,7 @@ class Judges::Judge
     end
     s = File.join(@dir, script)
     raise "Can't load '#{s}'" unless File.exist?(s)
-    elapsed(@loog, intro: "#{$judge} finished (#{@start.ago} already)", level: Logger::INFO) do
+    elapsed(@loog, intro: "#{$judge} finished", level: Logger::INFO) do
       load(s, true)
     ensure
       $fb = $judge = $options = $loog = nil

data/lib/judges.rb

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

data/test/commands/test_update.rb

@@ -45,6 +45,18 @@ class TestUpdate < Minitest::Test
     end
   end
 
+  def test_cancels_slow_judge
+    Dir.mktmpdir do |d|
+      save_it(File.join(d, 'foo/foo.rb'), 'sleep 10; $fb.insert.foo = 1')
+      file = File.join(d, 'base.fb')
+      Judges::Update.new(Loog::NULL).run({ 'timeout' => 0.1 }, [d, file])
+      fb = Factbase.new
+      fb.import(File.binread(file))
+      xml = Nokogiri::XML.parse(Factbase::ToXML.new(fb).xml)
+      assert(xml.xpath('/fb/f').empty?, xml)
+    end
+  end
+
   def test_extend_existing_factbase
     Dir.mktmpdir do |d|
       file = File.join(d, 'base.fb')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: judges
 version: !ruby/object:Gem::Version
-  version: 0.28.1
+  version: 0.29.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-19 00:00:00.000000000 Z
+date: 2024-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -192,6 +192,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timeout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement