cookstyle 7.32.8 → 8.0.0

data/lib/rubocop/cop/chef/deprecation/node_methods_not_attributes.rb

@@ -1,80 +1,80 @@
-# 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 Deprecations
-        # Use node attributes to access data provided by Ohai instead of using node methods to access that data.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   node.fqdn
-        #   node.platform
-        #   node.platform_family
-        #   node.platform_version
-        #   node.hostname
-        #
-        #   ### correct
-        #   node['fqdn']
-        #   node['platform']
-        #   node['platform_family']
-        #   node['platform_version']
-        #   node['hostname']
-        #
-        class NodeMethodsInsteadofAttributes < Base
-          extend AutoCorrector
-
-          MSG = 'Use node attributes to access Ohai data instead of node methods, which were deprecated in Chef Infra Client 13.'
-          RESTRICT_ON_SEND = %i(
-            current_user
-            domain
-            fqdn
-            hostname
-            ip6address
-            ipaddress
-            macaddress
-            machinename
-            ohai_time
-            os
-            os_version
-            platform
-            platform_build
-            platform_family
-            platform_version
-            root_group
-            shard_seed
-            uptime
-            uptime_seconds).freeze
-
-          def_node_matcher :node_ohai_methods?, <<-PATTERN
-            (send (send nil? :node) _)
-          PATTERN
-
-          def on_send(node)
-            node_ohai_methods?(node) do
-              add_offense(node.loc.selector, severity: :warning) do |corrector|
-                corrector.replace(node, "node['#{node.method_name}']")
-              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 Deprecations
+        # Use node attributes to access data provided by Ohai instead of using node methods to access that data.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   node.fqdn
+        #   node.platform
+        #   node.platform_family
+        #   node.platform_version
+        #   node.hostname
+        #
+        #   ### correct
+        #   node['fqdn']
+        #   node['platform']
+        #   node['platform_family']
+        #   node['platform_version']
+        #   node['hostname']
+        #
+        class NodeMethodsInsteadofAttributes < Base
+          extend AutoCorrector
+
+          MSG = 'Use node attributes to access Ohai data instead of node methods, which were deprecated in Chef Infra Client 13.'
+          RESTRICT_ON_SEND = %i(
+            current_user
+            domain
+            fqdn
+            hostname
+            ip6address
+            ipaddress
+            macaddress
+            machinename
+            ohai_time
+            os
+            os_version
+            platform
+            platform_build
+            platform_family
+            platform_version
+            root_group
+            shard_seed
+            uptime
+            uptime_seconds).freeze
+
+          def_node_matcher :node_ohai_methods?, <<-PATTERN
+            (send (send nil? :node) _)
+          PATTERN
+
+          def on_send(node)
+            node_ohai_methods?(node) do
+              add_offense(node.loc.selector, severity: :warning) do |corrector|
+                corrector.replace(node, "node['#{node.method_name}']")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/node_set.rb

@@ -1,54 +1,54 @@
-# frozen_string_literal: true
-#
-# Copyright:: Copyright 2019, Chef Software Inc.
-#
-# 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 Deprecations
-        # The `node.set` method has been removed in Chef Infra Client 13 and usage must be replaced with `node.normal`.
-        #
-        # This cop will autocorrect code to use node.normal, which is functionally identical to node.set, but we also discourage the use of that method as normal level attributes persist on the node even if the code setting the attribute is later removed.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   node.set['foo'] = true
-        #
-        #   ### correct
-        #   node.normal['foo'] = true
-        #
-        class NodeSet < Base
-          extend AutoCorrector
-
-          MSG = 'Do not use node.set. Replace with node.normal to keep identical behavior.'
-          RESTRICT_ON_SEND = [:set].freeze
-
-          def_node_matcher :node_set?, <<-PATTERN
-            (send (send _ :node) $:set)
-          PATTERN
-
-          def on_send(node)
-            node_set?(node) do
-              add_offense(node.loc.selector, severity: :warning) do |corrector|
-                corrector.replace(node.loc.selector, 'normal')
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: Copyright 2019, Chef Software Inc.
+#
+# 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 Deprecations
+        # The `node.set` method has been removed in Chef Infra Client 13 and usage must be replaced with `node.normal`.
+        #
+        # This cop will autocorrect code to use node.normal, which is functionally identical to node.set, but we also discourage the use of that method as normal level attributes persist on the node even if the code setting the attribute is later removed.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   node.set['foo'] = true
+        #
+        #   ### correct
+        #   node.normal['foo'] = true
+        #
+        class NodeSet < Base
+          extend AutoCorrector
+
+          MSG = 'Do not use node.set. Replace with node.normal to keep identical behavior.'
+          RESTRICT_ON_SEND = [:set].freeze
+
+          def_node_matcher :node_set?, <<-PATTERN
+            (send (send _ :node) $:set)
+          PATTERN
+
+          def on_send(node)
+            node_set?(node) do
+              add_offense(node.loc.selector, severity: :warning) do |corrector|
+                corrector.replace(node.loc.selector, 'normal')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/node_set_unless.rb

@@ -1,54 +1,54 @@
-# frozen_string_literal: true
-#
-# Copyright:: Copyright 2019, Chef Software Inc.
-#
-# 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 Deprecations
-        # The node.set_unless method has been removed in Chef Infra Client 13 and usage must be replaced with node.normal_unless.
-        #
-        # This cop will autocorrect code to use node.normal_unless, which is functionally identical to node.set_unless, but we also discourage the use of that method as normal level attributes persist on the node even if the code setting the attribute is later removed.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   node.set_unless['foo'] = true
-        #
-        #   ### correct
-        #   node.normal_unless['foo'] = true
-        #
-        class NodeSetUnless < Base
-          extend AutoCorrector
-
-          MSG = 'Do not use node.set_unless. Replace with node.normal_unless to keep identical behavior.'
-          RESTRICT_ON_SEND = [:set_unless].freeze
-
-          def_node_matcher :node_set_unless?, <<-PATTERN
-            (send (send _ :node) $:set_unless)
-          PATTERN
-
-          def on_send(node)
-            node_set_unless?(node) do
-              add_offense(node.loc.selector, severity: :warning) do |corrector|
-                corrector.replace(node.loc.selector, 'normal_unless')
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: Copyright 2019, Chef Software Inc.
+#
+# 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 Deprecations
+        # The node.set_unless method has been removed in Chef Infra Client 13 and usage must be replaced with node.normal_unless.
+        #
+        # This cop will autocorrect code to use node.normal_unless, which is functionally identical to node.set_unless, but we also discourage the use of that method as normal level attributes persist on the node even if the code setting the attribute is later removed.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   node.set_unless['foo'] = true
+        #
+        #   ### correct
+        #   node.normal_unless['foo'] = true
+        #
+        class NodeSetUnless < Base
+          extend AutoCorrector
+
+          MSG = 'Do not use node.set_unless. Replace with node.normal_unless to keep identical behavior.'
+          RESTRICT_ON_SEND = [:set_unless].freeze
+
+          def_node_matcher :node_set_unless?, <<-PATTERN
+            (send (send _ :node) $:set_unless)
+          PATTERN
+
+          def on_send(node)
+            node_set_unless?(node) do
+              add_offense(node.loc.selector, severity: :warning) do |corrector|
+                corrector.replace(node.loc.selector, 'normal_unless')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/node_set_without_level.rb

@@ -1,70 +1,70 @@
-# frozen_string_literal: true
-#
-# Copyright:: Copyright 2019, Chef Software Inc.
-#
-# 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 Deprecations
-        # When setting a node attribute in Chef Infra Client 11 and later you must specify the precedence level.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   node['foo']['bar'] = 1
-        #   node['foo']['bar'] << 1
-        #   node['foo']['bar'] += 1
-        #   node['foo']['bar'] -= 1
-        #
-        #   ### correct
-        #   node.default['foo']['bar'] = 1
-        #   node.default['foo']['bar'] << 1
-        #   node.default['foo']['bar'] += 1
-        #   node.default['foo']['bar'] -= 1
-        #
-        class NodeSetWithoutLevel < Base
-          MSG = 'When setting a node attribute in Chef Infra Client 11 and later you must specify the precedence level.'
-          RESTRICT_ON_SEND = [:[]=, :<<].freeze
-
-          def on_op_asgn(node)
-            # make sure it was a += or -=
-            if %i(- +).include?(node.node_parts[1])
-              add_offense_for_bare_assignment(node.children&.first)
-            end
-          end
-
-          def on_send(node)
-            # make sure the method being send is []= and then make sure the receiver is a send
-            if %i([]= <<).include?(node.method_name) && node.receiver.send_type?
-              add_offense_for_bare_assignment(node)
-            end
-          end
-
-          private
-
-          def add_offense_for_bare_assignment(sub_node)
-            if sub_node.receiver == s(:send, nil, :node) # node['foo'] scenario
-              add_offense(sub_node.receiver.loc.selector, severity: :warning)
-            elsif sub_node.receiver &&
-                  sub_node.receiver&.node_parts[0] == s(:send, nil, :node) &&
-                  sub_node.receiver&.node_parts[1] == :[] # node['foo']['bar'] scenario
-              add_offense(sub_node.receiver.node_parts.first.loc.selector, severity: :warning)
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: Copyright 2019, Chef Software Inc.
+#
+# 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 Deprecations
+        # When setting a node attribute in Chef Infra Client 11 and later you must specify the precedence level.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   node['foo']['bar'] = 1
+        #   node['foo']['bar'] << 1
+        #   node['foo']['bar'] += 1
+        #   node['foo']['bar'] -= 1
+        #
+        #   ### correct
+        #   node.default['foo']['bar'] = 1
+        #   node.default['foo']['bar'] << 1
+        #   node.default['foo']['bar'] += 1
+        #   node.default['foo']['bar'] -= 1
+        #
+        class NodeSetWithoutLevel < Base
+          MSG = 'When setting a node attribute in Chef Infra Client 11 and later you must specify the precedence level.'
+          RESTRICT_ON_SEND = [:[]=, :<<].freeze
+
+          def on_op_asgn(node)
+            # make sure it was a += or -=
+            if %i(- +).include?(node.node_parts[1])
+              add_offense_for_bare_assignment(node.children&.first)
+            end
+          end
+
+          def on_send(node)
+            # make sure the method being send is []= and then make sure the receiver is a send
+            if %i([]= <<).include?(node.method_name) && node.receiver.send_type?
+              add_offense_for_bare_assignment(node)
+            end
+          end
+
+          private
+
+          def add_offense_for_bare_assignment(sub_node)
+            if sub_node.receiver == s(:send, nil, :node) # node['foo'] scenario
+              add_offense(sub_node.receiver.loc.selector, severity: :warning)
+            elsif sub_node.receiver &&
+                  sub_node.receiver&.node_parts.first == s(:send, nil, :node) &&
+                  sub_node.receiver&.node_parts[1] == :[] # node['foo']['bar'] scenario
+              add_offense(sub_node.receiver.node_parts.first.loc.selector, severity: :warning)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/partial_search_class_usage.rb

@@ -1,67 +1,67 @@
-# 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 Deprecations
-        # Legacy Chef::PartialSearch class usage should be updated to use the `search` helper instead with the `filter_result` key.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   ::Chef::PartialSearch.new.search((:node, 'role:web',
-        #     keys: { 'name' => [ 'name' ],
-        #             'ip' => [ 'ipaddress' ],
-        #             'kernel_version' => %w(kernel version),
-        #               }
-        #   ).each do |result|
-        #     puts result['name']
-        #     puts result['ip']
-        #     puts result['kernel_version']
-        #   end
-        #
-        #   ### correct
-        #   search(:node, 'role:web',
-        #     filter_result: { 'name' => [ 'name' ],
-        #                      'ip' => [ 'ipaddress' ],
-        #                      'kernel_version' => %w(kernel version),
-        #               }
-        #   ).each do |result|
-        #     puts result['name']
-        #     puts result['ip']
-        #     puts result['kernel_version']
-        #   end
-        #
-        class PartialSearchClassUsage < Base
-          MSG = 'Legacy Chef::PartialSearch class usage should be updated to use the search helper instead with the filter_result key.'
-          RESTRICT_ON_SEND = [:new].freeze
-
-          def_node_matcher :partial_search_class?, <<-PATTERN
-            (send (const (const ... :Chef) :PartialSearch) :new)
-          PATTERN
-
-          def on_send(node)
-            partial_search_class?(node) do
-              add_offense(node, severity: :warning)
-            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 Deprecations
+        # Legacy Chef::PartialSearch class usage should be updated to use the `search` helper instead with the `filter_result` key.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   ::Chef::PartialSearch.new.search((:node, 'role:web',
+        #     keys: { 'name' => [ 'name' ],
+        #             'ip' => [ 'ipaddress' ],
+        #             'kernel_version' => %w(kernel version),
+        #               }
+        #   ).each do |result|
+        #     puts result['name']
+        #     puts result['ip']
+        #     puts result['kernel_version']
+        #   end
+        #
+        #   ### correct
+        #   search(:node, 'role:web',
+        #     filter_result: { 'name' => [ 'name' ],
+        #                      'ip' => [ 'ipaddress' ],
+        #                      'kernel_version' => %w(kernel version),
+        #               }
+        #   ).each do |result|
+        #     puts result['name']
+        #     puts result['ip']
+        #     puts result['kernel_version']
+        #   end
+        #
+        class PartialSearchClassUsage < Base
+          MSG = 'Legacy Chef::PartialSearch class usage should be updated to use the search helper instead with the filter_result key.'
+          RESTRICT_ON_SEND = [:new].freeze
+
+          def_node_matcher :partial_search_class?, <<-PATTERN
+            (send (const (const ... :Chef) :PartialSearch) :new)
+          PATTERN
+
+          def on_send(node)
+            partial_search_class?(node) do
+              add_offense(node, severity: :warning)
+            end
+          end
+        end
+      end
+    end
+  end
+end