gitara 0.1.0 → 0.1.1

data/CHANGELOG.markdown

@@ -0,0 +1,10 @@
+0.1.0 - 2012-02-17
+------------------
+
+* Added notes, bars, lines and scores to API.
+
+0.1.1 - 2012-02-18
+------------------
+
+* [#12] Expressions should be id'd based on class.
+

data/README.markdown

@@ -1,4 +1,4 @@
-Gitara is a Lilypond processor for guitar tablatures.
+Gitara is a Ruby DSL for generating Lilypond guitar tablatures
 
 
 Installation
@@ -14,7 +14,7 @@ Usage
 
     gitara export PATH [OPTIONS]...
 
-This generates a lilypond .ly file for PATH and calls lilypond to export the .ly file to pdf and midi. Please see `gitara help export` for the available options.
+This will generate a lilypond .ly file and then call lilypond to export the .ly file to pdf and midi. Please see `gitara help export` for the available options.
 
 
 Syntax
@@ -44,13 +44,13 @@ 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 musical expression often in Gitara (see Reusing bars below).
+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).
 
 
 Multiple voices
 ---------------
 
-If the bar has more than one note line, then each note line is a voice:
+Each line of notes in a bar is a [voice](http://lilypond.org/doc/v2.12/Documentation/user/lilypond-learning/Voices-contain-music):
 
     Gitara.define do
       bar do
@@ -59,8 +59,7 @@ If the bar has more than one note line, then each note line is a voice:
       end
     end
 
-The tab above will play "c d e f g a b c" and "c' d' e' f' g' a' b' c'" simultaneously,
-not sequentially.
+The tab above will play "c d e f g a b c" and "c' d' e' f' g' a' b' c'" simultaneously, not sequentially.
 
 
 Reusing bars
@@ -79,16 +78,13 @@ If you want to repeat a bar, you can name the bar and call it later:
       end
     end
 
-This will generate a tab with two Intro bars. It's important to group the
-two bars inside a score, because...
+This will generate a tab with two Intro bars. It's important to group the two bars inside a score, because...
 
 
 Only the last expression under Gitara.define will be generated
 --------------------------------------------------------------
 
-When writing a tab, oftentimes you want to generate only a part of the tab for
-isolation and testing. Gitara makes this easy by generating a lilypond file
-only for the last expression under Gitara.define. For example:
+When writing a tab, oftentimes you want to generate only a part of the tab for testing purposes. Gitara makes this easy by processing only for the last expression under Gitara.define. For example:
 
     Gitara.define do
       bar do
@@ -100,8 +96,7 @@ only for the last expression under Gitara.define. For example:
       end
     end
 
-This tab will generate only the second bar (notes "g a b c"). If you want Gitara
-to generate both bars, group them inside a score.
+This tab will generate only the second bar (notes "g a b c"). If you want Gitara to generate both bars, group them inside a score.
 
     Gitara.define do
       score do
@@ -133,7 +128,7 @@ If you want to generate a particular bar inside the score, you can copy it after
       end
     end
 
-Or you define the bar to call later:
+Or you can define the bar to call later:
 
     Gitara.define do
       bar :FirstBar do
@@ -171,15 +166,17 @@ You can group bars in a line:
 
 Lines are manually breaked with [\\break](http://lilypond.org/doc/v2.12/Documentation/notation/line-breaking).
 
+Like bars, lines can be named, reused, etc.
+
 
 Notes with single quotes and backslashes
 ----------------------------------------
 
-In Lilypond syntax, single quotes denote octaves while backslashes denote string numbers. So, the c note in the second string is written as
+In Lilypond syntax, single quotes refer to octaves while backslashes refer to string numbers. So, the c note in the second string is written as
 
     c'\2
 
-Since a Gitara file is a Ruby program, you have to be careful with backslashes when writing notes like the one above. Ruby provides two ways (I know of) to preserve the backslash in the note above:
+Since a Gitara file is a Ruby program, you have to be careful with backslashes when writing notes like the one above. As far as I know, Ruby provides two ways to preserve the backslash in the note above:
 
     notes %q|c'\2|
 
@@ -197,7 +194,7 @@ Prettier and easier to search and replace.
 Workflow
 --------
 
-I'm no Lilypond expert (heh). When writing a tab, I use [TuxGuitar](http://tuxguitar.herac.com.ar) to transcribe a set of notes (usually just one bar). I then export the TuxGuitar tab to lilypond so that I can get the lilypond notes. I then place the notes inside my Gitara tab. This workflow allows me to use TuxGuitar's GUI for transcribing notes while allowing me to use Gitara's features for naming bars and reusing them.
+I'm no Lilypond expert (heh). When writing a tab, I use [TuxGuitar](http://tuxguitar.herac.com.ar) to transcribe a set of notes (usually just one bar). I then export the TuxGuitar tab to lilypond so that I can get the lilypond notes. I then place these lilypond notes inside my Gitara tab. This workflow allows me to use TuxGuitar's GUI for transcribing notes while allowing me to use Gitara's features for naming expressions and reusing them.
 
 
 To do
@@ -209,6 +206,6 @@ For version 1, I want to convert this lilypond file I wrote to Gitara format:
 
 The remaining features are:
 
-1. Properties like the title and authors.
-2. Stanza labels.
+1. Properties like the title and authors
+2. Stanza labels
 3. Chord labels

data/examples/tab.ly

@@ -29,23 +29,23 @@ vTwoBarYouGot = { <f\4>4 <f\4>4 <c\5>4 <e\4>4 }
 vOneLineVerseOneLineTwo = { \vOneBarYouGot \vOneBarWhatYouThought \vOneBarWhenYouFirst \vOneBarItThough \break }
 vTwoLineVerseOneLineTwo = { \vTwoBarYouGot \vTwoBarWhatYouThought \vTwoBarWhenYouFirst \vTwoBarItThough \break }
 
-vOneLineTabOneScoreEightLineOne = { \vOneBarItsNot \vOneBarWhatYouThought \vOneBarWhenYouFirst \vOneBarBeganIt \break }
-vTwoLineTabOneScoreEightLineOne = { \vTwoBarItsNot \vTwoBarWhatYouThought \vTwoBarWhenYouFirst \vTwoBarBeganIt \break }
+vOneLineTabOneScoreOneLineOne = { \vOneBarItsNot \vOneBarWhatYouThought \vOneBarWhenYouFirst \vOneBarBeganIt \break }
+vTwoLineTabOneScoreOneLineOne = { \vTwoBarItsNot \vTwoBarWhatYouThought \vTwoBarWhenYouFirst \vTwoBarBeganIt \break }
 
 
 %-----------------------------------------------------------------------
 % Scores
 
-vOneScoreTabOneScoreEight = { \vOneLineTabOneScoreEightLineOne \vOneLineVerseOneLineTwo }
-vTwoScoreTabOneScoreEight = { \vTwoLineTabOneScoreEightLineOne \vTwoLineVerseOneLineTwo }
+vOneScoreTabOneScoreOne = { \vOneLineTabOneScoreOneLineOne \vOneLineVerseOneLineTwo }
+vTwoScoreTabOneScoreOne = { \vTwoLineTabOneScoreOneLineOne \vTwoLineVerseOneLineTwo }
 
 
 %-----------------------------------------------------------------------
 % Voices
 
-vOne = { \vOneScoreTabOneScoreEight }
+vOne = { \vOneScoreTabOneScoreOne }
 
-vTwo = { \vTwoScoreTabOneScoreEight }
+vTwo = { \vTwoScoreTabOneScoreOne }
 
 
 \score {

data/lib/gitara.rb

@@ -8,7 +8,6 @@ require "valuable"
 
 require "gitara/app"
 require "gitara/dsl"
-require "gitara/id_as_word"
 require "gitara/node/base"
 require "gitara/node/base/voiced_node"
 require "gitara/node/bar"
@@ -18,6 +17,7 @@ require "gitara/node/note_set"
 require "gitara/node/score"
 require "gitara/node/tab"
 require "gitara/pow/base"
+require "gitara/utilities"
 require "gitara/version"
 require "gitara/voice"
 

data/lib/gitara/node/base.rb

@@ -1,8 +1,6 @@
 module Gitara
   module Node
     class Base < Valuable
-      include IdAsWord
-
       has_value :name
       has_value :id, :default => 1
       has_value :parent
@@ -10,7 +8,7 @@ module Gitara
 
       def add(child)
         own_children << child
-        child.id = own_children.size
+        child.id = own_children.select{|c| c.is_a?(child.class)}.size
         child.parent = self
       end
 
@@ -40,6 +38,10 @@ module Gitara
         self.is_a?(klass) && self.definition? ? [self] : self.own_children.map{|child| child.definitions(klass) }.flatten
       end
 
+      def id_as_word
+        Utilities.id_as_word(id)
+      end
+
       def name
         attributes[:name] || "#{parent && parent.name}#{self.class.to_s.split('::').last}#{self.id_as_word}"
       end

data/lib/gitara/{id_as_word.rb → utilities.rb}

@@ -1,6 +1,6 @@
 module Gitara
-  module IdAsWord
-    def id_as_word
+  module Utilities
+    def self.id_as_word(id)
       id.en.numwords.gsub('-', '_').camelize
     end
   end

data/lib/gitara/version.rb

@@ -1,3 +1,3 @@
 module Gitara
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/gitara/voice.rb

@@ -1,7 +1,5 @@
 module Gitara
   class Voice < Valuable
-    include IdAsWord
-
     has_value :id
     has_value :parent
 
@@ -13,6 +11,10 @@ module Gitara
       "v#{id_as_word}"
     end
 
+    def id_as_word
+      Utilities.id_as_word(id)
+    end
+
     def stem_type
       "\\voice#{id_as_word}"
     end

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

@@ -47,6 +47,22 @@ describe Node::Base do
       parent.children[1].id.should == 2
       parent.children[1].parent.should == parent
     end
+
+    it "should set the id based on existing siblings having the same class as the child" do
+      parent = Node::Base.new
+
+      bar_1 = Node::Bar.new
+      parent.add bar_1
+      bar_1.id.should == 1
+
+      line_1 = Node::Line.new
+      parent.add line_1
+      line_1.id.should == 1
+
+      bar_2 = Node::Bar.new
+      parent.add bar_2
+      bar_2.id.should == 2
+    end
   end
 
   describe "definition" do

data/spec/spec_helper.rb

@@ -11,16 +11,6 @@ RSpec.configure do |config|
     Gitara.instance_variable_set :@tab, nil
   end
 
-  def debug?
-    $debug.tap do
-      $debug = false
-    end
-  end
-
-  def debug!
-    $debug = true
-  end
-
   def test_tmp_dir
     Pow('tmp/test')
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gitara
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - George Mendoza
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-17 00:00:00 Z
+date: 2012-02-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: active_support
@@ -196,6 +196,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- CHANGELOG.markdown
 - Gemfile
 - Guardfile
 - README.markdown
@@ -213,7 +214,6 @@ files:
 - lib/gitara.rb
 - lib/gitara/app.rb
 - lib/gitara/dsl.rb
-- lib/gitara/id_as_word.rb
 - lib/gitara/node/bar.rb
 - lib/gitara/node/bar/voiced_node.rb
 - lib/gitara/node/base.rb
@@ -228,6 +228,7 @@ files:
 - lib/gitara/template/score.erb
 - lib/gitara/template/tab.erb
 - lib/gitara/template/voice.erb
+- lib/gitara/utilities.rb
 - lib/gitara/version.rb
 - lib/gitara/voice.rb
 - spec/lib/gitara/app_spec.rb