Merge pull request #15 from januszm/rails_4_1

Compatibility with ActiveRecord 4.1 and Rgeo 1.1

Author: januszm

Gemfile

@@ -36,13 +36,12 @@
 
 source "http://rubygems.org"
 
-gem('rgeo-activerecord', '~> 0.4.5')
-gem('mysql2', '>= 0.2.13')
-#gem('activerecord', '~> 3.0.16')
-#gem('activerecord', '~> 3.1.7')
-gem('activerecord', '~> 3.2.7')
+gem 'rgeo-activerecord', github: 'rgeo/rgeo-activerecord', branch: '1.0'
+gem 'mysql2', '>= 0.2.13'
+gem 'activerecord', '>= 4.0', '< 4.2'
 
-group(:test) do
-  gem('rake', '>= 0.9.2')
-  gem('rdoc', '>= 3.12')
+group :test do
+  gem 'rake', '>= 0.9.2'
+  gem 'rdoc', '>= 3.12'
+  gem 'pry'
 end

History.rdoc

@@ -1,3 +1,7 @@
+=== 0.5.0 / 2015-08-06
+
+* Compatibility with ActiveRecord >= 4.0, < 4.2 and with rgeo-activerecord 1.x.
+
 === 0.4.3 / 2012-08-02
 
 * The gemspec no longer includes the timestamp in the version, so that bundler can pull from github. (Reported by corneverbruggen)
@@ -14,7 +18,7 @@
 
 === 0.4.0 / 2011-08-15
 
-* Various fixes for Rails 3.1 compatibility. 
+* Various fixes for Rails 3.1 compatibility.
 * Now requires rgeo-activerecord 0.4.0.
 * INCOMPATIBLE CHANGE: simple queries (e.g. MyClass.where(:latlon => my_point)) use an objective rather than spatial equality test. Earlier versions transformed this form to use st_equals, but now if you need to test for spatial equality, you'll need to call st_equals explicitly. I'm still evaluating which direction we want to go with this in the future, but we may be stuck with the current behavior because the hack required to transform these queries to use spatial equality was egregious and broke in Rails 3.1 with no clear workaround.
 

README.rdoc

@@ -3,23 +3,23 @@
 The MySQL2 Spatial \ActiveRecord Adapter is an \ActiveRecord connection
 adapter based on the standard mysql2 adapter. It extends the standard
 adapter to provide support for spatial columns and indexes in MySQL,
-using the {RGeo}[http://github.com/dazuma/rgeo] library to represent
+using the {RGeo}[http://github.com/rgeo/rgeo] library to represent
 spatial data in Ruby. Like the standard mysql2 adapter, this adapter
 requires the mysql2 gem.
 
 == What This Adapter Provides
 
 === Spatial Migrations
 
-First, this adapter extends the migration syntax to support creating 
+First, this adapter extends the migration syntax to support creating
 spatial columns and indexes. To create a spatial column, use the
 <tt>:geometry</tt> type, or any of the OGC spatial types such as
 <tt>:point</tt> or <tt>:line_string</tt>. To create a spatial index, set
 the <tt>:spatial</tt> option to true. Remember that, on some versions of
 MySQL, only the MyISAM engine supports spatial indexes, and the indexed
 column may need to be NOT NULL.
 
-Examples:
+Examples (require update):
 
   create_table :my_spatial_table, :options => 'ENGINE=MyISAM' do |t|
     t.column :latlon, :point, :null => false
@@ -55,13 +55,13 @@ the "rgeo-activerecord" gem.
 Examples, given the spatial table defined above:
 
   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:
@@ -98,13 +98,13 @@ write more complex queries in SQL.
 
 This adapter has the following requirements:
 
-* Ruby 1.8.7 or later. Ruby 1.9.2 or later preferred.
+* Ruby 1.9.3 or later. Ruby 2.0.0 or later preferred.
 * MySQL server 5.0 or later required for spatial extensions.
-* \ActiveRecord 3.0.3 or later. Earlier versions will not work.
-  Should be compatible with Rails versions through 3.2.x.
+* \ActiveRecord 4.0.0 or later. Earlier versions will not work.
+  Should be compatible with Rails versions through 4.0.x-4.1.x.
 * mysql2 gem 0.2.13 or later.
 * rgeo gem 0.3.15 or later.
-* rgeo-activerecord gem 0.4.5 or later.
+* rgeo-activerecord gem 1.x.
 
 Install this adapter as a gem:
 
@@ -149,18 +149,16 @@ 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://dazuma.github.com/activerecord-mysql2spatial-adapter/rdoc
+Documentation is available at http://rgeo.github.com/activerecord-mysql2spatial-adapter/rdoc
 
-Source code is hosted on Github at http://github.com/dazuma/activerecord-mysql2spatial-adapter
+Source code is hosted on Github at http://github.com/rgeo/activerecord-mysql2spatial-adapter
 
 Contributions are welcome. Fork the project on Github.
 
-Report bugs on Github issues at http://github.org/dazuma/activerecord-mysql2spatial-adapter/issues
+Report bugs on Github issues at http://github.org/rgeo/activerecord-mysql2spatial-adapter/issues
 
 Support available on the rgeo-users google group at http://groups.google.com/group/rgeo-users
 
-Contact the author at dazuma at gmail dot com.
-
 === Acknowledgments
 
 The Mysql2Spatial Adapter and its supporting libraries (including RGeo)

Rakefile

@@ -44,6 +44,7 @@ RAKEFILE_CONFIG = {} unless defined?(::RAKEFILE_CONFIG)
 # Gemspec
 
 require 'rubygems'
+require 'pry'
 gemspec_ = eval(::File.read(::Dir.glob('*.gemspec').first))
 release_gemspec_ = eval(::File.read(::Dir.glob('*.gemspec').first))
 release_gemspec_.version = gemspec_.version.to_s.sub(/\.nonrelease$/, '')
@@ -68,6 +69,8 @@ platform_suffix_ =
       'mri18'
     elsif ::RUBY_VERSION =~ /^1\.9\..*$/
       'mri19'
+    elsif ::RUBY_VERSION =~ /^2\..*$/
+      'mri2'
     else
       raise "Unknown version of Matz Ruby Interpreter (#{::RUBY_VERSION})"
     end

Version

@@ -1 +1 @@
-0.4.3
+0.5.0

activerecord-mysql2spatial-adapter.gemspec

@@ -42,14 +42,14 @@
   s_.email = 'dazuma@gmail.com'
   s_.homepage = "http://dazuma.github.com/activerecord-mysql2spatial-adapter"
   s_.rubyforge_project = 'virtuoso'
-  s_.required_ruby_version = '>= 1.8.7'
+  s_.required_ruby_version = '>= 1.9.3'
   s_.files = ::Dir.glob("lib/**/*.rb") +
     ::Dir.glob("test/**/*.rb") +
     ::Dir.glob("*.rdoc") +
     ['Version']
   s_.extra_rdoc_files = ::Dir.glob("*.rdoc")
   s_.test_files = ::Dir.glob("test/**/tc_*.rb")
   s_.platform = ::Gem::Platform::RUBY
-  s_.add_dependency('rgeo-activerecord', '~> 0.4.5')
+  s_.add_dependency('rgeo-activerecord', '~> 1.0')
   s_.add_dependency('mysql2', '>= 0.2.13')
 end

lib/active_record/connection_adapters/mysql2spatial_adapter.rb

@@ -84,6 +84,7 @@ module Mysql2SpatialAdapter
 
 
 require 'active_record/connection_adapters/mysql2spatial_adapter/version.rb'
+require 'active_record/connection_adapters/mysql2spatial_adapter/column_methods.rb' # check if this works with Rails < 4.x
 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'

lib/active_record/connection_adapters/mysql2spatial_adapter/column_methods.rb

@@ -0,0 +1,46 @@
+module ActiveRecord
+  module ConnectionAdapters
+    module Mysql2SpatialAdapter
+      module ColumnMethods
+        def spatial(name, options = {})
+          raise "You must set a type. For example: 't.spatial limit: { type: 'point' }'" unless options[:limit][:type]
+          column(name, options[:limit][:type], options)
+        end
+
+        def geography(name, options = {})
+          column(name, :geography, options)
+        end
+
+        def geometry(name, options = {})
+          column(name, :geometry, options)
+        end
+
+        def geometry_collection(name, options = {})
+          column(name, :geometry_collection, options)
+        end
+
+        def line_string(name, options = {})
+          column(name, :line_string, options)
+        end
+
+        def multi_line_string(name, options = {})
+          column(name, :multi_line_string, options)
+        end
+
+        def multi_point(name, options = {})
+          column(name, :multi_point, options)
+        end
+
+        def multi_polygon(name, options = {})
+          column(name, :multi_polygon, options)
+        end
+
+        def point(name, options = {})
+          column(name, :point, options)
+        end
+      end
+
+      ConnectionAdapters::TableDefinition.send(:include, ColumnMethods)
+    end
+  end
+end

lib/active_record/connection_adapters/mysql2spatial_adapter/main_adapter.rb

@@ -46,7 +46,7 @@ module Mysql2SpatialAdapter
       class MainAdapter < ConnectionAdapters::Mysql2Adapter
 
 
-        NATIVE_DATABASE_TYPES = Mysql2Adapter::NATIVE_DATABASE_TYPES.merge(:spatial => {:name => "geometry"})
+        NATIVE_DATABASE_TYPES = Mysql2Adapter::NATIVE_DATABASE_TYPES.merge(spatial: { name: 'geometry' })
 
 
         def initialize(*args_)
@@ -120,7 +120,7 @@ def columns(table_name_, name_=nil)
           columns_
         end
 
-
+        # Returns an array of indexes for the given table.
         def indexes(table_name_, name_=nil)
           indexes_ = []
           current_index_ = nil
@@ -129,11 +129,20 @@ def indexes(table_name_, name_=nil)
             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')
+              mysql_index_type = row_[:Index_type].downcase.to_sym
+              index_type  = INDEX_TYPES.include?(mysql_index_type)  ? mysql_index_type : nil
+              index_using = INDEX_USINGS.include?(mysql_index_type) ? mysql_index_type : nil
+              options = [row_[:Table], row_[:Key_name], row_[:Non_unique].to_i == 0, [], [], nil, nil, index_type, index_using]
+              indexes_ << if mysql_index_type == :spatial
+                options.push(true)
+                ::RGeo::ActiveRecord::SpatialIndexDefinition.new(*options)
+              else
+                IndexDefinition.new(*options)
+              end
             end
             last_index_ = indexes_.last
             last_index_.columns << row_[:Column_name]
-            last_index_.lengths << row_[:Sub_part] unless last_index_.spatial
+            last_index_.lengths << row_[:Sub_part] unless mysql_index_type == :spatial
           end
           indexes_
         end

lib/active_record/connection_adapters/mysql2spatial_adapter/spatial_column.rb

@@ -60,7 +60,7 @@ def initialize(factory_settings_, table_name_, name_, default_, sql_type_=nil, n
           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}
+            @limit = { type: @geometric_type.type_name.underscore }
           end
           FACTORY_SETTINGS_CACHE[factory_settings_.object_id] = factory_settings_
         end