fbe 0.19.2 → 0.19.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2d7532cc824357975d405225601f1f0873721e96b5328a9cd4e1d57191008a9
-  data.tar.gz: 1c64cade131c3f2751c0dffaaa9bd157cdc4ff41a70b0acf5efe8a8f2788e08b
+  metadata.gz: df9755e6d4d7bf5ae3a716031216786929ddfcdf328a3f026b308e9bbfc93f92
+  data.tar.gz: ed1cfe9f9877a3e3e1b77f30f4b9c8ca525885306d100058d5397019ca1005e6
 SHA512:
-  metadata.gz: 742ec0b8b9970a86549a8292ad5390cb5dcdb4addbc4c45590f3ff10526a67d4038c65cc9534d818859558a0915efeeef30d165816cd24a9a12cda2ec83cc87e
-  data.tar.gz: 70eb53d6eb30817c735ef3ab2ea62e050106b616a8384a647106c0ef4b40e861deb62d6a3dfc43a32471157144c9225425e092e4a4df614e91679444c5219f64
+  metadata.gz: 3bfc015d2f0c47035fae903627404da6fafcd823c14abdcdc8a37694fea73bbb4edd1f1467497379fff51e62388b741a205b28bcd0ee8a4b5c28aceaf0f6c22c
+  data.tar.gz: dc92c946e0d1bd14deb3d29a73b36f9317d7e06597ac2ec4fc05030ed9afea415830a71f101eb54ddd2793a02a3c6b480d2a2b95482f3deb0d62903230b1432e

data/lib/fbe/middleware/sqlite_store.rb

@@ -21,9 +21,6 @@ class Fbe::Middleware::SqliteStore
     dir = File.dirname(path)
     raise ArgumentError, "Directory #{dir} does not exist" unless File.directory?(dir)
     @path = File.absolute_path(path)
-    open
-    prepare
-    at_exit { close }
   end
 
   def read(key)
@@ -37,9 +34,13 @@ class Fbe::Middleware::SqliteStore
   end
 
   def write(key, value)
+    return if value.is_a?(Array) && value.any? do |vv|
+      req = JSON.parse(vv[0])
+      req['url'].include?('?') || req['method'] != 'get'
+    end
     value = JSON.dump(value)
-    perform do |tdb|
-      tdb.execute(<<~SQL, [key, value])
+    perform do |t|
+      t.execute(<<~SQL, [key, value])
         INSERT INTO cache(key, value) VALUES(?1, ?2)
         ON CONFLICT(key) DO UPDATE SET value = ?2
       SQL
@@ -47,32 +48,10 @@ class Fbe::Middleware::SqliteStore
     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
@@ -80,6 +59,14 @@ class Fbe::Middleware::SqliteStore
   private
 
   def perform(&)
+    @db ||=
+      SQLite3::Database.new(@path).tap do |d|
+        d.transaction do |t|
+          t.execute 'CREATE TABLE IF NOT EXISTS cache(key TEXT UNIQUE NOT NULL, value TEXT);'
+          t.execute 'CREATE INDEX IF NOT EXISTS key_idx ON cache(key);'
+        end
+        at_exit { @db&.close }
+      end
     @db.transaction(&)
   end
 end

data/lib/fbe/octo.rb

@@ -76,16 +76,24 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
               methods: [:get],
               backoff_factor: 2
             )
-            serializer = Marshal
             if options.sqlite_cache
               store = Fbe::Middleware::SqliteStore.new(options.sqlite_cache)
-              serializer = JSON
-              loog.info("Using HTTP cache in SQLite file: #{store.path}")
+              loog.info(
+                "Using HTTP cache in SQLite file: #{store.path} (" \
+                "#{File.exist?(store.path) ? "#{File.size(store.path)} bytes" : 'file is absent'}" \
+                ')'
+              )
+              builder.use(
+                Faraday::HttpCache,
+                store:, serializer: JSON, shared_cache: false, logger: Loog::NULL
+              )
+            else
+              loog.info("No HTTP cache in SQLite file, because 'sqlite_cache' option is not provided")
+              builder.use(
+                Faraday::HttpCache,
+                serializer: Marshal, shared_cache: false, logger: Loog::NULL
+              )
             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.19.2' unless const_defined?(:VERSION)
+  VERSION = '0.19.3' unless const_defined?(:VERSION)
 end

data/test/fbe/middleware/test_sqlite_store.rb

@@ -3,6 +3,7 @@
 # SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
 # SPDX-License-Identifier: MIT
 
+require 'qbash'
 require_relative '../../test__helper'
 require_relative '../../../lib/fbe/middleware'
 require_relative '../../../lib/fbe/middleware/sqlite_store'
@@ -12,24 +13,107 @@ require_relative '../../../lib/fbe/middleware/sqlite_store'
 # 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'))
+  def test_simple_caching_algorithm
+    with_tmpfile('x.db') do |f|
+      store = Fbe::Middleware::SqliteStore.new(f)
+      k = 'some-key'
+      assert_nil(store.read(k))
+      assert_nil(store.delete(k))
+      v1 = 'first value to save'
+      assert_nil(store.write(k, v1))
+      assert_equal(v1, store.read(k))
+      v2 = 'another value to save'
+      assert_nil(store.write(k, v2))
+      assert_equal(v2, store.read(k))
+      assert_nil(store.delete(k))
+      assert_nil(store.read(k))
+      assert_path_exists(f)
     end
   end
 
-  def test_sqlite_store_empty_all
-    Dir.mktmpdir do |dir|
-      store = Fbe::Middleware::SqliteStore.new(File.expand_path('test.db', dir))
+  def test_returns_empty_list
+    with_tmpfile('b.db') do |f|
+      store = Fbe::Middleware::SqliteStore.new(f)
+      assert_empty(store.all)
+    end
+  end
+
+  def test_clear_all_keys
+    with_tmpfile('a.db') do |f|
+      store = Fbe::Middleware::SqliteStore.new(f)
+      k = 'a key'
+      store.write(k, 'some value')
+      store.clear
+      assert_empty(store.all)
+    end
+  end
+
+  def test_empty_all_if_not_written
+    with_tmpfile do |f|
+      store = Fbe::Middleware::SqliteStore.new(f)
       assert_empty(store.all)
     end
   end
+
+  def test_wrong_db_path
+    assert_raises(ArgumentError) do
+      Fbe::Middleware::SqliteStore.new(nil).read('my_key')
+    end
+    assert_raises(ArgumentError) do
+      Fbe::Middleware::SqliteStore.new('').read('my_key')
+    end
+    assert_raises(ArgumentError) do
+      Fbe::Middleware::SqliteStore.new('/fakepath/fakefolder/test.db').read('my_key')
+    end
+  end
+
+  def test_not_db_file
+    with_tmpfile do |f|
+      File.binwrite(f, Array.new(20) { rand(0..255) }.pack('C*'))
+      ex =
+        assert_raises(SQLite3::NotADatabaseException) do
+          Fbe::Middleware::SqliteStore.new(f).read('my_key')
+        end
+      assert_match('file is not a database', ex.message)
+    end
+  end
+
+  def test_defer_db_close_callback
+    txt = <<~RUBY
+      require 'tempfile'
+      require 'sqlite3'
+      require 'fbe/middleware/sqlite_store'
+
+      SQLite3::Database.class_eval do
+        prepend(Module.new do
+          def close
+            super
+            puts 'closed sqlite after process exit'
+          end
+        end)
+      end
+
+      Tempfile.open('test.db') do |f|
+        Fbe::Middleware::SqliteStore.new(f.path).then do |s|
+          s.write('my_key', 'my_value')
+          s.read('my_key')
+        end
+      end
+    RUBY
+    out =
+      qbash(
+        'bundle exec ruby ' \
+        "-I#{Shellwords.escape(File.expand_path('../../../lib', __dir__))} " \
+        "-e #{Shellwords.escape(txt)} 2>&1"
+      )
+    assert_match('closed sqlite after process exit', out)
+  end
+
+  private
+
+  def with_tmpfile(name = 'test.db', &)
+    Dir.mktmpdir do |dir|
+      yield File.expand_path(name, dir)
+    end
+  end
 end

data/test/fbe/test_octo.rb

@@ -256,7 +256,10 @@ class TestOcto < Fbe::Test
   end
 
   def test_reads_quota
-    WebMock.enable_net_connect!
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://api.github.com/rate_limit').to_return(
+      { body: '{}', headers: { 'X-RateLimit-Remaining' => '222' } }
+    )
     o = Fbe.octo(loog: Loog::VERBOSE, global: {}, options: Judges::Options.new({ 'github_api_pause' => 0.01 }))
     refute_nil(o.off_quota?)
   end
@@ -365,7 +368,7 @@ class TestOcto < Fbe::Test
     assert_includes second_output, 'GitHub API trace is empty'
   end
 
-  def test_sqlite_store
+  def test_works_via_sqlite_store
     WebMock.disable_net_connect!
     Dir.mktmpdir do |dir|
       global = {}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fbe
 version: !ruby/object:Gem::Version
-  version: 0.19.2
+  version: 0.19.3
 platform: ruby
 authors:
 - Yegor Bugayenko