factbase 0.0.29 → 0.0.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cce648530bed16f5d251c8d84dae0a3c8726f1c688fbfdbf3723a39fe9f3e696
-  data.tar.gz: e0f31869dab8d231f63d2c075661e2e4ead17576d258bcc6bd19a643a659e35b
+  metadata.gz: 016b53cf00bc9efec24f50c333ab1fc14266151487fab61ce7d7ca533ba602a6
+  data.tar.gz: 89845aa58068bf78189d62602282dbcffe8f99a5d4b772dcf8bfd3ee4b3698d4
 SHA512:
-  metadata.gz: a2e76c6c010157ba7aff6098e44c9cde7958d288b0bb7ea41a69201ab1783763da31f657c52156a2991ac02fe56e48d31acdb3fb71749827eb126b5a363416e5
-  data.tar.gz: 908fa035b142fea947303b3306b38f3443e782d4a182f158d6674cc8396a704fb45cc68b4533ce61ded2e98a7fe57c2fd23716706df56b0a7254aa8f5dd35539
+  metadata.gz: 0d2fecf64f6b62d4ad8796469f4aa937a63e2398f032a812fc15b95ea6be48f0aa25fe032bc469e4afd4ced351f6ba8fbc914bf1dc074dd07ae881b481e39d0b
+  data.tar.gz: 9843fdc79bf8b53aae6b366d1ea133f92185a85dc37ed5f6779d478d030655e621d5431cf793ee162f79fddc4c51ae49403850f25849cbcefb7ac793cc4975ae

data/.github/workflows/license.yml

@@ -0,0 +1,57 @@
+# 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 NONINFRINGEMENT. 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.
+---
+name: license
+'on':
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  license:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - shell: bash
+        run: |
+          header="Copyright (c) $(date +%Y) Yegor Bugayenko"
+          failed="false"
+          while IFS= read -r file; do
+            if ! grep -q "${header}" "${file}"; then
+              failed="true"
+              echo "⚠️ Copyright header is not found in: ${file}"
+            else
+              echo "File looks good: ${file}"
+            fi
+          done < <(find . -type f \( \
+            -name "Dockerfile" -o \
+            -name "LICENSE.txt" -o \
+            -name "Makefile" -o \
+            -name "Rakefile" -o \
+            -name "*.sh" -o \
+            -name "*.rb" -o \
+            -name "*.fe" -o \
+            -name "*.yml" \
+            \) -print)
+          if [ "${failed}" = "true" ]; then
+            exit 1
+          fi

data/Gemfile

@@ -23,10 +23,10 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'minitest', '5.23.0', require: false
+gem 'minitest', '5.23.1', require: false
 gem 'rake', '13.2.1', require: false
 gem 'rspec-rails', '6.1.2', require: false
-gem 'rubocop', '1.63.5', require: false
+gem 'rubocop', '1.64.0', require: false
 gem 'rubocop-performance', '1.21.0', require: false
 gem 'rubocop-rspec', '2.29.2', require: false
 gem 'simplecov', '0.22.0', require: false

data/Gemfile.lock

@@ -59,7 +59,7 @@ GEM
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     loog (0.5.1)
-    minitest (5.23.0)
+    minitest (5.23.1)
     mutex_m (0.2.0)
     nokogiri (1.16.5-arm64-darwin)
       racc (~> 1.4)
@@ -75,7 +75,7 @@ GEM
       racc
     psych (5.1.2)
       stringio
-    racc (1.7.3)
+    racc (1.8.0)
     rack (3.0.11)
     rack-session (2.0.0)
       rack (>= 3.0.0)
@@ -125,7 +125,7 @@ GEM
       rspec-mocks (~> 3.13)
       rspec-support (~> 3.13)
     rspec-support (3.13.1)
-    rubocop (1.63.5)
+    rubocop (1.64.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -181,10 +181,10 @@ PLATFORMS
 
 DEPENDENCIES
   factbase!
-  minitest (= 5.23.0)
+  minitest (= 5.23.1)
   rake (= 13.2.1)
   rspec-rails (= 6.1.2)
-  rubocop (= 1.63.5)
+  rubocop (= 1.64.0)
   rubocop-performance (= 1.21.0)
   rubocop-rspec (= 2.29.2)
   simplecov (= 0.22.0)

data/README.md

@@ -14,7 +14,16 @@
 This Ruby gem manages an in-memory database of facts.
 A fact is simply a map of properties and values.
 The values are either atomic literals or non-empty sets of literals.
-It is possible to delete a fact, but impossible to delete a property from a fact.
+It is possible to delete a fact, but impossible to delete a property
+from a fact.
+
+**ATTENTION**: The current implemention is naive and,
+because of that, very slow. I will be very happy
+if you suggest a better implementation without the change of the interface.
+The `Factbase::query()` method is what mostly needs performance optimization:
+currently it simply iterates through all facts in the factbase in order
+to find those that match the provided terms. Obviously,
+even a simple indexing may significantly increase performance.
 
 Here is how you use it (it's thread-safe, by the way):
 
@@ -60,12 +69,19 @@ All terms available in a query:
 * `(gt a b)` returns true if `a` is greater than `b`
 * `(size k)` returns cardinality of `k` property (zero if property is absent)
 * `(type a)` returns type of `a` ("String", "Integer", "Float", or "Time")
-* `(matches a re)` returns type when `a` matches regular expression `re`
+* `(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
 
+There are also terms that match the entire factbase:
+
+* `(max k)` returns true if the value of `k` property
+is the largest in the entire factbase
+* `(min k)` returns true if the value of `k` is the smallest
+
 ## How to contribute
 
-Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
+Read
+[these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
 Make sure you build is green before you contribute
 your pull request. You will need to have
 [Ruby](https://www.ruby-lang.org/en/) 3.2+ and

data/lib/factbase/looged.rb

@@ -42,7 +42,7 @@ class Factbase::Looged
 
   def insert
     f = @fb.insert
-    @loog.debug('Inserted new fact')
+    @loog.debug("Inserted new fact ##{@fb.size}")
     Fact.new(f, @loog)
   end
 
@@ -79,6 +79,7 @@ class Factbase::Looged
       v = args[1]
       s = v.is_a?(Time) ? v.utc.iso8601 : v.to_s
       s = v.to_s.inspect if v.is_a?(String)
+      s = "#{s[0..40]}...#{s[-40..]}" if s.length > 80
       @loog.debug("Set '#{k[0..-2]}' to #{s} (#{v.class})") if k.end_with?('=')
       r
     end
@@ -103,13 +104,14 @@ class Factbase::Looged
     end
 
     def each(&)
+      q = Factbase::Syntax.new(@expr).to_term.to_s
       if block_given?
         r = @query.each(&)
         raise ".each of #{@query.class} returned #{r.class}" unless r.is_a?(Integer)
         if r.zero?
-          @loog.debug("Nothing found by '#{@expr}'")
+          @loog.debug("Nothing found by '#{q}'")
         else
-          @loog.debug("Found #{r} fact(s) by '#{@expr}'")
+          @loog.debug("Found #{r} fact(s) by '#{q}'")
         end
         r
       else
@@ -120,9 +122,9 @@ class Factbase::Looged
         end
         # rubocop:enable Style/MapIntoArray
         if array.empty?
-          @loog.debug("Nothing found by '#{@expr}'")
+          @loog.debug("Nothing found by '#{q}'")
         else
-          @loog.debug("Found #{array.size} fact(s) by '#{@expr}'")
+          @loog.debug("Found #{array.size} fact(s) by '#{q}'")
         end
         array
       end

data/lib/factbase/query.rb

@@ -40,7 +40,7 @@ class Factbase::Query
   # @return [Integer] Total number of facts yielded
   def each
     return to_enum(__method__) unless block_given?
-    term = Factbase::Syntax.new(@query).to_term
+    term = Factbase::Syntax.new(@query).to_term.on(@maps)
     yielded = 0
     @maps.each do |m|
       f = Factbase::Fact.new(@mutex, m)

data/lib/factbase/syntax.rb

@@ -39,17 +39,26 @@ class Factbase::Syntax
   # Convert it to a term.
   # @return [Term] The term detected
   def to_term
+    build.simplify
+  rescue StandardError => e
+    raise "#{e.message} in \"#{@query}\""
+  end
+
+  private
+
+  # Convert it to a term.
+  # @return [Term] The term detected
+  def build
     @tokens ||= to_tokens
+    raise 'No tokens' if @tokens.empty?
     @ast ||= to_ast(@tokens, 0)
-    raise "Too many terms: #{@query}" if @ast[1] != @tokens.size
+    raise 'Too many terms' if @ast[1] != @tokens.size
     term = @ast[0]
-    raise "No terms found: #{@query}" if term.nil?
-    raise "Not a term: #{@query}" unless term.is_a?(Factbase::Term)
+    raise 'No terms found' if term.nil?
+    raise 'Not a term' unless term.is_a?(Factbase::Term)
     term
   end
 
-  private
-
   # Reads the stream of tokens, starting at the +at+ position. If the
   # token at the position is not a literal (like 42 or "Hello") but a term,
   # the function recursively calls itself.
@@ -58,7 +67,7 @@ class Factbase::Syntax
   # is the term/literal and the second one is the position where the
   # scanning should continue.
   def to_ast(tokens, at)
-    raise "Closing too soon at ##{at}: #{@query}" if tokens[at] == :close
+    raise "Closing too soon at ##{at}" if tokens[at] == :close
     return [tokens[at], at + 1] unless tokens[at] == :open
     at += 1
     op = tokens[at]
@@ -66,11 +75,11 @@ class Factbase::Syntax
     operands = []
     at += 1
     loop do
-      raise "End of token stream at ##{at}: #{@query}" if tokens[at].nil?
+      raise "End of token stream at ##{at}" if tokens[at].nil?
       break if tokens[at] == :close
       (operand, at1) = to_ast(tokens, at)
-      raise "Stuck at position ##{at}: #{@query}" if at == at1
-      raise "Jump back at position ##{at}: #{@query}" if at1 < at
+      raise "Stuck at position ##{at}" if at == at1
+      raise "Jump back at position ##{at}" if at1 < at
       at = at1
       operands << operand
       break if tokens[at] == :close
@@ -110,12 +119,12 @@ class Factbase::Syntax
         acc += c
       end
     end
-    raise "String not closed: : #{@query}" if string
+    raise 'String not closed' if string
     list.map do |t|
       if t.is_a?(Symbol)
         t
       elsif t.start_with?('\'', '"')
-        raise "String literal can't be empty: #{@query}" if t.length <= 2
+        raise 'String literal can\'t be empty' if t.length <= 2
         t[1..-2]
       elsif t.match?(/^[0-9]+$/)
         t.to_i
@@ -124,7 +133,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}): #{@query}" 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

@@ -45,6 +45,29 @@ class Factbase::Term
     send(@op, fact)
   end
 
+  # Put it into the context: let it see the entire array of maps.
+  # @param [Array] maps The maps
+  # @return [Factbase::Term] Itself
+  def on(maps)
+    m = "#{@op}_on"
+    send(m, maps) if respond_to?(m, true)
+    @operands.each do |o|
+      o.on(maps) if o.is_a?(Factbase::Term)
+    end
+    self
+  end
+
+  # Simplify it if possible.
+  # @return [Factbase::Term] New term or itself
+  def simplify
+    m = "#{@op}_simplify"
+    if respond_to?(m, true)
+      send(m)
+    else
+      self
+    end
+  end
+
   # Turns it into a string.
   # @return [String] The string of it
   def to_s
@@ -71,29 +94,45 @@ class Factbase::Term
 
   def not(fact)
     assert_args(1)
-    r = @operands[0].evaluate(fact)
-    raise 'Boolean expected' unless r.is_a?(TrueClass) || r.is_a?(FalseClass)
-    !r
+    !only_bool(the_value(0, fact))
   end
 
   def or(fact)
-    @operands.each do |o|
-      r = o.evaluate(fact)
-      raise 'Boolean expected' unless r.is_a?(TrueClass) || r.is_a?(FalseClass)
-      return true if r
+    (0..@operands.size - 1).each do |i|
+      return true if only_bool(the_value(i, fact))
     end
     false
   end
 
   def and(fact)
-    @operands.each do |o|
-      r = o.evaluate(fact)
-      raise 'Boolean expected' unless r.is_a?(TrueClass) || r.is_a?(FalseClass)
-      return false unless r
+    (0..@operands.size - 1).each do |i|
+      return false unless only_bool(the_value(i, fact))
     end
     true
   end
 
+  def and_or_simplify
+    strs = []
+    ops = []
+    @operands.each do |o|
+      o = o.simplify
+      s = o.to_s
+      next if strs.include?(s)
+      strs << s
+      ops << o
+    end
+    return ops[0] if ops.size == 1
+    Factbase::Term.new(@op, ops)
+  end
+
+  def and_simplify
+    and_or_simplify
+  end
+
+  def or_simplify
+    and_or_simplify
+  end
+
   def when(fact)
     assert_args(2)
     a = @operands[0]
@@ -174,6 +213,26 @@ class Factbase::Term
     true
   end
 
+  def min(fact)
+    vv = the_value(0, fact)
+    return nil if vv.nil?
+    vv.any? { |v| v == @min }
+  end
+
+  def max(fact)
+    vv = the_value(0, fact)
+    return nil if vv.nil?
+    vv.any? { |v| v == @max }
+  end
+
+  def max_on(maps)
+    @max = best(maps) { |v, b| v > b }
+  end
+
+  def min_on(maps)
+    @min = best(maps) { |v, b| v < b }
+  end
+
   def assert_args(num)
     c = @operands.size
     raise "Too many (#{c}) operands for '#{@op}' (#{num} expected)" if c > num
@@ -195,4 +254,26 @@ class Factbase::Term
     v = [v] unless v.is_a?(Array)
     v
   end
+
+  def only_bool(val)
+    val = val[0] if val.is_a?(Array)
+    return false if val.nil?
+    raise "Boolean expected, while #{val.class} received" unless val.is_a?(TrueClass) || val.is_a?(FalseClass)
+    val
+  end
+
+  def best(maps)
+    k = @operands[0]
+    raise "A symbol expected, but provided: #{k}" unless k.is_a?(Symbol)
+    best = nil
+    maps.each do |m|
+      vv = m[k.to_s]
+      next if vv.nil?
+      vv = [vv] unless vv.is_a?(Array)
+      vv.each do |v|
+        best = v if best.nil? || yield(v, best)
+      end
+    end
+    best
+  end
 end

data/lib/factbase.rb

@@ -29,7 +29,7 @@ require 'yaml'
 # License:: MIT
 class Factbase
   # Current version of the gem (changed by .rultor.yml on every release)
-  VERSION = '0.0.29'
+  VERSION = '0.0.31'
 
   # Constructor.
   def initialize(facts = [])

data/test/factbase/test_fact.rb

@@ -84,6 +84,14 @@ class TestFact < Minitest::Test
     assert_equal(42, f.foo_bar, f.to_s)
   end
 
+  def test_set_twice_same_value
+    map = {}
+    f = Factbase::Fact.new(Mutex.new, map)
+    f.foo = 42
+    f.foo = 42
+    assert_equal(42, map['foo'])
+  end
+
   def test_time_in_utc
     f = Factbase::Fact.new(Mutex.new, {})
     t = Time.now

data/test/factbase/test_looged.rb

@@ -69,13 +69,30 @@ class TestLooged < Minitest::Test
     fb.insert
     fb.insert.bar = 3
     fb.insert
+    fb.insert.str =
+      "Он поскорей звонит. Вбегает
+      К нему слуга француз Гильо,
+      Халат и туфли предлагает
+      И подает ему белье.
+      Спешит Онегин одеваться,
+      Слуге велит приготовляться
+      С ним вместе ехать и с собой
+      Взять также ящик боевой.
+      Готовы санки беговые.
+      Он сел, на мельницу летит.
+      Примчались. Он слуге велит
+      Лепажа стволы роковые
+      Нести за ним, а лошадям
+      Отъехать в поле к двум дубкам."
     fb.query('(exists bar)').each(&:to_s)
     fb.query('(not (exists bar))').delete!
     [
-      'Inserted new fact',
+      'Inserted new fact #1',
+      'Inserted new fact #2',
       'Set \'bar\' to 3 (Integer)',
+      'Set \'str\' to "Он поскорей звонит. Вбегает\n      К нем...м\n      Отъехать в поле к двум дубкам." (String)',
       'Found 1 fact(s) by \'(exists bar)\'',
-      'Deleted 2 fact(s) by \'(not (exists bar))\''
+      'Deleted 3 fact(s) by \'(not (exists bar))\''
     ].each do |s|
       assert(log.to_s.include?("#{s}\n"), "#{log}\n")
     end

data/test/factbase/test_query.rb

@@ -60,6 +60,10 @@ class TestQuery < Minitest::Test
       '(eq (size hello) 0)' => 3,
       '(eq num pi)' => 0,
       '(absent time)' => 2,
+      '(max num)' => 1,
+      '(and (exists time) (max num))' => 0,
+      '(and (exists pi) (max num))' => 1,
+      '(min time)' => 1,
       '(and (absent time) (exists pi))' => 1,
       "(and (exists time) (not (\t\texists pi)))" => 1,
       "(or (eq num 66) (lt time #{(Time.now - 200).utc.iso8601}))" => 1

data/test/factbase/test_syntax.rb

@@ -106,9 +106,21 @@ class TestSyntax < Minitest::Test
       ')',
       '"'
     ].each do |q|
-      assert_raises(q) do
-        Factbase::Syntax.new(q).to_term
-      end
+      assert(
+        assert_raises(q) do
+          Factbase::Syntax.new(q).to_term
+        end.message.include?(q)
+      )
+    end
+  end
+
+  def test_simplification
+    {
+      '(foo)' => '(foo)',
+      '(and (foo) (foo))' => '(foo)',
+      '(and (foo) (or (and (eq a 1))) (eq a 1) (foo))' => '(and (foo) (eq a 1))'
+    }.each do |s, t|
+      assert_equal(t, Factbase::Syntax.new(s).to_term.to_s)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factbase
 version: !ruby/object:Gem::Version
-  version: 0.0.29
+  version: 0.0.31
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-21 00:00:00.000000000 Z
+date: 2024-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -78,6 +78,7 @@ files:
 - ".gitattributes"
 - ".github/workflows/actionlint.yml"
 - ".github/workflows/codecov.yml"
+- ".github/workflows/license.yml"
 - ".github/workflows/markdown-lint.yml"
 - ".github/workflows/pdd.yml"
 - ".github/workflows/rake.yml"