cookstyle 5.4.13 → 5.5.7

data/lib/rubocop/cop/chef/style/attribute_keys.rb

@@ -17,73 +17,75 @@
 module RuboCop
   module Cop
     module Chef
-      # Check which style of keys are used to access node attributes.
-      #
-      # There are two supported styles: "symbols" and "strings".
-      #
-      # @example when configuration is `EnforcedStyle: symbols`
-      #
-      #   # bad
-      #   node['foo']
-      #   node["foo"]
-      #
-      #   # good
-      #   node[:foo]
-      #
-      # @example when configuration is `EnforcedStyle: strings`
-      #
-      #   # bad
-      #   node[:foo]
-      #
-      #   # good
-      #   node['foo']
-      #   node["foo"]
-      #
-      class AttributeKeys < Cop
-        include RuboCop::Cop::ConfigurableEnforcedStyle
+      module ChefStyle
+        # Check which style of keys are used to access node attributes.
+        #
+        # There are two supported styles: "symbols" and "strings".
+        #
+        # @example when configuration is `EnforcedStyle: symbols`
+        #
+        #   # bad
+        #   node['foo']
+        #   node["foo"]
+        #
+        #   # good
+        #   node[:foo]
+        #
+        # @example when configuration is `EnforcedStyle: strings`
+        #
+        #   # bad
+        #   node[:foo]
+        #
+        #   # good
+        #   node['foo']
+        #   node["foo"]
+        #
+        class AttributeKeys < Cop
+          include RuboCop::Cop::ConfigurableEnforcedStyle
 
-        MSG = 'Use %s to access node attributes'.freeze
+          MSG = 'Use %s to access node attributes'.freeze
 
-        def_node_matcher :node_attribute_access?, <<-PATTERN
-          (send (send _ :node) :[] _)
-        PATTERN
+          def_node_matcher :node_attribute_access?, <<-PATTERN
+            (send (send _ :node) :[] _)
+          PATTERN
 
-        def_node_matcher :node_level_attribute_access?, <<-PATTERN
-          (send (send {(send _ :node) nil} {:default :role_default :env_default :normal :override :role_override :env_override :force_override :automatic}) :[] _)
-        PATTERN
+          def_node_matcher :node_level_attribute_access?, <<-PATTERN
+            (send (send {(send _ :node) nil} {:default :role_default :env_default :normal :override :role_override :env_override :force_override :automatic}) :[] _)
+          PATTERN
 
-        def on_send(node)
-          if node_attribute_access?(node) || node_level_attribute_access?(node)
-            # node is first child for #[], need to look for the outermost parent too.
-            outer_node = node
-            while outer_node.parent && outer_node.parent.type == :send && outer_node.parent.children[1] == :[]
+          def on_send(node)
+            if node_attribute_access?(node) || node_level_attribute_access?(node)
+              # node is first child for #[], need to look for the outermost parent too.
+              outer_node = node
+              while outer_node.parent && outer_node.parent.type == :send && outer_node.parent.children[1] == :[]
+                on_node_attribute_access(outer_node.children[2])
+                outer_node = outer_node.parent
+              end
+              # One last time for the outer-most access.
               on_node_attribute_access(outer_node.children[2])
-              outer_node = outer_node.parent
             end
-            # One last time for the outer-most access.
-            on_node_attribute_access(outer_node.children[2])
           end
-        end
 
-        def on_node_attribute_access(node)
-          if node.type == :str
-            style_detected(:strings)
-            add_offense(node, location: :expression, message: MSG % style, severity: :refactor) if style == :symbols
-          elsif node.type == :sym
-            style_detected(:symbols)
-            add_offense(node, location: :expression, message: MSG % style, severity: :refactor) if style == :strings
+          def on_node_attribute_access(node)
+            if node.type == :str
+              style_detected(:strings)
+              add_offense(node, location: :expression, message: MSG % style, severity: :refactor) if style == :symbols
+            elsif node.type == :sym
+              style_detected(:symbols)
+              add_offense(node, location: :expression, message: MSG % style, severity: :refactor) if style == :strings
+            end
           end
-        end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            key_string = node.children.first.to_s
-            key_replacement = if style == :symbols
-                                key_string.to_sym.inspect
-                              else # strings
-                                key_string.inspect
-                              end
-            corrector.replace(node.loc.expression, key_replacement)
+          def autocorrect(node)
+            lambda do |corrector|
+              key_string = node.children.first.to_s
+              key_replacement = if style == :symbols
+                                  key_string.to_sym.inspect
+                                else # strings
+                                  key_string.inspect
+                                end
+              corrector.replace(node.loc.expression, key_replacement)
+            end
           end
         end
       end

data/lib/rubocop/cop/chef/style/comment_sentence_spacing.rb

@@ -18,23 +18,25 @@
 module RuboCop
   module Cop
     module Chef
-      # Replaces double spaces between sentences with a single space.
-      # Note: This is DISABLED by default.
-      class CommentSentenceSpacing < Cop
-        MSG = 'Use a single space after sentences in comments'.freeze
+      module ChefStyle
+        # Replaces double spaces between sentences with a single space.
+        # Note: This is DISABLED by default.
+        class CommentSentenceSpacing < Cop
+          MSG = 'Use a single space after sentences in 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|
-            if comment.text.match?(/(.|\?)\s{2}/) # https://rubular.com/r/8o3SiDrQMJSzuU
-              add_offense(comment, location: comment.loc.expression, message: MSG, severity: :refactor)
+            processed_source.comments.each do |comment|
+              if comment.text.match?(/(.|\?)\s{2}/) # https://rubular.com/r/8o3SiDrQMJSzuU
+                add_offense(comment, location: comment.loc.expression, message: MSG, severity: :refactor)
+              end
             end
           end
-        end
 
-        def autocorrect(comment)
-          ->(corrector) { corrector.replace(comment.loc.expression, comment.text.gsub('.  ', '. ').gsub('?  ', '? ')) }
+          def autocorrect(comment)
+            ->(corrector) { corrector.replace(comment.loc.expression, comment.text.gsub('.  ', '. ').gsub('?  ', '? ')) }
+          end
         end
       end
     end

data/lib/rubocop/cop/chef/style/comments_copyright_format.rb

@@ -18,83 +18,85 @@
 module RuboCop
   module Cop
     module Chef
-      # Checks for incorrectly formatted copyright comments.
-      #
-      # @example
-      #
-      #   # bad (assuming current year is 2016)
-      #   Copyright:: 2013-2016 Opscode, Inc.
-      #   Copyright:: 2013-2016 Chef Inc.
-      #   Copyright:: 2013-2016 Chef Software Inc.
-      #   Copyright:: 2009-2010 2013-2016 Chef Software Inc.
-      #   Copyright:: Chef Software Inc.
-      #   Copyright:: Tim Smith
-      #   Copyright:: Copyright (c) 2015-2016 Chef Software, Inc.
-      #
-      #   # good (assuming current year is 2016)
-      #   Copyright:: 2013-2016 Chef Software, Inc.
-      #   Copyright:: 2013-2016 Tim Smith
-      #   Copyright:: 2016 37Signals, Inc.
-      #
-      class CopyrightCommentFormat < Cop
-        require 'date'
-
-        MSG = 'Properly format copyrights header comments'.freeze
-
-        def investigate(processed_source)
-          return unless processed_source.ast
-
-          processed_source.comments.each do |comment|
-            next unless comment.inline? # headers aren't in blocks
-
-            if invalid_copyright_comment?(comment)
-              add_offense(comment, location: comment.loc.expression, message: MSG, severity: :refactor)
+      module ChefStyle
+        # Checks for incorrectly formatted copyright comments.
+        #
+        # @example
+        #
+        #   # bad (assuming current year is 2019)
+        #   Copyright:: 2013-2019 Opscode, Inc.
+        #   Copyright:: 2013-2019 Chef Inc.
+        #   Copyright:: 2013-2019 Chef Software Inc.
+        #   Copyright:: 2009-2010 2013-2019 Chef Software Inc.
+        #   Copyright:: Chef Software Inc.
+        #   Copyright:: Tim Smith
+        #   Copyright:: Copyright (c) 2015-2019 Chef Software, Inc.
+        #
+        #   # good (assuming current year is 2019)
+        #   Copyright:: 2013-2019 Chef Software, Inc.
+        #   Copyright:: 2013-2019 Tim Smith
+        #   Copyright:: 2019 37Signals, Inc.
+        #
+        class CopyrightCommentFormat < Cop
+          require 'date'
+
+          MSG = 'Properly format copyrights header comments'.freeze
+
+          def investigate(processed_source)
+            return unless processed_source.ast
+
+            processed_source.comments.each do |comment|
+              next unless comment.inline? # headers aren't in blocks
+
+              if invalid_copyright_comment?(comment)
+                add_offense(comment, location: comment.loc.expression, message: MSG, severity: :refactor)
+              end
             end
           end
-        end
 
-        def autocorrect(comment)
-          correct_comment = "# Copyright:: #{copyright_date_range(comment)}, #{copyright_holder(comment)}"
-          ->(corrector) { corrector.replace(comment.loc.expression, correct_comment) }
-        end
+          def autocorrect(comment)
+            correct_comment = "# Copyright:: #{copyright_date_range(comment)}, #{copyright_holder(comment)}"
+            ->(corrector) { corrector.replace(comment.loc.expression, correct_comment) }
+          end
 
-        private
+          private
 
-        def copyright_date_range(comment)
-          dates = comment.text.scan(/([0-9]{4})/)
+          def copyright_date_range(comment)
+            dates = comment.text.scan(/([0-9]{4})/)
 
-          # no copyright year present so return this year
-          return Time.new.year if dates.empty?
+            # no copyright year present so return this year
+            return Time.new.year if dates.empty?
 
-          oldest_date = dates.min[0].to_i
+            oldest_date = dates.min[0].to_i
 
-          # Avoid returning THIS_YEAR - THIS_YEAR
-          if oldest_date == Time.new.year
-            oldest_date
-          else
-            "#{oldest_date}-#{Time.new.year}"
+            # Avoid returning THIS_YEAR - THIS_YEAR
+            if oldest_date == Time.new.year
+              oldest_date
+            else
+              "#{oldest_date}-#{Time.new.year}"
+            end
           end
-        end
 
-        def copyright_holder(comment)
-          # Grab just the company / individual name w/o :: or dates
-          match = /(?:.*[0-9]{4}|Copyright\W*)(?:,)?(?:\s)?(.*)/.match(comment.text)
-          marketing_sanitizer(match.captures[0])
-        end
+          def copyright_holder(comment)
+            # Grab just the company / individual name w/o :: or dates
+            match = /(?:.*[0-9]{4}|Copyright\W*)(?:,)?(?:\s)?(.*)/.match(comment.text)
+            marketing_sanitizer(match.captures[0])
+          end
 
-        # Flush Opscode down the memory hole and Chef Inc is not a company
-        def marketing_sanitizer(name)
-          name.gsub('Opscode', 'Chef Software').gsub(/Chef(?:,)? Inc.*/, 'Chef Software, Inc.')
-        end
+          # Flush Opscode down the memory hole and Chef Inc is not a company
+          def marketing_sanitizer(name)
+            name.gsub('Opscode', 'Chef Software').gsub(/Chef(?:,)? Inc.*/, 'Chef Software, Inc.')
+          end
 
-        def invalid_copyright_comment?(comment)
-          match = /# (?:Copyright\W*)(.*)/.match(comment.text)
-          return false unless match # it's not even a copyright
+          def invalid_copyright_comment?(comment)
+            match = /# (?:Copyright\W*)(.*)/.match(comment.text)
+            return false unless match # it's not even a copyright
 
-          current_text = match.captures[0]
-          desired_text = "#{copyright_date_range(comment)}, #{copyright_holder(comment)}"
+            current_text = match.captures[0]
+            desired_text = "#{copyright_date_range(comment)}, #{copyright_holder(comment)}"
 
-          return true unless current_text == desired_text
+            return true unless current_text == desired_text
+          end
         end
       end
     end

data/lib/rubocop/cop/chef/style/comments_format.rb

@@ -1,5 +1,6 @@
 #
-# Copyright:: 2016, Tim Smith
+# Copyright:: 2016-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.
@@ -17,59 +18,61 @@
 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

data/lib/rubocop/cop/chef/style/file_mode.rb

@@ -17,43 +17,45 @@
 module RuboCop
   module Cop
     module Chef
-      # Check the file modes are given as strings instead of integers.
-      #
-      # @example
-      #
-      #   # bad
-      #   mode 644
-      #   mode 0644
-      #
-      #   # good
-      #   mode '644'
-      #
-      class FileMode < Cop
-        MSG = 'Use strings for file modes'.freeze
+      module ChefStyle
+        # Check the file modes are given as strings instead of integers.
+        #
+        # @example
+        #
+        #   # bad
+        #   mode 644
+        #   mode 0644
+        #
+        #   # good
+        #   mode '644'
+        #
+        class FileMode < Cop
+          MSG = 'Use strings for file modes'.freeze
 
-        def_node_matcher :resource_mode?, <<-PATTERN
-          (send nil? :mode $int)
-        PATTERN
+          def_node_matcher :resource_mode?, <<-PATTERN
+            (send nil? :mode $int)
+          PATTERN
 
-        def on_send(node)
-          resource_mode?(node) do |mode_int|
-            add_offense(mode_int, location: :expression, message: MSG, severity: :refactor)
+          def on_send(node)
+            resource_mode?(node) do |mode_int|
+              add_offense(mode_int, location: :expression, message: MSG, severity: :refactor)
+            end
           end
-        end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            # If it was an octal literal, make sure we write out the right number.
-            replacement_base = octal?(node) ? 8 : 10
-            replacement_mode = node.children.first.to_s(replacement_base)
-            corrector.replace(node.loc.expression, replacement_mode.inspect)
+          def autocorrect(node)
+            lambda do |corrector|
+              # If it was an octal literal, make sure we write out the right number.
+              replacement_base = octal?(node) ? 8 : 10
+              replacement_mode = node.children.first.to_s(replacement_base)
+              corrector.replace(node.loc.expression, replacement_mode.inspect)
+            end
           end
-        end
 
-        private
+          private
 
-        def octal?(node)
-          node.source =~ /^0o?\d+/i
+          def octal?(node)
+            node.source =~ /^0o?\d+/i
+          end
         end
       end
     end