cookstyle 7.32.8 → 8.0.0

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

@@ -1,50 +1,50 @@
-# 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 default copyright comments from the chef generator cookbook command
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   Copyright:: 2019 YOUR_NAME
-        #   Copyright:: 2019 YOUR_COMPANY_NAME
-        #
-        #   ### correct
-        #   Copyright:: 2019 Tim Smith
-        #   Copyright:: 2019 Chef Software, Inc.
-        #
-        class DefaultCopyrightComments < Base
-          MSG = 'Cookbook copyright comment headers should be updated for a real person or organization.'
-
-          def on_new_investigation
-            return unless processed_source.ast
-
-            processed_source.comments.each do |comment|
-              next unless comment.inline? &&  # headers aren't in blocks
-                          /# (?:Copyright\W*).*YOUR_(NAME|COMPANY_NAME)/.match?(comment.text)
-              add_offense(comment, severity: :refactor)
-            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
+        # Checks for default copyright comments from the chef generator cookbook command
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   Copyright:: 2019 YOUR_NAME
+        #   Copyright:: 2019 YOUR_COMPANY_NAME
+        #
+        #   ### correct
+        #   Copyright:: 2019 Tim Smith
+        #   Copyright:: 2019 Chef Software, Inc.
+        #
+        class DefaultCopyrightComments < Base
+          MSG = 'Cookbook copyright comment headers should be updated for a real person or organization.'
+
+          def on_new_investigation
+            return unless processed_source.ast
+
+            processed_source.comments.each do |comment|
+              next unless comment.inline? && # headers aren't in blocks
+                          /# (?:Copyright\W*).*YOUR_(NAME|COMPANY_NAME)/.match?(comment.text)
+              add_offense(comment, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,71 +1,71 @@
-# 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 headers
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   Copyright 2013-2016 Chef Software, Inc.
-        #   Recipe default.rb
-        #   Attributes default.rb
-        #   License Apache2
-        #   Cookbook tomcat
-        #   Cookbook Name:: Tomcat
-        #   Attributes File:: default
-        #
-        #   ### correct
-        #   Copyright:: 2013-2016 Chef Software, Inc.
-        #   Recipe:: default.rb
-        #   Attributes:: default.rb
-        #   License:: Apache License, Version 2.0
-        #   Cookbook:: Tomcat
-        #
-        class CommentFormat < Base
-          extend AutoCorrector
-
-          MSG = 'Properly format header comments'
-          VERBOSE_COMMENT_REGEX = /^#\s*([A-Za-z]+)\s?(?:Name|File)?(?:::)?\s(.*)/.freeze
-          CHEF_LIKE_COMMENT_REGEX = /^#\s*(Author|Cookbook|Library|Attribute|Copyright|Recipe|Resource|Definition|License)\s+/.freeze
-
-          def on_new_investigation
-            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? && CHEF_LIKE_COMMENT_REGEX.match?(comment.text) # headers aren't in blocks
-
-              add_offense(comment, severity: :refactor) do |corrector|
-                # 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 = VERBOSE_COMMENT_REGEX.match(comment.text)
-                comment_type, value = match.captures
-                correct_comment = "# #{comment_type}:: #{value}"
-                corrector.replace(comment, correct_comment)
-              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
+        # Checks for incorrectly formatted headers
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   Copyright 2013-2016 Chef Software, Inc.
+        #   Recipe default.rb
+        #   Attributes default.rb
+        #   License Apache2
+        #   Cookbook tomcat
+        #   Cookbook Name:: Tomcat
+        #   Attributes File:: default
+        #
+        #   ### correct
+        #   Copyright:: 2013-2016 Chef Software, Inc.
+        #   Recipe:: default.rb
+        #   Attributes:: default.rb
+        #   License:: Apache License, Version 2.0
+        #   Cookbook:: Tomcat
+        #
+        class CommentFormat < Base
+          extend AutoCorrector
+
+          MSG = 'Properly format header comments'
+          VERBOSE_COMMENT_REGEX = /^#\s*([A-Za-z]+)\s?(?:Name|File)?(?:::)?\s(.*)/.freeze
+          CHEF_LIKE_COMMENT_REGEX = /^#\s*(Author|Cookbook|Library|Attribute|Copyright|Recipe|Resource|Definition|License)\s+/.freeze
+
+          def on_new_investigation
+            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? && CHEF_LIKE_COMMENT_REGEX.match?(comment.text) # headers aren't in blocks
+
+              add_offense(comment, severity: :refactor) do |corrector|
+                # 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 = VERBOSE_COMMENT_REGEX.match(comment.text)
+                comment_type, value = match.captures
+                correct_comment = "# #{comment_type}:: #{value}"
+                corrector.replace(comment, correct_comment)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,86 +1,86 @@
-# 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
-        # Use strings to represent file modes to avoid confusion between octal and base 10 integer formats.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   remote_directory '/etc/my.conf' do
-        #     content 'some content'
-        #     mode 0600
-        #     action :create
-        #   end
-        #
-        #   remote_directory 'handler' do
-        #     source 'handlers'
-        #     recursive true
-        #     files_mode 644
-        #     action :create
-        #   end
-        #
-        #   ### correct
-        #   remote_directory '/etc/my.conf' do
-        #     content 'some content'
-        #     mode '600'
-        #     action :create
-        #   end
-        #
-        #   remote_directory 'handler' do
-        #     source 'handlers'
-        #     recursive true
-        #     files_mode '644'
-        #     action :create
-        #   end
-        #
-        class FileMode < Base
-          extend RuboCop::Cop::AutoCorrector
-
-          MSG = 'Use strings to represent file modes to avoid confusion between octal and base 10 integer formats'
-          RESTRICT_ON_SEND = [:mode, :files_mode].freeze
-
-          def_node_matcher :resource_mode?, <<-PATTERN
-            (send nil? {:mode :files_mode} $int)
-          PATTERN
-
-          def on_send(node)
-            resource_mode?(node) do |mode_int|
-              add_offense(mode_int, severity: :refactor) do |corrector|
-                # If it was an octal literal, make sure we write out the right number.
-                replacement_base = octal?(mode_int) ? 8 : 10
-                replacement_mode = mode_int.children.first.to_s(replacement_base)
-
-                # we build our own escaped string instead of using .inspect because that way
-                # we can use single quotes instead of the double quotes that .inspect adds
-                corrector.replace(mode_int, "\'#{replacement_mode}\'")
-              end
-            end
-          end
-
-          private
-
-          def octal?(node)
-            node.source =~ /^0o?\d+/i
-          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
+        # Use strings to represent file modes to avoid confusion between octal and base 10 integer formats.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   remote_directory '/etc/my.conf' do
+        #     content 'some content'
+        #     mode 0600
+        #     action :create
+        #   end
+        #
+        #   remote_directory 'handler' do
+        #     source 'handlers'
+        #     recursive true
+        #     files_mode 644
+        #     action :create
+        #   end
+        #
+        #   ### correct
+        #   remote_directory '/etc/my.conf' do
+        #     content 'some content'
+        #     mode '600'
+        #     action :create
+        #   end
+        #
+        #   remote_directory 'handler' do
+        #     source 'handlers'
+        #     recursive true
+        #     files_mode '644'
+        #     action :create
+        #   end
+        #
+        class FileMode < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          MSG = 'Use strings to represent file modes to avoid confusion between octal and base 10 integer formats'
+          RESTRICT_ON_SEND = [:mode, :files_mode].freeze
+
+          def_node_matcher :resource_mode?, <<-PATTERN
+            (send nil? {:mode :files_mode} $int)
+          PATTERN
+
+          def on_send(node)
+            resource_mode?(node) do |mode_int|
+              add_offense(mode_int, severity: :refactor) do |corrector|
+                # If it was an octal literal, make sure we write out the right number.
+                replacement_base = octal?(mode_int) ? 8 : 10
+                replacement_mode = mode_int.children.first.to_s(replacement_base)
+
+                # we build our own escaped string instead of using .inspect because that way
+                # we can use single quotes instead of the double quotes that .inspect adds
+                corrector.replace(mode_int, "'#{replacement_mode}'")
+              end
+            end
+          end
+
+          private
+
+          def octal?(node)
+            node.source =~ /^0o?\d+/i
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,59 +1,59 @@
-# frozen_string_literal: true
-#
-# Copyright:: 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
-        # Use :immediately instead of :immediate for resource notification timing.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #
-        #   template '/etc/www/configures-apache.conf' do
-        #     notifies :restart, 'service[apache]', :immediate
-        #   end
-        #
-        #   ### correct
-        #
-        #   template '/etc/www/configures-apache.conf' do
-        #     notifies :restart, 'service[apache]', :immediately
-        #   end
-        #
-        class ImmediateNotificationTiming < Base
-          extend AutoCorrector
-
-          MSG = 'Use :immediately instead of :immediate for resource notification timing'
-          RESTRICT_ON_SEND = [:notifies, :subscribes].freeze
-
-          def_node_matcher :immediate_notify?, <<-PATTERN
-            (send nil? {:notifies :subscribes} (sym _) (...) $(sym :immediate))
-          PATTERN
-
-          def on_send(node)
-            immediate_notify?(node) do |timing|
-              add_offense(timing, severity: :refactor) do |corrector|
-                corrector.replace(timing, ':immediately')
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 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
+        # Use :immediately instead of :immediate for resource notification timing.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, 'service[apache]', :immediate
+        #   end
+        #
+        #   ### correct
+        #
+        #   template '/etc/www/configures-apache.conf' do
+        #     notifies :restart, 'service[apache]', :immediately
+        #   end
+        #
+        class ImmediateNotificationTiming < Base
+          extend AutoCorrector
+
+          MSG = 'Use :immediately instead of :immediate for resource notification timing'
+          RESTRICT_ON_SEND = [:notifies, :subscribes].freeze
+
+          def_node_matcher :immediate_notify?, <<-PATTERN
+            (send nil? {:notifies :subscribes} (sym _) (...) $(sym :immediate))
+          PATTERN
+
+          def on_send(node)
+            immediate_notify?(node) do |timing|
+              add_offense(timing, severity: :refactor) do |corrector|
+                corrector.replace(timing, ':immediately')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,58 +1,58 @@
-# 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
-        # There is no need to wrap the recipe in parentheses when using the include_recipe helper.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   include_recipe('foo::bar')
-        #
-        #   ### correct
-        #   include_recipe 'foo::bar'
-        #
-        class IncludeRecipeWithParentheses < Base
-          extend RuboCop::Cop::AutoCorrector
-
-          MSG = 'There is no need to wrap the recipe in parentheses when using the include_recipe helper'
-          RESTRICT_ON_SEND = [:include_recipe].freeze
-
-          def_node_matcher :include_recipe?, <<-PATTERN
-            (send nil? :include_recipe $(str _))
-          PATTERN
-
-          def on_send(node)
-            include_recipe?(node) do |recipe|
-              return unless node.parenthesized?
-
-              # avoid chefspec: expect(chef_run).to include_recipe('foo')
-              return if node.parent&.send_type?
-
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.replace(node, "include_recipe #{recipe.source}")
-              end
-            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
+        # There is no need to wrap the recipe in parentheses when using the include_recipe helper.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   include_recipe('foo::bar')
+        #
+        #   ### correct
+        #   include_recipe 'foo::bar'
+        #
+        class IncludeRecipeWithParentheses < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          MSG = 'There is no need to wrap the recipe in parentheses when using the include_recipe helper'
+          RESTRICT_ON_SEND = [:include_recipe].freeze
+
+          def_node_matcher :include_recipe?, <<-PATTERN
+            (send nil? :include_recipe $(str _))
+          PATTERN
+
+          def on_send(node)
+            include_recipe?(node) do |recipe|
+              return unless node.parenthesized?
+
+              # avoid chefspec: expect(chef_run).to include_recipe('foo')
+              return if node.parent&.send_type?
+
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, "include_recipe #{recipe.source}")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end