turf-ruby 0.8.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1759c68a13dd02fb326e6bf140b6a04cfc7c41cdb8094d444382438c74c639b
-  data.tar.gz: aead3f8b19b118f5a5be8a5e9d45800e6888a85b0833ddd60289a7bef723cfdb
+  metadata.gz: aace9437eb9fd63a23fb1cae270444dffa0dbf58f371ce88abf1ff7dc483fb5b
+  data.tar.gz: 15ef3f0c1cc5dd1d9ebfaf298512f0a509bb524a432b002cccfe48a4b5d2d011
 SHA512:
-  metadata.gz: 7729eb457352857ab86aa6a8e2f18c0801395ac7adb81623e07f2ea4164f378ee0eade368d0933eb6e66b5264667f3899f40eed8372e799f1084a96a8f65f46c
-  data.tar.gz: f105cc22e100bc24a73e6150b530a42a0b1f33dcc0326598da3fe18baed5e5674b3dc19d8f6c4b5b57a4329f224eed4a65adffffd4bab57b2ecb071c658dbb73
+  metadata.gz: e56d69dd9c440438b5de0734b7c8068e745a111a27c17fa7c6fc5883eed7c42fcdc1765234605f533fb9becfc22d7009c95199111665a147738e38abe0c5c30c
+  data.tar.gz: c5cf79e1af361fb5010c4f997445ddc7d6378422e07252b01f105464863d2253a0d8de89ed889ec872f958a81b0cfccd6c983076d80b92aaf236f75b05c6e6c4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Rafael Santos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,4 +1,7 @@
-# turf-ruby [![Build Status](https://travis-ci.com/formigarafa/turf-ruby.svg?branch=master)](https://travis-ci.com/formigarafa/turf-ruby)
+# turf-ruby
+
+[![Gem Version](https://badge.fury.io/rb/turf-ruby.svg)](https://badge.fury.io/rb/turf-ruby)
+[![Build Status](https://github.com/formigarafa/turf-ruby/actions/workflows/tests.yml/badge.svg)](https://github.com/formigarafa/turf-ruby)
 
 Ruby port of [Turf.js](https://turfjs.org/), an advance geospatial analysis library.
 
@@ -39,196 +42,216 @@ Currently not all functions are available, feel free to fork the repo and port m
 
 This list should be updated from [https://github.com/Turfjs/turf/blob/master/documentation.yml](https://github.com/Turfjs/turf/blob/master/documentation.yml).
 
-Measurement
-
+### Measurement
 - [x] along
 - [x] area
-- [ ] bbox
-- [ ] bboxPolygon
+- [x] bbox
+- [x] bbox_polygon
 - [x] bearing
-- [ ] center
-- [ ] centerOfMass
+- [x] center
+- [ ] center_of_mass
 - [x] centroid
 - [x] destination
 - [x] distance
 - [ ] envelope
+- [ ] great_circle
 - [x] length
 - [ ] midpoint
-- [ ] pointOnFeature
-- [ ] polygonTangents
-- [ ] pointToLineDistance
-- [ ] rhumbBearing
-- [ ] rhumbDestination
-- [ ] rhumbDistance
-- [ ] square
-- [ ] greatCircle
-
-Coordinate Mutation
-
-- [ ] cleanCoords
+- [ ] point_on_feature
+- [ ] point_to_line_distance
+- [ ] point_to_polygon_distance
+- [ ] polygon_tangents
+- [ ] rhumb_bearing
+- [ ] rhumb_destination
+- [ ] rhumb_distance
+- [x] square
+
+### Coordinate Mutation
+- [ ] clean_coords
 - [ ] flip
 - [ ] rewind
-- [ ] round
-- [ ] truncate
+- [x] round
+- [x] truncate
 
-Transformation
-
-- [ ] bboxClip
-- [ ] bezierSpline
+### Transformation
+- [x] bbox_clip
+- [ ] bezier_spline
 - [ ] buffer
-- [ ] circle
+- [x] circle
 - [ ] clone
 - [ ] concave
 - [ ] convex
 - [ ] difference
 - [ ] dissolve
 - [ ] intersect
-- [ ] lineOffset
-- [ ] polygonSmooth
+- [ ] line_offset
+- [ ] polygon_smooth
 - [ ] simplify
 - [ ] tesselate
-- [ ] transformRotate
-- [ ] transformTranslate
-- [ ] transformScale
+- [ ] transform_rotate
+- [ ] transform_scale
+- [ ] transform_translate
 - [ ] union
 - [ ] voronoi
 
-Feature Conversion
-
+### Feature Conversion
 - [ ] combine
-- [ ] explode
+- [x] explode
 - [ ] flatten
-- [ ] lineToPolygon
+- [ ] line_to_polygon
+- [ ] polygon_to_line
 - [ ] polygonize
-- [ ] polygonToLine
-
-Misc
 
+### Misc
 - [ ] kinks
-- [ ] lineArc
-- [ ] lineChunk
-- [ ] lineIntersect
-- [ ] lineOverlap
-- [ ] lineSegment
-- [ ] lineSlice
-- [ ] lineSliceAlong
-- [ ] lineSplit
+- [ ] line_arc
+- [ ] line_chunk
+- [ ] line_intersect
+- [ ] line_overlap
+- [ ] line_segment
+- [ ] line_slice
+- [ ] line_slice_along
+- [ ] line_split
 - [ ] mask
-- [ ] nearestPointOnLine
+- [ ] nearest_point_on_line
 - [ ] sector
-- [ ] shortestPath
-- [ ] unkinkPolygon
-
-Helper
+- [ ] shortest_path
+- [ ] unkink_polygon
 
-- [x] featureCollection
+### Helper
 - [x] feature
-- [x] geometryCollection
-- [x] lineString
-- [x] multiLineString
-- [x] multiPoint
-- [x] multiPolygon
+- [x] feature_collection
+- [x] geometry_collection
+- [x] line_string
+- [x] multi_line_string
+- [x] multi_point
+- [x] multi_polygon
 - [x] point
 - [x] polygon
 
-Random
-
-- [ ] randomPosition
-- [ ] randomPoint
-- [ ] randomLineString
-- [ ] randomPolygon
-
-Data
+### Random
+- [ ] random_line_string
+- [ ] random_point
+- [ ] random_polygon
+- [ ] random_position
 
+### Data
 - [ ] sample
 
-Interpolation
-
+### Interpolation
 - [ ] interpolate
 - [ ] isobands
 - [ ] isolines
 - [ ] planepoint
 - [ ] tin
 
-Joins
-
-- [ ] pointsWithinPolygon
+### Joins
+- [ ] points_within_polygon
 - [ ] tag
 
-Grids
+### Grids
+- [ ] hex_grid
+- [ ] point_grid
+- [ ] square_grid
+- [ ] triangle_grid
 
-- [ ] hexGrid
-- [ ] pointGrid
-- [ ] squareGrid
-- [ ] triangleGrid
+### Classification
+- [ ] nearest_point
 
-Classification
-
-- [ ] nearestPoint
+### Aggregation
+- [ ] clusters_dbscan
+- [ ] clusters_kmeans
+- [ ] collect
 
-Aggregation
+### Meta
+- [ ] cluster_each
+- [ ] cluster_reduce
+- [x] coord_all
+- [x] coord_each
+- [x] coord_reduce
+- [x] feature_each
+- [x] feature_reduce
+- [x] flatten_each
+- [x] flatten_reduce
+- [x] geom_each
+- [x] geom_reduce
+- [ ] get_cluster
+- [x] get_coord
+- [x] get_coords
+- [x] get_geom
+- [x] get_type
+- [x] prop_each
+- [x] prop_reduce
+- [x] segment_each
+- [x] segment_reduce
+
+### Assertions
+- [x] collection_of
+- [x] contains_number
+- [x] feature_of
+- [x] geojson_type
+
+### Booleans
+- [ ] boolean_clockwise
+- [ ] boolean_concave
+- [ ] boolean_contains
+- [ ] boolean_crosses
+- [ ] boolean_disjoint
+- [ ] boolean_equal
+- [ ] boolean_intersects
+- [ ] boolean_overlap
+- [ ] boolean_parallel
+- [x] boolean_point_in_polygon
+- [ ] boolean_point_on_line
+- [ ] boolean_touches
+- [ ] boolean_within
+
+### Unit Conversion
+- [x] azimuth_to_bearing
+- [x] bearing_to_azimuth
+- [x] convert_area
+- [x] convert_length
+- [x] degrees_to_radians
+- [x] length_to_degrees
+- [x] length_to_radians
+- [x] radians_to_degrees
+- [x] radians_to_length
+- [ ] to_mercator
+- [ ] to_wgs84
+
+### Other
+- [ ] angle
+- [ ] boolean_valid
+- [ ] center_mean
+- [ ] center_median
+- [ ] directional_mean
+- [ ] distance_weight
+- [ ] ellipse
+- [x] find_point
+- [x] find_segment
+- [x] geometry
+- [x] is_number
+- [x] is_object
+- [x] line_each
+- [x] line_reduce
+- [x] line_strings
+- [ ] moran_index
+- [ ] nearest_neighbor_analysis
+- [ ] nearest_point_to_line
+- [ ] p_norm_distance
+- [x] points
+- [x] polygons
+- [ ] quadrat_analysis
+- [x] rbush
+- [ ] rectangle_grid
+- [ ] standard_deviational_ellipse
+
+### Constants
+- [ ] K_TABLE
+- [x] AREA_FACTORS
+- [x] EARTH_RADIUS
+- [x] FACTORS
 
-- [ ] collect
-- [ ] clustersDbscan
-- [ ] clustersKmeans
-
-Meta
-
-- [ ] coordAll
-- [x] coordEach
-- [x] coordReduce
-- [x] featureEach
-- [x] featureReduce
-- [x] flattenEach
-- [x] flattenReduce
-- [x] getCoord
-- [ ] getCoords
-- [x] getGeom
-- [ ] getType
-- [x] geomEach
-- [x] geomReduce
-- [ ] propEach
-- [ ] propReduce
-- [ ] segmentEach
-- [ ] segmentReduce
-- [ ] getCluster
-- [ ] clusterEach
-- [ ] clusterReduce
-
-Assertions
-
-- [ ] collectionOf
-- [ ] containsNumber
-- [ ] geojsonType
-- [ ] featureOf
-
-Booleans
-
-- [ ] booleanClockwise
-- [ ] booleanConcave
-- [ ] booleanContains
-- [ ] booleanCrosses
-- [ ] booleanDisjoint
-- [ ] booleanEqual
-- [ ] booleanIntersects
-- [ ] booleanOverlap
-- [ ] booleanParallel
-- [x] booleanPointInPolygon
-- [ ] booleanPointOnLine
-- [ ] booleanWithin
-
-Unit Conversion
-
-- [ ] bearingToAzimuth
-- [ ] convertArea
-- [ ] convertLength
-- [ ] degreesToRadians
-- [x] lengthToRadians
-- [x] lengthToDegrees
-- [x] radiansToLength
-- [x] radiansToDegrees
-- [ ] toMercator
-- [ ] toWgs84
 
 ## Development
 

data/lib/turf/along.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+require_relative "bearing"
+require_relative "destination"
+require_relative "distance"
+require_relative "helpers"
+require_relative "invariant"
+
 # :nodoc:
 module Turf
   # @!group Measurement
@@ -10,7 +16,8 @@ module Turf
   # @param distance [number] distance along the line
   # @param units [string] can be degrees, radians, miles, or kilometers (optional, default "kilometers")
   # @return [Feature<Point>] Point distance units along the line
-  def along(line, distance, units: "kilometers")
+  def along(line, distance, options = {})
+    units = options[:units] || "kilometers"
     line = deep_symbolize_keys line
     travelled = 0
 
@@ -25,10 +32,10 @@ module Turf
         return point(coord) if overshot.zero?
 
         direction = bearing(coord, coords[i - 1]) - 180
-        interpolated = destination(coord, overshot, direction, units: units)
+        interpolated = destination(coord, overshot, direction, { units: units })
         return interpolated
       else
-        travelled += distance(coords[i], coords[i + 1], units: units)
+        travelled += distance(coords[i], coords[i + 1], { units: units })
       end
     end
 

data/lib/turf/angle.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Turf
+  def angle(*args)
+    raise NotImplementedError
+  end
+end

data/lib/turf/area.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require_relative "helpers"
+require_relative "meta"
+
 # :nodoc:
 module Turf
   # Takes one or more features and returns their area in square meters.
@@ -7,7 +10,7 @@ module Turf
   # @param geojson [GeoJSON] input GeoJSON feature(s)
   # @return [number] aria in square meters
   def area(geojson)
-    geom_reduce(geojson, initial_value: 0) do |value, geom|
+    geom_reduce(geojson, 0) do |value, geom|
       value + area_calculate_area(geom)
     end
   end

data/lib/turf/bbox.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Turf
+  # Calculates the bounding box for any GeoJSON object, including FeatureCollection.
+  # Uses geojson[:bbox] if available and options[:recompute] is not set.
+  #
+  # @param [Hash] geojson any GeoJSON object
+  # @param [Hash] options optional parameters
+  # @option options [Boolean] :recompute whether to ignore an existing bbox property on geojson
+  # @return [Array<Float>] bbox extent in [minX, minY, maxX, maxY] order
+  # @example
+  #   line = {
+  #     type: "LineString",
+  #     coordinates: [[-74, 40], [-78, 42], [-82, 35]]
+  #   }
+  #   bbox = bbox(line)
+  #   puts bbox.inspect # => [-82, 35, -74, 42]
+  def bbox(geojson, options = {})
+    # If geojson has a bbox property and options[:recompute] is not true, return the existing bbox
+    return geojson[:bbox] if geojson[:bbox] && options[:recompute] != true
+
+    # Initialize the result array with infinity values
+    result = [Float::INFINITY, Float::INFINITY, -Float::INFINITY, -Float::INFINITY]
+
+    # Iterate through each coordinate in the GeoJSON object using coord_each
+    coord_each(geojson) do |coord|
+      result[0] = coord[0] if result[0] > coord[0] # minX
+      result[1] = coord[1] if result[1] > coord[1] # minY
+      result[2] = coord[0] if result[2] < coord[0] # maxX
+      result[3] = coord[1] if result[3] < coord[1] # maxY
+    end
+
+    result
+  end
+end

data/lib/turf/bbox_clip.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Turf
+  # Takes a Feature and a bbox and clips the feature to the bbox using
+  # [lineclip](https://github.com/mapbox/lineclip).
+  # May result in degenerate edges when clipping Polygons.
+  #
+  # @param [Feature<LineString, MultiLineString, Polygon, MultiPolygon>] feature Feature to clip to the bbox
+  # @param [BBox] bbox Extent in [minX, minY, maxX, maxY] order
+  # @return [Feature<LineString, MultiLineString, Polygon, MultiPolygon>] Clipped Feature
+  # @example
+  #   bbox = [0, 0, 10, 10]
+  #   poly = polygon([[[2, 2], [8, 4], [12, 8], [3, 7], [2, 2]]])
+  #
+  #   clipped = bbox_clip(poly, bbox)
+  #
+  #   # add_to_map
+  #   add_to_map = [bbox, poly, clipped]
+  def bbox_clip(feature, bbox)
+    geom = get_geom(feature)
+    type = geom[:type]
+    properties = feature[:type] == "Feature" ? feature[:properties] : {}
+    coords = geom[:coordinates]
+
+    case type
+    when "LineString", "MultiLineString"
+      lines = []
+      coords = [coords] if type == "LineString"
+
+      coords.each do |line|
+        Lineclip.lineclip(line, bbox, lines)
+      end
+
+      if lines.length == 1
+        return line_string(lines[0], properties)
+      end
+
+      multi_line_string(lines, properties)
+    when "Polygon"
+      polygon(clip_polygon(coords, bbox), properties)
+    when "MultiPolygon"
+      multi_polygon(
+        coords.map { |poly| clip_polygon(poly, bbox) },
+        properties,
+      )
+    else
+      raise Error, "geometry #{type} not supported"
+    end
+  end
+
+  # Clips the rings of a Polygon or MultiPolygon to the bbox.
+  #
+  # @param [Array<Array<Array<Number>>>] rings The coordinates of the polygon rings
+  # @param [BBox] bbox Extent in [minX, minY, maxX, maxY] order
+  # @return [Array<Array<Array<Number>>>] Clipped polygon rings
+  def clip_polygon(rings, bbox)
+    out_rings = []
+
+    rings.each do |ring|
+      clipped = Lineclip.polygonclip(ring, bbox)
+
+      next unless clipped.any?
+
+      if clipped[0][0] != clipped[-1][0] || clipped[0][1] != clipped[-1][1]
+        clipped.push(clipped[0])
+      end
+
+      out_rings.push(clipped) if clipped.length >= 4
+    end
+
+    out_rings
+  end
+end

data/lib/turf/bbox_polygon.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Turf
+  # Takes a bbox and returns an equivalent polygon.
+  #
+  # @param bbox [Array<Numeric>] extent in [minX, minY, maxX, maxY] order
+  # @param options [Hash] Optional parameters
+  # @option options [Hash] :properties Translate properties to Polygon
+  # @option options [String, Numeric] :id Translate Id to Polygon
+  # @return [Feature<Polygon>] a Polygon representation of the bounding box
+  # @example
+  # bbox = [0, 0, 10, 10]
+  # poly = bbox_polygon(bbox)
+  # # addToMap
+  # add_to_map = [poly]
+  def bbox_polygon(bbox, options = {})
+    # Convert BBox positions to Numbers
+    # No performance loss for including to_f
+    # https://github.com/Turfjs/turf/issues/1119
+    west = Float(bbox[0], exception: false) || Float::NAN
+    south = Float(bbox[1], exception: false) || Float::NAN
+    east = Float(bbox[2], exception: false) || Float::NAN
+    north = Float(bbox[3], exception: false) || Float::NAN
+
+    if bbox.length == 6
+      raise Error, "@turf/bbox-polygon does not support BBox with 6 positions"
+    end
+
+    low_left = [west, south]
+    top_left = [west, north]
+    top_right = [east, north]
+    low_right = [east, south]
+
+    polygon(
+      [[low_left, low_right, top_right, top_left, low_left]],
+      options[:properties] || {},
+      { bbox: bbox, id: options[:id] },
+    )
+  end
+end

data/lib/turf/bearing.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require_relative "helpers"
+require_relative "invariant"
+
 # :nodoc:
 module Turf
   # @!group Measurement
@@ -11,8 +14,8 @@ module Turf
   # @param to [Coord] ending Point
   # @param final boolean calculates the final bearing if true
   # @return [number] bearing in decimal degrees, between -180 and 180 degrees (positive clockwise)
-  def bearing(from, to, final: false)
-    return calculate_final_bearing(from, to) if final
+  def bearing(from, to, options = {})
+    return calculate_final_bearing(from, to) if options[:final]
 
     coordinates1 = get_coord from
     coordinates2 = get_coord to

data/lib/turf/bezier_spline.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# :nodoc:
+module Turf
+  def bezier_spline(*args)
+    raise NotImplementedError
+  end
+end

data/lib/turf/boolean_clockwise.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Takes a ring and returns true or false whether or not the ring is clockwise or counter-clockwise.
+#
+# @param [Array<Array<Number>>] line to be evaluated
+# @return [Boolean] true/false
+# @example
+#   clockwise_ring = [[0, 0], [1, 1], [1, 0], [0, 0]]
+#   counter_clockwise_ring = [[0, 0], [1, 0], [1, 1], [0, 0]]
+#
+#   boolean_clockwise(clockwise_ring)
+#   # => true
+#   boolean_clockwise(counter_clockwise_ring)
+#   # => false
+module Turf
+  def boolean_clockwise(line)
+    ring = get_coords(line)
+    sum = 0
+
+    ring.each_cons(2) do |prev, cur|
+      sum += (cur[0] - prev[0]) * (cur[1] + prev[1])
+    end
+
+    sum > 0
+  end
+end