rgeo 1.1.2 → 2.0.0

data/lib/rgeo/coord_sys/srs_database/{interface.rb → entry.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # -----------------------------------------------------------------------------
 #
 # SRS database interface
@@ -15,32 +17,24 @@ module RGeo
     # 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
+    # Spatial reference system database classes must implement these methods:
+    #   get
+    #   clear_cache
+    #
+    # See SrOrg and UrlReader for implementations of SRSDatabase classes.
+    #
+    # 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.
+    #   get(identifier)
+    #
+    # Clear any cache utilized by this database.
+    #   clear_cache
 
+    module SRSDatabase
       # 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
@@ -64,19 +58,19 @@ module RGeo
         #   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.is_a?(::String)
+        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.is_a?(String)
             @coord_sys = CS.create_from_wkt(@coord_sys)
           end
-          @proj4 = data_[:proj4]
+          @proj4 = data[:proj4]
           if @proj4 && CoordSys.check!(:proj4)
-            if @proj4.is_a?(::String) || @proj4.is_a?(::Hash)
+            if @proj4.is_a?(String) || @proj4.is_a?(Hash)
               @proj4 = Proj4.create(@proj4)
             end
           end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # -----------------------------------------------------------------------------
 #
 # SRS database interface
@@ -24,9 +26,9 @@ module RGeo
         #   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
+        def initialize(catalog, opts = {})
+          @catalog = catalog.to_s.downcase
+          @cache = opts[:cache] ? {} : nil
         end
 
         # The spatialreference.org catalog used by this database.
@@ -35,26 +37,26 @@ module RGeo
         # 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_.is_a?(::Net::HTTPSuccess)
-            response_ = http_.request_get("/ref/#{@catalog}/#{ident_}/proj4/")
-            proj4_ = response_.body if response_.is_a?(::Net::HTTPSuccess)
+        def get(ident)
+          ident = ident.to_s
+          return @cache[ident] if @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.is_a?(Net::HTTPSuccess)
+            response = http.request_get("/ref/#{@catalog}/#{ident}/proj4/")
+            proj4 = response.body if response.is_a?(Net::HTTPSuccess)
           end
-          result_ = Entry.new(ident_, coord_sys: coord_sys_.strip, proj4: proj4_.strip)
-          @cache[ident_] = result_ if @cache
-          result_
+          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
+          @cache&.clear
         end
       end
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # -----------------------------------------------------------------------------
 #
 # SRS database interface
@@ -22,40 +24,40 @@ module RGeo
         #   is requested again, the result is served from cache rather
         #   than issuing another HTTP request. Default is false.
 
-        def initialize(opts_ = {})
-          @cache = opts_[:cache] ? {} : nil
+        def initialize(opts = {})
+          @cache = opts[:cache] ? {} : nil
         end
 
         # Retrieve the given URL and return an Entry.
         # Returns nil if the URL cannot be read as an OGC WKT or Proj4
         # coordinate system
 
-        def get(ident_)
-          ident_ = ident_.to_s
-          return @cache[ident_] if @cache && @cache.include?(ident_)
-          uri_ = ::URI.parse(ident_)
-          result_ = nil
-          ::Net::HTTP.start(uri_.host, uri_.port) do |http_|
-            request_ = uri_.path
-            request_ = "#{request_}?#{uri_.query}" if uri_.query
-            response_ = http_.request_get(request_)
-            if response_.is_a?(::Net::HTTPSuccess)
-              response_ = response_.body.strip
-              if response_[0, 1] == "+"
-                result_ = Entry.new(ident_, proj4: response_)
+        def get(ident)
+          ident = ident.to_s
+          return @cache[ident] if @cache&.include?(ident)
+          uri = URI.parse(ident)
+          result = nil
+          Net::HTTP.start(uri.host, uri.port) do |http|
+            request = uri.path
+            request = "#{request}?#{uri.query}" if uri.query
+            response = http.requestget(request)
+            if response.is_a?(Net::HTTPSuccess)
+              response = response.body.strip
+              if response[0, 1] == "+"
+                result = Entry.new(ident, proj4: response)
               else
-                result_ = Entry.new(ident_, coord_sys: response_)
+                result = Entry.new(ident, coord_sys: response)
               end
             end
           end
-          @cache[ident_] = result_ if @cache
-          result_
+          @cache[ident] = result if @cache
+          result
         end
 
         # Clear the cache if one is present.
 
         def clear_cache
-          @cache.clear if @cache
+          @cache&.clear
         end
       end
     end

data/lib/rgeo/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # -----------------------------------------------------------------------------
 #
 # Error classes for RGeo
@@ -9,7 +11,7 @@ module RGeo
 
   module Error
     # Base class for all RGeo-related exceptions
-    class RGeoError < ::RuntimeError
+    class RGeoError < RuntimeError
     end
 
     # The specified geometry is invalid

data/lib/rgeo/feature.rb

@@ -1,41 +1,30 @@
-# -----------------------------------------------------------------------------
+# frozen_string_literal: true
+
+# The Feature module contains interfaces and general tools for
+# implementations of the Open Geospatial Consortium Simple Features
+# Specification (SFS), version 1.1.0.
 #
-# Features namespace for RGeo
+# 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).
 #
-# -----------------------------------------------------------------------------
-
-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
-  # create factories. Those factories, in turn, provide the api for
-  # 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
+# 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
+# create factories. Those factories, in turn, provide the api for
+# 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.
 
-# Implementation files
 require "rgeo/feature/factory"
-require "rgeo/feature/mixins"
 require "rgeo/feature/types"
 require "rgeo/feature/geometry"
 require "rgeo/feature/point"

data/lib/rgeo/feature/curve.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # -----------------------------------------------------------------------------
 #
 # Curve feature interface

data/lib/rgeo/feature/factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # -----------------------------------------------------------------------------
 #
 # Feature factory interface
@@ -72,21 +74,21 @@ module RGeo
       #   information is present about whether the coordinate system is
       #   meant to be so interpreted.
 
-      def property(_name_)
+      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_)
+      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_)
+      def parse_wkb(str)
         nil
       end
 
@@ -97,7 +99,7 @@ module RGeo
       # supported. If both Z and M coordinates are supported, Z should
       # be passed first.
 
-      def point(_x_, _y_, *_extra_)
+      def point(x, y, *extra)
         nil
       end
 
@@ -110,7 +112,7 @@ module RGeo
       # result of building geometries from objects of the wrong factory
       # is undefined.
 
-      def line_string(_points_)
+      def line_string(points)
         nil
       end
 
@@ -123,7 +125,7 @@ module RGeo
       # result of building geometries from objects of the wrong factory
       # is undefined.
 
-      def line(_start_, _end_)
+      def line(start, stop)
         nil
       end
 
@@ -139,7 +141,7 @@ module RGeo
       # result of building geometries from objects of the wrong factory
       # is undefined.
 
-      def linear_ring(_points_)
+      def linear_ring(points)
         nil
       end
 
@@ -155,7 +157,7 @@ module RGeo
       # result of building geometries from objects of the wrong factory
       # is undefined.
 
-      def polygon(_outer_ring_, _inner_rings_ = nil)
+      def polygon(outer_ring, inner_rings = nil)
         nil
       end
 
@@ -167,7 +169,7 @@ module RGeo
       # result of building geometries from objects of the wrong factory
       # is undefined.
 
-      def collection(_elems_)
+      def collection(elems)
         nil
       end
 
@@ -182,7 +184,7 @@ module RGeo
       # result of building geometries from objects of the wrong factory
       # is undefined.
 
-      def multi_point(_elems_)
+      def multi_point(elems)
         nil
       end
 
@@ -197,7 +199,7 @@ module RGeo
       # result of building geometries from objects of the wrong factory
       # is undefined.
 
-      def multi_line_string(_elems_)
+      def multi_line_string(elems)
         nil
       end
 
@@ -214,7 +216,7 @@ module RGeo
       # result of building geometries from objects of the wrong factory
       # is undefined.
 
-      def multi_polygon(_elems_)
+      def multi_polygon(elems)
         nil
       end
 
@@ -270,7 +272,7 @@ module RGeo
       # algorithm to cast the object. Therefore, by default, you should
       # return false.
 
-      def override_cast(_original_, _type_, _flags_)
+      def override_cast(original, type, flags)
         false
       end
     end

data/lib/rgeo/feature/factory_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # -----------------------------------------------------------------------------
 #
 # Feature factory interface
@@ -72,15 +74,15 @@ module RGeo
       # [<tt>:has_m_coordinate</tt>]
       #   Support M coordinates. Default is usually false.
 
-      def call(_config_ = {})
+      def call(config = {})
         nil
       end
 
       # Return a new FactoryGenerator that always returns the given
       # factory.
 
-      def self.single(factory_)
-        ::Proc.new { |_c_| factory_ }
+      def self.single(factory)
+        proc { |c| factory }
       end
 
       # Return a new FactoryGenerator that calls the given delegate, but
@@ -88,8 +90,8 @@ module RGeo
       # for configuration values not explicitly specified, and you can
       # force certain values to override the given configuration.
 
-      def self.decorate(delegate_, default_config_ = {}, force_config_ = {})
-        ::Proc.new { |c_| delegate_.call(default_config_.merge(c_).merge(force_config_)) }
+      def self.decorate(delegate, default_config = {}, force_config = {})
+        proc { |c| delegate_.call(default_config.merge(c).merge(force_config)) }
       end
     end
   end

data/lib/rgeo/feature/geometry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # -----------------------------------------------------------------------------
 #
 # Geometry feature interface
@@ -240,7 +242,7 @@ module RGeo
       # this geometry, strictly speaking, the result of comparing objects
       # from different factories is undefined.
 
-      def equals?(_another_geometry_)
+      def equals?(another_geometry)
         raise Error::UnsupportedOperation, "Method Geometry#equals? not defined."
       end
 
@@ -259,7 +261,7 @@ module RGeo
       # this geometry, strictly speaking, the result of comparing objects
       # from different factories is undefined.
 
-      def disjoint?(_another_geometry_)
+      def disjoint?(another_geometry)
         raise Error::UnsupportedOperation, "Method Geometry#disjoint? not defined."
       end
 
@@ -278,7 +280,7 @@ module RGeo
       # this geometry, strictly speaking, the result of comparing objects
       # from different factories is undefined.
 
-      def intersects?(_another_geometry_)
+      def intersects?(another_geometry)
         raise Error::UnsupportedOperation, "Method Geometry#intersects? not defined."
       end
 
@@ -297,7 +299,7 @@ module RGeo
       # this geometry, strictly speaking, the result of comparing objects
       # from different factories is undefined.
 
-      def touches?(_another_geometry_)
+      def touches?(another_geometry)
         raise Error::UnsupportedOperation, "Method Geometry#touches? not defined."
       end
 
@@ -316,7 +318,7 @@ module RGeo
       # this geometry, strictly speaking, the result of comparing objects
       # from different factories is undefined.
 
-      def crosses?(_another_geometry_)
+      def crosses?(another_geometry)
         raise Error::UnsupportedOperation, "Method Geometry#crosses? not defined."
       end
 
@@ -335,7 +337,7 @@ module RGeo
       # this geometry, strictly speaking, the result of comparing objects
       # from different factories is undefined.
 
-      def within?(_another_geometry_)
+      def within?(another_geometry)
         raise Error::UnsupportedOperation, "Method Geometry#within? not defined."
       end
 
@@ -354,7 +356,7 @@ module RGeo
       # this geometry, strictly speaking, the result of comparing objects
       # from different factories is undefined.
 
-      def contains?(_another_geometry_)
+      def contains?(another_geometry)
         raise Error::UnsupportedOperation, "Method Geometry#contains? not defined."
       end
 
@@ -373,7 +375,7 @@ module RGeo
       # this geometry, strictly speaking, the result of comparing objects
       # from different factories is undefined.
 
-      def overlaps?(_another_geometry_)
+      def overlaps?(another_geometry)
         raise Error::UnsupportedOperation, "Method Geometry#overlaps? not defined."
       end
 
@@ -399,7 +401,7 @@ module RGeo
       # this geometry, strictly speaking, the result of comparing objects
       # from different factories is undefined.
 
-      def relate?(_another_geometry_, _intersection_pattern_matrix_)
+      def relate?(another_geometry, _intersection_pattern_matrix_)
         raise Error::UnsupportedOperation, "Method Geometry#relate not defined."
       end
 
@@ -418,7 +420,7 @@ module RGeo
       # this geometry, strictly speaking, the result of measuring the
       # distance between objects from different factories is undefined.
 
-      def distance(_another_geometry_)
+      def distance(another_geometry)
         raise Error::UnsupportedOperation, "Method Geometry#distance not defined."
       end
 
@@ -464,7 +466,7 @@ module RGeo
       # this geometry, strictly speaking, the result of performing
       # operations on objects from different factories is undefined.
 
-      def intersection(_another_geometry_)
+      def intersection(another_geometry)
         raise Error::UnsupportedOperation, "Method Geometry#intersection not defined."
       end
 
@@ -482,7 +484,7 @@ module RGeo
       # this geometry, strictly speaking, the result of performing
       # operations on objects from different factories is undefined.
 
-      def union(_another_geometry_)
+      def union(another_geometry)
         raise Error::UnsupportedOperation, "Method Geometry#union not defined."
       end
 
@@ -500,7 +502,7 @@ module RGeo
       # this geometry, strictly speaking, the result of performing
       # operations on objects from different factories is undefined.
 
-      def difference(_another_geometry_)
+      def difference(another_geometry)
         raise Error::UnsupportedOperation, "Method Geometry#difference not defined."
       end
 
@@ -518,7 +520,7 @@ module RGeo
       # this geometry, strictly speaking, the result of performing
       # operations on objects from different factories is undefined.
 
-      def sym_difference(_another_geometry_)
+      def sym_difference(another_geometry)
         raise Error::UnsupportedOperation, "Method Geometry#sym_difference not defined."
       end
 
@@ -530,7 +532,7 @@ module RGeo
       # this geometry, strictly speaking, the result of comparing objects
       # from different factories is undefined.
 
-      def rep_equals?(_another_geometry_)
+      def rep_equals?(another_geometry)
         raise Error::UnsupportedOperation, "Method Geometry#rep_equals? not defined."
       end
 
@@ -566,12 +568,12 @@ module RGeo
       # representational equivalence test, this method must fall back on
       # objective equivalence.
 
-      def eql?(rhs_)
-        if rhs_.is_a?(RGeo::Feature::Instance)
+      def eql?(rhs)
+        if rhs.is_a?(RGeo::Feature::Instance)
           begin
-            rep_equals?(rhs_)
+            rep_equals?(rhs)
           rescue Error::UnsupportedOperation
-            equal?(rhs_)
+            equal?(rhs)
           end
         else
           false
@@ -592,12 +594,12 @@ module RGeo
       # test, the == operator must fall back on representational or
       # objective equivalence.
 
-      def ==(rhs_)
-        if rhs_.is_a?(RGeo::Feature::Instance)
+      def ==(rhs)
+        if rhs.is_a?(RGeo::Feature::Instance)
           begin
-            equals?(rhs_)
+            equals?(rhs)
           rescue Error::UnsupportedOperation
-            eql?(rhs_)
+            eql?(rhs)
           end
         else
           false
@@ -609,8 +611,8 @@ module RGeo
       # types is not specified; an implementation may choose to provide
       # additional capabilities as appropriate.
 
-      def -(rhs_)
-        difference(rhs_)
+      def -(rhs)
+        difference(rhs)
       end
 
       # If the given rhs is a geometry object, this operator must behave
@@ -618,8 +620,8 @@ module RGeo
       # is not specified; an implementation may choose to provide
       # additional capabilities as appropriate.
 
-      def +(rhs_)
-        union(rhs_)
+      def +(rhs)
+        union(rhs)
       end
 
       # If the given rhs is a geometry object, this operator must behave
@@ -627,8 +629,8 @@ module RGeo
       # types is not specified; an implementation may choose to provide
       # additional capabilities as appropriate.
 
-      def *(rhs_)
-        intersection(rhs_)
+      def *(rhs)
+        intersection(rhs)
       end
     end
   end