m9t 0.3.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a5032bc2dee8145116056d99cc84fbaf492c8896
-  data.tar.gz: f361209c27b67471b1eb410651758141e4bf241e
+SHA256:
+  metadata.gz: 1e9e5be154c21f5d10e86c7c6f906f5bdd2287c56797965f8430c12fbcee09b2
+  data.tar.gz: c23bd6fe57b417fc46680c9c91dfe7517ea0833e1ec76f6cd959df5466a02028
 SHA512:
-  metadata.gz: 17d1116cc4b15a2b1cf7fb7191dbb01ac306f8d0748b6d638ee276263134c5e4d627d9e5e0a5f66e31732821f48c2c66d6122d4d5a23d80f46406ad13caf1b75
-  data.tar.gz: 6083ab4e3dc37724bf9984e62b0e3a50799e817edf000843e3dd679987e0d14314b97c718557e6043b4029c7323dbe7389a55d3bc8e463abd82e59c2db85c89e
+  metadata.gz: 12f3a7e3428384abfa69f90c2d7210dff7ba94494ae82e14b0be892159de160722ad60fd16502e68b699e228a1206af122246ff3c2062c24e14d942d0e90831f
+  data.tar.gz: 0b2fd9ec442f4dcaf8d992a3d301404d91c4ce6da76972affe6c40deb152f034cc6cc76a752ad921a7328748d3e4b05a40ee50edfe7675e687856fc5dcac58f1

data/.rspec

@@ -1,3 +1,2 @@
 --color
---format progress
-
+--require spec_helper

data/.travis.yml

@@ -5,6 +5,7 @@ rvm:
   - 2.0.0
   - 2.2.0
   - 2.3.0
+  - 2.4.0
   - jruby-19mode
 branches:
   only:

data/Gemfile

@@ -1,4 +1,3 @@
-source 'https://rubygems.org'
-
-gemspec :name => 'm9t'
+source "https://rubygems.org"
 
+gemspec name: "m9t"

data/Rakefile

@@ -1,9 +1,10 @@
 #!/usr/bin/env rake
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
 
-task :default => :spec
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task default: :spec
 
 RSpec::Core::RakeTask.new do |t|
-  t.pattern = 'spec/**/*_spec.rb'
+  t.pattern = "spec/**/*_spec.rb"
 end

data/lib/m9t.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010 Joe Yates
+# Copyright (c) 2010-2021 Joe Yates
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/lib/m9t/base.rb

@@ -1,6 +1,5 @@
-# encoding: utf-8
-require 'm9t/errors'
-require 'm9t/i18n'
+require "m9t/errors"
+require "m9t/i18n"
 
 module M9t
   module Base
@@ -82,15 +81,15 @@ module M9t
           @options
         end
 
-        # Reloads the class's default options
+        # Reloads the class"s default options
         def reset_options!
           @options = self::DEFAULT_OPTIONS.clone
         end
 
         # The name used for i18n translations
-        #  M9t::Distance => 'distance'
+        #  M9t::Distance => "distance"
         def measurement_name
-          name.split('::')[-1].downcase
+          name.split("::")[-1].downcase
         end
 
         def default_unit
@@ -145,20 +144,20 @@ module M9t
       key = i18n_key(options)
       unit = I18n.t(key, count: value_in_units)
 
-      "#{localized_value}%s#{unit}" % (options[:abbreviated] ? '' : ' ')
+      "#{localized_value}%s#{unit}" % (options[:abbreviated] ? "" : " ")
     end
 
     private
 
     def i18n_key(options = {})
-      key = 'units.' + self.class.measurement_name + '.' + options[:units].to_s
-      options[:abbreviated] ? key += '.abbreviated' : key += '.full'
+      key = "units.#{self.class.measurement_name}.#{options[:units]}"
+      key += options[:abbreviated] ? ".abbreviated" : ".full"
       key
     end
 
     def units_error(units)
-      known = self.class::CONVERSIONS.keys.collect(&:to_s).join(', ')
-      fail M9t::UnitError, "Unknown units '#{units}'. Known: #{known}"
+      known = self.class::CONVERSIONS.keys.collect(&:to_s).join(", ")
+      fail M9t::UnitError, %Q(Unknown units "#{units}". Known: #{known})
     end
 
     def extract_to(name)

data/lib/m9t/direction.rb

@@ -1,11 +1,10 @@
-# encoding: utf-8
-require 'm9t/base'
+require "m9t/base"
 
 module M9t
   # Represents a geographical direction
   class Direction
     DEFAULT_OPTIONS = {units: :degrees, abbreviated: false, decimals: 5}
-    CONVERSIONS          = {
+    CONVERSIONS = {
       degrees:  1.0,
       compass:  nil,
     }
@@ -18,20 +17,20 @@ module M9t
 
     class << self
       # Given a value in degrees, returns the nearest (localized) compass direction
-      #  M9t::Directions.to_compass(42) => 'NE'
+      #  M9t::Directions.to_compass(42) => "NE"
       def degrees_to_compass(degrees)
         sector = (normalize(degrees) / COMPASS_SECTOR_DEGREES).round
-        I18n.t(self.measurement_name + '.sectors')[sector]
+        I18n.t(self.measurement_name + ".sectors")[sector]
       end
 
       def compass_to_degrees(compass_direction)
         compass(compass_direction).to_f
       end
 
-      # Accepts a localized compass direction (e.g. 'N') and returns the equivalent M9t::Direction
-      #  M9t::Direction.compass('NE') => #<M9t::Direction:0xb76cc750 @value=45.0, @options={:units=>:degrees, :decimals=>5, :abbreviated=>false}>
+      # Accepts a localized compass direction (e.g. "N") and returns the equivalent M9t::Direction
+      #  M9t::Direction.compass("NE") => #<M9t::Direction:0x000000014a438618 @value=45.0>
       def compass(compass_direction)
-        sector = I18n.t(self.measurement_name + '.sectors').find_index(compass_direction)
+        sector = I18n.t(self.measurement_name + ".sectors").find_index(compass_direction)
         raise "Compass direction '#{compass_direction}' not recognised" if sector.nil?
         new(sector.to_f * COMPASS_SECTOR_DEGREES)
       end
@@ -39,13 +38,11 @@ module M9t
       # Reduce directions in degrees to the range [0, 360)
       #  M9t::Direction.normalize(1000) => 280.0
       def normalize(degrees)
-        case
-        when degrees < 0
-          normalize(degrees + CIRCLE)
-        when degrees >= CIRCLE
-          normalize(degrees - CIRCLE)
+        remainder = degrees.remainder(CIRCLE)
+        if remainder < 0
+          remainder + CIRCLE
         else
-          degrees
+          remainder
         end
       end
     end

data/lib/m9t/distance.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-require 'm9t/base'
+require "m9t/base"
 
 module M9t
   # Represents a distance

data/lib/m9t/errors.rb

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

data/lib/m9t/i18n.rb

@@ -1,8 +1,7 @@
-# encoding: utf-8
-require 'i18n'
+require "i18n"
 
 locales_path = File.expand_path(
-  File.join('..', '..', 'locales'), File.dirname(__FILE__)
+  File.join("..", "..", "locales"), File.dirname(__FILE__)
 )
 I18n.load_path += Dir.glob("#{ locales_path }/*.yml")
 I18n.reload!
@@ -16,19 +15,19 @@ I18n.reload!
 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,5 +1,4 @@
-# encoding: utf-8
-require 'm9t/base'
+require "m9t/base"
 
 module M9t
   # Represents atmospheric (or other) pressure

data/lib/m9t/speed.rb

@@ -1,6 +1,5 @@
-# encoding: utf-8
-require 'm9t/base'
-require 'm9t/distance'
+require "m9t/base"
+require "m9t/distance"
 
 module M9t
   # Represents a speed

data/lib/m9t/temperature.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-require 'm9t/base'
+require "m9t/base"
 
 module M9t
   # Represents a temperature

data/lib/m9t/version.rb

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

data/m9t.gemspec

@@ -1,31 +1,30 @@
-# -*- encoding: utf-8 -*-
-$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
-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 = '>= 1.9.3'
+  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!)
   s.test_files    = `git ls-files spec`.lines.map(&:chomp!)
-  s.require_paths = ['lib']
+  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 'codeclimate-test-reporter', '~> 0.4.8'
-  s.add_development_dependency 'rspec', '>= 3.0.0'
-  s.add_development_dependency 'simplecov' if RUBY_PLATFORM != 'java'
+  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

@@ -1,6 +1,4 @@
-# encoding: utf-8
-require 'spec_helper'
-require 'm9t/base'
+require "m9t/base"
 
 class SomeMeasurement
   DEFAULT_OPTIONS = {
@@ -19,62 +17,62 @@ end
 class SomeDerivedMeasurement < SomeMeasurement; end
 
 describe M9t::Base do
-  describe '.respond_to?' do
-    it 'is true for conversion between known units' 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
+    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
+  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
+    it "fails for unknown units" do
       expect {
         SomeMeasurement.bazs_to_bars(3.0)
       }.to raise_error(NoMethodError)
     end
   end
 
-  describe '#respond_to?' do
+  describe "#respond_to?" do
     subject { SomeMeasurement.new(3.0) }
 
-    it 'is true for conversion to known units' do
+    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
+    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
+    context "for unrecognized calls" do
+      it "calls super" do
         expect(subject.respond_to?(:ciao)).to be_falsey
       end
     end
   end
 
-  describe '#method_missing' do
+  describe "#method_missing" do
     subject { SomeMeasurement.new(3.0) }
 
-    it 'handles conversion to known units' do
+    it "handles conversion to known units" do
       expect(subject.to_bars).to be_a(Float)
     end
 
-    it 'fails for unknown units' do
+    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
+  describe "derived class" do
+    it "inherits options" do
       expect(SomeDerivedMeasurement.options).to eq(SomeMeasurement.options)
     end
   end

data/spec/direction_spec.rb

@@ -1,64 +1,74 @@
-# encoding: utf-8
-require 'spec_helper'
-require 'm9t/direction'
+require "m9t/direction"
 
 describe M9t::Direction do
   before do
     I18n.locale = :en
   end
 
-  describe '.measurement_name' do
+  describe ".measurement_name" do
     it "is 'direction'" do
-      expect(M9t::Direction.measurement_name).to eq('direction')
+      expect(M9t::Direction.measurement_name).to eq("direction")
     end
   end
 
-  describe '.options' do
-    it 'is set' do
+  describe ".options" do
+    it "is set" do
       expect(M9t::Direction.options).not_to be_nil
     end
 
-    context 'abbreviated' do
-      it 'is false' do
+    context "abbreviated" do
+      it "is false" do
         expect(M9t::Direction.options[:abbreviated]).to be_falsey
       end
     end
 
-    context 'units' do
-      it 'is degrees' do
+    context "units" do
+      it "is degrees" do
         expect(M9t::Direction.options[:units]).to eq(:degrees)
       end
     end
   end
 
-  describe '.normalize' do
-    it 'handles values > 360' do
+  describe ".normalize" do
+    it "reduces number greater than 360" do
       expect(M9t::Direction.normalize(725)).to eq(5)
     end
 
-    it 'handles values < 0' do
+    it "reduces 360" do
+      expect(M9t::Direction.normalize(360)).to eq(0)
+    end
+
+    it "increases numbers less than zero" do
       expect(M9t::Direction.normalize(-355)).to eq(5)
     end
+
+    it "handles values with decimals" do
+      expect(M9t::Direction.normalize(360.5)).to eq(0.5)
+    end
+
+    it "handles large values" do
+      M9t::Direction.normalize(1000000000)
+    end
   end
 
-  context 'conversion class methods' do
-    describe '.degrees_to_degrees' do
-      it 'returns the identity' do
+  context "conversion class methods" do
+    describe ".degrees_to_degrees" do
+      it "returns the identity" do
         expect(M9t::Direction.degrees_to_degrees(45)).to eq(45)
       end
     end
 
-    describe '.degrees_to_compass' do
+    describe ".degrees_to_compass" do
       before do
         I18n.locale = :en
       end
 
-      context 'exact' do
+      context "exact" do
         [
-          'N', 'NNE', 'NE', 'ENE',
-          'E', 'ESE', 'SE', 'SSE',
-          'S', 'SSW', 'SW', 'WSW',
-          'W', 'WNW', 'NW', 'NNW'
+          "N", "NNE", "NE", "ENE",
+          "E", "ESE", "SE", "SSE",
+          "S", "SSW", "SW", "WSW",
+          "W", "WNW", "NW", "NNW"
         ].each.with_index do |result, i|
           it "recognizes #{result}" do
             expect(M9t::Direction.degrees_to_compass(i * 22.5)).to eq(result)
@@ -66,121 +76,120 @@ describe M9t::Direction do
         end
       end
 
-      context 'rounding' do
-        specify 'up' do
-          expect(M9t::Direction.degrees_to_compass(42)).to eq('NE')
+      context "rounding" do
+        specify "up" do
+          expect(M9t::Direction.degrees_to_compass(42)).to eq("NE")
         end
 
-        specify 'down' do
-          expect(M9t::Direction.degrees_to_compass(93)).to eq('E')
+        specify "down" do
+          expect(M9t::Direction.degrees_to_compass(93)).to eq("E")
         end
       end
 
-      context 'i18n' do
+      context "i18n" do
         before do
           I18n.locale = :it
         end
 
-        it 'translates' do
-          expect(M9t::Direction.degrees_to_compass(270)).to eq('O')
+        it "translates" do
+          expect(M9t::Direction.degrees_to_compass(270)).to eq("O")
         end
       end
     end
 
-    describe 'compass_to_degrees' do
-      it 'converts correctly' do
-        expect(M9t::Direction.compass_to_degrees('WSW')).to eq(247.5)
+    describe "compass_to_degrees" do
+      it "converts correctly" do
+        expect(M9t::Direction.compass_to_degrees("WSW")).to eq(247.5)
       end
     end
   end
 
-  describe '.new' do
-    context 'strings' do
-      it 'works' do
-        expect(M9t::Direction.new('35').value).to eq(35)
+  describe ".new" do
+    context "strings" do
+      it "works" do
+        expect(M9t::Direction.new("35").value).to eq(35)
       end
 
-      it 'handles leading zeroes' do
-        expect(M9t::Direction.new('010').value).to eq(10)
+      it "handles leading zeroes" do
+        expect(M9t::Direction.new("010").value).to eq(10)
       end
     end
   end
 
-  describe '.compass' do
-    it 'converts cardinals' do
-      expect(M9t::Direction.compass('N').value).to eq(0)
+  describe ".compass" do
+    it "converts cardinals" do
+      expect(M9t::Direction.compass("N").value).to eq(0)
     end
 
-    it 'handles 16ths' do
-      expect(M9t::Direction.compass('WSW').value).to eq(247.5)
+    it "handles 16ths" do
+      expect(M9t::Direction.compass("WSW").value).to eq(247.5)
     end
   end
 
-  describe '#value' do
+  describe "#value" do
     let(:degrees) { M9t::Direction.new(45) }
 
-    it 'returns the supplied value' do
+    it "returns the supplied value" do
       expect(degrees.value).to eq(45)
     end
   end
 
-  describe '#to_s' do
-    context 'not abbreviated' do
-      context 'singular' do
+  describe "#to_s" do
+    context "not abbreviated" do
+      context "singular" do
         subject { M9t::Direction.new(1) }
 
-        it 'returns the full unit name' do
-          expect(subject.to_s).to eq('1 degree')
+        it "returns the full unit name" do
+          expect(subject.to_s).to eq("1 degree")
         end
 
-        it 'translates' do
+        it "translates" do
           I18n.locale = :it
-          expect(subject.to_s).to eq('1 grado')
+          expect(subject.to_s).to eq("1 grado")
         end
       end
 
-      context 'plural' do
+      context "plural" do
         subject { M9t::Direction.new(135) }
 
-        it 'returns the full unit name' do
-          expect(subject.to_s).to eq('135 degrees')
+        it "returns the full unit name" do
+          expect(subject.to_s).to eq("135 degrees")
         end
 
-        it 'translates' do
+        it "translates" do
           I18n.locale = :it
-          expect(subject.to_s).to eq('135 gradi')
+          expect(subject.to_s).to eq("135 gradi")
         end
       end
     end
 
-    context 'abbreviated' do
+    context "abbreviated" do
       subject { M9t::Direction.new(135) }
 
-      it 'uses the symbol' do
-        expect(subject.to_s(abbreviated: true)).to eq('135°')
+      it "uses the symbol" do
+        expect(subject.to_s(abbreviated: true)).to eq("135°")
       end
     end
 
-    context 'compass units' do
+    context "compass units" do
       subject { M9t::Direction.new(225) }
 
-      it 'works' do
-        expect(subject.to_s(units: :compass)).to eq('SW')
+      it "works" do
+        expect(subject.to_s(units: :compass)).to eq("SW")
       end
 
-      it 'translates' do
+      it "translates" do
         I18n.locale = :it
-        expect(subject.to_s(units: :compass)).to eq('SO')
+        expect(subject.to_s(units: :compass)).to eq("SO")
       end
     end
   end
 
-  describe '#to_compass' do
+  describe "#to_compass" do
     subject { M9t::Direction.new(0) }
 
-    it 'is correct' do
-      expect(subject.to_compass).to eq('N')
+    it "is correct" do
+      expect(subject.to_compass).to eq("N")
     end
   end
 end
-