Fingertips-conversions 1.2.1 → 1.3.0

data/conversions.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "conversions"
-  spec.version = "1.2.1"
+  spec.version = "1.3.0"
   
   spec.author = "Manfred Stienstra"
   spec.email = "manfred@fngtps.com"
@@ -13,8 +13,8 @@ Gem::Specification.new do |spec|
   EOF
   spec.homepage = "http://github.com/Fingertips/conversions/tree/master"
   
-  spec.files = ["conversions.gemspec", "init.rb", "lib", "LICENSE", "rails", "Rakefile", "README", "test", "TODO", "lib/conversions/active_record_accessors.rb", "lib/conversions/ext.rb", "lib/conversions/unit.rb", "lib/conversions.rb", "rails/init.rb", "test/accessor_test.rb", "test/ext_test.rb", "test/test_helper.rb", "test/unit_test.rb"]
-  spec.test_files = ["test/unit_test.rb", "test/accessor_test.rb", "test/ext_test.rb", "test/test_helper.rb"]
+  spec.files = ["conversions.gemspec", "init.rb", "lib", "LICENSE", "rails", "Rakefile", "README", "test", "TODO", "lib/conversions/active_record_accessors.rb", "lib/conversions/defaults.rb", "lib/conversions/unit.rb", "lib/conversions.rb", "rails/init.rb", "test/accessor_test.rb", "test/ext_test.rb", "test/test_helper.rb", "test/unit_test.rb", "test/conversions_test.rb"]
+  spec.test_files = ["test/unit_test.rb", "test/accessor_test.rb", "test/ext_test.rb", "test/test_helper.rb", "test/conversions_test.rb"]
   
   spec.has_rdoc = true
   spec.extra_rdoc_files = ['README', 'LICENSE']

data/lib/conversions.rb

@@ -1,31 +1,49 @@
+# Conversions makes it easy to convert between units.
 module Conversions
-  CONVERSION = {
-    :miles => {
-      :kilometres => 1.609344
-    },
-    :kilograms => {
-      :grams => 1000.0,
-      :pounds => 2.20462262,
-      :short_tons => 0.00110231131,
-      :tons => 0.00110231131
-    },
-    :tons => {
-      :pounds => 2000.0
-    },
-    :gallons => {
-      :litres => 3.7854118
-    },
-    :cubic_feet => {
-      :cubic_meters => 0.0283168466
-    }
-  }
+  mattr_accessor :conversions
+
+  # Clear all previously registered conversions
+  def self.clear
+    self.conversions = {}
+  end
+  clear
+  
+  # Load all the default conversions shipped with the code
+  def self.load_defaults
+    load File.expand_path('../conversions/defaults.rb', __FILE__)
+  end
+
+  # Register a new conversion. This automatically also registers the inverse conversion.
+  #
+  # * _from_: The unit to convert from (ie. :miles, :stones, or :pints)
+  # * _to_: The unit to convert to
+  # * _rate_: The conversion rate from _from_ to _to_. (_from_ * _rate_ = _to_)
+  def self.register(from, to, rate)
+    conversions[from] ||= {}
+    conversions[from][to] = rate
+    conversions[to] ||= {}
+    conversions[to][from] = 1.0 / rate
+  end
+
+  module Ext
+    # Convert from one unit to another.
+    #
+    # * _from_: The unit to convert from (ie. :miles, :stones, or :pints)
+    # * _to_: The unit to convert to
+    # * _options_:
+    #   * :scale: The number of digits you want after the dot.
+    def convert(from, to, options={})
+      Conversions::Unit.new(self, from).to(to, options)
+    end
+  end
 end
 
 require 'conversions/unit'
-require 'conversions/ext'
-require 'conversions/active_record_accessors'
 
-Numeric.send :include, Conversions::Ext
+Conversions.load_defaults
+Numeric.send(:include, Conversions::Ext)
+
 if defined?(ActiveRecord)
-  ActiveRecord::Base.send :extend, Conversions::ActiveRecordAccessors
-end
+  require 'conversions/active_record_accessors'
+  ActiveRecord::Base.send(:extend, Conversions::ActiveRecordAccessors)
+end

data/lib/conversions/active_record_accessors.rb

@@ -1,4 +1,4 @@
-module Conversions #:nodoc:
+module Conversions
   # Implements new accessor classmethods to define conversion accessors on active record classes.
   module ActiveRecordAccessors
     # Adds conversion methods to the model for a certain attribute.
@@ -38,11 +38,11 @@ module Conversions #:nodoc:
         raise ArgumentError, "Please specify both :external and :internal metrics."
       end
       define_method "#{attribute}_in_#{options[:external]}" do
-        v = send(attribute)
-        v ? v.send(options[:internal]).to(options[:external], options[:scale]) : nil
+        value = send(attribute)
+        value ? value.convert(options[:internal], options[:external], options.except(:internal, :external)) : nil
       end
       define_method "#{attribute}_in_#{options[:external]}=" do |v|
-        send("#{attribute}=", v.to_f.send(options[:external]).to(options[:internal]))
+        send("#{attribute}=", v.to_f.convert(options[:external], options[:internal]), options.except(:internal, :external))
       end
     end
   end

data/lib/conversions/defaults.rb

@@ -0,0 +1,27 @@
+{
+  :miles => {
+    :kilometres => 1.609344
+  },
+  :kilograms => {
+    :grams => 1000.0,
+    :pounds => 2.20462262,
+    :short_tons => 0.00110231131,
+    :tons => 0.00110231131
+  },
+  :tons => {
+    :pounds => 2000.0
+  },
+  :gallons => {
+    :litres => 3.7854118
+  },
+  :cubic_feet => {
+    :cubic_meters => 0.0283168466
+  },
+  :miles_per_gallon => {
+    :kilometres_per_litre => 0.425143707
+  }
+}.each do |from_unit, to_units|
+  to_units.each do |to_unit, rate|
+    Conversions.register(from_unit, to_unit, rate)
+  end
+end

data/lib/conversions/unit.rb

@@ -1,4 +1,4 @@
-module Conversions #:nodoc
+module Conversions
   # Proxy class to contain the unit as well as reference the base value
   class Unit
     # Create a new Unit instance.
@@ -13,34 +13,20 @@ module Conversions #:nodoc
     # Convert to a certain other unit.
     #
     # * _to_: The unit to convert to (ie. :kilometers)
-    # * _scale_: The number of digits behind the decimal point to you want to keep (Optional)
-    def to(to, scale=nil)
+    # * _options_:
+    #   * :scale: The number of digits behind the decimal point to you want to keep
+    def to(to, options={})
       value = @value * self.class.exchange_rate(@from, to)
-      scale.nil? ? value : (value * (10 ** scale)).round / (10 ** scale).to_f
+      options[:scale].nil? ? value : (value * (10 ** options[:scale])).round / (10 ** options[:scale]).to_f
     end
 
     def self.exchange_rate(from_unit, to_unit) #:nodoc:
       return 1 if from_unit == to_unit
-      from = conversion[from_unit]
+      from = Conversions.conversions[from_unit]
       raise ArgumentError, "Can't convert from `#{from}', unknown unit" if from.nil?
       to = from[to_unit]
       raise ArgumentError, "Can't convert from `#{from_unit}' to `#{to_unit}', unknown unit" if to.nil?
       to
     end
-    
-    def self.conversion #:nodoc:
-      if !defined? @@conversion
-        @@conversion = {}
-        CONVERSION.each do |from, conversion|
-          conversion.each do |to, value|
-            @@conversion[from] ||= {}
-            @@conversion[from][to] = value
-            @@conversion[to] ||= {}
-            @@conversion[to][from] = 1.0 / value
-          end
-        end
-      end
-      @@conversion
-    end
   end
 end

data/test/accessor_test.rb

@@ -8,7 +8,10 @@ class Flight
 end
 
 class AccessorTest < Test::Unit::TestCase
-
+  def setup
+    reset_defaults
+  end
+  
   def setup
     @flight = Flight.new
   end

data/test/conversions_test.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ConversionsTest < Test::Unit::TestCase
+  def setup
+    Conversions.clear
+  end
+  
+  def test_register
+    Conversions.register(:records, :cds, 0.47)
+    assert 2, Conversions.conversions.length
+    
+    assert_nothing_raised do
+      1.convert(:records, :cds)
+      1.convert(:cds, :records)
+    end
+  end
+  
+  def test_clear
+    Conversions.register(:records, :cds, 0.47)
+    assert 2, Conversions.conversions.length
+    Conversions.clear
+    assert 0, Conversions.conversions.length
+  end
+end

data/test/ext_test.rb

@@ -1,13 +1,16 @@
 require File.dirname(__FILE__) + '/test_helper'
 
 class ExtTest < Test::Unit::TestCase
+  def setup
+    reset_defaults
+  end
   
   def test_conversions
-    assert_in_delta 1.609344, 1.miles.to(:kilometres), DELTA
-    assert_in_delta 1.609344, 1.0.miles.to(:kilometres), DELTA
-    assert_in_delta 0.45359237, 1.pounds.to(:kilograms), DELTA
-    assert_in_delta 0.00110231131092439, 1.kilograms.to(:tons), DELTA
-    assert_in_delta 2.20462262184878, 1.kilograms.to(:pounds), DELTA
-    assert_in_delta 1, ( 1.kilograms.to(:pounds) * 1.pounds.to(:kilograms) ), DELTA
+    assert_in_delta 1.609344, 1.convert(:miles, :kilometres), DELTA
+    assert_in_delta 1.609344, 1.0.convert(:miles, :kilometres), DELTA
+    assert_in_delta 0.45359237, 1.convert(:pounds, :kilograms), DELTA
+    assert_in_delta 0.00110231131092439, 1.convert(:kilograms, :tons), DELTA
+    assert_in_delta 2.20462262184878, 1.convert(:kilograms, :pounds), DELTA
+    assert_in_delta 1, ( 1.convert(:kilograms, :pounds) * 1.convert(:pounds, :kilograms) ), DELTA
   end
 end

data/test/test_helper.rb

@@ -8,4 +8,9 @@ end
 $:.unshift File.dirname(__FILE__) + '/../lib'
 require 'conversions'
 
+def reset_defaults
+  Conversions.clear
+  Conversions.load_defaults
+end
+
 DELTA = 0.0000001

data/test/unit_test.rb

@@ -1,6 +1,10 @@
 require File.dirname(__FILE__) + '/test_helper'
 
 class UnitTest < Test::Unit::TestCase
+  def setup
+    reset_defaults
+  end
+  
   def test_exchange_rate
     assert_in_delta 1.609344, Conversions::Unit.exchange_rate(:miles, :kilometres), DELTA
     assert_in_delta 0.621371192237334, Conversions::Unit.exchange_rate(:kilometres, :miles), DELTA
@@ -11,7 +15,7 @@ class UnitTest < Test::Unit::TestCase
   end
   
   def test_exchange_rate_for_identity_transform
-    Conversions::Unit.conversion.keys.each do |unit|
+    Conversions.conversions.keys.each do |unit|
       assert_equal 1, Conversions::Unit.exchange_rate(unit, unit)
     end
   end
@@ -20,19 +24,20 @@ class UnitTest < Test::Unit::TestCase
     amount = Conversions::Unit.new(10.0, :miles)
     assert_in_delta 16.09344, amount.to(:kilometres), DELTA
     
-    amount = Conversions::Unit.new(10.0, :miles)
-    assert_equal 16.09, amount.to(:kilometres, 2), DELTA
-    
     amount = Conversions::Unit.new(10.0, :kilograms)
     assert_in_delta 22.0462262184878, amount.to(:pounds), DELTA
-    
-    amount = Conversions::Unit.new(10.0, :kilograms)
-    assert_equal 22.05, amount.to(:pounds, 2), DELTA
+  end
+  
+  def test_to_with_scale
+    amount = Conversions::Unit.new(10.0, :miles)
+    assert_equal 16.1, amount.to(:kilometres, :scale => 1)
+    assert_equal 16.09, amount.to(:kilometres, :scale => 2)
+    assert_equal 16.093, amount.to(:kilometres, :scale => 3)
   end
   
   def test_identity_transforms
-    Conversions::Unit.conversion.keys.each do |unit|
-      assert_equal 1.0, Conversions::Unit.new(1.0, unit).to(unit, 2)
+    Conversions.conversions.keys.each do |unit|
+      assert_equal 1.0, Conversions::Unit.new(1.0, unit).to(unit, :scale => 2)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Fingertips-conversions
 version: !ruby/object:Gem::Version 
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors: 
 - Manfred Stienstra
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-11 00:00:00 -08:00
+date: 2009-02-13 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -33,7 +33,7 @@ files:
 - test
 - TODO
 - lib/conversions/active_record_accessors.rb
-- lib/conversions/ext.rb
+- lib/conversions/defaults.rb
 - lib/conversions/unit.rb
 - lib/conversions.rb
 - rails/init.rb
@@ -41,6 +41,7 @@ files:
 - test/ext_test.rb
 - test/test_helper.rb
 - test/unit_test.rb
+- test/conversions_test.rb
 has_rdoc: true
 homepage: http://github.com/Fingertips/conversions/tree/master
 post_install_message: 
@@ -72,3 +73,4 @@ test_files:
 - test/accessor_test.rb
 - test/ext_test.rb
 - test/test_helper.rb
+- test/conversions_test.rb

data/lib/conversions/ext.rb

@@ -1,10 +0,0 @@
-module Conversions #:nodoc:
-  # Defines all the conversion methods (miles, kilometers, etc…)
-  module Ext
-    Unit.conversion.each do |method, _|
-      define_method method do
-        Unit.new self, method
-      end unless respond_to? method
-    end
-  end
-end