cookstyle 5.4.13 → 5.5.7

data/lib/cookstyle.rb

@@ -31,6 +31,7 @@ module Cookstyle
 end
 
 require 'rubocop/chef'
+require 'rubocop/chef/cookbook_helpers'
 require 'rubocop/chef/cookbook_only'
 
 # Chef specific cops

data/lib/cookstyle/version.rb

@@ -1,4 +1,4 @@
 module Cookstyle
-  VERSION = "5.4.13".freeze # rubocop: disable Style/StringLiterals
+  VERSION = "5.5.7".freeze # rubocop: disable Style/StringLiterals
   RUBOCOP_VERSION = '0.72.0'.freeze
 end

data/lib/rubocop/chef/cookbook_helpers.rb

@@ -0,0 +1,67 @@
+module RuboCop
+  module Chef
+    # Common node helpers used for matching against Chef Infra Cookbooks
+    module CookbookHelpers
+      # Match particular properties within a resource
+      #
+      # @param [String] resource_name The name of the resource to match
+      # @param [String] property_name The name of the property to match (or action)
+      # @param [<Type>] node The rubocop ast node to search
+      #
+      # @yield
+      #
+      def match_property_in_resource?(resource_name, property_name, node)
+        return unless node.block_type? # resources are blocks if they have properties
+        return unless node.children.first.receiver.nil? # resource blocks don't have a receiver
+        return if node.send_node.arguments.first.is_a?(RuboCop::AST::SymbolNode) # resources have a string name. resource actions have symbols
+
+        # bail if the block doesn't have a name a resource *generally* has a name.
+        # This isn't 100% true with things like apt_update and build_essential, but we'll live
+        # with that for now to avoid the false positives of getting stuck in generic blocks in resources
+        return if node.children.first.arguments.empty?
+
+        # bail out if we're not in the resource we care about or nil was passed (all resources)
+        return unless resource_name.nil? || node.children.first.method?(resource_name.to_sym) # see if we're in the right resource
+
+        resource_block = node.children[2] # the 3rd child is the actual block in the resource
+        return unless resource_block # nil would be an empty block
+        if resource_block.begin_type? # if begin_type we need to iterate over the children
+          resource_block.children.each do |resource_blk_child|
+            extract_send_types(resource_blk_child) do |p|
+              yield(p) if p.method_name == property_name.to_sym
+            end
+          end
+        else # there's only a single property to check
+          extract_send_types(resource_block) do |p|
+            yield(p) if p.method_name == property_name.to_sym
+          end
+        end
+      end
+
+      def method_arg_ast_to_string(ast)
+        # a property without a value. This is totally bogus, but they exist
+        return if ast.children[2].nil?
+        # https://rubular.com/r/6uzOMd6WCHewOu
+        m = ast.children[2].source.match(/^("|')(.*)("|')$/)
+        return m[2] unless m.nil?
+      end
+
+      private
+
+      def extract_send_types(node)
+        return if node.nil? # there are cases we can be passed an empty node
+        case node.type
+        when :send
+          yield(node) if node.receiver.nil? # if it's not nil then we're not in a property foo we're in bar.foo
+        when :while
+          extract_send_types(node.body) { |t| yield(t) }
+        when :if
+          node.branches.each { |n| extract_send_types(n) { |t| yield(t) } }
+        when :case
+          node.when_branches.each { |n| extract_send_types(n.body) { |t| yield(t) } } # unless node.when_branches.nil?
+          extract_send_types(node.else_branch) { |t| yield(t) } if node.else_branch
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/chef/correctness/block_guard_clause_string_only.rb

@@ -17,41 +17,44 @@
 module RuboCop
   module Cop
     module Chef
-      # Use secure Github and Gitlab URLs for source_url and issues_url
-      #
-      # @example
-      #
-      #   # bad
-      #   template '/etc/foo' do
-      #     mode '0644'
-      #     source 'foo.erb'
-      #     only_if { 'test -f /etc/foo' }
-      #   end
-      #
-      #   # good
-      #   template '/etc/foo' do
-      #     mode '0644'
-      #     source 'foo.erb'
-      #     only_if 'test -f /etc/foo'
-      #   end
-      #
-      class BlockGuardWithOnlyString < Cop
-        MSG = 'A resource guard (not_if/only_if) that is a string should not be wrapped in {}. Wrapping a guard string in {} causes it be executed as Ruby code which will always returns true instead of a shell command that will actually run.'.freeze
+      module ChefCorrectness
+        # A resource guard (not_if/only_if) that is a string should not be wrapped in {}.
+        # Wrapping a guard string in {} causes it be executed as Ruby code which will always returns true instead of a shell command that will actually run.
+        #
+        # @example
+        #
+        #   # bad
+        #   template '/etc/foo' do
+        #     mode '0644'
+        #     source 'foo.erb'
+        #     only_if { 'test -f /etc/foo' }
+        #   end
+        #
+        #   # good
+        #   template '/etc/foo' do
+        #     mode '0644'
+        #     source 'foo.erb'
+        #     only_if 'test -f /etc/foo'
+        #   end
+        #
+        class BlockGuardWithOnlyString < Cop
+          MSG = 'A resource guard (not_if/only_if) that is a string should not be wrapped in {}. Wrapping a guard string in {} causes it be executed as Ruby code which will always returns true instead of a shell command that will actually run.'.freeze
 
-        def_node_matcher :block_guard_with_only_string?, <<-PATTERN
-          (block (send nil? ${:not_if :only_if}) (args) (str $_) )
-        PATTERN
+          def_node_matcher :block_guard_with_only_string?, <<-PATTERN
+            (block (send nil? ${:not_if :only_if}) (args) (str $_) )
+          PATTERN
 
-        def on_block(node)
-          block_guard_with_only_string?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_block(node)
+            block_guard_with_only_string?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
-        end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            new_val = "#{node.method_name} #{node.body.source}"
-            corrector.replace(node.loc.expression, new_val)
+          def autocorrect(node)
+            lambda do |corrector|
+              new_val = "#{node.method_name} #{node.body.source}"
+              corrector.replace(node.loc.expression, new_val)
+            end
           end
         end
       end

data/lib/rubocop/cop/chef/correctness/cb_depends_on_self.rb

@@ -29,26 +29,28 @@ module RuboCop
       #   # good
       #   name 'foo'
       #
-      class CookbooksDependsOnSelf < Cop
-        MSG = 'A cookbook cannot depend on itself. This will fail on Chef Infra Client 13+'.freeze
+      module ChefCorrectness
+        class CookbooksDependsOnSelf < Cop
+          MSG = 'A cookbook cannot depend on itself. This will fail on Chef Infra Client 13+'.freeze
 
-        def_node_search :dependencies, '(send nil? :depends str ...)'
-        def_node_matcher :cb_name?, '(send nil? :name str ...)'
+          def_node_search :dependencies, '(send nil? :depends str ...)'
+          def_node_matcher :cb_name?, '(send nil? :name str ...)'
 
-        def on_send(node)
-          cb_name?(node) do
-            dependencies(processed_source.ast).each do |dep|
-              if dep.arguments == node.arguments
-                node = dep # set our dependency node as the node for autocorrecting later
-                add_offense(node, location: dep.source_range, message: MSG, severity: :refactor)
+          def on_send(node)
+            cb_name?(node) do
+              dependencies(processed_source.ast).each do |dep|
+                if dep.arguments == node.arguments
+                  node = dep # set our dependency node as the node for autocorrecting later
+                  add_offense(node, location: dep.source_range, message: MSG, severity: :refactor)
+                end
               end
             end
           end
-        end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.remove(node.source_range)
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.remove(node.source_range)
+            end
           end
         end
       end

data/lib/rubocop/cop/chef/correctness/default_maintainer_metadata.rb

@@ -18,28 +18,30 @@
 module RuboCop
   module Cop
     module Chef
-      # Metadata contains default maintainer information from the `chef generate cookbook`
-      # command. This should be updated to reflect that actual maintainer of the cookbook.
-      #
-      # @example
-      #
-      #   # bad
-      #   maintainer 'YOUR_COMPANY_NAME'
-      #   maintainer_email 'YOUR_EMAIL'
-      #
-      #   # good
-      #   maintainer 'Bob Bobberson'
-      #   maintainer_email 'bob@bobberson.com'
-      #
+      module ChefCorrectness
+        # Metadata contains default maintainer information from the `chef generate cookbook`
+        # command. This should be updated to reflect that actual maintainer of the cookbook.
+        #
+        # @example
+        #
+        #   # bad
+        #   maintainer 'YOUR_COMPANY_NAME'
+        #   maintainer_email 'YOUR_EMAIL'
+        #   maintainer 'The Authors'
+        #   maintainer_email 'you@example.com'
+        #   # good
+        #   maintainer 'Bob Bobberson'
+        #   maintainer_email 'bob@bobberson.com'
+        #
+        class DefaultMetadataMaintainer < Cop
+          MSG = 'Metadata contains default maintainer information from the cookbook generator. Add actual cookbook maintainer information to the metadata.rb.'.freeze
 
-      class DefaultMetadataMaintainer < Cop
-        MSG = 'Metadata contains default maintainer information from the cookbook generator. Add actual cookbook maintainer information to the metadata.rb.'.freeze
+          def_node_matcher :default_metadata?, '(send nil? {:maintainer :maintainer_email} (str {"YOUR_COMPANY_NAME" "The Authors" "YOUR_EMAIL" "you@example.com"}))'
 
-        def_node_matcher :default_metadata?, '(send nil? {:maintainer :maintainer_email} (str {"YOUR_COMPANY_NAME" "YOUR_EMAIL"}))'
-
-        def on_send(node)
-          default_metadata?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_send(node)
+            default_metadata?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
         end
       end

data/lib/rubocop/cop/chef/correctness/insecure_cookbook_url.rb

@@ -17,41 +17,43 @@
 module RuboCop
   module Cop
     module Chef
-      # Use secure Github and Gitlab URLs for source_url and issues_url
-      #
-      # @example
-      #
-      #   # 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'
-      #
-      #   # good
-      #   source_url 'http://github.com/something/something'
-      #   source_url 'http://gitlab.com/something/something'
-      #
-      class InsecureCookbookURL < Cop
-        MSG = 'Insecure http Github or Gitlab URLs for metadata source_url/issues_url fields'.freeze
+      module ChefCorrectness
+        # Use secure Github and Gitlab URLs for source_url and issues_url
+        #
+        # @example
+        #
+        #   # 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'
+        #
+        #   # good
+        #   source_url 'http://github.com/something/something'
+        #   source_url 'http://gitlab.com/something/something'
+        #
+        class InsecureCookbookURL < Cop
+          MSG = 'Insecure http Github or Gitlab URLs for metadata source_url/issues_url fields'.freeze
 
-        def_node_matcher :insecure_cb_url?, <<-PATTERN
-          (send nil? {:source_url :issues_url} (str #insecure_url?))
-        PATTERN
+          def_node_matcher :insecure_cb_url?, <<-PATTERN
+            (send nil? {:source_url :issues_url} (str #insecure_url?))
+          PATTERN
 
-        def insecure_url?(url)
-          # https://rubular.com/r/dS6L6bQZvwWxWq
-          url.match?(%r{http://(www.)*git(hub|lab)})
-        end
+          def insecure_url?(url)
+            # https://rubular.com/r/dS6L6bQZvwWxWq
+            url.match?(%r{http://(www.)*git(hub|lab)})
+          end
 
-        def on_send(node)
-          insecure_cb_url?(node) do
-            add_offense(node, location: :expression, message: MSG, severity: :refactor)
+          def on_send(node)
+            insecure_cb_url?(node) do
+              add_offense(node, location: :expression, message: MSG, severity: :refactor)
+            end
           end
-        end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.loc.expression, node.source.gsub(%r{http://(www.)*}, 'https://'))
+          def autocorrect(node)
+            lambda do |corrector|
+              corrector.replace(node.loc.expression, node.source.gsub(%r{http://(www.)*}, 'https://'))
+            end
           end
         end
       end

data/lib/rubocop/cop/chef/correctness/invalid_license_string.rb

@@ -18,471 +18,472 @@
 module RuboCop
   module Cop
     module Chef
-      # metadata.rb license field should include a SPDX compliant string
-      # or "all right reserved" (not case sensitive)
-      #
-      # @example
-      #
-      #   # bad
-      #   license 'Apache 2.0'
-      #
-      #   # good
-      #   license 'Apache-2.0'
-      #   license 'all rights reserved'
-      #
-      # list of valid SPDX.org license strings. To build an array run this:
-      # 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
-      #
+      module ChefCorrectness
+        # metadata.rb license field should include a SPDX compliant string
+        # or "all right reserved" (not case sensitive)
+        #
+        # @example
+        #
+        #   # bad
+        #   license 'Apache 2.0'
+        #
+        #   # good
+        #   license 'Apache-2.0'
+        #   license 'all rights reserved'
+        #
+        # list of valid SPDX.org license strings. To build an array run this:
+        # 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 < Cop
+          VALID_LICENSE_STRING = %w(
+            0BSD
+            AAL
+            ADSL
+            AFL-1.1
+            AFL-1.2
+            AFL-2.0
+            AFL-2.1
+            AFL-3.0
+            AGPL-1.0
+            AGPL-1.0-only
+            AGPL-1.0-or-later
+            AGPL-3.0
+            AGPL-3.0-only
+            AGPL-3.0-or-later
+            AMDPLPA
+            AML
+            AMPAS
+            ANTLR-PD
+            APAFML
+            APL-1.0
+            APSL-1.0
+            APSL-1.1
+            APSL-1.2
+            APSL-2.0
+            Abstyles
+            Adobe-2006
+            Adobe-Glyph
+            Afmparse
+            Aladdin
+            Apache-1.0
+            Apache-1.1
+            Apache-2.0
+            Artistic-1.0
+            Artistic-1.0-Perl
+            Artistic-1.0-cl8
+            Artistic-2.0
+            BSD-1-Clause
+            BSD-2-Clause
+            BSD-2-Clause-FreeBSD
+            BSD-2-Clause-NetBSD
+            BSD-2-Clause-Patent
+            BSD-3-Clause
+            BSD-3-Clause-Attribution
+            BSD-3-Clause-Clear
+            BSD-3-Clause-LBNL
+            BSD-3-Clause-No-Nuclear-License
+            BSD-3-Clause-No-Nuclear-License-2014
+            BSD-3-Clause-No-Nuclear-Warranty
+            BSD-3-Clause-Open-MPI
+            BSD-4-Clause
+            BSD-4-Clause-UC
+            BSD-Protection
+            BSD-Source-Code
+            BSL-1.0
+            Bahyph
+            Barr
+            Beerware
+            BitTorrent-1.0
+            BitTorrent-1.1
+            BlueOak-1.0.0
+            Borceux
+            CATOSL-1.1
+            CC-BY-1.0
+            CC-BY-2.0
+            CC-BY-2.5
+            CC-BY-3.0
+            CC-BY-4.0
+            CC-BY-NC-1.0
+            CC-BY-NC-2.0
+            CC-BY-NC-2.5
+            CC-BY-NC-3.0
+            CC-BY-NC-4.0
+            CC-BY-NC-ND-1.0
+            CC-BY-NC-ND-2.0
+            CC-BY-NC-ND-2.5
+            CC-BY-NC-ND-3.0
+            CC-BY-NC-ND-4.0
+            CC-BY-NC-SA-1.0
+            CC-BY-NC-SA-2.0
+            CC-BY-NC-SA-2.5
+            CC-BY-NC-SA-3.0
+            CC-BY-NC-SA-4.0
+            CC-BY-ND-1.0
+            CC-BY-ND-2.0
+            CC-BY-ND-2.5
+            CC-BY-ND-3.0
+            CC-BY-ND-4.0
+            CC-BY-SA-1.0
+            CC-BY-SA-2.0
+            CC-BY-SA-2.5
+            CC-BY-SA-3.0
+            CC-BY-SA-4.0
+            CC-PDDC
+            CC0-1.0
+            CDDL-1.0
+            CDDL-1.1
+            CDLA-Permissive-1.0
+            CDLA-Sharing-1.0
+            CECILL-1.0
+            CECILL-1.1
+            CECILL-2.0
+            CECILL-2.1
+            CECILL-B
+            CECILL-C
+            CERN-OHL-1.1
+            CERN-OHL-1.2
+            CNRI-Jython
+            CNRI-Python
+            CNRI-Python-GPL-Compatible
+            CPAL-1.0
+            CPL-1.0
+            CPOL-1.02
+            CUA-OPL-1.0
+            Caldera
+            ClArtistic
+            Condor-1.1
+            Crossword
+            CrystalStacker
+            Cube
+            D-FSL-1.0
+            DOC
+            DSDP
+            Dotseqn
+            ECL-1.0
+            ECL-2.0
+            EFL-1.0
+            EFL-2.0
+            EPL-1.0
+            EPL-2.0
+            EUDatagrid
+            EUPL-1.0
+            EUPL-1.1
+            EUPL-1.2
+            Entessa
+            ErlPL-1.1
+            Eurosym
+            FSFAP
+            FSFUL
+            FSFULLR
+            FTL
+            Fair
+            Frameworx-1.0
+            FreeImage
+            GFDL-1.1
+            GFDL-1.1-only
+            GFDL-1.1-or-later
+            GFDL-1.2
+            GFDL-1.2-only
+            GFDL-1.2-or-later
+            GFDL-1.3
+            GFDL-1.3-only
+            GFDL-1.3-or-later
+            GL2PS
+            GPL-1.0
+            GPL-1.0+
+            GPL-1.0-only
+            GPL-1.0-or-later
+            GPL-2.0
+            GPL-2.0+
+            GPL-2.0-only
+            GPL-2.0-or-later
+            GPL-2.0-with-GCC-exception
+            GPL-2.0-with-autoconf-exception
+            GPL-2.0-with-bison-exception
+            GPL-2.0-with-classpath-exception
+            GPL-2.0-with-font-exception
+            GPL-3.0
+            GPL-3.0+
+            GPL-3.0-only
+            GPL-3.0-or-later
+            GPL-3.0-with-GCC-exception
+            GPL-3.0-with-autoconf-exception
+            Giftware
+            Glide
+            Glulxe
+            HPND
+            HPND-sell-variant
+            HaskellReport
+            IBM-pibs
+            ICU
+            IJG
+            IPA
+            IPL-1.0
+            ISC
+            ImageMagick
+            Imlib2
+            Info-ZIP
+            Intel
+            Intel-ACPI
+            Interbase-1.0
+            JPNIC
+            JSON
+            JasPer-2.0
+            LAL-1.2
+            LAL-1.3
+            LGPL-2.0
+            LGPL-2.0+
+            LGPL-2.0-only
+            LGPL-2.0-or-later
+            LGPL-2.1
+            LGPL-2.1+
+            LGPL-2.1-only
+            LGPL-2.1-or-later
+            LGPL-3.0
+            LGPL-3.0+
+            LGPL-3.0-only
+            LGPL-3.0-or-later
+            LGPLLR
+            LPL-1.0
+            LPL-1.02
+            LPPL-1.0
+            LPPL-1.1
+            LPPL-1.2
+            LPPL-1.3a
+            LPPL-1.3c
+            Latex2e
+            Leptonica
+            LiLiQ-P-1.1
+            LiLiQ-R-1.1
+            LiLiQ-Rplus-1.1
+            Libpng
+            Linux-OpenIB
+            MIT
+            MIT-0
+            MIT-CMU
+            MIT-advertising
+            MIT-enna
+            MIT-feh
+            MITNFA
+            MPL-1.0
+            MPL-1.1
+            MPL-2.0
+            MPL-2.0-no-copyleft-exception
+            MS-PL
+            MS-RL
+            MTLL
+            MakeIndex
+            MirOS
+            Motosoto
+            Multics
+            Mup
+            NASA-1.3
+            NBPL-1.0
+            NCSA
+            NGPL
+            NLOD-1.0
+            NLPL
+            NOSL
+            NPL-1.0
+            NPL-1.1
+            NPOSL-3.0
+            NRL
+            NTP
+            Naumen
+            Net-SNMP
+            NetCDF
+            Newsletr
+            Nokia
+            Noweb
+            Nunit
+            OCCT-PL
+            OCLC-2.0
+            ODC-By-1.0
+            ODbL-1.0
+            OFL-1.0
+            OFL-1.1
+            OGL-UK-1.0
+            OGL-UK-2.0
+            OGL-UK-3.0
+            OGTSL
+            OLDAP-1.1
+            OLDAP-1.2
+            OLDAP-1.3
+            OLDAP-1.4
+            OLDAP-2.0
+            OLDAP-2.0.1
+            OLDAP-2.1
+            OLDAP-2.2
+            OLDAP-2.2.1
+            OLDAP-2.2.2
+            OLDAP-2.3
+            OLDAP-2.4
+            OLDAP-2.5
+            OLDAP-2.6
+            OLDAP-2.7
+            OLDAP-2.8
+            OML
+            OPL-1.0
+            OSET-PL-2.1
+            OSL-1.0
+            OSL-1.1
+            OSL-2.0
+            OSL-2.1
+            OSL-3.0
+            OpenSSL
+            PDDL-1.0
+            PHP-3.0
+            PHP-3.01
+            Parity-6.0.0
+            Plexus
+            PostgreSQL
+            Python-2.0
+            QPL-1.0
+            Qhull
+            RHeCos-1.1
+            RPL-1.1
+            RPL-1.5
+            RPSL-1.0
+            RSA-MD
+            RSCPL
+            Rdisc
+            Ruby
+            SAX-PD
+            SCEA
+            SGI-B-1.0
+            SGI-B-1.1
+            SGI-B-2.0
+            SHL-0.5
+            SHL-0.51
+            SISSL
+            SISSL-1.2
+            SMLNJ
+            SMPPL
+            SNIA
+            SPL-1.0
+            SSPL-1.0
+            SWL
+            Saxpath
+            Sendmail
+            Sendmail-8.23
+            SimPL-2.0
+            Sleepycat
+            Spencer-86
+            Spencer-94
+            Spencer-99
+            StandardML-NJ
+            SugarCRM-1.1.3
+            TAPR-OHL-1.0
+            TCL
+            TCP-wrappers
+            TMate
+            TORQUE-1.1
+            TOSL
+            TU-Berlin-1.0
+            TU-Berlin-2.0
+            UPL-1.0
+            Unicode-DFS-2015
+            Unicode-DFS-2016
+            Unicode-TOU
+            Unlicense
+            VOSTROM
+            VSL-1.0
+            Vim
+            W3C
+            W3C-19980720
+            W3C-20150513
+            WTFPL
+            Watcom-1.0
+            Wsuipa
+            X11
+            XFree86-1.1
+            XSkat
+            Xerox
+            Xnet
+            YPL-1.0
+            YPL-1.1
+            ZPL-1.1
+            ZPL-2.0
+            ZPL-2.1
+            Zed
+            Zend-2.0
+            Zimbra-1.3
+            Zimbra-1.4
+            Zlib
+            blessing
+            bzip2-1.0.5
+            bzip2-1.0.6
+            copyleft-next-0.3.0
+            copyleft-next-0.3.1
+            curl
+            diffmark
+            dvipdfm
+            eCos-2.0
+            eGenix
+            gSOAP-1.3b
+            gnuplot
+            iMatix
+            libpng-2.0
+            libtiff
+            mpich2
+            psfrag
+            psutils
+            wxWindows
+            xinetd
+            xpp
+            zlib-acknowledgement
+          ).freeze
 
-      class InvalidLicenseString < Cop
-        VALID_LICENSE_STRING = %w(
-          0BSD
-          AAL
-          ADSL
-          AFL-1.1
-          AFL-1.2
-          AFL-2.0
-          AFL-2.1
-          AFL-3.0
-          AGPL-1.0
-          AGPL-1.0-only
-          AGPL-1.0-or-later
-          AGPL-3.0
-          AGPL-3.0-only
-          AGPL-3.0-or-later
-          AMDPLPA
-          AML
-          AMPAS
-          ANTLR-PD
-          APAFML
-          APL-1.0
-          APSL-1.0
-          APSL-1.1
-          APSL-1.2
-          APSL-2.0
-          Abstyles
-          Adobe-2006
-          Adobe-Glyph
-          Afmparse
-          Aladdin
-          Apache-1.0
-          Apache-1.1
-          Apache-2.0
-          Artistic-1.0
-          Artistic-1.0-Perl
-          Artistic-1.0-cl8
-          Artistic-2.0
-          BSD-1-Clause
-          BSD-2-Clause
-          BSD-2-Clause-FreeBSD
-          BSD-2-Clause-NetBSD
-          BSD-2-Clause-Patent
-          BSD-3-Clause
-          BSD-3-Clause-Attribution
-          BSD-3-Clause-Clear
-          BSD-3-Clause-LBNL
-          BSD-3-Clause-No-Nuclear-License
-          BSD-3-Clause-No-Nuclear-License-2014
-          BSD-3-Clause-No-Nuclear-Warranty
-          BSD-3-Clause-Open-MPI
-          BSD-4-Clause
-          BSD-4-Clause-UC
-          BSD-Protection
-          BSD-Source-Code
-          BSL-1.0
-          Bahyph
-          Barr
-          Beerware
-          BitTorrent-1.0
-          BitTorrent-1.1
-          BlueOak-1.0.0
-          Borceux
-          CATOSL-1.1
-          CC-BY-1.0
-          CC-BY-2.0
-          CC-BY-2.5
-          CC-BY-3.0
-          CC-BY-4.0
-          CC-BY-NC-1.0
-          CC-BY-NC-2.0
-          CC-BY-NC-2.5
-          CC-BY-NC-3.0
-          CC-BY-NC-4.0
-          CC-BY-NC-ND-1.0
-          CC-BY-NC-ND-2.0
-          CC-BY-NC-ND-2.5
-          CC-BY-NC-ND-3.0
-          CC-BY-NC-ND-4.0
-          CC-BY-NC-SA-1.0
-          CC-BY-NC-SA-2.0
-          CC-BY-NC-SA-2.5
-          CC-BY-NC-SA-3.0
-          CC-BY-NC-SA-4.0
-          CC-BY-ND-1.0
-          CC-BY-ND-2.0
-          CC-BY-ND-2.5
-          CC-BY-ND-3.0
-          CC-BY-ND-4.0
-          CC-BY-SA-1.0
-          CC-BY-SA-2.0
-          CC-BY-SA-2.5
-          CC-BY-SA-3.0
-          CC-BY-SA-4.0
-          CC-PDDC
-          CC0-1.0
-          CDDL-1.0
-          CDDL-1.1
-          CDLA-Permissive-1.0
-          CDLA-Sharing-1.0
-          CECILL-1.0
-          CECILL-1.1
-          CECILL-2.0
-          CECILL-2.1
-          CECILL-B
-          CECILL-C
-          CERN-OHL-1.1
-          CERN-OHL-1.2
-          CNRI-Jython
-          CNRI-Python
-          CNRI-Python-GPL-Compatible
-          CPAL-1.0
-          CPL-1.0
-          CPOL-1.02
-          CUA-OPL-1.0
-          Caldera
-          ClArtistic
-          Condor-1.1
-          Crossword
-          CrystalStacker
-          Cube
-          D-FSL-1.0
-          DOC
-          DSDP
-          Dotseqn
-          ECL-1.0
-          ECL-2.0
-          EFL-1.0
-          EFL-2.0
-          EPL-1.0
-          EPL-2.0
-          EUDatagrid
-          EUPL-1.0
-          EUPL-1.1
-          EUPL-1.2
-          Entessa
-          ErlPL-1.1
-          Eurosym
-          FSFAP
-          FSFUL
-          FSFULLR
-          FTL
-          Fair
-          Frameworx-1.0
-          FreeImage
-          GFDL-1.1
-          GFDL-1.1-only
-          GFDL-1.1-or-later
-          GFDL-1.2
-          GFDL-1.2-only
-          GFDL-1.2-or-later
-          GFDL-1.3
-          GFDL-1.3-only
-          GFDL-1.3-or-later
-          GL2PS
-          GPL-1.0
-          GPL-1.0+
-          GPL-1.0-only
-          GPL-1.0-or-later
-          GPL-2.0
-          GPL-2.0+
-          GPL-2.0-only
-          GPL-2.0-or-later
-          GPL-2.0-with-GCC-exception
-          GPL-2.0-with-autoconf-exception
-          GPL-2.0-with-bison-exception
-          GPL-2.0-with-classpath-exception
-          GPL-2.0-with-font-exception
-          GPL-3.0
-          GPL-3.0+
-          GPL-3.0-only
-          GPL-3.0-or-later
-          GPL-3.0-with-GCC-exception
-          GPL-3.0-with-autoconf-exception
-          Giftware
-          Glide
-          Glulxe
-          HPND
-          HPND-sell-variant
-          HaskellReport
-          IBM-pibs
-          ICU
-          IJG
-          IPA
-          IPL-1.0
-          ISC
-          ImageMagick
-          Imlib2
-          Info-ZIP
-          Intel
-          Intel-ACPI
-          Interbase-1.0
-          JPNIC
-          JSON
-          JasPer-2.0
-          LAL-1.2
-          LAL-1.3
-          LGPL-2.0
-          LGPL-2.0+
-          LGPL-2.0-only
-          LGPL-2.0-or-later
-          LGPL-2.1
-          LGPL-2.1+
-          LGPL-2.1-only
-          LGPL-2.1-or-later
-          LGPL-3.0
-          LGPL-3.0+
-          LGPL-3.0-only
-          LGPL-3.0-or-later
-          LGPLLR
-          LPL-1.0
-          LPL-1.02
-          LPPL-1.0
-          LPPL-1.1
-          LPPL-1.2
-          LPPL-1.3a
-          LPPL-1.3c
-          Latex2e
-          Leptonica
-          LiLiQ-P-1.1
-          LiLiQ-R-1.1
-          LiLiQ-Rplus-1.1
-          Libpng
-          Linux-OpenIB
-          MIT
-          MIT-0
-          MIT-CMU
-          MIT-advertising
-          MIT-enna
-          MIT-feh
-          MITNFA
-          MPL-1.0
-          MPL-1.1
-          MPL-2.0
-          MPL-2.0-no-copyleft-exception
-          MS-PL
-          MS-RL
-          MTLL
-          MakeIndex
-          MirOS
-          Motosoto
-          Multics
-          Mup
-          NASA-1.3
-          NBPL-1.0
-          NCSA
-          NGPL
-          NLOD-1.0
-          NLPL
-          NOSL
-          NPL-1.0
-          NPL-1.1
-          NPOSL-3.0
-          NRL
-          NTP
-          Naumen
-          Net-SNMP
-          NetCDF
-          Newsletr
-          Nokia
-          Noweb
-          Nunit
-          OCCT-PL
-          OCLC-2.0
-          ODC-By-1.0
-          ODbL-1.0
-          OFL-1.0
-          OFL-1.1
-          OGL-UK-1.0
-          OGL-UK-2.0
-          OGL-UK-3.0
-          OGTSL
-          OLDAP-1.1
-          OLDAP-1.2
-          OLDAP-1.3
-          OLDAP-1.4
-          OLDAP-2.0
-          OLDAP-2.0.1
-          OLDAP-2.1
-          OLDAP-2.2
-          OLDAP-2.2.1
-          OLDAP-2.2.2
-          OLDAP-2.3
-          OLDAP-2.4
-          OLDAP-2.5
-          OLDAP-2.6
-          OLDAP-2.7
-          OLDAP-2.8
-          OML
-          OPL-1.0
-          OSET-PL-2.1
-          OSL-1.0
-          OSL-1.1
-          OSL-2.0
-          OSL-2.1
-          OSL-3.0
-          OpenSSL
-          PDDL-1.0
-          PHP-3.0
-          PHP-3.01
-          Parity-6.0.0
-          Plexus
-          PostgreSQL
-          Python-2.0
-          QPL-1.0
-          Qhull
-          RHeCos-1.1
-          RPL-1.1
-          RPL-1.5
-          RPSL-1.0
-          RSA-MD
-          RSCPL
-          Rdisc
-          Ruby
-          SAX-PD
-          SCEA
-          SGI-B-1.0
-          SGI-B-1.1
-          SGI-B-2.0
-          SHL-0.5
-          SHL-0.51
-          SISSL
-          SISSL-1.2
-          SMLNJ
-          SMPPL
-          SNIA
-          SPL-1.0
-          SSPL-1.0
-          SWL
-          Saxpath
-          Sendmail
-          Sendmail-8.23
-          SimPL-2.0
-          Sleepycat
-          Spencer-86
-          Spencer-94
-          Spencer-99
-          StandardML-NJ
-          SugarCRM-1.1.3
-          TAPR-OHL-1.0
-          TCL
-          TCP-wrappers
-          TMate
-          TORQUE-1.1
-          TOSL
-          TU-Berlin-1.0
-          TU-Berlin-2.0
-          UPL-1.0
-          Unicode-DFS-2015
-          Unicode-DFS-2016
-          Unicode-TOU
-          Unlicense
-          VOSTROM
-          VSL-1.0
-          Vim
-          W3C
-          W3C-19980720
-          W3C-20150513
-          WTFPL
-          Watcom-1.0
-          Wsuipa
-          X11
-          XFree86-1.1
-          XSkat
-          Xerox
-          Xnet
-          YPL-1.0
-          YPL-1.1
-          ZPL-1.1
-          ZPL-2.0
-          ZPL-2.1
-          Zed
-          Zend-2.0
-          Zimbra-1.3
-          Zimbra-1.4
-          Zlib
-          blessing
-          bzip2-1.0.5
-          bzip2-1.0.6
-          copyleft-next-0.3.0
-          copyleft-next-0.3.1
-          curl
-          diffmark
-          dvipdfm
-          eCos-2.0
-          eGenix
-          gSOAP-1.3b
-          gnuplot
-          iMatix
-          libpng-2.0
-          libtiff
-          mpich2
-          psfrag
-          psutils
-          wxWindows
-          xinetd
-          xpp
-          zlib-acknowledgement
-        ).freeze
+          COMMON_TYPOS = {
+            "all_rights": 'all rights reserved',
+            "apache 2.0": 'Apache-2.0',
+            "apache v2.0": 'Apache-2.0',
+            "apache license version 2.0": 'Apache-2.0',
+            "apache2": 'Apache-2.0',
+            "mit": 'MIT',
+            '3-clause bsd': 'BSD-3-Clause',
+            'gnu public license 3.0': 'GPL-3.0',
+            'gpl v2': 'GPL-2.0',
+            'gpl v3': 'GPL-3.0',
+            'gplv2': 'GPL-2.0',
+            'gplv3': 'GPL-3.0',
+            'mit license': 'MIT',
+          }.freeze
 
-        COMMON_TYPOS = {
-          "all_rights": 'all rights reserved',
-          "apache 2.0": 'Apache-2.0',
-          "apache v2.0": 'Apache-2.0',
-          "apache license version 2.0": 'Apache-2.0',
-          "apache2": 'Apache-2.0',
-          "mit": 'MIT',
-          '3-clause bsd': 'BSD-3-Clause',
-          'gnu public license 3.0': 'GPL-3.0',
-          'gpl v2': 'GPL-2.0',
-          'gpl v3': 'GPL-3.0',
-          'gplv2': 'GPL-2.0',
-          'gplv3': 'GPL-3.0',
-          'mit license': 'MIT',
-        }.freeze
+          MSG = 'Cookbook metadata.rb does not use a SPDX compliant license string or "all rights reserved". See https://spdx.org/licenses/ for a complete list of license identifiers.'.freeze
 
-        MSG = 'Cookbook metadata.rb does not use a SPDX compliant license string or "all rights reserved". See https://spdx.org/licenses/ for a complete list of license identifiers.'.freeze
+          def_node_matcher :license?, '(send nil? :license $str ...)'
 
-        def_node_matcher :license?, '(send nil? :license $str ...)'
-
-        def on_send(node)
-          license?(node) do |license|
-            unless valid_license?(license.str_content)
-              add_offense(license, location: :expression, message: MSG, severity: :refactor)
+          def on_send(node)
+            license?(node) do |license|
+              unless valid_license?(license.str_content)
+                add_offense(license, location: :expression, message: MSG, severity: :refactor)
+              end
             end
           end
-        end
 
-        def autocorrect(node)
-          correct_string = autocorrect_license_string(node.str_content)
-          if correct_string
-            lambda do |corrector|
-              corrector.replace(node.loc.expression, "'#{correct_string}'")
+          def autocorrect(node)
+            correct_string = autocorrect_license_string(node.str_content)
+            if correct_string
+              lambda do |corrector|
+                corrector.replace(node.loc.expression, "'#{correct_string}'")
+              end
             end
           end
-        end
 
-        # private
+          # private
 
-        def autocorrect_license_string(bad_string)
-          COMMON_TYPOS[bad_string.delete(',').downcase.to_sym]
-        end
+          def autocorrect_license_string(bad_string)
+            COMMON_TYPOS[bad_string.delete(',').downcase.to_sym]
+          end
 
-        def valid_license?(license)
-          VALID_LICENSE_STRING.include?(license) ||
-            license.downcase == 'all rights reserved'
+          def valid_license?(license)
+            VALID_LICENSE_STRING.include?(license) ||
+              license.downcase == 'all rights reserved'
+          end
         end
       end
     end