Lint/EmptyWhen

Ruby case/when statements don't fall through like many other languages, so add a
comment when we're intentionally not falling through.

Author: joshcooper

.rubocop_todo.yml

@@ -585,19 +585,6 @@ Layout/TrailingWhitespace:
 Lint/ConstantDefinitionInBlock:
   Enabled: false
 
-# Configuration parameters: AllowComments.
-Lint/EmptyWhen:
-  Exclude:
-    - 'lib/puppet/indirector/hiera.rb'
-    - 'lib/puppet/pops/evaluator/evaluator_impl.rb'
-    - 'lib/puppet/pops/lookup/data_dig_function_provider.rb'
-    - 'lib/puppet/pops/types/type_formatter.rb'
-    - 'lib/puppet/pops/types/type_mismatch_describer.rb'
-    - 'lib/puppet/pops/types/types.rb'
-    - 'lib/puppet/pops/validation/checker4_0.rb'
-    - 'lib/puppet/util/backups.rb'
-    - 'lib/puppet/util/windows/security.rb'
-
 # This cop supports safe auto-correction (--auto-correct).
 Lint/EnsureReturn:
   Exclude:

lib/puppet/indirector/hiera.rb

@@ -42,8 +42,7 @@ def find(request)
   # @return [Symbol,Hash,nil] The Hiera 'resolution_type'
   def convert_merge(merge)
     case merge
-    when nil
-    when 'first'
+    when nil, 'first'
       # Nil is OK. Defaults to Hiera :priority
       nil
     when Puppet::Pops::MergeStrategy

lib/puppet/pops/evaluator/evaluator_impl.rb

@@ -1083,7 +1083,9 @@ def eval_VariableExpression o, scope
     # may occur for some evaluation use cases.
     case name
     when String
+      # do nothing
     when Numeric
+      # do nothing
     else
       fail(Issues::ILLEGAL_VARIABLE_EXPRESSION, o.expr)
     end

lib/puppet/pops/lookup/data_dig_function_provider.rb

@@ -107,8 +107,7 @@ def instantiate_backend(lookup_invocation)
   # @return [Symbol,Hash,nil] The Hiera 'resolution_type'
   def convert_merge(merge)
     case merge
-    when nil
-    when 'first', 'default'
+    when nil, 'first', 'default'
       # Nil is OK. Defaults to Hiera :priority
       nil
     when Puppet::Pops::MergeStrategy

lib/puppet/pops/types/type_formatter.rb

@@ -728,6 +728,7 @@ def append_object_hash(hash)
   def append_elements(array, to_be_continued = false)
     case array.size
     when 0
+      # do nothing
     when 1
       @bld << array[0]
       @bld << COMMA_SEP if to_be_continued
@@ -740,6 +741,7 @@ def append_elements(array, to_be_continued = false)
   def append_strings(array, to_be_continued = false)
     case array.size
     when 0
+      # do nothing
     when 1
       append_string(array[0])
       @bld << COMMA_SEP if to_be_continued

lib/puppet/pops/types/type_mismatch_describer.rb

@@ -533,6 +533,7 @@ def validate_parameters(subject, params_struct, given_hash, missing_ok = false,
       errors = describe_struct_signature(params_struct, given_hash, missing_ok).flatten
       case errors.size
       when 0
+        # do nothing
       when 1
         raise Puppet::ParseError.new("#{subject}:#{errors[0].format}")
       else
@@ -573,6 +574,7 @@ def validate_default_parameter(subject, param_name, param_type, value, tense = :
         errors = describe(param_type, TypeCalculator.singleton.infer_set(value).generalize, [ParameterPathElement.new(param_name)])
         case errors.size
         when 0
+          # do nothing
         when 1
           raise Puppet::ParseError.new("#{subject}:#{errors[0].format}")
         else

lib/puppet/pops/types/types.rb

@@ -1178,6 +1178,7 @@ def on_error(from, radix = :default, abs = nil)
       def assert_radix(radix)
         case radix
         when 2, 8, 10, 16
+          # do nothing
         else
           raise ArgumentError.new(_("Illegal radix: %{radix}, expected 2, 8, 10, 16, or default") % { radix: radix })
         end

lib/puppet/pops/validation/checker4_0.rb

@@ -236,7 +236,9 @@ def check_AttributesOperation(o)
     p = container
     case p
     when Model::AbstractResource
+      # do nothing
     when Model::CollectExpression
+      # do nothing
     else
       # protect against just testing a snippet that has no parent, error message will be a bit strange
       # but it is not for a real program.

lib/puppet/util/backups.rb

@@ -27,7 +27,7 @@ def perform_backup_with_bucket(fileobj)
       info _("Recursively backing up to filebucket")
       Find.find(self[:path]) { |f| backup_file_with_filebucket(f) if File.file?(f) }
     when "file"; backup_file_with_filebucket(file)
-    when "link";
+    when "link"; # do nothing
     end
     true
   end

lib/puppet/util/windows/security.rb

@@ -237,8 +237,8 @@ def get_mode(path)
         if (ace.mask & FILE::FILE_APPEND_DATA).nonzero?
           mode |= S_ISVTX
         end
-      when well_known_app_packages_sid
-      when well_known_system_sid
+      when well_known_app_packages_sid, well_known_system_sid
+        # do nothing
       else
         #puts "Warning, unable to map SID into POSIX mode: #{ace.sid}"
         mode |= S_IEXTRA