fbe 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f70d456f08cfacd13990d45fd62834c1856260dd096583909fe4aa2b113f080
-  data.tar.gz: edd2a32689116bf7ae2940458f2e77cf6d33027097e3a01985af685d78f666b4
+  metadata.gz: 4a99af1e0cf0824c00460e0166b3b9882c40b49421989e94c5abcda5d1766042
+  data.tar.gz: e7963ae2eb4bdb52745a10dc5f4d240abf768549f1461098c93e7dc81986936a
 SHA512:
-  metadata.gz: 5a5371878121330954776a6fc2d7cc32ef4207afd7c6e73b8ac4399c6af222abbfda3afd7d2636eadb7bf3f305984ed547d755666e02d38d3a54c0479c289e15
-  data.tar.gz: 76cf0627e9c1bd78b9ad1e348ff5c6fce2f0c9e8374d2a0b09ae93c1b4faa27b240446f30abb1fb7821bcf5c18b5bd118b7f54d3615843773ebe3b1edcbca4c8
+  metadata.gz: 0f90f11a2f21822ab37f5b9300ee1dd35858f9ded52baed36404af1bc27d1ebf9880e720a08b0caff73e932fefad80716bddcdafb87f0e8b7c4c5b2f84014e6c
+  data.tar.gz: 01612e41f4b1d8432b55dff2a4ce3b77af9686a9f9b6b1e3c9ff099f10ec447ee1b7594bf9808297d3a799656f92909a2112f7234d6a603199bd5c2c154fe6a5

data/Gemfile.lock

@@ -17,6 +17,7 @@ PATH
       obk (> 0)
       octokit (~> 10.0)
       others (> 0)
+      sqlite3 (~> 2.6)
       tago (> 0)
       verbose (> 0)
 
@@ -217,6 +218,10 @@ GEM
       simplecov (~> 0.19)
     simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
+    sqlite3 (2.6.0-arm64-darwin)
+    sqlite3 (2.6.0-x64-mingw-ucrt)
+    sqlite3 (2.6.0-x86_64-darwin)
+    sqlite3 (2.6.0-x86_64-linux-gnu)
     strscan (3.1.5)
     tago (0.1.0)
     timeout (0.4.3)

data/fbe.gemspec

@@ -37,6 +37,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'obk', '>0'
   s.add_dependency 'octokit', '~>10.0'
   s.add_dependency 'others', '>0'
+  s.add_dependency 'sqlite3', '~> 2.6'
   s.add_dependency 'tago', '>0'
   s.add_dependency 'verbose', '>0'
   s.metadata['rubygems_mfa_required'] = 'true'

data/lib/fbe/middleware/sqlite_store.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
+# SPDX-License-Identifier: MIT
+
+require 'json'
+require 'sqlite3'
+require_relative '../../fbe'
+require_relative '../../fbe/middleware'
+
+# Persisted SQLite store for Faraday::HttpCache
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024-2025 Zerocracy
+# License:: MIT
+class Fbe::Middleware::SqliteStore
+  def initialize(path)
+    raise ArgumentError, 'Database path cannot be nil or empty' if path.nil? || path.empty?
+    dir = File.dirname(path)
+    raise ArgumentError, "Directory #{dir} does not exist" unless File.directory?(dir)
+    @path = path
+    open
+    prepare
+    at_exit { close }
+  end
+
+  def read(key)
+    value = perform { _1.execute('SELECT value FROM cache WHERE key = ? LIMIT 1', [key]) }.dig(0, 0)
+    JSON.parse(value) if value
+  end
+
+  def delete(key)
+    perform { _1.execute('DELETE FROM cache WHERE key = ?', [key]) }
+    nil
+  end
+
+  def write(key, value)
+    value = JSON.dump(value)
+    perform do |tdb|
+      tdb.execute(<<~SQL, [key, value])
+        INSERT INTO cache(key, value) VALUES(?1, ?2)
+        ON CONFLICT(key) DO UPDATE SET value = ?2
+      SQL
+    end
+    nil
+  end
+
+  def open
+    return if @db
+    @db = SQLite3::Database.new(@path)
+  end
+
+  def prepare
+    perform do |tdb|
+      tdb.execute 'CREATE TABLE IF NOT EXISTS cache(key TEXT UNIQUE NOT NULL, value TEXT);'
+      tdb.execute 'CREATE INDEX IF NOT EXISTS key_idx ON cache(key);'
+    end
+  end
+
+  def close
+    return if !@db || @db.closed?
+    @db.close
+    @db = nil
+  end
+
+  def clear
+    perform { _1.execute 'DELETE FROM cache;' }
+  end
+
+  def drop
+    perform { _1.execute 'DROP TABLE IF EXISTS cache;' }
+  end
+
+  def all
+    perform { _1.execute('SELECT key, value FROM cache') }
+  end
+
+  private
+
+  def perform(&)
+    @db.transaction(&)
+  end
+end

data/lib/fbe/octo.rb

@@ -3,6 +3,7 @@
 # SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
 # SPDX-License-Identifier: MIT
 
+require 'json'
 require 'decoor'
 require 'faraday/http_cache'
 require 'faraday/retry'
@@ -15,6 +16,7 @@ require_relative '../fbe'
 require_relative 'middleware'
 require_relative 'middleware/formatter'
 require_relative 'middleware/trace'
+require_relative 'middleware/sqlite_store'
 
 # Makes a call to the GitHub API.
 #
@@ -78,7 +80,15 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
               methods: [:get],
               backoff_factor: 2
             )
-            builder.use(Faraday::HttpCache, serializer: Marshal, shared_cache: false, logger: Loog::NULL)
+            serializer = Marshal
+            if options.sqlite_cache
+              store = Fbe::Middleware::SqliteStore.new(options.sqlite_cache)
+              serializer = JSON
+            end
+            builder.use(
+              Faraday::HttpCache,
+              store: store, serializer: serializer, shared_cache: false, logger: Loog::NULL
+            )
             builder.use(Octokit::Response::RaiseError)
             builder.use(Faraday::Response::Logger, loog, formatter: Fbe::Middleware::Formatter)
             builder.use(Fbe::Middleware::Trace, trace)

data/lib/fbe.rb

@@ -10,5 +10,5 @@
 # License:: MIT
 module Fbe
   # Current version of the gem (changed by +.rultor.yml+ on every release)
-  VERSION = '0.17.0' unless const_defined?(:VERSION)
+  VERSION = '0.18.0' unless const_defined?(:VERSION)
 end

data/test/fbe/middleware/test_sqlite_store.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
+# SPDX-License-Identifier: MIT
+
+require_relative '../../test__helper'
+require_relative '../../../lib/fbe/middleware'
+require_relative '../../../lib/fbe/middleware/sqlite_store'
+
+# Test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024-2025 Zerocracy
+# License:: MIT
+class SqliteStoreTest < Fbe::Test
+  def test_sqlite_store
+    Dir.mktmpdir do |dir|
+      store = Fbe::Middleware::SqliteStore.new(File.expand_path('test.db', dir))
+      assert_nil(store.read('my_key'))
+      assert_nil(store.delete('my_key'))
+      assert_nil(store.write('my_key', 'some value'))
+      assert_equal('some value', store.read('my_key'))
+      assert_nil(store.write('my_key', 'some value 2'))
+      assert_equal('some value 2', store.read('my_key'))
+      assert_nil(store.delete('my_key'))
+      assert_nil(store.read('my_key'))
+    end
+  end
+
+  def test_sqlite_store_empty_all
+    Dir.mktmpdir do |dir|
+      store = Fbe::Middleware::SqliteStore.new(File.expand_path('test.db', dir))
+      assert_empty(store.all)
+    end
+  end
+end

data/test/fbe/test_fb.rb

@@ -27,6 +27,28 @@ class TestFb < Fbe::Test
     assert_includes(stdout, 'Inserted new fact #1', stdout)
   end
 
+  def test_defends_against_improper_facts
+    $fb = Factbase.new
+    $global = {}
+    $options = Judges::Options.new
+    $loog = Loog::Buffer.new
+    assert_raises(StandardError, 'issue without repository') do
+      Fbe.fb.txn do |fbt|
+        f = fbt.insert
+        f.what = 'issue-was-opened'
+        f.issue = 42
+        f.where = 'github'
+      end
+    end
+    assert_raises(StandardError, 'repository without where') do
+      Fbe.fb.txn do |fbt|
+        f = fbt.insert
+        f.what = 'issue-was-opened'
+        f.repository = 44
+      end
+    end
+  end
+
   def test_increment_id_in_transaction
     $fb = Factbase.new
     $global = {}

data/test/fbe/test_octo.rb

@@ -366,4 +366,28 @@ class TestOcto < Fbe::Test
     second_output = second_loog.to_s
     assert_includes second_output, 'GitHub API trace is empty'
   end
+
+  def test_sqlite_store
+    WebMock.disable_net_connect!
+    Dir.mktmpdir do |dir|
+      global = {}
+      sqlite_cache = File.expand_path('test.db', dir)
+      o = Fbe.octo(loog: Loog::NULL, global:, options: Judges::Options.new({ 'sqlite_cache' => sqlite_cache }))
+      stub = stub_request(:get, 'https://api.github.com/user/42').to_return(
+        status: 200,
+        body: { login: 'user1' }.to_json,
+        headers: {
+          'Content-Type' => 'application/json',
+          'Cache-Control' => 'public, max-age=60, s-maxage=60',
+          'Etag' => 'W/"2ff9dd4c3153f006830b2b8b721f6a4bb400a1eb81a2e1fa0a3b846ad349b9ec"',
+          'Last-Modified' => 'Wed, 01 May 2025 20:00:00 GMT'
+        }
+      )
+      assert_equal('user1', o.user_name_by_id(42))
+      WebMock.remove_request_stub(stub)
+      global = {}
+      o = Fbe.octo(loog: Loog::NULL, global:, options: Judges::Options.new({ 'sqlite_cache' => sqlite_cache }))
+      assert_equal('user1', o.user_name_by_id(42))
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fbe
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -219,6 +219,20 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: tago
   requirement: !ruby/object:Gem::Requirement
@@ -307,6 +321,7 @@ files:
 - lib/fbe/just_one.rb
 - lib/fbe/middleware.rb
 - lib/fbe/middleware/formatter.rb
+- lib/fbe/middleware/sqlite_store.rb
 - lib/fbe/middleware/trace.rb
 - lib/fbe/octo.rb
 - lib/fbe/overwrite.rb
@@ -319,6 +334,7 @@ files:
 - renovate.json
 - rules/basic.fe
 - test/fbe/middleware/test_formatter.rb
+- test/fbe/middleware/test_sqlite_store.rb
 - test/fbe/middleware/test_trace.rb
 - test/fbe/test_award.rb
 - test/fbe/test_bylaws.rb