gps_tools 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f34883d049d7636e5425c8e21baa8b2d3db4329cbc5e0e19e5a68fdae380b2ee
-  data.tar.gz: e1bfa8b3b062c361c6137231262003e368d4b33a5855a7faa48217bcc5d6bb86
+  metadata.gz: ab1aed7260c6af3b0c702d324ac9f5f2b1def10dca3c0b1f9e8365e575360a8b
+  data.tar.gz: 3b0fd3d99b8a363afddcf289f6b2b1bd8f3a8396271c176060c37d043400f879
 SHA512:
-  metadata.gz: db5312a54634fd9acea85c51f20789f463dcf952dc4e22d4cc4a249699866d84107abad20cb359b0d770aed11bf4841105faaf8cf39c757aabbc9293287ba201
-  data.tar.gz: f8d2e305358eeffd2acd3e1530ac2c9a0bde6f0a07d2dac3309bcdc24b1e00bd0c672708352d243c1374a576e7092291b205899cd54aa4f5ea5d59c38df9b4b6
+  metadata.gz: 11813f0d7162599d79b9a304a26844560f5becd4959ad4ffc4ff5f443102636f7ade3eaa0cac716220858707582e44a6ec0d3ea60ac53edaaf0fe728d82d089b
+  data.tar.gz: ec6395e448fd121fa1ada673c678a814663feacc2f215c140f950fb7df37f53b67310698913064e7945c90a1eab2366750c66ae8c50df19b3f6ccd7e0ee88f77

data/lib/gps_tools.rb

@@ -1,13 +1,11 @@
-require 'gps_tools/distance'
-require 'gps_tools/geometry'
-
 class GPSTools
     ##
     # Returns the distance in miles (unit = "mile"), kilometers (unit = "km"), or nautical miles (unit = "nm")
     # between two gps coordinates, coord1 and coord2
     def self.distance(coord1, coord2, unit = "mile")
         distance_tool = Distance.new(unit)
-        return distance_tool.get_distance(coord1[0], coord1[1], coord2[0], coord2[1])
+        distance = distance_tool.get_distance(coord1[0], coord1[1], coord2[0], coord2[1])
+        return distance
     end
 
     ##
@@ -17,4 +15,29 @@ class GPSTools
         geometry = Geometry.new()
         return geometry.in_polygon?(polygon, coord)
     end
-end
+
+    ##
+    # Returns a new array containing all coordinates within the given polygon
+    def self.filter_by_polygon(polygon, coords)
+        geometry = Geometry.new()
+        return geometry.filter_by_polygon(polygon, coords)
+    end
+
+    ##
+    # Returns a boolean that identifies if a given gps coordinate, coord, is within
+    # a given radius of a center point, center
+    def self.in_radius?(radius, center, coord)
+        geometry = Geometry.new()
+        return geometry.in_radius?(radius, center, coord)
+    end
+
+    ##
+    # Returns a new array containing all coordinates within the given radius
+    def self.filter_by_radius(radius, center, coords)
+        geometry = Geometery.new()
+        return geometry.filter_by_radius(radius, center, coords)
+    end
+end
+
+require 'gps_tools/distance'
+require 'gps_tools/geometry'

data/lib/gps_tools/distance.rb

@@ -1,4 +1,4 @@
-class Distance
+class GPSTools::Distance
     def initialize(unit = "mile")
         @unit = unit
         case @unit
@@ -11,6 +11,9 @@ class Distance
         end
     end
 
+    ##
+    # Returns the distance in miles (unit = "mile"), kilometers (unit = "km"), or nautical miles (unit = "nm")
+    # between two gps coordinates, coord1 and coord2
     def get_distance(coord1, coord2)
         lat1 = coord1[0]
         long1 = coord1[1]
@@ -23,7 +26,8 @@ class Distance
         a = Math.sin(degrees_to_radians(lat_diff)/2) * Math.sin(degrees_to_radians(lat_diff)/2) + Math.sin(degrees_to_radians(long_diff)/2) * Math.sin(degrees_to_radians(long_diff)/2) * Math.cos(degrees_to_radians(lat1)) * Math.cos(degrees_to_radians(lat2))
         c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1-a))
         
-        return @earth_radius * c
+        distance = @earth_radius * c
+        return distance
     end
 
     private 

data/lib/gps_tools/geometry.rb

@@ -1,9 +1,7 @@
-class Geometry
-    def in_radius?(radius, center, coord)
-        distance = Distance.new.get_distance(center, coord)
-        distance <= radius
-    end
-
+class GPSTools::Geometry
+    ##
+    # Returns a boolean that identifies if a given gps coordinate, coord, is within
+    # a given polygon (array of [lat, lng])
     def in_polygon?(polygon, coord)
         n = polygon.length
 
@@ -41,6 +39,26 @@ class Geometry
         intersections % 2 == 1
     end
 
+    ##
+    # Returns a new array containing all coordinates within the given polygon
+    def filter_by_polygon(polygon, coords)
+        coords.select { |coord| in_polygon?(polygon, coord) }
+    end
+
+    ##
+    # Returns a boolean that identifies if a given gps coordinate, coord, is within
+    # a given radius of a center point, center
+    def in_radius?(radius, center, coord)
+        distance = GPSTools::Distance.new.get_distance(center, coord)
+        distance <= radius
+    end
+
+    ##
+    # Returns a new array containing all coordinates within the given radius
+    def filter_by_radius(radius, center, coords)
+        coords.select{ |coord| in_radius?(radius, center, coord) }
+    end
+
     private
         def max(a, b)
             a > b ? a : b

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gps_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dave Van Fleet
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-04 00:00:00.000000000 Z
+date: 2021-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -39,14 +39,7 @@ licenses:
 - MIT
 metadata: {}
 post_install_message:
-rdoc_options:
-- "-m"
-- README.rdoc
-- "-x"
-- lib/(?!gps_tools.rb).*
-- lib/gps_tools.rb
-- LICENSE
-- README.rdoc
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement