mixlib-config 2.2.11 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c764853ffe7576f6b9568775541cc9358cc6a392a26997af52ae0c9dcde1611e
-  data.tar.gz: 19713a0e41d1c407510483d11df8f6ac83e8645d5607890b5b7181fcf0e51689
+  metadata.gz: 542f1c9f7daff1297b70799397e6f44dba7896522e89334e71496db690802013
+  data.tar.gz: f2383ad0c71049dab95ceeac81d39d7b8ed1d8cb2e9a6ed45ac29acaa0d63838
 SHA512:
-  metadata.gz: 99c7c6639a2f2a1de69db7970d99ea5ca2a54fba04ac544967aba9a1552f3541a856b4d447098ee73364ac1094da33e7d5bdda92a87296e19d1d2dbbc5656ae2
-  data.tar.gz: 95be61fa365942dc7a0a7a1d1bcc5b0eff1e9a362ed9207a138e1dc362a7051c8a546d6b1bc1c2a40113bf93d83571a2fde96473ae1fe576e013faa0bdc3c78e
+  metadata.gz: d4137a9a0747261ad42cc1f3035ab6136823ee3c89666e7adf041e36190cd24179e0eee5711686011ab7c1e7efead2242aef88c6f9c0e03bfee8ef41509492be
+  data.tar.gz: 22248d0a227c55598fa81debb29a0eaa9436d27192bfbd45beb091b0ace555b4abd4783f09ef7c1febca965b386320268dada9fe5f45a94485cc266695144a9b

data/lib/mixlib/config.rb

@@ -33,11 +33,11 @@ module Mixlib
       class << base; attr_accessor :config_context_lists; end
       class << base; attr_accessor :config_context_hashes; end
       class << base; attr_accessor :config_parent; end
-      base.configuration = Hash.new
-      base.configurables = Hash.new
-      base.config_contexts = Hash.new
-      base.config_context_lists = Hash.new
-      base.config_context_hashes = Hash.new
+      base.configuration = ({})
+      base.configurables = ({})
+      base.config_contexts = ({})
+      base.config_context_lists = ({})
+      base.config_context_hashes = ({})
       base.initialize_mixlib_config
     end
 
@@ -70,7 +70,7 @@ module Mixlib
     # filename<String>:: A filename to read from
     def from_yaml(filename)
       require "yaml"
-      from_hash(YAML.load(IO.read(filename)), filename)
+      from_hash(YAML.load(IO.read(filename)))
     end
 
     # Parses valid JSON structure into Ruby
@@ -79,7 +79,7 @@ module Mixlib
     # filename<String>:: A filename to read from
     def from_json(filename)
       require "json"
-      from_hash(JSON.parse(IO.read(filename)), filename)
+      from_hash(JSON.parse(IO.read(filename)))
     end
 
     def from_toml(filename)
@@ -91,20 +91,8 @@ module Mixlib
     #
     # === Parameters
     # hash<Hash>:: A Hash containing configuration
-    def from_hash(hash, filename = "in_memory")
-      ruby_translation = []
-
-      to_dotted_hash(hash).each do |k, v|
-        if v.is_a? Array
-          ruby_translation << "#{k} #{v}"
-        elsif v.is_a? String
-          ruby_translation << "#{k} \"#{v}\""
-        else
-          ruby_translation << "#{k} #{v}"
-        end
-      end
-
-      instance_eval(ruby_translation.join("\n"), filename, 1)
+    def from_hash(hash)
+      apply_nested_hash(hash)
     end
 
     # Pass Mixlib::Config.configure() a block, and it will yield itself
@@ -153,11 +141,20 @@ module Mixlib
     # <True>:: If the config option exists
     # <False>:: If the config option does not exist
     def key?(key)
-      configuration.has_key?(key.to_sym) || config_contexts.has_key?(key.to_sym)
+      configuration.key?(key.to_sym) || config_contexts.key?(key.to_sym)
     end
 
     alias_method :has_key?, :key?
 
+    def is_default?(key)
+      symbol = key.to_sym
+      if configurables.key?(symbol)
+        configurables[symbol].is_default?(configuration)
+      else
+        raise ArgumentError, "config option must exist, and not be a context to check for default values"
+      end
+    end
+
     # Resets a config option to its default.
     #
     # === Parameters
@@ -168,8 +165,8 @@ module Mixlib
 
     # Resets all config options to their defaults.
     def reset
-      self.configuration = Hash.new
-      config_contexts.values.each { |config_context| config_context.reset }
+      self.configuration = ({})
+      config_contexts.values.each(&:reset)
     end
 
     # Makes a copy of any non-default values.
@@ -253,9 +250,9 @@ module Mixlib
     # === Returns
     # self
     def restore(hash)
-      self.configuration = hash.reject { |key, value| config_contexts.has_key?(key) }
+      self.configuration = hash.reject { |key, value| config_contexts.key?(key) }
       config_contexts.each do |key, config_context|
-        if hash.has_key?(key)
+        if hash.key?(key)
           config_context.restore(hash[key])
         else
           config_context.reset
@@ -263,7 +260,7 @@ module Mixlib
       end
       config_context_lists.each do |key, meta|
         meta[:values] = []
-        if hash.has_key?(key)
+        if hash.key?(key)
           hash[key].each do |val|
             context = define_context(meta[:definition_blocks])
             context.restore(val)
@@ -273,7 +270,7 @@ module Mixlib
       end
       config_context_hashes.each do |key, meta|
         meta[:values] = {}
-        if hash.has_key?(key)
+        if hash.key?(key)
           hash[key].each do |vkey, val|
             context = define_context(meta[:definition_blocks])
             context.restore(val)
@@ -292,7 +289,7 @@ module Mixlib
     # self
     def merge!(hash)
       hash.each do |key, value|
-        if config_contexts.has_key?(key)
+        if config_contexts.key?(key)
           # Grab the config context and let internal_get cache it if so desired
           config_contexts[key].restore(value)
         else
@@ -372,9 +369,10 @@ module Mixlib
     # The value of the config option.
     def configurable(symbol, &block)
       unless configurables[symbol]
-        if config_contexts.has_key?(symbol)
+        if config_contexts.key?(symbol)
           raise ReopenedConfigContextWithConfigurableError, "Cannot redefine config_context #{symbol} as a configurable value"
         end
+
         configurables[symbol] = Configurable.new(symbol)
         define_attr_accessor_methods(symbol)
       end
@@ -400,11 +398,11 @@ module Mixlib
     # block<Block>: a block that will be run in the context of this new config
     # class.
     def config_context(symbol, &block)
-      if configurables.has_key?(symbol)
+      if configurables.key?(symbol)
         raise ReopenedConfigurableWithConfigContextError, "Cannot redefine config value #{symbol} with a config context"
       end
 
-      if config_contexts.has_key?(symbol)
+      if config_contexts.key?(symbol)
         context = config_contexts[symbol]
       else
         context = Class.new
@@ -438,11 +436,11 @@ module Mixlib
     # block<Block>: a block that will be run in the context of this new config
     # class.
     def config_context_list(plural_symbol, singular_symbol, &block)
-      if configurables.has_key?(plural_symbol)
+      if configurables.key?(plural_symbol)
         raise ReopenedConfigurableWithConfigContextError, "Cannot redefine config value #{plural_symbol} with a config context"
       end
 
-      unless config_context_lists.has_key?(plural_symbol)
+      unless config_context_lists.key?(plural_symbol)
         config_context_lists[plural_symbol] = {
           definition_blocks: [],
           values: [],
@@ -470,11 +468,11 @@ module Mixlib
     # block<Block>: a block that will be run in the context of this new config
     # class.
     def config_context_hash(plural_symbol, singular_symbol, &block)
-      if configurables.has_key?(plural_symbol)
+      if configurables.key?(plural_symbol)
         raise ReopenedConfigurableWithConfigContextError, "Cannot redefine config value #{plural_symbol} with a config context"
       end
 
-      unless config_context_hashes.has_key?(plural_symbol)
+      unless config_context_hashes.key?(plural_symbol)
         config_context_hashes[plural_symbol] = {
           definition_blocks: [],
           values: {},
@@ -534,9 +532,10 @@ module Mixlib
     # <ArgumentError>:: if value is set to something other than true, false, or :warn
     #
     def config_strict_mode=(value)
-      if ![ true, false, :warn, nil ].include?(value)
+      unless [ true, false, :warn, nil ].include?(value)
         raise ArgumentError, "config_strict_mode must be true, false, nil or :warn"
       end
+
       @config_strict_mode = value
     end
 
@@ -558,6 +557,28 @@ module Mixlib
       internal_get_or_set(method_symbol, *args)
     end
 
+    protected
+
+    # Given a (nested) Hash, apply it to the config object and any contexts.
+    #
+    # This is preferable to converting it to the string representation with
+    # the #to_dotted_hash method above.
+    #
+    # === Parameters
+    # hash<Hash>:: The hash to apply to the config oject
+    def apply_nested_hash(hash)
+      hash.each do |k, v|
+        if v.is_a? Hash
+          # If loading from hash, and we reference a context that doesn't exist
+          # and warning/strict is off, we need to create the config context that we expected to be here.
+          context = internal_get(k.to_sym) || config_context(k.to_sym)
+          context.apply_nested_hash(v)
+        else
+          internal_set(k.to_sym, v)
+        end
+      end
+    end
+
     private
 
     # Given a (nested) Hash, turn it into a single top-level hash using dots as
@@ -588,9 +609,9 @@ module Mixlib
     # value<Object>:: Value to be set in config hash
     #
     def internal_set(symbol, value)
-      if configurables.has_key?(symbol)
+      if configurables.key?(symbol)
         configurables[symbol].set(configuration, value)
-      elsif config_contexts.has_key?(symbol)
+      elsif config_contexts.key?(symbol)
         config_contexts[symbol].restore(value.to_hash)
       else
         if config_strict_mode == :warn
@@ -603,13 +624,13 @@ module Mixlib
     end
 
     def internal_get(symbol)
-      if configurables.has_key?(symbol)
+      if configurables.key?(symbol)
         configurables[symbol].get(configuration)
-      elsif config_contexts.has_key?(symbol)
+      elsif config_contexts.key?(symbol)
         config_contexts[symbol]
-      elsif config_context_lists.has_key?(symbol)
+      elsif config_context_lists.key?(symbol)
         config_context_lists[symbol]
-      elsif config_context_hashes.has_key?(symbol)
+      elsif config_context_hashes.key?(symbol)
         config_context_hashes[symbol]
       else
         if config_strict_mode == :warn
@@ -686,7 +707,7 @@ module Mixlib
       # Adds a single new context to the list
       meta.send :define_method, singular_symbol do |key, &block|
         context_hash_details = internal_get(plural_symbol)
-        context = if context_hash_details[:values].has_key? key
+        context = if context_hash_details[:values].key? key
                     context_hash_details[:values][key]
                   else
                     new_context = define_context(context_hash_details[:definition_blocks])

data/lib/mixlib/config/configurable.rb

@@ -1,6 +1,6 @@
 #
 # Author:: John Keiser (<jkeiser@chef.io>)
-# Copyright:: Copyright (c) 2013-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) 2013-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,20 +19,31 @@
 module Mixlib
   module Config
     class Configurable
+      attr_reader :symbol
+      attr_reader :default_value
+      attr_reader :default_block
+
       def initialize(symbol)
         @symbol = symbol
-        @default_block = nil
-        @has_default = false
-        @default_value = nil
-        @writes_value = nil
       end
 
-      attr_reader :has_default
+      def has_default?
+        instance_variable_defined?(:@default_value)
+      end
+
+      def writes_value?
+        instance_variable_defined?(:@writes_value)
+      end
+
+      def default_block?
+        instance_variable_defined?(:@default_block)
+      end
+
+      alias_method :has_default, :has_default?
 
       def defaults_to(default_value = nil, &block)
-        @has_default = true
-        @default_block = block
         @default_value = default_value
+        @default_block = block if block_given?
         self
       end
 
@@ -42,32 +53,38 @@ module Mixlib
       end
 
       def get(config)
-        if config.has_key?(@symbol)
-          config[@symbol]
-        elsif @default_block
-          @default_block.call
+        if config.key?(symbol)
+          config[symbol]
+        elsif default_block?
+          default_block.call
         else
-          begin
-            # Some things cannot be dup'd, and you won't know this till after the fact
-            # because all values implement dup
-            config[@symbol] = @default_value.dup
-          rescue TypeError
-            @default_value
-          end
+          config[symbol] = safe_dup(default_value)
         end
       end
 
       def set(config, value)
-        config[@symbol] = @writes_value ? @writes_value.call(value) : value
+        config[symbol] = writes_value? ? @writes_value.call(value) : value
       end
 
       def default
-        if @default_block
-          @default_block.call
+        if default_block?
+          default_block.call
         else
-          @default_value
+          default_value
         end
       end
+
+      def is_default?(config)
+        !config.key?(symbol) || config[symbol] == default_value
+      end
+
+      private
+
+      def safe_dup(e)
+        e.dup
+      rescue TypeError
+        e
+      end
     end
   end
 end

data/lib/mixlib/config/version.rb

@@ -19,7 +19,7 @@
 module Mixlib
   module Config
 
-    VERSION = "2.2.11"
+    VERSION = "3.0.5".freeze
 
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mixlib-config
 version: !ruby/object:Gem::Version
-  version: 2.2.11
+  version: 3.0.5
 platform: ruby
 authors:
 - Chef Software, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-02 00:00:00.000000000 Z
+date: 2019-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tomlrb
@@ -24,85 +24,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: chefstyle
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: A class based configuration library
-email: legal@chef.io
+email: info@chef.io
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE
-- README.md
+extra_rdoc_files: []
 files:
-- Gemfile
 - LICENSE
 - NOTICE
-- README.md
-- Rakefile
 - lib/mixlib/config.rb
 - lib/mixlib/config/configurable.rb
 - lib/mixlib/config/reopened_config_context_with_configurable_error.rb
 - lib/mixlib/config/reopened_configurable_with_config_context_error.rb
 - lib/mixlib/config/unknown_config_option_error.rb
 - lib/mixlib/config/version.rb
-- mixlib-config.gemspec
-- spec/mixlib/config_spec.rb
-- spec/spec_helper.rb
-homepage: https://www.chef.io
+homepage: https://github.com/chef/mixlib-config
 licenses:
 - Apache-2.0
 metadata: {}
@@ -114,15 +50,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A class based configuration library