Contents

#
# Copyright:: 2019, 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
      # The long_description metadata.rb method is not used and is unnecessary in cookbooks
      #
      # @example
      #
      #   # bad
      #   long_description 'this is my cookbook and this description will never be seen'
      #

      class LongDescriptionMetadata < Cop
        MSG = 'The long_description metadata.rb method is not used and is unnecessary in cookbooks'.freeze

        def_node_matcher :long_description?, <<-PATTERN
          (send nil? :long_description ... )
        PATTERN

        def on_send(node)
          long_description?(node) do
            add_offense(node, location: :expression, message: MSG, severity: :refactor) if node.method_name == :long_description
          end
        end

        def autocorrect(node)
          lambda do |corrector|
            corrector.remove(node.loc.expression)
          end
        end
      end
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
cookstyle-5.4.13	lib/rubocop/cop/chef/deprecation/long_description_metadata.rb
cookstyle-5.3.6	lib/rubocop/cop/chef/deprecation/long_description_metadata.rb