seamusabshere-conversions 1.3.0 → 1.4.0

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 1
+:minor: 4
+:patch: 0

data/lib/conversions.rb

@@ -1,51 +1,59 @@
+# Conversions makes it easy to convert between units.
 module Conversions
   mattr_accessor :conversions
-  self.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] ||= {}
     conversions[from][to] = rate
     conversions[to] ||= {}
-    conversions[to][from] ||= {}
-    conversions[to][from] = 1 / rate
+    conversions[to][from] = 1.0 / rate
+    Conversions.define_shortcut(from)
+    Conversions.define_shortcut(to)
   end
-  
-  # This is ugly
-  {
-    :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|
-      register(from_unit, to_unit, rate)
+
+  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
 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(:convert, options[:internal], options[:external], :scale => 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(:convert, options[:external], 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,9 +13,16 @@ 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, options = {})
-      scale = options.delete(:scale)
+    # * _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
+      
       value = @value * self.class.exchange_rate(@from, to)
       scale.nil? ? value : (value * (10 ** scale)).round / (10 ** scale).to_f
     end

data/test/accessor_test.rb

@@ -11,7 +11,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,26 @@
+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

data/test/ext_test.rb

@@ -1,6 +1,10 @@
 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
@@ -8,10 +12,17 @@ class ExtTest < Test::Unit::TestCase
     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
+    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
   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,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
@@ -20,21 +24,26 @@ 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, :scale => 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
     
-    amount = Conversions::Unit.new(10.0, :kilograms)
-    assert_equal 22.05, amount.to(:pounds, :scale => 2), DELTA
-    
-    amount = Conversions::Unit.new(10.0, :miles_per_gallon)
-    assert_equal 4.25, amount.to(:kilometres_per_litre, :scale => 2), DELTA
+  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)
   end
   
   def test_identity_transforms
-    Conversions.conversions.each do |unit|
+    Conversions.conversions.keys.each do |unit|
       assert_equal 1.0, Conversions::Unit.new(1.0, unit).to(unit, :scale => 2)
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: seamusabshere-conversions
 version: !ruby/object:Gem::Version 
-  version: 1.3.0
+  version: 1.4.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-03-16 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -19,25 +19,17 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README
-- LICENSE
+extra_rdoc_files: []
+
 files: 
-- conversions.gemspec
-- init.rb
-- lib
-- LICENSE
-- rails
-- Rakefile
-- README
-- test
-- TODO
+- VERSION.yml
+- lib/conversions
 - lib/conversions/active_record_accessors.rb
-- lib/conversions/ext.rb
+- lib/conversions/defaults.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
@@ -45,7 +37,8 @@ has_rdoc: true
 homepage: http://github.com/Fingertips/conversions/tree/master
 post_install_message: 
 rdoc_options: 
-- --charset=utf-8
+- --inline-source
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -67,8 +60,5 @@ 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: 
-- test/unit_test.rb
-- test/accessor_test.rb
-- test/ext_test.rb
-- test/test_helper.rb
+test_files: []
+

data/LICENSE

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

@@ -1,32 +0,0 @@
-= Conversions
-
-The conversions plugin does a number of things. The core functionality is the unit conversion:
-
-  1.miles.to(:kilometres) #=> 1.609344
-  1.pounds.to(:kilograms) #=> 0.453592
-
-It also adds a class method to ActiveRecord::Base that allows you to define conversion methods for attributes:
-
-  class Car < ActiveRecord::Base
-    conversion_accessor :weight, :internal => :kilograms, :external => :pounds
-  end
-
-  car = Car.new(:weight => 1500)
-  car.weight_in_pounds #=> 3306.93393
-
-
-== Installation
-
-=== As a gem
-
-Configure the gem in environment.rb:
-  
-  config.gem 'Fingertips-conversions', :lib => 'conversions', :source => 'http://gems.github.com'
-
-Install them using Rails' rake task:
-
-  $ rake gems:install
-
-=== In your vendor directory:
-
-  script/install plugin git://github.com/Fingertips/conversions.git

data/Rakefile

@@ -1,34 +0,0 @@
-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
-
-namespace :rdoc do
-  desc 'Generate documentation for conversions plugin.'
-  Rake::RDocTask.new(:generate) do |rdoc|
-    rdoc.rdoc_dir = 'documentation'
-    rdoc.title    = 'Conversions'
-    rdoc.options << '--line-numbers' << '--inline-source' << '--charset' << 'utf-8'
-    rdoc.rdoc_files.include('README', 'lib/**/*.rb')
-  end
-end
-
-namespace :gem do
-  desc "Build the gem"
-  task :build do
-    sh 'gem build conversions.gemspec'
-  end
-  
-  desc "Install the gem"
-  task :install => :build do
-    sh 'sudo gem install conversions-*.gem'
-  end
-end

data/conversions.gemspec

@@ -1,22 +0,0 @@
-Gem::Specification.new do |spec|
-  spec.name = "conversions"
-  spec.version = "1.3.0"
-  
-  spec.author = "Manfred Stienstra"
-  spec.email = "manfred@fngtps.com"
-  
-  spec.description = <<-EOF
-    A Ruby on Rails plugin that adds conversion capabilities to numeric objects"
-  EOF
-  spec.summary = <<-EOF
-    A Ruby on Rails plugin that adds conversion capabilities to numeric objects"
-  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.has_rdoc = true
-  spec.extra_rdoc_files = ['README', 'LICENSE']
-  spec.rdoc_options << "--charset=utf-8"
-end

data/init.rb

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

data/lib/conversions/ext.rb

@@ -1,7 +0,0 @@
-module Conversions #:nodoc:
-  module Ext
-    def convert(from, to, options={})
-      Unit.new(self, from).to(to, options)
-    end
-  end
-end

data/rails/init.rb

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