summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-09-27 11:52:01 -0700
committerGitHub <noreply@github.com>2018-09-27 11:52:01 -0700
commit63b7d9e4fb250afb697d7d151cdcc102d9b258ac (patch)
tree59cc2f03bbd5d1e38d66d5dd8e5f310e764add7a
parentd90a4d1cfcba17b03136b6e31b620c6eafa29e3b (diff)
parent8400f4cb7d977896531ae277fdcf3398dc2d4c6c (diff)
downloadchef-63b7d9e4fb250afb697d7d151cdcc102d9b258ac.tar.gz
Merge pull request #7697 from chef/lcg/to-h-cleanup
replace some instances of to_hash with to_h
-rw-r--r--lib/chef/api_client.rb8
-rw-r--r--lib/chef/api_client_v1.rb10
-rw-r--r--lib/chef/audit/audit_reporter.rb2
-rw-r--r--lib/chef/audit/control_group_data.rb18
-rw-r--r--lib/chef/chef_fs/chef_fs_data_store.rb4
-rw-r--r--lib/chef/chef_fs/data_handler/data_handler_base.rb2
-rw-r--r--lib/chef/cookbook/manifest_v0.rb63
-rw-r--r--lib/chef/cookbook/manifest_v2.rb26
-rw-r--r--lib/chef/cookbook/metadata.rb6
-rw-r--r--lib/chef/cookbook_manifest.rb13
-rw-r--r--lib/chef/cookbook_version.rb2
-rw-r--r--lib/chef/data_bag.rb6
-rw-r--r--lib/chef/data_bag_item.rb8
-rw-r--r--lib/chef/data_collector.rb4
-rw-r--r--lib/chef/data_collector/resource_report.rb8
-rw-r--r--lib/chef/encrypted_data_bag_item.rb6
-rw-r--r--lib/chef/environment.rb6
-rw-r--r--lib/chef/handler.rb4
-rw-r--r--lib/chef/json_compat.rb2
-rw-r--r--lib/chef/key.rb12
-rw-r--r--lib/chef/knife/client_edit.rb4
-rw-r--r--lib/chef/knife/data_bag_show.rb4
-rw-r--r--lib/chef/knife/osc_user_edit.rb4
-rw-r--r--lib/chef/knife/user_edit.rb4
-rw-r--r--lib/chef/org.rb10
-rw-r--r--lib/chef/policy_builder/policyfile.rb8
-rw-r--r--lib/chef/resource.rb4
-rw-r--r--lib/chef/resource_collection/resource_collection_serialization.rb6
-rw-r--r--lib/chef/role.rb6
-rw-r--r--lib/chef/run_list/run_list_expansion.rb8
-rw-r--r--lib/chef/run_status.rb6
-rw-r--r--lib/chef/user.rb12
-rw-r--r--lib/chef/user_v1.rb14
-rw-r--r--spec/unit/audit/audit_reporter_spec.rb8
-rw-r--r--spec/unit/audit/control_group_data_spec.rb34
-rw-r--r--spec/unit/resource_collection_spec.rb2
36 files changed, 198 insertions, 146 deletions
diff --git a/lib/chef/api_client.rb b/lib/chef/api_client.rb
index 3120b58cc0..550aa6bd3f 100644
--- a/lib/chef/api_client.rb
+++ b/lib/chef/api_client.rb
@@ -1,7 +1,7 @@
#
# Author:: Adam Jacob (<adam@chef.io>)
# Author:: Nuo Yan (<nuo@chef.io>)
-# Copyright:: Copyright 2008-2016, Chef Software Inc.
+# Copyright:: Copyright 2008-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -110,7 +110,7 @@ class Chef
# Private key is included if available.
#
# @return [Hash]
- def to_hash
+ def to_h
result = {
"name" => @name,
"public_key" => @public_key,
@@ -123,11 +123,13 @@ class Chef
result
end
+ alias_method :to_hash, :to_h
+
# The JSON representation of the object.
#
# @return [String] the JSON string.
def to_json(*a)
- Chef::JSONCompat.to_json(to_hash, *a)
+ Chef::JSONCompat.to_json(to_h, *a)
end
def self.from_hash(o)
diff --git a/lib/chef/api_client_v1.rb b/lib/chef/api_client_v1.rb
index fcd4d91c13..8ce06ea780 100644
--- a/lib/chef/api_client_v1.rb
+++ b/lib/chef/api_client_v1.rb
@@ -1,7 +1,7 @@
#
# Author:: Adam Jacob (<adam@chef.io>)
# Author:: Nuo Yan (<nuo@chef.io>)
-# Copyright:: Copyright 2008-2016, Chef Software, Inc.
+# Copyright:: Copyright 2008-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -146,7 +146,7 @@ class Chef
# Private key is included if available.
#
# @return [Hash]
- def to_hash
+ def to_h
result = {
"name" => @name,
"validator" => @validator,
@@ -159,11 +159,13 @@ class Chef
result
end
+ alias_method :to_hash, :to_h
+
# The JSON representation of the object.
#
# @return [String] the JSON string.
def to_json(*a)
- Chef::JSONCompat.to_json(to_hash, *a)
+ Chef::JSONCompat.to_json(to_h, *a)
end
def self.from_hash(o)
@@ -312,7 +314,7 @@ class Chef
new_client = chef_rest_v0.post("clients", payload)
end
- Chef::ApiClientV1.from_hash(to_hash.merge(new_client))
+ Chef::ApiClientV1.from_hash(to_h.merge(new_client))
end
# As a string
diff --git a/lib/chef/audit/audit_reporter.rb b/lib/chef/audit/audit_reporter.rb
index 7e3abf2608..40f1f9ffd7 100644
--- a/lib/chef/audit/audit_reporter.rb
+++ b/lib/chef/audit/audit_reporter.rb
@@ -118,7 +118,7 @@ class Chef
audit_history_url = "controls"
Chef::Log.trace("Sending audit report (run-id: #{audit_data.run_id})")
- run_data = audit_data.to_hash
+ run_data = audit_data.to_h
if @audit_phase_error
error_info = "#{@audit_phase_error.class}: #{@audit_phase_error.message}"
diff --git a/lib/chef/audit/control_group_data.rb b/lib/chef/audit/control_group_data.rb
index 8825860023..63f301da02 100644
--- a/lib/chef/audit/control_group_data.rb
+++ b/lib/chef/audit/control_group_data.rb
@@ -1,7 +1,7 @@
#
# Author:: Tyler Ball (<tball@chef.io>)
#
-# Copyright:: Copyright 2014-2016, Chef Software, Inc.
+# Copyright:: Copyright 2014-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -35,15 +35,17 @@ class Chef
control_groups << control_group
end
- def to_hash
+ def to_h
{
node_name: node_name,
run_id: run_id,
start_time: start_time,
end_time: end_time,
- control_groups: control_groups.collect { |c| c.to_hash },
+ control_groups: control_groups.collect { |c| c.to_h },
}
end
+
+ alias_method :to_hash, :to_h
end
class ControlGroupData
@@ -76,7 +78,7 @@ class Chef
control
end
- def to_hash
+ def to_h
# We sort it so the examples appear in the output in the same order
# they appeared in the recipe
controls.sort! { |x, y| x.line_number <=> y.line_number }
@@ -85,12 +87,14 @@ class Chef
status: status,
number_succeeded: number_succeeded,
number_failed: number_failed,
- controls: controls.collect { |c| c.to_hash },
+ controls: controls.collect { |c| c.to_h },
}
# If there is a duplicate key, metadata will overwrite it
add_display_only_data(h).merge(metadata)
end
+ alias_method :to_hash, :to_h
+
private
def create_control(control_data)
@@ -122,7 +126,7 @@ class Chef
end
end
- def to_hash
+ def to_h
h = {
name: name,
status: status,
@@ -133,6 +137,8 @@ class Chef
h[:context] = context || []
h
end
+
+ alias_method :to_hash, :to_h
end
end
diff --git a/lib/chef/chef_fs/chef_fs_data_store.rb b/lib/chef/chef_fs/chef_fs_data_store.rb
index 7fa69bf497..3f8a047c6d 100644
--- a/lib/chef/chef_fs/chef_fs_data_store.rb
+++ b/lib/chef/chef_fs/chef_fs_data_store.rb
@@ -311,7 +311,7 @@ class Chef
cookbook_type = path[0]
result = nil
begin
- result = Chef::CookbookManifest.new(entry.chef_object, policy_mode: cookbook_type == "cookbook_artifacts").to_hash
+ result = Chef::CookbookManifest.new(entry.chef_object, policy_mode: cookbook_type == "cookbook_artifacts").to_h
rescue Chef::ChefFS::FileSystem::NotFoundError => e
raise ChefZero::DataStore::DataNotFoundError.new(to_zero_path(e.entry), e)
end
@@ -334,7 +334,7 @@ class Chef
end
if cookbook_type == "cookbook_artifacts"
- result["metadata"] = result["metadata"].to_hash
+ result["metadata"] = result["metadata"].to_h
result["metadata"].delete_if do |key, value|
value == [] ||
(value == {} && !%w{dependencies attributes recipes}.include?(key)) ||
diff --git a/lib/chef/chef_fs/data_handler/data_handler_base.rb b/lib/chef/chef_fs/data_handler/data_handler_base.rb
index c3cbb96ecc..febf0daf4b 100644
--- a/lib/chef/chef_fs/data_handler/data_handler_base.rb
+++ b/lib/chef/chef_fs/data_handler/data_handler_base.rb
@@ -114,7 +114,7 @@ class Chef
def from_ruby(path)
r = chef_class.new
r.from_file(path)
- r.to_hash
+ r.to_h
end
#
diff --git a/lib/chef/cookbook/manifest_v0.rb b/lib/chef/cookbook/manifest_v0.rb
index 5a6d7401fa..198c7a4741 100644
--- a/lib/chef/cookbook/manifest_v0.rb
+++ b/lib/chef/cookbook/manifest_v0.rb
@@ -1,5 +1,5 @@
# Author:: Daniel DeLeo (<dan@chef.io>)
-# Copyright:: Copyright 2015-2016, Chef Software Inc.
+# Copyright:: Copyright 2015-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -26,42 +26,47 @@ class Chef
COOKBOOK_SEGMENTS = %w{ resources providers recipes definitions libraries attributes files templates root_files }.freeze
- def self.from_hash(hash)
- response = Mash.new(hash)
- response[:all_files] = COOKBOOK_SEGMENTS.inject([]) do |memo, segment|
- next memo if hash[segment].nil? || hash[segment].empty?
- hash[segment].each do |file|
- file["name"] = "#{segment}/#{file["name"]}"
- memo << file
+ class << self
+
+ def from_hash(hash)
+ response = Mash.new(hash)
+ response[:all_files] = COOKBOOK_SEGMENTS.inject([]) do |memo, segment|
+ next memo if hash[segment].nil? || hash[segment].empty?
+ hash[segment].each do |file|
+ file["name"] = "#{segment}/#{file["name"]}"
+ memo << file
+ end
+ response.delete(segment)
+ memo
end
- response.delete(segment)
- memo
+ response
end
- response
- end
- def self.to_hash(manifest)
- result = manifest.manifest.dup
- result.delete("all_files")
+ def to_h(manifest)
+ result = manifest.manifest.dup
+ result.delete("all_files")
- files = manifest.by_parent_directory
- files.keys.each_with_object(result) do |parent, memo|
- if COOKBOOK_SEGMENTS.include?(parent)
- memo[parent] ||= []
- files[parent].each do |file|
- file["name"] = file["name"].split("/")[1]
- file.delete("full_path")
- memo[parent] << file
+ files = manifest.by_parent_directory
+ files.keys.each_with_object(result) do |parent, memo|
+ if COOKBOOK_SEGMENTS.include?(parent)
+ memo[parent] ||= []
+ files[parent].each do |file|
+ file["name"] = file["name"].split("/")[1]
+ file.delete("full_path")
+ memo[parent] << file
+ end
end
end
- end
- # Ensure all segments are set to [] if they don't exist.
- # See https://github.com/chef/chef/issues/6044
- COOKBOOK_SEGMENTS.each do |segment|
- result[segment] ||= []
+ # Ensure all segments are set to [] if they don't exist.
+ # See https://github.com/chef/chef/issues/6044
+ COOKBOOK_SEGMENTS.each do |segment|
+ result[segment] ||= []
+ end
+
+ result.merge({ "frozen?" => manifest.frozen_version?, "chef_type" => "cookbook_version" })
end
- result.merge({ "frozen?" => manifest.frozen_version?, "chef_type" => "cookbook_version" })
+ alias_method :to_hash, :to_h
end
end
end
diff --git a/lib/chef/cookbook/manifest_v2.rb b/lib/chef/cookbook/manifest_v2.rb
index 2a5f1fb5e6..37cad4b3b7 100644
--- a/lib/chef/cookbook/manifest_v2.rb
+++ b/lib/chef/cookbook/manifest_v2.rb
@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2015-2016, Chef Software Inc.
+# Copyright:: Copyright 2015-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -23,17 +23,21 @@ class Chef
minimum_api_version 2
- def self.from_hash(hash)
- Chef::Log.trace "processing manifest: #{hash}"
- Mash.new hash
- end
+ class << self
+ def from_hash(hash)
+ Chef::Log.trace "processing manifest: #{hash}"
+ Mash.new hash
+ end
+
+ def to_h(manifest)
+ result = manifest.manifest.dup
+ result["all_files"].map! { |file| file.delete("full_path"); file }
+ result["frozen?"] = manifest.frozen_version?
+ result["chef_type"] = "cookbook_version"
+ result.to_hash
+ end
- def self.to_hash(manifest)
- result = manifest.manifest.dup
- result["all_files"].map! { |file| file.delete("full_path"); file }
- result["frozen?"] = manifest.frozen_version?
- result["chef_type"] = "cookbook_version"
- result.to_hash
+ alias_method :to_hash, :to_h
end
end
diff --git a/lib/chef/cookbook/metadata.rb b/lib/chef/cookbook/metadata.rb
index 8716e502af..b4d6ab6936 100644
--- a/lib/chef/cookbook/metadata.rb
+++ b/lib/chef/cookbook/metadata.rb
@@ -465,7 +465,7 @@ class Chef
end
end
- def to_hash
+ def to_h
{
NAME => name,
DESCRIPTION => description,
@@ -488,8 +488,10 @@ class Chef
}
end
+ alias_method :to_hash, :to_h
+
def to_json(*a)
- Chef::JSONCompat.to_json(to_hash, *a)
+ Chef::JSONCompat.to_json(to_h, *a)
end
def self.from_hash(o)
diff --git a/lib/chef/cookbook_manifest.rb b/lib/chef/cookbook_manifest.rb
index c0c5b57a60..3f38f9cf29 100644
--- a/lib/chef/cookbook_manifest.rb
+++ b/lib/chef/cookbook_manifest.rb
@@ -1,5 +1,5 @@
# Author:: Daniel DeLeo (<dan@chef.io>)
-# Copyright:: Copyright 2015-2016, Chef Software Inc.
+# Copyright:: Copyright 2015-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -40,7 +40,7 @@ class Chef
def_delegator :@cookbook_version, :frozen_version?
# Create a new CookbookManifest object for the given `cookbook_version`.
- # You can subsequently call #to_hash to get a Hash representation of the
+ # You can subsequently call #to_h to get a Hash representation of the
# cookbook_version in the "manifest" format, or #to_json to get a JSON
# representation of the cookbook_version.
#
@@ -119,12 +119,14 @@ class Chef
@policy_mode
end
- def to_hash
- CookbookManifestVersions.to_hash(self)
+ def to_h
+ CookbookManifestVersions.to_h(self)
end
+ alias_method :to_hash, :to_h
+
def to_json(*a)
- result = to_hash
+ result = to_h
result["json_class"] = "Chef::CookbookVersion"
Chef::JSONCompat.to_json(result, *a)
end
@@ -321,5 +323,6 @@ class Chef
def_versioned_delegator :from_hash
def_versioned_delegator :to_hash
+ def_versioned_delegator :to_h
end
end
diff --git a/lib/chef/cookbook_version.rb b/lib/chef/cookbook_version.rb
index 07ee501ff7..2ed84e0d9d 100644
--- a/lib/chef/cookbook_version.rb
+++ b/lib/chef/cookbook_version.rb
@@ -407,7 +407,7 @@ class Chef
output["cookbook_name"] = name
output["name"] = full_name
output["frozen?"] = frozen_version?
- output["metadata"] = metadata.to_hash
+ output["metadata"] = metadata.to_h
output["version"] = version
output.merge(cookbook_manifest.by_parent_directory)
end
diff --git a/lib/chef/data_bag.rb b/lib/chef/data_bag.rb
index b7b5391c59..edef971830 100644
--- a/lib/chef/data_bag.rb
+++ b/lib/chef/data_bag.rb
@@ -58,7 +58,7 @@ class Chef
)
end
- def to_hash
+ def to_h
result = {
"name" => @name,
"json_class" => self.class.name,
@@ -67,9 +67,11 @@ class Chef
result
end
+ alias_method :to_hash, :to_h
+
# Serialize this object as a hash
def to_json(*a)
- Chef::JSONCompat.to_json(to_hash, *a)
+ Chef::JSONCompat.to_json(to_h, *a)
end
def chef_server_rest
diff --git a/lib/chef/data_bag_item.rb b/lib/chef/data_bag_item.rb
index 0d07daa39e..63b4060baa 100644
--- a/lib/chef/data_bag_item.rb
+++ b/lib/chef/data_bag_item.rb
@@ -101,13 +101,15 @@ class Chef
"data_bag_item_#{data_bag_name}_#{id}"
end
- def to_hash
+ def to_h
result = raw_data.dup
result["chef_type"] = "data_bag_item"
result["data_bag"] = data_bag.to_s
result
end
+ alias_method :to_hash, :to_h
+
# Serialize this object as a hash
def to_json(*a)
result = {
@@ -180,9 +182,9 @@ class Chef
end
def ==(other)
- other.respond_to?(:to_hash) &&
+ other.respond_to?(:to_h) &&
other.respond_to?(:data_bag) &&
- (other.to_hash == to_hash) &&
+ (other.to_h == to_h) &&
(other.data_bag.to_s == data_bag.to_s)
end
diff --git a/lib/chef/data_collector.rb b/lib/chef/data_collector.rb
index 5cc92a34e4..a0b4eeb4cb 100644
--- a/lib/chef/data_collector.rb
+++ b/lib/chef/data_collector.rb
@@ -2,7 +2,7 @@
# Author:: Adam Leff (<adamleff@chef.io>)
# Author:: Ryan Cragun (<ryan@chef.io>)
#
-# Copyright:: Copyright 2012-2017, Chef Software Inc.
+# Copyright:: Copyright 2012-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -428,7 +428,7 @@ class Chef
@all_resource_reports << OpenStruct.new(
resource: resource_report.new_resource,
action: resource_report.action,
- report_data: resource_report.to_hash
+ report_data: resource_report.to_h
)
end
diff --git a/lib/chef/data_collector/resource_report.rb b/lib/chef/data_collector/resource_report.rb
index 01651d5460..6d63595cc2 100644
--- a/lib/chef/data_collector/resource_report.rb
+++ b/lib/chef/data_collector/resource_report.rb
@@ -2,7 +2,7 @@
# Author:: Adam Leff (<adamleff@chef.io>)
# Author:: Ryan Cragun (<ryan@chef.io>)
#
-# Copyright:: Copyright 2012-2016, Chef Software Inc.
+# Copyright:: Copyright 2012-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -65,7 +65,7 @@ class Chef
%w{updated failed}.include?(status)
end
- def to_hash
+ def to_h
hash = {
"type" => new_resource.resource_name.to_sym,
"name" => new_resource.name.to_s,
@@ -90,8 +90,8 @@ class Chef
hash
end
- alias :to_h :to_hash
- alias :for_json :to_hash
+ alias_method :to_hash, :to_h
+ alias_method :for_json, :to_h
# We should be able to call the identity of a resource safely, but there
# is an edge case where resources that have a lazy property that is both
diff --git a/lib/chef/encrypted_data_bag_item.rb b/lib/chef/encrypted_data_bag_item.rb
index 56135872ac..71b506aba4 100644
--- a/lib/chef/encrypted_data_bag_item.rb
+++ b/lib/chef/encrypted_data_bag_item.rb
@@ -1,6 +1,6 @@
#
# Author:: Seth Falcon (<seth@chef.io>)
-# Copyright:: Copyright 2010-2016, Chef Software Inc.
+# Copyright:: Copyright 2010-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -84,10 +84,12 @@ class Chef::EncryptedDataBagItem
raise ArgumentError, "assignment not supported for #{self.class}"
end
- def to_hash
+ def to_h
@enc_hash.keys.inject({}) { |hash, key| hash[key] = self[key]; hash }
end
+ alias_method :to_hash, :to_h
+
def self.encrypt_data_bag_item(plain_hash, secret)
plain_hash.inject({}) do |h, (key, val)|
h[key] = if key != "id"
diff --git a/lib/chef/environment.rb b/lib/chef/environment.rb
index fa845cea6f..c40897d687 100644
--- a/lib/chef/environment.rb
+++ b/lib/chef/environment.rb
@@ -117,7 +117,7 @@ class Chef
@cookbook_versions[cookbook] = version
end
- def to_hash
+ def to_h
result = {
"name" => @name,
"description" => @description,
@@ -130,8 +130,10 @@ class Chef
result
end
+ alias_method :to_hash, :to_h
+
def to_json(*a)
- Chef::JSONCompat.to_json(to_hash, *a)
+ Chef::JSONCompat.to_json(to_h, *a)
end
def update_from!(o)
diff --git a/lib/chef/handler.rb b/lib/chef/handler.rb
index 34db223d43..0d4a3edbaa 100644
--- a/lib/chef/handler.rb
+++ b/lib/chef/handler.rb
@@ -1,6 +1,6 @@
#--
# Author:: Adam Jacob (<adam@chef.io>)
-# Copyright:: Copyright 2010-2016, Chef Software Inc.
+# Copyright:: Copyright 2010-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -259,7 +259,7 @@ class Chef
# Return the Hash representation of the run_status
def data
- @run_status.to_hash
+ @run_status.to_h
end
end
diff --git a/lib/chef/json_compat.rb b/lib/chef/json_compat.rb
index 00052208d2..1ce54b68bc 100644
--- a/lib/chef/json_compat.rb
+++ b/lib/chef/json_compat.rb
@@ -1,6 +1,6 @@
#
# Author:: Tim Hinderliter (<tim@chef.io>)
-# Copyright:: Copyright 2010-2016, Chef Software Inc.
+# Copyright:: Copyright 2010-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
diff --git a/lib/chef/key.rb b/lib/chef/key.rb
index 80315cc551..6971e84d5f 100644
--- a/lib/chef/key.rb
+++ b/lib/chef/key.rb
@@ -115,7 +115,7 @@ class Chef
regex: /^(\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z|infinity)$/)
end
- def to_hash
+ def to_h
result = {
@actor_field_name => @actor,
}
@@ -127,8 +127,10 @@ class Chef
result
end
+ alias_method :to_hash, :to_h
+
def to_json(*a)
- Chef::JSONCompat.to_json(to_hash, *a)
+ Chef::JSONCompat.to_json(to_h, *a)
end
def create
@@ -155,7 +157,7 @@ class Chef
result = chef_rest.post("#{api_base}/#{@actor}/keys", payload)
# append the private key to the current key if the server returned one,
# since the POST endpoint just returns uri and private_key if needed.
- new_key = to_hash
+ new_key = to_h
new_key["private_key"] = result["private_key"] if result["private_key"]
Chef::Key.from_hash(new_key)
end
@@ -175,12 +177,12 @@ class Chef
# to @name.
put_name = @name if put_name.nil?
- new_key = chef_rest.put("#{api_base}/#{@actor}/keys/#{put_name}", to_hash)
+ new_key = chef_rest.put("#{api_base}/#{@actor}/keys/#{put_name}", to_h)
# if the server returned a public_key, remove the create_key field, as we now have a key
if new_key["public_key"]
delete_create_key
end
- Chef::Key.from_hash(to_hash.merge(new_key))
+ Chef::Key.from_hash(to_h.merge(new_key))
end
def save
diff --git a/lib/chef/knife/client_edit.rb b/lib/chef/knife/client_edit.rb
index 49526c72b3..21fd3f457d 100644
--- a/lib/chef/knife/client_edit.rb
+++ b/lib/chef/knife/client_edit.rb
@@ -1,6 +1,6 @@
#
# Author:: Adam Jacob (<adam@chef.io>)
-# Copyright:: Copyright 2009-2016, Chef Software Inc.
+# Copyright:: Copyright 2009-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -37,7 +37,7 @@ class Chef
exit 1
end
- original_data = Chef::ApiClientV1.load(@client_name).to_hash
+ original_data = Chef::ApiClientV1.load(@client_name).to_h
edited_client = edit_hash(original_data)
if original_data != edited_client
client = Chef::ApiClientV1.from_hash(edited_client)
diff --git a/lib/chef/knife/data_bag_show.rb b/lib/chef/knife/data_bag_show.rb
index 5df0561276..eeebd11832 100644
--- a/lib/chef/knife/data_bag_show.rb
+++ b/lib/chef/knife/data_bag_show.rb
@@ -1,7 +1,7 @@
#
# Author:: Adam Jacob (<adam@chef.io>)
# Author:: Seth Falcon (<seth@chef.io>)
-# Copyright:: Copyright 2009-2016, Chef Software, Inc.
+# Copyright:: Copyright 2009-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -46,7 +46,7 @@ class Chef
raw = Chef::EncryptedDataBagItem.load(@name_args[0],
@name_args[1],
secret)
- format_for_display(raw.to_hash)
+ format_for_display(raw.to_h)
elsif encrypted && !secret
ui.warn("Encrypted data bag detected, but no secret provided for decoding. Displaying encrypted data.")
format_for_display(raw_data)
diff --git a/lib/chef/knife/osc_user_edit.rb b/lib/chef/knife/osc_user_edit.rb
index 89986c6f04..dad90199f5 100644
--- a/lib/chef/knife/osc_user_edit.rb
+++ b/lib/chef/knife/osc_user_edit.rb
@@ -1,6 +1,6 @@
#
# Author:: Steven Danna (<steve@chef.io>)
-# Copyright:: Copyright 2012-2016, Chef Software Inc.
+# Copyright:: Copyright 2012-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -43,7 +43,7 @@ class Chef
exit 1
end
- original_user = Chef::User.load(@user_name).to_hash
+ original_user = Chef::User.load(@user_name).to_h
edited_user = edit_hash(original_user)
if original_user != edited_user
user = Chef::User.from_hash(edited_user)
diff --git a/lib/chef/knife/user_edit.rb b/lib/chef/knife/user_edit.rb
index e445a31677..eb6d74c470 100644
--- a/lib/chef/knife/user_edit.rb
+++ b/lib/chef/knife/user_edit.rb
@@ -1,6 +1,6 @@
#
# Author:: Steven Danna (<steve@chef.io>)
-# Copyright:: Copyright 2012-2016, Chef Software Inc.
+# Copyright:: Copyright 2012-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -57,7 +57,7 @@ EOF
exit 1
end
- original_user = Chef::UserV1.load(@user_name).to_hash
+ original_user = Chef::UserV1.load(@user_name).to_h
# DEPRECATION NOTE
# Remove this if statement and corrosponding code post OSC 11 support.
#
diff --git a/lib/chef/org.rb b/lib/chef/org.rb
index ea1c411b67..afc5cf148d 100644
--- a/lib/chef/org.rb
+++ b/lib/chef/org.rb
@@ -58,7 +58,7 @@ class Chef
arg, kind_of: String)
end
- def to_hash
+ def to_h
result = {
"name" => @name,
"full_name" => @full_name,
@@ -68,20 +68,22 @@ class Chef
result
end
+ alias_method :to_hash, :to_h
+
def to_json(*a)
- Chef::JSONCompat.to_json(to_hash, *a)
+ Chef::JSONCompat.to_json(to_h, *a)
end
def create
payload = { name: name, full_name: full_name }
new_org = chef_rest.post("organizations", payload)
- Chef::Org.from_hash(to_hash.merge(new_org))
+ Chef::Org.from_hash(to_h.merge(new_org))
end
def update
payload = { name: name, full_name: full_name }
new_org = chef_rest.put("organizations/#{name}", payload)
- Chef::Org.from_hash(to_hash.merge(new_org))
+ Chef::Org.from_hash(to_h.merge(new_org))
end
def destroy
diff --git a/lib/chef/policy_builder/policyfile.rb b/lib/chef/policy_builder/policyfile.rb
index 80ecda1850..dd1dc40274 100644
--- a/lib/chef/policy_builder/policyfile.rb
+++ b/lib/chef/policy_builder/policyfile.rb
@@ -3,7 +3,7 @@
# Author:: Tim Hinderliter (<tim@chef.io>)
# Author:: Christopher Walters (<cw@chef.io>)
# Author:: Daniel DeLeo (<dan@chef.io>)
-# Copyright:: Copyright 2008-2016 Chef Software, Inc.
+# Copyright:: Copyright 2008-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -56,7 +56,7 @@ class Chef
# interface we need to properly send this through to
# events.run_list_expanded as it is expecting a RunListExpansion
# object.
- def to_hash
+ def to_h
# It looks like version only gets populated in the expanded_run_list when
# using a little used feature of roles to version lock cookbooks, so
# version is not reliable in here anyway (places like Automate UI are
@@ -73,8 +73,10 @@ class Chef
data_collector_hash
end
+ alias_method :to_hash, :to_h
+
def to_json(*opts)
- to_hash.to_json(*opts)
+ to_h.to_json(*opts)
end
end
diff --git a/lib/chef/resource.rb b/lib/chef/resource.rb
index 1440b2eb61..5222dc7286 100644
--- a/lib/chef/resource.rb
+++ b/lib/chef/resource.rb
@@ -682,7 +682,7 @@ class Chef
Chef::JSONCompat.to_json(results, *a)
end
- def to_hash
+ def to_h
# Grab all current state, then any other ivars (backcompat)
result = {}
self.class.state_properties.each do |p|
@@ -697,6 +697,8 @@ class Chef
result
end
+ alias_method :to_hash, :to_h
+
def self.from_hash(o)
resource = new(o["instance_vars"]["@name"])
o["instance_vars"].each do |k, v|
diff --git a/lib/chef/resource_collection/resource_collection_serialization.rb b/lib/chef/resource_collection/resource_collection_serialization.rb
index 4da1ad5048..d3133bae39 100644
--- a/lib/chef/resource_collection/resource_collection_serialization.rb
+++ b/lib/chef/resource_collection/resource_collection_serialization.rb
@@ -1,6 +1,6 @@
#
# Author:: Tyler Ball (<tball@chef.io>)
-# Copyright:: Copyright 2014-2016, Chef Software, Inc.
+# Copyright:: Copyright 2014-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,7 +22,7 @@ class Chef
class ResourceCollection
module ResourceCollectionSerialization
# Serialize this object as a hash
- def to_hash
+ def to_h
instance_vars = Hash.new
instance_variables.each do |iv|
instance_vars[iv] = instance_variable_get(iv)
@@ -33,6 +33,8 @@ class Chef
}
end
+ alias_method :to_hash, :to_h
+
def to_json(*a)
Chef::JSONCompat.to_json(to_hash, *a)
end
diff --git a/lib/chef/role.rb b/lib/chef/role.rb
index 73d5cf5743..fc9a383a1f 100644
--- a/lib/chef/role.rb
+++ b/lib/chef/role.rb
@@ -130,7 +130,7 @@ class Chef
)
end
- def to_hash
+ def to_h
env_run_lists_without_default = @env_run_lists.dup
env_run_lists_without_default.delete("_default")
result = {
@@ -152,9 +152,11 @@ class Chef
result
end
+ alias_method :to_hash, :to_h
+
# Serialize this object as a hash
def to_json(*a)
- Chef::JSONCompat.to_json(to_hash, *a)
+ Chef::JSONCompat.to_json(to_h, *a)
end
def update_from!(o)
diff --git a/lib/chef/run_list/run_list_expansion.rb b/lib/chef/run_list/run_list_expansion.rb
index 161574e884..a679eceba5 100644
--- a/lib/chef/run_list/run_list_expansion.rb
+++ b/lib/chef/run_list/run_list_expansion.rb
@@ -1,7 +1,7 @@
#
# Author:: Daniel DeLeo (<dan@chef.io>)
# Author:: Tim Hinderliter (<tim@chef.io>)
-# Copyright:: Copyright 2010-2016, Chef Software Inc.
+# Copyright:: Copyright 2010-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -144,14 +144,16 @@ class Chef
end
def to_json(*a)
- Chef::JSONCompat.to_json(to_hash, *a)
+ Chef::JSONCompat.to_json(to_h, *a)
end
- def to_hash
+ def to_h
seen_items = { recipe: {}, role: {} }
{ id: @environment, run_list: convert_run_list_trace("top level", seen_items) }
end
+ alias_method :to_hash, :to_h
+
private
# these methods modifies internal state based on arguments, so hide it.
diff --git a/lib/chef/run_status.rb b/lib/chef/run_status.rb
index 9a52f846c7..37b10fb9be 100644
--- a/lib/chef/run_status.rb
+++ b/lib/chef/run_status.rb
@@ -1,6 +1,6 @@
#
# Author:: Daniel DeLeo (<dan@chef.io>)
-# Copyright:: Copyright 2010-2016, Chef Software Inc.
+# Copyright:: Copyright 2010-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -102,7 +102,7 @@ class Chef::RunStatus
# * :updated_resources
# * :exception
# * :backtrace
- def to_hash
+ def to_h
# use a flat hash here so we can't errors from intermediate values being nil
{ node: node,
success: success?,
@@ -116,6 +116,8 @@ class Chef::RunStatus
run_id: run_id }
end
+ alias_method :to_hash, :to_h
+
# Returns a string of the format "ExceptionClass: message" or +nil+ if no
# +exception+ is set.
def formatted_exception
diff --git a/lib/chef/user.rb b/lib/chef/user.rb
index eba55c4186..f44d38c2d5 100644
--- a/lib/chef/user.rb
+++ b/lib/chef/user.rb
@@ -1,6 +1,6 @@
#
# Author:: Steven Danna (steve@chef.io)
-# Copyright:: Copyright 2012-2016, Chef Software, Inc.
+# Copyright:: Copyright 2012-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -77,7 +77,7 @@ class Chef
arg, kind_of: String)
end
- def to_hash
+ def to_h
result = {
"name" => @name,
"public_key" => @public_key,
@@ -88,8 +88,10 @@ class Chef
result
end
+ alias_method :to_hash, :to_h
+
def to_json(*a)
- Chef::JSONCompat.to_json(to_hash, *a)
+ Chef::JSONCompat.to_json(to_h, *a)
end
def destroy
@@ -100,7 +102,7 @@ class Chef
payload = { name: name, admin: admin, password: password }
payload[:public_key] = public_key if public_key
new_user = chef_rest_v0.post("users", payload)
- Chef::User.from_hash(to_hash.merge(new_user))
+ Chef::User.from_hash(to_h.merge(new_user))
end
def update(new_key = false)
@@ -108,7 +110,7 @@ class Chef
payload[:private_key] = new_key if new_key
payload[:password] = password if password
updated_user = chef_rest_v0.put("users/#{name}", payload)
- Chef::User.from_hash(to_hash.merge(updated_user))
+ Chef::User.from_hash(to_h.merge(updated_user))
end
def save(new_key = false)
diff --git a/lib/chef/user_v1.rb b/lib/chef/user_v1.rb
index 293bec54a7..949f5b0909 100644
--- a/lib/chef/user_v1.rb
+++ b/lib/chef/user_v1.rb
@@ -1,6 +1,6 @@
#
# Author:: Steven Danna (steve@chef.io)
-# Copyright:: Copyright 2012-2016, Chef Software, Inc.
+# Copyright:: Copyright 2012-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -112,7 +112,7 @@ class Chef
arg, kind_of: String)
end
- def to_hash
+ def to_h
result = {
"username" => @username,
}
@@ -128,8 +128,10 @@ class Chef
result
end
+ alias_method :to_hash, :to_h
+
def to_json(*a)
- Chef::JSONCompat.to_json(to_hash, *a)
+ Chef::JSONCompat.to_json(to_h, *a)
end
def destroy
@@ -180,7 +182,7 @@ class Chef
new_user = chef_root_rest_v0.post("users", payload)
end
- Chef::UserV1.from_hash(to_hash.merge(new_user))
+ Chef::UserV1.from_hash(to_h.merge(new_user))
end
def update(new_key = false)
@@ -213,7 +215,7 @@ class Chef
end
updated_user = chef_root_rest_v0.put("users/#{username}", payload)
end
- Chef::UserV1.from_hash(to_hash.merge(updated_user))
+ Chef::UserV1.from_hash(to_h.merge(updated_user))
end
def save(new_key = false)
@@ -229,7 +231,7 @@ class Chef
# Note: remove after API v0 no longer supported by client (and knife command).
def reregister
begin
- payload = to_hash.merge({ "private_key" => true })
+ payload = to_h.merge({ "private_key" => true })
reregistered_self = chef_root_rest_v0.put("users/#{username}", payload)
private_key(reregistered_self["private_key"])
# only V0 supported for reregister
diff --git a/spec/unit/audit/audit_reporter_spec.rb b/spec/unit/audit/audit_reporter_spec.rb
index db065db923..60e93a9331 100644
--- a/spec/unit/audit/audit_reporter_spec.rb
+++ b/spec/unit/audit/audit_reporter_spec.rb
@@ -53,7 +53,7 @@ describe Chef::Audit::AuditReporter do
describe "#run_completed" do
let(:audit_data) { Chef::Audit::AuditData.new(node.name, run_id) }
- let(:run_data) { audit_data.to_hash }
+ let(:run_data) { audit_data.to_h }
before do
allow(reporter).to receive(:auditing_enabled?).and_return(true)
@@ -61,7 +61,7 @@ describe Chef::Audit::AuditReporter do
allow(rest).to receive(:post).and_return(true)
allow(reporter).to receive(:audit_data).and_return(audit_data)
allow(reporter).to receive(:run_status).and_return(run_status)
- allow(audit_data).to receive(:to_hash).and_return(run_data)
+ allow(audit_data).to receive(:to_h).and_return(run_data)
end
describe "a successful run with auditing enabled" do
@@ -233,7 +233,7 @@ EOM
describe "#run_failed" do
let(:audit_data) { Chef::Audit::AuditData.new(node.name, run_id) }
- let(:run_data) { audit_data.to_hash }
+ let(:run_data) { audit_data.to_h }
let(:audit_error) do
double("AuditError", class: "Chef::Exceptions::AuditError",
@@ -249,7 +249,7 @@ EOM
allow(reporter).to receive(:auditing_enabled?).and_return(true)
allow(reporter).to receive(:run_status).and_return(run_status)
allow(reporter).to receive(:audit_data).and_return(audit_data)
- allow(audit_data).to receive(:to_hash).and_return(run_data)
+ allow(audit_data).to receive(:to_h).and_return(run_data)
end
context "when no prior exception is stored" do
diff --git a/spec/unit/audit/control_group_data_spec.rb b/spec/unit/audit/control_group_data_spec.rb
index 82af77dcea..e8af8be90d 100644
--- a/spec/unit/audit/control_group_data_spec.rb
+++ b/spec/unit/audit/control_group_data_spec.rb
@@ -2,7 +2,7 @@
# Author:: Tyler Ball (<tball@chef.io>)
# Author:: Claire McQuin (<claire@chef.io>)
#
-# Copyright:: Copyright 2014-2016, Chef Software, Inc.
+# Copyright:: Copyright 2014-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -57,9 +57,9 @@ describe Chef::Audit::AuditData do
end
end
- describe "#to_hash" do
+ describe "#to_h" do
- let(:audit_data_hash) { audit_data.to_hash }
+ let(:audit_data_hash) { audit_data.to_h }
it "returns a hash" do
expect(audit_data_hash).to be_a(Hash)
@@ -90,7 +90,7 @@ describe Chef::Audit::AuditData do
end
it "is a one-element list containing the control group hash" do
- expect(control_group_1).to receive(:to_hash).once.and_return(control_hash_1)
+ expect(control_group_1).to receive(:to_h).once.and_return(control_hash_1)
expect(control_groups.size).to eq 1
expect(control_groups).to include(control_hash_1)
end
@@ -103,8 +103,8 @@ describe Chef::Audit::AuditData do
end
it "is a list of control group hashes" do
- expect(control_group_1).to receive(:to_hash).and_return(control_hash_1)
- expect(control_group_2).to receive(:to_hash).and_return(control_hash_2)
+ expect(control_group_1).to receive(:to_h).and_return(control_hash_1)
+ expect(control_group_2).to receive(:to_h).and_return(control_hash_2)
expect(control_groups.size).to eq 2
expect(control_groups).to include(control_hash_1)
expect(control_groups).to include(control_hash_2)
@@ -127,9 +127,9 @@ describe Chef::Audit::ControlData do
resource_type: resource_type, resource_name: resource_name,
context: context, line_number: line_number) end
- describe "#to_hash" do
+ describe "#to_h" do
- let(:control_data_hash) { control_data.to_hash }
+ let(:control_data_hash) { control_data.to_h }
it "returns a hash" do
expect(control_data_hash).to be_a(Hash)
@@ -385,9 +385,9 @@ describe Chef::Audit::ControlGroupData do
end
end
- describe "#to_hash" do
+ describe "#to_h" do
- let(:control_group_data_hash) { control_group_data.to_hash }
+ let(:control_group_data_hash) { control_group_data.to_h }
it "returns a hash" do
expect(control_group_data_hash).to be_a(Hash)
@@ -413,11 +413,11 @@ describe Chef::Audit::ControlGroupData do
include_context "control"
let(:control_list) { [control_data] }
- let(:control_hash) { control.to_hash }
+ let(:control_hash) { control.to_h }
before do
expect(control_group_data).to receive(:controls).twice.and_return(control_list)
- expect(control_data).to receive(:to_hash).and_return(control_hash)
+ expect(control_data).to receive(:to_h).and_return(control_hash)
end
it "is a one-element list containing the control hash" do
@@ -426,7 +426,7 @@ describe Chef::Audit::ControlGroupData do
end
it "adds a sequence number to the control" do
- control_group_data.to_hash
+ control_group_data.to_h
expect(control_hash).to have_key(:sequence_number)
end
@@ -441,15 +441,15 @@ describe Chef::Audit::ControlGroupData do
let(:control_1) do
double("control 1",
line_number: control_hash_1[:line_number],
- to_hash: control_hash_1) end
+ to_h: control_hash_1) end
let(:control_2) do
double("control 2",
line_number: control_hash_2[:line_number],
- to_hash: control_hash_2) end
+ to_h: control_hash_2) end
let(:control_3) do
double("control 3",
line_number: control_hash_3[:line_number],
- to_hash: control_hash_3) end
+ to_h: control_hash_3) end
let(:control_list) { [control_1, control_2, control_3] }
let(:ordered_control_hashes) { [control_hash_2, control_hash_1, control_hash_3] }
@@ -470,7 +470,7 @@ describe Chef::Audit::ControlGroupData do
end
it "assigns sequence numbers in order" do
- control_group_data.to_hash
+ control_group_data.to_h
ordered_control_hashes.each_with_index do |control_hash, idx|
expect(control_hash[:sequence_number]).to eq idx + 1
end
diff --git a/spec/unit/resource_collection_spec.rb b/spec/unit/resource_collection_spec.rb
index 8dd367b0ec..c12a005cfc 100644
--- a/spec/unit/resource_collection_spec.rb
+++ b/spec/unit/resource_collection_spec.rb
@@ -1,7 +1,7 @@
#
# Author:: Adam Jacob (<adam@chef.io>)
# Author:: Christopher Walters (<cw@chef.io>)
-# Copyright:: Copyright 2008-2017, Chef Software Inc.
+# Copyright:: Copyright 2008-2018, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");