Class: Array
- Defined in:
- lib/sequel/serializer/json_serializer.rb,
lib/support/core_extensions.rb,
lib/sequel/serializer/xml_serializer.rb
Overview
:nodoc:
Instance Method Summary collapse
- #to_flat_file_row(options = { :delimeter => ',', :enclosed_by => '' }) ⇒ Object
- #to_fos_json(options = {}) ⇒ Object
- #to_fos_xml(options = {}) ⇒ Object
-
#to_xml(options = {}) ⇒ Object
Returns a string that represents this array in XML by sending
to_xml
to each element.
Instance Method Details
#to_flat_file_row(options = { :delimeter => ',', :enclosed_by => '' }) ⇒ Object
4 5 6 7 8 |
# File 'lib/support/core_extensions.rb', line 4 def to_flat_file_row = { :delimeter => ',', :enclosed_by => '' } self.inject("") do |csv, item| csv << "#{[:enclosed_by]}#{item}#{[:enclosed_by]}#{[:delimeter]}" end.chop end |
#to_fos_json(options = {}) ⇒ Object
111 112 113 114 115 116 117 |
# File 'lib/sequel/serializer/json_serializer.rb', line 111 def to_fos_json( = {}) if first.is_a? Sequel::Model collect{ |model| model.fill_hash([:methods]) }.to_json else to_json end end |
#to_fos_xml(options = {}) ⇒ Object
474 475 476 |
# File 'lib/sequel/serializer/xml_serializer.rb', line 474 def to_fos_xml( = {}) to_xml({:skip_instruct=>true, :skip_types=>true, :dasherize=>false, :only=>[]}.merge()) end |
#to_xml(options = {}) ⇒ Object
Returns a string that represents this array in XML by sending to_xml
to each element. Active Record collections delegate their representation in XML to this method.
All elements are expected to respond to to_xml
, if any of them does not an exception is raised.
The root node reflects the class name of the first element in plural if all elements belong to the same type and that’s not Hash:
customer.projects.to_xml
<?xml version="1.0" encoding="UTF-8"?>
<projects type="array">
<project>
<amount type="decimal">20000.0</amount>
<customer-id type="integer">1567</customer-id>
<deal-date type="date">2008-04-09</deal-date>
...
</project>
<project>
<amount type="decimal">57230.0</amount>
<customer-id type="integer">1567</customer-id>
<deal-date type="date">2008-04-15</deal-date>
...
</project>
</projects>
Otherwise the root element is “records”:
[{:foo => 1, :bar => 2}, {:baz => 3}].to_xml
<?xml version="1.0" encoding="UTF-8"?>
<records type="array">
<record>
<bar type="integer">2</bar>
<foo type="integer">1</foo>
</record>
<record>
<baz type="integer">3</baz>
</record>
</records>
If the collection is empty the root element is “nil-classes” by default:
[].to_xml
<?xml version="1.0" encoding="UTF-8"?>
<nil-classes type="array"/>
To ensure a meaningful root element use the :root
option:
customer_with_no_projects.projects.to_xml(:root => "projects")
<?xml version="1.0" encoding="UTF-8"?>
<projects type="array"/>
By default root children have as node name the one of the root singularized. You can change it with the :children
option.
The options
hash is passed downwards:
Message.all.to_xml(:skip_types => true)
<?xml version="1.0" encoding="UTF-8"?>
<messages>
<message>
<created-at>2008-03-07T09:58:18+01:00</created-at>
<id>1</id>
<name>1</name>
<updated-at>2008-03-07T09:58:18+01:00</updated-at>
<user-id>1</user-id>
</message>
</messages>
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 |
# File 'lib/sequel/serializer/xml_serializer.rb', line 442 def to_xml( = {}) raise "Not all elements respond to to_xml" unless all? { |e| e.respond_to? :to_xml } require 'builder' unless defined?(Builder) = .dup [:root] ||= all? { |e| e.is_a?(first.class) && first.class.to_s != "Hash" } ? first.class.name.underscore.pluralize.tr('/', '_') : "records" [:children] ||= [:root].singularize [:indent] ||= 2 [:builder] ||= Builder::XmlMarkup.new(:indent => [:indent]) root = .delete(:root).to_s children = .delete(:children) if !.has_key?(:dasherize) || [:dasherize] root = root.dasherize end [:builder].instruct! unless .delete(:skip_instruct) opts = .merge({ :root => children }) xml = [:builder] if empty? xml.tag!(root, [:skip_types] ? {} : {:type => "array"}) else xml.tag!(root, [:skip_types] ? {} : {:type => "array"}) { yield xml if block_given? each { |e| e.to_xml(opts.merge({ :skip_instruct => true })) } } end end |