spatial_adapter 1.2.0 → 1.3.0

data/.gitignore

@@ -0,0 +1,3 @@
+.rvmrc
+Gemfile.lock
+pkg/

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.rdoc

@@ -16,7 +16,7 @@ The following gems are required:
 For PostgreSQL:
 
 - PostGIS version 1.4.0 or higher should be installed in your database
- 
+
 == Installation
 
 Choose ONE of the following installation methods.  You shouldn't have to do both.
@@ -27,15 +27,15 @@ This is the preferred method of installation, and will pull in the required
 dependencies as well.
 
   gem install spatial_adapter
-  
+
 In a Rails 2.x app, you can add a gem dependency in environment.rb:
 
   config.gem 'spatial_adapter'
-  
+
 In a Rails 3 app, add a gem dependency to Gemfile:
 
   gem 'spatial_adapter'
-  
+
 === As a Rails Plugin
 
 In your Rails project, run the following:
@@ -50,18 +50,20 @@ Choose the database type for which you would like to use spatial_adapter, and
 load each with
 
   require 'spatial_adapter/[database]'
-  
+
 where [database] should be replaced with one of the following:
 
 - postgresql
 - mysql
-  
+- mysql2
+- jdbcmysql
+
 For example to use the PostgreSQL spatial adapter:
 
   require 'spatial_adapter/postgresql'
-  
-In a Rails app, spatial_adapter will automatically load the adapter for the database
-specified in your database.yml configuration.
+
+In a Rails app, spatial_adapter will automatically load the adapter for the
+database specified in your database.yml configuration.
 
 == Operations
 
@@ -73,13 +75,13 @@ and loaded in migrations the same way as columns of basic types.
 
 Here is an example of code for the creation of a table with a geometric column
 in PostGIS, along with the addition of a spatial index on the column:
- 
+
   ActiveRecord::Schema.define do
     create_table :table_points, :force => true do |t|
       t.string :data
       t.point :geom, :null => false, :srid => 123, :with_z => true
     end
-  
+
     add_index :table_points, :geom, :spatial => true
   end
 
@@ -90,15 +92,15 @@ Here is a related statement valid for MySql version <= 5.0.16:
       t.string :data
       t.point :geom, :null => false
     end
-  
+
     add_index :table_points, :geom, :spatial => true
   end
-  
+
 === Differences Between Databases
 
-- On all versions of MySQL, the :srid, :with_z, and :with_m options are ignored, since
-  they are not supported. 
-  
+- On all versions of MySQL, the :srid, :with_z, and :with_m options are ignored,
+  since they are not supported.
+
 - On MySQL versions <= 5.0.16, you have to add <tt>:options =>
   "ENGINE=MyISAM"</tt> to the create_table statement, since only MyISAM tables
   can have spatial columns.  In addition, only MyISAM tables may have spatial
@@ -161,7 +163,7 @@ library (http://georuby.rubyforge.org/): This is where the
 
     place = Place.find_first
     place.the_geom.y=123456.7 # this doesn't work
- 
+
   Since the translation to a geometry is performed every time the_geom is read,
   the change to y will not be saved! You would have to do something like this:
 
@@ -195,3 +197,14 @@ These will hopefully be added back in the near future.
 
 Any questions, enhancement proposals, bug notifications or corrections can be
 made via the project page at http://github.com/fragility/spatial_adapter
+
+== Running Tests
+
+The gem depdencencies can be installed with `bundle install`.
+
+You will need to set up an empty database named `spatial_adapter` for each
+adapter you want to test.
+
+Tests are partitioned by adapter and can be run using separate rake task.
+
+    bundle exec rake spec:[adapter]

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+[:mysql, :mysql2, :jdbcmysql, :postgresql].each do |adapter|
+  desc "Run specs for #{adapter} adapter"
+  RSpec::Core::RakeTask.new("spec:#{adapter.to_s}") do |t|
+    t.pattern = "spec/#{adapter}_spec.rb"
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/lib/spatial_adapter/base/mysql/adapter.rb

@@ -0,0 +1,54 @@
+module SpatialAdapter::Base::Mysql
+  module Adapter
+    GEOMETRY_REGEXP = /geometry|point|linestring|polygon|multipoint|multilinestring|multipolygon|geometrycollection/i
+
+    def supports_geographic?
+      false
+    end
+
+    def self.included klass
+      klass.class_eval do
+        def native_database_types
+          (defined?(NATIVE_DATABASE_TYPES) ? NATIVE_DATABASE_TYPES : super()) \
+            .merge(SpatialAdapter.geometry_data_types)
+        end
+
+        # Redefines the quote method to add behaviour for when a Geometry is
+        # encountered ; used when binding variables in find_by methods
+        def quote(value, column = nil)
+          if value.kind_of?(GeoRuby::SimpleFeatures::Geometry)
+            "GeomFromWKB(0x#{value.as_hex_wkb},#{value.srid})"
+          else
+            super(value,column)
+          end
+        end
+
+        #Redefines add_index to support the case where the index is spatial
+        #If the :spatial key in the options table is true, then the sql string for a spatial index is created
+        def add_index(table_name,column_name,options = {})
+          index_name = options[:name] || index_name(table_name,:column => Array(column_name))
+
+          if options[:spatial]
+            execute "CREATE SPATIAL INDEX #{index_name} ON #{table_name} (#{Array(column_name).join(", ")})"
+          else
+            super
+          end
+        end
+      end
+    end
+
+    private
+
+    def show_table_status_like(table)
+      execute("SHOW TABLE STATUS LIKE '#{table}'")
+    end
+
+    def show_fields_from(table, name = nil)
+      execute("SHOW FIELDS FROM #{quote_table_name(table)}", name)
+    end
+
+    def show_keys_from(table, name = nil)
+      execute("SHOW KEYS FROM #{quote_table_name(table)}", name) || []
+    end
+  end
+end

data/lib/spatial_adapter/base/mysql/spatial_column.rb

@@ -0,0 +1,12 @@
+module SpatialAdapter::Base::Mysql
+  module SpatialColumn
+    def string_to_geometry(string)
+      return string unless string.is_a?(String)
+      begin
+        GeoRuby::SimpleFeatures::Geometry.from_ewkb(string[4..-1])
+      rescue Exception => exception
+        nil
+      end
+    end
+  end
+end

data/lib/spatial_adapter/base/mysql.rb

@@ -0,0 +1,9 @@
+module SpatialAdapter
+  module Base
+    module Mysql
+    end
+  end
+end
+
+require 'spatial_adapter/base/mysql/adapter'
+require 'spatial_adapter/base/mysql/spatial_column'

data/lib/spatial_adapter/common/schema_dumper.rb

@@ -3,7 +3,7 @@ ActiveRecord::SchemaDumper.ignore_tables << "spatial_ref_sys" << "geometry_colum
 ActiveRecord::SchemaDumper.class_eval do
   # These are the valid options for a column specification (spatial options added)
   VALID_COLUMN_SPEC_KEYS = [:name, :limit, :precision, :scale, :default, :null, :srid, :with_z, :with_m, :geographic]
-  
+
   def table(table, stream)
     columns = @connection.columns(table)
     begin
@@ -15,7 +15,7 @@ ActiveRecord::SchemaDumper.class_eval do
       elsif @connection.respond_to?(:primary_key)
         pk = @connection.primary_key(table)
       end
-      
+
       tbl.print "  create_table #{table.inspect}"
       if columns.detect { |c| c.name == pk }
         if pk != 'id'
@@ -24,13 +24,13 @@ ActiveRecord::SchemaDumper.class_eval do
       else
         tbl.print ", :id => false"
       end
-      
+
       # Added by Spatial Adapter to ensure correct MySQL table engine
       if @connection.respond_to?(:options_for)
         res = @connection.options_for(table)
         tbl.print ", :options=>'#{res}'" if res
       end
-      
+
       tbl.print ", :force => true"
       tbl.puts " do |t|"
 
@@ -69,7 +69,7 @@ ActiveRecord::SchemaDumper.class_eval do
 
       tbl.puts "  end"
       tbl.puts
-      
+
       indexes(table, tbl)
 
       tbl.rewind
@@ -79,10 +79,10 @@ ActiveRecord::SchemaDumper.class_eval do
       stream.puts "#   #{e.message}"
       stream.puts
     end
-    
+
     stream
   end
-  
+
 
   def indexes(table, stream)
     if (indexes = @connection.indexes(table)).any?
@@ -101,14 +101,14 @@ ActiveRecord::SchemaDumper.class_eval do
       stream.puts
     end
   end
-  
+
   private
-  
+
   # Build specification for a table column
   def column_spec(column)
     spec = {}
     spec[:name]      = column.name.inspect
-    
+
     # AR has an optimisation which handles zero-scale decimals as integers.  This
     # code ensures that the dumper still dumps the column as a decimal.
     spec[:type]      = if column.type == :integer && [/^numeric/, /^decimal/].any? { |e| e.match(column.sql_type) }
@@ -121,9 +121,9 @@ ActiveRecord::SchemaDumper.class_eval do
     spec[:scale]     = column.scale.inspect if !column.scale.nil?
     spec[:null]      = 'false' if !column.null
     spec[:default]   = default_string(column.default) if column.has_default?
-    
+
     # Additions for spatial columns
-    if column.is_a?(SpatialColumn)
+    if column.is_a?(::SpatialAdapter::SpatialColumn)
       # Override with specific geometry type
       spec[:type]    = column.geometry_type.to_s
       spec[:srid]    = column.srid.inspect if column.srid != -1

data/lib/spatial_adapter/common/spatial_column.rb

@@ -9,11 +9,11 @@ module SpatialAdapter
       @with_z = with_z
       @with_m = with_m
     end
-  
+
     def spatial?
       !@geometry_type.nil?
     end
-    
+
     def geographic?
       false
     end
@@ -25,9 +25,9 @@ module SpatialAdapter
       spatial? ? self.class.string_to_geometry(value) : super
     end
 
-    #Redefines type_cast_code to add support for geometries. 
+    #Redefines type_cast_code to add support for geometries.
     #
-    #WARNING : Since ActiveRecord keeps only the string values directly returned from the database, it translates from these to the correct types everytime an attribute is read (using the code returned by this method), which is probably ok for simple types, but might be less than efficient for geometries. Also you cannot modify the geometry object returned directly or your change will not be saved. 
+    #WARNING : Since ActiveRecord keeps only the string values directly returned from the database, it translates from these to the correct types everytime an attribute is read (using the code returned by this method), which is probably ok for simple types, but might be less than efficient for geometries. Also you cannot modify the geometry object returned directly or your change will not be saved.
     # alias_method :type_cast_code_without_spatial, :type_cast_code
     def type_cast_code(var_name)
       spatial? ? "#{self.class.name}.string_to_geometry(#{var_name})" : super

data/lib/spatial_adapter/common/table_definition.rb

@@ -1,14 +1,12 @@
-include SpatialAdapter
+require 'spatial_adapter'
 
-ActiveRecord::ConnectionAdapters::TableDefinition.class_eval do
-  SpatialAdapter.geometry_data_types.keys.each do |column_type|
-    class_eval <<-EOV
-      def #{column_type}(*args)
-        options = args.extract_options!
-        column_names = args
-      
-        column_names.each { |name| column(name, '#{column_type}', options) }
+class ActiveRecord::ConnectionAdapters::TableDefinition
+  SpatialAdapter.geometry_data_types.keys.each do |column_name|
+    define_method(column_name) do |*args|
+      options = args.extract_options!
+      args.each do |name|
+        column(name, column_name, options)
       end
-    EOV
+    end
   end
 end

data/lib/spatial_adapter/common.rb

@@ -0,0 +1,10 @@
+module SpatialAdapter
+  module Common
+  end
+end
+
+require 'spatial_adapter/common/raw_geom_info'
+require 'spatial_adapter/common/spatial_column'
+require 'spatial_adapter/common/schema_definitions'
+require 'spatial_adapter/common/schema_dumper'
+require 'spatial_adapter/common/table_definition'

data/lib/spatial_adapter/jdbcmysql.rb

@@ -0,0 +1,50 @@
+require 'spatial_adapter'
+require 'spatial_adapter/base/mysql'
+require 'active_record/connection_adapters/jdbcmysql_adapter'
+
+module ActiveRecord::ConnectionAdapters
+  class MysqlAdapter
+    include SpatialAdapter::Base::Mysql::Adapter
+
+    #Redefinition of columns to add the information that a column is geometric
+    def columns(table_name, name = nil)#:nodoc:
+      show_fields_from(table_name, name).map do |field|
+        klass = \
+          if field["Type"] =~ GEOMETRY_REGEXP
+            ActiveRecord::ConnectionAdapters::SpatialMysqlColumn
+          else
+            ActiveRecord::ConnectionAdapters::MysqlColumn
+          end
+        klass.new(field['Field'], field['Default'], field['Type'], field['Null'] == "YES")
+      end
+    end
+
+    # Check the nature of the index : If it is SPATIAL, it is indicated in the
+    # IndexDefinition object (redefined to add the spatial flag in
+    # spatial_adapter_common.rb)
+    def indexes(table_name, name = nil)#:nodoc:
+      indexes = []
+      current_index = nil
+      show_keys_from(table_name, name).each do |row|
+        if current_index != row['Key_name']
+          next if row['Key_name'] == "PRIMARY" # skip the primary key
+          current_index = row['Key_name']
+          indexes << ActiveRecord::ConnectionAdapters::IndexDefinition \
+            .new(row['Table'], row['Key_name'], row['Non_unique'] == "0", [], row['Index_type'] == "SPATIAL")
+        end
+        indexes.last.columns << row['Column_name']
+      end
+      indexes
+    end
+
+    def options_for(table)
+      engine = show_table_status_like(table).first['Engine']
+      engine !~ /inno/i ? "ENGINE=#{engine}" : nil
+    end
+  end
+
+  class SpatialMysqlColumn < MysqlColumn
+    include SpatialAdapter::SpatialColumn
+    extend SpatialAdapter::Base::Mysql::SpatialColumn
+  end
+end

data/lib/spatial_adapter/mysql.rb

@@ -1,98 +1,56 @@
 require 'spatial_adapter'
+require 'spatial_adapter/base/mysql'
 require 'active_record/connection_adapters/mysql_adapter'
 
-ActiveRecord::ConnectionAdapters::MysqlAdapter.class_eval do
-  include SpatialAdapter
+module ActiveRecord::ConnectionAdapters
+  class MysqlAdapter
+    include SpatialAdapter::Base::Mysql::Adapter
+
+    #Redefinition of columns to add the information that a column is geometric
+    def columns(table_name, name = nil)#:nodoc:
+      result = show_fields_from(table_name, name)
+
+      columns = []
+      result.each do |field|
+        klass = \
+          if field[1] =~ GEOMETRY_REGEXP
+            ActiveRecord::ConnectionAdapters::SpatialMysqlColumn
+          else
+            ActiveRecord::ConnectionAdapters::MysqlColumn
+          end
+        columns << klass.new(field[0], field[4], field[1], field[2] == "YES")
+      end
 
-  def supports_geographic?
-    false
-  end
-  
-  alias :original_native_database_types :native_database_types
-  def native_database_types
-    original_native_database_types.merge!(geometry_data_types)
-  end
- 
-  alias :original_quote :quote
-  #Redefines the quote method to add behaviour for when a Geometry is encountered ; used when binding variables in find_by methods
-  def quote(value, column = nil)
-    if value.kind_of?(GeoRuby::SimpleFeatures::Geometry)
-      "GeomFromWKB(0x#{value.as_hex_wkb},#{value.srid})"
-    else
-      original_quote(value,column)
-    end
-  end
-  
-  #Redefinition of columns to add the information that a column is geometric
-  def columns(table_name, name = nil)#:nodoc:
-    sql = "SHOW FIELDS FROM #{quote_table_name(table_name)}"
-    columns = []
-    result = execute(sql, name)
-    result.each do |field|
-      klass = field[1] =~ /geometry|point|linestring|polygon|multipoint|multilinestring|multipolygon|geometrycollection/i ? ActiveRecord::ConnectionAdapters::SpatialMysqlColumn : ActiveRecord::ConnectionAdapters::MysqlColumn
-      columns << klass.new(field[0], field[4], field[1], field[2] == "YES")
+      result.free
+      columns
     end
-    result.free
-    columns
-  end
-
-
-  #operations relative to migrations
 
-  #Redefines add_index to support the case where the index is spatial
-  #If the :spatial key in the options table is true, then the sql string for a spatial index is created
-  def add_index(table_name,column_name,options = {})
-    index_name = options[:name] || index_name(table_name,:column => Array(column_name))
-    
-    if options[:spatial]
-      execute "CREATE SPATIAL INDEX #{index_name} ON #{table_name} (#{Array(column_name).join(", ")})"
-    else
-      super
-    end
-  end
-
-  #Check the nature of the index : If it is SPATIAL, it is indicated in the IndexDefinition object (redefined to add the spatial flag in spatial_adapter_common.rb)
-  def indexes(table_name, name = nil)#:nodoc:
-    indexes = []
-    current_index = nil
-    execute("SHOW KEYS FROM #{table_name}", name).each do |row|
-      if current_index != row[2]
-        next if row[2] == "PRIMARY" # skip the primary key
-        current_index = row[2]
-        indexes << ActiveRecord::ConnectionAdapters::IndexDefinition.new(row[0], row[2], row[1] == "0", [], row[10] == "SPATIAL")
+    # Check the nature of the index : If it is SPATIAL, it is indicated in the
+    # IndexDefinition object (redefined to add the spatial flag in
+    # spatial_adapter_common.rb)
+    def indexes(table_name, name = nil)#:nodoc:
+      indexes = []
+      current_index = nil
+      show_keys_from(table_name, name).each do |row|
+        if current_index != row[2]
+          next if row[2] == "PRIMARY" # skip the primary key
+          current_index = row[2]
+          indexes << ActiveRecord::ConnectionAdapters::IndexDefinition \
+            .new(row[0], row[2], row[1] == "0", [], row[10] == "SPATIAL")
+        end
+        indexes.last.columns << row[4]
       end
-      indexes.last.columns << row[4]
+      indexes
     end
-    indexes
-  end
-        
-  #Get the table creation options : Only the engine for now. The text encoding could also be parsed and returned here.
-  def options_for(table)
-    result = execute("show table status like '#{table}'")
-    engine = result.fetch_row[1]
-    if engine !~ /inno/i #inno is default so do nothing for it in order not to clutter the migration
-      "ENGINE=#{engine}" 
-    else
-      nil
+
+    def options_for(table)
+      engine = show_table_status_like(table).fetch_row[1]
+      engine !~ /inno/i ? "ENGINE=#{engine}" : nil
     end
   end
-end
 
-
-module ActiveRecord
-  module ConnectionAdapters
-    class SpatialMysqlColumn < MysqlColumn
-      include SpatialAdapter::SpatialColumn
-      
-      #MySql-specific geometry string parsing. By default, MySql returns geometries in strict wkb format with "0" characters in the first 4 positions.
-      def self.string_to_geometry(string)
-        return string unless string.is_a?(String)
-        begin
-          GeoRuby::SimpleFeatures::Geometry.from_ewkb(string[4..-1])
-        rescue Exception => exception
-          nil
-        end
-      end
-    end
+  class SpatialMysqlColumn < MysqlColumn
+    include SpatialAdapter::SpatialColumn
+    extend SpatialAdapter::Base::Mysql::SpatialColumn
   end
 end