distance 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0458b08c5bfa15588f29a9d14de9514610241e03
-  data.tar.gz: cf0704ea44beea40f4f21550f210815b44a22d0d
+  metadata.gz: 8b121430d288441c455ca6d8dc8b56f02892243a
+  data.tar.gz: 92a6e9bd2dd1c761ed4bdc5b3217195b04fc4119
 SHA512:
-  metadata.gz: cb694566926dbc4f0983c51af4af03cafcf94a64847fb17f307376dc928fff0c6d765b26024fda5da8cd0541f51d25e0745ca87a4ca1296a3536a9462960ec2d
-  data.tar.gz: 4ff910bf125cfca7643cacbc5e98dedb09ee797588a5b6be71b048212ca7a9601a808de75e23dbbfddcd49d8f4e63434396f9d295b1009bf3e746930b3f3e97a
+  metadata.gz: 13215885766b11f63db7a002b415c85000791db617006498de4d343262effe524d2d9b54b96289438c65e70fa59a696ab3d192acf038f9f895e829f5c8813867
+  data.tar.gz: 36a23b5ffefa619a8a04af53e015098e5995735466bb2835c483028268dec9804e8154e12e5fd540e5f83d9d46b5a2b8ea9750707ab8487a9c9e74f1ffa7887d

data/.travis.yml

@@ -1,7 +1,7 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.7
+  - 2.2.7
   - 2.3.4
   - 2.4.1
 before_install: gem install bundler -v 1.14.6

data/README.md

@@ -26,7 +26,7 @@ There are multiple options for constructing a new `Distance` instance. The basic
 constructor expects an `Float` argument that is the distannce is meters, e.g.
 
 ```ruby
-eight_hundred_meters = Distance.new(800)
+eight_hundred_meters = Distance.meters(800)
 ```
 
 If you are working with different units, you can construct a new instance with the
@@ -46,19 +46,31 @@ five_km.to_miles
 # => 3.11
 ```
 
+### Supported units
+
+* inches
+* feet
+* meters
+* kilometers
+* miles
+
+Additionally, the following constants are available
+
+* `Distance::MARATHON`
+
 ### Distance math
 
 You can perform basic math with distances
 
 ```ruby
-Distance.new(1) + Distance.new(2)
-# => Distance.new(3)
-Distance.new(3) - Distance.new(1)
-# => Distance.new(2)
-Distance.new(3) * 2
-# => Distance.new(6)
-Distance.new(6) / 2
-# => Distance.new(3)
+Distance.meters(1) + Distance.meters(2)
+# => Distance.meters(3)
+Distance.meters(3) - Distance.meters(1)
+# => Distance.meters(2)
+Distance.meters(3) * 2
+# => Distance.meters(6)
+Distance.meters(6) / 2
+# => Distance.meters(3)
 ```
 
 ### Distance equality
@@ -66,7 +78,7 @@ Distance.new(6) / 2
 You can also compare distances
 
 ```ruby
-Distance.new(10) > Distance.new(9)
+Distance.meters(10) > Distance.meters(9)
 # => true
 Distance.miles(10) <= Distance.kilometers(10)
 # => false
@@ -87,8 +99,8 @@ This adds the following convenience methods to `Float` and `Integer`
 # => Distance.miles(26.2)
 1.kilometer
 # => Distance.kilometers(1)
-5 * Distance.new(1000)
-# => Distance.new(5000)
+5 * Distance.meters(100)
+# => Distance.meters(500)
 ```
 
 ## Development

data/lib/distance.rb

@@ -4,6 +4,8 @@ class Distance
   # Multipliers from standard race units to meters
   module Multiplier
     KILOMETER = 1000.0
+    INCH      = 0.0254
+    FOOT      = 0.3048
     MILE      = 1609.344
   end
   private_constant :Multiplier
@@ -12,13 +14,26 @@ class Distance
     @distance_in_meters = distance_in_meters.to_f
   end
 
-  MARATHON      = new(42195.0)
-  HALF_MARATHON = new(21097.5)
+  private_class_method :new
+
+  MARATHON = new(42195.0)
+
+  def self.meters(n)
+    new(n)
+  end
 
   def self.kilometers(n)
     new(n * Multiplier::KILOMETER)
   end
 
+  def self.inches(n)
+    new(n * Multiplier::INCH)
+  end
+
+  def self.feet(n)
+    new(n * Multiplier::FOOT)
+  end
+
   def self.miles(n)
     new(n * Multiplier::MILE)
   end
@@ -27,40 +42,48 @@ class Distance
     distance_in_meters
   end
 
-  def to_miles
-    (distance_in_meters / Multiplier::MILE).round(2)
-  end
-
   def to_kilometers
     distance_in_meters / Multiplier::KILOMETER
   end
 
+  def to_inches
+    (distance_in_meters / Multiplier::INCH)
+  end
+
+  def to_feet
+    (distance_in_meters / Multiplier::FOOT)
+  end
+
+  def to_miles
+    (distance_in_meters / Multiplier::MILE)
+  end
+
   def +(other)
     unless other.is_a?(Distance)
       raise ArgumentError, 'Can only add a Distance to a Distance'
     end
-    Distance.new(to_f + other.to_f)
+    Distance.meters(to_f + other.to_f)
   end
 
   def -(other)
     unless other.is_a?(Distance)
       raise ArgumentError, 'Can only subtract a Distance from a Distance'
     end
-    Distance.new(to_f - other.to_f)
+    Distance.meters(to_f - other.to_f)
   end
 
   def *(multiplier)
     unless multiplier.is_a?(Numeric)
       raise ArgumentError, 'Can only multiply a Distance with a number'
     end
-    Distance.new(to_f * multiplier)
+    Distance.meters(to_f * multiplier)
   end
 
   def /(divisor)
     unless divisor.is_a?(Numeric)
       raise ArgumentError, 'Can only divide a Distance by a number'
     end
-    Distance.new(to_f / divisor)
+    Distance.meters(to_f / divisor)
   end
 
   def >(other)

data/lib/distance/core_ext/numeric.rb

@@ -1,10 +1,28 @@
 class Numeric
+  def meters
+    Distance.meters(self)
+  end
+
+  alias_method :meter, :meters
+
   def kilometers
     Distance.kilometers(self)
   end
 
   alias_method :kilometer, :kilometers
 
+  def inches
+    Distance.inches(self)
+  end
+
+  alias_method :inch, :inches
+
+  def feet
+    Distance.feet(self)
+  end
+
+  alias_method :foot, :feet
+
   def miles
     Distance.miles(self)
   end

data/lib/distance/version.rb

@@ -1,3 +1,3 @@
 class Distance
-  VERSION = '0.3.1'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: distance
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Tom Collier