judges 0.0.3 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8fa940672a16773cc8c32985a34d17be69953bfe402720276139d5e0729cab3
-  data.tar.gz: 9a06976c0a9853a2f8df682ab226d1d1e99944686f9d928e758c96d5b4a0c0f3
+  metadata.gz: 550115852b44ae26b7af9cb776bcbf9e5b7e043579ab8eec3930854f573a6768
+  data.tar.gz: 7efe473542ffd401220d8e5b65d853ba144ad8ceab0273f9531e3d462e072afc
 SHA512:
-  metadata.gz: 809aae9b795fc20d590482ed7d5d10f4f67aabfe3d5313e6f91972e285791fcc2c460908535c2fb83d7e6d2459f0d05bc594eb31d5c5ca43ac77f4cd20b2dfd2
-  data.tar.gz: ee8d097cbb5dc297b9abbcdac9d47a7dc826ba1e1d9af68f2a37552eef6f5ee781222e229546bf03236d12c18eaacd1fe9d3eee2452b9efdb365235e9b1f58c5
+  metadata.gz: '096f25e43ee418b94ae0a2f4b3d678c170170dfda2228191a269931bcfa1150e4f50151830e1132b3282ccaa768b2129deb8f29e55faebefd0bc7c2bd5ce2700'
+  data.tar.gz: d3f8922eeee30008f3883a7592667ce084a1d96785c4b04c51478c028ba99aa28eaddd151ac13a1bb7a101de8cc0f05434d22edcf6bbb1691b4bb76a4bd89067

data/.github/workflows/zerocracy.yaml

@@ -0,0 +1,42 @@
+# 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
+        with:
+          factbase: recent.fb
+      - run: mkdir gh-pages && cp recent.yml gh-pages
+      - uses: JamesIves/github-pages-deploy-action@v4.6.0
+        with:
+          branch: gh-pages
+          folder: gh-pages/recent.yml
+          factbase: recent.fb
+          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

@@ -36,7 +36,7 @@ class App
 
   program_desc 'Automated executor of judges for a factbase'
 
-  version '0.0.3'
+  version '0.0.10'
 
   desc 'Make it more verbose, logging as much as possible'
   switch([:v, :verbose])
@@ -53,15 +53,26 @@ 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.switch([:auto])
+    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/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.3'
+  s.version = '0.0.10'
   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,63 @@
+# 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 'At lease one argument required' if args.empty?
+    f = args[0]
+    raise "The file is absent: #{f}" unless File.exist?(f)
+    o = args[1]
+    if o.nil?
+      raise 'Either provide output file name or use --auto' unless opts[:auto]
+      o = File.join(File.dirname(f), File.basename(f).gsub(/\.[^.]*$/, ''))
+      o = "#{o}.#{opts[:format]}"
+    end
+    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}

@@ -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}

@@ -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/test/commands/test_print.rb

@@ -0,0 +1,47 @@
+# 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)
+      Judges::Print.new(Loog::VERBOSE).run({ format: 'yaml', auto: true }, [f])
+      y = File.join(d, 'base.yaml')
+      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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: judges
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.10
 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: []