schleyfox-rgeo 0.2.5

data/lib/rgeo/coord_sys/proj4.rb

@@ -0,0 +1,312 @@
+# -----------------------------------------------------------------------------
+# 
+# Proj4 wrapper 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
+  
+  module CoordSys
+    
+    
+    # This is a Ruby wrapper around a Proj4 coordinate system.
+    # It represents a single geographic coordinate system, which may be
+    # a flat projection, a geocentric (3-dimensional) coordinate system,
+    # or a geographic (latitude-longitude) coordinate system.
+    # 
+    # Generally, these are used to define the projection for a
+    # Feature::Factory. You can then convert between coordinate systems
+    # by casting geometries between such factories using the :project
+    # option. You may also use this object directly to perform low-level
+    # coordinate transformations.
+    
+    class Proj4
+      
+      
+      def inspect  # :nodoc:
+        "#<#{self.class}:0x#{object_id.to_s(16)} #{canonical_str.inspect}>"
+      end
+      
+      
+      def to_s  # :nodoc:
+        canonical_str
+      end
+      
+      
+      def hash  # :nodoc:
+        canonical_hash.hash
+      end
+      
+      
+      # Returns true if this Proj4 is equivalent to the given Proj4.
+      # 
+      # Note: this tests for equivalence by comparing only the hash
+      # definitions of the Proj4 objects, and returning true if those
+      # definitions are equivalent. In some cases, this may still return
+      # false even if the actual coordinate systems are identical, since
+      # there are sometimes multiple ways to express a given coordinate
+      # system.
+      
+      def eql?(rhs_)
+        rhs_.class == self.class && rhs_.canonical_hash == canonical_hash && rhs_._radians? == _radians?
+      end
+      alias_method :==, :eql?
+      
+      
+      # Returns the "canonical" string definition for this coordinate
+      # system, as reported by Proj4. This may be slightly different
+      # from the definition used to construct this object.
+      
+      def canonical_str
+        unless defined?(@canonical_str)
+          @canonical_str = _canonical_str
+        end
+        @canonical_str
+      end
+      
+      
+      # Returns the "canonical" hash definition for this coordinate
+      # system, as reported by Proj4. This may be slightly different
+      # from the definition used to construct this object.
+      
+      def canonical_hash
+        unless defined?(@canonical_hash)
+          @canonical_hash = {}
+          canonical_str.strip.split(/\s+/).each do |elem_|
+            if elem_ =~ /^\+(\w+)(=(\S+))?$/
+              @canonical_hash[$1] = $3
+            end
+          end
+        end
+        @canonical_hash
+      end
+      
+      
+      # Returns the string definition originally used to construct this
+      # object. Returns nil if this object wasn't created by a string
+      # definition; i.e. if it was created using get_geographic.
+      
+      def original_str
+        _original_str
+      end
+      
+      
+      # Returns true if this Proj4 object is a geographic (lat-long)
+      # coordinate system.
+      
+      def geographic?
+        _geographic?
+      end
+      
+      
+      # Returns true if this Proj4 object is a geocentric (3dz)
+      # coordinate system.
+      
+      def geocentric?
+        _geocentric?
+      end
+      
+      
+      # Returns true if this Proj4 object uses radians rather than degrees
+      # if it is a geographic coordinate system.
+      
+      def radians?
+        _radians?
+      end
+      
+      
+      # Get the geographic (unprojected lat-long) coordinate system
+      # corresponding to this coordinate system; i.e. the one that uses
+      # the same ellipsoid and datum.
+      
+      def get_geographic
+        _get_geographic
+      end
+      
+      
+      class << self
+        
+        
+        # Returns true if Proj4 is supported in this installation.
+        # If this returns false, the other methods such as create
+        # will not work.
+        
+        def supported?
+          respond_to?(:_create)
+        end
+        
+        
+        # Create a new Proj4 object, given a definition, which may be
+        # either a string or a hash. Returns nil if the given definition
+        # is invalid or Proj4 is not supported.
+        # 
+        # Recognized options include:
+        # 
+        # [<tt>:radians</tt>]
+        #   If set to true, then this proj4 will represent geographic
+        #   (latitude/longitude) coordinates in radians rather than
+        #   degrees. If this is a geographic coordinate system, then its
+        #   units will be in radians. If this is a projected coordinate
+        #   system, then its units will be unchanged, but any geographic
+        #   coordinate system obtained using get_geographic will use
+        #   radians as its units. If this is a geocentric or other type of
+        #   coordinate system, this has no effect. Default is false.
+        #   (That is all coordinates are in degrees by default.)
+        
+        def create(defn_, opts_={})
+          result_ = nil
+          if supported?
+            if defn_.kind_of?(::Hash)
+              defn_ = defn_.map{ |k_, v_| v_ ? "+#{k_}=#{v_}" : "+#{k_}" }.join(' ')
+            end
+            unless defn_ =~ /^\s*\+/
+              defn_ = defn_.sub(/^(\s*)/, '\1+').gsub(/(\s+)([^+\s])/, '\1+\2')
+            end
+            result_ = _create(defn_, opts_[:radians])
+            result_ = nil unless result_._valid?
+          end
+          result_
+        end
+        
+        
+        # Create a new Proj4 object, given a definition, which may be
+        # either a string or a hash. Raises Error::UnsupportedOperation
+        # if the given definition is invalid or Proj4 is not supported.
+        
+        def new(defn_, opts_={})
+          result_ = create(defn_, opts_)
+          unless result_
+            raise Error::UnsupportedOperation, "Proj4 not supported in this installation"
+          end
+          result_
+        end
+        
+        
+        # Low-level coordinate transform method.
+        # Transforms the given coordinate (x, y, [z]) from one proj4
+        # coordinate system to another. Returns an array with either two
+        # or three elements.
+        
+        def transform_coords(from_proj_, to_proj_, x_, y_, z_=nil)
+          if !from_proj_._radians? && from_proj_._geographic?
+            x_ *= ImplHelper::Math::RADIANS_PER_DEGREE
+            y_ *= ImplHelper::Math::RADIANS_PER_DEGREE
+          end
+          result_ = _transform_coords(from_proj_, to_proj_, x_, y_, z_)
+          if result_ && !to_proj_._radians? && to_proj_._geographic?
+            result_[0] *= ImplHelper::Math::DEGREES_PER_RADIAN
+            result_[1] *= ImplHelper::Math::DEGREES_PER_RADIAN
+          end
+          result_
+        end
+        
+        
+        # Low-level geometry transform method.
+        # Transforms the given geometry between the given two projections.
+        # The resulting geometry is constructed using the to_factory.
+        # Any projections associated with the factories themselves are
+        # ignored.
+        
+        def transform(from_proj_, from_geometry_, to_proj_, to_factory_)
+          case from_geometry_
+          when Feature::Point
+            _transform_point(from_proj_, from_geometry_, to_proj_, to_factory_)
+          when Feature::Line
+            to_factory_.line(from_geometry_.points.map{ |p_| _transform_point(from_proj_, p_, to_proj_, to_factory_) })
+          when Feature::LinearRing
+            _transform_linear_ring(from_proj_, from_geometry_, to_proj_, to_factory_)
+          when Feature::LineString
+            to_factory_.line_string(from_geometry_.points.map{ |p_| _transform_point(from_proj_, p_, to_proj_, to_factory_) })
+          when Feature::Polygon
+            _transform_polygon(from_proj_, from_geometry_, to_proj_, to_factory_)
+          when Feature::MultiPoint
+            to_factory_.multi_point(from_geometry_.map{ |p_| _transform_point(from_proj_, p_, to_proj_, to_factory_) })
+          when Feature::MultiLineString
+            to_factory_.multi_line_string(from_geometry_.map{ |g_| transform(from_proj_, g_, to_proj_, to_factory_) })
+          when Feature::MultiPolygon
+            to_factory_.multi_polygon(from_geometry_.map{ |p_| _transform_polygon(from_proj_, p_, to_proj_, to_factory_) })
+          when Feature::GeometryCollection
+            to_factory_.collection(from_geometry_.map{ |g_| transform(from_proj_, g_, to_proj_, to_factory_) })
+          end
+        end
+        
+        
+        def _transform_point(from_proj_, from_point_, to_proj_, to_factory_)  # :nodoc:
+          from_factory_ = from_point_.factory
+          from_has_z_ = from_factory_.property(:has_z_coordinate)
+          from_has_m_ = from_factory_.property(:has_m_coordinate)
+          to_has_z_ = to_factory_.property(:has_z_coordinate)
+          to_has_m_ = to_factory_.property(:has_m_coordinate)
+          x_ = from_point_.x
+          y_ = from_point_.y
+          if !from_proj_._radians? && from_proj_._geographic?
+            x_ *= ImplHelper::Math::RADIANS_PER_DEGREE
+            y_ *= ImplHelper::Math::RADIANS_PER_DEGREE
+          end
+          coords_ = _transform_coords(from_proj_, to_proj_, x_, y_, from_has_z_ ? from_point_.z : nil)
+          if coords_
+            if !to_proj_._radians? && to_proj_._geographic?
+              coords_[0] *= ImplHelper::Math::DEGREES_PER_RADIAN
+              coords_[1] *= ImplHelper::Math::DEGREES_PER_RADIAN
+            end
+            extras_ = []
+            extras_ << coords_[2].to_f if to_has_z_
+            extras_ << from_has_m_ ? from_point_.m : 0.0 if to_has_m_
+            to_factory_.point(coords_[0], coords_[1], *extras_)
+          else
+            nil
+          end
+        end
+        
+        
+        def _transform_linear_ring(from_proj_, from_ring_, to_proj_, to_factory_)  # :nodoc:
+          to_factory_.linear_ring(from_ring_.points[0..-2].map{ |p_| _transform_point(from_proj_, p_, to_proj_, to_factory_) })
+        end
+        
+        
+        def _transform_polygon(from_proj_, from_polygon_, to_proj_, to_factory_)  # :nodoc:
+          ext_ = _transform_linear_ring(from_proj_, from_polygon_.exterior_ring, to_proj_, to_factory_)
+          int_ = from_polygon_.interior_rings.map{ |r_| _transform_linear_ring(from_proj_, r_, to_proj_, to_factory_) }
+          to_factory_.polygon(ext_, int_)
+        end
+        
+        
+      end
+      
+      
+    end
+    
+    
+  end
+  
+end

data/lib/rgeo/coord_sys/srs_database/active_record_table.rb

@@ -0,0 +1,194 @@
+# -----------------------------------------------------------------------------
+# 
+# SRS database 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 CoordSys
+    
+    module SRSDatabase
+      
+      
+      # A spatial reference database implementation that uses ActiveRecord
+      # to access a spatial reference table provided by a spatial database
+      # implementation. You can use this class to obtain coordinate system
+      # information from your installation of, e.g. PostGIS.
+      
+      class ActiveRecordTable
+        
+        @@class_counter = 0
+        
+        
+        # Create a new ActiveRecord-backed database connection.
+        # 
+        # Options include:
+        # 
+        # [<tt>:ar_class</tt>]
+        #   An ActiveRecord class to use. You may provide this if you
+        #   already have an ActiveRecord class that accesses the table.
+        #   If not provided, an ActiveRecord class will be generated
+        #   for you, using the <tt>:ar_base_class</tt>,
+        #   <tt>:database_config</tt>, and <tt>:table_name</tt> options.
+        # [<tt>:ar_base_class</tt>]
+        #   Specify an ActiveRecord base class to use when generating an
+        #   ActiveRecord class. Default is ::ActiveRecord::Base. You may
+        #   want to use this if you have a base class already that
+        #   specifies an existing database connection and/or other
+        #   class-scope options.
+        # [<tt>:database_config</tt>]
+        #   If provided, <tt>establish_connection</tt> will be called on
+        #   the generated ActiveRecord class, with the given value.
+        # [<tt>:table_name</tt>]
+        #   The table name for the new ActiveRecord class. Defaults to
+        #   the value <tt>spatial_ref_sys</tt>, which is the OGC-specified
+        #   name for this table.
+        # [<tt>:srid_column</tt>]
+        #   The name of the SRID column. Defaults to "srid", which is the
+        #   OGC-specified name for this column.
+        # [<tt>:auth_name_column</tt>]
+        #   The name of the authority name column. On an OGC-compliant
+        #   database, this column should be named "auth_name". However,
+        #   the default is set to nil; you should set this option
+        #   explicitly if you want to read the authority name.
+        # [<tt>:auth_srid_column</tt>]
+        #   The name of the authority srid column. On an OGC-compliant
+        #   database, this column should be named "auth_srid". However,
+        #   the default is set to nil; you should set this option
+        #   explicitly if you want to read the authority's srid.
+        # [<tt>:name_column</tt>]
+        #   The name of the coordinate system name column. This column is
+        #   not part of the OGC spec, but it is included in some spatial
+        #   database implementations. Default is nil.
+        # [<tt>:description_column</tt>]
+        #   The name of the coordinate system description column. This
+        #   column is not part of the OGC spec, but may be included in
+        #   some spatial database implementations. Default is nil.
+        # [<tt>:srtext_column</tt>]
+        #   The name of the spatial reference WKT column. On an
+        #   OGC-compliant database, this column should be named "srtext".
+        #   However, not all databases include this column, so the default
+        #   is set to nil; you should set this option explicitly if you
+        #   want to read the OGC coordinate system specification.
+        # [<tt>:proj4text_column</tt>]
+        #   The name of the Proj4 format projection spec column. This
+        #   column is not part of the OGC spec, but may be included in
+        #   some spatial database implementations. Default is nil.
+        # [<tt>:cache</tt>]
+        #   If set to true, entries are cached when first retrieved, so
+        #   subsequent requests do not have to make a database round trip.
+        #   Default is false.
+        # 
+        # Some option settings may be provided by the ActiveRecord
+        # connection adapter, if the ActiveRecord class's connection uses
+        # an adapter that is RGeo-savvy. The "postgis" and "spatialite"
+        # adapters are such adapters. They automatically provide the
+        # <tt>:table_name</tt> and all the relevant column settings for
+        # the database-provided spatial reference table as defaults.
+        # However, you can still override those settings if you want to
+        # use a custom table.
+        
+        def initialize(opts_={})
+          @cache = opts_[:cache] ? {} : nil
+          @ar_class = opts_[:ar_class]
+          unless @ar_class
+            ar_base_class_ = opts_[:ar_base_class] || ::ActiveRecord::Base
+            @ar_class = ::Class.new(ar_base_class_)
+            self.class.const_set("Klass#{@@class_counter}", @ar_class)
+            @@class_counter += 1
+            @ar_class.class_eval do
+              establish_connection(opts_[:database_config]) if opts_[:database_config]
+            end
+          end
+          connection_ = @ar_class.connection
+          if connection_.respond_to?(:srs_database_columns)
+            opts_ = connection_.srs_database_columns.merge(opts_)
+          end
+          unless opts_[:ar_class]
+            @ar_class.class_eval do
+              set_table_name(opts_[:table_name] || 'spatial_ref_sys')
+            end
+          end
+          @srid_column = opts_[:srid_column] || 'srid'
+          @auth_name_column = opts_[:auth_name_column]
+          @auth_srid_column = opts_[:auth_srid_column]
+          @name_column = opts_[:name_column]
+          @description_column = opts_[:description_column]
+          @srtext_column = opts_[:srtext_column]
+          @proj4text_column = opts_[:proj4text_column]
+        end
+        
+        
+        # Retrieve an Entry given an integer SRID.
+        
+        def get(ident_)
+          ident_ = ident_.to_i
+          return @cache[ident_] if @cache && @cache.include?(ident_)
+          obj_ = @ar_class.where(@srid_column => ident_).first
+          unless obj_
+            @cache[ident_] = nil if @cache
+            return nil
+          end
+          auth_name_ = @auth_name_column ? obj_[@auth_name_column] : nil
+          auth_srid_ = @auth_srid_column ? obj_[@auth_srid_column] : nil
+          name_ = @name_column ? obj_[@name_column] : nil
+          description_ = @description_column ? obj_[@description_column] : nil
+          coord_sys_ = proj4_ = nil
+          if @srtext_column
+            coord_sys_ = CS.create_from_wkt(obj_[@srtext_column]) rescue nil
+          end
+          if @proj4text_column && Proj4.supported?
+            proj4_ = Proj4.create(obj_[@proj4text_column].strip) rescue nil
+          end
+          result_ = Entry.new(ident_, :authority => auth_name_, :authority_code => auth_srid_, :name => name_, :description => description_, :coord_sys => coord_sys_, :proj4 => proj4_)
+          @cache[ident_] = result_ if @cache
+          result_
+        end
+        
+        
+        # Clears the cache if a cache is active.
+        
+        def clear_cache
+          @cache.clear if @cache
+        end
+        
+        
+      end
+      
+      
+    end
+    
+  end
+  
+end