Sha256: 9824e1880997bcb48fbfd467e43a2faa23d212ceb59720a322f7ae9bb243223e

Contents?: true

Size: 1.94 KB

Versions: 6

Compression:

Stored size: 1.94 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 ChefDeprecations
        # Use the :run action in the ruby_block resource instead of the deprecated :create action
        #
        # @example
        #
        #   # bad
        #   ruby_block 'my special ruby block' do
        #     block do
        #       puts 'running'
        #     end
        #     action :create
        #   end
        #
        #   # good
        #   ruby_block 'my special ruby block' do
        #     block do
        #       puts 'running'
        #     end
        #     action :run
        #   end
        #
        class RubyBlockCreateAction < Cop
          include RuboCop::Chef::CookbookHelpers

          MSG = 'Use the :run action in the ruby_block resource instead of the deprecated :create action'

          def on_block(node)
            match_property_in_resource?(:ruby_block, 'action', node) do |ruby_action|
              ruby_action.arguments.each do |action|
                add_offense(action, location: :expression, message: MSG, severity: :warning) if action.source == ':create'
              end
            end
          end

          def autocorrect(node)
            lambda do |corrector|
              corrector.replace(node.loc.expression, ':run')
            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/deprecation/ruby_block_create_action.rb
cookstyle-6.15.5 lib/rubocop/cop/chef/deprecation/ruby_block_create_action.rb
cookstyle-6.15.3 lib/rubocop/cop/chef/deprecation/ruby_block_create_action.rb
cookstyle-6.14.7 lib/rubocop/cop/chef/deprecation/ruby_block_create_action.rb
cookstyle-6.13.3 lib/rubocop/cop/chef/deprecation/ruby_block_create_action.rb
cookstyle-6.12.6 lib/rubocop/cop/chef/deprecation/ruby_block_create_action.rb