lib/rubocop/cop/chef/style/comments_format.rb in cookstyle-5.4.13 vs lib/rubocop/cop/chef/style/comments_format.rb in cookstyle-5.5.7

@@ -1,7 +1,8 @@
 #
-# Copyright:: 2016, Tim Smith
+# Copyright:: 2016-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
 #
@@ -15,62 +16,64 @@
 #
 
 module RuboCop
   module Cop
     module Chef
-      # Checks for incorrectly formatted headers
-      #
-      # @example
-      #
-      #   # bad
-      #   Copyright 2013-2016 Chef Software, Inc.
-      #   Recipe default.rb
-      #   Attributes default.rb
-      #   License Apache2
-      #   Cookbook tomcat
-      #   Cookbook Name:: Tomcat
-      #   Attributes File:: default
-      #
-      #   # good
-      #   Copyright:: 2013-2016 Chef Software, Inc.
-      #   Recipe:: default.rb
-      #   Attributes:: default.rb
-      #   License:: Apache License, Version 2.0
-      #   Cookbook:: Tomcat
-      #
-      class CommentFormat < Cop
-        MSG = 'Properly format header comments'.freeze
+      module ChefStyle
+        # Checks for incorrectly formatted headers
+        #
+        # @example
+        #
+        #   # bad
+        #   Copyright 2013-2016 Chef Software, Inc.
+        #   Recipe default.rb
+        #   Attributes default.rb
+        #   License Apache2
+        #   Cookbook tomcat
+        #   Cookbook Name:: Tomcat
+        #   Attributes File:: default
+        #
+        #   # good
+        #   Copyright:: 2013-2016 Chef Software, Inc.
+        #   Recipe:: default.rb
+        #   Attributes:: default.rb
+        #   License:: Apache License, Version 2.0
+        #   Cookbook:: Tomcat
+        #
+        class CommentFormat < Cop
+          MSG = 'Properly format header comments'.freeze
 
-        def investigate(processed_source)
-          return unless processed_source.ast
+          def investigate(processed_source)
+            return unless processed_source.ast
 
-          processed_source.comments.each do |comment|
-            next if comment.loc.first_line > 10 # avoid false positives when we were checking further down the file
-            next unless comment.inline? # headers aren't in blocks
+            processed_source.comments.each do |comment|
+              next if comment.loc.first_line > 10 # avoid false positives when we were checking further down the file
+              next unless comment.inline? # headers aren't in blocks
 
-            if invalid_comment?(comment)
-              add_offense(comment, location: comment.loc.expression, message: MSG, severity: :refactor)
+              if invalid_comment?(comment)
+                add_offense(comment, location: comment.loc.expression, message: MSG, severity: :refactor)
+              end
             end
           end
-        end
 
-        def autocorrect(comment)
-          # Extract the type and the actual value. Strip out "Name" or "File"
-          # 'Cookbook Name' should be 'Cookbook'. Also skip a :: if present
-          # https://rubular.com/r/Do9fpLWXlCmvdJ
-          match = /^#\s*([A-Za-z]+)\s?(?:Name|File)?(?:::)?\s(.*)/.match(comment.text)
-          comment_type, value = match.captures
-          correct_comment = "# #{comment_type}:: #{value}"
+          def autocorrect(comment)
+            # Extract the type and the actual value. Strip out "Name" or "File"
+            # 'Cookbook Name' should be 'Cookbook'. Also skip a :: if present
+            # https://rubular.com/r/Do9fpLWXlCmvdJ
+            match = /^#\s*([A-Za-z]+)\s?(?:Name|File)?(?:::)?\s(.*)/.match(comment.text)
+            comment_type, value = match.captures
+            correct_comment = "# #{comment_type}:: #{value}"
 
-          ->(corrector) { corrector.replace(comment.loc.expression, correct_comment) }
-        end
+            ->(corrector) { corrector.replace(comment.loc.expression, correct_comment) }
+          end
 
-        private
+          private
 
-        def invalid_comment?(comment)
-          comment_types = %w(Author Cookbook Library Attribute Copyright Recipe Resource Definition License)
-          comment_types.any? do |comment_type|
-            /^#\s*#{comment_type}\s+/.match(comment.text)
+          def invalid_comment?(comment)
+            comment_types = %w(Author Cookbook Library Attribute Copyright Recipe Resource Definition License)
+            comment_types.any? do |comment_type|
+              /^#\s*#{comment_type}\s+/.match(comment.text)
+            end
           end
         end
       end
     end
   end