judges 0.0.2 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e7eeb4b709d0a2438806f8165bd693f493b38f43f42d7bf02ad11c776f50258
-  data.tar.gz: 48399e95c0dad8a6ca81055a44aea5a20e946b5e5b61ab2a809d13d594f8f7fc
+  metadata.gz: da7a3c5173e276f56441e87c312ce192650cbd0777846c5326cf7dd067bc90df
+  data.tar.gz: fb1a4eb7b10b2fa31e29b87462bca14d26dd01c5d77ce0468148f06bfcc7de08
 SHA512:
-  metadata.gz: 9dfc4c9282394baba0cdd7fc6ee9bb2245a76cd8db4486f6378df54cf893661273884ab2dd82d46cf2eef549c128182c88d263217f9dddd7375542b8a0c8953c
-  data.tar.gz: 76b7e0fb15421f3223d765e9b68c9bccd76b4c81134e1994ab432742fa280afd03c78d0734df3cc6f52cc38090d0ca9b5726223ce4da4f0ba7cf195e5ee1abe9
+  metadata.gz: aaa735ed030325cdf7800c6f4c34229de7b8bbee35acb685fa6f61a3e3bdfe989522c2f3eacf356fb13c26324e258c7a26021678fa6a3aa052ea52b2141f4fc5
+  data.tar.gz: 773bdad461b779ee18124bcab2da86142faab47cf866a6b9ee86c04e6cd42e2d5f4647d37dcfdca26dbbcc4e64531c374a08ab60adad0f2788c3dce9690c2bab

data/.github/workflows/zerocracy.yaml

@@ -0,0 +1,38 @@
+# Copyright (c) 2024 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+---
+name: zerocracy
+on:
+  schedule:
+    - cron: '0,10,20,30,50,50 * * * *'
+concurrency:
+  group: zerocracy
+  cancel-in-progress: true
+jobs:
+  yamllint:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: zerocracy/judges-action@master
+      - uses: JamesIves/github-pages-deploy-action@v4.6.0
+        with:
+          branch: gh-pages
+          folder: factbase.yml
+          clean: true

data/.gitignore

@@ -6,4 +6,5 @@ Gemfile.lock
 .DS_Store
 rdoc/
 doc/
-.yardoc/
+.yardoc/
+temp/

data/.rubocop.yml

@@ -47,3 +47,5 @@ Metrics/PerceivedComplexity:
   Enabled: false
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
+Layout/CaseIndentation:
+  Enabled: false

data/bin/judges

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-# Copyright (c) 2014-2024 Yegor Bugayenko
+# Copyright (c) 2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -36,7 +36,7 @@ class App
 
   program_desc 'Automated executor of judges for a factbase'
 
-  version '0.0.2'
+  version '0.0.9'
 
   desc 'Make it more verbose, logging as much as possible'
   switch([:v, :verbose])
@@ -53,15 +53,25 @@ class App
     c.desc 'Environment variable to pass to every judge'
     c.flag([:e, :environment], default_value: 'yes')
     c.action do |global, options, args|
-      require_relative '../lib/judges/update'
+      require_relative '../lib/judges/commands/update'
       Judges::Update.new(loog).run(options, args)
     end
   end
 
+  desc 'Print the factbase into a human-readable format (YAML, JSON, etc.)'
+  command :print do |c|
+    c.desc 'Output format (xml, json, or yaml)'
+    c.flag([:format], default_value: 'yaml')
+    c.action do |global, options, args|
+      require_relative '../lib/judges/commands/print'
+      Judges::Print.new(loog).run(options, args)
+    end
+  end
+
   desc 'Run automated tests for all judges'
   command :test do |c|
     c.action do |global, options, args|
-      require_relative '../lib/judges/test'
+      require_relative '../lib/judges/commands/test'
       Judges::Test.new(loog).run(options, args)
     end
   end

data/features/cli.feature

@@ -11,13 +11,32 @@ Feature: Simple Run
     Then Exit code is zero
 
   Scenario: Simple run of a few judges
-    Given I have a "simple/simple_judge.rb" file with content:
+    Given I make a temp directory
+    Then I have a "simple/simple_judge.rb" file with content:
     """
       $fb.query("(eq kind 'foo')").each do |f|
         n = $fb.insert
         n.kind = 'yes!'
       end
     """
-    When I run bin/judges with "update . simple.fb"
+    Then I run bin/judges with "update . simple.fb"
     Then Stdout contains "1 judges processed"
     And Exit code is zero
+
+  Scenario: Simple test of a few judges
+    Given I run bin/judges with "update ./fixtures temp/simple.fb"
+    Then Stdout contains "judges processed"
+    And Exit code is zero
+
+  Scenario: Simple print of a small factbase
+    Given I make a temp directory
+    Then I have a "simple/simple_judge.rb" file with content:
+    """
+      n = $fb.insert
+      n.kind = 'yes!'
+    """
+    Then I run bin/judges with "update . simple.fb"
+    Then I run bin/judges with "print --format=yaml simple.fb simple.yml"
+    Then Stdout contains "printed"
+    And Exit code is zero
+

data/features/gem_package.feature

@@ -3,7 +3,8 @@ Feature: Gem Package
   package the Gem into .gem file
 
   Scenario: Gem can be packaged
-    Given I have a "execs.rb" file with content:
+    Given I make a temp directory
+    Then I have a "execs.rb" file with content:
     """
     #!/usr/bin/env ruby
     require 'rubygems'

data/features/step_definitions/steps.rb

@@ -25,14 +25,19 @@ require 'English'
 
 Before do
   @cwd = Dir.pwd
-  @dir = Dir.mktmpdir('test')
-  FileUtils.mkdir_p(@dir)
-  Dir.chdir(@dir)
 end
 
 After do
-  Dir.chdir(@cwd)
-  FileUtils.rm_rf(@dir)
+  unless @tmp.nil?
+    Dir.chdir(@cwd)
+    FileUtils.rm_rf(@tmp)
+  end
+end
+
+Given(/^I make a temp directory$/) do
+  @tmp = Dir.mktmpdir('test')
+  FileUtils.mkdir_p(@tmp)
+  Dir.chdir(@tmp)
 end
 
 Given(/^I have a "([^"]*)" file with content:$/) do |file, text|
@@ -46,6 +51,18 @@ When(%r{^I run bin/judges with "([^"]*)"$}) do |arg|
   @exitstatus = $CHILD_STATUS.exitstatus
 end
 
+When(/^I run bash with "([^"]*)"$/) do |text|
+  FileUtils.copy_entry(@cwd, File.join(@tmp, 'judges'))
+  @stdout = `#{text}`
+  @exitstatus = $CHILD_STATUS.exitstatus
+end
+
+When(/^I run bash with:$/) do |text|
+  FileUtils.copy_entry(@cwd, File.join(@tmp, 'judges'))
+  @stdout = `#{text}`
+  @exitstatus = $CHILD_STATUS.exitstatus
+end
+
 Then(/^Stdout contains "([^"]*)"$/) do |txt|
   raise "STDOUT doesn't contain '#{txt}':\n#{@stdout}" unless @stdout.include?(txt)
 end
@@ -61,15 +78,3 @@ end
 Then(/^Exit code is not zero$/) do
   raise 'Zero exit code' if @exitstatus.zero?
 end
-
-When(/^I run bash with "([^"]*)"$/) do |text|
-  FileUtils.copy_entry(@cwd, File.join(@dir, 'judges'))
-  @stdout = `#{text}`
-  @exitstatus = $CHILD_STATUS.exitstatus
-end
-
-When(/^I run bash with:$/) do |text|
-  FileUtils.copy_entry(@cwd, File.join(@dir, 'judges'))
-  @stdout = `#{text}`
-  @exitstatus = $CHILD_STATUS.exitstatus
-end

data/features/support/env.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2022-2024 Yegor Bugayenko
+# Copyright (c) 2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/fixtures/reward_for_good_bug/no-reward.yml

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2024 Yegor Bugayenko
+# Copyright (c) 2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/fixtures/reward_for_good_bug/reward_it.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2014-2024 Yegor Bugayenko
+# Copyright (c) 2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/fixtures/reward_for_good_bug/simple-reward.yml

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2024 Yegor Bugayenko
+# Copyright (c) 2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/judges.gemspec

@@ -24,12 +24,16 @@ require 'English'
 
 Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
-  s.required_ruby_version = '>=2.3'
+  s.required_ruby_version = '>=3.2'
   s.name = 'judges'
-  s.version = '0.0.2'
+  s.version = '0.0.9'
   s.license = 'MIT'
-  s.summary = 'Command-line tool for a Factbase'
-  s.description = 'Runs a collection of judges against a factbase'
+  s.summary = 'Command-Line Tool for a Factbase'
+  s.description = '
+  Runs a collection of \"judges\" against a \"factbase,\" modifying it and updating.
+  Also, helps printing a factbase, merge with another one, inspect, and so on.
+  Also, helps run automated tests for a set of judges.
+  '
   s.authors = ['Yegor Bugayenko']
   s.email = 'yegor256@gmail.com'
   s.homepage = 'http://github.com/yegor256/judges'

data/lib/judges/commands/print.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2024 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'fileutils'
+require 'factbase'
+require_relative '../../judges'
+require_relative '../../judges/packs'
+
+# Update.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class Judges::Print
+  def initialize(loog)
+    @loog = loog
+  end
+
+  def run(opts, args)
+    raise 'Exactly two arguments required' unless args.size == 2
+    f = args[0]
+    raise "The file is absent: #{f}" unless File.exist?(f)
+    o = args[1]
+    fb = Factbase.new
+    fb.import(File.read(f))
+    @loog.info("Factbase imported from #{f} (#{File.size(f)} bytes)")
+    FileUtils.mkdir_p(File.dirname(o))
+    output =
+      case opts[:format].downcase
+        when 'yaml'
+          fb.to_yaml
+        when 'json'
+          fb.to_json
+        when 'xml'
+          fb.to_xml
+      end
+    File.write(o, output)
+    @loog.info("Factbase printed to #{o} (#{File.size(o)} bytes)")
+  end
+end

data/lib/judges/{test.rb → commands/test.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2014-2024 Yegor Bugayenko
+# Copyright (c) 2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -22,8 +22,8 @@
 
 require 'factbase'
 require 'nokogiri'
-require_relative '../judges'
-require_relative '../judges/packs'
+require_relative '../../judges'
+require_relative '../../judges/packs'
 
 # Test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)

data/lib/judges/{update.rb → commands/update.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2014-2024 Yegor Bugayenko
+# Copyright (c) 2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -21,8 +21,9 @@
 # SOFTWARE.
 
 require 'factbase'
-require_relative '../judges'
-require_relative '../judges/packs'
+require 'fileutils'
+require_relative '../../judges'
+require_relative '../../judges/packs'
 
 # Update.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
@@ -36,6 +37,7 @@ class Judges::Update
   def run(_opts, args)
     raise 'Exactly two arguments required' unless args.size == 2
     dir = args[0]
+    raise "The directory is absent: #{dir}" unless File.exist?(dir)
     file = args[1]
     fb = Factbase.new
     if File.exist?(file)
@@ -49,6 +51,7 @@ class Judges::Update
       p.run(fb, {})
     end
     @loog.info("#{done} judges processed")
+    FileUtils.mkdir_p(File.dirname(file))
     File.write(file, fb.export)
     @loog.info("Factbase exported to #{file} (#{File.size(file)} bytes)")
   end

data/lib/judges/pack.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2014-2024 Yegor Bugayenko
+# Copyright (c) 2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -44,7 +44,7 @@ class Judges::Pack
     end
     s = File.join(@dir, script)
     raise "Can't load '#{s}'" unless File.exist?(s)
-    require s
+    load s
   end
 
   # Get the name of the .rb script in the pack.

data/lib/judges/packs.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2014-2024 Yegor Bugayenko
+# Copyright (c) 2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/test/commands/test_print.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2024 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'minitest/autorun'
+require 'loog'
+require 'factbase'
+require 'yaml'
+require_relative '../../lib/judges'
+require_relative '../../lib/judges/commands/print'
+
+# Test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class TestPrint < Minitest::Test
+  def test_simple_print
+    Dir.mktmpdir do |d|
+      f = File.join(d, 'base.fb')
+      fb = Factbase.new
+      fb.insert
+      File.write(f, fb.export)
+      y = File.join(d, 'base.yml')
+      Judges::Print.new(Loog::VERBOSE).run({ format: 'yaml' }, [f, y])
+      puts File.read(y)
+      assert(File.exist?(y))
+      assert_equal(1, YAML.load_file(y)['facts'].size)
+    end
+  end
+end

data/test/{test_test.rb → commands/test_test.rb}

@@ -22,8 +22,8 @@
 
 require 'minitest/autorun'
 require 'loog'
-require_relative '../lib/judges'
-require_relative '../lib/judges/test'
+require_relative '../../lib/judges'
+require_relative '../../lib/judges/commands/test'
 
 # Test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
@@ -41,8 +41,8 @@ class TestTest < Minitest::Test
             foo: 42
         expected:
           - /fb[count(f)=1]
-          - /fb/f[foo/v='42']
-          - /fb/f[bar/v='4']
+          - /fb/f[foo='42']
+          - /fb/f[bar='4']
         YAML
       )
       Judges::Test.new(Loog::VERBOSE).run(nil, [d])

data/test/{test_update.rb → commands/test_update.rb}

@@ -22,8 +22,8 @@
 
 require 'minitest/autorun'
 require 'loog'
-require_relative '../lib/judges'
-require_relative '../lib/judges/update'
+require_relative '../../lib/judges'
+require_relative '../../lib/judges/commands/update'
 
 # Test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)

data/test/test_pack.rb

@@ -24,7 +24,7 @@ require 'minitest/autorun'
 require 'tmpdir'
 require 'factbase'
 require_relative '../lib/judges'
-require_relative '../lib/judges/packs'
+require_relative '../lib/judges/pack'
 
 # Test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
@@ -40,4 +40,17 @@ class TestPack < Minitest::Test
       assert_equal(1, fb.size)
     end
   end
+
+  def test_run_isolated
+    Dir.mktmpdir do |d|
+      File.write(File.join(d, 'bar.rb'), '$fb.insert')
+      pack = Judges::Pack.new(d)
+      fb1 = Factbase.new
+      pack.run(fb1, {})
+      assert_equal(1, fb1.size)
+      fb2 = Factbase.new
+      pack.run(fb2, {})
+      assert_equal(1, fb2.size)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: judges
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.9
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -80,7 +80,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
-description: Runs a collection of judges against a factbase
+description: "\n  Runs a collection of \\\"judges\\\" against a \\\"factbase,\\\"
+  modifying it and updating.\n  Also, helps printing a factbase, merge with another
+  one, inspect, and so on.\n  Also, helps run automated tests for a set of judges.\n
+  \ "
 email: yegor256@gmail.com
 executables:
 - judges
@@ -98,6 +101,7 @@ files:
 - ".github/workflows/rake.yml"
 - ".github/workflows/xcop.yml"
 - ".github/workflows/yamllint.yml"
+- ".github/workflows/zerocracy.yaml"
 - ".gitignore"
 - ".pdd"
 - ".rubocop.yml"
@@ -112,23 +116,25 @@ files:
 - features/gem_package.feature
 - features/step_definitions/steps.rb
 - features/support/env.rb
+- fixtures/reward_for_good_bug/README.md
 - fixtures/reward_for_good_bug/no-reward.yml
-- fixtures/reward_for_good_bug/reason.md
 - fixtures/reward_for_good_bug/reward_it.rb
 - fixtures/reward_for_good_bug/simple-reward.yml
 - judges.gemspec
 - lib/judges.rb
+- lib/judges/commands/print.rb
+- lib/judges/commands/test.rb
+- lib/judges/commands/update.rb
 - lib/judges/pack.rb
 - lib/judges/packs.rb
-- lib/judges/test.rb
-- lib/judges/update.rb
 - renovate.json
+- test/commands/test_print.rb
+- test/commands/test_test.rb
+- test/commands/test_update.rb
 - test/test__helper.rb
 - test/test_judges.rb
 - test/test_pack.rb
 - test/test_packs.rb
-- test/test_test.rb
-- test/test_update.rb
 homepage: http://github.com/yegor256/judges
 licenses:
 - MIT
@@ -143,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -153,5 +159,5 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
-summary: Command-line tool for a Factbase
+summary: Command-Line Tool for a Factbase
 test_files: []