distance 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 729676cbda36e7e5f8405041fb649cd1f426af3c
-  data.tar.gz: e31a927a8636482ef000de1f79def342642efa66
+  metadata.gz: 687cc209435ce9c3846923b3e45bbcf93a98657b
+  data.tar.gz: 420b0b31cb846bf09e18d6cdf5a2d450351ac5de
 SHA512:
-  metadata.gz: d2c490755baf580a8829d6f4bc4a7d2d65a55ef1fa03e98437fe93d4c3f5ac1d138189c49979659fc156324be4cd1a12390ff7467545172101878998b541aa1c
-  data.tar.gz: db278af8f2917b383c70c2c55a89deee2c9e2c0948d8ea7f4229f7e9f2223274f7c40056d0714cb4db9aa038a494adb262ce1174cce101591807beb4875f37b8
+  metadata.gz: 5330a178f261c0f5e1e353297d236b99179552d68e2d567bc54c1a41657b7f88bc7ba470ac32bebec37f3ed37e7ac4e98c6b4722f679b60b676a1e0741b6877b
+  data.tar.gz: 4429e65174098ffd8e237cdb9b27d8a9bdf53baab47ac1ea94f0e0686cc9da3e157d420a00625e6108152d13d9d035c62885f249d8f6134b128cd69eea33165f

data/.gitignore

@@ -10,3 +10,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+distance-*.gem

data/README.md

@@ -20,7 +20,55 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+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)
+```
+
+If you are working with different units, you can construct a new instance with the
+following convenience class methods
+
+```ruby
+ten_miles = Distance.miles(10)
+five_km = Distance.kilometers(5)
+```
+
+Once you have a `Distance` instance, you can convert it to another base unit like
+
+```ruby
+ten_miles.to_kilometers
+# => 16.09344
+five_km.to_miles
+# => 3.11
+```
+
+### 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 equality
+
+You can also compare distances
+
+```ruby
+Distance.new(10) > Distance.new(9)
+# => true
+Distance.miles(10) <= Distance.kilometers(10)
+# => false
+```
 
 ## Development
 

data/lib/distance/fixnum_extensions.rb

@@ -0,0 +1 @@
+require_relative '../core_ext/numeric'

data/lib/distance/version.rb

@@ -1,3 +1,3 @@
 class Distance
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/distance.rb

@@ -23,10 +23,6 @@ class Distance
     new(n * Multiplier::MILE)
   end
 
-  def in_kilometers?
-    distance_in_meters % Multiplier::KILOMETER == 0
-  end
-
   def to_f
     distance_in_meters
   end
@@ -39,9 +35,57 @@ class Distance
     distance_in_meters / Multiplier::KILOMETER
   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)
+  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)
+  end
+
+  def *(multiplier)
+    unless multiplier.is_a?(Numeric)
+      raise ArgumentError, 'Can only multiply a Distance with a number'
+    end
+    Distance.new(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)
+  end
+
+  def >(other)
+    return false unless other.is_a?(Distance)
+    to_f > other.to_f
+  end
+
+  def >=(other)
+    return false unless other.is_a?(Distance)
+    to_f >= other.to_f
+  end
+
   def ==(other)
     return false unless other.is_a?(Distance)
-    (to_f - other.to_f).abs < 0.01
+    to_f == other.to_f
+  end
+
+  def <(other)
+    return false unless other.is_a?(Distance)
+    to_f < other.to_f
+  end
+
+  def <=(other)
+    return false unless other.is_a?(Distance)
+    to_f <= other.to_f
   end
 
   private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: distance
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tom Collier
@@ -85,6 +85,7 @@ files:
 - bin/setup
 - distance.gemspec
 - lib/distance.rb
+- lib/distance/fixnum_extensions.rb
 - lib/distance/version.rb
 homepage: https://github.com/tcollier/distance
 licenses: