fbe 0.8.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3828337a178cb00363cfde7328b72d719e412861b1faeedeacbfa90ecdf55f01
-  data.tar.gz: 13e04faef8302ce164266d19cf5b54d9876376500c113a692467c30bde96345e
+  metadata.gz: 50140dbca73e4022726fad153402221b92d01a94f1cfc22eeb8f382170f0b4bc
+  data.tar.gz: 8fc5d55bc4b46f57dadb0bb36bd5461f2253bef19e143fb15704263e64d0ccd8
 SHA512:
-  metadata.gz: 7f35b12b769b206e111a63de0575f673be0c8514c42b3b90b33009a65529d8572f98d173d6c18dce29e8edd231afb7cd890c8dbe17af1b2e58733e7359453e73
-  data.tar.gz: 1743b4a1fe9deb57b39763f666683eb51ea6878fd56b86bc99fe1189c4fa58fcb42762b8e6f14cb7b0fd4256aca858824b8ca4ca6c0a7238d4f547c80d673b45
+  metadata.gz: ce99b5a1ad7500b952a731a863497b50b0f7b553a1b4521202149f1878d8b9e8eef8af79438d7ab96cb8ac238182a6ad044a98e82677efbc439d4a5ce39a6bfd
+  data.tar.gz: d51c72a5299c03aeb1e1bf20839a94e3d1c05fc679c6d32c8959d8634d2a9cdfa080082950358e33ba62bda4242dd8231f11bbb2a7f7752165c9fd5f7e04f5e6

data/.rubocop.yml

@@ -54,4 +54,3 @@ Metrics/ParameterLists:
   Enabled: false
 Layout/MultilineAssignmentLayout:
   Enabled: true
-require: []

data/Gemfile.lock

@@ -58,7 +58,7 @@ GEM
     bigdecimal (3.1.9)
     builder (3.3.0)
     concurrent-ruby (1.3.5)
-    connection_pool (2.5.0)
+    connection_pool (2.5.1)
     crack (1.0.0)
       bigdecimal
       rexml
@@ -99,7 +99,7 @@ GEM
     fiber-storage (1.0.1)
     gli (2.22.2)
       ostruct
-    graphql (2.5.3)
+    graphql (2.5.4)
       base64
       fiber-storage
       logger
@@ -111,7 +111,7 @@ GEM
       concurrent-ruby (~> 1.0)
     iri (0.10.0)
     json (2.10.2)
-    judges (0.39.2)
+    judges (0.41.0)
       backtrace (~> 0)
       baza.rb (~> 0)
       concurrent-ruby (~> 1.2)
@@ -143,13 +143,13 @@ GEM
     multipart-post (2.4.1)
     net-http (0.6.0)
       uri
-    nokogiri (1.18.7-arm64-darwin)
+    nokogiri (1.18.8-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.7-x64-mingw-ucrt)
+    nokogiri (1.18.8-x64-mingw-ucrt)
       racc (~> 1.4)
-    nokogiri (1.18.7-x86_64-darwin)
+    nokogiri (1.18.8-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.7-x86_64-linux-gnu)
+    nokogiri (1.18.8-x86_64-linux-gnu)
       racc (~> 1.4)
     obk (0.3.2)
     octokit (9.2.0)
@@ -175,7 +175,7 @@ GEM
     regexp_parser (2.10.0)
     retries (0.0.5)
     rexml (3.4.1)
-    rubocop (1.75.2)
+    rubocop (1.75.4)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)

data/assets/bylaws/bug-report-was-rewarded.liquid

@@ -1,7 +1,7 @@
 (award
   (explain "When a bug is reported and accepted by the team, the reporter receives a bonus")
   (aka
-    (let bonus {{ 4 | times: love }})
+    (let bonus {{ 6 | times: love }})
     (give bonus "as a basis")
     "award ${bonus} points")
   )

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

@@ -5,7 +5,7 @@
   (in reviews "the number of reviews provided")
 
   (aka
-    (let basis {{ 2 | times: love }})
+    (let basis {{ 8 | times: love }})
     (give basis "as a basis")
     "award ${basis} points")
 
@@ -46,10 +46,17 @@
     (let comments_k {{ 0.1 | times: anger }})
     (let comments_max -16)
     (let comments_min -4)
-    (set bonus_for_comments (times comments (times -1 comments_k)))
+    (let comments_threshold {{ 16 | divided_by: paranoia }})
+    (set bonus_for_comments
+      (if
+        (gt comments comments_threshold)
+        (times comments (times -1 comments_k))
+        0
+      )
+    )
     (set bonus_for_comments (between bonus_for_comments comments_min comments_max))
-    (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")
+    (give bonus_for_comments "for too many (${comments} > ${comments_threshold}) comments that were made during review")
+    "deduct ${comments_k} points for every comment above ${comments_threshold} made during review, but not more than ${comments_max} points")
 
   (aka
     (let few_hoc_fee {{ 4 | times: anger }})

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

@@ -5,7 +5,7 @@
   (in self "1 if the review was made for their own code contribution, otherwise zero")
 
   (aka
-    (let basis {{ 2 | times: love }})
+    (let basis {{ 6 | times: love }})
     (give basis "as a basis")
     "award ${basis} points")
 

data/assets/bylaws/enhancement-suggestion-was-rewarded.liquid

@@ -1,7 +1,7 @@
 (award
   (explain "When an enhancement is suggested and accepted by the team, the reporter receives a bonus")
   (aka
-    (let bonus {{ 4 | times: love }})
+    (let bonus {{ 6 | times: love }})
     (give bonus "as a basis")
     "award ${bonus} points")
   )

data/assets/bylaws/resolved-bug-was-rewarded.liquid

@@ -4,7 +4,7 @@
   (in self "1 if the bug was reported and resolved by the same person, otherwise zero")
   (set days (div hours 24))
   (aka
-    (let basis {{ 2 | times: love }})
+    (let basis {{ 4 | times: love }})
     (give basis "as a basis")
     "award ${basis} points")
 

data/lib/fbe/award.rb

@@ -62,20 +62,46 @@ class Fbe::Award
     bylaw
   end
 
-  # A term for bill.
+  # A term module for processing award billing logic.
+  #
+  # This module is used to extend Factbase terms to handle award calculations
+  # and billing operations. It provides methods to calculate point values and
+  # evaluate complex award expressions.
   module BTerm
+    # Returns a string representation of the term.
+    #
+    # @return [String] The term as a string in S-expression format
+    # @example
+    #   term.to_s #=> "(give (times loc 5) 'for LoC')"
     def to_s
       "(#{@op} #{@operands.join(' ')})"
     end
 
+    # Indicates whether the term is static.
+    #
+    # @return [Boolean] Always returns true for BTerm
     def static?
       true
     end
 
+    # Indicates whether the term is abstract.
+    #
+    # @return [Boolean] Always returns false for BTerm
     def abstract?
       false
     end
 
+    # Processes this term and applies its operations to a bill.
+    #
+    # @param [Fbe::Award::Bill] bill The bill to update
+    # @return [nil]
+    # @raise [RuntimeError] If there's a failure processing any term
+    # @example
+    #   term = Factbase::Syntax.new('(award (give 100 "for effort"))').to_term
+    #   term.redress!(Fbe::Award::BTerm)
+    #   bill = Fbe::Award::Bill.new
+    #   term.bill_to(bill)
+    #   bill.points #=> 100
     def bill_to(bill)
       case @op
       when :award
@@ -91,7 +117,9 @@ class Fbe::Award
           raise "Failure in #{o}: #{e.message}"
         end
       when :let, :set
-        bill.set(@operands[0], to_val(@operands[1], bill))
+        v = to_val(@operands[1], bill)
+        raise "Can't #{@op.inspect} #{@operands[0].inspect} to nil" if v.nil?
+        bill.set(@operands[0], v)
       when :give
         text = @operands[1]
         text = '' if text.nil?
@@ -103,18 +131,43 @@ class Fbe::Award
       end
     end
 
+    # Evaluates a value in the context of a bill.
+    #
+    # @param [Object] any The value to evaluate (symbol, term, or literal)
+    # @param [Fbe::Award::Bill] bill The bill providing context for evaluation
+    # @return [Object] The evaluated value
+    # @raise [RuntimeError] If a symbol isn't found in the bill
+    # @example
+    #   bill = Fbe::Award::Bill.new
+    #   bill.set(:loc, 100)
+    #   term.to_val(:loc, bill) #=> 100
     def to_val(any, bill)
       if any.is_a?(BTerm)
         any.calc(bill)
       elsif any.is_a?(Symbol)
         v = bill.vars[any]
-        raise "Unknown name '#{any}' among [#{bill.vars.keys.join(', ')}]" if v.nil?
+        raise "Unknown name #{any.inspect} among: #{bill.vars.keys.map(&:inspect).join(', ')}" if v.nil?
         v
       else
         any
       end
     end
 
+    # Calculates the value of this term in the context of a bill.
+    #
+    # This method evaluates terms like arithmetic operations, logical
+    # operations, and other expressions based on the operator type.
+    #
+    # @param [Fbe::Award::Bill] bill The bill providing context for calculation
+    # @return [Object] The calculated value (number, boolean, etc.)
+    # @raise [RuntimeError] If the term operation is unknown
+    # @example
+    #   bill = Fbe::Award::Bill.new
+    #   bill.set(:x, 10)
+    #   bill.set(:y, 5)
+    #   term = Factbase::Syntax.new('(times x y)').to_term
+    #   term.redress!(Fbe::Award::BTerm)
+    #   term.calc(bill) #=> 50
     def calc(bill)
       case @op
       when :total
@@ -273,29 +326,70 @@ class Fbe::Award
     end
   end
 
-  # A bill.
+  # A bill class that accumulates points and explanations for rewards.
+  #
+  # This class tracks variables, point values, and explanatory text
+  # for each award component. It provides methods to calculate total points
+  # and generate a human-readable summary of the rewards.
   class Bill
+    # @return [Hash] Variables set in this bill
     attr_reader :vars
 
+    # Creates a new empty bill.
+    #
+    # @example
+    #   bill = Fbe::Award::Bill.new
     def initialize
       @lines = []
       @vars = {}
     end
 
+    # Sets a variable in the bill's context.
+    #
+    # @param [Symbol] var The variable name
+    # @param [Object] value The value to assign
+    # @return [Object] The assigned value
+    # @example
+    #   bill = Fbe::Award::Bill.new
+    #   bill.set(:lines_of_code, 500)
     def set(var, value)
       @vars[var] = value
     end
 
+    # Adds a point value with explanatory text to the bill.
+    #
+    # @param [Integer, Float] value The point value to add
+    # @param [String] text The explanation for these points
+    # @return [nil]
+    # @note Zero-valued points are ignored
+    # @example
+    #   bill = Fbe::Award::Bill.new
+    #   bill.line(50, "for code review")
     def line(value, text)
       return if value.zero?
       text = text.gsub(/\$\{([a-z_0-9]+)\}/) { |_x| @vars[Regexp.last_match[1].to_sym] }
       @lines << { v: value, t: text }
     end
 
+    # Calculates the total points in this bill.
+    #
+    # @return [Integer] The sum of all point values, rounded to an integer
+    # @example
+    #   bill = Fbe::Award::Bill.new
+    #   bill.line(42.5, "for answer")
+    #   bill.points #=> 43
     def points
       @lines.sum { |l| l[:v] }.to_f.round.to_i
     end
 
+    # Generates a human-readable summary of the bill.
+    #
+    # @return [String] A description of the points earned
+    # @example
+    #   bill = Fbe::Award::Bill.new
+    #   bill.line(50, "for code review")
+    #   bill.line(25, "for documentation")
+    #   bill.greeting #=> "You've earned +75 points for this: +50 for code review; +25 for documentation. "
     def greeting
       items = @lines.map { |l| "#{format('%+d', l[:v])} #{l[:t]}" }
       case items.size
@@ -309,33 +403,83 @@ class Fbe::Award
     end
   end
 
-  # A bylaw.
+  # A class for generating human-readable bylaws.
+  #
+  # This class builds textual descriptions of award bylaws including
+  # introductions, calculation steps, and variable substitutions.
+  # It produces Markdown-formatted output describing how awards are calculated.
   class Bylaw
+    # @return [Hash] Variables defined in this bylaw
     attr_reader :vars
 
+    # Creates a new empty bylaw.
+    #
+    # @example
+    #   bylaw = Fbe::Award::Bylaw.new
     def initialize
       @lines = []
       @intro = ''
       @lets = {}
     end
 
+    # Removes the specified number of most recently added lines.
+    #
+    # @param [Integer] num The number of lines to remove from the end
+    # @return [Array] The removed lines
+    # @example
+    #   bylaw = Fbe::Award::Bylaw.new
+    #   bylaw.line("award 50 points")
+    #   bylaw.line("award 30 points")
+    #   bylaw.revert(1) # Removes "award 30 points"
     def revert(num)
       @lines.slice!(-num, num)
     end
 
+    # Sets the introductory text for the bylaw.
+    #
+    # @param [String] text The introductory text to set
+    # @return [String] The introductory text
+    # @example
+    #   bylaw = Fbe::Award::Bylaw.new
+    #   bylaw.intro("This bylaw determines rewards for code contributions")
     def intro(text)
       @intro = text
     end
 
+    # Adds a line of text to the bylaw, replacing variable references.
+    #
+    # @param [String] line The line of text to add
+    # @return [nil]
+    # @example
+    #   bylaw = Fbe::Award::Bylaw.new
+    #   bylaw.let(:points, 50)
+    #   bylaw.line("award ${points} points")
     def line(line)
       line = line.gsub(/\$\{([a-z_0-9]+)\}/) { |_x| "**#{@lets[Regexp.last_match[1].to_sym]}**" }
       @lines << line
     end
 
+    # Registers a variable with its value for substitution in lines.
+    #
+    # @param [Symbol] key The variable name
+    # @param [Object] value The value to associate with the variable
+    # @return [Object] The assigned value
+    # @example
+    #   bylaw = Fbe::Award::Bylaw.new
+    #   bylaw.let(:points, 50)
     def let(key, value)
       @lets[key] = value
     end
 
+    # Generates a Markdown-formatted representation of the bylaw.
+    #
+    # @return [String] The bylaw formatted as Markdown text
+    # @example
+    #   bylaw = Fbe::Award::Bylaw.new
+    #   bylaw.intro("This bylaw determines rewards for code contributions")
+    #   bylaw.line("award **50** points")
+    #   bylaw.markdown
+    #   #=> "This bylaw determines rewards for code contributions. Just award **50** points."
     def markdown
       pars = []
       pars << "#{@intro}." unless @intro.empty?

data/lib/fbe/conclude.rb

@@ -160,8 +160,24 @@ class Fbe::Conclude
 
   private
 
-  # @yield [Factbase::Fact] The next fact found by the query
-  # @return [Integer] The count of the facts seen
+  # Executes a query and processes each matching fact.
+  #
+  # This internal method handles fetching facts from the factbase,
+  # monitoring quotas and timeouts, and processing each fact through
+  # the provided block.
+  #
+  # @yield [Factbase::Transaction, Factbase::Fact] Transaction and the matching fact
+  # @return [Integer] The count of facts processed
+  # @example
+  #   # Inside the Fbe::Conclude class
+  #   def example_method
+  #     roll do |fbt, fact|
+  #       # Process the fact
+  #       new_fact = fbt.insert
+  #       # Return the new fact
+  #       new_fact
+  #     end
+  #   end
   def roll(&)
     passed = 0
     start = Time.now
@@ -185,6 +201,27 @@ class Fbe::Conclude
     passed
   end
 
+  # Populates a new fact based on a previous fact and a processing block.
+  #
+  # This internal method copies specified properties from the previous fact,
+  # calls the provided block for custom processing, and sets metadata
+  # on the new fact.
+  #
+  # @param [Factbase::Fact] fact The fact to populate
+  # @param [Factbase::Fact] prev The previous fact to copy from
+  # @yield [Factbase::Fact, Factbase::Fact] New fact and the previous fact
+  # @return [nil]
+  # @example
+  #   # Inside the Fbe::Conclude class
+  #   def example_method
+  #     @fb.txn do |fbt|
+  #       new_fact = fbt.insert
+  #       fill(new_fact, existing_fact) do |n, prev|
+  #         n.some_property = "new value"
+  #         "Operation completed"  # This becomes fact.details
+  #       end
+  #     end
+  #   end
   def fill(fact, prev)
     @follows.each do |follow|
       v = prev.send(follow)

data/lib/fbe/github_graph.rb

@@ -35,11 +35,29 @@ class Fbe::Graph
     @host = host
   end
 
+  # Executes a GraphQL query against the GitHub API.
+  #
+  # @param [String] qry The GraphQL query to execute
+  # @return [GraphQL::Client::Response] The query result data
+  # @example
+  #   graph = Fbe::Graph.new(token: 'github_token')
+  #   result = graph.query('{viewer {login}}')
+  #   puts result.viewer.login #=> "octocat"
   def query(qry)
     result = client.query(client.parse(qry))
     result.data
   end
 
+  # Retrieves resolved conversation threads from a pull request.
+  #
+  # @param [String] owner The repository owner (username or organization)
+  # @param [String] name The repository name
+  # @param [Integer] number The pull request number
+  # @return [Array<Hash>] An array of resolved conversation threads with their comments
+  # @example
+  #   graph = Fbe::Graph.new(token: 'github_token')
+  #   threads = graph.resolved_conversations('octocat', 'Hello-World', 42)
+  #   threads.first['comments']['nodes'].first['body'] #=> "Great work!"
   def resolved_conversations(owner, name, number)
     result = query(
       <<~GRAPHQL
@@ -72,6 +90,16 @@ class Fbe::Graph
     end || []
   end
 
+  # Gets the total number of commits in a branch.
+  #
+  # @param [String] owner The repository owner (username or organization)
+  # @param [String] name The repository name
+  # @param [String] branch The branch name (e.g., "master" or "main")
+  # @return [Integer] The total number of commits in the branch
+  # @example
+  #   graph = Fbe::Graph.new(token: 'github_token')
+  #   count = graph.total_commits('octocat', 'Hello-World', 'main')
+  #   puts count #=> 42
   def total_commits(owner, name, branch)
     result = query(
       <<~GRAPHQL
@@ -93,6 +121,15 @@ class Fbe::Graph
     result.repository.ref.target.history.total_count
   end
 
+  # Gets the total number of issues and pull requests in a repository.
+  #
+  # @param [String] owner The repository owner (username or organization)
+  # @param [String] name The repository name
+  # @return [Hash] A hash with 'issues' and 'pulls' counts
+  # @example
+  #   graph = Fbe::Graph.new(token: 'github_token')
+  #   counts = graph.total_issues_and_pulls('octocat', 'Hello-World')
+  #   puts counts #=> {"issues"=>42, "pulls"=>17}
   def total_issues_and_pulls(owner, name)
     result = query(
       <<~GRAPHQL
@@ -116,6 +153,9 @@ class Fbe::Graph
 
   private
 
+  # Creates or returns a cached GraphQL client instance.
+  #
+  # @return [GraphQL::Client] A configured GraphQL client for GitHub
   def client
     @client ||=
       begin
@@ -127,13 +167,24 @@ class Fbe::Graph
       end
   end
 
-  # The HTTP class
+  # HTTP transport class for GraphQL client to communicate with GitHub API
+  #
+  # This class extends GraphQL::Client::HTTP to handle GitHub-specific
+  # authentication and endpoints.
   class HTTP < GraphQL::Client::HTTP
+    # Initializes a new HTTP transport with GitHub authentication.
+    #
+    # @param [String] token GitHub API token for authentication
+    # @param [String] host GitHub API host (default: 'api.github.com')
     def initialize(token, host)
       @token = token
       super("https://#{host}/graphql")
     end
 
+    # Provides headers for GraphQL requests including authentication.
+    #
+    # @param [Object] _context The GraphQL request context (unused)
+    # @return [Hash] Headers for the request
     def headers(_context)
       { Authorization: "Bearer #{@token}" }
     end

data/lib/fbe/middleware/formatter.rb

@@ -54,11 +54,25 @@ class Fbe::Middleware::Formatter < Faraday::Logging::Formatter
 
   private
 
+  # Indents text with two spaces, including all lines.
+  #
+  # @param [String, nil] txt The text to indent
+  # @return [String] The indented text, or an empty string if input was nil
+  # @example
+  #   shifted("line1\nline2")
+  #   #=> "  line1\n  line2"
   def shifted(txt)
     return '' if txt.nil?
     "  #{txt.gsub("\n", "\n  ")}"
   end
 
+  # Formats HTTP headers as a multi-line string.
+  #
+  # @param [Hash, nil] headers The headers to format
+  # @return [String] The formatted headers, or an empty string if input was nil
+  # @example
+  #   dump_headers({"Content-Type" => "application/json", "Authorization" => "Bearer token"})
+  #   #=> "Content-Type: \"application/json\"\nAuthorization: \"Bearer token\""
   def dump_headers(headers)
     return '' if headers.nil?
     headers.map { |k, v| "#{k}: #{v.inspect}" }.join("\n")

data/lib/fbe/octo.rb

@@ -124,17 +124,40 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
     end
 end
 
-# Fake GitHub client, for tests.
+# Fake GitHub client for testing purposes.
+#
+# This class provides mock implementations of Octokit methods for testing.
+# It returns predictable data structures that mimic GitHub API responses.
 class Fbe::FakeOctokit
+  # Generates a random time in the past.
+  #
+  # @return [Time] A random time within the last 10,000 seconds
+  # @example
+  #   fake_client = Fbe::FakeOctokit.new
+  #   time = fake_client.random_time #=> 2024-09-04 12:34:56 -0700
   def random_time
     Time.now - rand(10_000)
   end
 
+  # Converts a string name to a deterministic integer.
+  #
+  # @param [String, Integer] name The name to convert or pass through
+  # @return [Integer, String] The sum of character codes if input is a string, otherwise the original input
+  # @example
+  #   fake_client = Fbe::FakeOctokit.new
+  #   fake_client.name_to_number("octocat") #=> 728
+  #   fake_client.name_to_number(42) #=> 42
   def name_to_number(name)
     return name unless name.is_a?(String)
     name.chars.sum(&:ord)
   end
 
+  # Returns a mock rate limit object.
+  #
+  # @return [Object] An object with a remaining method that returns 100
+  # @example
+  #   fake_client = Fbe::FakeOctokit.new
+  #   fake_client.rate_limit.remaining #=> 100
   def rate_limit
     o = Object.new
     def o.remaining
@@ -150,13 +173,25 @@ class Fbe::FakeOctokit
     ]
   end
 
-  # Give this repo a star.
+  # Gives a star to a repository.
+  #
+  # @param [String] _repo The repository name (e.g., 'user/repo')
+  # @return [Boolean] Always returns true
+  # @example
+  #   fake_client = Fbe::FakeOctokit.new
+  #   fake_client.star('octocat/Hello-World') #=> true
   def star(_repo)
     true
   end
 
-  # Get details of the user.
-  # @param [String|Integer] uid The login of the user or its ID
+  # Gets details of a GitHub user.
+  #
+  # @param [String, Integer] uid The login of the user or its numeric ID
+  # @return [Hash] User information including id, login, and type
+  # @example
+  #   fake_client = Fbe::FakeOctokit.new
+  #   fake_client.user(526_301) #=> {:id=>444, :login=>"yegor256", :type=>"User"}
+  #   fake_client.user('octocat') #=> {:id=>444, :login=>nil, :type=>"User"}
   def user(uid)
     login = (uid == 526_301 ? 'yegor256' : 'torvalds') if uid.is_a?(Integer)
     {
@@ -166,6 +201,15 @@ class Fbe::FakeOctokit
     }
   end
 
+  # Gets workflow runs for a repository.
+  #
+  # @param [String] repo The repository name
+  # @param [Hash] _opts Additional options (not used in mock)
+  # @return [Hash] Information about workflow runs including counts and details
+  # @example
+  #   fake_client = Fbe::FakeOctokit.new
+  #   result = fake_client.repository_workflow_runs('octocat/Hello-World')
+  #   result[:total_count] #=> 2
   def repository_workflow_runs(repo, _opts = {})
     {
       total_count: 2,
@@ -176,6 +220,15 @@ class Fbe::FakeOctokit
     }
   end
 
+  # Gets usage information for a specific workflow run.
+  #
+  # @param [String] _repo The repository name
+  # @param [Integer] _id The workflow run ID
+  # @return [Hash] Billing and usage information for the workflow run
+  # @example
+  #   fake_client = Fbe::FakeOctokit.new
+  #   usage = fake_client.workflow_run_usage('octocat/Hello-World', 42)
+  #   usage[:run_duration_ms] #=> 53000
   def workflow_run_usage(_repo, _id)
     {
       billable: {

data/lib/fbe/pmp.rb

@@ -19,11 +19,27 @@ require_relative 'fb'
 # this method throws an exception. The factbase must contain PMP-related facts.
 # Most probably, a special judge must fill it up with such a fact.
 #
+# The method uses a double nested `others` block to create a chainable interface
+# that allows accessing configuration like:
+#
+#   Fbe.pmp.hr.reward_points
+#   Fbe.pmp.cost.hourly_rate
+#   Fbe.pmp.time.deadline
+#
 # @param [Factbase] fb The factbase
 # @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 [String|Integer] The value of the property found
+# @return [Object] A proxy object that allows method chaining to access PMP properties
+# @example
+#   # Get HR reward points from PMP configuration
+#   points = Fbe.pmp.hr.reward_points
+#
+#   # Get hourly rate from cost area
+#   rate = Fbe.pmp.cost.hourly_rate
+#
+#   # Get deadline from time area
+#   deadline = Fbe.pmp.time.deadline
 def Fbe.pmp(fb: Fbe.fb, global: $global, options: $options, loog: $loog)
   others do |*args1|
     area = args1.first

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

data/test/fbe/test_bylaws.rb

@@ -31,9 +31,9 @@ class TestBylaws < Fbe::Test
         { hoc: 30_000, contributors: 1 } => 32
       },
       'resolved-bug-was-rewarded' => {
-        { hours: 1, self: 0 } => 8,
-        { hours: 48, self: 0 } => 4,
-        { hours: 80, self: 0 } => 4,
+        { hours: 1, self: 0 } => 12,
+        { hours: 48, self: 0 } => 6,
+        { hours: 80, self: 0 } => 5,
         { hours: 300, self: 0 } => 4,
         { hours: 3_000, self: 0 } => 4,
         { hours: 30_000, self: 0 } => 4,
@@ -45,9 +45,10 @@ class TestBylaws < Fbe::Test
       'code-review-was-rewarded' => {
         { hoc: 0, comments: 0, self: 0 } => 4,
         { hoc: 3, comments: 0, self: 0 } => 4,
-        { hoc: 78, comments: 7, self: 0 } => 4,
-        { hoc: 600, comments: 1, self: 0 } => 4,
-        { hoc: 500, comments: 40, self: 0 } => 17,
+        { hoc: 78, comments: 7, self: 0 } => 12,
+        { hoc: 120, comments: 4, self: 0 } => 4,
+        { hoc: 600, comments: 1, self: 0 } => 8,
+        { hoc: 500, comments: 40, self: 0 } => 24,
         { hoc: 5_000, comments: 100, self: 0 } => 24,
         { hoc: 100, comments: 50, self: 1 } => 4,
         { hoc: 10_000, comments: 200, self: 1 } => 4
@@ -59,19 +60,19 @@ class TestBylaws < Fbe::Test
         { hoc: 78, comments: 1, reviews: 0 } => 4,
         { hoc: 50, comments: 15, reviews: 0 } => 4,
         { 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 } => 12,
+        { hoc: 180, comments: 7, reviews: 2 } => 24,
+        { hoc: 199, comments: 8, reviews: 3 } => 24,
+        { hoc: 150, comments: 5, reviews: 1 } => 24,
         { hoc: 500, comments: 25, reviews: 2 } => 4,
-        { hoc: 99, comments: 6, reviews: 1 } => 4,
+        { hoc: 99, comments: 6, reviews: 1 } => 16,
         { hoc: 1_500, comments: 3, reviews: 0 } => 4,
         { hoc: 15_000, comments: 40, reviews: 0 } => 4
       },
       'bug-report-was-rewarded' => {
-        {} => 8
+        {} => 12
       },
       'enhancement-suggestion-was-rewarded' => {
-        {} => 8
+        {} => 12
       },
       'dud-was-punished' => {
         {} => -16

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: fbe
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 bindir: bin
 cert_chain: []
-date: 2025-04-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -253,8 +253,8 @@ email: yegor256@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
 - LICENSE.txt
+- README.md
 files:
 - ".0pdd.yml"
 - ".gitattributes"
@@ -358,7 +358,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: FactBase Extended (FBE), a collection of utility classes for Zerocracy judges
 test_files: []