Class: RuboCop::Cop::Chef::Modernize::RespondToInMetadata

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector, TargetChefVersion
Defined in:
lib/rubocop/cop/chef/modernize/respond_to_metadata.rb

Overview

It is not longer necessary respond_to?(:foo) or defined?(foo) in metadata. This was used to support new metadata methods in Chef 11 and early versions of Chef 12.

Examples:


### incorrect
chef_version '>= 13' if respond_to?(:chef_version)
chef_version '>= 13' if defined?(chef_version)
chef_version '>= 13' unless defined?(Ridley::Chef::Cookbook::Metadata)
if defined(chef_version)
  chef_version '>= 13'
end

### correct
chef_version '>= 13'

Constant Summary collapse

MSG = 
'It is no longer necessary to use respond_to? or defined? in metadata.rb in Chef Infra Client 12.15 and later'

Instance Method Summary collapse

Methods included from TargetChefVersion

minimum_target_chef_version, required_minimum_chef_version, support_target_chef_version?

Methods inherited from Base

#target_chef_version

Instance Method Details

#on_defined?(node) ⇒ Boolean

Returns:

  • (Boolean) 


59
60
61
62
63
64
65
66
67
68
 
# File 'lib/rubocop/cop/chef/modernize/respond_to_metadata.rb', line 59

def on_defined?(node)
  # When the if statement is if modifier like `foo if respond_to?(:foo)` then
  # node.if_branch is the actual method call we want to extract.
  # If a series of metadata methods are wrapped in an if statement then the content we want
  # is a block under the if statement and node.parent.if_branch can get us that block
  node = node.parent if node.parent.conditional? # we want the whole conditional statement
  add_offense(node, severity: :refactor) do |corrector|
    corrector.replace(node, node.if_branch.source)
  end
end

#on_if(node) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/rubocop/cop/chef/modernize/respond_to_metadata.rb', line 45

def on_if(node)
  if_respond_to?(node) do
    add_offense(node, severity: :refactor) do |corrector|
      # When the if statement is if modifier like `foo if respond_to?(:foo)` then
      # node.if_branch is the actual method call we want to extract.
      # If a series of metadata methods are wrapped in an if statement then the content we want
      # is a block under the if statement and node.parent.if_branch can get us that block
      node = node.parent unless node.if_type?

      corrector.replace(node, node.if_branch.source)
    end
  end
end