tsumanne 0.0.2 → 0.0.4

data/sorbet/rbi/gems/mixlib-config@3.0.27.rbi

@@ -4,10 +4,95 @@
 # This is an autogenerated file for types exported from the `mixlib-config` gem.
 # Please instead update this file by running `bin/tapioca gem mixlib-config`.
 
-# source://mixlib-config//lib/mixlib/config/version.rb#19
+
+# Author:: John Keiser (<jkeiser@chef.io>)
+# Copyright:: Copyright (c) 2013-2018, Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+#
+# Author:: John Keiser (<jkeiser@chef.io>)
+# Copyright:: Copyright (c) 2013-2016 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+#
+# Author:: John Keiser (<jkeiser@chef.io>)
+# Copyright:: Copyright (c) 2013-2016 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+#
+# Author:: John Keiser (<jkeiser@chef.io>)
+# Copyright:: Copyright (c) 2013-2016 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+#
+# Author:: Daniel DeLeo (<dan@chef.io>)
+# Copyright:: Copyright (c) 2013-2018, Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+# pkg:gem/mixlib-config#lib/mixlib/config/version.rb:19
 module Mixlib; end
 
-# source://mixlib-config//lib/mixlib/config/version.rb#20
+# pkg:gem/mixlib-config#lib/mixlib/config/version.rb:20
 module Mixlib::Config
   # Get the value of a config option
   #
@@ -20,7 +105,7 @@ module Mixlib::Config
   # === Raises
   # <UnknownConfigOptionError>:: If the config option does not exist and strict mode is on.
   #
-  # source://mixlib-config//lib/mixlib/config.rb#116
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:116
   def [](config_option); end
 
   # Set the value of a config option
@@ -35,7 +120,7 @@ module Mixlib::Config
   # === Raises
   # <UnknownConfigOptionError>:: If the config option does not exist and strict mode is on.
   #
-  # source://mixlib-config//lib/mixlib/config.rb#131
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:131
   def []=(config_option, value); end
 
   # metaprogramming to ensure that the slot for method_symbol
@@ -46,7 +131,7 @@ module Mixlib::Config
   # blk<Block>:: logic block to run in setting slot method_symbol to value
   # value<Object>:: Value to be set in config hash
   #
-  # source://mixlib-config//lib/mixlib/config.rb#331
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:331
   def config_attr_writer(method_symbol, &block); end
 
   # Allows you to create a new config context where you can define new
@@ -65,7 +150,7 @@ module Mixlib::Config
   # block<Block>: a block that will be run in the context of this new config
   # class.
   #
-  # source://mixlib-config//lib/mixlib/config.rb#400
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:400
   def config_context(symbol, &block); end
 
   # Allows you to create a new hash of config contexts where you can define new
@@ -85,7 +170,7 @@ module Mixlib::Config
   # block<Block>: a block that will be run in the context of this new config
   # class.
   #
-  # source://mixlib-config//lib/mixlib/config.rb#470
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:470
   def config_context_hash(plural_symbol, singular_symbol, &block); end
 
   # Allows you to create a new list of config contexts where you can define new
@@ -105,7 +190,7 @@ module Mixlib::Config
   # block<Block>: a block that will be run in the context of this new config
   # class.
   #
-  # source://mixlib-config//lib/mixlib/config.rb#438
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:438
   def config_context_list(plural_symbol, singular_symbol, &block); end
 
   # Gets or sets strict mode.  When strict mode is on, only values which
@@ -125,7 +210,7 @@ module Mixlib::Config
   # === Raises
   # <ArgumentError>:: if value is set to something other than true, false, or :warn
   #
-  # source://mixlib-config//lib/mixlib/config.rb#505
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:505
   def config_strict_mode(value = T.unsafe(nil)); end
 
   # Sets strict mode.  When strict mode is on, only values which
@@ -141,7 +226,7 @@ module Mixlib::Config
   # === Raises
   # <ArgumentError>:: if value is set to something other than true, false, or :warn
   #
-  # source://mixlib-config//lib/mixlib/config.rb#534
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:534
   def config_strict_mode=(value); end
 
   # metaprogramming to set information about a config option.  This may be
@@ -170,7 +255,7 @@ module Mixlib::Config
   # === Returns
   # The value of the config option.
   #
-  # source://mixlib-config//lib/mixlib/config.rb#370
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:370
   def configurable(symbol, &block); end
 
   # Pass Mixlib::Config.configure() a block, and it will yield itself
@@ -178,9 +263,7 @@ module Mixlib::Config
   # === Parameters
   # block<Block>:: A block that is called with self.configuration as the argument.
   #
-  # @yield [configuration]
-  #
-  # source://mixlib-config//lib/mixlib/config.rb#102
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:102
   def configure(&block); end
 
   # metaprogramming to set the default value for the given config option
@@ -190,7 +273,7 @@ module Mixlib::Config
   # default_value<Object>:: Default value (can be unspecified)
   # block<Block>:: Logic block that calculates default value
   #
-  # source://mixlib-config//lib/mixlib/config.rb#341
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:341
   def default(symbol, default_value = T.unsafe(nil), &block); end
 
   # Resets a config option to its default.
@@ -198,7 +281,7 @@ module Mixlib::Config
   # === Parameters
   # symbol<Symbol>:: Name of the config option
   #
-  # source://mixlib-config//lib/mixlib/config.rb#162
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:162
   def delete(symbol); end
 
   # Loads a given ruby file, and runs instance_eval against it in the context of the current
@@ -209,7 +292,7 @@ module Mixlib::Config
   # === Parameters
   # filename<String>:: A filename to read from
   #
-  # source://mixlib-config//lib/mixlib/config.rb#55
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:55
   def from_file(filename); end
 
   # Transforms a Hash into method-style configuration syntax to be processed
@@ -217,7 +300,7 @@ module Mixlib::Config
   # === Parameters
   # hash<Hash>:: A Hash containing configuration
   #
-  # source://mixlib-config//lib/mixlib/config.rb#94
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:94
   def from_hash(hash); end
 
   # Parses valid JSON structure into Ruby
@@ -225,10 +308,10 @@ module Mixlib::Config
   # === Parameters
   # filename<String>:: A filename to read from
   #
-  # source://mixlib-config//lib/mixlib/config.rb#80
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:80
   def from_json(filename); end
 
-  # source://mixlib-config//lib/mixlib/config.rb#85
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:85
   def from_toml(filename); end
 
   # Parses valid YAML structure into Ruby so it can be ingested into the Class
@@ -236,21 +319,10 @@ module Mixlib::Config
   # === Parameters
   # filename<String>:: A filename to read from
   #
-  # source://mixlib-config//lib/mixlib/config.rb#71
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:71
   def from_yaml(filename); end
 
-  # Check if Mixlib::Config has a config option.
-  #
-  # === Parameters
-  # key<Symbol>:: The config option to check for
-  #
-  # === Returns
-  # <True>:: If the config option exists
-  # <False>:: If the config option does not exist
-  #
-  # @return [Boolean]
-  #
-  # source://mixlib-config//lib/mixlib/config.rb#143
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:147
   def has_key?(key); end
 
   # Creates a shallow copy of the internal hash
@@ -260,15 +332,13 @@ module Mixlib::Config
   # === Returns
   # result of Hash#dup
   #
-  # source://mixlib-config//lib/mixlib/config.rb#319
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:319
   def hash_dup; end
 
-  # source://mixlib-config//lib/mixlib/config.rb#44
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:44
   def initialize_mixlib_config; end
 
-  # @return [Boolean]
-  #
-  # source://mixlib-config//lib/mixlib/config.rb#149
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:149
   def is_default?(key); end
 
   # Check if Mixlib::Config has a config option.
@@ -280,9 +350,7 @@ module Mixlib::Config
   # <True>:: If the config option exists
   # <False>:: If the config option does not exist
   #
-  # @return [Boolean]
-  #
-  # source://mixlib-config//lib/mixlib/config.rb#143
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:143
   def key?(key); end
 
   # Return the set of config hash keys.
@@ -293,7 +361,7 @@ module Mixlib::Config
   # === Returns
   # result of Hash#keys
   #
-  # source://mixlib-config//lib/mixlib/config.rb#309
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:309
   def keys; end
 
   # Merge an incoming hash with our config options
@@ -304,7 +372,7 @@ module Mixlib::Config
   # === Returns
   # self
   #
-  # source://mixlib-config//lib/mixlib/config.rb#290
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:290
   def merge!(hash); end
 
   # Allows for simple lookups and setting of config options via method calls
@@ -321,12 +389,12 @@ module Mixlib::Config
   # === Raises
   # <UnknownConfigOptionError>:: If the config option does not exist and strict mode is on.
   #
-  # source://mixlib-config//lib/mixlib/config.rb#555
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:555
   def method_missing(method_symbol, *args); end
 
   # Resets all config options to their defaults.
   #
-  # source://mixlib-config//lib/mixlib/config.rb#167
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:167
   def reset; end
 
   # Restore non-default values from the given hash.
@@ -337,7 +405,7 @@ module Mixlib::Config
   # === Returns
   # self
   #
-  # source://mixlib-config//lib/mixlib/config.rb#252
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:252
   def restore(hash); end
 
   # Makes a copy of any non-default values.
@@ -383,53 +451,10 @@ module Mixlib::Config
   #       }
   #     }
   #
-  # source://mixlib-config//lib/mixlib/config.rb#215
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:215
   def save(include_defaults = T.unsafe(nil)); end
 
-  # Makes a copy of any non-default values.
-  #
-  # This returns a shallow copy of the hash; while the hash itself is
-  # duplicated a la dup, modifying data inside arrays and hashes may modify
-  # the original Config object.
-  #
-  # === Returns
-  #
-  # Hash of values the user has set.
-  #
-  # === Examples
-  #
-  # For example, this config class:
-  #
-  #     class MyConfig < Mixlib::Config
-  #       default :will_be_set, 1
-  #       default :will_be_set_to_default, 1
-  #       default :will_not_be_set, 1
-  #       configurable(:computed_value) { |x| x*2 }
-  #       config_context :group do
-  #         default :will_not_be_set, 1
-  #       end
-  #       config_context :group_never_set
-  #     end
-  #
-  #     MyConfig.x = 2
-  #     MyConfig.will_be_set = 2
-  #     MyConfig.will_be_set_to_default = 1
-  #     MyConfig.computed_value = 2
-  #     MyConfig.group.x = 3
-  #
-  # produces this:
-  #
-  #     MyConfig.save == {
-  #       :x => 2,
-  #       :will_be_set => 2,
-  #       :will_be_set_to_default => 1,
-  #       :computed_value => 4,
-  #       :group => {
-  #         :x => 3
-  #       }
-  #     }
-  #
-  # source://mixlib-config//lib/mixlib/config.rb#215
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:243
   def to_hash(include_defaults = T.unsafe(nil)); end
 
   protected
@@ -442,27 +467,27 @@ module Mixlib::Config
   # === Parameters
   # hash<Hash>:: The hash to apply to the config object
   #
-  # source://mixlib-config//lib/mixlib/config.rb#569
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:569
   def apply_nested_hash(hash); end
 
   private
 
-  # source://mixlib-config//lib/mixlib/config.rb#659
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:659
   def define_attr_accessor_methods(symbol); end
 
-  # source://mixlib-config//lib/mixlib/config.rb#729
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:729
   def define_context(definition_blocks); end
 
-  # source://mixlib-config//lib/mixlib/config.rb#703
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:703
   def define_hash_attr_accessor_methods(plural_symbol, singular_symbol); end
 
-  # source://mixlib-config//lib/mixlib/config.rb#682
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:682
   def define_list_attr_accessor_methods(plural_symbol, singular_symbol); end
 
-  # source://mixlib-config//lib/mixlib/config.rb#629
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:629
   def internal_get(symbol); end
 
-  # source://mixlib-config//lib/mixlib/config.rb#648
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:648
   def internal_get_or_set(symbol, *args); end
 
   # Internal dispatch setter for config values.
@@ -471,7 +496,7 @@ module Mixlib::Config
   # symbol<Symbol>:: Name of the method (variable setter)
   # value<Object>:: Value to be set in config hash
   #
-  # source://mixlib-config//lib/mixlib/config.rb#614
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:614
   def internal_set(symbol, value); end
 
   # Given a (nested) Hash, turn it into a single top-level hash using dots as
@@ -485,96 +510,76 @@ module Mixlib::Config
   # === Returns
   # value:: A single-depth Hash using dot notation to indicate nesting
   #
-  # source://mixlib-config//lib/mixlib/config.rb#597
+  # pkg:gem/mixlib-config#lib/mixlib/config.rb:597
   def to_dotted_hash(hash, recursive_key = T.unsafe(nil)); end
 
   class << self
-    # @private
-    #
-    # source://mixlib-config//lib/mixlib/config.rb#29
+    # pkg:gem/mixlib-config#lib/mixlib/config.rb:29
     def extended(base); end
   end
 end
 
-# source://mixlib-config//lib/mixlib/config/configurable.rb#21
+# pkg:gem/mixlib-config#lib/mixlib/config/configurable.rb:21
 class Mixlib::Config::Configurable
-  # @return [Configurable] a new instance of Configurable
-  #
-  # source://mixlib-config//lib/mixlib/config/configurable.rb#26
+  # pkg:gem/mixlib-config#lib/mixlib/config/configurable.rb:26
   def initialize(symbol); end
 
-  # source://mixlib-config//lib/mixlib/config/configurable.rb#69
+  # pkg:gem/mixlib-config#lib/mixlib/config/configurable.rb:69
   def default; end
 
-  # Returns the value of attribute default_block.
-  #
-  # source://mixlib-config//lib/mixlib/config/configurable.rb#24
+  # pkg:gem/mixlib-config#lib/mixlib/config/configurable.rb:24
   def default_block; end
 
-  # @return [Boolean]
-  #
-  # source://mixlib-config//lib/mixlib/config/configurable.rb#38
+  # pkg:gem/mixlib-config#lib/mixlib/config/configurable.rb:38
   def default_block?; end
 
-  # Returns the value of attribute default_value.
-  #
-  # source://mixlib-config//lib/mixlib/config/configurable.rb#23
+  # pkg:gem/mixlib-config#lib/mixlib/config/configurable.rb:23
   def default_value; end
 
-  # source://mixlib-config//lib/mixlib/config/configurable.rb#44
+  # pkg:gem/mixlib-config#lib/mixlib/config/configurable.rb:44
   def defaults_to(default_value = T.unsafe(nil), &block); end
 
-  # source://mixlib-config//lib/mixlib/config/configurable.rb#55
+  # pkg:gem/mixlib-config#lib/mixlib/config/configurable.rb:55
   def get(config); end
 
-  # @return [Boolean]
-  #
-  # source://mixlib-config//lib/mixlib/config/configurable.rb#30
+  # pkg:gem/mixlib-config#lib/mixlib/config/configurable.rb:42
   def has_default; end
 
-  # @return [Boolean]
-  #
-  # source://mixlib-config//lib/mixlib/config/configurable.rb#30
+  # pkg:gem/mixlib-config#lib/mixlib/config/configurable.rb:30
   def has_default?; end
 
-  # @return [Boolean]
-  #
-  # source://mixlib-config//lib/mixlib/config/configurable.rb#77
+  # pkg:gem/mixlib-config#lib/mixlib/config/configurable.rb:77
   def is_default?(config); end
 
-  # source://mixlib-config//lib/mixlib/config/configurable.rb#65
+  # pkg:gem/mixlib-config#lib/mixlib/config/configurable.rb:65
   def set(config, value); end
 
-  # Returns the value of attribute symbol.
-  #
-  # source://mixlib-config//lib/mixlib/config/configurable.rb#22
+  # pkg:gem/mixlib-config#lib/mixlib/config/configurable.rb:22
   def symbol; end
 
-  # source://mixlib-config//lib/mixlib/config/configurable.rb#50
+  # pkg:gem/mixlib-config#lib/mixlib/config/configurable.rb:50
   def writes_value(&block); end
 
-  # @return [Boolean]
-  #
-  # source://mixlib-config//lib/mixlib/config/configurable.rb#34
+  # pkg:gem/mixlib-config#lib/mixlib/config/configurable.rb:34
   def writes_value?; end
 
   private
 
-  # source://mixlib-config//lib/mixlib/config/configurable.rb#83
+  # pkg:gem/mixlib-config#lib/mixlib/config/configurable.rb:83
   def safe_dup(e); end
 end
 
-# source://mixlib-config//lib/mixlib/config.rb#486
+# pkg:gem/mixlib-config#lib/mixlib/config.rb:486
 Mixlib::Config::NOT_PASSED = T.let(T.unsafe(nil), Object)
 
-# source://mixlib-config//lib/mixlib/config/reopened_config_context_with_configurable_error.rb#21
+# pkg:gem/mixlib-config#lib/mixlib/config/reopened_config_context_with_configurable_error.rb:21
 class Mixlib::Config::ReopenedConfigContextWithConfigurableError < ::StandardError; end
 
-# source://mixlib-config//lib/mixlib/config/reopened_configurable_with_config_context_error.rb#21
+# pkg:gem/mixlib-config#lib/mixlib/config/reopened_configurable_with_config_context_error.rb:21
 class Mixlib::Config::ReopenedConfigurableWithConfigContextError < ::StandardError; end
 
-# source://mixlib-config//lib/mixlib/config/unknown_config_option_error.rb#21
+# pkg:gem/mixlib-config#lib/mixlib/config/unknown_config_option_error.rb:21
 class Mixlib::Config::UnknownConfigOptionError < ::StandardError; end
 
-# source://mixlib-config//lib/mixlib/config/version.rb#22
+# pkg:gem/mixlib-config#lib/mixlib/config/version.rb:22
 Mixlib::Config::VERSION = T.let(T.unsafe(nil), String)