rgeo 0.1.16 → 0.1.17

data/History.rdoc

@@ -1,3 +1,10 @@
+=== 0.1.17 / 2010-11-20
+
+* Implemented ActiveRecord adapters that cover MySQL Spatial for the mysql and mysql2 gems. SpatiaLite and PostGIS adapters are coming later.
+* Added and documented FactoryGenerator.
+* API CHANGE: WKRep parsers now take FactoryGenerator rather than the ad-hoc factory_from_srid.
+* API CHANGE: Factory#override_cast now takes its optional flags in a hash so it can be extended more cleanly in the future.
+
 === 0.1.16 / 2010-11-18
 
 * Test coverage for WKB generator and parser; fixed a few bugs.

data/README.rdoc

@@ -29,10 +29,11 @@ Use RGeo to:
   intersections, creating buffers, and computing lengths and areas.
 * Correctly handle spherical geometry, and compute projections for
   geographic data analysis.
-* Store and retrieve spatial data in industry standard spatial storage
+* Store and retrieve spatial data in industry standard spatial database
   systems such as PostGIS.
 * Generate and interpret GeoJSON data for communication with common
-  location-based services.
+  location-based services; and read and write ESRI shapefiles for
+  interaction with legacy GIS data.
 * Extend Ruby On Rails to handle location data in a web application.
 * Write spatial applications following the latest open standards from
   the Open Geospatial Consortium.
@@ -46,7 +47,7 @@ RGeo has the following prerequisites:
 * GEOS 3.2 or later highly recommended. Some functions will not be
   available without it. This C/C++ library may be available via your
   operating system's package manager, or you can download it from
-  http://trac.osgeo.org/geos/
+  http://geos.osgeo.org/
 
 === Installation
 
@@ -63,23 +64,26 @@ library in the following locations:
 * /usr
 
 If GEOS has been installed in a different location, you must provide its
-installation prefix directory using the "--with-geos-dir" option.
-For example:
+installation prefix directory using the "--with-geos-dir" option. This
+option must be preceded by "--" to separate it, as a build switch, from
+the switches interpreted by the gem command. For example:
 
- gem install rgeo -- --with-geos-dir=/var/local
+ gem install rgeo -- --with-geos-dir=/path/to/my/geos/installation
 
 === Known issues and to-do items
 
 RGeo is currently under development and several planned features are not
 yet complete. These include:
 
-* Some operations on SimpleCartesian and SimpleSpherical.
-* Rails (ActiveRecord or ActiveModel) integration.
-* Other third-party integration, including possibly SimpleGeo.
+* SpatiaLite and PostGIS adapters for ActiveRecord.
 * Support for bbox and crs elements of GeoJSON.
-* Support for additional formats such as ESRI shapefiles.
+* Support for ESRI shapefile reading and writing.
+* Projection subsystem, and support for arbitrary projections in the geography module, utilizing proj4.
+* Several more operations on SimpleCartesian and SimpleSpherical.
+* Geography implementation utilizing ellipsoidal geometry, probably utilizing geographiclib.
+* Additional third-party integration, possibly including SimpleGeo, GeoRSS, KML.
 * JRuby support via JTS integration.
-* Rubinius support for Geos integration.
+* Rubinius support for GEOS integration.
 
 Additionally, not all implemented features are well-tested yet. In
 general, we currently consider this library to be "pre-alpha" quality,
@@ -102,6 +106,15 @@ RGeo is written by Daniel Azuma (http://www.daniel-azuma.com/).
 
 Development of RGeo is sponsored by GeoPage, Inc. (http://www.geopage.com/).
 
+RGeo links with the Open Source Geospatial Foundation's GEOS library to
+handle most Cartesian geometric calculations. GEOS and many other OSGeo
+projects can be found on OSGeo's web site (http://www.osgeo.org/).
+
+The ActiveRecord adapters owe some debt to the spatial_adapter plugin
+(http://github.com/fragility/spatial_adapter). We made a few different
+design decisions for RGeo, but studying the spatial_adapter source gave us
+a head start on our implementation.
+
 === License
 
 Copyright 2010 Daniel Azuma

data/Version

@@ -1 +1 @@
-0.1.16
+0.1.17

data/lib/active_record/connection_adapters/mysql2spatial_adapter.rb

@@ -0,0 +1,124 @@
+# -----------------------------------------------------------------------------
+# 
+# MysqlSpatial adapter for ActiveRecord
+# 
+# -----------------------------------------------------------------------------
+# 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/active_record/mysql_common'
+require 'active_record/connection_adapters/mysql2_adapter'
+
+
+module ActiveRecord  # :nodoc:
+  
+  class Base  # :nodoc:
+    
+    
+    def self.mysql2spatial_connection(config_)  # :nodoc:
+      config_[:username] = 'root' if config_[:username].nil?
+      if ::Mysql2::Client.const_defined?(:FOUND_ROWS)
+        config_[:flags] = ::Mysql2::Client::FOUND_ROWS
+      end
+      client_ = ::Mysql2::Client.new(config_.symbolize_keys)
+      options_ = [config_[:host], config_[:username], config_[:password], config_[:database], config_[:port], config_[:socket], 0]
+      ConnectionAdapters::Mysql2SpatialAdapter.new(client_, logger, options_, config_)
+    end
+    
+    
+  end
+  
+  
+  module ConnectionAdapters
+    
+    class Mysql2SpatialAdapter < Mysql2Adapter
+      
+      
+      class SpatialColumn < ConnectionAdapters::Mysql2Column
+        
+        include ::RGeo::ActiveRecord::MysqlCommon::ColumnMethods
+        
+      end
+      
+      
+      include ::RGeo::ActiveRecord::MysqlCommon::AdapterMethods
+      
+      
+      ADAPTER_NAME = 'Mysql2Spatial'.freeze
+      
+      NATIVE_DATABASE_TYPES = Mysql2Adapter::NATIVE_DATABASE_TYPES.merge(:geometry => {:name => "geometry"}, :point => {:name => "point"}, :line_string => {:name => "linestring"}, :polygon => {:name => "polygon"}, :geometry_collection => {:name => "geometrycollection"}, :multi_point => {:name => "multipoint"}, :multi_line_string => {:name => "multilinestring"}, :multi_polygon => {:name => "multipolygon"})
+      
+      
+      def native_database_types
+        NATIVE_DATABASE_TYPES
+      end
+      
+      
+      def adapter_name
+        ADAPTER_NAME
+      end
+      
+      
+      def columns(table_name_, name_=nil)
+        result_ = execute("SHOW FIELDS FROM #{quote_table_name(table_name_)}", :skip_logging)
+        columns_ = []
+        result_.each(:symbolize_keys => true, :as => :hash) do |field_|
+          columns_ << SpatialColumn.new(field_[:Field], field_[:Default], field_[:Type], field_[:Null] == "YES")
+        end
+        columns_
+      end
+      
+      
+      def indexes(table_name_, name_=nil)
+        indexes_ = []
+        current_index_ = nil
+        result_ = execute("SHOW KEYS FROM #{quote_table_name(table_name_)}", name_)
+        result_.each(:symbolize_keys => true, :as => :hash) do |row_|
+          if current_index_ != row_[:Key_name]
+            next if row_[:Key_name] == 'PRIMARY' # skip the primary key
+            current_index_ = row_[:Key_name]
+            new_index_ = ::RGeo::ActiveRecord::MysqlCommon::IndexDefinition.new(row_[:Table], row_[:Key_name], row_[:Non_unique] == 0, [], [])
+            new_index_.spatial = row_[:Index_type] == 'SPATIAL'
+            indexes_ << new_index_
+          end
+          indexes_.last.columns << row_[:Column_name]
+          indexes_.last.lengths << row_[:Sub_part]
+        end
+        indexes_
+      end
+      
+      
+    end
+    
+  end
+  
+  
+end

data/lib/active_record/connection_adapters/mysqlspatial_adapter.rb

@@ -0,0 +1,134 @@
+# -----------------------------------------------------------------------------
+# 
+# MysqlSpatial adapter for ActiveRecord
+# 
+# -----------------------------------------------------------------------------
+# 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/active_record/mysql_common'
+require 'active_record/connection_adapters/mysql_adapter'
+
+
+module ActiveRecord  # :nodoc:
+  
+  class Base  # :nodoc:
+    
+    
+    def self.mysqlspatial_connection(config_)  # :nodoc:
+      unless defined?(::Mysql)
+        begin
+          require 'mysql'
+        rescue ::LoadError
+          raise "!!! Missing the mysql gem. Add it to your Gemfile: gem 'mysql'"
+        end
+        unless defined?(::Mysql::Result) && ::Mysql::Result.method_defined?(:each_hash)
+          raise "!!! Outdated mysql gem. Upgrade to 2.8.1 or later. In your Gemfile: gem 'mysql', '2.8.1'. Or use gem 'mysql2'"
+        end
+      end
+      config_ = config_.symbolize_keys
+      mysql_ = ::Mysql.init
+      mysql_.ssl_set(config_[:sslkey], config_[:sslcert], config_[:sslca], config_[:sslcapath], config_[:sslcipher]) if config_[:sslca] || config_[:sslkey]
+      default_flags_ = ::Mysql.const_defined?(:CLIENT_MULTI_RESULTS) ? ::Mysql::CLIENT_MULTI_RESULTS : 0
+      default_flags_ |= ::Mysql::CLIENT_FOUND_ROWS if ::Mysql.const_defined?(:CLIENT_FOUND_ROWS)
+      options_ = [config_[:host], config_[:username] ? config_[:username].to_s : 'root', config_[:password].to_s, config_[:database], config_[:port], config_[:socket], default_flags_]
+      ConnectionAdapters::MysqlSpatialAdapter.new(mysql_, logger, options_, config_)
+    end
+    
+    
+  end
+  
+  
+  module ConnectionAdapters
+    
+    class MysqlSpatialAdapter < MysqlAdapter
+      
+      
+      class SpatialColumn < ConnectionAdapters::MysqlColumn
+        
+        include ::RGeo::ActiveRecord::MysqlCommon::ColumnMethods
+        
+      end
+      
+      
+      include ::RGeo::ActiveRecord::MysqlCommon::AdapterMethods
+      
+      
+      ADAPTER_NAME = 'MysqlSpatial'.freeze
+      
+      NATIVE_DATABASE_TYPES = MysqlAdapter::NATIVE_DATABASE_TYPES.merge(:geometry => {:name => "geometry"}, :point => {:name => "point"}, :line_string => {:name => "linestring"}, :polygon => {:name => "polygon"}, :geometry_collection => {:name => "geometrycollection"}, :multi_point => {:name => "multipoint"}, :multi_line_string => {:name => "multilinestring"}, :multi_polygon => {:name => "multipolygon"})
+      
+      
+      def native_database_types
+        NATIVE_DATABASE_TYPES
+      end
+      
+      
+      def adapter_name
+        ADAPTER_NAME
+      end
+      
+      
+      def columns(table_name_, name_=nil)
+        result_ = execute("SHOW FIELDS FROM #{quote_table_name(table_name_)}", :skip_logging)
+        columns_ = []
+        result_.each{ |field_| columns_ << SpatialColumn.new(field_[0], field_[4], field_[1], field_[2] == "YES") }
+        result_.free
+        columns_
+      end
+      
+      
+      def indexes(table_name_, name_=nil)
+        indexes_ = []
+        current_index_ = nil
+        result_ = execute("SHOW KEYS FROM #{quote_table_name(table_name_)}", name_)
+        result_.each do |row_|
+          if current_index_ != row_[2]
+            next if row_[2] == "PRIMARY" # skip the primary key
+            current_index_ = row_[2]
+            new_index_ = ::RGeo::ActiveRecord::MysqlCommon::IndexDefinition.new(row_[0], row_[2], row_[1] == "0", [], [])
+            new_index_.spatial = row_[10] == 'SPATIAL'
+            indexes_ << new_index_
+          end
+          indexes_.last.columns << row_[4]
+          indexes_.last.lengths << row_[7]
+        end
+        result_.free
+        indexes_
+      end
+      
+      
+    end
+    
+  end
+  
+  
+end

data/lib/rgeo/active_record/arel_modifications.rb

@@ -0,0 +1,73 @@
+# -----------------------------------------------------------------------------
+# 
+# Mysqlgeo adapter for ActiveRecord
+# 
+# -----------------------------------------------------------------------------
+# 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 'arel'
+
+
+module Arel
+  
+  module Attributes
+    
+    class Geometry < Attribute; end
+    
+    class << self
+      alias_method :for_without_geometry, :for
+      def for(column_)
+        column_.type == :geometry ? Geometry : for_without_geometry(column_)
+      end
+    end
+    
+  end
+  
+  module Visitors
+    
+    class Dot
+      alias :visit_Arel_Attributes_Geometry :visit_Arel_Attribute
+      alias :visit_RGeo_Features_Geometry :visit_String
+    end
+    
+    class ToSql
+      alias :visit_Arel_Attributes_Geometry :visit_Arel_Attributes_Attribute
+      alias :visit_RGeo_Features_Geometry :visit_String
+    end
+    
+    VISITORS['postgis'] = ::Arel::Visitors::PostgreSQL
+    VISITORS['mysqlspatial'] = ::Arel::Visitors::MySQL
+    VISITORS['spatialite'] = ::Arel::Visitors::SQLite
+    
+  end
+  
+end

data/lib/rgeo/active_record/base_modifications.rb

@@ -0,0 +1,72 @@
+# -----------------------------------------------------------------------------
+# 
+# Mysqlgeo adapter for ActiveRecord
+# 
+# -----------------------------------------------------------------------------
+# 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 'active_record'
+
+
+module ActiveRecord  # :nodoc:
+  
+  class Base  # :nodoc:
+    
+    self.attribute_types_cached_by_default << :geometry
+    
+    class_attribute :rgeo_default_factory, :instance_writer => false
+    self.rgeo_default_factory = nil
+    
+    class_attribute :rgeo_factory_generator, :instance_writer => false
+    self.rgeo_factory_generator = nil
+    
+    def self.to_generate_rgeo_factory(&block_)
+      self.rgeo_factory_generator = block_
+    end
+    
+    class << self
+      
+      alias_method :columns_without_rgeo_modification, :columns
+      def columns
+        unless defined?(@columns) && @columns
+          columns_without_rgeo_modification.each do |column_|
+            column_.ar_class = self if column_.respond_to?(:ar_class=)
+          end
+        end
+        @columns
+      end
+      
+    end
+    
+  end
+  
+end