Module: Lazier::Object

Extended by:
ActiveSupport::Concern
Includes:
ActionView::Helpers::NumberHelper
Defined in:
lib/lazier/object.rb

Overview

Extensions for all objects.

Instance Method Summary collapse

Instance Method Details

#debug_dump(format = :yaml, must_raise = true) ⇒ String

Inspects an object.

Parameters:

  • format (defaults to: :yaml) —

    The format to use.

  • must_raise (Boolean) (defaults to: true) —

    If raise a Dump exception.

Returns:

  • (String) —

    The object inspected and formatted.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/lazier/object.rb', line 162

def debug_dump(format = :yaml, must_raise = true)
  rv = ""

  begin
    if format == :pretty_json then
      rv = ::JSON.pretty_generate(self)
    else
      rv = self.send("to_#{format}")
    end
  rescue
    rv = self.inspect
  end

  must_raise ? raise(::Lazier::Exceptions::Dump.new(rv)) : rv
end

#ensure_array ⇒ Array

Makes sure that the object is an array. For non array objects, return a single element array containing the object.

Returns:

  • (Array) —

    If the object is an array, then the object itself, a single element array containing the object otherwise.



64
65
66
 
# File 'lib/lazier/object.rb', line 64

def ensure_array
  self.is_a?(::Array) ? self : [self]
end

#ensure_string ⇒ String

Makes sure that the object is a string. For nil, it returns "".

Returns:

  • (String) —

    The string representation of the object.



71
72
73
74
75
76
77
 
# File 'lib/lazier/object.rb', line 71

def ensure_string
  if self.is_a?(::String) then
    self
  else
    self.present? ? self.to_s : ""
  end
end

#format_boolean(true_name = nil, false_name = nil) ⇒ String

Formats a boolean.

Parameters:

  • true_name (String) (defaults to: nil) —

    The string representation of true. Defaults to Yes.

  • false_name (String) (defaults to: nil) —

    The string representation of false. Defaults to No.

Returns:

  • (String) —

    The string representation of the object.

See Also:



148
149
150
151
152
153
154
155
 
# File 'lib/lazier/object.rb', line 148

def format_boolean(true_name = nil, false_name = nil)
  names = {
    true => true_name || ::Lazier.settings.boolean_names[true],
    false => false_name || ::Lazier.settings.boolean_names[false]
  }

  names[self.to_boolean]
end

#format_number(prec = nil, decimal_separator = nil, add_string = nil, k_separator = nil) ⇒ String

Formats a number.

Parameters:

  • prec (Fixnum) (defaults to: nil) —

    The precision to show.

  • decimal_separator (String) (defaults to: nil) —

    The string to use as decimal separator.

  • add_string (String) (defaults to: nil) —

    The string to append to the number.

  • k_separator (String) (defaults to: nil) —

    The string to use as thousands separator.

Returns:

  • (String) —

    The string representation of the object.

See Also:



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/lazier/object.rb', line 126

def format_number(prec = nil, decimal_separator = nil, add_string = nil, k_separator = nil)
  prec ||= ::Lazier.settings.format_number[:prec]
  decimal_separator ||= ::Lazier.settings.format_number[:decimal_separator]
  add_string ||= ::Lazier.settings.format_number[:add_string]
  k_separator ||= ::Lazier.settings.format_number[:k_separator]
  format = "%n"
  unit = ""

  if add_string.present? then
    format = "%n %u"
    unit = add_string
  end

  (self.is_number? && prec >= 0) ? number_to_currency(self, {precision: prec, separator: decimal_separator, delimiter: k_separator, format: format, unit: unit}) : nil
end

#is_boolean? ⇒ Boolean

Checks if the object is a valid boolean value.

Returns:

  • (Boolean) —

    true is a valid boolean value, false otherwise.



57
58
59
 
# File 'lib/lazier/object.rb', line 57

def is_boolean?
  self.is_a?(::TrueClass) || self.is_a?(::FalseClass) || self.is_a?(::NilClass) || (self.ensure_string.strip =~ /^(1|0|true|false|yes|no|t|f|y|n)$/i)
end

#is_float? ⇒ Boolean

Checks if the object is a valid float.

Returns:

  • (Boolean) —

    true is a valid float, false otherwise.



50
51
52
 
# File 'lib/lazier/object.rb', line 50

def is_float?
  self.is_a?(::Float) || /^([+-]?)(\d+)([.,]\d+)?$/.match(self.normalize_number)
end

#is_integer? ⇒ Boolean

Checks if the object is a valid integer.

Returns:

  • (Boolean) —

    true is a valid integer, false otherwise.



43
44
45
 
# File 'lib/lazier/object.rb', line 43

def is_integer?
  self.is_a?(::Integer) || /^([+-]?)(\d+)$/.match(self.normalize_number)
end

#is_number? ⇒ Boolean

Checks if the object is a valid number.

Returns:

  • (Boolean) —

    true is a valid number, false otherwise.



36
37
38
 
# File 'lib/lazier/object.rb', line 36

def is_number?
  self.is_float?
end

#normalize_number ⇒ String

Normalizes a number for conversion. Basically this methods removes all separator and ensures that . is used for decimal separator.

Returns:

  • (String) —

    The normalized number.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/lazier/object.rb', line 16

def normalize_number
  rv = ""

  if self == true then
    rv = "1"
  elsif !self then
    rv = "0"
  else
    rv = self.ensure_string.strip
    rv = rv.split(/[\.,]/)
    rv[-1] = "." + rv[-1] if rv.length > 1
    rv = rv.join("")
  end

  rv
end

#round_to_precision(prec = 2) ⇒ Float

Returns the rounded float representaton of the object.

Parameters:

  • prec (Fixnum) (defaults to: 2) —

    The precision to keep.

Returns:

  • (Float) —

    The rounded float representaton of the object.



114
115
116
 
# File 'lib/lazier/object.rb', line 114

def round_to_precision(prec = 2)
  (self.is_number? && prec >= 0) ? number_with_precision(self, precision: prec) : nil
end

#to_boolean ⇒ Boolean

Converts the object to a boolean.

Returns:

  • (Boolean) —

    The boolean representation of the object.



104
105
106
107
108
 
# File 'lib/lazier/object.rb', line 104

def to_boolean
  rv = self
  rv = rv.to_i if rv.is_a?(::Float)
  (rv.is_a?(TrueClass) || /^(1|on|true|yes|t|y)$/i.match(rv.ensure_string.strip)) ? true : false
end

#to_float(default_value = 0.0) ⇒ Float

Converts the object to a float.

Parameters:

  • default_value (Float) (defaults to: 0.0) —

    The value to return if the conversion is not possible.

Returns:

  • (Float) —

    The float representation of the object.



83
84
85
86
87
88
89
90
91
 
# File 'lib/lazier/object.rb', line 83

def to_float(default_value = 0.0)
  if self.is_a?(::Float)
    self
  elsif self.is_a?(::Integer)
    self.to_f
  else
    self.is_float? ? ::Kernel.Float(self.normalize_number) : default_value
  end
end

#to_integer(default_value = 0) ⇒ Fixnum

Converts the object to a integer.

Parameters:

  • default_value (Fixnum) (defaults to: 0) —

    The value to return if the conversion is not possible.

Returns:

  • (Fixnum) —

    The integer representation of the object.



97
98
99
 
# File 'lib/lazier/object.rb', line 97

def to_integer(default_value = 0)
  self.is_a?(::Integer) ? self : self.to_float(default_value).to_i
end