unitwise 0.4.0 → 0.5.0

data/data/prefix.yaml

@@ -65,7 +65,7 @@
   :secondary_code: M
   :scalar: 1e-3
 - :names: micro
-  :symbol: μ
+  :symbol: "μ"
   :primary_code: u
   :secondary_code: U
   :scalar: 1e-6

data/lib/unitwise.rb

@@ -3,7 +3,7 @@ require 'liner'
 require "unitwise/version"
 require 'unitwise/base'
 require 'unitwise/expression'
-require 'unitwise/composable'
+require 'unitwise/compatible'
 require 'unitwise/scale'
 require 'unitwise/functional'
 require 'unitwise/measurement'

data/lib/unitwise/atom.rb

@@ -5,7 +5,7 @@ module Unitwise
   class Atom < Base
     liner :classification, :property, :metric, :special, :arbitrary, :dim
 
-    include Unitwise::Composable
+    include Unitwise::Compatible
 
     class << self
       # Array of hashes representing atom properties.

data/lib/unitwise/base.rb

@@ -18,6 +18,11 @@ module Unitwise
       end
     end
 
+    def initialize(*args)
+      super(*args)
+      freeze
+    end
+
     def names=(names)
       @names = Array(names)
     end

data/lib/unitwise/{composable.rb → compatible.rb}

@@ -1,8 +1,8 @@
 module Unitwise
-  # Composable provides methods for determing the composition of unit, term, or 
-  # measurement. This is used to establish compatibility between units, terms,
-  # or measurements.
-  module Composable
+  # Compatible is used to establish compatibility between units, terms, or
+  # measurements. This is done by determining the objects atomic composition
+  # represented as a Signed Multiset.
+  module Compatible
 
     # @api private
     def self.included(base)
@@ -37,7 +37,7 @@ module Unitwise
     # Determine if this instance is similar to or compatible with other
     # @return [true false]
     # @api public
-    def similar_to?(other)
+    def compatible_with?(other)
       self.composition == other.composition
     end
 
@@ -45,10 +45,9 @@ module Unitwise
     # @return [-1 0 1]
     # @api public
     def <=>(other)
-      if other.respond_to?(:composition) && similar_to?(other)
+      if other.respond_to?(:composition) && compatible_with?(other)
         scalar <=> other.scalar
       end
     end
-
   end
 end

data/lib/unitwise/functional.rb

@@ -45,8 +45,8 @@ module Unitwise
     attr_reader :function_name
 
     def initialize(value, unit, function_name)
-      super(value, unit)
       @function_name = function_name
+      super(value, unit)
     end
 
     def functional(x=scalar, forward = true)

data/lib/unitwise/measurement.rb

@@ -28,10 +28,10 @@ module Unitwise
     # @api public
     def convert_to(other_unit)
       other_unit = Unit.new(other_unit)
-      if similar_to?(other_unit)
+      if compatible_with?(other_unit)
         new(converted_value(other_unit), other_unit)
       else
-        raise ConversionError, "Can't convert #{inspect} to #{other_unit}."
+        raise ConversionError, "Can't convert #{self} to #{other_unit}."
       end
     end
 
@@ -42,7 +42,7 @@ module Unitwise
     #   measurement * some_other_measurement
     # @api public
     def *(other)
-      operate(:*, other) || raise(TypeError, "Can't multiply #{inspect} by #{other}.")
+      operate(:*, other) || raise(TypeError, "Can't multiply #{self} by #{other}.")
     end
 
     # Divide this measurement by a number or another measurement
@@ -52,7 +52,7 @@ module Unitwise
     #   measurement / some_other_measurement
     # @api public
     def /(other)
-      operate(:/, other) || raise(TypeError, "Can't divide #{inspect} by #{other}")
+      operate(:/, other) || raise(TypeError, "Can't divide #{self} by #{other}")
     end
 
     # Add another measurement to this unit. Units must be compatible.
@@ -61,7 +61,7 @@ module Unitwise
     #   measurement + some_other_measurement
     # @api public
     def +(other)
-      combine(:+, other) || raise(TypeError, "Can't add #{other} to #{inspect}.")
+      combine(:+, other) || raise(TypeError, "Can't add #{other} to #{self}.")
     end
 
     # Subtract another measurement from this unit. Units must be compatible.
@@ -70,7 +70,7 @@ module Unitwise
     #   measurement - some_other_measurement
     # @api public
     def -(other)
-      combine(:-, other) || raise(TypeError, "Can't subtract #{other} from #{inspect}.")
+      combine(:-, other) || raise(TypeError, "Can't subtract #{other} from #{self}.")
     end
 
     # Raise a measurement to a numeric power.
@@ -82,7 +82,7 @@ module Unitwise
       if number.is_a?(Numeric)
         new( value ** number, unit ** number )
       else
-        raise TypeError, "Can't raise #{inspect} to #{number} power."
+        raise TypeError, "Can't raise #{self} to #{number} power."
       end
     end
 
@@ -171,7 +171,7 @@ module Unitwise
     # Add or subtract other unit
     # @api private
     def combine(operator, other)
-      if similar_to?(other)
+      if other.respond_to?(:composition) && compatible_with?(other)
         new(value.send(operator, other.convert_to(unit).value), unit)
       end
     end
@@ -182,7 +182,7 @@ module Unitwise
       if other.is_a?(Numeric)
         new(value.send(operator, other), unit)
       elsif other.respond_to?(:composition)
-        if similar_to?(other)
+        if compatible_with?(other)
           converted = other.convert_to(unit)
           new(value.send(operator, converted.value), unit.send(operator, converted.unit))
         else

data/lib/unitwise/scale.rb

@@ -5,7 +5,12 @@ module Unitwise
   class Scale
     liner :value, :unit
 
-    include Unitwise::Composable
+    include Unitwise::Compatible
+
+    def initialize(*args)
+      super(*args)
+      freeze
+    end
 
     # The unit associated with this scale.
     # @return [Unitwise::Unit]

data/lib/unitwise/term.rb

@@ -1,8 +1,12 @@
 require 'signed_multiset'
 module Unitwise
   class Term < Liner.new(:atom, :prefix, :factor, :exponent, :annotation)
+    include Unitwise::Compatible
 
-    include Unitwise::Composable
+    def initialize(*args)
+      super(*args)
+      freeze
+    end
 
     def atom=(value)
       value.is_a?(Atom) ? super(value) : super(Atom.find(value.to_s))
@@ -25,11 +29,11 @@ module Unitwise
     end
 
     def factor
-      @factor ||= 1
+      super || 1
     end
 
     def exponent
-      @exponent ||= 1
+      super || 1
     end
 
     def scalar

data/lib/unitwise/unit.rb

@@ -1,8 +1,7 @@
 module Unitwise
   class Unit
     liner :expression, :terms
-
-    include Unitwise::Composable
+    include Unitwise::Compatible
 
     def initialize(input)
       if input.respond_to?(:expression)

data/lib/unitwise/version.rb

@@ -1,3 +1,3 @@
 module Unitwise
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unitwise
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Josh Lewis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-06 00:00:00.000000000 Z
+date: 2014-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liner
@@ -142,7 +142,7 @@ files:
 - lib/unitwise.rb
 - lib/unitwise/atom.rb
 - lib/unitwise/base.rb
-- lib/unitwise/composable.rb
+- lib/unitwise/compatible.rb
 - lib/unitwise/compound.rb
 - lib/unitwise/errors.rb
 - lib/unitwise/expression.rb