gitara 0.5.0 → 0.6.0

data/examples/tab-with-repeats.rb

@@ -0,0 +1,19 @@
+Gitara.define do
+  line do
+    repeat 4 do
+      bar do
+        notes "c4 d e f"
+      end
+    end
+
+    alternative do
+      bar do
+        notes "d2 e"
+      end
+
+      bar do
+        notes "f2 g"
+      end
+    end
+  end
+end

data/gitara.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "erubis"
   s.add_runtime_dependency "linguistics"
   s.add_runtime_dependency "pow"
+  s.add_runtime_dependency "redwood"
   s.add_runtime_dependency "thor"
   s.add_runtime_dependency "valuable"
 
@@ -31,4 +32,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency "pry"
   s.add_development_dependency "rb-inotify"
   s.add_development_dependency "rspec"
+  s.add_development_dependency "yard"
+  s.add_development_dependency "yard-rspec"
 end

data/lib/gitara.rb

@@ -2,16 +2,18 @@ require "active_support/inflector"
 require "erubis"
 require "linguistics"
 require "pow"
+require "redwood"
 require "thor"
 require "valuable"
 
 require "gitara/app"
 require "gitara/dsl"
-require "gitara/is_node_version"
 require "gitara/node/base"
+require "gitara/node/base/node_version"
 require "gitara/node/base/chorded_version"
 require "gitara/node/base/stanza_version"
 require "gitara/node/base/voiced_version"
+require "gitara/node/alternative"
 require "gitara/node/bar"
 require "gitara/node/bar/chorded_version"
 require "gitara/node/bar/stanza_version"
@@ -20,10 +22,10 @@ require "gitara/node/chord_set"
 require "gitara/node/chord_set/chorded_version"
 require "gitara/node/line"
 require "gitara/node/note_set"
+require "gitara/node/repeat"
 require "gitara/node/score"
 require "gitara/node/stanza"
 require "gitara/node/tab"
-require "gitara/pow/base"
 require "gitara/utilities"
 require "gitara/version"
 require "gitara/voice"
@@ -39,7 +41,7 @@ module Gitara
 
   def self.render(path, object)
     template = (Pow!('gitara/template') / "#{path}.erb")
-    erb = Erubis::Eruby.new(template.read!)
+    erb = Erubis::Eruby.new(Utilities.read!(template))
     erb.evaluate(object)
   end
 

data/lib/gitara/dsl.rb

@@ -4,8 +4,13 @@ module Gitara
   class Dsl < Valuable
     extend DslMacros
 
+    # @macro [attach] has_value
+    # @attribute $1
     has_value :node
 
+    # @macro [attach] can_add_property
+    # @method $1(value)
+    # Set value as the $1
     can_add_property :arranger
     can_add_property :composer
     can_add_property :instrument
@@ -30,6 +35,10 @@ module Gitara
       end
     end
 
+    def alternative(&block)
+      add Node::Alternative.new, &block
+    end
+
     def bar(*names, &block)
       add_names :names => names, :node_class => Node::Bar, &block
     end
@@ -50,6 +59,10 @@ module Gitara
       node.specified_duration = duration
     end
 
+    def repeat(value, &block)
+      add Node::Repeat.new(:value => value), &block
+    end
+
     def score(*names, &block)
       add_names :names => names, :node_class => Node::Score, &block
     end

data/lib/gitara/node/alternative.rb

@@ -0,0 +1,14 @@
+module Gitara
+  module Node
+    class Alternative < Base
+      def call_value(node_version)
+        alternatives = node_version.definition_children.map do |child|
+          "{ #{child.call_value} }"
+        end
+
+        "\\alternative { #{alternatives.join(' ')} }"
+      end
+    end
+  end
+end
+

data/lib/gitara/node/bar.rb

@@ -1,6 +1,8 @@
 module Gitara
   module Node
     class Bar < Base
+      # @macro [attach] has_value
+      # @attribute $1
       has_value :specified_duration
 
       def duration
@@ -12,7 +14,7 @@ module Gitara
       end
 
       def note_sets
-        children.select{|child| child.is_a?(Node::NoteSet)}
+        definition_children.select{|child| child.is_a?(Node::NoteSet)}
       end
 
       def specified_duration_as_lilypond

data/lib/gitara/node/base.rb

@@ -1,31 +1,37 @@
 module Gitara
   module Node
     class Base < Valuable
+      include Redwood
+
+      # @macro [attach] has_value
+      # @attribute $1
       has_value :name
       has_value :id, :default => 1
-      has_value :parent
       has_value :value
 
       def add(child)
-        own_children << child
-        child.id = own_children.select{|c| c.is_a?(child.class)}.size
-        child.parent = self
+        child.id = children.select{|c| c.is_a?(child.class)}.size + 1
+        graft child
+      end
+
+      def ancestor(klass)
+        ancestors.detect{|ancestor| ancestor.is_a?(klass)}
       end
 
-      def ancestor(node_class)
-        self.is_a?(node_class) ? self : self.parent && self.parent.ancestor(node_class)
+      def call_value(node_version)
+        node_version.call_name
       end
 
-      def children
-        if own_children.empty?
-          definition ? definition.own_children : []
+      def definition_children
+        if leaf?
+          definition ? definition.children : []
         else
-          own_children
+          children
         end
       end
 
       def children=(values)
-        own_children.clear
+        children.clear
         values.each do |child|
           add child
         end
@@ -39,13 +45,13 @@ module Gitara
         if self.definition_of?(target)
           self
         else
-          result = parent.own_children.detect{|node| node.definition_of?(target) }
+          result = parent.children.detect{|node| node.definition_of?(target) }
           result ? result : parent.definition(target)
         end
       end
 
       def definition?
-        ! own_children.empty? || ! value.nil?
+        has_children? || ! value.nil?
       end
 
       def definition_name
@@ -60,11 +66,11 @@ module Gitara
       end
 
       def definitions(klass)
-        self.is_a?(klass) && self.definition? ? [self] : self.own_children.map{|child| child.definitions(klass) }.flatten
+        self.is_a?(klass) && self.definition? ? [self] : self.children.map{|child| child.definitions(klass) }.flatten
       end
 
       def descendants(klass)
-        self.is_a?(klass) ? [self.definition] : self.children.map{|child| child.descendants(klass) }.flatten
+        self.is_a?(klass) ? [self.definition] : self.definition_children.map{|child| child.descendants(klass) }.flatten
       end
 
       def id_as_word
@@ -79,20 +85,12 @@ module Gitara
         attributes[:name] || "#{parent && parent.name}#{self.class.to_s.split('::').last}#{self.id_as_word}"
       end
 
-      def own_children
-        @children ||= []
-      end
-
-      def root
-        parent.nil? ? self : parent.root
-      end
-
       def stanza_version
         self.class::StanzaVersion.new(:node => self)
       end
 
       def value
-        attributes[:value] ? attributes[:value].gsub('/', "\\") : nil
+        attributes[:value].respond_to?(:gsub) ? attributes[:value].gsub('/', "\\") : attributes[:value]
       end
 
       def voiced_as(arg)

data/lib/gitara/node/base/chorded_version.rb

@@ -1,10 +1,7 @@
 module Gitara
   module Node
     class Base
-      class ChordedVersion < Valuable
-        include IsNodeVersion
-
-        has_value :node
+      class ChordedVersion < NodeVersion
       end
     end
   end

data/lib/gitara/node/base/node_version.rb

@@ -0,0 +1,35 @@
+module Gitara
+  module Node
+    class Base
+      class NodeVersion < Valuable
+        # @macro [attach] has_value
+        # @attribute $1
+        has_value :node
+
+        def call_name
+          "\\#{definition_name}"
+        end
+
+        def call_value
+          node.call_value(self)
+        end
+
+        def definition_children
+          node.definition_children.map{|child| self.class.new(:node => child)}
+        end
+
+        def definition_name
+          "#{prefix}#{node.class.to_s.split('::').last}#{node.definition_name}"
+        end
+
+        def prefix
+          self.class.to_s.split('::').last[0].downcase
+        end
+
+        def value
+          definition_children.map(&:call_value).join(' ')
+        end
+      end
+    end
+  end
+end

data/lib/gitara/node/base/stanza_version.rb

@@ -1,10 +1,7 @@
 module Gitara
   module Node
     class Base
-      class StanzaVersion < Valuable
-        include IsNodeVersion
-
-        has_value :node
+      class StanzaVersion < NodeVersion
       end
     end
   end

data/lib/gitara/node/base/voiced_version.rb

@@ -1,14 +1,13 @@
 module Gitara
   module Node
     class Base
-      class VoicedVersion < Valuable
-        include IsNodeVersion
-
-        has_value :node
+      class VoicedVersion < NodeVersion
+        # @macro [attach] has_value
+        # @attribute $1
         has_value :voice
 
-        def children
-          node.children.map{|child| child.voiced_as(voice) }
+        def definition_children
+          node.definition_children.map{|child| child.voiced_as(voice) }
         end
 
         def prefix

data/lib/gitara/node/repeat.rb

@@ -0,0 +1,10 @@
+module Gitara
+  module Node
+    class Repeat < Base
+      def call_value(node_version)
+        "\\repeat volta #{value} { #{ node_version.value } }"
+      end
+    end
+  end
+end
+

data/lib/gitara/node/tab.rb

@@ -1,6 +1,8 @@
 module Gitara
   module Node
     class Tab < Base
+      # @macro [attach] has_value
+      # @attribute $1
       has_value :arranger
       has_value :composer
       has_value :instrument
@@ -11,16 +13,12 @@ module Gitara
       has_value :title
       has_value :transposition
 
-      def self.parse(text)
-        Transform.new.apply(Parser.new.parse(text))
-      end
-
       def max_number_of_voices
         definitions(Node::Bar).map{|bar| bar.note_sets.size}.max
       end
 
       def playable_child
-        children.last
+        definition_children.last
       end
 
       def voices

data/lib/gitara/utilities.rb

@@ -7,6 +7,14 @@ module Gitara
     def self.inspect_attributes(object, *attributes)
       "#{object.class}(" + attributes.collect{|a| "#{a}=#{object.send(a).inspect}"}.join(', ') + ")"
     end
+
+    def self.read!(pow)
+      if pow.exists?
+        pow.read
+      else
+        raise PowError, "#{pow} does not exist"
+      end
+    end
   end
 end
 

data/lib/gitara/version.rb

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

data/lib/gitara/voice.rb

@@ -1,5 +1,7 @@
 module Gitara
   class Voice < Valuable
+    # @macro [attach] has_value
+    # @attribute $1
     has_value :id
     has_value :parent
 

data/spec/factories.rb

@@ -2,6 +2,9 @@ FactoryGirl.define do
   factory :note_set, :class => Node::NoteSet do
   end
 
+  factory :alternative, :class => Node::Alternative do
+  end
+
   factory :app, :class => App do
   end
 
@@ -28,6 +31,9 @@ FactoryGirl.define do
     children [FactoryGirl.build(:bar)]
   end
 
+  factory :repeat, :class => Node::Repeat do
+  end
+
   factory :stanza, :class => Node::Stanza do
     children [FactoryGirl.build(:line)]
   end

data/spec/lib/gitara/app_spec.rb

@@ -1,49 +1,33 @@
 require 'spec_helper'
 
-describe App do
-  class AppTest < Valuable
-    has_value :name
-
-    def run
-      app = FactoryGirl.build(:app)
-      app.invoke :export, ["examples/#{name}.rb"], "target-directory" => test_tmp_dir.path, "run-lilypond" => false
-      (Pow("tmp") / "#{name}.ly").write actual if self.expected != self.actual
-    end
-
-    def expected
-      @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!.gsub(/\n\s+\n/, "\n")
-    end
-  end
-
-  describe "export" do
+describe Gitara::App do
+  describe "#export" do
     it "can convert a tab to lilypond" do
-      app_test = AppTest.new(:name => 'tab')
+      app_test = AppTester.new(:name => 'tab')
       app_test.run
       app_test.actual.should == app_test.expected
     end
 
     it "can convert a tab with a partial to lilypond" do
-      app_test = AppTest.new(:name => 'tab-with-partial')
+      app_test = AppTester.new(:name => 'tab-with-partial')
       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 = AppTester.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 = AppTester.new(:name => 'tab-with-key-signature')
+      app_test.run
+      app_test.actual.should == app_test.expected
+    end
+
+    it "can convert a tab with repeats to lilypond" do
+      app_test = AppTester.new(:name => 'tab-with-repeats')
       app_test.run
       app_test.actual.should == app_test.expected
     end