cookstyle 7.32.8 → 8.1.1

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

@@ -1,59 +1,59 @@
-# frozen_string_literal: true
-#
-# Copyright:: 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
-        # When a property has a type of String it can accept any string. There is no need to also validate string inputs against a regex that accept all values.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   property :config_file, String, regex: /.*/
-        #   attribute :config_file, String, regex: /.*/
-        #
-        #   ### correct
-        #   property :config_file, String
-        #   attribute :config_file, String
-        #
-        class PropertySplatRegex < Base
-          include RangeHelp
-          extend AutoCorrector
-
-          MSG = 'There is no need to validate the input of properties in resources using a regex value that will always pass.'
-          RESTRICT_ON_SEND = [:property, :attribute].freeze
-
-          def_node_matcher :property_with_regex_splat?, <<-PATTERN
-            (send nil? {:property :attribute} (sym _) ... (hash <$(pair (sym :regex) (regexp (str ".*") (regopt))) ...>))
-          PATTERN
-
-          def on_send(node)
-            property_with_regex_splat?(node) do |splat|
-              add_offense(splat, severity: :refactor) do |corrector|
-                range = range_with_surrounding_comma(
-                  range_with_surrounding_space(
-                    range: splat.loc.expression, side: :left), :left)
-                corrector.remove(range)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 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
+        # When a property has a type of String it can accept any string. There is no need to also validate string inputs against a regex that accept all values.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   property :config_file, String, regex: /.*/
+        #   attribute :config_file, String, regex: /.*/
+        #
+        #   ### correct
+        #   property :config_file, String
+        #   attribute :config_file, String
+        #
+        class PropertySplatRegex < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'There is no need to validate the input of properties in resources using a regex value that will always pass.'
+          RESTRICT_ON_SEND = [:property, :attribute].freeze
+
+          def_node_matcher :property_with_regex_splat?, <<-PATTERN
+            (send nil? {:property :attribute} (sym _) ... (hash <$(pair (sym :regex) (regexp (str ".*") (regopt))) ...>))
+          PATTERN
+
+          def on_send(node)
+            property_with_regex_splat?(node) do |splat|
+              add_offense(splat, severity: :refactor) do |corrector|
+                range = range_with_surrounding_comma(
+                  range_with_surrounding_space(
+                    range: splat.loc.expression, side: :left), :left)
+                corrector.remove(range)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,61 +1,61 @@
-# frozen_string_literal: true
-#
-# Copyright:: Copyright 2019-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
-        # When using properties in a custom resource you shouldn't set a property to
-        # required and then provide a default value. If a property is required the
-        # user will always pass in a value and the default will never be used. In Chef
-        # Infra Client 13+ this became an error.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   property :bob, String, required: true, default: 'foo'
-        #
-        #   ### correct
-        #   property :bob, String, required: true
-        #
-        class PropertyWithRequiredAndDefault < Base
-          include RangeHelp
-          extend AutoCorrector
-
-          MSG = 'Resource properties should not be both required and have a default value. This will fail on Chef Infra Client 13+'
-          RESTRICT_ON_SEND = [:property, :attribute].freeze
-
-          # match on a property or attribute that has any name and any type and a hash that
-          # contains default: true and required: true. These are wrapped in <> which means
-          # the order doesn't matter in the hash.
-          def_node_matcher :required_and_default?, <<-PATTERN
-            (send nil? {:property :attribute} (sym _) ... (hash <$(pair (sym :default) ...) (pair (sym :required) true) ...>))
-          PATTERN
-
-          def on_send(node)
-            required_and_default?(node) do |default|
-              add_offense(node, severity: :refactor) do |corrector|
-                range = range_with_surrounding_comma(range_with_surrounding_space(range: default.loc.expression, side: :left), :left)
-                corrector.remove(range)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: Copyright 2019-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
+        # When using properties in a custom resource you shouldn't set a property to
+        # required and then provide a default value. If a property is required the
+        # user will always pass in a value and the default will never be used. In Chef
+        # Infra Client 13+ this became an error.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   property :bob, String, required: true, default: 'foo'
+        #
+        #   ### correct
+        #   property :bob, String, required: true
+        #
+        class PropertyWithRequiredAndDefault < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'Resource properties should not be both required and have a default value. This will fail on Chef Infra Client 13+'
+          RESTRICT_ON_SEND = [:property, :attribute].freeze
+
+          # match on a property or attribute that has any name and any type and a hash that
+          # contains default: true and required: true. These are wrapped in <> which means
+          # the order doesn't matter in the hash.
+          def_node_matcher :required_and_default?, <<-PATTERN
+            (send nil? {:property :attribute} (sym _) ... (hash <$(pair (sym :default) ...) (pair (sym :required) true) ...>))
+          PATTERN
+
+          def on_send(node)
+            required_and_default?(node) do |default|
+              add_offense(node, severity: :refactor) do |corrector|
+                range = range_with_surrounding_comma(range_with_surrounding_space(range: default.loc.expression, side: :left), :left)
+                corrector.remove(range)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/redundant/provides_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 provides metadata.rb method is not used and is unnecessary in cookbooks.
-        #
-        # @example
-        #
-        #   ### incorrect in metadata.rb:
-        #
-        #   provides "some_thing"
-        #
-        class ProvidesMetadata < Base
-          include RangeHelp
-          extend AutoCorrector
-
-          MSG = 'The provides metadata.rb method is not used and is unnecessary in cookbooks.'
-          RESTRICT_ON_SEND = [:provides].freeze
-
-          def on_send(node)
-            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
+        # The provides metadata.rb method is not used and is unnecessary in cookbooks.
+        #
+        # @example
+        #
+        #   ### incorrect in metadata.rb:
+        #
+        #   provides "some_thing"
+        #
+        class ProvidesMetadata < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'The provides metadata.rb method is not used and is unnecessary in cookbooks.'
+          RESTRICT_ON_SEND = [:provides].freeze
+
+          def on_send(node)
+            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/recipe_metadata.rb

@@ -1,47 +1,47 @@
-# 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 recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   recipe 'openldap::default', 'Install and configure OpenLDAP'
-        #
-        #
-        class RecipeMetadata < Base
-          include RangeHelp
-          include RuboCop::Chef::AutocorrectHelpers
-          extend AutoCorrector
-
-          MSG = "The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead."
-          RESTRICT_ON_SEND = [:recipe].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 recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   recipe 'openldap::default', 'Install and configure OpenLDAP'
+        #
+        #
+        class RecipeMetadata < Base
+          include RangeHelp
+          include RuboCop::Chef::AutocorrectHelpers
+          extend AutoCorrector
+
+          MSG = "The recipe metadata.rb method is not used and is unnecessary in cookbooks. Recipes should be documented in the cookbook's README.md file instead."
+          RESTRICT_ON_SEND = [:recipe].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/replaces_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 replaces metadata.rb method is not used and is unnecessary in cookbooks. Replacements for existing cookbooks should be documented in the cookbook's README.md file instead.
-        #
-        # @example
-        #
-        #   ### incorrect in metadata.rb:
-        #
-        #   replaces "another_cookbook"
-        #
-        class ReplacesMetadata < Base
-          include RangeHelp
-          extend AutoCorrector
-
-          MSG = 'The replaces metadata.rb method is not used and is unnecessary in cookbooks.'
-          RESTRICT_ON_SEND = [:replaces].freeze
-
-          def on_send(node)
-            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
+        # The replaces metadata.rb method is not used and is unnecessary in cookbooks. Replacements for existing cookbooks should be documented in the cookbook's README.md file instead.
+        #
+        # @example
+        #
+        #   ### incorrect in metadata.rb:
+        #
+        #   replaces "another_cookbook"
+        #
+        class ReplacesMetadata < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'The replaces metadata.rb method is not used and is unnecessary in cookbooks.'
+          RESTRICT_ON_SEND = [:replaces].freeze
+
+          def on_send(node)
+            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/resource_with_nothing_action.rb

@@ -1,52 +1,52 @@
-# frozen_string_literal: true
-#
-# Copyright:: 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
-        # Chef Infra Client provides the :nothing action by default for every resource. There is no need to define a :nothing action in your resource code.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   action :nothing
-        #     # let's do nothing
-        #   end
-        #
-        class ResourceWithNothingAction < Base
-          include RangeHelp
-          extend AutoCorrector
-
-          MSG = 'There is no need to define a :nothing action in your resource as Chef Infra Client provides the :nothing action by default for every resource.'
-
-          def_node_matcher :nothing_action?, <<-PATTERN
-            (block (send nil? :action (sym :nothing)) (args) ... )
-          PATTERN
-
-          def on_block(node)
-            nothing_action?(node) do
-              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
-end
+# frozen_string_literal: true
+#
+# Copyright:: 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
+        # Chef Infra Client provides the :nothing action by default for every resource. There is no need to define a :nothing action in your resource code.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   action :nothing
+        #     # let's do nothing
+        #   end
+        #
+        class ResourceWithNothingAction < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'There is no need to define a :nothing action in your resource as Chef Infra Client provides the :nothing action by default for every resource.'
+
+          def_node_matcher :nothing_action?, <<-PATTERN
+            (block (send nil? :action (sym :nothing)) (args) ... )
+          PATTERN
+
+          def on_block(node)
+            nothing_action?(node) do
+              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
+end