Contents

#
# Copyright:: 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 ChefSharing
        # Resources should include examples field to allow automated documention. Requires Chef Infra Client 13.9 or later.
        #
        # @example
        #
        #   # good
        #   examples <<~DOC
        #     **Specify a global domain value**
        #
        #     ```ruby
        #     macos_userdefaults 'full keyboard access to all controls' do
        #       key 'AppleKeyboardUIMode'
        #       value '2'
        #     end
        #     ```
        #   DOC
        #
        class IncludeResourceExamples < Cop
          include RangeHelp
          extend TargetChefVersion

          minimum_target_chef_version '13.9'

          MSG = 'Resources should include examples field to allow automated documention. Requires Chef Infra Client 13.9 or later.'.freeze

          def investigate(processed_source)
            return if processed_source.blank?

            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
            range = source_range(processed_source.buffer, 1, 0)

            add_offense(nil, location: range, message: MSG, severity: :refactor) unless resource_examples(processed_source.ast).any?
          end

          def_node_search :resource_examples, '(send nil? :examples dstr ...)'
        end
      end
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
cookstyle-6.11.4	lib/rubocop/cop/chef/sharing/include_resource_examples.rb
cookstyle-6.10.2	lib/rubocop/cop/chef/sharing/include_resource_examples.rb