factbase 0.0.39 → 0.0.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ff1db55d5a25e5036d3a98423caedc960f8323681e2227c82e0a397727067c0
-  data.tar.gz: b3000b708bd2eb69005998a722011a296384d5cea66641b975471e611b93e4d0
+  metadata.gz: 0ea2fe8670484d4eb3eac59caa947b547863a2106fa6ae771b8e9447b30573dc
+  data.tar.gz: b45d41378d4b61f0b3d8d01a3454819a4eca7724bd81adda7fe083c9594250ef
 SHA512:
-  metadata.gz: a377a359a877b1f50c83f13c451e095036b4087cf88e39c04a0e5d64e86337bfef458883646009daff4b2b90446abbdbd563a4921b3ed275b88b7408b69ef0de
-  data.tar.gz: 26a5ca088df353e0c526080213aa4d87b23805dd522617d52d2d738b1881c40ae4c659fa886db4fbe19a30a131ff6b5a7e19aadf5dbafcbd0f6b81954386bd65
+  metadata.gz: 40d6ca4cce2c4d64fe5e31b609c2fd15d05041358b8ae3be266c991f943ce242217378a8e83f96d8be83c50068fb65e04dff8c8c24708eeea8f79490e283c817
+  data.tar.gz: d09b19ac55775c511c0619b0a23be1260496f33d623927153e0b5b373b6919570a9f47104c0e2b1125299799f561e2b6fb39b2cb6ea5486b48ab76a05e15bfd1

data/Gemfile

@@ -26,7 +26,7 @@ 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 'simplecov', '0.22.0', 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)
@@ -184,7 +184,7 @@ 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)
   simplecov (= 0.22.0)

data/README.md

@@ -92,6 +92,7 @@ One term is for meta-programming:
 There are terms that are history of search aware:
 
 * `(prev a)` returns the value of `a` in the previously seen fact
+* `(unique k)` returns true if the value of `k` property hasn't been seen yet
 
 There are also terms that match the entire factbase
 and must be used inside the `(agg ..)` term:

data/lib/factbase/fact.rb

@@ -24,17 +24,20 @@ require 'json'
 require 'time'
 require_relative '../factbase'
 
-# Fact.
+# A single fact in a factbase.
 #
-# This is an internal class, it is not supposed to be instantiated directly.
-#
-# It is possible to use for testing directly, for example to make a
+# This is an internal class, it is not supposed to be instantiated directly,
+# by the +Factbase+ class.
+# However, it is possible to use it for testing directly, for example to make a
 # fact with a single key/value pair inside:
 #
 #  require 'factbase/fact'
 #  f = Factbase::Fact.new(Mutex.new, { 'foo' => [42, 256, 'Hello, world!'] })
 #  assert_equal(42, f.foo)
 #
+# A fact is basically a key/value hash map, where values are non-empty
+# sets of values.
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT

data/lib/factbase/looged.rb

@@ -20,6 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+require 'time'
 require 'loog'
 
 # A decorator of a Factbase, that logs all operations.
@@ -114,39 +115,51 @@ class Factbase::Looged
     def each(&)
       q = Factbase::Syntax.new(@expr).to_term.to_s
       if block_given?
-        r = @query.each(&)
+        r = nil
+        tail = Factbase::Looged.elapsed do
+          r = @query.each(&)
+        end
         raise ".each of #{@query.class} returned #{r.class}" unless r.is_a?(Integer)
         if r.zero?
-          @loog.debug("Nothing found by '#{q}'")
+          @loog.debug("Nothing found by '#{q}' #{tail}")
         else
-          @loog.debug("Found #{r} fact(s) by '#{q}'")
+          @loog.debug("Found #{r} fact(s) by '#{q}' #{tail}")
         end
         r
       else
         array = []
-        # rubocop:disable Style/MapIntoArray
-        @query.each do |f|
-          array << f
+        tail = Factbase::Looged.elapsed do
+          @query.each do |f|
+            array << f
+          end
         end
-        # rubocop:enable Style/MapIntoArray
         if array.empty?
-          @loog.debug("Nothing found by '#{q}'")
+          @loog.debug("Nothing found by '#{q}' #{tail}")
         else
-          @loog.debug("Found #{array.size} fact(s) by '#{q}'")
+          @loog.debug("Found #{array.size} fact(s) by '#{q}' #{tail}")
         end
         array
       end
     end
 
     def delete!
-      r = @query.delete!
+      r = nil
+      tail = Factbase::Looged.elapsed do
+        r = @query.delete!
+      end
       raise ".delete! of #{@query.class} returned #{r.class}" unless r.is_a?(Integer)
       if r.zero?
-        @loog.debug("Nothing deleted by '#{@expr}'")
+        @loog.debug("Nothing deleted by '#{@expr}' #{tail}")
       else
-        @loog.debug("Deleted #{r} fact(s) by '#{@expr}'")
+        @loog.debug("Deleted #{r} fact(s) by '#{@expr}' #{tail}")
       end
       r
     end
   end
+
+  def self.elapsed
+    start = Time.now
+    yield
+    "in #{format('%.2f', (Time.now - start) * 1000)}ms"
+  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/term.rb

@@ -36,6 +36,15 @@ require_relative 'fact'
 #  t = Factbase::Term.new(:lt, [:foo, 50])
 #  assert(t.evaluate(f))
 #
+# The design of this class may look ugly, since it has a large number of
+# methods, each of which corresponds to a different type of a +Term+. A much
+# better design would definitely involve many classes, one per each type
+# of a term. It's not done this way because of an experimental nature of
+# the project. Most probably we should keep current design intact, since it
+# works well and is rather simple to extend (by adding new term types).
+# Moreover, it looks like the number of possible term types is rather limited
+# and currently we implement most of them.
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
@@ -57,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}"
   end
 
   # Simplify it if possible.
@@ -102,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), 0)
     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), 0)
     end
     true
   end
@@ -184,6 +195,19 @@ class Factbase::Term
     before
   end
 
+  def unique(fact, _maps)
+    @uniques = [] if @uniques.nil?
+    assert_args(1)
+    vv = by_symbol(0, fact)
+    return false if vv.nil?
+    vv = [vv] unless vv.is_a?(Array)
+    vv.each do |v|
+      return false if @uniques.include?(v)
+      @uniques << v
+    end
+    true
+  end
+
   def many(fact, maps)
     assert_args(1)
     v = the_values(0, fact, maps)
@@ -317,6 +341,7 @@ 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)
     term = @operands[1]
@@ -352,10 +377,12 @@ 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
 

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.39'
+  VERSION = '0.0.41'
 
   # 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_looged.rb

@@ -94,7 +94,7 @@ class TestLooged < Minitest::Test
       'Found 1 fact(s) by \'(exists bar)\'',
       'Deleted 3 fact(s) by \'(not (exists bar))\''
     ].each do |s|
-      assert(log.to_s.include?("#{s}\n"), "#{log}\n")
+      assert(log.to_s.include?(s), "#{log}\n")
     end
   end
 end

data/test/factbase/test_query.rb

@@ -57,6 +57,9 @@ class TestQuery < Minitest::Test
       '(not (exists hello))' => 3,
       '(eq "Integer" (type num))' => 2,
       '(when (eq num 0) (exists time))' => 2,
+      '(unique num)' => 2,
+      '(unique name)' => 2,
+      '(unique pi)' => 1,
       '(many num)' => 1,
       '(one num)' => 2,
       '(gt num (minus 1 (either (at 0 (prev num)) 0)))' => 3,

data/test/factbase/test_term.rb

@@ -183,6 +183,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 = {})

metadata

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