rgeo 0.1.16 → 0.1.17

data/lib/rgeo/active_record/common.rb

@@ -0,0 +1,38 @@
+# -----------------------------------------------------------------------------
+# 
+# Common tools for spatial adapters for ActiveRecord
+# 
+# -----------------------------------------------------------------------------
+# Copyright 2010 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/arel_modifications'
+require 'rgeo/active_record/base_modifications'

data/lib/rgeo/active_record/mysql_common.rb

@@ -0,0 +1,187 @@
+# -----------------------------------------------------------------------------
+# 
+# MysqlSpatial adapter common tools for ActiveRecord
+# 
+# -----------------------------------------------------------------------------
+# Copyright 2010 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/features'
+require 'rgeo/cartesian'
+require 'rgeo/wkrep'
+require 'rgeo/active_record/common'
+
+
+module RGeo
+  
+  module ActiveRecord
+    
+    
+    module MysqlCommon
+      
+      
+      module AdapterMethods  # :nodoc:
+        
+        
+        def quote(value_, column_=nil)
+          if ::RGeo::Features::Geometry.check_type(value_)
+            "GeomFromWKB(0x#{::RGeo::WKRep::WKBGenerator.new(:hex_format => true).generate(value_)},#{value_.srid})"
+          else
+            super
+          end
+        end
+        
+        
+        def add_index(table_name_, column_name_, options_={})
+          if options_[:spatial]
+            index_name_ = index_name(table_name_, :column => Array(column_name_))
+            if ::Hash === options_
+              index_name_ = options_[:name] || index_name_
+            end
+            execute "CREATE SPATIAL INDEX #{index_name_} ON #{table_name_} (#{Array(column_name_).join(", ")})"
+          else
+            super
+          end
+        end
+        
+        
+      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
+        end
+        
+        
+        attr_writer :ar_class
+        
+        attr_reader :geometric_type
+        
+        
+        def geometry?
+          type == :geometry
+        end
+        
+        
+        def klass
+          type == :geometry ? ::RGeo::Features::Geometry : super
+        end
+        
+        
+        def type_cast(value_)
+          self.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
+        end
+        
+        
+        private
+        
+        def extract_geometric_type(sql_type_)
+          case sql_type_
+          when /^geometry$/i then ::RGeo::Features::Geometry
+          when /^point$/i then ::RGeo::Features::Point
+          when /^linestring$/i then ::RGeo::Features::LineString
+          when /^polygon$/i then ::RGeo::Features::Polygon
+          when /^geometrycollection$/i then ::RGeo::Features::GeometryCollection
+          when /^multipoint$/i then ::RGeo::Features::MultiPoint
+          when /^multilinestring$/i then ::RGeo::Features::MultiLineString
+          when /^multipolygon$/i then ::RGeo::Features::MultiPolygon
+          else nil
+          end
+        end
+        
+        
+        def simplified_type(sql_type_)
+          sql_type_ =~ /geometry|point|linestring|polygon/i ? :geometry : super
+        end
+        
+        
+        def self.string_to_geometry(str_, ar_class_)
+          case str_
+          when ::RGeo::Features::Geometry
+            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_)
+            else
+              ::RGeo::WKRep::WKBParser.new(:default_factory => default_factory_).parse(str_[4..-1])
+            end
+          else
+            nil
+          end
+        end
+        
+        
+      end
+      
+      
+    end
+    
+    
+  end
+  
+end

data/lib/rgeo/features/factory.rb

@@ -227,19 +227,24 @@ module RGeo
       # factory, and will be passed the original object (which may or may
       # not already be created by this factory), the SFS feature type
       # (which again may or may not already be the type of the original
-      # object), a flag indicating whether to keep the subtype if casting
-      # to a supertype of the current type, and a flag indicating whether
-      # to force the creation of a new object even if the original is
-      # already of the desired factory and type.
+      # object), and a hash of additional flags. These flags are:
+      # 
+      # <tt>:keep_subtype</tt>::
+      #   indicates whether to keep the subtype if casting to a supertype
+      #   of the current type
+      # <tt>:force_new</tt>::
+      #   indicates whether to force the creation of a new object even if
+      #   the original is already of the desired factory and type.
       # 
       # It should return either a casted result object, false, or nil.
       # A nil return value indicates that casting should be forced to
       # fail (and ::RGeo::Features::cast will return nil).
       # A false return value indicates that this method declines to
       # override the casting algorithm, and RGeo should use its default
-      # algorithm to cast the object.
+      # algorithm to cast the object. Therefore, by default, you should
+      # return false.
       
-      def override_cast(original_, type_, keep_subtype_, force_new_)
+      def override_cast(original_, type_, flags_)
         false
       end
       

data/lib/rgeo/features/factory_generator.rb

@@ -0,0 +1,109 @@
+# -----------------------------------------------------------------------------
+# 
+# Feature factory interface
+# 
+# -----------------------------------------------------------------------------
+# Copyright 2010 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 RGeo
+  
+  module Features
+    
+    
+    # A FactoryGenerator is a callable object (usually a Proc) that
+    # takes a configuration as a hash and returns a factory. These are
+    # often used, e.g., by parsers to determine what factory the parsed
+    # geometry should have.
+    # 
+    # See the call method for a list of common configuration parameters.
+    # Different generators will support different parameters. There is
+    # no mechanism defined to reflect on the capabilities of a factory
+    # generator.
+    # 
+    # Many of the implementations provide a factory method for creating
+    # factories. For example, RGeo::Cartesian::preferred_factory can be
+    # called to create a factory using the preferred Cartesian
+    # implementation. Thus, to get a corresponding factory generator,
+    # you can use the <tt>method</tt> method. e.g.
+    # 
+    #  factory_generator = ::RGeo::Cartesian.method(:preferred_factory)
+    # 
+    # FactoryGenerator is defined as a module and is provided
+    # primarily for the sake of documentation. Implementations need not
+    # necessarily include this module itself. Therefore, you should not
+    # depend on the kind_of? method to determine if an object is a
+    # factory generator.
+    
+    module FactoryGenerator
+      
+      
+      # Generate a factory given a configuration as a hash.
+      # 
+      # If the generator does not recognize or does not support a given
+      # configuration value, the behavior is usually determined by the
+      # <tt>:strict</tt> configuration element. If <tt>strict</tt> is
+      # set to true, the generator should fail fast and return nil or
+      # raise an exception. If it is set to false, the generator should
+      # attempt to do the best it can, even if it means returning a
+      # factory that does not match the requested configuration.
+      # 
+      # Common parameters are as follows. These are intended as a
+      # recommendation only. There is no hard requirement for any
+      # particular factory generator to support them.
+      # 
+      # <tt>:strict</tt>::
+      #   If true, return nil or raise an exception if any configuration
+      #   was not recognized or not supportable. Otherwise, if false,
+      #   the generator should attempt to do its best to return some
+      #   viable factory, even if it does not strictly match the
+      #   requested configuration. Default is usually false.
+      # <tt>:srid</tt>::
+      #   The SRID for the factory and objects it creates.
+      #   Default is usually 0.
+      # <tt>:support_z_coordinate</tt>::
+      #   Support the <tt>z_coordinate</tt> capability.
+      #   Default is usually false.
+      # <tt>:support_m_coordinate</tt>::
+      #   Support the <tt>m_coordinate</tt> capability.
+      #   Default is usually false.
+      
+      def call(config_={})
+        nil
+      end
+      
+      
+    end
+    
+    
+  end
+  
+end

data/lib/rgeo/features/types.rb

@@ -160,7 +160,7 @@ module RGeo
         
         # Let the factory override
         if nfactory_.respond_to?(:override_cast)
-          override_ = nfactory_.override_cast(obj_, ntype_, keep_subtype_, force_new_)
+          override_ = nfactory_.override_cast(obj_, ntype_, :keep_subtype => keep_subtype_, :force_new => force_new_)
           return override_ unless override_ == false
         end
         

data/lib/rgeo/geos/factory.rb

@@ -207,8 +207,10 @@ module RGeo
       
       # See ::RGeo::Features::Factory#override_cast
       
-      def override_cast(original_, ntype_, keep_subtype_, force_new_)
+      def override_cast(original_, ntype_, flags_)
         return nil unless Geos.supported?
+        keep_subtype_ = flags_[:keep_subtype]
+        force_new_ = flags_[:force_new]
         if GeometryImpl === original_
           type_ = original_.geometry_type
           ntype_ = type_ if keep_subtype_ && type_.include?(ntype_)

data/lib/rgeo/wkrep/wkb_parser.rb

@@ -53,14 +53,17 @@ module RGeo
     # constructor, or set on the object afterwards.
     # 
     # <tt>:default_factory</tt>::
-    #   The default factory for generated geometries, used when no SRID
-    #   is explicitly specified in the input. If none is provided, the
-    #   default cartesian factory will be used.
-    # <tt>:factory_from_srid</tt>::
-    #   A Proc that takes an SRID as the sole argument, and returns a
-    #   factory for generated geometries when that SRID is specified in
-    #   the input. If no such Proc is provided, the default_factory is
-    #   used, regardless of the input SRID.
+    #   The default factory for parsed geometries, used when no factory
+    #   generator is provided. If no default is provided either, the
+    #   default cartesian factory will be used as the default.
+    # <tt>:factory_generator</tt>::
+    #   A factory generator that should return a factory based on the
+    #   srid and dimension settings in the input. The factory generator
+    #   should understand the configuration options <tt>:srid</tt>,
+    #   <tt>:support_z_coordinate</tt>, and <tt>:support_m_coordinate</tt>.
+    #   See RGeo::Features::FactoryGenerator for more information.
+    #   If no generator is provided, the <tt>:default_factory</tt> is
+    #   used.
     # <tt>:support_ewkb</tt>::
     #   Activate support for PostGIS EWKB type codes, which use high
     #   order bits in the type code to signal the presence of Z, M, and
@@ -82,7 +85,7 @@ module RGeo
       
       def initialize(opts_={})
         @default_factory = opts_[:default_factory] || Cartesian.preferred_factory
-        @factory_from_srid = opts_[:factory_from_srid]
+        @factory_generator = opts_[:factory_generator]
         @support_ewkb = opts_[:support_ewkb] ? true : false
         @support_wkb12 = opts_[:support_wkb12] ? true : false
         @ignore_extra_bytes = opts_[:ignore_extra_bytes] ? true : false
@@ -99,21 +102,21 @@ module RGeo
         @default_factory = value_ || Cartesian.preferred_factory
       end
       
-      # Returns true if this parser has a factory_from_srid procedure.
+      # Returns the factory generator, or nil if there is none.
       # See WKBParser for details.
-      def has_factory_from_srid?
-        @factory_from_srid ? true : false
+      def factory_generator
+        @factory_generator
       end
       
-      # Sets the factory_from_srid. See WKBParser for details.
-      def factory_from_srid=(value_)
-        @factory_from_srid = value_
+      # Sets the factory_generator. See WKBParser for details.
+      def factory_generator=(value_)
+        @factory_generator = value_
       end
       
-      # Sets the factory_from_srid to the given block.
+      # Sets the factory_generator to the given block.
       # See WKBParser for details.
-      def set_factory_from_srid(&block_)
-        @factory_from_srid = block_
+      def to_generate_factory(&block_)
+        @factory_generator = block_
       end
       
       # Returns true if this parser supports EWKB.
@@ -215,9 +218,9 @@ module RGeo
           @cur_has_z = has_z_
           @cur_has_m = has_m_
           @cur_dims = 2 + (@cur_has_z ? 1 : 0) + (@cur_has_m ? 1 : 0)
-          @cur_srid = srid_
-          if srid_ && @factory_from_srid
-            @cur_factory = @factory_from_srid.call(srid_)
+          @cur_srid = srid_.to_i
+          if @factory_generator
+            @cur_factory = @factory_generator.call(:srid => @cur_srid, :support_z_coordinate => has_z_, :support_m_coordinate => has_m_)
           end
           if @cur_has_z && !@cur_factory.has_capability?(:z_coordinate)
             raise Errors::ParseError, "Data has Z coordinates but the factory doesn't have z_coordinate capability"