fbe 0.0.22 → 0.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0049f50b79fc11504fa48a1b8bf6f3245ec73673068254b639a342996467d3ae'
-  data.tar.gz: dae993c649a54a5e8a653d4a55128482d1350bbf07a9942cc5bce674a92f85b8
+  metadata.gz: b13ad3c8a5578c4a9e248948cab63ae21caeea7052d96260f2be85a43ee6f3b8
+  data.tar.gz: 90f8b081a67be3fd2f94a92cea890abb9b93f9b4b11a37a7bc6502f704c16510
 SHA512:
-  metadata.gz: b0b56a583dc6236fe4539192b10954cb5d16c3acad9f9193de6ed0d77fb14caab012fda9dbf25bfb416cd88ae601cdc710d28312f454ea93cb3144ee75cb3114
-  data.tar.gz: 1393af02f45e78b354d0bba98706427bba9c769ffa39f029973ef209e85b401ac9d021421af08ab9f5a3f997e51ce8b4f0861ca0ba42b2a184645671ae56143f
+  metadata.gz: 9ea216f0e9be56b06ae8e350ea89b341f9d9fc230ca7785f5b0c0a494fcba3de913143e9c0c5d7074eea3ad368520bfaa462f891c5daf744b4ababbf05e600e8
+  data.tar.gz: 28c70598550a0e68ad1315fee0adce8ebeb31a7eb400f348181c0f916b3b5aac646a1d4f8d51d79f70e5553f3a4a88b33ba4afd67f2075a735cb578ea5312f0c

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.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.23'
 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/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.23
 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