Merge pull request #510 from jstraw/rubocop-fixes-may4th

Fix Heredoc rubocop and Disable Style/ClassAndModuleChildren where needed
puppetlabs · May 10, 2023 · 79e37cf · 79e37cf
2 parents 8300062 + f99add9
commit 79e37cf
Show file tree

Hide file tree

Showing 12 changed files with 232 additions and 255 deletions.
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -40,19 +40,6 @@ Metrics/MethodLength:
 Metrics/PerceivedComplexity:
   Max: 20
 
-# Offense count: 114
-# Configuration parameters: ForbiddenDelimiters.
-# ForbiddenDelimiters: (?i-mx:(^|\s)(EO[A-Z]{1}|END)(\s|$))
-Naming/HeredocDelimiterNaming:
-  Exclude:
-    - 'lib/puppet/type/ini_subsetting.rb'
-    - 'spec/acceptance/ini_setting_spec.rb'
-    - 'spec/acceptance/ini_subsetting_spec.rb'
-    - 'spec/unit/puppet/provider/ini_setting/inheritance_spec.rb'
-    - 'spec/unit/puppet/provider/ini_setting/ruby_spec.rb'
-    - 'spec/unit/puppet/provider/ini_subsetting/ruby_spec.rb'
-    - 'spec/unit/puppet/util/ini_file_spec.rb'
-
 # Offense count: 12
 # Configuration parameters: IgnoredMetadata.
 RSpec/DescribeClass:
@@ -98,13 +85,3 @@ RSpec/NamedSubject:
 RSpec/NestedGroups:
   Max: 6
 
-# Offense count: 4
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: nested, compact
-Style/ClassAndModuleChildren:
-  Exclude:
-    - 'lib/puppet/util/external_iterator.rb'
-    - 'lib/puppet/util/ini_file.rb'
-    - 'lib/puppet/util/ini_file/section.rb'
-    - 'lib/puppet/util/setting_value.rb'
diff --git a/lib/puppet/type/ini_subsetting.rb b/lib/puppet/type/ini_subsetting.rb
@@ -104,15 +104,15 @@ def is_to_s(value) # rubocop:disable Naming/PredicateName : Changing breaks the
   end
 
   newparam(:insert_type) do
-    desc <<-EOF
+    desc <<-DOCUMENTATION
       Where the new subsetting item should be inserted
 
       * :start  - insert at the beginning of the line.
       * :end    - insert at the end of the line (default).
       * :before - insert before the specified element if possible.
       * :after  - insert after the specified element if possible.
       * :index  - insert at the specified index number.
-    EOF
+    DOCUMENTATION
 
     newvalues(:start, :end, :before, :after, :index)
     defaultto(:end)

diff --git a/lib/puppet/util/external_iterator.rb b/lib/puppet/util/external_iterator.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Puppet::Util
+module Puppet::Util # rubocop:disable Style/ClassAndModuleChildren
   #
   # external_iterator.rb
   #

diff --git a/lib/puppet/util/ini_file.rb b/lib/puppet/util/ini_file.rb
@@ -3,7 +3,7 @@
 require File.expand_path('external_iterator', __dir__)
 require File.expand_path('ini_file/section', __dir__)
 
-module Puppet::Util
+module Puppet::Util # rubocop:disable Style/ClassAndModuleChildren
   #
   # ini_file.rb
   #

diff --git a/lib/puppet/util/ini_file/section.rb b/lib/puppet/util/ini_file/section.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class Puppet::Util::IniFile
+class Puppet::Util::IniFile # rubocop:disable Style/ClassAndModuleChildren
   #
   # section.rb
   #

diff --git a/lib/puppet/util/setting_value.rb b/lib/puppet/util/setting_value.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Puppet::Util
+module Puppet::Util # rubocop:disable Style/ClassAndModuleChildren
   # This class can work with a list of subsettings inside
   # an ini file setting string to add, remove, extract and set their values.
   class SettingValue

diff --git a/spec/acceptance/ini_setting_spec.rb b/spec/acceptance/ini_setting_spec.rb
@@ -44,7 +44,7 @@
   end
 
   context 'when ensure parameter => present for global and section' do
-    pp = <<-EOS
+    pp = <<-MANIFEST
     ini_setting { 'ensure => present for section':
       ensure  => present,
       path    => "#{basedir}/ini_setting.ini",
@@ -59,7 +59,7 @@
       setting => 'four',
       value   => 'five',
     }
-    EOS
+    MANIFEST
 
     it_behaves_like 'has_content', "#{basedir}/ini_setting.ini", pp, %r{four = five\R\R\[one\]\Rtwo = three}
   end
@@ -76,15 +76,15 @@
       apply_manifest(ipp)
     end
 
-    pp = <<-EOS
+    pp = <<-MANIFEST
     ini_setting { 'ensure => absent for key/value':
       ensure  => absent,
       path    => "#{basedir}/ini_setting.ini",
       section => 'one',
       setting => 'two',
       value   => 'three',
     }
-    EOS
+    MANIFEST
 
     it 'applies the manifest twice' do
       expect { idempotent_apply(pp) }.not_to raise_error
@@ -119,15 +119,15 @@
       run_shell("rm #{basedir}/ini_setting.ini", expect_failures: true)
     end
 
-    pp = <<-EOS
+    pp = <<-MANIFEST
     ini_setting { 'ensure => absent for global':
       ensure  => absent,
       path    => "#{basedir}/ini_setting.ini",
       section => '',
       setting => 'four',
       value   => 'five',
     }
-    EOS
+    MANIFEST
 
     it 'applies the manifest twice' do
       expect { idempotent_apply(pp) }.not_to raise_error
@@ -148,28 +148,28 @@
 
   describe 'path parameter' do
     context 'when path => foo' do
-      pp = <<-EOS
+      pp = <<-MANIFEST
         ini_setting { 'path => foo':
           ensure     => present,
           section    => 'one',
           setting    => 'two',
           value      => 'three',
           path       => 'foo',
         }
-      EOS
+      MANIFEST
 
       it_behaves_like 'has_error', 'foo', pp, %r{must be fully qualified}
     end
   end
 
   context 'when ensure parameter => present and only section' do
-    pp = <<-EOS
+    pp = <<-MANIFEST
     ini_setting { 'ensure => present for section':
       ensure  => present,
       path    => "#{basedir}/ini_setting.ini",
       section => 'one',
     }
-    EOS
+    MANIFEST
 
     it_behaves_like 'has_content', "#{basedir}/ini_setting.ini", pp, %r{\[one\]}
   end
@@ -181,7 +181,7 @@
      { value: 'public_value', matcher: %r{initial_value.*public_value}, show_diff: true },
      { value: 'secret_value', matcher: %r{redacted sensitive information.*redacted sensitive information}, show_diff: false },
      { value: 'md5_value', matcher: %r{\{md5\}881671aa2bbc680bc530c4353125052b.*\{md5\}ed0903a7fa5de7886ca1a7a9ad06cf51}, show_diff: :md5 }].each do |i|
-      pp = <<-EOS
+      pp = <<-MANIFEST
           ini_setting { 'test_show_diff':
             ensure      => present,
             section     => 'test',
@@ -190,7 +190,7 @@
             path        => "#{basedir}/test_show_diff.ini",
             show_diff   => #{i[:show_diff]}
           }
-      EOS
+      MANIFEST
 
       context "when show_diff => #{i[:show_diff]}" do
         res = apply_manifest(pp, expect_changes: true)
@@ -206,15 +206,15 @@
   end
 
   describe 'values with spaces in the value part at the beginning or at the end' do
-    pp = <<-EOS
+    pp = <<-MANIFEST
       ini_setting { 'path => foo':
           ensure     => present,
           section    => 'one',
           setting    => 'two',
           value      => '               123',
           path       => '#{basedir}/ini_setting.ini',
         }
-    EOS
+    MANIFEST
 
     it_behaves_like 'has_content', "#{basedir}/ini_setting.ini", pp, %r{\[one\]\Rtwo = 123}
   end
@@ -238,7 +238,7 @@
     context 'when event is triggered' do
       context 'when update setting value' do
         let(:update_value_manifest) do
-          <<-EOS
+          <<-MANIFEST
           notify { foo:
             notify => Ini_Setting['updateSetting'],
           }
@@ -251,7 +251,7 @@
             value   => "newValue",
             refreshonly => true,
           }
-          EOS
+          MANIFEST
         end
 
         before(:each) do
@@ -271,7 +271,7 @@
 
       context 'when remove setting value' do
         let(:remove_setting_manifest) do
-          <<-EOS
+          <<-MANIFEST
           notify { foo:
             notify => Ini_Setting['removeSetting'],
           }
@@ -283,7 +283,7 @@
             setting => 'valueinsection1',
             refreshonly => true,
           }
-          EOS
+          MANIFEST
         end
 
         before(:each) do
@@ -305,7 +305,7 @@
     context 'when not receiving an event' do
       context 'when does not update setting' do
         let(:does_not_update_value_manifest) do
-          <<-EOS
+          <<-MANIFEST
           file { "#{basedir}/ini_setting.ini":
             ensure => present,
             notify => Ini_Setting['updateSetting'],
@@ -318,7 +318,7 @@
             value   => "newValue",
             refreshonly => true,
           }
-          EOS
+          MANIFEST
         end
 
         before(:each) do
@@ -339,7 +339,7 @@
 
       context 'when does not remove setting' do
         let(:does_not_remove_setting_manifest) do
-          <<-EOS
+          <<-MANIFEST
           file { "#{basedir}/ini_setting.ini":
             ensure => present,
             notify => Ini_Setting['removeSetting'],
@@ -352,7 +352,7 @@
             setting => 'valueinsection1',
             refreshonly => true,
           }
-          EOS
+          MANIFEST
         end
 
         before(:each) do

diff --git a/spec/acceptance/ini_subsetting_spec.rb b/spec/acceptance/ini_subsetting_spec.rb
@@ -46,7 +46,7 @@
   end
 
   describe 'ensure, section, setting, subsetting, & value parameters => present with subsections' do
-    pp = <<-EOS
+    pp = <<-MANIFEST
     ini_subsetting { 'ensure => present for alpha':
       ensure     => present,
       path       => "#{basedir}/ini_subsetting.ini",
@@ -64,23 +64,23 @@
       value      => 'trons',
       require    => Ini_subsetting['ensure => present for alpha'],
     }
-    EOS
+    MANIFEST
 
     describe file("#{basedir}/ini_subsetting.ini") do
       it_behaves_like 'has_content', "#{basedir}/ini_subsetting.ini", pp, %r{\[one\]\Rkey = alphabet betatrons}
     end
   end
 
   describe 'ensure => absent' do
-    pp = <<-EOS
+    pp = <<-MANIFEST
     ini_subsetting { 'ensure => absent for subsetting':
       ensure     => absent,
       path       => "#{basedir}/ini_subsetting.ini",
       section    => 'one',
       setting    => 'key',
       subsetting => 'alpha',
     }
-    EOS
+    MANIFEST
 
     it 'applies the manifest twice' do
       expect { idempotent_apply(pp) }.not_to raise_error
@@ -100,7 +100,7 @@
   end
 
   describe 'delete_if_empty => true' do
-    pp = <<-EOS
+    pp = <<-MANIFEST
     ini_subsetting { 'ensure => absent for alpha':
       ensure          => absent,
       path            => "#{basedir}/ini_subsetting.ini",
@@ -117,7 +117,7 @@
       subsetting      => 'beta',
       delete_if_empty => true,
     }
-    EOS
+    MANIFEST
 
     it 'applies the manifest twice' do
       run_shell("echo -e [one]\\\\nkey = alphabet betatrons > #{basedir}/ini_subsetting.ini", expect_failures: true)
@@ -163,7 +163,7 @@
           run_shell("rm #{path}", expect_failures: true)
         end
 
-        pp = <<-EOS
+        pp = <<-MANIFEST
         ini_subsetting { '#{parameter.first}':
           ensure     => #{(parameter.length > 1) ? 'present' : 'absent'},
           path       => '#{path}',
@@ -173,7 +173,7 @@
           subsetting => '#{parameter.first}',
           value      => '#{(parameter.length > 1) ? parameter[1] : ''}'
         }
-        EOS
+        MANIFEST
 
         it 'applies the manifest twice' do
           expect { idempotent_apply(pp) }.not_to raise_error
@@ -199,7 +199,7 @@
      { value: 'public_value', matcher: %r{initial_value.*public_value}, show_diff: true },
      { value: 'secret_value', matcher: %r{redacted sensitive information.*redacted sensitive information}, show_diff: false },
      { value: 'md5_value', matcher: %r{\{md5\}881671aa2bbc680bc530c4353125052b.*\{md5\}ed0903a7fa5de7886ca1a7a9ad06cf51}, show_diff: :md5 }].each do |i|
-       pp = <<-EOS
+       pp = <<-MANIFEST
           ini_subsetting { 'test_show_diff':
             ensure      => present,
             section     => 'test',
@@ -209,7 +209,7 @@
             path        => "#{basedir}/test_show_diff.ini",
             show_diff   => #{i[:show_diff]}
           }
-       EOS
+       MANIFEST
 
        context "when show_diff => #{i[:show_diff]}" do
          res = apply_manifest(pp, expect_changes: true)
@@ -251,7 +251,7 @@
       },
     ].each do |params|
       context "with '#{params[:insert_type]}' makes '#{params[:content]}'" do
-        pp = <<-EOS
+        pp = <<-MANIFEST
         ini_subsetting { "a":
           ensure     => present,
           section    => 'one',
@@ -282,7 +282,7 @@
           insert_type  => '#{params[:insert_type]}',
           insert_value => '#{params[:insert_value]}',
         }
-        EOS
+        MANIFEST
 
         it_behaves_like 'has_content', "#{basedir}/insert_types.ini", pp, params[:content]
       end