activerecord-postgis-adapter 0.5.1 → 0.6.0

data/Version

@@ -1 +1 @@
-0.5.1
+0.6.0

data/lib/active_record/connection_adapters/postgis_adapter.rb

@@ -34,25 +34,16 @@
 ;
 
 
-require 'rgeo/active_record'
-require 'active_record/connection_adapters/postgresql_adapter'
-
-if defined?(::RUBY_ENGINE) && ::RUBY_ENGINE == 'jruby'
-  require 'active_record/connection_adapters/postgis_adapter/jdbc_connection'
-else
-  require 'active_record/connection_adapters/postgis_adapter/pg_connection'
-end
-
-
 # The activerecord-postgis-adapter gem installs the *postgis*
 # connection adapter into ActiveRecord.
 
 module ActiveRecord
 
   # All ActiveRecord adapters go in this namespace.
+  # This adapter is installed into the PostGISAdapter submodule.
   module ConnectionAdapters
 
-    # The PostGIS Adapter
+    # The PostGIS Adapter lives in this namespace.
     module PostGISAdapter
 
       # The name returned by the adapter_name method of this adapter.
@@ -66,15 +57,38 @@ module ActiveRecord
 end
 
 
-require 'active_record/connection_adapters/postgis_adapter/version.rb'
-require 'active_record/connection_adapters/postgis_adapter/main_adapter.rb'
-require 'active_record/connection_adapters/postgis_adapter/spatial_table_definition.rb'
-require 'active_record/connection_adapters/postgis_adapter/spatial_column.rb'
-require 'active_record/connection_adapters/postgis_adapter/arel_tosql.rb'
+# :stopdoc:
 
+require 'active_record'
+require 'active_record/connection_adapters/postgresql_adapter'
+require 'rgeo/active_record'
+
+case ::ActiveRecord::VERSION::MAJOR
+when 3
+  require 'active_record/connection_adapters/postgis_adapter/shared/version.rb'
+  require 'active_record/connection_adapters/postgis_adapter/rails3/main_adapter.rb'
+  require 'active_record/connection_adapters/postgis_adapter/rails3/spatial_table_definition.rb'
+  require 'active_record/connection_adapters/postgis_adapter/rails3/spatial_column.rb'
+  require 'active_record/connection_adapters/postgis_adapter/shared/arel_tosql.rb'
+  require 'active_record/connection_adapters/postgis_adapter/shared/setup.rb'
+  require 'active_record/connection_adapters/postgis_adapter/rails3/create_connection'
+when 4
+  require 'active_record/connection_adapters/postgis_adapter/shared/version.rb'
+  require 'active_record/connection_adapters/postgis_adapter/rails4/main_adapter.rb'
+  require 'active_record/connection_adapters/postgis_adapter/rails4/spatial_table_definition.rb'
+  require 'active_record/connection_adapters/postgis_adapter/rails4/spatial_column.rb'
+  require 'active_record/connection_adapters/postgis_adapter/shared/arel_tosql.rb'
+  require 'active_record/connection_adapters/postgis_adapter/shared/setup.rb'
+  require 'active_record/connection_adapters/postgis_adapter/rails4/create_connection'
+  require 'active_record/connection_adapters/postgis_adapter/rails4/postgis_database_tasks.rb'
+else
+  raise "Unsupported ActiveRecord version #{::ActiveRecord::VERSION::STRING}"
+end
+
+::ActiveRecord::ConnectionAdapters::PostGISAdapter.initial_setup
+
+if defined?(::Rails::Railtie)
+  load 'active_record/connection_adapters/postgis_adapter/shared/railtie'
+end
 
-ignore_tables_ = ::ActiveRecord::SchemaDumper.ignore_tables
-ignore_tables_ << 'geometry_columns' unless ignore_tables_.include?('geometry_columns')
-ignore_tables_ << 'spatial_ref_sys' unless ignore_tables_.include?('spatial_ref_sys')
-ignore_tables_ << 'layer' unless ignore_tables_.include?('layer')
-ignore_tables_ << 'topology' unless ignore_tables_.include?('topology')
+# :startdoc:

data/lib/active_record/connection_adapters/postgis_adapter/rails3/create_connection.rb

@@ -0,0 +1,96 @@
+# -----------------------------------------------------------------------------
+#
+# PostGIS adapter for ActiveRecord
+#
+# -----------------------------------------------------------------------------
+# Copyright 2010-2012 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.
+# -----------------------------------------------------------------------------
+;
+
+
+module ActiveRecord  # :nodoc:
+
+  class Base  # :nodoc:
+
+    class << self
+
+
+      if defined?(::RUBY_ENGINE) && ::RUBY_ENGINE == 'jruby'
+
+
+        require 'active_record/connection_adapters/jdbcpostgresql_adapter'
+        require 'active_record/connection_adapters/postgis_adapter/shared/jdbc_compat'
+
+
+        def postgis_connection(config_)
+          ::ActiveRecord::ConnectionAdapters::PostGISAdapter.create_jdbc_connection(self, config_)
+        end
+
+        alias_method :jdbcpostgis_connection, :postgis_connection
+
+
+      else
+
+
+        require 'pg'
+
+
+        # ActiveRecord looks for the postgis_connection factory method in
+        # this class.
+        #
+        # Based on the default <tt>postgresql_connection</tt> definition from
+        # ActiveRecord.
+
+        def postgis_connection(config_)
+          config_ = config_.symbolize_keys
+          host_ = config_[:host]
+          port_ = config_[:port] || 5432
+          username_ = config_[:username].to_s if config_[:username]
+          password_ = config_[:password].to_s if config_[:password]
+
+          if config_.key?(:database)
+            database_ = config_[:database]
+          else
+            raise ::ArgumentError, "No database specified. Missing argument: database."
+          end
+
+          # The postgres drivers don't allow the creation of an unconnected PGconn object,
+          # so just pass a nil connection object for the time being.
+          ::ActiveRecord::ConnectionAdapters::PostGISAdapter::MainAdapter.new(nil, logger, [host_, port_, nil, nil, database_, username_, password_], config_)
+        end
+
+
+      end
+
+
+    end
+
+  end
+
+end

data/lib/active_record/connection_adapters/postgis_adapter/{databases.rake → rails3/databases.rake}

@@ -1,6 +1,6 @@
 # -----------------------------------------------------------------------------
 #
-# Rakefile changes for PostGIS adapter
+# PostGIS adapter for ActiveRecord
 #
 # -----------------------------------------------------------------------------
 # Copyright 2010-2012 Daniel Azuma
@@ -34,6 +34,9 @@
 ;
 
 
+# :stopdoc:
+
+
 require 'rgeo/active_record/task_hacker'
 
 
@@ -214,3 +217,6 @@ end
   drop_database(config_)
   create_database(config_)
 end
+
+
+# :startdoc:

data/lib/active_record/connection_adapters/postgis_adapter/{main_adapter.rb → rails3/main_adapter.rb}

@@ -34,16 +34,14 @@
 ;
 
 
-# :stopdoc:
+module ActiveRecord  # :nodoc:
 
-module ActiveRecord
+  module ConnectionAdapters  # :nodoc:
 
-  module ConnectionAdapters
+    module PostGISAdapter  # :nodoc:
 
-    module PostGISAdapter
 
-
-      class MainAdapter < PostgreSQLAdapter
+      class MainAdapter < PostgreSQLAdapter  # :nodoc:
 
 
         SPATIAL_COLUMN_CONSTRUCTORS = ::RGeo::ActiveRecord::DEFAULT_SPATIAL_COLUMN_CONSTRUCTORS.merge(
@@ -179,7 +177,11 @@ module ActiveRecord
 
             spatial_ = indtype_ == 'gist' && columns_.size == 1 && (columns_.values.first[1] == 'geometry' || columns_.values.first[1] == 'geography')
             column_names_ = columns_.values_at(*indkey_).compact.map{ |a_| a_[0] }
-            column_names_.empty? ? nil : ::RGeo::ActiveRecord::SpatialIndexDefinition.new(table_name_, index_name_, unique_, column_names_, nil, spatial_)
+            if column_names_.empty?
+              nil
+            else
+              ::RGeo::ActiveRecord::SpatialIndexDefinition.new(table_name_, index_name_, unique_, column_names_, nil, nil, nil, spatial_ ? true : false)
+            end
           end.compact
         end
 
@@ -333,5 +335,3 @@ module ActiveRecord
   end
 
 end
-
-# :startdoc:

data/lib/active_record/connection_adapters/postgis_adapter/{spatial_column.rb → rails3/spatial_column.rb}

@@ -34,16 +34,14 @@
 ;
 
 
-# :stopdoc:
+module ActiveRecord  # :nodoc:
 
-module ActiveRecord
+  module ConnectionAdapters  # :nodoc:
 
-  module ConnectionAdapters
+    module PostGISAdapter  # :nodoc:
 
-    module PostGISAdapter
 
-
-      class SpatialColumn < ConnectionAdapters::PostgreSQLColumn
+      class SpatialColumn < ConnectionAdapters::PostgreSQLColumn  # :nodoc:
 
 
         FACTORY_SETTINGS_CACHE = {}
@@ -195,5 +193,3 @@ module ActiveRecord
   end
 
 end
-
-# :startdoc:

data/lib/active_record/connection_adapters/postgis_adapter/{spatial_table_definition.rb → rails3/spatial_table_definition.rb}

@@ -34,13 +34,11 @@
 ;
 
 
-# :stopdoc:
+module ActiveRecord  # :nodoc:
 
-module ActiveRecord
+  module ConnectionAdapters  # :nodoc:
 
-  module ConnectionAdapters
-
-    module PostGISAdapter
+    module PostGISAdapter  # :nodoc:
 
       TableDefinitionSuperclass = if defined?(ConnectionAdapters::PostgreSQLAdapter::TableDefinition)
         ConnectionAdapters::PostgreSQLAdapter::TableDefinition
@@ -48,7 +46,7 @@ module ActiveRecord
         ConnectionAdapters::TableDefinition
       end
 
-      class SpatialTableDefinition < TableDefinitionSuperclass
+      class SpatialTableDefinition < TableDefinitionSuperclass  # :nodoc:
 
         def column(name_, type_, options_={})
           if (info_ = @base.spatial_column_constructor(type_.to_sym))
@@ -88,7 +86,7 @@ module ActiveRecord
       end
 
 
-      module SpatialColumnDefinitionMethods
+      module SpatialColumnDefinitionMethods  # :nodoc:
 
         def spatial_type
           @spatial_type
@@ -145,5 +143,3 @@ module ActiveRecord
   end
 
 end
-
-# :startdoc:

data/lib/active_record/connection_adapters/postgis_adapter/rails4/create_connection.rb

@@ -0,0 +1,88 @@
+# -----------------------------------------------------------------------------
+#
+# PostGIS adapter for ActiveRecord
+#
+# -----------------------------------------------------------------------------
+# Copyright 2010-2012 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.
+# -----------------------------------------------------------------------------
+;
+
+
+module ActiveRecord  # :nodoc:
+
+  module ConnectionHandling  # :nodoc:
+
+
+    if defined?(::RUBY_ENGINE) && ::RUBY_ENGINE == 'jruby'
+
+      require 'active_record/connection_adapters/jdbcpostgresql_adapter'
+      require 'active_record/connection_adapters/postgis_adapter/shared/jdbc_compat'
+
+
+      def postgis_connection(config_)
+        ::ActiveRecord::ConnectionAdapters::PostGISAdapter.create_jdbc_connection(self, config_)
+      end
+
+      alias_method :jdbcpostgis_connection, :postgis_connection
+
+
+    else
+
+
+      require 'pg'
+
+
+      # Based on the default <tt>postgresql_connection</tt> definition from
+      # ActiveRecord.
+
+      def postgis_connection(config_)
+        # FULL REPLACEMENT because we need to create a different class.
+        conn_params_ = config_.symbolize_keys
+
+        conn_params_.delete_if { |_, v_| v_.nil? }
+
+        # Map ActiveRecords param names to PGs.
+        conn_params_[:user] = conn_params_.delete(:username) if conn_params_[:username]
+        conn_params_[:dbname] = conn_params_.delete(:database) if conn_params_[:database]
+
+        # Forward only valid config params to PGconn.connect.
+        conn_params_.keep_if { |k_, _| VALID_CONN_PARAMS.include?(k_) }
+
+        # The postgres drivers don't allow the creation of an unconnected PGconn object,
+        # so just pass a nil connection object for the time being.
+        ::ActiveRecord::ConnectionAdapters::PostGISAdapter::MainAdapter.new(nil, logger, conn_params_, config_)
+      end
+
+
+    end
+
+
+  end
+
+end

data/lib/active_record/connection_adapters/postgis_adapter/rails4/databases.rake

@@ -0,0 +1,52 @@
+# -----------------------------------------------------------------------------
+#
+# PostGIS adapter for ActiveRecord
+#
+# -----------------------------------------------------------------------------
+# Copyright 2010-2012 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:
+
+
+namespace :db do
+  namespace :gis do
+    desc "Setup PostGIS data in the database"
+    task :setup => [:load_config, :rails_env] do
+      configs_for_environment.each do |config_|
+        ::ActiveRecord::ConnectionAdapters::PostGISAdapter::PostGISDatabaseTasks.new(config_).setup_gis
+      end
+    end
+  end
+end
+
+
+# :startdoc: