cookstyle 7.32.8 → 8.0.0

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

@@ -1,56 +1,56 @@
-# 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
-        # Chef Workstation 0.8 and later renamed the `ChefDK` module used when writing custom cookbook generators from `ChefDK` to `ChefCLI`. For compatibility with the latest Chef Workstation releases you'll need to reference the new class names.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   ChefDK::CLI
-        #   ChefDK::Generator::TemplateHelper
-        #   module ChefDK
-        #     # some additional code
-        #   end
-        #
-        #   ### correct
-        #   ChefCLI::CLI
-        #   ChefCLI::Generator::TemplateHelper
-        #   module ChefCLI
-        #     # some additional code
-        #   end
-        #
-        class ChefDKGenerators < Base
-          extend AutoCorrector
-          MSG = 'When writing cookbook generators use the ChefCLI module instead of the ChefDK module which was removed in Chef Workstation 0.8 and later.'
-
-          def on_const(node)
-            # We want to catch calls like ChefCLI::CLI.whatever or places where classes are defined in the ChefDK module
-            return unless node.const_name == 'ChefDK' && (node.parent&.module_type? || node.parent&.const_type?)
-
-            add_offense(node, severity: :warning) do |corrector|
-              corrector.replace(node, node.source.gsub('ChefDK', 'ChefCLI'))
-            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
+        # Chef Workstation 0.8 and later renamed the `ChefDK` module used when writing custom cookbook generators from `ChefDK` to `ChefCLI`. For compatibility with the latest Chef Workstation releases you'll need to reference the new class names.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   ChefDK::CLI
+        #   ChefDK::Generator::TemplateHelper
+        #   module ChefDK
+        #     # some additional code
+        #   end
+        #
+        #   ### correct
+        #   ChefCLI::CLI
+        #   ChefCLI::Generator::TemplateHelper
+        #   module ChefCLI
+        #     # some additional code
+        #   end
+        #
+        class ChefDKGenerators < Base
+          extend AutoCorrector
+          MSG = 'When writing cookbook generators use the ChefCLI module instead of the ChefDK module which was removed in Chef Workstation 0.8 and later.'
+
+          def on_const(node)
+            # We want to catch calls like ChefCLI::CLI.whatever or places where classes are defined in the ChefDK module
+            return unless node.const_name == 'ChefDK' && (node.parent&.module_type? || node.parent&.const_type?)
+
+            add_offense(node, severity: :warning) do |corrector|
+              corrector.replace(node, node.source.gsub('ChefDK', 'ChefCLI'))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,39 +1,39 @@
-# 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 Librarian-Chef depsolving project is no longer maintained and a Cheffile should not be used for cookbook depsolving. Consider using Policyfiles instead. If the Policyfiles model is not compatible with your workflow you may find Berkshelf offers a more similar, and still supported, experience to Librarian-Chef.
-        #
-        class Cheffile < Base
-          include RangeHelp
-
-          MSG = 'The Librarian-Chef depsolving project is no longer maintained and a Cheffile should not be used for cookbook depsolving. Consider using Policyfiles instead.'
-
-          def on_new_investigation
-            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
-            range = source_range(processed_source.buffer, 1, 0)
-
-            add_offense(range, severity: :warning)
-          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 Librarian-Chef depsolving project is no longer maintained and a Cheffile should not be used for cookbook depsolving. Consider using Policyfiles instead. If the Policyfiles model is not compatible with your workflow you may find Berkshelf offers a more similar, and still supported, experience to Librarian-Chef.
+        #
+        class Cheffile < Base
+          include RangeHelp
+
+          MSG = 'The Librarian-Chef depsolving project is no longer maintained and a Cheffile should not be used for cookbook depsolving. Consider using Policyfiles instead.'
+
+          def on_new_investigation
+            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
+            range = source_range(processed_source.buffer, 1, 0)
+
+            add_offense(range, severity: :warning)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,49 +1,49 @@
-# 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
-        # Don't use the deprecated ChefSpec Coverage report functionality in your specs. This feature has been removed as coverage reports encourage cookbook authors to write ineffective specs. Focus on testing your logic instead of achieving 100% code coverage.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #
-        #   at_exit { ChefSpec::Coverage.report! }
-        #
-        class ChefSpecCoverageReport < Base
-          extend AutoCorrector
-          MSG = "Don't use the deprecated ChefSpec coverage report functionality in your specs."
-
-          def_node_matcher :coverage_reporter?, <<-PATTERN
-          (block (send nil? :at_exit ) (args) (send (const (const nil? :ChefSpec) :Coverage) :report!))
-          PATTERN
-
-          def on_block(node)
-            coverage_reporter?(node) do
-              add_offense(node, severity: :warning) do |corrector|
-                corrector.remove(node)
-              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
+        # Don't use the deprecated ChefSpec Coverage report functionality in your specs. This feature has been removed as coverage reports encourage cookbook authors to write ineffective specs. Focus on testing your logic instead of achieving 100% code coverage.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #
+        #   at_exit { ChefSpec::Coverage.report! }
+        #
+        class ChefSpecCoverageReport < Base
+          extend AutoCorrector
+          MSG = "Don't use the deprecated ChefSpec coverage report functionality in your specs."
+
+          def_node_matcher :coverage_reporter?, <<-PATTERN
+          (block (send nil? :at_exit ) (args) (send (const (const nil? :ChefSpec) :Coverage) :report!))
+          PATTERN
+
+          def on_block(node)
+            coverage_reporter?(node) do
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.remove(node)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,61 +1,61 @@
-# 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 `ChefSpec::SoloRunner` or `ChefSpec::ServerRunner` instead of the deprecated `ChefSpec::Runner`. These new runners were introduced in ChefSpec 4.1 (Oct 2014).
-        #
-        # @example
-        #
-        #   ### incorrect
-        #
-        #   describe 'foo::default' do
-        #     subject { ChefSpec::Runner.new.converge(described_recipe) }
-        #
-        #     # some spec code
-        #   end
-        #
-        #   ### correct
-        #
-        #   describe 'foo::default' do
-        #     subject { ChefSpec::ServerRunner.new.converge(described_recipe) }
-        #
-        #     # some spec code
-        #   end
-        #
-        class ChefSpecLegacyRunner < Base
-          extend AutoCorrector
-          MSG = 'Use ChefSpec::SoloRunner or ChefSpec::ServerRunner instead of the deprecated ChefSpec::Runner.'
-
-          def_node_matcher :chefspec_runner?, <<-PATTERN
-          (const (const nil? :ChefSpec) :Runner)
-          PATTERN
-
-          def on_const(node)
-            chefspec_runner?(node) do
-              add_offense(node, severity: :warning) do |corrector|
-                corrector.replace(node, 'ChefSpec::ServerRunner')
-              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 `ChefSpec::SoloRunner` or `ChefSpec::ServerRunner` instead of the deprecated `ChefSpec::Runner`. These new runners were introduced in ChefSpec 4.1 (Oct 2014).
+        #
+        # @example
+        #
+        #   ### incorrect
+        #
+        #   describe 'foo::default' do
+        #     subject { ChefSpec::Runner.new.converge(described_recipe) }
+        #
+        #     # some spec code
+        #   end
+        #
+        #   ### correct
+        #
+        #   describe 'foo::default' do
+        #     subject { ChefSpec::ServerRunner.new.converge(described_recipe) }
+        #
+        #     # some spec code
+        #   end
+        #
+        class ChefSpecLegacyRunner < Base
+          extend AutoCorrector
+          MSG = 'Use ChefSpec::SoloRunner or ChefSpec::ServerRunner instead of the deprecated ChefSpec::Runner.'
+
+          def_node_matcher :chefspec_runner?, <<-PATTERN
+          (const (const nil? :ChefSpec) :Runner)
+          PATTERN
+
+          def on_const(node)
+            chefspec_runner?(node) do
+              add_offense(node, severity: :warning) do |corrector|
+                corrector.replace(node, 'ChefSpec::ServerRunner')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,56 +1,56 @@
-# 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 the `:remove` action in the `chocolatey_package` resource instead of `:uninstall` which was removed in Chef Infra Client 14+.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   chocolatey_package 'nginx' do
-        #     action :uninstall
-        #   end
-        #
-        #   ### correct
-        #   chocolatey_package 'nginx' do
-        #     action :remove
-        #   end
-        #
-        class ChocolateyPackageUninstallAction < Base
-          include RuboCop::Chef::CookbookHelpers
-          extend AutoCorrector
-
-          MSG = 'Use the :remove action in the chocolatey_package resource instead of :uninstall which was removed in Chef Infra Client 14+'
-
-          def on_block(node)
-            match_property_in_resource?(:chocolatey_package, 'action', node) do |choco_action|
-              choco_action.arguments.each do |action|
-                next unless action.source == ':uninstall'
-                add_offense(action, severity: :warning) do |corrector|
-                  corrector.replace(action, ':remove')
-                end
-              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 the `:remove` action in the `chocolatey_package` resource instead of `:uninstall` which was removed in Chef Infra Client 14+.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   chocolatey_package 'nginx' do
+        #     action :uninstall
+        #   end
+        #
+        #   ### correct
+        #   chocolatey_package 'nginx' do
+        #     action :remove
+        #   end
+        #
+        class ChocolateyPackageUninstallAction < Base
+          include RuboCop::Chef::CookbookHelpers
+          extend AutoCorrector
+
+          MSG = 'Use the :remove action in the chocolatey_package resource instead of :uninstall which was removed in Chef Infra Client 14+'
+
+          def on_block(node)
+            match_property_in_resource?(:chocolatey_package, 'action', node) do |choco_action|
+              choco_action.arguments.each do |action|
+                next unless action.source == ':uninstall'
+                add_offense(action, severity: :warning) do |corrector|
+                  corrector.replace(action, ':remove')
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,48 +1,48 @@
-# frozen_string_literal: true
-#
-# Copyright:: 2022, 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 Delivery CLI from Chef Delivery/Workflow is no longer bundled with Chef Workstation as Chef Delivery is end of life as of Dec 31st 2021.
-        #
-        # Users of Delivery / Workflow would include a `.delivery` directory in their cookbooks. This directory would include Delivery local-mode configs
-        # or Delivery cookbooks. The contents of this directory are now obsolete and should be removed.
-        #
-        class Delivery < Base
-          include RangeHelp
-
-          MSG = 'Do not include Chef Delivery (Workflow) configuration in your cookbooks. It went EOL Dec 31st 2021 and the delivery command was removed from Chef Workstation Feb 2022.'
-
-          def on_other_file
-            return unless processed_source.path.end_with?('/.delivery/project.toml', '/.delivery/config.json')
-
-            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
-            range = source_range(processed_source.buffer, 1, 0)
-
-            add_offense(range, severity: :warning)
-          end
-
-          # An empty / simple TOML file can also be syntatically valid Ruby, so
-          # RuboCop may start an investigation instead of calling on_other_file.
-          alias_method :on_new_investigation, :on_other_file
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+#
+# Copyright:: 2022, 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 Delivery CLI from Chef Delivery/Workflow is no longer bundled with Chef Workstation as Chef Delivery is end of life as of Dec 31st 2021.
+        #
+        # Users of Delivery / Workflow would include a `.delivery` directory in their cookbooks. This directory would include Delivery local-mode configs
+        # or Delivery cookbooks. The contents of this directory are now obsolete and should be removed.
+        #
+        class Delivery < Base
+          include RangeHelp
+
+          MSG = 'Do not include Chef Delivery (Workflow) configuration in your cookbooks. It went EOL Dec 31st 2021 and the delivery command was removed from Chef Workstation Feb 2022.'
+
+          def on_other_file
+            return unless processed_source.path.end_with?('/.delivery/project.toml', '/.delivery/config.json')
+
+            # Using range similar to RuboCop::Cop::Naming::Filename (file_name.rb)
+            range = source_range(processed_source.buffer, 1, 0)
+
+            add_offense(range, severity: :warning)
+          end
+
+          # An empty / simple TOML file can also be syntatically valid Ruby, so
+          # RuboCop may start an investigation instead of calling on_other_file.
+          alias_method :on_new_investigation, :on_other_file
+        end
+      end
+    end
+  end
+end