Zápis a čtení s použitím bloků

Hned v tomto příkladu vidíte doporučený způsob, jak manipulovat se soubory. Soubor se pro zápis otevře metodou File.open. Jako první parametr se předá jméno souboru, a jako druhý parametr mód přístupu. Pro zápis se používá písmeno "w" (z anglického slova write). Otevřený soubor se předá do bloku v proměnné f. Proměnná f není přímo obsahem souboru, takže do ní nemůžeme přímo přiřazovat. Jedná se spíše o tzv. "handler", neboli přístupový objekt, se kterým můžeme pracovat pomocí speciálních metod. Některé z těchto metod jsou stejné jako ty, na které jsme byli zvyklí při práci s textovým výstupem, mimo jiné lze na přístupovém objektu souboru používat metody puts a print. Tyto metody můžeme použít pro zapsání obsahu do souboru, který se následně za koncem bloku zase sám zavře. Pro čtení se použije také příkaz File.open, ale soubor otevřeme v módu "r" (read). Uvnitř bloku potom můžeme iterovat přes jednotlivé řádky metodou each_line, která postupně každý řádek předá do proměnné line.

# Otevrit soubor pro zapis (write) a predat do bloku v promenne f
File.open("testfile.txt","w") do |f|
  # Zapsat text do souboru
  f.puts "This is a test"
  f.puts "This is only a test"
end

# Otevrit soubor pro cteni
File.open("testfile.txt","r") do |f|
# Iterovat pres jednotlive radky
  f.each_line do |line|
    puts line
  end
  puts f.read
end

This is a test
This is only a test

Kopírování s použitím bloků

V následujícím příkladu budeme kopírovat obsah ze souboru testfile_source.txt do souboru testfile_target.txt. Používáme vnořené bloky, abychom měli oba soubory otevřené. Na pořadí bloků nezáleží, jeden předává proměnnou source a druhý target. Přes zdrojový soubor iterujeme metodou each_line a do cílového souboru zapisujemem metodou puts.

# Otevrit zdrojovy soubor pro zapis (write) a predat do bloku v promenne f
File.open("testfile_source.txt","w") do |f|
  # Zapsat text do souboru
  f.puts "This is a test"
  f.puts "This is only a test"
  f.puts "Line 3"
end

File.open("testfile_source.txt","r") do |source|
  File.open("testfile_target.txt","w") do |target|
    # Vypsat jmena souboru
    puts "Copying from #{ source.path } to #{ target.path }"    
    # Iterovat pres radky zdrojoveho souboru
    source.each_line do |line|
      # Kazdy radek zapisat do ciloveho souboru
      target.puts line
    end
  end
end

# Otevrit cilovy soubor pro cteni
File.open("testfile_target.txt","r") do |f|
  # Iterovat pres jednotlive radky
  f.each_line do |line|
    puts line
  end
end

Copying from testfile_source.txt to testfile_target.txt
This is a test
This is only a test

Kopírování s použitím přístupových objektů

Se soubory je možné pracovat i obecnějším způsobem, který může být vhodnější pro některá speciální použití. Přístupový objekt vytvoříme metodou File.new, které předáme opět jméno souboru a mód přístupu. Pro zápis, resp. čtení dat používáme metody puts a gets. Po dokončení práce se souborem bez použití bloku je potřeba soubor vždy zavřít. Pokud bychom soubor nezavřeli, tak by mohlo dojít ke ztrátě dat, nebo k vyčerpání systémových prostředků (na některých operačních systémech je maximum např. 100 otevřených souborů). Pro čtení souboru po řádcích můžeme zajímavým způsobem využít cyklus while. V tomto cyklu používáme přiřazovací operaci current_line = gets pro přečtení řádku ze souboru. Přiřazovací příkazy v ruby stejně jako skoro vše ostatní předávají dál přiřazovanou hodnotu (je např. možné legálně naplnit 3 proměnné příkazem a=b=c=1). Tohoto efektu využíváme v cyklu while, kdy přiřazení slouží zároveň jako podmínka. Když se narazí na konec souboru, tak se do proměnné current_line přiřadí nil, a cyklus skončí.

# Otevreme soubor testfile_source.txt pro zapis
f = File.new("testfile_source.txt","w")
# Zapiseme text
f.puts "This is a test"
f.puts "This is only a test"
# Soubor ted musime zavrit
f.close

# Otevreme soubor source pro cteni
source = File.new("testfile_source.txt","r")
# Otevreme soubor target pro zapis
target = File.new("testfile_target.txt","w")

puts "Copying from #{ source.path } to #{ target.path }"

# Cist obsah source po radcich. Kdyz se narazi na konec souboru,
# tak je vysledkem prirazeni current_line = source.gets nil a cyklus skonci
while current_line = source.gets
  target.puts current_line
end

# Zavrit oba soubory
source.close
target.close

# Otevrit soubor testfile_target.txt pro cteni
f = File.new("testfile_target.txt","r")
while current_line = f.gets
  # Vypsat kazdy radek souboru
  puts current_line
end
f.close

Copying from testfile_source.txt to testfile_target.txt
This is a test
This is only a test

Zápis do existujícího souboru

Pokud otevřeme soubor v módu "w", tak vždy dojde k jeho vymazání. To není vždy úplně žádoucí, někdy např. můžeme chtít jenom připsat další řádky na konec existujícího souboru. Pro tento účel se používá přístupový mód "a" (append). V následujícím příkladu se pokusíme zjistit, jestli soubor existuje použitím metody File.exists?. Pokud se soubor v současném pracovním adresáři nachází, metoda vrátí true a my otevřeme soubor pro přidávání na konec a zapíšeme do něj text "Another line". Pokud soubor neexistuje, tak jej otevřeme pro zápis a vložíme do něj text "First line".

 filename = "appendfile.txt"

# Test jestli soubor existuje
if File.exists?(filename)
  puts "Going to append to #{filename}"
  line_to_write = "Just another line"
else
  puts "Going to create #{filename}"
  line_to_write = "The first line!"
end

# Soubor otevreme pro pridavani na konec (append). 
# Pokud soubor neexistuje, tak se vytvori
File.open(filename,"a") do |f|
  f.puts line_to_write
  puts "Text written: \"#{line_to_write}\""
end

 Going to create appendfile.txt
Text written: "The first line!"

Argumenty z příkazové řádky

Když už náš program umí pracovat se soubory, tak se tím konečně stává "opravdovým programem", který skutečně "něco dělá". Nejde v něm už jenom o to, že do něj něco napíšeme a pak se nám něco dalšího zobrazí na monitoru. Teď už umíme číst a zapisovat reálné datové soubory. K tomu, aby náš program byl skutečně použitelný, bez editoru, přímo v operačním systému, nám zbývá ukázat si jednu důležitou funkcionalitu - parametry z příkazové řádky. Ruby programy se na příkazové řádce spouštějí příkazem ruby jmeno_meho_programu.rb. Pokud chceme našemu programu předat nějaké parametry (typicky to bývá např. jméno souboru, do kterého chceme zapisovat), tak tyto parametry zapíšeme oddělené mezerou za jméno programu. Celý formát tedy potom vypadá následovně: ruby jmeno_meho_programu.rb parametr1 parametr2 parametr3 ... parametrN. Předané parametry jsou uloženy v poli ARGV, a můžeme k nim přistupovat tak, jak jsme u pole zvyklí, tedy pomocí indexů. Následujícímu programu předáme v parametrech počet opakování, řetězec, který se má opakovat, a výsledný soubor. Program potom otevře tento soubor pro zápis a náš vybraný text do něj v určeném počtu opakování zapíše. Abychom si trochu zjednodušili práci a nemuseli spouštět opravdovou příkazovou řádku, použijeme funkci NetBeans pro předávání parametrů programu. Tyto parametry lze navolit ve vlastnostech projektu (Properties), sekce Run. Pro náš konkrétní program už byly parametry nastaveny, stačí jej spustit obvyklým způsobem.

 puts "You have executed this script with following arguments:"
# Iterujeme pres pole argumentu
ARGV.each_with_index do |arg,i|
  puts "#{i+1}. #{arg}"
end

# Priradime argumenty do promennych
count = ARGV[0].to_i
text = ARGV[1]
filename = ARGV[2]

puts "Text \"#{text}\" will be written to #{filename} #{count} times..."

# Zapiseme vysledek do souboru
File.open(filename,"w") do |f|
  count.times do
    f.puts text
  end
end

puts "Done!"

 You have executed this script with following arguments:
1. 10
2. This is from command line
3. arguments.txt
Text "This is from command line" will be written to arguments.txt 10 times...
Done!

Závěr

To je pro dnešek vše a v příštím dílu se podíváme jak pracovat s formátem XML v Ruby.