Sha256: dacb8ec0df499ecea19349116d88888107c1171ec54a347826701ade05681e29

Contents?: true

Size: 1.82 KB

Versions: 35

Compression:

Stored size: 1.82 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
        #
        #   #### incorrect
        #   {"foo" => "bar"}.to_yaml
        #
        #   #### correct
        #   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

35 entries across 35 versions & 1 rubygems

Version Path
cookstyle-7.30.1 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.28.2 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.27.0 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.26.1 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.25.10 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.25.9 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.25.8 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.25.6 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.24.1 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.23.0 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.22.3 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.21.0 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.20.0 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.19.0 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.18.0 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.17.0 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.16.1 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.15.4 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.15.3 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb
cookstyle-7.15.2 lib/rubocop/cop/chef/deprecation/use_yaml_dump.rb