chef 14.2.0-universal-mingw32 → 14.3.37-universal-mingw32

data/lib/chef/cookbook_loader.rb

@@ -93,7 +93,7 @@ class Chef
     def load_cookbook(cookbook_name)
       preload_cookbooks
 
-      return @cookbooks_by_name[cookbook_name] if @cookbooks_by_name.has_key?(cookbook_name)
+      return @cookbooks_by_name[cookbook_name] if @cookbooks_by_name.key?(cookbook_name)
 
       return nil unless @loaders_by_name.key?(cookbook_name.to_s)
 
@@ -112,7 +112,7 @@ class Chef
         end
       end
 
-      if @loaded_cookbooks.has_key?(cookbook_name)
+      if @loaded_cookbooks.key?(cookbook_name)
         cookbook_version = @loaded_cookbooks[cookbook_name].cookbook_version
         @cookbooks_by_name[cookbook_name] = cookbook_version
         @metadata[cookbook_name] = cookbook_version.metadata
@@ -121,7 +121,7 @@ class Chef
     end
 
     def [](cookbook)
-      if @cookbooks_by_name.has_key?(cookbook.to_sym) || load_cookbook(cookbook.to_sym)
+      if @cookbooks_by_name.key?(cookbook.to_sym) || load_cookbook(cookbook.to_sym)
         @cookbooks_by_name[cookbook.to_sym]
       else
         raise Exceptions::CookbookNotFoundInRepo, "Cannot find a cookbook named #{cookbook}; did you forget to add metadata to a cookbook? (https://docs.chef.io/config_rb_metadata.html)"

data/lib/chef/cookbook_manifest.rb

@@ -236,13 +236,13 @@ class Chef
         csum = checksum_cookbook_file(file)
         @checksums[csum] = file
         rs = Mash.new({
-          :name => name,
-          :path => path,
-          :checksum => csum,
-          :specificity => specificity,
+          name: name,
+          path: path,
+          checksum: csum,
+          specificity: specificity,
           # full_path is not a part of the normal manifest, but is very useful to keep around.
           # uploaders should strip this out.
-          :full_path => file,
+          full_path: file,
         })
 
         manifest[:all_files] << rs

data/lib/chef/cookbook_site_streaming_uploader.rb

@@ -31,7 +31,7 @@ class Chef
   # inspired by http://stanislavvitvitskiy.blogspot.com/2008/12/multipart-post-in-ruby.html
   class CookbookSiteStreamingUploader
 
-    DefaultHeaders = { "accept" => "application/json", "x-chef-version" => ::Chef::VERSION } # rubocop:disable Naming/ConstantName
+    DefaultHeaders = { "accept" => "application/json", "x-chef-version" => ::Chef::VERSION }.freeze # rubocop:disable Naming/ConstantName
 
     class << self
 
@@ -115,10 +115,10 @@ class Chef
         content_file.rewind if content_file # we consumed the file for the above operation, so rewind it.
 
         signing_options = {
-          :http_method => http_verb,
-          :path => url.path,
-          :user_id => user_id,
-          :timestamp => timestamp }
+          http_method: http_verb,
+          path: url.path,
+          user_id: user_id,
+          timestamp: timestamp }
         (content_file && signing_options[:file] = content_file) || (signing_options[:body] = (content_body || ""))
 
         headers.merge!(Mixlib::Authentication::SignedHeaderAuth.signing_object(signing_options).sign(secret_key))

data/lib/chef/cookbook_uploader.rb

@@ -56,7 +56,7 @@ class Chef
       end
 
       checksums = checksum_files.inject({}) { |memo, elt| memo[elt.first] = nil; memo }
-      new_sandbox = rest.post("sandboxes", { :checksums => checksums })
+      new_sandbox = rest.post("sandboxes", { checksums: checksums })
 
       Chef::Log.info("Uploading files")
 
@@ -83,7 +83,7 @@ class Chef
       # in eventual consistency)
       retries = 0
       begin
-        rest.put(sandbox_url, { :is_completed => true })
+        rest.put(sandbox_url, { is_completed: true })
       rescue Net::HTTPServerException => e
         if e.message =~ /^400/ && (retries += 1) <= 5
           sleep 2

data/lib/chef/cookbook_version.rb

@@ -42,7 +42,7 @@ class Chef
     def_delegator :@cookbook_manifest, :files_for
     def_delegator :@cookbook_manifest, :each_file
 
-    COOKBOOK_SEGMENTS = [ :resources, :providers, :recipes, :definitions, :libraries, :attributes, :files, :templates, :root_files ]
+    COOKBOOK_SEGMENTS = [ :resources, :providers, :recipes, :definitions, :libraries, :attributes, :files, :templates, :root_files ].freeze
 
     attr_reader :all_files
 
@@ -184,7 +184,7 @@ class Chef
 
     # called from DSL
     def load_recipe(recipe_name, run_context)
-      unless recipe_filenames_by_name.has_key?(recipe_name)
+      unless recipe_filenames_by_name.key?(recipe_name)
         raise Chef::Exceptions::RecipeNotFound, "could not find recipe #{recipe_name} for cookbook #{name}"
       end
 

data/lib/chef/data_bag.rb

@@ -54,7 +54,7 @@ class Chef
       set_or_return(
         :name,
         arg,
-        :regex => VALID_NAME
+        regex: VALID_NAME
       )
     end
 
@@ -126,7 +126,7 @@ class Chef
             item = Chef::JSONCompat.parse(IO.read(f))
 
             # Check if we have multiple items with similar names (ids) and raise if their content differs
-            if data_bag.has_key?(item["id"]) && data_bag[item["id"]] != item
+            if data_bag.key?(item["id"]) && data_bag[item["id"]] != item
               raise Chef::Exceptions::DuplicateDataBagItem, "Data bag '#{name}' has items with the same name '#{item["id"]}' but different content."
             else
               data_bag[item["id"]] = item
@@ -157,7 +157,7 @@ class Chef
       self
     end
 
-    #create a data bag via RESTful API
+    # create a data bag via RESTful API
     def create
       chef_server_rest.post("data", self)
       self

data/lib/chef/data_bag_item.rb

@@ -81,7 +81,7 @@ class Chef
       set_or_return(
         :data_bag,
         arg,
-        :regex => /^[\-[:alnum:]_]+$/
+        regex: /^[\-[:alnum:]_]+$/
       )
     end
 
@@ -90,7 +90,7 @@ class Chef
     end
 
     def object_name
-      raise Exceptions::ValidationFailed, "You must have an 'id' or :id key in the raw data" unless raw_data.has_key?("id")
+      raise Exceptions::ValidationFailed, "You must have an 'id' or :id key in the raw data" unless raw_data.key?("id")
       raise Exceptions::ValidationFailed, "You must have declared what bag this item belongs to!" unless data_bag
 
       id = raw_data["id"]

data/lib/chef/deprecated.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright:: Copyright 2016-2017, Chef Software Inc.
+# Copyright:: Copyright 2016-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -24,276 +24,210 @@ class Chef
     class << self
       include Chef::Mixin::ConvertToClassName
 
-      def create(type, message = nil, location = nil)
-        Chef::Deprecated.const_get(convert_to_class_name(type.to_s)).send(:new, message, location)
+      def create(type, message, location)
+        Chef::Deprecated.const_get(convert_to_class_name(type.to_s)).new(message, location)
       end
     end
 
     class Base
-      BASE_URL = "https://docs.chef.io/deprecations_"
+      BASE_URL = "https://docs.chef.io/deprecations_".freeze
 
-      attr_accessor :message, :location
+      attr_reader :message, :location
 
       def initialize(msg = nil, location = nil)
-        @message = msg if msg
-        @location = location if location
+        @message = msg
+        @location = location
       end
 
       def link
         "Please see #{url} for further details and information on how to correct this problem."
       end
 
+      # Render the URL for the deprecation documentation page.
+      #
+      # @return [String]
       def url
-        "#{BASE_URL}#{target}"
-      end
-
-      # We know that the only time this gets called is by Chef::Log.deprecation,
-      # so special case
-      def <<(location)
-        @location = location
-      end
-
-      def inspect
-        "#{message} (CHEF-#{id})#{location}.\n#{link}"
-      end
-
-      def id
-        raise NotImplementedError, "subclasses of Chef::Deprecated::Base should define #id with a unique number"
-      end
-
-      def target
-        raise NotImplementedError, "subclasses of Chef::Deprecated::Base should define #target"
+        "#{BASE_URL}#{self.class.doc_page}"
+      end
+
+      # Render the user-visible message for this deprecation.
+      #
+      # @return [String]
+      def to_s
+        "Deprecation CHEF-#{self.class.deprecation_id} from #{location}\n\n  #{message}\n\n#{link}"
+      end
+
+      # Check if this deprecation has been silenced.
+      #
+      # @return [Boolean]
+      def silenced?
+        # Check if all warnings have been silenced.
+        return true if Chef::Config[:silence_deprecation_warnings] == true
+        # Check if this warning has been silenced by the config.
+        return true if Chef::Config[:silence_deprecation_warnings].any? do |silence_spec|
+          # Just in case someone uses a symbol in the config by mistake.
+          silence_spec = silence_spec.to_s
+           # Check for a silence by deprecation name, or by location.
+          self.class.deprecation_key == silence_spec || self.class.deprecation_id.to_s == silence_spec || "chef-#{self.class.deprecation_id}" == silence_spec.downcase || location.include?(silence_spec)
+        end
+        # check if this warning has been silenced by inline comment.
+        return true if location =~ /^(.*?):(\d+):in/ && begin
+          # Don't buffer the whole file in memory, so read it one line at a time.
+          line_no = $2.to_i
+          location_file = ::File.open($1)
+          (line_no - 1).times { location_file.readline } # Read all the lines we don't care about.
+          relevant_line = location_file.readline
+          relevant_line.match?(/#.*chef:silence_deprecation($|[^:]|:#{self.class.deprecation_key})/)
+        end
+        false
+      end
+
+      class << self
+        attr_reader :deprecation_id, :doc_page
+
+        # Return the deprecation key as would be used with {Chef::Deprecated.create}.
+        #
+        # @return [String]
+        def deprecation_key
+          Chef::Mixin::ConvertToClassName.convert_to_snake_case(name, "Chef::Deprecated")
+        end
+
+        # Set the ID and documentation page path for this deprecation.
+        #
+        # Used in subclasses to set the data for each type of deprecation.
+        #
+        # @example
+        #   class MyDeprecation < Base
+        #     target 123, "my_deprecation.html"
+        #   end
+        # @param id [Integer] Deprecation ID number. This must be unique among
+        #   all deprecations.
+        # @param page [String, nil] Optional documentation page path. If not
+        #   specified, the deprecation key is used.
+        # @return [void]
+        def target(id, page = nil)
+          @deprecation_id = id
+          @doc_page = page || "#{deprecation_key}.html"
+        end
       end
     end
 
     class InternalApi < Base
-      def id
-        0
-      end
-
-      def target
-        "internal_api.html"
-      end
+      target 0
     end
 
     class JsonAutoInflate < Base
-      def id
-        1
-      end
-
-      def target
-        "json_auto_inflate.html"
-      end
+      target 1
     end
 
     class ExitCode < Base
-      def id
-        2
-      end
-
-      def target
-        "exit_code.html"
-      end
+      target 2
     end
 
     # id 3 has been deleted
 
     class Attributes < Base
-      def id
-        4
-      end
-
-      def target
-        "attributes.html"
-      end
+      target 4
     end
 
     class CustomResource < Base
-      def id
-        5
-      end
-
-      def target
-        "custom_resource_cleanups.html"
-      end
+      target 5, "custom_resource_cleanups.html"
     end
 
     class EasyInstall < Base
-      def id
-        6
-      end
-
-      def target
-        "easy_install.html"
-      end
+      target 6
     end
 
     class VerifyFile < Base
-      def id
-        7
-      end
-
-      def target
-        "verify_file.html"
-      end
+      target 7
     end
 
     class SupportsProperty < Base
-      def id
-        8
-      end
-
-      def target
-        "supports_property.html"
-      end
+      target 8
     end
 
     class ChefRest < Base
-      def id
-        9
-      end
-
-      def target
-        "chef_rest.html"
-      end
+      target 9
     end
 
     class DnfPackageAllowDowngrade < Base
-      def id
-        10
-      end
-
-      def target
-        "dnf_package_allow_downgrade.html"
-      end
+      target 10
     end
 
     class PropertyNameCollision < Base
-      def id
-        11
-      end
-
-      def target
-        "property_name_collision.html"
-      end
+      target 11
     end
 
     class LaunchdHashProperty < Base
-      def id
-        12
-      end
-
-      def target
-        "launchd_hash_property.html"
-      end
+      target 12
     end
 
     class ChefPlatformMethods < Base
-      def id
-        13
-      end
-
-      def target
-        "chef_platform_methods.html"
-      end
+      target 13
     end
 
     class RunCommand < Base
-      def id
-        14
-      end
-
-      def target
-        "run_command.html"
-      end
+      target 14
     end
 
     class PackageMisc < Base
-      def id
-        15
-      end
-
-      def target
-        "package_misc.html"
-      end
+      target 15
     end
 
     class MultiresourceMatch < Base
-      def id
-        16
-      end
-
-      def target
-        "multiresource_match.html"
-      end
+      target 16
     end
 
     class UseInlineResources < Base
-      def id
-        17
-      end
-
-      def target
-        "use_inline_resources.html"
-      end
+      target 17
     end
 
     class LocalListen < Base
-      def id
-        18
-      end
-
-      def target
-        "local_listen.html"
-      end
+      target 18
     end
 
     class NamespaceCollisions < Base
-      def id
-        19
-      end
-
-      def target
-        "namespace_collisions.html"
-      end
+      target 19
     end
 
     class DeployResource < Base
-      def id
-        21
-      end
-
-      def target
-        "deploy_resource.html"
-      end
+      target 21
     end
 
     class ErlResource < Base
-      def id
-        22
-      end
+      target 22
+    end
 
-      def target
-        "erl_resource.html"
-      end
+    class FreebsdPkgProvider < Base
+      target 23
+    end
+
+    class MapCollision < Base
+      target 25
     end
 
     # id 3694 was deleted
 
     # Returned when using the deprecated option on a property
     class Property < Base
-      def inspect
-        "#{message}\n#{location}"
+      target 24
+
+      def to_s
+        "Deprecated resource property used from #{location}\n\n  #{message}\n\nPlease consult the resource documentation for more information."
       end
     end
 
+    class ShellOut < Base
+      target 26
+    end
+
     class Generic < Base
       def url
         "https://docs.chef.io/chef_deprecations_client.html"
       end
 
-      def inspect
-        "#{message}\nThis is a generic error message and should be updated to have a proper deprecation class. #{location}\nPlease see #{url} for an overview of Chef deprecations."
+      def to_s
+        "Deprecation from #{location}\n\n  #{message}\n\n#{link}"
       end
     end