instance method to_sentence

Ruby on Rails 2.3.18

Since v2.2.3 Last seen in v2.3.18

Available in: v2.2.3 v2.3.18

Signature

to_sentence(options = {})

Converts the array to a comma-separated sentence where the last element is joined by the connector word. Options:

  • :words_connector - The sign or word used to join the elements in arrays with two or more elements (default: “, ”)

  • :two_words_connector - The sign or word used to join the elements in arrays with two elements (default: “ and ”)

  • :last_word_connector - The sign or word used to join the last element in arrays with three or more elements (default: “, and ”)

Parameters

options opt = {}
Source
# File activesupport/lib/active_support/core_ext/array/conversions.rb, line 9
        def to_sentence(options = {})
          default_words_connector     = I18n.translate(:'support.array.words_connector',     :locale => options[:locale])
          default_two_words_connector = I18n.translate(:'support.array.two_words_connector', :locale => options[:locale])
          default_last_word_connector = I18n.translate(:'support.array.last_word_connector', :locale => options[:locale])

          # Try to emulate to_senteces previous to 2.3
          if options.has_key?(:connector) || options.has_key?(:skip_last_comma)
            ::ActiveSupport::Deprecation.warn(":connector has been deprecated. Use :words_connector instead", caller) if options.has_key? :connector
            ::ActiveSupport::Deprecation.warn(":skip_last_comma has been deprecated. Use :last_word_connector instead", caller) if options.has_key? :skip_last_comma

            skip_last_comma = options.delete :skip_last_comma
            if connector = options.delete(:connector)
              options[:last_word_connector] ||= skip_last_comma ? connector : ", #{connector}"
            else
              options[:last_word_connector] ||= skip_last_comma ? default_two_words_connector : default_last_word_connector
            end
          end
          
          options.assert_valid_keys(:words_connector, :two_words_connector, :last_word_connector, :locale)       
          options.reverse_merge! :words_connector => default_words_connector, :two_words_connector => default_two_words_connector, :last_word_connector => default_last_word_connector
          
          case length
            when 0
              ""
            when 1
              self[0].to_s
            when 2
              "#{self[0]}#{options[:two_words_connector]}#{self[1]}"
            else
              "#{self[0...-1].join(options[:words_connector])}#{options[:last_word_connector]}#{self[-1]}"
          end
        end

Defined in activesupport/lib/active_support/core_ext/array/conversions.rb line 9 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveSupport::CoreExtensions::Array::Conversions

Type at least 2 characters to search.

↑↓ navigate · open · esc close