judges 0.0.19 → 0.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22748b35c785164e5fef5f8a6d013d92c380e2023d9806759339a11763f51554
-  data.tar.gz: 9245a7682189a256d5cd2b2779c7163189e751db721d0dd0eeb54e804bb0e7ca
+  metadata.gz: 428132cb0468f9c9e0fb7c3a51628cfb4f8b07a0ff26493cd476f10a8461ca02
+  data.tar.gz: 158206dab846c53314f29ed607e5789ede80e2b18c778dca09bd65ce67adaf93
 SHA512:
-  metadata.gz: 0b8d102de3483627367d4f8705b5473324f469b9a9d7367bbdee224f3d1db6e37a8ed34bab345ef6930dd321f473781b69e314c53aab2e499c8f8f10916ef519
-  data.tar.gz: d564a60e8d813fb4b785b0e4c084012f360c920ced92138bdf0f247f3aa89e1e5ac86104f928129cc2cc24b1c705d3d7f59c2d25bd59f019a4958024e0dcaa06
+  metadata.gz: c594b09ee2a9ea407344adf6e0a89f5e32f6ae2c4294810f89ac617dd9878cf3cee336ac2b3db934bfff1db68bf9b6a277d6a1b2d3afcf720fc34b58a12f73ab
+  data.tar.gz: 298affb7b7f6882a98a52117bc7fb5270e6ed71616505891d4b71080e53131b55236fe54de2a465a91a302d4ef2b70f361630bc4536a46c1a5190d9e9442fca6

data/bin/judges

@@ -29,7 +29,7 @@ require 'factbase'
 Encoding.default_external = Encoding::UTF_8
 Encoding.default_internal = Encoding::UTF_8
 
-ver = '0.0.19'
+ver = '0.0.21'
 
 include GLI::App
 
@@ -88,19 +88,28 @@ 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.desc 'Generate output name of the file automatically'
+  c.switch([:auto], default_value: false)
   c.action do |global, options, args|
     require_relative '../lib/judges/commands/print'
     Judges::Print.new(loog).run(options, args)
   end
 end
 
+desc 'Inspect the factbase and print all its possible meta-data'
+command :inspect do |c|
+  c.action do |global, options, args|
+    require_relative '../lib/judges/commands/inspect'
+    Judges::Inspect.new(loog).run(options, args)
+  end
+end
+
 desc 'Run automated tests for all judges'
 command :test do |c|
   c.desc 'Name of the test pack to run'
   c.flag([:pack], multiple: true)
-  c.desc 'Fail if no judges tested?'
-  c.flag([:quiet], default_value: false)
+  c.desc 'Stay quiet even if some tests fail or simply no tests executed?'
+  c.switch([:quiet], default_value: false)
   c.action do |global, options, args|
     require_relative '../lib/judges/commands/test'
     Judges::Test.new(loog).run(options, args)

data/features/cli.feature

@@ -27,12 +27,12 @@ Feature: Simple Run
   Scenario: Simple test of a few judges
     Given I run bin/judges with "test ./fixtures"
     Then Stdout contains "👉 Testing"
-    Then Stdout contains "judges tested successfully"
+    Then Stdout contains "judge(s) tested successfully"
     And Exit code is zero
 
   Scenario: Simple test of just one pack
     Given I run bin/judges with "test --pack reward_for_good_bug ./fixtures"
-    Then Stdout contains "judges tested successfully"
+    Then Stdout contains "judge(s) tested successfully"
     And Exit code is zero
 
   Scenario: Simple test of no packs
@@ -64,3 +64,16 @@ Feature: Simple Run
     Then Stdout contains "printed"
     And Exit code is zero
 
+  Scenario: Simple inspect of a small factbase
+    Given I make a temp directory
+    Then I have a "simple/simple_judge.rb" file with content:
+    """
+      return if $fb.size > 2
+      n = $fb.insert
+      n.kind = 'yes!'
+    """
+    Then I run bin/judges with "update . simple.fb"
+    Then I run bin/judges with "inspect simple.fb"
+    Then Stdout contains "Facts: 3"
+    And Exit code is zero
+

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.19'
+  s.version = '0.0.21'
   s.license = 'MIT'
   s.summary = 'Command-Line Tool for a Factbase'
   s.description = '
@@ -42,7 +42,7 @@ Gem::Specification.new do |s|
   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 'factbase', '~>0.0.16'
+  s.add_runtime_dependency 'factbase', '~>0.0.21'
   s.add_runtime_dependency 'gli', '~>2.21'
   s.add_runtime_dependency 'loog', '~>0.2'
   s.add_runtime_dependency 'nokogiri', '~> 1.10'

data/lib/judges/commands/inspect.rb

@@ -0,0 +1,40 @@
+# 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_relative '../../judges'
+require_relative '../../judges/impex'
+
+# Inspect.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class Judges::Inspect
+  def initialize(loog)
+    @loog = loog
+  end
+
+  def run(_opts, args)
+    raise 'At lease one argument required' if args.empty?
+    fb = Judges::Impex.new(@loog, args[0]).import
+    @loog.info("Facts: #{fb.size}")
+  end
+end

data/lib/judges/commands/print.rb

@@ -23,8 +23,7 @@
 require 'fileutils'
 require 'factbase'
 require_relative '../../judges'
-require_relative '../../judges/to_rel'
-require_relative '../../judges/packs'
+require_relative '../../judges/impex'
 
 # Update.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
@@ -37,17 +36,14 @@ class Judges::Print
 
   def run(opts, args)
     raise 'At lease one argument required' if args.empty?
-    f = args[0]
-    raise "The file is absent: #{f.to_rel}" unless File.exist?(f)
     o = args[1]
+    f = args[0]
+    fb = Judges::Impex.new(@loog, f).import
     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.binread(f))
-    @loog.info("Factbase imported from #{f.to_rel} (#{File.size(f)} bytes)")
     FileUtils.mkdir_p(File.dirname(o))
     output =
       case opts[:format].downcase

data/lib/judges/commands/test.rb

@@ -23,6 +23,7 @@
 require 'nokogiri'
 require 'factbase'
 require 'backtrace'
+require 'factbase/looged'
 require_relative '../../judges'
 require_relative '../../judges/to_rel'
 require_relative '../../judges/packs'
@@ -58,12 +59,14 @@ class Judges::Test
       end
       done += 1
     end
-    raise 'No judges tested :(' if done.zero? && !opts['quiet']
-    if errors.empty?
-      @loog.info("\nAll #{done} judges tested successfully")
+    if done.zero?
+      raise 'No judges tested :(' unless opts['quiet']
+      @loog.warn("\n👍 No judges tested")
+    elsif errors.empty?
+      @loog.info("\n👍 All #{done} judge(s) tested successfully")
     else
-      @loog.info("\n#{done} judges tested, #{errors.size} of them failed")
-      raise "#{errors.size} tests failed" unless errors.empty?
+      @loog.info("\n❌ #{done} judge(s) tested, #{errors.size} of them failed")
+      raise "#{errors.size} tests failed" unless opts['quiet']
     end
   end
 
@@ -89,7 +92,7 @@ class Judges::Test
         end
       end
     end
-    pack.run(fb, Judges::Options.new(yaml['options']))
+    pack.run(Factbase::Looged.new(fb, @loog), 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

@@ -21,6 +21,7 @@
 # SOFTWARE.
 
 require 'backtrace'
+require 'factbase/looged'
 require_relative '../../judges'
 require_relative '../../judges/to_rel'
 require_relative '../../judges/packs'
@@ -42,6 +43,7 @@ class Judges::Update
     raise "The directory is absent: #{dir.to_rel}" unless File.exist?(dir)
     impex = Judges::Impex.new(@loog, args[1])
     fb = impex.import(strict: false)
+    fb = Factbase::Looged.new(fb, @loog)
     options = Judges::Options.new(opts['option'])
     @loog.debug("The following options provided:\n\t#{options.to_s.gsub("\n", "\n\t")}")
     packs = Judges::Packs.new(dir, @loog)
@@ -65,7 +67,7 @@ class Judges::Update
     errors = []
     diff = 0
     done = packs.each_with_index do |p, i|
-      @loog.info("Running #{p.dir.to_rel} (##{i})...")
+      @loog.info("👍 Running #{p.name} (##{i}) at #{p.dir.to_rel}...")
       before = fb.size
       begin
         p.run(fb, options)

data/lib/judges/fb/if_absent.rb

@@ -21,14 +21,24 @@
 # SOFTWARE.
 
 require 'judges'
+require 'time'
 
 # Injects a fact if it's absent in the factbase.
 def if_absent(fb)
   attrs = {}
   f = Judges::Accumulator.new(attrs)
   yield f
-  q = attrs.map { |k, v| "(eq #{k} #{v})" }.join(' ')
-  return unless fb.query("(and #{q})").each.to_a.empty?
+  q = attrs.map do |k, v|
+    vv = v.to_s
+    if v.is_a?(String)
+      vv = "'#{vv.gsub('"', '\\"').gsub("'", "\\'")}'"
+    elsif v.is_a?(Time)
+      vv = v.iso8601
+    end
+    "(eq #{k} #{vv})"
+  end.join(' ')
+  q = "(and #{q})"
+  return unless fb.query(q).each.to_a.empty?
   n = fb.insert
   attrs.each { |k, v| n.send("#{k}=", v) }
   n

data/test/commands/test_inspect.rb

@@ -0,0 +1,46 @@
+# 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_relative '../../lib/judges'
+require_relative '../../lib/judges/commands/inspect'
+
+# Test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class TestInspect < Minitest::Test
+  def test_simple_inspect
+    Dir.mktmpdir do |d|
+      f = File.join(d, 'base.fb')
+      fb = Factbase.new
+      fb.insert
+      fb.insert
+      File.binwrite(f, fb.export)
+      loog = Loog::Buffer.new
+      Judges::Inspect.new(loog).run({}, [f])
+      assert(loog.to_s.include?('Facts: 2'))
+    end
+  end
+end

data/test/fb/test_if_absent.rb

@@ -23,6 +23,8 @@
 require 'minitest/autorun'
 require 'tmpdir'
 require 'factbase'
+require 'factbase/looged'
+require 'loog'
 require_relative '../../lib/judges'
 require_relative '../../lib/judges/fb/if_absent'
 
@@ -33,9 +35,19 @@ require_relative '../../lib/judges/fb/if_absent'
 class TestIfAbsent < Minitest::Test
   def test_ignores
     fb = Factbase.new
-    fb.insert.foo = 42
+    fb.insert.foo = 'hello dude'
     n = if_absent(fb) do |f|
-      f.foo = 42
+      f.foo = 'hello dude'
+    end
+    assert(n.nil?)
+  end
+
+  def test_ignores_with_time
+    fb = Factbase.new
+    t = Time.now
+    fb.insert.foo = t
+    n = if_absent(fb) do |f|
+      f.foo = t
     end
     assert(n.nil?)
   end
@@ -47,4 +59,38 @@ class TestIfAbsent < Minitest::Test
     end
     assert_equal(42, n.foo)
   end
+
+  def test_complex_ignores
+    fb = Factbase.new
+    f1 = fb.insert
+    f1.foo = 'hello, "dude"!'
+    f1.abc = 42
+    t = Time.now
+    f1.z = t
+    f1.bar = 3.14
+    n = if_absent(fb) do |f|
+      f.foo = 'hello, "dude"!'
+      f.abc = 42
+      f.z = t
+      f.bar = 3.14
+    end
+    assert(n.nil?)
+  end
+
+  def test_complex_injects
+    fb = Factbase.new
+    f1 = fb.insert
+    f1.foo = 'hello, "dude"!'
+    f1.abc = 42
+    t = Time.now
+    f1.z = t
+    f1.bar = 3.14
+    n = if_absent(fb) do |f|
+      f.foo = 'hello, "dude"!'
+      f.abc = 42
+      f.z = t + 1
+      f.bar = 3.15
+    end
+    assert(!n.nil?)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: judges
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.21
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.16
+        version: 0.0.21
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.16
+        version: 0.0.21
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
@@ -121,6 +121,7 @@ files:
 - fixtures/reward_for_good_bug/simple-reward.yml
 - judges.gemspec
 - lib/judges.rb
+- lib/judges/commands/inspect.rb
 - lib/judges/commands/join.rb
 - lib/judges/commands/print.rb
 - lib/judges/commands/test.rb
@@ -134,6 +135,7 @@ files:
 - lib/judges/packs.rb
 - lib/judges/to_rel.rb
 - renovate.json
+- test/commands/test_inspect.rb
 - test/commands/test_join.rb
 - test/commands/test_print.rb
 - test/commands/test_test.rb