Sha256: c23f23b56eea05db1634a955760d42d83cb3f4c045056c597383b0dc0c344a32

Contents?: true

Size: 2 KB

Versions: 6

Compression:

Stored size: 2 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
        # The nokogiri gem ships in Chef Infra Client 12+ and does not need to be installed before being used
        #
        # @example
        #
        #   # bad
        #   chef_gem 'nokogiri'
        #
        class ChefGemNokogiri < Cop
          include RuboCop::Chef::CookbookHelpers

          MSG = 'The nokogiri gem ships in Chef Infra Client 12+ and does not need to be installed before being used.'.freeze

          def_node_matcher :nokogiri_install?, <<-PATTERN
            (send nil? :chef_gem (str "nokogiri"))
          PATTERN

          def on_block(node)
            match_property_in_resource?(:chef_gem, 'package_name', node) do |pkg_name|
              add_offense(node, location: :expression, message: MSG, severity: :refactor) if pkg_name.arguments&.first&.str_content == 'nokogiri'
            end
          end

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

          def autocorrect(node)
            lambda do |corrector|
              node = node.parent if node.parent&.block_type? # make sure we get the whole block not just the method in the block
              corrector.remove(node.loc.expression)
            end
          end
        end
      end
    end
  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
cookstyle-5.18.4 lib/rubocop/cop/chef/modernize/chef_gem_nokogiri.rb
cookstyle-5.17.4 lib/rubocop/cop/chef/modernize/chef_gem_nokogiri.rb
cookstyle-5.16.11 lib/rubocop/cop/chef/modernize/chef_gem_nokogiri.rb
cookstyle-5.16.10 lib/rubocop/cop/chef/modernize/chef_gem_nokogiri.rb
cookstyle-5.15.7 lib/rubocop/cop/chef/modernize/chef_gem_nokogiri.rb
cookstyle-5.14.1 lib/rubocop/cop/chef/modernize/chef_gem_nokogiri.rb