activerecord-postgis-adapter 0.5.1 → 0.6.0

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

@@ -0,0 +1,220 @@
+# -----------------------------------------------------------------------------
+#
+# 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 ConnectionAdapters  # :nodoc:
+
+    module PostGISAdapter  # :nodoc:
+
+
+      class SpatialColumn < ConnectionAdapters::PostgreSQLColumn  # :nodoc:
+
+
+        def initialize(factory_settings_, table_name_, name_, default_, oid_type_, sql_type_=nil, null_=true, opts_=nil)
+          @factory_settings = factory_settings_
+          @table_name = table_name_
+          @geographic = sql_type_ =~ /geography/i ? true : false
+          if opts_
+            # This case comes from an entry in the geometry_columns table
+            @geometric_type = ::RGeo::ActiveRecord.geometric_type_from_name(opts_[:type]) ||
+              ::RGeo::Feature::Geometry
+            @srid = opts_[:srid].to_i
+            @has_z = opts_[:has_z] ? true : false
+            @has_m = opts_[:has_m] ? true : false
+          elsif @geographic
+            # Geographic type information is embedded in the SQL type
+            @geometric_type = ::RGeo::Feature::Geometry
+            @srid = 4326
+            @has_z = @has_m = false
+            if sql_type_ =~ /geography\((.*)\)$/i
+              params_ = $1.split(',')
+              if params_.size >= 2
+                if params_.first =~ /([a-z]+[^zm])(z?)(m?)/i
+                  @has_z = $2.length > 0
+                  @has_m = $3.length > 0
+                  @geometric_type = ::RGeo::ActiveRecord.geometric_type_from_name($1)
+                end
+                if params_.last =~ /(\d+)/
+                  @srid = $1.to_i
+                end
+              end
+            end
+          elsif sql_type_ =~ /geography|geometry|point|linestring|polygon/i
+            # Just in case there is a geometry column with no geometry_columns entry.
+            @geometric_type = ::RGeo::Feature::Geometry
+            @srid = @has_z = @has_m = nil
+          else
+            # Non-spatial column
+            @geometric_type = @has_z = @has_m = @srid = nil
+          end
+          super(name_, default_, oid_type_, sql_type_, null_)
+          if type == :spatial
+            if @srid
+              @limit = {:srid => @srid, :type => @geometric_type.type_name.underscore}
+              @limit[:has_z] = true if @has_z
+              @limit[:has_m] = true if @has_m
+              @limit[:geographic] = true if @geographic
+            else
+              @limit = {:no_constraints => true}
+            end
+          end
+        end
+
+
+        attr_reader :geographic
+        attr_reader :srid
+        attr_reader :geometric_type
+        attr_reader :has_z
+        attr_reader :has_m
+
+        alias_method :geographic?, :geographic
+        alias_method :has_z?, :has_z
+        alias_method :has_m?, :has_m
+
+
+        def spatial?
+          type == :spatial
+        end
+
+
+        def has_spatial_constraints?
+          !@srid.nil?
+        end
+
+
+        def klass
+          type == :spatial ? ::RGeo::Feature::Geometry : super
+        end
+
+
+        def type_cast(value_)
+          if type == :spatial
+            SpatialColumn.convert_to_geometry(value_, @factory_settings, @table_name, name,
+              @geographic, @srid, @has_z, @has_m)
+          else
+            super
+          end
+        end
+
+
+        private
+
+
+        def simplified_type(sql_type_)
+          sql_type_ =~ /geography|geometry|point|linestring|polygon/i ? :spatial : super
+        end
+
+
+        def self.convert_to_geometry(input_, factory_settings_, table_name_, column_, geographic_, srid_, has_z_, has_m_)
+          if srid_
+            constraints_ = {:geographic => geographic_, :has_z_coordinate => has_z_,
+              :has_m_coordinate => has_m_, :srid => srid_}
+          else
+            constraints_ = nil
+          end
+          if ::RGeo::Feature::Geometry === input_
+            factory_ = factory_settings_.get_column_factory(table_name_, column_, constraints_)
+            ::RGeo::Feature.cast(input_, factory_) rescue nil
+          elsif input_.respond_to?(:to_str)
+            input_ = input_.to_str
+            if input_.length == 0
+              nil
+            else
+              factory_ = factory_settings_.get_column_factory(table_name_, column_, constraints_)
+              marker_ = input_[0,1]
+              if marker_ == "\x00" || marker_ == "\x01" || input_[0,4] =~ /[0-9a-fA-F]{4}/
+                ::RGeo::WKRep::WKBParser.new(factory_, :support_ewkb => true).parse(input_) rescue nil
+              else
+                ::RGeo::WKRep::WKTParser.new(factory_, :support_ewkt => true).parse(input_) rescue nil
+              end
+            end
+          else
+            nil
+          end
+        end
+
+
+      end
+
+
+      # Register spatial types with the postgres OID mechanism
+      # so we can recognize custom columns coming from the database.
+
+      class SpatialOID < PostgreSQLAdapter::OID::Type  # :nodoc:
+
+        def initialize(factory_generator_)
+          @factory_generator = factory_generator_
+        end
+
+        def type_cast(value_)
+          return if value_.nil?
+          ::RGeo::WKRep::WKBParser.new(@factory_generator, :support_ewkb => true).parse(value_) rescue nil
+        end
+
+      end
+
+      PostgreSQLAdapter::OID.register_type('geometry', SpatialOID.new(nil))
+      PostgreSQLAdapter::OID.register_type('geography', SpatialOID.new(::RGeo::Geographic.method(:spherical_factory)))
+
+
+      # This is a hack to ActiveRecord::ModelSchema. We have to "decorate" the decorate_columns
+      # method to apply class-specific customizations to spatial type casting.
+
+      module DecorateColumnsModification  # :nodoc:
+
+        def decorate_columns(columns_hash_)
+          columns_hash_ = super(columns_hash_)
+          return unless columns_hash_
+          canonical_columns_ = self.columns_hash
+          columns_hash_.each do |name_, col_|
+            if col_.is_a?(SpatialOID) && (canonical_ = canonical_columns_[name_]) && canonical_.spatial?
+              columns_hash_[name_] = canonical_
+            end
+          end
+          columns_hash_
+        end
+
+      end
+
+      ::ActiveRecord::Base.extend(DecorateColumnsModification)
+
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,140 @@
+# -----------------------------------------------------------------------------
+#
+# 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 ConnectionAdapters  # :nodoc:
+
+    module PostGISAdapter  # :nodoc:
+
+
+      class SpatialTableDefinition < ConnectionAdapters::PostgreSQLAdapter::TableDefinition  # :nodoc:
+
+        def column(name_, type_, options_={})
+          if (info_ = @base.spatial_column_constructor(type_.to_sym))
+            type_ = options_[:type] || info_[:type] || type_
+            if type_.to_s == 'geometry' &&
+              (options_[:no_constraints] ||
+               options_[:limit].is_a?(::Hash) && options_[:limit][:no_constraints])
+            then
+              options_.delete(:limit)
+            else
+              options_[:type] = type_
+              type_ = :spatial
+            end
+          end
+          super(name_, type_, options_)
+          if type_ == :spatial
+            col_ = self[name_]
+            col_.extend(SpatialColumnDefinitionMethods) unless col_.respond_to?(:geographic?)
+            options_.merge!(col_.limit) if col_.limit.is_a?(::Hash)
+            col_.set_spatial_type(options_[:type])
+            col_.set_geographic(options_[:geographic])
+            col_.set_srid(options_[:srid])
+            col_.set_has_z(options_[:has_z])
+            col_.set_has_m(options_[:has_m])
+          end
+          self
+        end
+
+        def to_sql
+          @columns.find_all{ |c_| !c_.respond_to?(:geographic?) || c_.geographic? }.map{ |c_| c_.to_sql } * ', '
+        end
+
+        def non_geographic_spatial_columns
+          @columns.find_all{ |c_| c_.respond_to?(:geographic?) && !c_.geographic? }
+        end
+
+      end
+
+
+      module SpatialColumnDefinitionMethods  # :nodoc:
+
+        def spatial_type
+          @spatial_type
+        end
+
+        def geographic?
+          @geographic
+        end
+
+        def srid
+          @srid ? @srid.to_i : (geographic? ? 4326 : -1)
+        end
+
+        def has_z?
+          @has_z
+        end
+
+        def has_m?
+          @has_m
+        end
+
+        def set_geographic(value_)
+          @geographic = value_ ? true : false
+        end
+
+        def set_spatial_type(value_)
+          @spatial_type = value_.to_s
+        end
+
+        def set_srid(value_)
+          @srid = value_
+        end
+
+        def set_has_z(value_)
+          @has_z = value_ ? true : false
+        end
+
+        def set_has_m(value_)
+          @has_m = value_ ? true : false
+        end
+
+        def sql_type
+          type_ = spatial_type.upcase.gsub('_', '')
+          type_ << 'Z' if has_z?
+          type_ << 'M' if has_m?
+          "GEOGRAPHY(#{type_},#{srid})"
+        end
+
+      end
+
+
+    end
+
+  end
+
+end

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

@@ -1,6 +1,6 @@
 # -----------------------------------------------------------------------------
 #
-# Railtie for PostGIS adapter
+# PostGIS adapter for Rails 3.x
 #
 # -----------------------------------------------------------------------------
 # Copyright 2010-2012 Daniel Azuma
@@ -35,30 +35,5 @@
 
 
 require 'rails/railtie'
-
-
-# :stopdoc:
-
-module ActiveRecord
-
-  module ConnectionAdapters
-
-    module PostGISAdapter
-
-
-      class Railtie < ::Rails::Railtie
-
-        rake_tasks do
-          load ::File.expand_path('databases.rake', ::File.dirname(__FILE__))
-        end
-
-      end
-
-
-    end
-
-  end
-
-end
-
-# :startdoc:
+require 'active_record/connection_adapters/postgis_adapter'
+load 'active_record/connection_adapters/postgis_adapter/shared/railtie'

data/lib/active_record/connection_adapters/postgis_adapter/{arel_tosql.rb → shared/arel_tosql.rb}

@@ -34,12 +34,10 @@
 ;
 
 
-# :stopdoc:
+module Arel  # :nodoc:
+  module Visitors  # :nodoc:
 
-module Arel
-  module Visitors
-
-    class PostGIS < PostgreSQL
+    class PostGIS < PostgreSQL  # :nodoc:
 
       FUNC_MAP = {
         'st_wkttosql' => 'ST_GeomFromEWKT',
@@ -59,5 +57,3 @@ module Arel
 
   end
 end
-
-# :startdoc:

data/lib/active_record/connection_adapters/postgis_adapter/shared/jdbc_compat.rb

@@ -0,0 +1,133 @@
+# -----------------------------------------------------------------------------
+#
+# 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 ConnectionAdapters  # :nodoc:
+
+
+    # Extend JDBC's PostgreSQLAdapter implementation for compatibility with
+    # ActiveRecord's default PostgreSQLAdapter.
+
+    class PostgreSQLAdapter  # :nodoc:
+
+
+      # Add `query` method for compatibility
+
+      def query(*args)
+        select_rows(*args)
+      end
+
+
+      # Backport from master, so PostGIS adapater will work with current stable
+      # activerecord-jdbc-adapter gem.
+      #
+      # https://github.com/jruby/activerecord-jdbc-adapter/pull/200
+
+      unless method_defined?(:schema_search_path=)
+        def schema_search_path=(schema_csv)
+          if schema_csv
+            execute "SET search_path TO #{schema_csv}"
+            @schema_search_path = schema_csv
+          end
+        end
+      end
+
+
+      # Backport from master, so PostGIS adapater will work with current stable
+      # activerecord-jdbc-adapter gem.
+      #
+      # https://github.com/jruby/activerecord-jdbc-adapter/pull/200
+
+      unless method_defined?(:schema_search_path)
+        # Returns the active schema search path.
+        def schema_search_path
+          @schema_search_path ||= exec_query('SHOW search_path', 'SCHEMA')[0]['search_path']
+        end
+      end
+
+
+      # For ActiveRecord 3.1 compatibility: Add the "postgis" adapter to the
+      # matcher of jdbc-like adapters.
+
+      def self.visitor_for(pool)
+        config = pool.spec.config
+        adapter = config[:adapter]
+        adapter_spec = config[:adapter_spec] || self
+        if adapter =~ /^(jdbc|jndi|postgis)$/
+          adapter_spec.arel2_visitors(config).values.first.new(pool)
+        else
+          adapter_spec.arel2_visitors(config)[adapter].new(pool)
+        end
+      end
+
+
+    end
+
+
+    module PostGISAdapter  # :nodoc:
+
+
+      # Based on the default <tt>postgresql_connection</tt> definition from
+      # activerecord-jdbc-adapter
+
+      def self.create_jdbc_connection(context_, 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_ = context_.jdbc_connection(config_)
+        conn_.execute("SET SEARCH_PATH TO #{config_[:schema_search_path]}") if config_[:schema_search_path]
+        conn_
+      end
+
+
+    end
+
+
+  end
+
+end