RubyGems - cookstyle - Versions diffs - 7.7.2 → 7.10.1 - Mend

cookstyle 7.7.2 → 7.10.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (225) hide show

data/lib/rubocop/cop/chef/redundant/property_with_default_and_required.rb CHANGED Viewed

@@ -26,10 +26,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   property :bob, String, required: true, default: 'foo'
         #
-        #   # good
+        #   #### correct
         #   property :bob, String, required: true
         #
         class PropertyWithRequiredAndDefault < Base

data/lib/rubocop/cop/chef/redundant/provides_metadata.rb CHANGED Viewed

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad in metadata.rb:
+        #   #### incorrect in metadata.rb:
         #
         #   provides "some_thing"
         #

data/lib/rubocop/cop/chef/redundant/recipe_metadata.rb CHANGED Viewed

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   recipe 'openldap::default', 'Install and configure OpenLDAP'
         #
         #

data/lib/rubocop/cop/chef/redundant/replaces_metadata.rb CHANGED Viewed

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad in metadata.rb:
+        #   #### incorrect in metadata.rb:
         #
         #   replaces "another_cookbook"
         #

data/lib/rubocop/cop/chef/redundant/resource_with_nothing_action.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   action :nothing
         #     # let's do nothing
         #   end

data/lib/rubocop/cop/chef/redundant/sensitive_property_in_resource.rb CHANGED Viewed

@@ -21,7 +21,9 @@ module RuboCop
       module RedundantCode
         # Every Chef Infra resource already includes a sensitive property with a default value of false.
         #
-        # # bad
+        # @example
+        #
+        # #### incorrect
         # property :sensitive, [true, false], default: false
         #
         class SensitivePropertyInResource < Base

data/lib/rubocop/cop/chef/redundant/string_property_with_nil_default.rb CHANGED Viewed

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   property :config_file, String, default: nil
         #   property :config_file, [String, NilClass], default: nil
         #
-        #   # good
+        #   #### correct
         #   property :config_file, String
         #   property :config_file, [String, NilClass]
         #

data/lib/rubocop/cop/chef/redundant/suggests_metadata.rb CHANGED Viewed

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad in metadata.rb:
+        #   #### incorrect in metadata.rb:
         #
         #   suggests "another_cookbook"
         #

data/lib/rubocop/cop/chef/redundant/unnecessary_desired_state.rb CHANGED Viewed

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   property :foo, String, desired_state: true
         #   attribute :foo, String, desired_state: true
         #
-        #   # good
+        #   #### correct
         #   property :foo, String
         #   attribute :foo, String
         #

data/lib/rubocop/cop/chef/redundant/unnecessary_name_property.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   property :name, String
         #   property :name, String, name_property: true
         #   attribute :name, kind_of: String

data/lib/rubocop/cop/chef/redundant/use_create_if_missing.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   cookbook_file '/logs/foo/error.log' do
         #     source 'error.log'
         #     owner 'root'
@@ -32,7 +32,7 @@ module RuboCop
         #     not_if { ::File.exists?('/logs/foo/error.log') }
         #   end
         #
-        #   # good
+        #   #### correct
         #   cookbook_file '/logs/foo/error.log' do
         #     source 'error.log'
         #     owner 'root'

data/lib/rubocop/cop/chef/sharing/default_maintainer_metadata.rb CHANGED Viewed

@@ -24,12 +24,12 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   maintainer 'YOUR_COMPANY_NAME'
         #   maintainer_email 'YOUR_EMAIL'
         #   maintainer 'The Authors'
         #   maintainer_email 'you@example.com'
-        #   # good
+        #   #### correct
         #   maintainer 'Bob Bobberson'
         #   maintainer_email 'bob@bobberson.com'
         #

data/lib/rubocop/cop/chef/sharing/empty_metadata_field.rb CHANGED Viewed

@@ -24,10 +24,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   license ''
         #
-        #   # good
+        #   #### correct
         #   license 'Apache-2.0'
         #
         class EmptyMetadataField < Base

data/lib/rubocop/cop/chef/sharing/include_property_descriptions.rb CHANGED Viewed

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   property :foo, String
         #
-        #   # good
+        #   #### correct
         #   property :foo, String, description: "Set the important thing to..."
         #
         class IncludePropertyDescriptions < Base

data/lib/rubocop/cop/chef/sharing/include_resource_descriptions.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # good
+        #   #### correct
         #   resource_name :foo
         #   description "The foo resource is used to do..."
         #

data/lib/rubocop/cop/chef/sharing/include_resource_examples.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # good
+        #   #### correct
         #   examples <<~DOC
         #     **Specify a global domain value**
         #

data/lib/rubocop/cop/chef/sharing/insecure_cookbook_url.rb CHANGED Viewed

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   source_url 'http://github.com/something/something'
         #   source_url 'http://www.github.com/something/something'
         #   source_url 'http://www.gitlab.com/something/something'
         #   source_url 'http://gitlab.com/something/something'
         #
-        #   # good
+        #   #### correct
         #   source_url 'http://github.com/something/something'
         #   source_url 'http://gitlab.com/something/something'
         #

data/lib/rubocop/cop/chef/sharing/invalid_license_string.rb CHANGED Viewed

@@ -24,10 +24,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   license 'Apache 2.0'
         #
-        #   # good
+        #   #### correct
         #   license 'Apache-2.0'
         #   license 'all rights reserved'
         #

data/lib/rubocop/cop/chef/style/attribute_keys.rb CHANGED Viewed

@@ -25,19 +25,19 @@ module RuboCop
         #
         # @example when configuration is `EnforcedStyle: symbols`
         #
-        #   # bad
+        #   #### incorrect
         #   node['foo']
         #   node["foo"]
         #
-        #   # good
+        #   #### correct
         #   node[:foo]
         #
         # @example when configuration is `EnforcedStyle: strings`
         #
-        #   # bad
+        #   #### incorrect
         #   node[:foo]
         #
-        #   # good
+        #   #### correct
         #   node['foo']
         #   node["foo"]
         #

data/lib/rubocop/cop/chef/style/chef_whaaat.rb CHANGED Viewed

@@ -24,11 +24,11 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   Chef makes software
         #   Chef configures your systems
         #
-        #   # good
+        #   #### correct
         #   Chef Software makes software
         #   Chef Infra configures your systems
         #

data/lib/rubocop/cop/chef/style/comments_copyright_format.rb CHANGED Viewed

@@ -24,18 +24,18 @@ module RuboCop
         #
         # @example
         #
-        #   # bad (assuming current year is 2019)
-        #   Copyright:: 2013-2019 Opscode, Inc.
-        #   Copyright:: 2013-2019 Chef Inc.
-        #   Copyright:: 2013-2019 Chef Software Inc.
-        #   Copyright:: 2009-2010 2013-2019 Chef Software Inc.
+        #   #### incorrect
+        #   Copyright:: 2013-2022 Opscode, Inc.
+        #   Copyright:: 2013-2022 Chef Inc.
+        #   Copyright:: 2013-2022 Chef Software Inc.
+        #   Copyright:: 2009-2010 2013-2022 Chef Software Inc.
         #   Copyright:: Chef Software Inc.
         #   Copyright:: Tim Smith
-        #   Copyright:: Copyright (c) 2015-2019 Chef Software, Inc.
+        #   Copyright:: Copyright (c) 2015-2022 Chef Software, Inc.
         #
-        #   # good (assuming current year is 2019)
-        #   Copyright:: 2013-2019 Chef Software, Inc.
-        #   Copyright:: 2013-2019 Tim Smith
+        #   #### correct
+        #   Copyright:: 2013-2022 Chef Software, Inc.
+        #   Copyright:: 2013-2022 Tim Smith
         #   Copyright:: 2019 37Signals, Inc.
         #
         class CopyrightCommentFormat < Base

data/lib/rubocop/cop/chef/style/comments_default_copyright.rb CHANGED Viewed

@@ -24,11 +24,11 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   Copyright:: 2019 YOUR_NAME
         #   Copyright:: 2019 YOUR_COMPANY_NAME
         #
-        #   # good
+        #   #### correct
         #   Copyright:: 2019 Tim Smith
         #   Copyright:: 2019 Chef Software, Inc.
         #

data/lib/rubocop/cop/chef/style/comments_format.rb CHANGED Viewed

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   Copyright 2013-2016 Chef Software, Inc.
         #   Recipe default.rb
         #   Attributes default.rb
@@ -33,7 +33,7 @@ module RuboCop
         #   Cookbook Name:: Tomcat
         #   Attributes File:: default
         #
-        #   # good
+        #   #### correct
         #   Copyright:: 2013-2016 Chef Software, Inc.
         #   Recipe:: default.rb
         #   Attributes:: default.rb

data/lib/rubocop/cop/chef/style/file_mode.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   remote_directory '/etc/my.conf' do
         #     content 'some content'
         #     mode 0600
@@ -37,7 +37,7 @@ module RuboCop
         #     action :create
         #   end
         #
-        #   # good
+        #   #### correct
         #   remote_directory '/etc/my.conf' do
         #     content 'some content'
         #     mode '600'

data/lib/rubocop/cop/chef/style/immediate_notification_timing.rb CHANGED Viewed

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #
         #   template '/etc/www/configures-apache.conf' do
         #     notifies :restart, 'service[apache]', :immediate
         #   end
         #
-        #   # good
+        #   #### correct
         #
         #   template '/etc/www/configures-apache.conf' do
         #     notifies :restart, 'service[apache]', :immediately

data/lib/rubocop/cop/chef/style/include_recipe_with_parentheses.rb CHANGED Viewed

@@ -24,10 +24,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   include_recipe('foo::bar')
         #
-        #   # good
+        #   #### correct
         #   include_recipe 'foo::bar'
         #
         class IncludeRecipeWithParentheses < Base

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

@@ -23,12 +23,12 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   package 'legacy-sysv-deps' do
         #     only_if { !systemd }
         #   end
         #
-        #   # good
+        #   #### correct
         #   package 'legacy-sysv-deps' do
         #     not_if { systemd }
         #   end

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #
         #   %w( debian ubuntu ).each do |os|
         #     supports os
@@ -33,7 +33,7 @@ module RuboCop
         #     depends cb
         #   end
         #
-        #   # good
+        #   #### correct
         #
         #   supports 'debian'
         #   supports 'ubuntu'

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

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### 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
         #
-        #   # good
+        #   #### 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

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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   property :foo, [TrueClass, FalseClass]
         #
-        #   # good
+        #   #### correct
         #   property :foo, [true, false]
         #
         class TrueClassFalseClassResourceProperties < Base