Ticket #10124: as_array_docs.diff

activesupport/lib/active_support/core_ext/array/conversions.rb

@@ -4 +4 @@
-  module CoreExtensions #:nodoc:
-    module Array #:nodoc:
-      module Conversions
-
+
+
+
-        # * <tt>:connector</tt> - The word used to join the last element in arrays with two or more elements (default: "and")
-        # * <tt>:skip_last_comma</tt> - Set to true to return "a, b and c" instead of "a, b, and c".
+        #
+        # ==== Examples
+        #    ["Lions", "tigers", "bears"].to_sentence
+        #    # => "Lions, tigers, and bears"
+        #
+        #    ["Active Record", "Action Pack", "Active Resource"].to_sentence(:connector => "or")
+        #    # => "Active Record, Action Pack, or Active Resource" 
+        #
+        #    ["red", "green", "blue"].to_sentence(:skip_last_comma => true)
+        #    # => "red, green and blue"
+        #
-        def to_sentence(options = {})
-          options.assert_valid_keys(:connector, :skip_last_comma)
-          options.reverse_merge! :connector => 'and', :skip_last_comma => false
@@ -23 +36 @@
-          end
-        end
-
-
+
+
+
+
+
+
+
+
+
-        def to_param
-          join '/'
-        end
@@ -48 +69 @@
-          end
-        end
-        
+        # Attempts to convert the array and all of its elements to XML.  All elements must respond to
+        # to_xml or an error will be raised.
+        #
+        # ==== Options
+        # * <tt>:root</tt> - Sets the name for the root elements in the generated XML
+        # * <tt>:children</tt> - Sets the name for the child elements in the generated XML
+        # * <tt>:indent</tt> - Sets the how many spaces will be used to indent the generated XML
+        # * <tt>:builder</tt> - Allows you to provide your own Builder instance to use
+        #
+        # ==== Examples
+        #
+        #   [1,2,3].to_xml
+        #   # => RuntimeError: Not all elements respond to to_xml
+        # 
+        #   [{'key' => 'value', 'key2' => 'value'}, {'name' => 'Ruby on Rails'}].to_xml
+        #   # => "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
+        #         <records type=\"array\">
+        #           <record>
+        #             <key2>value</key2>
+        #             <key>value</key>
+        #           </record>
+        #           <record>
+        #             <name>Ruby on Rails</name>
+        #           </record>
+        #         </records>"
+        #
+        #   [{'key' => 'value'}].to_xml(:root => 'beets', :children => 'carrots')
+        #   # => "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
+        #         <beets type=\"array\">
+        #           <carrots>
+        #             <key>value</key>
+        #           </carrots>
+        #         </beets>"
-        def to_xml(options = {})
-          raise "Not all elements respond to to_xml" unless all? { |e| e.respond_to? :to_xml }
-