Lint/BooleanSymbol

Boolean symbols are used to workaround a bug in puppet's type DSL that prevents
falsey properties from being managed (PUP-2368). In general this enables the
cop, but excludes specific files and lines where symbols are needed.

Author: joshcooper

.rubocop.yml

@@ -17,6 +17,17 @@ AllCops:
     - 'lib/puppet/vendor/**/*'
     - 'lib/puppet/pops/parser/eparser.rb'
 
+# puppet uses symbol booleans in types and providers to work around long standing
+# bugs when trying to manage falsey pararameters and properties
+Lint/BooleanSymbol:
+  Enabled: true
+  Exclude:
+    - 'lib/puppet/type.rb'
+    - 'lib/puppet/type/**/*.rb'
+    - 'lib/puppet/provider/**/*.rb'
+    - 'lib/puppet/reference/providers.rb'
+    - 'lib/puppet/parameter/value.rb'
+
 Metrics/AbcSize:
   Enabled: false
 

.rubocop_todo.yml

@@ -580,10 +580,6 @@ Layout/TrailingEmptyLines:
 Layout/TrailingWhitespace:
   Enabled: false
 
-# This cop supports safe auto-correction (--auto-correct).
-Lint/BooleanSymbol:
-  Enabled: false
-
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: enums
 Lint/ConstantDefinitionInBlock:

lib/puppet/coercion.rb

@@ -19,9 +19,9 @@ def self.boolean(value)
     end
 
     case value
-    when true, :true, 'true', :yes, 'yes'
+    when true, :true, 'true', :yes, 'yes' # rubocop:disable Lint/BooleanSymbol
       true
-    when false, :false, 'false', :no, 'no'
+    when false, :false, 'false', :no, 'no' # rubocop:disable Lint/BooleanSymbol
       false
     else
       fail('expected a boolean value')

lib/puppet/configurer.rb

@@ -528,7 +528,7 @@ def valid_server_environment?
     session = Puppet.lookup(:http_session)
     begin
       fs = session.route_to(:fileserver)
-      fs.get_file_metadatas(path: URI(Puppet[:pluginsource]).path, recurse: :false, environment: @environment)
+      fs.get_file_metadatas(path: URI(Puppet[:pluginsource]).path, recurse: :false, environment: @environment) # rubocop:disable Lint/BooleanSymbol
       true
     rescue Puppet::HTTP::ResponseError => detail
       if detail.response.code == 404

lib/puppet/http/service/file_server.rb

@@ -99,7 +99,7 @@ def get_file_metadata(path:, environment:, links: :manage, checksum_type: Puppet
   #
   # @api public
   #
-  def get_file_metadatas(path: nil, environment:, recurse: :false, recurselimit: nil, max_files: nil, ignore: nil, links: :manage, checksum_type: Puppet[:digest_algorithm], source_permissions: :ignore)
+  def get_file_metadatas(path: nil, environment:, recurse: :false, recurselimit: nil, max_files: nil, ignore: nil, links: :manage, checksum_type: Puppet[:digest_algorithm], source_permissions: :ignore) # rubocop:disable Lint/BooleanSymbol
     validate_path(path)
 
     headers = add_puppet_headers('Accept' => get_mime_types(Puppet::FileServing::Metadata).join(', '))