rgeo 0.1.22 → 0.2.0

data/Version

@@ -1 +1 @@
-0.1.22
+0.2.0

data/ext/proj4_c_impl/extconf.rb

@@ -71,4 +71,4 @@ unless found_proj_
   puts "**** WARNING: Unable to find Proj headers or Proj version is too old."
   puts "**** Compiling without Proj support."
 end
-create_makefile('coord_sys/proj4_c_impl')
+create_makefile('rgeo/coord_sys/proj4_c_impl')

data/lib/rgeo.rb

@@ -37,95 +37,88 @@
 # RGeo is a spatial data library for Ruby. It focuses on the storage and
 # manipulation of spatial data types such as points, lines, and polygons.
 # 
-# === RGeo Modules
-# 
-# RGeo comprises a number of modules.
-# 
-# The RGeo::Feature module contains interface specifications for spatial
-# objects implemented by RGeo. These interfaces closely follow the OGC
-# Simple Features Specifiation (SFS). This module forms the core of RGeo.
-# 
-# The RGeo::CoordSys module contains classes for representing spatial
-# reference systems and coordinate transformations. For example, it
-# includes a wrapper for the Proj4 library, supporting many geographic
-# projections.
-# 
-# The RGeo::Cartesian module provides a basic pure ruby implementation of
-# spatial objects in a Cartesian (flat) coordinate system. It does not
-# implement all the geometric analysis operations in the SFS, but it
-# implements the data structures without requiring an external C library,
-# so it is often sufficient for basic applications.
-# 
-# The RGeo::Geos module is another Cartesian implementation that wraps
-# the GEOS library to provide a full, high-performance implementation of
-# Cartesian geometry that includes every operation defined in the SFS. It
-# requires GEOS 3.2 or later.
-# 
-# The RGeo::Geographic module contains spatial implementations that
-# operate in latitude-longitude coordinates and are well-suited for
-# geographic location based applications. Geographic implementations may
-# also be linked to projections.
-# 
-# The RGeo::WKRep module contains tools for reading and writing spatial
-# data in the OGC Well-Known Text (WKT) and Well-Known Binary (WKB)
-# representations. It also supports common variants such as the PostGIS
-# EWKT and EWKB representations.
-# 
-# The RGeo::GeoJSON module contains tools for GeoJSON serialization of
-# spatial objects. These tools work with any of the spatial object
-# implementations.
-# 
-# The RGeo::Shapefile module contains tools for reading ESRI shapefiles,
-# an industry standard (if somewhat legacy) file format commonly used for
-# providing geographic data sets.
-# 
-# The RGeo::ActiveRecord module contains ActiveRecord connection adapters
-# for handling spatial data with MySQL Spatial, SpatiaLite, and PostGIS.
-# See the RGeo::ActiveRecord rdocs for more information on using these
-# adapters. However, you do not need to access or require this module
-# directly from code. ActiveRecord will load these adapters automatically
-# when they are requested.
-# 
-# === Loading the library
-# 
-# After installing the RGeo gem, you can load the library with:
-#  require 'rgeo'
-# 
-# This will "lazy-load" the modules as they are referenced or needed
-# (using autoload).
-# 
-# If, for performance reasons, or because you want to run RGeo in a
-# multithreaded environment, you wish to eagerly load RGeo, you may do so
-# with:
-#  require 'rgeo/all'
-# 
-# You may also eagerly load individual modules:
-#  require 'rgeo/feature'
-#  require 'rgeo/cartesian'
-#  require 'rgeo/coord_sys'
-#  require 'rgeo/geographic'
-#  require 'rgeo/geos'
-#  require 'rgeo/geo_json'
-#  require 'rgeo/shapefile'
-#  require 'rgeo/wkrep'
-# 
-# You do not need to explicitly require any files for access to the
-# spatial ActiveRecord adapters. ActiveRecord will load them
-# automatically when they are referenced.
+# RGeo comprises a number of modules. The "rgeo" gem provides a suite of
+# standard modules. Additional optional modules are provided by separate
+# gems with names of the form "<tt>rgeo-*</tt>".
+# 
+# === Standard modules
+# 
+# These are the standard modules provided by the "rgeo" gem.
+# 
+# * RGeo::Feature contains interface specifications for spatial
+#   objects implemented by RGeo. These interfaces closely follow the OGC
+#   Simple Features Specifiation (SFS). This module forms the core of RGeo.
+# 
+# * RGeo::CoordSys contains classes for representing spatial
+#   reference systems and coordinate transformations. For example, it
+#   includes a wrapper for the Proj4 library, supporting many geographic
+#   projections.
+# 
+# * RGeo::Cartesian is a gateway for geometric data implementations
+#   that operate in Caresian (flat) coordinate systems. It also provides a
+#   basic pure ruby Cartesian implementation. This implementation does not
+#   cover all the geometric analysis operations defined by the SFS, but it
+#   does not require an external C library and is often sufficient for
+#   basic applications.
+# 
+# * RGeo::Geos is another Cartesian implementation that wraps the
+#   GEOS library to provide a full, high-performance implementation of
+#   Cartesian geometry that includes every operation defined in the SFS.
+#   It requires GEOS 3.2 or later.
+# 
+# * RGeo::Geographic contains spatial implementations that operate
+#   in latitude-longitude coordinates and are well-suited for geographic
+#   location based applications. Geographic spatial objects may also be
+#   linked to projections.
+# 
+# * RGeo::WKRep contains tools for reading and writing spatial
+#   data in the OGC Well-Known Text (WKT) and Well-Known Binary (WKB)
+#   representations. It also supports common variants such as the PostGIS
+#   EWKT and EWKB representations.
+# 
+# === Optional Modules
+# 
+# Here is a partial list of optional modules available as separate gems.
+# 
+# * <b>rgeo-geojson</b> provides the RGeo::GeoJSON module, containing
+#   tools for GeoJSON encoding and decoding of spatial objects.
+# 
+# * <b>rgeo-shapefile</b> provides the RGeo::Shapefile module, containing
+#   tools for reading ESRI shapefiles.
+# 
+# * <b>rgeo-activerecord</b> provides the RGeo::ActiveRecord module,
+#   containing some ActiveRecord extensions for spatial databases, and a
+#   set of common tools for ActiveRecord spatial database adapters.
+# 
+# Several ActiveRecord adapters use RGeo. These include:
+# 
+# * <b>mysqlspatial</b>, an adapter for MySQL spatial extensions based on
+#   the mysql adapter. Available as the activerecord-mysqlspatial-adapter
+#   gem.
+# 
+# * <b>mysql2spatial</b>, an adapter for MySQL spatial extensions based on
+#   the mysql2 adapter. Available as the activerecord-mysql2spatial-adapter
+#   gem.
+# 
+# * <b>spatialite</b>, an adapter for the SpatiaLite extension to the
+#   Sqlite3 database, and based on the sqlite3 adapter. Available as the
+#   activerecord-spatialite-adapter gem.
+# 
+# * <b>postgis</b>, an adapter for the PostGIS extension to the PostgreSQL
+#   database, and based on the postgresql adapter. Available as the
+#   activerecord-postgis-adapter gem.
 
 module RGeo
-  
-  autoload(:Cartesian, 'rgeo/cartesian')
-  autoload(:CoordSys, 'rgeo/coord_sys')
-  autoload(:Error, 'rgeo/error')
-  autoload(:Feature, 'rgeo/feature')
-  autoload(:GeoJSON, 'rgeo/geo_json')
-  autoload(:Geographic, 'rgeo/geographic')
-  autoload(:Geos, 'rgeo/geos')
-  autoload(:ImplHelper, 'rgeo/impl_helper')
-  autoload(:Shapefile, 'rgeo/shapefile')
-  autoload(:WKRep, 'rgeo/wkrep')
-  
 end
 
+
+# Core modules
 require 'rgeo/version'
+require 'rgeo/error'
+require 'rgeo/feature'
+require 'rgeo/coord_sys'
+require 'rgeo/impl_helper'
+require 'rgeo/wkrep'
+require 'rgeo/geos'
+require 'rgeo/cartesian'
+require 'rgeo/geographic'

data/lib/rgeo/cartesian.rb

@@ -34,10 +34,6 @@
 ;
 
 
-# Parent file
-require 'rgeo'
-
-
 module RGeo
   
   
@@ -54,12 +50,6 @@ module RGeo
 end
 
 
-# Dependency files.
-require 'rgeo/feature'
-require 'rgeo/geos'
-require 'rgeo/wkrep'
-require 'rgeo/impl_helper'
-
 # Implementation files.
 require 'rgeo/cartesian/calculations'
 require 'rgeo/cartesian/feature_methods'

data/lib/rgeo/coord_sys.rb

@@ -34,10 +34,6 @@
 ;
 
 
-# Parent file
-require 'rgeo'
-
-
 module RGeo
   
   
@@ -57,9 +53,6 @@ module RGeo
 end
 
 
-# Dependency files
-require 'rgeo/feature'
-
 # Implementation files
 require 'rgeo/coord_sys/proj4_c_impl'
 require 'rgeo/coord_sys/proj4'

data/lib/rgeo/coord_sys/proj4.rb

@@ -176,13 +176,13 @@ module RGeo
         
         
         # Create a new Proj4 object, given a definition, which may be
-        # either a string or a hash. Raises Error::UnsupportedCapability
+        # either a string or a hash. Raises Error::UnsupportedOperation
         # if the given definition is invalid or Proj4 is not supported.
         
         def new(defn_)
           result_ = create(defn_)
           unless result_
-            raise Error::UnsupportedCapability, "Proj4 not supported in this installation"
+            raise Error::UnsupportedOperation, "Proj4 not supported in this installation"
           end
           result_
         end

data/lib/rgeo/error.rb

@@ -34,10 +34,6 @@
 ;
 
 
-# Parent file
-require 'rgeo'
-
-
 module RGeo
   
   
@@ -53,8 +49,8 @@ module RGeo
     class InvalidGeometry < RGeoError
     end
     
-    # The specified capability is not supported or not implemented
-    class UnsupportedCapability < RGeoError
+    # The specified operation is not supported or not implemented
+    class UnsupportedOperation < RGeoError
     end
     
     # Parsing failed

data/lib/rgeo/feature.rb

@@ -34,10 +34,6 @@
 ;
 
 
-# Parent file
-require 'rgeo'
-
-
 module RGeo
   
   
@@ -72,9 +68,6 @@ module RGeo
 end
 
 
-# Dependency files
-require 'rgeo/error'
-
 # Implementation files
 require 'rgeo/feature/factory'
 require 'rgeo/feature/types'

data/lib/rgeo/feature/curve.rb

@@ -88,7 +88,7 @@ module RGeo
       # Returns a floating-point scalar value.
       
       def length
-        raise Error::UnsupportedCapability, "Method Curve#length not defined."
+        raise Error::UnsupportedOperation, "Method Curve#length not defined."
       end
       
       
@@ -101,7 +101,7 @@ module RGeo
       # Returns an object that supports the Point interface.
       
       def start_point
-        raise Error::UnsupportedCapability, "Method Curve#start_point not defined."
+        raise Error::UnsupportedOperation, "Method Curve#start_point not defined."
       end
       
       
@@ -114,7 +114,7 @@ module RGeo
       # Returns an object that supports the Point interface.
       
       def end_point
-        raise Error::UnsupportedCapability, "Method Curve#end_point not defined."
+        raise Error::UnsupportedOperation, "Method Curve#end_point not defined."
       end
       
       
@@ -128,7 +128,7 @@ module RGeo
       # specification, which stipulates an integer return value.
       
       def is_closed?
-        raise Error::UnsupportedCapability, "Method Curve#is_closed? not defined."
+        raise Error::UnsupportedOperation, "Method Curve#is_closed? not defined."
       end
       
       
@@ -144,7 +144,7 @@ module RGeo
       # specification, which stipulates an integer return value.
       
       def is_ring?
-        raise Error::UnsupportedCapability, "Method Curve#is_ring? not defined."
+        raise Error::UnsupportedOperation, "Method Curve#is_ring? not defined."
       end
       
       

data/lib/rgeo/feature/factory.rb

@@ -78,7 +78,7 @@ module RGeo
       # 
       # Each property has a symbolic name. Names that have no periods are
       # considered well-known names and are reserved for use by RGeo. If
-      # you want to define your own capabilities, use a name that is
+      # you want to define your own properties, use a name that is
       # namespaced with periods, such as <tt>:'mycompany.myprop'</tt>.
       # 
       # Property values are dependent on the individual property.
@@ -131,9 +131,9 @@ module RGeo
       # Create a feature of type Point.
       # The x and y parameters should be Float values.
       # 
-      # The extra parameters should be the Z and/or M coordinates, if the
-      # capabilities are supported. If both Z and M capabilities are
-      # supported, Z should be passed first.
+      # The extra parameters should be the Z and/or M coordinates, if
+      # supported. If both Z and M coordinates are supported, Z should
+      # be passed first.
       
       def point(x_, y_, *extra_)
         nil
@@ -143,6 +143,11 @@ module RGeo
       # Create a feature of type LineString.
       # The given points argument should be an Enumerable of Point
       # objects, or objects that can be cast to Point.
+      # 
+      # Although implementations are free to attempt to handle input
+      # objects that are not of this factory, strictly speaking, the
+      # result of building geometries from objects of the wrong factory
+      # is undefined.
       
       def line_string(points_)
         nil
@@ -152,6 +157,11 @@ module RGeo
       # Create a feature of type Line.
       # The given point arguments should be Point objects, or objects
       # that can be cast to Point.
+      # 
+      # Although implementations are free to attempt to handle input
+      # objects that are not of this factory, strictly speaking, the
+      # result of building geometries from objects of the wrong factory
+      # is undefined.
       
       def line(start_, end_)
         nil
@@ -164,6 +174,11 @@ module RGeo
       # If the first and last points are not equal, the ring is
       # automatically closed by appending the first point to the end of the
       # string.
+      # 
+      # Although implementations are free to attempt to handle input
+      # objects that are not of this factory, strictly speaking, the
+      # result of building geometries from objects of the wrong factory
+      # is undefined.
       
       def linear_ring(points_)
         nil
@@ -176,6 +191,11 @@ module RGeo
       # The inner_rings should be a possibly empty Enumerable of
       # LinearRing (or objects that can be casted to LinearRing).
       # You may also pass nil to indicate no inner rings.
+      # 
+      # Although implementations are free to attempt to handle input
+      # objects that are not of this factory, strictly speaking, the
+      # result of building geometries from objects of the wrong factory
+      # is undefined.
       
       def polygon(outer_ring_, inner_rings_=nil)
         nil
@@ -184,6 +204,11 @@ module RGeo
       
       # Create a feature of type GeometryCollection.
       # The elems should be an Enumerable of Geometry objects.
+      # 
+      # Although implementations are free to attempt to handle input
+      # objects that are not of this factory, strictly speaking, the
+      # result of building geometries from objects of the wrong factory
+      # is undefined.
       
       def collection(elems_)
         nil
@@ -195,6 +220,11 @@ module RGeo
       # that can be cast to Point.
       # Returns nil if any of the contained geometries is not a Point,
       # which would break the MultiPoint contract.
+      # 
+      # Although implementations are free to attempt to handle input
+      # objects that are not of this factory, strictly speaking, the
+      # result of building geometries from objects of the wrong factory
+      # is undefined.
       
       def multi_point(elems_)
         nil
@@ -206,6 +236,11 @@ module RGeo
       # cast to LineString or any of its subclasses.
       # Returns nil if any of the contained geometries is not a
       # LineString, which would break the MultiLineString contract.
+      # 
+      # Although implementations are free to attempt to handle input
+      # objects that are not of this factory, strictly speaking, the
+      # result of building geometries from objects of the wrong factory
+      # is undefined.
       
       def multi_line_string(elems_)
         nil
@@ -219,6 +254,11 @@ module RGeo
       # which would break the MultiPolygon contract.
       # Also returns nil if any of the other assertions for MultiPolygon
       # are not met, e.g. if any of the polygons overlap.
+      # 
+      # Although implementations are free to attempt to handle input
+      # objects that are not of this factory, strictly speaking, the
+      # result of building geometries from objects of the wrong factory
+      # is undefined.
       
       def multi_polygon(elems_)
         nil
@@ -239,7 +279,7 @@ module RGeo
       # system.
       # 
       # NOTE: This is a required method of the factory interface, but the
-      # coordinate system objects themselves are not yet available, so
+      # coordinate system classes themselves are not yet available, so
       # implementations should just return nil for now.
       
       def coord_sys