Contents

# frozen_string_literal: true
#
# Copyright:: 2019-2020, 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 Deprecations
        # Do not include the deprecated xml::ruby recipe to install the nokogiri gem. Chef Infra Client 12 and later ships with nokogiri included.
        #
        # @example
        #
        #   ### incorrect
        #   include_recipe 'xml::ruby'
        #
        class IncludingXMLRubyRecipe < Base
          extend AutoCorrector

          MSG = 'Do not include the deprecated xml::ruby recipe to install the nokogiri gem. Chef Infra Client 12 and later ships with nokogiri included.'
          RESTRICT_ON_SEND = [:include_recipe].freeze

          def_node_matcher :xml_ruby_recipe?, <<-PATTERN
            (send nil? :include_recipe (str "xml::ruby"))
          PATTERN

          def on_send(node)
            xml_ruby_recipe?(node) do
              node = node.parent if node.parent&.conditional? && node.parent&.single_line_condition? # make sure we catch any inline conditionals
              add_offense(node, severity: :warning) do |corrector|
                corrector.remove(node)
              end
            end
          end
        end
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 2 rubygems

Version	Path
cookstyle-7.32.8	lib/rubocop/cop/chef/deprecation/xml_ruby_recipe.rb
cookstyle-7.32.7	lib/rubocop/cop/chef/deprecation/xml_ruby_recipe.rb
cookstyle-ng-8.0.0	lib/rubocop/cop/chef/deprecation/xml_ruby_recipe.rb