Základy práce s XML
XML nemá předem daná pravidla pro reprezentaci datových struktur - tyto struktury musíme sami navrhnout a implementovat. Výhodou je o něco větší flexibilita tohoto datového formátu a možnost nadefinovat si skutečně libovolné struktury přesně odpovídající datové doméně. Pomocí knihovny REXML nejdříve vytvoříme XML dokument s kořenovým elementem data, ve kterém jsou jednotlivé položky pole uložené ve vnořených elementech animal. Toto XML zapíšeme do řetězce, který potom následně opět pomocí knihovny REXML načteme, a převedeme zpět na původní pole. Zde, nalezneme soubory, se kterými budeme dneska pracovat.
require 'rexml/document'
data = ['Cat', 'Dog', 'Elepahnt']
puts 'Input data:'
p data
doc = REXML::Document.new
doc << REXML::XMLDecl.new
root = REXML::Element.new('data')
data.each do |value|
new_element = REXML::Element.new('animal')
new_element.text = value
root.elements << new_element
end
doc.elements << root
xml = ""
doc.write(xml,2,false)
puts "Converted to XML"
puts xml
data2 = []
doc2 = REXML::Document.new(xml)
doc2.root.elements.each do |element|
data2 << element.text.strip
end
puts "Parsed from XML:"
p data2
Výstup
Input data:
["Cat", "Dog", "Elepahnt"]
Converted to XML
<?xml version='1.0'?>
<data>
<animal>
Cat
</animal>
<animal>
Dog
</animal>
<animal>
Elepahnt
</animal>
</data>
Parsed from XML:
["Cat", "Dog", "Elepahnt"]
Vytvoření XML pomocí knihovny REXML
V tomto příkladu zkusíme do XML zapsat datovou strukturu ze souboru quiz_object.yaml. Načtení této datové struktury do objektů provedeme metodou YAML.load_file. Aby toto načtení fungovalo, tak musíme mít přístupné definice příslušných tříd - o toto se stará příkaz require. REXML API pro vytváření XML je poměrně jednoduché, je to kombinace vytváření nových elementů pomocí Element.new, nastavování atributů elementům pomocí přístupové metody attributes, a vkládání podřazených elementů operátorem << do pole elements. Výsledné XML se uloží do souboru voláním doc.write.
require 'rexml/document'
require 'yaml'
require 'quiz_classes'
source_file = 'quiz_object.yaml'
target_file = 'quiz_object_rexml.xml'
quiz_object = YAML.load_file(source_file)
puts "Quiz data loaded from #{source_file}"
doc = REXML::Document.new
doc << REXML::XMLDecl.new
root = REXML::Element.new('quiz')
root.attributes['name'] = quiz_object.name
root.attributes['author'] = quiz_object.author
quiz_object.questions.each do |question|
new_question = REXML::Element.new('question')
new_question.attributes['text'] = question.text
question.answers.each do |answer|
new_answer = REXML::Element.new('answer')
new_answer.text = answer.text
correct = "0"
correct = "1" if answer.correct
new_answer.attributes['correct'] = correct
new_question.elements << new_answer
end
root.elements << new_question
end
doc.elements << root
File.open("quiz_object_rexml.xml","w") do |file|
doc.write(file,2)
end
puts "Quiz data written to #{target_file}"
puts
File.open(target_file,"r") do |file|
file.each_line do |line|
puts line
end
end
Výstup
Quiz data loaded from quiz_object.yaml
Quiz data written to quiz_rexml.xml
<?xml version='1.0'?>
<quiz name='Test vseobecnych znalosti' author='Tomas Marny'>
<question text='Hlavni mesto San Marina?'>
<answer correct='0'>
Torino
</answer>
<answer correct='1'>
San Marino
</answer>
<answer correct='0'>
Vatikan
</answer>
<answer correct='0'>
Terst
</answer>
</question>
...
Vytvoření XML pomocí knihovny Builder
Stejné XML jako v předchozím příkladu můžeme o něco úsporněji vytvořit pomocí knihovny builder. Pokud tuto knihovnu nemáte, tak si ji nainstalujte v NetBeans v menu Tools > Ruby Gems > New Gems > Search: builder.
Knihovna builder nabízí oproti REXML o něco úspornější API, které využívá dynamických vlastností jazyka Ruby. XML vytváříme voláním metod na objektu Builder::XmlMarkup, kde jméno volané metody je přímo jménem vytvářeného elementu, a případný textový obsah a atributy elementu se předají jako parametry této metody. Pro odlišení speciální metody (jako např instruct! pro vložení XML hlavičky) končí vykřičníkem. XML se zapisuje přímo do souboru, který jsme předali objektu Builder::XmlMarkup v parametru target.
require 'rubygems'
require 'builder'
require 'yaml'
require 'quiz_classes'
source_file = 'quiz_object.yaml'
target_file = 'quiz_object_builder.xml'
quiz_object = YAML.load_file(source_file)
puts "Quiz data loaded from #{source_file}"
File.open(target_file,'w') do |file|
xml = Builder::XmlMarkup.new({:target => file, :indent => 2})
xml.instruct!
xml.quiz({'name' => quiz_object.name, 'author' => quiz_object.author}) do
quiz_object.questions.each do |question|
xml.question({'text' => question.text}) do
question.answers.each do |answer|
correct = 0
correct = 1 if answer.correct
xml.answer(answer.text, {'correct' => correct})
end
end
end
end
end
puts "Quiz data written to #{target_file}"
puts
File.open(target_file,"r") do |file|
file.each_line do |line|
puts line
end
end
Výstup
Quiz data loaded from quiz_object.yaml
Quiz data written to quiz_builder.xml
<?xml version="1.0" encoding="UTF-8"?>
<quiz name="Test vseobecnych znalosti" author="Tomas Marny">
<question text="Hlavni mesto San Marina?">
<answer correct="0">Torino</answer>
<answer correct="1">San Marino</answer>
<answer correct="0">Vatikan</answer>
<answer correct="0">Terst</answer>
</question>
...
Načítání XML pomocí stromového rozhraní
V tomto příkladu načítáme XML stejným způsobem jako v prvním příkladu, pouze se jedná trochu složitější soubor. Čteme právě to XML, které jsme vytvořili v minulém příkladu. Základem jsou dvě vnořené smyčky, z nichž jedna iteruje přes otázky (root.elements) a druhá přes odpovědi (question.elements). V průběhu iterace vytváříme výsledné objekty. Seznam otázek vypíšeme metodou print_quiz.
require 'rexml/document'
require 'yaml'
require 'quiz_classes'
source_file = 'quiz_builder.xml'
puts "Parsing source file #{source_file}"
File.open(source_file,"r") do |file|
doc = REXML::Document.new(file)
name = doc.root.attributes['name']
author = doc.root.attributes['author']
quiz = Quiz.new(name,author,Array.new)
doc.root.elements.each do |question|
new_question = Question.new(question.attributes['text'],Array.new)
question.elements.each_with_index do |answer,i|
correct = false
correct = true if answer.attributes['correct']=="1"
new_question.answers << Answer.new(answer.text.strip,correct)
end
quiz.questions << new_question
end
quiz.print_quiz
end
Výstup
Parsing source file quiz_builder.xml
Test vseobecnych znalosti
Tomas Marny
1. Hlavni mesto San Marina?
a) Torino
b) San Marino
c) Vatikan
d) Terst
Soubory ke stažení
RAR archív s příklady
Závěr
Toto je pro dnešek vše, příště si řekneme něco o unit testech a dokumentaci.