activerecord-postgis-adapter 0.5.0 → 0.5.1

data/History.rdoc

@@ -1,3 +1,12 @@
+=== 0.5.1 / 2013-02-04
+
+* Database creation properly treats geometry_columns as a view when setting owner. (Pull request by hendrikstier)
+* Provide rake db:gis:setup task. (Pull request by Cody Russell)
+* Modifications for compatibility with postgres_ext. (Pull request by legendetm)
+* SpatialTableDefinition properly subclasses the Postgres-specific table definition class, if available. (Pull request by Joe Noon)
+* Database creation script no longer fails if the username includes weird characters. (Contributed by Toms Mikoss)
+* Updates for compatibility with jdbc-postgres 9.2.1002.1
+
 === 0.5.0 / 2012-12-12
 
 Thanks to the many who have submitted pull requests. A bunch of them are in this release. Special thanks to Nick Muerdter, who succeeded in porting the adapter to work with the JDBC Postgres adapter in JRuby, and also got Travis up and running for the project.

data/README.rdoc

@@ -128,7 +128,8 @@ system; you shouldn't try to run such a query against a lat/long
 
 This adapter has the following requirements:
 
-* Ruby 1.8.7 or later. Ruby 1.9.2 or later preferred. JRuby 1.6.3 or later also supported.
+* Ruby 1.8.7 or later. Ruby 1.9.2 or later preferred. JRuby 1.6.3 or
+  later also supported.
 * PostgreSQL 9.0 or later.
 * PostGIS 1.5, PostGIS 2.0, or later.
 * \ActiveRecord 3.0.3 or later. Earlier versions will not work.
@@ -136,7 +137,8 @@ This adapter has the following requirements:
 * rgeo gem 0.3.20 or later.
 * rgeo-activerecord gem 0.4.6 or later.
 
-Please note that this version of the adapter is targeted towards Rails 3.x only. The upcoming version 0.6 will target Rails 4.0.
+Please note that this version of the adapter is targeted towards Rails
+3.x only. The upcoming version 0.6 will target Rails 4.0.
 
 Install this adapter as a gem:
 

data/Version

@@ -1 +1 @@
-0.5.0
+0.5.1

data/lib/active_record/connection_adapters/postgis_adapter.rb

@@ -35,6 +35,7 @@
 
 
 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'

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

@@ -43,14 +43,102 @@ class Object
 end
 
 
+namespace :db do
+  namespace :gis do
+    desc "Setup PostGIS data in the database"
+    task :setup => [:load_config, :rails_env] do
+      configs_for_environment.each { |config| setup_gis(config) }
+    end
+  end
+end
+
+
+# superuser name/password
+def get_su_auth(config_)
+  username_ = config_['username']
+  su_username_ = config_['su_username'] || username_
+  su_password_ = config_['su_password'] || config_['password']
+  has_su_ = config_.include?('su_username')
+
+  [username_, su_username_, su_password_, has_su_]
+end
+
+
+def get_search_path(config_)
+  config_["schema_search_path"].to_s.strip.split(',').map(&:strip)
+end
+
+
+# Install postgis definitions into the database.
+# Note: a superuser is required to run the postgis definitions.
+# If a separate superuser is provided, we need to grant privileges on
+# the postgis definitions over to the regular user afterwards.
+# We also need to set the ownership of the postgis tables (spatial_ref_sys
+# and geometry_columns) to the regular user. This is required to e.g.
+# be able to disable referential integrity on the database when using
+# a database cleaner truncation strategy during testing.
+# The schema for the postgis definitions is chosen as follows:
+# If "postgis" is present in the search path, use it.
+# Otherwise, use the last schema in the search path.
+# If no search path is given, use "public".
+def setup_gis(config_)
+  # Initial setup of the database: Add schemas from the search path.
+  # If a superuser is given, we log in as the superuser, but we make sure
+  # the schemas are owned by the regular user.
+  username_, su_username_, su_password_, has_su_ = get_su_auth(config_)
+  ::ActiveRecord::Base.establish_connection(config_.merge('schema_search_path' => 'public', 'username' => su_username_, 'password' => su_password_))
+  conn_ = ::ActiveRecord::Base.connection
+  search_path_ = get_search_path(config_)
+  quoted_username_ = ::PGconn.quote_ident(username_)
+  auth_ = has_su_ ? " AUTHORIZATION #{quoted_username_}" : ''
+  search_path_.each do |schema_|
+    exists = schema_.downcase == 'public' || conn_.execute("SELECT 1 FROM pg_catalog.pg_namespace WHERE nspname='#{schema_}'").try(:first)
+    conn_.execute("CREATE SCHEMA #{schema_}#{auth_}") unless exists
+  end
+
+  script_dir_ = config_['script_dir']
+  postgis_extension_ = config_['postgis_extension']
+  if script_dir_ || postgis_extension_
+    postgis_schema_ = search_path_.include?('postgis') ? 'postgis' : (search_path_.last || 'public')
+    if script_dir_
+      # Use script_dir (for postgresql < 9.1 or postgis < 2.0)
+      conn_.execute("SET search_path TO #{postgis_schema_}")
+      conn_.execute(::File.read(::File.expand_path('postgis.sql', script_dir_)))
+      conn_.execute(::File.read(::File.expand_path('spatial_ref_sys.sql', script_dir_)))
+    elsif postgis_extension_
+      # Use postgis_extension (for postgresql >= 9.1 and postgis >= 2.0)
+      postgis_extension_ = 'postgis' if postgis_extension_ == true
+      postgis_extension_ = postgis_extension_.to_s.split(',') unless postgis_extension_.is_a?(::Array)
+      postgis_extension_.each do |extname_|
+        if extname_ == 'postgis_topology'
+          raise ArgumentError, "'topology' must be in schema_search_path for postgis_topology" unless search_path_.include?('topology')
+          conn_.execute("CREATE EXTENSION #{extname_} SCHEMA topology")
+        else
+          conn_.execute("CREATE EXTENSION #{extname_} SCHEMA #{postgis_schema_}")
+        end
+      end
+    end
+    if has_su_
+      conn_.execute("GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA #{postgis_schema_} TO #{quoted_username_}")
+      conn_.execute("GRANT ALL PRIVILEGES ON ALL FUNCTIONS IN SCHEMA #{postgis_schema_} TO #{quoted_username_}")
+
+      postgis_version = conn_.execute( "SELECT #{postgis_schema_}.postgis_version();" ).first[ 'postgis_version' ]
+      if postgis_version =~ /^2/
+        conn_.execute("ALTER VIEW #{postgis_schema_}.geometry_columns OWNER TO #{quoted_username_}")
+      else
+        conn_.execute("ALTER TABLE #{postgis_schema_}.geometry_columns OWNER TO #{quoted_username_}")
+      end
+      conn_.execute("ALTER TABLE #{postgis_schema_}.spatial_ref_sys OWNER TO #{quoted_username_}")
+    end
+  end
+end
+
+
 def create_database(config_)
   if config_['adapter'] == 'postgis'
     @encoding = config_['encoding'] || ::ENV['CHARSET'] || 'utf8'
     begin
-      has_su_ = config_.include?('su_username')            # Is there a distinct superuser?
-      username_ = config_['username']                      # regular user name
-      su_username_ = config_['su_username'] || username_   # superuser name
-      su_password_ = config_['su_password'] || config_['password']  # superuser password
+      username_, su_username_, su_password_, has_su_ = get_su_auth(config_)
 
       # Create the database. Optionally do so as the given superuser.
       # But make sure the database is owned by the regular user.
@@ -59,60 +147,7 @@ def create_database(config_)
       extra_configs_['owner'] = username_ if has_su_
       ::ActiveRecord::Base.connection.create_database(config_['database'], config_.merge(extra_configs_))
 
-      # Initial setup of the database: Add schemas from the search path.
-      # If a superuser is given, we log in as the superuser, but we make sure
-      # the schemas are owned by the regular user.
-      ::ActiveRecord::Base.establish_connection(config_.merge('schema_search_path' => 'public', 'username' => su_username_, 'password' => su_password_))
-      conn_ = ::ActiveRecord::Base.connection
-      search_path_ = config_["schema_search_path"].to_s.strip
-      search_path_ = search_path_.split(",").map{ |sp_| sp_.strip }
-      auth_ = has_su_ ? " AUTHORIZATION #{username_}" : ''
-      search_path_.each do |schema_|
-        exists = schema_.downcase == 'public' || conn_.execute("SELECT 1 FROM pg_catalog.pg_namespace WHERE nspname='#{schema_}'").try(:first)
-        conn_.execute("CREATE SCHEMA #{schema_}#{auth_}") unless exists
-      end
-
-      # Install postgis definitions into the database.
-      # Note: a superuser is required to run the postgis definitions.
-      # If a separate superuser is provided, we need to grant privileges on
-      # the postgis definitions over to the regular user afterwards.
-      # We also need to set the ownership of the postgis tables (spatial_ref_sys
-      # and geometry_columns) to the regular user. This is required to e.g.
-      # be able to disable referential integrity on the database when using
-      # a database cleaner truncation strategy during testing.
-      # The schema for the postgis definitions is chosen as follows:
-      # If "postgis" is present in the search path, use it.
-      # Otherwise, use the last schema in the search path.
-      # If no search path is given, use "public".
-      script_dir_ = config_['script_dir']
-      postgis_extension_ = config_['postgis_extension']
-      if script_dir_ || postgis_extension_
-        postgis_schema_ = search_path_.include?('postgis') ? 'postgis' : (search_path_.last || 'public')
-        if script_dir_
-          # Use script_dir (for postgresql < 9.1 or postgis < 2.0)
-          conn_.execute("SET search_path TO #{postgis_schema_}")
-          conn_.execute(::File.read(::File.expand_path('postgis.sql', script_dir_)))
-          conn_.execute(::File.read(::File.expand_path('spatial_ref_sys.sql', script_dir_)))
-        elsif postgis_extension_
-          # Use postgis_extension (for postgresql >= 9.1 and postgis >= 2.0)
-          postgis_extension_ = 'postgis' if postgis_extension_ == true
-          postgis_extension_ = postgis_extension_.to_s.split(',') unless postgis_extension_.is_a?(::Array)
-          postgis_extension_.each do |extname_|
-            if extname_ == 'postgis_topology'
-              raise ArgumentError, "'topology' must be in schema_search_path for postgis_topology" unless search_path_.include?('topology')
-              conn_.execute("CREATE EXTENSION #{extname_} SCHEMA topology")
-            else
-              conn_.execute("CREATE EXTENSION #{extname_} SCHEMA #{postgis_schema_}")
-            end
-          end
-        end
-        if has_su_
-          conn_.execute("GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA #{postgis_schema_} TO #{username_}")
-          conn_.execute("GRANT ALL PRIVILEGES ON ALL FUNCTIONS IN SCHEMA #{postgis_schema_} TO #{username_}")
-          conn_.execute("ALTER TABLE geometry_columns OWNER TO #{username_}")
-          conn_.execute("ALTER TABLE spatial_ref_sys OWNER TO #{username_}")
-        end
-      end
+      setup_gis(config_)
 
       # Done
       ::ActiveRecord::Base.establish_connection(config_)

data/lib/active_record/connection_adapters/postgis_adapter/jdbc_connection.rb

@@ -47,23 +47,32 @@ class ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
 end
 
 class ::ActiveRecord::Base
-  # ActiveRecord looks for the postgis_connection factory method in
-  # this class.
-  #
-  # Based on the default `postgresql_connection` definition from
-  # activerecord-jdbc-adapter's:
-  # lib/arjdbc/postgresql/connection_methods.rb
-  def self.postgis_connection(config)
-    require "arjdbc/postgresql"
-    config[:host] ||= "localhost"
-    config[:port] ||= 5432
-    config[:url] ||= "jdbc:postgresql://#{config[:host]}:#{config[:port]}/#{config[:database]}"
-    config[:url] << config[:pg_params] if config[:pg_params]
-    config[:driver] ||= "org.postgresql.Driver"
-    config[:adapter_class] = ::ActiveRecord::ConnectionAdapters::PostGISAdapter::MainAdapter
-    config[:adapter_spec] = ::ArJdbc::PostgreSQL
-    conn = jdbc_connection(config)
-    conn.execute("SET SEARCH_PATH TO #{config[:schema_search_path]}") if config[:schema_search_path]
-    conn
+  class << self
+    # ActiveRecord looks for the postgis_connection factory method in
+    # this class.
+    #
+    # Based on the default `postgresql_connection` definition from
+    # activerecord-jdbc-adapter's:
+    # lib/arjdbc/postgresql/connection_methods.rb
+    def postgis_connection(config)
+      begin
+        require 'jdbc/postgres'
+        ::Jdbc::Postgres.load_driver(:require) if defined?(::Jdbc::Postgres.load_driver)
+      rescue LoadError # assuming driver.jar is on the class-path
+      end
+      require "arjdbc/postgresql"
+      config[:username] ||= ::Java::JavaLang::System.get_property("user.name")
+      config[:host] ||= "localhost"
+      config[:port] ||= 5432
+      config[:url] ||= "jdbc:postgresql://#{config[:host]}:#{config[:port]}/#{config[:database]}"
+      config[:url] << config[:pg_params] if config[:pg_params]
+      config[:driver] ||= defined?(::Jdbc::Postgres.driver_name) ? ::Jdbc::Postgres.driver_name : 'org.postgresql.Driver'
+      config[:adapter_class] = ::ActiveRecord::ConnectionAdapters::PostGISAdapter::MainAdapter
+      config[:adapter_spec] = ::ArJdbc::PostgreSQL
+      conn = jdbc_connection(config)
+      conn.execute("SET SEARCH_PATH TO #{config[:schema_search_path]}") if config[:schema_search_path]
+      conn
+    end
+    alias_method :jdbcpostgis_connection, :postgis_connection
   end
 end

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

@@ -130,8 +130,11 @@ module ActiveRecord
               col_name_ = col_name_["column_name"]
             end
 
-            SpatialColumn.new(@rgeo_factory_settings, table_name_, col_name_, default_, type_,
-              notnull_ == 'f', type_ =~ /geometry/i ? spatial_info_[col_name_] : nil)
+            SpatialColumn.new(col_name_, default_, type_, notnull_ == 'f',
+              ((type_ =~ /geometry/i ? spatial_info_[col_name_] : nil) || {}).merge({
+                  :table_name => table_name_,
+                  :factory_settings => @rgeo_factory_settings
+                }))
           end
         end
 

data/lib/active_record/connection_adapters/postgis_adapter/pg_connection.rb

@@ -1,4 +1,3 @@
-require 'active_record/connection_adapters/postgresql_adapter'
 require 'pg'
 
 class ::ActiveRecord::Base

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

@@ -49,11 +49,11 @@ module ActiveRecord
         FACTORY_SETTINGS_CACHE = {}
 
 
-        def initialize(factory_settings_, table_name_, name_, default_, sql_type_=nil, null_=true, opts_=nil)
-          @factory_settings = factory_settings_
-          @table_name = table_name_
+        def initialize(name_, default_, sql_type_=nil, null_=true, opts_={})
+          @factory_settings = opts_.delete(:factory_settings)
+          @table_name = opts_.delete(:table_name)
           @geographic = sql_type_ =~ /geography/i ? true : false
-          if opts_
+          if opts_.length > 0
             # This case comes from an entry in the geometry_columns table
             @geometric_type = ::RGeo::ActiveRecord.geometric_type_from_name(opts_[:type]) ||
               ::RGeo::Feature::Geometry
@@ -97,7 +97,7 @@ module ActiveRecord
               @limit = {:no_constraints => true}
             end
           end
-          FACTORY_SETTINGS_CACHE[factory_settings_.object_id] = factory_settings_
+          FACTORY_SETTINGS_CACHE[@factory_settings.object_id] = @factory_settings
         end
 
 

data/lib/active_record/connection_adapters/postgis_adapter/spatial_table_definition.rb

@@ -42,8 +42,13 @@ module ActiveRecord
 
     module PostGISAdapter
 
+      TableDefinitionSuperclass = if defined?(ConnectionAdapters::PostgreSQLAdapter::TableDefinition)
+        ConnectionAdapters::PostgreSQLAdapter::TableDefinition
+      else
+        ConnectionAdapters::TableDefinition
+      end
 
-      class SpatialTableDefinition < ConnectionAdapters::TableDefinition
+      class SpatialTableDefinition < TableDefinitionSuperclass
 
         def column(name_, type_, options_={})
           if (info_ = @base.spatial_column_constructor(type_.to_sym))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-postgis-adapter
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-12 00:00:00.000000000 Z
+date: 2013-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rgeo-activerecord
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: virtuoso
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: An ActiveRecord adapter for PostGIS, based on RGeo.