Module: ActiveSupport::CoreExtensions::Array::Conversions

Included in:
Array
Defined in:
lib/active_support/core_ext/array/conversions.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object

:nodoc:



41
42
43
44
45
46
 
# File 'lib/active_support/core_ext/array/conversions.rb', line 41

def self.included(base) #:nodoc:
  base.class_eval do
    alias_method :to_default_s, :to_s
    alias_method :to_s, :to_formatted_s
  end
end

Instance Method Details

#to_formatted_s(format = :default) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/active_support/core_ext/array/conversions.rb', line 48

def to_formatted_s(format = :default)
  case format
    when :db
      if respond_to?(:empty?) && self.empty?
        "null"
      else
        collect { |element| element.id }.join(",")
      end
    else
      to_default_s
  end
end

#to_param ⇒ Object

Calls to_param on all its elements and joins the result with slashes. This is used by url_for in Action Pack.



28
29
30
 
# File 'lib/active_support/core_ext/array/conversions.rb', line 28

def to_param
  map(&:to_param).join '/'
end

#to_query(key) ⇒ Object

Converts an array into a string suitable for use as a URL query string, using the given key as the param name.

Example:

['Rails', 'coding'].to_query('hobbies') => "hobbies%5B%5D=Rails&hobbies%5B%5D=coding"



37
38
39
 
# File 'lib/active_support/core_ext/array/conversions.rb', line 37

def to_query(key)
  collect { |value| value.to_query("#{key}[]") } * '&'
end

#to_sentence(options = {}) ⇒ Object

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

  • :connector - The word used to join the last element in arrays with two or more elements (default: “and”)

  • :skip_last_comma - Set to true to return “a, b and c” instead of “a, b, and c”.



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/active_support/core_ext/array/conversions.rb', line 10

def to_sentence(options = {})
  options.assert_valid_keys(:connector, :skip_last_comma)
  options.reverse_merge! :connector => 'and', :skip_last_comma => false
  options[:connector] = "#{options[:connector]} " unless options[:connector].nil? || options[:connector].strip == ''

  case length
    when 0
      ""
    when 1
      self[0].to_s
    when 2
      "#{self[0]} #{options[:connector]}#{self[1]}"
    else
      "#{self[0...-1].join(', ')}#{options[:skip_last_comma] ? '' : ','} #{options[:connector]}#{self[-1]}"
  end
end

#to_xml(options = {}) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/active_support/core_ext/array/conversions.rb', line 61

def to_xml(options = {})
  raise "Not all elements respond to to_xml" unless all? { |e| e.respond_to? :to_xml }

  options[:root]     ||= all? { |e| e.is_a?(first.class) && first.class.to_s != "Hash" } ? first.class.to_s.underscore.pluralize : "records"
  options[:children] ||= options[:root].singularize
  options[:indent]   ||= 2
  options[:builder]  ||= Builder::XmlMarkup.new(:indent => options[:indent])

  root     = options.delete(:root).to_s
  children = options.delete(:children)

  if !options.has_key?(:dasherize) || options[:dasherize]
    root = root.dasherize
  end

  options[:builder].instruct! unless options.delete(:skip_instruct)

  opts = options.merge({ :root => children })

  xml = options[:builder]
  if empty?
    xml.tag!(root, options[:skip_types] ? {} : {:type => "array"})
  else
    xml.tag!(root, options[:skip_types] ? {} : {:type => "array"}) {
      yield xml if block_given?
      each { |e| e.to_xml(opts.merge!({ :skip_instruct => true })) }
    }
  end
end