gly 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 341817505f45deff8e6c9815061fa6cffa571858
+  data.tar.gz: 64ff6cb093190e69c37ed874af5c9b34e1499c3f
+SHA512:
+  metadata.gz: 41ba343096d37f095b7e9ca1724a8692d7bf4ca6dfcac689e681e9c61c1c95067ec42ba18f6fa8de259f6bf70b1960e5108f1f2503be1044e8df64bb0ec6fa96
+  data.tar.gz: a14a88215832854321ecadff5fd0f0c01a057d3ad991873aede7d91b879da35edfe197bca214144a55a4ad4ff893d0a365505849ce62020b9da7361a5fe9a2e8

data/bin/gly

@@ -0,0 +1,11 @@
+#!/bin/env ruby
+
+# gly
+# takes gly file, produces gabc file(s);
+# optionally makes a simple tex file including it(them) and
+# builds a pdf.
+
+require 'gly'
+require 'gly/cli'
+
+Gly::CLI.start ARGV

data/bin/glyfy

@@ -0,0 +1,4 @@
+#!/bin/env ruby
+
+# glyfy
+# takes gabc file(s), produces gly file

data/lib/gly.rb

@@ -0,0 +1,5 @@
+module Gly; end
+
+%w(parser gabc_convertor parsed_score headers lyrics document string_helpers).each do |mod|
+  require "gly/#{mod}"
+end

data/lib/gly.rb~

@@ -0,0 +1,5 @@
+module Gly; end
+
+%w(parser gabc_convertor).each do |mod|
+  require "lyv/#{mod}"
+end

data/lib/gly/cli.rb

@@ -0,0 +1,94 @@
+require 'thor'
+
+module Gly
+  # implements the 'gly' executable
+  class CLI < Thor
+    desc 'gabc FILE ...', 'convert gly to gabc'
+    def gabc(*files)
+      files.each {|f| gabc_convert(parse(f)) }
+    end
+
+    desc 'preview FILE ...', 'convert to gabc AND generate pdf preview'
+    def preview(*files)
+      files.each {|f| make_preview f }
+    end
+
+    private
+
+    def parse(gly_file)
+      document = File.open(gly_file) do |fr|
+        Parser.new.parse(fr)
+      end
+    end
+
+    def gabc_convert(doc)
+      doc.scores.each_with_index do |score, si|
+        score_id = score.headers['id'] || si.to_s
+        out_fname = File.basename(doc.path)
+                    .sub(/\.gly\Z/i, "_#{score_id}.gabc")
+        File.open(out_fname, 'w') do |fw|
+          GabcConvertor.new.convert score, fw
+        end
+        yield score, out_fname if block_given?
+      end
+    end
+
+    def make_preview(gly_file)
+      doc = parse(gly_file)
+
+      tex_header = <<EOS
+% LuaLaTeX
+
+\\documentclass[a4paper, 12pt]{article}
+\\usepackage[latin]{babel}
+\\usepackage[left=2cm, right=2cm, top=2cm, bottom=2cm]{geometry}
+
+\\usepackage{fontspec}
+
+% for gregorio
+\\usepackage{luatextra}
+\\usepackage{graphicx}
+\\usepackage{gregoriotex}
+
+\\title{#{doc.header['title']}}
+
+\\begin{document}
+
+#{doc.header['title'] && '\\maketitle'}
+
+EOS
+
+      tex_fname = File.basename(gly_file).sub(/\.gly\Z/i, '.tex')
+      File.open(tex_fname, 'w') do |fw|
+        fw.puts tex_header
+
+        gabc_convert(doc) do |score, gabc_fname|
+          system "gregorio #{gabc_fname}"
+          gtex_fname = gabc_fname.sub /\.gabc/i, ''
+          piece_title = %w(book manuscript arranger author).collect do |m|
+            score.headers[m]
+          end.delete_if(&:nil?).join ', '
+          fw.puts "\\commentary{\\footnotesize{#{piece_title}}}\n" unless piece_title.empty?
+
+          annotations = score.headers.each_value('annotation')
+          begin
+            fw.puts "\\setfirstannotation{#{annotations.next}}"
+            fw.puts "\\setsecondannotation{#{annotations.next}}"
+          rescue StopIteration
+            # ok, no more annotations
+          end
+
+          fw.puts "\\includescore{#{gtex_fname}}\n\\vspace{1cm}"
+        end
+
+        # tagline
+        fw.puts "\n\\vfill\n\\begin{center}"
+        fw.puts "\\texttt{gly preview https://github.com/igneus/gly}"
+        fw.puts "\\end{center}\n"
+        fw.puts "\n\\end{document}"
+      end
+
+      system "lualatex #{tex_fname}"
+    end
+  end
+end

data/lib/gly/cli.rb~

@@ -0,0 +1,13 @@
+module Gly
+  class CLI < Thor
+    desc 'gabc FILE ...', 'convert gly to gabc'
+    def gabc(*files)
+
+    end
+
+    desc 'preview FILE ...', 'convert to gabc AND generate pdf preview'
+    def preview(*files)
+
+    end
+  end
+end

data/lib/gly/document.rb

@@ -0,0 +1,15 @@
+module Gly
+  # Result of parsing of a gly file.
+  # Usually contains one or more scores
+  # and possibly a document header.
+  class Document
+    def initialize
+      @scores = []
+      @header = Headers.new
+      @path = nil
+    end
+
+    attr_reader :scores, :header
+    attr_accessor :path
+  end
+end

data/lib/gly/document.rb~

@@ -0,0 +1,8 @@
+module Gly
+  # Result of parsing of a gly file.
+  # Usually contains one or more scores
+  # and possibly a document header.
+  class Document
+
+  end
+end

data/lib/gly/gabc_convertor.rb

@@ -0,0 +1,60 @@
+module Gly
+  # converts parsed gly to gabc
+  class GabcConvertor
+    def convert(score, out=StringIO.new)
+      score.headers.each_pair do |key,value|
+        out.print '% ' unless Headers.gregorio_supported?(key)
+        out.puts "#{key}: #{value};"
+      end
+
+      out.puts '%%'
+
+      lyric_enum = score.lyrics.each_syllable.to_enum
+      score.music.each_with_index do |mus_chunk,i|
+        begin
+          next_syl = lyric_enum.peek
+        rescue StopIteration
+          next_syl = ''
+        end
+
+        if clef?(mus_chunk) ||
+           (nonlyrical_chunk?(mus_chunk) && ! nonlyrical_lyrics?(next_syl))
+          # music chunk normally not having lyrics
+          out.print ' ' if i != 0
+        else
+          # regular music chunk
+          begin
+            out.print strip_directives lyric_enum.next
+          rescue StopIteration
+            out.print ' ' if i != 0
+          end
+        end
+        out.print "(#{mus_chunk})"
+        # out.puts if differentia?(mus_chunk) # newline after each differentia
+      end
+
+      return out
+    end
+
+    def clef?(chunk)
+      chunk =~ /\A[cf][1-4]\Z/
+    end
+
+    def differentia?(chunk)
+      chunk =~ /\A*[,;:]+\Z/ # differentia
+    end
+
+    # is the given music chunk capable of bearing lyrics?
+    def nonlyrical_chunk?(chunk)
+      differentia? chunk
+    end
+
+    def nonlyrical_lyrics?(syl)
+      syl =~ /\A\s*!/ || syl =~ /\A\s*\*\Z/
+    end
+
+    def strip_directives(syl)
+      syl.sub(/(\s*)!/, '\1') # exclamation mark at the beginning - place even under nonlyrical music chunk
+    end
+  end
+end

data/lib/gly/gabc_convertor.rb~

@@ -0,0 +1,5 @@
+module Gly
+  # converts parsed gly to gabc
+  class GabcConvertor
+  end
+end

data/lib/gly/headers.rb

@@ -0,0 +1,80 @@
+require 'forwardable'
+
+module Gly
+  # score or document header
+  class Headers
+    extend Forwardable
+
+    # header fields supported by gregorio.
+    # Based on http://gregorio-project.github.io/gabc/index.html#header
+    # last checked 2015-12-06
+    GREGORIO_HEADERS = %w(
+name
+gabc-copyright
+score-copyright
+office-part
+occasion
+meter
+commentary
+arranger
+gabc-version
+author
+date
+manuscript
+manuscript-reference
+manuscript-storage-place
+book
+transcriber
+transcription-date
+gregoriotex-font
+mode
+initial-style
+centering-scheme
+user-notes
+annotation
+)
+
+    def initialize
+      # for quick lookup. Only holds a single value per header
+      @headers = {}
+      # holds order and as many values for a header as given in the
+      # score (typically annotation occurs more than once)
+      @pairs = []
+    end
+
+    def []=(key, value)
+      @headers[key] = value
+      @pairs << [key, value]
+    end
+
+    def_delegator :@headers, :[]
+    def_delegator :@pairs, :empty?
+
+    # some header fields may appear more than once;
+    # this method provides access to values of all occurrences
+    # of a given header field
+    def each_value(key)
+      return to_enum(:each_value, key) unless block_given?
+
+      each_pair do |k,v|
+        yield v if k == key
+      end
+    end
+
+    def each_pair
+      return to_enum(:each_pair) unless block_given?
+
+      @pairs.each do |k|
+        yield k[0], k[1]
+      end
+    end
+
+    def self.gregorio_supported?(key)
+      GREGORIO_HEADERS.include? key
+    end
+
+    def headers
+      self
+    end
+  end
+end

data/lib/gly/headers.rb~

@@ -0,0 +1,13 @@
+module Gly
+  class Headers
+    def initialize
+      @headers = {}
+      @keys_order = []
+    end
+
+    def []=(key, value)
+      @headers[key] = value
+      @keys_order << key
+    end
+  end
+end

data/lib/gly/lyrics.rb

@@ -0,0 +1,39 @@
+require 'forwardable'
+
+module Gly
+  class Lyrics
+    extend Forwardable
+
+    def initialize
+      @words = []
+    end
+
+    def each_syllable
+      return enum_for(:each_syllable) unless block_given?
+
+      @words.each do |w|
+        w.each_syllable.each_with_index do |s,si|
+          if si == 0
+            yield ' ' + s
+          else
+            yield s
+          end
+        end
+      end
+    end
+
+    def_delegator :@words, :each, :each_word
+    def_delegators :@words, :empty?, :<<
+  end
+
+  class Word
+    extend Forwardable
+
+    def initialize(syllables=[])
+      @syllables = syllables
+    end
+
+    def_delegators :@syllables, :<<, :push
+    def_delegator :@syllables, :each, :each_syllable
+  end
+end

data/lib/gly/lyrics.rb~

@@ -0,0 +1,21 @@
+require 'forwardable'
+
+module Gly
+  class Lyrics
+    def initialize
+      @words = []
+    end
+
+    def_delegator :@words, :each
+    alias_method :each_word, :each
+  end
+
+  class Word
+    def initialize
+      @syllables = []
+    end
+
+    def_delegator :@syllables, :<<, :push, :each
+    alias_method :each_syllable, :each
+  end
+end

data/lib/gly/parsed_score.rb

@@ -0,0 +1,16 @@
+module Gly
+  # result of a gly score parsing
+  class ParsedScore
+    def initialize
+      @headers = Headers.new
+      @lyrics = Lyrics.new
+      @music = []
+    end
+
+    attr_reader :headers, :lyrics, :music
+
+    def empty?
+      @headers.empty? && @lyrics.empty? && @music.empty?
+    end
+  end
+end

data/lib/gly/parsed_score.rb~

@@ -0,0 +1,6 @@
+# result of a gly score parsing
+module Gly
+  class ParsedScore
+    attr_reader :headers, :lyrics, :notes
+  end
+end

data/lib/gly/parser.rb

@@ -0,0 +1,106 @@
+module Gly
+  # parses gly source
+  class Parser
+    SYLLABLE_SEP = '--'
+
+    def parse(io)
+      @doc = Document.new
+      @score = ParsedScore.new
+
+      if io.respond_to? :path
+        @doc.path = io.path
+      end
+
+      io.each do |line|
+        line = strip_comments(line)
+
+        if empty? line
+          next
+        elsif new_score? line
+          push_score
+          @score = ParsedScore.new
+        elsif header_start? line
+          push_score
+          @score = @doc.header
+        elsif header_line? line
+          parse_header line
+        elsif lyrics_line? line
+          parse_lyrics line
+        else
+          parse_music line
+        end
+      end
+
+      push_score
+
+      return @doc
+    end
+
+    private
+
+    def empty?(str)
+      str =~ /\A\s*\Z/
+    end
+
+    def new_score?(str)
+      str =~ /\A\s*\\score/
+    end
+
+    def header_start?(str)
+      str =~ /\A\s*\\header/
+    end
+
+    def strip_comments(str)
+      str.sub(/%.*\Z/, '')
+    end
+
+    def header_line?(str)
+      in_header_block? || @score.lyrics.empty? && @score.music.empty? && str =~ /\w+:\s*./
+    end
+
+    EXPLICIT_LYRICS_RE = /\A\\l(yrics)?\s+/
+
+    def lyrics_line?(str)
+      str =~ EXPLICIT_LYRICS_RE || str.include?(SYLLABLE_SEP) || contains_unmusical_letters?(str)
+    end
+
+    def in_header_block?
+      @score.is_a? Headers
+    end
+
+    def contains_unmusical_letters?(str)
+      letters = str.gsub(/[\W\d_]+/, '')
+      letters !~ /\A[a-mvwoxz]*\Z/i # incomplete gabc music letters!
+    end
+
+    def parse_header(str)
+      hid, hvalue = str.split(':').collect(&:strip)
+      @score.headers[hid] = hvalue
+    end
+
+    def parse_lyrics(str)
+      # words: split by whitespace not being part of syllable
+      # separator
+      str
+        .sub(EXPLICIT_LYRICS_RE, '')
+        .split(/(?<!#{SYLLABLE_SEP})\s+(?!#{SYLLABLE_SEP})/)
+        .each do |word|
+        @score.lyrics << Word.new(word.split(/\s*#{SYLLABLE_SEP}\s*/))
+      end
+    end
+
+    def parse_music(str)
+      # music chunks: split by whitespace out of brackets
+      str.split(/\s+/).each do |chunk|
+        chunk.sub!(/\A\((.*?)\)\Z/, '\1') # unparenthesize
+        @score.music << chunk
+      end
+    end
+
+    def push_score
+      if @score.is_a?(ParsedScore) && !@score.empty?
+        @doc.scores << @score
+      end
+    end
+  end
+end

data/lib/gly/parser.rb~

@@ -0,0 +1,6 @@
+module Gly
+  # parses gly source
+  class Parser
+
+  end
+end

data/lib/gly/string_helpers.rb

@@ -0,0 +1,34 @@
+module Gly
+  module StringHelpers
+    extend self
+    
+    # splits string by whitespace that is not enclosed
+    # in brackets.
+    # At the same time removes brackets.
+    def bracket_aware_whitespace_split(str)
+      str = str.strip
+      chunk_start = 0
+      chunks = []
+      in_brackets = false
+      str.chars.each_with_index do |char, chi|
+        if in_brackets
+          next if char != ')'
+
+        else
+          if char =~ /^\s$/
+            if chunk_start != chi
+              chunks << str[chunk_start .. chi-1]
+            end
+            chunk_start = chi+1
+          end
+        end
+      end
+
+      chunks << str[chunk_start .. -1]
+
+      chunks
+    end
+
+    alias_method :music_split, :bracket_aware_whitespace_split
+  end
+end

data/lib/gly/string_helpers.rb~

@@ -0,0 +1,36 @@
+module Gly
+  module StringHelpers
+    extend self
+    
+    # splits string by whitespace that is not enclosed
+    # in brackets.
+    # At the same time removes brackets.
+    def bracket_aware_whitespace_split(str)
+      str = str.strip
+      chunk_start = 0
+      chunks = []
+      in_brackets = false
+      str.chars.each_with_index do |char, chi|
+        if in_brackets
+          next if char != ')'
+
+        else
+          if char =~ /^\s$/
+            if chunk_start != chi
+              chunks << str[chunk_start .. chi-1]
+            end
+            chunk_start = chi+1
+          end
+        end
+      end
+
+      if chunk_start != chi
+        chunks << str[chunk_start .. chi-1]
+      end
+
+      chunks
+    end
+
+    alias_method :music_split, :bracket_aware_whitespace_split
+  end
+end

data/tests/examples.rb

@@ -0,0 +1,28 @@
+# test-suite dynamically created from examples in subfolders
+
+require_relative 'test_helper'
+
+# Each test case is defined by a pair of files
+# in directories examples/given and examples/expected
+# which define what is an expected gabc result of a single-score
+# gly file.
+class TestExamples < GlyTest
+  def self.example_test_case(given_file, expected_file)
+    # filename without extension
+    case_name = File.basename(given_file).sub(/\.[^\.]*\Z/, '')
+
+    define_method "test_#{case_name}" do
+      expected = File.read expected_file
+      File.open given_file do |fr|
+        given = gly_process(fr).string
+        assert_equal expected, given
+      end
+    end
+  end
+
+  here = File.dirname __FILE__
+  Dir.glob(File.join(here, 'examples/gly/given/*.gly')).each do |given|
+    expected = given.sub('/given', '/expected').sub('.gly', '.gabc')
+    example_test_case given, expected
+  end
+end

data/tests/examples.rb~

@@ -0,0 +1,9 @@
+# test-suite dynamically created from examples in subfolders
+
+def create_test_suite(given_file, expected_file)
+
+end
+
+Dir.glob('examples/gly/**/*.gly').each do |given|
+  expected = given.sub('/given', '/expected').sub('.gly', '.gabc')
+end

data/tests/examples/gly/expected/block_lyrics.gabc

@@ -0,0 +1,2 @@
+%%
+a(i) a(i)

data/tests/examples/gly/expected/differentiae.gabc

@@ -0,0 +1,2 @@
+%%
+(c4) hej(h)hou(h) hej(h) (,) hou(f) (;) hej(h) (:) hou(f) (::) hej(h)

data/tests/examples/gly/expected/differentiae.gabc~

@@ -0,0 +1,2 @@
+(c4)
+hej(h) (,) hou(f) (;) hej(h) (:) hou(f) (::) hej(h)

data/tests/examples/gly/expected/document_header.gabc

@@ -0,0 +1,4 @@
+mode: 8;
+% description: Basic alleluia;
+%%
+(c4) A(g)lle(gh)lu(g)ia(g)

data/tests/examples/gly/expected/document_header.gabc~

@@ -0,0 +1,4 @@
+mode: 8;
+% description: Basic alleluia;
+%%
+(c4) A(g)lle(gh)lu(g)ia(g)

data/tests/examples/gly/expected/empty.gabc

@@ -0,0 +1 @@
+%%

data/tests/examples/gly/expected/explicit_lyrics.gabc

@@ -0,0 +1,2 @@
+%%
+ a(a)

data/tests/examples/gly/expected/explicit_lyrics.gabc~

@@ -0,0 +1,2 @@
+%%
+a(a)

data/tests/examples/gly/expected/explicit_score.gabc

@@ -0,0 +1,2 @@
+%%
+(h)

data/tests/examples/gly/expected/force_divisio_lyrics.gabc

@@ -0,0 +1,2 @@
+%%
+(c4) A(h)men.(h) V.(::) Di(gf)xi(gh)

data/tests/examples/gly/expected/header.gabc

@@ -0,0 +1,3 @@
+name: Nativitas gloriosae;
+office-part: laudes, 1. ant.;
+%%

data/tests/examples/gly/expected/header_unofficial.gabc

@@ -0,0 +1,4 @@
+name: Nativitas gloriosae;
+office-part: laudes, 1. ant.;
+% unofficial-header: value;
+%%

data/tests/examples/gly/expected/header_unofficial.gabc~

@@ -0,0 +1,3 @@
+name: Nativitas gloriosae;
+office-part: laudes, 1. ant.;
+%%

data/tests/examples/gly/expected/multiline.gabc

@@ -0,0 +1,2 @@
+%%
+(c4) Na(g)tí(g')vi(g)tas(gd) glo(f)ri(gh)ó(g)sae(g_') *()

data/tests/examples/gly/expected/multiline_interlaced.gabc

@@ -0,0 +1,2 @@
+%%
+(c4) Na(g)tí(g')vi(g)tas(gd) glo(f)ri(gh)ó(g)sae(g_') *()

data/tests/examples/gly/expected/nonlyrical_lyrics.gabc

@@ -0,0 +1,2 @@
+%%
+(c4) a(h)men,(h) *(,) a(h)men.(f)

data/tests/examples/gly/expected/nonlyrical_lyrics.gabc~

@@ -0,0 +1,2 @@
+%%
+a(h)men,(h) *(,) a(h)men.(f)

data/tests/examples/gly/expected/notes_bracketted.gabc

@@ -0,0 +1,2 @@
+%%
+(c4) (g) (g') (g) (gd) (f) (gh) (g) (g_') () (g a ij)

data/tests/examples/gly/expected/notes_bracketted.gabc~

@@ -0,0 +1 @@
+c4 g g' g gd f (gh) g g_' () (g a ij)

data/tests/examples/gly/expected/notes_only.gabc

@@ -0,0 +1,2 @@
+%%
+(c4) (g) (g') (g) (gd) (f) (gh) (g) (g_')

data/tests/examples/gly/expected/notes_with_lyrics.gabc

@@ -0,0 +1,2 @@
+%%
+(c4) Na(g)tí(g')vi(g)tas(gd) glo(f)ri(gh)ó(g)sae(g_') *()

data/tests/examples/gly/expected/notes_with_lyrics.gabc~

@@ -0,0 +1,2 @@
+c4 g g' g gd f gh g g_' ()
+Na -- tí -- vi -- tas glo -- ri -- ó -- sae *

data/tests/examples/gly/expected/unsyllabified_lyrics.gabc

@@ -0,0 +1,2 @@
+%%
+(c4) Custó(h)

data/tests/examples/gly/given/block_lyrics.gly

@@ -0,0 +1,3 @@
+a a
+\lyrics
+i i

data/tests/examples/gly/given/differentiae.gly

@@ -0,0 +1,3 @@
+c4
+h h h , f ; h : f :: h
+hej -- hou hej hou hej hou hej

data/tests/examples/gly/given/differentiae.gly~

@@ -0,0 +1,3 @@
+c4
+h , f ; h : f :: h
+hej hou hej hou hej

data/tests/examples/gly/given/document_header.gly

@@ -0,0 +1,9 @@
+\header
+title: Testing document with document header
+author: the author of gly
+
+\score
+mode: 8
+description: Basic alleluia
+c4 g gh g g
+A -- lle -- lu -- ia

data/tests/examples/gly/given/explicit_lyrics.gly

@@ -0,0 +1,2 @@
+a
+\lyrics a

data/tests/examples/gly/given/explicit_score.gly

@@ -0,0 +1,2 @@
+\score
+h

data/tests/examples/gly/given/force_divisio_lyrics.gly

@@ -0,0 +1,2 @@
+c4 h h :: gf gh
+A -- men. !V. Di -- xi

data/tests/examples/gly/given/header.gly

@@ -0,0 +1,2 @@
+name: Nativitas gloriosae
+office-part: laudes, 1. ant.

data/tests/examples/gly/given/header_unofficial.gly

@@ -0,0 +1,3 @@
+name: Nativitas gloriosae
+office-part: laudes, 1. ant.
+unofficial-header: value

data/tests/examples/gly/given/header_unofficial.gly~

@@ -0,0 +1,2 @@
+name: Nativitas gloriosae
+office-part: laudes, 1. ant.

data/tests/examples/gly/given/multiline.gly

@@ -0,0 +1,4 @@
+c4 g g' g gd
+f gh g g_' ()
+Na -- tí -- vi -- tas
+glo -- ri -- ó -- sae *

data/tests/examples/gly/given/multiline_interlaced.gly

@@ -0,0 +1,5 @@
+c4 g g' g gd
+Na -- tí -- vi -- tas
+
+f gh g g_' ()
+glo -- ri -- ó -- sae *

data/tests/examples/gly/given/multiline_interlaced.gly~

@@ -0,0 +1,4 @@
+c4 g g' g gd
+f gh g g_' ()
+Na -- tí -- vi -- tas
+glo -- ri -- ó -- sae *

data/tests/examples/gly/given/nonlyrical_lyrics.gly

@@ -0,0 +1,2 @@
+c4 h h , h f
+a -- men, * a -- men.

data/tests/examples/gly/given/nonlyrical_lyrics.gly~

@@ -0,0 +1,2 @@
+h h , h f
+a -- men, * a -- men.

data/tests/examples/gly/given/notes_bracketted.gabc~

@@ -0,0 +1 @@
+c4 g g' g gd f gh g g_'

data/tests/examples/gly/given/notes_bracketted.gly

@@ -0,0 +1 @@
+c4 g g' g gd f (gh) g g_' () (g a ij)

data/tests/examples/gly/given/notes_only.gly

@@ -0,0 +1 @@
+c4 g g' g gd f gh g g_'

data/tests/examples/gly/given/notes_with_lyrics.gly

@@ -0,0 +1,2 @@
+c4 g g' g gd f gh g g_' ()
+Na -- tí -- vi -- tas glo -- ri -- ó -- sae *

data/tests/examples/gly/given/unsyllabified_lyrics.gly

@@ -0,0 +1,2 @@
+c4 h
+Custó

data/tests/examples/gly/no_crash/document_header.gly~

@@ -0,0 +1,4 @@
+\header
+title: Testing document with document header
+author: the author of gly
+

data/tests/examples/gly/no_crash/multiple_scores.gly

@@ -0,0 +1,10 @@
+\score
+mode: 8
+description: Basic alleluia
+c4 g gh g g
+A -- lle -- lu -- ia
+
+\score
+description: Another simple alleluia
+c4 g gj hig h
+A -- lle -- lu -- ia

data/tests/examples/gly/no_crash/multiple_scores.gly~

@@ -0,0 +1,7 @@
+\score
+c4 g gh g g
+A -- lle -- lu -- ia
+
+\score
+c4 g gj hig h
+A -- lle -- lu -- ia

data/tests/no_crash.rb

@@ -0,0 +1,20 @@
+require_relative 'test_helper'
+
+# tests of cases that cannot be easily described by a pair
+# of single gly file and resulting gabc file
+class TestNoCrash < GlyTest
+  def self.nocrash_test_case(filename)
+    case_name = File.basename(filename).sub(/\.[^\.]*\Z/, '')
+    define_method "test_#{case_name}" do
+      File.open filename do |fr|
+        # simply let it convert to test that it does not crash
+        gly_process(fr).string
+      end
+    end
+  end
+
+  here = File.dirname __FILE__
+  Dir.glob(File.join(here, 'examples/gly/no_crash/*.gly')).each do |f|
+    nocrash_test_case f
+  end
+end

data/tests/programmed_examples.rb~

@@ -0,0 +1,14 @@
+require_relative 'test_helper'
+
+# tests of cases that cannot be easily described by a pair
+# of single gly file and resulting gabc file
+class TestSpecialCases < MiniTest::Test
+  def self.loads_without_crash_test(filename)
+    case_name = File.basename(given_file).sub(/\.[^\.]*\Z/, '')
+    define_method "test_#{case_name}" do
+      File.open given_file do |fr|
+        gly_process(fr).string
+      end
+    end
+  end
+end

data/tests/run.rb

@@ -0,0 +1,3 @@
+require_relative 'examples'
+require_relative 'no_crash'
+require_relative 'string_helpers_test'

data/tests/run.rb~

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+
+require_relative 'examples'

data/tests/string_helpers_test.rb

@@ -0,0 +1,19 @@
+require_relative 'test_helper'
+
+class StringHelpersTest < GlyTest
+  SH = Gly::StringHelpers
+
+  examples = [
+    ['single_chunk', 'a', ['a']],
+    ['simple_whitespace', 'aa aa', ['aa', 'aa']],
+    ['leading_trailing_whitespace', ' a a  ', ['a', 'a']],
+    ['bracketted', '(a)', ['a']],
+  ]
+  
+  examples.each do |e|
+    name, given, expected = e
+    define_method "test_#{name}" do
+      assert_equal expected, SH.music_split(given)
+    end
+  end
+end

data/tests/string_helpers_test.rb~

@@ -0,0 +1,9 @@
+require_relative 'test_helper'
+
+class StringHelpersTest < GlyTest
+  SH = Gly::StringHelpers
+  
+  def test_simple_whitespace_split
+    assert_equal ['aa', 'aa'], SH.music_split('aa aa')
+  end
+end

data/tests/test_helper.rb

@@ -0,0 +1,17 @@
+$: << File.expand_path('../lib', File.dirname(__FILE__))
+require 'gly'
+
+require 'minitest/autorun'
+
+require 'minitest/reporters'
+Minitest::Reporters.use!
+
+# parent of all gly test classes
+class GlyTest < MiniTest::Test
+  # shortcut performing gly->gabc conversion and returning
+  # it's results
+  def gly_process(gly_io)
+    doc = Gly::Parser.new.parse(gly_io)
+    Gly::GabcConvertor.new.convert(doc.scores[0])
+  end
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: gly
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jakub Pavlík
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: "# gly\n\nWriter-friendly Gregorian notation format compiling to gabc.\n\n*GLY*
+  is an acronym of \"Gregorio for liLYponders\" or\n\"Gregorio with separate LYrics.\n\n##
+  Why\n\nOne of the most popular solutions for typesetting quadratic\nnotation used
+  for the Gregorian chant is [Gregorio][gregorio].\n\nHowever, I have several objections
+  against it's input format.\nThat led me to designing an alternative, Gregorio-inspired\nnotation
+  format, which compiles to pure Gregorio GABC\n(which I don't like writing manually).\n\n##
+  Features\n\n* music separated from lyrics\n  * no need of the ubiquitous and tedious
+  parentheses\n  * separation of \"material and form\" -> easy copying of the music
+  or\n    lyrics alone is possible (useful for a composer)\n  * syllabified lyrics
+  entered in a format inspired by LilyPond\n* music and lyrics can be interspersed
+  as needed\n* no semicolons in the header\n* custom header fields supported (commented
+  out in the GABC output;\n  as gregorio crashes on headers it doesn't know)\n* several
+  scores per file (when compiled to gabc, each becomes\n  a separate file)\n* compile
+  pdf preview by a single command, without writing any (La)TeX\n\n## Examples\n\nTypical
+  GABC source of an antiphon looks like this:\n\n    name: Nativitas gloriosae;\n
+  \   office-part: laudes, 1. ant.;\n    occasion: In Nativitate B. Mariae Virginis;\n
+  \   book: Antiphonale Romanum 1912, pg. 704;\n    mode: 8;\n    initial-style: 1;\n
+  \   %%\n    \n    (c4) NA(g)TI(g)VI(g)TAS(gd) glo(f)ri(gh)ó(g)sae(g) * (,)\n    Vír(g)gi(g)nis(hi)
+  Ma(gh)rí(gf)ae,(f) (;)\n    ex(f) sé(g)mi(h)ne(h) A(hiwji)bra(hg)hae,(g) (;)\n    or(gh~)tae(g)
+  de(g) tri(g)bu(fe/fgf) Ju(d)da,(d) (;)\n    cla(df!gh)ra(g) ex(f) stir(hg~)pe(hi)
+  Da(h)vid.(g) (::)\n\nCorresponding GLY may look like this:\n\n    name: Nativitas
+  gloriosae\n    office-part: laudes, 1. ant.\n    occasion: In Nativitate B. Mariae
+  Virginis\n    book: Antiphonale Romanum 1912, pg. 704\n    mode: 8\n    initial-style:
+  1\n    \n    c4 g g g gd f gh g g ,\n    g g hi gh gf f ;\n    f g h h hiwji hg
+  g ;\n    gh~ g g g fe/fgf d d ;\n    df!gh g f hg~ hi h g ::\n    \n    NA -- TI
+  -- VI -- TAS glo -- ri -- ósae *\n    Vír -- gi -- nis Ma -- rí -- ae,\n    ex sé
+  -- mi -- ne A -- bra -- hae,\n    or -- tae de tri -- bu Ju -- da,\n    cla -- ra
+  ex stir -- pe Da -- vid.\n\nOr, with music and lyrics interlaced:\n\n    name: Nativitas
+  gloriosae\n    office-part: laudes, 1. ant.\n    occasion: In Nativitate B. Mariae
+  Virginis\n    book: Antiphonale Romanum 1912, pg. 704\n    mode: 8\n    initial-style:
+  1\n    \n    c4 g g g gd f gh g g ,\n    NA -- TI -- VI -- TAS glo -- ri -- ósae
+  *\n    \n    g g hi gh gf f ;\n    Vír -- gi -- nis Ma -- rí -- ae,\n    \n    f
+  g h h hiwji hg g ;\n    ex sé -- mi -- ne A -- bra -- hae,\n    \n    gh~ g g g
+  fe/fgf d d ;\n    or -- tae de tri -- bu Ju -- da,\n    \n    df!gh g f hg~ hi h
+  g ::\n    cla -- ra ex stir -- pe Da -- vid.\n\nOther arrangements are also possible.
+  Order of music and lyrics\nis actually ignored during processing.\n\n## Usage\n\nThis
+  gem provides executable `gly`. Run `gly help` for full list\nof subcommands. The
+  most important ones are:\n\n`gly gabc FILE1 ...`\n\nconverts given gly file(s) to
+  one or more gabc files (one per score,\ni.e. one gly may spawn a bunch of gabcs).\n\n`gly
+  preview FILE1 ...`\n\nAttempts to create a pdf document with all scores contained
+  in each\ngly file. Expects gregorio and lualatex to be in PATH\nand gregoriotex
+  to be installed and accessible by lualatex.\n\n## Tools\n\n[Emacs mode with syntax
+  highlighting for gly][elisp]\n\n![Editing gly in emacs](/doc/img/gly_emacs_scr.png)\n\n##
+  Run tests\n\nby executing `tests/run.rb`\n\n## License\n\nMIT\n\n[gregorio]: https://github.com/gregorio-project/gregorio\n[elisp]:
+  /tree/master/elisp\n"
+email: jkb.pavlik@gmail.com
+executables:
+- gly
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/gly
+- bin/glyfy
+- lib/gly.rb
+- lib/gly.rb~
+- lib/gly/cli.rb
+- lib/gly/cli.rb~
+- lib/gly/document.rb
+- lib/gly/document.rb~
+- lib/gly/gabc_convertor.rb
+- lib/gly/gabc_convertor.rb~
+- lib/gly/headers.rb
+- lib/gly/headers.rb~
+- lib/gly/lyrics.rb
+- lib/gly/lyrics.rb~
+- lib/gly/parsed_score.rb
+- lib/gly/parsed_score.rb~
+- lib/gly/parser.rb
+- lib/gly/parser.rb~
+- lib/gly/string_helpers.rb
+- lib/gly/string_helpers.rb~
+- tests/examples.rb
+- tests/examples.rb~
+- tests/examples/gly/expected/block_lyrics.gabc
+- tests/examples/gly/expected/differentiae.gabc
+- tests/examples/gly/expected/differentiae.gabc~
+- tests/examples/gly/expected/document_header.gabc
+- tests/examples/gly/expected/document_header.gabc~
+- tests/examples/gly/expected/empty.gabc
+- tests/examples/gly/expected/explicit_lyrics.gabc
+- tests/examples/gly/expected/explicit_lyrics.gabc~
+- tests/examples/gly/expected/explicit_score.gabc
+- tests/examples/gly/expected/force_divisio_lyrics.gabc
+- tests/examples/gly/expected/header.gabc
+- tests/examples/gly/expected/header_unofficial.gabc
+- tests/examples/gly/expected/header_unofficial.gabc~
+- tests/examples/gly/expected/multiline.gabc
+- tests/examples/gly/expected/multiline_interlaced.gabc
+- tests/examples/gly/expected/nonlyrical_lyrics.gabc
+- tests/examples/gly/expected/nonlyrical_lyrics.gabc~
+- tests/examples/gly/expected/notes_bracketted.gabc
+- tests/examples/gly/expected/notes_bracketted.gabc~
+- tests/examples/gly/expected/notes_only.gabc
+- tests/examples/gly/expected/notes_with_lyrics.gabc
+- tests/examples/gly/expected/notes_with_lyrics.gabc~
+- tests/examples/gly/expected/unsyllabified_lyrics.gabc
+- tests/examples/gly/given/block_lyrics.gly
+- tests/examples/gly/given/differentiae.gly
+- tests/examples/gly/given/differentiae.gly~
+- tests/examples/gly/given/document_header.gly
+- tests/examples/gly/given/empty.gly
+- tests/examples/gly/given/explicit_lyrics.gly
+- tests/examples/gly/given/explicit_score.gly
+- tests/examples/gly/given/force_divisio_lyrics.gly
+- tests/examples/gly/given/header.gly
+- tests/examples/gly/given/header_unofficial.gly
+- tests/examples/gly/given/header_unofficial.gly~
+- tests/examples/gly/given/multiline.gly
+- tests/examples/gly/given/multiline_interlaced.gly
+- tests/examples/gly/given/multiline_interlaced.gly~
+- tests/examples/gly/given/nonlyrical_lyrics.gly
+- tests/examples/gly/given/nonlyrical_lyrics.gly~
+- tests/examples/gly/given/notes_bracketted.gabc~
+- tests/examples/gly/given/notes_bracketted.gly
+- tests/examples/gly/given/notes_only.gly
+- tests/examples/gly/given/notes_with_lyrics.gly
+- tests/examples/gly/given/unsyllabified_lyrics.gly
+- tests/examples/gly/no_crash/document_header.gly~
+- tests/examples/gly/no_crash/multiple_scores.gly
+- tests/examples/gly/no_crash/multiple_scores.gly~
+- tests/no_crash.rb
+- tests/programmed_examples.rb~
+- tests/run.rb
+- tests/run.rb~
+- tests/string_helpers_test.rb
+- tests/string_helpers_test.rb~
+- tests/test_helper.rb
+homepage: http://github.com/igneus/gly
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Writer-friendly Gregorian notation format compiling to gabc
+test_files: []
+has_rdoc: