Sha256: 56772ebda066cd439312a08569fa4b8eaf09a1d38d0738629e61820e98623561

Contents?: true

Size: 1.57 KB

Versions: 6

Compression:

Stored size: 1.57 KB

Contents

# frozen_string_literal: true
#
# 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
      module ChefCorrectness
        # Use name properties instead of setting the name property in a resource. Setting the name property
        # directly causes notification and reporting issues.
        #
        # @example
        #
        #   # bad
        #   service 'foo' do
        #    name 'bar'
        #   end
        #
        #   # good
        #   service 'foo' do
        #    service_name 'bar'
        #   end
        #
        class ResourceSetsNameProperty < Cop
          include RuboCop::Chef::CookbookHelpers

          MSG = 'Resource sets the name property in the resource instead of using a name_property.'

          def on_block(node)
            match_property_in_resource?(nil, 'name', node) do |name_node|
              add_offense(name_node, location: :expression, message: MSG, severity: :refactor)
            end
          end
        end
      end
    end
  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
cookstyle-6.15.9 lib/rubocop/cop/chef/correctness/resource_sets_name_property.rb
cookstyle-6.15.5 lib/rubocop/cop/chef/correctness/resource_sets_name_property.rb
cookstyle-6.15.3 lib/rubocop/cop/chef/correctness/resource_sets_name_property.rb
cookstyle-6.14.7 lib/rubocop/cop/chef/correctness/resource_sets_name_property.rb
cookstyle-6.13.3 lib/rubocop/cop/chef/correctness/resource_sets_name_property.rb
cookstyle-6.12.6 lib/rubocop/cop/chef/correctness/resource_sets_name_property.rb