fbe 0.0.22 → 0.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0049f50b79fc11504fa48a1b8bf6f3245ec73673068254b639a342996467d3ae'
-  data.tar.gz: dae993c649a54a5e8a653d4a55128482d1350bbf07a9942cc5bce674a92f85b8
+  metadata.gz: 37b5cbcd563d2e31074d5f6625d32fd118a5302a4bcd021492639573e657b03e
+  data.tar.gz: 1045c3932e3952740ed611c42e0ed034de522281496cb7a5bc9953b1aa821eef
 SHA512:
-  metadata.gz: b0b56a583dc6236fe4539192b10954cb5d16c3acad9f9193de6ed0d77fb14caab012fda9dbf25bfb416cd88ae601cdc710d28312f454ea93cb3144ee75cb3114
-  data.tar.gz: 1393af02f45e78b354d0bba98706427bba9c769ffa39f029973ef209e85b401ac9d021421af08ab9f5a3f997e51ce8b4f0861ca0ba42b2a184645671ae56143f
+  metadata.gz: 4fb03336064109e32074c267d9a21520e1e24e5b4ced00ab38f06df2b6f6d80f9d9c4cb899fb2e35cf3706d78f2d24b99351e6a096b0eafe00aced686b7bda31
+  data.tar.gz: 898b56d6e5ad162e52fa457582014106d9155499a10d5b8b5448f41bf8dc094cf16df3d2ef13d9601eec606b0293ca3f276fd750897069e0a1f4c383d26d1cc6

data/Gemfile

@@ -32,4 +32,5 @@ gem 'rubocop-performance', '1.21.1', require: false
 gem 'rubocop-rspec', '3.0.3', require: false
 gem 'simplecov', '0.22.0', require: false
 gem 'simplecov-cobertura', '2.1.0', require: false
+gem 'webmock', '3.23.1', require: false
 gem 'yard', '0.9.36', require: false

data/Gemfile.lock

@@ -55,6 +55,9 @@ GEM
     builder (3.3.0)
     concurrent-ruby (1.3.3)
     connection_pool (2.4.1)
+    crack (1.0.0)
+      bigdecimal
+      rexml
     crass (1.0.6)
     decoor (0.0.1)
     diff-lcs (1.5.1)
@@ -87,7 +90,8 @@ GEM
     ffi (1.17.0-x64-mingw-ucrt)
     ffi (1.17.0-x86_64-darwin)
     ffi (1.17.0-x86_64-linux-gnu)
-    gli (2.21.3)
+    gli (2.21.5)
+    hashdiff (1.1.0)
     i18n (1.14.5)
       concurrent-ruby (~> 1.0)
     io-console (0.7.2)
@@ -241,6 +245,10 @@ GEM
     verbose (0.0.2)
       loog (~> 0.2)
       tago (~> 0.0)
+    webmock (3.23.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
     webrick (1.8.1)
     yaml (0.3.0)
     yard (0.9.36)
@@ -263,6 +271,7 @@ DEPENDENCIES
   rubocop-rspec (= 3.0.3)
   simplecov (= 0.22.0)
   simplecov-cobertura (= 2.1.0)
+  webmock (= 3.23.1)
   yard (= 0.9.36)
 
 BUNDLED WITH

data/README.md

@@ -1,4 +1,4 @@
-# FactBase Extended
+# FactBase Extended (FBE)
 
 [![DevOps By Rultor.com](http://www.rultor.com/b/zerocracy/fbe)](http://www.rultor.com/p/zerocracy/fbe)
 [![We recommend RubyMine](https://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)
@@ -13,12 +13,14 @@
 
 It's a collection of tools for
 [zerocracy/judges-action](https://github.com/zerocracy/judges-action).
+You are not supposed to use it directly, but only in a combination
+with other tools of Zerocracy.
 
 ## How to contribute
 
 Read
 [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
-Make sure you build is green before you contribute
+Make sure your build is green before you contribute
 your pull request. You will need to have
 [Ruby](https://www.ruby-lang.org/en/) 3.2+ and
 [Bundler](https://bundler.io/) installed. Then:

data/lib/fbe/award.rb

@@ -24,7 +24,25 @@
 
 require 'factbase/syntax'
 
-# Award generator.
+# A generator of awards.
+#
+# First, you should create a policy, using the same Lisp-ish syntax as
+# we use in queries to a Factbase, for example:
+#
+#  require 'fbe/award'
+#  a = Fbe::Award.new('(award (in loc "lines") (give (times loc 5) "for LoC"))')
+#
+# Then, you can either get a bill from it:
+#
+#  b = a.bill(loc: 345)
+#  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:
+#
+#  p = a.policy
+#  puts p.markdown  # Markdown of the policy
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
@@ -266,7 +284,14 @@ class Fbe::Award
 
     def greeting
       items = @lines.map { |l| "#{format('%+d', l[:v])} #{l[:t]}" }
-      "You've earned #{format('%+d', points)} points for this: #{items.join('; ')}. "
+      case items.size
+      when 0
+        "You've earned nothing. "
+      when 1
+        "You've earned #{format('%+d', points)} points. "
+      else
+        "You've earned #{format('%+d', points)} points for this: #{items.join('; ')}. "
+      end
     end
   end
 
@@ -289,7 +314,7 @@ class Fbe::Award
     end
 
     def line(line)
-      line = line.gsub(/\$\{([a-z_0-9]+)\}/) { |_x| @lets[Regexp.last_match[1].to_sym] }
+      line = line.gsub(/\$\{([a-z_0-9]+)\}/) { |_x| "**#{@lets[Regexp.last_match[1].to_sym]}**" }
       @lines << line
     end
 

data/lib/fbe/octo.rb

@@ -57,9 +57,14 @@ def Fbe.octo(options: $options, global: $global, loog: $loog)
         }
       }
       stack = Faraday::RackBuilder.new do |builder|
-        builder.use(Faraday::Retry::Middleware)
-        builder.use(Faraday::HttpCache, serializer: Marshal, shared_cache: false)
+        builder.use(
+          Faraday::Retry::Middleware,
+          exceptions: Faraday::Retry::Middleware::DEFAULT_EXCEPTIONS + [Octokit::TooManyRequests],
+          max: 5, interval: 1
+        )
+        builder.use(Faraday::HttpCache, serializer: Marshal, shared_cache: false, logger: Loog::NULL)
         builder.use(Octokit::Response::RaiseError)
+        builder.use(Faraday::Response::Logger, Loog::NULL)
         builder.adapter(Faraday.default_adapter)
       end
       o.middleware = stack

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.22'
+  VERSION = '0.0.24'
 end

data/test/fbe/test_award.rb

@@ -92,10 +92,20 @@ class TestAward < Minitest::Test
       '(award (let x_a 25) (set z (plus x_a 1)) (give z "..."))' =>
         'First, let _x-a_ be equal to **25**. Then, set _z_ to _x-a_ + **1**, and award _z_.',
       '(award (aka (let x 17) (give x "hey") "add ${x} when necessary"))' =>
-        'Just add 17 when necessary'
+        'Just add **17** when necessary'
     }.each do |q, t|
       md = Fbe::Award.new(q).policy.markdown
       assert(md.include?(t), md)
     end
   end
+
+  def test_shorten_when_one_number
+    g = Fbe::Award.new('(award (give 23 "for love"))').bill.greeting
+    assert_equal('You\'ve earned +23 points. ', g, g)
+  end
+
+  def test_shorten_when_nothing
+    g = Fbe::Award.new('(award (give 0 "for none"))').bill.greeting
+    assert_equal('You\'ve earned nothing. ', g, g)
+  end
 end

data/test/fbe/test_octo.rb

@@ -24,6 +24,7 @@
 
 require 'minitest/autorun'
 require 'judges/options'
+require 'webmock/minitest'
 require 'loog'
 require_relative '../test__helper'
 require_relative '../../lib/fbe/octo'
@@ -54,8 +55,34 @@ class TestOcto < Minitest::Test
     assert_equal(100, o.rate_limit.remaining)
   end
 
+  def test_caching
+    WebMock.disable_net_connect!
+    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' })
+      .times(1)
+      .then
+      .to_raise('second request should be cached, not passed to GitHub API!')
+    o.user('yegor256')
+    o.user('yegor256')
+  end
+
+  def test_retrying
+    WebMock.disable_net_connect!
+    global = {}
+    o = Fbe.octo(loog: Loog::NULL, global:, options: Judges::Options.new)
+    stub_request(:get, 'https://api.github.com/users/yegor256')
+      .to_raise(Octokit::TooManyRequests.new)
+      .times(1)
+      .then
+      .to_return(status: 200, body: '{}')
+    o.user('yegor256')
+  end
+
   def test_with_broken_token
     skip # it's a "live" test, run it manually if you need it
+    WebMock.enable_net_connect!
     global = {}
     options = Judges::Options.new({ 'github_token' => 'incorrect-value' })
     o = Fbe.octo(loog: Loog::NULL, global:, options:)
@@ -64,6 +91,7 @@ class TestOcto < Minitest::Test
 
   def test_commit_pulls
     skip # it's a "live" test, run it manually if you need it
+    WebMock.enable_net_connect!
     o = Fbe.octo(loog: Loog::NULL, global: {}, options: Judges::Options.new)
     assert_equal(1, o.commit_pulls('zerocracy/fbe', '0b7d0699bd744b62c0731064c2adaad0c58e1416').size)
     assert_equal(0, o.commit_pulls('zerocracy/fbe', '16b3ea6b71c6e932ba7666c40ca846ecaa6d6f0d').size)

data/test/test__helper.rb

@@ -22,6 +22,9 @@
 
 $stdout.sync = true
 
+require 'minitest/reporters'
+Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new]
+
 require 'simplecov'
 SimpleCov.start
 
@@ -29,6 +32,3 @@ require 'simplecov-cobertura'
 SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
 
 require 'minitest/autorun'
-
-require 'minitest/reporters'
-Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new]

metadata

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