activerecord-postgis-adapter 0.2.2 → 0.2.3

data/History.rdoc

@@ -1,3 +1,10 @@
+=== 0.2.3 / 2011-01-06
+
+* Many of ActiveRecord's rake tasks weren't working because they need to know about every adapter explicitly. I hesitate to call this "fixed" since I see it as a problem in ActiveRecord, but we now at least have a workaround so the rake tasks will run properly. (Reported by Tad Thorley.)
+* Dumping schema.rb now omits the PostGIS internal tables.
+* Added a new configuration parameter pointing to the script directory, for rake db:create.
+* If the "postgis" schema is included in the schema search path, it is used as a container for the PostGIS internal definitions when running rake db:create. Furthermore, that schema is omitted when dumping the structure.sql. This should eliminate all the PostGIS internal cruft from SQL structure dumps, and also eliminate the errors that would appear when rebuilding a test database because the PostGIS internals would get applied twice.
+
 === 0.2.2 / 2010-12-27
 
 * Support for basic spatial equality queries. e.g. constructs such as:

data/README.rdoc

@@ -7,13 +7,7 @@ the {RGeo}[http://github.com/dazuma/rgeo] library to represent spatial
 data in Ruby. Like the standard postgresql adapter, this adapter requires
 the pg gem.
 
-=== Usage
-
-To use this adapter, add this gem, "activerecord-postgis-adapter", to
-your Gemfile, and then request the adapter name "postgis" 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 postgresql adapter.
+=== What This Adapter Provides
 
 First, this adapter extends the migration syntax to support creating 
 spatial columns and indexes. To create a spatial column, use the
@@ -83,19 +77,20 @@ You can also use WKT:
 
  rec = SpatialTable.where(:latlon => 'POINT(-122 47)').first
 
-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.
+Other types of queries (e.g. radius searches) currently must be written
+in SQL. We are investigating writing a set of Arel extensions for
+constructing arbitrary spatial queries. However, these extensions will
+probably require Rails 3.1.
 
-=== Installation
+=== Installing The Adapter Gem
 
 This adapter has the following requirements:
 
 * Ruby 1.8.7 or later. Ruby 1.9.2 or later preferred.
 * PostGIS 1.5 or later.
 * \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.2.2 or later.
 * pg gem 0.10 or later.
 
 Install this adapter as a gem:
@@ -105,6 +100,58 @@ Install this adapter as a gem:
 See the README for the "rgeo" gem, a required dependency, for further
 installation information.
 
+=== Setting Up The Adapter
+
+To use this adapter, add this gem, "activerecord-postgis-adapter", to
+your Gemfile, and then request the adapter name "postgis" in your
+database connection configuration (which, for a Rails application, is in
+the config/database.yml file).
+
+Furthermore, the PostGIS adapter includes a special railtie that provides
+support for PostGIS databases in ActiveRecord's rake tasks. This railtie
+is required in order to run, e.g., rake test. To install this railtie,
+you should add this line to your config/application.rb:
+
+ require 'rgeo/active_record/postgis_adapter/railtie'
+
+Note that this railtie must load after the ActiveRecord railtie. That is,
+the above require command should appear after <tt>require 'rails/all'</tt>.
+
+Besides the adapter name "postgis", most of the other database connection
+configuration parameters are the same as for the stock postgresql adapter.
+However, there are a few special parameters you may want to set.
+
+The <i>script_dir</i> parameter provides the path to the directory
+containing the SQL scripts for PostGIS installation. i.e. this could be
+<tt>/usr/local/share/contrib/postgis-1.5</tt>. This directory should
+contain the files <tt>postgis.sql</tt> and <tt>spatial_ref_sys.sql</tt>.
+It is used by the db:create rake task to add the PostGIS types, functions,
+and tables to a newly created database. If you do not provide this
+parameter, you will need to add these objects to the database manually.
+Generally, therefore, this parameter is required at least for the test
+database, which is usually automatically created by the rake tasks.
+
+Because PostGIS adds many objects to the database, you may encounter a few
+issues when running Rails rake tasks that manage databases. Specifically:
+
+* Dumping the structure as sql (rake db:structure:dump) may include all
+  the PostGIS definitions as well, cluttering your SQL dump.
+* Rake tasks that automatically create the test database (e.g. rake test)
+  may emit a number of errors because PostGIS definitions are being added
+  twice to the database: once on creation, and again because they are
+  showing up in the SQL dump that ActiveRecord uses to copy the schema.
+
+Because of these issues, it is recommended that you include the schema
+name "postgis" in the <i>schema_search_path</i> parameter. The PostGIS
+adapter treats this schema name as special, in that:
+
+* The db:create rake task will automatically create the "postgis" schema,
+  and will create all the PostGIS objects in that schema.
+* Dumping the structure as sql will omit objects in the "postgis" schema.
+
+As a result, the PostGIS definitions will no longer appear in the SQL
+dump file, effectively eliminating the above issues.
+
 === Known bugs and limitations
 
 A few minor holes still exist in this adapter. Notably, using \ActiveRecord

data/Version

@@ -1 +1 @@
-0.2.2
+0.2.3

data/lib/active_record/connection_adapters/postgis_adapter.rb

@@ -95,7 +95,7 @@ module ActiveRecord
       
       # The postgres drivers don't allow the creation of an unconnected PGconn object,
       # so just pass a nil connection object for the time being.
-      ConnectionAdapters::PostGisAdapter.new(nil, logger, [host_, port_, nil, nil, database_, username_, password_], config_)
+      ConnectionAdapters::PostgisAdapter.new(nil, logger, [host_, port_, nil, nil, database_, username_, password_], config_)
     end
     
     
@@ -105,7 +105,7 @@ module ActiveRecord
   module ConnectionAdapters  # :nodoc:
     
     
-    class PostGisAdapter < PostgreSQLAdapter  # :nodoc:
+    class PostgisAdapter < PostgreSQLAdapter  # :nodoc:
       
       
       ADAPTER_NAME = 'PostGIS'.freeze
@@ -416,7 +416,7 @@ module ActiveRecord
         
         
         def type_cast_code(var_name_)
-          type == :geometry ? "::ActiveRecord::ConnectionAdapters::PostGisAdapter::SpatialColumn.convert_to_geometry(#{var_name_}, self.class, #{name.inspect}, #{@geographic ? 'true' : 'false'}, #{@srid.inspect}, #{@has_z ? 'true' : 'false'}, #{@has_m ? 'true' : 'false'})" : super
+          type == :geometry ? "::ActiveRecord::ConnectionAdapters::PostgisAdapter::SpatialColumn.convert_to_geometry(#{var_name_}, self.class, #{name.inspect}, #{@geographic ? 'true' : 'false'}, #{@srid.inspect}, #{@has_z ? 'true' : 'false'}, #{@has_m ? 'true' : 'false'})" : super
         end
         
         
@@ -463,3 +463,8 @@ module ActiveRecord
   
   
 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')

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

@@ -0,0 +1,117 @@
+# -----------------------------------------------------------------------------
+# 
+# Rakefile changes for PostGIS 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 'rgeo/active_record/task_hacker'
+
+
+class Object
+  alias_method :create_database_without_postgis, :create_database
+  alias_method :drop_database_without_postgis, :drop_database
+end
+
+
+def create_database(config_)
+  if config_['adapter'] == 'postgis'
+    @encoding = config_['encoding'] || ::ENV['CHARSET'] || 'utf8'
+    begin
+      ::ActiveRecord::Base.establish_connection(config_.merge('database' => 'postgres', 'schema_search_path' => 'public'))
+      ::ActiveRecord::Base.connection.create_database(config_['database'], config_.merge('encoding' => @encoding))
+      ::ActiveRecord::Base.establish_connection(config_.merge('schema_search_path' => 'public'))
+      if (script_dir_ = config_['script_dir'])
+        conn_ = ::ActiveRecord::Base.connection
+        search_path_ = config_["schema_search_path"].to_s.strip
+        search_path_ = search_path_.split(",").map{ |sp_| sp_.strip }
+        if search_path_.include?('postgis')
+          conn_.execute('CREATE SCHEMA postgis')
+          conn_.execute('SET search_path TO postgis')
+        end
+        conn_.execute(::File.read(::File.expand_path('postgis.sql', script_dir_)))
+        conn_.execute(::File.read(::File.expand_path('spatial_ref_sys.sql', script_dir_)))
+      end
+      ::ActiveRecord::Base.establish_connection(config_)
+    rescue ::Exception => e_
+      $stderr.puts(e_, *(e_.backtrace))
+      $stderr.puts("Couldn't create database for #{config.inspect}")
+    end
+  else
+    create_database_without_postgis(config_)
+  end
+end
+
+
+def drop_database(config_)
+  if config_['adapter'] == 'postgis'
+    ::ActiveRecord::Base.establish_connection(config_.merge('database' => 'postgres', 'schema_search_path' => 'public'))
+    ::ActiveRecord::Base.connection.drop_database(config_['database'])
+  else
+    drop_database_without_postgis(config_)
+  end
+end
+
+
+::RGeo::ActiveRecord::TaskHacker.modify('db:charset', nil, 'postgis') do |config_|
+  ::ActiveRecord::Base.establish_connection(config_)
+  puts(::ActiveRecord::Base.connection.encoding)
+end
+
+
+::RGeo::ActiveRecord::TaskHacker.modify('db:structure:dump', nil, 'postgis') do |config_|
+  ::ENV['PGHOST'] = config_["host"] if config_["host"]
+  ::ENV['PGPORT'] = config_["port"].to_s if config_["port"]
+  ::ENV['PGPASSWORD'] = config_["password"].to_s if config_["password"]
+  search_path_ = config_["schema_search_path"].to_s.strip
+  search_path_ = search_path_.split(",").map{ |sp_| sp_.strip }
+  search_path_.delete('postgis')
+  search_path_ = ['public'] if search_path_.length == 0
+  search_path_ = search_path_.map{ |sp_| "--schema=#{sp_}" }.join(" ")
+  `pg_dump -i -U "#{config_["username"]}" -s -x -O -f db/#{::Rails.env}_structure.sql #{search_path_} #{config_["database"]}`
+  raise "Error dumping database" if $?.exitstatus == 1
+end
+
+
+::RGeo::ActiveRecord::TaskHacker.modify('db:test:clone_structure', 'test', 'postgis') do |config_|
+  ::ENV['PGHOST'] = config_["host"] if config_["host"]
+  ::ENV['PGPORT'] = config_["port"].to_s if config_["port"]
+  ::ENV['PGPASSWORD'] = config_["password"].to_s if config_["password"]
+  `psql -U "#{config_["username"]}" -f #{::Rails.root}/db/#{::Rails.env}_structure.sql #{config_["database"]}`
+end
+
+
+::RGeo::ActiveRecord::TaskHacker.modify('db:test:purge', 'test', 'postgis') do |config_|
+  ::ActiveRecord::Base.clear_active_connections!
+  drop_database(config_)
+  create_database(config_)
+end

data/lib/rgeo/active_record/postgis_adapter/railtie.rb

@@ -0,0 +1,58 @@
+# -----------------------------------------------------------------------------
+# 
+# Railtie for PostGIS 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 'rails/railtie'
+
+
+module RGeo
+  
+  module ActiveRecord
+    
+    module PostgisAdapter
+      
+      class Railtie < ::Rails::Railtie
+        
+        rake_tasks do
+          load "rgeo/active_record/postgis_adapter/databases.rake"
+        end
+        
+      end
+      
+    end
+    
+  end
+  
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 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-06 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,8 +28,8 @@ dependencies:
         segments: 
         - 0
         - 2
-        - 1
-        version: 0.2.1
+        - 2
+        version: 0.2.2
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -58,6 +58,8 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - lib/active_record/connection_adapters/postgis_adapter.rb
+- lib/rgeo/active_record/postgis_adapter/railtie.rb
+- lib/rgeo/active_record/postgis_adapter/databases.rake
 - History.rdoc
 - README.rdoc
 - test/tc_basic.rb