factbase 0.7.3 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d14f3343341431bb4e9828abfc7f2c0bdda83d2c484cf6df1dbbc49b9b442ca
-  data.tar.gz: 48e762c8d0c94102c8e757469c177698db655714128ae315d53696421fecce04
+  metadata.gz: 20e78ab8a1e9e32a777880d99f15cb339c22310b152fcecc626847a364536059
+  data.tar.gz: 480617fd3b19baa46c43553eb6eb87accc4bd4faa8c28a7d121803b1e5f34da0
 SHA512:
-  metadata.gz: 584de94a190d5a07693d788f9d36db7899b6535e353315d41a864184384f62825a0b6c0885a23a9f7332621bb96891362fdc090f2f6e11dac7663af9b5c35fef
-  data.tar.gz: 78b784ccb6d2800dd3aa3711dd74cd43ec801a8343f87b695d47d6d9ae195d78e9350c57900dac388304da2a91f17b0b2bbf16ba8475fb794aea000e22a4c517
+  metadata.gz: dd1fcc7943c1c3c0cc0325f1dbbfeac4be919f79d7b456ea9a9a2ffae2548dac88825854c77d8de5ca91bfbc135fd79e227c745a7793cc27a455ef9a0262367d
+  data.tar.gz: c4e4f3faf564894f4e57e308fb768906ab59a3e413fb9e45f6f9674e183382d5b7c1616465e6a2ba6382f0a8950ea56a1cef423cbfa662511a3dfded178ff4d1

data/.github/workflows/benchmark.yml

@@ -23,11 +23,13 @@ jobs:
           bundler-cache: true
       - run: bundle config set --global path "$(pwd)/vendor/bundle"
       - run: bundle install --no-color
-      - run: bundle exec ruby benchmarks/simple.rb > stdout.txt
+      - run: bundle exec rake benchmark > stdout.txt
       - run: |
           set -x
           sum=$(
+            echo '```'
             cat stdout.txt
+            echo '```'
             echo
             echo "The results were calculated in [this GHA job][benchmark-gha]"
             echo "on $(date +'%Y-%m-%d') at $(date +'%H:%M'),"

data/.gitignore

@@ -1,9 +1,9 @@
-coverage/
-.idea/
 *.gem
-.bundle/
 .DS_Store
-rdoc/
-doc/
+.bundle/
+.idea/
 .yardoc/
+coverage/
+doc/
+rdoc/
 vendor/

data/.rultor.yml

@@ -3,7 +3,7 @@
 ---
 # yamllint disable rule:line-length
 docker:
-  image: yegor256/rultor-ruby
+  image: yegor256/ruby
 assets:
   rubygems.yml: yegor256/home#assets/rubygems.yml
 install: |

data/Gemfile

@@ -10,7 +10,7 @@ gem 'minitest', '5.25.4', require: false
 gem 'minitest-reporters', '1.7.1', require: false
 gem 'rake', '13.2.1', require: false
 gem 'rspec-rails', '7.1.1', require: false
-gem 'rubocop', '1.72.2', require: false
+gem 'rubocop', '1.73.1', require: false
 gem 'rubocop-minitest', '>0', require: false
 gem 'rubocop-performance', '>0', require: false
 gem 'rubocop-rake', '>0', require: false

data/Gemfile.lock

@@ -148,7 +148,7 @@ GEM
       rspec-mocks (~> 3.13)
       rspec-support (~> 3.13)
     rspec-support (3.13.2)
-    rubocop (1.72.2)
+    rubocop (1.73.1)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -159,7 +159,7 @@ GEM
       rubocop-ast (>= 1.38.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.38.0)
+    rubocop-ast (1.38.1)
       parser (>= 3.3.1.0)
     rubocop-minitest (0.37.1)
       lint_roller (~> 1.1)
@@ -197,7 +197,7 @@ GEM
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
-    uri (1.0.2)
+    uri (1.0.3)
     useragent (0.16.11)
     yaml (0.4.0)
     yard (0.9.37)
@@ -218,7 +218,7 @@ DEPENDENCIES
   minitest-reporters (= 1.7.1)
   rake (= 13.2.1)
   rspec-rails (= 7.1.1)
-  rubocop (= 1.72.2)
+  rubocop (= 1.73.1)
   rubocop-minitest (> 0)
   rubocop-performance (> 0)
   rubocop-rake (> 0)

data/README.md

@@ -17,7 +17,7 @@ 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.
 
-**ATTENTION**: The current implemention is naive and,
+**ATTENTION**: The current implementation is naive and,
 because of that, **very slow**. I will be very happy
 if you suggest a better implementation without the change of the interface.
 The `Factbase::query()` method is what mostly needs performance optimization:
@@ -68,9 +68,9 @@ You can make a factbase log all operations:
 
 ```ruby
 require 'loog'
-require 'factbase/looged'
+require 'factbase/logged'
 log = Loog::VERBOSE
-fb = Factbase::Looged.new(Factbase.new, log)
+fb = Factbase::Logged.new(Factbase.new, log)
 f = fb.insert
 ```
 
@@ -78,9 +78,9 @@ You can also count the amount of changes made to a factbase:
 
 ```ruby
 require 'loog'
-require 'factbase/tailled'
+require 'factbase/tallied'
 log = Loog::VERBOSE
-fb = Factbase::Tailled.new(Factbase.new, log)
+fb = Factbase::Tallied.new(Factbase.new, log)
 f = fb.insert
 churn = fb.churn
 assert churn.inserted == 1
@@ -137,7 +137,7 @@ Also, some simple arithmetic:
 * `(div v1 v2)` is a division of `∏v1` by `∏v2`
 
 It's possible to add and deduct string values to time values, like
-`(plus t '2 days')` or ``(minus t '14 hours')``.
+`(plus t '2 days')` or `(minus t '14 hours')`.
 
 Types may be converted:
 
@@ -190,7 +190,7 @@ There are some system-level terms:
 
 Read
 [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
-Make sure you build is green before you contribute
+Make sure your build is green before you contribute
 your pull request. You will need to have
 [Ruby](https://www.ruby-lang.org/en/) 3.2+ and
 [Bundler](https://bundler.io/) installed. Then:
@@ -207,26 +207,30 @@ If it's clean and you don't see any error messages, submit your pull request.
 This is the result of the benchmark:
 
 <!-- benchmark_begin -->
-| Action | Seconds | Details |
-| --- | --: | --- |
-| `fb.insert()` | 1.883 | Inserted 25000 facts |
-| `(gt time '2024-03-23T03:21:43Z')` | 0.201 | 25000 facts x100 |
-| `(gt cost 50)` | 0.175 | 12430 facts x100 |
-| `(eq title 'Object Thinking 5000')` | 0.129 | 1 facts x100 |
-| `(and (eq foo 42.998) (or (gt bar 200) (absent zzz)))` | 0.157 | 0 facts x100 |
-| `(eq id (agg (always) (max id)))` | 0.268 | 1 facts x100 |
-| `(join "c<=cost,b<=bar" (eq id (agg (always) (max id))))` | 1.844 | 25000 facts x100 |
-| txn: `query()` | 19.358 | modified 0 facts |
-| txn: `insert()` | 0.059 | modified 100 facts |
-| txn: `add()` | 16.223 | modified 3 facts |
-| txn: `delete!()` | 3.573 | modified 12439 facts |
-| `.export()` + `.import()` | 0.369 | 1451040 bytes |
-| `(gt cost 3)` | 0.030 | Deleted 12395 fact(s) |
-| `(gt bar 1)` | 0.001 | Deleted 363 fact(s) |
+```
+                                                                   user     system      total        real
+insert 50000 facts                                             1.216926   0.009687   1.226613 (  1.233335)
+export 50000 facts                                             0.055611   0.002976   0.058587 (  0.058594)
+import 1008464 bytes (50000 facts)                             0.068731   0.008049   0.076780 (  0.076828)
+insert 10 facts                                                0.096866   0.019001   0.115867 (  0.115919)
+query 10 times                                                 3.940857   0.141913   4.082770 (  4.089283)
+modify 10 attrs                                                3.430524   0.064981   3.495505 (  3.499871)
+delete 10 facts                                                2.130973   0.001001   2.131974 (  2.132124)
+(gt time '2024-03-23T03:21:43Z')                               0.192254   0.005977   0.198231 (  0.198500)
+(gt cost 50)                                                   0.201262   0.004008   0.205270 (  0.205516)
+(eq title 'Object Thinking 5000')                              0.201111   0.003973   0.205084 (  0.205312)
+(and (eq foo 42.998) (or (gt bar 200) (absent zzz)))           0.304289   0.002010   0.306299 (  0.306505)
+(eq id (agg (always) (max id)))                                0.399487   0.002987   0.402474 (  0.402837)
+(join "c<=cost,b<=bar" (eq id (agg (always) (max id))))        4.501088   0.016998   4.518086 (  4.519644)
+delete!                                                        0.117293   0.000007   0.117300 (  0.117330)
+Taped.append() x50000                                          0.028056   0.001978   0.030034 (  0.030038)
+Taped.each() x125                                              1.332449   0.002015   1.334464 (  1.334506)
+Taped.delete_if() x375                                         0.820585   0.000000   0.820585 (  0.820626)
+```
 
 The results were calculated in [this GHA job][benchmark-gha]
-on 2025-02-24 at 13:32,
+on 2025-02-28 at 09:13,
 on Linux with 4 CPUs.
 <!-- benchmark_end -->
 
-[benchmark-gha]: https://github.com/yegor256/factbase/actions/runs/13499241189
+[benchmark-gha]: https://github.com/yegor256/factbase/actions/runs/13584960859

data/REUSE.toml

@@ -4,13 +4,17 @@
 version = 1
 [[annotations]]
 path = [
+    "**/*.csv",
     "**/*.jpg",
     "**/*.json",
     "**/*.md",
     "**/*.pdf",
     "**/*.png",
     "**/*.svg",
+    "**/*.txt",
+    "**/*.vm",
     "**/.gitignore",
+    "**/CNAME",
     ".gitattributes",
     ".gitignore",
     ".gitleaksignore",

data/Rakefile

@@ -15,7 +15,7 @@ def version
   Gem::Specification.load(Dir['*.gemspec'].first).version
 end
 
-task default: %i[clean test rubocop yard]
+task default: %i[clean test rubocop yard benchmark]
 
 require 'rake/testtask'
 desc 'Run all unit tests'
@@ -40,7 +40,14 @@ RuboCop::RakeTask.new(:rubocop) do |task|
   task.requires << 'rubocop-rspec'
 end
 
-desc 'Run benchmark script'
+desc 'Benchmark them all'
 task :benchmark do
-  ruby 'benchmarks/simple.rb'
+  fb = Factbase.new
+  require 'benchmark'
+  Benchmark.bm(60) do |b|
+    Dir['benchmark/bench_*.rb'].each do |f|
+      require_relative f
+      Kernel.send(File.basename(f).gsub(/\.rb$/, '').to_sym, b, fb)
+    end
+  end
 end

data/benchmark/bench_factbase.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require_relative '../lib/factbase'
+
+def bench_factbase(bmk, fb)
+  total = 50_000
+  bmk.report("insert #{total} facts") do
+    total.times do
+      fact = fb.insert
+      fact.foo = rand(0.0..100.0).round(3)
+      fact.bar = rand(100..300)
+    end
+  end
+
+  bin = nil
+  bmk.report("export #{total} facts") do
+    bin = fb.export
+  end
+  bmk.report("import #{bin.size} bytes (#{total} facts)") do
+    fb2 = Factbase.new
+    fb2.import(bin)
+  end
+
+  actions = 10
+  bmk.report("insert #{actions} facts") do
+    fb.txn do |fbt|
+      actions.times do
+        fbt.insert.z = rand(0..100)
+      end
+    end
+  end
+  bmk.report("query #{actions} times") do
+    fb.txn do |fbt|
+      actions.times do |i|
+        fbt.query("(gt foo #{i})").each.to_a
+      end
+    end
+  end
+  bmk.report("modify #{actions} attrs") do
+    fb.txn do |fbt|
+      actions.times do |i|
+        fbt.query("(gt foo #{i})").each.to_a.first.bar = 55
+      end
+    end
+  end
+  bmk.report("delete #{actions} facts") do
+    fb.txn do |fbt|
+      actions.times do |i|
+        fbt.query("(gt foo #{100 - i})").delete!
+      end
+    end
+  end
+end

data/benchmark/bench_query.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require_relative '../lib/factbase'
+
+def bench_query(bmk, fb)
+  total = 5_000
+  total.times do |i|
+    f = fb.insert
+    f.id = i
+    f.title = "Object Thinking #{i}"
+    f.time = Time.now.iso8601
+    f.cost = rand(1..100)
+    f.foo = rand(0.0..100.0).round(3)
+    f.bar = rand(100..300)
+    f.seenBy = "User#{i}" if i.even?
+    f.zzz = "Extra#{i}" if (i % 10).zero?
+  end
+
+  runs = 10
+  [
+    '(gt time \'2024-03-23T03:21:43Z\')',
+    '(gt cost 50)',
+    '(eq title \'Object Thinking 5000\')',
+    '(and (eq foo 42.998) (or (gt bar 200) (absent zzz)))',
+    '(eq id (agg (always) (max id)))',
+    '(join "c<=cost,b<=bar" (eq id (agg (always) (max id))))'
+  ].each do |q|
+    bmk.report(q) do
+      runs.times do
+        fb.query(q).each.to_a
+      end
+    end
+  end
+
+  bmk.report('delete!') do
+    fb.query('(gt foo 50)').delete!
+  end
+end

data/benchmark/bench_taped.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require_relative '../lib/factbase'
+require_relative '../lib/factbase/taped'
+
+def bench_taped(bmk, _fb)
+  maps = []
+  taped = Factbase::Taped.new(maps)
+
+  cycles = 50_000
+  bmk.report("Taped.append() x#{cycles}") do
+    cycles.times do
+      taped << { foo: rand(0..100) }
+    end
+  end
+
+  cycles /= 400
+  bmk.report("Taped.each() x#{cycles}") do
+    cycles.times do
+      taped.each.to_a
+    end
+  end
+
+  cycles *= 3
+  bmk.report("Taped.delete_if() x#{cycles}") do
+    cycles.times do
+      taped.delete_if { |m| m[:foo] < 50 }
+    end
+  end
+end

data/lib/factbase/logged.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require 'decoor'
+require 'others'
+require 'time'
+require 'loog'
+require 'tago'
+require_relative 'syntax'
+
+# A decorator of a Factbase, that logs all operations.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
+# License:: MIT
+class Factbase::Logged
+  def initialize(fb, loog)
+    raise 'The "fb" is nil' if fb.nil?
+    @fb = fb
+    raise 'The "loog" is nil' if loog.nil?
+    @loog = loog
+  end
+
+  decoor(:fb)
+
+  def insert
+    start = Time.now
+    f = @fb.insert
+    @loog.debug("Inserted new fact ##{@fb.size} in #{start.ago}")
+    Fact.new(f, @loog)
+  end
+
+  def query(query)
+    Query.new(@fb, query, @loog)
+  end
+
+  def txn
+    start = Time.now
+    id = nil
+    rollback = false
+    r =
+      @fb.txn do |fbt|
+        id = fbt.object_id
+        yield Factbase::Logged.new(fbt, @loog)
+      rescue Factbase::Rollback => e
+        rollback = true
+        raise e
+      end
+    if rollback
+      @loog.debug("Txn ##{id} rolled back in #{start.ago}")
+    else
+      @loog.debug("Txn ##{id} touched #{r} in #{start.ago}")
+    end
+    r
+  end
+
+  # Fact decorator.
+  #
+  # This is an internal class, it is not supposed to be instantiated directly.
+  #
+  class Fact
+    MAX_LENGTH = 64
+
+    def initialize(fact, loog)
+      @fact = fact
+      @loog = loog
+    end
+
+    def to_s
+      @fact.to_s
+    end
+
+    def all_properties
+      @fact.all_properties
+    end
+
+    others do |*args|
+      r = @fact.method_missing(*args)
+      k = args[0].to_s
+      v = args[1]
+      s = v.is_a?(Time) ? v.utc.iso8601 : v.to_s
+      s = v.to_s.inspect if v.is_a?(String)
+      s = "#{s[0..MAX_LENGTH / 2]}...#{s[-MAX_LENGTH / 2..]}" if s.length > MAX_LENGTH
+      @loog.debug("Set '#{k[0..-2]}' to #{s} (#{v.class})") if k.end_with?('=')
+      r
+    end
+  end
+
+  # Query decorator.
+  #
+  # This is an internal class, it is not supposed to be instantiated directly.
+  #
+  class Query
+    def initialize(fb, expr, loog)
+      @fb = fb
+      @expr = expr
+      @loog = loog
+    end
+
+    def one(params = {})
+      q = Factbase::Syntax.new(@fb, @expr).to_term.to_s
+      r = nil
+      tail =
+        Factbase::Logged.elapsed do
+          r = @fb.query(@expr).one(params)
+        end
+      if r.nil?
+        @loog.debug("Nothing found by '#{q}' #{tail}")
+      else
+        @loog.debug("Found #{r} (#{r.class}) by '#{q}' #{tail}")
+      end
+      r
+    end
+
+    def each(params = {}, &)
+      q = Factbase::Syntax.new(@fb, @expr).to_term.to_s
+      if block_given?
+        r = nil
+        tail =
+          Factbase::Logged.elapsed do
+            r = @fb.query(@expr).each(params, &)
+          end
+        raise ".each of #{@expr.class} returned #{r.class}" unless r.is_a?(Integer)
+        if r.zero?
+          @loog.debug("Nothing found by '#{q}' #{tail}")
+        else
+          @loog.debug("Found #{r} fact(s) by '#{q}' #{tail}")
+        end
+        r
+      else
+        array = []
+        tail =
+          Factbase::Logged.elapsed do
+            @fb.query(@expr).each(params) do |f|
+              array << f
+            end
+          end
+        if array.empty?
+          @loog.debug("Nothing found by '#{q}' #{tail}")
+        else
+          @loog.debug("Found #{array.size} fact(s) by '#{q}' #{tail}")
+        end
+        array
+      end
+    end
+
+    def delete!
+      r = nil
+      before = @fb.size
+      tail =
+        Factbase::Logged.elapsed do
+          r = @fb.query(@expr).delete!
+        end
+      raise ".delete! of #{@expr.class} returned #{r.class}" unless r.is_a?(Integer)
+      if before.zero?
+        @loog.debug("There were no facts, nothing deleted by '#{@expr}' #{tail}")
+      elsif r.zero?
+        @loog.debug("No facts out of #{before} deleted by '#{@expr}' #{tail}")
+      else
+        @loog.debug("Deleted #{r} fact(s) out of #{before} by '#{@expr}' #{tail}")
+      end
+      r
+    end
+  end
+
+  def self.elapsed
+    start = Time.now
+    yield
+    "in #{start.ago}"
+  end
+end

data/lib/factbase/looged.rb

@@ -121,7 +121,7 @@ class Factbase::Looged
           Factbase::Looged.elapsed do
             r = @fb.query(@expr).each(params, &)
           end
-        raise ".each of #{@query.class} returned #{r.class}" unless r.is_a?(Integer)
+        raise ".each of #{@expr.class} returned #{r.class}" unless r.is_a?(Integer)
         if r.zero?
           @loog.debug("Nothing found by '#{q}' #{tail}")
         else

data/lib/factbase/taped.rb

@@ -12,20 +12,27 @@ require_relative '../factbase'
 # Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
 # License:: MIT
 class Factbase::Taped
-  attr_reader :inserted, :deleted, :added
-
-  def initialize(origin, lookup: {})
+  def initialize(origin)
     @origin = origin
-    @inserted = Set.new
-    @deleted = Set.new
-    @added = Set.new
-    @lookup = lookup
+    @inserted = []
+    @deleted = []
+    @added = []
+  end
+
+  def inserted
+    @inserted.uniq
+  end
+
+  def deleted
+    @deleted.uniq
+  end
+
+  def added
+    @added.uniq
   end
 
   def find_by_object_id(oid)
-    o = @lookup[oid]
-    o = @origin.find { |m| m.object_id == oid } if o.nil?
-    o
+    @origin.find { |m| m.object_id == oid }
   end
 
   def size
@@ -34,17 +41,12 @@ class Factbase::Taped
 
   def <<(map)
     @origin << (map)
-    # rubocop:disable Lint/HashCompareByIdentity
-    @lookup[map.object_id] = map
-    # rubocop:enable Lint/HashCompareByIdentity
-    @inserted.add(map.object_id)
+    @inserted.append(map.object_id)
   end
 
   def each
+    return to_enum(__method__) unless block_given?
     @origin.each do |m|
-      # rubocop:disable Lint/HashCompareByIdentity
-      @lookup[m.object_id] = m
-      # rubocop:enable Lint/HashCompareByIdentity
       yield TapedHash.new(m, @added)
     end
   end
@@ -52,10 +54,7 @@ class Factbase::Taped
   def delete_if
     @origin.delete_if do |m|
       r = yield m
-      if r
-        @lookup.delete(m.object_id)
-        @deleted.add(m.object_id)
-      end
+      @deleted.append(m.object_id) if r
       r
     end
   end
@@ -75,7 +74,7 @@ class Factbase::Taped
 
     def []=(key, value)
       @origin[key] = value
-      @added.add(@origin.object_id)
+      @added.append(@origin.object_id)
     end
   end
 
@@ -104,12 +103,12 @@ class Factbase::Taped
     end
 
     def <<(item)
-      @added.add(@oid)
+      @added.append(@oid)
       @origin << (item)
     end
 
     def uniq!
-      @added.add(@oid)
+      @added.append(@oid)
       @origin.uniq!
     end
   end