Class: RuboCop::Cop::Chef::ChefModernize::RespondToInMetadata

Inherits:
RuboCop::Cop
  • Object
show all
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:


# bad
chef_version '>= 13' if respond_to?(:chef_version)
chef_version '>= 13' if defined?(chef_version)
if defined(chef_version)
  chef_version '>= 13'
end

# good
chef_version '>= 13'

Constant Summary collapse

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

Instance Method Summary collapse

Instance Method Details

#autocorrect(node) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/rubocop/cop/chef/modernize/respond_to_metadata.rb', line 54

def autocorrect(node)
  lambda 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.loc.expression, node.if_branch.source)
  end
end

#on_defined?(node) ⇒ Boolean

Returns:

  • (Boolean) 


45
46
47
48
 
# File 'lib/rubocop/cop/chef/modernize/respond_to_metadata.rb', line 45

def on_defined?(node)
  node = node.parent if node.parent.if? # we want the whole if statement
  add_offense(node, location: :expression, message: MSG, severity: :refactor)
end

#on_if(node) ⇒ Object 



39
40
41
42
43
 
# File 'lib/rubocop/cop/chef/modernize/respond_to_metadata.rb', line 39

def on_if(node)
  if_respond_to?(node) do
    add_offense(node, location: :expression, message: MSG, severity: :refactor)
  end
end