rgeo 0.3.3 → 0.3.4

data/lib/rgeo/error.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Error classes for RGeo
-# 
+#
 # -----------------------------------------------------------------------------
-# Copyright 2010 Daniel Azuma
-# 
+# Copyright 2010-2012 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,
@@ -18,7 +18,7 @@
 # * 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
@@ -35,29 +35,29 @@
 
 
 module RGeo
-  
-  
+
+
   # All RGeo errors are members of this namespace.
-  
+
   module Error
-    
+
     # Base class for all RGeo-related exceptions
     class RGeoError < ::RuntimeError
     end
-    
+
     # The specified geometry is invalid
     class InvalidGeometry < RGeoError
     end
-    
+
     # The specified operation is not supported or not implemented
     class UnsupportedOperation < RGeoError
     end
-    
+
     # Parsing failed
     class ParseError < RGeoError
     end
-    
+
   end
-  
-  
+
+
 end

data/lib/rgeo/feature.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Features namespace for RGeo
-# 
+#
 # -----------------------------------------------------------------------------
-# Copyright 2010 Daniel Azuma
-# 
+# Copyright 2010-2012 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,
@@ -18,7 +18,7 @@
 # * 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
@@ -35,19 +35,19 @@
 
 
 module RGeo
-  
-  
+
+
   # The Feature namespace contains interfaces and general tools for
   # implementations of the Open Geospatial Consortium Simple Features
   # Specification (SFS), version 1.1.0.
-  # 
+  #
   # Each interface is defined as a module, and is provided primarily for
   # the sake of documentation. Implementations do not necessarily include
   # the modules themselves. Therefore, you should not depend on the
   # kind_of? method to check type. Instead, each interface module will
   # provide a check_type class method (and a corresponding === operator
   # to support case-when constructs).
-  # 
+  #
   # In addition, a Factory interface is defined here. A factory is an
   # object that knows how to construct geometry instances for a given
   # implementation. Each implementation's front-end consists of a way to
@@ -55,16 +55,16 @@ module RGeo
   # building the features themselves. Note that, like the geometry
   # modules, the Factory module itself may not actually be included in a
   # factory implementation.
-  # 
+  #
   # Any particular implementation may extend these interfaces to provide
   # implementation-specific features beyond what is stated in the SFS
   # itself. The implementation should separately document any such
   # extensions that it may provide.
-  
+
   module Feature
   end
-  
-  
+
+
 end
 
 

data/lib/rgeo/feature/curve.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Curve feature interface
-# 
+#
 # -----------------------------------------------------------------------------
-# Copyright 2010 Daniel Azuma
-# 
+# Copyright 2010-2012 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,
@@ -18,7 +18,7 @@
 # * 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
@@ -35,121 +35,121 @@
 
 
 module RGeo
-  
+
   module Feature
-    
-    
+
+
     # == SFS 1.1 Description
-    # 
+    #
     # A Curve is a 1-dimensional geometric object usually stored as a
     # sequence of Points, with the subtype of Curve specifying the form of
     # the interpolation between Points. This part of ISO 19125 defines only
     # one subclass of Curve, LineString, which uses linear interpolation
     # between Points.
-    # 
+    #
     # A Curve is a 1-dimensional geometric object that is the homeomorphic
     # image of a real, closed interval D=[a,b] under a mapping f:[a,b]->R2.
-    # 
+    #
     # A Curve is simple if it does not pass through the same Point twice.
-    # 
+    #
     # A Curve is closed if its start Point is equal to its end Point.
-    # 
+    #
     # The boundary of a closed Curve is empty.
-    # 
+    #
     # A Curve that is simple and closed is a Ring.
-    # 
+    #
     # The boundary of a non-closed Curve consists of its two end Points.
-    # 
+    #
     # A Curve is defined as topologically closed.
-    # 
+    #
     # == Notes
-    # 
+    #
     # Curve 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 check type. Instead, use the provided check_type
     # class method (or === operator) defined in the Type module.
-    # 
+    #
     # Some implementations may support higher dimensional points.
-    
+
     module Curve
-      
+
       include Geometry
       extend Type
-      
-      
+
+
       # === SFS 1.1 Description
-      # 
+      #
       # The length of this Curve in its associated spatial reference.
-      # 
+      #
       # === Notes
-      # 
+      #
       # Returns a floating-point scalar value.
-      
+
       def length
         raise Error::UnsupportedOperation, "Method Curve#length not defined."
       end
-      
-      
+
+
       # === SFS 1.1 Description
-      # 
+      #
       # The start Point of this Curve.
-      # 
+      #
       # === Notes
-      # 
+      #
       # Returns an object that supports the Point interface.
-      
+
       def start_point
         raise Error::UnsupportedOperation, "Method Curve#start_point not defined."
       end
-      
-      
+
+
       # === SFS 1.1 Description
-      # 
+      #
       # The end Point of this Curve.
-      # 
+      #
       # === Notes
-      # 
+      #
       # Returns an object that supports the Point interface.
-      
+
       def end_point
         raise Error::UnsupportedOperation, "Method Curve#end_point not defined."
       end
-      
-      
+
+
       # === SFS 1.1 Description
-      # 
+      #
       # Returns true if this Curve is closed [StartPoint() = EndPoint()].
-      # 
+      #
       # === Notes
-      # 
+      #
       # Returns a boolean value. Note that this is different from the SFS
       # specification, which stipulates an integer return value.
-      
+
       def is_closed?
         raise Error::UnsupportedOperation, "Method Curve#is_closed? not defined."
       end
-      
-      
+
+
       # === SFS 1.1 Description
-      # 
+      #
       # Returns true if this Curve is closed [StartPoint() = EndPoint()]
       # and this Curve is simple (does not pass through the same Point
       # more than once).
-      # 
+      #
       # === Notes
-      # 
+      #
       # Returns a boolean value. Note that this is different from the SFS
       # specification, which stipulates an integer return value.
-      
+
       def is_ring?
         raise Error::UnsupportedOperation, "Method Curve#is_ring? not defined."
       end
-      
-      
+
+
     end
-  
-    
+
+
   end
-  
+
 end

data/lib/rgeo/feature/factory.rb

@@ -1,15 +1,15 @@
 # -----------------------------------------------------------------------------
-# 
+#
 # Feature factory interface
-# 
+#
 # -----------------------------------------------------------------------------
-# Copyright 2010 Daniel Azuma
-# 
+# Copyright 2010-2012 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,
@@ -18,7 +18,7 @@
 # * 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
@@ -35,24 +35,24 @@
 
 
 module RGeo
-  
+
   module Feature
-    
-    
+
+
     # This is a standard interface for factories of features.
     # Generally, each Feature implementation will implement these
     # methods as a standard way to create features.
-    # 
+    #
     # If the implementation is unable to create the given feature,
     # it should generally return nil. Implementations may also choose to
     # raise an exception on failure.
-    # 
+    #
     # Some implementations may extend this interface to provide facilities
     # for creating additional objects according to the capabilities
     # provided by that implementation. Examples might include
     # higher-dimensional coordinates or additional subclasses not
     # explicitly required by the Simple Features Specification.
-    # 
+    #
     # Factory 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 result
@@ -61,27 +61,27 @@ module RGeo
     # is provided. All factory implementation classes MUST include
     # <tt>Factory::Instance</tt>, and you may use it in <tt>is_a?</tt>,
     # <tt>===</tt>, and case-when constructs.
-    
+
     module Factory
-      
-      
+
+
       # All factory implementations MUST include this submodule.
       # This serves as a marker that may be used to test an object for
       # factory-ness.
-      
+
       module Instance
       end
-      
-      
+
+
       # Returns meta-information about this factory, by key. This
       # information may involve support for optional functionality,
       # properties of the coordinate system, or other characteristics.
-      # 
+      #
       # Each property has a symbolic name. Names that have no periods are
       # considered well-known names and are reserved for use by RGeo. If
       # you want to define your own properties, use a name that is
       # namespaced with periods, such as <tt>:'mycompany.myprop'</tt>.
-      # 
+      #
       # Property values are dependent on the individual property.
       # Generally, properties that involve testing for functionality
       # should return true if the functionality is support, or false or
@@ -89,9 +89,9 @@ module RGeo
       # indicating different levels of support. In any case, the factory
       # should return nil for property names it does not recognize. This
       # value is considered the "default" or "no value" value.
-      # 
+      #
       # Currently defined well-known properties are:
-      # 
+      #
       # [<tt>:has_z_coordinate</tt>]
       #   Set to true if geometries created by this factory include a Z
       #   coordinate, and the Point#z method is available.
@@ -107,147 +107,147 @@ module RGeo
       #   interpreted as x=longitude and y=latitude. If false or nil, no
       #   information is present about whether the coordinate system is
       #   meant to be so interpreted.
-      
+
       def property(name_)
         nil
       end
-      
-      
+
+
       # Parse the given string in well-known-text format and return the
       # resulting feature. Returns nil if the string couldn't be parsed.
-      
+
       def parse_wkt(str_)
         nil
       end
-      
-      
+
+
       # Parse the given string in well-known-binary format and return the
       # resulting feature. Returns nil if the string couldn't be parsed.
-      
+
       def parse_wkb(str_)
         nil
       end
-      
-      
+
+
       # Create a feature of type Point.
       # The x and y parameters should be Float values.
-      # 
+      #
       # The extra parameters should be the Z and/or M coordinates, if
       # supported. If both Z and M coordinates are supported, Z should
       # be passed first.
-      
+
       def point(x_, y_, *extra_)
         nil
       end
-      
-      
+
+
       # Create a feature of type LineString.
       # The given points argument should be an Enumerable of Point
       # objects, or objects that can be cast to Point.
-      # 
+      #
       # Although implementations are free to attempt to handle input
       # objects that are not of this factory, strictly speaking, the
       # result of building geometries from objects of the wrong factory
       # is undefined.
-      
+
       def line_string(points_)
         nil
       end
-      
-      
+
+
       # Create a feature of type Line.
       # The given point arguments should be Point objects, or objects
       # that can be cast to Point.
-      # 
+      #
       # Although implementations are free to attempt to handle input
       # objects that are not of this factory, strictly speaking, the
       # result of building geometries from objects of the wrong factory
       # is undefined.
-      
+
       def line(start_, end_)
         nil
       end
-      
-      
+
+
       # Create a feature of type LinearRing.
       # The given points argument should be an Enumerable of Point
       # objects, or objects that can be cast to Point.
       # If the first and last points are not equal, the ring is
       # automatically closed by appending the first point to the end of the
       # string.
-      # 
+      #
       # Although implementations are free to attempt to handle input
       # objects that are not of this factory, strictly speaking, the
       # result of building geometries from objects of the wrong factory
       # is undefined.
-      
+
       def linear_ring(points_)
         nil
       end
-      
-      
+
+
       # Create a feature of type Polygon.
       # The outer_ring should be a LinearRing, or an object that can be
       # cast to LinearRing.
       # The inner_rings should be a possibly empty Enumerable of
       # LinearRing (or objects that can be casted to LinearRing).
       # You may also pass nil to indicate no inner rings.
-      # 
+      #
       # Although implementations are free to attempt to handle input
       # objects that are not of this factory, strictly speaking, the
       # result of building geometries from objects of the wrong factory
       # is undefined.
-      
+
       def polygon(outer_ring_, inner_rings_=nil)
         nil
       end
-      
-      
+
+
       # Create a feature of type GeometryCollection.
       # The elems should be an Enumerable of Geometry objects.
-      # 
+      #
       # Although implementations are free to attempt to handle input
       # objects that are not of this factory, strictly speaking, the
       # result of building geometries from objects of the wrong factory
       # is undefined.
-      
+
       def collection(elems_)
         nil
       end
-      
-      
+
+
       # Create a feature of type MultiPoint.
       # The elems should be an Enumerable of Point objects, or objects
       # that can be cast to Point.
       # Returns nil if any of the contained geometries is not a Point,
       # which would break the MultiPoint contract.
-      # 
+      #
       # Although implementations are free to attempt to handle input
       # objects that are not of this factory, strictly speaking, the
       # result of building geometries from objects of the wrong factory
       # is undefined.
-      
+
       def multi_point(elems_)
         nil
       end
-      
-      
+
+
       # Create a feature of type MultiLineString.
       # The elems should be an Enumerable of objects that are or can be
       # cast to LineString or any of its subclasses.
       # Returns nil if any of the contained geometries is not a
       # LineString, which would break the MultiLineString contract.
-      # 
+      #
       # Although implementations are free to attempt to handle input
       # objects that are not of this factory, strictly speaking, the
       # result of building geometries from objects of the wrong factory
       # is undefined.
-      
+
       def multi_line_string(elems_)
         nil
       end
-      
-      
+
+
       # Create a feature of type MultiPolygon.
       # The elems should be an Enumerable of objects that are or can be
       # cast to Polygon or any of its subclasses.
@@ -255,39 +255,39 @@ module RGeo
       # which would break the MultiPolygon contract.
       # Also returns nil if any of the other assertions for MultiPolygon
       # are not met, e.g. if any of the polygons overlap.
-      # 
+      #
       # Although implementations are free to attempt to handle input
       # objects that are not of this factory, strictly speaking, the
       # result of building geometries from objects of the wrong factory
       # is undefined.
-      
+
       def multi_polygon(elems_)
         nil
       end
-      
-      
+
+
       # Returns a RGeo::CoordSys::Proj4 representing the projection for
       # the coordinate system of features created by this factory, or nil
       # if there is no such proj4 projection.
-      
+
       def proj4
         nil
       end
-      
-      
+
+
       # Returns the coordinate system specification for the features
       # created by this factory, or nil if there is no such coordinate
       # system.
-      # 
+      #
       # NOTE: This is a required method of the factory interface, but the
       # coordinate system classes themselves are not yet available, so
       # implementations should just return nil for now.
-      
+
       def coord_sys
         nil
       end
-      
-      
+
+
       # This is an optional method that may be implemented to customize
       # casting for this factory. Basically, RGeo defines standard ways
       # to cast certain types of objects from one factory to another and
@@ -295,13 +295,13 @@ module RGeo
       # override how things are casted TO its implementation using this
       # method. It can do this to optimize certain casting cases, or
       # implement special cases particular to this factory.
-      # 
+      #
       # This method will be called (if defined) on the destination
       # 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), 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
@@ -311,7 +311,7 @@ module RGeo
       # [<tt>:project</tt>]
       #   indicates whether to project the coordinates from the source to
       #   the destination proj4 coordinate system, if available
-      # 
+      #
       # 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::Feature.cast will return nil).
@@ -319,15 +319,15 @@ module RGeo
       # override the casting algorithm, and RGeo should use its default
       # algorithm to cast the object. Therefore, by default, you should
       # return false.
-      
+
       def override_cast(original_, type_, flags_)
         false
       end
-      
-      
+
+
     end
-  
-    
+
+
   end
-  
+
 end