activerecord-mysql2spatial-adapter 0.2.1 → 0.3.0

data/History.rdoc

@@ -1,3 +1,10 @@
+=== 0.3.0 / 2011-01-26
+
+* Reworked type and constraint handling, which should result in a large number of bug fixes, especially related to schema dumps.
+* Experimental support for complex spatial queries. (Requires Arel 2.1, which is expected to be released with Rails 3.1.)
+* The path to the Railtie is now different (see the README), though a compatibility wrapper has been left in the old location.
+* Reorganized the code a bit for better clarity.
+
 === 0.2.1 / 2010-12-27
 
 * Support for basic spatial equality queries. e.g. constructs such as:

data/README.rdoc

@@ -7,13 +7,9 @@ using the {RGeo}[http://github.com/dazuma/rgeo] library to represent
 spatial data in Ruby. Like the standard mysql2 adapter, this adapter
 requires the mysql2 gem.
 
-=== Usage
+== What This Adapter Provides
 
-To use this adapter, add this gem, "activerecord-mysql2spatial-adapter",
-to your Gemfile, and then request the adapter name "mysql2spatial" in
-your database connection configuration (which, for a Rails application,
-is in the config/database.yml file). The other database connection
-configuration parameters are the same as for the stock mysql2 adapter.
+=== Spatial Migrations
 
 First, this adapter extends the migration syntax to support creating 
 spatial columns and indexes. To create a spatial column, use the
@@ -25,24 +21,29 @@ column may need to be NOT NULL.
 
 Examples:
 
- create_table :spatial_table, :options => 'ENGINE=MyISAM' do |t|
-   t.column :latlon, :point, :null => false
-   t.line_string :path
-   t.geometry :shape
- end
- change_table :spatial_table do |t|
-   t.index :latlon, :spatial => true
- end
+  create_table :my_spatial_table, :options => 'ENGINE=MyISAM' do |t|
+    t.column :latlon, :point, :null => false
+    t.line_string :path
+    t.geometry :shape
+  end
+  change_table :my_spatial_table do |t|
+    t.index :latlon, :spatial => true
+  end
+
+=== Spatial Attributes
 
 When this adapter is in use, spatial attributes in your \ActiveRecord
 objects will have RGeo geometry values. You can set spatial attributes
 either to RGeo geometry objects, or to strings in WKT (well-known text)
 format, which the adapter will automatically convert to geometry objects.
 
-To specify the RGeo geometry factory, you can either set an explicit
-factory for a column, or provide a factory generator that will yield the
-appropriate factory for the table's spatial columns based on the value.
-For the former, call the set_rgeo_factory_for_column class method on your
+Spatial objects in RGeo are tied to a factory that specifies the
+coordinate system as well as other behaviors of the object. You must
+therefore specify a factory for each spatial column (attribute) in your
+ActiveRecord class. You can either set an explicit factory for a specific
+column, or provide a factory generator that will yield the appropriate
+factory for the table's spatial columns based on their types. For the
+former, call the <tt>set_rgeo_factory_for_column</tt> class method on your
 \ActiveRecord class. For the latter, set the rgeo_factory_generator class
 attribute. This generator should understand at least the <tt>:srid</tt>
 options, which will be provided based on the SRID embedded in the value
@@ -53,58 +54,98 @@ the "rgeo-activerecord" gem.
 
 Examples, given the spatial table defined above:
 
- class SpatialTable < ActiveRecord::Base
-   
-   # By default, use the GEOS implementation for spatial columns.
-   self.rgeo_factory_generator = RGeo::Geos.method(:factory)
-   
-   # But use a geographic implementation for the :latlon column.
-   set_rgeo_factory_for_column(:latlon, RGeo::Geographic.spherical_factory)
-   
- end
+  class MySpatialTable < ActiveRecord::Base
+    
+    # By default, use the GEOS implementation for spatial columns.
+    self.rgeo_factory_generator = RGeo::Geos.method(:factory)
+    
+    # But use a geographic implementation for the :latlon column.
+    set_rgeo_factory_for_column(:latlon, RGeo::Geographic.spherical_factory)
+    
+  end
 
 Now you can interact with the data using the RGeo types:
 
- rec = SpatialTable.new
- rec.latlon = 'POINT(-122 47)'   # You can set by feature object or WKT.
- loc = rec.latlon                # Accessing always returns a feature object, in
-                                 # this case, a geographic that understands latitude.
- loc.latitude                    # => 47
- rec.shape = loc                 # the factory for the :shape column is GEOS, so the
-                                 # value will be cast from geographic to GEOS.
- RGeo::Geos.is_geos?(rec.shape)  # => true
+  rec = MySpatialTable.new
+  rec.latlon = 'POINT(-122 47)'   # You can set by feature object or WKT.
+  loc = rec.latlon                # Accessing always returns a feature object, in
+                                  # this case, a geographic that understands latitude.
+  loc.latitude                    # => 47
+  rec.shape = loc                 # the factory for the :shape column is GEOS, so the
+                                  # value will be cast from geographic to GEOS.
+  RGeo::Geos.is_geos?(rec.shape)  # => true
+
+=== Spatial Queries
 
 You can create simple queries based on spatial equality in the same way
 you would on a scalar column:
 
- rec = SpatialTable.where(:latlon => RGeo::Geos.factory.point(-122, 47)).first
+  rec = MySpatialTable.where(:latlon => RGeo::Geos.factory.point(-122, 47)).first
 
 You can also use WKT:
 
- rec = SpatialTable.where(:latlon => 'POINT(-122 47)').first
+  rec = MySpatialTable.where(:latlon => 'POINT(-122 47)').first
+
+The adapter also provides experimental support for more complex queries
+such as radius searches. However, these extensions require Arel 2.1
+(which is scheduled for release with Rails 3.1). We do not have these
+documented yet, and the syntax is subject to change. For now, you should
+write more complex queries in SQL.
 
-Other types of queries currently must be written in SQL. However, we are
-investigating writing a set of Arel extensions for constructing arbitrary
-spatial queries.
+== Installation And Configuration
 
-=== Installation
+=== Installing The Adapter Gem
 
 This adapter has the following requirements:
 
 * Ruby 1.8.7 or later. Ruby 1.9.2 or later preferred.
 * MySQL server 5.0 or later required for spatial extensions.
 * \ActiveRecord 3.0.3 or later. Earlier versions will not work.
-* rgeo gem 0.2.3 or later.
-* rgeo-activerecord gem 0.2.1 or later.
+* rgeo gem 0.2.4 or later.
+* rgeo-activerecord gem 0.3.0 or later.
 * mysql2 gem 0.2.6 or later.
 
 Install this adapter as a gem:
 
- gem install activerecord-mysql2spatial-adapter
+  gem install activerecord-mysql2spatial-adapter
 
 See the README for the "rgeo" gem, a required dependency, for further
 installation information.
 
+=== Basic Setup
+
+To use this adapter, add this gem, "activerecord-mysql2spatial-adapter",
+to your Gemfile, and then request the adapter name "mysql2spatial" in
+your database connection configuration (which, for a Rails application,
+is in the config/database.yml file). The other database connection
+configuration parameters are the same as for the stock mysql2 adapter,
+so you can create a new Rails application using:
+
+  rails new my_app --database=mysql
+
+...and then just change the adapter name to "mysql2spatial".
+
+== Additional Information
+
+=== Known bugs and limitations
+
+This adapter is not yet well tested. There are probably some bugs and
+holes in the functionality. We aren't using MySQL spatial extensions in
+production at GeoPage, so we would appreciate testing help and feedback
+from anyone who is.
+
+One known issue is that if you want to use Rails's testing rake tasks and
+you have spatial indexes in your schema, you should use the <tt>:sql</tt>
+dump style. e.g. set <tt>config.active_record.schema_format = :sql</tt>.
+The reason is that Rails's Ruby-format schema dumper does not preserve
+the :options used to create the table, specifically setting the
+Engine=MyISAM. Under MySQL Spatial, you may create spatial indexes only
+on MyISAM tables; unfortunately, if you use the Ruby-format schema to
+create your test databases, Rails does not transfer this information
+properly, and your test tables are created as InnoDB. The workaround is
+to use the <tt>:sql</tt> dump format. This has been reported as a bug in
+Rails as of Rails 3.0.3, so we hope it will get rectified at some point.
+
 === Development and support
 
 Documentation is available at http://virtuoso.rubyforge.org/activerecord-mysql2spatial-adapter/README_rdoc.html
@@ -119,7 +160,8 @@ Contact the author at dazuma at gmail dot com.
 
 === Acknowledgments
 
-RGeo is written by Daniel Azuma (http://www.daniel-azuma.com).
+The Mysql2Spatial Adapter and its supporting libraries (including RGeo)
+are written by Daniel Azuma (http://www.daniel-azuma.com).
 
 Development of RGeo is sponsored by GeoPage, Inc. (http://www.geopage.com).
 

data/Version

@@ -1 +1 @@
-0.2.1
+0.3.0

data/lib/active_record/connection_adapters/mysql2spatial_adapter.rb

@@ -38,34 +38,6 @@ require 'rgeo/active_record'
 require 'active_record/connection_adapters/mysql2_adapter'
 
 
-# :stopdoc:
-
-module Arel
-  module Visitors
-    
-    class MySQL2Spatial < MySQL
-      
-      FUNC_MAP = {
-        'ST_WKTToSQL' => 'GeomFromText',
-        'ST_Equals' => 'Equals',
-      }
-      
-      include ::RGeo::ActiveRecord::SpatialToSql
-      
-      def st_func(standard_name_)
-        FUNC_MAP[standard_name_] || standard_name_
-      end
-      
-    end
-    
-    VISITORS['mysql2spatial'] = ::Arel::Visitors::MySQL2Spatial
-    
-  end
-end
-
-# :startdoc:
-
-
 # The activerecord-mysql2spatial-adapter gem installs the *mysql2spatial*
 # connection adapter into ActiveRecord.
 
@@ -87,153 +59,31 @@ module ActiveRecord
       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_)
+      ::ActiveRecord::ConnectionAdapters::Mysql2SpatialAdapter::MainAdapter.new(client_, logger, options_, config_)
     end
     
     
   end
   
   
-  module ConnectionAdapters  # :nodoc:
+  # All ActiveRecord adapters go in this namespace.
+  module ConnectionAdapters
     
-    class Mysql2SpatialAdapter < Mysql2Adapter  # :nodoc:
-      
+    # The Mysql2Spatial adapter
+    module Mysql2SpatialAdapter
       
+      # The name returned by the adapter_name method of this adapter.
       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 quote(value_, column_=nil)
-        if ::RGeo::Feature::Geometry.check_type(value_)
-          "GeomFromWKB(0x#{::RGeo::WKRep::WKBGenerator.new(:hex_format => true).generate(value_)},#{value_.srid})"
-        else
-          super
-        end
-      end
-      
-      
-      def add_index(table_name_, column_name_, options_={})
-        if options_[:spatial]
-          index_name_ = index_name(table_name_, :column => Array(column_name_))
-          if ::Hash === options_
-            index_name_ = options_[:name] || index_name_
-          end
-          execute "CREATE SPATIAL INDEX #{index_name_} ON #{table_name_} (#{Array(column_name_).join(", ")})"
-        else
-          super
-        end
-      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]
-            indexes_ << ::RGeo::ActiveRecord::SpatialIndexDefinition.new(row_[:Table], row_[:Key_name], row_[:Non_unique] == 0, [], [], row_[:Index_type] == 'SPATIAL')
-          end
-          indexes_.last.columns << row_[:Column_name]
-          indexes_.last.lengths << row_[:Sub_part]
-        end
-        indexes_
-      end
-      
-      
-      class SpatialColumn < ConnectionAdapters::Mysql2Column  # :nodoc:
-        
-        
-        def initialize(name_, default_, sql_type_=nil, null_=true)
-          super(name_, default_,sql_type_, null_)
-          @geometric_type = ::RGeo::ActiveRecord.geometric_type_from_name(sql_type_)
-          @ar_class = ::ActiveRecord::Base
-        end
-        
-        
-        def set_ar_class(val_)
-          @ar_class = val_
-        end
-        
-        
-        attr_reader :geometric_type
-        
-        
-        def spatial?
-          type == :geometry
-        end
-        
-        
-        def klass
-          type == :geometry ? ::RGeo::Feature::Geometry : super
-        end
-        
-        
-        def type_cast(value_)
-          type == :geometry ? SpatialColumn.convert_to_geometry(value_, @ar_class, name) : super
-        end
-        
-        
-        def type_cast_code(var_name_)
-          type == :geometry ? "::ActiveRecord::ConnectionAdapters::Mysql2SpatialAdapter::SpatialColumn.convert_to_geometry(#{var_name_}, self.class, #{name.inspect})" : super
-        end
-        
-        
-        private
-        
-        def simplified_type(sql_type_)
-          sql_type_ =~ /geometry|point|linestring|polygon/i ? :geometry : super
-        end
-        
-        
-        def self.convert_to_geometry(input_, ar_class_, column_)
-          case input_
-          when ::RGeo::Feature::Geometry
-            factory_ = ar_class_.rgeo_factory_for_column(column_, :srid => input_.srid)
-            ::RGeo::Feature.cast(input_, factory_)
-          when ::String
-            marker_ = input_[4,1]
-            if marker_ == "\x00" || marker_ == "\x01"
-              factory_ = ar_class_.rgeo_factory_for_column(column_, :srid => input_[0,4].unpack(marker_ == "\x01" ? 'V' : 'N').first)
-              ::RGeo::WKRep::WKBParser.new(factory_).parse(input_[4..-1])
-            else
-              factory_ = ar_class_.rgeo_factory_for_column(column_)
-              ::RGeo::WKRep::WKTParser.new(factory_, :support_ewkt => true).parse(input_)
-            end
-          else
-            nil
-          end
-        end
-        
-        
-      end
-      
-      
     end
     
   end
   
   
 end
+
+
+require 'active_record/connection_adapters/mysql2spatial_adapter/version.rb'
+require 'active_record/connection_adapters/mysql2spatial_adapter/main_adapter.rb'
+require 'active_record/connection_adapters/mysql2spatial_adapter/spatial_column.rb'
+require 'active_record/connection_adapters/mysql2spatial_adapter/arel_tosql.rb'

data/lib/active_record/connection_adapters/mysql2spatial_adapter/arel_tosql.rb

@@ -0,0 +1,69 @@
+# -----------------------------------------------------------------------------
+# 
+# Mysql2Spatial 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.
+# -----------------------------------------------------------------------------
+;
+
+
+# :stopdoc:
+
+module Arel
+  module Visitors
+    
+    class MySQL2Spatial < MySQL
+      
+      FUNC_MAP = {
+        'st_wkttosql' => 'GeomFromText',
+        'st_wkbtosql' => 'GeomFromWKB',
+        'st_length' => 'GLength',
+      }
+      
+      include ::RGeo::ActiveRecord::SpatialToSql
+      
+      def st_func(standard_name_)
+        if (name_ = FUNC_MAP[standard_name_.downcase])
+          name_
+        elsif standard_name_ =~ /^st_(\w+)$/i
+          $1
+        else
+          standard_name_
+        end
+      end
+      
+    end
+    
+    VISITORS['mysql2spatial'] = ::Arel::Visitors::MySQL2Spatial
+    
+  end
+end
+
+# :startdoc:

data/lib/active_record/connection_adapters/mysql2spatial_adapter/main_adapter.rb

@@ -0,0 +1,136 @@
+# -----------------------------------------------------------------------------
+# 
+# Mysql2Spatial 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.
+# -----------------------------------------------------------------------------
+;
+
+
+# :stopdoc:
+
+module ActiveRecord
+  
+  module ConnectionAdapters
+    
+    module Mysql2SpatialAdapter
+      
+      
+      class MainAdapter < ConnectionAdapters::Mysql2Adapter
+        
+        
+        NATIVE_DATABASE_TYPES = Mysql2Adapter::NATIVE_DATABASE_TYPES.merge(:spatial => {:name => "geometry"})
+        
+        
+        def adapter_name
+          Mysql2SpatialAdapter::ADAPTER_NAME
+        end
+        
+        
+        def spatial_column_constructor(name_)
+          ::RGeo::ActiveRecord::DEFAULT_SPATIAL_COLUMN_CONSTRUCTORS[name_]
+        end
+        
+        
+        def native_database_types
+          NATIVE_DATABASE_TYPES
+        end
+        
+        
+        def quote(value_, column_=nil)
+          if ::RGeo::Feature::Geometry.check_type(value_)
+            "GeomFromWKB(0x#{::RGeo::WKRep::WKBGenerator.new(:hex_format => true).generate(value_)},#{value_.srid})"
+          else
+            super
+          end
+        end
+        
+        
+        def type_to_sql(type_, limit_=nil, precision_=nil, scale_=nil)
+          if (info_ = spatial_column_constructor(type_.to_sym))
+            type_ = limit_[:type] || type_ if limit_.is_a?(::Hash)
+            type_ = 'geometry' if type_.to_s == 'spatial'
+            type_ = type_.to_s.gsub('_', '').upcase
+          end
+          super(type_, limit_, precision_, scale_)
+        end
+        
+        
+        def add_index(table_name_, column_name_, options_={})
+          if options_[:spatial]
+            index_name_ = index_name(table_name_, :column => Array(column_name_))
+            if ::Hash === options_
+              index_name_ = options_[:name] || index_name_
+            end
+            execute "CREATE SPATIAL INDEX #{index_name_} ON #{table_name_} (#{Array(column_name_).join(", ")})"
+          else
+            super
+          end
+        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]
+              indexes_ << ::RGeo::ActiveRecord::SpatialIndexDefinition.new(row_[:Table], row_[:Key_name], row_[:Non_unique] == 0, [], [], row_[:Index_type] == 'SPATIAL')
+            end
+            last_index_ = indexes_.last
+            last_index_.columns << row_[:Column_name]
+            last_index_.lengths << row_[:Sub_part] unless last_index_.spatial
+          end
+          indexes_
+        end
+      
+        
+      end
+      
+      
+    end
+    
+  end
+  
+end
+
+# :startdoc:

data/lib/active_record/connection_adapters/mysql2spatial_adapter/spatial_column.rb

@@ -0,0 +1,123 @@
+# -----------------------------------------------------------------------------
+# 
+# Mysql2Spatial 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.
+# -----------------------------------------------------------------------------
+;
+
+
+# :stopdoc:
+
+module ActiveRecord
+  
+  module ConnectionAdapters
+    
+    module Mysql2SpatialAdapter
+      
+      
+      class SpatialColumn < ConnectionAdapters::Mysql2Column
+        
+        
+        def initialize(name_, default_, sql_type_=nil, null_=true)
+          super(name_, default_,sql_type_, null_)
+          @geometric_type = ::RGeo::ActiveRecord.geometric_type_from_name(sql_type_)
+          if type == :spatial
+            @limit = {:type => @geometric_type.type_name.underscore}
+          end
+          @ar_class = ::ActiveRecord::Base
+        end
+        
+        
+        def set_ar_class(val_)
+          @ar_class = val_
+        end
+        
+        
+        attr_reader :geometric_type
+        
+        
+        def spatial?
+          type == :spatial
+        end
+        
+        
+        def klass
+          type == :spatial ? ::RGeo::Feature::Geometry : super
+        end
+        
+        
+        def type_cast(value_)
+          type == :spatial ? SpatialColumn.convert_to_geometry(value_, @ar_class, name) : super
+        end
+        
+        
+        def type_cast_code(var_name_)
+          type == :spatial ? "::ActiveRecord::ConnectionAdapters::Mysql2SpatialAdapter::SpatialColumn.convert_to_geometry(#{var_name_}, self.class, #{name.inspect})" : super
+        end
+        
+        
+        private
+        
+        def simplified_type(sql_type_)
+          sql_type_ =~ /geometry|point|linestring|polygon/i ? :spatial : super
+        end
+        
+        
+        def self.convert_to_geometry(input_, ar_class_, column_)
+          case input_
+          when ::RGeo::Feature::Geometry
+            factory_ = ar_class_.rgeo_factory_for_column(column_, :srid => input_.srid)
+            ::RGeo::Feature.cast(input_, factory_)
+          when ::String
+            marker_ = input_[4,1]
+            if marker_ == "\x00" || marker_ == "\x01"
+              factory_ = ar_class_.rgeo_factory_for_column(column_, :srid => input_[0,4].unpack(marker_ == "\x01" ? 'V' : 'N').first)
+              ::RGeo::WKRep::WKBParser.new(factory_).parse(input_[4..-1])
+            else
+              factory_ = ar_class_.rgeo_factory_for_column(column_)
+              ::RGeo::WKRep::WKTParser.new(factory_, :support_ewkt => true).parse(input_)
+            end
+          else
+            nil
+          end
+        end
+        
+        
+      end
+      
+      
+    end
+    
+  end
+  
+end
+
+# :startdoc:

data/lib/active_record/connection_adapters/mysql2spatial_adapter/version.rb

@@ -0,0 +1,62 @@
+# -----------------------------------------------------------------------------
+# 
+# Mysql2Spatial 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.
+# -----------------------------------------------------------------------------
+;
+
+
+begin
+  require 'versionomy'
+rescue ::LoadError
+end
+
+
+module ActiveRecord
+  
+  module ConnectionAdapters
+    
+    module Mysql2SpatialAdapter
+      
+      
+      # Current version of Mysql2SpatialAdapter as a frozen string
+      VERSION_STRING = ::File.read(::File.dirname(__FILE__)+'/../../../../Version').strip.freeze
+      
+      # Current version of Mysql2SpatialAdapter as a Versionomy object, if the
+      # Versionomy gem is available; otherwise equal to VERSION_STRING.
+      VERSION = defined?(::Versionomy) ? ::Versionomy.parse(VERSION_STRING) : VERSION_STRING
+      
+      
+    end
+    
+  end
+  
+end

data/test/tc_basic.rb

@@ -62,6 +62,11 @@ module RGeo
             end
             
             
+            def test_version
+              assert_not_nil(::ActiveRecord::ConnectionAdapters::Mysql2SpatialAdapter::VERSION)
+            end
+            
+            
             def test_create_simple_geometry
               klass_ = create_ar_class
               klass_.connection.create_table(:spatial_test) do |t_|
@@ -161,29 +166,33 @@ module RGeo
             end
             
             
-            def test_query_point
-              klass_ = populate_ar_class(:latlon_point)
-              obj_ = klass_.new
-              obj_.latlon = @factory.point(1, 2)
-              obj_.save!
-              id_ = obj_.id
-              obj2_ = klass_.where(:latlon => @factory.multi_point([@factory.point(1, 2)])).first
-              assert_equal(id_, obj2_.id)
-              obj3_ = klass_.where(:latlon => @factory.point(2, 2)).first
-              assert_nil(obj3_)
+            def test_create_simple_geometry_using_shortcut
+              klass_ = create_ar_class
+              klass_.connection.create_table(:spatial_test) do |t_|
+                t_.geometry 'latlon'
+              end
+              assert_equal(::RGeo::Feature::Geometry, klass_.columns.last.geometric_type)
+              assert(klass_.cached_attributes.include?('latlon'))
             end
             
             
-            def test_query_point_wkt
-              klass_ = populate_ar_class(:latlon_point)
-              obj_ = klass_.new
-              obj_.latlon = @factory.point(1, 2)
-              obj_.save!
-              id_ = obj_.id
-              obj2_ = klass_.where(:latlon => 'POINT(1 2)').first
-              assert_equal(id_, obj2_.id)
-              obj3_ = klass_.where(:latlon => 'POINT(2 2)').first
-              assert_nil(obj3_)
+            def test_create_point_geometry_using_shortcut
+              klass_ = create_ar_class
+              klass_.connection.create_table(:spatial_test) do |t_|
+                t_.point 'latlon'
+              end
+              assert_equal(::RGeo::Feature::Point, klass_.columns.last.geometric_type)
+              assert(klass_.cached_attributes.include?('latlon'))
+            end
+            
+            
+            def test_create_geometry_using_limit
+              klass_ = create_ar_class
+              klass_.connection.create_table(:spatial_test) do |t_|
+                t_.spatial 'geom', :limit => {:type => :line_string}
+              end
+              assert_equal(::RGeo::Feature::LineString, klass_.columns.last.geometric_type)
+              assert(klass_.cached_attributes.include?('geom'))
             end
             
             

data/test/tc_spatial_queries.rb

@@ -0,0 +1,125 @@
+# -----------------------------------------------------------------------------
+# 
+# Tests for the Mysql2Spatial ActiveRecord adapter
+# 
+# -----------------------------------------------------------------------------
+# 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 'test/unit'
+require 'rgeo/active_record/adapter_test_helper'
+
+
+module RGeo
+  module ActiveRecord  # :nodoc:
+    module Mysql2SpatialAdapter  # :nodoc:
+      module Tests  # :nodoc:
+        
+        class TestSpatialQueries < ::Test::Unit::TestCase  # :nodoc:
+          
+          DATABASE_CONFIG_PATH = ::File.dirname(__FILE__)+'/database.yml'
+          include AdapterTestHelper
+          
+          define_test_methods do
+            
+            
+            def populate_ar_class(content_)
+              klass_ = create_ar_class
+              case content_
+              when :latlon_point
+                klass_.connection.create_table(:spatial_test) do |t_|
+                  t_.column 'latlon', :point
+                end
+              when :path_linestring
+                klass_.connection.create_table(:spatial_test) do |t_|
+                  t_.column 'path', :line_string
+                end
+              end
+              klass_
+            end
+            
+            
+            def test_query_point
+              klass_ = populate_ar_class(:latlon_point)
+              obj_ = klass_.new
+              obj_.latlon = @factory.point(1, 2)
+              obj_.save!
+              id_ = obj_.id
+              obj2_ = klass_.where(:latlon => @factory.multi_point([@factory.point(1, 2)])).first
+              assert_equal(id_, obj2_.id)
+              obj3_ = klass_.where(:latlon => @factory.point(2, 2)).first
+              assert_nil(obj3_)
+            end
+            
+            
+            def test_query_point_wkt
+              klass_ = populate_ar_class(:latlon_point)
+              obj_ = klass_.new
+              obj_.latlon = @factory.point(1, 2)
+              obj_.save!
+              id_ = obj_.id
+              obj2_ = klass_.where(:latlon => 'POINT(1 2)').first
+              assert_equal(id_, obj2_.id)
+              obj3_ = klass_.where(:latlon => 'POINT(2 2)').first
+              assert_nil(obj3_)
+            end
+            
+            
+            if ::RGeo::ActiveRecord.spatial_expressions_supported?
+              
+              
+              def test_query_st_length
+                klass_ = populate_ar_class(:path_linestring)
+                obj_ = klass_.new
+                obj_.path = @factory.line(@factory.point(1, 2), @factory.point(3, 2))
+                obj_.save!
+                id_ = obj_.id
+                obj2_ = klass_.where(klass_.arel_table[:path].st_length.eq(2)).first
+                assert_equal(id_, obj2_.id)
+                obj3_ = klass_.where(klass_.arel_table[:path].st_length.gt(3)).first
+                assert_nil(obj3_)
+              end
+              
+              
+            else
+              
+              puts "WARNING: The current Arel does not support named functions. Spatial expression tests skipped."
+              
+            end
+            
+            
+          end
+          
+        end
+        
+      end
+    end
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Daniel Azuma
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-27 00:00:00 -08:00
+date: 2011-01-26 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -23,13 +23,13 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 2
-        - 1
-        version: 0.2.1
+        - 3
+        - 0
+        version: 0.3.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -57,10 +57,15 @@ extra_rdoc_files:
 - History.rdoc
 - README.rdoc
 files: 
+- lib/active_record/connection_adapters/mysql2spatial_adapter/arel_tosql.rb
+- lib/active_record/connection_adapters/mysql2spatial_adapter/main_adapter.rb
+- lib/active_record/connection_adapters/mysql2spatial_adapter/spatial_column.rb
+- lib/active_record/connection_adapters/mysql2spatial_adapter/version.rb
 - lib/active_record/connection_adapters/mysql2spatial_adapter.rb
 - History.rdoc
 - README.rdoc
 - test/tc_basic.rb
+- test/tc_spatial_queries.rb
 - Version
 has_rdoc: true
 homepage: http://virtuoso.rubyforge.org/activerecord-mysql2spatial-adapter
@@ -98,3 +103,4 @@ specification_version: 3
 summary: An ActiveRecord adapter for MySQL Spatial Extensions, based on RGeo and the mysql2 gem.
 test_files: 
 - test/tc_basic.rb
+- test/tc_spatial_queries.rb