gitara 0.6.0 → 0.7.0

data/.gitignore

@@ -3,6 +3,7 @@
 git.bundle
 .geanyprj
 .rvmrc
+.switch_file
 .yardoc
 Gemfile.lock
 doc/*

data/README.markdown

@@ -255,6 +255,7 @@ A gitara file can have the following properties:
       midi_instrument "acoustic guitar (nylon)"
       string_tunings "#guitar-tuning"
       tempo "4 = 75"
+      time "4/4"
       transposition "d"
     end
 
@@ -265,6 +266,7 @@ A gitara file can have the following properties:
 * midi_instrument - the type of instrument played in the midi export of the tab. By default, "acoustic guitar (nylon)".
 * [string_tunings](http://lilypond.org/doc/v2.12/Documentation/user/lilypond/Common-notation-for-fretted-strings#Custom-tablatures)
 * [tempo](http://lilypond.org/doc/v2.12/Documentation/user/lilypond/Writing-parts#Metronome-marks)
+* [time](http://lilypond.org/doc/v2.12/Documentation/user/lilypond/Displaying-rhythms#Time-signature) - default is 4/4
 * 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).
 

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

@@ -0,0 +1,114 @@
+\version "2.12.3"
+\include "english.ly"
+
+\paper {
+ indent = #0
+}
+
+\header {
+  title = ""
+  composer = ""
+  arranger = ""
+  instrument = ""
+}
+
+%-----------------------------------------------------------------------
+% Chord Sets
+%-----------------------------------------------------------------------
+% Bars
+
+vOneBarCChordBarOne = {  c4 e4 }
+cBarCChordBarOne = {   }
+sBarCChordBarOne = {  r4^"C chord" r4 }
+
+vOneBarCChordBarTwo = {  g2 }
+cBarCChordBarTwo = {   }
+sBarCChordBarTwo = {  r4 r4 }
+%-----------------------------------------------------------------------
+% Lines
+%-----------------------------------------------------------------------
+% Stanzas
+
+vOneStanzaCChord = { \vOneBarCChordBarOne \vOneBarCChordBarTwo }
+cStanzaCChord = { \cBarCChordBarOne \cBarCChordBarTwo }
+sStanzaCChord = { \sBarCChordBarOne \sBarCChordBarTwo }
+%-----------------------------------------------------------------------
+% Scores
+%-----------------------------------------------------------------------
+% Voices
+
+vOne = {
+  \vOneStanzaCChord
+}
+%-----------------------------------------------------------------------
+% Stanza Headings
+
+stanzaHeadings = { \sStanzaCChord }
+
+%-----------------------------------------------------------------------
+% Chord Headings
+
+chordHeadings = { \cStanzaCChord }
+
+%-----------------------------------------------------------------------
+
+\score {
+  \new StaffGroup <<
+    \new Staff <<
+      \time 2/4
+      \clef "treble_8"
+
+      \new Voice \with { \remove Rest_engraver } {
+        \stanzaHeadings
+      }
+
+      \new Voice {
+        \voiceOne
+        \vOne
+      }
+    >>
+
+    \new TabStaff <<
+      \new TabVoice {
+        \slurUp
+        \vOne
+      }
+      \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)"} <<
+    \clef "treble_8"
+
+    \new Voice {
+      \unfoldRepeats {
+        \vOne
+      }
+    }
+  >>
+
+  \midi {}
+}

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

@@ -0,0 +1,13 @@
+Gitara.define do
+  time '2/4'
+
+  stanza "C chord" do
+    bar do
+      notes "c4 e4"
+    end
+
+    bar do
+      notes "g2"
+    end
+  end
+end

data/lib/gitara.rb

@@ -26,6 +26,7 @@ require "gitara/node/repeat"
 require "gitara/node/score"
 require "gitara/node/stanza"
 require "gitara/node/tab"
+require "gitara/time_signature"
 require "gitara/utilities"
 require "gitara/version"
 require "gitara/voice"

data/lib/gitara/dsl.rb

@@ -18,6 +18,7 @@ module Gitara
     can_add_property :midi_instrument
     can_add_property :string_tunings
     can_add_property :tempo
+    can_add_property :time
     can_add_property :title
     can_add_property :transposition
 

data/lib/gitara/node/bar.rb

@@ -5,10 +5,6 @@ module Gitara
       # @attribute $1
       has_value :specified_duration
 
-      def duration
-        specified_duration || 1
-      end
-
       def first_bar_of_stanza?
         stanza && stanza.descendants(Node::Bar)[0] == self
       end
@@ -26,7 +22,24 @@ module Gitara
       end
 
       def stanza_heading
-        first_bar_of_stanza? ? %Q|r#{duration}^"#{ancestor(Node::Stanza).name}"| : "r#{duration}"
+        first_bar_of_stanza? ?  stanza_heading_for_first_bar : stanza_heading_for_succeeding_bars
+      end
+
+      def stanza_heading_for_first_bar
+        if specified_duration
+          %Q|r#{specified_duration}^"#{ancestor(Node::Stanza).name}"|
+        else
+          ts = ancestor(Node::Tab).time_signature
+          if ts.generates_whole_note_bars?
+            %Q|#{ts.rest_bar_value}^"#{ancestor(Node::Stanza).name}"|
+          else
+            %Q|r#{ts.beat_unit}^"#{ancestor(Node::Stanza).name}" | + ("r#{ts.beat_unit} " * (ts.beats_per_bar - 1)).strip
+          end
+        end
+      end
+
+      def stanza_heading_for_succeeding_bars
+        specified_duration ? "r#{specified_duration}" : ancestor(Node::Tab).time_signature.rest_bar_value
       end
     end
   end

data/lib/gitara/node/tab.rb

@@ -10,6 +10,7 @@ module Gitara
       has_value :midi_instrument, :default => "acoustic guitar (nylon)"
       has_value :string_tunings
       has_value :tempo
+      has_value :time
       has_value :title
       has_value :transposition
 
@@ -21,6 +22,10 @@ module Gitara
         definition_children.last
       end
 
+      def time_signature
+        @time_signature ||= TimeSignature.new(:value => time || '4/4')
+      end
+
       def voices
         @voices ||= Array.new(max_number_of_voices){|i| Voice.new(:id => i + 1, :parent => self)}
       end

data/lib/gitara/template/tab.erb

@@ -69,6 +69,7 @@ chordHeadings = { <%= playable_child.chorded.call_name %> }
 \score {
   \new StaffGroup <<
     \new Staff <<
+      <%= Gitara.render('tab_time', self) %>
       <%= Gitara.render('tab_tempo', self) %>
       \clef "treble_8"
 

data/lib/gitara/template/tab_time.erb

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

data/lib/gitara/time_signature.rb

@@ -0,0 +1,21 @@
+module Gitara
+  class TimeSignature < Valuable
+    has_value :value
+
+    def beats_per_bar
+      value.split('/')[0].to_i
+    end
+
+    def beat_unit
+      value.split('/')[1].to_i
+    end
+
+    def generates_whole_note_bars?
+      beat_unit == beats_per_bar
+    end
+
+    def rest_bar_value
+      generates_whole_note_bars? ? "r1" : ("r#{beat_unit} " * beats_per_bar).strip
+    end
+  end
+end

data/lib/gitara/version.rb

@@ -1,3 +1,3 @@
 module Gitara
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/spec/factories.rb

@@ -49,6 +49,9 @@ FactoryGirl.define do
     children [FactoryGirl.build(:score)]
   end
 
+  factory :time_signature, :class => TimeSignature do
+  end
+
   factory :voice, :class => Voice do
   end
 

data/spec/lib/gitara/app_spec.rb

@@ -31,5 +31,11 @@ describe Gitara::App do
       app_test.run
       app_test.actual.should == app_test.expected
     end
+
+    it "can convert a tab with a specified time to lilypond" do
+      app_test = AppTester.new(:name => 'tab-with-time-signature')
+      app_test.run
+      app_test.actual.should == app_test.expected
+    end
   end
 end

data/spec/lib/gitara/node/bar/stanza_version_spec.rb

@@ -5,6 +5,7 @@ describe Gitara::Node::Bar::StanzaVersion do
     it "should be the stanza heading of the bar" do
       bar = FactoryGirl.build(:bar)
       stanza = FactoryGirl.build(:stanza, :name => 'Intro', :children => [bar])
+      tab = FactoryGirl.build(:tab, :children => [stanza], :time => '4/4')
 
       stanza_version_of_bar = FactoryGirl.build(:stanza_version_bar, :node => bar)
       stanza_version_of_bar.value.should == 'r1^"Intro"'

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

@@ -22,27 +22,37 @@ describe Gitara::Node::Bar do
     it "should be a whole rest with the stanza name if the bar is the first node of a stanza" do
       bar = FactoryGirl.build(:bar)
       stanza = FactoryGirl.build(:stanza, :name => 'Intro', :children => [bar])
+      tab = FactoryGirl.build(:tab, :children => [stanza], :time => '4/4')
 
       bar.stanza_heading.should == 'r1^"Intro"'
     end
 
     it "should be a whole rest with no stanza name if the bar is not the first node of a stanza" do
-      bar = FactoryGirl.build(:bar)
-      bar.stanza_heading.should == 'r1'
+      first_bar = FactoryGirl.build(:bar)
+      second_bar = FactoryGirl.build(:bar)
+      stanza = FactoryGirl.build(:stanza, :name => 'Intro', :children => [first_bar, second_bar])
+      tab = FactoryGirl.build(:tab, :children => [stanza], :time => '4/4')
+
+      second_bar.stanza_heading.should == 'r1'
     end
   end
 
   describe "#with a special_duration" do
-    subject { FactoryGirl.build(:bar, :specified_duration => 8) }
-
     it "should be a partial with the stanza name if the bar is the first node of a stanza" do
+      subject = FactoryGirl.build(:bar, :specified_duration => 8)
       stanza = FactoryGirl.build(:stanza, :name => 'Intro', :children => [subject])
+      tab = FactoryGirl.build(:tab, :children => [stanza], :time => '4/4')
 
       subject.stanza_heading.should == 'r8^"Intro"'
     end
 
     it "should be a partial with no stanza name if the subject is not the first node of a stanza" do
-      subject.stanza_heading.should == 'r8'
+      first_bar = FactoryGirl.build(:bar)
+      second_bar = FactoryGirl.build(:bar, :specified_duration => 8)
+      stanza = FactoryGirl.build(:stanza, :name => 'Intro', :children => [first_bar, second_bar])
+      tab = FactoryGirl.build(:tab, :children => [stanza], :time => '4/4')
+
+      second_bar.stanza_heading.should == 'r8'
     end
   end
 
@@ -78,13 +88,21 @@ describe Gitara::Node::Bar do
     end
   end
 
-  describe "#duration" do
-    it "should be 1 if there is no specified duration" do
-      FactoryGirl.build(:bar, :specified_duration => nil).duration.should == 1
+  describe "#stanza_heading_for_first_bar" do
+    it "should be the time signature's rest bar value with the stanza name if the time signature will generate whole note bars" do
+      bar = FactoryGirl.build(:bar)
+      stanza = FactoryGirl.build(:stanza, :name => 'Intro', :children => [bar])
+      tab = FactoryGirl.build(:tab, :children => [stanza], :time => '4/4')
+
+      bar.stanza_heading_for_first_bar.should == 'r1^"Intro"'
     end
 
-    it "should be the specified duration if present" do
-      FactoryGirl.build(:bar, :specified_duration => 8).duration.should == 8
+    it "should attach the stanza name to the first rest note if the time signature will not generate whole note bars" do
+      bar = FactoryGirl.build(:bar)
+      stanza = FactoryGirl.build(:stanza, :name => 'Intro', :children => [bar])
+      tab = FactoryGirl.build(:tab, :children => [stanza], :time => '3/4')
+
+      bar.stanza_heading_for_first_bar.should == 'r4^"Intro" r4 r4'
     end
   end
 end

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

@@ -50,4 +50,16 @@ describe Gitara::Node::Tab do
       tab.midi_instrument.should == 'acoustic guitar (nylon)'
     end
   end
+
+  describe "#time_signature" do
+    it "should be based on time if it exists" do
+      tab = FactoryGirl.build(:tab, :time => '3/4')
+      tab.time_signature.value.should == '3/4'
+    end
+
+    it "should be 4/4 if time is not set" do
+      tab = FactoryGirl.build(:tab, :time => nil)
+      tab.time_signature.value.should == '4/4'
+    end
+  end
 end

data/spec/lib/gitara/time_signature_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Gitara::TimeSignature do
+  describe "#rest_bar_value" do
+    it "should be r1 if the time signature generates whole note bars" do
+      FactoryGirl.build(:time_signature, :value => '4/4').rest_bar_value.should == "r1"
+    end
+
+    it "should be based on beat unit and beats per bar if the time signature does not generate whole note bars" do
+      FactoryGirl.build(:time_signature, :value => '3/4').rest_bar_value.should == "r4 r4 r4"
+    end
+  end
+
+  describe "#generates_whole_note_bars?" do
+    it "should be true if the beat unit is the same as the beats per bar" do
+      FactoryGirl.build(:time_signature, :value => '4/4').generates_whole_note_bars?.should be_true
+    end
+
+    it "should be false if the beat unit is not the same as the beats per bar" do
+      FactoryGirl.build(:time_signature, :value => '3/4').generates_whole_note_bars?.should be_false
+    end
+  end
+
+  describe "beat_unit" do
+    it "is the second part of the value" do
+      FactoryGirl.build(:time_signature, :value => '3/4').beat_unit.should == 4
+    end
+  end
+
+  describe "beats_per_bar" do
+    it "is the first part of the value" do
+      FactoryGirl.build(:time_signature, :value => '3/4').beats_per_bar.should == 3
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitara
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-01 00:00:00.000000000 Z
+date: 2012-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_support
-  requirement: &69443170 !ruby/object:Gem::Requirement
+  requirement: &72250440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *69443170
+  version_requirements: *72250440
 - !ruby/object:Gem::Dependency
   name: erubis
-  requirement: &69442290 !ruby/object:Gem::Requirement
+  requirement: &72250160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *69442290
+  version_requirements: *72250160
 - !ruby/object:Gem::Dependency
   name: linguistics
-  requirement: &69441980 !ruby/object:Gem::Requirement
+  requirement: &72249910 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *69441980
+  version_requirements: *72249910
 - !ruby/object:Gem::Dependency
   name: pow
-  requirement: &69441550 !ruby/object:Gem::Requirement
+  requirement: &72249630 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *69441550
+  version_requirements: *72249630
 - !ruby/object:Gem::Dependency
   name: redwood
-  requirement: &69441120 !ruby/object:Gem::Requirement
+  requirement: &72249330 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *69441120
+  version_requirements: *72249330
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &69440840 !ruby/object:Gem::Requirement
+  requirement: &72249010 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *69440840
+  version_requirements: *72249010
 - !ruby/object:Gem::Dependency
   name: valuable
-  requirement: &69440430 !ruby/object:Gem::Requirement
+  requirement: &72248620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *69440430
+  version_requirements: *72248620
 - !ruby/object:Gem::Dependency
   name: factory_girl
-  requirement: &69440080 !ruby/object:Gem::Requirement
+  requirement: &72248250 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *69440080
+  version_requirements: *72248250
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &69439780 !ruby/object:Gem::Requirement
+  requirement: &72248000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *69439780
+  version_requirements: *72248000
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &69439500 !ruby/object:Gem::Requirement
+  requirement: &72247730 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *69439500
+  version_requirements: *72247730
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &69439160 !ruby/object:Gem::Requirement
+  requirement: &72247480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *69439160
+  version_requirements: *72247480
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &69438880 !ruby/object:Gem::Requirement
+  requirement: &72247170 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *69438880
+  version_requirements: *72247170
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &69438580 !ruby/object:Gem::Requirement
+  requirement: &72246840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *69438580
+  version_requirements: *72246840
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &69438320 !ruby/object:Gem::Requirement
+  requirement: &72246430 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,10 +164,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *69438320
+  version_requirements: *72246430
 - !ruby/object:Gem::Dependency
   name: yard-rspec
-  requirement: &69438040 !ruby/object:Gem::Requirement
+  requirement: &72245950 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -175,7 +175,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *69438040
+  version_requirements: *72245950
 description: A Ruby DSL for generating Lilypond guitar tablatures.
 email:
 - gsmendoza@gmail.com
@@ -208,6 +208,8 @@ files:
 - examples/tab-with-partial.rb
 - examples/tab-with-repeats.ly
 - examples/tab-with-repeats.rb
+- examples/tab-with-time-signature.ly
+- examples/tab-with-time-signature.rb
 - examples/tab.ly
 - examples/tab.rb
 - gitara.gemspec
@@ -240,7 +242,9 @@ files:
 - lib/gitara/template/stanza.erb
 - lib/gitara/template/tab.erb
 - lib/gitara/template/tab_tempo.erb
+- lib/gitara/template/tab_time.erb
 - lib/gitara/template/voice.erb
+- lib/gitara/time_signature.rb
 - lib/gitara/utilities.rb
 - lib/gitara/version.rb
 - lib/gitara/voice.rb
@@ -262,6 +266,7 @@ files:
 - spec/lib/gitara/node/repeat_spec.rb
 - spec/lib/gitara/node/stanza_spec.rb
 - spec/lib/gitara/node/tab_spec.rb
+- spec/lib/gitara/time_signature_spec.rb
 - spec/lib/gitara/voice_spec.rb
 - spec/lib/gitara_spec.rb
 - spec/spec_helper.rb