Merge pull request #317 from danielparks/format_heredoccs

Use tilde heredocs for readability

.rubocop.yml

@@ -124,7 +124,7 @@ Layout/ArgumentAlignment:
 Layout/BeginEndAlignment:
   Enabled: false
 Layout/ClosingHeredocIndentation:
-  Enabled: false
+  Enabled: true
 Layout/EmptyComment:
   Enabled: false
 Layout/EmptyLineAfterGuardClause:
@@ -140,7 +140,7 @@ Layout/FirstArgumentIndentation:
 Layout/HashAlignment:
   Enabled: false
 Layout/HeredocIndentation:
-  Enabled: false
+  Enabled: true
 Layout/LeadingEmptyLines:
   Enabled: false
 Layout/SpaceAroundMethodCallOperator:

spec/acceptance/generate_markdown_spec.rb

@@ -11,30 +11,30 @@
     sut_tmp_path
   end
 
-  expected = <<-EOF
-# Reference
+  expected = <<~'EOF'
+    # Reference
 
-## Classes
-* [`test`](#test): This class exists to serve as fixture data for testing the puppet strings face
+    ## Classes
+    * [`test`](#test): This class exists to serve as fixture data for testing the puppet strings face
 
-## Classes
+    ## Classes
 
-### test
+    ### test
 
-#### Examples
-```puppet
-class { "test": }
-```
+    #### Examples
+    ```puppet
+    class { "test": }
+    ```
 
-#### Parameters
+    #### Parameters
 
-##### `package_name`
+    ##### `package_name`
 
-The name of the package
+    The name of the package
 
-##### `service_name`
+    ##### `service_name`
 
-The name of the service
+    The name of the service
 
   EOF
 

spec/fixtures/acceptance/modules/test/lib/puppet/datatypes/acceptancedatatype.rb

@@ -10,13 +10,13 @@
 #   @param [Integer] param2 param2 func1 documentation
 #   @return [Optional[String]]
 Puppet::DataTypes.create_type('AcceptanceDataType') do
-  interface <<-PUPPET
+  interface <<~'PUPPET'
     attributes => {
       param1 => Variant[Numeric, String[1,2]],
       param2 => { type => Optional[String[1]], value => "param2" }
     },
     functions => {
       func1 => Callable[[String, Integer], Optional[String]]
     }
-    PUPPET
+  PUPPET
 end

spec/fixtures/ruby/data_type.rb

@@ -8,13 +8,13 @@
 #   @param [Integer] param2 param2 documentation
 #   @return [Optional[String]]
 Puppet::DataTypes.create_type('UnitDataType') do
-  interface <<-PUPPET
+  interface <<~'PUPPET'
     attributes => {
       param1 => Variant[Numeric, String[1,2]],
       param2 => { type => Optional[String[1]], value => "param2" }
     },
     functions => {
       func1 => Callable[[String, Integer], Optional[String]]
     }
-    PUPPET
+  PUPPET
 end

spec/fixtures/ruby/func3x.rb

@@ -1,12 +1,11 @@
 # An example 3.x function
-Puppet::Parser::Functions.newfunction(:func3x, doc: <<-DOC
- Documentation for an example 3.x function.
- @param param1 [String] The first parameter.
- @param param2 [Integer] The second parameter.
- @return [Undef]
- @example Calling the function.
-   func3x('hi', 10)
- DOC
- ) do |*args|
-   #...
+Puppet::Parser::Functions.newfunction(:func3x, doc: <<~'DOC') do |*args|
+   Documentation for an example 3.x function.
+   @param param1 [String] The first parameter.
+   @param param2 [Integer] The second parameter.
+   @return [Undef]
+   @example Calling the function.
+     func3x('hi', 10)
+  DOC
+  # ...
 end

spec/fixtures/ruby/resource_api.rb

@@ -1,19 +1,19 @@
 Puppet::ResourceApi.register_type(
   name: 'apt_key',
-  docs: <<-EOS,
-@summary Example resource type using the new API.
-@raise SomeError
-This type provides Puppet with the capabilities to manage GPG keys needed
-by apt to perform package validation. Apt has it's own GPG keyring that can
-be manipulated through the `apt-key` command.
-@example here's an example
-  apt_key { '6F6B15509CF8E59E6E469F327F438280EF8D349F':
-    source => 'http://apt.puppetlabs.com/pubkey.gpg'
-  }
+  docs: <<~'EOS',
+    @summary Example resource type using the new API.
+    @raise SomeError
+    This type provides Puppet with the capabilities to manage GPG keys needed
+    by apt to perform package validation. Apt has it's own GPG keyring that can
+    be manipulated through the `apt-key` command.
+    @example here's an example
+      apt_key { '6F6B15509CF8E59E6E469F327F438280EF8D349F':
+        source => 'http://apt.puppetlabs.com/pubkey.gpg'
+      }
 
-**Autorequires**:
-If Puppet is given the location of a key file which looks like an absolute
-path this type will autorequire that file.
+    **Autorequires**:
+    If Puppet is given the location of a key file which looks like an absolute
+    path this type will autorequire that file.
   EOS
   attributes:   {
     ensure:      {

spec/fixtures/ruby/resource_type.rb

@@ -1,15 +1,15 @@
 Puppet::Type.newtype(:database) do
-  desc <<-DESC
-An example database server type.
-@option opts :foo bar
-@enum ensure :up Upstate
-@enum ensure :down Downstate
-@raise SomeError
-@example here's an example
- database { 'foo':
-   address => 'qux.baz.bar',
- }
-DESC
+  desc <<~'DESC'
+    An example database server type.
+    @option opts :foo bar
+    @enum ensure :up Upstate
+    @enum ensure :down Downstate
+    @raise SomeError
+    @example here's an example
+     database { 'foo':
+       address => 'qux.baz.bar',
+     }
+  DESC
   feature :encryption, 'The provider supports encryption.', methods: [:encrypt]
   ensurable do
     desc 'What state the database should be in.'

spec/unit/puppet-strings/describe_spec.rb

@@ -15,125 +15,125 @@
   before :each do
     # Populate the YARD registry with both Puppet and Ruby source
 
-    YARD::Parser::SourceParser.parse_string(<<-SOURCE, :ruby)
-Puppet::Type.newtype(:database) do
-  desc 'An example database server resource type.'
-end
+    YARD::Parser::SourceParser.parse_string(<<~'SOURCE', :ruby)
+      Puppet::Type.newtype(:database) do
+        desc 'An example database server resource type.'
+      end
     SOURCE
 
-    YARD::Parser::SourceParser.parse_string(<<-SOURCE, :ruby)
-Puppet::ResourceApi.register_type(
-  name: 'apt_key',
-  docs: <<-EOS,
-@summary Example resource type using the new API.
-@raise SomeError
-This type provides Puppet with the capabilities to manage GPG keys needed
-by apt to perform package validation. Apt has it's own GPG keyring that can
-be manipulated through the `apt-key` command.
-@example here's an example
-  apt_key { '6F6B15509CF8E59E6E469F327F438280EF8D349F':
-    source => 'http://apt.puppetlabs.com/pubkey.gpg'
-  }
-
-**Autorequires**:
-If Puppet is given the location of a key file which looks like an absolute
-path this type will autorequire that file.
-  EOS
-)
+    YARD::Parser::SourceParser.parse_string(<<~'SOURCE', :ruby)
+      Puppet::ResourceApi.register_type(
+        name: 'apt_key',
+        docs: <<~'EOS',
+          @summary Example resource type using the new API.
+          @raise SomeError
+          This type provides Puppet with the capabilities to manage GPG keys needed
+          by apt to perform package validation. Apt has it's own GPG keyring that can
+          be manipulated through the `apt-key` command.
+          @example here's an example
+            apt_key { '6F6B15509CF8E59E6E469F327F438280EF8D349F':
+              source => 'http://apt.puppetlabs.com/pubkey.gpg'
+            }
+
+          **Autorequires**:
+          If Puppet is given the location of a key file which looks like an absolute
+          path this type will autorequire that file.
+        EOS
+      )
     SOURCE
 
-    YARD::Parser::SourceParser.parse_string(<<-SOURCE, :ruby)
-  Puppet::Type.type(:file).newproperty(:content) do
-    include Puppet::Util::Checksums
-    include Puppet::DataSync
+    YARD::Parser::SourceParser.parse_string(<<~'SOURCE', :ruby)
+      Puppet::Type.type(:file).newproperty(:content) do
+        include Puppet::Util::Checksums
+        include Puppet::DataSync
 
-    attr_reader :actual_content
+        attr_reader :actual_content
 
-    desc <<-'EOT'
-      The desired contents of a file, as a string. This attribute is mutually
-      exclusive with `source` and `target`.
-    EOT
-  end
+        desc <<~'EOT'
+          The desired contents of a file, as a string. This attribute is mutually
+          exclusive with `source` and `target`.
+        EOT
+      end
     SOURCE
 
-    YARD::Parser::SourceParser.parse_string(<<-SOURCE, :ruby)
-  Puppet::Type.newtype(:file) do
-    include Puppet::Util::Checksums
-    include Puppet::Util::Backups
-    include Puppet::Util::SymbolicFileMode
+    YARD::Parser::SourceParser.parse_string(<<~'SOURCE', :ruby)
+      Puppet::Type.newtype(:file) do
+        include Puppet::Util::Checksums
+        include Puppet::Util::Backups
+        include Puppet::Util::SymbolicFileMode
 
-    @doc = "Manages files, including their content, ownership, and permissions.
+        @doc = "Manages files, including their content, ownership, and permissions.
 
-      The `file` type can manage normal files, directories, and symlinks; the
-      type should be specified in the `ensure` attribute."
+          The `file` type can manage normal files, directories, and symlinks; the
+          type should be specified in the `ensure` attribute."
 
-    newparam(:path) do
-      desc <<-'EOT'
-        The path to the file to manage.  Must be fully qualified.
+        newparam(:path) do
+          desc <<~'EOT'
+            The path to the file to manage.  Must be fully qualified.
 
-        On Windows, the path should include the drive letter and should use `/` as
-        the separator character (rather than `\\`).
-      EOT
-      isnamevar
-    end
+            On Windows, the path should include the drive letter and should use `/` as
+            the separator character (rather than `\`).
+          EOT
+          isnamevar
+        end
 
-  end
+      end
     SOURCE
 
-    YARD::Parser::SourceParser.parse_string(<<-SOURCE, :ruby)
-Puppet::Type.type(:file).newproperty(:source) do
-  include Puppet::Util::Checksums
-  include Puppet::DataSync
+    YARD::Parser::SourceParser.parse_string(<<~'SOURCE', :ruby)
+      Puppet::Type.type(:file).newproperty(:source) do
+        include Puppet::Util::Checksums
+        include Puppet::DataSync
 
-  attr_reader :actual_content
+        attr_reader :actual_content
 
-  desc <<-'EOT'
-    The desired contents of a file, as a string. This attribute is mutually
-    exclusive with `source` and `target`.
-  EOT
-end
+        desc <<-'EOT'
+          The desired contents of a file, as a string. This attribute is mutually
+          exclusive with `source` and `target`.
+        EOT
+      end
     SOURCE
   end
 
   describe 'rendering DESCRIBE to stdout' do
     it 'outputs the expected describe content for the list of types' do
-      output = <<-DATA
-These are the types known to puppet:
-apt_key         - This type provides Puppet with the capabiliti ...
-database        - An example database server resource type.
-file            - Manages files, including their content, owner ...
+      output = <<~'DATA'
+        These are the types known to puppet:
+        apt_key         - This type provides Puppet with the capabiliti ...
+        database        - An example database server resource type.
+        file            - Manages files, including their content, owner ...
       DATA
       expect { described_class.render(nil, true) }.to output(output).to_stdout
     end
     it 'outputs the expected describe content for a type' do
-      output = <<-DATA
+      output = <<~'DATA'
 
-file
-====
-Manages files, including their content, ownership, and permissions.
+        file
+        ====
+        Manages files, including their content, ownership, and permissions.
 
-The `file` type can manage normal files, directories, and symlinks; the
-type should be specified in the `ensure` attribute.
+        The `file` type can manage normal files, directories, and symlinks; the
+        type should be specified in the `ensure` attribute.
 
-Parameters
-----------
+        Parameters
+        ----------
 
-- **content**
-The desired contents of a file, as a string. This attribute is mutually
-exclusive with `source` and `target`.
+        - **content**
+        The desired contents of a file, as a string. This attribute is mutually
+        exclusive with `source` and `target`.
 
-- **path**
-The path to the file to manage.  Must be fully qualified.
+        - **path**
+        The path to the file to manage.  Must be fully qualified.
 
-On Windows, the path should include the drive letter and should use `/` as
-the separator character (rather than `\\`).
+        On Windows, the path should include the drive letter and should use `/` as
+        the separator character (rather than `\`).
 
-- **source**
-The desired contents of a file, as a string. This attribute is mutually
-exclusive with `source` and `target`.
+        - **source**
+        The desired contents of a file, as a string. This attribute is mutually
+        exclusive with `source` and `target`.
 
-Providers
----------
+        Providers
+        ---------
       DATA
       expect { described_class.render(['file']) }.to output(output).to_stdout
     end