fbe 0.0.55 → 0.0.56

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 705cf29669f71d490c86421f566b0ec05c61fa1d8352b97d752ea26b8bcbb294
-  data.tar.gz: e68fc23391048fac0a41a5b26af5ac85c4a34b3c434845710736d093d7eeb714
+  metadata.gz: 50405a3f7472db8c909709be30db7a6eed4f5923fca49fac7ac58da9e936c324
+  data.tar.gz: 60d9ca2097226f9763e532e0f27f020087994953d772029fb7bfb9570e6c8396
 SHA512:
-  metadata.gz: 20ca9dfe05821edf5df55fccc51303fa23598e81dd15361cfb8b8f23db99b399c9e984ed0a1e1e97f43a0ebd048bd0beec5d8f870163cf0cea5c264fc1a505fc
-  data.tar.gz: e8fdc7f6988f441cf0d0cb63c52f29a95f17c9681be435eb6c57012403e903e0ce65bd4b60402e802485221f3c7d7ca0cc847d1ba2f40e318af9be82ab989dcc
+  metadata.gz: 7a4f743d351eb119586a77f6d675f4c311b511bd72823da1b4be71eb4ba5abcd70a22be42c91973835cc3b5451ae8c8bb68015945f1104ef504a23be073c2913
+  data.tar.gz: e3dc8bfefcfc1fbcc5519af0961b8aea92c0ea2702e9d348710557e95ccfb8df725e4d350ecb7e11a3cac839893d27c77a709458cc0dab9c29a9a85eb77da5b6

data/.simplecov

@@ -36,6 +36,6 @@ else
   SimpleCov.start do
     add_filter '/test/'
     add_filter '/features/'
-    minimum_coverage 20
+    minimum_coverage 15
   end
 end

data/Gemfile.lock

@@ -11,6 +11,7 @@ PATH
       faraday-retry (> 0)
       graphql-client (> 0)
       judges (> 0)
+      liquid (= 5.5.1)
       loog (> 0)
       obk (> 0)
       octokit (> 0)
@@ -54,7 +55,7 @@ GEM
     ast (2.4.2)
     backtrace (0.4.0)
     base64 (0.2.0)
-    baza.rb (0.0.6)
+    baza.rb (0.0.7)
       backtrace (> 0)
       faraday (> 0)
       faraday-http-cache (> 0)
@@ -77,6 +78,9 @@ GEM
     diff-lcs (1.5.1)
     docile (1.4.1)
     drb (2.2.1)
+    elapsed (0.0.1)
+      loog (> 0)
+      tago (> 0)
     erubi (1.13.0)
     ethon (0.16.0)
       ffi (>= 1.15.0)
@@ -121,21 +125,23 @@ GEM
       reline (>= 0.4.2)
     iri (0.8.0)
     json (2.7.2)
-    judges (0.25.2)
-      backtrace (~> 0)
-      baza.rb (~> 0)
+    judges (0.26.0)
+      backtrace (> 0)
+      baza.rb (> 0)
       concurrent-ruby (~> 1.2)
-      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)
     logger (1.6.0)
     loofah (2.22.0)
       crass (~> 1.0.2)
@@ -164,7 +170,7 @@ GEM
       faraday (>= 1, < 3)
       sawyer (~> 0.9)
     others (0.0.3)
-    parallel (1.26.2)
+    parallel (1.26.3)
     parser (3.3.4.2)
       ast (~> 2.4.1)
       racc
@@ -233,7 +239,7 @@ GEM
       rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.32.0)
+    rubocop-ast (1.32.1)
       parser (>= 3.3.1.0)
     rubocop-performance (1.21.1)
       rubocop (>= 1.48.1, < 2.0)

data/README.md

@@ -29,19 +29,23 @@ These tools help manage facts:
 * `Fbe.overwrite` changes a property in a fact to another value by deleting
 the fact first, and then creating a new similar fact with all previous
 properties but one changed.
-* `Fbe.pmp` takes a PMP-related property by the area.
 
 They help with formatting:
 
 * `Fbe.who` formats user name.
 * `Fbe.issue` formats issue number.
-* `Fbe.award` calculates award by the policy.
+* `Fbe.award` calculates award by the bylaw.
 * `Fbe.sec` formats seconds.
 
 They help with external connections:
 
 * `Fbe.octo` connects to GitHub API.
 
+They help with management:
+
+* `Fbe.pmp` takes a PMP-related property by the area.
+* `Fbe.bylaws` builds a hash with bylaws.
+
 ## How to contribute
 
 Read

data/assets/bylaws/bad-branch-name-was-punished.liquid

@@ -0,0 +1,7 @@
+(award
+  (explain "If a branch has a name that doesn\\\'t obey the convention, a penalty is given to the author")
+  (aka
+    (let fee -12)
+    (give fee "as a basis")
+    "deduct ${fee} points")
+  )

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

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

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

@@ -0,0 +1,82 @@
+(award
+  (explain "When a code contribution is made, the author gets a bonus")
+  (in hoc "the total number of hits-of-code in the contribution")
+  (in comments "the total number of comments made by all reviewers")
+  (in reviews "the number of reviews provided")
+
+  (aka
+    (let basis {{ 8 | times: love }})
+    (give basis "as a basis")
+    "award ${basis} points")
+
+  (aka
+    (let hoc_k {{ 0.05 | times: love }})
+    (let hoc_threshold 200)
+    (let hoc_max 16)
+    (let hoc_min 5)
+    (set bonus_for_hoc (if (lt hoc hoc_threshold) (times hoc hoc_k) 0))
+    (set bonus_for_hoc (between bonus_for_hoc hoc_min hoc_max))
+    (give bonus_for_hoc "for the ${hoc} hits-of-code that you wrote")
+    "add ${hoc_k} points for each
+      [hit-of-code](https://www.yegor256.com/2014/11/14/hits-of-code.html),
+      but not more than ${hoc_max} points")
+
+  (aka
+    (let many_hoc_fee {{ 4 | times: anger }})
+    (set penalty_for_hoc (if (gte hoc hoc_threshold) (times -1 many_hoc_fee) 0))
+    (give penalty_for_hoc "for too many hits-of-code (${hoc} >= ${hoc_threshold})")
+    "deduct ${many_hoc_fee} points if more than ${hoc_threshold}
+      [hits-of-code](https://www.yegor256.com/2014/11/14/hits-of-code.html)")
+
+  (aka
+    (let many_hoc_fee2 {{ 8 | times: anger }})
+    (let hoc_threshold2 800)
+    (set penalty_for_hoc2 (if (gte hoc hoc_threshold2) (times -1 many_hoc_fee2) 0))
+    (give penalty_for_hoc2 "for way too many hits-of-code (${hoc} >= ${hoc_threshold2})")
+    "deduct ${many_hoc_fee2} points if more than ${hoc_threshold2}
+      [hits-of-code](https://www.yegor256.com/2014/11/14/hits-of-code.html)")
+
+  (aka
+    (let no_review_fee {{ 8 | times: anger }})
+    (set penalty_for_no_review (if (eq reviews 0) (times -1 no_review_fee) 0))
+    (give penalty_for_no_review "for the lack of code review")
+    "deduct ${no_review_fee} points if there were no code review")
+
+  (aka
+    (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)))
+    (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")
+
+  (aka
+    (let few_comments_fee {{ 2 | times: anger }})
+    (let comments_needed 5)
+    (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 20)
+    (set penalty_for_few_hoc (if (lt hoc hoc_needed) (times -1 few_hoc_fee) 0))
+    (give penalty_for_few_hoc "for too few (${hoc}) hits-of-code")
+    "deduct ${few_hoc_fee} points if you contribute less than ${hoc_needed} hits-of-code")
+
+  (aka
+    (let max 32)
+    (set over (if (gt (total) max) (minus max (total)) 0))
+    (give over "to not go over the cap")
+    (let min 4)
+    (set least (if (lt (total) min) (minus min (total)) 0))
+    (give least "to give you at least something")
+    "make sure the reward is not larger than ${max} points and not smaller than ${min} points")
+  )

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

@@ -0,0 +1,68 @@
+(award
+  (explain "An author of every code review gets a bonus")
+  (in hoc "the total number of hits-of-code in the contribution")
+  (in comments "the total number of comments made by all reviewers")
+  (in self "1 if the review was made for their own code contribution, otherwise zero")
+
+  (aka
+    (let basis {{ 4 | times: love }})
+    (give basis "as a basis")
+    "award ${basis} points")
+
+  (aka
+    (let self_fee {{ 12 | times: anger }})
+    (set penalty_for_self_review (if (eq self 1) (times -1 self_fee) 0))
+    (give penalty_for_self_review "for reviewing your own contribution (which is a bad idea)")
+    "deduct ${self_fee} points if they reviewed their own contribution")
+
+  (aka
+    (let hoc_k {{ 0.01 | times: love }})
+    (let hoc_max 16)
+    (let hoc_min 5)
+    (set bonus_for_hoc (times hoc hoc_k))
+    (set bonus_for_hoc (between bonus_for_hoc hoc_min hoc_max))
+    (set bonus_for_hoc (if (eq self 1) 0 bonus_for_hoc))
+    (give bonus_for_hoc "for the ${hoc} hits-of-code that you reviewed")
+    "add ${hoc_k} points for each
+      [hit-of-code](https://www.yegor256.com/2014/11/14/hits-of-code.html),
+      but not more than ${hoc_max} points")
+
+  (aka
+    (let few_comments_fee {{ 5 | times: anger }})
+    (let comments_needed 6)
+    (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")
+    "deduct ${silence_fee} points if there were absolutely no comments made during review")
+
+  (aka
+    (let comments_k {{ 0.25 | times: love }})
+    (let comments_max 8)
+    (let comments_min 5)
+    (set bonus_for_comments (times comments comments_k))
+    (set bonus_for_comments (between bonus_for_comments comments_min comments_max))
+    (set bonus_for_comments (if (eq self 1) 0 bonus_for_comments))
+    (give bonus_for_comments "for the ${comments} comment(s) that you have made")
+    "add ${comments_k} points for each comment during the review, but not more than ${comments_max} points")
+
+  (aka
+    (let hoc_fee {{ 4 | times: anger }})
+    (let hoc_needed 15)
+    (set penalty_for_hoc (if (lt hoc hoc_needed) (times -1 hoc_fee) 0))
+    (give penalty_for_hoc "for too few (${hoc}) hits-of-code")
+    "deduct ${hoc_fee} points if there were less than ${hoc_needed} hits-of-code")
+
+  (aka
+    (let max 32)
+    (set over (if (gt (total) max) (minus max (total)) 0))
+    (give over "to not go over the cap")
+    (let min 4)
+    (set least (if (lt (total) min) (minus min (total)) 0))
+    (give least "to give you at least something")
+    "make sure the reward is not larger than ${max} points and not smaller than ${min} points")
+  )

data/assets/bylaws/dud-was-punished.liquid

@@ -0,0 +1,7 @@
+(award
+  (explain "When an issue is submitted but then rejected by the team, the reporter gets a penalty")
+  (aka
+    (let fee {{ -8 | times: anger }})
+    (give fee "as a basis")
+    "deduct ${fee} points")
+  )

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

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

data/assets/bylaws/published-release-was-rewarded.liquid

@@ -0,0 +1,29 @@
+(award
+  (explain "When a new release is published, everybody who contributed gets a bonus")
+  (in hoc "how many hits-of-code are in the release")
+  (in contributors "how many people contributed to the release")
+  (aka
+    (let basis {{ 12 | times: love }})
+    (give basis "as a basis")
+    "award ${basis} points")
+
+  (aka
+    (let hoc_k {{ 0.005 | times: love }})
+    (let hoc_max 24)
+    (let hoc_min 4)
+    (set b1 (times hoc hoc_k))
+    (set b1 (between b1 hoc_min hoc_max))
+    (give b1 "for ${hoc} hits-of-code")
+    "add ${hoc_k} points for each
+      [hit-of-code](https://www.yegor256.com/2014/11/14/hits-of-code.html),
+      but not more than ${hoc_max} points")
+
+  (aka
+    (let max 32)
+    (set over (if (gt (total) max) (minus max (total)) 0))
+    (give over "to not go over the cap")
+    (let min 4)
+    (set least (if (lt (total) min) (minus min (total)) 0))
+    (give least "to give you at least something")
+    "make sure the reward is not larger than ${max} points and not smaller than ${min} points")
+  )

data/assets/bylaws/push-to-master-was-punished.liquid

@@ -0,0 +1,7 @@
+(award
+  (explain "When someone pushes directly to the default branch, they get a penalty")
+  (aka
+    (let fee -16)
+    (give fee "as a basis")
+    "${fee} points")
+  )

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

@@ -0,0 +1,40 @@
+(award
+  (explain "When a bug is resolved, the person who was assigned to it gets a bonus")
+  (in hours "how many hours it took to resolve the bug")
+  (in self "1 if the bug was reported and resolved by the same person, otherwise zero")
+  (set days (div hours 24))
+  (aka
+    (let basis {{ 8 | times: love }})
+    (give basis "as a basis")
+    "award ${basis} points")
+
+  (aka
+    (let b1 {{ 4 | times: love }})
+    (let hours_threshold 24)
+    (set b1 (if (lt hours hours_threshold) b1 0))
+    (give b1 "for resolving it in less than ${hours_threshold} hours")
+    "add ${b1} points if it was resolved in less than ${hours_threshold} hours")
+
+  (aka
+    (let self_fee {{ 8 | times: anger }})
+    (set penalty_for_self (if (eq self 1) (times -1 self_fee) 0))
+    (give penalty_for_self "for resolving the bug reported by you earlier")
+    "deduct ${self_fee} points if they resolved the bug earlier reported by themselves")
+
+  (aka
+    (let day_fee {{ 0.5 | times: anger }})
+    (set b2 (times -1 (times days day_fee)))
+    (let days_fee_max -20)
+    (set b2 (max b2 days_fee_max))
+    (give b2 "for ${days} days of delay")
+    "deduct ${day_fee} points for each day of delay, but no more than ${days_fee_max} points")
+
+  (aka
+    (let max 24)
+    (set over (if (gt (total) max) (minus max (total)) 0))
+    (give over "to not go over the cap")
+    (let min 4)
+    (set least (if (lt (total) min) (minus min (total)) 0))
+    (give least "to give you at least something")
+    "make sure the reward is not larger than ${max} points and not smaller than ${min} points")
+  )

data/fbe.gemspec

@@ -48,6 +48,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'faraday-retry', '>0'
   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'

data/lib/fbe/award.rb

@@ -23,10 +23,11 @@
 # SOFTWARE.
 
 require 'factbase/syntax'
+require_relative 'fb'
 
 # A generator of awards.
 #
-# First, you should create a policy, using the same Lisp-ish syntax as
+# First, you should create a bylaw, using the same Lisp-ish syntax as
 # we use in queries to a Factbase, for example:
 #
 #  require 'fbe/award'
@@ -38,17 +39,17 @@ require 'factbase/syntax'
 #  puts b.points  # how many points to reward, a number
 #  puts b.greeting  # how to explain the reward, a text
 #
-# Or else, you can get a policy text:
+# Or else, you can get a bylaw text:
 #
-#  p = a.policy
-#  puts p.markdown  # Markdown of the policy
+#  p = a.bylaw
+#  puts p.markdown  # Markdown of the bylaw
 #
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 class Fbe::Award
   # Ctor.
-  # @param [String] query The query with the policy
+  # @param [String] query The query with the bylaw
   # @param [String] judge The name of the judge
   def initialize(query = nil, judge: $judge, global: $global, options: $options, loog: $loog)
     query = Fbe.pmp(fb: Fbe.fb, global:, options:, loog:).hr.send(judge.gsub('-', '_')) if query.nil?
@@ -66,13 +67,13 @@ class Fbe::Award
     bill
   end
 
-  # Build a policy object from this award query.
-  # @return [Fbe::Award::Policy] The policy
-  def policy
+  # Build a bylaw object from this award query.
+  # @return [Fbe::Award::Bylaw] The bylaw
+  def bylaw
     term = Factbase::Syntax.new(@query, term: Fbe::Award::PTerm).to_term
-    policy = Policy.new
-    term.publish_to(policy)
-    policy
+    bylaw = Bylaw.new
+    term.publish_to(bylaw)
+    bylaw
   end
 
   # A term for bill.
@@ -172,7 +173,7 @@ class Fbe::Award
     end
   end
 
-  # A term for policy.
+  # A term for bylaw.
   class PTerm
     def initialize(operator, operands)
       @op = operator
@@ -220,33 +221,33 @@ class Fbe::Award
       end
     end
 
-    def publish_to(policy)
+    def publish_to(bylaw)
       case @op
       when :award
         @operands.each do |o|
-          o.publish_to(policy)
+          o.publish_to(bylaw)
         rescue StandardError => e
           raise "Failure in #{o}: #{e.message}"
         end
       when :aka
         @operands[0..-2].each do |o|
-          o.publish_to(policy)
+          o.publish_to(bylaw)
         rescue StandardError => e
           raise "Failure in #{o}: #{e.message}"
         end
-        policy.revert(@operands.size - 1)
-        policy.line(to_p(@operands[@operands.size - 1]))
+        bylaw.revert(@operands.size - 1)
+        bylaw.line(to_p(@operands[@operands.size - 1]))
       when :explain
-        policy.intro(to_p(@operands[0]))
+        bylaw.intro(to_p(@operands[0]))
       when :in
-        policy.line("assume that #{to_p(@operands[0])} is #{to_p(@operands[1])}")
+        bylaw.line("assume that #{to_p(@operands[0])} is #{to_p(@operands[1])}")
       when :let
-        policy.line("let #{to_p(@operands[0])} be equal to #{to_p(@operands[1])}")
-        policy.let(@operands[0], @operands[1])
+        bylaw.line("let #{to_p(@operands[0])} be equal to #{to_p(@operands[1])}")
+        bylaw.let(@operands[0], @operands[1])
       when :set
-        policy.line("set #{to_p(@operands[0])} to #{to_p(@operands[1])}")
+        bylaw.line("set #{to_p(@operands[0])} to #{to_p(@operands[1])}")
       when :give
-        policy.line("award #{to_p(@operands[0])}")
+        bylaw.line("award #{to_p(@operands[0])}")
       else
         raise "Unknown term '#{@op}'"
       end
@@ -316,8 +317,8 @@ class Fbe::Award
     end
   end
 
-  # A policy.
-  class Policy
+  # A bylaw.
+  class Bylaw
     attr_reader :vars
 
     def initialize

data/lib/fbe/bylaws.rb

@@ -0,0 +1,42 @@
+# 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 'liquid'
+require_relative '../fbe'
+
+# A generator of policies/bylaws.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+def Fbe.bylaws(anger: 2, love: 2)
+  home = File.join(__dir__, '../../assets/bylaws')
+  raise "The directory with templates is absent '#{home}'" 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
+    )
+    [File.basename(f).gsub(/\.liquid$/, ''), formula]
+  end
+end

data/lib/fbe/conclude.rb

@@ -33,7 +33,7 @@ require_relative 'if_absent'
 # @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] logg The logging facility
+# @param [Loog] loog The logging facility
 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(&)
@@ -50,7 +50,7 @@ class Fbe::Conclude
   # @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] logg The logging facility
+  # @param [Loog] loog The logging facility
   def initialize(fb:, judge:, global:, options:, loog:)
     @fb = fb
     @judge = judge

data/lib/fbe/fb.rb

@@ -35,7 +35,7 @@ require_relative '../fbe'
 # @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] logg The logging facility
+# @param [Loog] loog The logging facility
 def Fbe.fb(fb: $fb, global: $global, options: $options, loog: $loog)
   global[:fb] ||=
     begin

data/lib/fbe/issue.rb

@@ -29,7 +29,7 @@ require_relative '../fbe'
 # @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] logg The logging facility
+# @param [Loog] loog The logging facility
 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/overwrite.rb

@@ -36,7 +36,7 @@ require_relative 'fb'
 #
 # @param [Factbase::Fact] fact The fact to modify
 # @param [String] property The name of the property to set
-# @param [Any] vqlue The value to set
+# @param [Any] value The value to set
 def Fbe.overwrite(fact, property, value, fb: Fbe.fb)
   raise 'The fact is nil' if fact.nil?
   raise "The property is not a String but #{property.class} (#{property})" unless property.is_a?(String)

data/lib/fbe/pmp.rb

@@ -31,7 +31,7 @@ require_relative '../fbe'
 # @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] logg The logging facility
+# @param [Loog] loog The logging facility
 def Fbe.pmp(fb: Fbe.fb, global: $global, options: $options, loog: $loog)
   others do |*args1|
     area = args1.first

data/lib/fbe/regularly.rb

@@ -32,7 +32,7 @@ require_relative 'fb'
 # @param [Integer] p_since_days Since when to collect stats, X days
 # @param [Factbase] fb The factbase
 # @param [String] judge The name of the judge, from the +judges+ tool
-# @param [Loog] logg The logging facility
+# @param [Loog] loog The logging facility
 def Fbe.regularly(area, p_every_days, p_since_days = nil, fb: Fbe.fb, judge: $judge, loog: $loog, &)
   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

data/lib/fbe/repeatedly.rb

@@ -32,7 +32,7 @@ require_relative 'overwrite'
 # @param [Integer] p_every_hours How frequently to run, every X hours
 # @param [Factbase] fb The factbase
 # @param [String] judge The name of the judge, from the +judges+ tool
-# @param [Loog] logg The logging facility
+# @param [Loog] loog The logging facility
 def Fbe.repeatedly(area, p_every_hours, fb: Fbe.fb, judge: $judge, loog: $loog, &)
   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

data/lib/fbe/who.rb

@@ -30,7 +30,7 @@ require_relative '../fbe'
 # @param [String] prop The property in the fact, with the ID
 # @param [Judges::Options] options The options coming from the +judges+ tool
 # @param [Hash] global The hash for global caching
-# @param [Loog] logg The logging facility
+# @param [Loog] loog The logging facility
 def Fbe.who(fact, prop = :who, options: $options, global: $global, loog: $loog)
   id = fact[prop.to_s]
   raise "There is no #{prop} property" if id.nil?

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.55'
+  VERSION = '0.0.56'
 end

data/test/fbe/test_award.rb

@@ -73,7 +73,7 @@ class TestAward < Minitest::Test
       'bug in 10 (<36) hours',
       '+30 as a basis'
     ].each { |t| assert(g.include?(t), g) }
-    md = a.policy.markdown
+    md = a.bylaw.markdown
     [
       'First, assume that _hours_ is hours',
       ', and award _b₂_'
@@ -129,7 +129,7 @@ class TestAward < Minitest::Test
       '(award (aka (let x 17) (give x "hey") "add ${x} when necessary"))' =>
         'Just add **17** when necessary'
     }.each do |q, t|
-      md = Fbe::Award.new(q).policy.markdown
+      md = Fbe::Award.new(q).bylaw.markdown
       assert(md.include?(t), md)
     end
   end

data/test/fbe/test_bylaws.rb

@@ -0,0 +1,126 @@
+# 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 'minitest/autorun'
+require 'loog'
+require_relative '../test__helper'
+require_relative '../../lib/fbe/award'
+require_relative '../../lib/fbe/bylaws'
+
+# Test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class TestBylaws < Minitest::Test
+  def test_simple
+    laws = Fbe.bylaws
+    assert(laws.size > 1)
+    assert(!laws['published-release-was-rewarded'].nil?)
+  end
+
+  def test_check_all_bills
+    awards = {
+      'published-release-was-rewarded' => {
+        { hoc: 0, contributors: 1 } => 24,
+        { hoc: 10, contributors: 1 } => 24,
+        { hoc: 100, contributors: 1 } => 24,
+        { hoc: 500, contributors: 1 } => 29,
+        { hoc: 1_000, contributors: 1 } => 32,
+        { hoc: 10_000, contributors: 1 } => 32,
+        { hoc: 30_000, contributors: 1 } => 32
+      },
+      'resolved-bug-was-rewarded' => {
+        { hours: 1, self: 0 } => 24,
+        { hours: 48, self: 0 } => 14,
+        { hours: 80, self: 0 } => 13,
+        { hours: 300, self: 0 } => 4,
+        { hours: 3_000, self: 0 } => 4,
+        { hours: 30_000, self: 0 } => 4,
+        { hours: 1, self: 1 } => 8
+      },
+      'push-to-master-was-punished' => {
+        {} => -16
+      },
+      'code-review-was-rewarded' => {
+        { hoc: 0, comments: 0, self: 0 } => 4,
+        { hoc: 3, comments: 0, self: 0 } => 4,
+        { hoc: 78, comments: 7, self: 0 } => 8,
+        { hoc: 600, comments: 1, self: 0 } => 10,
+        { hoc: 500, comments: 40, self: 0 } => 26,
+        { hoc: 5_000, comments: 100, self: 0 } => 32,
+        { hoc: 100, comments: 50, self: 1 } => 4,
+        { hoc: 10_000, comments: 200, self: 1 } => 4
+      },
+      'code-contribution-was-rewarded' => {
+        { hoc: 0, comments: 0, reviews: 0 } => 4,
+        { hoc: 3, comments: 0, reviews: 0 } => 4,
+        { hoc: 78, comments: 0, reviews: 0 } => 4,
+        { hoc: 78, comments: 1, reviews: 0 } => 4,
+        { hoc: 50, comments: 15, reviews: 0 } => 5,
+        { hoc: 50, comments: 25, reviews: 0 } => 4,
+        { hoc: 180, comments: 7, reviews: 2 } => 32,
+        { hoc: 150, comments: 5, reviews: 1 } => 31,
+        { hoc: 500, comments: 25, reviews: 2 } => 4,
+        { hoc: 99, comments: 6, reviews: 1 } => 26,
+        { hoc: 1_500, comments: 3, reviews: 0 } => 4,
+        { hoc: 15_000, comments: 40, reviews: 0 } => 4
+      },
+      'bug-report-was-rewarded' => {
+        {} => 16
+      },
+      'enhancement-suggestion-was-rewarded' => {
+        {} => 16
+      },
+      'dud-was-punished' => {
+        {} => -16
+      },
+      'bad-branch-name-was-punished' => {
+        {} => -12
+      }
+    }
+    awards.each do |title, pairs|
+      formula = Fbe.bylaws[title]
+      assert(!formula.nil?, title)
+      a = Fbe::Award.new(formula)
+      help = [
+        "  #{title}: {\n    ",
+        pairs.map do |args, _|
+          [
+            '{',
+            args.empty? ? '' : "#{args.map { |k, v| " #{k}: #{v.to_s.gsub(/(?<!^)([0-9]{3})$/, '_\1')}" }.join(',')} ",
+            "} => #{a.bill(args).points}"
+          ].join
+        end.join(",\n    "),
+        "\n  },"
+      ].join
+      pairs.each do |args, points|
+        b = a.bill(args)
+        next if b.points == points
+        raise \
+          "Wrong reward of #{b.points} points from #{title}, " \
+          "while #{points} expected (#{args}): #{b.greeting}\n\n#{help}"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fbe
 version: !ruby/object:Gem::Version
-  version: 0.0.55
+  version: 0.0.56
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-18 00:00:00.000000000 Z
+date: 2024-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -136,6 +136,20 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.5.1
 - !ruby/object:Gem::Dependency
   name: loog
   requirement: !ruby/object:Gem::Requirement
@@ -236,9 +250,19 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/bylaws/bad-branch-name-was-punished.liquid
+- assets/bylaws/bug-report-was-rewarded.liquid
+- assets/bylaws/code-contribution-was-rewarded.liquid
+- assets/bylaws/code-review-was-rewarded.liquid
+- assets/bylaws/dud-was-punished.liquid
+- assets/bylaws/enhancement-suggestion-was-rewarded.liquid
+- assets/bylaws/published-release-was-rewarded.liquid
+- assets/bylaws/push-to-master-was-punished.liquid
+- assets/bylaws/resolved-bug-was-rewarded.liquid
 - fbe.gemspec
 - lib/fbe.rb
 - lib/fbe/award.rb
+- lib/fbe/bylaws.rb
 - lib/fbe/conclude.rb
 - lib/fbe/copy.rb
 - lib/fbe/fb.rb
@@ -261,6 +285,7 @@ files:
 - rules/basic.fe
 - test/fbe/middleware/test_quota.rb
 - test/fbe/test_award.rb
+- test/fbe/test_bylaws.rb
 - test/fbe/test_conclude.rb
 - test/fbe/test_copy.rb
 - test/fbe/test_fb.rb