turf-ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f24676db8efcacbc042e80f6becc3656633e1c0a134159eec5e94273c2bb6f8
-  data.tar.gz: 66b5a9abfeb752015cc6245ecaf54c89911aa9b7142748435460eef0830b7277
+  metadata.gz: f8ed0e8a70920277e4e8507100d1f14084e75d0904c03feea99dc8196530561a
+  data.tar.gz: baba690e3110b85c5ece7eed4f5bd3229b5ecfbbeeca7ad4a7ca8e05d182763f
 SHA512:
-  metadata.gz: fe352b01c818eba0bc3e7f0be524b0a2c7c6c6be4609b8d85459998e12e16c9b18a96721df0afbb46c8d85e03ebe918075c380c2b31b10cdff23681c3c6c9d66
-  data.tar.gz: d47f32281f41ccb1b5f3079c51ddb90f4efd39bd02d6e2e2c51c0a325865038db557e1708453e5069782fb244943b6f20bd57c57534ee68fa29b4435b25fd8b4
+  metadata.gz: 9e331328f338fff791262493ae0f63da0baea68b5ec457c911ce62711803fc5f91b989bb5a2abc5191ff354f25306c664cb1b00a75c857484da518da4367a475
+  data.tar.gz: 7d1814173daf223ec7d8f9bbd4ae080c18c85bcfe4c0d307ada85abde67772aaa5d58bf87024fb5757825b5faa7544ab908ff12bc67c3cc5302ecf5e5281a0d6

data/.hound.yml

@@ -0,0 +1,5 @@
+fail_on_violations: true
+
+rubocop:
+  config_file: .rubocop.yml
+  version: 0.80.0

data/.rubocop.yml

@@ -0,0 +1,32 @@
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Metrics:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: false
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/.travis.yml

@@ -3,4 +3,4 @@ language: ruby
 cache: bundler
 rvm:
   - 2.7.0
-before_install: gem install bundler -v 2.1.2
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in turf-ruby.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
 gem "minitest", "~> 5.0"
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    turf-ruby (0.1.0)
+    turf-ruby (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -18,4 +18,4 @@ DEPENDENCIES
   turf-ruby!
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

data/README.md

@@ -1,4 +1,4 @@
-# Turf Ruby
+# Turf Ruby [![Build Status](https://travis-ci.com/formigarafa/turf-ruby.svg?branch=master)](https://travis-ci.com/formigarafa/turf-ruby)
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/turf`. To experiment with that code, run `bin/console` for an interactive prompt.
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
 
@@ -7,4 +9,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+task default: :test

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
-require "turf-ruby"
+require "turf_ruby"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/turf.rb

@@ -1,6 +1,16 @@
+# frozen_string_literal: true
+
 require "turf/version"
 
 module Turf
   class Error < StandardError; end
-  # Your code goes here...
+
+  # A non-intrusive implemenation of Rails' Hash#deep_symbolize_keys
+  def self.deep_symbolize_keys(hash)
+    return hash unless hash.is_a? Hash
+
+    hash.transform_keys(&:to_sym).transform_values do |value|
+      deep_symbolize_keys(value)
+    end
+  end
 end

data/lib/turf/helper.rb

@@ -1,26 +1,96 @@
+# frozen_string_literal: true
+
 module Turf
+  EARTH_RADIUS = 6_371_008.8
+  FACTORS = {
+    "centimeters" => EARTH_RADIUS * 100,
+    "centimetres" => EARTH_RADIUS * 100,
+    "degrees" => EARTH_RADIUS / 111_325,
+    "feet" => EARTH_RADIUS * 3.28084,
+    "inches" => EARTH_RADIUS * 39.370,
+    "kilometers" => EARTH_RADIUS / 1000,
+    "kilometres" => EARTH_RADIUS / 1000,
+    "meters" => EARTH_RADIUS,
+    "metres" => EARTH_RADIUS,
+    "miles" => EARTH_RADIUS / 1609.344,
+    "millimeters" => EARTH_RADIUS * 1000,
+    "millimetres" => EARTH_RADIUS * 1000,
+    "nauticalmiles" => EARTH_RADIUS / 1852,
+    "radians" => 1,
+    "yards" => EARTH_RADIUS / 1.0936
+  }.freeze
+
   def self.feature(geom, properties = nil, options = {})
     feat = {
       type: "Feature",
       geometry: geom,
-      properties: properties || {},
+      properties: properties || {}
     }
-    if options[:id]
-      feat[:id] = options[:id]
-    end
+    feat[:id] = options[:id] if options[:id]
 
-    if options[:bbox]
-      feat[:bbox] = options[:bbox]
-    end
+    feat[:bbox] = options[:bbox] if options[:bbox]
 
     feat
   end
 
+  def self.line_string(coordinates, properties = nil, options = {})
+    if coordinates.size < 2
+      raise Error, "coordinates must be an array of two or more positions"
+    end
+
+    geom = {
+      type: "LineString",
+      coordinates: coordinates
+    }
+    feature(geom, properties, options)
+  end
+
   def self.point(coordinates, properties = nil, options = {})
     geom = {
       type: "Point",
-      coordinates: coordinates,
+      coordinates: coordinates
+    }
+    feature(geom, properties, options)
+  end
+
+  def self.polygon(coordinates, properties = nil, options = {})
+    coordinates.each do |ring|
+      if ring.size < 4
+        raise(
+          Error,
+          "Each LinearRing of a Polygon must have 4 or more Positions.",
+        )
+      end
+
+      ring.last.each_with_index do |number, idx|
+        if ring.first[idx] != number
+          raise Error, "First and last Position are not equivalent."
+        end
+      end
+    end
+    geom = {
+      type: "Polygon",
+      coordinates: coordinates
     }
     feature(geom, properties, options)
   end
+
+  def self.degrees_to_radians(degrees)
+    radians = degrees.remainder(360)
+    radians * Math::PI / 180
+  end
+
+  def self.radians_to_length(radians, units = "kilometers")
+    factor = FACTORS[units]
+    raise Error, "#{units} units is invalid" unless factor
+
+    radians * factor
+  end
+
+  def self.length_to_radians(distance, units = "kilometers")
+    factor = FACTORS[units]
+    raise Error, "#{units} units is invalid" unless factor
+
+    distance / factor
+  end
 end

data/lib/turf/invariant.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Turf
+  def self.get_coord(coord)
+    if !coord
+      raise Error, "coord is required"
+    end
+
+    is_numeric = ->(i) { i.is_a? Numeric }
+    if coord.is_a?(Array) && coord.length >= 2 && coord.all?(&is_numeric)
+      return coord
+    end
+
+    if coord.is_a? Hash
+      coord = deep_symbolize_keys(coord)
+
+      is_feature = coord[:type] == "Feature"
+      if is_feature && coord.fetch(:geometry, {})[:type] == "Point"
+        return coord[:geometry][:coordinates]
+      end
+
+      if coord[:type] == "Point"
+        return coord[:coordinates]
+      end
+    end
+
+    raise Error, "coord must be GeoJSON Point or an Array of numbers"
+  end
+end

data/lib/turf/measurement.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Turf
+  def self.distance(from, to, **options)
+    coordinates1 = get_coord from
+    coordinates2 = get_coord to
+
+    d_lat = degrees_to_radians coordinates2[1] - coordinates1[1]
+    d_lon = degrees_to_radians coordinates2[0] - coordinates1[0]
+    lat1 = degrees_to_radians coordinates1[1]
+    lat2 = degrees_to_radians coordinates2[1]
+
+    a =
+      (
+        (Math.sin(d_lat / 2)**2) +
+        (Math.sin(d_lon / 2)**2) * Math.cos(lat1) * Math.cos(lat2)
+      )
+
+    call_args = [
+      2 * Math.atan2(
+        Math.sqrt(a),
+        Math.sqrt(1 - a),
+      ),
+    ]
+    if options[:units]
+      call_args << options[:units]
+    end
+    public_send(:radians_to_length, *call_args)
+  end
+end

data/lib/turf/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Turf
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/turf_ruby.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "turf"
+require "turf/helper"
+require "turf/measurement"
+require "turf/invariant"

data/turf-ruby.gemspec

@@ -1,4 +1,6 @@
-require_relative 'lib/turf/version'
+# frozen_string_literal: true
+
+require_relative "lib/turf/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "turf-ruby"
@@ -6,8 +8,12 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Rafael Santos"]
   spec.email         = ["santos@rafael.nz"]
 
-  spec.summary       = %q{A modular geospatial engine. Ruby port of TurfJS.}
-  spec.description   = %q{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.}
+  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.3.0")
@@ -16,9 +22,12 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = spec.homepage
 
   # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turf-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rafael Santos
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-19 00:00:00.000000000 Z
+date: 2020-03-10 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
@@ -20,6 +20,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -29,10 +31,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/turf-ruby.rb
 - lib/turf.rb
 - lib/turf/helper.rb
+- lib/turf/invariant.rb
+- lib/turf/measurement.rb
 - lib/turf/version.rb
+- lib/turf_ruby.rb
 - turf-ruby.gemspec
 homepage: http://github.com/formigarafa/turf-ruby
 licenses:

data/lib/turf-ruby.rb

@@ -1,2 +0,0 @@
-require "turf"
-require "turf/helper"