rgeo 0.1.19 → 0.1.20

data/lib/rgeo/{features → feature}/point.rb

@@ -36,7 +36,7 @@
 
 module RGeo
   
-  module Features
+  module Feature
     
     
     # == SFS 1.1 Description
@@ -73,7 +73,7 @@ module RGeo
       # Returns a floating-point scalar value.
       
       def x
-        raise Errors::MethodUnimplemented
+        raise Error::UnsupportedCapability, "Method Point#x not defined."
       end
       
       
@@ -86,7 +86,7 @@ module RGeo
       # Returns a floating-point scalar value.
       
       def y
-        raise Errors::MethodUnimplemented
+        raise Error::UnsupportedCapability, "Method Point#y not defined."
       end
       
       
@@ -97,7 +97,7 @@ module RGeo
       # not support the <tt>z_coordinate</tt> capability.
       
       def z
-        raise Errors::MethodUnimplemented
+        raise Error::UnsupportedCapability, "Method Point#z not defined."
       end
       
       
@@ -108,7 +108,7 @@ module RGeo
       # not support the <tt>m_coordinate</tt> capability.
       
       def m
-        raise Errors::MethodUnimplemented
+        raise Error::UnsupportedCapability, "Method Point#m not defined."
       end
       
       

data/lib/rgeo/{features → feature}/polygon.rb

@@ -36,7 +36,7 @@
 
 module RGeo
   
-  module Features
+  module Feature
     
     
     # == SFS 1.1 Description
@@ -94,7 +94,7 @@ module RGeo
       # Returns an object that supports the LinearRing interface.
       
       def exterior_ring
-        raise Errors::MethodUnimplemented
+        raise Error::UnsupportedCapability, "Method Polygon#exterior_ring not defined."
       end
       
       
@@ -107,7 +107,7 @@ module RGeo
       # Returns an integer.
       
       def num_interior_rings
-        raise Errors::MethodUnimplemented
+        raise Error::UnsupportedCapability, "Method Polygon#num_interior_rings not defined."
       end
       
       
@@ -121,7 +121,7 @@ module RGeo
       # if the given n is out of range.
       
       def interior_ring_n(n_)
-        raise Errors::MethodUnimplemented
+        raise Error::UnsupportedCapability, "Method Polygon#interior_ring_n not defined."
       end
       
       
@@ -129,7 +129,7 @@ module RGeo
       # that support the LinearRing interface.
       
       def interior_rings
-        raise Errors::MethodUnimplemented
+        raise Error::UnsupportedCapability, "Method Polygon#interior_rings not defined."
       end
       
       

data/lib/rgeo/{features → feature}/surface.rb

@@ -36,7 +36,7 @@
 
 module RGeo
   
-  module Features
+  module Feature
     
     
     # == SFS 1.1 Description
@@ -83,7 +83,7 @@ module RGeo
       # Returns a floating-point scalar value.
       
       def area
-        raise Errors::MethodUnimplemented
+        raise Error::UnsupportedCapability, "Method Surface#area not defined."
       end
       
       
@@ -97,7 +97,7 @@ module RGeo
       # Returns an object that supports the Point interface.
       
       def centroid
-        raise Errors::MethodUnimplemented
+        raise Error::UnsupportedCapability, "Method Surface#centroid not defined."
       end
       
       
@@ -110,7 +110,7 @@ module RGeo
       # Returns an object that supports the Point interface.
       
       def point_on_surface
-        raise Errors::MethodUnimplemented
+        raise Error::UnsupportedCapability, "Method Surface#point_on_surface not defined."
       end
       
       

data/lib/rgeo/feature/types.rb

@@ -0,0 +1,301 @@
+# -----------------------------------------------------------------------------
+# 
+# Feature type management and casting
+# 
+# -----------------------------------------------------------------------------
+# 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 Feature
+    
+    
+    # These methods are available as module methods (not instance methods)
+    # of the various feature types.
+    # For example, you may determine whether a feature object is a
+    # point by calling:
+    # 
+    #   ::RGeo::Feature::Point.check_type(object)
+    # 
+    # A corresponding === operator is provided so you can use the type
+    # modules in a case-when clause.
+    # 
+    # You may also use the presence of this module to determine whether
+    # a particular object is a feature type:
+    # 
+    #   object.kind_of?(::RGeo::Feature::Type)
+    
+    module Type
+      
+      
+      # All geometry implementations MUST include this submodule.
+      # This serves as a marker that may be used to test an object for
+      # feature-ness.
+      
+      module Instance
+      end
+      
+      
+      # Returns true if the given object is this type or a subtype
+      # thereof, or if it is a feature object whose geometry_type is
+      # this type or a subtype thereof.
+      # 
+      # Note that feature objects need not actually include this module.
+      
+      def check_type(rhs_)
+        rhs_ = rhs_.geometry_type if rhs_.kind_of?(Instance)
+        rhs_.kind_of?(Type) && (rhs_ == self || rhs_.include?(self))
+      end
+      alias_method :===, :check_type
+      
+      
+      # Returns true if this type is the same type or a subtype of the
+      # given type.
+      
+      def subtype_of?(type_)
+        self == type_ || self.include?(type_)
+      end
+      
+      
+      # Returns the OpenGIS type name of this type.
+      
+      def type_name
+        self.name.sub('RGeo::Feature::', '')
+      end
+      
+      
+    end
+    
+    
+    class << self
+      
+      
+      # Cast the given object according to the given parameters, if
+      # possible, and return the resulting object. If the requested cast
+      # is not possible, nil is returned.
+      # 
+      # Parameters may be provided as a hash, or as separate arguments.
+      # Hash keys are as follows:
+      # 
+      # <tt>:factory</tt>::
+      #   Set the factory to the given factory. If this argument is not
+      #   given, the original object's factory is kept.
+      # <tt>:type</tt>::
+      #   Cast to the given type, which must be a module in the
+      #   RGeo::Feature namespace. If this argument is not given, the
+      #   result keeps the same type as the original.
+      # <tt>:project</tt>::
+      #   If this is set to true, and both the original and new factories
+      #   support proj4 projections, then the cast will also cause the
+      #   coordinates to be transformed between those two projections.
+      #   If set to false, the coordinates are not modified. Default is
+      #   false.
+      # <tt>:keep_subtype</tt>::
+      #   Value must be a boolean indicating whether to keep the subtype
+      #   of the original. If set to false, casting to a particular type
+      #   always casts strictly to that type, even if the old type is a
+      #   subtype of the new type. If set to true, the cast retains the
+      #   subtype in that case. For example, casting a LinearRing to a
+      #   LineString will normally yield a LineString, even though
+      #   LinearRing is already a more specific subtype. If you set this
+      #   value to true, the casted object will remain a LinearRing.
+      #   Default is false.
+      # <tt>:force_new</tt>::
+      #   Always return a newly-created object, even if neither the type
+      #   nor factory is modified. Normally, if this is set to false, and
+      #   a cast is not set to modify either the factory or type, the
+      #   original object itself is returned. Setting this flag to true
+      #   causes cast to return a clone in that case. Default is false.
+      #
+      # You may also pass the new factory, the new type, and the flags
+      # as separate arguments. In this case, the flag names must be
+      # passed as symbols, and their effect is the same as setting their
+      # values to true. You can even combine separate arguments and hash
+      # arguments. For example, the following three calls are equivalent:
+      # 
+      #  Feature.cast(geom, :type => Feature::Point, :project => true)
+      #  Feature.cast(geom, Feature::Point, :project => true)
+      #  Feature.cast(geom, Feature::Point, :project)
+      # 
+      # RGeo provides a default casting algorithm. Individual feature
+      # implementation factories may override this and customize the
+      # casting behavior by defining the override_cast method. See
+      # ::RGeo::Feature::Factory#override_cast for more details.
+      
+      def cast(obj_, *params_)
+        # Interpret params
+        factory_ = obj_.factory
+        type_ = obj_.geometry_type
+        opts_ = {}
+        params_.each do |param_|
+          case param_
+          when Factory::Instance
+            opts_[:factory] = param_
+          when Type
+            opts_[:type] = param_
+          when ::Symbol
+            opts_[param_] = true
+          when ::Hash
+            opts_.merge!(param_)
+          end
+        end
+        force_new_ = opts_[:force_new]
+        keep_subtype_ = opts_[:keep_subtype]
+        project_ = opts_[:project]
+        nfactory_ = opts_.delete(:factory) || factory_
+        ntype_ = opts_.delete(:type) || type_
+        
+        # Let the factory override
+        if nfactory_.respond_to?(:override_cast)
+          override_ = nfactory_.override_cast(obj_, ntype_, opts_)
+          return override_ unless override_ == false
+        end
+        
+        # Default algorithm
+        ntype_ = type_ if keep_subtype_ && type_.include?(ntype_)
+        if ntype_ == type_
+          # Types are the same
+          if nfactory_ == factory_
+            force_new_ ? obj_.dup : obj_
+          else
+            if type_ == Point
+              proj_ = nproj_ = nil
+              if project_ && factory_.has_capability?(:proj4) && nfactory_.has_capability?(:proj4)
+                proj_ = factory_.proj4
+                nproj_ = nfactory_.proj4
+              end
+              hasz_ = factory_.has_capability?(:z_coordinate)
+              nhasz_ = nfactory_.has_capability?(:z_coordinate)
+              if proj_ && nproj_
+                coords_ = CoordSys::Proj4.transform_coords(proj_, nproj_, obj_.x, obj_.y, hasz_ ? obj_.z : nil)
+                coords_ << (hasz_ ? obj_.z : 0.0) if nhasz_ && coords_.size < 3
+              else
+                coords_ = [obj_.x, obj_.y]
+                coords_ << (hasz_ ? obj_.z : 0.0) if nhasz_
+              end
+              coords_ << (factory_.has_capability?(:m_coordinate) ? obj_.m : 0.0) if nfactory_.has_capability?(:m_coordinate)
+              nfactory_.point(*coords_)
+            elsif type_ == Line
+              nfactory_.line(cast(obj_.start_point, nfactory_, opts_), cast(obj_.end_point, nfactory_, opts_))
+            elsif type_ == LinearRing
+              nfactory_.linear_ring(obj_.points.map{ |p_| cast(p_, nfactory_, opts_) })
+            elsif type_ == LineString
+              nfactory_.line_string(obj_.points.map{ |p_| cast(p_, nfactory_, opts_) })
+            elsif type_ == Polygon
+              nfactory_.polygon(cast(obj_.exterior_ring, nfactory_, opts_),
+                                obj_.interior_rings.map{ |r_| cast(r_, nfactory_, opts_) })
+            elsif type_ == MultiPoint
+              nfactory_.multi_point(obj_.map{ |g_| cast(g_, nfactory_, opts_) })
+            elsif type_ == MultiLineString
+              nfactory_.multi_line_string(obj_.map{ |g_| cast(g_, nfactory_, opts_) })
+            elsif type_ == MultiPolygon
+              nfactory_.multi_polygon(obj_.map{ |g_| cast(g_, nfactory_, opts_) })
+            elsif type_ == GeometryCollection
+              nfactory_.collection(obj_.map{ |g_| cast(g_, nfactory_, opts_) })
+            else
+              nil
+            end
+          end
+        else
+          # Types are different
+          if ntype_ == Point && (type_ == MultiPoint || type_ == GeometryCollection) ||
+              (ntype_ == Line || ntype_ == LineString || ntype_ == LinearRing) && (type_ == MultiLineString || type_ == GeometryCollection) ||
+              ntype_ == Polygon && (type_ == MultiPolygon || type_ == GeometryCollection)
+          then
+            if obj_.num_geometries == 1
+              cast(obj_.geometry_n(0), nfactory_, ntype_, opts_)
+            else
+              nil
+            end
+          elsif ntype_ == Point
+            nil
+          elsif ntype_ == Line
+            if type_ == LineString && obj_.num_points == 2
+              nfactory_.line(cast(obj_.point_n(0), nfactory_, opts_), cast(obj_.point_n(1), nfactory_, opts_))
+            else
+              nil
+            end
+          elsif ntype_ == LinearRing
+            if type_ == LineString
+              nfactory_.linear_ring(obj_.points.map{ |p_| cast(p_, nfactory_, opts_) })
+            else
+              nil
+            end
+          elsif ntype_ == LineString
+            if type_ == Line || type_ == LinearRing
+              nfactory_.line_string(obj_.points.map{ |p_| cast(p_, nfactory_, opts_) })
+            else
+              nil
+            end
+          elsif ntype_ == MultiPoint
+            if type_ == Point
+              nfactory_.multi_point([cast(obj_, nfactory_, opts_)])
+            elsif type_ == GeometryCollection
+              nfactory_.multi_point(obj_.map{ |g_| cast(p_, nfactory_, opts_) })
+            else
+              nil
+            end
+          elsif ntype_ == MultiLineString
+            if type_ == Line || type_ == LinearRing || type_ == LineString
+              nfactory_.multi_line_string([cast(obj_, nfactory_, opts_)])
+            elsif type_ == GeometryCollection
+              nfactory_.multi_line_string(obj_.map{ |g_| cast(p_, nfactory_, opts_) })
+            else
+              nil
+            end
+          elsif ntype_ == MultiPolygon
+            if type_ == Polygon
+              nfactory_.multi_polygon([cast(obj_, nfactory_, opts_)])
+            elsif type_ == GeometryCollection
+              nfactory_.multi_polygon(obj_.map{ |g_| cast(p_, nfactory_, opts_) })
+            else
+              nil
+            end
+          elsif ntype_ == GeometryCollection
+            if type_ == MultiPoint || type_ == MultiLineString || type_ == MultiPolygon
+              nfactory_.collection(obj_.map{ |g_| cast(p_, nfactory_, opts_) })
+            else
+              nfactory_.collection([cast(obj_, nfactory_, opts_)])
+            end
+          else
+            nil
+          end
+        end
+      end
+      
+      
+    end
+  
+    
+  end
+  
+end

data/lib/rgeo/geo_json.rb

@@ -52,7 +52,7 @@ end
 
 
 # Dependency files
-require 'rgeo/features'
+require 'rgeo/feature'
 
 # Implementation files
 require 'rgeo/geo_json/entities'

data/lib/rgeo/geo_json/coder.rb

@@ -40,7 +40,7 @@ module RGeo
     
     
     # This object encapsulates encoding and decoding settings (principally
-    # the RGeo::Features::Factory and the RGeo::GeoJSON::EntityFactory to
+    # the RGeo::Feature::Factory and the RGeo::GeoJSON::EntityFactory to
     # be used) so that you can encode and decode without specifying those
     # settings every time.
     
@@ -95,7 +95,7 @@ module RGeo
           if @@json_available
             @json_parser = ::Proc.new{ |str_| ::JSON.parse(str_) }
           else
-            raise Errors::RGeoError, "JSON library is not available. You may need to install the 'json' gem."
+            raise Error::RGeoError, "JSON library is not available. You may need to install the 'json' gem."
           end
         when :yajl
           if @@yajl_available.nil?
@@ -109,7 +109,7 @@ module RGeo
           if @@yajl_available
             @json_parser = ::Proc.new{ |str_| ::Yajl::Parser.new.parse(str_) }
           else
-            raise Errors::RGeoError, "Yajl library is not available. You may need to install the 'yajl' gem."
+            raise Error::RGeoError, "Yajl library is not available. You may need to install the 'yajl' gem."
           end
         when :active_support
           if @@activesupport_available.nil?
@@ -123,7 +123,7 @@ module RGeo
           if @@activesupport_available
             @json_parser = ::Proc.new{ |str_| ::ActiveSupport::JSON.decode(str_) }
           else
-            raise Errors::RGeoError, "ActiveSupport::JSON library is not available. You may need to install the 'activesupport' gem."
+            raise Error::RGeoError, "ActiveSupport::JSON library is not available. You may need to install the 'activesupport' gem."
           end
         when ::Proc, nil
           # Leave as is
@@ -137,7 +137,7 @@ module RGeo
       
       
       # Encode the given object as GeoJSON. The object may be one of the
-      # geometry objects specified in RGeo::Features, or an appropriate
+      # geometry objects specified in RGeo::Feature, or an appropriate
       # GeoJSON wrapper entity supported by this coder's entity factory.
       # 
       # This method returns a JSON object (i.e. a hash). In order to
@@ -193,7 +193,7 @@ module RGeo
       end
       
       
-      # Returns the RGeo::Features::Factory used to generate geometry objects.
+      # Returns the RGeo::Feature::Factory used to generate geometry objects.
       
       def geo_factory
         @geo_factory
@@ -237,37 +237,37 @@ module RGeo
           end
         end
         case object_
-        when Features::Point
+        when ::RGeo::Feature::Point
           {
             'type' => 'Point',
             'coordinates' => point_encoder_.call(object_),
           }
-        when Features::LineString
+        when ::RGeo::Feature::LineString
           {
             'type' => 'LineString',
             'coordinates' => object_.points.map(&point_encoder_),
           }
-        when Features::Polygon
+        when ::RGeo::Feature::Polygon
           {
             'type' => 'Polygon',
             'coordinates' => [object_.exterior_ring.points.map(&point_encoder_)] + object_.interior_rings.map{ |r_| r_.points.map(&point_encoder_) }
           }
-        when Features::MultiPoint
+        when ::RGeo::Feature::MultiPoint
           {
             'type' => 'MultiPoint',
             'coordinates' => object_.map(&point_encoder_),
           }
-        when Features::MultiLineString
+        when ::RGeo::Feature::MultiLineString
           {
             'type' => 'MultiLineString',
             'coordinates' => object_.map{ |ls_| ls_.points.map(&point_encoder_) },
           }
-        when Features::MultiPolygon
+        when ::RGeo::Feature::MultiPolygon
           {
             'type' => 'MultiPolygon',
             'coordinates' => object_.map{ |poly_| [poly_.exterior_ring.points.map(&point_encoder_)] + poly_.interior_rings.map{ |r_| r_.points.map(&point_encoder_) } },
           }
-        when Features::GeometryCollection
+        when ::RGeo::Feature::GeometryCollection
           {
             'type' => 'GeometryCollection',
             'geometries' => object_.map{ |geom_| _encode_geometry(geom_, point_encoder_) },