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 ChefModernize
        # Use the `data_bag_item` helper instead of `Chef::DataBagItem.load` or `Chef::EncryptedDataBagItem.load`.
        #
        # @example
        #
        #   # bad
        #   plain_text_data = Chef::DataBagItem.load('foo', 'bar')
        #   encrypted_data = Chef::EncryptedDataBagItem.load('foo2', 'bar2')
        #
        #   # good
        #   plain_text_data = data_bag_item('foo', 'bar')
        #   encrypted_data = data_bag_item('foo2', 'bar2')
        #
        class DatabagHelpers < Base
          extend AutoCorrector

          MSG = 'Use the `data_bag_item` helper instead of `Chef::DataBagItem.load` or `Chef::EncryptedDataBagItem.load`.'

          def_node_matcher :data_bag_class_load?, <<-PATTERN
          (send
            (const
              (const nil? :Chef) {:DataBagItem :EncryptedDataBagItem}) :load
              ...)
          PATTERN

          def on_send(node)
            data_bag_class_load?(node) do
              add_offense(node, message: MSG, severity: :refactor) do |corrector|
                corrector.replace(node,
                   node.source.gsub(/Chef::(EncryptedDataBagItem|DataBagItem).load/, 'data_bag_item'))
              end
            end
          end
        end
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
cookstyle-6.19.5	lib/rubocop/cop/chef/modernize/databag_helpers.rb