m9t 0.3.2 → 1.0.0

data/lib/m9t/distance.rb

@@ -1,23 +1,20 @@
-# encoding: utf-8
-require 'i18n'
-require 'm9t/base'
+require "m9t/base"
 
 module M9t
-
   # Represents a distance
   class Distance
-    DEFAULT_OPTIONS      = {:units => :meters, :abbreviated => false, :precision => 5}
-    CONVERSIONS          = {
-      :meters     => 1.0,
-      :kilometers => 1.0 / 1000.0,
-      :feet       => 1.0 / 0.3048,
-      :miles      => 1.0 / 1609.344
+    DEFAULT_OPTIONS = {
+      units: :meters, abbreviated: false, precision: 5
+    }
+    CONVERSIONS = {
+      meters:     1.0,
+      kilometers: 1.0 / 1000.0,
+      feet:       1.0 / 0.3048,
+      miles:      1.0 / 1609.344
     }
 
     include M9t::Base
 
     alias :to_meters :value
-
   end
-
 end

data/lib/m9t/errors.rb

@@ -0,0 +1,9 @@
+module M9t
+  # Base class for all M9t exceptions
+  class M9tError < StandardError
+  end
+
+  # Raised when a M9t class receives an unrecogized ':units' value
+  class UnitError < M9t::M9tError
+  end
+end

data/lib/m9t/i18n.rb

@@ -1,25 +1,33 @@
-# encoding: utf-8
-require 'i18n'
+require "i18n"
+
+locales_path = File.expand_path(
+  File.join("..", "..", "locales"), File.dirname(__FILE__)
+)
+I18n.load_path += Dir.glob("#{ locales_path }/*.yml")
+I18n.reload!
 
 # Monkey patch I18n
+# i18n does not handle localizing numbers.
+# See the following GitHub issues:
+# * https://github.com/svenfuchs/i18n/issues/328
+# * https://github.com/svenfuchs/i18n/issues/135
+# * https://github.com/svenfuchs/i18n/issues/183
 module I18n
-
   # Handle non-English numerical separators
   # with I18n.locale = :it,
-  #   I18n.localize_float(5.23) => '5,23000'
+  #   I18n.localize_float(5.23) => "5,23000"
   def I18n.localize_float(float, options = {})
-    format = options[:format] || '%f'
+    format = options[:format] || "%f"
     english = format % float
-    integers, decimal = english.split('.')
-    integers ||= ''
+    integers, decimal = english.split(".")
+    integers ||= ""
 
-    thousands_separator = I18n.t('numbers.thousands_separator')
-    integers.gsub(',', thousands_separator)
+    thousands_separator = I18n.t("numbers.thousands_separator")
+    integers.gsub(",", thousands_separator)
 
     return integers if decimal.nil?
 
-    decimal_separator = I18n.t('numbers.decimal_separator')
+    decimal_separator = I18n.t("numbers.decimal_separator")
     integers + decimal_separator + decimal
   end
 end
-

data/lib/m9t/pressure.rb

@@ -1,23 +1,17 @@
-# encoding: utf-8
-require 'i18n'
-require 'm9t/base'
+require "m9t/base"
 
 module M9t
-
   # Represents atmospheric (or other) pressure
   class Pressure
-    DEFAULT_OPTIONS  = {:units => :bar, :abbreviated => false, :precision => 5}
+    DEFAULT_OPTIONS  = {units: :bar, abbreviated: false, precision: 5}
     CONVERSIONS          = {
-      :bar               => 1.0,
-      :pascals           => 1.0 / 0.00001,
-      :hectopascals      => 1.0 / 0.001,
-      :kilopascals       => 1.0 / 0.01,
-      :inches_of_mercury => 1.0 / ( 3386.389 * 0.00001 )
+      bar:               1.0,
+      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
-
   end
-
 end
-

data/lib/m9t/speed.rb

@@ -1,28 +1,25 @@
-# encoding: utf-8
-require 'i18n'
-require 'm9t/distance'
+require "m9t/base"
+require "m9t/distance"
 
 module M9t
-
   # Represents a speed
   class Speed
-    DEFAULT_OPTIONS = {:units => :meters_per_second, :abbreviated => false, :precision => 5}
+    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             = KMH / 1.852
+    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,
-      :miles_per_hour      => MPH,
-      :knots               => KNOTS
+      meters_per_second:   1.0,
+      kilometers_per_hour: KMH,
+      miles_per_hour:      MPH,
+      knots:               KNOTS
     }
 
     include M9t::Base
 
     alias :to_meters_per_second :value
-
   end
-
 end
-

data/lib/m9t/temperature.rb

@@ -1,17 +1,16 @@
-# encoding: utf-8
-require 'i18n'
-require 'm9t/base'
+require "m9t/base"
 
 module M9t
-
   # Represents a temperature
   # Using degrees (celcius), not kelvin, as default unit
   class Temperature
-    DEFAULT_OPTIONS      = {:units => :degrees, :abbreviated => false, :precision => 5}
-    CONVERSIONS          = {
-      :degrees   => 1.0,
-      :kelvin    => nil,
-      :fahrenheit => nil
+    DEFAULT_OPTIONS = {
+      units: :degrees, abbreviated: false, precision: 5
+    }
+    CONVERSIONS  = {
+      degrees:   1.0,
+      kelvin:    nil,
+      fahrenheit: nil
     }
 
     # Conversions
@@ -20,14 +19,13 @@ module M9t
     include M9t::Base
 
     class << self
-
       # Accepts a value in kelvin and returns the equivalent M9t::Temperature
-      def kelvin( kelvin )
-        new( kelvin.to_f + ABSOLUTE_ZERO )
+      def kelvin(kelvin)
+        new(kelvin.to_f + ABSOLUTE_ZERO)
       end
 
-      def fahrenheit( fahrenheit )
-        new( fahrenheit_to_degrees( fahrenheit ) )
+      def fahrenheit(fahrenheit)
+        new(fahrenheit_to_degrees(fahrenheit))
       end
 
       # Converts degrees to kelvin
@@ -47,9 +45,8 @@ module M9t
 
       # Converts Fahrenheit to degrees
       def fahrenheit_to_degrees(fahrenheit)
-        fahrenheit.to_f - 32 * 5.0 / 9.0
+        (fahrenheit.to_f - 32) * 5.0 / 9.0
       end
-
     end
 
     alias :to_degrees :value
@@ -62,8 +59,5 @@ module M9t
     def to_fahrenheit
       self.class.to_fahrenheit(@value)
     end
-
   end
-
 end
-

data/lib/m9t/version.rb

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

data/locales/de.yml

@@ -0,0 +1,68 @@
+# encoding: utf8
+de:
+  numbers:
+    thousands_separator: '.'
+    decimal_separator: ','
+  units:
+    distance:
+      meters:
+        full:
+          zero: Meter
+          one: Meter
+          other: Meter
+        abbreviated: m
+      kilometers:
+        full:
+          zero: Kilometer
+          one: Kilometer 
+          other: Kilometer
+        abbreviated: km
+      miles:
+        full:
+          zero: Meilen
+          one: Meile
+          other: Meilen
+      feet:
+        full:
+          one: Fuß
+          other: Fuß
+        abbreviated: ft
+    direction:
+      degrees:
+        full:
+          zero: Grad
+          one: Grad
+          other: Grad
+        abbreviated: °
+    speed:
+      meters_per_second:
+        full:
+          zero: Meter pro Sekunde
+          one: Meter pro Sekunde
+          other: Meter pro Sekunde
+        abbreviated: m/s
+      kilometers_per_hour:
+        full:
+          one: Kilometer pro Stunde
+          other: Kilometer pro Stunde
+        abbreviated: km/h
+      knots:
+        full:
+          zero: Knoten
+          one: Knoten
+          other: Knoten
+    temperature:
+      degrees:
+        full:
+          zero: Grad
+          one: Grad
+          other: Grad
+        abbreviated: °C
+      kelvin:
+        full:
+          zero: Kelvin
+          one: Kelvin
+          other: Kelvin
+        abbreviated: K
+  direction:
+    sectors: ['N', 'NNO', 'NO', 'ONO', 'O', 'OSO', 'SO', 'SSO', 'S', 'SSW', 'SW', 'WSW', 'W', 'WNW', 'NW', 'NNW', 'N']

data/locales/en.yml

@@ -22,6 +22,7 @@ en:
           zero: miles
           one: mile
           other: miles
+        abbreviated: mi
       feet:
         full:
           one: foot
@@ -35,6 +36,12 @@ en:
           other: degrees
         abbreviated: °
     speed:
+      miles_per_hour:
+        full:
+          zero: miles per hour
+          one: mile per hour
+          other: miles per hour
+        abbreviated: mph
       meters_per_second:
         full:
           zero: meters per second
@@ -52,6 +59,12 @@ en:
           one: knot
           other: knots
     temperature:
+      fahrenheit:
+        full:
+          zero: degrees
+          one: degree
+          other: degrees
+        abbreviated: °F
       degrees:
         full:
           zero: degrees

data/m9t.gemspec

@@ -1,28 +1,30 @@
-# -*- encoding: utf-8 -*-
-$:.unshift( File.dirname(__FILE__) + '/lib' )
-require 'm9t/version'
+$LOAD_PATH.unshift(File.expand_path("../lib", __FILE__))
+require "m9t/version"
 
 gemspec = Gem::Specification.new do |s|
-  s.name          = 'm9t'
+  s.name          = "m9t"
   s.platform      = Gem::Platform::RUBY
   s.version       = M9t::VERSION::STRING
+  s.required_ruby_version = ">= 2.4.0"
 
-  s.summary       = 'Measurements and conversions library for Ruby'
-  s.description   = 'Classes for handling basic measurement units: distance, direction, speed, temperature and pressure'
+  s.summary       = "Measurements and conversions library for Ruby"
+  s.description   = "Classes for handling basic measurement units: distance, direction, speed, temperature and pressure"
+  s.license       = "MIT"
 
-  s.homepage      = 'https://github.com/joeyates/m9t'
-  s.author        = 'Joe Yates'
-  s.email         = 'joe.g.yates@gmail.com'
+  s.homepage      = "https://github.com/joeyates/m9t"
+  s.author        = "Joe Yates"
+  s.email         = "joe.g.yates@gmail.com"
 
-  s.files         = `git ls-files`.lines.map( &:chomp! ).reject { | f | f[ 0 .. 0 ] == '.' }
-  s.test_files    = `git ls-files`.lines.map( &:chomp! ).select { | f | f =~ /_test.rb$/ }
-  s.require_paths = ['lib']
+  s.files         = `git ls-files`.lines.map(&:chomp!)
+  s.test_files    = `git ls-files spec`.lines.map(&:chomp!)
+  s.require_paths = ["lib"]
 
-  s.rubyforge_project = 'nowarning'
+  s.rubyforge_project = "nowarning"
 
-  s.add_dependency 'rake'
-  s.add_dependency 'i18n', '>= 0.3.5'
+  s.add_dependency "rake"
+  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'
+  s.add_development_dependency "codeclimate-test-reporter", "~> 0.4.8"
+  s.add_development_dependency "rspec", ">= 3.0.0"
+  s.add_development_dependency "simplecov" if RUBY_PLATFORM != "java"
 end

data/spec/base_spec.rb

@@ -0,0 +1,79 @@
+require "m9t/base"
+
+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
+
+describe M9t::Base do
+  describe ".respond_to?" do
+    it "is true for conversion between known units" do
+      expect(SomeMeasurement.respond_to?(:foos_to_bars)).to be_truthy
+    end
+
+    it "is false for unknown units" do
+      expect(SomeMeasurement.respond_to?(:bazs_to_bars)).to be_falsey
+    end
+  end
+
+  describe ".method_missing" do
+    it "handles conversion between known units" do
+      expect(SomeMeasurement.foos_to_bars(3.0)).to be_a(Float)
+    end
+
+    it "fails for unknown units" do
+      expect {
+        SomeMeasurement.bazs_to_bars(3.0)
+      }.to raise_error(NoMethodError)
+    end
+  end
+
+  describe "#respond_to?" do
+    subject { SomeMeasurement.new(3.0) }
+
+    it "is true for conversion to known units" do
+      expect(subject.respond_to?(:to_bars)).to be_truthy
+    end
+
+    it "is false for unknown units" do
+      expect(subject.respond_to?(:to_bazs)).to be_falsey
+    end
+
+    context "for unrecognized calls" do
+      it "calls super" do
+        expect(subject.respond_to?(:ciao)).to be_falsey
+      end
+    end
+  end
+
+  describe "#method_missing" do
+    subject { SomeMeasurement.new(3.0) }
+
+    it "handles conversion to known units" do
+      expect(subject.to_bars).to be_a(Float)
+    end
+
+    it "fails for unknown units" do
+      expect {
+        subject.to_bazs(3.0)
+      }.to raise_error(NoMethodError)
+    end
+  end
+
+  describe "derived class" do
+    it "inherits options" do
+      expect(SomeDerivedMeasurement.options).to eq(SomeMeasurement.options)
+    end
+  end
+end