lydown 0.9.0 → 0.10.0

data/lib/lydown/templates.rb

@@ -8,7 +8,9 @@ module Lydown
     
     def self.render(name, ctx, locals = {})
       _binding = ctx.respond_to?(:template_binding) ? ctx.template_binding(locals) : binding
-      template(name).result(_binding)
+
+      # remove trailing white space and superfluous new lines
+      template(name).result(_binding).gsub(/^\s+$/, '').gsub(/\n+/m, "\n")
     end
     
     def self.template(name)
@@ -16,7 +18,11 @@ module Lydown
     end
     
     def self.load_template(name)
-      ERB.new IO.read(File.join(TEMPLATES_DIR, "#{name}.erb")), 0, '<>'
+      fn = name.is_a?(Symbol) ? 
+        File.join(TEMPLATES_DIR, "#{name}.erb") :
+        name
+      
+      ERB.new IO.read(fn), 0, '<>'
     end
   end
   

data/lib/lydown/templates/lilypond_doc.erb

@@ -1,20 +1,29 @@
 \version "2.18.2"
 
-<% unless self['render_opts']['no_lib'] %>
+<% unless self['render_opts/no_lib'] %>
 \include "<%= File.join(LY_LIB_DIR, 'lib.ly') %>"
 <% end %>
 
+<% if self.render_mode == :proof %>
+<%= Lydown::Rendering::PROOFING_LY_SETTINGS %>
+<% end %>
+
 <% if self['layout'] %>
 \layout {
 }
 <% end %>
 
+<%= Lydown::Templates.render(:variables, self) %>
+
 \book {
   \header {
   }
 
+  \bookpart {
   <% self['movements'].each do |n, m| %>
     <%= Lydown::Templates.render(:movement, self, name: n, movement: m) 
     %>
   <% end %>
+  
+  }
 }

data/lib/lydown/templates/movement.erb

@@ -1,7 +1,7 @@
 <%
-  score_mode = self['render_opts/mode'] == :score
+  render_mode = self.render_mode
   staff_groups = Lydown::Rendering::Staff.staff_groups(
-    self, movement, movement['parts'].keys)
+    self, {movement: name}, movement['parts'].keys)
   parts_in_order = staff_groups.flatten
   staff_hierarchy = Lydown::Rendering::Staff.staff_hierarchy(staff_groups)
     
@@ -9,25 +9,62 @@
     m[p] = movement['parts'][p]
     m
   end
+
+  score_mode = (render_mode == :score) || 
+    (render_mode == :proof) || (parts.size > 1)
   
+  tacet = Lydown::Rendering::Movement.tacet?(self, name)
   movement_title = Lydown::Rendering::Movement.movement_title(self, name)
+  movement_source = self.get_setting(:movement_source , movement: name)
+  
+  format = self['options/format'] || self['render_opts/format'] || :pdf
+  midi_mode = (format == :midi) || (format == :mp3)
+  
+  empty_staves = self.get_setting(:empty_staves, movement: name)
+  
+  page_breaks = Lydown::Rendering::Movement.page_breaks(self, movement: name)
+  
+  includes = Lydown::Rendering::Movement.include_files(self, movement: name)
+  
+  hide_bar_numbers = Lydown::Rendering::Movement.hide_bar_numbers?(
+    self, movement: name
+  )
 %>
 
-\bookpart {
-  <% if movement_title %>
-    \header { 
-      piece = \markup {
-        \column {
-          \fill-line {\bold \large "<%= movement_title %>"}
-          
+<% if page_breaks[:blank_page_before] %>
+} \bookpart {
+  \markup \column {
+  \null \null \null \null \null \null
+  \null \null \null \null \null \null
+  \null \null \null \null \null \null
+  \null \null \null \null \null \null
+  \fill-line { "(this page has been left blank to facilitate page turning)" } 
+  }
+} \bookpart {
+\pageBreak
+<% elsif page_breaks[:before] %>
+  } \bookpart {
+<% end %>
+
+<% includes.each do |i| %>
+  <%= i %>
+<% end %>
+
+<% unless tacet %>
+  \score {
+    <% if movement_title && render_mode != :proof %>
+      \header { 
+        piece = \markup { 
+          \bold \large { <%= movement_title %> } 
+          <% if movement_source %>
+            \hspace #1 \italic { <%= movement_source %> }
+          <% end %>
         }
       }
-    }
-  <% end %>
+    <% end %>
   
-  <% if score_mode %>
-    \score {
-      <% if self['empty_staves'] == 'hide' %>
+    <% if score_mode %>
+      <% if empty_staves == 'hide' %>
         \layout {
           \context {
             \RemoveEmptyStaffContext
@@ -35,31 +72,47 @@
           }
         }      
       <% end %>
-      
+    
       \new StaffGroup <<
         \set StaffGroup.systemStartDelimiterHierarchy = <%= staff_hierarchy %>
-  <% end %>
+    <% end %>
     
-      <% if n = movement['bar_number'] %>
-        \set Score.currentBarNumber = #<%= n %>
-        \set Score.barNumberVisibility = #all-bar-numbers-visible
-        \bar ""
-      <% end %>
+        <% if n = movement['bar_number'] %>
+          \set Score.currentBarNumber = #<%= n %>
+          \set Score.barNumberVisibility = #all-bar-numbers-visible
+          \bar ""
+        <% end %>
       
-      <% parts.each do |n, p| %>
-        <%= Lydown::Templates.render(:part, self, 
-          name: n, part: p, movement: movement) %>
-      <% end %>
+        <% parts.each do |n, p| %>
+          <%= Lydown::Templates.render(:part, self, 
+            name: n, part: p, movement: movement, movement_name: name) %>
+        <% end %>
   
-  <% if score_mode %>
+    <% if score_mode %>
       >>
-      <% if self['render_opts']['format'] == 'midi' %>
-      \midi {
-        <% if tempo = movement['settings/midi_tempo'] %>
-          \tempo <%= tempo %>
-        <% end %>
+    <% end %>
+    <% if midi_mode %>
+    \midi {
+      <% if tempo = self.get_setting(:midi_tempo, movement: name) %>
+        \tempo <%= tempo %>
+      <% end %>
+    }
+    <% end %> 
+    
+    <% if hide_bar_numbers %>
+    \layout {
+      \context {
+        \Score
+        \omit BarNumber
       }
-      <% end %> 
     }
-  <% end %>
-}
+    <% end %>
+  }
+<% else # tacet %>
+  \markup { 
+    \line { \bold \large { <%= movement_title %> } }
+    \line { \pad-markup #3 " " }
+    
+  }
+<% end %>
+<% if page_breaks[:after] %>\pageBreak <% end %>

data/lib/lydown/templates/multi_voice.erb

@@ -1,5 +1,5 @@
 <<
-  <% beaming_mode = Lydown::Rendering::Staff.beaming_mode(part) %>
+  <% beaming_mode = Lydown::Rendering::Staff.beaming_mode(self, self.current_setting_opts) %>
   <% voice_prefix = part.nil? || (part == "") ? nil : "#{part}_" %>
 
   <% self['process/voices'].each do |voice, stream| %>

data/lib/lydown/templates/part.erb

@@ -1,90 +1,118 @@
 <%
-  title = nil
+  render_mode = self.render_mode
+
+  setting_opts = {movement: movement_name, part: name}
+
+  inline_part_title = nil
   if name && (name != '')
-    title = Lydown::Rendering.part_title(name)
+    part_title = Lydown::Rendering::Staff.part_title(self, setting_opts)
     voice_prefix = "#{name}_"
   else
-    title = nil
+    part_title = "#\"\""
     voice_prefix = nil
   end
-  staff_id = "#{title && title.gsub(' ', '')}Staff"
-  
+  staff_id = Lydown::Rendering::Staff.staff_id(name)
 
-  score_mode = self['render_opts/mode'] == :score
+  score_mode = render_mode == :score
   
-  part['settings'] ||= {
-    'pickup' => self[:pickup],
-    'key' => self[:key],
-    'tempo' => self[:tempo]
-  }.deep!
-
-  clef = Lydown::Rendering::Staff.clef(name)
+  clef = Lydown::Rendering::Staff.clef(self, setting_opts)
+  prevent_remove_empty = Lydown::Rendering::Staff.prevent_remove_empty(self, setting_opts)
   
-  midi_mode = self['render_opts']['format'] == 'midi'
+  midi_mode = (self['render_opts/format'] == 'midi') ||
+              (self['render_opts/format'] == 'mp3')
   midi_instrument = midi_mode && Lydown::Rendering::Staff.midi_instrument(name)
   
-  beaming_mode = Lydown::Rendering::Staff.beaming_mode(name)
-  partial = part['settings'][:pickup] ? "\\partial #{part['settings'][:pickup]}" : ""
+  beaming_mode = Lydown::Rendering::Staff.beaming_mode(self, setting_opts)
+  partial = self.get_setting(:pickup, setting_opts)
+  partial = partial ? "\\partial #{partial}" : ""
   
-  end_barline = Lydown::Rendering::Staff.end_barline(self, movement)
+  end_barline = Lydown::Rendering::Staff.end_barline(self, setting_opts)
 
-  cadenza = part['settings'][:time] == 'unmetered'
+  time = self.get_setting(:time, setting_opts)
+  cadenza = time == 'unmetered'
+  
+  skip_bars = (render_mode == :proof) || (render_mode == :part)
+
+  instrument_names = self.get_setting(:instrument_names, setting_opts)
+  hide_instrument_names = 
+    (instrument_names == 'hide') || 
+    (instrument_names =~ /^inline\-?(.+)?$/)
+    
+  if instrument_names =~ /^inline\-?(.+)?$/
+    alignment = $1 && "\\#{$1}"
+    inline_part_title = Lydown::Rendering::Staff.inline_part_title(
+      self, setting_opts.merge(alignment: alignment)
+    )
+  end
 %>
 
 <<
 
 \new Staff = <%= staff_id %> \with {
+  <% if prevent_remove_empty %>
+    \override VerticalAxisGroup.remove-empty = ##f
+  <% end %>
+  <% if size = self.get_setting(:staff_size, setting_opts) %>
+    fontSize = #<%= size %>
+    \override StaffSymbol.staff-space = #(magstep <%= size %>)
+  <% end %>
 }
 
 \context Staff = <%= staff_id %> {
-  <% if part['settings'][:tempo] %>
-    \tempo "<%= part['settings'][:tempo] %>"
+  <% if skip_bars %>
+    \set Score.skipBars = ##t
+  <% end %>
+    
+
+  <% if tempo = self.get_setting(:tempo, setting_opts) %>
+    \tempo "<%= tempo %>"
   <% end %>
 
-<% if score_mode %>\set Staff.instrumentName = #"<%= title %>"<% end %>
+<% if score_mode && !hide_instrument_names %>
+  \set Staff.instrumentName = <%= part_title %>
+<% end %>
 
 <% if midi_instrument %>
   \set Staff.midiInstrument = #"<%= midi_instrument %>"
 <% end %>
 
-  \relative c {
-    <% if clef %>
-        \clef "<%= clef %>"
-    <% end %>
-    <%= partial %>
-    
-    <<
-      \new Voice = "<%= voice_prefix %>voice1" {
-        <%= beaming_mode %>
-        <%= part['music'] %>
-      }
-    >>
-    <% if end_barline %>
-      \bar "<%= end_barline %>"
-    <% end %>
-  }
+  <% if clef %>
+      \clef "<%= clef %>"
+  <% end %>
+  <%= partial %>
+
+  <% if score_mode && inline_part_title %>
+    <%= inline_part_title %>
+  <% end %>
+  
+  <%= beaming_mode %>
+  \<%= Lydown::Rendering.variable_name(setting_opts.merge(stream: :music)) %>
+  
+  <% if end_barline %>
+    \bar "<%= end_barline %>"
+  <% end %>
 }
 
-  <% if part['lyrics'] %>
-    <% multi_voice = part['lyrics'].size > 1 %>
-    <% part['lyrics'].each_key do |voice| %>
-      <% above_staff = multi_voice && ['voice1', 'voice3'].include?(voice) %>
-      <% part['lyrics'][voice].keys.sort.each do |idx| %>
-        \new Lyrics 
-        <% if above_staff %>
-          \with { alignAboveContext = "<%= staff_id %>" }
-        <% end %>
-        {
-          \lyricsto "<%= voice_prefix %><%= voice %>" {
-            <%= part['lyrics'][voice][idx] %>
-          }
-        }
+<% if part['lyrics'] %>
+  <% multi_voice = part['lyrics'].size > 1 %>
+  <% part['lyrics'].each_key do |voice| %>
+    <% above_staff = multi_voice && ['voice1', 'voice3'].include?(voice) %>
+    <% part['lyrics'][voice].keys.sort.each do |idx| %>
+      \new Lyrics 
+      <% if above_staff %>
+        \with { alignAboveContext = "<%= staff_id %>" }
       <% end %>
+      {
+        \lyricsto "<%= voice_prefix %><%= voice %>" {
+          \<%= Lydown::Rendering.variable_name(setting_opts.merge(stream: :lyrics, voice: voice, idx: idx)) %>
+        }
+      }
     <% end %>
-  
   <% end %>
 
-  <% if part['figures'] %>
-    \figures { <%= part['figures'] %> }
-  <% end %>
+<% end %>
+
+<% if part['figures'] %>
+  \new FiguredBass { \<%= Lydown::Rendering.variable_name(setting_opts.merge(stream: :figures)) %> }
+<% end %>
 >>

data/lib/lydown/templates/variables.erb

@@ -0,0 +1,38 @@
+<% var_name = lambda {|opts| Lydown::Rendering.variable_name(opts)} %>
+<% self['movements'].each do |mvt_name, mvt|
+     mvt['parts'].each do |part_name, part|
+       var_opts = {movement: mvt_name, part: part_name}
+       if part_name && !part_name.empty?
+         voice_prefix = "#{part_name}_"
+       else
+         voice_prefix = nil
+       end
+%>
+<%= var_name[var_opts.merge(stream: :music)] %> = \relative c {
+  <<
+    \new Voice = "<%= voice_prefix %>voice1" {
+      <%= part['music'] %>
+    }
+  >>
+}
+
+<%     if part['lyrics']
+         part['lyrics'].each do |voice, voice_lyrics|
+           voice_lyrics.each do |idx, lyrics|
+%>
+<%= var_name[var_opts.merge(stream: :lyrics, voice: voice, idx: idx)]%> = \lyricmode { <%= lyrics %> }
+<%
+           end
+         end
+       end
+%>
+<%     if part['figures']
+%>
+<%= var_name[var_opts.merge(stream: :figures)]%> = \figuremode { <%= part['figures'] %> }
+<%
+       end
+%>
+<%
+     end
+   end 
+%>

data/lib/lydown/version.rb

@@ -1,3 +1,3 @@
 module Lydown
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

data/lib/lydown/work.rb

@@ -25,8 +25,8 @@ module Lydown
     end
 
     def to_lilypond(opts = {})
-      @context['render_opts'] = opts
-      ly_code = ''
+      @context[:render_opts] = opts.stringify_keys
+      @context[:variables] = {}
 
       if opts[:stream_path]
         unless @context[opts[:stream_path]]
@@ -34,14 +34,13 @@ module Lydown
         end
         @context[opts[:stream_path]].strip
       else
-        @original_context = @context
-        begin
-          filtered = @context.filter(opts)
-          filtered.extend(TemplateBinding)
-          Lydown::Templates.render(:lilypond_doc, filtered)
-        ensure
-          @context = @original_context
-        end
+        filtered = @context.filter(opts)
+        
+        # the filtered context is to the template's self 
+        filtered.extend(TemplateBinding)
+
+        # Remove empty lines from the rendered code
+        Lydown::Templates.render(:lilypond_doc, filtered)
       end
     end
 
@@ -77,11 +76,20 @@ module Lydown
     DEFAULT_BASENAMES = %w{work movement}
 
     def process_directory(path)
+      parts_filter = @context[:options][:parts]
+      if @context[:options] && @context[:options][:include_parts]
+        if parts_filter
+          parts_filter += @context[:options][:include_parts]
+        else
+          parts_filter = @context[:options][:include_parts]
+        end
+      end
+      
       state = {
         streams:          {},
         movements:        Hash.new {|h, k| h[k] = {}},
         current_movement: nil,
-        part_filter:      @context[:options][:parts],
+        part_filter:      parts_filter,
         mvmt_filter:      @context[:options][:movements]
       }
       
@@ -110,7 +118,9 @@ module Lydown
           state[:movements][state[:current_movement]][part] = entry
         end
       elsif File.directory?(entry) && recursive
+        # handle movement subdirectory
         movement = File.basename(entry)
+        state[:movements][movement] ||= {}.deep!
         unless skip_movement?(movement, state)
           state[:current_movement] = movement
           read_directory(entry, false, state)
@@ -119,8 +129,7 @@ module Lydown
     end
     
     def skip_part?(part, state)
-      DEFAULT_BASENAMES.include?(part) ||
-        state[:part_filter] && !state[:part_filter].include?(part)
+      DEFAULT_BASENAMES.include?(part)
     end
     
     def skip_movement?(mvmt, state)
@@ -136,7 +145,7 @@ module Lydown
     
     PARALLEL_PROCESS_OPTIONS = {
       progress: {
-        title: 'Process',
+        title: 'Render',
         format: Lydown::CLI::PROGRESS_FORMAT
       }
     }
@@ -145,15 +154,17 @@ module Lydown
       streams = state[:streams]
       proof_mode =  @context['options/proof_mode']
       paths = streams.keys
-
-      processed_streams = Parallel.map(paths, PARALLEL_PARSE_OPTIONS) do |path|
+      
+      processed_streams = Parallel.map(paths, PARALLEL_PARSE_OPTIONS.clone) do |path|
         content = IO.read(path)
-        LydownParser.parse(content, {
-          filename: File.expand_path(path),
-          source: content,
-          proof_mode: proof_mode,
-          no_progress: true
-        })
+        Cache.hit(content) do
+          LydownParser.parse(content, {
+            filename: File.expand_path(path),
+            source: content,
+            proof_mode: proof_mode,
+            no_progress: true
+          })
+        end
       end
       processed_streams.each_with_index {|s, idx| streams[paths[idx]] = s}
     end
@@ -169,12 +180,14 @@ module Lydown
     
     def translate_movement_files(state)
       stream_entries = prepare_work_stream_array(state)
-      processed_contexts = Parallel.map(stream_entries, PARALLEL_PROCESS_OPTIONS) do |entry|
+      processed_contexts = Parallel.map(stream_entries, PARALLEL_PROCESS_OPTIONS.clone) do |entry|
         mvmt_stream, stream = *entry
         ctx = @context.clone_for_translation
-        ctx.translate(mvmt_stream)
-        ctx.translate(stream)
-        ctx
+        Cache.hit(ctx, mvmt_stream, stream) do
+          ctx.translate(mvmt_stream)
+          ctx.translate(stream)
+          ctx
+        end
       end
       
       processed_contexts.each {|ctx| @context.merge_movements(ctx)}