factbase 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cddb3957ecbb2cce6a0957e00759aa8c54edc2b6ce1dae45509968cf22894c7a
-  data.tar.gz: 880d4fdde6788b80ee1db1a94fdfeed15d98b8fe7a0d8c3c4c0b6611a5cfdf79
+  metadata.gz: 474551d14c160969e1361d2518458de199c6777865aedf1a34f5a4de00f22542
+  data.tar.gz: ae437f74a4422631c9f3fa3c4a1752b42eadbef4c0c3a2339829d3417a928441
 SHA512:
-  metadata.gz: ddd8fce247c59e80ab719451fca226e0598459557cdd33cbcaf21fd8e12b6ae23b82e3cf3173d638414ad2654a6e3a40d6cc586a1d8804df9111a68474e87489
-  data.tar.gz: 3ef80c4d7e05cc7daa9f8a4e9c38a47c7555693416ab521b2ef589b9abab6ba592e7484171b92df96e77333eae8f36bb85a19e4c9fb63cc2ae06cd3e7d4e2b72
+  metadata.gz: cc63686b69eb970b104a748be486d3e254f8ac919b9e171e801c77e6a02645c3e8daac33ea5807d3f37fe1d1e7f9d7744326f44155ad36d18cf1f498ade75cff
+  data.tar.gz: 7c5d8f8aa98f68fa5a96d6f387cfe892fd43026ad2c51c418b0dccda72f3cdebac2ca24e9c1b9a3d205576c96888bb7ca03adab925c6533abc18de5e51769424

data/.github/workflows/benchmark.yml

@@ -28,7 +28,7 @@ jobs:
           set -x
           sum=$(
             echo '```text'
-            cat stdout.txt
+            cat stdout.txt | cut -c -71
             echo '```'
             echo
             echo "The results were calculated in [this GHA job][benchmark-gha]"
@@ -43,6 +43,7 @@ jobs:
           rm stdout.txt
       - uses: peter-evans/create-pull-request@v7
         with:
+          sign-commits: true
           branch: benchmark-results
           commit-message: 'new benchmarking results'
           delete-branch: true

data/.github/workflows/copyrights.yml

@@ -16,4 +16,4 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
-      - uses: yegor256/copyrights-action@0.0.8
+      - uses: yegor256/copyrights-action@0.0.12

data/.github/workflows/markdown-lint.yml

@@ -20,4 +20,4 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
-      - uses: articulate/actions-markdownlint@v1
+      - uses: DavidAnson/markdownlint-cli2-action@v20.0.0

data/.github/workflows/typos.yml

@@ -0,0 +1,19 @@
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+---
+# yamllint disable rule:line-length
+name: typos
+'on':
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  typos:
+    timeout-minutes: 15
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: crate-ci/typos@v1.33.1

data/.gitignore

@@ -1,10 +1,11 @@
-*.gem
-.DS_Store
 .bundle/
+.DS_Store
 .idea/
 .yardoc/
+*.gem
 coverage/
 doc/
 node_modules/
 rdoc/
 vendor/
+.claude/

data/.rubocop.yml

@@ -46,3 +46,4 @@ Security/MarshalLoad:
   Enabled: false
 Layout/MultilineAssignmentLayout:
   Enabled: true
+require: []

data/Gemfile.lock

@@ -26,11 +26,13 @@ GEM
     elapsed (0.0.1)
       loog (> 0)
       tago (> 0)
-    json (2.11.3)
-    language_server-protocol (3.17.0.4)
+    erb (5.0.1)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
-    loog (0.6.0)
+    loog (0.6.1)
+      logger (~> 1.0)
     minitest (5.25.5)
     minitest-reporters (1.7.1)
       ansi
@@ -52,22 +54,23 @@ GEM
       ast (~> 2.4.1)
       racc
     prism (1.4.0)
-    psych (5.2.3)
+    psych (5.2.6)
       date
       stringio
-    qbash (0.4.0)
+    qbash (0.4.5)
       backtrace (> 0)
       elapsed (> 0)
       loog (> 0)
       tago (> 0)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.2.1)
-    rdoc (6.13.1)
+    rake (13.3.0)
+    rdoc (6.14.0)
+      erb
       psych (>= 4.0.0)
     regexp_parser (2.10.0)
     rexml (3.4.1)
-    rubocop (1.75.4)
+    rubocop (1.75.8)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -81,7 +84,7 @@ GEM
     rubocop-ast (1.44.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
-    rubocop-minitest (0.38.0)
+    rubocop-minitest (0.38.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.75.0, < 2.0)
       rubocop-ast (>= 1.38.0, < 2.0)

data/README.md

@@ -209,34 +209,34 @@ This is the result of the benchmark:
 
 <!-- benchmark_begin -->
 ```text
-                                                                   user     system      total        real
-insert 20000 facts                                             0.584619   0.003744   0.588363 (  0.588372)
-export 20000 facts                                             0.019872   0.004992   0.024864 (  0.024870)
-import 411135 bytes (20000 facts)                              0.030978   0.004000   0.034978 (  0.034983)
-insert 10 facts                                                0.043662   0.002056   0.045718 (  0.045738)
-query 10 times w/txn                                           1.809973   0.034886   1.844859 (  1.845456)
-query 10 times w/o txn                                         0.039074   0.004004   0.043078 (  0.043081)
-modify 10 attrs w/txn                                          1.705921   0.015961   1.721882 (  1.722316)
-delete 10 facts w/txn                                          1.021624   0.007014   1.028638 (  1.028692)
-(and (eq what 'issue-was-closed') (exists... -> 200            2.110981   0.005000   2.115981 (  2.116099)
-(and (eq what 'issue-was-closed') (exists... -> 200/txn        1.125909   0.000000   1.125909 (  1.125962)
-(and (eq what 'issue-was-closed') (exists... -> zero           2.417743   0.000993   2.418736 (  2.418869)
-(and (eq what 'issue-was-closed') (exists... -> zero/txn       1.282409   0.003006   1.285415 (  1.285498)
-(gt time '2024-03-23T03:21:43Z')                               0.092167   0.000000   0.092167 (  0.092169)
-(gt cost 50)                                                   0.107435   0.000000   0.107435 (  0.107438)
-(eq title 'Object Thinking 5000')                              0.002544   0.000000   0.002544 (  0.002546)
-(and (eq foo 42.998) (or (gt bar 200) (absent zzz)))           0.022142   0.000000   0.022142 (  0.022143)
-(eq id (agg (always) (max id)))                                0.244818   0.000000   0.244818 (  0.244835)
-(join "c<=cost,b<=bar" (eq id (agg (always) (max id))))        0.672133   0.001998   0.674131 (  0.674186)
-delete!                                                        0.074661   0.000000   0.074661 (  0.074663)
-Taped.append() x50000                                          0.037757   0.004997   0.042754 (  0.042759)
-Taped.each() x125                                              1.283630   0.001995   1.285625 (  1.285706)
-Taped.delete_if() x375                                         0.819901   0.000000   0.819901 (  0.819968)
+                                                                   user
+insert 20000 facts                                             0.606861
+export 20000 facts                                             0.029288
+import 410768 bytes (20000 facts)                              0.029856
+insert 10 facts                                                0.042954
+query 10 times w/txn                                           1.951537
+query 10 times w/o txn                                         0.038436
+modify 10 attrs w/txn                                          1.815854
+delete 10 facts w/txn                                          1.023006
+(and (eq what 'issue-was-closed') (exists... -> 200            2.130857
+(and (eq what 'issue-was-closed') (exists... -> 200/txn        1.146039
+(and (eq what 'issue-was-closed') (exists... -> zero           2.424541
+(and (eq what 'issue-was-closed') (exists... -> zero/txn       1.297135
+(gt time '2024-03-23T03:21:43Z')                               0.109071
+(gt cost 50)                                                   0.092356
+(eq title 'Object Thinking 5000')                              0.002707
+(and (eq foo 42.998) (or (gt bar 200) (absent zzz)))           0.024449
+(eq id (agg (always) (max id)))                                0.257526
+(join "c<=cost,b<=bar" (eq id (agg (always) (max id))))        0.650843
+delete!                                                        0.075867
+Taped.append() x50000                                          0.038991
+Taped.each() x125                                              1.321896
+Taped.delete_if() x375                                         0.830375
 ```
 
 The results were calculated in [this GHA job][benchmark-gha]
-on 2025-04-07 at 10:33,
+on 2025-06-03 at 09:54,
 on Linux with 4 CPUs.
 <!-- benchmark_end -->
 
-[benchmark-gha]: https://github.com/yegor256/factbase/actions/runs/14306969571
+[benchmark-gha]: https://github.com/yegor256/factbase/actions/runs/15414210508

data/REUSE.toml

@@ -4,9 +4,17 @@
 version = 1
 [[annotations]]
 path = [
+    ".DS_Store",
+    ".gitattributes",
+    ".gitignore",
+    ".pdd",
     "**.json",
     "**.md",
+    "**.png",
     "**.txt",
+    "**/.DS_Store",
+    "**/.gitignore",
+    "**/.pdd",
     "**/*.csv",
     "**/*.jpg",
     "**/*.json",
@@ -16,15 +24,8 @@ path = [
     "**/*.svg",
     "**/*.txt",
     "**/*.vm",
-    "**/.DS_Store",
-    "**/.gitignore",
-    "**/.pdd",
     "**/CNAME",
     "**/Gemfile.lock",
-    ".DS_Store",
-    ".gitattributes",
-    ".gitignore",
-    ".pdd",
     "Gemfile.lock",
     "README.md",
     "renovate.json",

data/lib/factbase/cached/cached_fact.rb

@@ -20,6 +20,10 @@ class Factbase::CachedFact
     @cache = cache
   end
 
+  def to_s
+    @origin.to_s
+  end
+
   # When a method is missing, this method is called.
   others do |*args|
     @cache.clear if args[0].to_s.end_with?('=')

data/lib/factbase/cached/cached_factbase.rb

@@ -22,9 +22,9 @@ class Factbase::CachedFactbase
   # @param [Factbase] origin Original factbase to decorate
   # @param [Hash] cache Cache to use
   def initialize(origin, cache = {})
-    raise 'Wront type of original' unless origin.respond_to?(:query)
+    raise 'Wrong type of original' unless origin.respond_to?(:query)
     @origin = origin
-    raise 'Wront type of cache' unless cache.is_a?(Hash)
+    raise 'Wrong type of cache' unless cache.is_a?(Hash)
     @cache = cache
   end
 

data/lib/factbase/fact_as_yaml.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require 'yaml'
+require_relative '../factbase'
+
+# Single fact to YAML converter.
+#
+# This class helps converting a single fact to YAML format, for example:
+#
+#  require 'factbase/fact_as_yaml'
+#  fb = Factbase.new
+#  f = fb.query('(eq foo 42)').to_a.first
+#  puts Factbase::FactAsYaml.new(f).to_s
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
+# License:: MIT
+class Factbase::FactAsYaml
+  # Constructor.
+  def initialize(fact)
+    @fact = fact
+  end
+
+  # Convert the fact to YAML.
+  # @return [String] The fact in YAML format
+  def to_s
+    props = @fact.all_properties
+    hash = {}
+    props.each do |p|
+      v = @fact[p]
+      hash[p] = v.is_a?(Array) ? v : [v]
+    end
+    hash.sort.to_h.to_yaml
+  end
+end

data/lib/factbase/indexed/indexed_fact.rb

@@ -20,6 +20,10 @@ class Factbase::IndexedFact
     @idx = idx
   end
 
+  def to_s
+    @origin.to_s
+  end
+
   # When a method is missing, this method is called.
   others do |*args|
     @idx.clear if args[0].to_s.end_with?('=')

data/lib/factbase/indexed/indexed_factbase.rb

@@ -22,9 +22,9 @@ class Factbase::IndexedFactbase
   # @param [Factbase] origin Original factbase to decorate
   # @param [Hash] idx Index to use
   def initialize(origin, idx = {})
-    raise 'Wront type of original' unless origin.respond_to?(:query)
+    raise 'Wrong type of original' unless origin.respond_to?(:query)
     @origin = origin
-    raise 'Wront type of index' unless idx.is_a?(Hash)
+    raise 'Wrong type of index' unless idx.is_a?(Hash)
     @idx = idx
   end
 

data/lib/factbase.rb

@@ -82,7 +82,7 @@ require 'yaml'
 # License:: MIT
 class Factbase
   # Current version of the gem (changed by .rultor.yml on every release)
-  VERSION = '0.10.1' unless const_defined?(:VERSION)
+  VERSION = '0.11.0' unless const_defined?(:VERSION)
 
   # An exception that may be thrown in a transaction, to roll it back.
   class Rollback < StandardError; end

data/test/factbase/cached/test_cached_factbase.rb

@@ -32,4 +32,13 @@ class TestCachedFactbase < Factbase::Test
     refute_empty(origin.query('(exists bar)').each.to_a)
     refute_empty(fb.query('(exists bar)').each.to_a)
   end
+
+  def test_prints_fact_correctly
+    fb = Factbase::CachedFactbase.new(Factbase.new)
+    f1 = fb.insert
+    f1.foo = 42
+    assert_equal('[ foo: [42] ]', f1.to_s)
+    f2 = fb.query('(always)').each.to_a.first
+    assert_equal('[ foo: [42] ] + {}', f2.to_s)
+  end
 end

data/test/factbase/test_fact_as_yaml.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require 'yaml'
+require_relative '../../lib/factbase'
+require_relative '../../lib/factbase/fact_as_yaml'
+require_relative '../test__helper'
+
+# Test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
+# License:: MIT
+class TestFactAsYaml < Factbase::Test
+  def test_simple_rendering
+    fb = Factbase.new
+    f = fb.insert
+    f._id = 1
+    f.foo = 42
+    f.bar = 'hello'
+    yaml_str = Factbase::FactAsYaml.new(f).to_s
+    yaml = YAML.load(yaml_str)
+    assert_equal(1, yaml['_id'][0])
+    assert_equal('hello', yaml['bar'][0])
+    assert_equal(42, yaml['foo'][0])
+  end
+
+  def test_multiple_values
+    fb = Factbase.new
+    f = fb.insert
+    f.foo = 42
+    f.foo = 256
+    f.foo = 512
+    yaml_str = Factbase::FactAsYaml.new(f).to_s
+    yaml = YAML.load(yaml_str)
+    assert_equal([42, 256, 512], yaml['foo'])
+  end
+
+  def test_sorted_keys
+    fb = Factbase.new
+    f = fb.insert
+    f.c = 3
+    f.a = 1
+    f.b = 2
+    yaml_str = Factbase::FactAsYaml.new(f).to_s
+    assert_operator(yaml_str.index('a:'), :<, yaml_str.index('b:'))
+    assert_operator(yaml_str.index('b:'), :<, yaml_str.index('c:'))
+  end
+
+  def test_usage_example_from_issue
+    fb = Factbase.new
+    f = fb.insert
+    f._id = 1
+    f.name = 'test'
+    f = fb.query('(eq _id 1)').each.to_a.first
+    yaml_str = Factbase::FactAsYaml.new(f).to_s
+    assert(yaml_str)
+    assert_includes(yaml_str, '_id')
+    assert_includes(yaml_str, 'name')
+  end
+end

data/test/factbase/test_query.rb

@@ -197,7 +197,7 @@ class TestQuery < Factbase::Test
     end
   end
 
-  def test_finds_with_subsitution
+  def test_finds_with_substitution
     maps = [{ 'foo' => [42] }, { 'bar' => [7] }, { 'foo' => [666] }]
     with_factbases(maps) do |badge, fb|
       assert_equal(0, fb.query('(eq 2 (agg (eq foo $foo) (count)))').each.to_a.size, "with #{badge}")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: factbase
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -157,6 +157,7 @@ files:
 - ".github/workflows/pdd.yml"
 - ".github/workflows/rake.yml"
 - ".github/workflows/reuse.yml"
+- ".github/workflows/typos.yml"
 - ".github/workflows/xcop.yml"
 - ".github/workflows/yamllint.yml"
 - ".gitignore"
@@ -200,6 +201,7 @@ files:
 - lib/factbase/cached/cached_term.rb
 - lib/factbase/churn.rb
 - lib/factbase/fact.rb
+- lib/factbase/fact_as_yaml.rb
 - lib/factbase/flatten.rb
 - lib/factbase/indexed/indexed_fact.rb
 - lib/factbase/indexed/indexed_factbase.rb
@@ -255,6 +257,7 @@ files:
 - test/factbase/test_accum.rb
 - test/factbase/test_churn.rb
 - test/factbase/test_fact.rb
+- test/factbase/test_fact_as_yaml.rb
 - test/factbase/test_flatten.rb
 - test/factbase/test_inv.rb
 - test/factbase/test_logged.rb