seamusabshere-conversions 0.1.0 → 1.2

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2008 Manfred Stienstra, Fingertips <manfred@fngtps.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,15 @@
+Conversions
+-----------
+
+A plugin to convert units.
+
+Installation
+-----------
+
+As a GemPlugin:
+
+config.gem 'Fingertips-conversions', :lib => 'conversions', :source => 'http://gems.github.com'
+
+As a normal plugin:
+
+script/install plugin git://github.com/Fingertips/conversions.git

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the conversions plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for conversions plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Conversions'
+  rdoc.options << '--line-numbers' << '--inline-source' << '--charset' << 'utf-8'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/conversions.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name     = "conversions"
+  s.version  = "1.2"
+  s.date     = "2009-01-12"
+  s.summary  = "A Ruby on Rails plugin that adds conversion capabilities to numeric objects"
+  s.homepage = "http://github.com/Fingertips/conversions/tree/master"
+  s.description = "A Ruby on Rails plugin that adds conversion capabilities to numeric objects"
+  s.authors  = "Fingertips"
+  s.email = "manfred@fngtps.com"
+  #s.files = Dir['[a-zA-Z]*'] + Dir['lib/**/*.rb'] + Dir['rails/*.rb'] + Dir['test/**/*']
+  s.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"]
+  s.test_file = "test/unit_test.rb"
+end

data/init.rb

@@ -0,0 +1 @@
+require 'conversions'

data/lib/conversions.rb

@@ -1,59 +1,31 @@
-# Conversions makes it easy to convert between units.
 module Conversions
-  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
-    Conversions.define_shortcut(from)
-    Conversions.define_shortcut(to)
-  end
-
-  def self.define_shortcut(unit)
-    Numeric.class_eval do
-      define_method unit do
-        Conversions::Unit.new(self, unit)
-      end unless respond_to? unit
-    end
-  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
+  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
+    }
+  }
 end
 
 require 'conversions/unit'
+require 'conversions/ext'
+require 'conversions/active_record_accessors'
 
-Conversions.load_defaults
-Numeric.send(:include, Conversions::Ext)
-
+Numeric.send :include, Conversions::Ext
 if defined?(ActiveRecord)
-  require 'conversions/active_record_accessors'
-  ActiveRecord::Base.send(:extend, Conversions::ActiveRecordAccessors)
-end
+  ActiveRecord::Base.send :extend, Conversions::ActiveRecordAccessors
+end

data/lib/conversions/active_record_accessors.rb

@@ -1,4 +1,4 @@
-module Conversions
+module Conversions #:nodoc:
   # 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
         raise ArgumentError, "Please specify both :external and :internal metrics."
       end
       define_method "#{attribute}_in_#{options[:external]}" do
-        value = send(attribute)
-        value ? value.convert(options[:internal], options[:external], options.except(:internal, :external)) : nil
+        v = send(attribute)
+        v ? v.send(options[:internal]).to(options[:external], options[:scale]) : nil
       end
       define_method "#{attribute}_in_#{options[:external]}=" do |v|
-        send("#{attribute}=", v.to_f.convert(options[:external], options[:internal], options.except(:internal, :external)))
+        send("#{attribute}=", v.to_f.send(options[:external]).to(options[:internal]))
       end
     end
   end

data/lib/conversions/ext.rb

@@ -0,0 +1,10 @@
+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

data/lib/conversions/unit.rb

@@ -1,4 +1,4 @@
-module Conversions
+module Conversions #:nodoc
   # Proxy class to contain the unit as well as reference the base value
   class Unit
     # Create a new Unit instance.
@@ -13,27 +13,34 @@ module Conversions
     # Convert to a certain other unit.
     #
     # * _to_: The unit to convert to (ie. :kilometers)
-    # * _options_:
-    #   * :scale: The number of digits behind the decimal point to you want to keep
-    def to(to, options={})
-      case options
-      when Integer
-        scale = options
-      when Hash
-        scale = options[:scale]
-      end
-      
+    # * _scale_: The number of digits behind the decimal point to you want to keep (Optional)
+    def to(to, scale=nil)
       value = @value * self.class.exchange_rate(@from, to)
       scale.nil? ? value : (value * (10 ** scale)).round / (10 ** scale).to_f
     end
 
     def self.exchange_rate(from_unit, to_unit) #:nodoc:
       return 1 if from_unit == to_unit
-      from = Conversions.conversions[from_unit]
+      from = conversion[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/rails/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), '..', 'init')

data/test/accessor_test.rb

@@ -5,16 +5,10 @@ class Flight
   attr_accessor :distance, :fuel_consumption
   conversion_accessor :distance, :internal => :kilometres, :external => :miles
   conversion_accessor :fuel_consumption, :internal => :litres, :external => :gallons, :scale => 2
-  
-  Conversions.register(:kilometres, :leagues, 0.179985601)
-  conversion_accessor :distance, :internal => :kilometres, :external => :leagues, :scale => 2
 end
 
 class AccessorTest < Test::Unit::TestCase
-  def setup
-    reset_defaults
-  end
-  
+
   def setup
     @flight = Flight.new
   end
@@ -33,9 +27,4 @@ class AccessorTest < Test::Unit::TestCase
     @flight.fuel_consumption = 3400
     assert_equal 898.18, @flight.fuel_consumption_in_gallons, DELTA
   end
-  
-  def test_register
-    @flight.distance = 1200
-    assert_in_delta 215.98, @flight.distance_in_leagues, DELTA
-  end
 end

data/test/ext_test.rb

@@ -1,17 +1,8 @@
 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.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
     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
@@ -19,10 +10,4 @@ class ExtTest < Test::Unit::TestCase
     assert_in_delta 2.20462262184878, 1.kilograms.to(:pounds), DELTA
     assert_in_delta 1, ( 1.kilograms.to(:pounds) * 1.pounds.to(:kilograms) ), DELTA
   end
-  
-  def test_register
-    Conversions.register(:dollars, :cents, 100.0)
-    assert_in_delta 1000.0, 10.convert(:dollars, :cents), DELTA
-    assert_in_delta 1000.0, 10.dollars.to(:cents), DELTA
-  end
 end

data/test/test_helper.rb

@@ -8,9 +8,4 @@ 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,10 +1,6 @@
 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
@@ -15,7 +11,7 @@ class UnitTest < Test::Unit::TestCase
   end
   
   def test_exchange_rate_for_identity_transform
-    Conversions.conversions.keys.each do |unit|
+    Conversions::Unit.conversion.keys.each do |unit|
       assert_equal 1, Conversions::Unit.exchange_rate(unit, unit)
     end
   end
@@ -24,34 +20,19 @@ 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
-  end
-  
-  def test_to_with_options
-    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_to_with_scale
-    amount = Conversions::Unit.new(10.0, :miles)
-    assert_equal 16.1, amount.to(:kilometres, 1)
-    assert_equal 16.09, amount.to(:kilometres, 2)
-    assert_equal 16.093, amount.to(:kilometres, 3)
+    amount = Conversions::Unit.new(10.0, :kilograms)
+    assert_equal 22.05, amount.to(:pounds, 2), DELTA
   end
   
   def test_identity_transforms
-    Conversions.conversions.keys.each do |unit|
-      assert_equal 1.0, Conversions::Unit.new(1.0, unit).to(unit, :scale => 2)
+    Conversions::Unit.conversion.keys.each do |unit|
+      assert_equal 1.0, Conversions::Unit.new(1.0, unit).to(unit, 2)
     end
   end
-  
-  def test_register
-    Conversions.register(:dollars, :cents, 100.0)
-    assert_in_delta 0.01, Conversions::Unit.exchange_rate(:cents, :dollars), DELTA
-    amount = Conversions::Unit.new(10.0, :dollars)
-    assert_equal 1000.0, amount.to(:cents, :scale => 2), DELTA
-  end
 end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification 
 name: seamusabshere-conversions
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: "1.2"
 platform: ruby
 authors: 
-- Manfred Stienstra
+- Fingertips
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-03-16 00:00:00 -07:00
+date: 2009-01-12 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
-description: A Ruby on Rails plugin that adds conversion capabilities to numeric objects"
+description: A Ruby on Rails plugin that adds conversion capabilities to numeric objects
 email: manfred@fngtps.com
 executables: []
 
@@ -22,22 +22,29 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/conversions
+- conversions.gemspec
+- init.rb
+- lib
+- LICENSE
+- rails
+- Rakefile
+- README
+- test
+- TODO
 - lib/conversions/active_record_accessors.rb
-- lib/conversions/defaults.rb
+- lib/conversions/ext.rb
 - lib/conversions/unit.rb
 - lib/conversions.rb
+- rails/init.rb
 - test/accessor_test.rb
-- test/conversions_test.rb
 - test/ext_test.rb
 - test/test_helper.rb
 - test/unit_test.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/Fingertips/conversions/tree/master
 post_install_message: 
-rdoc_options: 
-- --inline-source
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -58,6 +65,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: A Ruby on Rails plugin that adds conversion capabilities to numeric objects"
-test_files: []
-
+summary: A Ruby on Rails plugin that adds conversion capabilities to numeric objects
+test_files: 
+- test/unit_test.rb

data/lib/conversions/defaults.rb

@@ -1,27 +0,0 @@
-{
-  :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/test/conversions_test.rb

@@ -1,26 +0,0 @@
-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)
-      1.records.to(:cds)
-      1.cds.to(: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