m9t 0.2.3 → 0.3.0

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec :name => 'm9t'

data/MIT-LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Joe Yates
+
+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.md

@@ -0,0 +1,100 @@
+m9t [![Build Status](https://secure.travis-ci.org/joeyates/m9t.png)][Continuous Integration]
+===
+
+*Measurements and coversions library for Ruby*
+
+  * [Source Code]
+  * [API documentation]
+  * [Rubygem]
+  * [Continuous Integration]
+
+[Source Code]: https://github.com/joeyates/m9t "Source code at GitHub"
+[API documentation]: http://rubydoc.info/gems/m9t/frames "RDoc API Documentation at Rubydoc.info"
+[Rubygem]: http://rubygems.org/gems/m9t "Ruby gem at rubygems.org"
+[Continuous Integration]: http://travis-ci.org/joeyates/m9t "Build status by Travis-CI"
+
+This package handles the basic units of measure:
+
+- distance,
+- direction,
+- speed,
+- temperature,
+- weight.
+
+The emphasis is on:
+
+- coherent interface,
+- ease of translation (using i18n).
+
+Internals
+=========
+
+Internally, values are stored in SI units, with the exception of temperature:
+
+- distance - meters,
+- direction - degrees,
+- speed - meters per second,
+- temperature - degrees celcius,
+- weight - kilograms.
+
+Interface
+=========
+
+new: accepts the S.I. unit as a parameter:
+
+    height = M9t::Distance.new(1.75)
+
+to_f: returns the decimal value(s):
+
+    height.to_f -> 1.75
+
+other units:
+there are class methods named after each known unit,
+which take values in that unit
+(actually, they are defined as needed):
+
+    marathon = M9t::Distance.miles(26.21875)
+    marathon.to_f -> 42194.988
+
+to_s: returns a localized string with units:
+
+    I18n.locale = :it
+    puts M9t::Distance.new(3).to_s -> '3 metri'
+
+Class methods for conversion
+============================
+
+Methods are available for conversion between any pair of units:
+
+    M9t::Distance.miles_to_meters(26.21875) -> 42194.988
+
+Testing
+=======
+
+Coverage
+--------
+
+ruby 1.8.x:
+
+    $ rake rcov
+
+ruby 1.9.x:
+
+    $ COVERAGE=1 rake test
+
+Alternatives
+============
+
+- ruby-units
+  - Doesn't handle i18n:
+    - The library depends heavily on English string representations of units.
+  - Monkey patches a lot of core classes:
+    - Adds methods to e.g. Object.
+
+License
+=======
+
+Dual license:
+
+- MIT License: see MIT-LICENSE.txt,
+- GPL version 3: see GPL-LICENSE.txt

data/Rakefile

@@ -1,15 +1,9 @@
-require 'rubygems'
-require 'rake/rdoctask'
+require 'bundler'
 require 'rake/testtask'
-require 'rake/clean'
 
 $:.unshift( File.dirname(__FILE__) + '/lib' )
-require 'bundler/version'
 require 'm9t'
 
-RDOC_OPTS = ['--quiet', '--title', 'm9t: Measurement units', '--main', 'README.rdoc', '--inline-source']
-CLEAN.include 'doc'
-
 task :default => :test
 
 Rake::TestTask.new do |t|
@@ -18,19 +12,20 @@ Rake::TestTask.new do |t|
   t.verbose    = true
 end
 
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'doc/rdoc'
-  rdoc.options  += RDOC_OPTS
-  rdoc.main     = 'README.rdoc'
-  rdoc.rdoc_files.add ['README.rdoc', 'COPYING', 'lib/**/*.rb']
+if RUBY_VERSION < '1.9'
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.test_files = FileList['test/*_test.rb']
+    t.rcov_opts  << '--exclude /gems/'
+  end
 end
 
 desc "Build the gem"
 task :build do
-  system "gem build m9t.gemspec"
+  `gem build m9t.gemspec`
 end
 
 desc "Publish a new version of the gem"
 task :release => :build do
-  system "gem push m9t-#{M9t::VERSION}"
+  `gem push m9t-#{M9t::VERSION::STRING}.gem`
 end

data/lib/m9t/base.rb

@@ -9,7 +9,7 @@ module M9t
     def self.generate_conversions(klass)
       klass.instance_eval do |klass|
         def convert(from, to, value)
-          value * self::CONVERSIONS[from] / self::CONVERSIONS[to]
+          value / self::CONVERSIONS[from] * self::CONVERSIONS[to]
         end
 
         def method_missing(name, *args, &block)
@@ -40,7 +40,7 @@ module M9t
           return false if not self::CONVERSIONS[name.to_sym]
           self.class.instance_exec do
             define_method( name.to_sym ) do | *args |
-              new( args[ 0 ].to_f * self::CONVERSIONS[ name ] )
+              new( args[ 0 ].to_f / self::CONVERSIONS[ name ] )
             end
           end
         end
@@ -69,7 +69,7 @@ module M9t
         # The name used for i18n translations
         #  M9t::Distance => 'distance'
         def measurement_name
-          name.downcase.split('::')[1]
+          name.split('::')[-1].downcase
         end
 
         def default_unit

data/lib/m9t/distance.rb

@@ -10,9 +10,9 @@ module M9t
     DEFAULT_OPTIONS      = {:units => :meters, :abbreviated => false, :precision => 5}
     CONVERSIONS          = {
       :meters     => 1.0,
-      :kilometers => 1000.0,
-      :feet       => 0.3048,
-      :miles      => 1609.344
+      :kilometers => 1.0 / 1000.0,
+      :feet       => 1.0 / 0.3048,
+      :miles      => 1.0 / 1609.344
     }
 
     include M9t::Base

data/lib/m9t/pressure.rb

@@ -10,10 +10,10 @@ module M9t
     DEFAULT_OPTIONS  = {:units => :bar, :abbreviated => false, :precision => 5}
     CONVERSIONS          = {
       :bar               => 1.0,
-      :pascals           => 0.00001,
-      :hectopascals      => 0.001,
-      :kilopascals       => 0.01,
-      :inches_of_mercury => 3386.389 * 0.00001
+      :pascals           => 1.0 / 0.00001,
+      :hectopascals      => 1.0 / 0.001,
+      :kilopascals       => 1.0 / 0.01,
+      :inches_of_mercury => 1.0 / ( 3386.389 * 0.00001 )
     }
 
     include M9t::Base

data/lib/m9t/speed.rb

@@ -9,10 +9,9 @@ module M9t
   class Speed
     DEFAULT_OPTIONS = {:units => :meters_per_second, :abbreviated => false, :precision => 5}
     SECONDS_PER_HOUR  = 60.0 * 60
-    KMH               = M9t::Distance::CONVERSIONS[:kilometers] / SECONDS_PER_HOUR
-    MPH               = M9t::Distance::CONVERSIONS[:miles] / SECONDS_PER_HOUR
-    KNOTS_TO_KMH      = 1.852
-    KNOTS             = KNOTS_TO_KMH / SECONDS_PER_HOUR * M9t::Distance::CONVERSIONS[:kilometers]
+    KMH               = M9t::Distance::CONVERSIONS[:kilometers] * SECONDS_PER_HOUR
+    MPH               = M9t::Distance::CONVERSIONS[:miles] * SECONDS_PER_HOUR
+    KNOTS             = KMH / 1.852
     CONVERSIONS = {
       :meters_per_second   => 1.0,
       :kilometers_per_hour => KMH,

data/lib/m9t/version.rb

@@ -2,8 +2,8 @@ module M9t
 
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 2
-    TINY  = 3
+    MINOR = 3
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/locales/it.yml

@@ -1,4 +1,4 @@
-# encoding: utf8
+# encoding: utf-8
 it:
   numbers:
     thousands_separator: '.'

data/m9t.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.unshift( File.dirname(__FILE__) + '/lib' )
+require 'm9t/version'
+
+gemspec = Gem::Specification.new do |s|
+  s.name          = 'm9t'
+  s.platform      = Gem::Platform::RUBY
+  s.version       = M9t::VERSION::STRING
+
+  s.summary       = 'Measurements and conversions library for Ruby'
+  s.description   = 'Classes for handling basic measurement units: distance, direction, speed, temperature and pressure'
+
+  s.homepage      = 'https://github.com/joeyates/m9t'
+  s.author        = 'Joe Yates'
+  s.email         = 'joe.g.yates@gmail.com'
+
+  s.files         = `git ls-files`.map( &:chomp! ).reject { | f | f[ 0 .. 0 ] == '.' }
+  s.test_files    = `git ls-files`.map( &:chomp! ).select { | f | f =~ /_test.rb$/ }
+  s.require_paths = ['lib']
+
+  s.rubyforge_project = 'nowarning'
+
+  s.add_dependency 'rake'                  if RUBY_VERSION < '1.9'
+  s.add_dependency 'rake', '~> 0.8.7'      if RUBY_VERSION > '1.9'
+  s.add_dependency 'i18n', '>= 0.3.5'
+
+  s.add_development_dependency 'rcov'      if RUBY_VERSION < '1.9'
+  s.add_development_dependency 'simplecov' if RUBY_VERSION > '1.9'
+end

data/test/base_test.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+require File.expand_path( 'test_helper', File.dirname( __FILE__ ) )
+
+class SomeMeasurement
+  DEFAULT_OPTIONS = {:units => :foos, :abbreviated => false, :decimals => 1}
+  CONVERSIONS     = {:foos =>      1.0,
+                     :bars => 1 / 42.0}
+
+  include M9t::Base
+end
+
+class SomeDerivedMeasurement < SomeMeasurement
+end
+
+class TestM9tBase < Test::Unit::TestCase
+
+  def setup
+    I18n.locale = :en
+    SomeMeasurement.reset_options!
+  end
+
+  # class methods
+
+  def test_class_method_missing_for_known_units
+    assert_in_delta(0.0714, SomeMeasurement.foos_to_bars(3.0), 0.001)
+  end
+
+  def test_class_method_missing_fails_on_unknown_units
+    assert_raise(RuntimeError) do
+      SomeMeasurement.bazs_to_bars(3.0)
+    end
+  end
+
+  # instance methods
+
+  def test_instance_method_missing_for_known_units
+    some = SomeMeasurement.new(3.0)
+    assert_in_delta(0.0714, some.to_bars(3.0), 0.001)
+  end
+
+  def test_instance_method_missing_fails_on_unknown_units
+    some = SomeMeasurement.new(3.0)
+    assert_raise(RuntimeError) do
+      some.to_bazs(3.0)
+    end
+  end
+
+  # derived classes
+
+  def test_derived_class_gets_options
+    assert_equal(SomeMeasurement.options, SomeDerivedMeasurement.options)
+  end
+
+end

data/test/direction_test.rb

@@ -1,12 +1,9 @@
-#!/usr/bin/env ruby
 # encoding: utf-8
 
-require 'rubygems' if RUBY_VERSION < '1.9'
-require 'test/unit'
-require File.join(File.expand_path(File.dirname(__FILE__) + '/../lib'), 'm9t')
+require File.expand_path( 'test_helper', File.dirname( __FILE__ ) )
 
 class TestM9tDirection < Test::Unit::TestCase
-  
+
   def setup
     I18n.locale = :en
     M9t::Direction.reset_options!
@@ -48,8 +45,8 @@ class TestM9tDirection < Test::Unit::TestCase
 
   def test_degrees_to_compass
     assert_equal('N', M9t::Direction.degrees_to_compass(0))
-    assert_equal('NE', M9t::Direction.degrees_to_compass(42)) # Quantizing up
-    assert_equal('E', M9t::Direction.degrees_to_compass(93)) # Quantizing down
+    assert_equal('NE', M9t::Direction.degrees_to_compass(42)) # Rounding up
+    assert_equal('E', M9t::Direction.degrees_to_compass(93)) # Rounding down
     assert_equal('ESE', M9t::Direction.degrees_to_compass(113)) # 16ths
     I18n.locale = :it
     assert_equal('O', M9t::Direction.degrees_to_compass(270))
@@ -100,4 +97,10 @@ class TestM9tDirection < Test::Unit::TestCase
     assert_equal(10, M9t::Direction.new('010').value)
   end
 
+  def test_to_compass
+    direction = M9t::Direction.new(0)
+
+    assert_equal('N', direction.to_compass)
+  end
+
 end

data/test/distance_test.rb

@@ -1,9 +1,6 @@
-#!/usr/bin/env ruby
 # encoding: utf-8
 
-require 'rubygems' if RUBY_VERSION < '1.9'
-require 'test/unit'
-require File.join(File.expand_path(File.dirname(__FILE__) + '/../lib'), 'm9t')
+require File.expand_path( 'test_helper', File.dirname( __FILE__ ) )
 
 class TestM9tDistance < Test::Unit::TestCase
 

data/test/i18n_test.rb

@@ -1,12 +1,9 @@
-#!/usr/bin/env ruby
 # encoding: utf-8
 
-require 'rubygems' if RUBY_VERSION < '1.9'
-require 'test/unit'
-require File.join(File.expand_path(File.dirname(__FILE__) + '/../lib'), 'm9t')
+require File.expand_path( 'test_helper', File.dirname( __FILE__ ) )
 
 class TestI18nMonkeyPatching < Test::Unit::TestCase
-  
+
   def setup
   end
 

data/test/pressure_test.rb

@@ -1,9 +1,6 @@
-#!/usr/bin/env ruby
 # encoding: utf-8
 
-require 'rubygems' if RUBY_VERSION < '1.9'
-require 'test/unit'
-require File.join(File.expand_path(File.dirname(__FILE__) + '/../lib'), 'm9t')
+require File.expand_path( 'test_helper', File.dirname( __FILE__ ) )
 
 class TestM9tDistance < Test::Unit::TestCase
 

data/test/speed_test.rb

@@ -1,12 +1,9 @@
-#!/usr/bin/env ruby
 # encoding: utf-8
 
-require 'rubygems' if RUBY_VERSION < '1.9'
-require 'test/unit'
-require File.join(File.expand_path(File.dirname(__FILE__) + '/../lib'), 'm9t')
+require File.expand_path( 'test_helper', File.dirname( __FILE__ ) )
 
 class TestM9tSpeed < Test::Unit::TestCase
-  
+
   def setup
     I18n.locale = :en
     M9t::Speed.reset_options!
@@ -28,7 +25,7 @@ class TestM9tSpeed < Test::Unit::TestCase
   # conversion constants
 
   def test_knot_conversion
-    assert_in_delta(0.51444, M9t::Speed::KNOTS, 0.0001)
+    assert_in_delta(1.9438, M9t::Speed::KNOTS, 0.0001)
   end
 
   # input conversions

data/test/temperature_test.rb

@@ -1,12 +1,9 @@
-#!/usr/bin/env ruby
 # encoding: utf-8
 
-require 'rubygems' if RUBY_VERSION < '1.9'
-require 'test/unit'
-require File.join(File.expand_path(File.dirname(__FILE__) + '/../lib'), 'm9t')
+require File.expand_path( 'test_helper', File.dirname( __FILE__ ) )
 
 class TestM9tTemperature < Test::Unit::TestCase
-  
+
   def setup
     I18n.locale = :en
     M9t::Temperature.reset_options!
@@ -51,6 +48,10 @@ class TestM9tTemperature < Test::Unit::TestCase
     assert_in_delta(32, M9t::Temperature.to_fahrenheit(0), 0.0001)
   end
 
+  def test_class_kelvin_to_degrees
+    assert_in_delta(-273.15, M9t::Temperature.kelvin_to_degrees(0), 0.0001)
+  end
+
   # Instance methods
 
   # new