seamusabshere-conversions 0.1.0

data/lib/conversions/active_record_accessors.rb

@@ -0,0 +1,49 @@
+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.
+    #
+    # Options:
+    #
+    # * <tt>:internal</tt>: The unit of the internal value
+    # * <tt>:external</tt>: The unit of desired external value
+    # * <tt>:scale</tt>: If a scale is given, the external value is automatically rounded on the specified scale.
+    #
+    #
+    # Examples:
+    #
+    #  require 'conversions'
+    #
+    #  class Flight
+    #    extend Conversions::ActiveRecordAccessors
+    #
+    #    attr_accessor :distance
+    #    conversion_accessor :distance, :internal => :kilometers, :external => :miles, :scale => 2
+    #
+    #    def initialize(distance)
+    #      self.distance = distance
+    #    end
+    #  end
+    #
+    #  flight = Flight.new(1200)
+    #  flight.distance_in_miles #=> 745.65, rounded down to two decimals as specified in :scale
+    #
+    # When used as a plugin for Rails, the ActiveRecord::Base is automatically extended.
+    #
+    #  class Car < ActiveRecord::Base
+    #    conversion_accessor :length, :internal => :kilometers, :external => :miles
+    #  end
+    def conversion_accessor(attribute, options={})
+      if options[:internal].nil? or options[:external].nil?
+        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
+      end
+      define_method "#{attribute}_in_#{options[:external]}=" do |v|
+        send("#{attribute}=", v.to_f.convert(options[:external], options[:internal], options.except(:internal, :external)))
+      end
+    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

@@ -0,0 +1,39 @@
+module Conversions
+  # Proxy class to contain the unit as well as reference the base value
+  class Unit
+    # Create a new Unit instance.
+    #
+    # * _value_: The value to convert from (ie. 4.92)
+    # * _from_: The unit to convert from (ie. :miles)
+    def initialize(value, from)
+      @value = value
+      @from = from
+    end
+
+    # 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
+      
+      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]
+      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
+  end
+end

data/lib/conversions.rb

@@ -0,0 +1,59 @@
+# 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
+end
+
+require 'conversions/unit'
+
+Conversions.load_defaults
+Numeric.send(:include, Conversions::Ext)
+
+if defined?(ActiveRecord)
+  require 'conversions/active_record_accessors'
+  ActiveRecord::Base.send(:extend, Conversions::ActiveRecordAccessors)
+end

data/test/accessor_test.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class Flight
+  extend Conversions::ActiveRecordAccessors
+  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
+
+  def test_include
+    assert @flight.respond_to?(:distance)
+    assert @flight.respond_to?(:distance_in_miles)
+  end
+
+  def test_conversion
+    @flight.distance = 1200
+    assert_in_delta 745.645430684801, @flight.distance_in_miles, DELTA
+  end
+
+  def test_conversion_with_scale
+    @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/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

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

@@ -0,0 +1,16 @@
+require 'test/unit'
+
+if not defined?(ActiveRecord)
+  require 'rubygems'
+  require 'active_record'
+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

@@ -0,0 +1,57 @@
+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
+    assert_raises(ArgumentError) { Conversions::Unit.exchange_rate(:unknown, :miles) }
+    assert_raises(ArgumentError) { Conversions::Unit.exchange_rate(:miles, :unknown) }
+    assert_raises(ArgumentError) { Conversions::Unit.exchange_rate(nil, :miles) }
+    assert_raises(ArgumentError) { Conversions::Unit.exchange_rate(:miles, nil) }
+  end
+  
+  def test_exchange_rate_for_identity_transform
+    Conversions.conversions.keys.each do |unit|
+      assert_equal 1, Conversions::Unit.exchange_rate(unit, unit)
+    end
+  end
+  
+  def test_to
+    amount = Conversions::Unit.new(10.0, :miles)
+    assert_in_delta 16.09344, amount.to(:kilometres), 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)
+  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)
+    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

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: seamusabshere-conversions
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Manfred Stienstra
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-16 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A Ruby on Rails plugin that adds conversion capabilities to numeric objects"
+email: manfred@fngtps.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/conversions
+- lib/conversions/active_record_accessors.rb
+- lib/conversions/defaults.rb
+- lib/conversions/unit.rb
+- lib/conversions.rb
+- test/accessor_test.rb
+- test/conversions_test.rb
+- test/ext_test.rb
+- test/test_helper.rb
+- test/unit_test.rb
+has_rdoc: true
+homepage: http://github.com/Fingertips/conversions/tree/master
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+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: []
+