fbe 0.0.76 → 0.0.78

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7d74bb1725292686a566e35d5de70e48ef024c5730238cd4ab70bc17376662d
-  data.tar.gz: 94f38ca547e653eaae7f133ba8d61ee44db2ef31ea71bdcfccd39b12fe26571f
+  metadata.gz: 8be7701ad73edc6322026cac63ded7eec6c24d32d49db8687639d6794eb07aa6
+  data.tar.gz: b70c04b466d25b1c9dcf90f5fb4d6d781c13a5f511aba1568b4acf3f64d5ebd8
 SHA512:
-  metadata.gz: 418f6b9751ed8251fb8981b59f03957501b6ae0625dea457aecec2cb8913025e08ff45252c65b0ce896ea1c5774c244efeb5c309a2c2662738e5b9a6414a7592
-  data.tar.gz: 143e8bf09239a7985a27d89907daa2b9bfb0b912f81d890e95343fcae960cc80997ae77a3203e0fe2fac2f551a56fbaffd10787f36e5607db457d147fa064cde
+  metadata.gz: 5c6562c2e9d0c0b01e3a533df5fa4c93f0775543f6c6c46c5830bade030015055fd96dc1ee34424204a3147c5560a1312df624aab029ba9629fbc9a71c726c23
+  data.tar.gz: bb2e16aea231b2de20d5e938011916c89aef6c5fe03ea4acd0b1a17317dafc68a9ef9b0a9ec860acb1fd7d170dd65cad018e46b8b87a1af7b42d8f409299b949

data/.github/workflows/rake.yml

@@ -31,7 +31,7 @@ jobs:
     name: test
     strategy:
       matrix:
-        os: [ubuntu-20.04, macos-12, windows-2022]
+        os: [ubuntu-22.04, macos-12]
         ruby: [3.2]
     runs-on: ${{ matrix.os }}
     steps:

data/Gemfile.lock

@@ -2,21 +2,22 @@ PATH
   remote: .
   specs:
     fbe (0.0.0)
-      backtrace (> 0)
-      decoor (> 0)
-      factbase (> 0)
-      faraday (> 0)
-      faraday-http-cache (> 0)
-      faraday-multipart (> 0)
-      faraday-retry (> 0)
-      graphql-client (> 0)
-      judges (> 0)
+      backtrace (~> 0)
+      baza.rb (~> 0)
+      decoor (~> 0)
+      factbase (~> 0)
+      faraday (~> 2)
+      faraday-http-cache (~> 2)
+      faraday-multipart (~> 1)
+      faraday-retry (~> 2)
+      graphql-client (~> 0)
+      judges (~> 0)
       liquid (= 5.5.1)
-      loog (> 0)
-      obk (> 0)
-      octokit (> 0)
-      others (> 0)
-      verbose (> 0)
+      loog (~> 0)
+      obk (~> 0)
+      octokit (~> 9)
+      others (~> 0)
+      verbose (~> 0)
 
 GEM
   remote: https://rubygems.org/
@@ -55,7 +56,7 @@ GEM
     ast (2.4.2)
     backtrace (0.4.0)
     base64 (0.2.0)
-    baza.rb (0.0.8)
+    baza.rb (0.0.9)
       backtrace (> 0)
       elapsed (> 0)
       faraday (> 0)
@@ -112,7 +113,7 @@ GEM
     ffi (1.17.0-x86_64-linux-gnu)
     fiber-storage (1.0.0)
     gli (2.21.5)
-    graphql (2.3.16)
+    graphql (2.3.18)
       base64
       fiber-storage
     graphql-client (0.23.0)
@@ -122,25 +123,25 @@ GEM
     i18n (1.14.6)
       concurrent-ruby (~> 1.0)
     io-console (0.7.2)
-    irb (1.14.0)
+    irb (1.14.1)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
     iri (0.8.0)
     json (2.7.2)
-    judges (0.26.1)
-      backtrace (> 0)
-      baza.rb (> 0)
+    judges (0.27.0)
+      backtrace (~> 0)
+      baza.rb (~> 0)
       concurrent-ruby (~> 1.2)
-      elapsed (> 0)
-      factbase (> 0)
+      elapsed (~> 0)
+      factbase (~> 0)
       gli (~> 2.21)
-      iri (> 0)
-      loog (> 0)
+      iri (~> 0)
+      loog (~> 0)
       moments (~> 0.3)
       nokogiri (~> 1.10)
-      others (> 0)
-      retries (> 0)
-      tago (> 0)
+      others (~> 0)
+      retries (~> 0)
+      tago (~> 0)
       typhoeus (~> 1.3)
     language_server-protocol (3.17.0.3)
     liquid (5.5.1)
@@ -180,7 +181,7 @@ GEM
       stringio
     public_suffix (6.0.1)
     racc (1.8.1)
-    rack (3.1.7)
+    rack (3.1.8)
     rack-session (2.0.0)
       rack (>= 3.0.0)
     rack-test (2.1.0)
@@ -217,7 +218,7 @@ GEM
     rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.1)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-rails (7.0.1)
@@ -280,7 +281,7 @@ GEM
     webrick (1.8.2)
     yaml (0.3.0)
     yard (0.9.37)
-    zeitwerk (2.6.18)
+    zeitwerk (2.7.0)
 
 PLATFORMS
   arm64-darwin-22

data/fbe.gemspec

@@ -39,20 +39,21 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split($RS)
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
-  s.add_dependency 'backtrace', '>0'
-  s.add_dependency 'decoor', '>0'
-  s.add_dependency 'factbase', '>0'
-  s.add_dependency 'faraday', '>0'
-  s.add_dependency 'faraday-http-cache', '>0'
-  s.add_dependency 'faraday-multipart', '>0'
-  s.add_dependency 'faraday-retry', '>0'
-  s.add_dependency 'graphql-client', '>0'
-  s.add_dependency 'judges', '>0'
+  s.add_dependency 'backtrace', '~>0'
+  s.add_dependency 'baza.rb', '~>0'
+  s.add_dependency 'decoor', '~>0'
+  s.add_dependency 'factbase', '~>0'
+  s.add_dependency 'faraday', '~>2'
+  s.add_dependency 'faraday-http-cache', '~>2'
+  s.add_dependency 'faraday-multipart', '~>1'
+  s.add_dependency 'faraday-retry', '~>2'
+  s.add_dependency 'graphql-client', '~>0'
+  s.add_dependency 'judges', '~>0'
   s.add_dependency 'liquid', '5.5.1'
-  s.add_dependency 'loog', '>0'
-  s.add_dependency 'obk', '>0'
-  s.add_dependency 'octokit', '>0'
-  s.add_dependency 'others', '>0'
-  s.add_dependency 'verbose', '>0'
+  s.add_dependency 'loog', '~>0'
+  s.add_dependency 'obk', '~>0'
+  s.add_dependency 'octokit', '~>9'
+  s.add_dependency 'others', '~>0'
+  s.add_dependency 'verbose', '~>0'
   s.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/fbe/bylaws.rb

@@ -25,17 +25,21 @@
 require 'liquid'
 require_relative '../fbe'
 
-# A generator of policies/bylaws.
+# Generates policies/bylaws.
 #
-# Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2024 Yegor Bugayenko
-# License:: MIT
+# Using the templates stored in the +assets/bylaws+ directory, this function
+# creates a hash, where keys are names and values are formulas of bylaws.
+#
+# @param [Integer] anger How strict must be the bylaws, giving punishments
+# @param [Integer] love How big should be the volume of rewards
+# @param [Integer] paranoia How much should be required to reward love
+# @return [Hash<String, String>] Names of bylaws and their formulas
 def Fbe.bylaws(anger: 2, love: 2, paranoia: 2)
-  raise 'The "anger" must be in the [0..4] interval' unless !anger.negative? && anger < 5
-  raise 'The "lover" must be in the [0..4] interval' unless !love.negative? && love < 5
-  raise 'The "paranoia" must be in the [1..4] interval' unless paranoia.positive? && paranoia < 5
+  raise "The 'anger' must be in the [0..4] interval: #{anger.inspect}" unless !anger.negative? && anger < 5
+  raise "The 'love' must be in the [0..4] interval: #{love.inspect}" unless !love.negative? && love < 5
+  raise "The 'paranoia' must be in the [1..4] interval: #{paranoia.inspect}" unless paranoia.positive? && paranoia < 5
   home = File.join(__dir__, '../../assets/bylaws')
-  raise "The directory with templates is absent '#{home}'" unless File.exist?(home)
+  raise "The directory with templates is absent #{home.inspect}" unless File.exist?(home)
   Dir[File.join(home, '*.liquid')].to_h do |f|
     formula = Liquid::Template.parse(File.read(f)).render(
       'anger' => anger, 'love' => love, 'paranoia' => paranoia

data/lib/fbe/conclude.rb

@@ -27,19 +27,39 @@ require_relative 'fb'
 require_relative 'octo'
 require_relative 'if_absent'
 
-# Create a conclude code block.
+# Creates an instance of {Fbe::Conclude} and evals it with the block provided.
 #
 # @param [Factbase] fb The factbase
 # @param [String] judge The name of the judge, from the +judges+ tool
 # @param [Hash] global The hash for global caching
 # @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, &)
   c = Fbe::Conclude.new(fb:, judge:, loog:, options:, global:)
   c.instance_eval(&)
 end
 
-# Conclude.
+# A concluding block.
+#
+# You may want to use this class when you want to go through a number
+# of facts in the factbase, applying certain algorithm to each of them
+# and possibly creating new facts from them.
+#
+# For example, you want to make a new +good+ fact for every +bad+ fact found:
+#
+#  require 'fbe/conclude'
+#  conclude do
+#    on '(exist bad)'
+#    follow 'when'
+#    draw on |n, b|
+#      n.good = 'yes!'
+#    end
+#  end
+#
+# This snippet will find all facts that have +bad+ property and then create
+# new facts, letting the block in the {Fbe::Conclude#draw} deal with them.
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Zerocracy
 # License:: MIT
@@ -62,19 +82,52 @@ class Fbe::Conclude
     @quota_aware = false
   end
 
+  # Make this block aware of GitHub API quota.
+  #
+  # When the quota is reached, the loop will gracefully stop.
+  #
+  # @return [nil] Nothing
   def quota_aware
     @quota_aware = true
   end
 
+  # Set the query that should find the facts in the factbase.
+  #
+  # @param [String] query The query
+  # @return [nil] Nothing
   def on(query)
     raise 'Query is already set' unless @query.nil?
     @query = query
   end
 
+  # Set the list of properties to copy from the facts found to new facts.
+  #
+  # @param [Arra<String>] props List of property names
+  # @return [nil] Nothing
   def follow(props)
-    @follows = props.split
+    @follows = props.strip.split.compact
   end
 
+  # Create new fact from every fact found by the query.
+  #
+  # For example, you want to conclude a +reward+ from every +win+ fact:
+  #
+  #  require 'fbe/conclude'
+  #  conclude do
+  #    on '(exist win)'
+  #    follow 'win when'
+  #    draw on |n, w|
+  #      n.reward = 10
+  #    end
+  #  end
+  #
+  # This snippet will find all facts that have +win+ property and will create
+  # new facts for all of them, passing them one by one in to the block of
+  # the +draw+, where +n+ would be the new created fact and the +w+ would
+  # be the fact found.
+  #
+  # @yield [Array<Factbase::Fact,Factbase::Fact>] New fact and seen fact
+  # @return [Integer] The count of the facts processed
   def draw(&)
     roll do |fbt, a|
       n = fbt.insert
@@ -83,14 +136,20 @@ class Fbe::Conclude
     end
   end
 
-  def maybe(&)
-    roll do |fbt, a|
-      Fbe.if_absent(fb: fbt) do |n|
-        fill(n, a, &)
-      end
-    end
-  end
-
+  # Take every fact, allowing the given block to process it.
+  #
+  # For example, you want to add +when+ property to every fact:
+  #
+  #  require 'fbe/conclude'
+  #  conclude do
+  #    on '(always)'
+  #    consider on |f|
+  #      f.when = Time.new
+  #    end
+  #  end
+  #
+  # @yield [Factbase::Fact] The next fact found by the query
+  # @return [Integer] The count of the facts processed
   def consider(&)
     roll do |_fbt, a|
       yield a
@@ -100,6 +159,8 @@ class Fbe::Conclude
 
   private
 
+  # @yield [Factbase::Fact] The next fact found by the query
+  # @return [Integer] The count of the facts seen
   def roll(&)
     passed = 0
     catch :stop do
@@ -113,6 +174,7 @@ class Fbe::Conclude
       end
     end
     @loog.debug("Found and processed #{passed} facts by: #{@query}")
+    passed
   end
 
   def fill(fact, prev)

data/lib/fbe/copy.rb

@@ -25,20 +25,27 @@
 require_relative '../fbe'
 require_relative 'fb'
 
-# Make a copy of a fact, moving all properties to a new fact.
+# Makes a copy of a fact, moving all properties to a new fact.
+#
+# All properties from the +source+ will be copied to the +target+, except those
+# listed in the +except+.
 #
 # @param [Factbase::Fact] source The source
 # @param [Factbase::Fact] target The targer
 # @param [Array<String>] except List of properties to NOT copy
+# @return [Integer] How many properties were copied
 def Fbe.copy(source, target, except: [])
   raise 'The source is nil' if source.nil?
   raise 'The target is nil' if target.nil?
   raise 'The except is nil' if except.nil?
+  copied = 0
   source.all_properties.each do |k|
     next unless target[k].nil?
     next if except.include?(k)
     source[k].each do |v|
       target.send(:"#{k}=", v)
+      copied += 1
     end
   end
+  copied
 end

data/lib/fbe/enter.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# MIT License
+#
+# Copyright (c) 2024 Zerocracy
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'baza-rb'
+require_relative '../fbe'
+
+# Enter a new valve.
+#
+# @param [String] badge Unique badge of the valve
+# @param [String] why The reason
+# @param [Judges::Options] options The options coming from the +judges+ tool
+# @param [Loog] loog The logging facility
+# @return [String] Full name of the user
+def Fbe.enter(badge, why, options: $options, loog: $loog, &)
+  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, &)
+end

data/lib/fbe/fb.rb

@@ -32,10 +32,15 @@ require_relative '../fbe'
 
 # Returns an instance of +Factbase+ (cached).
 #
+# Instead of using +$fb+ directly, it is recommended to use this utility
+# method. It will not only return the global factbase, but will also
+# make sure it's properly decorated and cached.
+#
 # @param [Factbase] fb The global factbase provided by the +judges+ tool
 # @param [Hash] global The hash for global caching
 # @param [Judges::Options] options The options coming from the +judges+ tool
 # @param [Loog] loog The logging facility
+# @return [Factbase] The global factbase
 def Fbe.fb(fb: $fb, global: $global, options: $options, loog: $loog)
   global[:fb] ||=
     begin

data/lib/fbe/github_graph.rb

@@ -22,15 +22,16 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require 'loog'
 require 'graphql/client'
 require 'graphql/client/http'
+require 'loog'
 
-# Interface to GitHub GraphQL API.
+# Creates an instance of {Fbe::Graph}.
 #
 # @param [Judges::Options] options The options available globally
 # @param [Hash] global Hash of global options
 # @param [Loog] loog Logging facility
+# @return [Fbe::Graph] The instance of the class
 def Fbe.github_graph(options: $options, global: $global, loog: $loog)
   global[:github_graph] ||=
     if options.testing.nil?
@@ -41,7 +42,11 @@ def Fbe.github_graph(options: $options, global: $global, loog: $loog)
     end
 end
 
-# The GitHub GraphQL client
+# A client to GitHub GraphQL.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Zerocracy
+# License:: MIT
 class Fbe::Graph
   def initialize(token:, host: 'api.github.com')
     @token = token

data/lib/fbe/if_absent.rb

@@ -22,13 +22,33 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require 'time'
 require 'others'
+require 'time'
 require_relative '../fbe'
 require_relative 'fb'
 
 # Injects a fact if it's absent in the factbase, otherwise (it is already
 # there) returns NIL.
+#
+# Here is what you do when you want to add a fact to the factbase, but
+# don't want to make a duplicate of an existing one:
+#
+#  require 'fbe/if_absent'
+#  n =
+#   Fbe.if_absent do |f|
+#     f.what = 'something'
+#     f.details = 'important'
+#   end
+#  return if n.nil?
+#  n.when = Time.now
+#
+# This code will definitely create one fact with +what+ equals to +something+
+# and +details+ equals to +important+, while the +when+ will be equal to the
+# time of its first creation.
+#
+# @param [Factbase] fb The global factbase
+# @yield [Factbase::Fact] The fact just created
+# @return [nil|Factbase::Fact] Either +nil+ if it's already there or a new fact
 def Fbe.if_absent(fb: Fbe.fb)
   attrs = {}
   f =
@@ -51,7 +71,8 @@ def Fbe.if_absent(fb: Fbe.fb)
     "(eq #{k} #{vv})"
   end.join(' ')
   q = "(and #{q})"
-  return nil unless fb.query(q).each.to_a.empty?
+  before = fb.query(q).each.to_a.first
+  return nil if before
   n = fb.insert
   attrs.each { |k, v| n.send("#{k}=", v) }
   n

data/lib/fbe/issue.rb

@@ -23,13 +23,20 @@
 # SOFTWARE.
 
 require_relative '../fbe'
+require_relative 'octo'
 
 # Converts an ID of GitHub issue into a nicely formatting string.
 #
+# The function takes the +repository+ property of the provided +fact+,
+# goes to the GitHub API in order to find the full name of the repository,
+# and then creates a string with the full name of repository + issue, for
+# example +"zerocracy/fbe#42"+.
+#
 # @param [Factbase::Fact] fact The fact, where to get the ID of GitHub issue
 # @param [Judges::Options] options The options coming from the +judges+ tool
 # @param [Hash] global The hash for global caching
 # @param [Loog] loog The logging facility
+# @return [String] Textual representation of GitHub issue number
 def Fbe.issue(fact, options: $options, global: $global, loog: $loog)
   rid = fact['repository']
   raise "There is no 'repository' property" if rid.nil?

data/lib/fbe/iterate.rb

@@ -23,21 +23,40 @@
 # SOFTWARE.
 
 require_relative '../fbe'
-require_relative 'unmask_repos'
-require_relative 'octo'
 require_relative 'fb'
+require_relative 'octo'
+require_relative 'unmask_repos'
 
-# Create a conclude code block.
+# Creates an instance of {Fbe::Iterate} and evals it with the block provided.
+#
+# @param [Factbase] fb The global factbase provided by the +judges+ tool
+# @param [Judges::Options] options The options coming from the +judges+ tool
+# @param [Hash] global The hash for global caching
+# @param [Loog] loog The logging facility
+# @yield [Factbase::Fact] The fact
 def Fbe.iterate(fb: Fbe.fb, loog: $loog, options: $options, global: $global, &)
   c = Fbe::Iterate.new(fb:, loog:, options:, global:)
   c.instance_eval(&)
 end
 
-# Iterate.
+# An iterator.
+#
+# Here, you go through all repositories defined by the +repositories+ option
+# in the +$options+, trying to run the provided query for each of them. If the
+# query returns an integer that is different from the previously seen, the
+# function keeps repeating the cycle. Otherwise, it will restart from the
+# beginning.
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Zerocracy
 # License:: MIT
 class Fbe::Iterate
+  # Ctor.
+  #
+  # @param [Factbase] fb The factbase
+  # @param [Loog] loog The logging facility
+  # @param [Judges::Options] options The options coming from the +judges+ tool
+  # @param [Hash] global The hash for global caching
   def initialize(fb:, loog:, options:, global:)
     @fb = fb
     @loog = loog
@@ -50,22 +69,39 @@ class Fbe::Iterate
     @quota_aware = false
   end
 
+  # Make this block aware of GitHub API quota.
+  #
+  # When the quota is reached, the loop will gracefully stop.
+  #
+  # @return [nil] Nothing
   def quota_aware
     @quota_aware = true
   end
 
+  # Sets the total counter of repeats to make.
+  #
+  # @param [Integer] repeats The total count of them
+  # @return [nil] Nothing
   def repeats(repeats)
     raise 'Cannot set "repeats" to nil' if repeats.nil?
     raise 'The "repeats" must be a positive integer' unless repeats.positive?
     @repeats = repeats
   end
 
+  # Sets the query to run.
+  #
+  # @param [String] query The query
+  # @return [nil] Nothing
   def by(query)
     raise 'Query is already set' unless @query.nil?
     raise 'Cannot set query to nil' if query.nil?
     @query = query
   end
 
+  # Sets the label to use in the "marker" fact.
+  #
+  # @param [String] label The label
+  # @return [nil] Nothing
   def as(label)
     raise 'Label is already set' unless @label.nil?
     raise 'Cannot set "label" to nil' if label.nil?
@@ -73,10 +109,13 @@ class Fbe::Iterate
   end
 
   # It makes a number of repeats of going through all repositories
-  # provided by the "repositories" configuration option. In each "repeat"
+  # provided by the +repositories+ configuration option. In each "repeat"
   # it yields the repository ID and a number that is retrieved by the
-  # "query". The query is supplied with two parameter:
-  # "$before" (the value from the previous repeat and "$rid" (the repo ID).
+  # +query+. The query is supplied with two parameter:
+  # +$before+ the value from the previous repeat and +$repository+ (GitHub repo ID).
+  #
+  # @yield [Array<Integer, Integer>] Repository ID and the next number to be considered
+  # @return [nil] Nothing
   def over(&)
     raise 'Use "as" first' if @label.nil?
     raise 'Use "by" first' if @query.nil?

data/lib/fbe/just_one.rb

@@ -29,6 +29,20 @@ require_relative 'fb'
 
 # Injects a fact if it's absent in the factbase, otherwise (it is already
 # there) returns the existing one.
+#
+#  require 'fbe/just_one'
+#  n =
+#   Fbe.just_one do |f|
+#     f.what = 'something'
+#     f.details = 'important'
+#   end
+#
+# This code will guarantee that only one fact with +what+ equals to +something+
+# and +details+ equals to +important+ may exist.
+#
+# @param [Factbase] fb The global factbase
+# @yield [Factbase::Fact] The fact that was either created or found
+# @return [Factbase::Fact] The fact found
 def Fbe.just_one(fb: Fbe.fb)
   attrs = {}
   f =

data/lib/fbe/middleware/quota.rb

@@ -25,6 +25,10 @@
 require 'faraday'
 
 # Faraday Middleware that monitors GitHub API rate limits.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Zerocracy
+# License:: MIT
 class Fbe::Middleware::Quota < Faraday::Middleware
   def initialize(app, loog: Loog::NULL, pause: 60, limit: 100, rate: 5)
     super(app)