gly 0.0.3 → 0.0.4

data/lib/gly/headers.rb

@@ -32,6 +32,7 @@ initial-style
 centering-scheme
 user-notes
 annotation
+nabc-lines
 )
 
     def initialize
@@ -47,7 +48,8 @@ annotation
       @pairs << [key, value]
     end
 
-    def_delegator :@headers, :[]
+    def_delegators :@headers, :[], :size, :keys, :values,
+       :has_key?, :includes?, :include?
     def_delegator :@pairs, :empty?
 
     # some header fields may appear more than once;

data/lib/gly/lister.rb

@@ -1,8 +1,9 @@
 module Gly
   class Lister
-    def initialize(files)
+    def initialize(files, format=nil)
       @files = files
       @error = false
+      @format = find_formatter(format || :grep)
     end
 
     def list(io, errio)
@@ -15,12 +16,9 @@ module Gly
           next
         end
 
-        io.puts
-        io.puts "== #{f}"
-
+        io.puts @format.file(f)
         document.scores.each do |s|
-          l = s.lyrics.readable
-          io.puts l unless l.empty?
+          io.puts @format.score(s)
         end
       end
     end
@@ -28,5 +26,42 @@ module Gly
     def error?
       @error
     end
+
+    private
+
+    def find_formatter(name)
+      formatter_name = name.to_s.capitalize + 'Format'
+      begin
+        klass = self.class.const_get(formatter_name)
+      rescue NameError
+        raise Gly::Exception.new("Invalid list format '#{name}'")
+      end
+
+      klass.new
+    end
+
+    # simple, sort of beautiful, easy to read for a human
+    class OverviewFormat
+      def file(f)
+        "\n== #{f}"
+      end
+
+      def score(s)
+        l = s.lyrics.readable
+        l unless l.empty?
+      end
+    end
+
+    # less beauty, more repetition, for easier grepping
+    class GrepFormat
+      def file(f)
+        @file = f
+        nil
+      end
+
+      def score(s)
+        "#{@file}##{s.headers['id']} #{s.lyrics.readable}"
+      end
+    end
   end
 end

data/lib/gly/lyrics.rb

@@ -11,13 +11,13 @@ module Gly
     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
+      @words.each_with_index do |w,wi|
+        w.each_syllable.each do |s|
+          yield s
+        end
+
+        if (wi + 1) < @words.size
+          yield ' '
         end
       end
     end

data/lib/gly/markup.rb

@@ -0,0 +1,15 @@
+module Gly
+  class Markup
+    def initialize(text='')
+      @text = text
+    end
+
+    def text
+      @text.strip
+    end
+
+    def <<(line)
+      @text += line
+    end
+  end
+end

data/lib/gly/markup.rb~

@@ -0,0 +1,11 @@
+module Gly
+  class Markup
+    def initialize(text='')
+      @text = text
+    end
+
+    def <<(line)
+      @text += "\n" + line
+    end
+  end
+end

data/lib/gly/parser.rb

@@ -5,17 +5,12 @@ module Gly
   class Parser
     def initialize(syllable_separator=nil)
       @syllable_separator = syllable_separator || '--'
+      @current_block = :score
     end
 
     def parse(source)
       if source.is_a? String
-        if File.file? source
-          parse_fname source
-        elsif source == '-'
-          parse_io STDIN
-        else
-          parse_str source
-        end
+        parse_fname source
       else
         parse_io source
       end
@@ -33,7 +28,7 @@ module Gly
 
     def parse_io(io)
       @doc = Document.new
-      @score = ParsedScore.new
+      @score = Score.new
 
       if io.respond_to? :path
         @doc.path = io.path
@@ -42,24 +37,40 @@ module Gly
       io.each do |line|
         line = strip_comments(line)
 
-        if empty? line
+        if empty?(line) && @current_block != :markup
           next
+        # keywords specifying line or block type
         elsif new_score? line
           push_score
-          @score = ParsedScore.new
+          @score = Score.new
+          @current_block = :score
         elsif header_start? line
           push_score
           @score = @doc.header
-        elsif header_line? line
-          parse_header line
+          @current_block = :header
+        elsif markup_start? line
+          push_score
+          @doc.content << Markup.new
+          @current_block = :markup
+        elsif block_start? line
+          @current_block = line.match(/\w+/)[0].to_sym
         elsif explicit_lyrics? line
           parse_lyrics line
         elsif explicit_music? line
           parse_music line
+        elsif explicit_markup? line
+          push_score
+          parse_markup line
+        # line in a typed block
+        elsif @current_block != :score
+          parse_default line
+        # content type autodetection
+        elsif header_line? line
+          parse_header line
         elsif lyrics_line? line
           parse_lyrics line
         else
-          parse_music line
+          parse_default line
         end
       end
 
@@ -75,11 +86,19 @@ module Gly
     end
 
     def new_score?(str)
-      str =~ /\A\s*\\score/
+      str =~ /\A\s*\\(score)\s*\Z/
     end
 
     def header_start?(str)
-      str =~ /\A\s*\\header/
+      str =~ /\A\s*\\(header)\s*\Z/
+    end
+
+    def markup_start?(str)
+      str =~ /\A\s*\\(markup)\s*\Z/
+    end
+
+    def block_start?(str)
+      str =~ /\A\s*\\(lyrics|music)\s*\Z/
     end
 
     def strip_comments(str)
@@ -87,7 +106,7 @@ module Gly
     end
 
     def header_line?(str)
-      in_header_block? || @score.lyrics.empty? && @score.music.empty? && str =~ /\w+:\s*./
+      @current_block == :score && @score.lyrics.empty? && @score.music.empty? && str =~ /\A[\w_-]+:/
     end
 
     EXPLICIT_LYRICS_RE = /\A\\l(yrics)?\s+/
@@ -102,12 +121,14 @@ module Gly
       str =~ EXPLICIT_MUSIC_RE
     end
 
-    def lyrics_line?(str)
-      !contains_square_brackets?(str) && (str.include?(@syllable_separator) || contains_unmusical_letters?(str))
+    EXPLICIT_MARKUP_RE = /\A\\markup\s*/
+
+    def explicit_markup?(str)
+      str =~ EXPLICIT_MARKUP_RE
     end
 
-    def in_header_block?
-      @score.is_a? Headers
+    def lyrics_line?(str)
+      !contains_square_brackets?(str) && (str.include?(@syllable_separator) || contains_unmusical_letters?(str))
     end
 
     def contains_unmusical_letters?(str)
@@ -120,7 +141,7 @@ module Gly
     end
 
     def parse_header(str)
-      hid, hvalue = str.split(':').collect(&:strip)
+      hid, hvalue = str.split(':', 2).collect(&:strip)
       @score.headers[hid] = hvalue
     end
 
@@ -144,10 +165,31 @@ module Gly
       end
     end
 
+    def parse_markup(line)
+      if line =~ EXPLICIT_MARKUP_RE
+        @doc << Markup.new(line.sub(EXPLICIT_MARKUP_RE, ''))
+      else
+        @doc.content.last << line
+      end
+    end
+
+    def parse_default(line)
+      if @current_block == :score
+        return parse_music line
+      end
+
+      send "parse_#{@current_block}", line
+    end
+
     def push_score
-      if @score.is_a?(ParsedScore) && !@score.empty?
-        @doc << @score
+      if @score.is_a?(Score) && !@score.empty?
+        begin
+          @doc << @score
+        rescue ArgumentError => ex
+          raise ParseError.wrap ex
+        end
       end
+      @score = nil
     end
   end
 end

data/lib/gly/preview_builder.rb

@@ -15,10 +15,11 @@ module Gly
 
     def build
       @gabcs.each do |g|
-        exec 'gregorio', g
+        outfile = g.sub /(\.gabc)?$/i, '.gtex'
+        benevolent_exec('gregorio', '-o', outfile, g)
       end
 
-      exec 'lualatex', @main_tex
+      exec 'lualatex', '--interaction=nonstopmode', @main_tex
     end
 
     private
@@ -28,11 +29,19 @@ module Gly
       unless ok
         case $?.exitstatus
         when 127
-          STDERR.puts "'#{progname}' is required for this gly command to work, but it was not found. Please, ensure that '#{progname}' is installed in one of the directories listed in your PATH and try again."
+          raise Gly::Exception.new "'#{progname}' is required for this gly command to work, but it was not found. Please, ensure that '#{progname}' is installed in one of the directories listed in your PATH and try again."
         else
-          STDERR.puts "'#{progname}' exited with exit code #{$?.to_i}. Let's continue and see what happens ..."
+          raise Gly::Exception.new "'#{progname}' exited with exit code #{$?.to_i}."
         end
       end
     end
+
+    def benevolent_exec(progname, *args)
+      begin
+        exec progname, *args
+      rescue Gly::Exception => err
+        STDERR.puts err.message + " Let's continue and see what happens ..."
+      end
+    end
   end
 end

data/lib/gly/preview_generator.rb

@@ -27,37 +27,25 @@ module Gly
         fw.puts header_table document.header
       end
 
-      convertor.each_score_with_gabcname do |score, gabc_fname|
-        @builder.add_gabc gabc_fname
-
-        if @options[:full_headers]
-          fw.puts header_table score.headers
-        end
-
-        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
+      scores_with_names = convertor.each_score_with_gabcname
+
+      document.content.each do |c|
+        if c.is_a? Markup
+          fw.puts render_markup(c)
+        else
+          score, gabc_fname, gtex_fname = scores_with_names.next
+          fw.puts render_score(score, gabc_fname, gtex_fname)
         end
-
-        fw.puts "\\includescore{#{gtex_fname}}\n\\vspace{1cm}"
       end
 
       if @options['no_document']
         tex = doc_body.string
       else
         replacements = {
-          glyvars: header_variables(document.header),
-          body: doc_body.string
+          'glyvars' => header_variables(document.header),
+          'body' => doc_body.string
         }
-        tex = @template % replacements
+        tex = @template.gsub(/\{\{(\w+)\}\}/) {|m| replacements[m[2..-3]] }
       end
 
       with_preview_io(document.path) do |fw|
@@ -74,6 +62,39 @@ module Gly
 
     private
 
+    def render_markup(markup)
+      markup.text
+    end
+
+    def render_score(score, gabc_fname, gtex_fname)
+      r = StringIO.new
+
+      @builder.add_gabc gabc_fname
+
+      if @options[:full_headers]
+        r.puts header_table score.headers
+      end
+
+      piece_title = %w(id book manuscript arranger author).collect do |m|
+        val = score.headers[m]
+        val = "\\texttt{\\##{val}}" if val && m == 'id'
+        val
+      end.delete_if(&:nil?).join ', '
+      r.puts "\\commentary{\\footnotesize{#{piece_title}}}\n" unless piece_title.empty?
+
+      annotations = score.headers.each_value('annotation')
+      begin
+        r.puts "\\setfirstannotation{#{annotations.next}}"
+        r.puts "\\setsecondannotation{#{annotations.next}}"
+      rescue StopIteration
+        # ok, no more annotations
+      end
+
+      r.puts "\\includescore{#{gtex_fname}}\n\\vspace{1cm}"
+
+      r.string
+    end
+
     def with_preview_io(src_name)
       if @preview_dest
         yield @preview_dest

data/lib/gly/{parsed_score.rb → score.rb}

@@ -1,6 +1,6 @@
 module Gly
   # result of a gly score parsing
-  class ParsedScore
+  class Score
     def initialize
       @headers = Headers.new
       @lyrics = Lyrics.new

data/lib/gly/templates/lualatex_document.tex

@@ -1,4 +1,4 @@
-%% LuaLaTeX
+% LuaLaTeX
 
 \documentclass[a4paper, 12pt]{article}
 \usepackage[latin]{babel}
@@ -8,19 +8,19 @@
 \usepackage[hidelinks]{hyperref}
 \usepackage{etoolbox}
 
-%% for gregorio
+% for gregorio
 \usepackage{luatextra}
 \usepackage{graphicx}
 \usepackage{gregoriotex}
 
-%{glyvars}
+{{glyvars}}
 
-%% header fields like title, transcription-date etc.
-%% are translated by 'gly preview' to latex commands like
-%% \glyTitle \glyTranscriptionDate etc.
-%% (All of your document header fields are handled this way.)
-%% These commands can be used for various purposes,
-%% but we will use them only to assemble document title:
+% header fields like title, transcription-date etc.
+% are translated by 'gly preview' to latex commands like
+% \glyTitle \glyTranscriptionDate etc.
+% (All of your document header fields are handled this way.)
+% These commands can be used for various purposes,
+% but we will use them only to assemble document title:
 \newcommand{\glyPreviewTitle}{
   \begin{center}
     \ifdef{\glyTitle}{{\huge \glyTitle}}{}
@@ -43,9 +43,9 @@
 
 \glyPreviewTitle
 
-%{body}
+{{body}}
 
-%% tagline
+% tagline
 \vfill
 \glyPreviewTagline
 \end{document}