factbase 0.0.30 → 0.0.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58a162c50ba7d2b9d21ca0ff2d62e34acd0c46d2666b596ceffcceb2dc4215c0
-  data.tar.gz: 61514fa0fa904ea71540c0f9d4776ea75d5405aa5a1b73d32e051c29606b5fdb
+  metadata.gz: 53e563c36bf3d61f977bbae719a1b6069973a40b28f37ba4e3222f7fbae7091c
+  data.tar.gz: ecd5e6b589ceda68f8a25369e6d7c169500dab90ac6bfca26af5384d0e74bdc9
 SHA512:
-  metadata.gz: 7b3841073dba72e3fcc6e1fd089235d93829264504447557b3b23f6eb3fa74a4ebccad0d27062af84dc00ab115ca06d9dcc9621bf245d54e09b121bb21983737
-  data.tar.gz: aed653f93b7505db410e81d9fefd8fe9d38fc6b89947f89c952992bcdd76dab1d5f9e4a8cd941df426cb7b200855f26fb2981a9698ac35e8e6ea682c693787e7
+  metadata.gz: 7fc18cb91cd74af7e9e87b0740b10d1409278ce0dc8a7ea589ef8c45a5b61501dbe0706faf012a49862c911c25859d85a93ad1e6e275421af4c3255bcd5d1b2b
+  data.tar.gz: bf4d812092097c9edb40ccd4aeac447b96906bbdbb515696199f9fa229d8e620ba36b2c80435e1d75115c07e5f2bac6029215df0657d03d51ceb42d053f6652c

data/.github/workflows/license.yml

@@ -0,0 +1,57 @@
+# 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: license
+'on':
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  license:
+    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

data/Gemfile

@@ -23,10 +23,10 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'minitest', '5.23.0', require: false
+gem 'minitest', '5.23.1', 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', '1.64.0', 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

data/Gemfile.lock

@@ -59,7 +59,7 @@ GEM
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     loog (0.5.1)
-    minitest (5.23.0)
+    minitest (5.23.1)
     mutex_m (0.2.0)
     nokogiri (1.16.5-arm64-darwin)
       racc (~> 1.4)
@@ -75,7 +75,7 @@ GEM
       racc
     psych (5.1.2)
       stringio
-    racc (1.7.3)
+    racc (1.8.0)
     rack (3.0.11)
     rack-session (2.0.0)
       rack (>= 3.0.0)
@@ -125,7 +125,7 @@ GEM
       rspec-mocks (~> 3.13)
       rspec-support (~> 3.13)
     rspec-support (3.13.1)
-    rubocop (1.63.5)
+    rubocop (1.64.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -181,10 +181,10 @@ PLATFORMS
 
 DEPENDENCIES
   factbase!
-  minitest (= 5.23.0)
+  minitest (= 5.23.1)
   rake (= 13.2.1)
   rspec-rails (= 6.1.2)
-  rubocop (= 1.63.5)
+  rubocop (= 1.64.0)
   rubocop-performance (= 1.21.0)
   rubocop-rspec (= 2.29.2)
   simplecov (= 0.22.0)

data/README.md

@@ -14,7 +14,8 @@
 This Ruby gem manages an in-memory database of facts.
 A fact is simply a map of properties and values.
 The values are either atomic literals or non-empty sets of literals.
-It is possible to delete a fact, but impossible to delete a property from a fact.
+It is possible to delete a fact, but impossible to delete a property
+from a fact.
 
 **ATTENTION**: The current implemention is naive and,
 because of that, very slow. I will be very happy
@@ -55,8 +56,7 @@ assert(f2.query('(eq foo 42)').each.to_a.size == 1)
 
 All terms available in a query:
 
-* `()` is true
-* `(nil)` is false
+* `(always)` and `(never)` are "true" and "false"
 * `(not t)` inverses the `t` if it's boolean (exception otherwise)
 * `(or t1 t2 ...)` returns true if at least one argument is true
 * `(and t1 t2 ...)` returns true if all arguments are true
@@ -73,12 +73,14 @@ All terms available in a query:
 
 There are also terms that match the entire factbase:
 
-* `(max k)` returns true if the value of `k` property is the largest in the entire factbase
+* `(max k)` returns true if the value of `k` property
+is the largest in the entire factbase
 * `(min k)` returns true if the value of `k` is the smallest
 
 ## How to contribute
 
-Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
+Read
+[these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
 Make sure you build is green before you contribute
 your pull request. You will need to have
 [Ruby](https://www.ruby-lang.org/en/) 3.2+ and

data/lib/factbase/syntax.rb

@@ -39,17 +39,26 @@ class Factbase::Syntax
   # Convert it to a term.
   # @return [Term] The term detected
   def to_term
+    build.simplify
+  rescue StandardError => e
+    raise "#{e.message} in \"#{@query}\""
+  end
+
+  private
+
+  # Convert it to a term.
+  # @return [Term] The term detected
+  def build
     @tokens ||= to_tokens
+    raise 'No tokens' if @tokens.empty?
     @ast ||= to_ast(@tokens, 0)
-    raise "Too many terms: #{@query}" if @ast[1] != @tokens.size
+    raise 'Too many terms' if @ast[1] != @tokens.size
     term = @ast[0]
-    raise "No terms found: #{@query}" if term.nil?
-    raise "Not a term: #{@query}" unless term.is_a?(Factbase::Term)
+    raise 'No terms found' if term.nil?
+    raise 'Not a term' unless term.is_a?(Factbase::Term)
     term
   end
 
-  private
-
   # Reads the stream of tokens, starting at the +at+ position. If the
   # token at the position is not a literal (like 42 or "Hello") but a term,
   # the function recursively calls itself.
@@ -58,19 +67,19 @@ class Factbase::Syntax
   # is the term/literal and the second one is the position where the
   # scanning should continue.
   def to_ast(tokens, at)
-    raise "Closing too soon at ##{at}: #{@query}" if tokens[at] == :close
+    raise "Closing too soon at ##{at}" if tokens[at] == :close
     return [tokens[at], at + 1] unless tokens[at] == :open
     at += 1
     op = tokens[at]
-    return [Factbase::Term.new(:nil, []), at + 1] if op == :close
+    raise 'No token found' if op == :close
     operands = []
     at += 1
     loop do
-      raise "End of token stream at ##{at}: #{@query}" if tokens[at].nil?
+      raise "End of token stream at ##{at}" if tokens[at].nil?
       break if tokens[at] == :close
       (operand, at1) = to_ast(tokens, at)
-      raise "Stuck at position ##{at}: #{@query}" if at == at1
-      raise "Jump back at position ##{at}: #{@query}" if at1 < at
+      raise "Stuck at position ##{at}" if at == at1
+      raise "Jump back at position ##{at}" if at1 < at
       at = at1
       operands << operand
       break if tokens[at] == :close
@@ -110,12 +119,12 @@ class Factbase::Syntax
         acc += c
       end
     end
-    raise "String not closed: : #{@query}" if string
+    raise 'String not closed' if string
     list.map do |t|
       if t.is_a?(Symbol)
         t
       elsif t.start_with?('\'', '"')
-        raise "String literal can't be empty: #{@query}" if t.length <= 2
+        raise 'String literal can\'t be empty' if t.length <= 2
         t[1..-2]
       elsif t.match?(/^[0-9]+$/)
         t.to_i
@@ -124,7 +133,7 @@ class Factbase::Syntax
       elsif t.match?(/^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$/)
         Time.parse(t)
       else
-        raise "Wrong symbol format (#{t}): #{@query}" unless t.match?(/^[a-z][a-zA-Z0-9_]*$/)
+        raise "Wrong symbol format (#{t})" unless t.match?(/^[a-z][a-zA-Z0-9_]*$/)
         t.to_sym
       end
     end

data/lib/factbase/term.rb

@@ -43,6 +43,8 @@ class Factbase::Term
   # @return [bool] TRUE if matches
   def evaluate(fact)
     send(@op, fact)
+  rescue NoMethodError => _e
+    raise "Term '#{@op}' is not defined"
   end
 
   # Put it into the context: let it see the entire array of maps.
@@ -57,6 +59,17 @@ class Factbase::Term
     self
   end
 
+  # Simplify it if possible.
+  # @return [Factbase::Term] New term or itself
+  def simplify
+    m = "#{@op}_simplify"
+    if respond_to?(m, true)
+      send(m)
+    else
+      self
+    end
+  end
+
   # Turns it into a string.
   # @return [String] The string of it
   def to_s
@@ -76,11 +89,16 @@ class Factbase::Term
 
   private
 
-  def nil(_fact)
+  def always(_fact)
     assert_args(0)
     true
   end
 
+  def never(_fact)
+    assert_args(0)
+    false
+  end
+
   def not(fact)
     assert_args(1)
     !only_bool(the_value(0, fact))
@@ -100,6 +118,28 @@ class Factbase::Term
     true
   end
 
+  def and_or_simplify
+    strs = []
+    ops = []
+    @operands.each do |o|
+      o = o.simplify
+      s = o.to_s
+      next if strs.include?(s)
+      strs << s
+      ops << o
+    end
+    return ops[0] if ops.size == 1
+    Factbase::Term.new(@op, ops)
+  end
+
+  def and_simplify
+    and_or_simplify
+  end
+
+  def or_simplify
+    and_or_simplify
+  end
+
   def when(fact)
     assert_args(2)
     a = @operands[0]

data/lib/factbase.rb

@@ -29,7 +29,7 @@ require 'yaml'
 # License:: MIT
 class Factbase
   # Current version of the gem (changed by .rultor.yml on every release)
-  VERSION = '0.0.30'
+  VERSION = '0.0.32'
 
   # Constructor.
   def initialize(facts = [])

data/test/factbase/test_inv.rb

@@ -42,7 +42,7 @@ class TestInv < Minitest::Test
     end
     f.c = 256
     assert_equal(42, f.a)
-    assert_equal(1, fb.query('()').each.to_a.size)
+    assert_equal(1, fb.query('(always)').each.to_a.size)
   end
 
   def test_pre_and_inv

data/test/factbase/test_looged.rb

@@ -48,19 +48,19 @@ class TestLooged < Minitest::Test
     fb = Factbase.new
     fb.insert
     fb.insert
-    assert_equal(2, Factbase::Looged.new(fb, Loog::NULL).query('()').each(&:to_s))
+    assert_equal(2, Factbase::Looged.new(fb, Loog::NULL).query('(always)').each(&:to_s))
   end
 
   def test_returns_int_when_empty
     fb = Factbase.new
-    assert_equal(0, Factbase::Looged.new(fb, Loog::NULL).query('()').each(&:to_s))
+    assert_equal(0, Factbase::Looged.new(fb, Loog::NULL).query('(always)').each(&:to_s))
   end
 
   def test_logs_when_enumerator
     fb = Factbase::Looged.new(Factbase.new, Loog::NULL)
-    assert_equal(0, fb.query('()').each.to_a.size)
+    assert_equal(0, fb.query('(always)').each.to_a.size)
     fb.insert
-    assert_equal(1, fb.query('()').each.to_a.size)
+    assert_equal(1, fb.query('(always)').each.to_a.size)
   end
 
   def test_proper_logging

data/test/factbase/test_pre.rb

@@ -33,6 +33,6 @@ class TestPre < Minitest::Test
     fb = Factbase::Pre.new(Factbase.new) { |f| f.foo = 42 }
     f = fb.insert
     assert_equal(42, f.foo)
-    assert_equal(1, fb.query('()').each.to_a.size)
+    assert_equal(1, fb.query('(always)').each.to_a.size)
   end
 end

data/test/factbase/test_query.rb

@@ -90,6 +90,16 @@ class TestQuery < Minitest::Test
     assert_equal(1, maps.size)
   end
 
+  def test_deleting_nothing
+    maps = []
+    maps << { 'foo' => [42] }
+    maps << { 'bar' => [4, 5] }
+    maps << { 'bar' => 5 }
+    q = Factbase::Query.new(maps, Mutex.new, '(never)')
+    assert_equal(0, q.delete!)
+    assert_equal(3, maps.size)
+  end
+
   def test_to_array
     maps = []
     maps << { 'foo' => [42] }

data/test/factbase/test_syntax.rb

@@ -41,13 +41,12 @@ class TestSyntax < Minitest::Test
 
   def test_simple_parsing
     [
-      '()',
       '(foo)',
       '(foo (bar) (zz 77)   )',
       "(eq foo   \n\n 'Hello, world!'\n)\n",
       "(eq x 'Hello, \\' \n) \\' ( world!')",
       "# this is a comment\n(eq foo # test\n 42)\n\n# another comment\n",
-      "(or ( a 4) (b 5) () (and () (c 5) \t\t(r 7 w8s w8is 'Foo')))"
+      "(or ( a 4) (b 5) (always) (and (always) (c 5) \t\t(r 7 w8s w8is 'Foo')))"
     ].each do |q|
       Factbase::Syntax.new(q).to_term
     end
@@ -67,7 +66,7 @@ class TestSyntax < Minitest::Test
       '(eq t 2024-05-25T19:43:48Z)',
       '(eq t 3.1415926)',
       '(eq t 3.0e+21)',
-      "(foo (x (f (t (y 42 'Hey you'))) (f) (r 3)) y z)"
+      "(foo (x (f (t (y 42 'Hey you'))) (never) (r 3)) y z)"
     ].each do |q|
       assert_equal(q, Factbase::Syntax.new(q).to_term.to_s)
     end
@@ -91,6 +90,7 @@ class TestSyntax < Minitest::Test
   def test_broken_syntax
     [
       '',
+      '()',
       '(foo',
       '(foo 1) (bar 2)',
       'some text',
@@ -106,9 +106,21 @@ class TestSyntax < Minitest::Test
       ')',
       '"'
     ].each do |q|
-      assert_raises(q) do
-        Factbase::Syntax.new(q).to_term
-      end
+      assert(
+        assert_raises(q) do
+          Factbase::Syntax.new(q).to_term
+        end.message.include?(q)
+      )
+    end
+  end
+
+  def test_simplification
+    {
+      '(foo)' => '(foo)',
+      '(and (foo) (foo))' => '(foo)',
+      '(and (foo) (or (and (eq a 1))) (eq a 1) (foo))' => '(and (foo) (eq a 1))'
+    }.each do |s, t|
+      assert_equal(t, Factbase::Syntax.new(s).to_term.to_s)
     end
   end
 end

data/test/factbase/test_term.rb

@@ -82,8 +82,13 @@ class TestTerm < Minitest::Test
     assert(!t.evaluate(fact('bar' => [100])))
   end
 
+  def test_false_matching
+    t = Factbase::Term.new(:never, [])
+    assert(!t.evaluate(fact('foo' => [100])))
+  end
+
   def test_not_matching
-    t = Factbase::Term.new(:not, [Factbase::Term.new(:nil, [])])
+    t = Factbase::Term.new(:not, [Factbase::Term.new(:always, [])])
     assert(!t.evaluate(fact('foo' => [100])))
   end
 

data/test/test_factbase.rb

@@ -107,7 +107,7 @@ class TestFactbase < Minitest::Test
 
   def test_all_decorators
     [
-      Factbase::Rules.new(Factbase.new, '()'),
+      Factbase::Rules.new(Factbase.new, '(always)'),
       Factbase::Inv.new(Factbase.new) { |_, _| true },
       Factbase::Pre.new(Factbase.new) { |_| true },
       Factbase::Looged.new(Factbase.new, Loog::NULL),
@@ -126,7 +126,7 @@ class TestFactbase < Minitest::Test
       end
       d.import(d.export)
       assert_equal(4, d.size)
-      assert_equal(4, d.query('()').each.to_a.size)
+      assert_equal(4, d.query('(always)').each.to_a.size)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factbase
 version: !ruby/object:Gem::Version
-  version: 0.0.30
+  version: 0.0.32
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-21 00:00:00.000000000 Z
+date: 2024-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -78,6 +78,7 @@ files:
 - ".gitattributes"
 - ".github/workflows/actionlint.yml"
 - ".github/workflows/codecov.yml"
+- ".github/workflows/license.yml"
 - ".github/workflows/markdown-lint.yml"
 - ".github/workflows/pdd.yml"
 - ".github/workflows/rake.yml"