factbase 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc21a8440801909645bc06e200ca9b238ab899f6ecd5ef422eec4d082fdbbfaf
-  data.tar.gz: 05fb34e5249ec11dd0cddcfe74888d89a3343c44afada52926f720c102804321
+  metadata.gz: d62cf79f36b50a4a4e447d9596287e62b4a5c5850a74980ec1571cbf6b2db4e2
+  data.tar.gz: 8b0ddac1b055b6de0a78e3f96adf04a2132384a75a65b24ae904f3bd9e41c02f
 SHA512:
-  metadata.gz: 6c72854f13afe4af7be6a232c12c60025cd9d286559940e96a0ebd9decf748e13e8db4993bffe64f8416d3c03cd20f9a491c06c55434bdba2f53c32edd7d7410
-  data.tar.gz: e44f1b7c3c83f207ead55e5aed42844eb98dd53ee6ef5241be0e0931cbe7670dc0c6103c002ce6a4a7cbc8818784de6c7f600a7102d91a20a2dcc732a62fc5d7
+  metadata.gz: 73c098af9694327477acb8455b5d28d8c208ed3105f6a7273296c6fca7304ef67a7c6707b8db34d3556d2254b3297c2c93236115a9d69c3ae423d02cc84c5e5c
+  data.tar.gz: 5b04e6671d7296e398c2fc7e8bbf5d19a0eeca5429fdab09bea857816601e580c2e38985b7ca434648536693940ac81f90cb140596be740b2f770c54f338b0ae

data/.rubocop.yml

@@ -45,3 +45,5 @@ Metrics/PerceivedComplexity:
   Max: 20
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
+Naming/MethodParameterName:
+  MinNameLength: 2

data/.rultor.yml

@@ -31,8 +31,8 @@ release:
     [[ "${tag}" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]] || exit -1
     bundle exec rake
     rm -rf *.gem
-    sed -i "s/0\.0\.0/${tag}/g" lib/factbase.rb
-    git add lib/factbase.rb
+    sed -i "s/0\.0\.0/${tag}/g" factbase.gemspec
+    git add factbase.gemspec
     git commit -m "version set to ${tag}"
     gem build factbase.gemspec
     chmod 0600 ../rubygems.yml

data/factbase.gemspec

@@ -22,16 +22,11 @@
 
 require 'English'
 
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-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.name = 'factbase'
-  s.version = Factbase::VERSION
+  s.version = '0.0.5'
   s.license = 'MIT'
   s.summary = 'Factbase'
   s.description = 'Fact base in memory and on disc'

data/lib/factbase/fact.rb

@@ -20,6 +20,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+require_relative '../factbase'
+
 # Fact.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
@@ -39,6 +41,12 @@ class Factbase::Fact
         @map[k] << args[1]
       end
       nil
+    elsif k == '[]'
+      kk = args[1].to_s
+      @mutex.synchronize do
+        @map[kk] = [] if @map[kk].nil?
+      end
+      @map[kk]
     else
       v = @map[k]
       raise "Can't find '#{k}'" if v.nil?

data/lib/factbase/query.rb

@@ -20,6 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+require_relative '../factbase'
 require_relative 'syntax'
 require_relative 'fact'
 
@@ -39,8 +40,9 @@ class Factbase::Query
   def each
     term = Factbase::Syntax.new(@query).to_term
     @maps.each do |m|
-      next unless term.matches?(m)
-      yield Factbase::Fact.new(@mutex, m)
+      f = Factbase::Fact.new(@mutex, m)
+      next unless term.matches?(f)
+      yield f
     end
   end
 

data/lib/factbase/spy.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2024 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require_relative '../factbase'
+
+# Spy.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class Factbase::Spy
+  def initialize(fb, key)
+    @fb = fb
+    @key = key
+    @caught = []
+  end
+
+  def caught_keys
+    @caught
+  end
+
+  def query(expr)
+    scan(Factbase::Syntax.new(expr).to_term)
+    @fb.query(expr)
+  end
+
+  def insert
+    SpyFact.new(@fb.insert, @key, @caught)
+  end
+
+  def export
+    @fb.export
+  end
+
+  def import(data)
+    @fb.import(data)
+  end
+
+  def to_json(opt = nil)
+    @fb.to_json(opt)
+  end
+
+  # A fact that is spying.
+  class SpyFact
+    def initialize(fact, key, caught)
+      @fact = fact
+      @key = key
+      @caught = caught
+    end
+
+    def method_missing(*args)
+      @caught << args[1] if args[0].to_s == "#{@key}="
+      @fact.method_missing(*args)
+    end
+
+    # rubocop:disable Style/OptionalBooleanParameter
+    def respond_to?(method, include_private = false)
+      # rubocop:enable Style/OptionalBooleanParameter
+      @fact.respond_to?(method, include_private)
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      @fact.respond_to_missing?(method, include_private)
+    end
+  end
+
+  private
+
+  def scan(term)
+    @caught << term.operands[1] if term.op == :eq && term.operands[0].to_s == @key
+    term.operands.each do |o|
+      scan(o) if o.is_a?(Factbase::Term)
+    end
+  end
+end

data/lib/factbase/term.rb

@@ -20,6 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+require_relative '../factbase'
 require_relative 'fact'
 
 # Term.
@@ -27,16 +28,18 @@ require_relative 'fact'
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 class Factbase::Term
+  attr_reader :op, :operands
+
   def initialize(operator, operands)
     @op = operator
     @operands = operands
   end
 
-  # Does it match the map?
-  # @param [Map] The map
+  # Does it match the fact?
+  # @param [Factbase::Fact] The fact
   # @return [bool] TRUE if matches
-  def matches?(map)
-    send(@op, map)
+  def matches?(fact)
+    send(@op, fact)
   end
 
   def to_s
@@ -54,62 +57,62 @@ class Factbase::Term
 
   private
 
-  def nil(_map)
+  def nil(_fact)
     assert_args(0)
     true
   end
 
-  def not(map)
+  def not(fact)
     assert_args(1)
-    !@operands[0].matches?(map)
+    !@operands[0].matches?(fact)
   end
 
-  def or(map)
+  def or(fact)
     @operands.each do |o|
-      return true if o.matches?(map)
+      return true if o.matches?(fact)
     end
     false
   end
 
-  def and(map)
+  def and(fact)
     @operands.each do |o|
-      return false unless o.matches?(map)
+      return false unless o.matches?(fact)
     end
     true
   end
 
-  def exists(map)
+  def exists(fact)
     assert_args(1)
     k = @operands[0].to_s
-    !map[k].nil?
+    !fact[k].empty?
   end
 
-  def absent(map)
+  def absent(fact)
     assert_args(1)
     k = @operands[0].to_s
-    map[k].nil?
+    fact[k].empty?
   end
 
-  def eq(map)
+  def eq(fact)
     assert_args(2)
     k = @operands[0].to_s
-    v = map[k]
-    return false if v.nil?
+    v = fact[k]
+    return false if v.empty?
     v.include?(@operands[1])
   end
 
-  def lt(map)
+  def lt(fact)
     assert_args(2)
     k = @operands[0].to_s
-    v = map[k]
-    return false if v.nil?
+    v = fact[k]
+    return false if v.empty?
     v[0] < @operands[1]
   end
 
-  def gt(map)
+  def gt(fact)
     assert_args(2)
     k = @operands[0].to_s
-    v = map[k]
+    v = fact[k]
     return false if v.nil?
     v[0] > @operands[1]
   end

data/lib/factbase/white_list.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2024 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require_relative '../factbase'
+
+# White list.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class Factbase::WhiteList
+  def initialize(fb, key, list)
+    @fb = fb
+    @key = key
+    @allowed = list
+  end
+
+  def query(expr)
+    @fb.query(expr)
+  end
+
+  def insert
+    WhiteFact.new(@fb.insert, @key, @allowed)
+  end
+
+  def export
+    @fb.export
+  end
+
+  def import(data)
+    @fb.import(data)
+  end
+
+  def to_json(opt = nil)
+    @fb.to_json(opt)
+  end
+
+  # A fact that is allows only values from the list.
+  class WhiteFact
+    def initialize(fact, key, list)
+      @fact = fact
+      @key = key
+      @allowed = list
+    end
+
+    def method_missing(*args)
+      raise "#{args[0]} '#{args[1]}' not allowed" if args[0].to_s == "#{@key}=" && !@allowed.include?(args[1])
+      @fact.method_missing(*args)
+    end
+
+    # rubocop:disable Style/OptionalBooleanParameter
+    def respond_to?(method, include_private = false)
+      # rubocop:enable Style/OptionalBooleanParameter
+      @fact.respond_to?(method, include_private)
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      @fact.respond_to_missing?(method, include_private)
+    end
+  end
+end

data/lib/factbase.rb

@@ -25,9 +25,6 @@
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 class Factbase
-  # Current version of the library and of this class.
-  VERSION = '0.0.4'
-
   # Constructor.
   def initialize
     @maps = []
@@ -37,6 +34,7 @@ class Factbase
   # Insert a new fact.
   # @return [Factbase::Fact] The fact just inserted
   def insert
+    require_relative 'factbase/fact'
     map = {}
     @mutex.synchronize do
       f = Factbase::Fact.new(Mutex.new, map)
@@ -62,6 +60,7 @@ class Factbase
   #
   # @param [String] query The query to use for selections
   def query(query)
+    require_relative 'factbase/query'
     Factbase::Query.new(@maps, @mutex, query)
   end
 
@@ -81,6 +80,3 @@ class Factbase
     @maps.to_json
   end
 end
-
-require_relative 'factbase/fact'
-require_relative 'factbase/query'

data/test/factbase/test_fact.rb

@@ -23,6 +23,7 @@
 
 require 'minitest/autorun'
 require_relative '../../lib/factbase'
+require_relative '../../lib/factbase/fact'
 
 # Fact test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
@@ -36,5 +37,6 @@ class TestFact < Minitest::Test
     assert_equal(42, f.foo)
     f.foo = 256
     assert_equal(42, f.foo)
+    assert_equal([42, 256], f['foo'])
   end
 end

data/test/factbase/test_query.rb

@@ -23,6 +23,7 @@
 
 require 'minitest/autorun'
 require_relative '../../lib/factbase'
+require_relative '../../lib/factbase/query'
 
 # Query test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)

data/test/factbase/test_spy.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2024 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'minitest/autorun'
+require_relative '../../lib/factbase'
+require_relative '../../lib/factbase/spy'
+
+# Spy test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class TestSpy < Minitest::Test
+  def test_simple_spying
+    fb = Factbase::Spy.new(Factbase.new, 'foo')
+    fb.insert.foo = 42
+    fb.insert.foo = 'hello'
+    fb.query('(eq foo "test")').each do |f|
+      assert(f.id.positive?)
+    end
+    assert_equal(3, fb.caught_keys.size)
+    assert(fb.caught_keys.include?('hello'))
+    assert(fb.caught_keys.include?(42))
+    assert(fb.caught_keys.include?('test'))
+  end
+end

data/test/factbase/test_term.rb

@@ -31,38 +31,38 @@ require_relative '../../lib/factbase/term'
 class TestTerm < Minitest::Test
   def test_simple_matching
     t = Factbase::Term.new(:eq, ['foo', 42])
-    assert(t.matches?({ 'foo' => [42] }))
-    assert(!t.matches?({ 'foo' => ['Hello!'] }))
-    assert(!t.matches?({ 'bar' => ['Hello!'] }))
+    assert(t.matches?(fact('foo' => [42])))
+    assert(!t.matches?(fact('foo' => ['Hello!'])))
+    assert(!t.matches?(fact('bar' => ['Hello!'])))
   end
 
   def test_eq_matching
     t = Factbase::Term.new(:eq, ['foo', 42])
-    assert(t.matches?({ 'foo' => [10, 5, 6, -8, 'hey', 42, 9, 'fdsf'] }))
-    assert(!t.matches?({ 'foo' => [100] }))
+    assert(t.matches?(fact('foo' => [10, 5, 6, -8, 'hey', 42, 9, 'fdsf'])))
+    assert(!t.matches?(fact('foo' => [100])))
   end
 
   def test_lt_matching
     t = Factbase::Term.new(:lt, ['foo', 42])
-    assert(t.matches?({ 'foo' => [10] }))
-    assert(!t.matches?({ 'foo' => [100] }))
+    assert(t.matches?(fact('foo' => [10])))
+    assert(!t.matches?(fact('foo' => [100])))
   end
 
   def test_gt_matching
     t = Factbase::Term.new(:gt, ['foo', 42])
-    assert(t.matches?({ 'foo' => [100] }))
-    assert(!t.matches?({ 'foo' => [10] }))
+    assert(t.matches?(fact('foo' => [100])))
+    assert(!t.matches?(fact('foo' => [10])))
   end
 
   def test_not_matching
     t = Factbase::Term.new(:not, [Factbase::Term.new(:nil, [])])
-    assert(!t.matches?({ 'foo' => [100] }))
+    assert(!t.matches?(fact('foo' => [100])))
   end
 
   def test_not_exists_matching
     t = Factbase::Term.new(:not, [Factbase::Term.new(:eq, ['foo', 100])])
-    assert(t.matches?({ 'foo' => [42, 12, -90] }))
-    assert(!t.matches?({ 'foo' => [100] }))
+    assert(t.matches?(fact('foo' => [42, 12, -90])))
+    assert(!t.matches?(fact('foo' => [100])))
   end
 
   def test_or_matching
@@ -73,8 +73,14 @@ class TestTerm < Minitest::Test
         Factbase::Term.new(:eq, ['bar', 5])
       ]
     )
-    assert(t.matches?({ 'foo' => [4] }))
-    assert(t.matches?({ 'bar' => [5] }))
-    assert(!t.matches?({ 'bar' => [42] }))
+    assert(t.matches?(fact('foo' => [4])))
+    assert(t.matches?(fact('bar' => [5])))
+    assert(!t.matches?(fact('bar' => [42])))
+  end
+
+  private
+
+  def fact(map)
+    Factbase::Fact.new(Mutex.new, map)
   end
 end

data/test/factbase/test_white_list.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2024 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'minitest/autorun'
+require_relative '../../lib/factbase'
+require_relative '../../lib/factbase/white_list'
+
+# WhiteList test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class TestWhiteList < Minitest::Test
+  def test_simple_white_listing
+    fb = Factbase::WhiteList.new(Factbase.new, 'foo', ['hello'])
+    fb.insert.foo = 'hello'
+    assert_raises do
+      fb.insert.foo = 42
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factbase
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-10 00:00:00.000000000 Z
+date: 2024-05-11 00:00:00.000000000 Z
 dependencies: []
 description: Fact base in memory and on disc
 email: yegor256@gmail.com
@@ -41,13 +41,17 @@ files:
 - lib/factbase.rb
 - lib/factbase/fact.rb
 - lib/factbase/query.rb
+- lib/factbase/spy.rb
 - lib/factbase/syntax.rb
 - lib/factbase/term.rb
+- lib/factbase/white_list.rb
 - renovate.json
 - test/factbase/test_fact.rb
 - test/factbase/test_query.rb
+- test/factbase/test_spy.rb
 - test/factbase/test_syntax.rb
 - test/factbase/test_term.rb
+- test/factbase/test_white_list.rb
 - test/test__helper.rb
 - test/test_factbase.rb
 homepage: http://github.com/yegor256/factbase.rb