🔧 Add a global config object

Config.global inherits from Config.default

Author: nevans

lib/net/imap.rb

@@ -737,6 +737,9 @@ class IMAP < Protocol
       include SSL
     end
 
+    # Returns the global Config object
+    def self.config; Config.global end
+
     # Returns the debug mode.
     def self.debug
       return @@debug

lib/net/imap/config.rb

@@ -8,12 +8,14 @@ module Net
   class IMAP
 
     # Net::IMAP::Config stores configuration options for Net::IMAP clients.
+    # The global configuration can be seen at either Net::IMAP.config or
+    # Net::IMAP::Config.global.
     #
     # ## Inheritance
     #
     # Configs have a parent[rdoc-ref:Config::AttrInheritance#parent] config, and
     # any attributes which have not been set locally will inherit the parent's
-    # value.
+    # value.  Config.global inherits from Config.default.
     #
     # See the following methods, defined by Config::AttrInheritance:
     # - {#new}[rdoc-ref:Config::AttrInheritance#reset] -- create a new config
@@ -31,6 +33,19 @@ class Config
       # The default config, which is hardcoded and frozen.
       def self.default; @default end
 
+      # The global config object.
+      def self.global; @global end
+
+      def self.[](config) # :nodoc: unfinished API
+        if config.is_a?(Config) || config.nil? && global.nil?
+          config
+        else
+          raise TypeError, "no implicit conversion of %s to %s" % [
+            config.class, Config
+          ]
+        end
+      end
+
       include AttrAccessors
       include AttrInheritance
 
@@ -65,7 +80,7 @@ def self.default; @default end
       # If +parent+ is not given, the global config is used by default.
       #
       # If a block is given, the new config object is yielded to it.
-      def initialize(parent = nil, **attrs)
+      def initialize(parent = Config.global, **attrs)
         super(parent)
         attrs.each do send(:"#{_1}=", _2) end
         yield self if block_given?
@@ -77,6 +92,8 @@ def initialize(parent = nil, **attrs)
         idle_response_timeout: 5,
       ).freeze
 
+      @global = default.new
+
     end
   end
 end

lib/net/imap/config/attr_inheritance.rb

@@ -32,7 +32,7 @@ def #{name}; (val = super) == INHERITED ? parent&.#{name} : val end
 
         def initialize(parent = nil) # :notnew:
           super()
-          @parent = parent
+          @parent = Config[parent]
           reset
         end
 

test/net/imap/test_config.rb

@@ -6,6 +6,10 @@
 class ConfigTest < Test::Unit::TestCase
   Config = Net::IMAP::Config
 
+  setup do
+    Config.global.reset
+  end
+
   test "#debug" do
     assert Config.new(debug: true).debug
     refute Config.new(debug: false).debug
@@ -32,6 +36,23 @@ class ConfigTest < Test::Unit::TestCase
     refute default.debug?
   end
 
+  test ".global" do
+    global = Config.global
+    assert global.equal?(Config.global)
+    assert global.is_a?(Config)
+    assert_same Config.default, global.parent
+    assert_equal false, global.debug?
+    global.debug = true
+    assert_equal true, global.debug?
+    global.reset(:debug)
+    assert_equal false, global.debug?
+    refute global.frozen?
+  end
+
+  test "Net::IMAP.config" do
+    assert Net::IMAP.config.equal?(Config.global)
+  end
+
   test ".new(parent, ...) and inheritance" do
     base = Config.new debug: false
     child = Config.new(base)
@@ -76,6 +97,12 @@ class ConfigTest < Test::Unit::TestCase
     assert_equal false, child.debug?
   end
 
+  test ".new always sets a parent" do
+    assert_same Config.global,  Config.new.parent
+    assert_same Config.default, Config.new(Config.default).parent
+    assert_same Config.global,  Config.new(Config.global).parent
+  end
+
   test "#inherited? and #reset(attr)" do
     base = Config.new debug: false, open_timeout: 99, idle_response_timeout: 15
     child = base.new debug: true, open_timeout: 15, idle_response_timeout: 10

test/net/imap/test_deprecated_client_options.rb

@@ -8,6 +8,7 @@ class DeprecatedClientOptionsTest < Test::Unit::TestCase
   include Net::IMAP::FakeServer::TestHelper
 
   def setup
+    Net::IMAP.config.reset
     @do_not_reverse_lookup = Socket.do_not_reverse_lookup
     Socket.do_not_reverse_lookup = true
     @threads = []

test/net/imap/test_imap.rb

@@ -12,6 +12,7 @@ class IMAPTest < Test::Unit::TestCase
   include Net::IMAP::FakeServer::TestHelper
 
   def setup
+    Net::IMAP.config.reset
     @do_not_reverse_lookup = Socket.do_not_reverse_lookup
     Socket.do_not_reverse_lookup = true
     @threads = []

test/net/imap/test_imap_capabilities.rb

@@ -9,6 +9,7 @@ class IMAPCapabilitiesTest < Test::Unit::TestCase
   include Net::IMAP::FakeServer::TestHelper
 
   def setup
+    Net::IMAP.config.reset
     @do_not_reverse_lookup = Socket.do_not_reverse_lookup
     Socket.do_not_reverse_lookup = true
     @threads = []

test/net/imap/test_imap_response_data.rb

@@ -6,6 +6,7 @@
 class IMAPResponseDataTest < Test::Unit::TestCase
 
   def setup
+    Net::IMAP.config.reset
     @do_not_reverse_lookup = Socket.do_not_reverse_lookup
     Socket.do_not_reverse_lookup = true
   end

test/net/imap/test_imap_response_parser.rb

@@ -11,6 +11,7 @@ class IMAPResponseParserTest < Test::Unit::TestCase
   extend  NetIMAPTestHelpers::TestFixtureGenerators
 
   def setup
+    Net::IMAP.config.reset
     @do_not_reverse_lookup = Socket.do_not_reverse_lookup
     Socket.do_not_reverse_lookup = true
   end