terraformer 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54582188df43611a0c97f98da5aa5cb4d4536930
-  data.tar.gz: 0980f0f42c63fbc4467f1d6cc8fbcf2d8f05b35a
+  metadata.gz: fee193b46a63e77c85cc7e9038265f18f4354330
+  data.tar.gz: 4e6ccf353873c97779a5a9adfd382fca1560dafe
 SHA512:
-  metadata.gz: 5179f0a38c1f9be3484033b314b5a9ae9ebee77f887df1ab42473a3249851ff67761039905bb863be4ce8bc914f73fef974a6182ceb29e7c373a3eff526c94e7
-  data.tar.gz: 83a1031d1f5721640184cd5fe0f5bdc6ac88294549622693dd0a747aa84a8081b9d11ade0b07e31a59b04773bcf9763d93f42fcc90c94fa3d776773d264c94c6
+  metadata.gz: e388553715283647e19799cd4cce2a9c1081b20fff457c9c64be5697e9ac912680f617c5f4b8d02ab77ca20628a2cac918eed94b911aa5b6589b98405daaa2ab
+  data.tar.gz: 800a2242a2e9736d1a205be2308727f5d8d029a61127bde45a8948d72ebc645c04a9fe4c488999a1e79ff377e29c9979df548ee80ddd289a231a2080c09b8553

data/Gemfile

@@ -1,11 +1,10 @@
 source 'https://rubygems.org'
 
-gem 'rake'
-gem 'launchy', require: nil
+gem 'launchy', '~>2.4', require: nil
 
 group :test do
-  gem 'http'
-  gem 'pry'
-  gem 'pry-nav'
-  gem 'ruby-prof'
+  gem 'httpclient', '~>2.5'
+  gem 'pry', '~>0.10'
+  gem 'pry-nav', '~>0.2'
+  gem 'ruby-prof', '~>0.15'
 end

data/README.md

@@ -2,3 +2,53 @@ terraformer-ruby
 ================
 
 mostly faithful port of [terraformer](https://github.com/Esri/Terraformer)
+
+### Installation
+
+`gem install terraformer`
+
+or include in an application's `Gemfile`
+
+`gem terraformer`
+
+### Basic usage
+
+[terraformer-ruby](https://github.com/esripdx/terraformer-ruby) is a port of [terraformer](https://github.com/Esri/Terraformer).
+
+##### Create a Terraformer primitive from GeoJSON
+
+```
+> polygon = Terraformer.parse '{
+  "type": "Polygon",
+  "coordinates": [
+    [
+      [-122.66589403152467, 45.52290150862236],
+      [-122.66926288604736, 45.52291654238294],
+      [-122.67115116119385, 45.518406234030586],
+      [-122.67325401306151, 45.514000817199715],
+      [-122.6684260368347, 45.5127377671934],
+      [-122.66765356063841, 45.51694782364431],
+      [-122.66589403152467, 45.52290150862236 ]
+    ]
+  ]
+}'
+
+> point = Terraformer.parse '{
+  "type": "Point",
+  "coordinates": [-122.66947746276854, 45.51775972687403]
+}'
+
+```
+Now that you have a point and a polygon primitive you can use the primitive helper methods.
+
+```
+# add a new vertex to our polygon
+> new_point = Terraformer::Point.new -122.6708507537842, 45.513188859735436
+> polygon.insert_vertex 2, new_point
+```
+You can also have Terraformer perform many geometric operations like convex hulls and bounding boxes.
+```
+> convex_hull = polygon.convex_hull
+> point.within? convex_hull #returns true
+> bounding_box = polygon.bbox #returns the bounding box for this object.
+```

data/lib/terraformer.rb

@@ -9,16 +9,21 @@ require 'ext/enumerable'
 require 'ext/hash'
 require 'forwardable'
 
+# terraformer.rb - a toolkit for working with geojson in ruby
+#
 module Terraformer
 
+  # number of decimal places of precision to limit bigmath calculations to
+  #
   PRECISION = BigDecimal.double_fig
   BigDecimal.limit PRECISION
+
   PI = BigMath.PI PRECISION
   DEFAULT_BUFFER_RESOLUTION = 64
-
   EARTH_RADIUS = 6378137.to_d
   DEGREES_PER_RADIAN = 180.0.to_d / PI
   RADIANS_PER_DEGREE = PI / 180.0.to_d
+
   MERCATOR_CRS = {
     type: "link",
     properties: {
@@ -26,6 +31,7 @@ module Terraformer
       type: "ogcwkt"
     }
   }
+
   GEOGRAPHIC_CRS = {
     type: "link",
     properties: {
@@ -34,6 +40,10 @@ module Terraformer
     }
   }
 
+  # parses geojson into a terraformer object. parameter must be a +Hash+,
+  # +String+ or +File+ containing a valid geojson object. return class type
+  # is determined by +type+ property.
+  #
   def self.parse geojson
     if String === geojson
       geojson = File.read geojson if File.readable? geojson
@@ -48,13 +58,20 @@ module Terraformer
     end
   end
 
+  # open OS's default browser to geojson.io with param data
+  #
   def self.geojson_io data
     require 'launchy'
     Launchy.open "http://geojson.io/#data=data:application/json,#{URI.encode_www_form_component data.to_json}"
   end
 
+  # abstract base class for terraformer objects. implements +bbox+ and
+  # +envelope+.
+  #
   class Primitive
 
+    # handles basic JSON parsing for terraformer object constructors.
+    #
     def initialize *args
       arg = String === args[0] ? JSON.parse(args[0]) : args[0]
       raise ArgumentError.new "invalid argument(s): #{args}" unless Hash === arg
@@ -62,18 +79,28 @@ module Terraformer
       yield arg if block_given?
     end
 
+    # terraformer object type as a +String+.
+    #
     def type
       self.class.to_s.sub 'Terraformer::', ''
     end
 
+    # returns a bounding envelope as a +Hash+ of the geometry. the envelope has
+    # keys for coordinates +x+ and +y+, and dimensions +w+ and +h+.
+    #
     def envelope
-      Bounds.envelope self
+      Bounds.envelope self.respond_to?(:geometry) ? self.geometry : self
     end
 
+    # returns a bounding box array of values, with minimum axis values followed
+    # by maximum axis values.
+    #
     def bbox type = :bbox
-      Bounds.bounds self, type
+      Bounds.bounds self.respond_to?(:geometry) ? self.geometry : self, type
     end
 
+    # base +to_json+ implementation for all terraformer objects.
+    #
     def to_json *args
       h = self.to_hash *args
       args.pop if Hash === args.last

data/lib/terraformer/version.rb

@@ -1,3 +1,3 @@
 module Terraformer
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

data/terraformer.gemspec

@@ -12,4 +12,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Terraformer::VERSION
   gem.license       = 'apache'
+  gem.add_runtime_dependency 'launchy', '~>2.4'
 end

data/test/helper.rb

@@ -11,9 +11,12 @@ require 'terraformer'
 module MiniTest::Expectations
 
   GEOJSON_VALIDATE_URL = 'http://geojsonlint.com/validate'
+  GEOJSON_VALIDATE_HEADERS = {'Content-Type' => 'application/json'}
+
+  HC = HTTPClient.new
 
   def validate_geojson geojson_h
-    r = JSON.parse HTTP['Content-Type' => 'application/json'].post(GEOJSON_VALIDATE_URL, json: geojson_h).body
+    r = JSON.parse HC.post(GEOJSON_VALIDATE_URL, geojson_h.to_json, GEOJSON_VALIDATE_HEADERS).body
     r['status'].must_equal 'ok'
   end
 

data/test/primitive_spec.rb

@@ -40,6 +40,12 @@ describe Terraformer::Primitive do
       bbox.must_equal expected
     end
 
+    it 'works on features' do
+      wc = Terraformer.parse EXAMPLES[:waldocanyon]
+      bbox = wc.bbox
+      bbox.dont_be_terrible_ok
+    end
+
   end
 
   describe 'to_json' do

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: terraformer
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Kenichi Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-04 00:00:00.000000000 Z
-dependencies: []
+date: 2014-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 description: ''
 email:
 - kenichi.nakamura@gmail.com
@@ -81,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: ''