chordy 0.7.2 → 0.7.3

data/README.rdoc

@@ -1,4 +1,4 @@
-= chordy  {<img src="https://travis-ci.org/darth10/chordy.png" />}[https://travis-ci.org/darth10/chordy]
+= chordy  {<img src="https://secure.travis-ci.org/darth10/chordy.png?branch=master" />}[https://travis-ci.org/darth10/chordy]
 
 chordy is a DSL written in Ruby for printing guitar chord diagrams.
 A chordy script produces output that looks like a song with various chords, sections and arbitrary text.
@@ -14,7 +14,9 @@ Formatting options are also provided.
 == Usage
 
 After installing the chordy gem, you can start chordy in an interactive mode through <code>irb</code>.
-You can declare chords to play using the <code>play</code> function. 
+You can declare chords to play using the <code>play</code> function.
+
+=== Basic chords 
 
 The <code>play</code> function takes one required arugment, which can be a chord family like C or F#.
 There are a handful of notations to specify a chord family.
@@ -187,8 +189,10 @@ You can specify low-to-high string order for playing a chord by adding a <code>:
 
   1.9.3-p327 :005 >
 
-You can also play variations in notes, such as a muted chord or a harmonic.
-To play a variation, you can either use the <code>play</code> function suffixed with the variation name to play.
+=== Variations
+
+You can also play variations in chords, such as a muted chord or a harmonic.
+To play a variation, use the <em>play_var</em> function, where <em>var</em> is the variation name to play.
 Alternatively, you could use the name of the variation itself as a function, which takes a block of chords to be played.
 For example, the <code>play_mute</code> function plays a muted chord, and the <code>slide_down</code> function plays multiple chords with a slide down.
 This {wiki page}[http://darth10.github.com/chordy/chords.html] contains a complete listing of all supported varations.
@@ -248,6 +252,8 @@ For example, it's not possible to print both variations in a chord with both <co
 
   1.9.3-p327 :008 >
 
+=== Tuning
+
 Chordy also supports different tunings.
 The <code>tune</code> function can be used to change the tuning, and has to be supplied with a tuning parameter.
 A tuning is represented as <em>tuning_x_y</em>, where <em>x</em> is the number of strings in the tuning and <em>y</em> is the name of the tuning.
@@ -295,6 +301,8 @@ This {wiki page}[http://darth10.github.com/chordy/tuning.html] contains a comple
 
   1.9.3-p327 :005 >
 
+=== Scripting
+
 You could also script the chords to play by using <code>require 'chordy_script'</code>.
 Just be sure to call <code>print_chords</code>.
 Here's a sample chordy script.
@@ -322,6 +330,8 @@ Here's what the output of the script looks like.
    A [--3---2---3---2--|--1-----]
    E [--3---0-------0--|--------]
 
+=== Text and Sections
+
 Text can be added by using <code>text</code>.
 To provide structure to your output, use <code>section</code> to separate chords.
 Here's the previous script with some text and sections.

data/VERSION

@@ -1 +1 @@
-0.7.2
+0.7.3

data/lib/chordy.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+require 'stringio'
 includes = ['chords', 'util']
 
 include_dirs = includes.map { |dir| "chordy/#{dir}/" }
@@ -76,16 +75,12 @@ module Chordy
     strings = [6, 7, 8]
 
     if new_tuning.is_a? Array
-      if strings.include? new_tuning.length
-        if direction == :high_to_low
-          new_tuning = new_tuning.reverse
-        end
-
-        set_chords_to_tuning new_tuning
-        to_do_print = true
-      else
-        puts "Invalid tuning; only " + strings.join(",") + " strings are allowed" 
+      if direction == :high_to_low
+        new_tuning = new_tuning.reverse
       end
+
+      set_chords_to_tuning new_tuning
+      to_do_print = true
     else
       if is_tuning? new_tuning.to_s
         new_tuning = eval("#{new_tuning}")
@@ -164,7 +159,7 @@ module Chordy
     do_print
   end
 
-  def separator 
+  def separator
     section
   end
 
@@ -210,14 +205,14 @@ module Chordy
             line << curr_chord.print_string_at(i, Chordy.chord_space, Chordy.low_to_high)
           end
         end
-        
+
         chords_in_section = chords_in_section + 1
         to_skip_end_strings = false
       elsif (chords[chord_index].is_a? Util::Text) or (chords[chord_index].is_a? Util::Section)
         lines_to_print.push chords[chord_index].to_s
         to_skip_end_strings = true
         chords_in_section = 0
-        
+
         if chords[chord_index + 1].is_a? Chord
           to_print_start_chords = true
         end
@@ -229,7 +224,7 @@ module Chordy
       else
         is_next_chord_section_or_text = false
       end
-      
+
       if ((chords_in_section % Chordy.line_length) == 0) or (chord_index == chords.length) or is_next_chord_section_or_text
         if to_skip_end_strings
           to_skip_end_strings = false
@@ -244,11 +239,11 @@ module Chordy
         lines_to_print.push ""
         is_new_line = true
       elsif (chords_in_section % Chordy.line_length) == (Chordy.line_length / 2) and is_even_line_length
-        last_chord_lines.each_with_index do |line, i| 
+        last_chord_lines.each_with_index do |line, i|
           line << Chord.print_half_length_string_at(i, Chordy.tuning, Chordy.half_length_delimiter, Chordy.chord_space)
         end
       end
-      
+
       if is_next_chord_section_or_text
         is_new_line = false
       end
@@ -263,6 +258,14 @@ module Chordy
     nil
   end
 
+  def print_chords_to_string
+    sio = StringIO.new
+    old_stdout, $stdout = $stdout, sio
+    print_chords
+    $stdout = old_stdout
+    sio.string
+  end
+
   Chord::CHORD_FLAGS.each_with_index do |name,i|
     eval <<-ENDOFEVAL
     def #{name}
@@ -271,7 +274,7 @@ module Chordy
       Chordy.auto = false
       begin
         chord = yield if block_given?
-        
+
         num_new_chords = Chordy.chords.length - saved_chord_index
         Chordy.chords.last(num_new_chords).each { |c| c.send :#{name} }
       rescue Exception => e

data/lib/chordy/chord.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Chordy
 
   class Chord
@@ -13,7 +11,7 @@ module Chordy
     def self.get_num_high_strings length
       (length / 3.0).ceil
     end
-    
+
     def self.start_of_strings tuning, start_delimiter, low_to_high
       num_strings = tuning.length
       num_high_strings = get_num_high_strings num_strings
@@ -30,7 +28,7 @@ module Chordy
       strings_to_print = strings_range.map { |s| s.rjust(2) + start_delimiter.rjust(2) }
       strings_to_print + [ " " * 4 ]
     end
-    
+
     def self.end_of_strings tuning, end_delimiter
       num_strings = tuning.length
       ([ end_delimiter ] * num_strings) + [ "" ]
@@ -71,7 +69,7 @@ module Chordy
         :sus7 => :suspended_7,
       }
     end
-    
+
     def initialize chord, strings
       @strings = [-1] * strings
       pad_low = false
@@ -93,7 +91,7 @@ module Chordy
       pad_or_trim strings, pad_low
       @flags = 0
     end
-    
+
     def pad_or_trim length, pad_low
       if @strings.length > length
         @strings = @strings.last length
@@ -102,7 +100,7 @@ module Chordy
         if pad_low
           first = @strings.first
           min = @strings.min
-          
+
           # play as bar chord
           bar_chord_string = ((first == min) and (min > 0) and (first > 0)) ? first : -1
           @strings = ([bar_chord_string] * diff) + @strings
@@ -117,6 +115,10 @@ module Chordy
     def play chord_type
       method_for_chord_type = "play_" + chord_type.to_s
       chord = eval(method_for_chord_type)
+      if chord.length > @strings.length
+        chord = chord.last @strings.length
+      end
+
       chord
     end
 
@@ -159,11 +161,11 @@ module Chordy
       end
 
       to_print = to_print.rjust(3, chord_space)
-      
+
       if @flags != 0
         to_print = print_string_with_flag_at index_to_print, to_print, chord_space
       end
-      
+
       to_print.ljust(4, chord_space)
     end
 
@@ -193,7 +195,7 @@ module Chordy
     end
 
     # for printing flags on diff line
-    def print_flag 
+    def print_flag
       to_print = ""
 
       if has_flag MUTE
@@ -203,7 +205,7 @@ module Chordy
       end
 
       to_print.rjust(3).ljust(4)
-    end 
+    end
   end
 
   Chord::CHORD_FLAGS.each_with_index do |name,i|

data/lib/chordy/chords/a.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require File.join(File.dirname(__FILE__), '..', 'chord')
 
 module Chordy

data/lib/chordy/chords/a_sharp.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require File.join(File.dirname(__FILE__), '..', 'chord')
 
 module Chordy
@@ -20,7 +18,7 @@ module Chordy
     def play_dominant_7_5
       [0, 1, 2, 1, 3, 4]
     end
-    
+
     def play_major_6
       [1, 1, 3, 3, 3, 3]
     end
@@ -40,7 +38,7 @@ module Chordy
     def play_minor_7
       [1, 1, 3, 1, 2, 1]
     end
-    
+
     def play_half_diminished_7
       [1, 1, 2, 1, 2, 4]
     end

data/lib/chordy/chords/b.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require File.join(File.dirname(__FILE__), '..', 'chord')
 
 module Chordy

data/lib/chordy/chords/c.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require File.join(File.dirname(__FILE__), '..', 'chord')
 
 module Chordy

data/lib/chordy/chords/c_sharp.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require File.join(File.dirname(__FILE__), '..', 'chord')
 
 module Chordy
@@ -20,7 +18,7 @@ module Chordy
     def play_dominant_7_5
       [-1, 2, 3, 4, 2, 3]
     end
-    
+
     def play_major_6
       [1, 1, 3, 1, 2, 1]
     end
@@ -40,7 +38,7 @@ module Chordy
     def play_minor_7
       [0, 2, 2, 4, 2, 4]
     end
-    
+
     def play_half_diminished_7
       [0, 2, 2, 4, 2, 3]
     end
@@ -56,7 +54,7 @@ module Chordy
     def play_augmented_7
       [-1, 2, 3, 4, 2, 5]
     end
-    
+
     def play_augmented_major_7
       [1, 4, 3, 2, 1, 1]
     end

data/lib/chordy/chords/d.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require File.join(File.dirname(__FILE__), '..', 'chord')
 
 module Chordy

data/lib/chordy/chords/d_sharp.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require File.join(File.dirname(__FILE__), '..', 'chord')
 
 module Chordy
@@ -20,7 +18,7 @@ module Chordy
     def play_dominant_7_5
       [-1, 0, 1, 2, 2, 3]
     end
-    
+
     def play_major_6
       [-1, 1, 1, 3, 1, 3]
     end
@@ -40,7 +38,7 @@ module Chordy
     def play_minor_7
       [-1, 1, 1, 3, 2, 2]
     end
-    
+
     def play_half_diminished_7
       [2, -1, 1, 2, 2, 2]
     end
@@ -56,7 +54,7 @@ module Chordy
     def play_augmented_7
       [-1, -1, 1, 4, 2, 3]
     end
-    
+
     def play_augmented_major_7
       [-1, 2, 1, 0, 3, 3]
     end

data/lib/chordy/chords/e.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require File.join(File.dirname(__FILE__), '..', 'chord')
 
 module Chordy

data/lib/chordy/chords/f.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require File.join(File.dirname(__FILE__), '..', 'chord')
 
 module Chordy

data/lib/chordy/chords/f_sharp.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require File.join(File.dirname(__FILE__), '..', 'chord')
 
 module Chordy

data/lib/chordy/chords/g.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require File.join(File.dirname(__FILE__), '..', 'chord')
 
 module Chordy

data/lib/chordy/chords/g_sharp.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require File.join(File.dirname(__FILE__), '..', 'chord')
 
 module Chordy
@@ -20,7 +18,7 @@ module Chordy
     def play_dominant_7_5
       [-1, -1, 0, 1, 1, 2]
     end
-    
+
     def play_major_6
       [4, 3, 1, 1, 1, 1]
     end
@@ -40,7 +38,7 @@ module Chordy
     def play_minor_7
       [0, 0, 2, 2, 1, 3]
     end
-    
+
     def play_half_diminished_7
       [2, 2, 0, 1, 0, 2]
     end
@@ -56,7 +54,7 @@ module Chordy
     def play_augmented_7
       [-1, 3, 2, 1, 1, 2]
     end
-    
+
     def play_augmented_major_7
       [0, 3, 2, 1, 1, 3]
     end

data/lib/chordy/util/section.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Util
 
   class Section
@@ -9,7 +7,7 @@ module Util
       @title = title
       @separator_length = separator_length
     end
-    
+
     def to_s
       title_str = @title.to_s
       title_str.rjust(title_str.length + 2, "-").ljust(@separator_length, "-")

data/lib/chordy/util/text.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Util
 
   class Text < String

data/lib/chordy/util/tuning.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Util
 
   module Tuning

data/lib/chordy_script.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'chordy'
 
 no_auto

data/test/helper.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'rubygems'
 require 'bundler'
 

data/test/test_chordy.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'helper'
 
 class TestChordy < Test::Unit::TestCase
@@ -42,9 +40,29 @@ class TestChordy < Test::Unit::TestCase
     end
   end
 
-  should "have 6,7 or 8 strings" do
-    # TODO implement
-    true
+  should "support any tuning length" do
+    no_auto
+    tuning_range = 1..20
+
+    tuning_range.each do |t|
+      assert_nothing_raised do
+        tuning = ["a"] * t
+        tune tuning
+        play :C
+      end
+    end
+  end
+
+  should "print to string" do
+    string = 1
+    no_of_strings = 6
+
+    no_auto
+    play [string] * no_of_strings
+    a = print_chords_to_string
+    a_parts = a.split("\n").first(no_of_strings)
+
+    a_parts.each { |c| assert(c.include? string.to_s) }
   end
 
   should "know strings at different positions" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chordy
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-09 00:00:00.000000000 Z
+date: 2013-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
@@ -172,7 +172,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -115352785
+      hash: 509814771
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -181,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: chordy
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: DSL for guitar chords