Contents

# frozen_string_literal: true
#
# Copyright:: 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
        # Use `platform?('windows')` instead of the legacy `Chef::Platform.windows?` helper
        #
        # @example
        #
        #   ### incorrect
        #   Chef::Platform.windows?
        #
        #   ### correct
        #   platform?('windows')
        #   platform_family?('windows')
        #
        class ChefWindowsPlatformHelper < Base
          extend AutoCorrector
          MSG = "Use `platform?('windows')` instead of the legacy `Chef::Platform.windows?` helper."
          RESTRICT_ON_SEND = [:windows?].freeze

          def_node_matcher :chef_platform_windows?, <<-PATTERN
            (send
              (const
                (const nil? :Chef) :Platform) :windows?)
          PATTERN

          def on_send(node)
            chef_platform_windows?(node) do
              add_offense(node, severity: :warning) do |corrector|
                corrector.replace(node, "platform?('windows')")
              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/chef_windows_platform_helper.rb
cookstyle-7.32.7	lib/rubocop/cop/chef/deprecation/chef_windows_platform_helper.rb
cookstyle-ng-8.0.0	lib/rubocop/cop/chef/deprecation/chef_windows_platform_helper.rb