factbase 0.0.28 → 0.0.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffdf62af221a65ab9efa6097b01dab23edba0399bc8551757d450ff828f14367
-  data.tar.gz: 175dd8ead3a933305d46c8c4bb657a46efc507db3ad1045bb7495614dedfc1c2
+  metadata.gz: cce648530bed16f5d251c8d84dae0a3c8726f1c688fbfdbf3723a39fe9f3e696
+  data.tar.gz: e0f31869dab8d231f63d2c075661e2e4ead17576d258bcc6bd19a643a659e35b
 SHA512:
-  metadata.gz: ccade318b2db8568b72fcd29dd8d8cc301a791911a749bba8154485e8e95d1a00c2466477ff7e798f8a5146e87e03c69af8493fd05ae38c9463a8ffc9e29da62
-  data.tar.gz: 30730a5e848923b73c98f188142f30f56fd8eec95d8839561a6be01956922f60d9fe46a9dcf361b2f6b4bffca993fd20471bd51f1e2840659ba7bc252c9853b2
+  metadata.gz: a2e76c6c010157ba7aff6098e44c9cde7958d288b0bb7ea41a69201ab1783763da31f657c52156a2991ac02fe56e48d31acdb3fb71749827eb126b5a363416e5
+  data.tar.gz: 908fa035b142fea947303b3306b38f3443e782d4a182f158d6674cc8396a704fb45cc68b4533ce61ded2e98a7fe57c2fd23716706df56b0a7254aa8f5dd35539

data/.rubocop.yml

@@ -41,9 +41,9 @@ Metrics/AbcSize:
 Metrics/BlockLength:
   Max: 30
 Metrics/CyclomaticComplexity:
-  Max: 20
+  Max: 25
 Metrics/PerceivedComplexity:
-  Max: 20
+  Max: 25
 Metrics/ClassLength:
   Enabled: false
 Layout/EmptyLineAfterGuardClause:

data/README.md

@@ -12,15 +12,18 @@
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/factbase/blob/master/LICENSE.txt)
 
 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.
 
 Here is how you use it (it's thread-safe, by the way):
 
 ```ruby
 fb = Factbase.new
 f = fb.insert
-f.type = 'book'
+f.kind = 'book'
 f.title = 'Object Thinking'
-fb.query('(eq type "book")').each do |f|
+fb.query('(eq kind "book")').each do |f|
   f.seen = true
 end
 fb.insert
@@ -29,17 +32,37 @@ fb.query('(not (exists seen))').each do |f|
 end
 ```
 
-You can save the factbase to disc and load it back:
+You can save the factbase to the disc and then load it back:
 
 ```ruby
 file = '/tmp/simple.fb'
 f1 = Factbase.new
-f1.insert
+f = f1.insert
+f.foo = 42
 File.save(file, f1.export)
 f2 = Factbase.new
 f2.import(File.read(file))
+assert(f2.query('(eq foo 42)').each.to_a.size == 1)
 ```
 
+All terms available in a query:
+
+* `()` is true
+* `(nil)` is 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
+* `(when t1 t2)` returns true if `t1` is true and `t2` is true or `t1` is false
+* `(exists k)` returns true if `k` property exists in the fact
+* `(absent k)` returns true if `k` property is absent
+* `(eq a b)` returns true if `a` equals to `b`
+* `(lt a b)` returns true if `a` is less than `b`
+* `(gt a b)` returns true if `a` is greater than `b`
+* `(size k)` returns cardinality of `k` property (zero if property is absent)
+* `(type a)` returns type of `a` ("String", "Integer", "Float", or "Time")
+* `(matches a re)` returns type when `a` matches regular expression `re`
+* `(defn foo "self.to_s")` defines a new term using Ruby syntax and returns true
+
 ## How to contribute
 
 Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).

data/lib/factbase/fact.rb

@@ -61,6 +61,7 @@ class Factbase::Fact
         end
         @map[kk] = [@map[kk]] unless @map[kk].is_a?(Array)
         @map[kk] << v
+        @map[kk].uniq!
       end
       nil
     elsif k == '[]'
@@ -69,7 +70,7 @@ class Factbase::Fact
       v = @map[k]
       if v.nil?
         raise "Can't get '#{k}', the fact is empty" if @map.empty?
-        raise "Can't find '#{k}' attribute in [#{@map.keys.join(', ')}]"
+        raise "Can't find '#{k}' attribute out of [#{@map.keys.join(', ')}]"
       end
       v.is_a?(Array) ? v[0] : v
     end

data/lib/factbase/query.rb

@@ -44,7 +44,7 @@ class Factbase::Query
     yielded = 0
     @maps.each do |m|
       f = Factbase::Fact.new(@mutex, m)
-      next unless term.eval(f)
+      next unless term.evaluate(f)
       yield f
       yielded += 1
     end
@@ -59,7 +59,7 @@ class Factbase::Query
     @mutex.synchronize do
       @maps.delete_if do |m|
         f = Factbase::Fact.new(@mutex, m)
-        if term.eval(f)
+        if term.evaluate(f)
           deleted += 1
           true
         else

data/lib/factbase/rules.rb

@@ -117,7 +117,7 @@ class Factbase::Rules
     end
 
     def it(fact)
-      return if Factbase::Syntax.new(@expr).to_term.eval(fact)
+      return if Factbase::Syntax.new(@expr).to_term.evaluate(fact)
       raise "The fact is in invalid state: #{fact}"
     end
   end

data/lib/factbase/syntax.rb

@@ -41,9 +41,10 @@ class Factbase::Syntax
   def to_term
     @tokens ||= to_tokens
     @ast ||= to_ast(@tokens, 0)
+    raise "Too many terms: #{@query}" if @ast[1] != @tokens.size
     term = @ast[0]
-    raise 'No terms found' if term.nil?
-    raise 'Not a term' unless term.is_a?(Factbase::Term)
+    raise "No terms found: #{@query}" if term.nil?
+    raise "Not a term: #{@query}" unless term.is_a?(Factbase::Term)
     term
   end
 
@@ -57,7 +58,7 @@ 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}" if tokens[at] == :close
+    raise "Closing too soon at ##{at}: #{@query}" if tokens[at] == :close
     return [tokens[at], at + 1] unless tokens[at] == :open
     at += 1
     op = tokens[at]
@@ -65,11 +66,11 @@ class Factbase::Syntax
     operands = []
     at += 1
     loop do
-      raise "End of token stream at ##{at}" if tokens[at].nil?
+      raise "End of token stream at ##{at}: #{@query}" if tokens[at].nil?
       break if tokens[at] == :close
       (operand, at1) = to_ast(tokens, at)
-      raise "Stuck at position ##{at}" if at == at1
-      raise "Jump back at position ##{at}" if at1 < at
+      raise "Stuck at position ##{at}: #{@query}" if at == at1
+      raise "Jump back at position ##{at}: #{@query}" if at1 < at
       at = at1
       operands << operand
       break if tokens[at] == :close
@@ -109,12 +110,12 @@ class Factbase::Syntax
         acc += c
       end
     end
-    raise 'String not closed' if string
+    raise "String not closed: : #{@query}" if string
     list.map do |t|
       if t.is_a?(Symbol)
         t
       elsif t.start_with?('\'', '"')
-        raise 'String literal can\'t be empty' if t.length <= 2
+        raise "String literal can't be empty: #{@query}" if t.length <= 2
         t[1..-2]
       elsif t.match?(/^[0-9]+$/)
         t.to_i
@@ -123,6 +124,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_]*$/)
         t.to_sym
       end
     end

data/lib/factbase/term.rb

@@ -41,7 +41,7 @@ class Factbase::Term
   # Does it match the fact?
   # @param [Factbase::Fact] fact The fact
   # @return [bool] TRUE if matches
-  def eval(fact)
+  def evaluate(fact)
     send(@op, fact)
   end
 
@@ -71,19 +71,25 @@ class Factbase::Term
 
   def not(fact)
     assert_args(1)
-    !@operands[0].eval(fact)
+    r = @operands[0].evaluate(fact)
+    raise 'Boolean expected' unless r.is_a?(TrueClass) || r.is_a?(FalseClass)
+    !r
   end
 
   def or(fact)
     @operands.each do |o|
-      return true if o.eval(fact)
+      r = o.evaluate(fact)
+      raise 'Boolean expected' unless r.is_a?(TrueClass) || r.is_a?(FalseClass)
+      return true if r
     end
     false
   end
 
   def and(fact)
     @operands.each do |o|
-      return false unless o.eval(fact)
+      r = o.evaluate(fact)
+      raise 'Boolean expected' unless r.is_a?(TrueClass) || r.is_a?(FalseClass)
+      return false unless r
     end
     true
   end
@@ -92,7 +98,7 @@ class Factbase::Term
     assert_args(2)
     a = @operands[0]
     b = @operands[1]
-    !a.eval(fact) || (a.eval(fact) && b.eval(fact))
+    !a.evaluate(fact) || (a.evaluate(fact) && b.evaluate(fact))
   end
 
   def exists(fact)
@@ -132,6 +138,17 @@ class Factbase::Term
     v.class.to_s
   end
 
+  def matches(fact)
+    assert_args(2)
+    str = the_value(0, fact)
+    raise 'String is nil' if str.nil?
+    raise 'Exactly one string expected' unless str.size == 1
+    re = the_value(1, fact)
+    raise 'Regexp is nil' if re.nil?
+    raise 'Exactly one regexp expected' unless re.size == 1
+    str[0].to_s.match?(re[0])
+  end
+
   def arithmetic(op, fact)
     assert_args(2)
     lefts = the_value(0, fact)
@@ -147,6 +164,16 @@ class Factbase::Term
     end
   end
 
+  def defn(_fact)
+    fn = @operands[0]
+    raise 'A symbol expected as first argument of defn' unless fn.is_a?(Symbol)
+    e = "class Factbase::Term\nprivate\ndef #{fn}(fact)\n#{@operands[1]}\nend\nend"
+    # rubocop:disable Security/Eval
+    eval(e)
+    # rubocop:enable Security/Eval
+    true
+  end
+
   def assert_args(num)
     c = @operands.size
     raise "Too many (#{c}) operands for '#{@op}' (#{num} expected)" if c > num
@@ -162,7 +189,7 @@ class Factbase::Term
 
   def the_value(pos, fact)
     v = @operands[pos]
-    v = v.eval(fact) if v.is_a?(Factbase::Term)
+    v = v.evaluate(fact) if v.is_a?(Factbase::Term)
     v = fact[v.to_s] if v.is_a?(Symbol)
     return v if v.nil?
     v = [v] unless v.is_a?(Array)

data/lib/factbase/to_xml.rb

@@ -37,11 +37,13 @@ class Factbase::ToXML
   # Convert the entire factbase into XML.
   # @return [String] The factbase in XML format
   def xml
+    bytes = @fb.export
+    maps = Marshal.load(bytes)
     meta = {
-      factbase_version: Factbase::VERSION,
-      dob: Time.now.utc.iso8601
+      version: Factbase::VERSION,
+      dob: Time.now.utc.iso8601,
+      size: bytes.size
     }
-    maps = Marshal.load(@fb.export)
     Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
       xml.fb(meta) do
         maps.each do |m|

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.28'
+  VERSION = '0.0.29'
 
   # Constructor.
   def initialize(facts = [])

data/test/factbase/test_fact.rb

@@ -39,6 +39,16 @@ class TestFact < Minitest::Test
     assert_equal([42, 256], f['foo'], f.to_s)
   end
 
+  def test_keeps_values_unique
+    map = {}
+    f = Factbase::Fact.new(Mutex.new, map)
+    f.foo = 42
+    f.foo = 'Hello'
+    assert_equal(2, map['foo'].size)
+    f.foo = 42
+    assert_equal(2, map['foo'].size)
+  end
+
   def test_fails_when_empty
     f = Factbase::Fact.new(Mutex.new, {})
     assert_raises do

data/test/factbase/test_syntax.rb

@@ -45,8 +45,9 @@ class TestSyntax < Minitest::Test
       '(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 8s 8is 'Foo')))"
+      "(or ( a 4) (b 5) () (and () (c 5) \t\t(r 7 w8s w8is 'Foo')))"
     ].each do |q|
       Factbase::Syntax.new(q).to_term
     end
@@ -83,7 +84,7 @@ class TestSyntax < Minitest::Test
       '(or (eq bar 888) (eq z 1))' => true,
       "(or (gt bar 100) (eq foo 'Hello, world!'))" => true
     }.each do |k, v|
-      assert_equal(v, Factbase::Syntax.new(k).to_term.eval(m), k)
+      assert_equal(v, Factbase::Syntax.new(k).to_term.evaluate(m), k)
     end
   end
 
@@ -91,11 +92,13 @@ class TestSyntax < Minitest::Test
     [
       '',
       '(foo',
+      '(foo 1) (bar 2)',
       'some text',
       '"hello, world!',
       '(foo 7',
       "(foo 7 'Dude'",
       '(foo x y z (',
+      '(bad-term-name 42)',
       '(foo x y (z t (f 42 ',
       ')foo ) y z)',
       '(x "")',
@@ -103,7 +106,7 @@ class TestSyntax < Minitest::Test
       ')',
       '"'
     ].each do |q|
-      assert_raises do
+      assert_raises(q) do
         Factbase::Syntax.new(q).to_term
       end
     end

data/test/factbase/test_term.rb

@@ -30,95 +30,102 @@ require_relative '../../lib/factbase/term'
 class TestTerm < Minitest::Test
   def test_simple_matching
     t = Factbase::Term.new(:eq, [:foo, 42])
-    assert(t.eval(fact('foo' => [42])))
-    assert(!t.eval(fact('foo' => 'Hello!')))
-    assert(!t.eval(fact('bar' => ['Hello!'])))
+    assert(t.evaluate(fact('foo' => [42])))
+    assert(!t.evaluate(fact('foo' => 'Hello!')))
+    assert(!t.evaluate(fact('bar' => ['Hello!'])))
   end
 
   def test_eq_matching
     t = Factbase::Term.new(:eq, [:foo, 42])
-    assert(t.eval(fact('foo' => 42)))
-    assert(t.eval(fact('foo' => [10, 5, 6, -8, 'hey', 42, 9, 'fdsf'])))
-    assert(!t.eval(fact('foo' => [100])))
-    assert(!t.eval(fact('foo' => [])))
-    assert(!t.eval(fact('bar' => [])))
+    assert(t.evaluate(fact('foo' => 42)))
+    assert(t.evaluate(fact('foo' => [10, 5, 6, -8, 'hey', 42, 9, 'fdsf'])))
+    assert(!t.evaluate(fact('foo' => [100])))
+    assert(!t.evaluate(fact('foo' => [])))
+    assert(!t.evaluate(fact('bar' => [])))
   end
 
   def test_eq_matching_time
     now = Time.now
     t = Factbase::Term.new(:eq, [:foo, Time.parse(now.iso8601)])
-    assert(t.eval(fact('foo' => now)))
-    assert(t.eval(fact('foo' => [now, Time.now])))
+    assert(t.evaluate(fact('foo' => now)))
+    assert(t.evaluate(fact('foo' => [now, Time.now])))
   end
 
   def test_lt_matching
     t = Factbase::Term.new(:lt, [:foo, 42])
-    assert(t.eval(fact('foo' => [10])))
-    assert(!t.eval(fact('foo' => [100])))
-    assert(!t.eval(fact('foo' => 100)))
-    assert(!t.eval(fact('bar' => 100)))
+    assert(t.evaluate(fact('foo' => [10])))
+    assert(!t.evaluate(fact('foo' => [100])))
+    assert(!t.evaluate(fact('foo' => 100)))
+    assert(!t.evaluate(fact('bar' => 100)))
   end
 
   def test_gt_matching
     t = Factbase::Term.new(:gt, [:foo, 42])
-    assert(t.eval(fact('foo' => [100])))
-    assert(t.eval(fact('foo' => 100)))
-    assert(!t.eval(fact('foo' => [10])))
-    assert(!t.eval(fact('foo' => 10)))
-    assert(!t.eval(fact('bar' => 10)))
+    assert(t.evaluate(fact('foo' => [100])))
+    assert(t.evaluate(fact('foo' => 100)))
+    assert(!t.evaluate(fact('foo' => [10])))
+    assert(!t.evaluate(fact('foo' => 10)))
+    assert(!t.evaluate(fact('bar' => 10)))
   end
 
   def test_lt_matching_time
     t = Factbase::Term.new(:lt, [:foo, Time.now])
-    assert(t.eval(fact('foo' => [Time.now - 100])))
-    assert(!t.eval(fact('foo' => [Time.now + 100])))
-    assert(!t.eval(fact('bar' => [100])))
+    assert(t.evaluate(fact('foo' => [Time.now - 100])))
+    assert(!t.evaluate(fact('foo' => [Time.now + 100])))
+    assert(!t.evaluate(fact('bar' => [100])))
   end
 
   def test_gt_matching_time
     t = Factbase::Term.new(:gt, [:foo, Time.now])
-    assert(t.eval(fact('foo' => [Time.now + 100])))
-    assert(!t.eval(fact('foo' => [Time.now - 100])))
-    assert(!t.eval(fact('bar' => [100])))
+    assert(t.evaluate(fact('foo' => [Time.now + 100])))
+    assert(!t.evaluate(fact('foo' => [Time.now - 100])))
+    assert(!t.evaluate(fact('bar' => [100])))
   end
 
   def test_not_matching
     t = Factbase::Term.new(:not, [Factbase::Term.new(:nil, [])])
-    assert(!t.eval(fact('foo' => [100])))
+    assert(!t.evaluate(fact('foo' => [100])))
   end
 
   def test_not_eq_matching
     t = Factbase::Term.new(:not, [Factbase::Term.new(:eq, [:foo, 100])])
-    assert(t.eval(fact('foo' => [42, 12, -90])))
-    assert(!t.eval(fact('foo' => 100)))
+    assert(t.evaluate(fact('foo' => [42, 12, -90])))
+    assert(!t.evaluate(fact('foo' => 100)))
   end
 
   def test_size_matching
     t = Factbase::Term.new(:size, [:foo])
-    assert_equal(3, t.eval(fact('foo' => [42, 12, -90])))
-    assert_equal(0, t.eval(fact('bar' => 100)))
+    assert_equal(3, t.evaluate(fact('foo' => [42, 12, -90])))
+    assert_equal(0, t.evaluate(fact('bar' => 100)))
   end
 
   def test_exists_matching
     t = Factbase::Term.new(:exists, [:foo])
-    assert(t.eval(fact('foo' => [42, 12, -90])))
-    assert(!t.eval(fact('bar' => 100)))
+    assert(t.evaluate(fact('foo' => [42, 12, -90])))
+    assert(!t.evaluate(fact('bar' => 100)))
   end
 
   def test_absent_matching
     t = Factbase::Term.new(:absent, [:foo])
-    assert(t.eval(fact('z' => [42, 12, -90])))
-    assert(!t.eval(fact('foo' => 100)))
+    assert(t.evaluate(fact('z' => [42, 12, -90])))
+    assert(!t.evaluate(fact('foo' => 100)))
   end
 
   def test_type_matching
     t = Factbase::Term.new(:type, [:foo])
-    assert_equal('Integer', t.eval(fact('foo' => 42)))
-    assert_equal('Array', t.eval(fact('foo' => [1, 2, 3])))
-    assert_equal('String', t.eval(fact('foo' => 'Hello, world!')))
-    assert_equal('Float', t.eval(fact('foo' => 3.14)))
-    assert_equal('Time', t.eval(fact('foo' => Time.now)))
-    assert_equal('nil', t.eval(fact))
+    assert_equal('Integer', t.evaluate(fact('foo' => 42)))
+    assert_equal('Array', t.evaluate(fact('foo' => [1, 2, 3])))
+    assert_equal('String', t.evaluate(fact('foo' => 'Hello, world!')))
+    assert_equal('Float', t.evaluate(fact('foo' => 3.14)))
+    assert_equal('Time', t.evaluate(fact('foo' => Time.now)))
+    assert_equal('nil', t.evaluate(fact))
+  end
+
+  def test_regexp_matching
+    t = Factbase::Term.new(:matches, [:foo, '[a-z]+'])
+    assert(t.evaluate(fact('foo' => 'hello')))
+    assert(t.evaluate(fact('foo' => 'hello 42')))
+    assert(!t.evaluate(fact('foo' => 42)))
   end
 
   def test_or_matching
@@ -129,9 +136,9 @@ class TestTerm < Minitest::Test
         Factbase::Term.new(:eq, [:bar, 5])
       ]
     )
-    assert(t.eval(fact('foo' => [4])))
-    assert(t.eval(fact('bar' => [5])))
-    assert(!t.eval(fact('bar' => [42])))
+    assert(t.evaluate(fact('foo' => [4])))
+    assert(t.evaluate(fact('bar' => [5])))
+    assert(!t.evaluate(fact('bar' => [42])))
   end
 
   def test_when_matching
@@ -142,9 +149,16 @@ class TestTerm < Minitest::Test
         Factbase::Term.new(:eq, [:bar, 5])
       ]
     )
-    assert(t.eval(fact('foo' => 4, 'bar' => 5)))
-    assert(!t.eval(fact('foo' => 4)))
-    assert(t.eval(fact('foo' => 5, 'bar' => 5)))
+    assert(t.evaluate(fact('foo' => 4, 'bar' => 5)))
+    assert(!t.evaluate(fact('foo' => 4)))
+    assert(t.evaluate(fact('foo' => 5, 'bar' => 5)))
+  end
+
+  def test_defn_simple
+    t = Factbase::Term.new(:defn, [:foo, 'self.to_s'])
+    assert_equal(true, t.evaluate(fact('foo' => 4)))
+    t1 = Factbase::Term.new(:foo, ['hello, world!'])
+    assert_equal('(foo \'hello, world!\')', t1.evaluate(fact))
   end
 
   private

data/test/factbase/test_to_xml.rb

@@ -57,7 +57,8 @@ class TestToXML < Minitest::Test
     to = Factbase::ToXML.new(fb)
     xml = Nokogiri::XML.parse(to.xml)
     assert(!xml.xpath('/fb[@dob]').empty?)
-    assert(!xml.xpath('/fb[@factbase_version]').empty?)
+    assert(!xml.xpath('/fb[@version]').empty?)
+    assert(!xml.xpath('/fb[@size]').empty?)
   end
 
   def test_to_xml_with_short_names

metadata

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