AllowedActionsFromInitialize

All Cookstyle Cops


The department is: Chef/Modernize

The full name of the cop is: Chef/Modernize/AllowedActionsFromInitialize


Enabled by default Supports autocorrection Target Chef Version
Enabled Yes All Versions

The allowed actions can now be specified using the allowed_actions helper instead of using the @actions or @allowed_actions variables in the resource’s initialize method. In general we recommend against writing HWRPs, but if HWRPs are necessary you should utilize as much of the resource DSL as possible.

Examples

incorrect

def initialize(*args)
  super
  @actions = [ :create, :add ]
end

# also bad
def initialize(*args)
  super
  @allowed_actions = [ :create, :add ]
end

correct

allowed_actions [ :create, :add ]

Configurable attributes

Name Default value Configurable values
Version Added 5.15.0 String
Include
  • **/resources/*.rb
  • **/libraries/*.rb
Array

© Chef Software, Inc.
Licensed under the Creative Commons Attribution 3.0 Unported License.
The Chef™ Mark and Chef Logo are either registered trademarks/service marks or trademarks/servicemarks of Chef, in the United States and other countries and are used with Chef Inc's permission.
We are not affiliated with, endorsed or sponsored by Chef Inc.
https://docs.chef.io/workstation/cookstyle/chef_modernize_allowedactionsfrominitialize/