activerecord-spatialite-adapter 0.4.0 → 0.4.1

data/History.rdoc

@@ -1,3 +1,12 @@
+=== 0.4.1 / 2012-03-17
+
+* Some compatibility fixes for Rails 3.2.
+* Geometry columns were "not null" by default. Fixed. (Patch by michael-groble.)
+* Fixed exception on inserting nil values. (Patch by michael-groble.)
+* No longer raises exceptions on driver versions that don't support enable_load_extension. (Patch by michael-groble.)
+* Now requires rgeo-activerecord 0.4.3.
+* Includes instructions for running the tests. (Thanks to vgeorge for the suggestions.)
+
 === 0.4.0 / 2011-08-15
 
 * Various fixes for Rails 3.1 compatibility.

data/README.rdoc

@@ -97,12 +97,20 @@ 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.
-* SpatiaLite 2.3 or later (2.4 recommended).
-* sqlite3 gem 1.3.3 or later.
+* sqlite 3.7.3 or later.
+* SpatiaLite 3.0 or later. Version 2.3 may work but is not officially
+  supported.
+* sqlite3 gem 1.3.5 or later.
 * \ActiveRecord 3.0.3 or later. Earlier versions will not work.
-  Appears to be compatible with Rails 3.1rc5.
-* rgeo gem 0.3.2 or later.
-* rgeo-activerecord gem 0.4.0 or later.
+  Should be compatible with Rails versions through 3.2.x.
+* rgeo gem 0.3.7 or later.
+* rgeo-activerecord gem 0.4.3 or later.
+
+Note: if you are running Mac OS X, the OS-provided copy of sqlite3 may
+not support extensions. You should install an alternate copy of sqlite3
+(for example, using MacPorts or Homebrew) reinstall the gem using:
+
+  gem install sqlite3 -- --with-sqlite3-dir=/path/to/alternate/sqlite3
 
 Install this adapter as a gem:
 
@@ -203,11 +211,11 @@ Contact the author at dazuma at gmail dot com.
 The SpatiaLite Adapter and its supporting libraries (including RGeo) are
 written by Daniel Azuma (http://www.daniel-azuma.com).
 
-Development of RGeo is sponsored by GeoPage, Inc. (http://www.geopage.com).
+Development is supported by Pirq. (http://www.pirq.com).
 
 === License
 
-Copyright 2010-2011 Daniel Azuma
+Copyright 2010-2012 Daniel Azuma
 
 All rights reserved.
 

data/Version

@@ -1 +1 @@
-0.4.0
+0.4.1

data/lib/active_record/connection_adapters/spatialite_adapter.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # SpatiaLite adapter for ActiveRecord
-# 
+#
 # -----------------------------------------------------------------------------
 # 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,
@@ -18,7 +18,7 @@
 # * 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
@@ -42,16 +42,16 @@ require 'active_record/connection_adapters/sqlite3_adapter'
 # connection adapter into ActiveRecord.
 
 module ActiveRecord
-  
-  
+
+
   # ActiveRecord looks for the spatialite_connection factory method in
   # this class.
-  
+
   class Base
-    
-    
+
+
     # Create a spatialite connection adapter.
-    
+
     def self.spatialite_connection(config_)
       unless 'spatialite' == config_[:adapter]
         raise ::ArgumentError, 'adapter name should be "spatialite"'
@@ -59,20 +59,17 @@ module ActiveRecord
       unless config_[:database]
         raise ::ArgumentError, "No database file specified. Missing argument: database"
       end
-      
+
       # Allow database path relative to Rails.root, but only if
       # the database path is not the special path that tells
       # Sqlite to build a database only in memory.
       if defined?(::Rails.root) && ':memory:' != config_[:database]
         config_[:database] = ::File.expand_path(config_[:database], ::Rails.root)
       end
-      
-      unless self.class.const_defined?(:SQLite3)
-        require_library_or_gem('sqlite3')
-      end
+
       db_ = ::SQLite3::Database.new(config_[:database], :results_as_hash => true)
       db_.busy_timeout(config_[:timeout]) unless config_[:timeout].nil?
-      
+
       # Load SpatiaLite
       path_ = config_[:libspatialite]
       if path_ && (!::File.file?(path_) || !::File.readable?(path_))
@@ -92,30 +89,32 @@ module ActiveRecord
       unless path_
         raise 'Cannot find libspatialite in the usual places. Please provide the path in the "libspatialite" config parameter.'
       end
-      db_.enable_load_extension(1)
-      db_.load_extension(path_)
-      
+      if db_.respond_to?(:enable_load_extension)
+        db_.enable_load_extension(1)
+        db_.load_extension(path_)
+      end
+
       ::ActiveRecord::ConnectionAdapters::SpatiaLiteAdapter::MainAdapter.new(db_, logger, config_)
     end
-    
-    
+
+
   end
-  
-  
+
+
   # All ActiveRecord adapters go in this namespace.
   module ConnectionAdapters
-    
+
     # The SpatiaLite Adapter
     module SpatiaLiteAdapter
-      
+
       # The name returned by the adapter_name method of this adapter.
       ADAPTER_NAME = 'SpatiaLite'.freeze
-      
+
     end
-    
+
   end
-  
-  
+
+
 end
 
 

data/lib/active_record/connection_adapters/spatialite_adapter/arel_tosql.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # SpatiaLite adapter for ActiveRecord
-# 
+#
 # -----------------------------------------------------------------------------
 # 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,
@@ -18,7 +18,7 @@
 # * 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
@@ -38,23 +38,23 @@
 
 module Arel
   module Visitors
-    
+
     class SpatiaLite < SQLite
-      
+
       FUNC_MAP = {
         'st_wkttosql' => 'GeomFromText',
       }
-      
+
       include ::RGeo::ActiveRecord::SpatialToSql
-      
+
       def st_func(standard_name_)
         FUNC_MAP[standard_name_.downcase] || standard_name_
       end
-      
+
     end
-    
+
     VISITORS['spatialite'] = ::Arel::Visitors::SpatiaLite
-    
+
   end
 end
 

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

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # 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,
@@ -18,7 +18,7 @@
 # * 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

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

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # SpatiaLite adapter for ActiveRecord
-# 
+#
 # -----------------------------------------------------------------------------
 # 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,
@@ -18,7 +18,7 @@
 # * 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
@@ -37,48 +37,57 @@
 # :stopdoc:
 
 module ActiveRecord
-  
+
   module ConnectionAdapters
-    
+
     module SpatiaLiteAdapter
-      
-      
+
+
       class MainAdapter < SQLite3Adapter
-        
-        
+
+
         @@native_database_types = nil
-        
-        
+
+
+        def initialize(*args_)
+          super
+          # Rails 3.2 way of defining the visitor: do so in the constructor
+          if defined?(@visitor) && @visitor
+            @visitor = ::Arel::Visitors::SpatiaLite.new(self)
+          end
+        end
+
+
         def set_rgeo_factory_settings(factory_settings_)
           @rgeo_factory_settings = factory_settings_
         end
-        
-        
+
+
         def adapter_name
           SpatiaLiteAdapter::ADAPTER_NAME
         end
-        
-        
+
+
         def spatial_column_constructor(name_)
           ::RGeo::ActiveRecord::DEFAULT_SPATIAL_COLUMN_CONSTRUCTORS[name_]
         end
-        
-        
+
+
         def native_database_types
           @@native_database_types ||= super.merge(:spatial => {:name => 'geometry'})
         end
-        
-        
+
+
         def spatialite_version
           @spatialite_version ||= SQLiteAdapter::Version.new(select_value('SELECT spatialite_version()'))
         end
-        
-        
+
+
         def srs_database_columns
           {:name_column => 'ref_sys_name', :proj4text_column => 'proj4text', :auth_name_column => 'auth_name', :auth_srid_column => 'auth_srid'}
         end
-        
-        
+
+
         def quote(value_, column_=nil)
           if ::RGeo::Feature::Geometry.check_type(value_)
             "GeomFromWKB(X'#{::RGeo::WKRep::WKBGenerator.new(:hex_format => true).generate(value_)}', #{value_.srid})"
@@ -86,8 +95,8 @@ module ActiveRecord
             super
           end
         end
-        
-        
+
+
         def substitute_at(column_, index_)
           if column_.spatial?
             ::Arel.sql('GeomFromText(?,?)')
@@ -95,8 +104,8 @@ module ActiveRecord
             super
           end
         end
-        
-        
+
+
         def type_cast(value_, column_)
           if column_.spatial? && ::RGeo::Feature::Geometry.check_type(value_)
             ::RGeo::WKRep::WKTGenerator.new(:convert_case => :upper).generate(value_)
@@ -104,22 +113,22 @@ module ActiveRecord
             super
           end
         end
-        
-        
+
+
         def exec_query(sql_, name_=nil, binds_=[])
           real_binds_ = []
           binds_.each do |bind_|
             if bind_[0].spatial?
               real_binds_ << bind_
-              real_binds_ << [bind_[0], bind_[1].srid]
+              real_binds_ << [bind_[0], bind_[1] ? bind_[1].srid : nil]
             else
               real_binds_ << bind_
             end
           end
           super(sql_, name_, real_binds_)
         end
-        
-        
+
+
         def columns(table_name_, name_=nil)  #:nodoc:
           spatial_info_ = spatial_column_info(table_name_)
           table_structure(table_name_).map do |field_|
@@ -132,8 +141,8 @@ module ActiveRecord
             col_
           end
         end
-        
-        
+
+
         def indexes(table_name_, name_=nil)
           results_ = super.map do |index_|
             ::RGeo::ActiveRecord::SpatialIndexDefinition.new(index_.table, index_.name, index_.unique, index_.columns, index_.lengths)
@@ -145,8 +154,8 @@ module ActiveRecord
             ::RGeo::ActiveRecord::SpatialIndexDefinition.new(table_name_, n_, false, [col_name_], [], true)
           end
         end
-        
-        
+
+
         def create_table(table_name_, options_={})
           table_name_ = table_name_.to_s
           table_definition_ = SpatialTableDefinition.new(self)
@@ -155,40 +164,42 @@ module ActiveRecord
           if options_[:force] && table_exists?(table_name_)
             drop_table(table_name_, options_)
           end
-          
+
           create_sql_ = "CREATE#{' TEMPORARY' if options_[:temporary]} TABLE "
           create_sql_ << "#{quote_table_name(table_name_)} ("
           create_sql_ << table_definition_.to_sql
           create_sql_ << ") #{options_[:options]}"
           execute create_sql_
-          
+
           table_definition_.spatial_columns.each do |col_|
-            execute("SELECT AddGeometryColumn('#{quote_string(table_name_)}', '#{quote_string(col_.name.to_s)}', #{col_.srid}, '#{quote_string(col_.spatial_type.gsub('_','').upcase)}', 'XY', #{col_.null ? 0 : 1})")
+            null_ = col_.null.nil? ? true : col_.null
+            execute("SELECT AddGeometryColumn('#{quote_string(table_name_)}', '#{quote_string(col_.name.to_s)}', #{col_.srid}, '#{quote_string(col_.spatial_type.gsub('_','').upcase)}', 'XY', #{null_ ? 0 : 1})")
           end
         end
-        
-        
-        def drop_table(table_name_, options_={})
+
+
+        def drop_table(table_name_, *options_)
           indexes(table_name_).each do |index_|
             remove_index(table_name_, :spatial => true, :column => index_.columns[0]) if index_.spatial
           end
           execute("DELETE from geometry_columns where f_table_name='#{quote_string(table_name_.to_s)}'")
           super
         end
-        
-        
+
+
         def add_column(table_name_, column_name_, type_, options_={})
           if (info_ = spatial_column_constructor(type_.to_sym))
             limit_ = options_[:limit]
             options_.merge!(limit_) if limit_.is_a?(::Hash)
             type_ = (options_[:type] || info_[:type] || type_).to_s.gsub('_', '').upcase
-            execute("SELECT AddGeometryColumn('#{quote_string(table_name_.to_s)}', '#{quote_string(column_name_.to_s)}', #{options_[:srid].to_i}, '#{quote_string(type_.to_s)}', 'XY', #{options_[:null] == false ? 0 : 1})")
+            null_ = options_[:null].nil? ? true : options_[:null]
+            execute("SELECT AddGeometryColumn('#{quote_string(table_name_.to_s)}', '#{quote_string(column_name_.to_s)}', #{options_[:srid].to_i}, '#{quote_string(type_.to_s)}', 'XY', #{null_ ? 0 : 1})")
           else
             super
           end
         end
-        
-        
+
+
         def add_index(table_name_, column_name_, options_={})
           if options_[:spatial]
             column_name_ = column_name_.first if column_name_.kind_of?(::Array) && column_name_.size == 1
@@ -207,8 +218,8 @@ module ActiveRecord
             super
           end
         end
-        
-        
+
+
         def remove_index(table_name_, options_={})
           if options_[:spatial]
             table_name_ = table_name_.to_s
@@ -242,8 +253,8 @@ module ActiveRecord
             super
           end
         end
-        
-        
+
+
         def spatial_column_info(table_name_)
           info_ = execute("SELECT * FROM geometry_columns WHERE f_table_name='#{quote_string(table_name_.to_s)}'")
           result_ = {}
@@ -258,15 +269,15 @@ module ActiveRecord
           end
           result_
         end
-        
-        
+
+
       end
-      
-      
+
+
     end
-    
+
   end
-  
+
 end
 
 # :startdoc: