measurement 0.1

data/CHANGELOG

@@ -0,0 +1 @@
+v0.1 First version

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Jeremy Wells
+
+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/Manifest

@@ -0,0 +1,15 @@
+CHANGELOG
+LICENSE
+Manifest
+README.rdoc
+Rakefile
+lib/measurement.rb
+lib/measurement/conversion.rb
+lib/measurement/length.rb
+lib/measurement/weight.rb
+spec/lib/conversion_spec.rb
+spec/lib/length_spec.rb
+spec/lib/measurement_spec.rb
+spec/lib/weight_spec.rb
+spec/spec.opts
+spec/spec_helper.rb

data/README.rdoc

@@ -0,0 +1,40 @@
+= Library for holding, converting and formatting measurements
+
+* http://github.com/jemmyw/measurement
+
+== DESCRIPTION
+
+== INSTALL:
+
+* sudo gem install measurement
+
+== EXAMPLE:
+
+  require 'measurement/length'
+  length = Length.parse('180.34cm')
+  puts length.in_feet_and_inches => 5' 11"
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Jeremy Wells
+
+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/Rakefile

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'spec'
+require 'spec/rake/spectask'
+require 'echoe'
+Echoe.new('measurement') do |gem|
+  gem.author = "Jeremy Wells"
+  gem.summary = "A library for holding, converting and formatting measurements"
+  gem.email = "jemmyw@gmail.com"
+end

data/lib/measurement.rb

@@ -0,0 +1,129 @@
+require File.join(File.dirname(__FILE__), 'measurement', 'conversion')
+
+module Measurement
+  class NoScaleFoundException < Exception; end
+  
+  class Base
+    def self.base(*args)
+      if args.any?
+        @base = Conversion.new(1.0, *args)
+        add_conversion(@base)
+      else
+        @base
+      end
+    end
+    
+    def self.conversions
+      @conversions ||= []
+    end
+  
+    def self.conversion(scale, *args)
+      add_conversion(Conversion.new(scale, *args))
+    end
+  
+    def self.add_conversion(conversion)
+      conversions << conversion
+    end
+  
+    def self.fetch_scale(scale = nil)
+      scale.nil? ? base : conversions.detect do |conversion|
+        conversion.has_name?(scale)
+      end
+    end
+    
+    def self.find_scale(scale)
+      conversions.detect do |conversion|
+        conversion.has_name?(scale) ||
+          conversion.suffix == scale
+      end
+    end
+  
+    def self.from(amount, scale)
+      fetch_scale(scale).from(amount)
+    end
+  
+    def self.to(amount, scale = nil)
+      fetch_scale(scale).to(amount)
+    end
+  
+    def self.format(amount, scale = nil, precision = 2)
+      fetch_scale(scale).format(amount, precision)
+    end
+    
+    def self.parse(string)
+      string = string.dup
+      base_amount = 0.0
+      
+      while string =~ /(\d+(\.\d+)?)([^\d]*)/
+        amount = $1.to_f
+        scale = $3 && $3.strip
+        
+        if scale && scale.length > 0
+          scale = find_scale(scale)
+          
+          if scale.nil?
+            raise NoScaleFoundException.new(scale)
+          else
+            base_amount += scale.from(amount)
+          end
+        else
+          base_amount += amount
+        end
+        
+        string.sub!(/(\d+(\.\d+)?)([^\d]*)/, '')
+      end
+      
+      self.new(base_amount)
+    end
+  
+    def initialize(amount = 0, scale = nil)
+      @amount = self.class.from(amount, scale)
+    end
+  
+    def to_i
+      @amount.to_i
+    end
+  
+    def to_f
+      @amount.to_f
+    end
+  
+    def as(scale)
+      self.class.to(@amount, scale)
+    end
+    
+    def method_missing(method, *args)
+      if method.to_s =~ /^(as|in)_(.*)/
+        scale = $2
+        if scale =~ /and/
+          to_s(scale, *args)
+        else
+          as(scale.to_sym, *args)
+        end
+      else
+        super
+      end
+    end
+  
+    def to_s(scale = nil, precision = 2)
+      if scale.to_s =~ /_and_/
+        scales = scale.to_s.split('_and_')
+        amount = @amount
+        strs = []
+    
+        while scale = scales.shift
+          n_in = self.class.to(amount, scale.to_sym)
+          n_in = n_in.floor unless scales.empty?        
+          n_out = self.class.from(n_in, scale.to_sym)
+          amount -= self.class.from(n_in, scale.to_sym)
+          strs << self.class.format(n_out, scale.to_sym, 0)
+        end
+    
+        strs.join(' ')
+      else
+        self.class.format(@amount, scale, precision)
+      end
+    end
+    alias_method :format, :to_s
+  end
+end

data/lib/measurement/conversion.rb

@@ -0,0 +1,35 @@
+module Measurement
+  class Conversion
+    attr_reader :names
+    
+    def initialize(scale, *args)
+      @options = args.last.is_a?(Hash) ? args.pop : {}
+      @names = args
+      @scale = scale
+    end
+    
+    def has_name?(name)
+      names.include?(name)
+    end
+  
+    def from(amount)
+      amount.to_f * @scale
+    end
+  
+    def to(amount)
+      amount.to_f / @scale
+    end
+  
+    def format(amount, precision = 2)
+      prefix + ("%.#{precision}f" % to(amount)) + suffix
+    end
+  
+    def prefix
+      @options[:prefix] || ''
+    end
+  
+    def suffix
+      @options[:suffix] || ''
+    end
+  end
+end

data/lib/measurement/length.rb

@@ -0,0 +1,16 @@
+require File.join(File.dirname(__FILE__), '..', 'measurement')
+
+class Length < Measurement::Base
+  base :metre, :suffix => 'm'
+  conversion 1000, :kilometre, :kilometres, :km, :suffix => 'km'
+  conversion 0.01, :centimetre, :centimetres, :cm, :suffix => 'cm'
+  conversion 0.001, :millimetre, :mm, :suffix => 'mm'
+  
+  conversion 0.0254, :inch, :inches, :suffix => '"'
+  conversion 0.3048, :feet, :foot, :suffix => "'"
+  conversion 1609.34, :mile, :miles, :suffix => ' miles'
+  conversion 0.1016, :hand, :hands, :suffix => ' hands'
+  
+  conversion 299792458, :light_seconds, :suffix => ' light seconds'
+  conversion 1079252848800, :light_hours, :suffix => ' light hours'
+end

data/lib/measurement/weight.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), '..', 'measurement')
+
+class Weight < Measurement::Base
+  base :grams, :suffix => 'g'
+  conversion 1000.0, :kilograms, :kg, :kgs, :suffix => 'kg'
+  conversion 453.59236, :pounds, :pound, :lbs, :suffix => 'lbs'
+  conversion 28.3495231, :ounces, :ounce, :oz, :suffix => 'oz'
+  conversion 6350.29318, :stone, :st, :suffix => 'st'
+end

data/measurement.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{measurement}
+  s.version = "0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeremy Wells"]
+  s.date = %q{2010-02-27}
+  s.description = %q{A library for holding, converting and formatting measurements}
+  s.email = %q{jemmyw@gmail.com}
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.rdoc", "lib/measurement.rb", "lib/measurement/conversion.rb", "lib/measurement/length.rb", "lib/measurement/weight.rb"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README.rdoc", "Rakefile", "lib/measurement.rb", "lib/measurement/conversion.rb", "lib/measurement/length.rb", "lib/measurement/weight.rb", "spec/lib/conversion_spec.rb", "spec/lib/length_spec.rb", "spec/lib/measurement_spec.rb", "spec/lib/weight_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "measurement.gemspec"]
+  s.homepage = %q{}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Measurement", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{measurement}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A library for holding, converting and formatting measurements}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/lib/conversion_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Measurement::Conversion do
+  describe '#instance methods' do
+    before do
+      @conversion = Measurement::Conversion.new(150.0, :test, :other)
+    end
+        
+    describe '#from' do
+      it 'should multiply the amount by the conversion scale' do
+        @conversion.from(1).should == 150.0
+      end
+    end
+  
+    describe '#to' do
+      it 'should divide the amount by the conversion scale' do
+        @conversion.to(150).should == 1
+      end
+    end
+  
+    describe '#format' do
+      it 'should return a string' do
+        @conversion.format(1).should be_a(String)
+      end
+      
+      it 'should format using the given precision' do
+        @conversion.format(200,1).should == "1.3"
+        @conversion.format(200,2).should == "1.33"
+      end
+      
+      it 'should apply the suffix' do
+        @conversion = Measurement::Conversion.new(150.0, :test, :suffix => 'test')
+        @conversion.format(150, 0).should == "1test"
+      end
+      
+      it 'should apply the prefix' do
+        @conversion = Measurement::Conversion.new(150.0, :test, :prefix => 'test')
+        @conversion.format(150, 0).should == "test1"
+      end
+    end
+  end
+end

data/spec/lib/length_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Length do
+  it 'should have 10 conversions' do
+    Length.conversions.size.should == 10
+  end
+  
+  it 'should use metres as a base' do
+    Length.new(1).to_s(nil, 0).should == '1m'
+  end
+  
+  { :cm => 100,
+    :mm => 1000,
+    :inches => 39.370,
+    :feet => 3.281,
+    :hand => 9.842,
+    :km => 0.001
+  }.each do |key, value|
+    it "should have #{key} with 1 metre = #{value} #{key}" do
+      Length.new(1).as(key).should be_close(value, 0.001)
+    end
+  end
+  
+  it 'should have miles' do
+    Length.new(1).in_miles.should be_close(0.0006213, 0.0000001)
+  end
+end

data/spec/lib/measurement_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Measurement::Base do
+  describe '::parse' do
+    it 'should parse in the base unit if no unit is specified' do
+      Length.parse('113').to_f.should == 113.0
+    end
+    
+    it 'should parse floating point numbers' do
+      Length.parse('113.43').to_f.should == 113.43
+    end
+    
+    it 'should parse in the unit specified' do
+      Length.parse('32cm').to_f.should == 0.32
+      Length.parse('32cm').to_s(:cm, 0).should == '32cm'
+    end
+    
+    it 'should parse multiple units' do
+      Length.parse('32cm 5mm').to_f.should == 0.325
+      Length.parse('32cm 5mm').to_s(:cm, 0).should == '32cm'
+      Length.parse('32cm 5mm').to_s(:cm_and_mm).should == '32cm 5mm'
+    end
+    
+    it 'should be able to parse units based on their suffix' do
+      Length.parse('5"').in_inches.should == 5.0
+      Length.parse(%Q{5' 11"}).to_f.should == 1.8034
+    end
+    
+    it 'should raise a NoScaleFoundException if there is no scale matching the one passed' do
+      lambda do
+        Length.parse('10giglygoops')
+      end.should raise_error(Measurement::NoScaleFoundException)
+    end
+  end
+  
+  describe '#method_missing' do
+    it 'should call as if passed in_scale' do
+      Length.new(10).in_cm.should == Length.new(10).as(:cm)
+    end
+    
+    it 'should call as if passed as_scale' do
+      Length.new(10).as_cm.should == Length.new(10).as(:cm)
+    end
+    
+    it 'should call to_s if passed in_scale_and_another_scale' do
+      length = Length.new(123.52390842)
+      length.in_cm_and_mm.should == length.to_s(:cm_and_mm)
+    end
+  end
+end

data/spec/lib/weight_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Weight do
+  it 'should use metres as a base' do
+    Weight.new(1).to_s(nil, 0).should == '1g'
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--color
+--reverse
+--debugger

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'lib/measurement'
+require 'lib/measurement/length'
+require 'lib/measurement/weight'

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: measurement
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Jeremy Wells
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-27 00:00:00 +13:00
+default_executable: 
+dependencies: []
+
+description: A library for holding, converting and formatting measurements
+email: jemmyw@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- LICENSE
+- README.rdoc
+- lib/measurement.rb
+- lib/measurement/conversion.rb
+- lib/measurement/length.rb
+- lib/measurement/weight.rb
+files: 
+- CHANGELOG
+- LICENSE
+- Manifest
+- README.rdoc
+- Rakefile
+- lib/measurement.rb
+- lib/measurement/conversion.rb
+- lib/measurement/length.rb
+- lib/measurement/weight.rb
+- spec/lib/conversion_spec.rb
+- spec/lib/length_spec.rb
+- spec/lib/measurement_spec.rb
+- spec/lib/weight_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- measurement.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Measurement
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: measurement
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A library for holding, converting and formatting measurements
+test_files: []
+