cookstyle 7.32.8 → 8.1.1

data/lib/rubocop/cop/chef/style/negating_only_if.rb

@@ -1,69 +1,69 @@
-# 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 Style
-        # Instead of using only_if conditionals with ! to negate the returned value, use not_if which is easier to read
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   package 'legacy-sysv-deps' do
-        #     only_if { !systemd }
-        #   end
-        #
-        #   ### correct
-        #   package 'legacy-sysv-deps' do
-        #     not_if { systemd }
-        #   end
-        #
-        class NegatingOnlyIf < Base
-          extend AutoCorrector
-
-          MSG = 'Instead of using only_if conditionals with ! to negate the returned value, use not_if which is easier to read'
-
-          def_node_matcher :negated_only_if?, <<-PATTERN
-            (block
-              $(send nil? :only_if)
-              (args)
-              $(send
-                $(...) :!))
-          PATTERN
-
-          def on_block(node)
-            negated_only_if?(node) do |only_if, code|
-              # skip inspec controls where we don't have not_if
-              return if node.parent&.parent&.block_type? &&
-                        node.parent&.parent&.method_name == :control
-
-              # the value was double negated to work around types: ex: !!systemd?
-              return if code.descendants.first.send_type? &&
-                        code.descendants.first.negation_method?
-
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.replace(code, code.source.gsub(/^!/, ''))
-                corrector.replace(only_if.source_range, 'not_if')
-              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 Style
+        # Instead of using only_if conditionals with ! to negate the returned value, use not_if which is easier to read
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   package 'legacy-sysv-deps' do
+        #     only_if { !systemd }
+        #   end
+        #
+        #   ### correct
+        #   package 'legacy-sysv-deps' do
+        #     not_if { systemd }
+        #   end
+        #
+        class NegatingOnlyIf < Base
+          extend AutoCorrector
+
+          MSG = 'Instead of using only_if conditionals with ! to negate the returned value, use not_if which is easier to read'
+
+          def_node_matcher :negated_only_if?, <<-PATTERN
+            (block
+              $(send nil? :only_if)
+              (args)
+              $(send
+                $(...) :!))
+          PATTERN
+
+          def on_block(node)
+            negated_only_if?(node) do |only_if, code|
+              # skip inspec controls where we don't have not_if
+              return if node.parent&.parent&.block_type? &&
+                        node.parent&.parent&.method_name == :control
+
+              # the value was double negated to work around types: ex: !!systemd?
+              return if code.descendants.first.send_type? &&
+                        code.descendants.first.negation_method?
+
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(code, code.source.gsub(/^!/, ''))
+                corrector.replace(only_if.source_range, 'not_if')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/style/overly_complex_supports_depends_metadata.rb

@@ -1,70 +1,70 @@
-# 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 Style
-        # Don't loop over an array to set cookbook dependencies or supported platforms if you have fewer than three values to set. Setting multiple `supports` or `depends` values is simpler and easier to understand for new users.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #
-        #   %w( debian ubuntu ).each do |os|
-        #     supports os
-        #   end
-        #
-        #   %w( apt yum ).each do |cb|
-        #     depends cb
-        #   end
-        #
-        #   ### correct
-        #
-        #   supports 'debian'
-        #   supports 'ubuntu'
-        #
-        #   depends 'apt'
-        #   depends 'yum'
-        #
-        class OverlyComplexSupportsDependsMetadata < Base
-          extend AutoCorrector
-          MSG = "Don't loop over an array to set cookbook dependencies or supported platforms if you have fewer than three values to set."
-
-          def_node_matcher :supports_depends_array?, <<-PATTERN
-            (block
-              (send
-                $(array ...) :each)
-              (args
-                (arg _))
-              (send nil? ${:supports :depends} (lvar _)))
-          PATTERN
-
-          def on_block(node)
-            supports_depends_array?(node) do |array, type|
-              return unless array.values.count < 3
-              add_offense(node, severity: :refactor) do |corrector|
-                corrected_value = array.values.map { |x| "#{type} '#{x.source}'" }
-                corrector.replace(node, corrected_value.join("\n"))
-              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 Style
+        # Don't loop over an array to set cookbook dependencies or supported platforms if you have fewer than three values to set. Setting multiple `supports` or `depends` values is simpler and easier to understand for new users.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #
+        #   %w( debian ubuntu ).each do |os|
+        #     supports os
+        #   end
+        #
+        #   %w( apt yum ).each do |cb|
+        #     depends cb
+        #   end
+        #
+        #   ### correct
+        #
+        #   supports 'debian'
+        #   supports 'ubuntu'
+        #
+        #   depends 'apt'
+        #   depends 'yum'
+        #
+        class OverlyComplexSupportsDependsMetadata < Base
+          extend AutoCorrector
+          MSG = "Don't loop over an array to set cookbook dependencies or supported platforms if you have fewer than three values to set."
+
+          def_node_matcher :supports_depends_array?, <<-PATTERN
+            (block
+              (send
+                $(array ...) :each)
+              (args
+                (arg _))
+              (send nil? ${:supports :depends} (lvar _)))
+          PATTERN
+
+          def on_block(node)
+            supports_depends_array?(node) do |array, type|
+              return unless array.values.count < 3
+              add_offense(node, severity: :refactor) do |corrector|
+                corrected_value = array.values.map { |x| "#{type} '#{x.source}'" }
+                corrector.replace(node, corrected_value.join("\n"))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/style/simplify_platform_major_version_check.rb

@@ -1,89 +1,89 @@
-# 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 Style
-        # When checking the major version number of a platform you can take the node['platform_version'] attribute and transform it to an integer to strip it down to just the major version number. This simple way of determining the major version number of a platform should be used instead of splitting the platform into multiple fields with '.' as the delimiter.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   node['platform_version'].split('.').first
-        #   node['platform_version'].split('.')[0]
-        #   node['platform_version'].split('.').first.to_i
-        #   node['platform_version'].split('.')[0].to_i
-        #
-        #   ### correct
-        #
-        #   # check to see if we're on RHEL 7 on a RHEL 7.6 node where node['platform_version] is 7.6.1810
-        #   if node['platform_version'].to_i == 7
-        #     # some code
-        #   end
-        #
-        class SimplifyPlatformMajorVersionCheck < Base
-          extend AutoCorrector
-
-          MSG = "Use node['platform_version'].to_i instead of node['platform_version'].split('.').first or node['platform_version'].split('.')[0]"
-          RESTRICT_ON_SEND = [:split].freeze
-
-          def_node_matcher :platform_version_check?, <<-PATTERN
-            (send (send (send nil? :node) :[] (str "platform_version") ) :split (str ".") )
-          PATTERN
-
-          def on_send(node)
-            platform_version_check?(node) do
-              if parent_method_equals?(node, :[])
-                node = node.parent
-                if node&.arguments.count == 1 &&
-                   node&.arguments&.first&.int_type? &&
-                   node&.arguments&.first.source == '0'
-                  add_offense_to_i_if_present(node)
-                end
-              elsif parent_method_equals?(node, :first)
-                node = node.parent
-                add_offense_to_i_if_present(node)
-              end
-            end
-          end
-
-          private
-
-          # if the parent is .to_i then we want to alert on that
-          def add_offense_to_i_if_present(node)
-            node = node.parent if parent_method_equals?(node, :to_i)
-            add_offense(node, severity: :refactor) do |corrector|
-              corrector.replace(node, "node['platform_version'].to_i")
-            end
-          end
-
-          # see if the parent is a method and if it equals the passed in name
-          #
-          # @param [Rubocop::AST:Node] node The rubocop ast node to search
-          # @param [Symbol] name The method name
-          #
-          def parent_method_equals?(node, name)
-            return false if node.parent.nil?
-            return false unless node.parent.send_type?
-            name == node.parent.method_name
-          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 Style
+        # When checking the major version number of a platform you can take the node['platform_version'] attribute and transform it to an integer to strip it down to just the major version number. This simple way of determining the major version number of a platform should be used instead of splitting the platform into multiple fields with '.' as the delimiter.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   node['platform_version'].split('.').first
+        #   node['platform_version'].split('.')[0]
+        #   node['platform_version'].split('.').first.to_i
+        #   node['platform_version'].split('.')[0].to_i
+        #
+        #   ### correct
+        #
+        #   # check to see if we're on RHEL 7 on a RHEL 7.6 node where node['platform_version] is 7.6.1810
+        #   if node['platform_version'].to_i == 7
+        #     # some code
+        #   end
+        #
+        class SimplifyPlatformMajorVersionCheck < Base
+          extend AutoCorrector
+
+          MSG = "Use node['platform_version'].to_i instead of node['platform_version'].split('.').first or node['platform_version'].split('.')[0]"
+          RESTRICT_ON_SEND = [:split].freeze
+
+          def_node_matcher :platform_version_check?, <<-PATTERN
+            (send (send (send nil? :node) :[] (str "platform_version") ) :split (str ".") )
+          PATTERN
+
+          def on_send(node)
+            platform_version_check?(node) do
+              if parent_method_equals?(node, :[])
+                node = node.parent
+                if node&.arguments.count == 1 &&
+                   node&.arguments&.first&.int_type? &&
+                   node&.arguments&.first.source == '0'
+                  add_offense_to_i_if_present(node)
+                end
+              elsif parent_method_equals?(node, :first)
+                node = node.parent
+                add_offense_to_i_if_present(node)
+              end
+            end
+          end
+
+          private
+
+          # if the parent is .to_i then we want to alert on that
+          def add_offense_to_i_if_present(node)
+            node = node.parent if parent_method_equals?(node, :to_i)
+            add_offense(node, severity: :refactor) do |corrector|
+              corrector.replace(node, "node['platform_version'].to_i")
+            end
+          end
+
+          # see if the parent is a method and if it equals the passed in name
+          #
+          # @param [Rubocop::AST:Node] node The rubocop ast node to search
+          # @param [Symbol] name The method name
+          #
+          def parent_method_equals?(node, name)
+            return false if node.parent.nil?
+            return false unless node.parent.send_type?
+            name == node.parent.method_name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/style/true_false_resource_properties.rb

@@ -1,53 +1,53 @@
-# 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 Style
-        # When setting the allowed types for a resource to accept either true or false values it's much simpler to use true and false instead of TrueClass and FalseClass.
-        #
-        # @example
-        #
-        #   ### incorrect
-        #   property :foo, [TrueClass, FalseClass]
-        #
-        #   ### correct
-        #   property :foo, [true, false]
-        #
-        class TrueClassFalseClassResourceProperties < Base
-          extend AutoCorrector
-
-          MSG = "When setting the allowed types for a resource to accept either true or false values it's much simpler to use true and false instead of TrueClass and FalseClass."
-          RESTRICT_ON_SEND = [:property, :attribute].freeze
-
-          def_node_matcher :trueclass_falseclass_property?, <<-PATTERN
-            (send nil? {:property :attribute} (sym _) $(array (const nil? :TrueClass) (const nil? :FalseClass)) ... )
-          PATTERN
-
-          def on_send(node)
-            trueclass_falseclass_property?(node) do |types|
-              add_offense(node, severity: :refactor) do |corrector|
-                corrector.replace(types, '[true, false]')
-              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 Style
+        # When setting the allowed types for a resource to accept either true or false values it's much simpler to use true and false instead of TrueClass and FalseClass.
+        #
+        # @example
+        #
+        #   ### incorrect
+        #   property :foo, [TrueClass, FalseClass]
+        #
+        #   ### correct
+        #   property :foo, [true, false]
+        #
+        class TrueClassFalseClassResourceProperties < Base
+          extend AutoCorrector
+
+          MSG = "When setting the allowed types for a resource to accept either true or false values it's much simpler to use true and false instead of TrueClass and FalseClass."
+          RESTRICT_ON_SEND = [:property, :attribute].freeze
+
+          def_node_matcher :trueclass_falseclass_property?, <<-PATTERN
+            (send nil? {:property :attribute} (sym _) $(array (const nil? :TrueClass) (const nil? :FalseClass)) ... )
+          PATTERN
+
+          def on_send(node)
+            trueclass_falseclass_property?(node) do |types|
+              add_offense(node, severity: :refactor) do |corrector|
+                corrector.replace(types, '[true, false]')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end