rgeo-activerecord 2.1.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eefa5be0ab751442125af4725e0c68a027de604a
-  data.tar.gz: febd0ffb4107382342a35c47d85c4e42f79407f5
+  metadata.gz: f60cf6ae67e0e2e1a73d57c4a0bad86f534f96c0
+  data.tar.gz: 17c3e5ecc8458e01eab3dc4531622ec3460cb193
 SHA512:
-  metadata.gz: 4d80baf3359fd91e9ea9425fc9ae152f7e3ed4ef91e91156ce40b64eb49c7dfe198b2b10355b238ae5d5c5a5e51b808beccdd0ed94ceef5fec71756fa2fdfd6a
-  data.tar.gz: d7e315bd3bba85db027ff861083ab3d0ede51e2d627d4f24172427ad9869456060c94c590ed80ab05a76da9cc2944acf50f4969d43edced4b3ac1c171a2b9d26
+  metadata.gz: 7296946f83cabf48737cd6e5b7f3b8af4af78ba3c69b77e86618bdbff65be11a05d8c32c44084a8ced839f5952c9a560f8d6912db0fe5c6fd953cc12c89bc2a8
+  data.tar.gz: 2a2239bd24fa6d7e4940da9a61253fa9b427457e6b01120d94f822428c476544d698463f72b240ad83c826c954bb8ad21e74f8c4037c7f99b65999f9f679ee3f

data/README.md

@@ -73,8 +73,6 @@ Development is supported by:
 
 ### License
 
-Copyright 2013 Daniel Azuma
-
-Copyright 2014 Tee Parham
+Copyright 2015 Daniel Azuma, Tee Parham
 
 https://github.com/rgeo/rgeo-activerecord/blob/master/LICENSE.txt

data/lib/rgeo-activerecord.rb

@@ -1,35 +1 @@
-# -----------------------------------------------------------------------------
-#
-# ActiveRecord extensions for RGeo
-#
-# -----------------------------------------------------------------------------
-# 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'

data/lib/rgeo/active_record.rb

@@ -4,21 +4,11 @@
 # ActiveRecord, and a set of tools and helpers for writing RGeo-based
 # spatial connection adapters.
 
-module RGeo
-  # This module contains a set of ActiveRecord extensions for RGeo.
-  # Generally, you will not need to interact with the contents of this
-  # module directly, unless you are writing a spatial ActiveRecord
-  # connection adapter.
-
-  module ActiveRecord
-  end
-end
-
 require 'rgeo'
 require 'active_record'
 require 'rgeo/active_record/version'
 require 'rgeo/active_record/spatial_expressions'
+require 'rgeo/active_record/spatial_factory_store'
 require 'rgeo/active_record/arel_spatial_queries'
 require 'rgeo/active_record/common_adapter_elements'
-require 'rgeo/active_record/ar_factory_settings'
 require 'rgeo/active_record/geometry_mixin'

data/lib/rgeo/active_record/spatial_factory_store.rb

@@ -0,0 +1,61 @@
+module RGeo
+  module ActiveRecord
+    class SpatialFactoryStore
+      include Singleton
+
+      attr_accessor :registry
+
+      def initialize
+        @registry = {}
+      end
+
+      def register(factory, attrs = {})
+        registry[key(attrs)] = factory
+      end
+
+      def default(attrs = {})
+        @default || default_for_attrs(attrs)
+      end
+
+      def default=(factory)
+        @default = factory
+      end
+
+      def factory(attrs)
+        registry[key(attrs)] || default(attrs)
+      end
+
+      def clear
+        @registry = {}
+      end
+
+      private
+
+      def default_for_attrs(attrs)
+        if attrs[:sql_type] =~ /geography/
+          RGeo::Geographic.spherical_factory(to_factory_attrs(attrs))
+        else
+          RGeo::Cartesian.preferred_factory(to_factory_attrs(attrs))
+        end
+      end
+
+      def to_factory_attrs(attrs)
+        {
+          has_m_coordinate: attrs[:has_m],
+          has_z_coordinate: attrs[:has_z],
+          srid:             (attrs[:srid] || 0),
+        }
+      end
+
+      def key(attrs)
+        {
+          geo_type: "geometry",
+          has_m:    false,
+          has_z:    false,
+          sql_type: "geometry",
+          srid:     0,
+        }.merge(attrs).hash
+      end
+    end
+  end
+end

data/lib/rgeo/active_record/version.rb

@@ -1,5 +1,5 @@
 module RGeo
   module ActiveRecord
-    VERSION = "2.1.1".freeze
+    VERSION = "3.0.0".freeze
   end
 end

data/test/basic_test.rb

@@ -1,43 +1,13 @@
 require 'test_helper'
 
-class BasicTest < Minitest::Test # :nodoc:
-  class MyTable < ::ActiveRecord::Base
+class BasicTest < Minitest::Test
+  class MyTable < ActiveRecord::Base
   end
 
-  def test_has_version
+  def test_version
     assert RGeo::ActiveRecord::VERSION
   end
 
-  def test_default_factory_generator
-    MyTable.rgeo_factory_generator = nil
-    factory = MyTable.rgeo_factory_for_column(:hello).call(has_z_coordinate: true, srid: 4326)
-    assert_equal true, factory.property(:has_z_coordinate)
-    assert_equal true, factory.property(:is_cartesian)
-    assert_nil factory.property(:is_geographic)
-    assert_equal 4326, factory.srid
-  end
-
-  def test_set_factory_generator
-    MyTable.rgeo_factory_generator = RGeo::Geographic.method(:spherical_factory)
-    factory = MyTable.rgeo_factory_for_column(:hello, has_z_coordinate: true, srid: 4326)
-    assert_equal true, factory.property(:has_z_coordinate)
-    assert_equal true, factory.property(:is_geographic)
-    assert_nil factory.property(:is_cartesian)
-    assert_equal false, factory.has_projection?
-    assert_equal 4326, factory.srid
-  end
-
-  def test_specific_factory_for_column
-    MyTable.rgeo_factory_generator = nil
-    MyTable.set_rgeo_factory_for_column(:foo, RGeo::Geographic.simple_mercator_factory(has_z_coordinate: true))
-    factory = MyTable.rgeo_factory_for_column(:foo)
-    assert_equal true, factory.property(:has_z_coordinate)
-    assert_equal true, factory.property(:is_geographic)
-    assert_nil factory.property(:is_cartesian)
-    assert_equal true, factory.has_projection?
-    assert_equal 4326, factory.srid
-  end
-
   def test_default_as_json_wkt
     RGeo::ActiveRecord::GeometryMixin.set_json_generator(nil)
     factory = RGeo::Cartesian.preferred_factory
@@ -61,7 +31,6 @@ class BasicTest < Minitest::Test # :nodoc:
   private
 
   def arel_visitor
-    Arel::Visitors::PostgreSQL.new(Arel::Table.engine.connection)
+    Arel::Visitors::PostgreSQL.new(FakeRecord::Connection.new)
   end
-
 end

data/test/spatial_factory_store_test.rb

@@ -0,0 +1,45 @@
+require "test_helper"
+
+class SpatialFactoryStoreTest < Minitest::Test
+  def test_default
+    store.default = nil
+    assert RGeo::Cartesian.preferred_factory === store.default
+  end
+
+  def test_set_default
+    store.clear
+    default_factory = Object.new
+    store.default = default_factory
+    assert_equal default_factory, store.default
+  end
+
+  def test_register
+    store.clear
+    default_factory = Object.new
+    store.default = default_factory
+
+    point_factory = Object.new
+    store.register point_factory, geo_type: "point", srid: 4326
+    assert_equal point_factory, store.factory(geo_type: "point", srid: 4326)
+    assert_equal 1, store.registry.size
+    assert_equal point_factory, store.factory(geo_type: "point", srid: 4326)
+    assert_equal 1, store.registry.size
+
+    polygon_factory = Object.new
+    store.register polygon_factory, geo_type: "polygon"
+    assert_equal polygon_factory, store.factory(geo_type: "polygon")
+    assert_equal 2, store.registry.size
+
+    z_point_factory = Object.new
+    store.register z_point_factory, geo_type: "point", has_z: true
+    assert_equal z_point_factory, store.factory(geo_type: "point", has_z: true)
+
+    assert_equal default_factory, store.factory(geo_type: "linestring")
+  end
+
+  private
+
+  def store
+    RGeo::ActiveRecord::SpatialFactoryStore.instance
+  end
+end

data/test/support/fake_record.rb

@@ -1,4 +1,4 @@
-# From https://github.com/rails/arel/blob/4-0-stable/test/support/fake_record.rb
+# From https://github.com/rails/arel/master/test/support/fake_record.rb
 module FakeRecord
   class Column < Struct.new(:name, :type)
   end
@@ -61,12 +61,20 @@ module FakeRecord
     end
 
     def quote thing, column = nil
-      if column && column.type == :integer
-        return 'NULL' if thing.nil?
-        return thing.to_i
+      if column && !thing.nil?
+        case column.type
+        when :integer
+          thing = thing.to_i
+        when :string
+          thing = thing.to_s
+        end
       end
 
       case thing
+      when DateTime
+        "'#{thing.strftime("%Y-%m-%d %H:%M:%S")}'"
+      when Date
+        "'#{thing.strftime("%Y-%m-%d")}'"
       when true
         "'t'"
       when false
@@ -76,7 +84,7 @@ module FakeRecord
       when Numeric
         thing
       else
-        "'#{thing}'"
+        "'#{thing.to_s.gsub("'", "\\\\'")}'"
       end
     end
   end
@@ -108,6 +116,10 @@ module FakeRecord
     def schema_cache
       connection
     end
+
+    def quote thing, column = nil
+      connection.quote thing, column
+    end
   end
 
   class Base

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rgeo-activerecord
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Daniel Azuma, Tee Parham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2015-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rgeo
@@ -93,15 +93,14 @@ files:
 - README.md
 - lib/rgeo-activerecord.rb
 - lib/rgeo/active_record.rb
-- lib/rgeo/active_record/adapter_test_helper.rb
-- lib/rgeo/active_record/ar_factory_settings.rb
 - lib/rgeo/active_record/arel_spatial_queries.rb
 - lib/rgeo/active_record/common_adapter_elements.rb
 - lib/rgeo/active_record/geometry_mixin.rb
 - lib/rgeo/active_record/spatial_expressions.rb
+- lib/rgeo/active_record/spatial_factory_store.rb
 - lib/rgeo/active_record/version.rb
 - test/basic_test.rb
-- test/common_adapter_elements_test.rb
+- test/spatial_factory_store_test.rb
 - test/support/fake_record.rb
 - test/test_helper.rb
 homepage: http://github.com/rgeo/rgeo-activerecord
@@ -129,6 +128,7 @@ specification_version: 4
 summary: An RGeo module providing spatial extensions to ActiveRecord.
 test_files:
 - test/basic_test.rb
-- test/common_adapter_elements_test.rb
+- test/spatial_factory_store_test.rb
 - test/support/fake_record.rb
 - test/test_helper.rb
+has_rdoc: 

data/lib/rgeo/active_record/adapter_test_helper.rb

@@ -1,130 +0,0 @@
-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.
-        klass_.connection_pool.with_connection do |c_|
-          if c_.respond_to?(:schema_cache)
-            # 3.2.x and 4.0.x
-            c_.schema_cache.clear!
-          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
-      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

@@ -1,146 +0,0 @@
-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, generator)
-        @factory_generators[table_name.to_s] = generator
-      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=(generator)
-        rgeo_factory_settings.set_factory_generator(table_name, generator)
-      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

data/test/common_adapter_elements_test.rb

@@ -1,7 +0,0 @@
-require 'test_helper'
-
-class CommonAdapterElementsTest < Minitest::Test # :nodoc:
-  def test_geo_schema_dumper
-
-  end
-end