cookstyle 7.32.8 → 8.0.0

data/lib/rubocop/cop/chef/deprecation/locale_lc_all_property.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 Deprecations
-        # The local resource's lc_all property has been deprecated and will be removed in Chef Infra Client 17
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   locale 'set locale' do
-        #     lang 'en_gb.utf-8'
-        #     lc_all 'en_gb.utf-8'
-        #   end
-        #
-        class LocaleDeprecatedLcAllProperty < Base
-          include RuboCop::Chef::CookbookHelpers
-
-          MSG = "The local resource's lc_all property has been deprecated and will be removed in Chef Infra Client 17"
-
-          def on_block(node)
-            match_property_in_resource?(:locale, 'lc_all', node) do |property|
-              add_offense(property, 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
+        # The local resource's lc_all property has been deprecated and will be removed in Chef Infra Client 17
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   locale 'set locale' do
+        #     lang 'en_gb.utf-8'
+        #     lc_all 'en_gb.utf-8'
+        #   end
+        #
+        class LocaleDeprecatedLcAllProperty < Base
+          include RuboCop::Chef::CookbookHelpers
+
+          MSG = "The local resource's lc_all property has been deprecated and will be removed in Chef Infra Client 17"
+
+          def on_block(node)
+            match_property_in_resource?(:locale, 'lc_all', node) do |property|
+              add_offense(property, severity: :warning)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,63 +1,63 @@
-# 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 Deprecations
-        # In Chef Infra Client 16 the log resource no longer notifies when logging so notifications should not be triggered from log resources. Use the notify_group resource introduced in Chef Infra Client 15.8 instead to aggregate notifications.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   template '/etc/foo' do
-        #     source 'bar.erb'
-        #     notifies :write, 'log[Aggregate notifications using a single log resource]', :immediately
-        #   end
-        #
-        #   log 'Aggregate notifications using a single log resource' do
-        #     notifies :restart, 'service[foo]', :delayed
-        #   end
-        #
-        #   ### correct
-        #   template '/etc/foo' do
-        #     source 'bar.erb'
-        #     notifies :run, 'notify_group[Aggregate notifications using a single notify_group resource]', :immediately
-        #   end
-        #
-        #   notify_group 'Aggregate notifications using a single notify_group resource' do
-        #     notifies :restart, 'service[foo]', :delayed
-        #   end
-        #
-        class LogResourceNotifications < Base
-          include RuboCop::Chef::CookbookHelpers
-          extend TargetChefVersion
-
-          minimum_target_chef_version '15.8'
-
-          MSG = 'In Chef Infra Client 16 the log resource no longer notifies when logging so notifications should not be triggered from log resources. Use the notify_group resource introduced in Chef Infra Client 15.8 instead to aggregate notifications.'
-
-          def on_block(node)
-            match_property_in_resource?(:log, 'notifies', node) do |prop_node|
-              add_offense(prop_node, severity: :warning)
-            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 Deprecations
+        # In Chef Infra Client 16 the log resource no longer notifies when logging so notifications should not be triggered from log resources. Use the notify_group resource introduced in Chef Infra Client 15.8 instead to aggregate notifications.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   template '/etc/foo' do
+        #     source 'bar.erb'
+        #     notifies :write, 'log[Aggregate notifications using a single log resource]', :immediately
+        #   end
+        #
+        #   log 'Aggregate notifications using a single log resource' do
+        #     notifies :restart, 'service[foo]', :delayed
+        #   end
+        #
+        #   ### correct
+        #   template '/etc/foo' do
+        #     source 'bar.erb'
+        #     notifies :run, 'notify_group[Aggregate notifications using a single notify_group resource]', :immediately
+        #   end
+        #
+        #   notify_group 'Aggregate notifications using a single notify_group resource' do
+        #     notifies :restart, 'service[foo]', :delayed
+        #   end
+        #
+        class LogResourceNotifications < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend TargetChefVersion
+
+          minimum_target_chef_version '15.8'
+
+          MSG = 'In Chef Infra Client 16 the log resource no longer notifies when logging so notifications should not be triggered from log resources. Use the notify_group resource introduced in Chef Infra Client 15.8 instead to aggregate notifications.'
+
+          def on_block(node)
+            match_property_in_resource?(:log, 'notifies', node) do |prop_node|
+              add_offense(prop_node, severity: :warning)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,60 +1,60 @@
-# 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 Deprecations
-        # The `global` property in the macos_userdefaults resource was deprecated in Chef Infra Client 16.3. This property was never properly implemented and caused failures under many conditions. Omitting the `domain` property will now set global defaults.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   macos_userdefaults 'set a value' do
-        #     global true
-        #     key 'key'
-        #     value 'value'
-        #   end
-        #
-        #   ### correct
-        #   macos_userdefaults 'set a value' do
-        #     key 'key'
-        #     value 'value'
-        #   end
-        #
-        class MacosUserdefaultsGlobalProperty < Base
-          extend TargetChefVersion
-          include RangeHelp
-          include RuboCop::Chef::CookbookHelpers
-          extend AutoCorrector
-
-          minimum_target_chef_version '16.3'
-
-          MSG = 'The `global` property in the macos_userdefaults resource was deprecated in Chef Infra Client 16.3. Omitting the `domain` property will now set global defaults.'
-
-          def on_block(node)
-            match_property_in_resource?(:macos_userdefaults, 'global', node) do |global|
-              add_offense(global.loc.expression, severity: :warning) do |corrector|
-                corrector.remove(range_with_surrounding_space(range: global.loc.expression, side: :left))
-              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 Deprecations
+        # The `global` property in the macos_userdefaults resource was deprecated in Chef Infra Client 16.3. This property was never properly implemented and caused failures under many conditions. Omitting the `domain` property will now set global defaults.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   macos_userdefaults 'set a value' do
+        #     global true
+        #     key 'key'
+        #     value 'value'
+        #   end
+        #
+        #   ### correct
+        #   macos_userdefaults 'set a value' do
+        #     key 'key'
+        #     value 'value'
+        #   end
+        #
+        class MacosUserdefaultsGlobalProperty < Base
+          extend TargetChefVersion
+          include RangeHelp
+          include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
+
+          minimum_target_chef_version '16.3'
+
+          MSG = 'The `global` property in the macos_userdefaults resource was deprecated in Chef Infra Client 16.3. Omitting the `domain` property will now set global defaults.'
+
+          def on_block(node)
+            match_property_in_resource?(:macos_userdefaults, 'global', node) do |global|
+              add_offense(global.loc.expression, severity: :warning) do |corrector|
+                corrector.remove(range_with_surrounding_space(range: global.loc.expression, side: :left))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/deprecation/name_property_and_default.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 Deprecations
-        # A resource property (or attribute) can't be marked as a name_property (or name_attribute) and also have a default value. The name property is a special property that is derived from the name of the resource block in and thus always has a value passed to the resource. For example if you define `my_resource 'foo'` in recipe, then the name property of `my_resource` will automatically be set to `foo`. Setting a property to be both a name_property and have a default value will cause Chef Infra Client failures in 13.0 and later releases.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   property :config_file, String, default: 'foo', name_property: true
-        #   attribute :config_file, String, default: 'foo', name_attribute: true
-        #
-        #   ### correct
-        #   property :config_file, String, name_property: true
-        #   attribute :config_file, String, name_attribute: true
-        #
-        class NamePropertyWithDefaultValue < Base
-          include RangeHelp
-          extend AutoCorrector
-
-          MSG = "A resource property can't be marked as a name_property and also have a default value. This will fail in Chef Infra Client 13 or later."
-          RESTRICT_ON_SEND = [:attribute, :property].freeze
-
-          # match on a property or attribute that has any name and any type and a hash that
-          # contains name_property/name_attribute true and any default value. These are wrapped in
-          # <> which means the order doesn't matter in the hash.
-          def_node_matcher :name_property_with_default?, <<-PATTERN
-            (send nil? {:property :attribute} (sym _) ... (hash <(pair (sym {:name_property :name_attribute}) (true)) $(pair (sym :default) ...) ...>))
-          PATTERN
-
-          def on_send(node)
-            name_property_with_default?(node) do |default|
-              add_offense(node, severity: :warning) 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, 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
+        # A resource property (or attribute) can't be marked as a name_property (or name_attribute) and also have a default value. The name property is a special property that is derived from the name of the resource block in and thus always has a value passed to the resource. For example if you define `my_resource 'foo'` in recipe, then the name property of `my_resource` will automatically be set to `foo`. Setting a property to be both a name_property and have a default value will cause Chef Infra Client failures in 13.0 and later releases.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   property :config_file, String, default: 'foo', name_property: true
+        #   attribute :config_file, String, default: 'foo', name_attribute: true
+        #
+        #   ### correct
+        #   property :config_file, String, name_property: true
+        #   attribute :config_file, String, name_attribute: true
+        #
+        class NamePropertyWithDefaultValue < Base
+          include RangeHelp
+          extend AutoCorrector
+
+          MSG = "A resource property can't be marked as a name_property and also have a default value. This will fail in Chef Infra Client 13 or later."
+          RESTRICT_ON_SEND = [:attribute, :property].freeze
+
+          # match on a property or attribute that has any name and any type and a hash that
+          # contains name_property/name_attribute true and any default value. These are wrapped in
+          # <> which means the order doesn't matter in the hash.
+          def_node_matcher :name_property_with_default?, <<-PATTERN
+            (send nil? {:property :attribute} (sym _) ... (hash <(pair (sym {:name_property :name_attribute}) (true)) $(pair (sym :default) ...) ...>))
+          PATTERN
+
+          def on_send(node)
+            name_property_with_default?(node) do |default|
+              add_offense(node, severity: :warning) 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/deprecation/node_deep_fetch.rb

@@ -1,65 +1,65 @@
-# 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.deep_fetch method has been removed from Chef-Sugar, and must be replaced by the node.read API.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   node.deep_fetch("foo")
-        #
-        #   ### correct
-        #   node.read("foo")
-        #
-        #   ### incorrect
-        #   node.deep_fetch!("foo")
-        #
-        #   ### correct
-        #   node.read!("foo")
-        #
-        class NodeDeepFetch < Base
-          extend RuboCop::Cop::AutoCorrector
-
-          RESTRICT_ON_SEND = [:deep_fetch, :deep_fetch!].freeze
-
-          def_node_matcher :node_deep_fetch?, <<-PATTERN
-            (send (send _ :node) ${:deep_fetch :deep_fetch!} _)
-          PATTERN
-
-          def on_send(node)
-            node_deep_fetch?(node) do
-              add_offense(node.loc.selector, message: "Do not use node.#{node.method_name}. Replace with node.#{fix_name(node.method_name)} to keep identical behavior.", severity: :warning) do |corrector|
-                corrector.replace(node.loc.selector, fix_name(node.method_name))
-              end
-            end
-          end
-
-          private
-
-          def fix_name(name)
-            return 'read!' if name == :deep_fetch!
-            return 'read' if name == :deep_fetch
-            name.to_s
-          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.deep_fetch method has been removed from Chef-Sugar, and must be replaced by the node.read API.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   node.deep_fetch("foo")
+        #
+        #   ### correct
+        #   node.read("foo")
+        #
+        #   ### incorrect
+        #   node.deep_fetch!("foo")
+        #
+        #   ### correct
+        #   node.read!("foo")
+        #
+        class NodeDeepFetch < Base
+          extend RuboCop::Cop::AutoCorrector
+
+          RESTRICT_ON_SEND = [:deep_fetch, :deep_fetch!].freeze
+
+          def_node_matcher :node_deep_fetch?, <<-PATTERN
+            (send (send _ :node) ${:deep_fetch :deep_fetch!} _)
+          PATTERN
+
+          def on_send(node)
+            node_deep_fetch?(node) do
+              add_offense(node.loc.selector, message: "Do not use node.#{node.method_name}. Replace with node.#{fix_name(node.method_name)} to keep identical behavior.", severity: :warning) do |corrector|
+                corrector.replace(node.loc.selector, fix_name(node.method_name))
+              end
+            end
+          end
+
+          private
+
+          def fix_name(name)
+            return 'read!' if name == :deep_fetch!
+            return 'read' if name == :deep_fetch
+            name.to_s
+          end
+        end
+      end
+    end
+  end
+end