fbe 0.0.42 → 0.0.43

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '095a45978ce9e57eae04c5d10dc974071b3400dfe5f3fe0ce5da88acf87d6fd1'
-  data.tar.gz: 63e430609dab7392f310b9772f35a427d8ec8799717da1a7fb70c4552d92a44c
+  metadata.gz: '081da62424351c5ee65fc8a949e74f16326905f3a0748d89ba47d13ee2a5e5df'
+  data.tar.gz: fd71a1f8d8fd721c992a46f16269357c7e784aac172b1909f09e97436190d971
 SHA512:
-  metadata.gz: 223d399f84eb5a6290b4c0e13d0e04124a6ebd449964ce60b439942b73e6fda71db43ddead097b0a8ca15adea0e37bf9e6d5938a281d602ba3333fd4634bcdda
-  data.tar.gz: 405c244aa9637bda9fb035051248c54edf9c6eba6008f4c371e435a34ab5e80c7d93b4796e55650335714b30062cbf66b211acb7bdf48a8270fbeb5fd0c29ae7
+  metadata.gz: 5752ff7c46fba04d57d6357209827994c45d693d9447a951ba6118dd56d9d2b96774bd141316ae9d17e1552ba98476be7ef1b8edb70538cf43ac6d80887b7e97
+  data.tar.gz: 0a8a030cfd4781ef70841db89a6e4db6114e83083ae111e5d80fc51093795ba1251f400b5cb0cf795db3f15baef105079101d74213d68637801127e15cda912e

data/lib/fbe/middleware/quota.rb

@@ -26,13 +26,20 @@ require 'faraday'
 
 # Faraday Middleware that monitors GitHub API rate limits.
 class Fbe::Middleware::Quota < Faraday::Middleware
-  def initialize(app, logger: Loog::NULL, pause: 60, limit: 100, rate: 5)
+  def initialize(app, loog: Loog::NULL, pause: 60, limit: 100, rate: 5)
     super(app)
-    @limit = limit
     @requests = 0
     @app = app
-    @logger = logger
+    raise 'The "loog" cannot be nil' if loog.nil?
+    @loog = loog
+    raise 'The "pause" cannot be nil' if pause.nil?
+    raise 'The "pause" must be a positive integer' unless pause.positive?
     @pause = pause
+    raise 'The "limit" cannot be nil' if limit.nil?
+    raise 'The "limit" must be a positive integer' unless limit.positive?
+    @limit = limit
+    raise 'The "rate" cannot be nil' if rate.nil?
+    raise 'The "rate" must be a positive integer' unless rate.positive?
     @rate = rate
   end
 
@@ -40,7 +47,7 @@ class Fbe::Middleware::Quota < Faraday::Middleware
     @requests += 1
     response = @app.call(env)
     if out_of_limit?(env)
-      @logger.info(
+      @loog.info(
         "Too much GitHub API quota consumed, pausing for #{@pause} seconds"
       )
       sleep(@pause)

data/lib/fbe/octo.rb

@@ -33,6 +33,15 @@ require_relative '../fbe'
 require_relative 'middleware'
 require_relative 'middleware/quota'
 
+# Interface to GitHub API.
+#
+# It is supposed to be used instead of Octokit client, because it
+# is pre-configured and enables additional fearues, such as retrying,
+# logging, and caching.
+#
+# @param [Judges::Options] options The options available globally
+# @param [Hash] global Hash of global options
+# @param [Loog] loog Logging facility
 def Fbe.octo(options: $options, global: $global, loog: $loog)
   raise 'The $global is not set' if global.nil?
   global[:octo] ||=
@@ -79,11 +88,7 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
               methods: [:get],
               backoff_factor: 2
             )
-            builder.use(
-              Fbe::Middleware::Quota,
-              logger: loog,
-              pause: options.github_api_pause
-            )
+            builder.use(Fbe::Middleware::Quota, loog:, pause: options.github_api_pause || 60)
             builder.use(Faraday::HttpCache, serializer: Marshal, shared_cache: false, logger: Loog::NULL)
             builder.use(Octokit::Response::RaiseError)
             builder.use(Faraday::Response::Logger, Loog::NULL)

data/lib/fbe/overwrite.rb

@@ -38,11 +38,12 @@ require_relative 'fb'
 # @param [String] property The name of the property to set
 # @param [Any] vqlue The value to set
 def Fbe.overwrite(fact, property, value, fb: Fbe.fb)
+  raise 'The fact is nil' if fact.nil?
   before = {}
   fact.all_properties.each do |prop|
     before[prop.to_s] = fact[prop]
   end
-  id = fact['_id'].first
+  id = fact['_id']&.first
   raise 'There is no _id in the fact, cannot use Fbe.overwrite' if id.nil?
   raise "No facts by _id = #{id}" if fb.query("(eq _id #{id})").delete!.zero?
   n = fb.insert

data/lib/fbe.rb

@@ -27,5 +27,5 @@
 # License:: MIT
 module Fbe
   # Current version of the gem (changed by .rultor.yml on every release)
-  VERSION = '0.0.42'
+  VERSION = '0.0.43'
 end

data/test/fbe/middleware/test_quota.rb

@@ -45,9 +45,9 @@ class QuotaTest < Minitest::Test
 
   def test_quota_middleware_pauses_when_quota_low
     loog = Loog::NULL
-    pause = 0
+    pause = 1
     app = FakeApp.new
-    middleware = Fbe::Middleware::Quota.new(app, logger: loog, pause:)
+    middleware = Fbe::Middleware::Quota.new(app, loog:, pause:)
     start_time = Time.now
     105.times do
       env = Judges::Options.new(
@@ -66,7 +66,7 @@ class QuotaTest < Minitest::Test
     log_output = StringIO.new
     loog = Logger.new(log_output)
     app = FakeApp.new
-    middleware = Fbe::Middleware::Quota.new(app, logger: loog, pause:)
+    middleware = Fbe::Middleware::Quota.new(app, loog:, pause:)
     105.times do
       env = Judges::Options.new(
         'method' => :get,

data/test/fbe/test_overwrite.rb

@@ -54,6 +54,14 @@ class TestOverwrite < Minitest::Test
     assert_equal(42, fb.query('(always)').each.to_a.first['foo'].first)
   end
 
+  def test_without_id
+    fb = Factbase.new
+    f = fb.insert
+    assert_raises do
+      Fbe.overwrite(f, :foo, 42, fb:)
+    end
+  end
+
   def test_safe_insert
     fb = Factbase.new
     f1 = fb.insert

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fbe
 version: !ruby/object:Gem::Version
-  version: 0.0.42
+  version: 0.0.43
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-07 00:00:00.000000000 Z
+date: 2024-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace