RubyGems - cookstyle - Versions diffs - 8.5.2 → 8.6.4 - Mend

cookstyle 8.5.2 → 8.6.4

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 (253) hide show

data/lib/rubocop/cop/chef/modernize/windows_registry_uac.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   registry_key 'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System' do
         #     values [{ name: 'EnableLUA', type: :dword, data: 0 },
         #             { name: 'PromptOnSecureDesktop', type: :dword, data: 0 },
@@ -32,7 +32,7 @@ module RuboCop
         #     action :create
         #   end
         #
-        #   ### correct
+        #   # good
         #   windows_uac 'Set Windows UAC settings' do
         #     enable_uac false
         #     prompt_on_secure_desktop true

data/lib/rubocop/cop/chef/modernize/windows_zipfile.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   windows_zipfile 'C:\\files\\' do
         #     source 'C:\\Temp\\file.zip'
         #   end

data/lib/rubocop/cop/chef/modernize/zipfile_resource.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   zipfile "C:\file.zip" do
         #     path 'C:\expand_here'
         #   end

data/lib/rubocop/cop/chef/modernize/zypper_repo.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   zypper_repo 'apache' do
         #     baseurl 'http://download.opensuse.org/repositories/Apache'
         #     path '/openSUSE_Leap_42.2'
@@ -31,7 +31,7 @@ module RuboCop
         #     priority '100'
         #   end
         #
-        #   ### correct
+        #   # good
         #   zypper_repository 'apache' do
         #     baseurl 'http://download.opensuse.org/repositories/Apache'
         #     path '/openSUSE_Leap_42.2'

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   apt_repository 'my repo' do
         #     uri 'http://packages.example.com/debian'
         #     components %w(stable main)
@@ -31,7 +31,7 @@ module RuboCop
         #     distribution node['lsb']['codename']
         #   end
         #
-        #   ### correct
+        #   # good
         #   apt_repository 'my repo' do
         #     uri 'http://packages.example.com/debian'
         #     components %w(stable main)

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   apt_repository 'my repo' do
         #     uri 'http://packages.example.com/debian'
         #     components %w(stable main)
@@ -31,7 +31,7 @@ module RuboCop
         #     notifies :run, 'execute[apt-get update]', :immediately
         #   end
         #
-        #   ### correct
+        #   # good
         #   apt_repository 'my repo' do
         #     uri 'http://packages.example.com/debian'
         #     components %w(stable main)

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect in metadata.rb:
+        #   # bad in metadata.rb:
         #
         #    attribute 'zookeeper_bridge/server',
         #              display_name: 'zookeeper server',

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

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

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   allowed_actions [:create, :remove]
         #
         #   # also bad

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

@@ -23,13 +23,13 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   chef_gem 'deep_merge' do
         #     action :nothing
         #     compile_time true
         #   end.run_action(:install)
         #
-        #   ### correct
+        #   # good
         #   chef_gem 'deep_merge' do
         #     action :install
         #     compile_time true

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   grouping 'windows_log_rotate', title: 'Demonstration cookbook with code to switch loggers'
         #
         class GroupingMetadata < Base

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   long_description 'this is my cookbook and this description will never be seen'
         #
         class LongDescriptionMetadata < Base

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

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   platform?('redhat') || platform?('ubuntu')
         #   platform_family?('debian') || platform_family?('rhel')
         #
-        #   ### correct
+        #   # good
         #   platform?('redhat', 'ubuntu')
         #   platform_family?('debian', 'rhel')
         #

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

@@ -31,7 +31,7 @@ module RuboCop
         # name_property of config_file. All throughout the code of this resource we'd
         # use new_resource.config_file when referencing the path to the config.
         #
-        # We can use a friendly name for the block and specific a value to config_file
+        # We can use a friendly name for the block and specify a value for config_file
         # ntp_config 'Configure the main config file' do
         #   config_file '/etc/ntp/ntp.conf'
         #   action :create
@@ -43,7 +43,7 @@ module RuboCop
         #   action :create
         # end
         #
-        # The core tenant of the name property feature is that these properties are optional
+        # The core tenet of the name property feature is that these properties are optional
         # and making them required effectively turns off the functionality provided by name
         # properties. If the goal is to always require the user to pass the config_file property
         # then it should just be made a required property and not a name_property.
@@ -51,11 +51,11 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   property :config_file, String, required: true, name_property: true
         #   attribute :config_file, String, required: true, name_attribute: true
         #
-        #   ### correct
+        #   # good
         #   property :config_file, String, required: true
         #
         class NamePropertyIsRequired < Base

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   node['platform'].to_s
         #   node['platform_family'].to_s
         #   node['platform_version'].to_s
@@ -32,7 +32,7 @@ module RuboCop
         #   node['os'].to_s
         #   node['name'].to_s
         #
-        #   ### correct
+        #   # good
         #   node['platform']
         #   node['platform_family']
         #   node['platform_version']

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

@@ -19,15 +19,15 @@ module RuboCop
   module Cop
     module Chef
       module RedundantCode
-        # When a property has a type of String it can accept any string. There is no need to also validate string inputs against a regex that accept all values.
+        # When a property has a type of String it can accept any string. There is no need to also validate string inputs against a regex that accepts all values.
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   property :config_file, String, regex: /.*/
         #   attribute :config_file, String, regex: /.*/
         #
-        #   ### correct
+        #   # good
         #   property :config_file, String
         #   attribute :config_file, String
         #

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

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

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

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

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

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

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

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

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

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

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

@@ -23,8 +23,8 @@ module RuboCop
         #
         # @example
         #
-        # ### incorrect
-        # property :sensitive, [true, false], default: false
+        #   # bad
+        #   property :sensitive, [true, false], default: false
         #
         class SensitivePropertyInResource < Base
           extend AutoCorrector

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

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

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

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect in metadata.rb:
+        #   # bad 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
         #
-        #   ### incorrect
+        #   # bad
         #   property :foo, String, desired_state: true
         #   attribute :foo, String, desired_state: true
         #
-        #   ### correct
+        #   # good
         #   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
         #
-        #   ### incorrect
+        #   # bad
         #   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
         #
-        #   ### incorrect
+        #   # bad
         #   cookbook_file '/logs/foo/error.log' do
         #     source 'error.log'
         #     owner 'root'
@@ -41,7 +41,7 @@ module RuboCop
         #     not_if { ::File.exist?('/foo/bar') }
         #   end
         #
-        #   ### correct
+        #   # good
         #   cookbook_file '/logs/foo/error.log' do
         #     source 'error.log'
         #     owner 'root'

data/lib/rubocop/cop/chef/security/ssh_private_key.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   file '/Users/bob_bobberson/.ssh/id_rsa' do
         #     content '-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----'
         #     mode '600'

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

@@ -19,16 +19,17 @@ module RuboCop
   module Cop
     module Chef
       module Sharing
-        # Metadata contains default maintainer information from the `chef generate cookbook` command. This should be updated to reflect that actual maintainer of the cookbook.
+        # Metadata contains default maintainer information from the `chef generate cookbook` command. This should be updated to reflect the actual maintainer of the cookbook.
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   maintainer 'YOUR_COMPANY_NAME'
         #   maintainer_email 'YOUR_EMAIL'
         #   maintainer 'The Authors'
         #   maintainer_email 'you@example.com'
-        #   ### correct
+        #
+        #   # good
         #   maintainer 'Bob Bobberson'
         #   maintainer_email 'bob@bobberson.com'
         #

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

@@ -23,10 +23,10 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   license ''
         #
-        #   ### correct
+        #   # good
         #   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
         #
-        #   ### incorrect
+        #   # bad
         #   property :foo, String
         #
-        #   ### correct
+        #   # good
         #   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
         #
-        #   ### correct
+        #   # good
         #   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
         #
-        #   ### correct
+        #   # good
         #   examples <<~DOC
         #     **Specify a global domain value**
         #

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

@@ -23,15 +23,15 @@ module RuboCop
         #
         # @example
         #
-        #   ### incorrect
+        #   # bad
         #   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'
         #
-        #   ### correct
-        #   source_url 'http://github.com/something/something'
-        #   source_url 'http://gitlab.com/something/something'
+        #   # good
+        #   source_url 'https://github.com/something/something'
+        #   source_url 'https://gitlab.com/something/something'
         #
         class InsecureCookbookURL < Base
           extend AutoCorrector