cookstyle 7.32.8 → 8.0.0

data/lib/rubocop/cop/chef/redundant/apt_repository_notifies_apt_update.rb

@@ -1,60 +1,60 @@
-# 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 RedundantCode
-        # There is no need to notify an apt-get update when an apt_repository is created as this is done automatically by the apt_repository resource.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   apt_repository 'my repo' do
-        #     uri 'http://packages.example.com/debian'
-        #     components %w(stable main)
-        #     deb_src false
-        #     notifies :run, 'execute[apt-get update]', :immediately
-        #   end
-        #
-        #   ### correct
-        #   apt_repository 'my repo' do
-        #     uri 'http://packages.example.com/debian'
-        #     components %w(stable main)
-        #     deb_src false
-        #   end
-        #
-        class AptRepositoryNotifiesAptUpdate < Base
-          include RuboCop::Chef::CookbookHelpers
-          include RangeHelp
-          extend AutoCorrector
-
-          MSG = 'There is no need to notify an apt-get update when an apt_repository is created as this is done automatically by the apt_repository resource.'
-
-          def on_block(node)
-            match_property_in_resource?(:apt_repository, 'notifies', node) do |notifies|
-              return unless notifies.arguments[1] == s(:str, 'execute[apt-get update]')
-              add_offense(notifies, severity: :refactor) do |corrector|
-                corrector.remove(range_with_surrounding_space(range: notifies.loc.expression, side: :left))
-              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 RedundantCode
+        # There is no need to notify an apt-get update when an apt_repository is created as this is done automatically by the apt_repository resource.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   apt_repository 'my repo' do
+        #     uri 'http://packages.example.com/debian'
+        #     components %w(stable main)
+        #     deb_src false
+        #     notifies :run, 'execute[apt-get update]', :immediately
+        #   end
+        #
+        #   ### correct
+        #   apt_repository 'my repo' do
+        #     uri 'http://packages.example.com/debian'
+        #     components %w(stable main)
+        #     deb_src false
+        #   end
+        #
+        class AptRepositoryNotifiesAptUpdate < Base
+          include RuboCop::Chef::CookbookHelpers
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'There is no need to notify an apt-get update when an apt_repository is created as this is done automatically by the apt_repository resource.'
+
+          def on_block(node)
+            match_property_in_resource?(:apt_repository, 'notifies', node) do |notifies|
+              return unless notifies.arguments[1] == s(:str, 'execute[apt-get update]')
+              add_offense(notifies, severity: :refactor) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: notifies.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/redundant/attribute_metadata.rb

@@ -1,52 +1,52 @@
-# 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 RedundantCode
-        # The attribute metadata.rb method is not used and is unnecessary in cookbooks.
-        #
-        # @example
-        #
-        #   ### incorrect in metadata.rb:
-        #
-        #    attribute 'zookeeper_bridge/server',
-        #              display_name: 'zookeeper server',
-        #              description: 'Zookeeper server address.',
-        #              type: 'string',
-        #              required: 'optional',
-        #              default: '"127.0.0.1:2181"'
-        #
-        class AttributeMetadata < Base
-          include RangeHelp
-          include RuboCop::Chef::AutocorrectHelpers
-          extend AutoCorrector
-
-          MSG = 'The attribute metadata.rb method is not used and is unnecessary in cookbooks.'
-          RESTRICT_ON_SEND = [:attribute].freeze
-
-          def on_send(node)
-            add_offense(node, severity: :refactor) do |corrector|
-              corrector.remove(range_with_surrounding_space(range: expression_including_heredocs(node), side: :left))
-            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 RedundantCode
+        # The attribute metadata.rb method is not used and is unnecessary in cookbooks.
+        #
+        # @example
+        #
+        #   ### incorrect in metadata.rb:
+        #
+        #    attribute 'zookeeper_bridge/server',
+        #              display_name: 'zookeeper server',
+        #              description: 'Zookeeper server address.',
+        #              type: 'string',
+        #              required: 'optional',
+        #              default: '"127.0.0.1:2181"'
+        #
+        class AttributeMetadata < Base
+          include RangeHelp
+          include RuboCop::Chef::AutocorrectHelpers
+          extend AutoCorrector
+
+          MSG = 'The attribute metadata.rb method is not used and is unnecessary in cookbooks.'
+          RESTRICT_ON_SEND = [:attribute].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.remove(range_with_surrounding_space(range: expression_including_heredocs(node), side: :left))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/redundant/conflicts_metadata.rb

@@ -1,46 +1,46 @@
-# 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 RedundantCode
-        # The conflicts metadata.rb method is not used and is unnecessary in cookbooks.
-        #
-        # @example
-        #
-        #   ### incorrect in metadata.rb:
-        #
-        #   conflicts "another_cookbook"
-        #
-        class ConflictsMetadata < Base
-          include RangeHelp
-          extend AutoCorrector
-
-          MSG = 'The conflicts metadata.rb method is not used and is unnecessary in cookbooks.'
-          RESTRICT_ON_SEND = [:conflicts].freeze
-
-          def on_send(node)
-            add_offense(node, severity: :refactor) do |corrector|
-              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :right))
-            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 RedundantCode
+        # The conflicts metadata.rb method is not used and is unnecessary in cookbooks.
+        #
+        # @example
+        #
+        #   ### incorrect in metadata.rb:
+        #
+        #   conflicts "another_cookbook"
+        #
+        class ConflictsMetadata < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'The conflicts metadata.rb method is not used and is unnecessary in cookbooks.'
+          RESTRICT_ON_SEND = [:conflicts].freeze
+
+          def on_send(node)
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :right))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/redundant/custom_resource_with_allowed_actions.rb

@@ -1,60 +1,60 @@
-# 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 RedundantCode
-        # It is not necessary to set `actions` or `allowed_actions` in custom resources as Chef Infra Client determines these automatically from the set of all actions defined in the resource.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   allowed_actions [:create, :remove]
-        #
-        #   # also bad
-        #   actions [:create, :remove]
-        #
-        class CustomResourceWithAllowedActions < Base
-          include RangeHelp
-          extend AutoCorrector
-
-          MSG = 'It is not necessary to set `actions` or `allowed_actions` in custom resources as Chef Infra Client determines these automatically from the set of all actions defined in the resource'
-          RESTRICT_ON_SEND = [:allowed_actions, :actions].freeze
-
-          def_node_search :poise_require, '(send nil? :require (str "poise"))'
-
-          def_node_search :resource_actions?, <<-PATTERN
-            (block (send nil? :action ... ) ... )
-          PATTERN
-
-          def on_send(node)
-            # avoid triggering on things like new_resource.actions
-            return unless node.receiver.nil?
-
-            # if the resource requires poise then bail out since we're in a poise resource where @allowed_actions is legit
-            return if poise_require(processed_source.ast).any? || !resource_actions?(processed_source.ast)
-
-            add_offense(node, severity: :refactor) do |corrector|
-              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
-            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 RedundantCode
+        # It is not necessary to set `actions` or `allowed_actions` in custom resources as Chef Infra Client determines these automatically from the set of all actions defined in the resource.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   allowed_actions [:create, :remove]
+        #
+        #   # also bad
+        #   actions [:create, :remove]
+        #
+        class CustomResourceWithAllowedActions < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'It is not necessary to set `actions` or `allowed_actions` in custom resources as Chef Infra Client determines these automatically from the set of all actions defined in the resource'
+          RESTRICT_ON_SEND = [:allowed_actions, :actions].freeze
+
+          def_node_search :poise_require, '(send nil? :require (str "poise"))'
+
+          def_node_search :resource_actions?, <<-PATTERN
+            (block (send nil? :action ... ) ... )
+          PATTERN
+
+          def on_send(node)
+            # avoid triggering on things like new_resource.actions
+            return unless node.receiver.nil?
+
+            # if the resource requires poise then bail out since we're in a poise resource where @allowed_actions is legit
+            return if poise_require(processed_source.ast).any? || !resource_actions?(processed_source.ast)
+
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.remove(range_with_surrounding_space(range: node.loc.expression, side: :left))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/redundant/double_compile_time.rb

@@ -1,68 +1,68 @@
-# 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 RedundantCode
-        # If a resource includes the `compile_time` property there's no need to also use `.run_action(:some_action)` on the resource block
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   chef_gem 'deep_merge' do
-        #     action :nothing
-        #     compile_time true
-        #   end.run_action(:install)
-        #
-        #   ### correct
-        #   chef_gem 'deep_merge' do
-        #     action :install
-        #     compile_time true
-        #   end
-        #
-        class DoubleCompileTime < Base
-          extend RuboCop::Cop::AutoCorrector
-
-          MSG = "If a resource includes the `compile_time` property there's no need to also use `.run_action(:some_action)` on the resource block."
-          RESTRICT_ON_SEND = [:run_action].freeze
-
-          def_node_matcher :compile_time_and_run_action?, <<-PATTERN
-          (send
-            $(block
-              (send nil? ... )
-              (args)
-              (begin <
-                (send nil? :action (sym $_) )
-                (send nil? :compile_time (true) )
-                ...
-              >)
-            ) :run_action (sym $_) )
-          PATTERN
-
-          def on_send(node)
-            compile_time_and_run_action?(node) do |resource, action, run_action|
-              add_offense(node.loc.selector, severity: :refactor) do |corrector|
-                corrector.replace(node, resource.source.gsub(action.to_s, run_action.to_s))
-              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 RedundantCode
+        # If a resource includes the `compile_time` property there's no need to also use `.run_action(:some_action)` on the resource block
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   chef_gem 'deep_merge' do
+        #     action :nothing
+        #     compile_time true
+        #   end.run_action(:install)
+        #
+        #   ### correct
+        #   chef_gem 'deep_merge' do
+        #     action :install
+        #     compile_time true
+        #   end
+        #
+        class DoubleCompileTime < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          MSG = "If a resource includes the `compile_time` property there's no need to also use `.run_action(:some_action)` on the resource block."
+          RESTRICT_ON_SEND = [:run_action].freeze
+
+          def_node_matcher :compile_time_and_run_action?, <<-PATTERN
+          (send
+            $(block
+              (send nil? ... )
+              (args)
+              (begin <
+                (send nil? :action (sym $_) )
+                (send nil? :compile_time (true) )
+                ...
+              >)
+            ) :run_action (sym $_) )
+          PATTERN
+
+          def on_send(node)
+            compile_time_and_run_action?(node) do |resource, action, run_action|
+              add_offense(node.loc.selector, severity: :refactor) do |corrector|
+                corrector.replace(node, resource.source.gsub(action.to_s, run_action.to_s))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end