factbase 0.12.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ba24c42ea5df6fab3bfcf4477eff165173de5eb224c80e8bd1b1eeda5a9036d
-  data.tar.gz: b0f9362eec0b148f451dcbc94012db27ac97a02e4c6fbe48e0303a33d5f46c9e
+  metadata.gz: e275580781c232bdbea9b569d456ff3955c4a1fe1add33101398d00acc9605e5
+  data.tar.gz: 5c3a6d0e61c81a8bc7a2cc0a3ca6f003a77ad0cd9fdae1d68e2ecb55d386b169
 SHA512:
-  metadata.gz: e6460f586f42569fac5f6dedd783ab68e47f1fc2e7e05932033003586b40339044005d383306fce26f3f56a375d7a33d3a2798d3b84356e76c09550c6375e3d9
-  data.tar.gz: c8067f91613d87093ebf824c4800298e2b2e25654fc4ad9b5c3fed4c26e8265e19968a8eac887e5b541de48e5ebc531df6925c4ad73c48b49b1cb80ba429e5b7
+  metadata.gz: 0d764be837fc143d2a39b7f58d40cc33f93a3fb37a8608cca74b514b41a1ecbfac64c5e4b5bde836fa414fb33ae6cd0c7b7668802a8431f6a6f3a428a3bd6f90
+  data.tar.gz: 4aa141144fb2b41a4b6a47b0ca2acde9b3c35d1c8bd487700e9fe0d88a19ea6eac0224dd0390969a3377856b0f84d1af3d54f6a870ce63300065f151e2e828f9

data/.github/workflows/typos.yml

@@ -16,4 +16,4 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
-      - uses: crate-ci/typos@v1.33.1
+      - uses: crate-ci/typos@v1.34.0

data/Gemfile

@@ -11,12 +11,12 @@ gem 'minitest-reporters', '~>1.7', require: false
 gem 'os', '~>1.1', require: false
 gem 'qbash', '~>0.4', require: false
 gem 'rake', '~>13.2', require: false
-gem 'rdoc', '~>6.13', require: false
+gem 'rdoc', '6.14.2', require: false # GPL
 gem 'rubocop', '~>1.74', require: false
 gem 'rubocop-minitest', '~>0.38', require: false
 gem 'rubocop-performance', '~>1.25', require: false
 gem 'rubocop-rake', '~>0.7', require: false
 gem 'simplecov', '~>0.22', require: false
-gem 'simplecov-cobertura', '~>2.1', require: false
+gem 'simplecov-cobertura', '~>3.0', require: false
 gem 'threads', '~>0.4', require: false
 gem 'yard', '~>0.9', require: false

data/Gemfile.lock

@@ -24,12 +24,12 @@ GEM
     date (3.4.1)
     decoor (0.1.0)
     docile (1.4.1)
-    elapsed (0.0.1)
+    elapsed (0.1.0)
       loog (> 0)
       tago (> 0)
     ellipsized (0.3.0)
-    erb (5.0.1)
-    json (2.12.2)
+    erb (5.0.2)
+    json (2.13.0)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
@@ -41,13 +41,13 @@ GEM
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    nokogiri (1.18.8-arm64-darwin)
+    nokogiri (1.18.9-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.8-x64-mingw-ucrt)
+    nokogiri (1.18.9-x64-mingw-ucrt)
       racc (~> 1.4)
-    nokogiri (1.18.8-x86_64-darwin)
+    nokogiri (1.18.9-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.8-x86_64-linux-gnu)
+    nokogiri (1.18.9-x86_64-linux-gnu)
       racc (~> 1.4)
     os (1.1.4)
     others (0.1.1)
@@ -67,12 +67,12 @@ GEM
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.3.0)
-    rdoc (6.14.1)
+    rdoc (6.14.2)
       erb
       psych (>= 4.0.0)
     regexp_parser (2.10.0)
     rexml (3.4.1)
-    rubocop (1.77.0)
+    rubocop (1.78.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -83,7 +83,7 @@ GEM
       rubocop-ast (>= 1.45.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.45.1)
+    rubocop-ast (1.46.0)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
     rubocop-minitest (0.38.1)
@@ -102,10 +102,10 @@ GEM
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-cobertura (2.1.0)
+    simplecov-cobertura (3.0.0)
       rexml
       simplecov (~> 0.19)
-    simplecov-html (0.13.1)
+    simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
     stringio (3.1.7)
     tago (0.1.0)
@@ -134,13 +134,13 @@ DEPENDENCIES
   os (~> 1.1)
   qbash (~> 0.4)
   rake (~> 13.2)
-  rdoc (~> 6.13)
+  rdoc (= 6.14.2)
   rubocop (~> 1.74)
   rubocop-minitest (~> 0.38)
   rubocop-performance (~> 1.25)
   rubocop-rake (~> 0.7)
   simplecov (~> 0.22)
-  simplecov-cobertura (~> 2.1)
+  simplecov-cobertura (~> 3.0)
   threads (~> 0.4)
   yard (~> 0.9)
 

data/lib/factbase/impatient.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require 'decoor'
+require 'timeout'
+require_relative 'syntax'
+
+# A decorator of a Factbase, that terminates long-running queries.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
+# License:: MIT
+class Factbase::Impatient
+  # Ctor.
+  # @param [Factbase] fb The factbase to decorate
+  # @param [Integer] timeout Timeout in seconds
+  def initialize(fb, timeout: 15)
+    raise 'The "fb" is nil' if fb.nil?
+    @origin = fb
+    @timeout = timeout
+  end
+
+  decoor(:origin)
+
+  def insert
+    @origin.insert
+  end
+
+  def query(term, maps = nil)
+    term = to_term(term) if term.is_a?(String)
+    Query.new(term, maps, @timeout, @origin)
+  end
+
+  def txn
+    @origin.txn do |fbt|
+      yield Factbase::Impatient.new(fbt, timeout: @timeout)
+    end
+  end
+
+  # Query decorator.
+  #
+  # This is an internal class, it is not supposed to be instantiated directly.
+  class Query
+    def initialize(term, maps, timeout, fb)
+      @term = term
+      @maps = maps
+      @timeout = timeout
+      @fb = fb
+    end
+
+    def to_s
+      @term.to_s
+    end
+
+    def each(fb = @fb, params = {}, &)
+      return to_enum(__method__, fb, params) unless block_given?
+      qry = @fb.query(@term, @maps)
+      Timeout.timeout(@timeout) do
+        qry.each(fb, params, &)
+      end
+    rescue Timeout::Error => e
+      raise "Query timed out after #{@timeout} seconds: #{e.message}"
+    end
+
+    def one(fb = @fb, params = {})
+      qry = @fb.query(@term, @maps)
+      Timeout.timeout(@timeout) do
+        qry.one(fb, params)
+      end
+    rescue Timeout::Error => e
+      raise "Query timed out after #{@timeout} seconds: #{e.message}"
+    end
+
+    def delete!(fb = @fb)
+      qry = @fb.query(@term, @maps)
+      Timeout.timeout(@timeout) do
+        qry.delete!(fb)
+      end
+    rescue Timeout::Error => e
+      raise "Query timed out after #{@timeout} seconds: #{e.message}"
+    end
+  end
+end

data/lib/factbase/version.rb

@@ -9,5 +9,5 @@
 # License:: MIT
 class Factbase
   # Current version of the gem (changed by .rultor.yml on every release)
-  VERSION = '0.12.1' unless const_defined?(:VERSION)
+  VERSION = '0.14.0' unless const_defined?(:VERSION)
 end

data/lib/factbase.rb

@@ -177,7 +177,12 @@ class Factbase
     taped = Factbase::Taped.new(before)
     catch :commit do
       require_relative 'factbase/light'
-      yield Factbase::Light.new(Factbase.new(taped))
+      commit = false
+      catch :rollback do
+        yield Factbase::Light.new(Factbase.new(taped))
+        commit = true
+      end
+      return 0 unless commit
     rescue Factbase::Rollback
       return 0
     end

data/test/factbase/test_impatient.rb

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require_relative '../test__helper'
+require_relative '../../lib/factbase'
+require_relative '../../lib/factbase/query'
+require_relative '../../lib/factbase/impatient'
+
+# Test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
+# License:: MIT
+class TestImpatient < Factbase::Test
+  class SlowFactbase < Factbase
+    class SlowQuery < Factbase::Query
+      def one(fb = @fb, params = {})
+        sleep 0.2
+        super
+      end
+    end
+
+    def query(term, maps = nil)
+      maps ||= @maps
+      term = to_term(term) if term.is_a?(String)
+      SlowQuery.new(maps, term, self)
+    end
+  end
+
+  class SlowDeleteFactbase < Factbase
+    class SlowQuery < Factbase::Query
+      def delete!(fb = @fb)
+        sleep 0.2
+        super
+      end
+    end
+
+    def query(term, maps = nil)
+      maps ||= @maps
+      term = to_term(term) if term.is_a?(String)
+      SlowQuery.new(maps, term, self)
+    end
+  end
+
+  class SlowEnoughFactbase < Factbase
+    class SlowQuery < Factbase::Query
+      def one(fb = @fb, params = {})
+        sleep 1.5
+        super
+      end
+    end
+
+    def query(term, maps = nil)
+      maps ||= @maps
+      term = to_term(term) if term.is_a?(String)
+      SlowQuery.new(maps, term, self)
+    end
+  end
+
+  def test_simple_query
+    fb = Factbase::Impatient.new(Factbase.new)
+    fb.insert
+    fb.insert.bar = 3
+    found = 0
+    fb.query('(exists bar)').each do |f|
+      assert_predicate(f.bar, :positive?)
+      f.foo = 42
+      assert_equal(42, f.foo)
+      found += 1
+    end
+    assert_equal(1, found)
+    assert_equal(2, fb.size)
+  end
+
+  def test_query_one
+    fb = Factbase::Impatient.new(Factbase.new)
+    fb.insert
+    fb.insert.bar = 42
+    assert_equal(1, fb.query('(agg (exists bar) (count))').one)
+    assert_equal([42], fb.query('(agg (exists bar) (first bar))').one)
+  end
+
+  def test_query_timeout
+    fb = Factbase::Impatient.new(Factbase.new, timeout: 0.1)
+    1000.times do
+      fb.insert.value = rand(1000)
+    end
+    ex =
+      assert_raises(StandardError) do
+        fb.query('(always)').each do
+          sleep 0.2
+        end
+      end
+    assert_includes(ex.message, 'Query timed out after 0.1 seconds')
+  end
+
+  def test_query_one_timeout
+    slow_fb = SlowFactbase.new
+    1000.times do
+      slow_fb.insert.value = rand(1000)
+    end
+    fb = Factbase::Impatient.new(slow_fb, timeout: 0.1)
+    ex =
+      assert_raises(StandardError) do
+        fb.query('(always)').one
+      end
+    assert_includes(ex.message, 'Query timed out after 0.1 seconds')
+  end
+
+  def test_delete_timeout
+    slow_fb = SlowDeleteFactbase.new
+    1000.times do |i|
+      slow_fb.insert.value = i
+    end
+    fb = Factbase::Impatient.new(slow_fb, timeout: 0.1)
+    ex =
+      assert_raises(StandardError) do
+        fb.query('(gt value 500)').delete!
+      end
+    assert_includes(ex.message, 'Query timed out after 0.1 seconds')
+  end
+
+  def test_with_txn
+    fb = Factbase::Impatient.new(Factbase.new)
+    assert(
+      fb.txn do |fbt|
+        fbt.insert.foo = 42
+      end
+    )
+    assert_equal(1, fb.size)
+  end
+
+  def test_with_txn_timeout
+    fb = Factbase::Impatient.new(Factbase.new, timeout: 0.1)
+    fb.txn do |fbt|
+      fbt.insert.slow = 42
+      ex =
+        assert_raises(StandardError) do
+          fbt.query('(always)').each do
+            sleep 0.2
+          end
+        end
+      assert_includes(ex.message, 'Query timed out after 0.1 seconds')
+    end
+  end
+
+  def test_returns_int
+    fb = Factbase.new
+    fb.insert
+    fb.insert
+    assert_equal(2, Factbase::Impatient.new(fb).query('(always)').each(&:to_s))
+  end
+
+  def test_returns_int_when_empty
+    fb = Factbase.new
+    assert_equal(0, Factbase::Impatient.new(fb).query('(always)').each(&:to_s))
+  end
+
+  def test_returns_to_s_correctly
+    fb = Factbase.new
+    q = '(always)'
+    assert_equal(q, fb.query(q).to_s)
+  end
+
+  def test_enumerator_support
+    fb = Factbase::Impatient.new(Factbase.new)
+    assert_equal(0, fb.query('(always)').each.to_a.size)
+    fb.insert
+    assert_equal(1, fb.query('(always)').each.to_a.size)
+  end
+
+  def test_query_completes_before_timeout
+    fb = Factbase::Impatient.new(Factbase.new, timeout: 1)
+    100.times do |i|
+      fb.insert.index = i
+    end
+    count = 0
+    fb.query('(always)').each do |f|
+      count += 1
+      assert_equal(count - 1, f.index)
+    end
+    assert_equal(100, count)
+  end
+
+  def test_custom_timeout
+    slow_fb = SlowEnoughFactbase.new
+    slow_fb.insert.value = 42
+    fb = Factbase::Impatient.new(slow_fb, timeout: 2)
+    start = Time.now
+    result = fb.query('(agg (eq value 42) (first value))').one
+    elapsed = Time.now - start
+    assert_operator(elapsed, :>=, 1.5)
+    assert_equal([42], result)
+  end
+
+  def test_nil_factbase_raises
+    ex =
+      assert_raises(StandardError) do
+        Factbase::Impatient.new(nil)
+      end
+    assert_equal('The "fb" is nil', ex.message)
+  end
+end

data/test/factbase/test_query.rb

@@ -10,6 +10,7 @@ require_relative '../../lib/factbase'
 require_relative '../../lib/factbase/query'
 require_relative '../../lib/factbase/logged'
 require_relative '../../lib/factbase/pre'
+require_relative '../../lib/factbase/impatient'
 require_relative '../../lib/factbase/inv'
 require_relative '../../lib/factbase/rules'
 require_relative '../../lib/factbase/tallied'
@@ -314,6 +315,7 @@ class TestQuery < Factbase::Test
   def with_factbases(maps = [], &)
     {
       'plain' => Factbase.new(maps),
+      'plain+impatient' => Factbase::Impatient.new(Factbase.new(maps)),
       'pre+plain' => Factbase::Pre.new(Factbase.new(maps)) { nil },
       'rules+plain' => Factbase::Rules.new(Factbase.new(maps), '(always)'),
       'inv+plain' => Factbase::Inv.new(Factbase.new(maps)) { nil },

data/test/test_factbase.rb

@@ -486,6 +486,15 @@ class TestFactbase < Factbase::Test
     assert_equal(1, fb.size)
   end
 
+  def test_rolls_back
+    fb = Factbase.new
+    fb.txn do |fbt|
+      fbt.insert.foo = 1
+      throw :rollback
+    end
+    assert_equal(0, fb.size)
+  end
+
   def test_get_raise_for_empty_fact
     fb = Factbase.new
     fb.txn do |fbt|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: factbase
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -218,6 +218,7 @@ files:
 - lib/factbase/fact.rb
 - lib/factbase/fact_as_yaml.rb
 - lib/factbase/flatten.rb
+- lib/factbase/impatient.rb
 - lib/factbase/indexed/indexed_fact.rb
 - lib/factbase/indexed/indexed_factbase.rb
 - lib/factbase/indexed/indexed_query.rb
@@ -275,6 +276,7 @@ files:
 - test/factbase/test_fact.rb
 - test/factbase/test_fact_as_yaml.rb
 - test/factbase/test_flatten.rb
+- test/factbase/test_impatient.rb
 - test/factbase/test_inv.rb
 - test/factbase/test_logged.rb
 - test/factbase/test_pre.rb