ruby-units 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4469dec705c5d77901aca55e790e97160ef23648
-  data.tar.gz: 9482d71c9eef96842fdfb3d3f18f29726b6eed83
+  metadata.gz: 8e6acf899cc64a4b47d9bed66ea695ee59e3d26b
+  data.tar.gz: 6c04d8f9069b6944cb0ca0f32adf74a722b9036d
 SHA512:
-  metadata.gz: 86f7e2337fef38a8ed931382684b4f2f8b2f75693e3df8055abd1b1a4df453640b85e557619ac9e5ccd3c814be4c38ca0748c32524138679648404cb8916a775
-  data.tar.gz: ba383e2fe3d816c7f100cfe26e6f48e85c3ced35a646d1fbd9faf92a3e6a6be62be94b87f951a00639bd64cfd158faf70999de9b25a867345bb65f11c2ff120b
+  metadata.gz: 594ca11e51bcd2090f715ff431059045ec981cf758f9b72771faa8978d1dee8ac3677dc4b78b3552dc9786ffa3c62ee7f377569213dd6b43b5245a4b8ffc3f36
+  data.tar.gz: 8ce5144320bb529a3b4c6eea632e17a424997f458a1efd18b4a6fa6ec5ceb9c7dd2fbf4f93ce349e528cb745327c118690518370cda3327aa3ecabb50b7c4e5d

data/CHANGELOG.txt

@@ -1,5 +1,8 @@
 Change Log for Ruby-units
 =========================
+2016-12-28  2.1.0   * add support for ruby 2.4.0
+                    * allow configuration for optional separator on output
+                    * Fix issue #105 -- change 'grad' to 'gon'
 2015-11-07  2.0.0   * remove support for ruby versions less than 2.0
                     * remove `.unit` and `.u` from String
                     * remove `.unit` from Date

data/README.md

@@ -118,6 +118,7 @@ Unit.new('1.5 mm').to_s("%0.2f")  # "1.50 mm".  Enter any valid format
 Unit.new('1.5 mm').to_s("in")     # converts to inches before printing
 Unit.new("2 m").to_s(:ft)         # returns 6'7"
 Unit.new("100 kg").to_s(:lbs)     # returns 220 lbs, 7 oz
+Unit.new("100 kg").to_s(:stone)   # returns 15 stone, 10 lb
 ```
 
 Time Helpers
@@ -228,9 +229,21 @@ Unit.redefine!("cup") do |cup|
 end
 ```
 
+### Useful methods
+
+1. `scalar` will return the numeric portion of the unit without the attached units
+2. `base_scalar` will return the scalar in base units (SI)
+3. `units` will return the name of the units (without the scalar)
+4. `base` will return the unit converted to base units (SI)
+
+### Storing in a database
+
+Units can be stored in a database as either the string representation or in two separate columns defining the scalar and the units.
+Note that if sorting by units is desired you will want to ensure that you are storing the scalars in a consistent unit (i.e, the base units).
+
 ### Namespaced Class
 
-Sometimes the default class 'Unit' may conflict with other gems or applications. Internally ruby-units defines itself using the RubyUnits namespace. The actual class of a unit is the RubyUnits::Unit. For simplicity and backwards compatiblity, the '::Unit' class is defined as an alias to '::RubyUnits::Unit'.
+Sometimes the default class 'Unit' may conflict with other gems or applications. Internally ruby-units defines itself using the RubyUnits namespace. The actual class of a unit is the RubyUnits::Unit. For simplicity and backwards compatibility, the '::Unit' class is defined as an alias to '::RubyUnits::Unit'.
 
 To load ruby-units without this alias...
 
@@ -245,3 +258,37 @@ gem 'ruby-units', require: 'ruby_units/namespaced'
 ```
 
 Note: when using the namespaced version, the Unit.new('unit string') helper will not be defined.
+
+### Configuration
+
+Configuration options can be set like:
+
+```
+RubyUnits.configure do |config|
+  config.separator = false
+end
+```
+
+Currently there is only one configuration you can set:
+
+1. separator (true/false): should a space be used to separate the scalar from the unit part during output.
+
+
+### NOTES
+
+#### Mathn
+
+Note that the current implementation of ruby-units requires 'mathn' from the ruby standard library.
+This tends to change the behavior of integer math in ways that many people do not expect, and can be the source
+of numerous bugs and odd behaviors.  If you encounter what appears to be a bug in your code that seems to be related
+
+to the use of ruby-units, try to reproduce the bug by just including 'mathn' by itself.
+
+If you identify a bug in a gem or code that uses mathn, please file a bug report or create a pull request to fix it.
+
+#### Performance vs. Accuracy
+
+Ruby units was originally intended to provide a robust and accurate way to do arbitrary unit conversions.  
+In some cases, these conversions can result in the creation and garbage collection of a lot of intermediate objects during
+calculations.  This in turn can have a negative impact on performance.  The design of ruby-units has emphasized accuracy
+over speed.  YMMV if you are doing a lot of math involving units.

data/VERSION

@@ -1 +1 @@
-2.0.1
+2.1.0

data/lib/ruby_units/cache.rb

@@ -1,20 +1,21 @@
-class RubyUnits::Unit < Numeric
-  @@cached_units = {}
-  
-  class Cache
-    def self.get(key = nil)
-      key.nil? ? @@cached_units : @@cached_units[key]
-    end
-  
-    def self.set(key, value)
-      @@cached_units[key] = value
-    end
+module RubyUnits
+  class Unit < Numeric
+    @@cached_units = {}
+
+    class Cache
+      def self.get(key = nil)
+        key.nil? ? @@cached_units : @@cached_units[key]
+      end
+
+      def self.set(key, value)
+        @@cached_units[key] = value
+      end
 
-    def self.clear
-      @@cached_units = {}
-      @@base_unit_cache = {}
-      Unit.new(1)
+      def self.clear
+        @@cached_units = {}
+        @@base_unit_cache = {}
+        Unit.new(1)
+      end
     end
-    
   end
 end

data/lib/ruby_units/configuration.rb

@@ -0,0 +1,41 @@
+# allow for optional configuration of RubyUnits
+#
+# Usage:
+#
+#     RubyUnits.configure do |config|
+#       config.separator = false
+#     end
+module RubyUnits
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  # holds actual configuration values for RubyUnits
+  class Configuration
+    # used to separate the scalar from the unit when generating output.
+    # set to nil to prevent adding a space to the string representation of a unit
+    # separators other than ' ' and '' may work, but you may encounter problems
+    attr_reader :separator
+
+    def initialize
+      self.separator = true
+    end
+
+    def separator=(value)
+      raise ArgumentError, "configuration 'separator' may only be true or false" unless value.class == TrueClass || value.class == FalseClass
+      @separator = value ? ' ' : nil
+    end
+  end
+end

data/lib/ruby_units/date.rb

@@ -3,7 +3,7 @@ require 'date'
 # Allow date objects to do offsets by a time unit
 # Date.today + Unit.new("1 week") => gives today+1 week
 class Date
-  alias_method :unit_date_add, :+
+  alias unit_date_add +
   # @param [Object] other
   # @return [Unit]
   def +(other)
@@ -16,7 +16,7 @@ class Date
     end
   end
 
-  alias_method :unit_date_sub, :-
+  alias unit_date_sub -
   # @param [Object] other
   # @return [Unit]
   def -(other)
@@ -46,7 +46,7 @@ class Date
   end
   # :nocov_19:
 
-  alias_method :units_datetime_inspect, :inspect
+  alias units_datetime_inspect inspect
   # @deprecated
   def inspect(dump = false)
     return units_datetime_inspect if dump

data/lib/ruby_units/definition.rb

@@ -1,8 +1,6 @@
 class RubyUnits::Unit < Numeric
-
   # Handle the definition of units
   class Definition
-
     # @return [Array]
     attr_writer :aliases
 
@@ -30,14 +28,14 @@ class RubyUnits::Unit < Numeric
     #     unit.definition = RubyUnits::Unit.new("7/4 inches")
     #   end
     #
-    def initialize(_name, _definition = [], &block)
+    def initialize(name, definition = [])
       yield self if block_given?
-      self.name     ||= _name.gsub(/[<>]/,'')
-      @aliases      ||= (_definition[0] || [_name])
-      @scalar       ||= _definition[1]
-      @kind         ||= _definition[2]
-      @numerator    ||= _definition[3] || RubyUnits::Unit::UNITY_ARRAY
-      @denominator  ||= _definition[4] || RubyUnits::Unit::UNITY_ARRAY
+      self.name     ||= name.gsub(/[<>]/, '')
+      @aliases      ||= (definition[0] || [name])
+      @scalar       ||= definition[1]
+      @kind         ||= definition[2]
+      @numerator    ||= definition[3] || RubyUnits::Unit::UNITY_ARRAY
+      @denominator  ||= definition[4] || RubyUnits::Unit::UNITY_ARRAY
       @display_name ||= @aliases.first
     end
 
@@ -46,14 +44,14 @@ class RubyUnits::Unit < Numeric
     # @return [String, nil]
     # @todo refactor Unit and Unit::Definition so we don't need to wrap units with angle brackets
     def name
-      "<#{@name}>" if (defined?(@name) && @name)
+      "<#{@name}>" if defined?(@name) && @name
     end
 
     # set the name, strip off '<' and '>'
     # @param [String]
     # @return [String]
-    def name=(_name)
-      @name = _name.gsub(/[<>]/,'')
+    def name=(name_value)
+      @name = name_value.gsub(/[<>]/, '')
     end
 
     # alias array must contain the name of the unit and entries must be unique
@@ -66,35 +64,35 @@ class RubyUnits::Unit < Numeric
     # @param [Unit] unit
     # @return [Unit::Definition]
     def definition=(unit)
-      _base         = unit.to_base
-      @scalar       = _base.scalar
-      @kind         = _base.kind
-      @numerator    = _base.numerator
-      @denominator  = _base.denominator
+      base         = unit.to_base
+      @scalar      = base.scalar
+      @kind        = base.kind
+      @numerator   = base.numerator
+      @denominator = base.denominator
       self
     end
 
     # is this definition for a prefix?
     # @return [Boolean]
     def prefix?
-      self.kind == :prefix
+      kind == :prefix
     end
 
     # Is this definition the unity definition?
     # @return [Boolean]
     def unity?
-      self.prefix? && self.scalar == 1
+      prefix? && scalar == 1
     end
 
     # is this a base unit?
     # units are base units if the scalar is one, and the unit is defined in terms of itself.
     # @return [Boolean]
     def base?
-      (self.denominator     == RubyUnits::Unit::UNITY_ARRAY) &&
-      (self.numerator       != RubyUnits::Unit::UNITY_ARRAY) &&
-      (self.numerator.size  == 1) &&
-      (self.scalar          == 1) &&
-      (self.numerator.first == self.name)
+      (denominator     == RubyUnits::Unit::UNITY_ARRAY) &&
+        (numerator       != RubyUnits::Unit::UNITY_ARRAY) &&
+        (numerator.size  == 1) &&
+        (scalar          == 1) &&
+        (numerator.first == self.name)
     end
   end
 end

data/lib/ruby_units/math.rb

@@ -1,14 +1,13 @@
 require 'mathn'
 
-# Math will convert unit objects to radians and then attempt to use the value for 
-# trigonometric functions.  
+# Math will convert unit objects to radians and then attempt to use the value for
+# trigonometric functions.
 module Math
-
-  alias :unit_sqrt :sqrt
+  alias unit_sqrt sqrt
   # @return [Numeric]
   def sqrt(n)
-    if RubyUnits::Unit === n
-      (n**(Rational(1,2))).to_unit 
+    if n.is_a?(RubyUnits::Unit)
+      (n**Rational(1, 2)).to_unit
     else
       unit_sqrt(n)
     end
@@ -19,12 +18,12 @@ module Math
   module_function :sqrt
 
   #:nocov:
-  if self.respond_to?(:cbrt)
-    alias :unit_cbrt :cbrt
+  if respond_to?(:cbrt)
+    alias unit_cbrt cbrt
     # @return [Numeric]
     def cbrt(n)
       if RubyUnits::Unit === n
-        (n**(Rational(1,3))).to_unit 
+        (n**Rational(1, 3)).to_unit
       else
         unit_cbrt(n)
       end
@@ -35,18 +34,18 @@ module Math
     module_function :cbrt
   end
   #:nocov:
-    
-  alias :unit_sin :sin
+
+  alias unit_sin sin
   # @return [Numeric]
   def sin(n)
-   RubyUnits::Unit === n ? unit_sin(n.convert_to('radian').scalar) : unit_sin(n)
+    RubyUnits::Unit === n ? unit_sin(n.convert_to('radian').scalar) : unit_sin(n)
   end
   # @return [Numeric]
   module_function :unit_sin
   # @return [Numeric]
   module_function :sin
 
-  alias :unit_cos :cos
+  alias unit_cos cos
   # @return [Numeric]
   def cos(n)
     RubyUnits::Unit === n ? unit_cos(n.convert_to('radian').scalar) : unit_cos(n)
@@ -55,8 +54,8 @@ module Math
   module_function :unit_cos
   # @return [Numeric]
   module_function :cos
-    
-  alias :unit_sinh :sinh
+
+  alias unit_sinh sinh
   # @return [Numeric]
   def sinh(n)
     RubyUnits::Unit === n ? unit_sinh(n.convert_to('radian').scalar) : unit_sinh(n)
@@ -66,7 +65,7 @@ module Math
   # @return [Numeric]
   module_function :sinh
 
-  alias :unit_cosh :cosh
+  alias unit_cosh cosh
   # @return [Numeric]
   def cosh(n)
     RubyUnits::Unit === n ? unit_cosh(n.convert_to('radian').scalar) : unit_cosh(n)
@@ -76,17 +75,17 @@ module Math
   # @return [Numeric]
   module_function :cosh
 
-  alias :unit_tan :tan
+  alias unit_tan tan
   # @return [Numeric]
   def tan(n)
-   RubyUnits::Unit === n ? unit_tan(n.convert_to('radian').scalar) : unit_tan(n)
+    RubyUnits::Unit === n ? unit_tan(n.convert_to('radian').scalar) : unit_tan(n)
   end
   # @return [Numeric]
   module_function :tan
   # @return [Numeric]
   module_function :unit_tan
 
-  alias :unit_tanh :tanh
+  alias unit_tanh tanh
   # @return [Numeric]
   def tanh(n)
     RubyUnits::Unit === n ? unit_tanh(n.convert_to('radian').scalar) : unit_tanh(n)
@@ -96,36 +95,33 @@ module Math
   # @return [Numeric]
   module_function :tanh
 
-  alias :unit_hypot :hypot
+  alias unit_hypot hypot
   # Convert parameters to consistent units and perform the function
   # @return [Numeric]
-  def hypot(x,y)
+  def hypot(x, y)
     if RubyUnits::Unit === x && RubyUnits::Unit === y
-      (x**2 + y**2)**(1/2)
+      (x**2 + y**2)**(1 / 2)
     else
-      unit_hypot(x,y)
+      unit_hypot(x, y)
     end
   end
   # @return [Numeric]
   module_function :unit_hypot
   # @return [Numeric]
   module_function :hypot
-  
-  alias :unit_atan2 :atan2
-  # @return [Numeric]
-  def atan2(x,y)
-    case
-    when (x.is_a?(RubyUnits::Unit) && y.is_a?(RubyUnits::Unit)) && (x !~ y)
-      raise ArgumentError, "Incompatible RubyUnits::Units"
-    when (x.is_a?(RubyUnits::Unit) && y.is_a?(RubyUnits::Unit)) && (x =~ y)
-      Math::unit_atan2(x.base_scalar, y.base_scalar)
+
+  alias unit_atan2 atan2
+  # @return [Numeric]
+  def atan2(x, y)
+    raise ArgumentError, 'Incompatible RubyUnits::Units' if (x.is_a?(RubyUnits::Unit) && y.is_a?(RubyUnits::Unit)) && !x.compatible?(y)
+    if (x.is_a?(RubyUnits::Unit) && y.is_a?(RubyUnits::Unit)) && x.compatible?(y)
+      Math.unit_atan2(x.base_scalar, y.base_scalar)
     else
-      Math::unit_atan2(x,y)
+      Math.unit_atan2(x, y)
     end
   end
   # @return [Numeric]
   module_function :unit_atan2
   # @return [Numeric]
   module_function :atan2
-   
 end

data/lib/ruby_units/namespaced.rb

@@ -3,6 +3,7 @@ $LOAD_PATH << File.dirname(__FILE__)
 
 # require_relative this file to avoid creating an class alias from Unit to RubyUnits::Unit
 require_relative 'version'
+require_relative 'configuration'
 require_relative 'definition'
 require_relative 'cache'
 require_relative 'array'

data/lib/ruby_units/string.rb

@@ -6,19 +6,18 @@ class String
     other ? RubyUnits::Unit.new(self).convert_to(other) : RubyUnits::Unit.new(self)
   end
 
-  alias_method :original_format, :%
+  alias original_format %
   # format unit output using formating codes
   # @example '%0.2f' % '1 mm'.to_unit => '1.00 mm'
   # @return [String]
   def format_with_unit(*other)
-    case
-    when other.first.is_a?(RubyUnits::Unit)
+    if other.first.is_a?(RubyUnits::Unit)
       other.first.to_s(self)
     else
       original_format(*other)
     end
   end
-  alias_method :%, :format_with_unit
+  alias % format_with_unit
 
   # @param (see RubyUnits::Unit#convert_to)
   # @return (see RubyUnits::Unit#convert_to)

data/lib/ruby_units/time.rb

@@ -5,7 +5,6 @@ require 'time'
 # is in years, decades, or centuries.  This leads to less precise values, but ones that match the
 # calendar better.
 class Time
-
   class << self
     alias unit_time_at at
   end
@@ -15,15 +14,15 @@ class Time
   # @param [Time] arg
   # @param [Integer] ms
   # @return [RubyUnits::Unit, Time]
-  def self.at(arg, ms=nil)
+  def self.at(arg, ms = nil)
     case arg
     when Time
       unit_time_at(arg)
     when RubyUnits::Unit
       if ms
-        unit_time_at(arg.convert_to("s").scalar, ms)
+        unit_time_at(arg.convert_to('s').scalar, ms)
       else
-        unit_time_at(arg.convert_to("s").scalar)
+        unit_time_at(arg.convert_to('s').scalar)
       end
     else
       ms.nil? ? unit_time_at(arg) : unit_time_at(arg, ms)
@@ -41,16 +40,16 @@ class Time
     # :nocov_19:
   end
 
-  alias :unit_add :+
+  alias unit_add +
   # @return [RubyUnits::Unit, Time]
   def +(other)
     case other
     when RubyUnits::Unit
-      other = other.convert_to('d').round.convert_to('s') if ['y', 'decade', 'century'].include? other.units
+      other = other.convert_to('d').round.convert_to('s') if %w(y decade century).include? other.units
       begin
         unit_add(other.convert_to('s').scalar)
       rescue RangeError
-        self.to_datetime + other
+        to_datetime + other
       end
     else
       unit_add(other)
@@ -64,17 +63,17 @@ class Time
     Time.now + duration.to_unit
   end
 
-  alias :unit_sub :-
+  alias unit_sub -
 
   # @return [RubyUnits::Unit, Time]
   def -(other)
     case other
     when RubyUnits::Unit
-      other = other.convert_to('d').round.convert_to('s') if ['y', 'decade', 'century'].include? other.units
+      other = other.convert_to('d').round.convert_to('s') if %w(y decade century).include? other.units
       begin
         unit_sub(other.convert_to('s').scalar)
       rescue RangeError
-        self.send(:to_datetime) - other
+        send(:to_datetime) - other
       end
     else
       unit_sub(other)