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: [], case_sensitive: false, value: nil) ⇒ Unit

Returns a new instance of Unit.



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

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

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

Instance Attribute Details

#case_sensitive ⇒ Object (readonly)

Returns the value of attribute case_sensitive.



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

def case_sensitive
  @case_sensitive
end

#conversion_amount ⇒ Object (readonly)

Returns the value of attribute conversion_amount.



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

def conversion_amount
  @conversion_amount
end

#conversion_unit ⇒ Object (readonly)

Returns the value of attribute conversion_unit.



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

def conversion_unit
  @conversion_unit
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



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

def name
  @name
end

#names ⇒ Object (readonly)

Returns the value of attribute names.



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

def names
  @names
end

Instance Method Details

#<=>(other) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/measured/unit.rb', line 38

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 



22
23
24
 
# File 'lib/measured/unit.rb', line 22

def add_alias(aliases)
  @names = (@names << aliases).flatten.sort
end

#inspect ⇒ Object 



34
35
36
 
# File 'lib/measured/unit.rb', line 34

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

#inverse_conversion_amount ⇒ Object 



50
51
52
 
# File 'lib/measured/unit.rb', line 50

def inverse_conversion_amount
  1 / conversion_amount.to_r
end

#name_eql?(name_to_compare) ⇒ Boolean

Returns:

  • (Boolean) 


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

def name_eql?(name_to_compare)
  with_case_sensitivity(self.name).include?(with_case_sensitivity(name_to_compare).join)
end

#names_include?(name_to_compare) ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/measured/unit.rb', line 18

def names_include?(name_to_compare)
  with_case_sensitivity(self.names).include?(with_case_sensitivity(name_to_compare).join)
end

#to_s ⇒ Object 



26
27
28
29
30
31
32
 
# File 'lib/measured/unit.rb', line 26

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