factbase 0.0.17 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7ba6b0db6da2ae4a2075896ff5b8365716d881eab694e0c848063cfb0b19270
-  data.tar.gz: 53e1f409d20404d60827545927f1b88797708889d18fc0177d176a7ae93e9a68
+  metadata.gz: bf6bf5824dca2b686d94a18b4341e2fbcd08adf286e228043418c98e2633673a
+  data.tar.gz: e37dcd3ad0fc483ed24586e353bc48d9afc6ec42384ef39f0cab9d30a85ede93
 SHA512:
-  metadata.gz: 5f2db2983906007c6d4e12bb63b730e277d055c0f4768f41f6bc3ac68a6bccf6fa59226fa8ab417c41f0f53dfa163af59d7732e9082800494268e3d047de6f0c
-  data.tar.gz: 9c77ce233f61637e0bec39b72da43fdc5403d0e098b4f4505747bce634233810acaaa88e65aa59c6ded4f8aef870b25823f04f051999ec9e221a26b5520960f9
+  metadata.gz: 00d59f7a614600ba776343545188b3ba4a0ea5f6f4470da577cd7506b6286a1f28f6232c03d47425d235132d9d1d694d5a212dcfd0ffcf3096269e1da900b6ab
+  data.tar.gz: 4572157aab7d5d5844905a1bee96e002233efdbf2667c245438c746f765c8c9aa41ede733c6c24ec9fa01728304a2e9b8d5e18d4d46ac0a04bd8d8666d70178c

data/.github/workflows/rake.yml

@@ -32,7 +32,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-20.04, macos-12]
-        ruby: [2.7, 3.2]
+        ruby: [3.2]
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4

data/README.md

@@ -32,11 +32,12 @@ end
 You can save the factbase to disc and load it back:
 
 ```ruby
+file = '/tmp/simple.fb'
 f1 = Factbase.new
 f1.insert
-File.save('/tmp/db.txt', f1.export)
+File.save(file, f1.export)
 f2 = Factbase.new
-f2.import(File.read('/tmp/db.txt'))
+f2.import(File.read(file))
 ```
 
 ## How to contribute
@@ -44,7 +45,7 @@ f2.import(File.read('/tmp/db.txt'))
 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/) 2.3+ and
+[Ruby](https://www.ruby-lang.org/en/) 3.2+ and
 [Bundler](https://bundler.io/) installed. Then:
 
 ```bash

data/factbase.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 = '>=2.3'
   s.name = 'factbase'
-  s.version = '0.0.17'
+  s.version = '0.0.19'
   s.license = 'MIT'
   s.summary = 'Factbase'
   s.description = 'Fact base in memory and on disc'

data/lib/factbase/fact.rb

@@ -21,6 +21,7 @@
 # SOFTWARE.
 
 require 'json'
+require 'time'
 require_relative '../factbase'
 
 # Fact.
@@ -33,10 +34,13 @@ class Factbase::Fact
     @map = map
   end
 
+  # Convert it to a string.
+  # @return [String] String representation of it (in JSON)
   def to_s
     @map.to_json
   end
 
+  # When a method is missing, this method is called.
   def method_missing(*args)
     k = args[0].to_s
     if k.end_with?('=')
@@ -46,6 +50,7 @@ class Factbase::Fact
       raise "Prop value can't be nil" if v.nil?
       raise "Prop value can't be empty" if v == ''
       raise "Prop type '#{v.class}' is not allowed" unless [String, Integer, Float, Time].include?(v.class)
+      v = v.utc if v.is_a?(Time)
       @mutex.synchronize do
         before = @map[kk]
         return if before == v

data/lib/factbase/looged.rb

@@ -84,7 +84,8 @@ class Factbase::Looged
     def method_missing(*args)
       r = @fact.method_missing(*args)
       k = args[0].to_s
-      @loog.debug("Set '#{k[0..-2]}' to '#{args[1]}'") if k.end_with?('=')
+      v = args[1]
+      @loog.debug("Set '#{k[0..-2]}' to '#{v.to_s.inspect}' (#{v.class})") if k.end_with?('=')
       r
     end
 
@@ -109,13 +110,23 @@ class Factbase::Looged
 
     def each(&)
       r = @query.each(&)
-      @loog.debug("Found #{r} facts by '#{@expr}'")
+      raise 'Invalid return from query.each' unless r.is_a?(Integer)
+      if r.zero?
+        @loog.debug("Nothing found by '#{@expr}'")
+      else
+        @loog.debug("Found #{r} fact(s) by '#{@expr}'")
+      end
       r
     end
 
     def delete!
       r = @query.delete!
-      @loog.debug("Deleted #{r} facts by '#{@expr}'")
+      raise 'Invalid return from query.delete!' unless r.is_a?(Integer)
+      if r.zero?
+        @loog.debug("Nothing deleted by '#{@expr}'")
+      else
+        @loog.debug("Deleted #{r} fact(s) by '#{@expr}'")
+      end
       r
     end
   end

data/lib/factbase/syntax.rb

@@ -29,6 +29,8 @@ require_relative 'term'
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 class Factbase::Syntax
+  # Ctor.
+  # @param [String] query The query, for example "(eq id 42)"
   def initialize(query)
     @query = query
   end

data/lib/factbase/term.rb

@@ -30,18 +30,23 @@ require_relative 'fact'
 class Factbase::Term
   attr_reader :op, :operands
 
+  # Ctor.
+  # @param [Symbol] operator Operator
+  # @param [Array] operands Operands
   def initialize(operator, operands)
     @op = operator
     @operands = operands
   end
 
   # Does it match the fact?
-  # @param [Factbase::Fact] The fact
+  # @param [Factbase::Fact] fact The fact
   # @return [bool] TRUE if matches
   def matches?(fact)
     send(@op, fact)
   end
 
+  # Turns it into a string.
+  # @return [String] The string of it
   def to_s
     items = []
     items << @op
@@ -85,13 +90,17 @@ class Factbase::Term
 
   def exists(fact)
     assert_args(1)
-    k = @operands[0].to_s
+    o = @operands[0]
+    raise "A symbol expected: #{o}" unless o.is_a?(Symbol)
+    k = o.to_s
     !fact[k].nil?
   end
 
   def absent(fact)
     assert_args(1)
-    k = @operands[0].to_s
+    o = @operands[0]
+    raise "A symbol expected: #{o}" unless o.is_a?(Symbol)
+    k = o.to_s
     fact[k].nil?
   end
 
@@ -109,7 +118,9 @@ class Factbase::Term
 
   def arithmetic(op, fact)
     assert_args(2)
-    k = @operands[0].to_s
+    o = @operands[0]
+    raise "A symbol expected by #{op}: #{o}" unless o.is_a?(Symbol)
+    k = o.to_s
     v = fact[k]
     return false if v.nil?
     v = [v] unless v.is_a?(Array)

data/test/factbase/test_fact.rb

@@ -73,4 +73,12 @@ class TestFact < Minitest::Test
     f.send('foo_bar=', 42)
     assert_equal(42, f.foo_bar, f.to_s)
   end
+
+  def test_time_in_utc
+    f = Factbase::Fact.new(Mutex.new, {})
+    t = Time.now
+    f.foo = t
+    assert_equal(t.utc, f.foo)
+    assert_equal(t.utc.to_s, f.foo.to_s)
+  end
 end

data/test/factbase/test_looged.rb

@@ -43,4 +43,30 @@ class TestLooged < Minitest::Test
     assert_equal(2, found)
     assert_equal(2, fb.size)
   end
+
+  def test_returns_int
+    fb = Factbase.new
+    fb.insert
+    fb.insert
+    assert_equal(2, Factbase::Looged.new(fb, Loog::NULL).query('()').each(&:to_s))
+  end
+
+  def test_proper_logging
+    log = Loog::Buffer.new
+    fb = Factbase::Looged.new(Factbase.new, log)
+    fb.insert
+    fb.insert.bar = 3
+    fb.insert
+    fb.query('(exists bar)').each(&:to_s)
+    fb.query('(not (exists bar))').delete!
+    [
+      'Inserted fact #1',
+      'Inserted fact #2',
+      'Set \'bar\' to \'"3"\' (Integer)',
+      'Found 1 fact(s) by \'(exists bar)\'',
+      'Deleted 2 fact(s) by \'(not (exists bar))\''
+    ].each do |s|
+      assert(log.to_s.include?("#{s}\n"), "#{log}\n")
+    end
+  end
 end

data/test/factbase/test_query.rb

@@ -77,4 +77,11 @@ class TestQuery < Minitest::Test
     maps << { 'foo' => [42] }
     assert_equal(1, Factbase::Query.new(maps, Mutex.new, '(eq foo 42)').each.to_a.size)
   end
+
+  def test_returns_int
+    maps = []
+    maps << { 'foo' => 1 }
+    q = Factbase::Query.new(maps, Mutex.new, '(eq foo 1)')
+    assert_equal(1, q.each(&:to_s))
+  end
 end

data/test/factbase/test_term.rb

@@ -29,14 +29,14 @@ require_relative '../../lib/factbase/term'
 # License:: MIT
 class TestTerm < Minitest::Test
   def test_simple_matching
-    t = Factbase::Term.new(:eq, ['foo', 42])
+    t = Factbase::Term.new(:eq, [:foo, 42])
     assert(t.matches?(fact('foo' => [42])))
     assert(!t.matches?(fact('foo' => 'Hello!')))
     assert(!t.matches?(fact('bar' => ['Hello!'])))
   end
 
   def test_eq_matching
-    t = Factbase::Term.new(:eq, ['foo', 42])
+    t = Factbase::Term.new(:eq, [:foo, 42])
     assert(t.matches?(fact('foo' => 42)))
     assert(t.matches?(fact('foo' => [10, 5, 6, -8, 'hey', 42, 9, 'fdsf'])))
     assert(!t.matches?(fact('foo' => [100])))
@@ -45,7 +45,7 @@ class TestTerm < Minitest::Test
   end
 
   def test_lt_matching
-    t = Factbase::Term.new(:lt, ['foo', 42])
+    t = Factbase::Term.new(:lt, [:foo, 42])
     assert(t.matches?(fact('foo' => [10])))
     assert(!t.matches?(fact('foo' => [100])))
     assert(!t.matches?(fact('foo' => 100)))
@@ -53,7 +53,7 @@ class TestTerm < Minitest::Test
   end
 
   def test_gt_matching
-    t = Factbase::Term.new(:gt, ['foo', 42])
+    t = Factbase::Term.new(:gt, [:foo, 42])
     assert(t.matches?(fact('foo' => [100])))
     assert(t.matches?(fact('foo' => 100)))
     assert(!t.matches?(fact('foo' => [10])))
@@ -62,14 +62,14 @@ class TestTerm < Minitest::Test
   end
 
   def test_lt_matching_time
-    t = Factbase::Term.new(:lt, ['foo', Time.now])
+    t = Factbase::Term.new(:lt, [:foo, Time.now])
     assert(t.matches?(fact('foo' => [Time.now - 100])))
     assert(!t.matches?(fact('foo' => [Time.now + 100])))
     assert(!t.matches?(fact('bar' => [100])))
   end
 
   def test_gt_matching_time
-    t = Factbase::Term.new(:gt, ['foo', Time.now])
+    t = Factbase::Term.new(:gt, [:foo, Time.now])
     assert(t.matches?(fact('foo' => [Time.now + 100])))
     assert(!t.matches?(fact('foo' => [Time.now - 100])))
     assert(!t.matches?(fact('bar' => [100])))
@@ -81,19 +81,19 @@ class TestTerm < Minitest::Test
   end
 
   def test_not_eq_matching
-    t = Factbase::Term.new(:not, [Factbase::Term.new(:eq, ['foo', 100])])
+    t = Factbase::Term.new(:not, [Factbase::Term.new(:eq, [:foo, 100])])
     assert(t.matches?(fact('foo' => [42, 12, -90])))
     assert(!t.matches?(fact('foo' => 100)))
   end
 
   def test_exists_matching
-    t = Factbase::Term.new(:exists, ['foo'])
+    t = Factbase::Term.new(:exists, [:foo])
     assert(t.matches?(fact('foo' => [42, 12, -90])))
     assert(!t.matches?(fact('bar' => 100)))
   end
 
   def test_absent_matching
-    t = Factbase::Term.new(:absent, ['foo'])
+    t = Factbase::Term.new(:absent, [:foo])
     assert(t.matches?(fact('z' => [42, 12, -90])))
     assert(!t.matches?(fact('foo' => 100)))
   end
@@ -102,8 +102,8 @@ class TestTerm < Minitest::Test
     t = Factbase::Term.new(
       :or,
       [
-        Factbase::Term.new(:eq, ['foo', 4]),
-        Factbase::Term.new(:eq, ['bar', 5])
+        Factbase::Term.new(:eq, [:foo, 4]),
+        Factbase::Term.new(:eq, [:bar, 5])
       ]
     )
     assert(t.matches?(fact('foo' => [4])))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: factbase
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.19
 platform: ruby
 authors:
 - Yegor Bugayenko