fbe 0.30.0 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d28d22ca3024f7acbd6630b903aeaaf5391e2debb3cd7dbab920c664473f1567
-  data.tar.gz: 955bd9e464b2450eeeee67c9cbcc222687c00a1bb6bc5d9b5e37539d7b43700b
+  metadata.gz: 2621af2f5ed4213f7137482238a6c1fc2af0f534a88b196e277cdf17bb9d27de
+  data.tar.gz: 65bfa710cd5680c579207ea1ce650c25ed743b39b835ce1500cd1b62d7d57fd4
 SHA512:
-  metadata.gz: 87935f90c30759d39a960e0c44c717bf7cd6080114aa538546b3970efdec95449a3e749fbe6b575cf064cbd536f133a694d1ba11a9e608cf6fc43c058ec85867
-  data.tar.gz: e1b306dfdb743aac0efaaa41fbaa73aeb327cdeae33a254046211eb98608c876e7ae351800dde5ff72a74741774985cad53c264a51d24d8cfa12cb570d044189
+  metadata.gz: a0d04610b4d6bd1bf32587b73baade530e6b22aead4fffe69f0bd6067f254d4f0899701ed84bf8a38f2fc9798ab39708d71a05d0a9681d001da5d12e8c4d47e5
+  data.tar.gz: dc62b030009940330564967622a9e0c16f16bce715d0fcd9e00cb54a7e617a24bfd68e70409b98fcc7cfbcc70c1ff356286b4047530ebcf808fe2f20c68b1f55

data/fbe.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.authors = ['Yegor Bugayenko']
   s.email = 'yegor256@gmail.com'
   s.homepage = 'https://github.com/zerocracy/fbe'
-  s.files = `git ls-files`.split($RS)
+  s.files = `git ls-files | grep -v -E '^(test/|renovate|coverage)'`.split($RS)
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
   s.add_dependency 'backtrace', '~>0.4'

data/lib/fbe/conclude.rb

@@ -17,13 +17,16 @@ require_relative 'octo'
 # @param [Judges::Options] options The options coming from the +judges+ tool
 # @param [Loog] loog The logging facility
 # @yield [Factbase::Fact] The fact
-def Fbe.conclude(fb: Fbe.fb, judge: $judge, loog: $loog, options: $options, global: $global, time: Time, &)
+def Fbe.conclude(
+  fb: Fbe.fb, judge: $judge, loog: $loog, options: $options, global: $global,
+  start: $start, time: Time, &
+)
   raise 'The fb is nil' if fb.nil?
   raise 'The $judge is not set' if judge.nil?
   raise 'The $global is not set' if global.nil?
   raise 'The $options is not set' if options.nil?
   raise 'The $loog is not set' if loog.nil?
-  c = Fbe::Conclude.new(fb:, judge:, loog:, options:, global:, time:)
+  c = Fbe::Conclude.new(fb:, judge:, loog:, options:, global:, start:, time:)
   c.instance_eval(&)
 end
 
@@ -59,28 +62,38 @@ class Fbe::Conclude
   # @param [Judges::Options] options The options coming from the +judges+ tool
   # @param [Loog] loog The logging facility
   # @param [Time] time The time
-  def initialize(fb:, judge:, global:, options:, loog:, time: Time)
+  def initialize(fb:, judge:, global:, options:, loog:, start:, time: Time)
     @fb = fb
     @judge = judge
     @loog = loog
     @options = options
     @global = global
+    @start = start
     @query = nil
     @follows = []
-    @quota_aware = false
+    @lifetime_aware = true
+    @quota_aware = true
     @timeout = 60
     @time = time
   end
 
-  # Make this block aware of GitHub API quota.
+  # Make this block not aware of GitHub API quota.
   #
-  # When the quota is reached, the loop will gracefully stop to avoid
-  # hitting GitHub API rate limits. This helps prevent interruptions
-  # in long-running operations.
+  # When the quota is reached, the loop will NOT gracefully stop to avoid
+  # hitting GitHub API rate limits.
   #
   # @return [nil] Nothing is returned
-  def quota_aware
-    @quota_aware = true
+  def quota_unaware
+    @quota_aware = false
+  end
+
+  # Make this block NOT aware of lifetime limitations.
+  #
+  # When the lifetime is over, the loop will NOT gracefully stop.
+  #
+  # @return [nil] Nothing is returned
+  def lifetime_aware
+    @lifetime_aware = false
   end
 
   # Make sure this block runs for less than allowed amount of seconds.
@@ -189,6 +202,10 @@ class Fbe::Conclude
         @loog.debug('We ran out of GitHub quota, must stop here')
         break
       end
+      if @lifetime_aware && @options.lifetime && Time.now - @start > @options.lifetime - 10
+        @loog.debug('We ran out of lifetime, must stop here')
+        break
+      end
       now = @time.now
       if now > start + @timeout
         @loog.debug("We've spent more than #{start.ago}, must stop here")

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.30.0' unless const_defined?(:VERSION)
+  VERSION = '0.31.0' unless const_defined?(:VERSION)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fbe
 version: !ruby/object:Gem::Version
-  version: 0.30.0
+  version: 0.31.0
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -391,37 +391,7 @@ files:
 - lib/fbe/tombstone.rb
 - lib/fbe/unmask_repos.rb
 - lib/fbe/who.rb
-- renovate.json
 - rules/basic.fe
-- test/fbe/middleware/test_formatter.rb
-- test/fbe/middleware/test_rate_limit.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
-- test/fbe/test_copy.rb
-- test/fbe/test_delete.rb
-- test/fbe/test_delete_one.rb
-- test/fbe/test_enter.rb
-- test/fbe/test_fb.rb
-- test/fbe/test_github_graph.rb
-- test/fbe/test_if_absent.rb
-- test/fbe/test_issue.rb
-- test/fbe/test_iterate.rb
-- test/fbe/test_just_one.rb
-- test/fbe/test_kill_if.rb
-- test/fbe/test_octo.rb
-- test/fbe/test_overwrite.rb
-- test/fbe/test_pmp.rb
-- test/fbe/test_regularly.rb
-- test/fbe/test_repeatedly.rb
-- test/fbe/test_sec.rb
-- test/fbe/test_tombstone.rb
-- test/fbe/test_unmask_repos.rb
-- test/fbe/test_who.rb
-- test/test__helper.rb
-- test/test_fbe.rb
 homepage: https://github.com/zerocracy/fbe
 licenses:
 - MIT

data/renovate.json

@@ -1,6 +0,0 @@
-{
-  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-  "extends": [
-    "config:base"
-  ]
-}

data/test/fbe/middleware/test_formatter.rb

@@ -1,104 +0,0 @@
-# frozen_string_literal: true
-
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
-# SPDX-License-Identifier: MIT
-
-require 'faraday'
-require 'loog'
-require 'securerandom'
-require_relative '../../../lib/fbe'
-require_relative '../../../lib/fbe/middleware'
-require_relative '../../../lib/fbe/middleware/formatter'
-require_relative '../../test__helper'
-
-# Test.
-# Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2024-2025 Zerocracy
-# License:: MIT
-class LoggingFormatterTest < Fbe::Test
-  def test_success_response
-    log_it(status: 200) do |loog|
-      assert_empty(loog.to_s)
-    end
-  end
-
-  def test_forward_response
-    log_it(status: 303) do |loog|
-      assert_empty(loog.to_s)
-    end
-  end
-
-  def test_error_response
-    log_it(status: 401) do |loog|
-      str = loog.to_s
-      refute_empty(str)
-      [
-        %r{http://example.com},
-        /Authorization:/,
-        %r{HTTP/1.1 401},
-        /x-github-api-version-selected: "2022-11-28"/,
-        /hello, world!/,
-        /request body/
-      ].each { |ptn| assert_match(ptn, str) }
-    end
-  end
-
-  def test_limit_response
-    log_it(status: 403) do |loog|
-      str = loog.to_s
-      refute_empty(str)
-    end
-  end
-
-  def test_truncate_body_for_error_text_response
-    body = SecureRandom.alphanumeric(120)
-    log_it(
-      status: 502,
-      response_body: body,
-      response_headers: {
-        'content-type' => 'text/html; charset=utf-8',
-        'x-github-api-version-selected' => '2022-11-28'
-      }
-    ) do |loog|
-      str = loog.to_s
-      refute_empty(str)
-      [
-        %r{http://example.com},
-        /Authorization:/,
-        /some request body/,
-        %r{HTTP/1.1 502},
-        /x-github-api-version-selected: "2022-11-28"/,
-        %r{content-type: "text/html; charset=utf-8"},
-        "#{body.slice(0, 97)}..."
-      ].each { |ptn| assert_match(ptn, str) }
-    end
-  end
-
-  private
-
-  def log_it(
-    status:,
-    method: :get,
-    response_body: '{"message": "hello, world!"}',
-    response_headers: { 'content-type' => 'application/json', 'x-github-api-version-selected' => '2022-11-28' }
-  )
-    loog = Loog::Buffer.new
-    formatter = Fbe::Middleware::Formatter.new(logger: loog, options: {})
-    formatter.request(
-      Faraday::Env.from(
-        {
-          method:,
-          request_body: 'some request body',
-          url: URI('http://example.com'),
-          request_headers: {
-            'Authorization' => 'Bearer github_pat_11AAsecret'
-          }
-        }
-      )
-    )
-    formatter.response(
-      Faraday::Env.from({ status:, response_body:, response_headers: })
-    )
-    yield loog
-  end
-end

data/test/fbe/middleware/test_rate_limit.rb

@@ -1,152 +0,0 @@
-# frozen_string_literal: true
-
-# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
-# SPDX-License-Identifier: MIT
-
-require 'faraday'
-require 'webmock'
-require_relative '../../../lib/fbe'
-require_relative '../../../lib/fbe/middleware'
-require_relative '../../../lib/fbe/middleware/rate_limit'
-require_relative '../../test__helper'
-
-# Test.
-# Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2024-2025 Zerocracy
-# License:: MIT
-class RateLimitTest < Fbe::Test
-  def test_caches_rate_limit_response_on_first_call
-    rate_limit_response = {
-      'rate' => {
-        'limit' => 5000,
-        'remaining' => 4999,
-        'reset' => 1_672_531_200
-      }
-    }
-    stub_request(:get, 'https://api.github.com/rate_limit')
-      .to_return(status: 200, body: rate_limit_response.to_json, headers: { 'Content-Type' => 'application/json' })
-    conn = create_connection
-    response = conn.get('/rate_limit')
-    assert_equal 200, response.status
-    assert_equal 4999, response.body['rate']['remaining']
-  end
-
-  def test_returns_cached_response_on_subsequent_calls
-    rate_limit_response = {
-      'rate' => {
-        'limit' => 5000,
-        'remaining' => 4999,
-        'reset' => 1_672_531_200
-      }
-    }
-    stub_request(:get, 'https://api.github.com/rate_limit')
-      .to_return(status: 200, body: rate_limit_response.to_json, headers: { 'Content-Type' => 'application/json' })
-      .times(1)
-    conn = create_connection
-    conn.get('/rate_limit')
-    response = conn.get('/rate_limit')
-    assert_equal 200, response.status
-    assert_equal 4999, response.body['rate']['remaining']
-    assert_requested :get, 'https://api.github.com/rate_limit', times: 1
-  end
-
-  def test_decrements_remaining_count_for_non_rate_limit_requests
-    rate_limit_response = {
-      'rate' => {
-        'limit' => 5000,
-        'remaining' => 4999,
-        'reset' => 1_672_531_200
-      }
-    }
-    stub_request(:get, 'https://api.github.com/rate_limit')
-      .to_return(status: 200, body: rate_limit_response.to_json, headers: { 'Content-Type' => 'application/json',
-                                                                            'X-RateLimit-Remaining' => '4999' })
-    stub_request(:get, 'https://api.github.com/user')
-      .to_return(status: 200, body: '{"login": "test"}', headers: { 'Content-Type' => 'application/json' })
-    conn = create_connection
-    conn.get('/rate_limit')
-    conn.get('/user')
-    response = conn.get('/rate_limit')
-    assert_equal 4998, response.body['rate']['remaining']
-    assert_equal '4998', response.headers['x-ratelimit-remaining']
-  end
-
-  def test_refreshes_cache_after_hundred_requests
-    rate_limit_response = {
-      'rate' => {
-        'limit' => 5000,
-        'remaining' => 4999,
-        'reset' => 1_672_531_200
-      }
-    }
-    refreshed_response = {
-      'rate' => {
-        'limit' => 5000,
-        'remaining' => 4950,
-        'reset' => 1_672_531_200
-      }
-    }
-    stub_request(:get, 'https://api.github.com/rate_limit')
-      .to_return(status: 200, body: rate_limit_response.to_json, headers: { 'Content-Type' => 'application/json' })
-      .then
-      .to_return(status: 200, body: refreshed_response.to_json, headers: { 'Content-Type' => 'application/json' })
-    stub_request(:get, 'https://api.github.com/user')
-      .to_return(status: 200, body: '{"login": "test"}', headers: { 'Content-Type' => 'application/json' })
-      .times(100)
-    conn = create_connection
-    conn.get('/rate_limit')
-    100.times { conn.get('/user') }
-    response = conn.get('/rate_limit')
-    assert_equal 4950, response.body['rate']['remaining']
-    assert_requested :get, 'https://api.github.com/rate_limit', times: 2
-  end
-
-  def test_handles_response_without_rate_data
-    stub_request(:get, 'https://api.github.com/rate_limit')
-      .to_return(status: 200, body: '{}', headers: { 'Content-Type' => 'application/json' })
-    conn = create_connection
-    response = conn.get('/rate_limit')
-    assert_equal 200, response.status
-    assert_empty(response.body)
-  end
-
-  def test_ignores_non_hash_response_body
-    stub_request(:get, 'https://api.github.com/rate_limit')
-      .to_return(status: 200, body: 'invalid json', headers: { 'Content-Type' => 'text/plain' })
-    conn = create_connection
-    response = conn.get('/rate_limit')
-    assert_equal 200, response.status
-    assert_equal 'invalid json', response.body
-  end
-
-  def test_handles_zero_remaining_count
-    rate_limit_response = {
-      'rate' => {
-        'limit' => 5000,
-        'remaining' => 1,
-        'reset' => 1_672_531_200
-      }
-    }
-    stub_request(:get, 'https://api.github.com/rate_limit')
-      .to_return(status: 200, body: rate_limit_response.to_json, headers: { 'Content-Type' => 'application/json' })
-    stub_request(:get, 'https://api.github.com/user')
-      .to_return(status: 200, body: '{"login": "test"}', headers: { 'Content-Type' => 'application/json' })
-      .times(2)
-    conn = create_connection
-    conn.get('/rate_limit')
-    conn.get('/user')
-    conn.get('/user')
-    response = conn.get('/rate_limit')
-    assert_equal 0, response.body['rate']['remaining']
-  end
-
-  private
-
-  def create_connection
-    Faraday.new(url: 'https://api.github.com') do |f|
-      f.use Fbe::Middleware::RateLimit
-      f.response :json
-      f.adapter :net_http
-    end
-  end
-end