mixlib-config 2.2.12 → 3.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e49d199c25ed417933cc95a2868d154e4f0fbc631aef9d1c5f05310ebbdbbe56
-  data.tar.gz: 4307e6ce5ff263812c96055084d328901587139f82ca213a2ec1272208931150
+  metadata.gz: 6997a320d19a4e3844ff8ccdb84dbf5a830dc7b83114e787a413cc4cc64c3776
+  data.tar.gz: 379b34bd06770b8e24f14eb3060577794d5e3f4fc2a5ecc5d25df951eefec632
 SHA512:
-  metadata.gz: cdfcc6a831af4bd63216614a7e191152cd5f9dee67e7e87a2775d5d7c766b7c6e8f667ec45062400688e2cc746e2936041087f4e1de85e72f91b10c71c7a36de
-  data.tar.gz: ac0b067a839675c594663b0fa5a91cd66059dc807775dfaacceae62f77efb975d3f26db0ca1781571bfd73c97c5b09bea921fe04fc7e0cf3af48e617917241f5
+  metadata.gz: 776bf8d4cf896adb8164cc73ba2d7e44c9ebc343fdbca6d78084976ef69a8f50add631bff91a33d36a785df04243357ddd1959619a392919dbdd24c7f8dbed83
+  data.tar.gz: adc0991e31c17d3d485a694a4bc9e74c79ed41465cedd59d1229995d52bee49ae5e15fb6705fb89f4581ed3bad01e77556c898f38a15cba0055acd96a4f5745d

data/lib/mixlib/config.rb

@@ -18,11 +18,11 @@
 # limitations under the License.
 #
 
-require "mixlib/config/version"
-require "mixlib/config/configurable"
-require "mixlib/config/unknown_config_option_error"
-require "mixlib/config/reopened_config_context_with_configurable_error"
-require "mixlib/config/reopened_configurable_with_config_context_error"
+require_relative "config/version"
+require_relative "config/configurable"
+require_relative "config/unknown_config_option_error"
+require_relative "config/reopened_config_context_with_configurable_error"
+require_relative "config/reopened_configurable_with_config_context_error"
 
 module Mixlib
   module Config
@@ -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,14 +141,14 @@ 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.has_key?(symbol)
+      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"
@@ -177,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.
@@ -262,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
@@ -272,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)
@@ -282,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)
@@ -301,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
@@ -381,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
@@ -409,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
@@ -447,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: [],
@@ -479,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: {},
@@ -543,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
 
@@ -567,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
@@ -597,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
@@ -612,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
@@ -695,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/version.rb

@@ -19,7 +19,7 @@
 module Mixlib
   module Config
 
-    VERSION = "2.2.12"
+    VERSION = "3.0.6".freeze
 
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mixlib-config
 version: !ruby/object:Gem::Version
-  version: 2.2.12
+  version: 3.0.6
 platform: ruby
 authors:
 - Chef Software, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-06 00:00:00.000000000 Z
+date: 2019-12-29 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

data/Gemfile

@@ -1,3 +0,0 @@
-source "https://rubygems.org"
-
-gemspec

data/README.md

@@ -1,316 +0,0 @@
-# Mixlib::Config
-
-[![Build Status](https://travis-ci.org/chef/mixlib-config.svg?branch=master)](https://travis-ci.org/chef/mixlib-config)[![Gem Version](https://badge.fury.io/rb/mixlib-config.svg)](https://badge.fury.io/rb/mixlib-config)
-
-Mixlib::Config provides a class-based configuration object, as used in Chef. To use in your project:
-
-```ruby
-  require 'mixlib/config'
-
-  module MyConfig
-    extend Mixlib::Config
-    config_strict_mode true
-    default :first_value, 'something'
-    default :other_value, 'something_else'
-  end
-```
-
-You can use this to provide a configuration file for a user. For example, if you do this:
-
-```ruby
-  MyConfig.from_file('~/.myconfig.rb')
-```
-
-A user could write a Ruby config file that looked like this:
-
-```ruby
-  first_value 'hi'
-  second_value "#{first_value}!  10 times 10 is #{10*10}!"
-```
-
-Inside your app, you can check configuration values with this syntax:
-
-```ruby
-  MyConfig.first_value   # returns 'something'
-  MyConfig[:first_value] # returns 'something'
-```
-
-And you can modify configuration values with this syntax:
-
-```ruby
-  MyConfig.first_value('foobar')    # sets first_value to 'foobar'
-  MyConfig.first_value = 'foobar'   # sets first_value to 'foobar'
-  MyConfig[:first_value] = 'foobar' # sets first_value to 'foobar'
-```
-
-If you prefer to allow your users to pass in configuration via YAML, JSON or TOML files, `mixlib-config` supports that too!
-
-```ruby
-  MyConfig.from_file('~/.myconfig.yml')
-  MyConfig.from_file('~/.myconfig.json')
-  MyConfig.from_file('~/.myconfig.toml')
-```
-
-This way, a user could write a YAML config file that looked like this:
-
-```yaml
----
-first_value: 'hi'
-second_value: 'goodbye'
-```
-
-or a JSON file that looks like this:
-
-```json
-{
-  "first_value": "hi",
-  "second_value": "goodbye"
-}
-```
-
-or a TOML file that looks like this:
-
-```toml
-first_value = "hi"
-second_value = "goodbye"
-```
-
-Please note: There is an inherent limitation in the logic you can do with YAML and JSON file. At this time, `mixlib-config` does not support ERB or other logic in YAML or JSON config (read "static content only").
-
-## Nested Configuration
-
-Often you want to be able to group configuration options to provide a common context. Mixlib::Config supports this thus:
-
-```ruby
-  require 'mixlib/config'
-
-  module MyConfig
-    extend Mixlib::Config
-    config_context :logging do
-      default :base_filename, 'mylog'
-      default :max_log_files, 10
-    end
-  end
-```
-
-The user can write their config file in one of three formats:
-
-### Method Style
-
-```ruby
-logging.base_filename 'superlog'
-logging.max_log_files 2
-```
-
-### Block Style
-
-Using this format the block is executed in the context, so all configurables on that context is directly accessible
-
-```ruby
-logging do
-  base_filename 'superlog'
-  max_log_files 2
-end
-```
-
-### Block with Argument Style
-
-Using this format the context is given to the block as an argument
-
-```ruby
-logging do |l|
-  l.base_filename = 'superlog'
-  l.max_log_files = 2
-end
-```
-
-You can access these variables thus:
-
-```ruby
-  MyConfig.logging.base_filename
-  MyConfig[:logging][:max_log_files]
-```
-
-### Lists of Contexts
-For use cases where you need to be able to specify a list of things with identical configuration
-you can define a `context_config_list` like so:
-
-```ruby
-  require 'mixlib/config'
-
-  module MyConfig
-    extend Mixlib::Config
-
-    # The first argument is the plural word for your item, the second is the singular
-    config_context_list :apples, :apple do
-      default :species
-      default :color, 'red'
-      default :crispness, 10
-    end
-  end
-```
-
-With this definition everytime the `apple` is called within the config file it
-will create a new item that can be configured with a block like so:
-
-```ruby
-apple do
-  species 'Royal Gala'
-end
-apple do
-  species 'Granny Smith'
-  color 'green'
-end
-```
-
-You can then iterate over the defined values in code:
-
-```ruby
-MyConfig.apples.each do |apple|
-  puts "#{apple.species} are #{apple.color}"
-end
-
-# => Royal Gala are red
-# => Granny Smith are green
-```
-
-_**Note**: When using the config context lists they must use the [block style](#block-style) or [block with argument style](#block-with-argument-style)_
-
-### Hashes of Contexts
-For use cases where you need to be able to specify a list of things with identical configuration
-that are keyed to a specific value, you can define a `context_config_hash` like so:
-
-```ruby
-  require 'mixlib/config'
-
-  module MyConfig
-    extend Mixlib::Config
-
-    # The first argument is the plural word for your item, the second is the singular
-    config_context_hash :apples, :apple do
-      default :species
-      default :color, 'red'
-      default :crispness, 10
-    end
-  end
-```
-
-This can then be used in the config file like so:
-
-```ruby
-apple 'Royal Gala' do
-  species 'Royal Gala'
-end
-apple 'Granny Smith' do
-  species 'Granny Smith'
-  color 'green'
-end
-
-# You can also reopen a context to edit a value
-apple 'Royal Gala' do
-  crispness 3
-end
-```
-
-You can then iterate over the defined values in code:
-
-```ruby
-MyConfig.apples.each do |key, apple|
-  puts "#{key} => #{apple.species} are #{apple.color}"
-end
-
-# => Royal Gala => Royal Gala are red
-# => Granny Smith => Granny Smith are green
-```
-
-_**Note**: When using the config context hashes they must use the [block style](#block-style) or [block with argument style](#block-with-argument-style)_
-
-## Default Values
-
-Mixlib::Config has a powerful default value facility. In addition to being able to specify explicit default values, you can even specify Ruby code blocks that will run if the config value is not set. This can allow you to build options whose values are based on other options.
-
-```ruby
-  require 'mixlib/config'
-
-  module MyConfig
-    extend Mixlib::Config
-    config_strict_mode true
-    default :verbosity, 1
-    default(:print_network_requests) { verbosity >= 2 }
-    default(:print_ridiculously_unimportant_stuff) { verbosity >= 10 }
-  end
-```
-
-This allows the user to quickly specify a number of values with one default, while still allowing them to override anything:
-
-```ruby
-  verbosity 5
-  print_network_requests false
-```
-
-You can also inspect if the values are still their defaults or not:
-
-```ruby
-MyConfig.is_default?(:verbosity)  # == true
-MyConfig[:verbosity] = 5
-MyConfig.is_default?(:verbosity)  # == false
-MyConfig[:verbosity] = 1
-MyConfig.is_default?(:verbosity)  # == true
-```
-
-Trying to call `is_default?` on a config context or a config which does not have a declared default is an error and will raise.
-
-## Strict Mode
-
-Misspellings are a common configuration problem, and Mixlib::Config has an answer: `config_strict_mode`. Setting `config_strict_mode` to `true` will cause any misspelled or incorrect configuration option references to throw `Mixlib::Config::UnknownConfigOptionError`.
-
-```ruby
-  require 'mixlib/config'
-
-  module MyConfig
-    extend Mixlib::Config
-    config_strict_mode true
-    default :filename, '~/output.txt'
-    configurable :server_url # configurable declares an option with no default value
-    config_context :logging do
-      default :base_name, 'log'
-      default :max_files, 20
-    end
-  end
-```
-
-Now if a user types `fielname "~/output-mine.txt"` in their configuration file, it will toss an exception telling them that the option "fielname" is unknown. If you do not set config_strict_mode, the fielname option will be merrily set and the application just won't know about it.
-
-Different config_contexts can have different strict modes; but they inherit the strict mode of their parent if you don't explicitly set it. So setting it once at the top level is sufficient. In the above example, `logging.base_naem 'mylog'` will raise an error.
-
-In conclusion: _always set config_strict_mode to true_. You know you want to.
-
-## Testing and Reset
-
-Testing your application with different sets of arguments can by simplified with `reset`. Call `MyConfig.reset` before each test and all configuration will be reset to its default value. There's no need to explicitly unset all your options between each run.
-
-NOTE: if you have arrays of arrays, or other deep nesting, we suggest you use code blocks to set up your default values (`default(:option) { [ [ 1, 2 ], [ 3, 4 ] ] }`). Deep children will not always be reset to their default values.
-
-Enjoy!
-
-## Contributing
-
-For information on contributing to this project see <https://github.com/chef/chef/blob/master/CONTRIBUTING.md>
-
-## License
-
-- Copyright:: Copyright (c) 2009-2016 Chef Software, Inc.
-- License:: Apache License, Version 2.0
-
-```text
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.