cookstyle 7.32.8 → 8.0.0

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

@@ -1,50 +1,50 @@
-# 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
-        # Every Chef Infra resource already includes a sensitive property with a default value of false.
-        #
-        # @example
-        #
-        # ### incorrect
-        # property :sensitive, [true, false], default: false
-        #
-        class SensitivePropertyInResource < Base
-          extend AutoCorrector
-
-          MSG = 'Every Chef Infra resource already includes a sensitive property with a default value of false.'
-          RESTRICT_ON_SEND = [:property, :attribute].freeze
-
-          def_node_matcher :sensitive_property?, <<-PATTERN
-            (send nil? {:property :attribute} (sym :sensitive) ... (hash (pair (sym :default) (false))))
-          PATTERN
-
-          def on_send(node)
-            return unless sensitive_property?(node)
-
-            add_offense(node, severity: :refactor) do |corrector|
-              corrector.remove(node.source_range)
-            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
+        # Every Chef Infra resource already includes a sensitive property with a default value of false.
+        #
+        # @example
+        #
+        # ### incorrect
+        # property :sensitive, [true, false], default: false
+        #
+        class SensitivePropertyInResource < Base
+          extend AutoCorrector
+
+          MSG = 'Every Chef Infra resource already includes a sensitive property with a default value of false.'
+          RESTRICT_ON_SEND = [:property, :attribute].freeze
+
+          def_node_matcher :sensitive_property?, <<-PATTERN
+            (send nil? {:property :attribute} (sym :sensitive) ... (hash (pair (sym :default) (false))))
+          PATTERN
+
+          def on_send(node)
+            return unless sensitive_property?(node)
+
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.remove(node.source_range)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,64 +1,64 @@
-# 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
-        # Properties have a nil value by default so there is no need to set the default value to nil.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   property :config_file, String, default: nil
-        #   property :config_file, [String, NilClass], default: nil
-        #
-        #   ### correct
-        #   property :config_file, String
-        #   property :config_file, [String, NilClass]
-        #
-        class StringPropertyWithNilDefault < Base
-          include RangeHelp
-          extend AutoCorrector
-
-          MSG = 'Properties have a nil value by default so there is no need to set the default value to nil.'
-          RESTRICT_ON_SEND = [:property].freeze
-
-          def_node_matcher :string_property_with_nil_default?, <<-PATTERN
-            (send nil? :property (sym _)
-            {(const nil? :String) #string_and_nil_like?}
-            (hash <$(pair (sym :default) (nil)) ...>))
-          PATTERN
-
-          # An array of types that includes String & either NilClass or nil
-          def_node_matcher :string_and_nil_like?, <<-PATTERN
-            (array <(const nil? :String) {(const nil? :NilClass) (nil)}>)
-          PATTERN
-
-          def on_send(node)
-            string_property_with_nil_default?(node) do |nil_default|
-              add_offense(nil_default, severity: :refactor) do |corrector|
-                range = range_with_surrounding_comma(range_with_surrounding_space(range: nil_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
+        # Properties have a nil value by default so there is no need to set the default value to nil.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   property :config_file, String, default: nil
+        #   property :config_file, [String, NilClass], default: nil
+        #
+        #   ### correct
+        #   property :config_file, String
+        #   property :config_file, [String, NilClass]
+        #
+        class StringPropertyWithNilDefault < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'Properties have a nil value by default so there is no need to set the default value to nil.'
+          RESTRICT_ON_SEND = [:property].freeze
+
+          def_node_matcher :string_property_with_nil_default?, <<-PATTERN
+            (send nil? :property (sym _)
+            {(const nil? :String) #string_and_nil_like?}
+            (hash <$(pair (sym :default) (nil)) ...>))
+          PATTERN
+
+          # An array of types that includes String & either NilClass or nil
+          def_node_matcher :string_and_nil_like?, <<-PATTERN
+            (array <(const nil? :String) {(const nil? :NilClass) (nil)}>)
+          PATTERN
+
+          def on_send(node)
+            string_property_with_nil_default?(node) do |nil_default|
+              add_offense(nil_default, severity: :refactor) do |corrector|
+                range = range_with_surrounding_comma(range_with_surrounding_space(range: nil_default.loc.expression, side: :left), :left)
+                corrector.remove(range)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/redundant/suggests_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 suggests metadata.rb method is not used and is unnecessary in cookbooks.
-        #
-        # @example
-        #
-        #   ### incorrect in metadata.rb:
-        #
-        #   suggests "another_cookbook"
-        #
-        class SuggestsMetadata < Base
-          include RangeHelp
-          extend AutoCorrector
-
-          MSG = 'The suggests metadata.rb method is not used and is unnecessary in cookbooks.'
-          RESTRICT_ON_SEND = [:suggests].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 suggests metadata.rb method is not used and is unnecessary in cookbooks.
+        #
+        # @example
+        #
+        #   ### incorrect in metadata.rb:
+        #
+        #   suggests "another_cookbook"
+        #
+        class SuggestsMetadata < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'The suggests metadata.rb method is not used and is unnecessary in cookbooks.'
+          RESTRICT_ON_SEND = [:suggests].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/unnecessary_desired_state.rb

@@ -1,60 +1,60 @@
-# 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
-        # There is no need to set a property/attribute to desired_state: true as all properties/attributes have a desired_state of true by default.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   property :foo, String, desired_state: true
-        #   attribute :foo, String, desired_state: true
-        #
-        #   ### correct
-        #   property :foo, String
-        #   attribute :foo, String
-        #
-        class UnnecessaryDesiredState < Base
-          include RangeHelp
-          extend AutoCorrector
-
-          MSG = 'There is no need to set a property to desired_state: true as all properties have a desired_state of true by default.'
-          RESTRICT_ON_SEND = [:property, :attribute].freeze
-
-          def_node_matcher :property?, <<-PATTERN
-            (send nil? {:property :attribute} (sym _) ... $(hash ...))
-          PATTERN
-
-          def on_send(node)
-            property?(node) do |hash_vals|
-              hash_vals.each_pair do |k, v|
-                next unless k == s(:sym, :desired_state) && v == s(:true) # cookstyle: disable Lint/BooleanSymbol
-                add_offense(v.parent, severity: :refactor) do |corrector|
-                  range = range_with_surrounding_comma(range_with_surrounding_space(range: v.parent.loc.expression, side: :left), :left)
-                  corrector.remove(range)
-                end
-              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
+        # There is no need to set a property/attribute to desired_state: true as all properties/attributes have a desired_state of true by default.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   property :foo, String, desired_state: true
+        #   attribute :foo, String, desired_state: true
+        #
+        #   ### correct
+        #   property :foo, String
+        #   attribute :foo, String
+        #
+        class UnnecessaryDesiredState < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = 'There is no need to set a property to desired_state: true as all properties have a desired_state of true by default.'
+          RESTRICT_ON_SEND = [:property, :attribute].freeze
+
+          def_node_matcher :property?, <<-PATTERN
+            (send nil? {:property :attribute} (sym _) ... $(hash ...))
+          PATTERN
+
+          def on_send(node)
+            property?(node) do |hash_vals|
+              hash_vals.each_pair do |k, v|
+                next unless k == s(:sym, :desired_state) && v == s(:true) # rubocop: disable Lint/BooleanSymbol
+                add_offense(v.parent, severity: :refactor) do |corrector|
+                  range = range_with_surrounding_comma(range_with_surrounding_space(range: v.parent.loc.expression, side: :left), :left)
+                  corrector.remove(range)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,67 +1,67 @@
-# 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
-        # There is no need to define a property or attribute named :name in a resource as Chef Infra defines this on all resources by default.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   property :name, String
-        #   property :name, String, name_property: true
-        #   attribute :name, kind_of: String
-        #   attribute :name, kind_of: String, name_attribute: true
-        #   attribute :name, name_attribute: true, kind_of: String
-        #
-        class UnnecessaryNameProperty < Base
-          extend AutoCorrector
-
-          MSG = 'There is no need to define a property or attribute named :name in a resource as Chef Infra defines this on all resources by default.'
-          RESTRICT_ON_SEND = [:property, :attribute].freeze
-
-          def_node_matcher :name_property?, <<-PATTERN
-          (send nil? {:attribute :property}
-            (sym :name)
-            (const nil? :String)?
-            (hash $...)?
-          )
-          PATTERN
-
-          def on_send(node)
-            name_property?(node) do |hash_vals|
-              # It's perfectly valid to redefine the name property if you give it non-default values
-              # We do this in a few of our core resources where we give it a default value of "" for nameless resources
-              # If there are hash vals in this attribute/property compare them with the default keys and if there's anything
-              # else return so we don't alert
-              unless hash_vals.empty?
-                hash_keys = hash_vals.first.map { |x| x.key.value }
-                return unless (hash_keys - [:kind_of, :name_attribute, :name_property]).empty?
-              end
-
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.remove(node.source_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
+        # There is no need to define a property or attribute named :name in a resource as Chef Infra defines this on all resources by default.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   property :name, String
+        #   property :name, String, name_property: true
+        #   attribute :name, kind_of: String
+        #   attribute :name, kind_of: String, name_attribute: true
+        #   attribute :name, name_attribute: true, kind_of: String
+        #
+        class UnnecessaryNameProperty < Base
+          extend AutoCorrector
+
+          MSG = 'There is no need to define a property or attribute named :name in a resource as Chef Infra defines this on all resources by default.'
+          RESTRICT_ON_SEND = [:property, :attribute].freeze
+
+          def_node_matcher :name_property?, <<-PATTERN
+          (send nil? {:attribute :property}
+            (sym :name)
+            (const nil? :String)?
+            (hash $...)?
+          )
+          PATTERN
+
+          def on_send(node)
+            name_property?(node) do |hash_vals|
+              # It's perfectly valid to redefine the name property if you give it non-default values
+              # We do this in a few of our core resources where we give it a default value of "" for nameless resources
+              # If there are hash vals in this attribute/property compare them with the default keys and if there's anything
+              # else return so we don't alert
+              unless hash_vals.empty?
+                hash_keys = hash_vals.first.map { |x| x.key.value }
+                return unless (hash_keys - [:kind_of, :name_attribute, :name_property]).empty?
+              end
+
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.remove(node.source_range)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end