unitwise 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f269726294777e995dada36f1169f639de28b5f
-  data.tar.gz: e9bc9e48ee65a4d08539d5ee85c7cb2d14d65573
+  metadata.gz: d9050a8b1974209dc285b85f896030daed2e6319
+  data.tar.gz: 239e8d8949dfadf97acd2b5d431d7c9722d93b9e
 SHA512:
-  metadata.gz: e5f8cd371aac1c89b4eeab25f3f5d92fa45029244073deb0515dd9ef4c5347d8b91a96838b71319ec040147fed46a0f4b91656296839c408230f9f823bf14860
-  data.tar.gz: 17cdcce509f3db09c4cb607f8d51c64d0ea5a6ae51653f0a8c56de61756f75d280f677ac6a06c3086058a6f83d8c121a570ef234c6d23be3788038b67a74496e
+  metadata.gz: 3ebf1ae8eaa28fbff80dadf844629f74e36593c094ee1b8a82aee615e1989b1d995a5512e573405422814c8bb581b5e44bad928372f91dccf40eff3584b6d854
+  data.tar.gz: b8290d0f28ab189333ed4b16efdf5d5ea42f9d0d0b3d65d4822cda9e33ee234ee1da2ed544487b4be9814a4d4cd07aba2480d1ab714262e1c75dfee5812d99b7

data/Gemfile

@@ -1,5 +1,2 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in unitwise.gemspec
-gem 'pry'
 gemspec

data/lib/unitwise/atom.rb

@@ -4,8 +4,7 @@ module Unitwise
   # 'meter', 'hour', 'pound force'.
   class Atom < Base
     liner :classification, :property, :metric, :special, :arbitrary, :dim
-
-    include Unitwise::Compatible
+    include Compatible
 
     class << self
       # Array of hashes representing atom properties.
@@ -71,6 +70,7 @@ module Unitwise
     def depth
       base? ? 0 : scale.depth + 1
     end
+    memoize :depth
 
     # Determine if this is the last atom in the scale chain
     # @return [true, false]
@@ -116,5 +116,6 @@ module Unitwise
     def root_terms
       base? ? [Term.new(:atom_code => primary_code)] : scale.root_terms
     end
+    memoize :root_terms
   end
 end

data/lib/unitwise/base.rb

@@ -1,9 +1,9 @@
-require 'yaml'
 module Unitwise
   # The base class that Atom and Prefix are extended from. This class provides
   # shared functionality for said classes.
   class Base
     liner :names, :primary_code, :secondary_code, :symbol, :scale
+    include Memoizable
 
     # The list of tracked items.
     # @return [Array] An array of memoized instances.
@@ -30,14 +30,6 @@ module Unitwise
       end
     end
 
-    # Setup a new instance. Takes a hash of attributes, or an array of
-    # attribute values.
-    # @api public
-    def initialize(*args)
-      super(*args)
-      freeze
-    end
-
     # Setter for the names attribute. Will always set as an array.
     # @api semipublic
     def names=(names)
@@ -52,6 +44,7 @@ module Unitwise
         n.downcase.strip.gsub(/\s/, '_').gsub(/\W/, '')
       end
     end
+    memoize :slugs
 
     # String representation for the instance.
     # @return [String]

data/lib/unitwise/compatible.rb

@@ -6,6 +6,13 @@ module Unitwise
     # @api private
     def self.included(base)
       base.send :include, Comparable
+      base.send :include, Memoizable unless base < Memoizable
+      base.send :memoize, :composition, :composition_string
+    end
+
+    def initialize(*args)
+      super(*args)
+      freeze
     end
 
     # A representation of a unit based on the atoms it's derived from.

data/lib/unitwise/expression.rb

@@ -1,5 +1,3 @@
-require 'parslet'
-
 require 'unitwise/expression/matcher'
 require 'unitwise/expression/parser'
 require 'unitwise/expression/transformer'

data/lib/unitwise/scale.rb

@@ -4,19 +4,13 @@ module Unitwise
   # magnitude and direction. This class should be considered mostly privateish.
   class Scale
     liner :value, :unit
-
     include Unitwise::Compatible
 
-    def initialize(*args)
-      super(*args)
-      freeze
-    end
-
-    # The unit associated with this scale.
-    # @return [Unitwise::Unit]
+    # Set the unit vector.
+    # @param value [String, Unitwise::Unit]
     # @api public
-    def unit
-      @unit.is_a?(Unit) ? @unit : Unit.new(@unit)
+    def unit=(value)
+      @unit = value.is_a?(Unit) ? value : Unit.new(value)
     end
 
     # List the atoms associated with this scale's unit.
@@ -40,13 +34,6 @@ module Unitwise
       unit.special?
     end
 
-    # Return a converted value for this scale, based on it's function for
-    # scales with special units.
-    # @param x [Numeric] Value to convert to or from
-    # @param forward [true, false] whether to convert to this unit or from it.
-    # @return [Numeric]
-    # @api public
-
     # Get a scalar value for this scale.
     # @param magnitude [Numeric] An optional magnitude on this scale.
     # @return [Numeric] A scalar value on a linear scale
@@ -59,7 +46,7 @@ module Unitwise
       end
     end
 
-    # Get a magnitude based on a linear scale value. Only used by scales with 
+    # Get a magnitude based on a linear scale value. Only used by scales with
     # special atoms in it's hierarchy.
     # @param scalar [Numeric] A linear scalar value
     # @return [Numeric] The equivalent magnitude on this scale
@@ -78,6 +65,7 @@ module Unitwise
     def root_terms
       unit.root_terms
     end
+    memoize :root_terms
 
     # How far away is this instances unit from the deepest leve atom.
     # @return [Integer]
@@ -85,6 +73,7 @@ module Unitwise
     def depth
       unit.depth + 1
     end
+    memoize :depth
 
     # Convert to a simple string representing the scale.
     # @api public
@@ -95,5 +84,18 @@ module Unitwise
     def inspect
       "#<#{self.class} value=#{value} unit=#{unit}>"
     end
+
+    # Redefine hash for apropriate hash/key lookup
+    # @api semipublic
+    def hash
+      [value, unit.to_s, self.class].hash
+    end
+    memoize :hash
+
+    # Redefine hash equality to match the hashes
+    # @api semipublic
+    def eql?(other)
+      hash == other.hash
+    end
   end
 end

data/lib/unitwise/term.rb

@@ -1,17 +1,9 @@
-require 'signed_multiset'
 module Unitwise
   # A Term is the combination of an atom, prefix, factor and annotation.
   # Not all properties have to be present. Examples: 'g', 'mm', 'mi2', '4[pi]',
   # 'kJ{Electric Potential}'
   class Term < Liner.new(:atom, :prefix, :factor, :exponent, :annotation)
-    include Unitwise::Compatible
-
-    # Setup a new term. Send a hash of properties, or ordered property values.
-    # @api public
-    def initialize(*args)
-      super(*args)
-      freeze
-    end
+    include Compatible
 
     # Set the atom.
     # @param value [String, Atom] Either a string representing an Atom, or an
@@ -40,6 +32,7 @@ module Unitwise
     def depth
       atom ? atom.depth + 1 : 0
     end
+    memoize :depth
 
     # Determine if this is the last term in the scale chain
     # @return [true, false]
@@ -90,6 +83,7 @@ module Unitwise
         end
       end
     end
+    memoize :root_terms
 
     # Term multiplication. Multiply by a Unit, another Term, or a Numeric.
     # params other [Unit, Term, Numeric]
@@ -134,6 +128,7 @@ module Unitwise
       [(factor if factor != 1), prefix.to_s,
         atom.to_s, (exponent if exponent != 1)].compact.join('')
     end
+    memoize :to_s
 
     private
 

data/lib/unitwise/unit.rb

@@ -4,7 +4,7 @@ module Unitwise
   # a magnitude, but it does have a scale.
   class Unit
     liner :expression, :terms
-    include Unitwise::Compatible
+    include Compatible
 
     # Create a new unit. You can send an expression or a collection of terms
     # @param input [String, Unit, [Term]] A string expression, a unit, or a
@@ -17,32 +17,34 @@ module Unitwise
         @expression = input.to_s
       else
         @terms = input
+        @expression = Expression.compose(input)
       end
-    end
-
-    def expression
-      @expression ||= (Expression.compose(@terms) if @terms)
+      freeze
     end
 
     def terms
-      @terms ||= (Expression.decompose(@expression) if @expression)
+      @terms || Expression.decompose(expression)
     end
 
     def atoms
       terms.map(&:atom)
     end
+    memoize :atoms
 
     def special?
       terms.count == 1 && terms.all?(&:special?)
     end
+    memoize :special?
 
     def depth
       terms.map(&:depth).max + 1
     end
+    memoize :depth
 
     def root_terms
       terms.map(&:root_terms).flatten
     end
+    memoize :root_terms
 
     def scalar(magnitude = 1)
       terms.reduce(1) do |prod, term|

data/lib/unitwise/version.rb

@@ -1,3 +1,3 @@
 module Unitwise
-  VERSION = '0.6.1'
+  VERSION = '0.6.2'
 end

data/lib/unitwise.rb

@@ -1,4 +1,8 @@
 require 'liner'
+require 'memoizable'
+require 'parslet'
+require 'signed_multiset'
+require 'yaml'
 
 require 'unitwise/version'
 require 'unitwise/base'

data/test/support/scale_tests.rb

@@ -4,15 +4,15 @@ module ScaleTests
     base.class_eval do
       subject { described_class.new(4, "J") }
 
-      let(:mph)  { Unitwise::Measurement.new(60, '[mi_i]/h') }
-      let(:kmh)  { Unitwise::Measurement.new(100, 'km/h') }
-      let(:mile) { Unitwise::Measurement.new(3, '[mi_i]') }
-      let(:hpm)  { Unitwise::Measurement.new(6, 'h/[mi_i]') }
-      let(:cui)  { Unitwise::Measurement.new(12, "[in_i]3") }
-      let(:cel)  { Unitwise::Measurement.new(22, 'Cel') }
-      let(:k)    { Unitwise::Measurement.new(373.15, 'K') }
-      let(:f)    { Unitwise::Measurement.new(98.6, '[degF]')}
-      let(:r)    { Unitwise::Measurement.new(491.67, '[degR]') }
+      let(:mph)  { described_class.new(60, '[mi_i]/h') }
+      let(:kmh)  { described_class.new(100, 'km/h') }
+      let(:mile) { described_class.new(3, '[mi_i]') }
+      let(:hpm)  { described_class.new(6, 'h/[mi_i]') }
+      let(:cui)  { described_class.new(12, "[in_i]3") }
+      let(:cel)  { described_class.new(22, 'Cel') }
+      let(:k)    { described_class.new(373.15, 'K') }
+      let(:f)    { described_class.new(98.6, '[degF]')}
+      let(:r)    { described_class.new(491.67, '[degR]') }
 
       describe "#new" do
         it "must set attributes" do
@@ -79,6 +79,12 @@ module ScaleTests
         end
       end
 
+      describe "#frozen?" do
+        it "must be frozen" do
+          subject.frozen?.must_equal true
+        end
+      end
+
     end
   end
 end

data/test/unitwise/atom_test.rb

@@ -120,4 +120,10 @@ describe Unitwise::Atom do
       skip("need to figure out mocking and stubbing with minitest")
     end
   end
+
+  describe "#frozen?" do
+    it "should be frozen" do
+      second.frozen?.must_equal true
+    end
+  end
 end

data/test/unitwise/measurement_test.rb

@@ -117,13 +117,44 @@ describe Unitwise::Measurement do
   describe "#coerce" do
     let(:meter) { Unitwise::Measurement.new(1, 'm') }
     it "must coerce numerics" do
-      meter.coerce(5).must_equal [ Unitwise::Measurement.new(5, '1'), meter ]
+      (5 * meter).must_equal Unitwise::Measurement.new(5, 'm')
     end
     it "should raise an error for other crap" do
       lambda { meter.coerce("foo") }.must_raise TypeError
     end
   end
 
+  describe "equality" do
+    let(:m)    { Unitwise::Measurement.new(1,'m') }
+    let(:mm)   { Unitwise::Measurement.new(1000,'mm') }
+    let(:foot) { Unitwise::Measurement.new(1,'foot') }
+    let(:g)    { Unitwise::Measurement.new(1,'gram') }
+    it "should be ==" do
+      assert m == m
+      assert m == mm
+      refute m == foot
+      refute m == g
+    end
+    it "should be ===" do
+      assert m == m
+      assert m === mm
+      refute m === foot
+      refute m == g
+    end
+    it "should be equal?" do
+      assert m.equal?(m)
+      refute m.equal?(mm)
+      refute m.equal?(foot)
+      refute m.equal?(g)
+    end
+    it "should be eql?" do
+      assert m.eql?(m)
+      refute m.equal?(mm)
+      refute m.equal?(foot)
+      refute m.equal?(g)
+    end
+  end
+
   describe "#method_missing" do
     let(:meter) { Unitwise::Measurement.new(1, 'm')}
     it "must convert 'to_mm'" do

data/test/unitwise/term_test.rb

@@ -40,5 +40,10 @@ describe Unitwise::Term do
       end
     end
 
+    describe "#frozen?" do
+      it "should be frozen" do
+        subject.frozen?.must_equal true
+      end
+    end
   end
 end

data/test/unitwise/unit_test.rb

@@ -50,16 +50,22 @@ describe Unitwise::Unit do
   describe "#*" do
     it "should multiply units" do
       mult = kg * ms2
-      mult.expression.to_s.must_match /kg.*\/s2/
-      mult.expression.to_s.must_match /m.*\/s2/
+      mult.expression.to_s.must_match(/kg.*\/s2/)
+      mult.expression.to_s.must_match(/m.*\/s2/)
     end
   end
 
   describe "#/" do
     it "should divide units" do
       div = kg / ms2
-      div.expression.to_s.must_match /kg.*\/m/
-      div.expression.to_s.must_match /s2.*\/m/
+      div.expression.to_s.must_match(/kg.*\/m/)
+      div.expression.to_s.must_match(/s2.*\/m/)
+    end
+  end
+
+  describe "#frozen?" do
+    it "should be frozen" do
+      kg.frozen?.must_equal true
     end
   end
 

data/unitwise.gemspec

@@ -8,11 +8,11 @@ Gem::Specification.new do |gem|
   gem.version       = Unitwise::VERSION
   gem.authors       = ['Josh Lewis']
   gem.email         = ['josh.w.lewis@gmail.com']
-  gem.description   = 'Ruby implementation of the Unified Code for Units of ' \
-                      'Measure (UCUM)'
-  gem.summary       = 'Unitwise is a library for performing mathematical '\
-                      'operations and conversions on all units defined by '\
-                      'the Unified Code for Units of Measure(UCUM).'
+  gem.description   = 'Physical quantity and units of measure conversion '    \
+                      'and math library'
+  gem.summary       = 'Convert between and perform mathematical operations '  \
+                      'on physical quantities and units of measure defined '  \
+                      'by the Unified Code for Units of Measure.'
   gem.homepage      = 'http://github.com/joshwlewis/unitwise'
   gem.license       = 'MIT'
 
@@ -20,19 +20,21 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(/^test\//)
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'liner', '~> 0.2.4'
-  gem.add_dependency 'signed_multiset', '~> 0.2.0'
+  gem.add_dependency               'liner',           '~> 0.2'
+  gem.add_dependency               'signed_multiset', '~> 0.2'
+  gem.add_dependency               'memoizable',      '~> 0.4'
 
   if RUBY_VERSION > '1.8.7'
-    gem.add_dependency 'parslet', '~> 1.5'
-    gem.add_development_dependency 'nokogiri', '~> 1.5'
-    gem.add_development_dependency 'coveralls', '~> 0.6'
+    gem.add_dependency             'parslet',         '~> 1.5'
+    gem.add_development_dependency 'nokogiri',        '~> 1.5'
+    gem.add_development_dependency 'coveralls',       '~> 0.6'
   else
-    gem.add_dependency 'parslet', '~> 1.5.0'
-    gem.add_development_dependency 'nokogiri', '~> 1.5.10'
+    gem.add_dependency             'parslet',         '~> 1.5.0'
+    gem.add_development_dependency 'nokogiri',        '~> 1.5.10'
   end
 
-  gem.add_development_dependency 'minitest',  '>= 5.0'
-  gem.add_development_dependency 'rake',      '>= 10.0'
-  gem.add_development_dependency 'nori',      '~> 2.3'
+  gem.add_development_dependency   'pry',             '~> 0.9'
+  gem.add_development_dependency   'minitest',        '~> 5.0'
+  gem.add_development_dependency   'rake',            '~> 10.0'
+  gem.add_development_dependency   'nori',            '~> 2.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unitwise
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Josh Lewis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-19 00:00:00.000000000 Z
+date: 2014-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liner
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: signed_multiset
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: memoizable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: parslet
   requirement: !ruby/object:Gem::Requirement
@@ -80,32 +94,46 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
@@ -122,7 +150,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-description: Ruby implementation of the Unified Code for Units of Measure (UCUM)
+description: Physical quantity and units of measure conversion and math library
 email:
 - josh.w.lewis@gmail.com
 executables: []
@@ -209,8 +237,8 @@ rubyforge_project:
 rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
-summary: Unitwise is a library for performing mathematical operations and conversions
-  on all units defined by the Unified Code for Units of Measure(UCUM).
+summary: Convert between and perform mathematical operations on physical quantities
+  and units of measure defined by the Unified Code for Units of Measure.
 test_files:
 - test/support/scale_tests.rb
 - test/test_helper.rb