gpsutils 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b08abae07817d01900c8694765fc931aec033cda
-  data.tar.gz: 8d6c8cc1ab1a4a61fff24bfe8ce0d3eea6a78974
+  metadata.gz: 13f60e90df69b5df1eb2e4bc8ae38bbc4a85552d
+  data.tar.gz: 185af0e83814dbbb3dbd72e25d7d6cc8e1afd601
 SHA512:
-  metadata.gz: 97f7ff70700839488150c3d50bd726b9ecfc0a54e7dd2f47f57a6623ea5496dc7b79a970968698013f3738317c21b08b1f3f0103b69588294ee1c58efed90842
-  data.tar.gz: 15b14e3c54fd1622387a3c82095116f82438d7cf7f23064db595ffdaed7a23ebc8bc178e3bf79b8d96d5cf5f00b134eb98192c24920cc5dd0a6ab86b5ffdf199
+  metadata.gz: e603405c2410a019078df94458d2c4844e08ad860486ef82c01693c1799e5ba17f4d2356d178374a25fdea7e8b0e047fbc2e9fffa91b93c093f3dfbd366f1538
+  data.tar.gz: 58463a2addc7e96469fb9a9a056062a3619e2aed678e6ac0ebf8e88c3ff796914544ae07553b0e9ea03664c86eeccf7a452ad44fc228c9783d728b8bd783d916

data/README.md

@@ -21,11 +21,13 @@ You can install the package from rubygems or github using Bundler or create your
 ### Using Bundler with rubygems
 
 Edit you Gemfile and add the following line:
+
 ```ruby
 gem 'gpsutils'
 ```
 
 Then run:
+
 ```bash
 $ bundle install
 ```
@@ -33,11 +35,13 @@ $ bundle install
 ### Using Bundler with github
 
 Edit you Gemfile and add the following line:
+
 ```ruby
 gem 'gpsutils', :git => 'https://github.com/megamoose/gpsutils.git'
 ```
 
 Then run:
+
 ```bash
 $ bundle install
 ```

data/lib/gpsutils/version.rb

@@ -1,3 +1,3 @@
 module GpsUtils
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/gpsutils.rb

@@ -1,8 +1,18 @@
 module GpsUtils
 
 	class Point
-		attr_accessor :lat, :lng
-
+		# @!attribute [r] lat
+		#	@return [Float, Integer] Latitude
+		attr_reader :lat
+
+		# @!attribute [r] lng
+		#	@return [Float, Integer] Longitude
+		attr_reader :lng
+
+		# Initialize Point.
+		#
+		# @param lat [Integer, Float] Latitude
+		# @param lng [Integer, Float] Langitude
 		def initialize(lat, lng)
 			unless lat.is_a? Float or lat.is_a? Integer
 				raise ArgumentError.new 'lat must be float or integer.'
@@ -16,6 +26,8 @@ module GpsUtils
 			@lng = lng
 		end
 
+		# @return [Array] Array with latitude and longitude as Float or Integer
+		#   values, as used when object was initialized
 		def to_a
 			[@lat, @lng]
 		end
@@ -26,9 +38,27 @@ module GpsUtils
 	end
 
 	class BoundingBox
-		attr_accessor :se, :nw
-
+		# @!attribute [r] nw
+		#	@return [Point] North-West corner
+		attr_reader :nw
+
+		# @!attribute [r] nw
+		#	@return [Point] South-East corner
+		attr_reader :se
+
+		# Initialize BoundingBox.
+		#
+		# @param nw_point [Point] North-West corner
+		# @param se_point [Point] South-East corner
 		def initialize(nw_point, se_point)
+			unless nw_point.is_a? Point
+				raise ArgumentError.new 'nw_point must be a Point.'
+			end
+
+			unless se_point.is_a? Point
+				raise ArgumentError.new 'se_point must be a Point.'
+			end
+
 			@nw = nw_point
 			@se = se_point
 
@@ -39,15 +69,16 @@ module GpsUtils
 			@p41ms = @p41 ** 2
 		end
 
+		# Determine whether point is inside bounding box.
+		#
+		# @param point [Point]
 		def cover?(point)
-			return false if @nw.lat == @se.lat and @nw.lng == @se.lng
-
 			p = [point.lat - @nw.lat, point.lng - @se.lng]
 
 			p21x = p[0] * @p21
 			p41x = p[1] * @p41
 
-			0 <= p21x and p21x <= @p21ms and 0 <= p41x and p41x <= @p41ms
+			0 < p21x and p21x < @p21ms and 0 <= p41x and p41x <= @p41ms
 		end
 
 	end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gpsutils
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ronnie Mose
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-03 00:00:00.000000000 Z
+date: 2016-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler