Class Text::Format::Number
In: lib/text/format/number.rb
Parent: Object
Alpha Roman Number lib/text/format.rb lib/text/format/alpha.rb lib/text/format/roman.rb lib/text/format/number.rb Format Text Module: Text

Provides a numbering object that will produce numbers. Accepts three parameters for numbering that will control how the numbers are presented when given as #[](index).

:offset:The number to add to the index in order to produce the proper index. This is because tag_text indexes from 0, not 1. This defaults to 1.
:postfix:The value that will be appended to the number presented by #[]. Defaults to nil.
:prefix:The value that will be prepended to the number presented by #[]. Defaults to nil.
  n1 = Text::Format::Number.new(:postfix => ".")
  puts n1[0]  # => "1."
  puts n1[1]  # => "2.

  n2 = Text::Format::Number.new(:prefix => "2.")
  puts n2[0]  # => "2.1"
  puts n2[1]  # => "2.2"

  n3 = Text::Format::Number.new(:offset => 3)
  puts n3[0]  # => "3"
  puts n3[1]  # => "4"

Methods

[]   new  

Public Class methods

[Source]

    # File lib/text/format/number.rb, line 29
29:   def initialize(options = {}) #:yields self:
30:     @offset   = options[:offset].to_i || 1
31:     @postfix  = options[:postfix]     || nil
32:     @prefix   = options[:prefix]      || nil
33:   end

Public Instance methods

[Source]

    # File lib/text/format/number.rb, line 25
25:   def [](index)
26:     "#{@prefix}#{index + @offset}#{@postfix}"
27:   end

[Validate]