method

to_sentence

Ruby on Rails latest stable (v6.1.7.7) - 1 note - Class: ActiveSupport::CoreExtensions::Array::Conversions

1.0.0 (0)
1.1.6 (0)
1.2.6 (0)
2.0.3 (0)
2.1.0 (0)
2.2.1 (1)
2.3.8 (13)
3.0.0
3.0.9
3.1.0
3.2.1
3.2.8
3.2.13
4.0.2
4.1.8
4.2.1
4.2.7
4.2.9
5.0.0.1
5.1.7
5.2.3
6.0.0
6.1.3.1
6.1.7.7
7.0.0
7.1.3.2
What's this?

Method deprecated or moved

This method is deprecated or moved on the latest stable version. The last existing version (v2.3.8) is shown here.

These similar methods exist in v6.1.7.7:

to_sentence(options = {}) public

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 ")

Show 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''support.array.words_connector',     :locale => options[:locale])
          default_two_words_connector = I18n.translate('support.array.two_words_connector''support.array.two_words_connector', :locale => options[:locale])
          default_last_word_connector = I18n.translate('support.array.last_word_connector''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

March 2, 2009

2 thanks

Valid options changed in Rails v2.3.0 RC1

The valid options in Rails v2.3.0 RC1 are no longer

:connector and :skip_last_comma, but

:words_connector, :two_words_connector, and :last_word_connector:

>> %w(lorem ipsum dolor sit).to_sentence
=> "lorem, ipsum, dolor, and sit"

>> %w(lorem ipsum dolor sit).to_sentence(:words_connector => ' + ')
=> "lorem + ipsum + dolor, and sit"

>> %w(lorem ipsum).to_sentence(:two_words_connector => ' through ')
=> "lorem through ipsum"

# No effect if more than two words
>> %w(lorem ipsum dolor sit).to_sentence(:two_words_connector => ' through ')
=> "lorem, ipsum, dolor, and sit"

>> %w(lorem ipsum dolor sit).to_sentence(:last_word_connector => ' or ')
=> "lorem, ipsum, dolor or sit"

to_sentence

Related methods

Method deprecated or moved

Valid options changed in Rails v2.3.0 RC1

Flowdock - Team Inbox With Chat for Software Developers