faraday 0.9.1 → 0.16.0

data/lib/faraday/autoload.rb

@@ -1,84 +1,95 @@
+# frozen_string_literal: true
+
 module Faraday
-  # Internal: Adds the ability for other modules to manage autoloadable
+  # Adds the ability for other modules to manage autoloadable
   # constants.
+  #
+  # @api private
   module AutoloadHelper
-    # Internal: Registers the constants to be auto loaded.
+    # Registers the constants to be auto loaded.
     #
-    # prefix  - The String require prefix.  If the path is inside Faraday, then
-    #           it will be prefixed with the root path of this loaded Faraday
-    #           version.
-    # options - Hash of Symbol => String library names.
+    # @param prefix [String] The require prefix. If the path is inside Faraday,
+    #           then it will be prefixed with the root path of this loaded
+    #           Faraday version.
+    # @param options [{ Symbol => String }] library names.
     #
-    # Examples.
+    # @example
     #
     #   Faraday.autoload_all 'faraday/foo',
-    #     :Bar => 'bar'
+    #     Bar: 'bar'
     #
     #   # requires faraday/foo/bar to load Faraday::Bar.
     #   Faraday::Bar
     #
-    #
-    # Returns nothing.
+    # @return [void]
     def autoload_all(prefix, options)
-      if prefix =~ /^faraday(\/|$)/i
+      if prefix =~ %r{^faraday(/|$)}i
         prefix = File.join(Faraday.root_path, prefix)
       end
+
       options.each do |const_name, path|
         autoload const_name, File.join(prefix, path)
       end
     end
 
-    # Internal: Loads each autoloaded constant.  If thread safety is a concern,
+    # Loads each autoloaded constant.  If thread safety is a concern,
     # wrap this in a Mutex.
     #
-    # Returns nothing.
+    # @return [void]
     def load_autoloaded_constants
       constants.each do |const|
         const_get(const) if autoload?(const)
       end
     end
 
-    # Internal: Filters the module's contents with those that have been already
+    # Filters the module's contents with those that have been already
     # autoloaded.
     #
-    # Returns an Array of Class/Module objects.
+    # @return [Array<Class, Module>]
     def all_loaded_constants
-      constants.map { |c| const_get(c) }.
-        select { |a| a.respond_to?(:loaded?) && a.loaded? }
+      constants
+        .map { |c| const_get(c) }
+        .select { |a| a.respond_to?(:loaded?) && a.loaded? }
     end
   end
 
+  # Adapter is the base class for all Faraday adapters.
+  # @see lib/faraday/adapter.rb Original class location
   class Adapter
     extend AutoloadHelper
     autoload_all 'faraday/adapter',
-      :NetHttp           => 'net_http',
-      :NetHttpPersistent => 'net_http_persistent',
-      :Typhoeus          => 'typhoeus',
-      :EMSynchrony       => 'em_synchrony',
-      :EMHttp            => 'em_http',
-      :Patron            => 'patron',
-      :Excon             => 'excon',
-      :Test              => 'test',
-      :Rack              => 'rack',
-      :HTTPClient        => 'httpclient'
+                 NetHttp: 'net_http',
+                 NetHttpPersistent: 'net_http_persistent',
+                 EMSynchrony: 'em_synchrony',
+                 EMHttp: 'em_http',
+                 Typhoeus: 'typhoeus',
+                 Patron: 'patron',
+                 Excon: 'excon',
+                 Test: 'test',
+                 Rack: 'rack',
+                 HTTPClient: 'httpclient'
   end
 
+  # Request represents a single HTTP request for a Faraday adapter to make.
+  # @see lib/faraday/request.rb Original class location
   class Request
     extend AutoloadHelper
     autoload_all 'faraday/request',
-      :UrlEncoded => 'url_encoded',
-      :Multipart => 'multipart',
-      :Retry => 'retry',
-      :Authorization => 'authorization',
-      :BasicAuthentication => 'basic_authentication',
-      :TokenAuthentication => 'token_authentication',
-      :Instrumentation => 'instrumentation'
+                 UrlEncoded: 'url_encoded',
+                 Multipart: 'multipart',
+                 Retry: 'retry',
+                 Authorization: 'authorization',
+                 BasicAuthentication: 'basic_authentication',
+                 TokenAuthentication: 'token_authentication',
+                 Instrumentation: 'instrumentation'
   end
 
+  # Response represents the returned value of a sent Faraday request.
+  # @see lib/faraday/response.rb Original class location
   class Response
     extend AutoloadHelper
     autoload_all 'faraday/response',
-      :RaiseError => 'raise_error',
-      :Logger     => 'logger'
+                 RaiseError: 'raise_error',
+                 Logger: 'logger'
   end
 end