rgeo-ar 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6450384669367d1c94d13c408784df96c62f410
+  data.tar.gz: a569d6e0b7c8ed5f0bf2981e15d8df5c3877c353
+SHA512:
+  metadata.gz: 8cb09d66ed6ffcc134563e065f95b0d1311cd672fe49cec0aa0e3bd57ad6ede7ad83ebb8b1301418dce2511dfa366306012c6c4c3127e6f0e1a0d413e2b25606
+  data.tar.gz: e6b2c1824c98ad1f8004d51c9fa4cab9ee1ce19b42ba089ad603b5e56b5ccac6a4b2ce50849e58cf6ff9ba8436cc5f385b824fb3fc60e5d2a37324bf814bc699

data/History.rdoc

@@ -0,0 +1,98 @@
+=== 0.5.0 / 2013-02-27
+
+* No changes. Rereleased as 0.5.0 final.
+
+=== 0.5.0.beta2 / 2013-02-04
+
+* Revert change made to SpatialIndexDefinition in beta1.
+* Fix some deprecations in the post-test cache cleanup.
+
+=== 0.5.0.beta1 / 2013-02-04
+
+* Updates for compatibility with Rails 4 and support of Rails 4 oriented adapters.
+* Testing tool is better factored to allow customization of cleanup
+
+=== 0.4.6 / 2012-12-11
+
+* You can now provide both a default and an override database config file in the test helper.
+* The gemspec no longer includes the timestamp in the version, so that bundler can pull from github. (Reported by corneverbruggen)
+
+=== 0.4.5 / 2012-04-13
+
+* Task hacker failed ungracefully when attempting to hack a nonexistent task. Fixed.
+
+=== 0.4.4 / 2012-04-12
+
+* Support cartesian bounding boxes in queries.
+
+=== 0.4.3 / 2012-02-22
+
+* Some fixes for Rails 3.2 compatibility.
+
+=== 0.4.2 / 2012-01-09
+
+* Added an "rgeo-activerecord.rb" wrapper so bundler's auto-require will work without modification. (Reported by Mauricio Pasquier Juan.)
+* Fixed unit tests so they actually pass...
+
+=== 0.4.1 / 2011-10-26
+
+* Fixed wrong variable name crash in rgeo_factory_for_column (patch by Andy Allan).
+
+=== 0.4.0 / 2011-08-15
+
+* Several compatibility fixes for Rails 3.1.
+* Revamped factory setter mechanism with a system that should be more robust.
+* Some general code cleanup.
+
+=== 0.3.4 / 2011-05-23
+
+* Uses the mixin feature of RGeo 0.3 to add an as_json method to all geometry objects. This should allow ActiveRecord's JSON serialization to function for models with geometry fields. (Reported by thenetduck and tonyc on github.)
+
+=== 0.3.3 / 2011-04-11
+
+* A .gemspec file is now available for gem building and bundler git integration.
+
+=== 0.3.2 / 2011-02-28
+
+* Fixed a bug that sometimes caused spatial column detection to fail, which could result in exceptions or incorrect spatial queries.
+
+=== 0.3.1 / 2011-02-28
+
+* Fixed a bug that could cause some spatial ActiveRecord adapters to fail to create multiple spatial columns in a migration.
+
+=== 0.3.0 / 2011-01-26
+
+* Experimental support for complex spatial queries. (Requires Arel 2.1, which is expected to be released with Rails 3.1.) Currently, only a low-level Arel-based interface is supported.
+* Better support for geography types in PostGIS.
+* Adapters can now define additional column constructors.
+* Support for spatial column constructors on change_table.
+* Fixed column type inference for some cases where the column included Z and/or M.
+* IS NULL predicates now work properly with spatial types.
+* Preferred attribute type is now :spatial rather than :geometry.
+* The gem version is now accessible via an api.
+* Some code reorganization.
+
+=== 0.2.4 / 2011-01-13
+
+* Fixed a problem that caused a hang during rake db:rollback, as well as probably certain other functions that use ActiveRecord::Base directly rather than a subclass. (Reported by Alexander Graefe.)
+
+=== 0.2.3 / 2011-01-07
+
+* Updated gem dependencies to include Arel 2.0.6, since some earlier Arel versions weren't working. (Reported by Pirmin Kalberer.)
+
+=== 0.2.2 / 2011-01-06
+
+* Some adjustments to the Arel integration for future Arel compatibility. (Thanks to Aaron Patterson.)
+* Support code for hacking ActiveRecord's rake tasks.
+
+=== 0.2.1 / 2010-12-27
+
+* Support for RGeo features as nodes in the Arel AST.
+* Basic utility Arel visitor methods for handling spatial equality nodes in where-expressions.
+
+=== 0.2.0 / 2010-12-07
+
+* Initial public alpha release. Spun rgeo-activerecord off from the core rgeo gem.
+* Support for setting factory by column.
+
+For earlier history, see the History file for the rgeo gem.

data/README.rdoc

@@ -0,0 +1,95 @@
+== RGeo::ActiveRecord
+
+
+RGeo::ActiveRecord is an optional {RGeo}[http://github.com/dazuma/rgeo]
+module providing spatial extensions for \ActiveRecord, as well as a set
+of helpers for writing spatial \ActiveRecord adapters based on \RGeo.
+
+==== FORK NOTICE
+
+This project is released as the `rgeo-ar` gem. It only works
+with ActiveRecord 4.1+. It works with this PostGIS ActiveRecord extension:
+https://github.com/neighborland/activerecord-postgis-adapter
+
+
+=== Summary
+
+\RGeo is a key component for writing location-aware applications in the
+Ruby programming language. At its core is an implementation of the
+industry standard OGC Simple Features Specification, which provides data
+representations of geometric objects such as points, lines, and polygons,
+along with a set of geometric analysis operations. See the README for the
+"rgeo" gem for more information.
+
+RGeo::ActiveRecord is an optional \RGeo add-on module providing spatial
+extensions for \ActiveRecord, as well as a set of helpers for writing
+spatial \ActiveRecord adapters based on \RGeo.
+
+=== Installation
+
+RGeo::ActiveRecord has the following requirements:
+
+* Ruby 2.0.0+
+* rgeo 0.3.20+
+* ActiveRecord 4.1.0+
+* arel 5.0.0+
+
+Generally, \ActiveRecord adapters which depend on this module should be
+installed as gems, and they will install this module automatically as
+a dependency. However, you can also install it manually as a gem:
+
+  gem install rgeo
+  gem install rgeo-ar
+
+See the README for the "rgeo" gem, a required dependency, for further
+installation information.
+
+=== Development and support
+
+Documentation is available at http://dazuma.github.com/rgeo-activerecord/rdoc
+
+Original source code is hosted on Github at http://github.com/dazuma/rgeo-activerecord
+
+Contributions are welcome. Fork the project on Github.
+
+Report bugs on Github issues at http://github.org/dazuma/rgeo-activerecord/issues
+
+Support available on the rgeo-users google group at http://groups.google.com/group/rgeo-users
+
+Contact the author at dazuma at gmail dot com.
+
+=== Acknowledgments
+
+\RGeo is written by Daniel Azuma (http://www.daniel-azuma.com).
+
+Development is supported by Pirq. (http://pirq.com).
+
+=== License
+
+Copyright 2010-2013 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.

data/lib/rgeo/active_record/adapter_test_helper.rb

@@ -0,0 +1,186 @@
+# -----------------------------------------------------------------------------
+#
+# Helper methods for ActiveRecord adapter tests
+#
+# -----------------------------------------------------------------------------
+# 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.
+# -----------------------------------------------------------------------------
+;
+
+
+require 'rgeo/active_record'
+require 'yaml'
+require 'logger'
+
+
+module RGeo
+  module ActiveRecord
+
+
+    # A helper module for creating unit tests for adapters.
+
+    module AdapterTestHelper
+
+      @class_num = 0
+
+
+      # When this module is included in a test case class, it
+      # automatically attempts to load the database config file from the
+      # path specified by constants defined in the class. It first tries
+      # OVERRIDE_DATABASE_CONFIG_PATH, and then falls back on
+      # DATABASE_CONFIG_PATH.
+      # It then defines the DATABASE_CONFIG and DEFAULT_AR_CLASS constants
+      # in the testcase class.
+      #
+      # When you define your test methods, you should wrap them in a call
+      # to the class method define_test_methods. This will cause them to
+      # be defined conditionally based on whether the database config is
+      # present.
+
+      def self.included(klass_)
+        database_config_ = ::YAML.load_file(klass_.const_get(:OVERRIDE_DATABASE_CONFIG_PATH)) rescue nil
+        database_config_ ||= ::YAML.load_file(klass_.const_get(:DATABASE_CONFIG_PATH)) rescue nil
+        if database_config_
+          database_config_.stringify_keys!
+          if klass_.respond_to?(:before_open_database)
+            klass_.before_open_database(:config => database_config_)
+          end
+          klass_.const_set(:DATABASE_CONFIG, database_config_)
+          ar_class_ = AdapterTestHelper.new_class(database_config_)
+          klass_.const_set(:DEFAULT_AR_CLASS, ar_class_)
+          if klass_.respond_to?(:initialize_database)
+            klass_.initialize_database(:ar_class => ar_class_, :connection => ar_class_.connection)
+          end
+          def klass_.define_test_methods
+            yield
+          end
+        else
+          def klass_.define_test_methods
+            def test_warning
+              puts "WARNING: Couldn't find database.yml; skipping tests."
+            end
+          end
+        end
+      end
+
+
+      def self.new_class(param_)  # :nodoc:
+        base_ = param_.kind_of?(::Class) ? param_ : ::ActiveRecord::Base
+        config_ = param_.kind_of?(::Hash) ? param_ : nil
+        klass_ = ::Class.new(base_)
+        @class_num += 1
+        self.const_set("Klass#{@class_num}".to_sym, klass_)
+        klass_.class_eval do
+          establish_connection(config_) if config_
+          self.table_name = :spatial_test
+        end
+        klass_
+      end
+
+
+      # Default setup method that calls cleanup_tables.
+      # It also defines a couple of useful factories: @factory (a
+      # cartesian factory) and @geographic_factory (a spherical factory)
+
+      def setup
+        @factory = ::RGeo::Cartesian.preferred_factory(:srid => 3785)
+        @geographic_factory = ::RGeo::Geographic.spherical_factory(:srid => 4326)
+        cleanup_tables
+        cleanup_caches
+      end
+
+
+      # Default teardown method that calls cleanup_tables.
+
+      def teardown
+        cleanup_tables
+        cleanup_caches
+      end
+
+
+      # Utility method that attempts to clean up any table that was
+      # created by a test method. Normally called automatically at setup
+      # and teardown. If you override those methods, you'll need to call
+      # this from your method.
+
+      def cleanup_tables
+        klass_ = self.class.const_get(:DEFAULT_AR_CLASS)
+        if klass_.connection.tables.include?('spatial_test')
+          klass_.connection.drop_table(:spatial_test)
+        end
+      end
+
+
+      # Utility method that cleans up any schema info that was cached by
+      # ActiveRecord during a test. Normally called automatically at setup
+      # and teardown. If you override those methods, you'll need to call
+      # this from your method.
+
+      def cleanup_caches
+        klass_ = self.class.const_get(:DEFAULT_AR_CLASS)
+
+        # Clear any RGeo factory settings.
+        klass_.connection_pool.rgeo_factory_settings.clear!
+
+        # Clear out any ActiveRecord caches that are present.
+        # Different Rails versions use different types of caches.
+        has_schema_cache_ = false
+        klass_.connection_pool.with_connection do |c_|
+          if c_.respond_to?(:schema_cache)
+            # 3.2.x and 4.0.x
+            c_.schema_cache.clear!
+            has_schema_cache_ = true
+          end
+          if c_.respond_to?(:clear_cache!)
+            # 3.1 and above
+            c_.clear_cache!
+          end
+          # All 3.x and 4.0
+          c_.clear_query_cache
+        end
+        if !has_schema_cache_ && klass_.connection_pool.respond_to?(:clear_cache!)
+          # 3.1.x only
+          klass_.connection_pool.clear_cache!
+        end
+      end
+
+
+      # Utility method that creates and returns a new ActiveRecord class
+      # subclassing the DEFAULT_AR_CLASS.
+
+      def create_ar_class(opts_={})
+        @ar_class = AdapterTestHelper.new_class(self.class.const_get(:DEFAULT_AR_CLASS))
+      end
+
+
+    end
+
+
+  end
+end

data/lib/rgeo/active_record/ar_factory_settings.rb

@@ -0,0 +1,229 @@
+# -----------------------------------------------------------------------------
+#
+# Additions to ActiveRecord::Base for factory settings
+#
+# -----------------------------------------------------------------------------
+# 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.
+# -----------------------------------------------------------------------------
+;
+
+
+require 'active_record'
+
+
+module RGeo
+
+  module ActiveRecord
+
+
+    # The default factory generator for ActiveRecord::Base.
+
+    DEFAULT_FACTORY_GENERATOR = ::Proc.new do |config_|
+      if config_.delete(:geographic)
+        ::RGeo::Geographic.spherical_factory(config_)
+      else
+        ::RGeo::Cartesian.preferred_factory(config_)
+      end
+    end
+
+
+    # An object that manages the RGeo factories for a ConnectionPool.
+
+    class RGeoFactorySettings
+
+      def initialize  # :nodoc:
+        @factory_generators = {}
+        @column_factories = {}
+      end
+
+
+      # Get the default factory generator for the given table
+
+      def get_factory_generator(table_name_)
+        @factory_generators[table_name_.to_s] || ::RGeo::ActiveRecord::DEFAULT_FACTORY_GENERATOR
+      end
+
+
+      # Set the default factory generator for the given table
+
+      def set_factory_generator(table_name_, gen_)
+        @factory_generators[table_name_.to_s] = gen_
+      end
+
+
+      # Get the factory or factory generator for the given table name
+      # and column name.
+
+      def get_column_factory(table_name_, column_name_, params_=nil)
+        table_name_ = table_name_.to_s
+        column_name_ = column_name_.to_s
+        result_ = (@column_factories[table_name_] ||= {})[column_name_] ||
+          @factory_generators[table_name_] || ::RGeo::ActiveRecord::DEFAULT_FACTORY_GENERATOR
+        if params_ && !result_.kind_of?(::RGeo::Feature::Factory::Instance)
+          result_ = result_.call(params_)
+        end
+        result_
+      end
+
+
+      # Set the factory or factory generator for the given table name
+      # and column name.
+
+      def set_column_factory(table_name_, column_name_, factory_)
+        (@column_factories[table_name_.to_s] ||= {})[column_name_.to_s] = factory_
+      end
+
+
+      # Clear settings for the given table name, or for all tables
+
+      def clear!(table_name_=nil)
+        if table_name_
+          table_name_ = table_name_.to_s
+          @factory_generators.delete(table_name_)
+          @column_factories.delete(table_name_)
+        else
+          @factory_generators.clear
+          @column_factories.clear
+        end
+      end
+
+
+      DEFAULT = self.new
+
+
+    end
+
+
+    # Additional class methods on ::ActiveRecord::Base that provide
+    # a way to control the RGeo factory used for ActiveRecord objects.
+
+    module ActiveRecordBaseFactorySettings
+
+
+      # Return the RGeoFactorySettings object associated with this
+      # class's connection.
+
+      def rgeo_factory_settings
+        pool_ = begin
+          connection_pool
+        rescue ::ActiveRecord::ConnectionNotEstablished
+          nil
+        end
+        pool_ ? pool_.rgeo_factory_settings : RGeoFactorySettings::DEFAULT
+      end
+
+
+      # The value of this attribute is a RGeo::Feature::FactoryGenerator
+      # that is used to generate the proper factory when loading geometry
+      # objects from the database. For example, if the data being loaded
+      # has M but not Z coordinates, and an embedded SRID, then this
+      # FactoryGenerator is called with the appropriate configuration to
+      # obtain a factory with those properties. This factory is the one
+      # associated with the actual geometry properties of the ActiveRecord
+      # object. The result of this generator can be overridden by setting
+      # an explicit factory for a given class and column using the
+      # column_rgeo_factory method.
+
+      def rgeo_factory_generator
+        rgeo_factory_settings.get_factory_generator(table_name)
+      end
+
+
+      # Set the rgeo_factory_generator attribute
+
+      def rgeo_factory_generator=(gen_)
+        rgeo_factory_settings.set_factory_generator(table_name, gen_)
+      end
+
+
+      # This is a convenient way to set the rgeo_factory_generator by
+      # passing a block.
+
+      def to_generate_rgeo_factory(&block_)
+        rgeo_factory_settings.set_factory_generator(table_name, block_)
+      end
+
+
+      # Set a specific factory for this ActiveRecord class and the given
+      # column name. This setting, if present, overrides the result of the
+      # rgeo_factory_generator.
+
+      def set_rgeo_factory_for_column(column_name_, factory_)
+        rgeo_factory_settings.set_column_factory(table_name, column_name_, factory_)
+      end
+
+
+      # Returns the factory generator or specific factory to use for this
+      # ActiveRecord class and the given column name.
+      # If an explicit factory was set for the given column, returns it.
+      # Otherwise, if a params hash is given, passes that hash to the
+      # rgeo_factory_generator for this class, and returns the resulting
+      # factory. Otherwise, if no params hash is given, just returns the
+      # rgeo_factory_generator for this class.
+
+      def rgeo_factory_for_column(column_name_, params_=nil)
+        rgeo_factory_settings.get_column_factory(table_name, column_name_, params_)
+      end
+
+
+    end
+
+    ::ActiveRecord::Base.extend(ActiveRecordBaseFactorySettings)
+
+
+    # :stopdoc:
+
+
+    # Patch for connection pool to track geo factories per table name
+
+    ::ActiveRecord::ConnectionAdapters::ConnectionPool.class_eval do
+
+      def rgeo_factory_settings
+        @_rgeo_factory_settings ||= RGeoFactorySettings.new
+      end
+
+      private
+      alias_method :new_connection_without_rgeo_modification, :new_connection
+      def new_connection
+        result_ = new_connection_without_rgeo_modification
+        if result_.respond_to?(:set_rgeo_factory_settings)
+          result_.set_rgeo_factory_settings(rgeo_factory_settings)
+        end
+        result_
+      end
+
+    end
+
+
+    # :startdoc:
+
+
+  end
+
+end