factbase 0.0.36 → 0.0.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c801d7ec256766a03b081de5949367aef74dc991b67207ae30c6e6229f11c425
-  data.tar.gz: 2cfc12996cc7e4d85fad86377ddc9b87916d5d2a1cbe5542ba8128488c1e0049
+  metadata.gz: f3c7e0abf7bec6e53f050b4eeaeddd2b9954ee77b2a5f9a0332394c995d91ba9
+  data.tar.gz: 5da4b8574d7b1a93fd67f3d833bf51952eb5b3d9c303b9e20a084dc5953d71bc
 SHA512:
-  metadata.gz: 6d2d1ec011eaf2d34f00068fa71809bf8bd3fe794b6097eeb1292ad25f1a6916e319490a137fa4c1908c00ce640f19c8efff27444ca277e72048daf5e688c3ef
-  data.tar.gz: 7f20423de58a836eb68261a8d7ad45ec00056a4f991b8f34c68dd4833a42bbb0009bca75a4a8092112cfb80599e2be04e5cca9a9bfe18b3ae18102622d98f9a6
+  metadata.gz: f472603e32966c098979c2a461d94cd60f1f6213c4cea4abae225694d59ae88df252bbd42dcfb3292efb97352618cfa35fe56bef86bf87310dc74b4dbce65a20
+  data.tar.gz: fb91b271a5d57c59268dd386f8960e1c3c3c1577ea80e5c9bc3b623eaa6c559b15ce326f23ec9035e795d08ce647af353f4ae12aef5a34a124286f41fdf79130

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/.rubocop.yml

@@ -43,7 +43,7 @@ Metrics/BlockLength:
 Metrics/CyclomaticComplexity:
   Max: 25
 Metrics/PerceivedComplexity:
-  Max: 25
+  Max: 30
 Metrics/ClassLength:
   Enabled: false
 Layout/EmptyLineAfterGuardClause:

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/README.md

@@ -71,7 +71,7 @@ There are some terms available in a query:
 * `(many a)` return true if there are many values in the `a` property
 * `(one a)` returns true if there is only one value in the `a` property
 * `(at i a)` returns the `i`-th value of the `a` property
-* `(nonil a b)` returns `b` if `a` is `nil`
+* `(either a b)` returns `b` if `a` is `nil`
 * `(matches a re)` returns true when `a` matches regular expression `re`
 * `(defn foo "self.to_s")` defines a new term using Ruby syntax and returns true
 

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

@@ -44,7 +44,9 @@ class Factbase::Syntax
   def to_term
     build.simplify
   rescue StandardError => e
-    raise "#{e.message} in \"#{@query}\""
+    err = "#{e.message} in #{@query}"
+    err = "#{err}, tokens: #{@tokens}" unless @tokens.nil?
+    raise err
   end
 
   private
@@ -95,7 +97,11 @@ class Factbase::Syntax
     list = []
     acc = ''
     string = false
-    @query.to_s.gsub(/#.*$/, '').chars.each do |c|
+    comment = false
+    @query.to_s.chars.each do |c|
+      comment = true if !string && c == '#'
+      comment = false if comment && c == "\n"
+      next if comment
       if ['\'', '"'].include?(c)
         if string && acc[acc.length - 1] == '\\'
           acc = acc[0..-2]
@@ -136,7 +142,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
@@ -149,7 +158,7 @@ class Factbase::Term
     by_symbol(0, fact).nil?
   end
 
-  def nonil(fact, maps)
+  def either(fact, maps)
     assert_args(2)
     v = the_values(0, fact, maps)
     return v unless v.nil?

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.38'
 
   # Constructor.
   def initialize(facts = [])

data/test/factbase/test_query.rb

@@ -59,7 +59,7 @@ class TestQuery < Minitest::Test
       '(when (eq num 0) (exists time))' => 2,
       '(many num)' => 1,
       '(one num)' => 2,
-      '(gt num (minus 1 (nonil (at 0 (prev num)) 0)))' => 3,
+      '(gt num (minus 1 (either (at 0 (prev num)) 0)))' => 3,
       '(and (not (many num)) (eq num (plus 21 +21)))' => 1,
       '(and (not (many num)) (eq num (minus -100 -142)))' => 1,
       '(and (one num) (eq num (times 7 6)))' => 1,
@@ -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/factbase/test_syntax.rb

@@ -42,10 +42,12 @@ class TestSyntax < Minitest::Test
   def test_simple_parsing
     [
       '(foo)',
-      '(foo (bar) (zz 77)   )',
+      '(foo (bar) (zz 77)   ) # hey',
+      "# hello\n\n\n(foo (bar))",
       "(eq foo   \n\n 'Hello, world!'\n)\n",
       "(eq x 'Hello, \\' \n) \\' ( world!')",
       "# this is a comment\n(eq foo # test\n 42)\n\n# another comment\n",
+      "(foo 'Hello,\n\nworld!\r\t\n')\n",
       "(or ( a 4) (b 5) (always) (and (always) (c 5) \t\t(r 7 w8s w8is 'Foo')))"
     ].each do |q|
       Factbase::Syntax.new(q).to_term
@@ -60,7 +62,7 @@ class TestSyntax < Minitest::Test
       "(r 'Dude\\'s Friend')",
       "(r 'I\\'m \\\"good\\\"')",
       '(foo x y z)',
-      "(foo x y z t f 42 'Hi!' 33)",
+      "(foo x y z t f 42 'Hi!# you' 33)",
       '(foo (x) y z)',
       '(eq t 2024-05-25T19:43:48Z)',
       '(eq t 2024-05-25T19:43:48Z)',
@@ -106,11 +108,10 @@ class TestSyntax < Minitest::Test
       ')',
       '"'
     ].each do |q|
-      assert(
-        assert_raises(q) do
-          Factbase::Syntax.new(q).to_term
-        end.message.include?(q)
-      )
+      msg = assert_raises(q) do
+        Factbase::Syntax.new(q).to_term
+      end.message
+      assert(msg.include?(q), msg)
     end
   end
 

data/test/factbase/test_term.rb

@@ -178,8 +178,8 @@ class TestTerm < Minitest::Test
     assert_equal(5, t.evaluate(fact('foo' => [4, 5]), []))
   end
 
-  def test_nonil
-    t = Factbase::Term.new(:nonil, [Factbase::Term.new(:at, [5, :foo]), 42])
+  def test_either
+    t = Factbase::Term.new(:either, [Factbase::Term.new(:at, [5, :foo]), 42])
     assert_equal([42], t.evaluate(fact('foo' => 4), []))
   end
 

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.38
 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:
   - - ">="