judges 0.0.24 → 0.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed5fca9c346d6f092bde73a242e8b347f2abba9f7330767db25edca3d1df1dd3
-  data.tar.gz: cbb70db60a4dc7c953cfa6feea4d5955a27f76cf34b3c5403423e8e3b804db84
+  metadata.gz: 2326cabc04af248b0125f37645bd07fce0d9f19633f6ebaa10fdcf134da35b73
+  data.tar.gz: ede2d649e85f3d5f637daaa963bf56887b2150345ede96bb7fd4c53f7e5f1400
 SHA512:
-  metadata.gz: c6d4dffa49971e1dc77788263b005d843223bf96faba1cb67333b773f411fdd9b6920577f1edaab9ae9e6fcb7191c37febc2b1ae0ee55d6fa272f45f36242aa2
-  data.tar.gz: a0cde0d189d3ae6bf15da5252fb03dc530103de68adeb2379dc048a2354987bb5371863352640a64cc04663db5b4c099ff7ae474f793ce4ff7f6589f5f0b4da5
+  metadata.gz: 5ed7d4a0d763cd9f1a5a565033cd42e69e8d52b113f8b117832861ad8d9c22194667ef6759aa8c4c8806cc754435a3cb9583c9951183eba01c7cb3f4aa83f03e
+  data.tar.gz: f3bfaee1fe32ff3315a533dc67019edc9e6c7fbb22db758917a17c0a643dc0a60a69e2e3641d9a954c426e39c928bef098ff1309dad18ce14bd69cf77aa061b0

data/.github/workflows/codecov.yml

@@ -19,7 +19,7 @@
 # SOFTWARE.
 ---
 name: codecov
-on:
+'on':
   push:
     branches:
       - master
@@ -31,7 +31,8 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 3.2
-      - run: bundle update
+          bundler-cache: true
+      - run: bundle install
       - run: bundle exec rake
       - uses: codecov/codecov-action@v4.0.0-beta.3
         with:

data/.github/workflows/rake.yml

@@ -31,7 +31,7 @@ jobs:
     name: test
     strategy:
       matrix:
-        os: [ubuntu-20.04, macos-12]
+        os: [ubuntu-20.04, macos-12, windows-2022]
         ruby: [3.2]
     runs-on: ${{ matrix.os }}
     steps:
@@ -39,5 +39,6 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      - run: bundle update
+          bundler-cache: true
+      - run: bundle install
       - run: bundle exec rake

data/.gitignore

@@ -1,5 +1,4 @@
 coverage/
-Gemfile.lock
 .idea/
 *.gem
 .bundle/

data/.rubocop.yml

@@ -22,6 +22,7 @@ AllCops:
   Exclude:
     - 'bin/**/*'
     - 'assets/**/*'
+    - 'vendor/**/*'
   DisplayCopNames: true
   TargetRubyVersion: 3.2
   SuggestExtensions: false
@@ -51,3 +52,5 @@ Layout/CaseIndentation:
   Enabled: false
 Naming/MethodParameterName:
   MinNameLength: 2
+Layout/EndOfLine:
+  EnforcedStyle: lf

data/Gemfile

@@ -28,6 +28,7 @@ gem 'minitest', '5.23.0', require: false
 gem 'rake', '13.2.1', require: false
 gem 'rspec-rails', '6.1.2', require: false
 gem 'rubocop', '1.63.5', require: false
+gem 'rubocop-performance', '1.21.0', require: false
 gem 'rubocop-rspec', '2.29.2', require: false
 gem 'simplecov', '0.22.0', require: false
 gem 'simplecov-cobertura', '2.1.0', require: false

data/Gemfile.lock

@@ -0,0 +1,235 @@
+PATH
+  remote: .
+  specs:
+    judges (0.0.0)
+      backtrace (~> 0.3)
+      factbase (~> 0.0.22)
+      gli (~> 2.21)
+      loog (~> 0.2)
+      nokogiri (~> 1.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.1.3.3)
+      actionview (= 7.1.3.3)
+      activesupport (= 7.1.3.3)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      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)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activesupport (7.1.3.3)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    backtrace (0.4.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    builder (3.2.4)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    cucumber (9.2.0)
+      builder (~> 3.2)
+      cucumber-ci-environment (> 9, < 11)
+      cucumber-core (> 13, < 14)
+      cucumber-cucumber-expressions (~> 17.0)
+      cucumber-gherkin (> 24, < 28)
+      cucumber-html-formatter (> 20.3, < 22)
+      cucumber-messages (> 19, < 25)
+      diff-lcs (~> 1.5)
+      mini_mime (~> 1.1)
+      multi_test (~> 1.1)
+      sys-uname (~> 1.2)
+    cucumber-ci-environment (10.0.1)
+    cucumber-core (13.0.2)
+      cucumber-gherkin (>= 27, < 28)
+      cucumber-messages (>= 20, < 23)
+      cucumber-tag-expressions (> 5, < 7)
+    cucumber-cucumber-expressions (17.1.0)
+      bigdecimal
+    cucumber-gherkin (27.0.0)
+      cucumber-messages (>= 19.1.4, < 23)
+    cucumber-html-formatter (21.3.1)
+      cucumber-messages (> 19, < 25)
+    cucumber-messages (22.0.0)
+    cucumber-tag-expressions (6.1.0)
+    diff-lcs (1.5.1)
+    docile (1.4.0)
+    drb (2.2.1)
+    erubi (1.12.0)
+    factbase (0.0.22)
+      json (~> 2.7)
+      loog (~> 0.2)
+      nokogiri (~> 1.10)
+      yaml (~> 0.3)
+    ffi (1.16.3)
+    ffi (1.16.3-x64-mingw-ucrt)
+    gli (2.21.1)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
+    irb (1.13.1)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    loog (0.5.1)
+    mini_mime (1.1.5)
+    minitest (5.23.0)
+    multi_test (1.1.0)
+    mutex_m (0.2.0)
+    nokogiri (1.16.5-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.5-x64-mingw-ucrt)
+      racc (~> 1.4)
+    nokogiri (1.16.5-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.5-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.24.0)
+    parser (3.3.1.0)
+      ast (~> 2.4.1)
+      racc
+    psych (5.1.2)
+      stringio
+    racc (1.7.3)
+    rack (3.0.11)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    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)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rdoc (6.6.3.1)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.2)
+    reline (0.5.7)
+      io-console (~> 0.5)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-rails (6.1.2)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.13)
+      rspec-expectations (~> 3.13)
+      rspec-mocks (~> 3.13)
+      rspec-support (~> 3.13)
+    rspec-support (3.13.1)
+    rubocop (1.63.5)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-performance (1.21.0)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rspec (2.29.2)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.28.3)
+      rubocop (~> 1.40)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-cobertura (2.1.0)
+      rexml
+      simplecov (~> 0.19)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    stringio (3.1.0)
+    strscan (3.1.0)
+    sys-uname (1.2.3)
+      ffi (~> 1.1)
+    thor (1.3.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    yaml (0.3.0)
+    yard (0.9.36)
+    zeitwerk (2.6.14)
+
+PLATFORMS
+  arm64-darwin-22
+  x64-mingw-ucrt
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  cucumber (= 9.2.0)
+  judges!
+  minitest (= 5.23.0)
+  rake (= 13.2.1)
+  rspec-rails (= 6.1.2)
+  rubocop (= 1.63.5)
+  rubocop-performance (= 1.21.0)
+  rubocop-rspec (= 2.29.2)
+  simplecov (= 0.22.0)
+  simplecov-cobertura (= 2.1.0)
+  yard (= 0.9.36)
+
+BUNDLED WITH
+   2.4.22

data/README.md

@@ -14,6 +14,41 @@
 A command line tool and a Ruby gem for running judges agains a
 [factbase](https://github.com/yegor256/factbase).
 
+Every "judge" is a directory with a single `.rb` file and a number
+of `.yml` files. A script in the Ruby file is executed with the following
+global variables available to it:
+
+* `$fb` — an instance
+  of [`Factbase`](https://www.rubydoc.info/gems/factbase/0.0.22/Factbase),
+  where facts may be added/updated;
+* `$loog` — an instance
+  of [`Loog`](https://www.rubydoc.info/gems/loog/0.5.1/Loog),
+  where `.info` and `.debug` logs are welcome;
+* `$options` — a holder of options coming from `.yml` files;
+* `$local` — a hash map that is cleaned up when all tests
+  in the pack are finished;
+* `$global` — a hash map that is never cleaned up;
+* `$judge` — the name of the directory, where the `.rb` script is located.
+
+Every `.yml` file must be formatted as such:
+
+```yaml
+input:
+  -
+    foo: 42
+    bar: Hello, world!
+options:
+  max: 100
+expected:
+  - /fb[count(f)=1]
+```
+
+Here, the `input` is an array of facts to be placed into the Factbase before
+the test starts; the `options` is a hash map of options to be passed
+via command line `--option` of the `update` command; and `expected` is
+an array of XPath expressions that must be present in the XML of the Factbase
+when the test is finished.
+
 ## How to contribute
 
 Read

data/bin/judges

@@ -32,7 +32,7 @@ Encoding.default_internal = Encoding::UTF_8
 class App
   extend GLI::App
 
-  ver = '0.0.24'
+  ver = '0.0.25'
 
   loog = Loog::REGULAR
 

data/features/step_definitions/steps.rb

@@ -47,7 +47,9 @@ end
 
 When(%r{^I run bin/judges with "([^"]*)"$}) do |arg|
   home = File.join(File.dirname(__FILE__), '../..')
-  @stdout = `GLI_DEBUG=true ruby -I#{home}/lib #{home}/bin/judges #{arg}`
+  cmd = "ruby -I#{home}/lib #{home}/bin/judges #{arg}"
+  cmd = "GLI_DEBUG=true #{cmd}" unless Gem.win_platform?
+  @stdout = `#{cmd}`
   @exitstatus = $CHILD_STATUS.exitstatus
 end
 

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

data/lib/judges/commands/test.rb

@@ -44,14 +44,16 @@ class Judges::Test
     @loog.info("Testing judges in #{dir.to_rel}...")
     errors = []
     done = 0
+    global = {}
     Judges::Packs.new(dir, opts['lib'], @loog).each_with_index do |p, i|
+      local = {}
       next unless include?(opts, p.name)
       @loog.info("\n👉 Testing #{p.script} (##{i}) in #{p.dir.to_rel}...")
       p.tests.each do |f|
         yaml = YAML.load_file(f, permitted_classes: [Time])
         @loog.info("Testing #{f.to_rel}:")
         begin
-          test_one(p, yaml)
+          test_one(p, global, local, yaml)
         rescue StandardError => e
           @loog.warn(Backtrace.new(e))
           errors << f
@@ -78,7 +80,7 @@ class Judges::Test
     packs.include?(name)
   end
 
-  def test_one(pack, yaml)
+  def test_one(pack, global, local, yaml)
     fb = Factbase.new
     yaml['input'].each do |i|
       f = fb.insert
@@ -92,7 +94,7 @@ class Judges::Test
         end
       end
     end
-    pack.run(Factbase::Looged.new(fb, @loog), Judges::Options.new(yaml['options']))
+    pack.run(Factbase::Looged.new(fb, @loog), global, local, Judges::Options.new(yaml['options']))
     xml = Nokogiri::XML.parse(fb.to_xml)
     yaml['expected'].each do |xp|
       raise "#{pack.script} doesn't match '#{xp}':\n#{xml}" if xml.xpath(xp).empty?

data/lib/judges/commands/update.rb

@@ -66,11 +66,13 @@ class Judges::Update
   def cycle(packs, fb, impex, options)
     errors = []
     diff = 0
+    global = {}
     done = packs.each_with_index do |p, i|
+      local = {}
       @loog.info("👉 Running #{p.name} (##{i}) at #{p.dir.to_rel}...")
       before = fb.size
       begin
-        p.run(fb, options)
+        p.run(fb, global, local, options)
       rescue StandardError => e
         @loog.warn(Backtrace.new(e))
         errors << p.script

data/lib/judges/pack.rb

@@ -39,11 +39,13 @@ class Judges::Pack
   end
 
   # Run it with the given Factbase and environment variables.
-  def run(fbase, options)
+  def run(fbase, global, local, options)
     $fb = fbase
     $judge = File.basename(@dir)
     $options = options
     $loog = @loog
+    $global = global
+    $local = local
     unless @lib.nil?
       raise "Lib dir #{@lib.to_rel} is absent" unless File.exist?(@lib)
       raise "Lib #{@lib.to_rel} is not a directory" unless File.directory?(@lib)

data/test/test_pack.rb

@@ -37,7 +37,7 @@ class TestPack < Minitest::Test
       File.write(File.join(d, 'foo.rb'), '$fb.insert')
       pack = Judges::Pack.new(d, nil, Loog::VERBOSE)
       fb = Factbase.new
-      pack.run(fb, {})
+      pack.run(fb, {}, {}, {})
       assert_equal(1, fb.size)
     end
   end
@@ -47,10 +47,10 @@ class TestPack < Minitest::Test
       File.write(File.join(d, 'bar.rb'), '$fb.insert')
       pack = Judges::Pack.new(d, nil, Loog::VERBOSE)
       fb1 = Factbase.new
-      pack.run(fb1, {})
+      pack.run(fb1, {}, {}, {})
       assert_equal(1, fb1.size)
       fb2 = Factbase.new
-      pack.run(fb2, {})
+      pack.run(fb2, {}, {}, {})
       assert_equal(1, fb2.size)
     end
   end
@@ -59,7 +59,25 @@ class TestPack < Minitest::Test
     Dir.mktmpdir do |d|
       File.write(File.join(d, 'x.rb'), 'once($fb).insert')
       pack = Judges::Pack.new(d, nil, Loog::VERBOSE)
-      pack.run(Factbase.new, {})
+      pack.run(Factbase.new, {}, {}, {})
+    end
+  end
+
+  def test_passes_local_vars_between_tests
+    Dir.mktmpdir do |d|
+      File.write(
+        File.join(d, 'x.rb'),
+        '
+        $local[:foo] = 42 if $local[:foo].nil?
+        $local[:foo] = $local[:foo] + 1
+        '
+      )
+      pack = Judges::Pack.new(d, nil, Loog::NULL)
+      local = {}
+      pack.run(Factbase.new, {}, local, {})
+      pack.run(Factbase.new, {}, local, {})
+      pack.run(Factbase.new, {}, local, {})
+      assert_equal(45, local[:foo])
     end
   end
 
@@ -70,7 +88,7 @@ class TestPack < Minitest::Test
       FileUtils.mkdir(dir)
       File.write(File.join(dir, 'foo.rb'), '$loog.info("judge=" + $judge)')
       log = Loog::Buffer.new
-      Judges::Pack.new(dir, nil, log).run(Factbase.new, {})
+      Judges::Pack.new(dir, nil, log).run(Factbase.new, {}, {}, {})
       assert(log.to_s.include?("judge=#{j}"))
     end
   end
@@ -85,7 +103,7 @@ class TestPack < Minitest::Test
       File.write(File.join(lib, 'y.rb'), '$foo = 42')
       pack = Judges::Pack.new(dir, lib, Loog::VERBOSE)
       fb = Factbase.new
-      pack.run(fb, {})
+      pack.run(fb, {}, {}, {})
       assert_equal(42, fb.query('()').each.to_a.first.bar)
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: judges
 version: !ruby/object:Gem::Version
-  version: 0.0.24
+  version: 0.0.25
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -107,6 +107,7 @@ files:
 - ".rultor.yml"
 - ".simplecov"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile