rgeo 0.1.14 → 0.1.15

data/lib/rgeo/geography/simple_mercator/projector.rb

@@ -65,7 +65,7 @@ module RGeo
         def unproject(geometry_)
           case geometry_
           when Features::Point
-            dpr_ = Helper::DEGREES_PER_RADIAN
+            dpr_ = ::RGeo::ImplHelpers::Math::DEGREES_PER_RADIAN
             radius_ = EQUATORIAL_RADIUS
             @geography_factory.point(geometry_.x / radius_ * dpr_,
               (2.0 * ::Math.atan(::Math.exp(geometry_.y / radius_)) - ::Math::PI / 2.0) * dpr_)

data/lib/rgeo/geography/simple_spherical.rb

@@ -0,0 +1,68 @@
+# -----------------------------------------------------------------------------
+# 
+# Simple spherical geography implementation for RGeo
+# 
+# -----------------------------------------------------------------------------
+# Copyright 2010 Daniel Azuma
+# 
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the copyright holder, nor the names of any other
+#   contributors to this software, may be used to endorse or promote products
+#   derived from this software without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+;
+
+
+require 'rgeo/geography'
+
+
+module RGeo
+  
+  module Geography
+    
+    
+    # This namespace contains the simple spherical implementation.
+    
+    module SimpleSpherical
+    end
+    
+    
+  end
+  
+  
+end
+
+
+# Dependency source files.
+paths_ = [
+  'features',
+  'wkrep',
+  'impl_helpers',
+  'geography/simple_spherical/calculations',
+  'geography/simple_spherical/feature_methods',
+  'geography/simple_spherical/feature_classes',
+  'geography/factory',
+  'geography/projected_window',
+]
+paths_.each{ |path_| require "rgeo/#{path_}" }

data/lib/rgeo/geography/simple_spherical/calculations.rb

@@ -85,7 +85,7 @@ module RGeo
         def latlon
           lat_rad_ = ::Math.asin(@z)
           lon_rad_ = ::Math.atan2(@y, @x) rescue 0.0
-          rpd_ = Helper::RADIANS_PER_DEGREE
+          rpd_ = ::RGeo::ImplHelpers::Math::RADIANS_PER_DEGREE
           [lat_rad_ / rpd_, lon_rad_ / rpd_]
         end
         
@@ -120,7 +120,7 @@ module RGeo
         
         
         def self.from_latlon(lat_, lon_)
-          rpd_ = Helper::RADIANS_PER_DEGREE
+          rpd_ = ::RGeo::ImplHelpers::Math::RADIANS_PER_DEGREE
           lat_rad_ = rpd_ * lat_
           lon_rad_ = rpd_ * lon_
           z_ = ::Math.sin(lat_rad_)

data/lib/rgeo/geography/simple_spherical/feature_classes.rb

@@ -44,10 +44,10 @@ module RGeo
       class PointImpl  # :nodoc:
         
         
-        include Features::Point
-        include ImplHelpers::BasicGeometryMethods
-        include SimpleSpherical::GeometryMethods
-        include ImplHelpers::BasicPointMethods
+        include ::RGeo::Features::Point
+        include ::RGeo::ImplHelpers::BasicGeometryMethods
+        include ::RGeo::Geography::SimpleSpherical::GeometryMethods
+        include ::RGeo::ImplHelpers::BasicPointMethods
         
         
         def _validate_geometry
@@ -81,11 +81,11 @@ module RGeo
       class LineStringImpl  # :nodoc:
         
         
-        include Features::LineString
-        include ImplHelpers::BasicGeometryMethods
-        include SimpleSpherical::GeometryMethods
-        include ImplHelpers::BasicLineStringMethods
-        include SimpleSpherical::LineStringMethods
+        include ::RGeo::Features::LineString
+        include ::RGeo::ImplHelpers::BasicGeometryMethods
+        include ::RGeo::Geography::SimpleSpherical::GeometryMethods
+        include ::RGeo::ImplHelpers::BasicLineStringMethods
+        include ::RGeo::Geography::SimpleSpherical::LineStringMethods
         
         
       end
@@ -94,12 +94,12 @@ module RGeo
       class LineImpl  # :nodoc:
         
         
-        include Features::Line
-        include ImplHelpers::BasicGeometryMethods
-        include SimpleSpherical::GeometryMethods
-        include ImplHelpers::BasicLineStringMethods
-        include SimpleSpherical::LineStringMethods
-        include ImplHelpers::BasicLineMethods
+        include ::RGeo::Features::Line
+        include ::RGeo::ImplHelpers::BasicGeometryMethods
+        include ::RGeo::Geography::SimpleSpherical::GeometryMethods
+        include ::RGeo::ImplHelpers::BasicLineStringMethods
+        include ::RGeo::Geography::SimpleSpherical::LineStringMethods
+        include ::RGeo::ImplHelpers::BasicLineMethods
         
         
       end
@@ -108,12 +108,12 @@ module RGeo
       class LinearRingImpl  # :nodoc:
         
         
-        include Features::Line
-        include ImplHelpers::BasicGeometryMethods
-        include SimpleSpherical::GeometryMethods
-        include ImplHelpers::BasicLineStringMethods
-        include SimpleSpherical::LineStringMethods
-        include ImplHelpers::BasicLinearRingMethods
+        include ::RGeo::Features::Line
+        include ::RGeo::ImplHelpers::BasicGeometryMethods
+        include ::RGeo::Geography::SimpleSpherical::GeometryMethods
+        include ::RGeo::ImplHelpers::BasicLineStringMethods
+        include ::RGeo::Geography::SimpleSpherical::LineStringMethods
+        include ::RGeo::ImplHelpers::BasicLinearRingMethods
         
         
       end
@@ -122,10 +122,10 @@ module RGeo
       class PolygonImpl  # :nodoc:
         
         
-        include Features::Polygon
-        include ImplHelpers::BasicGeometryMethods
-        include SimpleSpherical::GeometryMethods
-        include ImplHelpers::BasicPolygonMethods
+        include ::RGeo::Features::Polygon
+        include ::RGeo::ImplHelpers::BasicGeometryMethods
+        include ::RGeo::Geography::SimpleSpherical::GeometryMethods
+        include ::RGeo::ImplHelpers::BasicPolygonMethods
         
         
       end
@@ -134,10 +134,10 @@ module RGeo
       class GeometryCollectionImpl  # :nodoc:
         
         
-        include Features::GeometryCollection
-        include ImplHelpers::BasicGeometryMethods
-        include SimpleSpherical::GeometryMethods
-        include ImplHelpers::BasicGeometryCollectionMethods
+        include ::RGeo::Features::GeometryCollection
+        include ::RGeo::ImplHelpers::BasicGeometryMethods
+        include ::RGeo::Geography::SimpleSpherical::GeometryMethods
+        include ::RGeo::ImplHelpers::BasicGeometryCollectionMethods
         
         
       end
@@ -146,11 +146,11 @@ module RGeo
       class MultiPointImpl  # :nodoc:
         
         
-        include Features::GeometryCollection
-        include ImplHelpers::BasicGeometryMethods
-        include SimpleSpherical::GeometryMethods
-        include ImplHelpers::BasicGeometryCollectionMethods
-        include ImplHelpers::BasicMultiPointMethods
+        include ::RGeo::Features::GeometryCollection
+        include ::RGeo::ImplHelpers::BasicGeometryMethods
+        include ::RGeo::Geography::SimpleSpherical::GeometryMethods
+        include ::RGeo::ImplHelpers::BasicGeometryCollectionMethods
+        include ::RGeo::ImplHelpers::BasicMultiPointMethods
         
         
       end
@@ -159,11 +159,11 @@ module RGeo
       class MultiLineStringImpl  # :nodoc:
         
         
-        include Features::GeometryCollection
-        include ImplHelpers::BasicGeometryMethods
-        include SimpleSpherical::GeometryMethods
-        include ImplHelpers::BasicGeometryCollectionMethods
-        include ImplHelpers::BasicMultiLineStringMethods
+        include ::RGeo::Features::GeometryCollection
+        include ::RGeo::ImplHelpers::BasicGeometryMethods
+        include ::RGeo::Geography::SimpleSpherical::GeometryMethods
+        include ::RGeo::ImplHelpers::BasicGeometryCollectionMethods
+        include ::RGeo::ImplHelpers::BasicMultiLineStringMethods
         
         
       end
@@ -172,11 +172,11 @@ module RGeo
       class MultiPolygonImpl  # :nodoc:
         
         
-        include Features::GeometryCollection
-        include ImplHelpers::BasicGeometryMethods
-        include SimpleSpherical::GeometryMethods
-        include ImplHelpers::BasicGeometryCollectionMethods
-        include ImplHelpers::BasicMultiPolygonMethods
+        include ::RGeo::Features::GeometryCollection
+        include ::RGeo::ImplHelpers::BasicGeometryMethods
+        include ::RGeo::Geography::SimpleSpherical::GeometryMethods
+        include ::RGeo::ImplHelpers::BasicGeometryCollectionMethods
+        include ::RGeo::ImplHelpers::BasicMultiPolygonMethods
         
         
       end

data/lib/rgeo/geos.rb

@@ -34,6 +34,10 @@
 ;
 
 
+# Parent file
+require 'rgeo'
+
+
 module RGeo
   
   
@@ -61,12 +65,11 @@ module RGeo
 end
 
 
-# Dependency source files.
-paths_ = [
-  'features',
-  'geos/factory',
-  'geos/interface',
-  'geos/geos_c_impl',
-  'geos/impl_additions',
-]
-paths_.each{ |path_| require "rgeo/#{path_}" }
+# Dependency files
+require 'rgeo/features'
+
+# Implementation files
+require 'rgeo/geos/factory'
+require 'rgeo/geos/interface'
+require 'rgeo/geos/geos_c_impl'
+require 'rgeo/geos/impl_additions'

data/lib/rgeo/impl_helpers.rb

@@ -34,6 +34,10 @@
 ;
 
 
+# Parent file
+require 'rgeo'
+
+
 module RGeo
   
   
@@ -44,12 +48,13 @@ module RGeo
 end
 
 
-# Dependency source files.
-paths_ = [
-  'impl_helpers/basic_geometry_methods',
-  'impl_helpers/basic_geometry_collection_methods',
-  'impl_helpers/basic_point_methods',
-  'impl_helpers/basic_line_string_methods',
-  'impl_helpers/basic_polygon_methods',
-]
-paths_.each{ |path_| require "rgeo/#{path_}" }
+# Dependency files
+require 'rgeo/features'
+
+# Implementation files
+require 'rgeo/impl_helpers/math'
+require 'rgeo/impl_helpers/basic_geometry_methods'
+require 'rgeo/impl_helpers/basic_geometry_collection_methods'
+require 'rgeo/impl_helpers/basic_point_methods'
+require 'rgeo/impl_helpers/basic_line_string_methods'
+require 'rgeo/impl_helpers/basic_polygon_methods'

data/lib/rgeo/impl_helpers/basic_geometry_collection_methods.rb

@@ -130,6 +130,11 @@ module RGeo
       end
       
       
+      def length
+        @elements.inject(0.0){ |sum_, obj_| sum_ + obj_.length }
+      end
+      
+      
     end
     
     
@@ -178,6 +183,11 @@ module RGeo
       end
       
       
+      def area
+        @elements.inject(0.0){ |sum_, obj_| sum_ + obj_.area }
+      end
+      
+      
     end
     
     

data/lib/rgeo/impl_helpers/basic_point_methods.rb

@@ -48,6 +48,9 @@ module RGeo
         @y = y_.to_f
         @z = factory_.has_capability?(:z_coordinate) ? extra_.shift.to_f : nil
         @m = factory_.has_capability?(:m_coordinate) ? extra_.shift.to_f : nil
+        if extra_.size > 0
+          raise ::ArgumentError, "Too many arguments for point initializer"
+        end
         _validate_geometry
       end
       

data/lib/rgeo/{geography/helper.rb → impl_helpers/math.rb}

@@ -1,6 +1,6 @@
 # -----------------------------------------------------------------------------
 # 
-# Helper for geography implementations
+# Math constants and tools
 # 
 # -----------------------------------------------------------------------------
 # Copyright 2010 Daniel Azuma
@@ -36,9 +36,9 @@
 
 module RGeo
   
-  module Geography
+  module ImplHelpers  # :nodoc:
     
-    module Helper  # :nodoc:
+    module Math  # :nodoc:
       
       RADIANS_PER_DEGREE = ::Math::PI/180.0
       DEGREES_PER_RADIAN = 180.0/::Math::PI

data/lib/rgeo/wkrep.rb

@@ -34,12 +34,33 @@
 ;
 
 
+# Parent file
+require 'rgeo'
+
+
 module RGeo
   
   
-  # Implementations of the OpenGIS well-known representation
-  # (i.e. the WKT/WKB) and its variants (e.g. the EWKT/EWKB used by
-  # PostGIS). Provides generation and parsing facilities.
+  # This module contains implementations of the OpenGIS well-known
+  # representations: the WKT (well-known text representation) and the
+  # WKB (well-known binary representation), as defined in the Simple
+  # Features Specification, version 1.1. Facilities are provided to
+  # serialize any geometry into one of these formats, and to parse a
+  # serialized string back into a geometry. Support is also provided for
+  # the common extensions to these formats-- notably, the EWKT and EWKB
+  # formats used by PostGIS.
+  # 
+  # To serialize a geometry into WKT (well-known text) format, use
+  # the WKRep::WKTGenerator class.
+  # 
+  # To serialize a geometry into WKB (well-known binary) format, use
+  # the WKRep::WKBGenerator class.
+  # 
+  # To parse a string in WKT (well-known text) format back into a
+  # geometry object, use the WKRep::WKTParser class.
+  # 
+  # To parse a byte string in WKB (well-known binary) format back into a
+  # geometry object, use the WKRep::WKBParser class.
   
   module WKRep
   end
@@ -48,12 +69,11 @@ module RGeo
 end
 
 
-# Dependency source files.
-paths_ = [
-  'features',
-  'wkrep/wkt_parser',
-  'wkrep/wkt_generator',
-  'wkrep/wkb_parser',
-  'wkrep/wkb_generator',
-]
-paths_.each{ |path_| require "rgeo/#{path_}" }
+# Dependency files
+require 'rgeo/features'
+
+# Implementation files
+require 'rgeo/wkrep/wkt_parser'
+require 'rgeo/wkrep/wkt_generator'
+require 'rgeo/wkrep/wkb_parser'
+require 'rgeo/wkrep/wkb_generator'

data/lib/rgeo/wkrep/wkb_generator.rb

@@ -39,9 +39,42 @@ module RGeo
   module WKRep
     
     
+    # This class provides the functionality of serializing a geometry as
+    # WKB (well-known binary) format. You may also customize the
+    # serializer to generate PostGIS EWKB extensions to the output, or to
+    # follow the Simple Features Specification 1.2 extensions for Z and M
+    # coordinates.
+    # 
+    # To use this class, create an instance with the desired settings and
+    # customizations, and call the generate method.
+    # 
+    # === Configuration options
+    # 
+    # The following options are recognized. These can be passed to the
+    # constructor, or set on the object afterwards.
+    # 
+    # <tt>:type_format</tt>::
+    #   The format for type codes. Possible values are <tt>:wkb11</tt>,
+    #   indicating SFS 1.1 WKB (i.e. no Z or M values); <tt>:ewkb</tt>,
+    #   indicating the PostGIS EWKB extensions (i.e. Z and M presence
+    #   flagged by the two high bits of the type code, and support for
+    #   embedded SRID); or <tt>:wkb12</tt> (indicating SFS 1.2 WKB
+    #   (i.e. Z and M presence flagged by adding 1000 and/or 2000 to
+    #   the type code.) Default is <tt>:wkb11</tt>.
+    # <tt>:emit_ewkb_srid</tt>::
+    #   If true, embed the SRID in the toplevel geometry. Available only
+    #   if <tt>:type_format</tt> is <tt>:ewkb</tt>. Default is false.
+    # <tt>:hex_format</tt>::
+    #   If true, output a hex string instead of a byte string.
+    #   Default is false.
+    # <tt>:little_endian</tt>::
+    #   If true, output little endian (NDR) byte order. If false, output
+    #   big endian (XDR), or network byte order. Default is false.
+    
     class WKBGenerator
       
       
+      # :stopdoc:
       TYPE_CODES = {
         Features::Point => 1,
         Features::LineString => 2,
@@ -53,15 +86,68 @@ module RGeo
         Features::MultiPolygon => 6,
         Features::GeometryCollection => 7,
       }
+      # :startdoc:
+      
       
+      # Create and configure a WKB generator. See the WKBGenerator
+      # documentation for the options that can be passed.
       
       def initialize(opts_={})
-        @type_format = opts_[:type_format]
-        @emit_ewkb_srid = opts_[:emit_ewkb_srid] if @type_format == :ewkb
-        @hex_format = opts_[:hex_format]
-        @little_endian = opts_[:little_endian]
+        @type_format = opts_[:type_format] || :wkb11
+        @emit_ewkb_srid = opts_[:emit_ewkb_srid] ? true : false if @type_format == :ewkb
+        @hex_format = opts_[:hex_format] ? true : false
+        @little_endian = opts_[:little_endian] ? true : false
+      end
+      
+      
+      # Returns the format for type codes. See WKBGenerator for details.
+      def type_format
+        @type_format
+      end
+      
+      # Sets the format for type codes. See WKBGenerator for details.
+      def type_format=(value_)
+        @type_format = value_
+      end
+      
+      # Returns whether SRID is embedded. See WKBGenerator for details.
+      def emit_ewkb_srid?
+        @emit_ewkb_srid
+      end
+      
+      # Sets whether SRID is embedded. Available only when the type_format
+      # is <tt>:ewkb</tt>. See WKBGenerator for details.
+      def emit_ewkb_srid=(value_)
+        @emit_ewkb_srid = @type_format == :ewkb && value_
       end
       
+      # Returns whether output is converted to hex.
+      # See WKBGenerator for details.
+      def hex_format?
+        @hex_format
+      end
+      
+      # Sets whether output is converted to hex.
+      # See WKBGenerator for details.
+      def hex_format=(value_)
+        @hex_format = value_ ? true : false
+      end
+      
+      # Returns whether output is little-endian (NDR).
+      # See WKBGenerator for details.
+      def little_endian?
+        @little_endian
+      end
+      
+      # Sets whether output is little-endian (NDR).
+      # See WKBGenerator for details.
+      def little_endian=(value_)
+        @little_endian = value_ ? true : false
+      end
+      
+      
+      # Generate and return the WKB format for the given geometry object,
+      # according to the current settings.
       
       def generate(obj_)
         factory_ = obj_.factory
@@ -87,13 +173,13 @@ module RGeo
           raise Errors::ParseError, "Unrecognized Geometry Type: #{type_}"
         end
         emit_srid_ = false
-        if @emit_ewkb_srid && toplevel_
-          type_code |= 0x20000000
-          emit_srid_ = true
-        end
         if @type_format == :ewkb
           type_code_ |= 0x80000000 if @cur_has_z
           type_code_ |= 0x40000000 if @cur_has_m
+          if @emit_ewkb_srid && toplevel_
+            type_code |= 0x20000000
+            emit_srid_ = true
+          end
         elsif @type_format == :wkb12
           type_code_ += 1000 if @cur_has_z
           type_code_ += 2000 if @cur_has_m
@@ -169,7 +255,7 @@ module RGeo
       def _finish_emitter  # :nodoc:
         str_ = @cur_array.join
         @cur_array = nil
-        str_
+        @hex_format ? str_.unpack("H*")[0] : str_
       end