turf-ruby 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15efb6b14189380f9e59456b544fc7cb95436eeceefbf4772f4f6ee1ea2d8a4e
-  data.tar.gz: 16d8e44ef4eea15d03ed3059375d3df6c6c793f8c178878b6e1ebcbdb4f6d509
+  metadata.gz: a1759c68a13dd02fb326e6bf140b6a04cfc7c41cdb8094d444382438c74c639b
+  data.tar.gz: aead3f8b19b118f5a5be8a5e9d45800e6888a85b0833ddd60289a7bef723cfdb
 SHA512:
-  metadata.gz: 4362da521aff1c2514668c011fd86348c2df8d6cb27510b17459303e046a3550552810bcc5ff42593ff758d4998d84de897bedf1ca851a71da0e44baec0e589f
-  data.tar.gz: ad865f140fab4344bdb0e05bdc31e4e505a8479d2e86e1cdf4dc986130f4033d540dbe4db6bfb2cf6c07bdbfadbb53ef6aeef784d656f75c205263b5fee0e9ac
+  metadata.gz: 7729eb457352857ab86aa6a8e2f18c0801395ac7adb81623e07f2ea4164f378ee0eade368d0933eb6e66b5264667f3899f40eed8372e799f1084a96a8f65f46c
+  data.tar.gz: f105cc22e100bc24a73e6150b530a42a0b1f33dcc0326598da3fe18baed5e5674b3dc19d8f6c4b5b57a4329f224eed4a65adffffd4bab57b2ecb071c658dbb73

data/README.md

@@ -0,0 +1,257 @@
+# turf-ruby [![Build Status](https://travis-ci.com/formigarafa/turf-ruby.svg?branch=master)](https://travis-ci.com/formigarafa/turf-ruby)
+
+Ruby port of [Turf.js](https://turfjs.org/), an advance geospatial analysis library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'turf-ruby'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install turf-ruby
+
+## Usage
+
+Example:
+
+```
+# Turf.js uses [GeoJSON](https://en.wikipedia.org/wiki/GeoJSON) is input and output, so does turf-ruby.
+from = { type: "Feature", geometry: { type: "Point", coordinates: [-75.343, 39.984] } }
+to = { type: "Feature", geometry: { type: "Point", coordinates: [-75.534, 39.123] } }
+
+Turf::distance(from, to, units: 'miles')
+# 60.35329997171344
+```
+
+You can view all methods here: [https://formigarafa.github.io/turf-ruby/](https://formigarafa.github.io/turf-ruby/). Most methods have their documentation linked to Turf.js.
+
+## Progress
+
+Currently not all functions are available, feel free to fork the repo and port missing functions you need by reading [source code of Turf.js](https://github.com/Turfjs/turf/tree/master/packages/). And don't forget to open a pull-request afterward.
+
+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
+
+- [x] along
+- [x] area
+- [ ] bbox
+- [ ] bboxPolygon
+- [x] bearing
+- [ ] center
+- [ ] centerOfMass
+- [x] centroid
+- [x] destination
+- [x] distance
+- [ ] envelope
+- [x] length
+- [ ] midpoint
+- [ ] pointOnFeature
+- [ ] polygonTangents
+- [ ] pointToLineDistance
+- [ ] rhumbBearing
+- [ ] rhumbDestination
+- [ ] rhumbDistance
+- [ ] square
+- [ ] greatCircle
+
+Coordinate Mutation
+
+- [ ] cleanCoords
+- [ ] flip
+- [ ] rewind
+- [ ] round
+- [ ] truncate
+
+Transformation
+
+- [ ] bboxClip
+- [ ] bezierSpline
+- [ ] buffer
+- [ ] circle
+- [ ] clone
+- [ ] concave
+- [ ] convex
+- [ ] difference
+- [ ] dissolve
+- [ ] intersect
+- [ ] lineOffset
+- [ ] polygonSmooth
+- [ ] simplify
+- [ ] tesselate
+- [ ] transformRotate
+- [ ] transformTranslate
+- [ ] transformScale
+- [ ] union
+- [ ] voronoi
+
+Feature Conversion
+
+- [ ] combine
+- [ ] explode
+- [ ] flatten
+- [ ] lineToPolygon
+- [ ] polygonize
+- [ ] polygonToLine
+
+Misc
+
+- [ ] kinks
+- [ ] lineArc
+- [ ] lineChunk
+- [ ] lineIntersect
+- [ ] lineOverlap
+- [ ] lineSegment
+- [ ] lineSlice
+- [ ] lineSliceAlong
+- [ ] lineSplit
+- [ ] mask
+- [ ] nearestPointOnLine
+- [ ] sector
+- [ ] shortestPath
+- [ ] unkinkPolygon
+
+Helper
+
+- [x] featureCollection
+- [x] feature
+- [x] geometryCollection
+- [x] lineString
+- [x] multiLineString
+- [x] multiPoint
+- [x] multiPolygon
+- [x] point
+- [x] polygon
+
+Random
+
+- [ ] randomPosition
+- [ ] randomPoint
+- [ ] randomLineString
+- [ ] randomPolygon
+
+Data
+
+- [ ] sample
+
+Interpolation
+
+- [ ] interpolate
+- [ ] isobands
+- [ ] isolines
+- [ ] planepoint
+- [ ] tin
+
+Joins
+
+- [ ] pointsWithinPolygon
+- [ ] tag
+
+Grids
+
+- [ ] hexGrid
+- [ ] pointGrid
+- [ ] squareGrid
+- [ ] triangleGrid
+
+Classification
+
+- [ ] nearestPoint
+
+Aggregation
+
+- [ ] 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
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/formigarafa/turf-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
+
+## Code of Conduct
+
+Everyone interacting in the Turf Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Great Thanks
+
+Great thanks to people that care to share and helping with the evolution of the community:
+
+- [@layerssss](https://github.com/layerssss) - Michael Yin
+- [@Henridv](https://github.com/Henridv) - Henri De Veene

data/lib/turf/circle.rb

@@ -11,19 +11,16 @@ module Turf
   # @param {string} [options.units='kilometers'] miles, kilometers, degrees, or radians
   # @param {hash} [options.properties={}] properties
   # @returns {Feature<Polygon>} circle polygon
-  def circle(center, radius, options = {}, units: nil, steps: 64)
-    # default params
+  def circle(center, radius, options = {})
     center = deep_symbolize_keys(center)
-    properties = options[:properties] || (
-      !center.is_a?(Array) && center[:type] == "Feature" && center[:properties] ? center[:properties] : {}
-    )
+    # default params
+    steps = options[:steps] || 64
+    properties = options[:properties]
+    properties ||= !center.is_a?(Array) && center[:type] == "Feature" && center[:properties]
+    properties ||= {}
 
     # main
     coordinates = []
-    destination_options = { properties: properties }
-    if units
-      destination_options[:units] = units
-    end
     steps.times do |i|
       coordinates.push(destination(center, radius, (i * -360.0) / steps, **options).dig(:geometry, :coordinates))
     end

data/lib/turf/destination.rb

@@ -13,12 +13,12 @@ module Turf
   # @param units [string] miles, kilometers, degrees, or radians
   # @param properties [Hash] Translate properties to Point
   # @return [Feature<Point>] destination point
-  def destination(origin, distance, bearing, units: "kilometers", properties: {})
+  def destination(origin, distance, bearing, options = {})
     coordinates1 = get_coord origin
     longitude1 = degrees_to_radians coordinates1[0]
     latitude1 = degrees_to_radians coordinates1[1]
     bearing_radians = degrees_to_radians bearing
-    radians = length_to_radians distance, units
+    radians = length_to_radians distance, options[:units]
 
     latitude2 = Math.asin((Math.sin(latitude1) * Math.cos(radians)) +
       (Math.cos(latitude1) * Math.sin(radians) * Math.cos(bearing_radians)))
@@ -29,6 +29,6 @@ module Turf
     lng = radians_to_degrees(longitude2)
     lat = radians_to_degrees(latitude2)
 
-    point([lng, lat], properties: properties)
+    point([lng, lat], properties: options[:properties])
   end
 end

data/lib/turf/helpers.rb

@@ -209,7 +209,8 @@ module Turf
   # @param radians [number] in radians across the sphere
   # @param units [string] can be degrees, radians, miles, inches, yards, metres, meters, kilometres, kilometers.
   # @return [number] distance
-  def radians_to_length(radians, units = "kilometers")
+  def radians_to_length(radians, units = nil)
+    units ||= "kilometers"
     factor = FACTORS[units]
     raise Error, "#{units} units is invalid" unless factor
 
@@ -222,7 +223,8 @@ module Turf
   # @param distance [number] in real units
   # @param units [string] can be degrees, radians, miles, inches, yards, metres, meters, kilometres, kilometers.
   # @return [number] radians
-  def length_to_radians(distance, units = "kilometers")
+  def length_to_radians(distance, units = nil)
+    units ||= "kilometers"
     factor = FACTORS[units]
     raise Error, "#{units} units is invalid" unless factor
 

data/lib/turf/version.rb

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

data/turf-ruby.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/turf/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "turf-ruby"
+  spec.version       = Turf::VERSION
+  spec.authors       = ["Rafael Santos"]
+  spec.email         = ["formigarafa@gmail.com"]
+
+  spec.summary       = "A modular geospatial engine. Ruby port of TurfJS."
+  spec.description   = [
+    "Turf Ruby is a Ruby library for spatial analysis. ",
+    "It includes traditional spatial operations, helper functions for creating",
+    " GeoJSON data, and data classification and statistics tools.",
+  ].join
+  spec.homepage      = "http://github.com/formigarafa/turf-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["documentation_uri"] = "https://formigarafa.github.io/turf-ruby/"
+
+  spec.files = Dir["*.gemspec", "lib/**/*", "LICENSE.txt", "README.md"]
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turf-ruby
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Rafael Santos
@@ -13,11 +13,12 @@ description: Turf Ruby is a Ruby library for spatial analysis. It includes tradi
   spatial operations, helper functions for creating GeoJSON data, and data classification
   and statistics tools.
 email:
-- santos@rafael.nz
+- formigarafa@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/turf.rb
 - lib/turf/along.rb
 - lib/turf/area.rb
@@ -34,6 +35,7 @@ files:
 - lib/turf/truncate.rb
 - lib/turf/version.rb
 - lib/turf_ruby.rb
+- turf-ruby.gemspec
 homepage: http://github.com/formigarafa/turf-ruby
 licenses:
 - MIT