Sha256: 0c195f19df06ba0762352702ae111b321f0d96268504dfddba9d9d3244d1f762

Contents?: true

Size: 1.73 KB

Versions: 18

Compression:

Stored size: 1.73 KB

Contents

#
# 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 ChefModernize
        # ChefSpec 7.1 and later auto generate ChefSpec matchers. Matchers in cookbooks can now be removed.
        #
        # @example
        #
        #   # bad
        #   if defined?(ChefSpec)
        #     def create_yum_repository(resource_name)
        #       ChefSpec::Matchers::ResourceMatcher.new(:yum_repository, :create, resource_name)
        #     end
        #   end
        #
        class DefinesChefSpecMatchers < Cop
          MSG = 'ChefSpec matchers are now auto generated by ChefSpec 7.1+ and do not need to be defined in a cookbook'.freeze

          def_node_matcher :chefspec_matcher?, <<-PATTERN
            (if ( :defined? (const nil? :ChefSpec)) ... )
          PATTERN

          def on_if(node)
            chefspec_matcher?(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

18 entries across 18 versions & 1 rubygems

Version Path
cookstyle-5.18.4 lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
cookstyle-5.17.4 lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
cookstyle-5.16.11 lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
cookstyle-5.16.10 lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
cookstyle-5.15.7 lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
cookstyle-5.14.1 lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
cookstyle-5.13.7 lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
cookstyle-5.12.13 lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
cookstyle-5.12.12 lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
cookstyle-5.11.0 lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
cookstyle-5.10.13 lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
cookstyle-5.10.11 lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
cookstyle-5.9.3 lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
cookstyle-5.8.1 lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
cookstyle-5.7.0 lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
cookstyle-5.6.5 lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
cookstyle-5.6.2 lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb
cookstyle-5.5.7 lib/rubocop/cop/chef/modernize/defines_chefspec_matchers.rb