fbe 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af8e39332315cd637642316ea61761792955d43688813b75339b112b58747900
-  data.tar.gz: 6a2fa9d6c135c1ec2500872ace2bba09d00a89fe87c1af6435e54e880f361df4
+  metadata.gz: 485d65ab1a72472bc118062f665516e8092e0f35b6b566acf567cad26259944c
+  data.tar.gz: c558708f7897da86b6c2133154cfb5861aa6fd1aeef8686eb109290de43b7b03
 SHA512:
-  metadata.gz: 94a48b37c3d821a8c609e99accfc1fb350b1e317f2cb27c7d351a8a472ff1565edec77d4a3bd2a1d39c758c8e6faa71e5706a1a30fe0364bceffd25144466642
-  data.tar.gz: 8073b49266007c50ae6989ffb1b006fbcddce056cb042be19f5ca39c4e99ad97b58ad77c598d51102b51ef77b9545a4f86fd29cf0323edb7fee9920ff6e65227
+  metadata.gz: 684d4072dbe3ae3fc6043abbeddf6e0cce131948516df23a64b784777fa6a9a63e11e9eb09880116a4376be7d5292b2df983d472ae8d12bed00ea75c434a7c62
+  data.tar.gz: 56469e2fa299e1b411415b787b2edd3d19e75a7850a7a737dfb427505e8ec1c924a9e7935709d6bb05d13247e453eec25a5c5da84b7df15e9a5f4f29bf6f2dbf

data/Gemfile.lock

@@ -70,7 +70,7 @@ GEM
       tago (> 0)
     ethon (0.16.0)
       ffi (>= 1.15.0)
-    factbase (0.9.10)
+    factbase (0.10.0)
       backtrace (~> 0.4)
       decoor (~> 0.0)
       json (~> 2.7)
@@ -92,11 +92,11 @@ GEM
       net-http (>= 0.5.0)
     faraday-retry (2.3.1)
       faraday (~> 2.0)
-    ffi (1.17.1-arm64-darwin)
-    ffi (1.17.1-x64-mingw-ucrt)
-    ffi (1.17.1-x86_64-darwin)
-    ffi (1.17.1-x86_64-linux-gnu)
-    fiber-storage (1.0.0)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x64-mingw-ucrt)
+    ffi (1.17.2-x86_64-darwin)
+    ffi (1.17.2-x86_64-linux-gnu)
+    fiber-storage (1.0.1)
     gli (2.22.2)
       ostruct
     graphql (2.5.3)

data/assets/bylaws/code-contribution-was-rewarded.liquid

@@ -51,19 +51,6 @@
     (give bonus_for_comments "for too many (${comments}) comments that were made during review")
     "deduct ${comments_k} points for every comment made during review, but not more than ${comments_max} points")
 
-  (aka
-    (let few_comments_fee {{ 2 | times: anger }})
-    (let comments_needed {{ 3 | times: paranoia }})
-    (set penalty_for_few_comments (if (and (lt comments comments_needed) (not (eq comments 0))) (times -1 few_comments_fee) 0))
-    (give penalty_for_few_comments "for very few (${comments}) comments")
-    "deduct ${few_comments_fee} points if there were less than ${comments_needed} comments made during review")
-
-  (aka
-    (let silence_fee {{ 8 | times: anger }})
-    (set penalty_for_silence (if (eq comments 0) (times -1 silence_fee) 0))
-    (give penalty_for_silence "for absolutely no comments posted by reviewers")
-    "deduct ${silence_fee} points if there were absolutely no comments made by reviewers during the review")
-
   (aka
     (let few_hoc_fee {{ 4 | times: anger }})
     (let hoc_needed {{ 10 | times: paranoia }})

data/lib/fbe/conclude.rb

@@ -18,6 +18,11 @@ require_relative 'if_absent'
 # @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, &)
+  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:)
   c.instance_eval(&)
 end
@@ -160,21 +165,20 @@ class Fbe::Conclude
   def roll(&)
     passed = 0
     start = Time.now
-    catch :stop do
-      @fb.txn do |fbt|
-        fbt.query(@query).each do |a|
-          if @quota_aware && Fbe.octo(loog: @loog, options: @options, global: @global).off_quota
-            @loog.debug('We ran out of GitHub quota, must stop here')
-            throw :stop
-          end
-          if Time.now > start + @timeout
-            @loog.debug("We've spent more than #{start.ago}, must stop here")
-            throw :stop
-          end
-          n = yield fbt, a
-          @loog.info("#{n.what}: #{n.details}") unless n.nil?
-          passed += 1
+    oct = Fbe.octo(loog: @loog, options: @options, global: @global)
+    @fb.txn do |fbt|
+      fbt.query(@query).each do |a|
+        if @quota_aware && oct.off_quota
+          @loog.debug('We ran out of GitHub quota, must stop here')
+          throw :commit
         end
+        if Time.now > start + @timeout
+          @loog.debug("We've spent more than #{start.ago}, must stop here")
+          throw :commit
+        end
+        n = yield fbt, a
+        @loog.info("#{n.what}: #{n.details}") unless n.nil?
+        passed += 1
       end
     end
     @loog.debug("Found and processed #{passed} facts by: #{@query}")

data/lib/fbe/enter.rb

@@ -14,6 +14,10 @@ require_relative '../fbe'
 # @param [Loog] loog The logging facility
 # @return [String] Full name of the user
 def Fbe.enter(badge, why, options: $options, loog: $loog, &)
+  raise 'The badge is nil' if badge.nil?
+  raise 'The why is nil' if why.nil?
+  raise 'The $options is not set' if options.nil?
+  raise 'The $loog is not set' if loog.nil?
   return yield unless options.testing.nil?
   baza = BazaRb.new('api.zerocracy.com', 443, options.zerocracy_token, loog:)
   baza.enter(options.job_name, badge, why, options.job_id.to_i, &)

data/lib/fbe/fb.rb

@@ -26,6 +26,10 @@ require_relative '../fbe'
 # @param [Loog] loog The logging facility
 # @return [Factbase] The global factbase
 def Fbe.fb(fb: $fb, global: $global, options: $options, loog: $loog)
+  raise 'The fb is nil' if fb.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?
   global[:fb] ||=
     begin
       rules = Dir.glob(File.join('rules', '*.fe')).map { |f| File.read(f) }

data/lib/fbe/issue.rb

@@ -19,6 +19,10 @@ require_relative 'octo'
 # @param [Loog] loog The logging facility
 # @return [String] Textual representation of GitHub issue number
 def Fbe.issue(fact, options: $options, global: $global, loog: $loog)
+  raise 'The fact is nil' if fact.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?
   rid = fact['repository']
   raise "There is no 'repository' property" if rid.nil?
   rid = rid.first.to_i

data/lib/fbe/iterate.rb

@@ -18,6 +18,10 @@ require_relative 'unmask_repos'
 # @param [Loog] loog The logging facility
 # @yield [Factbase::Fact] The fact
 def Fbe.iterate(fb: Fbe.fb, loog: $loog, options: $options, global: $global, &)
+  raise 'The fb is nil' if fb.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::Iterate.new(fb:, loog:, options:, global:)
   c.instance_eval(&)
 end

data/lib/fbe/octo.rb

@@ -26,6 +26,8 @@ require_relative 'middleware/formatter'
 # @return [Hash] Usually returns a JSON, as it comes from the GitHub API
 def Fbe.octo(options: $options, global: $global, loog: $loog)
   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?
   global[:octo] ||=
     begin
       if options.testing.nil?
@@ -88,6 +90,7 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
             @loog.info("Too much GitHub API quota consumed already (#{left} < #{threshold}), stopping")
             true
           else
+            @loog.debug("Still #{left} GitHub API quota left (>#{threshold})")
             false
           end
         end
@@ -147,13 +150,14 @@ class Fbe::FakeOctokit
     true
   end
 
-  def user(name)
-    login = name
-    login = name == 526_301 ? 'yegor256' : 'torvalds' if login.is_a?(Integer)
+  # Get details of the user.
+  # @param [String|Integer] uid The login of the user or its ID
+  def user(uid)
+    login = (uid == 526_301 ? 'yegor256' : 'torvalds') if uid.is_a?(Integer)
     {
       id: 444,
       login:,
-      type: name == 29_139_614 ? 'Bot' : 'User'
+      type: uid == 29_139_614 ? 'Bot' : 'User'
     }
   end
 

data/lib/fbe/overwrite.rb

@@ -21,6 +21,7 @@ require_relative 'fb'
 # @return [Factbase::Fact] Returns new fact or previous one
 def Fbe.overwrite(fact, property, value, fb: Fbe.fb)
   raise 'The fact is nil' if fact.nil?
+  raise 'The fb is nil' if fb.nil?
   raise "The property is not a String but #{property.class} (#{property})" unless property.is_a?(String)
   return fact if !fact[property].nil? && fact[property].size == 1 && fact[property].first == value
   before = {}

data/lib/fbe/regularly.rb

@@ -16,6 +16,11 @@ require_relative 'fb'
 # @param [Loog] loog The logging facility
 # @return [nil] Nothing
 def Fbe.regularly(area, p_every_days, p_since_days = nil, fb: Fbe.fb, judge: $judge, loog: $loog, &)
+  raise 'The area is nil' if area.nil?
+  raise 'The p_every_days is nil' if p_every_days.nil?
+  raise 'The fb is nil' if fb.nil?
+  raise 'The $judge is not set' if judge.nil?
+  raise 'The $loog is not set' if loog.nil?
   pmp = fb.query("(and (eq what 'pmp') (eq area '#{area}') (exists #{p_every_days}))").each.to_a.first
   interval = pmp.nil? ? 7 : pmp[p_every_days].first
   unless fb.query(

data/lib/fbe/repeatedly.rb

@@ -16,6 +16,11 @@ require_relative 'overwrite'
 # @param [Loog] loog The logging facility
 # @return [nil] Nothing
 def Fbe.repeatedly(area, p_every_hours, fb: Fbe.fb, judge: $judge, loog: $loog, &)
+  raise 'The area is nil' if area.nil?
+  raise 'The p_every_hours is nil' if p_every_hours.nil?
+  raise 'The fb is nil' if fb.nil?
+  raise 'The $judge is not set' if judge.nil?
+  raise 'The $loog is not set' if loog.nil?
   pmp = fb.query("(and (eq what 'pmp') (eq area '#{area}') (exists #{p_every_hours}))").each.to_a.first
   hours = pmp.nil? ? 24 : pmp[p_every_hours].first
   unless fb.query(

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

data/test/fbe/test_bylaws.rb

@@ -61,7 +61,7 @@ class TestBylaws < Fbe::Test
         { hoc: 50, comments: 25, reviews: 0 } => 4,
         { hoc: 180, comments: 7, reviews: 2 } => 13,
         { hoc: 199, comments: 8, reviews: 3 } => 14,
-        { hoc: 150, comments: 5, reviews: 1 } => 8,
+        { hoc: 150, comments: 5, reviews: 1 } => 12,
         { hoc: 500, comments: 25, reviews: 2 } => 4,
         { hoc: 99, comments: 6, reviews: 1 } => 4,
         { hoc: 1_500, comments: 3, reviews: 0 } => 4,

data/test/fbe/test_conclude.rb

@@ -61,6 +61,38 @@ class TestConclude < Fbe::Test
     assert_equal(42, f.bar)
   end
 
+  def test_considers_until_quota
+    WebMock.disable_net_connect!
+    fb = Factbase.new
+    5.times do
+      fb.insert.foo = 1
+    end
+    options = Judges::Options.new
+    stub_request(:get, %r{https://api.github.com/users/.*}).to_return(
+      {
+        body: { id: rand(100) }.to_json,
+        headers: { 'Content-Type' => 'application/json', 'X-RateLimit-Remaining' => '999' }
+      },
+      {
+        body: { id: rand(100) }.to_json,
+        headers: { 'Content-Type' => 'application/json', 'X-RateLimit-Remaining' => '9' }
+      }
+    )
+    stub_request(:get, 'https://api.github.com/rate_limit').to_return(
+      body: 'hm...', headers: { 'X-RateLimit-Remaining' => '777' }
+    ).times(1)
+    global = {}
+    o = Fbe.octo(loog: Loog::NULL, options:, global:)
+    Fbe.conclude(fb:, judge: 'boom', loog: Loog::NULL, options:, global:) do
+      quota_aware
+      on '(exists foo)'
+      consider do |f|
+        f.bar = o.user("user-#{rand(100)}")[:id]
+      end
+    end
+    assert_equal(2, fb.query('(exists bar)').each.to_a.size)
+  end
+
   def test_ignores_globals
     $fb = nil
     $loog = nil

data/test/fbe/test_octo.rb

@@ -56,7 +56,7 @@ class TestOcto < Fbe::Test
     global = {}
     o = Fbe.octo(loog: Loog::NULL, global:, options: Judges::Options.new)
     stub_request(:get, 'https://api.github.com/users/yegor256')
-      .to_return(status: 200, body: '{}', headers: { 'Cache-Control' => 'public, max-age=60', 'etag' => 'abc' })
+      .to_return(body: '{}', headers: { 'Cache-Control' => 'public, max-age=60', 'etag' => 'abc' })
       .times(1)
       .then
       .to_raise('second request should be cached, not passed to GitHub API!')
@@ -64,12 +64,50 @@ class TestOcto < Fbe::Test
     o.user('yegor256')
   end
 
+  def test_rate_limit_remaining
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://api.github.com/rate_limit').to_return(
+      { body: '{}', headers: { 'X-RateLimit-Remaining' => '222' } }
+    )
+    stub_request(:get, 'https://api.github.com/user/42').to_return(
+      body: '', headers: { 'X-RateLimit-Remaining' => '4' }
+    )
+    o = Octokit::Client.new
+    assert_equal(222, o.rate_limit.remaining)
+    o.user(42)
+    assert_equal(4, o.rate_limit.remaining)
+    assert_equal(4, o.rate_limit.remaining)
+  end
+
   def test_off_quota
     WebMock.disable_net_connect!
-    stub_request(:get, 'https://api.github.com/rate_limit')
-      .to_return(status: 200, body: '{}', headers: { 'X-RateLimit-Remaining' => '1000' })
+    stub_request(:get, 'https://api.github.com/rate_limit').to_return(
+      body: '{}', headers: { 'X-RateLimit-Remaining' => '333' }
+    )
+    stub_request(:get, 'https://api.github.com/user/42').to_return(
+      body: '', headers: { 'X-RateLimit-Remaining' => '3' }
+    )
     o = Fbe.octo(loog: Loog::NULL, global: {}, options: Judges::Options.new)
     refute(o.off_quota)
+    o.user(42)
+    assert(o.off_quota)
+  end
+
+  def test_off_quota_twice
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://api.github.com/rate_limit').to_return(
+      body: '{}', headers: { 'X-RateLimit-Remaining' => '333' }
+    )
+    stub_request(:get, 'https://api.github.com/user/42').to_return(
+      { body: '', headers: { 'X-RateLimit-Remaining' => '5555' } },
+      { body: '', headers: { 'X-RateLimit-Remaining' => '5' } }
+    )
+    o = Fbe.octo(loog: Loog::VERBOSE, global: {}, options: Judges::Options.new)
+    refute(o.off_quota)
+    o.user(42)
+    refute(o.off_quota)
+    o.user(42)
+    assert(o.off_quota)
   end
 
   def test_retrying
@@ -80,7 +118,7 @@ class TestOcto < Fbe::Test
       .to_raise(Octokit::TooManyRequests.new)
       .times(1)
       .then
-      .to_return(status: 200, body: '{}')
+      .to_return(body: '{}')
     o.user('yegor256')
   end
 
@@ -92,7 +130,7 @@ class TestOcto < Fbe::Test
       .to_return(status: 503)
       .times(1)
       .then
-      .to_return(status: 200, body: '{}')
+      .to_return(body: '{}')
     o.user('yegor256')
   end
 
@@ -136,11 +174,11 @@ class TestOcto < Fbe::Test
     o = Fbe.octo(loog: Loog::NULL, global: {}, options: Judges::Options.new({ 'github_api_pause' => 0.01 }))
     stub_request(:get, 'https://api.github.com/users/foo')
       .to_return(
-        status: 200, body: '{}',
+        body: '{}',
         headers: { 'x-ratelimit-remaining' => '1' }
       )
       .to_return(
-        status: 200, body: '{}',
+        body: '{}',
         headers: { 'x-ratelimit-remaining' => '10000' }
       )
     o.user('foo')

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: fbe
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 bindir: bin
 cert_chain: []
-date: 2025-04-15 00:00:00.000000000 Z
+date: 2025-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace