gitara 0.2.0 → 0.3.0

data/CHANGELOG.markdown

@@ -1,3 +1,8 @@
+0.3.0 - 2012-02-19
+------------------
+
+* [#14] Add properties.
+
 0.2.0 - 2012-02-19
 ------------------
 

data/README.markdown

@@ -48,7 +48,7 @@ Bars are the smallest expressions in Gitara, that is, a gitara file must have at
       end
     end
 
-With Gitara, it's easier to write notes using [absolute note names](http://lilypond.org/doc/v2.12/Documentation/learning/absolute-note-names) instead of relative note names. This is because we'll be reusing bars and other Gitara expressions (see Reusing bars below).
+With Gitara, it's easier to write notes using [absolute note names](http://lilypond.org/doc/v2.12/Documentation/user/lilypond/Writing-pitches#Absolute-octave-entry) instead of relative note names. This is because we'll be reusing bars and other Gitara expressions (see Reusing bars below).
 
 
 Multiple voices
@@ -168,7 +168,7 @@ You can group bars in a line:
       bar :BayangMagiliw, :PerlasNgSilanganan, :AlabNgPuso, :SaDibdibMoyBuhay
     end
 
-Lines are manually breaked with [\\break](http://lilypond.org/doc/v2.12/Documentation/notation/line-breaking).
+Lines are manually breaked with [\\break](http://lilypond.org/doc/v2.12/Documentation/user/lilypond/Line-breaking).
 
 Like bars, lines can be named, reused, etc.
 
@@ -179,6 +179,30 @@ Stanzas
 The names of a stanza will be displayed at the top of the stanza's first bar.
 
 
+Properties
+----------
+
+A gitara file can have the following optional properties:
+
+    Gitara.define do
+      title "Wise Up"
+      composer "Aimee Mann"
+      arranger "Arranged by George Mendoza"
+      instrument "Guitar (capo on second fret)"
+      midi_instrument "acoustic guitar (nylon)"
+      tempo "4 = 75"
+      transposition "d"
+    end
+
+* arranger - tab's arranger
+* composer - song's composer
+* instrument - description of the instrument used on the tab
+* 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.
+* 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/aimee-man-wise-up/aimee-man-wise-up.ly

@@ -5,6 +5,13 @@
  indent = #0
 }
 
+\header {
+  title = "Wise Up"
+  composer = "Aimee Mann"
+  arranger = "Arranged by George Mendoza"
+  instrument = "Guitar (capo on second fret)"
+}
+
 %-----------------------------------------------------------------------
 % Bars
 
@@ -144,9 +151,15 @@ vTwoScoreTabOneScoreOne = { \vTwoStanzaIntro \vTwoStanzaVerseOne \vTwoStanzaChor
 %-----------------------------------------------------------------------
 % Voices
 
-vOne = { \vOneScoreTabOneScoreOne }
+vOne = {
+  \transposition d''
+  \vOneScoreTabOneScoreOne
+}
 
-vTwo = { \vTwoScoreTabOneScoreOne }
+vTwo = {
+  \transposition d'
+  \vTwoScoreTabOneScoreOne
+}
 
 
 %-----------------------------------------------------------------------
@@ -169,6 +182,7 @@ stanzaHeadings = {
   \new StaffGroup <<
     \new Staff <<
       \tempo 4 = 75
+
       \clef "treble_8"
 
       \new Voice \with { \remove Rest_engraver } {
@@ -220,6 +234,7 @@ stanzaHeadings = {
 \score {
   \new Staff \with {midiInstrument = #"acoustic guitar (nylon)"} <<
     \tempo 4 = 75
+
     \clef "treble_8"
 
     \new Voice {

data/examples/aimee-man-wise-up/aimee-man-wise-up.rb

@@ -1,4 +1,12 @@
 Gitara.define do
+  title "Wise Up"
+  composer "Aimee Mann"
+  arranger "Arranged by George Mendoza"
+  instrument "Guitar (capo on second fret)"
+  midi_instrument "acoustic guitar (nylon)"
+  tempo "4 = 75"
+  transposition "d"
+
   bar :BeforeYouSign do
     notes "r8 <d'/2>16( <c'/2>8.) <a/3>16 <c'/2>8. <d'/2>16 <e'/1>8. <g/3>8"
     notes "<d/4>4 <d/4>4 <d/4>4 <d/4>4"

data/examples/tab.ly

@@ -5,6 +5,13 @@
  indent = #0
 }
 
+\header {
+  title = "Wise Up"
+  composer = "Aimee Mann"
+  arranger = "Arranged by George Mendoza"
+  instrument = "Guitar (capo on second fret)"
+}
+
 %-----------------------------------------------------------------------
 % Bars
 
@@ -54,9 +61,15 @@ vTwoScoreTabOneScoreOne = { \vTwoStanzaVerseOne }
 %-----------------------------------------------------------------------
 % Voices
 
-vOne = { \vOneScoreTabOneScoreOne }
+vOne = {
+  \transposition d''
+  \vOneScoreTabOneScoreOne
+}
 
-vTwo = { \vTwoScoreTabOneScoreOne }
+vTwo = {
+  \transposition d'
+  \vTwoScoreTabOneScoreOne
+}
 
 
 %-----------------------------------------------------------------------
@@ -72,6 +85,7 @@ stanzaHeadings = {
   \new StaffGroup <<
     \new Staff <<
       \tempo 4 = 75
+
       \clef "treble_8"
 
       \new Voice \with { \remove Rest_engraver } {
@@ -123,6 +137,7 @@ stanzaHeadings = {
 \score {
   \new Staff \with {midiInstrument = #"acoustic guitar (nylon)"} <<
     \tempo 4 = 75
+
     \clef "treble_8"
 
     \new Voice {

data/examples/tab.rb

@@ -1,4 +1,12 @@
 Gitara.define do
+  title "Wise Up"
+  composer "Aimee Mann"
+  arranger "Arranged by George Mendoza"
+  instrument "Guitar (capo on second fret)"
+  midi_instrument "acoustic guitar (nylon)"
+  transposition "d"
+  tempo "4 = 75"
+
   bar :BeganIt do
     notes "/skip 4 <a/3 c'/2 >8 <g/3>8 /skip 4 <g/3 c'/2 >8 <g/3>8"
     notes "<f/4>4 <f/4>4 <c/5>4 <e/4>4"

data/lib/gitara/dsl.rb

@@ -1,7 +1,19 @@
+require "gitara/dsl_macros"
+
 module Gitara
   class Dsl < Valuable
+    extend DslMacros
+
     has_value :node
 
+    can_add_property :arranger
+    can_add_property :composer
+    can_add_property :instrument
+    can_add_property :midi_instrument
+    can_add_property :tempo
+    can_add_property :title
+    can_add_property :transposition
+
     def add(child, &block)
       self.node.add child
       Dsl.new(:node => child).instance_eval(&block) if block_given?

data/lib/gitara/dsl_macros.rb

@@ -0,0 +1,9 @@
+module Gitara
+  module DslMacros
+    def can_add_property(property)
+      define_method property do |value|
+        node.attributes[property] = value
+      end
+    end
+  end
+end

data/lib/gitara/node/tab.rb

@@ -1,6 +1,14 @@
 module Gitara
   module Node
     class Tab < Base
+      has_value :arranger
+      has_value :composer
+      has_value :instrument
+      has_value :midi_instrument, :default => "acoustic guitar (nylon)"
+      has_value :tempo
+      has_value :title
+      has_value :transposition
+
       def self.parse(text)
         Transform.new.apply(Parser.new.parse(text))
       end

data/lib/gitara/template/tab.erb

@@ -5,6 +5,13 @@
  indent = #0
 }
 
+\header {
+  title = "<%= self.title %>"
+  composer = "<%= self.composer %>"
+  arranger = "<%= self.arranger %>"
+  instrument = "<%= self.instrument %>"
+}
+
 %-----------------------------------------------------------------------
 % Bars
 
@@ -54,7 +61,7 @@ stanzaHeadings = {
 \score {
   \new StaffGroup <<
     \new Staff <<
-      \tempo 4 = 75
+      <%= Gitara.render('tab_tempo', self) %>
       \clef "treble_8"
 
       \new Voice \with { \remove Rest_engraver } {
@@ -100,8 +107,8 @@ stanzaHeadings = {
 
 % showLastLength = R1*4
 \score {
-  \new Staff \with {midiInstrument = #"acoustic guitar (nylon)"} <<
-    \tempo 4 = 75
+  \new Staff \with {midiInstrument = #"<%= self.midi_instrument %>"} <<
+    <%= Gitara.render('tab_tempo', self) %>
     \clef "treble_8"
 
     <% voices.each do |voice| %>

data/lib/gitara/template/tab_tempo.erb

@@ -0,0 +1,3 @@
+<% if tempo %>
+\tempo <%= self.tempo %>
+<% end %>

data/lib/gitara/template/voice.erb

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

data/lib/gitara/version.rb

@@ -1,3 +1,3 @@
 module Gitara
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/gitara/voice.rb

@@ -15,8 +15,16 @@ module Gitara
       Utilities.id_as_word(id)
     end
 
+    def octave
+      (self.parent.max_number_of_voices - self.id) + 1
+    end
+
     def stem_type
       "\\voice#{id_as_word}"
     end
+
+    def transposition
+      "#{self.parent.transposition}#{"'" * self.octave}" if self.parent.transposition
+    end
   end
 end

data/spec/lib/gitara/dsl_spec.rb

@@ -202,5 +202,18 @@ describe Gitara do
         stanza.own_children[0].should == line
       end
     end
+
+    [:title, :composer, :arranger, :instrument, :midi_instrument, :tempo, :transposition].each do |property|
+      describe "#{property}(value)" do
+        it "should set the #{property} of the tab to value" do
+          tab =Node::Tab.new
+
+          dsl = Dsl.new(:node => tab)
+          dsl.send property, "test"
+
+          tab.send(property).should == "test"
+        end
+      end
+    end
   end
 end

data/spec/lib/gitara/node/tab_spec.rb

@@ -54,4 +54,11 @@ describe 'Tab' do
       tab.playable_child.id.should == 2
     end
   end
+
+  describe "midi_instrument" do
+    it "should have acoustic guitar (nylon) as default" do
+      tab = Node::Tab.new
+      tab.midi_instrument.should == 'acoustic guitar (nylon)'
+    end
+  end
 end

data/spec/lib/gitara/voice_spec.rb

@@ -28,4 +28,58 @@ describe Voice do
       voice.stem_type.should == '\voiceOne'
     end
   end
+
+  describe "transposition" do
+    it "should be based on the tab's transposition and the voice's octave" do
+      tab = Node::Tab.new(
+        :transposition => 'd',
+        :children => [
+          Node::Bar.new(:children => [
+            Node::NoteSet.new,
+            Node::NoteSet.new
+          ])
+        ]
+      )
+      tab.max_number_of_voices.should == 2
+
+      voice = Voice.new(:parent => tab, :id => 1)
+      voice.transposition.should == "d''"
+
+      voice = Voice.new(:parent => tab, :id => 2)
+      voice.transposition.should == "d'"
+    end
+
+    it "should be blank if the tab has no transposition" do
+      tab = Node::Tab.new(
+        :children => [
+          Node::Bar.new(:children => [
+            Node::NoteSet.new,
+            Node::NoteSet.new
+          ])
+        ]
+      )
+      tab.max_number_of_voices.should == 2
+
+      voice = Voice.new(:parent => tab, :id => 1)
+      voice.transposition.should be_nil
+    end
+  end
+
+  describe "octave" do
+    it "should be based on the voice's position in the tab" do
+      tab = Node::Tab.new(:children => [
+        Node::Bar.new(:children => [
+          Node::NoteSet.new,
+          Node::NoteSet.new
+        ])
+      ])
+      tab.max_number_of_voices.should == 2
+
+      voice = Voice.new(:parent => tab, :id => 1)
+      voice.octave.should == 2
+
+      voice = Voice.new(:parent => tab, :id => 2)
+      voice.octave.should == 1
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gitara
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - George Mendoza
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-19 00:00:00 Z
+date: 2012-02-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: active_support
@@ -200,6 +200,7 @@ files:
 - lib/gitara.rb
 - lib/gitara/app.rb
 - lib/gitara/dsl.rb
+- lib/gitara/dsl_macros.rb
 - lib/gitara/node/bar.rb
 - lib/gitara/node/bar/voiced_node.rb
 - lib/gitara/node/base.rb
@@ -215,6 +216,7 @@ files:
 - lib/gitara/template/score.erb
 - lib/gitara/template/stanza.erb
 - lib/gitara/template/tab.erb
+- lib/gitara/template/tab_tempo.erb
 - lib/gitara/template/voice.erb
 - lib/gitara/utilities.rb
 - lib/gitara/version.rb