Class: Fbe::Award::Bill

Inherits:
Object
  • Object
show all
Defined in:
lib/fbe/award.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Bill

Creates a new empty bill.

Examples:

bill = Fbe::Award::Bill.new


333
334
335
336
 
# File 'lib/fbe/award.rb', line 333

def initialize
  @lines = []
  @vars = {}
end

Instance Attribute Details

#vars ⇒ Object (readonly)

Returns the value of attribute vars.



327
328
329
 
# File 'lib/fbe/award.rb', line 327

def vars
  @vars
end

Instance Method Details

#greeting ⇒ String

Generates a human-readable summary of the bill.

Examples:

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. "

Returns:

  • (String) —

    A description of the points earned



384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/fbe/award.rb', line 384

def greeting
  items = @lines.map { |l| "#{format('%+d', l[:v])} #{l[:t]}" }
  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

#line(value, text) ⇒ nil

Note:

Zero-valued points are ignored

Adds a point value with explanatory text to the bill.

Examples:

bill = Fbe::Award::Bill.new
bill.line(50, "for code review")

Parameters:

  • value (Integer, Float) —

    The point value to add

  • text (String) —

    The explanation for these points

Returns:

  • (nil) 


359
360
361
362
363
 
# File 'lib/fbe/award.rb', line 359

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

#points ⇒ Integer

Calculates the total points in this bill.

Examples:

bill = Fbe::Award::Bill.new
bill.line(42.5, "for answer")
bill.points #=> 43

Returns:

  • (Integer) —

    The sum of all point values, rounded to an integer



372
373
374
 
# File 'lib/fbe/award.rb', line 372

def points
  Integer(Float(@lines.sum { |l| l[:v] }).round.to_s, 10)
end

#set(var, value) ⇒ Object

Sets a variable in the bill's context.

Examples:

bill = Fbe::Award::Bill.new
bill.set(:lines_of_code, 500)

Parameters:

  • var (Symbol) —

    The variable name

  • value (Object) —

    The value to assign

Returns:

  • (Object) —

    The assigned value



346
347
348
 
# File 'lib/fbe/award.rb', line 346

def set(var, value)
  @vars[var] = value
end