rgeo 0.2.9 → 0.3.0

data/lib/rgeo/feature/line_string.rb

@@ -54,9 +54,8 @@ module RGeo
     
     module LineString
       
-      extend Type
-      
       include Curve
+      extend Type
       
       
       # === SFS 1.1 Description

data/lib/rgeo/feature/linear_ring.rb

@@ -53,9 +53,8 @@ module RGeo
     
     module LinearRing
       
-      extend Type
-      
       include LineString
+      extend Type
       
       
     end

data/lib/rgeo/feature/mixins.rb

@@ -0,0 +1,198 @@
+# -----------------------------------------------------------------------------
+# 
+# Mixin tracker
+# 
+# -----------------------------------------------------------------------------
+# 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
+    
+    
+    # MixinCollection is a mechanism for adding arbitrary methods to
+    # geometry objects.
+    # 
+    # Normally, geometry objects respond to the methods defined in the
+    # feature interface for that type of geometry; e.g.
+    # RGeo::Feature::Geometry, RGeo::Feature::Point, etc. Some
+    # implementations include additional methods specific to the
+    # implementation. However, occasionally it is desirable also to
+    # include custom methods allowing objects to function in different
+    # contexts. To do so, provide those methods in a mixin Module, and
+    # add it to an appropriate MixinCollection. A MixinCollection is
+    # simply a collection of mixin Modules, connected to geometry types,
+    # that are included in objects of that type.
+    # 
+    # There is a global collection, MixinCollection::GLOBAL, which
+    # manages mixins to be added to all implementations. In addition,
+    # individual implementation factories may provide additional local
+    # MixinCollection objects for mixins specific to objects created
+    # by that factory.
+    # 
+    # Each mixin module added to a MixinCollection is connected to a
+    # specific type, which controls to which objects that mixin is added.
+    # For example, a mixin connected to Point is added only to Point
+    # objects. A mixin connected to GeometryCollection is added to
+    # GeometryCollection objects as well as MultiPoint, MultiLineString,
+    # and MultiPolygon, since those are subtypes of GeometryCollection.
+    # To add a mixin to all objects, connect it to the Geometry base type.
+
+    class MixinCollection
+      
+      
+      # An API point controlling a particular type.
+      
+      class TypeData
+        
+        
+        def initialize(collection_, type_)  # :nodoc:
+          @collection = collection_
+          @type = type_
+          @mixins = []
+          @classes = []
+          @rmixins = []
+          @rclasses = []
+        end
+        
+        
+        # The feature type
+        attr_reader :type
+        
+        # The MixinCollection owning this data
+        attr_reader :collection
+        
+        
+        # Add a mixin to be included in implementations of this type.
+        
+        def add(module_)
+          @mixins << module_
+          @classes.each{ |k_| k_.class_eval{ include(module_) } }
+          _radd(module_)
+        end
+        
+        
+        # A class that implements this type should call this method to
+        # get the appropriate mixins.
+        # If include_ancestry_ is set to true, then mixins connected to
+        # subtypes of this type are also added to the class.
+        
+        def include_in_class(klass_, include_ancestry_=false)
+          (include_ancestry_ ? @rmixins : @mixins).each{ |m_| klass_.class_eval{ include(m_) } }
+          (include_ancestry_ ? @rclasses : @classes) << klass_
+          self
+        end
+        
+        
+        # An object that implements this type should call this method to
+        # get the appropriate mixins.
+        # If include_ancestry_ is set to true, then mixins connected to
+        # subtypes of this type are also added to the object.
+        
+        def include_in_object(obj_, include_ancestry_=false)
+          (include_ancestry_ ? @rmixins : @mixins).each{ |m_| obj_.extend(m_) }
+          self
+        end
+        
+        
+        def _radd(module_)  # :nodoc:
+          @rmixins << module_
+          @rclasses.each{ |k_| k_.class_eval{ include(module_) } }
+          @type.each_immediate_subtype{ |t_| @collection.for_type(t_)._radd(module_) }
+          self
+        end
+        
+        
+      end
+      
+      
+      # Create a new empty MixinCollection
+      
+      def initialize
+        @types = {}
+      end
+      
+      
+      # Returns a TypeData for the given type.
+      # 
+      # e.g. to add a module for point types, you can call:
+      #  for_type(::RGeo::Feature::Point).add(module)
+      
+      def for_type(type_)
+        (@types[type_] ||= TypeData.new(self, type_))
+      end
+      
+      
+      # Add a module connected to the given type.
+      # 
+      # Shorthand for:
+      #  for_type(type_).add(module_)
+      
+      def add(type_, module_)
+        for_type(type_).add(module_)
+      end
+      
+      
+      # A class that implements this type should call this method to
+      # get the appropriate mixins.
+      # 
+      # Shorthand for:
+      #  for_type(type_).include_in_class(klass_, include_ancestry_)
+      
+      def include_in_class(type_, klass_, include_ancestry_=false)
+        for_type(type_).include_in_class(klass_, include_ancestry_)
+      end
+      
+      
+      # An object that implements this type should call this method to
+      # get the appropriate mixins.
+      # 
+      # Shorthand for:
+      #  for_type(type_).include_in_object(obj_, include_ancestry_)
+      
+      def include_in_object(type_, obj_, include_ancestry_=false)
+        for_type(type_).include_in_object(obj_, include_ancestry_)
+      end
+      
+      
+      # The global MixinCollection. Mixins added to this collection are
+      # added to all geometry objects for all implementations.
+      
+      GLOBAL = MixinCollection.new
+      
+      
+    end
+    
+    
+  end
+  
+end

data/lib/rgeo/feature/multi_curve.rb

@@ -71,9 +71,8 @@ module RGeo
     
     module MultiCurve
       
-      extend Type
-      
       include GeometryCollection
+      extend Type
       
       
       # === SFS 1.1 Description

data/lib/rgeo/feature/multi_line_string.rb

@@ -53,9 +53,8 @@ module RGeo
     
     module MultiLineString
       
-      extend Type
-      
       include MultiCurve
+      extend Type
       
       
     end

data/lib/rgeo/feature/multi_point.rb

@@ -60,9 +60,8 @@ module RGeo
     
     module MultiPoint
       
-      extend Type
-      
       include GeometryCollection
+      extend Type
       
       
     end

data/lib/rgeo/feature/multi_polygon.rb

@@ -84,9 +84,8 @@ module RGeo
     
     module MultiPolygon
       
-      extend Type
-      
       include MultiSurface
+      extend Type
       
       
     end

data/lib/rgeo/feature/multi_surface.rb

@@ -62,9 +62,8 @@ module RGeo
     
     module MultiSurface
       
-      extend Type
-      
       include GeometryCollection
+      extend Type
       
       
       # === SFS 1.1 Description

data/lib/rgeo/feature/point.rb

@@ -59,9 +59,8 @@ module RGeo
     
     module Point
       
-      extend Type
-      
       include Geometry
+      extend Type
       
       
       # === SFS 1.1 Description

data/lib/rgeo/feature/polygon.rb

@@ -79,10 +79,8 @@ module RGeo
     
     module Polygon
       
-      extend Type
-      
       include Surface
-      include ::Enumerable
+      extend Type
       
       
       # === SFS 1.1 Description

data/lib/rgeo/feature/surface.rb

@@ -68,9 +68,8 @@ module RGeo
     
     module Surface
       
-      extend Type
-      
       include Geometry
+      extend Type
       
       
       # === SFS 1.1 Description

data/lib/rgeo/feature/types.rb

@@ -90,6 +90,21 @@ module RGeo
       end
       
       
+      # Returns the supertype of this type. The supertype of Geometry
+      # is nil.
+      
+      def supertype
+        @supertype
+      end
+      
+      
+      # Iterates over the known immediate subtypes of this type.
+      
+      def each_immediate_subtype(&block_)
+        @subtypes.each(&block_) if @subtypes
+      end
+      
+      
       # Returns the OpenGIS type name of this type.
       
       def type_name
@@ -97,6 +112,18 @@ module RGeo
       end
       
       
+      def _add_subtype(type_)  # :nodoc:
+        (@subtypes ||= []) << type_
+      end
+      
+      
+      def self.extended(type_)  # :nodoc:
+        supertype_ = type_.included_modules.find{ |m_| m_.kind_of?(self) }
+        type_.instance_variable_set(:@supertype, supertype_)
+        supertype_._add_subtype(type_) if supertype_
+      end
+      
+      
     end
     
     

data/lib/rgeo/geographic/projected_feature_classes.rb

@@ -79,6 +79,9 @@ module RGeo
       alias_method :lat, :y
       
       
+      Feature::MixinCollection::GLOBAL.for_type(Feature::Point).include_in_class(self, true)
+      
+      
     end
     
     
@@ -93,13 +96,16 @@ module RGeo
       include ProjectedLineStringMethods
       
       
+      Feature::MixinCollection::GLOBAL.for_type(Feature::LineString).include_in_class(self, true)
+      
+      
     end
     
     
     class ProjectedLinearRingImpl  # :nodoc:
       
       
-      include Feature::Line
+      include Feature::LinearRing
       include ImplHelper::BasicGeometryMethods
       include ImplHelper::BasicLineStringMethods
       include ImplHelper::BasicLinearRingMethods
@@ -108,6 +114,9 @@ module RGeo
       include ProjectedLineStringMethods
       
       
+      Feature::MixinCollection::GLOBAL.for_type(Feature::LinearRing).include_in_class(self, true)
+      
+      
     end
     
     
@@ -123,6 +132,9 @@ module RGeo
       include ProjectedLineStringMethods
       
       
+      Feature::MixinCollection::GLOBAL.for_type(Feature::Line).include_in_class(self, true)
+      
+      
     end
     
     
@@ -144,6 +156,9 @@ module RGeo
       end
       
       
+      Feature::MixinCollection::GLOBAL.for_type(Feature::Polygon).include_in_class(self, true)
+      
+      
     end
     
     
@@ -156,26 +171,32 @@ module RGeo
       include ProjectedGeometryMethods
       
       
+      Feature::MixinCollection::GLOBAL.for_type(Feature::GeometryCollection).include_in_class(self, true)
+      
+      
     end
     
     
     class ProjectedMultiPointImpl  # :nodoc:
       
       
-      include Feature::GeometryCollection
+      include Feature::MultiPoint
       include ImplHelper::BasicGeometryMethods
       include ImplHelper::BasicGeometryCollectionMethods
       include ImplHelper::BasicMultiPointMethods
       include ProjectedGeometryMethods
       
       
+      Feature::MixinCollection::GLOBAL.for_type(Feature::MultiPoint).include_in_class(self, true)
+      
+      
     end
     
     
     class ProjectedMultiLineStringImpl  # :nodoc:
       
       
-      include Feature::GeometryCollection
+      include Feature::MultiLineString
       include ImplHelper::BasicGeometryMethods
       include ImplHelper::BasicGeometryCollectionMethods
       include ImplHelper::BasicMultiLineStringMethods
@@ -183,13 +204,16 @@ module RGeo
       include ProjectedNCurveMethods
       
       
+      Feature::MixinCollection::GLOBAL.for_type(Feature::MultiLineString).include_in_class(self, true)
+      
+      
     end
     
     
     class ProjectedMultiPolygonImpl  # :nodoc:
       
       
-      include Feature::GeometryCollection
+      include Feature::MultiPolygon
       include ImplHelper::BasicGeometryMethods
       include ImplHelper::BasicGeometryCollectionMethods
       include ImplHelper::BasicMultiPolygonMethods
@@ -205,6 +229,9 @@ module RGeo
       end
       
       
+      Feature::MixinCollection::GLOBAL.for_type(Feature::MultiPolygon).include_in_class(self, true)
+      
+      
     end