Sha256: d872a80e31f3b12dba33fcc97bd53f1eb768fe0a8336744114cc0117df6f32fc

Contents?: true

Size: 1.51 KB

Versions: 9

Compression:

Stored size: 1.51 KB

Contents

#
# Copyright:: 2019, 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 ChefDeprecations
        # 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
          include RangeHelp

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

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

          def autocorrect(node)
            lambda do |corrector|
              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :right))
            end
          end
        end
      end
    end
  end
end

Version data entries

9 entries across 9 versions & 1 rubygems

Version Path
cookstyle-5.14.1 lib/rubocop/cop/chef/deprecation/long_description_metadata.rb
cookstyle-5.13.7 lib/rubocop/cop/chef/deprecation/long_description_metadata.rb
cookstyle-5.12.13 lib/rubocop/cop/chef/deprecation/long_description_metadata.rb
cookstyle-5.12.12 lib/rubocop/cop/chef/deprecation/long_description_metadata.rb
cookstyle-5.11.0 lib/rubocop/cop/chef/deprecation/long_description_metadata.rb
cookstyle-5.10.13 lib/rubocop/cop/chef/deprecation/long_description_metadata.rb
cookstyle-5.10.11 lib/rubocop/cop/chef/deprecation/long_description_metadata.rb
cookstyle-5.9.3 lib/rubocop/cop/chef/deprecation/long_description_metadata.rb
cookstyle-5.8.1 lib/rubocop/cop/chef/deprecation/long_description_metadata.rb