lygre 0.0.1

data/spec/gabcgrammar_spec.rb

@@ -0,0 +1,222 @@
+# encoding: UTF-8
+
+require_relative 'spec_helper'
+
+# the GabcParser is described through the file format
+# it should be able to parse
+describe 'gabc' do
+
+  describe 'valid gabc file must contain a header delimiter' do
+
+    it 'file with just the header delimiter is valid' do
+      "%%\n".should compile
+    end
+
+    it 'file without header delimiter is invalid' do
+      src = ""
+      src.should_not compile
+    end
+  end
+
+  describe 'header contains' do
+        
+    describe 'whitespace' do
+      it '- any number of empty lines' do
+        src = "\n\n\n\n%%\n"
+        src.should compile
+      end
+
+      it '- spaces and tabs' do
+        src = "    \n\t\n%%\n"
+        src.should compile
+      end
+    end
+
+    describe 'header fields' do
+      it '- e.g. "name"' do
+        src = "name: incipit;\n%%\n"
+        src.should compile
+      end
+
+      it 'whose identifiers may include dashes' do
+        src = "office-part: introitus/...;\n%%\n"
+        src.should compile
+      end
+
+      it '- a lot of them' do
+        src = load_example 'header.gabc'
+        src.should compile
+      end
+    end
+
+    describe 'comments' do
+      it ', which may occupy a whole line' do
+        src = "% comment\n%%\n"
+        src.should compile
+      end
+
+      it 'following whitespace' do
+        src = "  % comm' comm' comment\n%%\n"
+        src.should compile
+      end
+
+      it 'following header fields' do
+        src = "name: incipit; % what a beautiful name!\n%%\n"
+        src.should compile
+      end
+    end
+
+  end
+
+  describe 'body contains' do
+
+    describe 'whitespace' do
+      it '- any number of empty lines' do
+        "%%\n\n\n\n\n".should compile
+      end
+
+      it '- spaces and tabs' do
+        "%%\n    \n\t\n".should compile
+      end
+    end
+
+    describe 'clef' do
+      it 'c clef on the 3rd line' do
+        "%%\n(c3)".should compile
+      end
+
+      it 'c clef on the 1st line' do
+        "%%\n(c1)".should compile
+      end
+
+      it 'c clef with bemol' do
+        "%%\n(cb3)".should compile
+      end
+
+      it 'f clef on the 3rd line' do
+        "%%\n(f3)".should compile
+      end
+    end
+
+    describe 'music' do
+      it 'some simple notes' do
+        "%%\n(a) (h) (g) ".should compile
+      end
+
+      it 'all possible notes' do
+        "%%\n (a) (b) (c) (d) (e) (f) (g) (h) (i) (j) (k) (l) (m)".should compile
+      end
+
+      it 'empty music chunk is also valid' do
+        "%%\n ()".should compile
+      end
+
+      describe 'one-note neumes without and with shape modifiers' do
+        it { "%%\n (g)".should compile }
+        it { "%%\n (G) (G~) (G>)".should compile } 
+        it { "%%\n (g~) (g<) (g>)".should compile }
+        it { "%%\n (go) (go~) (go<)".should compile }
+        it { "%%\n (gw) (gv) (gs) (gs<)".should compile }
+        it { "%%\n (-f)".should compile }
+        it { "%%\n (gqi)".should compile }
+        it { "%%\n (gWi)".should compile }
+        it { "%%\n (gr) (gR) (gr0)".should compile }
+      end
+
+      describe 'repetitions' do
+        it { "%%\n (gvv)".should compile }
+        it { "%%\n (gsss)".should compile }
+      end
+
+      describe 'rhythmic signs' do
+        it { "%%\n (g.)".should compile }
+        it { "%%\n (g..)".should compile }
+        it { "%%\n (g_)".should compile }
+        it { "%%\n (g')".should compile }
+        it { "%%\n (g_0)".should compile }
+        it { "%%\n (g__0)".should compile }
+        it { "%%\n (g_')".should compile }
+        it { "%%\n (g_h_)".should compile }
+      end
+
+      describe 'accents' do
+        it { "%%\n (gr1)".should compile }
+        it { "%%\n (gr0r1)".should compile } # linea punctum cavum + accent
+        it { "%%\n (gr2) (gr3) (gr4) (gr5)".should compile }
+      end
+
+      describe 'composed neumes' do
+        it { "%%\n (ghg)".should compile }
+        it { "%%\n (hvGFE)".should compile }
+        it { "%%\n (hghe)".should compile }
+      end
+
+      describe 'alterations' do
+        it { "%%\n (gxg)".should compile }
+        it { "%%\n (gyg)".should compile }
+        it { "%%\n (g#g)".should compile }
+      end
+
+      describe 'spaces' do
+        it { "%%\n (h/h)".should compile }
+        it { "%%\n (h//h)".should compile }
+        it { "%%\n (h h)".should compile }
+        it 'unbreakable space' do 
+          "%%\n (h! h)".should compile 
+        end
+        it 'prevent note linking' do
+          "%%\n (gh!i)".should compile 
+        end
+      end
+
+      describe 'divisiones' do
+        it { "%%\n (,) (`) (;) (:) (::)".should compile }
+        it { "%%\n (;1) (;2) (;3) (;4) (;5) (;6)".should compile }
+        it { "%%\n (:') (,_)".should compile }
+      end
+
+      describe 'forced line-breaks' do
+        it { "%%\n (ez)".should compile }
+        it { "%%\n (eZ)".should compile }
+      end
+
+      describe 'custos, guide' do
+        it { "%%\n (z0)".should compile }
+        it { "%%\n (h) (g) (::) (h+)".should compile }
+      end
+
+      describe 'choral signs' do
+        it { "%%\n (g[cs:sign]h)".should compile }
+      end
+
+      describe 'braces' do
+        it { "%%\n (g[ob:1;6mm])".should compile }
+        it { "%%\n (g[ob:0;7mm])".should compile }
+        it { "%%\n (g[ocb:1;6mm])".should compile }
+        it { "%%\n (g[ocba:1;6mm])".should compile }
+      end
+
+      describe 'real-life examples that once failed' do
+        it { "%%\n ad(IV./hig)".should compile }
+      end
+    end
+
+    describe 'lyrics' do
+      it 'simple word with simple notes' do
+        "%%\n or(h)bis(h)".should compile
+      end
+
+      describe 'special characters' do
+        it { "%%\n <sp>R/</sp>() re(g)spon(f)sum(e)".should compile }
+        it { "%%\n tu(h)<sp>'ae</sp>(h)".should compile }
+      end
+
+      describe 'formatting' do
+        it { "%%\n <b>tu</b>(h)ae(h)".should compile }
+        it { "%%\n po(h)<i>pu</i>(h)<i>li</i>(h)".should compile }
+        it { "%%\n <sc>can. i</sc>()".should compile }
+      end
+    end
+
+  end
+end

data/spec/gabcparser_spec.rb

@@ -0,0 +1,44 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe GabcParser do
+
+  before :each do
+    # beginning of the Populus Sion example
+    @src = "name: Populus Sion;\n%%\n
+(c3) Pó(eh/hi)pu(h)lus(h) Si(hi)on,(hgh.) *(;) 
+ec(hihi)ce(e.) Dó(e.f!gwh/hi)mi(h)nus(h) vé(hi)ni(ig/ih)et.(h.) (::)"
+    @parser = GabcParser.new
+  end
+
+  describe '#parse' do
+    it 'returns ScoreNode' do
+      @parser.parse(@src).should be_kind_of Gabc::ScoreNode
+    end
+  end
+
+  describe 'lyrics_syllable rule' do
+    it 'does not accept space' do
+      @parser.parse(' ', root: :lyrics_syllable).should be_nil
+    end
+
+    it 'does not accept string beginning with space' do
+      @parser.parse(' aa', root: :lyrics_syllable).should be_nil
+    end
+
+    it 'accepts ascii characters' do
+      @parser.parse('aa', root: :lyrics_syllable).should be_true
+    end
+
+    it 'accepts characters with accents' do
+      @parser.parse('áéíóúý', root: :lyrics_syllable).should be_true
+    end
+  end
+
+  describe 'regular_word_character rule' do
+    it 'does not accept space' do
+      @parser.parse(' ', root: :regular_word_character).should be_nil
+    end
+  end
+end

data/spec/gabcpitchreader_spec.rb

@@ -0,0 +1,116 @@
+# encoding: UTF-8
+
+describe GabcPitchReader do
+
+  describe '.new' do
+    it 'takes clef type and position' do
+      pr = GabcPitchReader.new(:c, 3)
+      pr.clef.should eq :c
+      pr.clef_position.should eq 3
+
+      pr = GabcPitchReader.new(:f, 3)
+      pr.clef.should eq :f
+    end
+  end
+
+  describe '#base returns absolute pitch of the lowest writable note (a)' do
+    #it { GabcPitchReader.new(:c, 4).base.should eq NoteFactory["a"] }
+    #it { GabcPitchReader.new(:f, 2).base.should eq NoteFactory["a"] }
+
+    #it { GabcPitchReader.new(:c, 1).base.should eq NoteFactory["g'"] }
+    #it { GabcPitchReader.new(:f, 1).base.should eq NoteFactory["c'"] }
+  end
+end
+
+describe NoteFactory do
+
+  before :all do
+    @f = NoteFactory
+  end
+
+  describe '.create' do
+    it { @f.create("c'").value.should eq 60 }
+    it { @f.create("c''").value.should eq 72 }
+    it { @f.create("c'''").value.should eq 84 }
+
+    it { @f.create("c").value.should eq 48 }
+    it { @f.create("c,").value.should eq 36 }
+    it { @f.create("c,,").value.should eq 24 }
+
+    it { @f.create("c").value.should eq 48 }
+    it { @f.create("d").value.should eq 50 }
+    it { @f.create("e").value.should eq 52 }
+    it { @f.create("f").value.should eq 53 }
+    it { @f.create("g").value.should eq 55 }
+    it { @f.create("a").value.should eq 57 }
+    it { @f.create("b").value.should eq 59 }
+
+    it { expect { @f.create("x") }.to raise_exception ArgumentError }
+    it { expect { @f.create("c*") }.to raise_exception ArgumentError }
+  end
+
+  describe '.lily_abs_pitch' do
+    it 'operates exactly reverse to .create' do
+      %w{ c d g c' f' a' b' g'' d''' c, c,, c,,, d, e, e,, b, }.each do |lypitch|
+        @f.lily_abs_pitch(@f[lypitch]).should eq lypitch
+      end
+    end
+  end
+
+  describe '[]' do
+    it { @f["c'"].value.should eq 60 }
+    it { @f["c''"].value.should eq 72 }
+  end
+end
+
+describe 'monkey-patched RBMusicTheory' do
+
+  before :each do
+    @f = NoteFactory
+    @s = @f["c''"].major_scale
+  end
+
+  describe 'Note#diatonic_steps' do
+    it { @f["c'"].diatonic_steps(1).should eq @f["d'"] }
+    it { @f["c'"].diatonic_steps(0).should eq @f["c'"] }
+    it { @f["c'"].diatonic_steps(7).should eq @f["c''"] }
+    it { @f["c'"].diatonic_steps(8).should eq @f["d''"] }
+    it { @f["c'"].diatonic_steps(-2).should eq @f["a"] }
+    it { @f["c''"].diatonic_steps(-9).should eq @f["a"] }
+    it { @f["c'''"].diatonic_steps(-9).should eq @f["a'"] }
+    it { @f["c,"].diatonic_steps(-9).should eq @f["a,,,"] }
+    it { @f["c,"].diatonic_steps(-10).should eq @f["g,,,"] }
+  end
+
+  describe 'Note#degree_in' do
+    it { @f["c''"].degree_in(@s).should eq 1 }
+    it { @f["d''"].degree_in(@s).should eq 2 }
+
+    it { @f["c'''"].degree_in(@s).should eq 8 }
+    it { @f["e'''"].degree_in(@s).should eq 10 }
+    it { @f["b'"].degree_in(@s).should eq 0 }
+    it { @f["a'"].degree_in(@s).should eq -1 }
+    it { @f["a"].degree_in(@s).should eq -8 }
+
+    it 'behaves consistently with Scale#degree' do
+      [2, 8, -1, -12].each do |deg|
+        @s.degree(deg).degree_in(@s).should eq deg
+      end
+    end
+  end
+
+  describe 'Scale#degree' do
+    describe 'for positive degrees it behaves as expected' do
+      it { @s.degree(1).should eq @f["c''"] }
+      it { @s.degree(2).should eq @f["d''"] }
+      it { @s.degree(8).should eq @f["c'''"] }
+    end
+
+    describe 'and then there is zero and negative numbers' do
+      it { @s.degree(0).should eq @f["b'"] }
+      it { @s.degree(-1).should eq @f["a'"] }
+      it { @s.degree(-8).should eq @f["a"] }
+      it { @s.degree(-15).should eq @f["a,"] }
+    end
+  end
+end

data/spec/gabcscore_spec.rb

@@ -0,0 +1,143 @@
+# encoding: UTF-8
+
+require_relative 'spec_helper'
+
+# GabcScore is the parsing result returned by GabcParser
+
+describe GabcScore do
+
+  before :each do
+    # beginning of the Populus Sion example
+    @src = "name: Populus Sion;\n%%\n
+(c3) Pó(eh/hi)pu(h)lus(h) Si(hi)on,(hgh.) *(;) 
+ec(hihi)ce(e.) Dó(e.f!gwh/hi)mi(h)nus(h) vé(hi)ni(ig/ih)et.(h.) (::)"
+    @parser = GabcParser.new
+  end
+
+  describe 'creation' do
+    it 'is returned by ScoreNode#create_score' do
+      @parser.parse(@src).create_score.should be_a GabcScore
+    end
+  end
+
+  describe '#header' do
+    before :each do
+      @score = @parser.parse(@src).create_score
+    end
+
+    it 'is a Hash' do
+      @score.header.should be_kind_of Hash
+    end
+
+    it 'contains the field specified in the score' do
+      @score.header.should have_key 'name'
+    end
+
+    it 'contains the field value' do
+      @score.header['name'].should eq 'Populus Sion'
+    end
+
+    it 'may be empty' do
+      src = "%%\n"
+      score = @parser.parse(src).create_score
+      score.header.should be_empty
+    end
+  end
+
+  describe '#music' do
+    before :each do
+      @score = @parser.parse(@src).create_score
+    end
+
+    it 'is GabcMusic' do
+      @score.music.should be_kind_of GabcMusic
+    end
+  end
+end
+
+describe GabcMusic do
+
+  before :each do
+    # beginning of the Populus Sion example
+    @src = "name: Populus Sion;\n%%\n
+(c3) Pó(eh/hi)pu(h)lus(h) Si(hi)on,(hgh.) *(;) 
+ec(hihi)ce(e.) Dó(e.f!gwh/hi)mi(h)nus(h) vé(hi)ni(ig/ih)et.(h.) (::)"
+    @parser = GabcParser.new
+    @music = @parser.parse(@src).create_score.music
+  end
+
+  describe '#clef' do
+    subject { @music.clef }
+    it { should be_a GabcClef }
+  end
+
+  describe '#words' do
+    subject { @music.words }
+    it { should be_a Array }
+    it { should_not be_empty }
+    it { should contain_a GabcWord }
+  end
+end
+
+describe GabcClef do
+
+  before :each do
+    # beginning of the Populus Sion example
+    @src = "name: Populus Sion;\n%%\n
+(c3) Pó(eh/hi)pu(h)lus(h) Si(hi)on,(hgh.) *(;) 
+ec(hihi)ce(e.) Dó(e.f!gwh/hi)mi(h)nus(h) vé(hi)ni(ig/ih)et.(h.) (::)"
+    @parser = GabcParser.new
+    @music = @parser.parse(@src).create_score.music
+    @clef = @music.clef
+  end
+
+  it 'should return key from the score' do
+    @clef.to_s.should eq 'c3'
+  end
+
+  it 'has no bemol' do
+    @clef.bemol.should be_false
+  end
+
+  describe 'has bemol' do
+    before :each do
+      src = "%%\n(cb3)"
+      @music = @parser.parse(src).create_score.music
+    end 
+
+    it { @music.clef.bemol.should be_true }
+    it { @music.clef.to_s.should eq 'cb3' }
+  end
+end
+
+describe GabcWord do
+  before :each do
+    # beginning of the Populus Sion example
+    @src = "name: Populus Sion;\n%%\n
+(c3) Pó(eh/hi)pu(h)lus(h) Si(hi)on,(hgh.) *(;) 
+ec(hihi)ce(e.) Dó(e.f!gwh/hi)mi(h)nus(h) vé(hi)ni(ig/ih)et.(h.) (::)"
+    @parser = GabcParser.new
+    @music = @parser.parse(@src).create_score.music
+    @word = @music.words.first
+  end
+
+  describe 'a simple word' do
+    subject { @word }
+    it { should_not be_empty }
+    it { should contain_a GabcSyllable }
+  end
+
+  describe 'lyrics' do
+    it { @word.size.should eq 3 }
+    it { @word.first.lyrics.should eq 'Pó' }
+    it { @word[1].lyrics.should eq 'pu' }
+    it { @music.words[1].first.lyrics.should eq 'Si' }
+    it { @music.words[-2].last.lyrics.should eq 'et.' }
+    it { @music.words.last.last.lyrics.should eq '' }
+  end
+
+  describe 'notes' do
+    it { @word.first.notes.should_not be_empty }
+    it { @word.first.notes.first.pitch.should eq :e }
+  end
+end