chords 0.1 → 0.2

data/README

@@ -2,9 +2,17 @@ Chords
 ======
 A chord generator lib for guitar-like instruments.
 
+Using via gem (hosted at gemcutter.org)
+---------------------------------------
+
+$ sudo gem install chords
+$ chords -h
 
-Running irb under chords/lib:
 
+Running irb under chords/lib:
+-----------------------------
+>> require 'rubygems'
+=> true
 >> require 'chords'
 => true
 >> include Chords

data/bin/chords

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'chords/command_line'
+require 'chords/command_line_parser'
 
 Chords::CommandLineParser.new(ARGV).parse

data/lib/chords/chord.rb

@@ -6,47 +6,64 @@ module Chords
     attr_reader :notes
     attr_accessor :root
     
-    def initialize(*notes)
+    def initialize(title_parts, *notes)
+      @title_parts = title_parts
       @notes = notes.flatten
       @root = @notes.first
     end
     
     def first_inversion
       raise "Not enough notes for inversion" if notes.size < 3
-      inversion = Chord.new(@notes[1], @notes[2], @root, *@notes[3..-1])
+      inversion = Chord.new(@title_parts.dup + ['1st inv.'],
+                            @notes[1], @notes[2], @root, *@notes[3..-1])
       inversion.root = @root
       inversion
     end
     
     def second_inversion
       raise "Not enough notes for inversion" if notes.size < 3
-      inversion = Chord.new(@notes[2], @root, @notes[1], *@notes[3..-1])
+      inversion = Chord.new(@title_parts.dup + ['2nd inv.'],
+                            @notes[2], @root, @notes[1], *@notes[3..-1])
       inversion.root = @root
       inversion
     end
     
     def sixth
-      Chord.new(@notes + [@root + 9])
+      chord = Chord.new(@title_parts.dup + ['6th'], @notes + [@root + 9])
+      chord.root = @root
+      chord
     end
     
     def seventh
-      Chord.new(@notes + [@root + 10])
+      chord = Chord.new(@title_parts.dup + ['7th'], @notes + [@root + 10])
+      chord.root = @root
+      chord
     end
     
     def add9
-      Chord.new(@notes + [@root + 14])
+      chord = Chord.new(@title_parts.dup + ['add9'], @notes + [@root + 14])
+      chord.root = @root
+      chord
     end
     
     def add11
-      Chord.new(@notes + [@root + 17])
+      chord = Chord.new(@title_parts.dup + ['add11'], @notes + [@root + 17])
+      chord.root = @root
+      chord
     end
     
     def bass(note)
-      chord = Chord.new([note] + @notes)
-      chord.root = self.root
+      chord = Chord.new(@title_parts.dup + ["(bass #{note.title})"], [note] + @notes)
+      chord.root = @root
       chord
     end
     
+    def title
+      ret = @root.title
+      ret += " #{@title_parts.join(' ')}" unless @title_parts.empty?
+      ret
+    end
+    
   end
   
 end

data/lib/chords/chord_factory.rb

@@ -16,7 +16,7 @@ module Chords
       raise "No chord with key #{key}" unless CHORDS.has_key?(key)
       notes = [root]
       notes += CHORDS[key].map{|interval| root + interval}
-      Chord.new(notes)
+      Chord.new([key.to_s], notes)
     end
   end
   

data/lib/chords/{command_line.rb → command_line_parser.rb}

@@ -10,6 +10,7 @@ module Chords
       @duplicates = 0
       @max_fret_distance = Chords::Fingering::DEFAULT_MAX_FRET_DISTANCE
       @tuning = Chords::Fretboard::TUNINGS[:standard]
+      @formatter = Chords::TextFormatter
     end
     
     def parse
@@ -48,6 +49,10 @@ module Chords
         @tuning = Chords::Fretboard::TUNINGS[t.to_sym]
       end
       
+      @opts.on("--pdf", "Output to pdf.") do
+        @formatter = Chords::PDFFormatter
+      end
+      
       @opts.on_tail("-h", "--help", examples) do
         puts @opts
       end
@@ -67,10 +72,10 @@ module Chords
         chord_str =~ /^(.{1,2})\.(.*)/
 
         if $1 and $2 and Chords::NOTES.flatten.include?($1)
-          note = Chords.const_get($1)
           begin
+            note = Chords.const_get($1)
             chord = note.class_eval($2)
-            Fretboard.new(@tuning, @frets).print(chord, 
+            Fretboard.new(@tuning, @frets, @formatter).print(chord, 
               {:duplicates => @duplicates,
                :max_fret_distance => @max_fret_distance})
             return

data/lib/chords/fingering.rb

@@ -87,6 +87,18 @@ module Chords
       @positions.hash
     end
     
+    # return an array of relative positions
+    def relative(max_fret_dist)
+      not_open = @positions.select{|p| !p.nil? and p > 0}
+      
+      if not_open.max <= (max_fret_dist + 1)
+        @positions
+      else
+        diff = (not_open.min - 1)
+        @positions.map{|p| (p.nil? or p == 0) ? p : p - diff}
+      end
+    end
+    
     private
     
     def new_note_positions(note, string_index, max_fret_distance)

data/lib/chords/fretboard.rb

@@ -1,6 +1,7 @@
 require 'chords/chord_factory'
 require 'chords/fingering'
 require 'chords/text_formatter'
+require 'chords/pdf_formatter'
 
 module Chords
   
@@ -37,19 +38,25 @@ module Chords
                :c15      => [C.new(-1), G.new, D.new, G.new(1), C.new(1), D.new(1)],
                
                # "Extended chord" tunings
-               :dmaj7    => [D.new(-1), A.new, D.new, Fs.new(1), A.new(1), Cs.new(1)]
+               :dmaj7    => [D.new(-1), A.new, D.new, Fs.new(1), A.new(1), Cs.new(1)],
+               
+               # Other instruments
+               :mandolin => [G.new, D.new, A.new(1), E.new(2)],
+               :ukulele  => [G.new, C.new, E.new(1), A.new(1)],
+               :banjo    => [G.new, D.new, G.new(1), B.new(1), D.new(1)]
               }
     
     attr_reader :frets, :open_notes
     
-    def initialize(open_notes, frets)
+    def initialize(open_notes, frets, formatter_class=TextFormatter)
       @open_notes, @frets = open_notes, frets
-      @formatter = TextFormatter.new(self)
+      @formatter = formatter_class.new(self)
     end
     
     def self.method_missing(meth, *args)
       if TUNINGS.has_key?(meth)
-        Fretboard.new(TUNINGS[meth], (args.first || DEFAULT_FRETS))
+        Fretboard.new(TUNINGS[meth], (args[0] || DEFAULT_FRETS),
+                      args[1] || TextFormatter)
       else
         super
       end
@@ -61,7 +68,7 @@ module Chords
     
     def print(chord, opts={})
       fingerings = find(chord, opts)
-      @formatter.print(fingerings)
+      @formatter.print(chord.title, fingerings, opts)
     end
     
   end

data/lib/chords/note.rb

@@ -5,7 +5,7 @@ module Chords
 
   module Note
     include Comparable
-    attr_reader :interval, :name, :octave
+    attr_reader :interval, :octave
 
     def self.create_by_value(value)
       octave = value / 12
@@ -33,14 +33,14 @@ module Chords
       end
     end
 
-    def name; self.class.to_s.gsub(/^.*::/, '') end
-
+    def title; self.class.title end
+    
     def +(other); Note.create_by_value(value + other) end
     def -(other); Note.create_by_value(value - other) end
   end
   
   # E.g. E + 3 => G
-  module NoteClassArithmetic
+  module NoteClassMethods
     def +(interval)
       note = NOTES.detect{|n| [n].flatten.include?(self.to_s.gsub(/^.*::/, ''))}
       idx = NOTES.index(note) + interval
@@ -48,6 +48,7 @@ module Chords
       Chords.const_get [NOTES[idx]].flatten.first
     end
     def -(interval); self + (-interval) end
+    def title; self.to_s.gsub(/^.*::/, '').sub('s', '#') end
   end
   
   NOTES.each_with_index do |names, i|
@@ -55,7 +56,7 @@ module Chords
     names.each do |n|
       eval %Q(class #{n}
                 include Note
-                extend NoteClassArithmetic
+                extend NoteClassMethods
                 
                 def initialize(octave=0)
                   @interval, @octave = #{i}, octave

data/lib/chords/pdf_formatter.rb

@@ -0,0 +1,97 @@
+
+require 'prawn'
+require 'prawn/layout'
+
+module Chords
+  
+  class PDFFormatter
+    
+    def initialize(fretboard)
+      @fretboard = fretboard
+    end
+    
+    def print(title, fingerings, opts={})
+      @pdf = Prawn::Document.new(:top_margin => 50)
+      @pdf.draw_text "#{title}", :at => [@pdf.margin_box.left, @pdf.margin_box.top + 30]
+      @max_dist = opts[:max_fret_distance] || Fingering::DEFAULT_MAX_FRET_DISTANCE
+      
+      if fingerings.empty?
+        @pdf.text 'No fingerings found.'
+      else
+        @pdf.define_grid(:columns => 4, :rows => 6, :gutter => 40)
+        
+        fingerings.each_with_index do |f, i|
+          print_fingering(f, i)
+        end
+      end
+      
+      @pdf.render_file('chords.pdf')
+      puts "Wrote chords.pdf"
+    end
+    
+    private
+    
+    def string_dist(box)
+      box.width / (@fretboard.open_notes.size - 1)
+    end
+    
+    def fret_dist(box)
+       box.height / (@max_dist + 1)
+    end
+    
+    def get_box(i)
+      @pdf.start_new_page if @pdf.page_count <= i / 24
+      i_on_page = i % 24
+      @pdf.grid(i_on_page / 4, i_on_page % 4)  
+    end
+    
+    def fretboard_text(str, x, y)
+      x_adj = str.length > 1 ? -6 : -3
+      @pdf.draw_text(str, :at => [x + x_adj, y])
+    end
+    
+    def print_fretboard(i)
+      box = get_box(i)
+      
+      @pdf.mask(:line_width) do
+        @pdf.line_width 3
+        @pdf.stroke_line box.top_left, box.top_right
+      end
+        
+      @pdf.stroke_line box.bottom_left, box.bottom_right
+        
+      @fretboard.open_notes.each_with_index do |note, note_i|
+        x = box.left + note_i*string_dist(box)
+        @pdf.stroke_line [x, box.top], [x, box.bottom]
+        fretboard_text(note.title, box.left + note_i*string_dist(box), box.bottom - 11)
+      end
+        
+      @max_dist.times do |n|
+        y = box.top - ((n+1) * fret_dist(box))
+        @pdf.stroke_line [box.left, y], [box.right, y]
+      end
+    end
+    
+    def print_fingering(fingering, i)
+      print_fretboard(i)
+      
+      box = get_box(i)
+      
+      rad = ([fret_dist(box), string_dist(box)].min / 2) - 4
+      
+      fingering.each_with_index do |pos, pos_i|
+        fretboard_text((pos || 'x').to_s, box.left + pos_i*string_dist(box), box.top + 4)
+        
+        next if [nil, 0].include?(pos)
+        
+        @pdf.fill_and_stroke do
+          @pdf.circle_at [box.left + (pos_i * (string_dist(box))), 
+                          box.top + (fret_dist(box) / 2) -
+                          (fingering.relative(@max_dist)[pos_i] * fret_dist(box))], 
+                          :radius => rad
+        end        
+      end
+    end
+  end
+  
+end

data/lib/chords/text_formatter.rb

@@ -7,7 +7,7 @@ module Chords
       @fretboard = fretboard
     end
     
-    def print(fingerings)
+    def print(title, fingerings, opts={})
       rows = [""] * @fretboard.open_notes.size
       
       fingerings.each do |fingering|
@@ -20,7 +20,7 @@ module Chords
       while rows.first.length > idx
         parts = []
         rows.each_with_index do |row, i| 
-          parts << "#{@fretboard.open_notes[i].name.rjust(2, ' ')}: " + row[idx...(idx+75)]
+          parts << "#{@fretboard.open_notes[i].title.rjust(2, ' ')}: " + row[idx...(idx+75)]
         end
         puts "\n" + (parts.reverse.join("\n")) + "\n\n"
         idx += 75

metadata

@@ -1,7 +1,11 @@
 --- !ruby/object:Gem::Specification 
 name: chords
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  version: "0.2"
 platform: ruby
 authors: 
 - Antti Hakala
@@ -9,10 +13,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-25 00:00:00 +02:00
+date: 2010-03-31 00:00:00 +03:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: prawn
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 4
+        version: 0.8.4
+  type: :runtime
+  version_requirements: *id001
 description: "Chords is a chord generator for guitar-like instruments. Handy for special tunings. "
 email: antti.hakala@gmail.com
 executables: 
@@ -27,10 +44,11 @@ files:
 - bin/chords
 - lib/chords/chord.rb
 - lib/chords/chord_factory.rb
-- lib/chords/command_line.rb
+- lib/chords/command_line_parser.rb
 - lib/chords/fingering.rb
 - lib/chords/fretboard.rb
 - lib/chords/note.rb
+- lib/chords/pdf_formatter.rb
 - lib/chords/text_formatter.rb
 - lib/chords.rb
 has_rdoc: true
@@ -46,18 +64,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Chord generator for guitar-like instruments.