Class: Measured::Unit

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/measured/unit.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, aliases: [], value: nil) ⇒ Unit

Returns a new instance of Unit.



4
5
6
7
8
9
 
# File 'lib/measured/unit.rb', line 4

def initialize(name, aliases: [], value: nil)
  @name = name.to_s
  @names = ([@name] + aliases.map{|n| n.to_s }).sort

  @conversion_amount, @conversion_unit = parse_value(value) if value
end

Instance Attribute Details

#conversion_amount ⇒ Object (readonly)

Returns the value of attribute conversion_amount.



11
12
13
 
# File 'lib/measured/unit.rb', line 11

def conversion_amount
  @conversion_amount
end

#conversion_unit ⇒ Object (readonly)

Returns the value of attribute conversion_unit.



11
12
13
 
# File 'lib/measured/unit.rb', line 11

def conversion_unit
  @conversion_unit
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



11
12
13
 
# File 'lib/measured/unit.rb', line 11

def name
  @name
end

#names ⇒ Object (readonly)

Returns the value of attribute names.



11
12
13
 
# File 'lib/measured/unit.rb', line 11

def names
  @names
end

Instance Method Details

#<=>(other) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/measured/unit.rb', line 41

def <=>(other)
  if self.class == other.class
    if other.names != @names
      other.names <=> @names
    else
      other.conversion_amount <=> @conversion_amount
    end
  else
    @name <=> other
  end
end

#add_alias(aliases) ⇒ Object 



25
26
27
 
# File 'lib/measured/unit.rb', line 25

def add_alias(aliases)
  @names = (@names << aliases).flatten.sort unless aliases.nil? || aliases.empty?
end

#inspect ⇒ Object 



37
38
39
 
# File 'lib/measured/unit.rb', line 37

def inspect
  "#<Measured::Unit: #{ @name } (#{ @names.join(", ") }) #{ conversion_string }>"
end

#inverse_conversion_amount ⇒ Object 



53
54
55
 
# File 'lib/measured/unit.rb', line 53

def inverse_conversion_amount
  1 / conversion_amount.to_r
end

#name_eql?(name_to_compare, case_sensitive: false) ⇒ Boolean

Returns:

  • (Boolean) 


13
14
15
16
17
 
# File 'lib/measured/unit.rb', line 13

def name_eql?(name_to_compare, case_sensitive: false)
  return false unless name_to_compare.present?
  name_to_compare = name_to_compare.to_s
  case_sensitive ? @name.eql?(name_to_compare) : case_insensitive(@name).include?(name_to_compare.downcase)
end

#names_include?(name_to_compare, case_sensitive: false) ⇒ Boolean

Returns:

  • (Boolean) 


19
20
21
22
23
 
# File 'lib/measured/unit.rb', line 19

def names_include?(name_to_compare, case_sensitive: false)
  return false unless name_to_compare.present?
  name_to_compare = name_to_compare.to_s
  case_sensitive ? @names.include?(name_to_compare) : case_insensitive(@names).include?(name_to_compare.downcase)
end

#to_s ⇒ Object 



29
30
31
32
33
34
35
 
# File 'lib/measured/unit.rb', line 29

def to_s
  if conversion_string
    "#{ @name } (#{ conversion_string })"
  else
    @name
  end
end