turf-ruby 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 989a5a140f46d9b673a83f71d3df89e6e6b2f9eaa23266a49db3ebeace62ce15
-  data.tar.gz: 921c501f57d3446e76a505a0f6be9d9549a4f7cd09a57699b192ab2ae8ff7eff
+  metadata.gz: 4a1a13828f696140452584b283d12c6d8c9f365d97cbc0995ccbd275756a84e8
+  data.tar.gz: 8c9b413efdd827194c98535eb64dfe61bb5057c5aa0c61bc1e3899cf9b79a24c
 SHA512:
-  metadata.gz: 41d5d74fffef50e570dd4171a5b3518a8b7a07b5ff697da60ef0fddd718919aee2affd646647f99176e5b13f1ee5264249845bf403930831cfe4849da4431127
-  data.tar.gz: e50d3fdba23ffcb7d73e345bfde22c7fdb3793a0a2b9c923afe52f6bfe8b0893da6a617bbd3d258f7b2229fdca59c1a33a622b9a67dd11e831ec34db0b29666c
+  metadata.gz: b8ba31f189e103c965d96cf6e424e0e229221e3bf0391a0d45156f841b64d43cdbc690be5fe58555c41bd4d800313d177467b3f00b3fc599f87925f4261d3864
+  data.tar.gz: e56c866eef2ff30d099e459a4d0d095931de7ce1c72f5d5a91f569600fbb694c3ef410d6ab050ea614dc565a014d36643ab53b9910eeada430c9fc3bbb5da220

data/lib/turf.rb

@@ -13,11 +13,18 @@ module Turf
   private
 
   # A non-intrusive implemenation of Rails' Hash#deep_symbolize_keys
-  def deep_symbolize_keys(hash)
-    return hash unless hash.is_a? Hash
-
-    hash.transform_keys(&:to_sym).transform_values do |value|
-      deep_symbolize_keys(value)
+  def deep_symbolize_keys(input)
+    case input
+    when Hash
+      input.transform_keys(&:to_sym).transform_values do |value|
+        deep_symbolize_keys(value)
+      end
+    when Array
+      input.map do |value|
+        deep_symbolize_keys value
+      end
+    else
+      input
     end
   end
 end

data/lib/turf/along.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+#:nodoc:
 module Turf
   # @!group Measurement
 

data/lib/turf/bearing.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+#:nodoc:
 module Turf
   # @!group Measurement
 

data/lib/turf/boolean_point_in_polygon.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+#:nodoc:
 module Turf
   # @!group Booleans
 

data/lib/turf/centroid.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+#:nodoc:
+module Turf
+  # @!group Measurement
+
+  # Takes one or more features and calculates the centroid using the mean of all vertices. This lessens the effect of
+  # small islands and artifacts when calculating the centroid of a set of polygons.
+  # @see http://turfjs.org/docs/#centroid
+  # @param geojson [GeoJSON] GeoJSON to be centered
+  # @param properties [Hash] a [Hash] that is used as the Feature's properties
+  # @return [Feature<Point>] the centroid of the input features
+  def centroid(geojson, properties: {})
+    x_sum = 0
+    y_sum = 0
+    len = 0
+
+    coord_each geojson, exclude_wrap_coord: true do |coord|
+      x_sum += coord[0]
+      y_sum += coord[1]
+      len += 1
+    end
+
+    point(
+      [x_sum / len, y_sum / len],
+      properties: properties,
+    )
+  end
+end

data/lib/turf/destination.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+#:nodoc:
 module Turf
   # @!group Measurement
 
@@ -28,7 +29,6 @@ module Turf
     lng = radians_to_degrees(longitude2)
     lat = radians_to_degrees(latitude2)
 
-    # prevent ruby@2 converting `properties` as kwargs
-    point([lng, lat], properties, **{})
+    point([lng, lat], properties: properties)
   end
 end

data/lib/turf/distance.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+#:nodoc:
 module Turf
   # @!group Measurement
 

data/lib/turf/helpers.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+#:nodoc:
 module Turf
   EARTH_RADIUS = 6_371_008.8
   private_constant :EARTH_RADIUS
@@ -31,11 +32,11 @@ module Turf
   # @param bbox [Array<number>] Bounding Box Array [west, south, east, north] associated with the Feature
   # @param id [string | number] Identifier associated with the Feature
   # @return [Feature] a GeoJSON Feature
-  def feature(geom, properties = {}, bbox: nil, id: nil)
+  def feature(geom, properties: {}, bbox: nil, id: nil)
     feat = {
       type: "Feature",
-      geometry: geom,
-      properties: properties
+      properties: properties,
+      geometry: geom
     }
     feat[:id] = options[:id] if id
     feat[:bbox] = options[:bbox] if bbox
@@ -65,7 +66,7 @@ module Turf
   # @param bbox [Array<number>] Bounding Box Array [west, south, east, north] associated with the Feature
   # @param id [string | number] Identifier associated with the Feature
   # @return [Feature<LineString>] LineString Feature
-  def line_string(coordinates, properties = {}, bbox: nil, id: nil)
+  def line_string(coordinates, properties: {}, bbox: nil, id: nil)
     if coordinates.size < 2
       raise Error, "coordinates must be an array of two or more positions"
     end
@@ -74,7 +75,7 @@ module Turf
       type: "LineString",
       coordinates: coordinates
     }
-    feature(geom, properties, bbox: bbox, id: id)
+    feature(geom, properties: properties, bbox: bbox, id: id)
   end
 
   # Creates a Point Feature from a Position.
@@ -84,12 +85,12 @@ module Turf
   # @param bbox [Array<number>] Bounding Box Array [west, south, east, north] associated with the Feature
   # @param id [string | number] Identifier associated with the Feature
   # @return [Feature<Point>] a Point feature
-  def point(coordinates, properties = {}, id: nil, bbox: nil)
+  def point(coordinates, properties: {}, id: nil, bbox: nil)
     geom = {
       type: "Point",
       coordinates: coordinates
     }
-    feature(geom, properties, id: id, bbox: bbox)
+    feature(geom, properties: properties, id: id, bbox: bbox)
   end
 
   # Creates a Polygon Feature from an Array of LinearRings.
@@ -99,7 +100,7 @@ module Turf
   # @param bbox [Array<number>] Bounding Box Array [west, south, east, north] associated with the Feature
   # @param id [string | number] Identifier associated with the Feature
   # @return [Feature<Polygon>] Polygon feature
-  def polygon(coordinates, properties = {}, bbox: nil, id: nil)
+  def polygon(coordinates, properties: {}, bbox: nil, id: nil)
     coordinates.each do |ring|
       if ring.size < 4
         raise(
@@ -118,7 +119,37 @@ module Turf
       type: "Polygon",
       coordinates: coordinates
     }
-    feature(geom, properties, id: id, bbox: bbox)
+    feature(geom, properties: properties, id: id, bbox: bbox)
+  end
+
+  # Creates a Feature<MultiPolygon> based on a coordinate array. Properties can be added optionally.
+  # @see https://turfjs.org/docs/#multiPolygon
+  # @param coordinates [Array<Array<Array<Array<number>>>>] an array of Polygons
+  # @param properties [Hash] an Hash of key-value pairs to add as properties
+  # @param bbox [Array<number>] Bounding Box Array [west, south, east, north] associated with the Feature
+  # @param id [string|number] Identifier associated with the Feature
+  # @return [Feature<MultiPolygon>] a multipolygon feature
+  def multi_polygon(coordinates, properties: {}, bbox: nil, id: nil)
+    geom = {
+      type: "MultiPolygon",
+      coordinates: coordinates
+    }
+    feature(geom, properties: properties, id: id, bbox: bbox)
+  end
+
+  # Creates a Feature<MultiLineString> based on a coordinate array. Properties can be added optionally.
+  # @see https://turfjs.org/docs/#multiLineString
+  # @param coordinates [Array<Array<Array<number>>>] coordinates an array of LineStrings
+  # @param properties [Hash] a Hash of key-value pairs to add as properties
+  # @param bbox [Array<number>] Bounding Box Array [west, south, east, north] associated with the Feature
+  # @param id [string|number] Identifier associated with the Feature
+  # @return [Feature<MultiLineString>] a MultiLineString feature
+  def multi_line_string(coordinates, properties: {}, bbox: nil, id: nil)
+    geom = {
+      type: "MultiLineString",
+      coordinates: coordinates
+    }
+    feature(geom, properties: properties, id: id, bbox: bbox)
   end
 
   # @!group Unit Conversion

data/lib/turf/invariant.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+#:nodoc:
 module Turf
   # @!group Meta
 

data/lib/turf/meta.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+#:nodoc:
+module Turf
+  # @!group Meta
+
+  # Iterate over coordinates in any GeoJSON object, similar to Array.forEach()
+  # @see https://turfjs.org/docs/#coordEach
+  # @param geojson [FeatureCollection|Feature|Geometry] any GeoJSON object
+  # @param exclude_wrap_coord [boolean] whether or not to include the final coordinate of LinearRings that wraps the
+  # ring in its iteration
+  # @yield [current_coord, coord_index] given any coordinate
+  # @yieldparam current_coord [Array<number>] The current coordinate being processed.
+  # @yieldparam coord_index [number] The current index of the coordinate being processed.
+  def coord_each(geojson, exclude_wrap_coord: false, &block)
+    return unless geojson
+
+    geojson = deep_symbolize_keys geojson
+    geometries = []
+    case geojson[:type]
+    when "FeatureCollection"
+      geojson[:features].each do |feature|
+        geometries.push feature[:geometry]
+      end
+    when "Feature"
+      geometries.push geojson[:geometry]
+    else
+      geometries.push geojson
+    end
+
+    # flatten GeometryCollection
+    geometries =
+      geometries.map do |geometry|
+        next if geometry.nil?
+        next geometry unless geometry[:type] == "GeometryCollection"
+
+        geometry[:geometries]
+      end.flatten
+
+    coords =
+      geometries.flat_map do |geometry|
+        next nil if geometry.nil?
+
+        case geometry[:type]
+        when "Point"
+          [geometry[:coordinates]]
+        when "LineString", "MultiPoint"
+          geometry[:coordinates]
+        when "Polygon", "MultiLineString"
+          geometry[:coordinates].flat_map do |line_coords|
+            (
+              exclude_wrap_coord ? line_coords.slice(0...-1) : line_coords
+            )
+          end
+        when "MultiPolygon"
+          geometry[:coordinates].flat_map do |polygon_coords|
+            polygon_coords.flat_map do |line_coords|
+              (
+                exclude_wrap_coord ? line_coords.slice(0...-1) : line_coords
+              )
+            end
+          end
+        when "Feature"
+          [].tap do |feature_coords|
+            coord_each geometry, exclude_wrap_coord: exclude_wrap_coord do |coord|
+              feature_coords.push coord
+            end
+          end
+        else
+          raise Error, "Unknown Geometry Type: #{geometry[:type]}"
+        end
+      end.compact
+
+    coords.each_with_index(&block)
+  end
+
+  # Iterate over features in any GeoJSON object, similar to Array.forEach.
+  # @see https://turfjs.org/docs/#featureEach
+  # @param geojson [FeatureCollection|Feature|Geometry] any GeoJSON object
+  # @yield [feature] given any coordinate
+  # @yieldparam feature [Feature<any>] currentFeature The current Feature being processed.
+  # @yieldparam feature_index [number] The current index of the Feature being processed.
+  def feature_each(geojson, &block)
+    return unless geojson
+
+    geojson = deep_symbolize_keys geojson
+    case geojson[:type]
+    when "Feature"
+      yield geojson, 0
+    when "FeatureCollection"
+      geojson[:features].each_with_index(&block)
+    end
+  end
+end

data/lib/turf/version.rb

@@ -2,5 +2,5 @@
 
 module Turf
   # Version of turf-ruby
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/turf_ruby.rb

@@ -11,5 +11,7 @@ require "turf/along"
 require "turf/distance"
 require "turf/invariant"
 require "turf/boolean_point_in_polygon"
+require "turf/centroid"
+require "turf/meta"
 
 require "turf"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turf-ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Rafael Santos
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-14 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies: []
 description: Turf Ruby is a Ruby library for spatial analysis. It includes traditional
   spatial operations, helper functions for creating GeoJSON data, and data classification
@@ -23,10 +23,12 @@ files:
 - lib/turf/along.rb
 - lib/turf/bearing.rb
 - lib/turf/boolean_point_in_polygon.rb
+- lib/turf/centroid.rb
 - lib/turf/destination.rb
 - lib/turf/distance.rb
 - lib/turf/helpers.rb
 - lib/turf/invariant.rb
+- lib/turf/meta.rb
 - lib/turf/version.rb
 - lib/turf_ruby.rb
 homepage: http://github.com/formigarafa/turf-ruby
@@ -44,7 +46,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="