factbase 0.0.36 → 0.0.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c801d7ec256766a03b081de5949367aef74dc991b67207ae30c6e6229f11c425
-  data.tar.gz: 2cfc12996cc7e4d85fad86377ddc9b87916d5d2a1cbe5542ba8128488c1e0049
+  metadata.gz: a464f6fa40a3aef098e4ab4a58b6f6905ac101421f22fb806b63c4fb624aa610
+  data.tar.gz: ad19a0147890d8b4ff8fff96f7e9f47b09ecb264b3cb52fa606be892278fa380
 SHA512:
-  metadata.gz: 6d2d1ec011eaf2d34f00068fa71809bf8bd3fe794b6097eeb1292ad25f1a6916e319490a137fa4c1908c00ce640f19c8efff27444ca277e72048daf5e688c3ef
-  data.tar.gz: 7f20423de58a836eb68261a8d7ad45ec00056a4f991b8f34c68dd4833a42bbb0009bca75a4a8092112cfb80599e2be04e5cca9a9bfe18b3ae18102622d98f9a6
+  metadata.gz: 6abb74b759ef7eea421e8a7f4f1ebdbf7ae46836dfefcd324286508fbb82e207a787265c0cf9f8931b43b00d50e5df983266fa9442f9c277111dfa9ea3a778de
+  data.tar.gz: b0ed97f83f59230bafce810488f3e720d098a748149f7fbd58b7f1c25425b2fba6b742ce16b18692df34607eb3c42f9f11196ca212bc0273d7bdffe15e759efe

data/.github/workflows/rake.yml

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

data/Gemfile.lock

@@ -101,7 +101,7 @@ GEM
       zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.2.1)
-    rdoc (6.6.3.1)
+    rdoc (6.7.0)
       psych (>= 4.0.0)
     regexp_parser (2.9.2)
     reline (0.5.7)
@@ -171,7 +171,7 @@ GEM
     webrick (1.8.1)
     yaml (0.3.0)
     yard (0.9.36)
-    zeitwerk (2.6.14)
+    zeitwerk (2.6.15)
 
 PLATFORMS
   arm64-darwin-22

data/factbase.gemspec

@@ -25,17 +25,21 @@ require_relative 'lib/factbase'
 
 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.required_ruby_version = '>=3.0'
   s.name = 'factbase'
   s.version = Factbase::VERSION
   s.license = 'MIT'
   s.summary = 'Factbase'
-  s.description = 'Fact base in memory and on disc'
+  s.description =
+    'A primitive in-memory collection of key-value records ' \
+    'known as "facts," with an ability to insert facts, add properties ' \
+    'to facts, and delete facts. There is no ability to modify facts. ' \
+    'It is also possible to find facts using Lisp-alike query predicates. ' \
+    'An entire factbase may be exported to a binary file and imported back.'
   s.authors = ['Yegor Bugayenko']
   s.email = 'yegor256@gmail.com'
   s.homepage = 'http://github.com/yegor256/factbase.rb'
   s.files = `git ls-files`.split($RS)
-  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
   s.add_runtime_dependency 'json', '~> 2.7'

data/lib/factbase/fact.rb

@@ -28,10 +28,20 @@ require_relative '../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
+# 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)
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 class Factbase::Fact
+  # Ctor.
+  # @param [Mutex] mutex A mutex to use for maps synchronization
+  # @param [Hash] map A map of key/value pairs
   def initialize(mutex, map)
     @mutex = mutex
     @map = map

data/lib/factbase/syntax.rb

@@ -136,7 +136,7 @@ class Factbase::Syntax
       elsif t.match?(/^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$/)
         Time.parse(t)
       else
-        raise "Wrong symbol format (#{t})" unless t.match?(/^[a-z][a-zA-Z0-9_]*$/)
+        raise "Wrong symbol format (#{t})" unless t.match?(/^[_a-z][a-zA-Z0-9_]*$/)
         t.to_sym
       end
     end

data/lib/factbase/term.rb

@@ -27,6 +27,15 @@ require_relative 'fact'
 #
 # 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
+# term with two arguments:
+#
+#  require 'factbase/fact'
+#  require 'factbase/term'
+#  f = Factbase::Fact.new(Mutex.new, { 'foo' => [42, 256, 'Hello, world!'] })
+#  t = Factbase::Term.new(:lt, [:foo, 50])
+#  assert(t.evaluate(f))
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT

data/lib/factbase.rb

@@ -24,12 +24,32 @@ require 'json'
 require 'yaml'
 
 # Factbase.
+#
+# This is an entry point to a factbase:
+#
+#  fb = Factbase.new
+#  f = fb.insert # new fact created
+#  f.name = 'Jeff Lebowski'
+#  f.age = 42
+#  found = f.query('(gt 20 age)').each.to_a[0]
+#  assert(found.age == 42)
+#
+# A factbase may be exported to a file and then imported back:
+#
+#  fb1 = Factbase.new
+#  File.writebin(file, fb1.export)
+#  fb2 = Factbase.new # it's empty
+#  fb2.import(File.readbin(file))
+#
+# It's important to use +writebin+ and +readbin+, because the content is
+# a chain of bytes, not a text.
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 class Factbase
   # Current version of the gem (changed by .rultor.yml on every release)
-  VERSION = '0.0.36'
+  VERSION = '0.0.37'
 
   # Constructor.
   def initialize(facts = [])

data/test/factbase/test_query.rb

@@ -67,7 +67,7 @@ class TestQuery < Minitest::Test
       '(gt (size num) 2)' => 1,
       '(matches name "^[a-z]+$")' => 1,
       '(lt (size num) 2)' => 2,
-      '(eq (size hello) 0)' => 3,
+      '(eq (size _hello) 0)' => 3,
       '(eq num pi)' => 0,
       '(absent time)' => 2,
       '(eq pi (agg (eq num 0) (sum pi)))' => 1,

data/test/test_factbase.rb

@@ -49,8 +49,8 @@ class TestFactbase < Minitest::Test
     f2 = Factbase.new
     f1.insert.foo = 42
     Tempfile.open do |f|
-      File.write(f.path, f1.export)
-      f2.import(File.read(f.path))
+      File.binwrite(f.path, f1.export)
+      f2.import(File.binread(f.path))
     end
     assert_equal(1, f2.query('(eq foo 42)').each.to_a.count)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factbase
 version: !ruby/object:Gem::Version
-  version: 0.0.36
+  version: 0.0.37
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-26 00:00:00.000000000 Z
+date: 2024-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -66,7 +66,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
-description: Fact base in memory and on disc
+description: A primitive in-memory collection of key-value records known as "facts,"
+  with an ability to insert facts, add properties to facts, and delete facts. There
+  is no ability to modify facts. It is also possible to find facts using Lisp-alike
+  query predicates. An entire factbase may be exported to a binary file and imported
+  back.
 email: yegor256@gmail.com
 executables: []
 extensions: []
@@ -138,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="