Sha256: 024c70770cee25c6072eb5e870e7c1be82a1916cefb190778d790b3cca5e88ac

Contents?: true

Size: 1.72 KB

Versions: 6

Compression:

Stored size: 1.72 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
        # Some providers in resources override the provides? method, used to check whether they are a valid provider on the current platform. In Chef Infra Client 13, this will cause an error. Instead use `provides :SOME_PROVIDER_NAME` to register the provider.
        #
        # @example
        #
        #   # bad
        #   def provides?
        #    true
        #   end
        #
        #   # good
        #   provides :SOME_PROVIDER_NAME
        #
        class ResourceOverridesProvidesMethod < Cop
          MSG = "Don't override the provides? method in a resource provider. Use provides :SOME_PROVIDER_NAME instead. This will cause failures in Chef Infra Client 13 and later."

          def_node_search :provides, '(send nil? :provides ...)'

          def on_def(node)
            if node.method_name == :provides?
              add_offense(node, location: :expression, message: MSG, severity: :warning) if provides(processed_source.ast).count == 0
            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/resource_overrides_provides_method.rb
cookstyle-6.15.5 lib/rubocop/cop/chef/deprecation/resource_overrides_provides_method.rb
cookstyle-6.15.3 lib/rubocop/cop/chef/deprecation/resource_overrides_provides_method.rb
cookstyle-6.14.7 lib/rubocop/cop/chef/deprecation/resource_overrides_provides_method.rb
cookstyle-6.13.3 lib/rubocop/cop/chef/deprecation/resource_overrides_provides_method.rb
cookstyle-6.12.6 lib/rubocop/cop/chef/deprecation/resource_overrides_provides_method.rb