chordy 0.7.1

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+before_install:
+  - gem update --system
+  - gem install bundler
+  - gem --version

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rake", ">=10.0.2"
+  gem "rdoc", ">= 3.12"
+  gem "bundler", ">= 1.2.3"
+  gem "jeweler", ">= 1.8.4"
+  gem "simplecov", ">= 0"
+  gem "ruby-debug19", ">= 0"
+end

data/LICENSE.rdoc

@@ -0,0 +1,24 @@
+= chordy
+
+The MIT License
+
+Copyright (c) 2012 Akhil Wali
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,196 @@
+= chordy  {<img src="https://travis-ci.org/darth10/chordy.png" />}[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 notes.
+
+It supports all chord families and most chord types.
+Variations in a note, such as a palm-mute or a trill, are also supported.  
+Formatting options are also provided.
+
+== Installation
+
+<em>Ruby Gems</em> is required.
+
+Download the latest gem distribution from the {downloads page}[http://github.com/darth10/chordy/downloads]
+and run <code>gem install chordy.gem</code> to install chordy.
+
+== 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. 
+
+  $ irb -r chordy
+  irb(main):001:0> play C
+   E [--3-]
+   A [--3-]
+   D [--2-]
+   G [--0-]
+   B [--1-]
+   E [--0-]
+
+
+  => #<C:0x4d896f8 @flags=0, @strings=[3, 3, 2, 0, 1, 0], @type=:major>
+
+  irb(main):002:0> play EFlat
+   E [--3-----]
+   A [--3---1-]
+   D [--2---1-]
+   G [--0---3-]
+   B [--1---4-]
+   E [--0---3-]
+
+
+  => #<DSharp:0x4d7afc8 @flags=0, @strings=[-1, 1, 1, 3, 4, 3], @type=:major>
+
+  irb(main):003:0>
+
+To specify a chord type such a minor or a suspended chord, specify a second parameter such as <code>:minor</code> or <code>:suspended_4</code>.
+The chord type can also specified in a shorter way like <code>:m</code> or <code>:sus4</code>.
+Note that the default for this parameter is <code>:major</code>, which is shortened to <code>:M</code>.
+This {wiki page}[http://darth10.github.com/chordy/chords.html] contains a complete listing of all chord families and types.
+
+  irb(main):001:0> play C, :minor
+   E [----]
+   A [--3-]
+   D [--1-]
+   G [--0-]
+   B [--4-]
+   E [--3-]
+  
+  
+  => #<C:0xb72e1924 @flags=0, @strings=[-1, 3, 1, 0, 4, 3], @type=:minor>
+  
+  irb(main):002:0> play E, :sus4
+   E [------0-]
+   A [--3---2-]
+   D [--1---2-]
+   G [--0---2-]
+   B [--4---0-]
+   E [--3---0-]
+  
+  
+  => #<E:0xb72df138 @flags=0, @strings=[0, 2, 2, 2, 0, 0], @type=:suspended_4>
+  
+  irb(main):003:0> 
+
+A chord can also be described in terms of it's strings, by just passing an array of integers to the <code>play</code> function.
+
+  irb(main):001:0> play [5]
+   E [--5-]
+   A [----]
+   D [----]
+   G [----]
+   B [----]
+   E [----]
+  
+  
+  => #<Chord:0xb726e2e4 @strings=[5, -1, -1, -1, -1, -1], @flags=0>
+  
+  irb(main):002:0> play [2, 4, 4]
+   E [--5---2-]
+   A [------4-]
+   D [------4-]
+   G [--------]
+   B [--------]
+   E [--------]
+  
+  
+  => #<Chord:0xb726b01c @strings=[2, 4, 4, -1, -1, -1], @flags=0>
+  
+  irb(main):003:0>
+
+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.
+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.
+
+  irb(main):001:0> play_mute A
+   E [--0-]
+   A [--0-]
+   D [--2-]
+   G [--2-]
+   B [--2-]
+   E [--0-]
+        M
+  
+  => #<A:0x4d85018 @flags=1, @strings=[0, 0, 2, 2, 2, 0], @type=:major>
+  
+  irb(main):002:0> slide_down {
+  irb(main):003:1*   play [2, 2, 4]
+  irb(main):004:1>   play [4, 4, 6]
+  irb(main):005:1> }
+   E [--0---2\--4\]
+   A [--0---2\--4\]
+   D [--2---4\--6\]
+   G [--2---------]
+   B [--2---------]
+   E [--0---------]
+        M
+  
+  => #<Chord:0x4d4a1a0 @flags=32, @strings=[4, 4, 6, -1, -1, -1]>
+  
+  irb(main):006:0>
+
+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 a variable prefixed with <em>tuning_</em>, followed by the number of strings in the tuning and the name of the tuning.
+For example, <code>tuning_7_a</code> represents A-tuning on a 7-string instrument.
+This {wiki page}[http://darth10.github.com/chordy/tuning.html] contains a complete listing of all supported tunings.
+
+  irb(main):001:0> tuning_7_a
+  => ["a", "d", "g", "c", "f", "a", "d"]
+  
+  irb(main):002:0> tune tuning_7_a
+  => nil
+  
+  irb(main):003:0> play C
+   A [----]
+   D [--3-]
+   G [--3-]
+   C [--2-]
+   F [--0-]
+   A [--1-]
+   D [--0-]
+  
+  
+  => #<C:0x4d67018 @flags=0, @strings=[-1, 3, 3, 2, 0, 1, 0], @type=:major>
+  
+  irb(main):004:0>
+
+You could also script the chords to play by using <code>require 'chordy_script'</code>.
+Here's a sample chordy script.
+
+  # 'sample.rb'
+  require 'chordy_script'
+  
+  play :C
+  play "E"
+  play :C, :m
+  play "E", "minor"
+  
+  play [-1, 3, 3, 2, 0, 1, -1]
+  play [-1, 0, 2, 2]
+
+Here's what the output of the script looks like.
+
+  $ ruby sample.rb
+  # TODO #
+
+TODO sections and text 
+
+== Documentation
+
+Visit the wiki[http://darth10.github.com/chordy] for more information. To generate the API documentation, use <code>rake rdoc</code>.
+
+== Contributing
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Make sure your code is formatted as described in the Github Ruby style-guide.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+

data/Rakefile

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake/dsl_definition'
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "chordy"
+  gem.rubyforge_project = "chordy"
+  gem.version = "0.7.1"
+  gem.homepage = "http://github.com/darth10/chordy"
+  gem.license = "MIT"
+  gem.summary = %Q{DSL for guitar chords}
+  gem.description = %Q{Chordy is a DSL written in Ruby to print guitar chords diagrams}
+  gem.email = "akhil.wali.10@gmail.com"
+  gem.authors = ["Akhil Wali"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => [:test, :build]
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "chordy #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('LICENSE.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/a_chords.rb

@@ -0,0 +1,81 @@
+# encoding: utf-8
+
+require 'chord'
+
+class A < Chord
+  def play_major
+    [0, 0, 2, 2, 2, 0]
+  end
+
+  def play_minor
+    [0, 0, 2, 2, 1, 0]
+  end
+
+  def play_dominant_7
+    [0, 0, 2, 0, 2, 0]
+  end
+
+  def play_dominant_7_5
+    [-1, 0, 1, 0, 2, 3]
+  end
+
+  def play_major_6
+    [0, 0, 2, 2, 2, 2]
+  end
+
+  def play_major_7
+    [0, 0, 2, 1, 2, 0]
+  end
+
+  def play_major_9
+    [-1, 2, 2, 2, 2, 3]
+  end
+
+  def play_minor_6
+    [2, 0, 2, 2, 1, 2]
+  end
+
+  def play_minor_7
+    [0, 0, 2, 0, 1, 0]
+  end
+
+  def play_half_diminished_7
+    [-1, 0, 1, 0, 1, 3]
+  end
+
+  def play_minor_major_7
+    [0, 0, 2, 1, 1, 0]
+  end
+
+  def play_augmented_5
+    [1, 0, 3, 2, 2, 1]
+  end
+
+  def play_augmented_7
+    [1, 4, 3, 0, 2, 1]
+  end
+
+  def play_augmented_major_7
+    [-1, 0, -1, 1, 2, 1]
+  end
+
+  def play_diminished_5
+    [5, 6, 7, 5, 4, 5]
+  end
+
+  def play_diminished_7
+    [-1, -1, 1, 2, 1, 2]
+  end
+
+  def play_diminished_9
+    [2, -1, 5, 3, 2, 5]
+  end
+
+  def play_suspended_4
+    [0, 0, 2, 2, 3, 0]
+  end
+
+  def play_suspended_7
+    [0, 0, 2, 0, 3, 0]
+  end
+end

data/lib/a_sharp_chords.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+
+require 'chord'
+
+class ASharp < Chord
+  def play_major
+    [1, 1, 3, 3, 3, 1]
+  end
+
+  def play_minor
+    [1, 1, 3, 3, 2, 1]
+  end
+
+  def play_dominant_7
+    [1, 1, 3, 1, 3, 1]
+  end
+
+  def play_dominant_7_5
+    [0, 1, 2, 1, 3, 4]
+  end
+  
+  def play_major_6
+    [1, 1, 3, 3, 3, 3]
+  end
+
+  def play_major_7
+    [1, 1, 3, 2, 3, 1]
+  end
+
+  def play_major_9
+    [-1, 1, 0, 1, 1, 1]
+  end
+
+  def play_minor_6
+    [-1, -1, 3, 3, 2, 3]
+  end
+
+  def play_minor_7
+    [1, 1, 3, 1, 2, 1]
+  end
+  
+  def play_half_diminished_7
+    [1, 1, 2, 1, 2, 4]
+  end
+
+  def play_minor_major_7
+    [1, 1, 3, 2, 2, 1]
+  end
+
+  def play_augmented_5
+    [2, -1, 4, 3, 3, 2]
+  end
+
+  def play_augmented_7
+    [-1, 1, 4, 1, 3, 2]
+  end
+
+  def play_augmented_major_7
+    [-1, 1, 0, 2, 3, 2]
+  end
+
+  def play_diminished_5
+    [0, 1, 2, 3, 2, 0]
+  end
+
+  def play_diminished_7
+    [-1, -1, 2, 3, 2, 3]
+  end
+
+  def play_diminished_9
+    [1, 1, 0, 1, 0, 1]
+  end
+
+  def play_suspended_4
+    [1, 1, 1, 3, 4, 1]
+  end
+
+  def play_suspended_7
+    [1, 1, 1, 1, 3, 1]
+  end
+end
+
+BFlat = ASharp