schleyfox-rgeo 0.2.5

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

@@ -0,0 +1,165 @@
+# -----------------------------------------------------------------------------
+# 
+# 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
+    
+    
+    # This module contains tools for accessing spatial reference
+    # databases. These are databases (either local or remote) from which
+    # you can look up coordinate system specifications, typically in
+    # either OGC or Proj4 format. For example, you can access the
+    # <tt>spatial_ref_sys</tt> table provided with an OGC-compliant RDBMS
+    # such as PostGIS. You can also read the database files provided with
+    # the proj4 library, or access online databases such as the
+    # spatialreference.org site.
+    
+    module SRSDatabase
+      
+      
+      # Interface specification for spatial reference system databases.
+      # This module exists primarily for the sake of documentation.
+      # Database implementations need not actually include this module,
+      # but at least need to duck-type its methods.
+      
+      module Interface
+        
+        
+        # Retrieve an Entry given an identifier. The identifier is usually
+        # a numeric spatial reference ID (SRID), but could be a string
+        # value for certain database types.
+        
+        def get(ident_)
+          nil
+        end
+        
+        
+        # Clears any cache utilized by this database.
+        
+        def clear_cache
+          nil
+        end
+        
+        
+      end
+      
+      
+      # An entry in a spatial reference system database.
+      # Every entry has an identifier, but all the other attributes are
+      # optional and may or may not be present depending on the database.
+      
+      class Entry
+        
+        
+        # Create an entry.
+        # You must provide an identifier, which may be numeric or a
+        # string. The data hash should contain any other attributes,
+        # keyed by symbol.
+        # 
+        # Some attribute inputs have special behaviors:
+        # 
+        # [<tt>:coord_sys</tt>]
+        #   You can pass a CS coordinate system object, or a string in
+        #   WKT format.
+        # [<tt>:proj4</tt>]
+        #   You can pass a Proj4 object, or a proj4-format string.
+        # [<tt>:name</tt>]
+        #   If the name is not provided directly, it is taken from the
+        #   coord_sys.
+        # [<tt>:authority</tt>]
+        #   If the authority name is not provided directly, it is taken
+        #   from the coord_sys.
+        # [<tt>:authority_code</tt>]
+        #   If the authority code is not provided directly, it is taken
+        #   from the coord_sys.
+        
+        def initialize(ident_, data_={})
+          @identifier = ident_
+          @authority = data_[:authority]
+          @authority_code = data_[:authority_code]
+          @name = data_[:name]
+          @description = data_[:description]
+          @coord_sys = data_[:coord_sys]
+          if @coord_sys.kind_of?(::String)
+            @coord_sys = CS.create_from_wkt(@coord_sys)
+          end
+          @proj4 = data_[:proj4]
+          if Proj4.supported?
+            if @proj4.kind_of?(::String) || @proj4.kind_of?(::Hash)
+              @proj4 = Proj4.create(@proj4)
+            end
+          else
+            @proj4 = nil
+          end
+          if @coord_sys
+            @name = @coord_sys.name unless @name
+            @authority = @coord_sys.authority unless @authority
+            @authority_code = @coord_sys.authority unless @authority_code
+          end
+        end
+        
+        
+        # The database key or identifier.
+        attr_reader :identifier
+        
+        # The authority name, if present. Example: "epsg".
+        attr_reader :authority
+        
+        # The authority code, e.g. an EPSG code.
+        attr_reader :authority_code
+        
+        # A human-readable name for this coordinate system.
+        attr_reader :name
+        
+        # A human-readable description for this coordinate system.
+        attr_reader :description
+        
+        # The CS::CoordinateSystem object.
+        attr_reader :coord_sys
+        
+        # The Proj4 object.
+        attr_reader :proj4
+        
+        
+      end
+      
+      
+    end
+    
+  end
+  
+end

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

@@ -0,0 +1,188 @@
+# -----------------------------------------------------------------------------
+# 
+# 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 backed by coordinate
+      # system files installed as part of the proj4 library. For a given
+      # Proj4Data object, you specify a single file (e.g. the epsg data
+      # file), and you can retrieve records by ID number.
+      
+      class Proj4Data
+        
+        
+        # Connect to one of the proj4 data files. You should provide the
+        # file name, optionally the installation directory if it is not
+        # in a typical location, and several additional options.
+        # 
+        # These options are recognized:
+        # 
+        # [<tt>:dir</tt>]
+        #   The path for the share/proj directory that contains the
+        #   requested data file. By default, the Proj4Data class will
+        #   try a number of directories for you, including
+        #   /usr/local/share/proj, /opt/local/share/proj, /usr/share/proj,
+        #   and a few other variants. However, if you have proj4 installed
+        #   elsewhere, you can provide an explicit directory using this
+        #   option. You may also pass nil as the value, in which case all
+        #   the normal lookup paths will be disabled, and you will have to
+        #   provide the full path as the file name.
+        # [<tt>:cache</tt>]
+        #   If set to true, this class caches previously looked up entries
+        #   so subsequent lookups do not have to reread the file. If set
+        #   to <tt>:read_all</tt>, then ALL values in the file are read in
+        #   and cached the first time a lookup is done. If set to
+        #   <tt>:preload</tt>, then ALL values in the file are read in
+        #   immediately when the database is created. Default is false,
+        #   indicating that the file will be reread on every lookup.
+        # [<tt>:authority</tt>]
+        #   If set, its value is taken as the authority name for all
+        #   entries. The authority code will be set to the identifier. If
+        #   not set, then the authority fields of entries will be blank.
+        
+        def initialize(filename_, opts_={})
+          dir_ = nil
+          if opts_.include?(:dir)
+            dir_ = opts_[:dir]
+          else
+            ['/usr/local/share/proj', '/usr/local/proj/share/proj', '/usr/local/proj4/share/proj', '/opt/local/share/proj', '/opt/proj/share/proj', '/opt/proj4/share/proj', '/opt/share/proj', '/usr/share/proj'].each do |d_|
+              if ::File.directory?(d_) && ::File.readable?(d_)
+                dir_ = d_
+                break
+              end
+            end
+          end
+          @path = dir_ ? "#{dir_}/#{filename_}" : filename_
+          @authority = opts_[:authority]
+          if opts_[:cache]
+            @cache = {}
+            case opts_[:cache]
+            when :read_all
+              @populate_state = 1
+            when :preload
+              _search_file(nil)
+              @populate_state = 2
+            else
+              @populate_state = 0
+            end
+          else
+            @cache = nil
+            @populate_state = 0
+          end
+        end
+        
+        
+        # Retrieve the Entry for the given ID number.
+        
+        def get(ident_)
+          ident_ = ident_.to_s
+          return @cache[ident_] if @cache && @cache.include?(ident_)
+          result_ = nil
+          if @populate_state == 0
+            data_ = _search_file(ident_)
+            result_ = Entry.new(ident_, :authority => @authority, :authority_code => @authority ? ident_ : nil, :name => data_[1], :proj4 => data_[2]) if data_
+            @cache[ident_] = result_ if @cache
+          elsif @populate_state == 1
+            _search_file(nil)
+            result_ = @cache[ident_]
+            @populate_state = 2
+          end
+          result_
+        end
+        
+        
+        # Clear the cache if one exists.
+        
+        def clear_cache
+          @cache.clear if @cache
+          @populate_state = 1 if @populate_state == 2
+        end
+        
+        
+        def _search_file(ident_)  # :nodoc:
+          ::File.open(@path) do |file_|
+            cur_name_ = nil
+            cur_ident_ = nil
+            cur_text_ = nil
+            file_.each do |line_|
+              line_.strip!
+              if (comment_delim_ = line_.index('#'))
+                cur_name_ = line_[comment_delim_+1..-1].strip
+                line_ = line_[0..comment_delim_-1].strip
+              end
+              unless cur_ident_
+                if line_ =~ /^<(\w+)>(.*)/
+                  cur_ident_ = $1
+                  cur_text_ = []
+                  line_ = $2.strip
+                end
+              end
+              if cur_ident_
+                if line_[-2..-1] == '<>'
+                  cur_text_ << line_[0..-3].strip
+                  cur_text_ = cur_text_.join(' ')
+                  if ident_.nil?
+                    @cache[ident_] = Entry.new(ident_, :authority => @authority, :authority_code => @authority ? id_ : nil, :name => cur_name_, :proj4 => cur_text_)
+                  end
+                  if cur_ident_ == ident_
+                    return [ident_, cur_name_, cur_text_]
+                  end
+                  cur_ident_ = nil
+                  cur_name_ = nil
+                  cur_text_ = nil
+                else
+                  cur_text_ << line_
+                end
+              end
+            end
+          end
+          nil
+        end
+        
+        
+      end
+      
+      
+    end
+    
+  end
+  
+end

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

@@ -0,0 +1,108 @@
+# -----------------------------------------------------------------------------
+# 
+# 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.
+# -----------------------------------------------------------------------------
+;
+
+
+require 'net/http'
+
+
+module RGeo
+  
+  module CoordSys
+    
+    module SRSDatabase
+      
+      
+      # A spatial reference database implementation that fetches data
+      # from the spatialreference.org website.
+      
+      class SrOrg
+        
+        
+        # Create a database backed by the given catalog of the
+        # spatialreference.org website. Catalogs currently supported by
+        # spatialreference.org are "epsg", "esri", "iau2000" and "sr-org".
+        # 
+        # Options:
+        # 
+        # [<tt>:cache</tt>]
+        #   If set to true, lookup results are cached so if the same URL
+        #   is requested again, the result is served from cache rather
+        #   than issuing another HTTP request. Default is false.
+        
+        def initialize(catalog_, opts_={})
+          @catalog = catalog_.to_s.downcase
+          @cache = opts_[:cache] ? {} : nil
+        end
+        
+        
+        # The spatialreference.org catalog used by this database.
+        attr_reader :catalog
+        
+        
+        # Retrieve the Entry from a spatialreference.org catalog given an
+        # integer ID.
+        
+        def get(ident_)
+          ident_ = ident_.to_s
+          return @cache[ident_] if @cache && @cache.include?(ident_)
+          coord_sys_ = nil
+          proj4_ = nil
+          ::Net::HTTP.start('spatialreference.org') do |http_|
+            response_ = http_.request_get("/ref/#{@catalog}/#{ident_}/ogcwkt/")
+            coord_sys_ = response_.body if response_.kind_of?(::Net::HTTPSuccess)
+            response_ = http_.request_get("/ref/#{@catalog}/#{ident_}/proj4/")
+            proj4_ = response_.body if response_.kind_of?(::Net::HTTPSuccess)
+          end
+          result_ = Entry.new(ident_, :coord_sys => coord_sys_.strip, :proj4 => proj4_.strip)
+          @cache[ident_] = result_ if @cache
+          result_
+        end
+        
+        
+        # Clear the cache if one exists.
+        
+        def clear_cache
+          @cache.clear if @cache
+        end
+        
+        
+      end
+      
+      
+    end
+    
+  end
+  
+end