Fingertips-conversions 1.2.1

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,32 @@
+= 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

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

@@ -0,0 +1,22 @@
+Gem::Specification.new do |spec|
+  spec.name = "conversions"
+  spec.version = "1.2.1"
+  
+  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

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

data/lib/conversions/active_record_accessors.rb

@@ -0,0 +1,49 @@
+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.
+    #
+    # 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
+        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.send(options[:external]).to(options[:internal]))
+      end
+    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

@@ -0,0 +1,46 @@
+module Conversions #:nodoc
+  # 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)
+    # * _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 = 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/lib/conversions.rb

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

data/rails/init.rb

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

data/test/accessor_test.rb

@@ -0,0 +1,30 @@
+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
+end
+
+class AccessorTest < Test::Unit::TestCase
+
+  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
+end

data/test/ext_test.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ExtTest < Test::Unit::TestCase
+  
+  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
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'test/unit'
+
+if not defined?(ActiveRecord)
+  require 'rubygems'
+  require 'active_record'
+end
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'conversions'
+
+DELTA = 0.0000001

data/test/unit_test.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class UnitTest < Test::Unit::TestCase
+  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::Unit.conversion.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, :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_identity_transforms
+    Conversions::Unit.conversion.keys.each do |unit|
+      assert_equal 1.0, Conversions::Unit.new(1.0, unit).to(unit, 2)
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: Fingertips-conversions
+version: !ruby/object:Gem::Version 
+  version: 1.2.1
+platform: ruby
+authors: 
+- Manfred Stienstra
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-11 00:00:00 -08: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: 
+- README
+- LICENSE
+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
+has_rdoc: true
+homepage: http://github.com/Fingertips/conversions/tree/master
+post_install_message: 
+rdoc_options: 
+- --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: 
+- test/unit_test.rb
+- test/accessor_test.rb
+- test/ext_test.rb
+- test/test_helper.rb