rgeo 0.1.10

data/lib/rgeo/geo_json/entities.rb

@@ -0,0 +1,284 @@
+# -----------------------------------------------------------------------------
+# 
+# GeoJSON standard entities
+# 
+# -----------------------------------------------------------------------------
+# 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 GeoJSON
+    
+    
+    # This is a GeoJSON wrapper entity that corresponds to the GeoJSON
+    # "Feature" type. It is an immutable type.
+    # 
+    # This is the default implementation that is generated by
+    # RGeo::GeoJSON::EntityFactory. You may replace this implementation
+    # by writing your own entity factory. Note that an alternate Feature
+    # implementation need not subclass or even duck-type this class.
+    # the entity factory mediates all interaction between the GeoJSON
+    # engine and features.
+    
+    class Feature
+      
+      
+      # Create a feature wrapping the given geometry, with the given ID
+      # and properties.
+      
+      def initialize(geometry_, id_=nil, properties_={})
+        @geometry = geometry_
+        @id = id_
+        @properties = properties_.dup
+      end
+      
+      
+      def inspect  # :nodoc:
+        "#<#{self.class}:0x#{object_id.to_s(16)} id=#{@id.inspect} geom=#{@geometry.as_text.inspect}>"
+      end
+      
+      def to_s  # :nodoc:
+        inspect
+      end
+      
+      def hash  # :nodoc:
+        @geometry.hash + @id.hash + @properties.hash
+      end
+      
+      
+      # Two features are equal if their geometries, IDs, and properties
+      # are all equal.
+      # This methods uses the eql? method to test geometry equality, which
+      # may behave differently than the == operator.
+      
+      def eql?(rhs_)
+        rhs_.kind_of?(Feature) && @geometry.eql?(rhs_.geometry) && @id.eql?(rhs_.feature_id) && @properties.eql?(rhs_.properties)
+      end
+      
+      
+      # Two features are equal if their geometries, IDs, and properties
+      # are all equal.
+      # This methods uses the == operator to test geometry equality, which
+      # may behave differently than the eql? method.
+      
+      def ==(rhs_)
+        rhs_.kind_of?(Feature) && @geometry == rhs_.geometry && @id.eql?(rhs_.feature_id) && @properties.eql?(rhs_.properties)
+      end
+      
+      
+      # Returns the geometry contained in this feature.
+      
+      def geometry
+        @geometry
+      end
+      
+      
+      # Returns the ID for this feature, which may be nil.
+      
+      def feature_id
+        @id
+      end
+      
+      
+      # Returns a copy of the properties for this feature.
+      
+      def properties
+        @properties.dup
+      end
+      
+      
+    end
+    
+    
+    # This is a GeoJSON wrapper entity that corresponds to the GeoJSON
+    # "FeatureCollection" type. It is an immutable type.
+    # 
+    # This is the default implementation that is generated by
+    # RGeo::GeoJSON::EntityFactory. You may replace this implementation
+    # by writing your own entity factory. Note that an alternate
+    # FeatureCollection implementation need not subclass or even
+    # duck-type this class. The entity factory mediates all interaction
+    # between the GeoJSON engine and feature collections.
+    
+    class FeatureCollection
+      
+      include ::Enumerable
+      
+      
+      # Create a new FeatureCollection with the given features, which must
+      # be provided as an Enumerable.
+      
+      def initialize(features_=[])
+        @features = []
+        features_.each{ |f_| @features << f_ if f_.kind_of?(Feature) }
+      end
+      
+      
+      def inspect  # :nodoc:
+        "#<#{self.class}:0x#{object_id.to_s(16)}>"
+      end
+      
+      def to_s  # :nodoc:
+        inspect
+      end
+      
+      def hash  # :nodoc:
+        @features.hash
+      end
+      
+      
+      # Two feature collections are equal if they contain the same
+      # features in the same order.
+      # This methods uses the eql? method to test geometry equality, which
+      # may behave differently than the == operator.
+      
+      def eql?(rhs_)
+        rhs_.kind_of?(FeatureCollection) && @features.eql?(rhs_.instance_variable_get(:@features))
+      end
+      
+      
+      # Two feature collections are equal if they contain the same
+      # features in the same order.
+      # This methods uses the == operator to test geometry equality, which
+      # may behave differently than the eql? method.
+      
+      def ==(rhs_)
+        rhs_.kind_of?(FeatureCollection) && @features == rhs_.instance_variable_get(:@features)
+      end
+      
+      
+      # Iterates or returns an iterator for the features.
+      
+      def each(&block_)
+        @features.each(&block_)
+      end
+      
+      
+      # Returns the number of features contained in this collection.
+      
+      def size
+        @features.size
+      end
+      
+      
+      # Access a feature by index.
+      
+      def [](index_)
+        @features[index_]
+      end
+      
+      
+    end
+    
+    
+    # This is the default entity factory. It creates objects of type
+    # RGeo::GeoJSON::Feature and RGeo::GeoJSON::FeatureCollection.
+    # You may create your own entity factory by duck-typing this class.
+    
+    class EntityFactory
+      
+      
+      # Create and return a new feature, given geometry, ID, and
+      # properties hash.
+      
+      def feature(geometry_, id_=nil, properties_={})
+        Feature.new(geometry_, id_, properties_)
+      end
+      
+      
+      # Create and return a new feature collection, given an enumerable
+      # of feature objects.
+      
+      def feature_collection(features_=[])
+        FeatureCollection.new(features_)
+      end
+      
+      
+      # Returns true if the given object is a feature created by this
+      # entity factory.
+      
+      def is_feature?(object_)
+        object_.kind_of?(Feature)
+      end
+      
+      
+      # Returns true if the given object is a feature collection created
+      # by this entity factory.
+      
+      def is_feature_collection?(object_)
+        object_.kind_of?(FeatureCollection)
+      end
+      
+      
+      # Run Enumerable#map on the features contained in the given feature
+      # collection.
+      
+      def map_feature_collection(object_, &block_)
+        object_.map(&block_)
+      end
+      
+      
+      # Returns the geometry associated with the given feature.
+      
+      def get_feature_geometry(object_)
+        object_.geometry
+      end
+      
+      
+      # Returns the ID of the given feature, or nil for no ID.
+      
+      def get_feature_id(object_)
+        object_.feature_id
+      end
+      
+      
+      # Returns the properties of the given feature as a hash. Editing
+      # this hash does not change the state of the feature.
+      
+      def get_feature_properties(object_)
+        object_.properties
+      end
+      
+      
+      # Return the singleton instance of EntityFactory.
+      
+      def self.instance
+        @instance ||= self.new
+      end
+      
+      
+    end
+    
+    
+  end
+  
+end

data/lib/rgeo/geo_json/interface.rb

@@ -0,0 +1,95 @@
+# -----------------------------------------------------------------------------
+# 
+# GeoJSON toplevel 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 GeoJSON
+    
+    class << self
+      
+      
+      # High-level convenience routine for encoding an object as GeoJSON.
+      # Pass the object, which may one of the geometry objects specified
+      # in RGeo::Features, or an appropriate GeoJSON wrapper entity such
+      # as RGeo::GeoJSON::Feature or RGeo::GeoJSON::FeatureCollection.
+      # 
+      # The only option supported is <tt>:entity_factory</tt>, which lets
+      # you override the types of GeoJSON entities supported. See
+      # RGeo::GeoJSON::EntityFactory for more information. By default,
+      # encode supports objects of type RGeo::GeoJSON::Feature and
+      # RGeo::GeoJSON::FeatureCollection.
+      
+      def encode(object_, opts_={})
+        Coder.new(nil, opts_).encode(object_)
+      end
+      
+      
+      # High-level convenience routine for decoding an object from GeoJSON.
+      # The input may be a JSON hash, a String, or an IO object from which
+      # to read the JSON string. You must also provide the
+      # RGeo::Features::Factory to use to create geometric objects.
+      # 
+      # The only option supported is <tt>:entity_factory</tt>, which lets
+      # you override the types of GeoJSON entities that can be created.
+      # See RGeo::GeoJSON::EntityFactory for more information. By default,
+      # decode generates objects of type RGeo::GeoJSON::Feature and
+      # RGeo::GeoJSON::FeatureCollection.
+      
+      def decode(input_, geo_factory_, opts_={})
+        Coder.new(geo_factory_, opts_).decode(input_)
+      end
+      
+      
+      # Creates and returns a coder object of type RGeo::GeoJSON::Coder
+      # that encapsulates encoding and decoding settings (principally the
+      # RGeo::Features::Factory and the RGeo::GeoJSON::EntityFactory to be
+      # used).
+      # The geo factory is a required argument. The entity factory is
+      # optional. To provide one, pass an option with key
+      # <tt>:entity_factory</tt>. It defaults to the default
+      # RGeo::GeoJSON::EntityFactory, which generates objects of type
+      # RGeo::GeoJSON::Feature or RGeo::GeoJSON::FeatureCollection.
+      
+      def coder(geo_factory_, opts_={})
+        Coder.new(geo_factory_, opts_)
+      end
+      
+      
+    end
+    
+  end
+  
+end

data/lib/rgeo/geography.rb

@@ -0,0 +1,75 @@
+# -----------------------------------------------------------------------------
+# 
+# Geographic data for RGeo
+# 
+# -----------------------------------------------------------------------------
+# 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
+  
+  
+  # The Geography implementation provides geographic features using
+  # latitude/longitude coordinates measured in degrees.
+  
+  module Geography
+  end
+  
+  
+end
+
+
+# Dependency source files.
+paths_ = [
+  'features',
+  'geography/common/helper',
+  'geography/common/geometry_methods',
+  'geography/common/point_methods',
+  'geography/common/line_string_methods',
+  'geography/common/polygon_methods',
+  'geography/common/geometry_collection_methods',
+  'geography/simple_spherical/calculations',
+  'geography/simple_spherical/geometry_methods',
+  'geography/simple_spherical/point_impl',
+  'geography/simple_spherical/line_string_impl',
+  'geography/simple_spherical/polygon_impl',
+  'geography/simple_spherical/geometry_collection_impl',
+  'geography/simple_spherical/multi_point_impl',
+  'geography/simple_spherical/multi_line_string_impl',
+  'geography/simple_spherical/multi_polygon_impl',
+  'geography/simple_mercator/projector',
+  'geography/simple_mercator/feature_methods',
+  'geography/simple_mercator/feature_classes',
+  'geography/factory',
+  'geography/projected_window',
+  'geography/factories',
+]
+paths_.each{ |path_| require "rgeo/#{path_}" }