factbase 0.0.40 → 0.0.42

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 129d17fba6d19bc5131f853d6b90c2e963187e84626270be4f7766e926d4c2c9
-  data.tar.gz: 4196611d541b81bdc1a73bf31f4b1fe15077ad702d8d1ec558f0f61d5e530396
+  metadata.gz: 42066d9d82538ecb6f0ec8df6cc711f4328e1ba496f00366fe67719ca8a1185e
+  data.tar.gz: d40e21b7e426af5184b9b03f515da4508b1e1e9e52995f566b16c778eefefca3
 SHA512:
-  metadata.gz: 1d87ddb11c2252043c963c6e086a617f216bc15a79441cfa121a0e3de3157f31705cfd1bfea7b6b89996488c76805ee27152f4be00627c7d3f3e1d506636c303
-  data.tar.gz: 5e913f0d675f19fc03cc83c80301af5fd390de8cdaf730a0ea2612768ae0056286be7f5f42686616ee0b1fc69cf22adc0009e9df5315251971e9c948da5ee739
+  metadata.gz: ff04d1f7e3eb1b18b36544ea8fb61280cda250a5e9920ba7b858092ae7c13111efce537d39acd7119f2f70c8704a89d06c98bf54b5a4639b4f187599f61eecbc
+  data.tar.gz: '09ba7d04f933f758c1db716c9490d464a2202644560a594bfae0a77e8bee8d26dcc38605101417a062ccd5c9645b5187e7f069e8f31e6bc782e48dc79775a347'

data/Gemfile

@@ -26,9 +26,9 @@ gemspec
 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.64.0', require: false
+gem 'rubocop', '1.64.1', require: false
 gem 'rubocop-performance', '1.21.0', require: false
-gem 'rubocop-rspec', '2.29.2', require: false
+gem 'rubocop-rspec', '2.30.0', require: false
 gem 'simplecov', '0.22.0', require: false
 gem 'simplecov-cobertura', '2.1.0', require: false
 gem 'yard', '0.9.36', require: false

data/Gemfile.lock

@@ -70,7 +70,7 @@ GEM
     nokogiri (1.16.5-x86_64-linux)
       racc (~> 1.4)
     parallel (1.24.0)
-    parser (3.3.1.0)
+    parser (3.3.2.0)
       ast (~> 2.4.1)
       racc
     psych (5.1.2)
@@ -125,7 +125,7 @@ GEM
       rspec-mocks (~> 3.13)
       rspec-support (~> 3.13)
     rspec-support (3.13.1)
-    rubocop (1.64.0)
+    rubocop (1.64.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -145,7 +145,7 @@ GEM
     rubocop-performance (1.21.0)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rspec (2.29.2)
+    rubocop-rspec (2.30.0)
       rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
@@ -184,9 +184,9 @@ DEPENDENCIES
   minitest (= 5.23.1)
   rake (= 13.2.1)
   rspec-rails (= 6.1.2)
-  rubocop (= 1.64.0)
+  rubocop (= 1.64.1)
   rubocop-performance (= 1.21.0)
-  rubocop-rspec (= 2.29.2)
+  rubocop-rspec (= 2.30.0)
   simplecov (= 0.22.0)
   simplecov-cobertura (= 2.1.0)
   yard (= 0.9.36)

data/README.md

@@ -88,6 +88,7 @@ Also, some simple arithmetic:
 One term is for meta-programming:
 
 * `(defn foo "self.to_s")` defines a new term using Ruby syntax and returns true
+* `(undef foo)` undefines a term (nothing happens if it's not defined yet)
 
 There are terms that are history of search aware:
 

data/lib/factbase/inv.rb

@@ -81,13 +81,13 @@ class Factbase::Inv
     end
 
     # rubocop:disable Style/OptionalBooleanParameter
-    def respond_to?(method, include_private = false)
+    def respond_to?(_method, _include_private = false)
       # rubocop:enable Style/OptionalBooleanParameter
-      @fact.respond_to?(method, include_private)
+      true
     end
 
-    def respond_to_missing?(method, include_private = false)
-      @fact.respond_to_missing?(method, include_private)
+    def respond_to_missing?(_method, _include_private = false)
+      true
     end
   end
 

data/lib/factbase/looged.rb

@@ -91,13 +91,13 @@ class Factbase::Looged
     end
 
     # rubocop:disable Style/OptionalBooleanParameter
-    def respond_to?(method, include_private = false)
+    def respond_to?(_method, _include_private = false)
       # rubocop:enable Style/OptionalBooleanParameter
-      @fact.respond_to?(method, include_private)
+      true
     end
 
-    def respond_to_missing?(method, include_private = false)
-      @fact.respond_to_missing?(method, include_private)
+    def respond_to_missing?(_method, _include_private = false)
+      true
     end
   end
 

data/lib/factbase/query.rb

@@ -26,12 +26,17 @@ require_relative 'fact'
 
 # Query.
 #
-# This is an internal class, it is not supposed to be instantiated directly.
+# This is an internal class, it is not supposed to be instantiated directly. It
+# is created by the +query()+ method of the +Factbase+ class.
 #
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 class Factbase::Query
+  # Constructor.
+  # @param [Array<Fact>] maps Array of facts to start with
+  # @param [Mutex] mutex Mutex to sync all modifications to the +maps+
+  # @param [String] query The query as a string
   def initialize(maps, mutex, query)
     @maps = maps
     @mutex = mutex
@@ -48,7 +53,9 @@ class Factbase::Query
     @maps.each do |m|
       f = Factbase::Fact.new(@mutex, m)
       r = term.evaluate(f, @maps)
-      raise 'Unexpected evaluation result, must be boolean' unless r.is_a?(TrueClass) || r.is_a?(FalseClass)
+      unless r.is_a?(TrueClass) || r.is_a?(FalseClass)
+        raise "Unexpected evaluation result (#{r.class}), must be Boolean at #{@query}"
+      end
       next unless r
       yield f
       yielded += 1

data/lib/factbase/rules.rb

@@ -21,20 +21,21 @@
 # SOFTWARE.
 
 require_relative '../factbase'
+require_relative '../factbase/syntax'
 
 # A decorator of a Factbase, that checks rules on every set.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 class Factbase::Rules
-  def initialize(fb, rules)
+  def initialize(fb, rules, check = Check.new(rules))
     @fb = fb
     @rules = rules
-    @check = Check.new(fb, @rules)
+    @check = check
   end
 
   def dup
-    Factbase::Rules.new(@fb.dup, @rules)
+    Factbase::Rules.new(@fb.dup, @rules, @check)
   end
 
   def size
@@ -50,7 +51,13 @@ class Factbase::Rules
   end
 
   def txn(this = self, &)
+    before = @check
+    @check = Blind.new
     @fb.txn(this, &)
+    @check = before
+    @fb.query('(always)').each do |f|
+      @check.it(f)
+    end
   end
 
   def export
@@ -83,13 +90,13 @@ class Factbase::Rules
     end
 
     # rubocop:disable Style/OptionalBooleanParameter
-    def respond_to?(method, include_private = false)
+    def respond_to?(_method, _include_private = false)
       # rubocop:enable Style/OptionalBooleanParameter
-      @fact.respond_to?(method, include_private)
+      true
     end
 
-    def respond_to_missing?(method, include_private = false)
-      @fact.respond_to_missing?(method, include_private)
+    def respond_to_missing?(_method, _include_private = false)
+      true
     end
   end
 
@@ -118,16 +125,24 @@ class Factbase::Rules
   # Check one fact.
   #
   # This is an internal class, it is not supposed to be instantiated directly.
-  #
   class Check
-    def initialize(fb, expr)
-      @fb = fb
+    def initialize(expr)
       @expr = expr
     end
 
     def it(fact)
       return if Factbase::Syntax.new(@expr).to_term.evaluate(fact, [])
-      raise "The fact is in invalid state: #{fact}"
+      e = "#{@expr[0..32]}..." if @expr.length > 32
+      raise "The fact doesn't match the #{e.inspect} rule: #{fact}"
+    end
+  end
+
+  # Check one fact (never complaining).
+  #
+  # This is an internal class, it is not supposed to be instantiated directly.
+  class Blind
+    def it(_fact)
+      true
     end
   end
 end

data/lib/factbase/term.rb

@@ -66,7 +66,9 @@ class Factbase::Term
   def evaluate(fact, maps)
     send(@op, fact, maps)
   rescue NoMethodError => e
-    raise "Term '#{@op}' is not defined: #{e.message}"
+    raise "Term '#{@op}' is not defined at #{self}: #{e.message}"
+  rescue StandardError => e
+    raise "#{e.message} at #{self} (#{e.backtrace[0]})"
   end
 
   # Simplify it if possible.
@@ -111,19 +113,19 @@ class Factbase::Term
 
   def not(fact, maps)
     assert_args(1)
-    !only_bool(the_values(0, fact, maps))
+    !only_bool(the_values(0, fact, maps), 0)
   end
 
   def or(fact, maps)
     (0..@operands.size - 1).each do |i|
-      return true if only_bool(the_values(i, fact, maps))
+      return true if only_bool(the_values(i, fact, maps), i)
     end
     false
   end
 
   def and(fact, maps)
     (0..@operands.size - 1).each do |i|
-      return false unless only_bool(the_values(i, fact, maps))
+      return false unless only_bool(the_values(i, fact, maps), i)
     end
     true
   end
@@ -177,7 +179,7 @@ class Factbase::Term
   def at(fact, maps)
     assert_args(2)
     i = the_values(0, fact, maps)
-    raise 'Too many values at first position, one expected' unless i.size == 1
+    raise "Too many values (#{i.size}) at first position, one expected" unless i.size == 1
     i = i[0]
     return nil if i.nil?
     v = the_values(1, fact, maps)
@@ -299,8 +301,12 @@ class Factbase::Term
   end
 
   def defn(_fact, _maps)
+    assert_args(2)
     fn = @operands[0]
-    raise 'A symbol expected as first argument of defn' unless fn.is_a?(Symbol)
+    raise "A symbol expected as first argument of 'defn'" unless fn.is_a?(Symbol)
+    raise "Can't use '#{fn}' name as a term" if Factbase::Term.instance_methods(true).include?(fn)
+    raise "Term '#{fn}' is already defined" if Factbase::Term.private_instance_methods(false).include?(fn)
+    raise "The '#{fn}' is a bad name for a term" unless fn.match?(/^[a-z_]+$/)
     e = "class Factbase::Term\nprivate\ndef #{fn}(fact, maps)\n#{@operands[1]}\nend\nend"
     # rubocop:disable Security/Eval
     eval(e)
@@ -308,6 +314,16 @@ class Factbase::Term
     true
   end
 
+  def undef(_fact, _maps)
+    assert_args(1)
+    fn = @operands[0]
+    raise "A symbol expected as first argument of 'undef'" unless fn.is_a?(Symbol)
+    if Factbase::Term.private_instance_methods(false).include?(fn)
+      Factbase::Term.class_eval("undef :#{fn}", __FILE__, __LINE__ - 1) # undef :foo
+    end
+    true
+  end
+
   def min(_fact, maps)
     @min ||= best(maps) { |v, b| v < b }
   end
@@ -324,7 +340,7 @@ class Factbase::Term
     @sum ||=
       begin
         k = @operands[0]
-        raise "A symbol expected, but provided: #{k}" unless k.is_a?(Symbol)
+        raise "A symbol expected, but '#{k}' provided" unless k.is_a?(Symbol)
         sum = 0
         maps.each do |m|
           vv = m[k.to_s]
@@ -339,10 +355,11 @@ class Factbase::Term
   end
 
   def agg(_fact, maps)
+    assert_args(2)
     selector = @operands[0]
-    raise "A term expected, but #{selector} provided" unless selector.is_a?(Factbase::Term)
+    raise "A term expected, but '#{selector}' provided" unless selector.is_a?(Factbase::Term)
     term = @operands[1]
-    raise "A term expected, but #{term} provided" unless term.is_a?(Factbase::Term)
+    raise "A term expected, but '#{term}' provided" unless term.is_a?(Factbase::Term)
     subset = maps.select { |m| selector.evaluate(m, maps) }
     @agg ||=
       if subset.empty?
@@ -360,7 +377,7 @@ class Factbase::Term
 
   def by_symbol(pos, fact)
     o = @operands[pos]
-    raise "A symbol expected at ##{pos}, but provided: #{o}" unless o.is_a?(Symbol)
+    raise "A symbol expected at ##{pos}, but '#{o}' provided" unless o.is_a?(Symbol)
     k = o.to_s
     fact[k]
   end
@@ -374,16 +391,18 @@ class Factbase::Term
     v
   end
 
-  def only_bool(val)
+  def only_bool(val, pos)
     val = val[0] if val.is_a?(Array)
     return false if val.nil?
-    raise "Boolean expected, while #{val.class} received" unless val.is_a?(TrueClass) || val.is_a?(FalseClass)
+    unless val.is_a?(TrueClass) || val.is_a?(FalseClass)
+      raise "Boolean expected, while #{val.class} received from #{@operands[pos]}"
+    end
     val
   end
 
   def best(maps)
     k = @operands[0]
-    raise "A symbol expected, but provided: #{k}" unless k.is_a?(Symbol)
+    raise "A symbol expected, but #{k} provided" unless k.is_a?(Symbol)
     best = nil
     maps.each do |m|
       vv = m[k.to_s]

data/lib/factbase/to_json.rb

@@ -45,6 +45,6 @@ class Factbase::ToJSON
   # @return [String] The factbase in JSON format
   def json
     maps = Marshal.load(@fb.export)
-    maps.to_json
+    maps.map { |m| m.sort.to_h }.to_json
   end
 end

data/lib/factbase/to_xml.rb

@@ -55,7 +55,7 @@ class Factbase::ToXML
       xml.fb(meta) do
         maps.each do |m|
           xml.f_ do
-            m.each do |k, vv|
+            m.sort.to_h.each do |k, vv|
               if vv.is_a?(Array)
                 xml.send(:"#{k}_") do
                   vv.each do |v|

data/lib/factbase/to_yaml.rb

@@ -45,6 +45,6 @@ class Factbase::ToYAML
   # @return [String] The factbase in YAML format
   def yaml
     maps = Marshal.load(@fb.export)
-    YAML.dump({ 'facts' => maps })
+    YAML.dump({ 'facts' => maps.map { |m| m.sort.to_h } })
   end
 end

data/lib/factbase/tuples.rb

@@ -22,8 +22,6 @@
 
 require_relative '../factbase'
 
-# Tuples.
-#
 # With the help of this class, it's possible to select a few facts
 # from a factbase at a time, which depend on each other. For example,
 # it's necessary to find a fact where the +name+ is set and then find
@@ -36,8 +34,9 @@ require_relative '../factbase'
 #  end
 #
 # Here, the +{f0.salary}+ is a special substitution place, which is replaced
-# by the +salary+ of the fact that is found by the previous query. The indexing
-# of queries starts from zero.
+# by the +salary+ of the fact that is found by the previous query.
+#
+# The indexing of queries starts from zero.
 #
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko

data/lib/factbase.rb

@@ -79,12 +79,13 @@ require 'yaml'
 # License:: MIT
 class Factbase
   # Current version of the gem (changed by .rultor.yml on every release)
-  VERSION = '0.0.40'
+  VERSION = '0.0.42'
 
   # An exception that may be thrown in a transaction, to roll it back.
   class Rollback < StandardError; end
 
   # Constructor.
+  # @param [Array<Hash>] facts Array of facts to start with
   def initialize(facts = [])
     @maps = facts
     @mutex = Mutex.new

data/test/factbase/test_query.rb

@@ -79,6 +79,7 @@ class TestQuery < Minitest::Test
       '(eq time (min time))' => 1,
       '(and (absent time) (exists pi))' => 1,
       "(and (exists time) (not (\t\texists pi)))" => 1,
+      '(undef something)' => 3,
       "(or (eq num +66) (lt time #{(Time.now - 200).utc.iso8601}))" => 1
     }.each do |q, r|
       assert_equal(r, Factbase::Query.new(maps, Mutex.new, q).each.to_a.size, q)

data/test/factbase/test_rules.rb

@@ -42,4 +42,45 @@ class TestRules < Minitest::Test
       f2.first = 1
     end
   end
+
+  def test_to_string
+    fb = Factbase::Rules.new(
+      Factbase.new,
+      '(when (exists a) (exists b))'
+    )
+    f = fb.insert
+    assert(f.to_s.length.positive?)
+  end
+
+  def test_check_only_when_txn_is_closed
+    fb = Factbase::Rules.new(Factbase.new, '(when (exists a) (exists b))')
+    ok = false
+    assert_raises do
+      fb.txn do |fbt|
+        f = fbt.insert
+        f.a = 1
+        f.c = 2
+        ok = true
+      end
+    end
+    assert(ok)
+  end
+
+  def test_in_combination_with_pre
+    fb = Factbase::Rules.new(Factbase.new, '(when (exists a) (exists b))')
+    fb = Factbase::Pre.new(fb) do |f|
+      f.hello = 42
+    end
+    ok = false
+    assert_raises do
+      fb.txn do |fbt|
+        f = fbt.insert
+        f.a = 1
+        f.c = 2
+        ok = true
+      end
+    end
+    assert(ok)
+    assert_equal(1, fb.query('(eq hello 42)').each.to_a.size)
+  end
 end

data/test/factbase/test_term.rb

@@ -166,6 +166,34 @@ class TestTerm < Minitest::Test
     assert_equal('(foo \'hello, world!\')', t1.evaluate(fact, []))
   end
 
+  def test_defn_again_by_mistake
+    t = Factbase::Term.new(:defn, [:and, 'self.to_s'])
+    assert_raises do
+      t.evaluate(fact, [])
+    end
+  end
+
+  def test_defn_bad_name_by_mistake
+    t = Factbase::Term.new(:defn, [:to_s, 'self.to_s'])
+    assert_raises do
+      t.evaluate(fact, [])
+    end
+  end
+
+  def test_defn_bad_name_spelling_by_mistake
+    t = Factbase::Term.new(:defn, [:'some-key', 'self.to_s'])
+    assert_raises do
+      t.evaluate(fact, [])
+    end
+  end
+
+  def test_undef_simple
+    t = Factbase::Term.new(:defn, [:hello, 'self.to_s'])
+    assert_equal(true, t.evaluate(fact, []))
+    t = Factbase::Term.new(:undef, [:hello])
+    assert_equal(true, t.evaluate(fact, []))
+  end
+
   def test_past
     t = Factbase::Term.new(:prev, [:foo])
     assert_nil(t.evaluate(fact('foo' => 4), []))
@@ -183,6 +211,22 @@ class TestTerm < Minitest::Test
     assert_equal([42], t.evaluate(fact('foo' => 4), []))
   end
 
+  def test_report_missing_term
+    t = Factbase::Term.new(:something, [])
+    msg = assert_raises do
+      t.evaluate(fact, [])
+    end.message
+    assert(msg.include?('not defined at (something)'), msg)
+  end
+
+  def test_report_other_error
+    t = Factbase::Term.new(:at, [])
+    msg = assert_raises do
+      t.evaluate(fact, [])
+    end.message
+    assert(msg.include?('at (at)'), msg)
+  end
+
   private
 
   def fact(map = {})

data/test/factbase/test_to_json.rb

@@ -39,4 +39,14 @@ class TestToJSON < Minitest::Test
     json = JSON.parse(to.json)
     assert(42, json[0]['foo'][1])
   end
+
+  def test_sort_keys
+    fb = Factbase.new
+    f = fb.insert
+    f.c = 42
+    f.b = 1
+    f.a = 256
+    json = Factbase::ToJSON.new(fb).json
+    assert(json.include?('{"a":256,"b":1,"c":42}'), json)
+  end
 end

data/test/factbase/test_to_xml.rb

@@ -73,4 +73,15 @@ class TestToXML < Minitest::Test
     assert(!xml.xpath('/fb/f/f').empty?)
     assert(!xml.xpath('/fb/f/class').empty?)
   end
+
+  def test_sorts_keys
+    fb = Factbase.new
+    f = fb.insert
+    f.x = 20
+    f.t = 40
+    f.a = 10
+    f.c = 1
+    xml = Factbase::ToXML.new(fb).xml
+    assert(xml.gsub(/\s*/, '').include?('<f><a>10</a><c>1</c><t>40</t><x>20</x></f>'), xml)
+  end
 end

data/test/factbase/test_to_yaml.rb

@@ -42,4 +42,14 @@ class TestToYAML < Minitest::Test
     assert_equal(42, yaml['facts'][0]['foo'][0])
     assert_equal(256, yaml['facts'][0]['foo'][1])
   end
+
+  def test_sorts_keys
+    fb = Factbase.new
+    f = fb.insert
+    f.b = 42
+    f.a = 256
+    f.c = 10
+    yaml = Factbase::ToYAML.new(fb).yaml
+    assert(yaml.include?("a: 256\n  b: 42\n  c: 10"), yaml)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factbase
 version: !ruby/object:Gem::Version
-  version: 0.0.40
+  version: 0.0.42
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-30 00:00:00.000000000 Z
+date: 2024-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json