Sha256: 798f8cdc82192ef47051b9d53186fcb3027b31885458b9244201cf07247df3ae

Contents?: true

Size: 1.81 KB

Versions: 11

Compression:

Stored size: 1.81 KB

Contents

# frozen_string_literal: true
#
# Copyright:: 2020, 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 Deprecations
        # Chef Infra Client 16.5 introduced performance enhancements to Ruby library loading. Due to the underlying implementation of Ruby's `.to_yaml` method, it does not automatically load the `yaml` library and `YAML.dump()` should be used instead to properly load the `yaml` library.
        #
        # @example
        #
        #   # bad
        #   {"foo" => "bar"}.to_yaml
        #
        #   # good
        #   YAML.dump({"foo" => "bar"})
        #
        class UseYamlDump < Base
          extend AutoCorrector

          MSG = "Chef Infra Client 16.5 introduced performance enhancements to Ruby library loading. Due to the underlying implementation of Ruby's `.to_yaml` method, it does not automatically load the `yaml` library and `YAML.dump()` should be used instead to properly load the `yaml` library."
          RESTRICT_ON_SEND = [:to_yaml].freeze

          def on_send(node)
            add_offense(node, message: MSG, severity: :warning) do |corrector|
              corrector.replace(node, "YAML.dump(#{node.receiver.source})")
            end
          end
        end
      end
    end
  end
end

Version data entries

11 entries across 11 versions & 1 rubygems

Version Path
cookstyle-7.7.2 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.6.1 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.5.3 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.5.2 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.5.1 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.4.0 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.3.11 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.3.10 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.2.1 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.1.2 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.0.0 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb