class DidYouMean::Formatter - Documentation for Ruby 4.0
Description: class DidYouMean::Formatter: Formatter+ is the basic, default formatter for the gem. The formatter responds to the +message_for+ method and it returns a human readable string.
Keywords: ruby,class,DidYouMean::Formatter

🔍

No recent searches

# class DidYouMean::Formatter

The `DidYouMean::Formatter` is the basic, default formatter for the gem. The formatter responds to the `message_for` method and it returns a human readable string.

### Public Class Methods

message_for (corrections)
Source

    # File lib/did_you_mean/formatter.rb, line 29
    def self.message_for(corrections)
      corrections.empty? ? "" : "\nDid you mean?  #{corrections.join("\n               ")}"
    end

Returns a human readable string that contains `corrections`. This formatter is designed to be less verbose to not take too much screen space while being helpful enough to the user.

@example

    formatter = DidYouMean::Formatter.new

    # displays suggestions in two lines with the leading empty line
    puts formatter.message_for(["methods", "method"])

    Did you mean?  methods
                    method
    # => nil

    # displays an empty line
    puts formatter.message_for([])

    # => nil

### Public Instance Methods

message_for (corrections)
Source

    # File lib/did_you_mean/formatter.rb, line 33
    def message_for(corrections)
      warn "The instance method #message_for has been deprecated. Please use the class method " \
           "DidYouMean::Formatter.message_for(...) instead."

      self.class.message_for(corrections)
    end