Contents

#
# Copyright:: 2019, Chef Software, Inc.
# Author:: Tim Smith (<[e-mail]>)
#
# 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 ChefModernize
        # In Chef Infra Client releases after 12.5 it is no longer necessary to set `actions` or `allowed_actions` as Chef Infra Client determines these automatically from the set of all actions defined in the resource.
        #
        # @example
        #
        #   # bad
        #   property :something, String
        #
        #   allowed_actions [:create, :remove]
        #
        #   # also bad
        #   property :something, String
        #
        #   actions [:create, :remove]
        #
        #   # good
        #   property :something, String
        #
        class CustomResourceWithAllowedActions < Cop
          MSG = 'Resources no longer need to define the allowed actions with allowed_actions or actions methods.'.freeze

          def_node_matcher :allowed_actions?, <<-PATTERN
            (send nil? {:allowed_actions :actions} ... )
          PATTERN

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

          def autocorrect(node)
            lambda do |corrector|
              corrector.remove(node.loc.expression)
            end
          end
        end
      end
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
cookstyle-5.9.3	lib/rubocop/cop/chef/modernize/resource_with_allowed_actions.rb
cookstyle-5.8.1	lib/rubocop/cop/chef/modernize/resource_with_allowed_actions.rb