instance method `block_format`

Ruby on Rails 8.1.2

Since v3.0.20

Available in: v3.0.20 v3.1.12 v3.2.22.5 v4.0.13 v4.1.16 v4.2.9 v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

block_format(text)

Take the text and format it, indented two spaces for each line, and wrapped at 72 columns:

text = <<-TEXT
  This is
  the      paragraph.

  * item1 * item2
TEXT

block_format text
# => "  This is the paragraph.\n\n  * item1\n  * item2\n"

Parameters

text req

Source

# File actionmailer/lib/action_mailer/mail_helper.rb, line 22
    def block_format(text)
      formatted = text.split(/\n\r?\n/).collect { |paragraph|
        format_paragraph(paragraph)
      }.join("\n\n")

      # Make list points stand on their own line
      output = +""
      splits = formatted.split(/(\*+|\#+)/)
      while line = splits.shift
        if line.start_with?("*", "#") && splits.first&.start_with?(" ")
          output.chomp!(" ") while output.end_with?(" ")
          output << "  #{line} #{splits.shift.strip}\n"
        else
          output << line
        end
      end

      output
    end

Defined in actionmailer/lib/action_mailer/mail_helper.rb line 22 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActionMailer::MailHelper

Signature

Parameters