judges 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eed10a2293bdfe6ddfc33e7623d7eb8f905428f60fd002c55e7eb75afdcd96f
-  data.tar.gz: df6b6941021d0c4fbcdb22d4608d41365ca7e537104eda09909f56cb4dd8dd3d
+  metadata.gz: c525e90c9ec78d8d7b745c026e07d033427b6193e185bd28d2edc153f254c863
+  data.tar.gz: bff22a2e3f8d9813261f76df90a7087454e393e66f997822717422d4ddfdc084
 SHA512:
-  metadata.gz: 07a943829af24cf0388303f9804f8b476449e3feea10ec3fa3703278ffb96e3b8c7a342d06e611e99168a8711397c380fdb70e8504fecaa22be48a6db0627550
-  data.tar.gz: 605f4d9c1598a4950098837ae6d8a8a432b882d1d4da75f93df78e530a584101642fbed0eb76d3df728f7dae4adbe30fb86c517ded6c16ff13f907b89ee4f797
+  metadata.gz: 7a490f1f175fdf0e663ae3f104c2901b86eed9e6d9b16192e59829802a821ae0cec67dc9a72400d7d40f2be228e3c8323508c8e7a210c1f562db0055d4e1a762
+  data.tar.gz: 3ec540d2d05fae0b620a3ee89ac4c1dad8d06cd3387cca7a4076490b9710bedcece3a373500208517ac47f0d14469444c60c783f810227045e7ae831a404aaa5

data/.github/workflows/{license.yml → copyrights.yml}

@@ -18,40 +18,13 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 ---
-name: license
+name: copyrights
 'on':
   push:
-    branches:
-      - master
   pull_request:
-    branches:
-      - master
 jobs:
-  license:
+  copyrights:
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v4
-      - shell: bash
-        run: |
-          header="Copyright (c) $(date +%Y) Yegor Bugayenko"
-          failed="false"
-          while IFS= read -r file; do
-            if ! grep -q "${header}" "${file}"; then
-              failed="true"
-              echo "⚠️ Copyright header is not found in: ${file}"
-            else
-              echo "File looks good: ${file}"
-            fi
-          done < <(find . -type f \( \
-            -name "Dockerfile" -o \
-            -name "LICENSE.txt" -o \
-            -name "Makefile" -o \
-            -name "Rakefile" -o \
-            -name "*.sh" -o \
-            -name "*.rb" -o \
-            -name "*.fe" -o \
-            -name "*.yml" \
-            \) -print)
-          if [ "${failed}" = "true" ]; then
-            exit 1
-          fi
+      - uses: yegor256/copyrights-action@0.0.4

data/Gemfile

@@ -30,7 +30,7 @@ gem 'rake', '13.2.1', require: false
 gem 'rspec-rails', '6.1.2', require: false
 gem 'rubocop', '1.64.1', require: false
 gem 'rubocop-performance', '1.21.0', require: false
-gem 'rubocop-rspec', '2.30.0', require: false
+gem 'rubocop-rspec', '2.31.0', require: false
 gem 'simplecov', '0.22.0', require: false
 gem 'simplecov-cobertura', '2.1.0', require: false
 gem 'webmock', '3.23.1', require: false

data/Gemfile.lock

@@ -47,7 +47,7 @@ GEM
     backtrace (0.4.0)
     base64 (0.2.0)
     bigdecimal (3.1.8)
-    builder (3.2.4)
+    builder (3.3.0)
     concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
     crack (1.0.0)
@@ -85,7 +85,7 @@ GEM
     erubi (1.12.0)
     ethon (0.16.0)
       ffi (>= 1.15.0)
-    factbase (0.0.42)
+    factbase (0.0.44)
       json (~> 2.7)
       loog (~> 0.2)
       nokogiri (~> 1.10)
@@ -209,7 +209,7 @@ GEM
     rubocop-performance (1.21.0)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rspec (2.30.0)
+    rubocop-rspec (2.31.0)
       rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
@@ -263,7 +263,7 @@ DEPENDENCIES
   rspec-rails (= 6.1.2)
   rubocop (= 1.64.1)
   rubocop-performance (= 1.21.0)
-  rubocop-rspec (= 2.30.0)
+  rubocop-rspec (= 2.31.0)
   simplecov (= 0.22.0)
   simplecov-cobertura (= 2.1.0)
   webmock (= 3.23.1)

data/README.md

@@ -34,6 +34,8 @@ global variables available to it:
 Every `.yml` file must be formatted as such:
 
 ```yaml
+category: slow
+runs: 1
 skip: false
 input:
   -
@@ -52,6 +54,12 @@ via the command line `--option` flag 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.
 
+The `category` (default: `[]`) may have one or an array of categories,
+which then may be turned on via the `--category` command line flag.
+
+The `runs` (default: `1`) is the number of times the `.rb` script should
+be executed. After each execution, all expected XPath expressions are validated.
+
 ## How to contribute
 
 Read

data/bin/judges

@@ -138,6 +138,8 @@ class App
     c.flag([:enable], multiple: true)
     c.desc 'Name of the judge to run (directory name)'
     c.flag([:judge], multiple: true)
+    c.desc 'How many times to run?'
+    c.flag([:runs], type: Integer, default_value: 1)
     c.desc 'The location of a Ruby library (directory with .rb files to include)'
     c.flag([:lib])
     c.desc 'Stay quiet even if some tests fail or simply no tests executed?'

data/features/test.feature

@@ -47,6 +47,25 @@ Feature: Test
     Then Stdout contains "All 1 judge(s) and 1 tests passed"
     And Exit code is zero
 
+  Scenario: Simple test with two runs
+    Given I make a temp directory
+    Then I have a "foo/simple.rb" file with content:
+    """
+      n = $fb.insert
+      n.foo = $fb.size
+    """
+    Then I have a "foo/good.yml" file with content:
+    """
+    ---
+    runs: 3
+    input: []
+    expected:
+      - /fb/f[foo=count(/fb/f)]
+    """
+    Then I run bin/judges with "test ."
+    Then Stdout contains "All 1 judge(s) and 1 tests passed"
+    And Exit code is zero
+
   Scenario: Enable only one category
     Given I make a temp directory
     Then I have a "mine/good/good.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.5.0'
+  s.version = '0.7.0'
   s.license = 'MIT'
   s.summary = 'Command-Line Tool for a Factbase'
   s.description =

data/lib/judges/churn.rb

@@ -0,0 +1,60 @@
+# 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'
+
+# How many facts were modified.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class Judges::Churn
+  attr_reader :added, :removed
+
+  def initialize(added, removed)
+    @added = added
+    @removed = removed
+  end
+
+  def to_s
+    "#{@added}/#{@removed}"
+  end
+
+  def zero?
+    @added.zero? && @removed.zero?
+  end
+
+  def +(other)
+    if other.is_a?(Judges::Churn)
+      Judges::Churn.new(@added + other.added, @removed + other.removed)
+    else
+      Judges::Churn.new(@added + other, @removed)
+    end
+  end
+
+  def -(other)
+    if other.is_a?(Judges::Churn)
+      Judges::Churn.new(@added - other.added, @removed - other.removed)
+    else
+      Judges::Churn.new(@added, @removed + other)
+    end
+  end
+end

data/lib/judges/commands/test.rb

@@ -122,7 +122,9 @@ class Judges::Test
       end
     end
     options = Judges::Options.new(opts['option']) + Judges::Options.new(yaml['options'])
-    judge.run(Factbase::Looged.new(fb, @loog), {}, {}, options)
+    (1..(opts['runs'] || yaml['runs'] || 1)).each do
+      judge.run(Factbase::Looged.new(fb, @loog), {}, {}, options)
+    end
     xpaths = yaml['expected']
     return if xpaths.nil?
     xml = Nokogiri::XML.parse(Factbase::ToXML.new(fb).xml)

data/lib/judges/commands/update.rb

@@ -25,6 +25,7 @@ require 'factbase/looged'
 require_relative '../../judges'
 require_relative '../../judges/to_rel'
 require_relative '../../judges/judges'
+require_relative '../../judges/churn'
 require_relative '../../judges/options'
 require_relative '../../judges/impex'
 require_relative '../../judges/elapsed'
@@ -72,42 +73,21 @@ class Judges::Update
     end
   end
 
-  # How many facts were modified.
-  class Churn
-    attr_reader :added, :removed
-
-    def initialize(added, removed)
-      @added = added
-      @removed = removed
-    end
-
-    def to_s
-      "#{@added}/-#{@removed}"
-    end
-
-    def zero?
-      @added.zero? && @removed.zero?
-    end
-
-    def +(other)
-      Churn.new(@added + other.added, @removed + other.removed)
-    end
-  end
-
   private
 
   # Run all judges in a full cycle, one by one.
   # @return [Churn] How many modifications have been made
   def cycle(opts, judges, fb, options)
     errors = []
-    churn = Churn.new(0, 0)
+    churn = Judges::Churn.new(0, 0)
     global = {}
     elapsed(@loog) do
       done = judges.each_with_index do |p, i|
-        @loog.info("\n👉 Running #{p.name} (##{i}) at #{p.dir.to_rel}...")
+        @loog.info("\n\n👉 Running #{p.name} (##{i}) at #{p.dir.to_rel}...")
         elapsed(@loog) do
-          churn += one_judge(fb, p, global, options)
-          throw :"👍 The judge #{p.name} modified #{churn} facts\n"
+          c = one_judge(fb, p, global, options)
+          churn += c
+          throw :"👍 The judge #{p.name} modified #{c} facts"
         end
       rescue StandardError, SyntaxError => e
         @loog.warn(Backtrace.new(e))
@@ -132,9 +112,9 @@ class Judges::Update
     after = fb.size
     diff = after - before
     if diff.positive?
-      Churn.new(diff, 0)
+      Judges::Churn.new(diff, 0)
     else
-      Churn.new(0, -diff)
+      Judges::Churn.new(0, -diff)
     end
   end
 end

data/lib/judges.rb

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

data/test/test_churn.rb

@@ -0,0 +1,38 @@
+# 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_relative '../lib/judges'
+require_relative '../lib/judges/churn'
+
+# Test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class TestChurn < Minitest::Test
+  def test_basic
+    churn = Judges::Churn.new(0, 0)
+    assert_equal('0/0', churn.to_s)
+    assert_equal('42/0', (churn + 42).to_s)
+    assert_equal('0/17', (churn - 17).to_s)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: judges
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-06 00:00:00.000000000 Z
+date: 2024-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -151,7 +151,7 @@ files:
 - ".gitattributes"
 - ".github/workflows/actionlint.yml"
 - ".github/workflows/codecov.yml"
-- ".github/workflows/license.yml"
+- ".github/workflows/copyrights.yml"
 - ".github/workflows/markdown-lint.yml"
 - ".github/workflows/pdd.yml"
 - ".github/workflows/rake.yml"
@@ -190,6 +190,7 @@ files:
 - lib/judges.rb
 - lib/judges/baza.rb
 - lib/judges/categories.rb
+- lib/judges/churn.rb
 - lib/judges/commands/eval.rb
 - lib/judges/commands/import.rb
 - lib/judges/commands/inspect.rb
@@ -220,6 +221,7 @@ files:
 - test/test__helper.rb
 - test/test_baza.rb
 - test/test_categories.rb
+- test/test_churn.rb
 - test/test_impex.rb
 - test/test_judge.rb
 - test/test_judges.rb