fbe 0.16.1 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 011c5a07ab2d1b15194cd2950da1cd466698d37a9aa0bbd07225ce7bca335881
-  data.tar.gz: 1fa420cebbdc70897a4779601a5cc8e4596a9542a223e64e020086ff0ec10826
+  metadata.gz: 4a99af1e0cf0824c00460e0166b3b9882c40b49421989e94c5abcda5d1766042
+  data.tar.gz: e7963ae2eb4bdb52745a10dc5f4d240abf768549f1461098c93e7dc81986936a
 SHA512:
-  metadata.gz: 1790fa88d1d97b8509d61c85592c36ca5147e97e982015991fc15128315a210190505310cf1d53b618507b354e1b77b065bbc1cbfff4b8ffc771f50bea5778fa
-  data.tar.gz: 4bf95961acba3192c824e48054c8a36d7aa72184645305c8fcc6ef9e5926cd08c7f661353bc6244b8e789b1fb5ea2e4dcf8a089969267bc55b80fdf9b641b775
+  metadata.gz: 0f90f11a2f21822ab37f5b9300ee1dd35858f9ded52baed36404af1bc27d1ebf9880e720a08b0caff73e932fefad80716bddcdafb87f0e8b7c4c5b2f84014e6c
+  data.tar.gz: 01612e41f4b1d8432b55dff2a4ce3b77af9686a9f9b6b1e3c9ff099f10ec447ee1b7594bf9808297d3a799656f92909a2112f7234d6a603199bd5c2c154fe6a5

data/.gitignore

@@ -8,3 +8,4 @@ doc/
 node_modules/
 rdoc/
 vendor/
+.claude/

data/.rubocop.yml

@@ -14,6 +14,8 @@ plugins:
   - rubocop-minitest
   - rubocop-performance
   - rubocop-rake
+Minitest/MultipleAssertions:
+  Max: 10
 Minitest/EmptyLineBeforeAssertionMethods:
   Enabled: false
 Style/GlobalVars:
@@ -54,4 +56,3 @@ Metrics/ParameterLists:
   Enabled: false
 Layout/MultilineAssignmentLayout:
   Enabled: true
-require: []

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/Rakefile

@@ -16,7 +16,7 @@ def version
   Gem::Specification.load(Dir['*.gemspec'].first).version
 end
 
-task default: %i[clean test picks rubocop yard]
+task default: %i[clean test rubocop picks yard]
 
 require 'rake/testtask'
 desc 'Run all unit tests'

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/middleware/trace.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
+# SPDX-License-Identifier: MIT
+
+require 'faraday'
+require_relative '../../fbe'
+require_relative '../../fbe/middleware'
+
+# Faraday middleware that traces all API calls.
+#
+# This middleware records all HTTP requests and responses in a trace array,
+# capturing method, URL, status, and timing information for debugging and
+# monitoring purposes.
+#
+# @example Usage in Faraday middleware stack
+#   trace = []
+#   connection = Faraday.new do |f|
+#     f.use Fbe::Middleware::Trace, trace
+#   end
+#   connection.get('/api/endpoint')
+#   trace.first[:method] #=> :get
+#   trace.first[:url] #=> 'https://example.com/api/endpoint'
+#   trace.first[:status] #=> 200
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024-2025 Zerocracy
+# License:: MIT
+class Fbe::Middleware::Trace < Faraday::Middleware
+  # Initializes the trace middleware.
+  #
+  # @param [Object] app The next middleware in the stack
+  # @param [Array] trace The array to store trace entries
+  def initialize(app, trace)
+    super(app)
+    @trace = trace
+  end
+
+  # Processes the HTTP request and records trace information.
+  #
+  # @param [Faraday::Env] env The request environment
+  # @return [Faraday::Response] The response from the next middleware
+  def call(env)
+    started = Time.now
+    entry = {
+      method: env.method,
+      url: env.url.to_s,
+      started_at: started
+    }
+    @app.call(env).on_complete do |response_env|
+      finished = Time.now
+      entry[:status] = response_env.status
+      entry[:finished_at] = finished
+      entry[:duration] = finished - started
+      @trace << entry
+    end
+  end
+end

data/lib/fbe/octo.rb

@@ -3,16 +3,20 @@
 # SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
 # SPDX-License-Identifier: MIT
 
+require 'json'
 require 'decoor'
 require 'faraday/http_cache'
 require 'faraday/retry'
 require 'loog'
 require 'obk'
 require 'octokit'
+require 'uri'
 require 'verbose'
 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.
 #
@@ -30,6 +34,7 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
   raise 'The $loog is not set' if loog.nil?
   global[:octo] ||=
     begin
+      trace = []
       if options.testing.nil?
         o = Octokit::Client.new
         token = options.github_token
@@ -50,8 +55,10 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
           loog.warn('The GitHub API token is an empty string, won\'t use it')
         else
           o = Octokit::Client.new(access_token: token)
-          loog.info("Accessing GitHub API with a token (#{token.length} chars, ending by #{token[-4..].inspect}, " \
-                    "#{Octokit::Client.new(access_token: token).rate_limit.remaining} quota remaining)")
+          loog.info(
+            "Accessing GitHub API with a token (#{token.length} chars, ending by #{token[-4..].inspect}, " \
+            "#{Octokit::Client.new(access_token: token).rate_limit.remaining} quota remaining)"
+          )
         end
         o.auto_paginate = true
         o.per_page = 100
@@ -73,9 +80,18 @@ 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)
             builder.adapter(Faraday.default_adapter)
           end
         o.middleware = stack
@@ -84,7 +100,25 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
         loog.debug('The connection to GitHub API is mocked')
         o = Fbe::FakeOctokit.new
       end
-      decoor(o, loog:) do
+      decoor(o, loog:, trace:) do
+        def print_trace!
+          if @trace.empty?
+            @loog.debug('GitHub API trace is empty')
+          else
+            grouped =
+              @trace.group_by do |entry|
+                uri = URI.parse(entry[:url])
+                "#{uri.scheme}://#{uri.host}#{uri.path}"
+              end
+            message = grouped
+              .sort_by { |_path, entries| -entries.count }
+              .map { |path, entries| "  #{path}: #{entries.count}" }
+              .join("\n")
+            @loog.info("GitHub API trace (#{grouped.count} URLs vs #{@trace.count} requests):\n#{message}")
+            @trace.clear
+          end
+        end
+
         def off_quota(threshold: 50)
           left = @origin.rate_limit.remaining
           if left < threshold

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.16.1' 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/middleware/test_trace.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
+# SPDX-License-Identifier: MIT
+
+require 'faraday'
+require 'webmock'
+require_relative '../../test__helper'
+require_relative '../../../lib/fbe'
+require_relative '../../../lib/fbe/middleware'
+require_relative '../../../lib/fbe/middleware/trace'
+
+# Test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024-2025 Zerocracy
+# License:: MIT
+class TraceTest < Fbe::Test
+  def test_traces_successful_request
+    trace = []
+    stub_request(:get, 'http://example.com/test')
+      .to_return(status: 200, body: 'success')
+    conn =
+      Faraday.new do |f|
+        f.use Fbe::Middleware::Trace, trace
+        f.adapter :net_http
+      end
+    conn.get('http://example.com/test')
+    assert_equal 1, trace.size
+    entry = trace.first
+    assert_equal :get, entry[:method]
+    assert_equal 'http://example.com/test', entry[:url]
+    assert_equal 200, entry[:status]
+    assert_instance_of Time, entry[:started_at]
+    assert_instance_of Time, entry[:finished_at]
+    assert_instance_of Float, entry[:duration]
+    assert_operator entry[:duration], :>=, 0
+    assert_operator entry[:finished_at], :>=, entry[:started_at]
+  end
+
+  def test_traces_multiple_requests
+    trace = []
+    stub_request(:get, 'http://example.com/endpoint1').to_return(status: 200)
+    stub_request(:post, 'http://example.com/endpoint2').to_return(status: 201)
+    stub_request(:delete, 'http://example.com/endpoint3').to_return(status: 404)
+    conn =
+      Faraday.new do |f|
+        f.use Fbe::Middleware::Trace, trace
+        f.adapter :net_http
+      end
+    conn.get('http://example.com/endpoint1')
+    conn.post('http://example.com/endpoint2')
+    conn.delete('http://example.com/endpoint3')
+    assert_equal 3, trace.size
+    assert_equal :get, trace[0][:method]
+    assert_equal 200, trace[0][:status]
+    assert_equal :post, trace[1][:method]
+    assert_equal 201, trace[1][:status]
+    assert_equal :delete, trace[2][:method]
+    assert_equal 404, trace[2][:status]
+  end
+
+  def test_traces_error_responses
+    trace = []
+    stub_request(:get, 'http://example.com/error').to_return(status: 500, body: 'error')
+    conn =
+      Faraday.new do |f|
+        f.use Fbe::Middleware::Trace, trace
+        f.adapter :net_http
+      end
+    conn.get('http://example.com/error')
+    assert_equal 1, trace.size
+    entry = trace.first
+    assert_equal 500, entry[:status]
+    assert_equal 'http://example.com/error', entry[:url]
+  end
+
+  def test_handles_connection_errors
+    trace = []
+    stub_request(:get, 'http://example.com/timeout').to_timeout
+    conn =
+      Faraday.new do |f|
+        f.use Fbe::Middleware::Trace, trace
+        f.adapter :net_http
+      end
+    assert_raises(Faraday::ConnectionFailed) do
+      conn.get('http://example.com/timeout')
+    end
+    assert_equal 0, trace.size
+  end
+
+  def test_preserves_request_with_query_params
+    trace = []
+    stub_request(:get, 'http://example.com/search').with(query: { 'q' => 'test', 'page' => '2' }).to_return(status: 200)
+    conn =
+      Faraday.new do |f|
+        f.use Fbe::Middleware::Trace, trace
+        f.adapter :net_http
+      end
+    conn.get('http://example.com/search?q=test&page=2')
+    assert_equal 1, trace.size
+    url = trace.first[:url]
+    assert url.start_with?('http://example.com/search?')
+    assert_includes url, 'q=test'
+    assert_includes url, 'page=2'
+  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

@@ -322,4 +322,72 @@ class TestOcto < Fbe::Test
       }
     end
   end
+
+  def test_print_trace
+    loog = Loog::Buffer.new
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://api.github.com/user/123').to_return(
+      status: 200,
+      body: '{"id":123,"login":"test"}'
+    )
+    stub_request(:get, 'https://api.github.com/repos/foo/bar').to_return(
+      status: 200,
+      body: '{"id":456,"full_name":"foo/bar"}'
+    )
+    octo = Fbe.octo(loog:, global: {}, options: Judges::Options.new)
+    octo.user(123)
+    octo.repository('foo/bar')
+    octo.repository('foo/bar')
+    octo.print_trace!
+    output = loog.to_s
+    assert_includes output, 'GitHub API trace (2 URLs vs 3 requests)'
+    assert_includes output, 'https://api.github.com/user/123: 1'
+    assert_includes output, 'https://api.github.com/repos/foo/bar: 2'
+    repo_index = output.index('https://api.github.com/repos/foo/bar: 2')
+    user_index = output.index('https://api.github.com/user/123: 1')
+    assert_operator repo_index, :<, user_index, 'URLs should be sorted by request count (highest first)'
+  end
+
+  def test_trace_gets_cleared_after_print
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://api.github.com/user/456').to_return(
+      status: 200,
+      body: '{"id":456,"login":"testuser"}'
+    )
+    first_loog = Loog::Buffer.new
+    octo = Fbe.octo(loog: first_loog, global: {}, options: Judges::Options.new)
+    octo.user(456)
+    octo.print_trace!
+    first_output = first_loog.to_s
+    assert_includes first_output, 'GitHub API trace'
+    second_loog = Loog::Buffer.new
+    octo.instance_variable_set(:@loog, second_loog)
+    octo.print_trace!
+    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.16.1
+  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,8 @@ 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
 - lib/fbe/pmp.rb
@@ -318,6 +334,8 @@ 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
 - test/fbe/test_conclude.rb