gitara 0.0.1 → 0.1.0

data/spec/lib/gitara/node/base/voiced_node_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe 'VoicedNode' do
+  describe "call_name" do
+    it "should be the call name of the voiced node's definition name" do
+      voiced_node = Node::Base::VoicedNode.new(:node => Node::Base.new(:name => 'Intro'), :voice => Voice.new(:id => 1))
+      voiced_node.call_name.should == '\vOneBaseIntro'
+    end
+  end
+
+  describe "definition_name" do
+    it "should include the voice's id, the node's class, and the node's name" do
+      voiced_node = Node::Base::VoicedNode.new(:node => Node::Base.new(:name => 'Intro'), :voice => Voice.new(:id => 1))
+      voiced_node.definition_name.should == 'vOneBaseIntro'
+    end
+  end
+
+  describe "children" do
+    it "should be voiced versions of the node's children" do
+      parent = Node::Base.new(:name => 'parent')
+      child = Node::Base.new(:name => 'child')
+      parent.add child
+
+      voice = Voice.new(:id => 1)
+
+      voiced_node = Node::Base::VoicedNode.new(:node => parent, :voice => voice)
+
+      children = voiced_node.children
+      children.should have(1).voiced_node
+      children[0].node.should == child
+      children[0].voice.should == voice
+    end
+  end
+end
+

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

@@ -0,0 +1,201 @@
+require 'spec_helper'
+
+describe Node::Base do
+  describe "children" do
+    it "should be its own children if they exist" do
+      child = Node::Base.new(:id => nil)
+
+      parent = Node::Base.new
+      parent.children = [child]
+      parent.children.should == [child]
+    end
+
+    it "should be the children of its definition if the node is not a definition" do
+      child = Node::NoteSet.new
+      definition_bar = Node::Bar.new(:name => 'Intro').tap {|bar|
+        bar.children = [child]
+      }
+
+      call_bar = Node::Bar.new(:name => 'Intro')
+
+      tab = Node::Tab.new.tap {|tab|
+        tab.children = [definition_bar, call_bar]
+      }
+
+      call_bar.children.should == [child]
+    end
+  end
+
+  describe "children=(other)" do
+    it "should set the ids and parents of the children" do
+      parent = Node::Base.new
+      parent.children = [Node::Base.new(:id => nil)]
+      parent.children[0].id.should == 1
+      parent.children[0].parent.should == parent
+    end
+  end
+
+  describe "add(child)" do
+    it "should set the id and parent of the child" do
+      parent = Node::Base.new
+
+      parent.add Node::Base.new(:id => nil)
+      parent.children[0].id.should == 1
+      parent.children[0].parent.should == parent
+
+      parent.add Node::Base.new(:id => nil)
+      parent.children[1].id.should == 2
+      parent.children[1].parent.should == parent
+    end
+  end
+
+  describe "definition" do
+    it "should be the definition node which matches this node's name" do
+      definition_bar = Node::Bar.new(:name => 'Intro').tap {|bar|
+        bar.children = [
+          Node::NoteSet.new,
+          Node::NoteSet.new
+        ]
+      }
+
+      call_bar = Node::Bar.new(:name => 'Intro')
+
+      tab = Node::Tab.new.tap {|tab|
+        tab.children = [definition_bar, call_bar]
+      }
+
+      call_bar.send(:definition).should == definition_bar
+    end
+  end
+
+  describe "definition?" do
+    it "should be true if this node has children" do
+      definition_bar = Node::Bar.new(:name => 'Intro').tap {|bar|
+        bar.add Node::NoteSet.new
+        bar.add Node::NoteSet.new
+      }
+      definition_bar.should be_definition
+    end
+
+    it "should be false if this node does not have children" do
+      call_bar = Node::Bar.new(:name => 'Intro')
+      call_bar.should_not be_definition
+    end
+  end
+
+  describe "value" do
+    it "should convert slashes to backslashes" do
+      node = Node::Base.new(:value => %q|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"|)
+      node.value.should == %q|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"|
+    end
+  end
+
+  describe "voiced_as(arg)" do
+    it "should return the voiced version of the node, if arg is a voice" do
+      node = Node::Base.new
+      voice = Voice.new
+
+      node_voice_pair = node.voiced_as(voice)
+      node_voice_pair.should be_a(Node::Base::VoicedNode)
+      node_voice_pair.node.should == node
+      node_voice_pair.voice.should == voice
+    end
+
+    it "should return the voiced versions of the node, if arg are voices" do
+      node = Node::Base.new
+      voices = [Voice.new, Voice.new]
+
+      node_voice_pairs = node.voiced_as(voices)
+      node_voice_pairs.size.should == 2
+
+      node_voice_pairs.each do |pair|
+        pair.should be_a(Node::Base::VoicedNode)
+        pair.node.should == node
+      end
+
+      node_voice_pairs[0].voice.should == voices[0]
+      node_voice_pairs[1].voice.should == voices[1]
+    end
+  end
+
+  describe "definitions(klass)" do
+    it "should be itself if it is an instance of the klass" do
+      node = Node::Bar.new
+      node.add Node::NoteSet.new
+      node.should be_definition
+
+      node.definitions(Node::Bar).should == [node]
+    end
+
+    it "should include descendants which are instances of klass" do
+      node = Node::Base.new.tap do |base|
+        base.add(
+          Node::Bar.new.tap do |bar|
+            bar.add Node::NoteSet.new
+          end
+        )
+
+        base.add(
+          Node::Bar.new.tap do |bar|
+            bar.add Node::NoteSet.new
+          end
+        )
+      end
+
+      node.definitions(Node::Bar).should have(2).bars
+    end
+  end
+
+  describe "root" do
+    it "should be itself if it has no parent" do
+      node = Node::Base.new
+      node.root.should == node
+    end
+
+    it "should be the ancentor of the node which has no parent of its own" do
+      note_set = Node::NoteSet.new
+
+      bar = Node::Bar.new
+      bar.add note_set
+
+      root = Node::Base.new
+      root.add bar
+
+      note_set.root.should == root
+    end
+  end
+
+  describe "name" do
+    it "should be the given name, if available" do
+      Node::Bar.new(:name => :Intro).name.should == :Intro
+    end
+
+    it "should be based on the parent's name the node's class and id, if not available" do
+      child = Node::NoteSet.new
+      bar = Node::Bar.new(:name => :Intro).tap do |bar|
+        bar.add child
+      end
+
+      child.name.should == "IntroNoteSetOne"
+    end
+
+    it "should be based on the node's class and id, if there's no parent and the there's no given name" do
+      child = Node::NoteSet.new
+      child.name.should == "NoteSetOne"
+    end
+  end
+
+  describe "id" do
+    it "should be 1 by default" do
+      child = Node::NoteSet.new
+      child.id.should == 1
+    end
+  end
+
+  describe "id_as_word" do
+    it "should camelize if necessary" do
+      node = Node::Base.new(:id => 24)
+      node.id_as_word.should == "TwentyFour"
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Node::NoteSet do
+end

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

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe 'Tab' do
+  describe "voices" do
+    it "should create a <max_number_of_voices> voices" do
+      tab = Node::Tab.new.tap {|tab|
+        tab.children = [
+          Node::Bar.new.tap {|bar|
+            bar.children = [
+              Node::NoteSet.new,
+              Node::NoteSet.new
+            ]
+          }
+        ]
+      }
+      voices = tab.voices
+      voices.should have(2).values
+      voices[0].id.should == 1
+      voices[1].id.should == 2
+      voices.map(&:parent).uniq.should == [tab]
+    end
+  end
+
+  describe "max_number_of_voices" do
+    it "should be the max number of note_sets in a bar" do
+      tab = Node::Tab.new.tap {|tab|
+        tab.children = [
+          Node::Bar.new.tap {|bar|
+            bar.children = [
+              Node::NoteSet.new,
+              Node::NoteSet.new
+            ]
+          }
+        ]
+      }
+      tab.max_number_of_voices.should == 2
+    end
+  end
+
+  describe "playable_child" do
+    it "should be the last child of the tab" do
+      tab = Node::Tab.new.tap {|tab|
+        tab.children = [
+          Node::Bar.new(:name => 'Intro').tap {|bar|
+            bar.children = [
+              Node::NoteSet.new,
+              Node::NoteSet.new
+            ]
+          },
+          Node::Bar.new(:name => 'Intro')
+        ]
+      }
+
+      tab.playable_child.id.should == 2
+    end
+  end
+end

data/spec/lib/gitara/voice_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Voice do
+  describe "call_name" do
+    it "should be the variable name of the node when called inside lilypond" do
+      voice = Voice.new(:id => 1)
+      voice.call_name.should == '\vOne'
+    end
+  end
+
+  describe "definition_name" do
+    it "should be the name of the voice in a lilypond variable definition statement" do
+      voice = Voice.new(:id => 1)
+      voice.definition_name.should == "vOne"
+    end
+  end
+
+  describe "id_as_word" do
+    it "should convert the id to word" do
+      node = Voice.new(:id => 1)
+      node.id_as_word.should == "One"
+    end
+  end
+
+  describe "stem_type" do
+    it "should be the lilypond stem type for the voice" do
+      voice = Voice.new(:id => 1)
+      voice.stem_type.should == '\voiceOne'
+    end
+  end
+end

data/spec/lib/gitara_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Gitara do
+  describe "tab" do
+    it "should create a tab instance if it does not exist" do
+      Gitara.tab.should be_nil
+      Gitara.define
+      Gitara.tab.should be_a(Node::Tab)
+    end
+
+    it "should instance evaluate a block if given" do
+      tab = Gitara.define do
+        bar "Intro" do
+          notes "c"
+        end
+      end
+
+      bars = tab.definitions(Node::Bar)
+      bars.size.should == 1
+      bars[0].name.should == 'Intro'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'gitara'
+require 'parslet/convenience'
+require 'parslet/rig/rspec'
+require 'pry'
+
+RSpec.configure do |config|
+  include Gitara
+
+  config.before :each do
+    test_tmp_dir.delete! if test_tmp_dir.exists?
+    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
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gitara
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - George Mendoza
@@ -15,14 +15,181 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-08 00:00:00 Z
-dependencies: []
-
-description: This will be a work in progress. Ultimately the goal is to have a good basic tablature DSL that is easily convertible to lilypond.
+date: 2012-02-17 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: active_support
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: erubis
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: linguistics
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: parslet
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: pow
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: valuable
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: pry
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: rb-inotify
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id012
+description: A Ruby DSL for generating Lilypond guitar tablatures.
 email: 
 - gsmendoza@gmail.com
-executables: []
-
+executables: 
+- gitara
 extensions: []
 
 extra_rdoc_files: []
@@ -30,10 +197,50 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- Guardfile
+- README.markdown
 - Rakefile
+- bin/gitara
+- examples/aimee-man-wise-up/aimee-man-wise-up.ly
+- examples/aimee-man-wise-up/aimee-man-wise-up.midi
+- examples/aimee-man-wise-up/aimee-man-wise-up.pdf
+- examples/aimee-man-wise-up/aimee-man-wise-up.rb
+- examples/tab-with-bar.rb
+- examples/tab-with-reused-bar.rb
+- examples/tab.ly
+- examples/tab.rb
 - gitara.gemspec
 - 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
+- lib/gitara/node/base/voiced_node.rb
+- lib/gitara/node/line.rb
+- lib/gitara/node/note_set.rb
+- lib/gitara/node/score.rb
+- lib/gitara/node/tab.rb
+- lib/gitara/pow/base.rb
+- lib/gitara/template/bar.erb
+- lib/gitara/template/line.erb
+- lib/gitara/template/score.erb
+- lib/gitara/template/tab.erb
+- lib/gitara/template/voice.erb
 - lib/gitara/version.rb
+- lib/gitara/voice.rb
+- spec/lib/gitara/app_spec.rb
+- spec/lib/gitara/dsl_spec.rb
+- spec/lib/gitara/node/bar/voiced_node_spec.rb
+- spec/lib/gitara/node/bar_spec.rb
+- spec/lib/gitara/node/base/voiced_node_spec.rb
+- spec/lib/gitara/node/base_spec.rb
+- spec/lib/gitara/node/note_set_spec.rb
+- spec/lib/gitara/node/tab_spec.rb
+- spec/lib/gitara/voice_spec.rb
+- spec/lib/gitara_spec.rb
+- spec/spec_helper.rb
 homepage: ""
 licenses: []
 
@@ -66,6 +273,6 @@ rubyforge_project: gitara
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: A Ruby DSL for tablatures
+summary: Ruby + Lilypond = pretty guitar tablatures.
 test_files: []