cookstyle 7.32.8 → 8.0.0

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

@@ -1,46 +1,46 @@
-# frozen_string_literal: true
-#
-# 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
-        # The grouping metadata.rb method is not used and is unnecessary in cookbooks.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   grouping 'windows_log_rotate', title: 'Demonstration cookbook with code to switch loggers'
-        #
-        class GroupingMetadata < Base
-          include RangeHelp
-          include RuboCop::Chef::AutocorrectHelpers
-          extend AutoCorrector
-
-          MSG = 'The grouping metadata.rb method is not used and is unnecessary in cookbooks.'
-          RESTRICT_ON_SEND = [:grouping].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-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
+        # The grouping metadata.rb method is not used and is unnecessary in cookbooks.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   grouping 'windows_log_rotate', title: 'Demonstration cookbook with code to switch loggers'
+        #
+        class GroupingMetadata < Base
+          include RangeHelp
+          include RuboCop::Chef::AutocorrectHelpers
+          extend AutoCorrector
+
+          MSG = 'The grouping metadata.rb method is not used and is unnecessary in cookbooks.'
+          RESTRICT_ON_SEND = [:grouping].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/long_description_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 long_description metadata.rb method is not used and is unnecessary in cookbooks.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   long_description 'this is my cookbook and this description will never be seen'
-        #
-        class LongDescriptionMetadata < Base
-          include RangeHelp
-          include RuboCop::Chef::AutocorrectHelpers
-          extend AutoCorrector
-
-          MSG = 'The long_description metadata.rb method is not used and is unnecessary in cookbooks.'
-          RESTRICT_ON_SEND = [:long_description].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 long_description metadata.rb method is not used and is unnecessary in cookbooks.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   long_description 'this is my cookbook and this description will never be seen'
+        #
+        class LongDescriptionMetadata < Base
+          include RangeHelp
+          include RuboCop::Chef::AutocorrectHelpers
+          extend AutoCorrector
+
+          MSG = 'The long_description metadata.rb method is not used and is unnecessary in cookbooks.'
+          RESTRICT_ON_SEND = [:long_description].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/multiple_platform_checks.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 RedundantCode
-        # You can pass multiple values to the platform? and platform_family? helpers instead of calling the helpers multiple times.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   platform?('redhat') || platform?('ubuntu')
-        #   platform_family?('debian') || platform_family?('rhel')
-        #
-        #   ### correct
-        #   platform?('redhat', 'ubuntu')
-        #   platform_family?('debian', 'rhel')
-        #
-        class MultiplePlatformChecks < Base
-          extend AutoCorrector
-
-          MSG = 'You can pass multiple values to the platform? and platform_family? helpers instead of calling the helpers multiple times.'
-
-          def_node_matcher :or_platform_helpers?, <<-PATTERN
-            (or (send nil? ${:platform? :platform_family?} $_ )* )
-          PATTERN
-
-          def on_or(node)
-            or_platform_helpers?(node) do |helpers, plats|
-              # if the helper types were the same it's an offense, but platform_family?('rhel') || platform?('ubuntu') is legit
-              return unless helpers.uniq.size == 1
-
-              add_offense(node, severity: :refactor) do |corrector|
-                new_string = "#{helpers.first}(#{plats.map(&:source).join(', ')})"
-                corrector.replace(node, new_string)
-              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
+        # You can pass multiple values to the platform? and platform_family? helpers instead of calling the helpers multiple times.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   platform?('redhat') || platform?('ubuntu')
+        #   platform_family?('debian') || platform_family?('rhel')
+        #
+        #   ### correct
+        #   platform?('redhat', 'ubuntu')
+        #   platform_family?('debian', 'rhel')
+        #
+        class MultiplePlatformChecks < Base
+          extend AutoCorrector
+
+          MSG = 'You can pass multiple values to the platform? and platform_family? helpers instead of calling the helpers multiple times.'
+
+          def_node_matcher :or_platform_helpers?, <<-PATTERN
+            (or (send nil? ${:platform? :platform_family?} $_ )* )
+          PATTERN
+
+          def on_or(node)
+            or_platform_helpers?(node) do |helpers, plats|
+              # if the helper types were the same it's an offense, but platform_family?('rhel') || platform?('ubuntu') is legit
+              return unless helpers.uniq.size == 1
+
+              add_offense(node, severity: :refactor) do |corrector|
+                new_string = "#{helpers.first}(#{plats.map(&:source).join(', ')})"
+                corrector.replace(node, new_string)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,81 +1,81 @@
-# 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
-        # be both required and a name_property. Name properties are a way to optionally
-        # override the name given to the resource block in cookbook code. In your resource
-        # code you use the name_property and if the user doesn't pass in anything to that
-        # property its value will be populated with resource block's name. This
-        # allows users to provide more friendly resource names for logging that give
-        # additional context on the change being made.
-        #
-        # How about a nice example! Here we have a resource called ntp_config that has a
-        # name_property of config_file. All throughout the code of this resource we'd
-        # use new_resource.config_file when referencing the path to the config.
-        #
-        # We can use a friendly name for the block and specific a value to config_file
-        # ntp_config 'Configure the main config file' do
-        #   config_file '/etc/ntp/ntp.conf'
-        #   action :create
-        # end
-        #
-        # We can also just set the config path as the resource block and Chef will
-        # make sure to pass this in as new_resource.config_file as well.
-        # ntp_config '/etc/ntp/ntp.conf' do
-        #   action :create
-        # end
-        #
-        # The core tenant of the name property feature is that these properties are optional
-        # and making them required effectively turns off the functionality provided by name
-        # properties. If the goal is to always require the user to pass the config_file property
-        # then it should just be made a required property and not a name_property.
-        #
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   property :config_file, String, required: true, name_property: true
-        #   attribute :config_file, String, required: true, name_attribute: true
-        #
-        #   ### correct
-        #   property :config_file, String, required: true
-        #
-        class NamePropertyIsRequired < Base
-          MSG = 'Resource properties marked as name properties should not also be required properties'
-          RESTRICT_ON_SEND = [:property, :attribute].freeze
-
-          # match on a property or attribute that has any name and any type and a hash that
-          # contains name_property: true and required: true. These are wrapped in <> which means
-          # the order doesn't matter in the hash.
-          def_node_matcher :name_property_and_required?, <<-PATTERN
-            (send nil? {:property :attribute} (sym _) ... (hash <(pair (sym {:name_property :name_attribute}) (true)) $(pair (sym :required) (true) ) ...>))
-          PATTERN
-
-          def on_send(node)
-            name_property_and_required?(node) do
-              add_offense(node, severity: :refactor)
-            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
+        # be both required and a name_property. Name properties are a way to optionally
+        # override the name given to the resource block in cookbook code. In your resource
+        # code you use the name_property and if the user doesn't pass in anything to that
+        # property its value will be populated with resource block's name. This
+        # allows users to provide more friendly resource names for logging that give
+        # additional context on the change being made.
+        #
+        # How about a nice example! Here we have a resource called ntp_config that has a
+        # name_property of config_file. All throughout the code of this resource we'd
+        # use new_resource.config_file when referencing the path to the config.
+        #
+        # We can use a friendly name for the block and specific a value to config_file
+        # ntp_config 'Configure the main config file' do
+        #   config_file '/etc/ntp/ntp.conf'
+        #   action :create
+        # end
+        #
+        # We can also just set the config path as the resource block and Chef will
+        # make sure to pass this in as new_resource.config_file as well.
+        # ntp_config '/etc/ntp/ntp.conf' do
+        #   action :create
+        # end
+        #
+        # The core tenant of the name property feature is that these properties are optional
+        # and making them required effectively turns off the functionality provided by name
+        # properties. If the goal is to always require the user to pass the config_file property
+        # then it should just be made a required property and not a name_property.
+        #
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   property :config_file, String, required: true, name_property: true
+        #   attribute :config_file, String, required: true, name_attribute: true
+        #
+        #   ### correct
+        #   property :config_file, String, required: true
+        #
+        class NamePropertyIsRequired < Base
+          MSG = 'Resource properties marked as name properties should not also be required properties'
+          RESTRICT_ON_SEND = [:property, :attribute].freeze
+
+          # match on a property or attribute that has any name and any type and a hash that
+          # contains name_property: true and required: true. These are wrapped in <> which means
+          # the order doesn't matter in the hash.
+          def_node_matcher :name_property_and_required?, <<-PATTERN
+            (send nil? {:property :attribute} (sym _) ... (hash <(pair (sym {:name_property :name_attribute}) (true)) $(pair (sym :required) (true) ) ...>))
+          PATTERN
+
+          def on_send(node)
+            name_property_and_required?(node) do
+              add_offense(node, severity: :refactor)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,65 +1,65 @@
-# 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
-        # Many Ohai node attributes are already strings and don't need to be cast to strings again
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   node['platform'].to_s
-        #   node['platform_family'].to_s
-        #   node['platform_version'].to_s
-        #   node['fqdn'].to_s
-        #   node['hostname'].to_s
-        #   node['os'].to_s
-        #   node['name'].to_s
-        #
-        #   ### correct
-        #   node['platform']
-        #   node['platform_family']
-        #   node['platform_version']
-        #   node['fqdn']
-        #   node['hostname']
-        #   node['os']
-        #   node['name']
-        #
-        class OhaiAttributeToString < Base
-          extend AutoCorrector
-
-          MSG = "This Ohai node attribute is already a string and doesn't need to be converted"
-          RESTRICT_ON_SEND = [:to_s].freeze
-
-          def_node_matcher :attribute_to_s?, <<-PATTERN
-            (send (send (send nil? :node) :[] $(str {"platform" "platform_family" "platform_version" "fqdn" "hostname" "os" "name"}) ) :to_s )
-          PATTERN
-
-          def on_send(node)
-            attribute_to_s?(node) do |method|
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.replace(node, "node['#{method.value}']")
-              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
+        # Many Ohai node attributes are already strings and don't need to be cast to strings again
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   node['platform'].to_s
+        #   node['platform_family'].to_s
+        #   node['platform_version'].to_s
+        #   node['fqdn'].to_s
+        #   node['hostname'].to_s
+        #   node['os'].to_s
+        #   node['name'].to_s
+        #
+        #   ### correct
+        #   node['platform']
+        #   node['platform_family']
+        #   node['platform_version']
+        #   node['fqdn']
+        #   node['hostname']
+        #   node['os']
+        #   node['name']
+        #
+        class OhaiAttributeToString < Base
+          extend AutoCorrector
+
+          MSG = "This Ohai node attribute is already a string and doesn't need to be converted"
+          RESTRICT_ON_SEND = [:to_s].freeze
+
+          def_node_matcher :attribute_to_s?, <<-PATTERN
+            (send (send (send nil? :node) :[] $(str {"platform" "platform_family" "platform_version" "fqdn" "hostname" "os" "name"}) ) :to_s )
+          PATTERN
+
+          def on_send(node)
+            attribute_to_s?(node) do |method|
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(node, "node['#{method.value}']")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end