activerecord-spatialite-adapter 0.2.2 → 0.2.3

data/History.rdoc

@@ -1,3 +1,7 @@
+=== 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.)
+
 === 0.2.2 / 2010-12-27
 
 * Support for basic spatial equality queries. e.g. constructs such as:

data/README.rdoc

@@ -7,17 +7,7 @@ the {RGeo}[http://github.com/dazuma/rgeo] library to represent spatial
 data in Ruby. Like the standard sqlite3 adapter, this adapter requires
 the sqlite3-ruby gem.
 
-=== Usage
-
-To use this adapter, add this gem, "activerecord-spatialite-adapter",
-to your Gemfile, and then request the adapter name "spatialite" 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 sqlite3 adapter,
-with the exception of one additional parameter, <tt>libspatialite</tt>,
-which should be set to the full path to the libspatialite shared library,
-if it is not installed in a standard place (such as /usr/local or
-/opt/local).
+=== 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
@@ -89,15 +79,15 @@ 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.
 
-=== Installation
+=== Installing The Adapter Gem
 
 This adapter has the following requirements:
 
 * Ruby 1.8.7 or later. Ruby 1.9.2 or later preferred.
 * SpatiaLite 2.3 or later (2.4 recommended).
 * \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.
 * sqlite3 gem 1.3 or later.
 
 Install this adapter as a gem:
@@ -107,6 +97,28 @@ 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-spatialite-adapter",
+to your Gemfile, and then request the adapter name "spatialite" 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 sqlite3 adapter,
+with the exception of one additional parameter, <tt>libspatialite</tt>,
+which should be set to the full path to the libspatialite shared library,
+if it is not installed in a standard place (such as /usr/local or
+/opt/local).
+
+Furthermore, the SpatiaLite adapter includes a special railtie that
+provides support for SpatiaLite 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/spatialite_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>.
+
 === Known bugs and limitations
 
 The spatialite adapter works in principle, but there are a few known holes

data/Version

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

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

@@ -0,0 +1,100 @@
+# -----------------------------------------------------------------------------
+# 
+# Rakefile changes for SpatiaLite 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_spatialite, :create_database
+  alias_method :drop_database_without_spatialite, :drop_database
+end
+
+
+def create_database(config_)
+  if config_['adapter'] == 'spatialite'
+    if ::File.exist?(config_['database'])
+      $stderr.puts "#{config_['database']} already exists"
+    else
+      begin
+        # Create the SQLite database
+        ::ActiveRecord::Base.establish_connection(config_)
+        conn_ = ::ActiveRecord::Base.connection
+        conn_.execute('SELECT InitSpatialMetaData()')
+      rescue ::Exception => e_
+        $stderr.puts e_, *(e_.backtrace)
+        $stderr.puts "Couldn't create database for #{config_.inspect}"
+      end
+    end
+  else
+    create_database_without_spatialite(config_)
+  end
+end
+
+
+def drop_database(config_)
+  if config_['adapter'] == 'spatialite'
+    require 'pathname'
+    path_ = ::Pathname.new(config_['database'])
+    file_ = path_.absolute? ? path_.to_s : ::File.join(::Rails.root, path_)
+    ::FileUtils.rm(file_)
+  else
+    drop_database_without_spatialite(config_)
+  end
+end
+
+
+::RGeo::ActiveRecord::TaskHacker.modify('db:charset', nil, 'spatialite') do |config_|
+  ::ActiveRecord::Base.establish_connection(config_)
+  puts(::ActiveRecord::Base.connection.encoding)
+end
+
+
+::RGeo::ActiveRecord::TaskHacker.modify('db:structure:dump', nil, 'spatialite') do |config_|
+  dbfile_ = config_["database"] || config_["dbfile"]
+  `sqlite3 #{dbfile_} .schema > db/#{::Rails.env}_structure.sql`
+end
+
+
+::RGeo::ActiveRecord::TaskHacker.modify('db:test:clone_structure', 'test', 'spatialite') do |config_|
+  dbfile_ = config_["database"] || config_["dbfile"]
+  `sqlite3 #{dbfile_} < #{::Rails.root}/db/#{::Rails.env}_structure.sql`
+end
+
+
+::RGeo::ActiveRecord::TaskHacker.modify('db:test:purge', 'test', 'spatialite') do |config_|
+  dbfile_ = config_["database"] || config_["dbfile"]
+  ::File.delete(dbfile_) if ::File.exist?(dbfile_)
+end

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

@@ -0,0 +1,58 @@
+# -----------------------------------------------------------------------------
+# 
+# Railtie for SpatiaLite 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 SpatialiteAdapter
+      
+      class Railtie < ::Rails::Railtie
+        
+        rake_tasks do
+          load "rgeo/active_record/spatialite_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/spatialite_adapter.rb
+- lib/rgeo/active_record/spatialite_adapter/railtie.rb
+- lib/rgeo/active_record/spatialite_adapter/databases.rake
 - History.rdoc
 - README.rdoc
 - test/tc_basic.rb