activerecord-postgis-adapter 0.3.5 → 0.4.0

data/History.rdoc

@@ -1,3 +1,15 @@
+=== 0.4.0 / 2011-08-15
+
+* Various fixes for Rails 3.1 compatibility.
+* Now requires rgeo-activerecord 0.4.0.
+* INCOMPATIBLE CHANGE: simple queries (e.g. MyClass.where(:latlon => my_point)) use an objective rather than spatial equality test. Earlier versions transformed this form to use st_equals, but now if you need to test for spatial equality, you'll need to call st_equals explicitly. I'm still evaluating which direction we want to go with this in the future, but we may be stuck with the current behavior because the hack required to transform these queries to use spatial equality was egregious and broke in Rails 3.1 with no clear workaround.
+
+=== 0.3.6 / 2011-06-21
+
+* Require latest rgeo-activerecord to get some fixes.
+* Note PostgreSQL 9 requirement in the README. (Reported by Samuel Cochran)
+* Now doesn't throw exceptions if an RGeo cast fails when setting an attribute.
+
 === 0.3.5 / 2011-04-12
 
 * The .gemspec was missing the databases.rake file. Fixed.

data/README.rdoc

@@ -89,7 +89,7 @@ Now you can interact with the data using the RGeo types:
 
 === Spatial Queries
 
-You can create simple queries based on spatial equality in the same way
+You can create simple queries based on objective equality in the same way
 you would on a scalar column:
 
   rec = MySpatialTable.where(:latlon => RGeo::Geos.factory.point(-122, 47)).first
@@ -111,11 +111,13 @@ 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.
+* PostgreSQL 9.0 or later.
 * PostGIS 1.5 or later.
-* pg gem 0.10 or later.
+* pg gem 0.11 or later.
 * \ActiveRecord 3.0.3 or later. Earlier versions will not work.
-* rgeo gem 0.2.8 or later.
-* rgeo-activerecord gem 0.3.3 or later.
+  Appears to be compatible with Rails 3.1rc5.
+* rgeo gem 0.3.2 or later.
+* rgeo-activerecord gem 0.4.0 or later.
 
 Install this adapter as a gem:
 
@@ -260,6 +262,8 @@ Contributions are welcome. Fork the project on Github.
 
 Report bugs on Github issues at http://github.org/dazuma/activerecord-postgis-adapter/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

data/Version

@@ -1 +1 @@
-0.3.5
+0.4.0

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

@@ -53,6 +53,11 @@ module ActiveRecord
         @@native_database_types = nil
         
         
+        def set_rgeo_factory_settings(factory_settings_)
+          @rgeo_factory_settings = factory_settings_
+        end
+        
+        
         def adapter_name
           PostGISAdapter::ADAPTER_NAME
         end
@@ -90,16 +95,30 @@ module ActiveRecord
         end
         
         
+        def type_cast(value_, column_)
+          if ::RGeo::Feature::Geometry.check_type(value_)
+            ::RGeo::WKRep::WKBGenerator.new(:hex_format => true, :type_format => :ewkb, :emit_ewkb_srid => true).generate(value_)
+          else
+            super
+          end
+        end
+        
+        
         def columns(table_name_, name_=nil)
+          # FULL REPLACEMENT. RE-CHECK ON NEW VERSIONS.
+          # We needed to return a spatial column subclass.
           table_name_ = table_name_.to_s
           spatial_info_ = spatial_column_info(table_name_)
           column_definitions(table_name_).collect do |name_, type_, default_, notnull_|
-            SpatialColumn.new(name_, default_, type_, notnull_ == 'f', type_ =~ /geometry/i ? spatial_info_[name_] : nil)
+            SpatialColumn.new(@rgeo_factory_settings, table_name_.to_s, name_, default_, type_,
+              notnull_ == 'f', type_ =~ /geometry/i ? spatial_info_[name_] : nil)
           end
         end
         
         
         def indexes(table_name_, name_=nil)
+          # FULL REPLACEMENT. RE-CHECK ON NEW VERSIONS.
+          # We needed to modify the catalog queries to pull the index type info.
           
           # Remove postgis from schemas
           schemas_ = schema_search_path.split(/,/)
@@ -143,6 +162,12 @@ module ActiveRecord
         
         
         def create_table(table_name_, options_={})
+          # FULL REPLACEMENT. RE-CHECK ON NEW VERSIONS.
+          # Note: we have to do a full replacement for Rails 3.0 because
+          # there is no way to override the creation of the table
+          # definition object. In Rails 3.1, this has been factored out
+          # into the table_definition method, so we could rewrite this
+          # to call super if we're willing to go 3.1 only.
           table_name_ = table_name_.to_s
           table_definition_ = SpatialTableDefinition.new(self)
           table_definition_.primary_key(options_[:primary_key] || ::ActiveRecord::Base.get_primary_key(table_name_.singularize)) unless options_[:id] == false
@@ -229,6 +254,8 @@ module ActiveRecord
         
         
         def add_index(table_name_, column_name_, options_={})
+          # FULL REPLACEMENT. RE-CHECK ON NEW VERSIONS.
+          # We have to fully-replace because of the gist_clause.
           table_name_ = table_name_.to_s
           column_names_ = ::Array.wrap(column_name_)
           index_name_ = index_name(table_name_, :column => column_names_)

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

@@ -46,7 +46,9 @@ module ActiveRecord
       class SpatialColumn < ConnectionAdapters::PostgreSQLColumn
         
         
-        def initialize(name_, default_, sql_type_=nil, null_=true, opts_=nil)
+        def initialize(factory_settings_, table_name_, name_, default_, sql_type_=nil, null_=true, opts_=nil)
+          @factory_settings = factory_settings_
+          @table_name = table_name_
           super(name_, default_, sql_type_, null_)
           @geographic = sql_type_ =~ /geography/i ? true : false
           if opts_
@@ -92,12 +94,6 @@ module ActiveRecord
               @limit = {:no_constraints => true}
             end
           end
-          @ar_class = ::ActiveRecord::Base
-        end
-        
-        
-        def set_ar_class(val_)
-          @ar_class = val_
         end
         
         
@@ -129,8 +125,8 @@ module ActiveRecord
         
         def type_cast(value_)
           if type == :spatial
-            SpatialColumn.convert_to_geometry(value_, @ar_class, name, @geographic,
-              @srid, @has_z, @has_m)
+            SpatialColumn.convert_to_geometry(value_, @factory_settings, @table_name, name,
+              @geographic, @srid, @has_z, @has_m)
           else
             super
           end
@@ -140,8 +136,9 @@ module ActiveRecord
         def type_cast_code(var_name_)
           if type == :spatial
             "::ActiveRecord::ConnectionAdapters::PostGISAdapter::SpatialColumn.convert_to_geometry("+
-              "#{var_name_}, self.class, #{name.inspect}, #{@geographic ? 'true' : 'false'}, "+
-              "#{@srid.inspect}, #{@has_z ? 'true' : 'false'}, #{@has_m ? 'true' : 'false'})"
+              "#{var_name_}, self.class.rgeo_factory_settings, self.class.table_name, "+
+              "#{name.inspect}, #{@geographic ? 'true' : 'false'}, #{@srid.inspect}, "+
+              "#{@has_z ? 'true' : 'false'}, #{@has_m ? 'true' : 'false'})"
           else
             super
           end
@@ -156,7 +153,7 @@ module ActiveRecord
         end
         
         
-        def self.convert_to_geometry(input_, ar_class_, column_, geographic_, srid_, has_z_, has_m_)
+        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_}
@@ -165,18 +162,16 @@ module ActiveRecord
           end
           case input_
           when ::RGeo::Feature::Geometry
-            factory_ = ar_class_.rgeo_factory_for_column(column_, constraints_)
-            ::RGeo::Feature.cast(input_, factory_)
+            factory_ = factory_settings_.get_column_factory(table_name_, column_, constraints_)
+            ::RGeo::Feature.cast(input_, factory_) rescue nil
           when ::String
             if input_.length == 0
               nil
             else
-              factory_ = ar_class_.rgeo_factory_for_column(column_, constraints_)
+              factory_ = factory_settings_.get_column_factory(table_name_, column_, constraints_)
               marker_ = input_[0,1]
-              if marker_ == "\x00" || marker_ == "\x01"
+              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
-              elsif input_[0,4] =~ /[0-9a-fA-F]{4}/
-                ::RGeo::WKRep::WKBParser.new(factory_, :support_ewkb => true).parse_hex(input_) rescue nil
               else
                 ::RGeo::WKRep::WKTParser.new(factory_, :support_ewkt => true).parse(input_) rescue nil
               end
@@ -192,10 +187,8 @@ module ActiveRecord
       
     end
     
-    
   end
   
-  
 end
 
 # :startdoc:

data/test/tc_basic.rb

@@ -53,9 +53,9 @@ module RGeo
             def populate_ar_class(content_)
               klass_ = create_ar_class
               case content_
-              when :latlon_point
+              when :mercator_point
                 klass_.connection.create_table(:spatial_test) do |t_|
-                  t_.column 'latlon', :point, :srid => 4326
+                  t_.column 'latlon', :point, :srid => 3785
                 end
               when :latlon_point_geographic
                 klass_.connection.create_table(:spatial_test) do |t_|
@@ -83,34 +83,34 @@ module RGeo
             
             
             def test_set_and_get_point
-              klass_ = populate_ar_class(:latlon_point)
+              klass_ = populate_ar_class(:mercator_point)
               obj_ = klass_.new
               assert_nil(obj_.latlon)
               obj_.latlon = @factory.point(1, 2)
               assert_equal(@factory.point(1, 2), obj_.latlon)
-              assert_equal(4326, obj_.latlon.srid)
+              assert_equal(3785, obj_.latlon.srid)
             end
             
             
             def test_set_and_get_point_from_wkt
-              klass_ = populate_ar_class(:latlon_point)
+              klass_ = populate_ar_class(:mercator_point)
               obj_ = klass_.new
               assert_nil(obj_.latlon)
               obj_.latlon = 'POINT(1 2)'
               assert_equal(@factory.point(1, 2), obj_.latlon)
-              assert_equal(4326, obj_.latlon.srid)
+              assert_equal(3785, obj_.latlon.srid)
             end
             
             
             def test_save_and_load_point
-              klass_ = populate_ar_class(:latlon_point)
+              klass_ = populate_ar_class(:mercator_point)
               obj_ = klass_.new
               obj_.latlon = @factory.point(1, 2)
               obj_.save!
               id_ = obj_.id
               obj2_ = klass_.find(id_)
               assert_equal(@factory.point(1, 2), obj2_.latlon)
-              assert_equal(4326, obj2_.latlon.srid)
+              assert_equal(3785, obj2_.latlon.srid)
               assert_equal(true, ::RGeo::Geos.is_geos?(obj2_.latlon))
             end
             
@@ -129,14 +129,21 @@ module RGeo
             
             
             def test_save_and_load_point_from_wkt
-              klass_ = populate_ar_class(:latlon_point)
+              klass_ = populate_ar_class(:mercator_point)
               obj_ = klass_.new
               obj_.latlon = 'POINT(1 2)'
               obj_.save!
               id_ = obj_.id
               obj2_ = klass_.find(id_)
               assert_equal(@factory.point(1, 2), obj2_.latlon)
-              assert_equal(4326, obj2_.latlon.srid)
+              assert_equal(3785, obj2_.latlon.srid)
+            end
+            
+            
+            def test_set_point_bad_wkt
+              klass_ = populate_ar_class(:mercator_point)
+              obj_ = klass_.create(:latlon => 'POINT (x)')
+              assert_nil(obj_.latlon)
             end
             
             
@@ -182,6 +189,15 @@ module RGeo
             end
             
             
+            def test_point_to_json
+              klass_ = populate_ar_class(:mercator_point)
+              obj_ = klass_.new
+              assert_match(/"latlon":null/, obj_.to_json)
+              obj_.latlon = @factory.point(1, 2)
+              assert_match(/"latlon":"POINT\s\(1\.0\s2\.0\)"/, obj_.to_json)
+            end
+            
+            
           end
           
         end

data/test/tc_spatial_queries.rb

@@ -53,9 +53,9 @@ module RGeo
             def populate_ar_class(content_)
               klass_ = create_ar_class
               case content_
-              when :latlon_point
+              when :mercator_point
                 klass_.connection.create_table(:spatial_test) do |t_|
-                  t_.column 'latlon', :point, :srid => 4326
+                  t_.column 'latlon', :point, :srid => 3785
                 end
               when :latlon_point_geographic
                 klass_.connection.create_table(:spatial_test) do |t_|
@@ -63,7 +63,7 @@ module RGeo
                 end
               when :path_linestring
                 klass_.connection.create_table(:spatial_test) do |t_|
-                  t_.column 'path', :line_string, :srid => 4326
+                  t_.column 'path', :line_string, :srid => 3785
                 end
               end
               klass_
@@ -71,7 +71,7 @@ module RGeo
             
             
             def test_query_point
-              klass_ = populate_ar_class(:latlon_point)
+              klass_ = populate_ar_class(:mercator_point)
               obj_ = klass_.new
               obj_.latlon = @factory.point(1, 2)
               obj_.save!
@@ -84,14 +84,14 @@ module RGeo
             
             
             def test_query_point_wkt
-              klass_ = populate_ar_class(:latlon_point)
+              klass_ = populate_ar_class(:mercator_point)
               obj_ = klass_.new
               obj_.latlon = @factory.point(1, 2)
               obj_.save!
               id_ = obj_.id
-              obj2_ = klass_.where(:latlon => 'SRID=4326;POINT(1 2)').first
+              obj2_ = klass_.where(:latlon => 'SRID=3785;POINT(1 2)').first
               assert_equal(id_, obj2_.id)
-              obj3_ = klass_.where(:latlon => 'SRID=4326;POINT(2 2)').first
+              obj3_ = klass_.where(:latlon => 'SRID=3785;POINT(2 2)').first
               assert_nil(obj3_)
             end
             
@@ -100,27 +100,27 @@ module RGeo
               
               
               def test_query_st_distance
-                klass_ = populate_ar_class(:latlon_point)
+                klass_ = populate_ar_class(:mercator_point)
                 obj_ = klass_.new
                 obj_.latlon = @factory.point(1, 2)
                 obj_.save!
                 id_ = obj_.id
-                obj2_ = klass_.where(klass_.arel_table[:latlon].st_distance('SRID=4326;POINT(2 3)').lt(2)).first
+                obj2_ = klass_.where(klass_.arel_table[:latlon].st_distance('SRID=3785;POINT(2 3)').lt(2)).first
                 assert_equal(id_, obj2_.id)
-                obj3_ = klass_.where(klass_.arel_table[:latlon].st_distance('SRID=4326;POINT(2 3)').gt(2)).first
+                obj3_ = klass_.where(klass_.arel_table[:latlon].st_distance('SRID=3785;POINT(2 3)').gt(2)).first
                 assert_nil(obj3_)
               end
               
               
               def test_query_st_distance_from_constant
-                klass_ = populate_ar_class(:latlon_point)
+                klass_ = populate_ar_class(:mercator_point)
                 obj_ = klass_.new
                 obj_.latlon = @factory.point(1, 2)
                 obj_.save!
                 id_ = obj_.id
-                obj2_ = klass_.where(::Arel.spatial('SRID=4326;POINT(2 3)').st_distance(klass_.arel_table[:latlon]).lt(2)).first
+                obj2_ = klass_.where(::Arel.spatial('SRID=3785;POINT(2 3)').st_distance(klass_.arel_table[:latlon]).lt(2)).first
                 assert_equal(id_, obj2_.id)
-                obj3_ = klass_.where(::Arel.spatial('SRID=4326;POINT(2 3)').st_distance(klass_.arel_table[:latlon]).gt(2)).first
+                obj3_ = klass_.where(::Arel.spatial('SRID=3785;POINT(2 3)').st_distance(klass_.arel_table[:latlon]).gt(2)).first
                 assert_nil(obj3_)
               end
               

metadata

@@ -2,7 +2,7 @@
 name: activerecord-postgis-adapter
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors: 
 - Daniel Azuma
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-13 00:00:00 Z
+date: 2011-08-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rgeo-activerecord
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.3.3
+        version: 0.4.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -31,7 +31,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.10.0
+        version: 0.11.0
   type: :runtime
   version_requirements: *id002
 description: This is an ActiveRecord connection adapter for PostGIS. It is based on the stock PostgreSQL adapter, but provides built-in support for the spatial extensions provided by PostGIS. It uses the RGeo library to represent spatial data in Ruby.
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: virtuoso
-rubygems_version: 1.7.2
+rubygems_version: 1.8.7
 signing_key: 
 specification_version: 3
 summary: An ActiveRecord adapter for PostGIS, based on RGeo.