cookstyle 7.32.8 → 8.0.0

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

@@ -1,95 +1,94 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2016, Noah Kantrowitz
-#
-# 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 Style
-        # 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`
-        #
-        #   ### incorrect
-        #   node['foo']
-        #   node["foo"]
-        #
-        #   ### correct
-        #   node[:foo]
-        #
-        # @example when configuration is `EnforcedStyle: strings`
-        #
-        #   ### incorrect
-        #   node[:foo]
-        #
-        #   ### correct
-        #   node['foo']
-        #   node["foo"]
-        #
-        class AttributeKeys < Cop
-          include RuboCop::Cop::ConfigurableEnforcedStyle
-
-          MSG = 'Use %s to access node attributes'
-          RESTRICT_ON_SEND = [:[]].freeze
-
-          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 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.send_type? && 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])
-            end
-          end
-
-          def on_node_attribute_access(node)
-            if node.str_type?
-              style_detected(:strings)
-              add_offense(node, message: MSG % style, severity: :refactor) if style == :symbols
-            elsif node.sym_type?
-              style_detected(:symbols)
-              add_offense(node, message: MSG % style, severity: :refactor) if style == :strings
-            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, key_replacement)
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 2016, Noah Kantrowitz
+#
+# 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 Style
+        # 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`
+        #
+        #   ### incorrect
+        #   node['foo']
+        #   node["foo"]
+        #
+        #   ### correct
+        #   node[:foo]
+        #
+        # @example when configuration is `EnforcedStyle: strings`
+        #
+        #   ### incorrect
+        #   node[:foo]
+        #
+        #   ### correct
+        #   node['foo']
+        #   node["foo"]
+        #
+        class AttributeKeys < Base
+          extend AutoCorrector
+          include RuboCop::Cop::ConfigurableEnforcedStyle
+
+          MSG = 'Use %s to access node attributes'
+          RESTRICT_ON_SEND = [:[]].freeze
+
+          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 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.send_type? && 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])
+            end
+          end
+
+          def on_node_attribute_access(node)
+            if node.str_type?
+              style_detected(:strings)
+              if style == :symbols
+                add_offense(node, message: MSG % style, severity: :refactor) do |corrector|
+                  key_string = node.children.first.to_s
+                  corrector.replace(node, key_string.to_sym.inspect)
+                end
+              end
+            elsif node.sym_type?
+              style_detected(:symbols)
+              if style == :strings
+                add_offense(node, message: MSG % style, severity: :refactor) do |corrector|
+                  key_string = node.children.first.to_s
+                  corrector.replace(node, key_string.inspect)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,49 +1,49 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2020, Chef Software, Inc.
-# Author:: Tim Smith (<tsmith84@gmail.com>)
-#
-# 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 Style
-        # Checks for comments that mention "Chef" without context. Do you mean Chef Infra or Chef Software?
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   Chef makes software
-        #   Chef configures your systems
-        #
-        #   ### correct
-        #   Chef Software makes software
-        #   Chef Infra configures your systems
-        #
-        class ChefWhaaat < Cop
-          MSG = 'Do you mean Chef (the company) or a Chef product (e.g. Chef Infra, Chef InSpec, etc)?'
-
-          def on_new_investigation
-            return unless processed_source.ast
-
-            processed_source.comments.each do |comment|
-              next unless comment.text.match?(/Chef [a-z]/) # https://rubular.com/r/0YzfDAbwJrDHix
-              add_offense(comment, severity: :refactor)
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 2020, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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 Style
+        # Checks for comments that mention "Chef" without context. Do you mean Chef Infra or Chef Software?
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   Chef makes software
+        #   Chef configures your systems
+        #
+        #   ### correct
+        #   Chef Software makes software
+        #   Chef Infra configures your systems
+        #
+        class ChefWhaaat < Base
+          MSG = 'Do you mean Chef (the company) or a Chef product (e.g. Chef Infra, Chef InSpec, etc)?'
+
+          def on_new_investigation
+            return unless processed_source.ast
+
+            processed_source.comments.each do |comment|
+              next unless comment.text.match?(/Chef [a-z]/) # https://rubular.com/r/0YzfDAbwJrDHix
+              add_offense(comment, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,42 +1,42 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2016-2019, Chef Software, Inc.
-# Author:: Tim Smith (<tsmith84@gmail.com>)
-#
-# 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 Style
-        # Replaces double spaces between sentences with a single space.
-        # Note: This is DISABLED by default.
-        class CommentSentenceSpacing < Base
-          extend AutoCorrector
-          MSG = 'Use a single space after sentences in comments'
-
-          def on_new_investigation
-            return unless processed_source.ast
-
-            processed_source.comments.each do |comment|
-              next unless comment.text.match?(/(.|\?)\s{2}/) # https://rubular.com/r/8o3SiDrQMJSzuU
-              add_offense(comment, severity: :refactor) do |corrector|
-                corrector.replace(comment, comment.text.gsub('.  ', '. ').gsub('?  ', '? '))
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 2016-2019, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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 Style
+        # Replaces double spaces between sentences with a single space.
+        # Note: This is DISABLED by default.
+        class CommentSentenceSpacing < Base
+          extend AutoCorrector
+          MSG = 'Use a single space after sentences in comments'
+
+          def on_new_investigation
+            return unless processed_source.ast
+
+            processed_source.comments.each do |comment|
+              next unless comment.text.match?(/(.|\?)\s{2}/) # https://rubular.com/r/8o3SiDrQMJSzuU
+              add_offense(comment, severity: :refactor) do |corrector|
+                corrector.replace(comment, comment.text.gsub('.  ', '. ').gsub('?  ', '? '))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,101 +1,101 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2016-2019, Chef Software, Inc.
-# Author:: Tim Smith (<tsmith84@gmail.com>)
-#
-# 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 Style
-        # Checks for incorrectly formatted copyright comments.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   Copyright:: 2013-2022 Opscode, Inc.
-        #   Copyright:: 2013-2022 Chef Inc.
-        #   Copyright:: 2013-2022 Chef Software Inc.
-        #   Copyright:: 2009-2010 2013-2022 Chef Software Inc.
-        #   Copyright:: Chef Software Inc.
-        #   Copyright:: Tim Smith
-        #   Copyright:: Copyright (c) 2015-2022 Chef Software, Inc.
-        #
-        #   ### correct
-        #   Copyright:: 2013-2022 Chef Software, Inc.
-        #   Copyright:: 2013-2022 Tim Smith
-        #   Copyright:: 2019 37Signals, Inc.
-        #
-        class CopyrightCommentFormat < Base
-          extend AutoCorrector
-          require 'date'
-
-          MSG = 'Properly format copyrights header comments'
-
-          def on_new_investigation
-            return unless processed_source.ast
-
-            processed_source.comments.each do |comment|
-              next unless comment.inline? && invalid_copyright_comment?(comment) # headers aren't in blocks
-
-              add_offense(comment, severity: :refactor) do |corrector|
-                correct_comment = "# Copyright:: #{copyright_date_range(comment)}, #{copyright_holder(comment)}"
-                corrector.replace(comment, correct_comment)
-              end
-            end
-          end
-
-          private
-
-          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?
-
-            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}"
-            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
-
-          # 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
-
-            current_text = match.captures[0]
-            desired_text = "#{copyright_date_range(comment)}, #{copyright_holder(comment)}"
-
-            return true unless current_text == desired_text
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 2016-2019, Chef Software, Inc.
+# Author:: Tim Smith (<tsmith84@gmail.com>)
+#
+# 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 Style
+        # Checks for incorrectly formatted copyright comments.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   Copyright:: 2013-2022 Opscode, Inc.
+        #   Copyright:: 2013-2022 Chef Inc.
+        #   Copyright:: 2013-2022 Chef Software Inc.
+        #   Copyright:: 2009-2010 2013-2022 Chef Software Inc.
+        #   Copyright:: Chef Software Inc.
+        #   Copyright:: Tim Smith
+        #   Copyright:: Copyright (c) 2015-2022 Chef Software, Inc.
+        #
+        #   ### correct
+        #   Copyright:: 2013-2022 Chef Software, Inc.
+        #   Copyright:: 2013-2022 Tim Smith
+        #   Copyright:: 2019 37Signals, Inc.
+        #
+        class CopyrightCommentFormat < Base
+          extend AutoCorrector
+          require 'date'
+
+          MSG = 'Properly format copyrights header comments'
+
+          def on_new_investigation
+            return unless processed_source.ast
+
+            processed_source.comments.each do |comment|
+              next unless comment.inline? && invalid_copyright_comment?(comment) # headers aren't in blocks
+
+              add_offense(comment, severity: :refactor) do |corrector|
+                correct_comment = "# Copyright:: #{copyright_date_range(comment)}, #{copyright_holder(comment)}"
+                corrector.replace(comment, correct_comment)
+              end
+            end
+          end
+
+          private
+
+          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?
+
+            oldest_date = dates.min.first.to_i
+
+            # Avoid returning THIS_YEAR - THIS_YEAR
+            if oldest_date == Time.new.year
+              oldest_date
+            else
+              "#{oldest_date}-#{Time.new.year}"
+            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.first)
+          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
+
+            current_text = match.captures.first
+            desired_text = "#{copyright_date_range(comment)}, #{copyright_holder(comment)}"
+
+            true unless current_text == desired_text
+          end
+        end
+      end
+    end
+  end
+end