diff options
| author | Tim Smith <tsmith@chef.io> | 2018-03-26 11:51:53 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-03-26 11:51:53 -0700 |
| commit | 2f78c8e68591a0d84439c2e9e921893fdf6f6c2b (patch) | |
| tree | 8c286073fee256f7afbc30083d3ce5082d9e858e /lib/chef/resource.rb | |
| parent | 1f680e381154ced90769936ffb74574ae97fb27c (diff) | |
| parent | 3a2fd533ddd386440cb5307cf9585922f31452d7 (diff) | |
| download | chef-2f78c8e68591a0d84439c2e9e921893fdf6f6c2b.tar.gz | |
Merge pull request #7050 from chef/tm/deprecated_properties
RFC-102: Deprecation warning in resources
Diffstat (limited to 'lib/chef/resource.rb')
| -rw-r--r-- | lib/chef/resource.rb | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/lib/chef/resource.rb b/lib/chef/resource.rb index 26298e5b1d..46bc25b713 100644 --- a/lib/chef/resource.rb +++ b/lib/chef/resource.rb @@ -148,6 +148,7 @@ class Chef @not_if = [] @only_if = [] @source_line = nil + @deprecated = false # We would like to raise an error when the user gives us a guard # interpreter and a ruby_block to the guard. In order to achieve this # we need to understand when the user overrides the default guard @@ -1181,8 +1182,8 @@ class Chef # Internal Resource Interface (for Chef) # - FORBIDDEN_IVARS = [:@run_context, :@logger, :@not_if, :@only_if, :@enclosing_provider, :@description, :@introduced, :@examples, :@validation_message] - HIDDEN_IVARS = [:@allowed_actions, :@resource_name, :@source_line, :@run_context, :@logger, :@name, :@not_if, :@only_if, :@elapsed_time, :@enclosing_provider, :@description, :@introduced, :@examples, :@validation_message] + FORBIDDEN_IVARS = [:@run_context, :@logger, :@not_if, :@only_if, :@enclosing_provider, :@description, :@introduced, :@examples, :@validation_message, :@deprecated] + HIDDEN_IVARS = [:@allowed_actions, :@resource_name, :@source_line, :@run_context, :@logger, :@name, :@not_if, :@only_if, :@elapsed_time, :@enclosing_provider, :@description, :@introduced, :@examples, :@validation_message, :@deprecated] include Chef::Mixin::ConvertToClassName extend Chef::Mixin::ConvertToClassName @@ -1406,6 +1407,14 @@ class Chef @examples end + def self.deprecated(deprecated = "NOT_PASSED") + if deprecated != "NOT_PASSED" + @deprecated = true + @deprecated_message = deprecated + end + @deprecated + end + # # The cookbook in which this Resource was defined (if any). # |