lib/terraformer.rb in terraformer-0.0.7 vs lib/terraformer.rb in terraformer-0.0.8

@@ -7,35 +7,45 @@
 require 'ext/big_math'
 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: {
       href: "http://spatialreference.org/ref/sr-org/6928/ogcwkt/",
       type: "ogcwkt"
     }
   }
+
   GEOGRAPHIC_CRS = {
     type: "link",
     properties: {
       href: "http://spatialreference.org/ref/epsg/4326/ogcwkt/",
       type: "ogcwkt"
     }
   }
 
+  # 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
       geojson = JSON.parse geojson
     end
@@ -46,35 +56,52 @@
     else
       raise ArgumentError.new 'unknown type: ' + geojson['type']
     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
       raise ArgumentError.new "invalid type: #{arg['type']}" unless arg['type'] == self.type
       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
       h.to_json *args
     end