rgeo 0.1.20 → 0.1.21

data/lib/rgeo.rb

@@ -79,6 +79,13 @@
 # an industry standard (if somewhat legacy) file format commonly used for
 # providing geographic data sets.
 # 
+# The RGeo::ActiveRecord module contains ActiveRecord connection adapters
+# for handling spatial data with MySQL Spatial, SpatiaLite, and PostGIS.
+# See the RGeo::ActiveRecord rdocs for more information on using these
+# adapters. However, you do not need to access or require this module
+# directly from code. ActiveRecord will load these adapters automatically
+# when they are requested.
+# 
 # === Loading the library
 # 
 # After installing the RGeo gem, you can load the library with:
@@ -102,42 +109,16 @@
 #  require 'rgeo/shapefile'
 #  require 'rgeo/wkrep'
 # 
-# === Spatial connection adapters for ActiveRecord
-# 
-# RGeo also provides ActiveRecord connection adapters for common spatial
-# databases. You can specify and use these connection adapters in the same
-# way you use any other connection adapter, for example by specifying the
-# adapter name in a Rails application's database.yml file. You do not need
-# to require any files to gain access to these adapters. RGeo makes them
-# available to ActiveRecord automatically.
-# 
-# These adapters are:
-# 
-# <tt>mysqlspatial</tt>::
-#   An adapter based on the standard mysql adapter. It extends the stock
-#   adapter to provide support for spatial columns in MySQL, mapping the
-#   values properly to RGeo spatial objects. Like the standard mysql
-#   adapter, this requires the mysql gem (version 2.8 or later).
-# <tt>mysql2spatial</tt>::
-#   An adapter for MySQL spatial based on the mysql2 adapter. It requires
-#   the mysql2 gem (version 0.2.6 or later).
-# <tt>spatialite</tt>::
-#   An adapter for the SpatiaLite extension to Sqlite3. It is based on
-#   the stock sqlite3 adapter, and requires the sqlite3-ruby gem.
-#   <b>(INCOMPLETE)</b>
-# <tt>postgis</tt>::
-#   An adapter for the PostGIS extension to Postgresql. It is based on
-#   the stock postgres adapter, and requires the pg gem.
-#   <b>(INCOMPLETE)</b>
+# You do not need to explicitly require any files for access to the
+# spatial ActiveRecord adapters. ActiveRecord will load them
+# automatically when they are referenced.
 
 module RGeo
   
   autoload(:Cartesian, 'rgeo/cartesian')
   autoload(:CoordSys, 'rgeo/coord_sys')
   autoload(:Error, 'rgeo/error')
-  autoload(:Errors, 'rgeo/error')
   autoload(:Feature, 'rgeo/feature')
-  autoload(:Features, 'rgeo/feature')
   autoload(:GeoJSON, 'rgeo/geo_json')
   autoload(:Geography, 'rgeo/geography')
   autoload(:Geos, 'rgeo/geos')

data/lib/rgeo/active_record/arel_modifications.rb

@@ -68,6 +68,7 @@ module Arel
     
     VISITORS['postgis'] = ::Arel::Visitors::PostgreSQL
     VISITORS['mysqlspatial'] = ::Arel::Visitors::MySQL
+    VISITORS['mysql2spatial'] = ::Arel::Visitors::MySQL
     VISITORS['spatialite'] = ::Arel::Visitors::SQLite
     
   end

data/lib/rgeo/active_record/base_modifications.rb

@@ -58,11 +58,6 @@ module ActiveRecord
   # obtain a factory with those properties. This factory is the one
   # associated with the actual geometry properties of the ActiveRecord
   # object.
-  # 
-  # === ActiveRecord::Base::rgeo_default_factory
-  # 
-  # The default factory used to load RGeo geometry objects from the
-  # database. This is used when there is no rgeo_factory_generator.
   
   class Base
     
@@ -70,11 +65,14 @@ module ActiveRecord
     self.attribute_types_cached_by_default << :geometry
     
     
-    class_attribute :rgeo_default_factory, :instance_writer => false
-    self.rgeo_default_factory = nil
-    
     class_attribute :rgeo_factory_generator, :instance_writer => false
-    self.rgeo_factory_generator = nil
+    self.rgeo_factory_generator = ::Proc.new do |config_|
+      if config_.delete(:geographic)
+        ::RGeo::Geography.spherical_factory(config_)
+      else
+        ::RGeo::Cartesian.preferred_factory(config_)
+      end
+    end
     
     
     # This is a convenient way to set the rgeo_factory_generator by
@@ -92,7 +90,7 @@ module ActiveRecord
       def columns
         unless defined?(@columns) && @columns
           columns_without_rgeo_modification.each do |column_|
-            column_.ar_class = self if column_.respond_to?(:ar_class=)
+            column_.set_ar_class(self) if column_.respond_to?(:set_ar_class)
           end
         end
         @columns
@@ -104,4 +102,23 @@ module ActiveRecord
   end
   
   
+  module ConnectionAdapters  # :nodoc:
+    
+    class TableDefinition  # :nodoc:
+      
+      ::RGeo::ActiveRecord::GEOMETRY_TYPES.each do |type_|
+        method_ = <<-END_METHOD
+          def #{type_}(*args_)
+            opts_ = args_.extract_options!
+            args_.each{ |name_| column(name_, '#{type_}', opts_) }
+          end
+        END_METHOD
+        class_eval(method_, __FILE__, __LINE__-5)
+      end
+      
+    end
+    
+  end
+  
+  
 end

data/lib/rgeo/active_record/common.rb

@@ -34,5 +34,133 @@
 ;
 
 
+require 'rgeo/feature'
+require 'rgeo/cartesian'
+require 'rgeo/geography'
+
+
+module RGeo
+  
+  
+  # RGeo provides ActiveRecord connection adapters for common spatial
+  # databases. They cause ActiveRecord to make spatial database fields
+  # available as RGeo feature objects instead of internally-coded data.
+  # They also provide extensions to the schema management APIs for
+  # creating spatial columns and spatial indexes.
+  # 
+  # You can specify and use these connection adapters in the same way you
+  # use any other connection adapter, for example by specifying the
+  # adapter name in a Rails application's database.yml file. You do not
+  # need to require any files to gain access to these adapters. RGeo
+  # makes them available to ActiveRecord automatically.
+  # 
+  # The RGeo::ActiveRecord module itself is a namespace for the internal
+  # adapter implementation. You generally do not need to interact with
+  # this module yourself.
+  # 
+  # Following is a list of the adapters supported by RGeo.
+  # 
+  # === mysqlspatial
+  # 
+  # An adapter based on the standard mysql adapter. It extends the stock
+  # adapter to provide support for spatial columns in MySQL, mapping the
+  # values properly to RGeo spatial objects. Like the standard mysql
+  # adapter, this requires the mysql gem (version 2.8 or later).
+  # 
+  # In a database.yml configuration, mysqlspatial uses the same config
+  # parameters as the stock mysql adapter.
+  # 
+  # STATUS: The mysqlspatial adapter is fairly complete, and there are no
+  # known functionality holes at this time. However, it is not yet
+  # well-tested.
+  # 
+  # === mysql2spatial
+  # 
+  # An adapter for MySQL spatial based on the mysql2 adapter. It requires
+  # the mysql2 gem (version 0.2.6 or later).
+  # 
+  # In a database.yml configuration, mysql2spatial uses the same config
+  # parameters as the stock mysql2 adapter.
+  # 
+  # STATUS: The mysql2spatial adapter is fairly complete, and there are
+  # no known functionality holes at this time. However, it is not yet
+  # well-tested.
+  # 
+  # === spatialite
+  # 
+  # An adapter for the SpatiaLite extension to Sqlite3. It is based on
+  # the stock sqlite3 adapter, and requires the sqlite3-ruby gem.
+  # 
+  # In a database.yml configuration, in addition to the config parameters
+  # used by the stock sqlite3 adapter, spatialite recognizes the
+  # following parameters:
+  # 
+  # <tt>libspatialite</tt>::
+  #   The path to the libspatialite shared library. By default, the
+  #   adapter tries to look for this library in several usual places,
+  #   including /usr/local, /usr/local/spatialite, /opt/local, /usr,
+  #   and a few others. If it does not find libspatialite installed in
+  #   one of these locations, it will raise an exception. If your
+  #   library is installed in a different place, you can explicitly
+  #   provide the path using this configuration key.
+  # 
+  # STATUS: The spatialite adapter works in principle, but there are a
+  # few known holes in the functionality. Notably, things that require
+  # the alter_table mechanism may not function properly, because the
+  # current sqlite3 implementation doesn't properly preserve triggers.
+  # This includes, among other things, removing columns. However, most
+  # simple things work, including creating tables with geometric columns,
+  # adding geometric columns to existing tables, and creating and
+  # removing spatial R*tree indexes. Note that this adapter is not yet
+  # well-tested.
+  # 
+  # === postgis
+  # 
+  # An adapter for the PostGIS extension to Postgresql. It is based on
+  # the stock postgresql adapter, and requires the pg gem.
+  # 
+  # In a database.yml configuration, postgis uses the same config
+  # parameters as the stock postgresql adapter.
+  # 
+  # STATUS: The postgis adapter works in principle, but there are a
+  # few known holes in the functionality. Notably, getting index info
+  # doesn't recognize spatial (GiST) indexes. Also be aware that this
+  # adapter is not yet well-tested.
+  
+  module ActiveRecord
+    
+    # Additional column types for geometries.
+    GEOMETRY_TYPES = [:geometry, :point, :line_string, :polygon, :geometry_collection, :multi_line_string, :multi_point, :multi_polygon].freeze
+    
+    module Common  # :nodoc:
+      
+      class IndexDefinition < ::Struct.new(:table, :name, :unique, :columns, :lengths, :spatial)  # :nodoc:
+      end
+      
+      class << self
+        
+        def geometric_type_from_name(name_)
+          case name_.downcase
+          when 'geometry' then ::RGeo::Feature::Geometry
+          when 'point' then ::RGeo::Feature::Point
+          when 'linestring' then ::RGeo::Feature::LineString
+          when 'polygon' then ::RGeo::Feature::Polygon
+          when 'geometrycollection' then ::RGeo::Feature::GeometryCollection
+          when 'multipoint' then ::RGeo::Feature::MultiPoint
+          when 'multilinestring' then ::RGeo::Feature::MultiLineString
+          when 'multipolygon' then ::RGeo::Feature::MultiPolygon
+          else nil
+          end
+        end
+        
+      end
+      
+    end
+    
+  end
+  
+end
+
+
 require 'rgeo/active_record/arel_modifications'
 require 'rgeo/active_record/base_modifications'

data/lib/rgeo/active_record/mysql_common.rb

@@ -42,7 +42,7 @@ require 'rgeo/active_record/common'
 
 module RGeo
   
-  module ActiveRecord  # :nodoc:
+  module ActiveRecord
     
     
     module MysqlCommon  # :nodoc:
@@ -76,29 +76,25 @@ module RGeo
       end
       
       
-      class IndexDefinition < ::ActiveRecord::ConnectionAdapters::IndexDefinition  # :nodoc:
-        
-        attr_accessor :spatial
-        
-      end
-      
-      
       module ColumnMethods  # :nodoc:
         
         
         def initialize(name_, default_, sql_type_=nil, null_=true)
           super(name_, default_,sql_type_, null_)
-          @geometric_type = extract_geometric_type(sql_type_)
-          @ar_class = nil
+          @geometric_type = ::RGeo::ActiveRecord::Common.geometric_type_from_name(sql_type_)
+          @ar_class = ::ActiveRecord::Base
         end
         
         
-        attr_writer :ar_class
+        def set_ar_class(val_)
+          @ar_class = val_
+        end
+        
         
         attr_reader :geometric_type
         
         
-        def geometry?
+        def spatial?
           type == :geometry
         end
         
@@ -109,32 +105,17 @@ module RGeo
         
         
         def type_cast(value_)
-          self.geometry? ? ColumnMethods.string_to_geometry(value_, @ar_class) : super
+          type == :geometry ? ColumnMethods.string_to_geometry(value_, @ar_class) : super
         end
         
         
         def type_cast_code(var_name_)
-          self.geometry? ? "::RGeo::ActiveRecord::MysqlCommon::ColumnMethods.string_to_geometry(#{var_name_}, self.class)" : super
+          type == :geometry ? "::RGeo::ActiveRecord::MysqlCommon::ColumnMethods.string_to_geometry(#{var_name_}, self.class)" : super
         end
         
         
         private
         
-        def extract_geometric_type(sql_type_)
-          case sql_type_
-          when /^geometry$/i then ::RGeo::Feature::Geometry
-          when /^point$/i then ::RGeo::Feature::Point
-          when /^linestring$/i then ::RGeo::Feature::LineString
-          when /^polygon$/i then ::RGeo::Feature::Polygon
-          when /^geometrycollection$/i then ::RGeo::Feature::GeometryCollection
-          when /^multipoint$/i then ::RGeo::Feature::MultiPoint
-          when /^multilinestring$/i then ::RGeo::Feature::MultiLineString
-          when /^multipolygon$/i then ::RGeo::Feature::MultiPolygon
-          else nil
-          end
-        end
-        
-        
         def simplified_type(sql_type_)
           sql_type_ =~ /geometry|point|linestring|polygon/i ? :geometry : super
         end
@@ -146,29 +127,11 @@ module RGeo
             str_
           when ::String
             marker_ = str_[4,1]
-            little_endian_ = marker_ == "\x01"
-            wkt_ = !little_endian_ && marker_ != "\x00"
-            srid_ = wkt_ ? 0 : str_[0,4].unpack(little_endian_ ? 'V' : 'N').first
-            factory_generator_ = nil
-            in_factory_generator_ = ar_class_ ? ar_class_.rgeo_factory_generator : nil
-            default_factory_ = ar_class_ ? ar_class_.rgeo_default_factory : nil
-            if default_factory_ || in_factory_generator_
-              if in_factory_generator_
-                default_factory_ ||= factory_generator_.call(:srid => srid_)
-                if wkt_
-                  factory_generator_ = in_factory_generator_
-                end
-              end
-            else
-              default_factory_ = ::RGeo::Cartesian.preferred_factory(:srid => srid_)
-              if wkt_
-                factory_generator_ = ::RGeo::Cartesian.method(:preferred_factory)
-              end
-            end
-            if wkt_
-              ::RGeo::WKRep::WKTParser.new(:support_ewkt => true, :default_factory => default_factory_, :factory_generator => factory_generator_).parse(str_)
+            factory_generator_ = ar_class_.rgeo_factory_generator
+            if marker_ == "\x00" || marker_ == "\x01"
+              ::RGeo::WKRep::WKBParser.new(factory_generator_, :default_srid => str_[0,4].unpack(marker_ == "\x01" ? 'V' : 'N').first).parse(str_[4..-1])
             else
-              ::RGeo::WKRep::WKBParser.new(:default_factory => default_factory_).parse(str_[4..-1])
+              ::RGeo::WKRep::WKTParser.new(factory_generator_, :support_ewkt => true).parse(str_)
             end
           else
             nil

data/lib/rgeo/cartesian/factory.rb

@@ -100,14 +100,14 @@ module RGeo
       # See ::RGeo::Feature::Factory#parse_wkt
       
       def parse_wkt(str_)
-        WKRep::WKTParser.new(:default_factory => self).parse(str_)
+        WKRep::WKTParser.new(self).parse(str_)
       end
       
       
       # See ::RGeo::Feature::Factory#parse_wkb
       
       def parse_wkb(str_)
-        WKRep::WKBParser.new(:default_factory => self).parse(str_)
+        WKRep::WKBParser.new(self).parse(str_)
       end
       
       

data/lib/rgeo/coord_sys.rb

@@ -1,6 +1,6 @@
 # -----------------------------------------------------------------------------
 # 
-# GEOS wrapper for RGeo
+# Coordinate systems for RGeo
 # 
 # -----------------------------------------------------------------------------
 # Copyright 2010 Daniel Azuma

data/lib/rgeo/coord_sys/proj4.rb

@@ -54,7 +54,7 @@ module RGeo
       
       
       def inspect  # :nodoc:
-        "#<#{self.class}:0x#{object_id.to_s(16)} #{_canonical_str.inspect}>"
+        "#<#{self.class}:0x#{object_id.to_s(16)} #{canonical_str.inspect}>"
       end
       
       
@@ -78,8 +78,9 @@ module RGeo
       # system.
       
       def eql?(rhs_)
-        rhs_.is_a?(Proj4) && rhs_._canonical_hash == canonical_hash
+        rhs_.class == self.class && rhs_.canonical_hash == canonical_hash
       end
+      alias_method :==, :eql?
       
       
       # Returns the "canonical" string definition for this coordinate

data/lib/rgeo/error.rb

@@ -63,8 +63,5 @@ module RGeo
     
   end
   
-  # Deprecated alias
-  Errors = Error
-  
   
 end

data/lib/rgeo/feature.rb

@@ -68,9 +68,6 @@ module RGeo
   module Feature
   end
   
-  # Deprecated alias
-  Features = Feature
-  
   
 end
 
@@ -95,3 +92,4 @@ require 'rgeo/feature/multi_curve'
 require 'rgeo/feature/multi_line_string'
 require 'rgeo/feature/multi_surface'
 require 'rgeo/feature/multi_polygon'
+require 'rgeo/feature/factory_generator'