Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new PropertyWithNameAttribute rule #125

Merged
merged 4 commits into from
Jul 24, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions config/cookstyle.yml
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,12 @@ Chef/WhyRunSupportedTrue:
Description: why_run_supported? no longer needs to be set to true as it is the default in Chef 13+
Enabled: true

PropertyWithNameAttribute:
Description: Resource property sets name_attribute not name_property
Enabled: true
# Include:
# - '**/resources/.*\.rb'

###############################
# Utilize new built-in resources
###############################
Expand Down
59 changes: 59 additions & 0 deletions lib/rubocop/cop/chef/property_with_name_attribute.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
#
# Copyright:: Copyright 2019, Chef Software Inc.
# Author:: Tim Smith (<tsmith@chef.io>)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
module RuboCop
module Cop
module Chef
# When using properties in a custom resource you should use name_property not
# the legacy name_attribute from the days of attributes
#
# @example
#
# # bad
# property :bob, String, name_attribute: true
#
# # good
# property :bob, String, name_property: true
#
class PropertyWithNameAttribute < Cop
MSG = 'Resource property sets name_attribute not name_property'.freeze

def on_send(node)
add_offense(node, location: :expression, message: MSG, severity: :refactor) if attribute_method_mix?(node)
end

def autocorrect(node)
lambda do |corrector|
corrector.replace(node.loc.expression, node.source.gsub('name_attribute', 'name_property'))
end
end

private

def attribute_method_mix?(node)
if node.method_name == :property
node.arguments.each do |arg|
if arg.type == :hash
return true if arg.source.match?(/name_attribute:/)
end
end
false # no name_attribute found
end
end
end
end
end
end