gitara 0.4.2 → 0.5.0

data/CHANGELOG.markdown

@@ -1,3 +1,10 @@
+0.5.0 - 2012-03-18
+------------------
+
+* [#19] I should be able to specify alternate tunings.
+* [#21] I should be able to specify the key signature.
+
+
 0.4.2 - 2012-03-17
 ------------------
 

data/README.markdown

@@ -227,7 +227,9 @@ A gitara file can have the following optional properties:
       composer "Aimee Mann"
       arranger "Arranged by George Mendoza"
       instrument "Guitar (capo on second fret)"
+      key 'c \major'
       midi_instrument "acoustic guitar (nylon)"
+      string_tunings "#guitar-tuning"
       tempo "4 = 75"
       transposition "d"
     end
@@ -235,12 +237,13 @@ A gitara file can have the following optional properties:
 * arranger - tab's arranger
 * composer - song's composer
 * instrument - description of the instrument used on the tab
+* key - [key signature](http://lilypond.org/doc/v2.12/Documentation/user/lilypond/Displaying-pitches#Key-signature)
 * midi_instrument - the type of instrument played in the midi export of the tab. By default, "acoustic guitar (nylon)".
-* tempo - see [lilypond](http://lilypond.org/doc/v2.12/Documentation/user/lilypond/Writing-parts#Metronome-marks) for the format.
+* string_tunings - see [lilypond](http://lilypond.org/doc/v2.12/Documentation/user/lilypond/Common-notation-for-fretted-strings#Custom-tablatures)
+* tempo - see [lilypond](http://lilypond.org/doc/v2.12/Documentation/user/lilypond/Writing-parts#Metronome-marks) for the format
 * title - title of the song
 * transposition - adjusts the pitch of the instrument. The default transposition is "c". If you set it to "d", then you have to play the tab two frets higher on the guitar (capo on second fret).
 
-
 Notes with single quotes and backslashes
 ----------------------------------------
 

data/examples/tab-with-alternate-tuning.ly

@@ -0,0 +1,142 @@
+\version "2.12.3"
+\include "english.ly"
+
+\paper {
+ indent = #0
+}
+
+\header {
+  title = ""
+  composer = ""
+  arranger = ""
+  instrument = ""
+}
+
+%-----------------------------------------------------------------------
+% Chord Sets
+
+
+%-----------------------------------------------------------------------
+% Bars
+
+vOneBarTabOneBarOne = {  <d'\2 fs'\1 >4. <fs'\1 d'\2 >4 <fs'\1 d'\2 >8 \skip 4 }
+vTwoBarTabOneBarOne = {  <d,\6>4 <d\4>2 <d\4>8 <a,\5>8 }
+cBarTabOneBarOne = {   }
+sBarTabOneBarOne = {  r1 }
+
+
+%-----------------------------------------------------------------------
+% Lines
+
+
+%-----------------------------------------------------------------------
+% Stanzas
+
+
+%-----------------------------------------------------------------------
+% Scores
+
+
+%-----------------------------------------------------------------------
+% Voices
+
+vOne = {
+  \transposition d''
+  \vOneBarTabOneBarOne
+}
+
+vTwo = {
+  \transposition d'
+  \vTwoBarTabOneBarOne
+}
+
+
+%-----------------------------------------------------------------------
+% Stanza Headings
+
+stanzaHeadings = { \sBarTabOneBarOne }
+
+%-----------------------------------------------------------------------
+% Chord Headings
+
+chordHeadings = { \cBarTabOneBarOne }
+
+%-----------------------------------------------------------------------
+
+\score {
+  \new StaffGroup <<
+    \new Staff <<
+      \tempo 4 = 100
+
+      \clef "treble_8"
+
+      \new Voice \with { \remove Rest_engraver } {
+        \stanzaHeadings
+      }
+
+      \new Voice {
+        \voiceOne
+        \vOne
+      }
+      \new Voice {
+        \voiceTwo
+        \vTwo
+      }
+    >>
+
+    \new TabStaff <<
+      \set TabStaff.stringTunings = #'(4 -1 -5 -10 -15 -22)
+      \new TabVoice {
+        \slurUp
+        \vOne
+      }
+      \new TabVoice {
+        \slurUp
+        \vTwo
+      }
+      \new TabVoice {
+        \chordHeadings
+      }
+    >>
+  >>
+
+  \layout {
+    \context { \Staff
+      \override TimeSignature #'style = #'numbered
+      \override StringNumber #'transparent = ##t
+    }
+    \context { \TabStaff
+      \override TimeSignature #'style = #'numbered
+    }
+    \context { \Voice
+      \remove Slur_engraver
+    }
+    \context { \TabVoice
+      \remove Dots_engraver
+      \remove Stem_engraver
+      \remove Rest_engraver
+    }
+  }
+}
+
+% showLastLength = R1*4
+\score {
+  \new Staff \with {midiInstrument = #"acoustic guitar (nylon)"} <<
+    \tempo 4 = 100
+
+    \clef "treble_8"
+
+    \new Voice {
+      \unfoldRepeats {
+        \vOne
+      }
+    }
+    \new Voice {
+      \unfoldRepeats {
+        \vTwo
+      }
+    }
+  >>
+
+  \midi {}
+}

data/examples/tab-with-alternate-tuning.rb

@@ -0,0 +1,10 @@
+Gitara.define do
+  string_tunings "#'(4 -1 -5 -10 -15 -22)" # Drop D
+  tempo "4 = 100"
+  transposition "d"
+
+  bar do
+    notes "<d'/2 fs'/1 >4. <fs'/1 d'/2 >4 <fs'/1 d'/2 >8 /skip 4"
+    notes "<d,/6>4 <d/4>2 <d/4>8 <a,/5>8"
+  end
+end

data/examples/tab-with-key-signature.ly

@@ -0,0 +1,132 @@
+\version "2.12.3"
+\include "english.ly"
+
+\paper {
+ indent = #0
+}
+
+\header {
+  title = ""
+  composer = ""
+  arranger = ""
+  instrument = ""
+}
+
+%-----------------------------------------------------------------------
+% Chord Sets
+%-----------------------------------------------------------------------
+% Bars
+
+vOneBarTabOneBarOne = {  <d'\2 fs'\1 >4. <fs'\1 d'\2 >4 <fs'\1 d'\2 >8 \skip 4 }
+vTwoBarTabOneBarOne = {  <d,\6>4 <d\4>2 <d\4>8 <a,\5>8 }
+cBarTabOneBarOne = {   }
+sBarTabOneBarOne = {  r1 }
+%-----------------------------------------------------------------------
+% Lines
+%-----------------------------------------------------------------------
+% Stanzas
+%-----------------------------------------------------------------------
+% Scores
+%-----------------------------------------------------------------------
+% Voices
+
+vOne = {
+  \transposition d''
+  \vOneBarTabOneBarOne
+}
+
+vTwo = {
+  \transposition d'
+  \vTwoBarTabOneBarOne
+}
+%-----------------------------------------------------------------------
+% Stanza Headings
+
+stanzaHeadings = { \sBarTabOneBarOne }
+
+%-----------------------------------------------------------------------
+% Chord Headings
+
+chordHeadings = { \cBarTabOneBarOne }
+
+%-----------------------------------------------------------------------
+
+\score {
+  \new StaffGroup <<
+    \new Staff <<
+      \tempo 4 = 100
+
+      \clef "treble_8"
+
+      \new Voice \with { \remove Rest_engraver } {
+        \stanzaHeadings
+      }
+
+      \new Voice {
+        \key d \major
+        \voiceOne
+        \vOne
+      }
+      \new Voice {
+        \key d \major
+        \voiceTwo
+        \vTwo
+      }
+    >>
+
+    \new TabStaff <<
+      \set TabStaff.stringTunings = #'(4 -1 -5 -10 -15 -22)
+      \new TabVoice {
+        \slurUp
+        \vOne
+      }
+      \new TabVoice {
+        \slurUp
+        \vTwo
+      }
+      \new TabVoice {
+        \chordHeadings
+      }
+    >>
+  >>
+
+  \layout {
+    \context { \Staff
+      \override TimeSignature #'style = #'numbered
+      \override StringNumber #'transparent = ##t
+    }
+    \context { \TabStaff
+      \override TimeSignature #'style = #'numbered
+    }
+    \context { \Voice
+      \remove Slur_engraver
+    }
+    \context { \TabVoice
+      \remove Dots_engraver
+      \remove Stem_engraver
+      \remove Rest_engraver
+    }
+  }
+}
+
+% showLastLength = R1*4
+\score {
+  \new Staff \with {midiInstrument = #"acoustic guitar (nylon)"} <<
+    \tempo 4 = 100
+
+    \clef "treble_8"
+
+    \new Voice {
+      \unfoldRepeats {
+        \vOne
+      }
+    }
+    \new Voice {
+      \unfoldRepeats {
+        \vTwo
+      }
+    }
+  >>
+
+  \midi {}
+}

data/examples/tab-with-key-signature.rb

@@ -0,0 +1,11 @@
+Gitara.define do
+  key 'd \major'
+  string_tunings "#'(4 -1 -5 -10 -15 -22)" # Drop D
+  tempo "4 = 100"
+  transposition "d"
+
+  bar do
+    notes "<d'/2 fs'/1 >4. <fs'/1 d'/2 >4 <fs'/1 d'/2 >8 /skip 4"
+    notes "<d,/6>4 <d/4>2 <d/4>8 <a,/5>8"
+  end
+end

data/lib/gitara/dsl.rb

@@ -9,7 +9,9 @@ module Gitara
     can_add_property :arranger
     can_add_property :composer
     can_add_property :instrument
+    can_add_property :key
     can_add_property :midi_instrument
+    can_add_property :string_tunings
     can_add_property :tempo
     can_add_property :title
     can_add_property :transposition

data/lib/gitara/node/tab.rb

@@ -4,7 +4,9 @@ module Gitara
       has_value :arranger
       has_value :composer
       has_value :instrument
+      has_value :key
       has_value :midi_instrument, :default => "acoustic guitar (nylon)"
+      has_value :string_tunings
       has_value :tempo
       has_value :title
       has_value :transposition

data/lib/gitara/template/tab.erb

@@ -78,6 +78,7 @@ chordHeadings = { <%= playable_child.chorded.call_name %> }
 
       <% voices.each do |voice| %>
       \new Voice {
+        <%= self.key && "\\key #{self.key}" %>
         <%= voice.stem_type %>
         <%= voice.call_name %>
       }
@@ -85,6 +86,7 @@ chordHeadings = { <%= playable_child.chorded.call_name %> }
     >>
 
     \new TabStaff <<
+      <%= self.string_tunings && "\\set TabStaff.stringTunings = #{self.string_tunings}" %>
       <% voices.each do |voice| %>
       \new TabVoice {
         \slurUp

data/lib/gitara/template/voice.erb

@@ -1,6 +1,4 @@
 <%= definition_name %> = {
-  <% if self.transposition %>
-  \transposition <%= self.transposition %>
-  <% end %>
+  <%= self.transposition && "\\transposition #{self.transposition}" %>
   <%= parent.playable_child.voiced_as(self).call_name %>
 }

data/lib/gitara/version.rb

@@ -1,3 +1,3 @@
 module Gitara
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

data/spec/lib/gitara/app_spec.rb

@@ -7,15 +7,19 @@ describe App do
     def run
       app = FactoryGirl.build(:app)
       app.invoke :export, ["examples/#{name}.rb"], "target-directory" => test_tmp_dir.path, "run-lilypond" => false
-      (Pow("tmp") / "new-#{name}.ly").write actual if self.expected != self.actual
+      (Pow("tmp") / "#{name}.ly").write actual if self.expected != self.actual
     end
 
     def expected
-      @expected ||= Pow("examples/#{name}.ly").read
+      @expected ||= Pow("examples/#{name}.ly").read!.gsub(/\n\s+\n/, "\n")
+    rescue PowError => e
+      puts "#{e.message}. Copying actual result..."
+      Pow("examples/#{name}.ly").write actual
+      retry
     end
 
     def actual
-      @actual ||= (test_tmp_dir / "#{name}.ly").read
+      @actual ||= (test_tmp_dir / "#{name}.ly").read!.gsub(/\n\s+\n/, "\n")
     end
   end
 
@@ -31,5 +35,17 @@ describe App do
       app_test.run
       app_test.actual.should == app_test.expected
     end
+
+    it "can convert a tab with alternate tuning to lilypond" do
+      app_test = AppTest.new(:name => 'tab-with-alternate-tuning')
+      app_test.run
+      app_test.actual.should == app_test.expected
+    end
+
+    it "can convert a tab with a specified key signature to lilypond" do
+      app_test = AppTest.new(:name => 'tab-with-key-signature')
+      app_test.run
+      app_test.actual.should == app_test.expected
+    end
   end
 end

data/spec/lib/gitara/dsl_spec.rb

@@ -203,7 +203,7 @@ describe Gitara do
       end
     end
 
-    [:title, :composer, :arranger, :instrument, :midi_instrument, :tempo, :transposition].each do |property|
+    [:title, :composer, :arranger, :instrument, :key, :midi_instrument, :string_tunings, :tempo, :transposition].each do |property|
       describe "#{property}(value)" do
         it "should set the #{property} of the tab to value" do
           tab = FactoryGirl.build(:tab)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitara
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-17 00:00:00.000000000 Z
+date: 2012-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_support
-  requirement: &76036530 !ruby/object:Gem::Requirement
+  requirement: &78713260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *76036530
+  version_requirements: *78713260
 - !ruby/object:Gem::Dependency
   name: erubis
-  requirement: &76036310 !ruby/object:Gem::Requirement
+  requirement: &78713040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *76036310
+  version_requirements: *78713040
 - !ruby/object:Gem::Dependency
   name: linguistics
-  requirement: &76036050 !ruby/object:Gem::Requirement
+  requirement: &78712780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *76036050
+  version_requirements: *78712780
 - !ruby/object:Gem::Dependency
   name: pow
-  requirement: &76035840 !ruby/object:Gem::Requirement
+  requirement: &78712550 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *76035840
+  version_requirements: *78712550
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &76035600 !ruby/object:Gem::Requirement
+  requirement: &78712320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *76035600
+  version_requirements: *78712320
 - !ruby/object:Gem::Dependency
   name: valuable
-  requirement: &76035350 !ruby/object:Gem::Requirement
+  requirement: &78712070 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *76035350
+  version_requirements: *78712070
 - !ruby/object:Gem::Dependency
   name: factory_girl
-  requirement: &76035070 !ruby/object:Gem::Requirement
+  requirement: &78711790 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *76035070
+  version_requirements: *78711790
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &75681160 !ruby/object:Gem::Requirement
+  requirement: &78357910 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *75681160
+  version_requirements: *78357910
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &75680880 !ruby/object:Gem::Requirement
+  requirement: &78357620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *75680880
+  version_requirements: *78357620
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &75680640 !ruby/object:Gem::Requirement
+  requirement: &78357380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *75680640
+  version_requirements: *78357380
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &75680330 !ruby/object:Gem::Requirement
+  requirement: &78357060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *75680330
+  version_requirements: *78357060
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &75680020 !ruby/object:Gem::Requirement
+  requirement: &78356740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,7 +142,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *75680020
+  version_requirements: *78356740
 description: A Ruby DSL for generating Lilypond guitar tablatures.
 email:
 - gsmendoza@gmail.com
@@ -166,10 +166,12 @@ files:
 - examples/eraserheads-huling-el-bimbo/tab.midi
 - examples/eraserheads-huling-el-bimbo/tab.pdf
 - examples/eraserheads-huling-el-bimbo/tab.rb
-- examples/tab-with-bar.rb
+- examples/tab-with-alternate-tuning.ly
+- examples/tab-with-alternate-tuning.rb
+- examples/tab-with-key-signature.ly
+- examples/tab-with-key-signature.rb
 - examples/tab-with-partial.ly
 - examples/tab-with-partial.rb
-- examples/tab-with-reused-bar.rb
 - examples/tab.ly
 - examples/tab.rb
 - gitara.gemspec

data/examples/tab-with-bar.rb

@@ -1,7 +0,0 @@
-Gitara.define do
-  bar "Intro" do
-    notes "<g'/1>8 <a/3>8 <g'/1>8 <a/3>16 <g'/1>8 <g/3>16 <e'/1>4 <g/3>8"
-    notes "<f/4>4 <f/4>4 <c/5>4 <e/4>4"
-  end
-end
-

data/examples/tab-with-reused-bar.rb

@@ -1,9 +0,0 @@
-Gitara.define do
-  bar "Intro" do
-    notes "<g'/1>8 <a/3>8 <g'/1>8 <a/3>16 <g'/1>8 <g/3>16 <e'/1>4 <g/3>8"
-    notes "<f/4>4 <f/4>4 <c/5>4 <e/4>4"
-  end
-
-  bar "Intro"
-end
-