factbase 0.0.25 → 0.0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9e0276640bc70144f57a3926e20b6e2d44063da6fe7236fb956867a06e102ba
-  data.tar.gz: c7826200059da686fe4025aadae2aa1d83eda7e061e4e72c888e327a3d24adda
+  metadata.gz: 29134d600523642a5dd215f28aa9b48ec3337fec96d4dc41ea0500a3a4ee46c5
+  data.tar.gz: 2335e295a7b5dfe6f3cb1eb5ace692cfbc32d788c91906a6f609249b26c4da13
 SHA512:
-  metadata.gz: 8362694429ca241aaa592d36f662b2939ddaec04017ae37326611db4c9a697ab95321f6b3d406a9f4d65be86f9f42ba019ca4c8ec0e8b3ec5c77967bf75107d2
-  data.tar.gz: 7c96e521d770381536b956e43781c909f597d39b8098178b0c0b77e15e4733c2eaded65a91704ca81c42f214168ad89505f8cfe6830e84e994c247213ef138df
+  metadata.gz: bf293f3f8ce5b6f1a515a071f771f1a8d84149e0198b0f11073900ed55a6b218bc2d4dcc65ecc439b777fb8163bb13b2f5d24bea9f2600639276183218f2d9f5
+  data.tar.gz: ec4c0b3a780ea432b8560485b4a8c467d2b7fc165a1d29fd27b1e03d35f7f481cc11584b3f60100f4a63b308d84023304eb92f8f970cc105cff7e9eba06df0af

data/.rubocop.yml

@@ -44,9 +44,13 @@ Metrics/CyclomaticComplexity:
   Max: 20
 Metrics/PerceivedComplexity:
   Max: 20
+Metrics/ClassLength:
+  Enabled: false
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
 Naming/MethodParameterName:
   MinNameLength: 2
 Layout/EndOfLine:
   EnforcedStyle: lf
+Security/MarshalLoad:
+  Enabled: false

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" factbase.gemspec
-    git add factbase.gemspec
+    sed -i "s/0\.0\.0/${tag}/g" lib/factbase.rb
+    git add lib/factbase.rb
     git commit -m "version set to ${tag}"
     gem build factbase.gemspec
     chmod 0600 ../rubygems.yml

data/factbase.gemspec

@@ -21,12 +21,13 @@
 # SOFTWARE.
 
 require 'English'
+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 = '0.0.25'
+  s.version = Factbase::VERSION
   s.license = 'MIT'
   s.summary = 'Factbase'
   s.description = 'Fact base in memory and on disc'

data/lib/factbase/fact.rb

@@ -46,6 +46,7 @@ class Factbase::Fact
     if k.end_with?('=')
       kk = k[0..-2]
       raise "Invalid prop name '#{kk}'" unless kk.match?(/^[a-z][_a-zA-Z0-9]*$/)
+      raise "Prohibited prop name '#{kk}'" if kk == 'to_s'
       v = args[1]
       raise "Prop value can't be nil" if v.nil?
       raise "Prop value can't be empty" if v == ''

data/lib/factbase/inv.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'
+
 # A decorator of a Factbase, that checks invariants on every set.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
@@ -30,8 +32,8 @@ class Factbase::Inv
     @block = block
   end
 
-  def empty?
-    @fb.empty?
+  def dup
+    Factbase::Inv.new(@fb.dup, &@block)
   end
 
   def size
@@ -46,6 +48,10 @@ class Factbase::Inv
     Query.new(@fb.query(query), @block)
   end
 
+  def txn(this = self, &)
+    @fb.txn(this, &)
+  end
+
   def export
     @fb.export
   end
@@ -54,18 +60,6 @@ class Factbase::Inv
     @fb.import(bytes)
   end
 
-  def to_json(opt = nil)
-    @fb.to_json(opt)
-  end
-
-  def to_xml
-    @fb.to_xml
-  end
-
-  def to_yaml
-    @fb.to_yaml
-  end
-
   # Fact decorator.
   class Fact
     def initialize(fact, block)

data/lib/factbase/looged.rb

@@ -32,8 +32,8 @@ class Factbase::Looged
     @loog = loog
   end
 
-  def empty?
-    @fb.empty?
+  def dup
+    Factbase::Looged.new(@fb.dup, @loog)
   end
 
   def size
@@ -50,6 +50,10 @@ class Factbase::Looged
     Query.new(@fb.query(query), query, @loog)
   end
 
+  def txn(this = self, &)
+    @fb.txn(this, &)
+  end
+
   def export
     @fb.export
   end
@@ -58,18 +62,6 @@ class Factbase::Looged
     @fb.import(bytes)
   end
 
-  def to_json(opt = nil)
-    @fb.to_json(opt)
-  end
-
-  def to_xml
-    @fb.to_xml
-  end
-
-  def to_yaml
-    @fb.to_yaml
-  end
-
   # Fact decorator.
   class Fact
     def initialize(fact, loog)
@@ -85,7 +77,9 @@ class Factbase::Looged
       r = @fact.method_missing(*args)
       k = args[0].to_s
       v = args[1]
-      @loog.debug("Set '#{k[0..-2]}' to #{v.to_s.inspect} (#{v.class})") if k.end_with?('=')
+      s = v.is_a?(Time) ? v.utc.iso8601 : v.to_s
+      s = v.to_s.inspect if v.is_a?(String)
+      @loog.debug("Set '#{k[0..-2]}' to #{s} (#{v.class})") if k.end_with?('=')
       r
     end
 

data/lib/factbase/pre.rb

@@ -21,6 +21,7 @@
 # SOFTWARE.
 
 require 'loog'
+require_relative '../factbase'
 
 # A decorator of a Factbase, that runs a provided block on every +insert+.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
@@ -32,8 +33,8 @@ class Factbase::Pre
     @block = block
   end
 
-  def empty?
-    @fb.empty?
+  def dup
+    Factbase::Pre.new(@fb.dup, &@block)
   end
 
   def size
@@ -50,6 +51,10 @@ class Factbase::Pre
     @fb.query(query)
   end
 
+  def txn(this = self, &)
+    @fb.txn(this, &)
+  end
+
   def export
     @fb.export
   end
@@ -57,16 +62,4 @@ class Factbase::Pre
   def import(bytes)
     @fb.import(bytes)
   end
-
-  def to_json(opt = nil)
-    @fb.to_json(opt)
-  end
-
-  def to_xml
-    @fb.to_xml
-  end
-
-  def to_yaml
-    @fb.to_yaml
-  end
 end

data/lib/factbase/query.rb

@@ -44,7 +44,7 @@ class Factbase::Query
     yielded = 0
     @maps.each do |m|
       f = Factbase::Fact.new(@mutex, m)
-      next unless term.matches?(f)
+      next unless term.eval(f)
       yield f
       yielded += 1
     end
@@ -59,7 +59,7 @@ class Factbase::Query
     @mutex.synchronize do
       @maps.delete_if do |m|
         f = Factbase::Fact.new(@mutex, m)
-        if term.matches?(f)
+        if term.eval(f)
           deleted += 1
           true
         else

data/lib/factbase/rules.rb

@@ -0,0 +1,124 @@
+# 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'
+
+# A decorator of a Factbase, that checks rules on every set.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class Factbase::Rules
+  def initialize(fb, rules)
+    @fb = fb
+    @rules = rules
+    @check = Check.new(fb, @rules)
+  end
+
+  def dup
+    Factbase::Rules.new(@fb.dup, @rules)
+  end
+
+  def size
+    @fb.size
+  end
+
+  def insert
+    Fact.new(@fb.insert, @check)
+  end
+
+  def query(query)
+    Query.new(@fb.query(query), @check)
+  end
+
+  def txn(this = self, &)
+    @fb.txn(this, &)
+  end
+
+  def export
+    @fb.export
+  end
+
+  def import(bytes)
+    @fb.import(bytes)
+  end
+
+  # Fact decorator.
+  class Fact
+    def initialize(fact, check)
+      @fact = fact
+      @check = check
+    end
+
+    def to_s
+      @fact.to_s
+    end
+
+    def method_missing(*args)
+      r = @fact.method_missing(*args)
+      k = args[0].to_s
+      @check.it(self) if k.end_with?('=')
+      r
+    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
+
+  # Query decorator.
+  class Query
+    def initialize(query, check)
+      @query = query
+      @check = check
+    end
+
+    def each
+      return to_enum(__method__) unless block_given?
+      @query.each do |f|
+        yield Fact.new(f, @check)
+      end
+    end
+
+    def delete!
+      @query.delete!
+    end
+  end
+
+  # Check one fact.
+  class Check
+    def initialize(fb, expr)
+      @fb = fb
+      @expr = expr
+    end
+
+    def it(fact)
+      return if Factbase::Syntax.new(@expr).to_term.eval(fact)
+      raise "The fact is in invalid state: #{fact}"
+    end
+  end
+end

data/lib/factbase/spy.rb

@@ -37,6 +37,14 @@ class Factbase::Spy
     @caught
   end
 
+  def dup
+    Factbase::Spy.new(@fb.dup, @key)
+  end
+
+  def size
+    @fb.size
+  end
+
   def query(expr)
     scan(Factbase::Syntax.new(expr).to_term)
     @fb.query(expr)
@@ -50,12 +58,12 @@ class Factbase::Spy
     @fb.export
   end
 
-  def import(data)
-    @fb.import(data)
+  def txn(this = self, &)
+    @fb.txn(this, &)
   end
 
-  def to_json(opt = nil)
-    @fb.to_json(opt)
+  def import(data)
+    @fb.import(data)
   end
 
   # A fact that is spying.

data/lib/factbase/syntax.rb

@@ -20,6 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+require 'time'
 require_relative '../factbase'
 require_relative 'fact'
 require_relative 'term'
@@ -42,6 +43,7 @@ class Factbase::Syntax
     @ast ||= to_ast(@tokens, 0)
     term = @ast[0]
     raise 'No terms found' if term.nil?
+    raise 'Not a term' unless term.is_a?(Factbase::Term)
     term
   end
 
@@ -80,7 +82,7 @@ class Factbase::Syntax
     list = []
     acc = ''
     string = false
-    @query.to_s.chars.each do |c|
+    @query.to_s.gsub(/#.*$/, '').chars.each do |c|
       if ['\'', '"'].include?(c)
         if string && acc[acc.length - 1] == '\\'
           acc = acc[0..-2]

data/lib/factbase/term.rb

@@ -41,7 +41,7 @@ class Factbase::Term
   # Does it match the fact?
   # @param [Factbase::Fact] fact The fact
   # @return [bool] TRUE if matches
-  def matches?(fact)
+  def eval(fact)
     send(@op, fact)
   end
 
@@ -71,23 +71,30 @@ class Factbase::Term
 
   def not(fact)
     assert_args(1)
-    !@operands[0].matches?(fact)
+    !@operands[0].eval(fact)
   end
 
   def or(fact)
     @operands.each do |o|
-      return true if o.matches?(fact)
+      return true if o.eval(fact)
     end
     false
   end
 
   def and(fact)
     @operands.each do |o|
-      return false unless o.matches?(fact)
+      return false unless o.eval(fact)
     end
     true
   end
 
+  def when(fact)
+    assert_args(2)
+    a = @operands[0]
+    b = @operands[1]
+    !a.eval(fact) || (a.eval(fact) && b.eval(fact))
+  end
+
   def exists(fact)
     assert_args(1)
     o = @operands[0]
@@ -116,12 +123,35 @@ class Factbase::Term
     arithmetic(:>, fact)
   end
 
+  def size(fact)
+    assert_args(1)
+    o = @operands[0]
+    raise "A symbol expected: #{o}" unless o.is_a?(Symbol)
+    k = o.to_s
+    return 0 if fact[k].nil?
+    return 1 unless fact[k].is_a?(Array)
+    fact[k].size
+  end
+
+  def type(fact)
+    assert_args(1)
+    o = @operands[0]
+    raise "A symbol expected: #{o}" unless o.is_a?(Symbol)
+    k = o.to_s
+    return 'nil' if fact[k].nil?
+    fact[k].class.to_s
+  end
+
   def arithmetic(op, fact)
     assert_args(2)
     o = @operands[0]
-    raise "A symbol expected by #{op}: #{o}" unless o.is_a?(Symbol)
-    k = o.to_s
-    v = fact[k]
+    if o.is_a?(Factbase::Term)
+      v = o.eval(fact)
+    else
+      raise "A symbol expected by #{op}: #{o}" unless o.is_a?(Symbol)
+      k = o.to_s
+      v = fact[k]
+    end
     return false if v.nil?
     v = [v] unless v.is_a?(Array)
     v.any? do |vv|

data/lib/factbase/to_json.rb

@@ -0,0 +1,43 @@
+# 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 'json'
+require 'time'
+require_relative '../factbase'
+
+# Factbase to JSON converter.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class Factbase::ToJSON
+  # Constructor.
+  def initialize(fb)
+    @fb = fb
+  end
+
+  # Convert the entire factbase into JSON.
+  # @return [String] The factbase in JSON format
+  def json
+    maps = Marshal.load(@fb.export)
+    maps.to_json
+  end
+end

data/lib/factbase/to_xml.rb

@@ -0,0 +1,75 @@
+# 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 'nokogiri'
+require 'time'
+require_relative '../factbase'
+
+# Factbase to XML converter.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class Factbase::ToXML
+  # Constructor.
+  def initialize(fb)
+    @fb = fb
+  end
+
+  # Convert the entire factbase into XML.
+  # @return [String] The factbase in XML format
+  def xml
+    meta = {
+      factbase_version: Factbase::VERSION,
+      dob: Time.now.utc.iso8601
+    }
+    maps = Marshal.load(@fb.export)
+    Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+      xml.fb(meta) do
+        maps.each do |m|
+          xml.f_ do
+            m.each do |k, vv|
+              if vv.is_a?(Array)
+                xml.send(:"#{k}_") do
+                  vv.each do |v|
+                    xml.send(:v, to_str(v))
+                  end
+                end
+              else
+                xml.send(:"#{k}_", to_str(vv))
+              end
+            end
+          end
+        end
+      end
+    end.to_xml
+  end
+
+  private
+
+  def to_str(val)
+    if val.is_a?(Time)
+      val.utc.iso8601
+    else
+      val.to_s
+    end
+  end
+end

data/lib/factbase/to_yaml.rb

@@ -0,0 +1,43 @@
+# 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 'yaml'
+require 'time'
+require_relative '../factbase'
+
+# Factbase to YAML converter.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class Factbase::ToYAML
+  # Constructor.
+  def initialize(fb)
+    @fb = fb
+  end
+
+  # Convert the entire factbase into YAML.
+  # @return [String] The factbase in YAML format
+  def yaml
+    maps = Marshal.load(@fb.export)
+    YAML.dump({ 'facts' => maps })
+  end
+end