fbe 0.30.0 → 0.31.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d28d22ca3024f7acbd6630b903aeaaf5391e2debb3cd7dbab920c664473f1567
-  data.tar.gz: 955bd9e464b2450eeeee67c9cbcc222687c00a1bb6bc5d9b5e37539d7b43700b
+  metadata.gz: 5ed41fbbf01d78ba6023ca93c5956fc9c37bb32624fd0ff1e589deed34b5c5dd
+  data.tar.gz: 34495a35e25f5a6241080c4fca1a6c7d78728e66fe809f989dbadfbcebae2f8f
 SHA512:
-  metadata.gz: 87935f90c30759d39a960e0c44c717bf7cd6080114aa538546b3970efdec95449a3e749fbe6b575cf064cbd536f133a694d1ba11a9e608cf6fc43c058ec85867
-  data.tar.gz: e1b306dfdb743aac0efaaa41fbaa73aeb327cdeae33a254046211eb98608c876e7ae351800dde5ff72a74741774985cad53c264a51d24d8cfa12cb570d044189
+  metadata.gz: 2178c31a1bce0a392b717a8429036cf6018325a77714f68f25dd2d8bdb5bbaf8e822cb358a26d7a47a18cb894b00e9ea99040685a9c1f317f6bbcda0501edc6b
+  data.tar.gz: ca9db41e2ed0f7fcc618c9bce81d5720e3c3b820a54e74ff16661eccd6e111117f78a307358bcef7163527ea64adfa92f326112de9581b1d47934c80cd2f0a10

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.
@@ -186,7 +199,11 @@ class Fbe::Conclude
     oct = Fbe.octo(loog: @loog, options: @options, global: @global)
     @fb.query(@query).each do |a|
       if @quota_aware && oct.off_quota?
-        @loog.debug('We ran out of GitHub quota, must stop here')
+        @loog.info('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

data/lib/fbe/fb.rb

@@ -44,8 +44,12 @@ def Fbe.fb(fb: $fb, global: $global, options: $options, loog: $loog)
           max = fbt.query('(max _id)').one
           f._id = (max.nil? ? 0 : max) + 1
           f._time = Time.now
-          f._version = "#{Factbase::VERSION}/#{Judges::VERSION}/#{options.action_version}"
-          f._job = options.job_id unless options.job_id.nil?
+          f._version = [
+            Factbase::VERSION,
+            Judges::VERSION,
+            options.action_version
+          ].compact.join('/')
+          f._job = options.job_id.to_i if options.job_id
         end
       Factbase::Impatient.new(
         Factbase::Logged.new(

data/lib/fbe/iterate.rb

@@ -201,7 +201,7 @@ class Fbe::Iterate
     seen = {}
     oct = Fbe.octo(loog: @loog, options: @options, global: @global)
     if oct.off_quota?
-      @loog.debug('We are off GitHub quota, cannot even start, sorry')
+      @loog.info('We are off GitHub quota, cannot even start, sorry')
       return
     end
     repos = Fbe.unmask_repos(
@@ -234,7 +234,7 @@ class Fbe::Iterate
       end
       repos.each do |repo|
         if @quota_aware && oct.off_quota?
-          @loog.debug("We are off GitHub quota, we must skip #{repo}")
+          @loog.info("We are off GitHub quota, we must skip #{repo}")
           break
         end
         if Time.now - start > timeout

data/lib/fbe/octo.rb

@@ -164,7 +164,7 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
           def off_quota?(threshold: 50)
             left = @origin.rate_limit!.remaining
             if left < threshold
-              @loog.info("Too much GitHub API quota consumed already (#{left} < #{threshold}), stopping")
+              @loog.info("Too much GitHub API quota consumed already (#{left} < #{threshold})")
               true
             else
               @loog.debug("Still #{left} GitHub API quota left (>#{threshold})")
@@ -712,29 +712,40 @@ class Fbe::FakeOctokit
   #   client.pull_request('octocat/Hello-World', 1)
   #   # => {:id=>42, :number=>1, :additions=>12, ...}
   def pull_request(repo, number)
-    {
-      id: 42,
-      number:,
-      repo: {
-        full_name: repo
-      },
-      base: {
+    if number == 29
+      {
+        id: 42,
+        number:,
+        user: { id: 421, login: 'user' },
+        created_at: Time.parse('2024-08-20 15:35:30 UTC'),
+        additions: 12,
+        deletions: 5
+      }
+    else
+      {
+        id: 42,
+        number:,
         repo: {
           full_name: repo
-        }
-      },
-      state: 'closed',
-      user: { login: 'yegor256', id: 526_301, type: 'User' },
-      head: { ref: 'master', sha: '6dcb09b5b57875f334f61aebed695e2e4193db5e' },
-      additions: 12,
-      deletions: 5,
-      changed_files: 3,
-      comments: 2,
-      review_comments: 2,
-      closed_at: Time.parse('2024-12-20'),
-      merged_at: Time.parse('2024-12-20'),
-      created_at: Time.parse('2024-09-20')
-    }
+        },
+        base: {
+          repo: {
+            full_name: repo
+          }
+        },
+        state: 'closed',
+        user: { login: 'yegor256', id: 526_301, type: 'User' },
+        head: { ref: 'master', sha: '6dcb09b5b57875f334f61aebed695e2e4193db5e' },
+        additions: 12,
+        deletions: 5,
+        changed_files: 3,
+        comments: 2,
+        review_comments: 2,
+        closed_at: Time.parse('2024-12-20'),
+        merged_at: Time.parse('2024-12-20'),
+        created_at: Time.parse('2024-09-20')
+      }
+    end
   end
 
   # Lists pull requests for a repository.
@@ -831,6 +842,13 @@ class Fbe::FakeOctokit
     ]
   end
 
+  def pull_request_review_comments(_repo, _number, _review, _options = {})
+    [
+      { id: 22_447_120, user: { login: 'yegor256', id: 526_301, type: 'User' } },
+      { id: 22_447_121, user: { login: 'yegor256', id: 526_301, type: 'User' } }
+    ]
+  end
+
   def review_comments(_repo, _number)
     [
       {

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.1' 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.1
 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