RubyGems - cookstyle - Versions diffs - 7.5.2 → 7.8.3 - Mend

cookstyle 7.5.2 → 7.8.3

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

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

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

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

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

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

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

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

@@ -21,13 +21,15 @@ module RuboCop
       module RedundantCode
         # If a resource includes the `compile_time` property there's no need to also use `.run_action(:some_action)` on the resource block
         #
-        #   # bad
+        # @example
+        #
+        #   #### incorrect
         #   chef_gem 'deep_merge' do
         #     action :nothing
         #     compile_time true
         #   end.run_action(:install)
         #
-        #   # good
+        #   #### correct
         #   chef_gem 'deep_merge' do
         #     action :install
         #     compile_time true

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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   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

@@ -24,7 +24,7 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   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

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

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

@@ -51,12 +51,11 @@ module RuboCop
         #
         # @example
         #
-        #
-        #   # bad
+        #   #### incorrect
         #   property :config_file, String, required: true, name_property: true
         #   attribute :config_file, String, required: true, name_attribute: true
         #
-        #   # good
+        #   #### correct
         #   property :config_file, String, required: true
         #
         class NamePropertyIsRequired < Base

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

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

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

@@ -23,11 +23,11 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   property :config_file, String, regex: /.*/
         #   attribute :config_file, String, regex: /.*/
         #
-        #   # good
+        #   #### correct
         #   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
         #
-        #   # 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,18 +24,20 @@ module RuboCop
         #
         # @example
         #
-        #   # bad
+        #   #### incorrect
         #   license 'Apache 2.0'
         #
-        #   # good
+        #   #### correct
         #   license 'Apache-2.0'
         #   license 'all rights reserved'
         #
-        # list of valid SPDX.org license strings. To build an array run this:
+        # list of valid SPDX.org license strings. To build an array run this ruby:
+        # ```ruby
         # require 'json'
         # require 'net/http'
         # json_data = JSON.parse(Net::HTTP.get(URI('https://raw.githubusercontent.com/spdx/license-list-data/master/json/licenses.json')))
         # licenses = json_data['licenses'].map {|l| l['licenseId'] }.sort
+        # ```
         #
         class InvalidLicenseString < Base
           extend AutoCorrector
@@ -59,6 +61,7 @@ module RuboCop
             AML
             AMPAS
             ANTLR-PD
+            ANTLR-PD-fallback
             APAFML
             APL-1.0
             APSL-1.0
@@ -82,6 +85,7 @@ module RuboCop
             BSD-2-Clause-FreeBSD
             BSD-2-Clause-NetBSD
             BSD-2-Clause-Patent
+            BSD-2-Clause-Views
             BSD-3-Clause
             BSD-3-Clause-Attribution
             BSD-3-Clause-Clear
@@ -95,6 +99,7 @@ module RuboCop
             BSD-Protection
             BSD-Source-Code
             BSL-1.0
+            BUSL-1.1
             Bahyph
             Barr
             Beerware
@@ -102,11 +107,15 @@ module RuboCop
             BitTorrent-1.1
             BlueOak-1.0.0
             Borceux
+            CAL-1.0
+            CAL-1.0-Combined-Work-Exception
             CATOSL-1.1
             CC-BY-1.0
             CC-BY-2.0
             CC-BY-2.5
             CC-BY-3.0
+            CC-BY-3.0-AT
+            CC-BY-3.0-US
             CC-BY-4.0
             CC-BY-NC-1.0
             CC-BY-NC-2.0
@@ -117,6 +126,7 @@ module RuboCop
             CC-BY-NC-ND-2.0
             CC-BY-NC-ND-2.5
             CC-BY-NC-ND-3.0
+            CC-BY-NC-ND-3.0-IGO
             CC-BY-NC-ND-4.0
             CC-BY-NC-SA-1.0
             CC-BY-NC-SA-2.0
@@ -130,8 +140,10 @@ module RuboCop
             CC-BY-ND-4.0
             CC-BY-SA-1.0
             CC-BY-SA-2.0
+            CC-BY-SA-2.0-UK
             CC-BY-SA-2.5
             CC-BY-SA-3.0
+            CC-BY-SA-3.0-AT
             CC-BY-SA-4.0
             CC-PDDC
             CC0-1.0
@@ -147,6 +159,9 @@ module RuboCop
             CECILL-C
             CERN-OHL-1.1
             CERN-OHL-1.2
+            CERN-OHL-P-2.0
+            CERN-OHL-S-2.0
+            CERN-OHL-W-2.0
             CNRI-Jython
             CNRI-Python
             CNRI-Python-GPL-Compatible
@@ -168,6 +183,7 @@ module RuboCop
             ECL-2.0
             EFL-1.0
             EFL-2.0
+            EPICS
             EPL-1.0
             EPL-2.0
             EUDatagrid
@@ -185,15 +201,28 @@ module RuboCop
             Frameworx-1.0
             FreeImage
             GFDL-1.1
+            GFDL-1.1-invariants-only
+            GFDL-1.1-invariants-or-later
+            GFDL-1.1-no-invariants-only
+            GFDL-1.1-no-invariants-or-later
             GFDL-1.1-only
             GFDL-1.1-or-later
             GFDL-1.2
+            GFDL-1.2-invariants-only
+            GFDL-1.2-invariants-or-later
+            GFDL-1.2-no-invariants-only
+            GFDL-1.2-no-invariants-or-later
             GFDL-1.2-only
             GFDL-1.2-or-later
             GFDL-1.3
+            GFDL-1.3-invariants-only
+            GFDL-1.3-invariants-or-later
+            GFDL-1.3-no-invariants-only
+            GFDL-1.3-no-invariants-or-later
             GFDL-1.3-only
             GFDL-1.3-or-later
             GL2PS
+            GLWTPL
             GPL-1.0
             GPL-1.0+
             GPL-1.0-only
@@ -218,7 +247,9 @@ module RuboCop
             Glulxe
             HPND
             HPND-sell-variant
+            HTMLTIDY
             HaskellReport
+            Hippocratic-2.1
             IBM-pibs
             ICU
             IJG
@@ -269,6 +300,7 @@ module RuboCop
             MIT-advertising
             MIT-enna
             MIT-feh
+            MIT-open-group
             MITNFA
             MPL-1.0
             MPL-1.1
@@ -280,12 +312,17 @@ module RuboCop
             MakeIndex
             MirOS
             Motosoto
+            MulanPSL-1.0
+            MulanPSL-2.0
             Multics
             Mup
             NASA-1.3
             NBPL-1.0
+            NCGL-UK-2.0
             NCSA
             NGPL
+            NIST-PD
+            NIST-PD-fallback
             NLOD-1.0
             NLPL
             NOSL
@@ -294,6 +331,7 @@ module RuboCop
             NPOSL-3.0
             NRL
             NTP
+            NTP-0
             Naumen
             Net-SNMP
             NetCDF
@@ -301,12 +339,19 @@ module RuboCop
             Nokia
             Noweb
             Nunit
+            O-UDA-1.0
             OCCT-PL
             OCLC-2.0
             ODC-By-1.0
             ODbL-1.0
             OFL-1.0
+            OFL-1.0-RFN
+            OFL-1.0-no-RFN
             OFL-1.1
+            OFL-1.1-RFN
+            OFL-1.1-no-RFN
+            OGC-1.0
+            OGL-Canada-2.0
             OGL-UK-1.0
             OGL-UK-2.0
             OGL-UK-3.0
@@ -339,8 +384,12 @@ module RuboCop
             PDDL-1.0
             PHP-3.0
             PHP-3.01
+            PSF-2.0
             Parity-6.0.0
+            Parity-7.0.0
             Plexus
+            PolyForm-Noncommercial-1.0.0
+            PolyForm-Small-Business-1.0.0
             PostgreSQL
             Python-2.0
             QPL-1.0
@@ -366,6 +415,8 @@ module RuboCop
             SMPPL
             SNIA
             SPL-1.0
+            SSH-OpenSSH
+            SSH-short
             SSPL-1.0
             SWL
             Saxpath
@@ -386,6 +437,7 @@ module RuboCop
             TOSL
             TU-Berlin-1.0
             TU-Berlin-2.0
+            UCL-1.0
             UPL-1.0
             Unicode-DFS-2015
             Unicode-DFS-2016
@@ -425,10 +477,12 @@ module RuboCop
             dvipdfm
             eCos-2.0
             eGenix
+            etalab-2.0
             gSOAP-1.3b
             gnuplot
             iMatix
             libpng-2.0
+            libselinux-1.0
             libtiff
             mpich2
             psfrag