Dotaz: Ruby - dotaz (prosba) spolupráce

[Edelstadt]

Zdravím, omlouvám se za titulek, nic lepšího mě nenapadlo. Ve zkratce - mám skript v ruby vypočítávající určité chronologické pomůcky (sluneční kruh, epakty, nedělní písmena atd.) na GTK. Funguje (víceméně), ale je mi jasný, že jako naprostý amatér a začátečník to je tak říkajíc zprasený (i s ohledem na to, že je to vytvořený za jedno odpoledne). Otázka zní - je tu někdo, kdo by to popřípadě upravil, řekněme uhladil? Nemám iluze, že by to využilo milion lidí, ale pro určité lidi by to mohlo být zajímavé a usnadnit práci. Předem děkuji.

Odpovědi

[wamba]

takhle ti těžko někdo pomůže, protože o tom skriptu není žádná představa.

zkus ho sem vložit (např. jako přílohu, odkaz na github atp.) a určitě se tu někdo najde, kdo ti alespoň s nějakými úpravami pomůže.

bude podle mě lepší, když ty úpravy budeš dělat sám podle návrhů, než ti ho někdo celý přepíše :)

[Edelstadt]

Příloha:

• hodiny2.rb (10397 bytů)

Tak tedy přikládám soubor se skriptem. Hanba mě fackuje a vůbec se mi nechtělo takový amatérský počin uveřejňovat, ale uvědomuji si, že to tak bude nejlepší a dám na radu.

[Michal Karas]

No začal bych asi tím, že bych začal dodržovat to, čemu se česky říká štábní kultura, anglicky styleguide. Viz například Ruby Styleguide na GitHubu.

Takhle to je opravdu hrozný bordel. Jednou neodsadíš vůbec, podruhé použiješ dvě mezery, potřetí tabulátor...

605 znaků na řádek je taky moc, existují důvody pro to, aby ses držel zavedených 80 znaků.

Co se týče Ruby, tak bych měl několik tipů:

Návratovou hodnotou z metody je v případě absence klíčového slova return implicitně poslední vyhodnocený výraz, takže je běžný idiom u jednoduchých metod ten return vynechávat. Například namísto:

def epakty_j(g)
   x = ((g-1)*11)%30
   return x
end

mít jen:

def epakty_j(g)
  ((g - 1) * 11) % 30
end

Dále se mrkni, jakým způsobem se v Ruby používá case. Tvá metoda epakta_jj je krásným adeptem:

def epakta_jj(h)
  case h
  when 1 then 11
  when 2 then 22
  ...
  end
end

A metody celkově by neměly být příliš dlouhé a obsahovat příliš mnoho přiřazení. Vyzkoušej například nástroj reek, který se snaží hledat code smells. U věcí, které ti nahlásí jako problematické, to chce zkusit se trochu zamyslet, jestli to nejde vyřešit lépe. Mnohokrát to totiž opravdu lépe jde. Máš tam třeba metodu nedelni_pismeno_g, která má 127 řádků, to je hrozně moc. Když se na ni jen tak zběžně koukám, nebylo by lepší brát informace z nějaké interní datové struktury a tu metodu použít jen na její interpretaci?

NEDELNI_PISMENA = [ [1583..1699, { 'A' => 'D', 'B' => 'E', ... }],
                    [1700..1799, { 'A' => 'E', 'B' => 'F', ... },
                    ... ]

def nedelni_pismeno_g(c, d)
  range = NEDELNI_PISMENA.find { |x| x.first.include?(d) }
  return 'Neni' if range.nil?
  range.last[c]
end

Navíc je fajn dávat proměnným rozumná jména, lépe se to pak čte. Předpokládám, že u té poslední metody (nedelni_pismeno_g) je například proměnná d rok.

Neznám tu tvou doménovou oblast, takže je možné, že některé ty věci lze řešit elegantněji nějak algoritmicky, ale to já už takhle na první pohled těžko posoudím.

[Edelstadt]

Super, děkuji mnohokráte za odpověď, něco takovýho jsem potřeboval Ovšem tak nějak tuším, že vymyslet to, co už mám nebylo zdaleka tak hrozný jako to upravit...Každopádně děkuji, přijdu zas

[wamba]

(předem Ruby není programovací jazyk, ve kterém se dobře vyznám, tak berte mé rady s rezervou) no dejme tomu nedelni_pismeno_j by šlo napsat například jako

 
NEDELNI_PISMENO=%w[A GF E D C BA G F E DC B A G FE D C B AG F E D CB A G F ED C B A] 
def nedelni_pismeno_j(b)
   return NEDELNI_PISMENO[b]
end

dále tam je příliš mnoho "magických proměnných" např. 19 znamená, co? a těch 19 ve velikonoce_j a ve zlate_cislo je totéž? Proto je zvykem definovat konstantu s vysvětlujícím názvem a pak ji používat místo toho čísla.

a taky bych změnil úvodní komentář (pokud nejste Marcus Scalpere) :)

[Edelstadt]

Úpravy algoritmů naprosto vítány, v tom mám velký rezervy a vypadá to pak strašně. Co se dotýče těch proměných, je to trochu složitější...určitě by to šlo nějak popsat, ovšem vysvětlení by nejspíš ani nešlo popsat nějak stručně. Zrovna u toho zlatého čísla ta 19 určue 19ti letý cyklus, ve kterých se opakují fáze měsíce ve stejný kalendářní den. Komentář snad jediný měnit nemusím, jsem to já

[wamba]

já bych klidně zadefinoval něco jako CYKLUS_OPAKOVANI_FAZE_MESICE=19 a pak používal tuhle konstantu (v dobrém editoru to nebude žádné zdržení při používání dlouhých jmen konstant) a zvýší to srozumitelnost

tady je návrh úpravy subrutiny nedelni_pismeno_g

def nedelni_pismeno_g(c, d)
  pismena_h={
    'A' => 6,
    'B' => 5, 
    'C' => 4, 
    'D' => 3, 
    'E' => 2,
    'F' => 1,
    'G' => 0,
  }
  #pismena_a=pismena_h.keys.sort! {|a,b| pismena_h[a] <=> pismena_h[b]}
  pismena_a=%w[G F E D C B A]

  if d <= 1582 or d >= 2100
    return "Neni"
  end
  
  posun = d <= 1699 ? 3 :
          d <= 1799 ? 4 :
          d <= 1899 ? 5 :
          d <= 2099 ? 6 : 0

  if c.length == 1
    return pismena_a[pismena_h[c] - posun % pismena_a.length]
  else
    return nedelni_pismeno_g(c[0],d)+nedelni_pismeno_g(c[1],d)
  end
end

opět potřeba brát s rezervou píši, co mě právě napadlo a na co jsem narazil v manuálu Ruby :)

[Michal Karas]

Ternární operátor se kvůli čitelnosti obvykle používá jen na jednoduché věci, které se bez problému vejdou na jeden řádek. Použít 4 tyto operátory v jednom přiřazení IMHO není vhodné. V Ruby by se na ten tvůj případ nejlépe hodil asi case a do when větví by se to rozstřelovalo podle instancí Range.

[wamba]

Beru na vědomí. Jak už jsem nastínil, v Ruby neznám pořádně ani standardní příkazy a syntaxi, natož zvyklosti. (A mi vlastní je jazyk, u kterého "case-like" konstrukce je poměrně novinkou :))

Navíc se dopouštím toho, co předtím kritizuji, že používám "magická čísla".

Zkrátka nelze mnou navržené řešení brát jako hotovou věc, ale spíš směr, kudy by se ty úpravy mohli ubírat.

[Jirka]

Co sem koukal, tak ve funkci rozdil_e(j) je chyba v algoritmu. Rozdíl ve dnech mezi julianským a gregorianským kalendářem se mění ne při změně letopočtu, ale až při přestupném dni. Vše je již vypočteno na Jaký je dnes den dle juliánského kalendáře.

[Edelstadt]

Příloha:

• h2.rb (6242 bytů)

Dobrá, ztrapním se ještě jednou. Předělávám podle rad a postupně zkouším, ovšem narazil jsem na jeden problém. Funguje je to, až na některé roky, třeba 1993 (přitom 1992 funguje) a nějak si to nedovedu vysvětlit. Přiložím sem "nový" výtvor. A děkuji mnohokráte za všechny rady a připomínky

[wamba]

jak už jsem psal, já bych něco, kde mám prvky očíslovány 1..n, tak bych použil pole

např.

def epakta_jj(h)
  return [ 0, 11, 22, 3, 14, 25, 6, 17, 28, 9, 10, 1, 12, 23, 9, 15, 26, 7, 18, 29 ][h]
end

pak tam je často něco jako pokud je rok pod 1700 vrať tohle číslo, pokud je pod 1800 tak tohle atd. tak to by se dalo napsat do subrutiny,

používal bych nějakou untilitu, která do kódu správně doplní mezery (tidy)

[Michal Karas]

Pořád ti hapruje ta štábní kultura. Pro odsazení tam máš smíchané tabulátory, 2 mezery, 3 mezery, 12 mezer, ...

Mezery kolem operátorů máš jen v první půlce skriptu, v té druhé už to vše lepíš na sebe.

V metodě insert_text máš pořád řádek dlouhý 590 znaků. Nevím co za objekt je txtvu.buffer.text, ale většina tříd pro práci s řetězci anebo IO má definovaný operátor <<, který ti umožní to rozdělit do více řádků.

Když chceš, aby některá větev case byla použita pro více hodnot, tak máš u where [hodnota1, hodnota2, ...]. To je špatně! Ruby používá operátor ===, aby zjistilo, jestli se tou větví vydat. Uzavřením více hodnot do hranatých závorek způsobíš to, že se ti porovnává pole s nějakou hodnotou, například [2, 8, 19] === sKruh u metody nedelni_pismeno_j. Ty hranaté závorky odstraň.

Když už jsme u toho, název proměnné sKruh taky není ideální. Je konvence používat snake case pro jména proměnných, tedy například slunecni_kruh.

Zbav se toho zanořeného ternárního operátoru. Naopak bych ho použil u metod konkurenty a zlate_cislo:

def zlate_cislo(rok)
  x = (rok + 1) % 19
  x == 0 ? 19 : x
end

U metody velikonoce_g si hlídáš, aby fungovala až pro roky větší než 1582. U takto jednoduchých výrazů je v Ruby konvence dávat podmínku až za výraz: return 'neni' if x <= 1582.

Jinak u metod velikonoce_j a velikonoce_g máš jeden vstupní argument, jednou se jmenuje x, podruhé l. Tohle je matoucí, musel jsem se podívat, jak ty metody voláš z insert_text, abych zjistil, v čem je tam rozdíl. A rozdíl tam není. Oba ty parametry pojmenuje rok anebo year, abys ulehčil čtení kódu ostatním a vlastně i sobě, až se k tomu skriptu v budoucnu vrátíš a už ho nebudeš mít celý v hlavě.

K těm metodám bych měl ještě jednu poznámku. Jako vstup pro ně máš rok a výstup například "22. dubna". Snaž se dělat metody tak, aby plnily vždy jen jednu úlohu. Tady už máš smíchané dvě věci dohromady: výpočet dne velikonoc a naformátování datumu na český řetězec. Navrhoval bych, aby metody velikonoce_j a velikonoce_g vracely instanci třídy Date a dodělej si metodu, která ti naformátuje Date na české datum. Jako výhodu to má například to, že všechny tři ty metody budou snadněji znovupoužitelné v budoucnu.

[Michal Karas]

A hlavně to vůbec neber jako ztrapňování se! Každý nějak začíná a je stokrát lepší se zeptat a postupně se zlepšovat, než být se sebou spokojený a psát prasácký kód.