jamming 0.1.2 → 0.2.0

data/README.markdown

@@ -24,6 +24,29 @@ This will write Em7#9, <em>The Jimi Hendrix Chord</em>, to <tt>/tmp/old_good_jim
 
 ![Em7#9 - The Jimi Hendrix Chord](https://github.com/andmej/jamming/raw/master/examples/Em7%239.png)
 
+### Auto labels
+
+Jamming has an internal database with some chords that lets her auto-identify some chords. So, for example:
+
+     File.open("/tmp/a_major.png", 'w') do |f|
+         chord = Jamming::Chord.new("x-0-2-2-2-0")
+         f.write chord.to_png
+     end
+     
+will generate an image like this:
+
+![A Major](http://jamming.heroku.com/chords/x02220)
+
+(Notice the _A_ label even if you never explicitly declared it.)
+
+If you'd like to override this behavior, pass `:label => nil` to the `to_png` method.
+
+If you find a chord that is not auto-labeled but you'd like it to be, please add it [to this file](https://github.com/andmej/jamming/blob/master/lib/jamming/dictionary.rb) and send a pull request.
+
+### Front-end
+
+Jamming is better served with a front-end that takes care of generating the images for you. Check out [this tiny Sinatra app](https://github.com/andmej/jamming_frontend) that does just that.
+
 Thanks
 ---
 

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/jamming.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jamming}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrés Mejía"]
-  s.date = %q{2010-12-20}
+  s.date = %q{2010-12-21}
   s.description = %q{A Ruby library to generate images of guitar chords}
   s.email = %q{andmej@gmail.com}
   s.extra_rdoc_files = [
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
     "jamming.gemspec",
     "lib/jamming.rb",
     "lib/jamming/chord.rb",
+    "lib/jamming/dictionary.rb",
     "lib/jamming/png_formatter.rb",
     "test/helper.rb",
     "test/test_jamming.rb"

data/lib/jamming/chord.rb

@@ -1,4 +1,5 @@
 require 'jamming/png_formatter'
+require 'jamming/dictionary'
 
 module Jamming
   class Chord
@@ -9,7 +10,11 @@ module Jamming
     end
   
     def to_png(options = {})
-      Jamming::PNGFormatter.new(frets).print(options)
+      Jamming::PNGFormatter.new(frets).print({ :label => name }.merge(options))
+    end
+    
+    def name
+      Jamming::Dictionary.name_for(frets)
     end
   
     protected

data/lib/jamming/dictionary.rb

@@ -0,0 +1,34 @@
+module Jamming
+  class Dictionary
+    DICTIONARY = {
+      "A"  => %w(x02220),
+      "Am" => %w(x02210),
+      "B"  => %w(x24442),
+      "Bm" => %w(x24432),
+      "C"  => %w(x32010),
+      "Cm" => %w(x35543),
+      "D"  => %w(xx0232),
+      "Dm" => %w(xx0231),
+      "E"  => %w(022100),      
+      "Em" => %w(022000),
+      "F"  => %w(133211),
+      "Fm" => %w(133111),
+      "G"  => %w(320022 320002),
+      "Gm" => %w(355333)      
+    }
+
+    def self.name_for(frets)
+      frets = normalize_frets(frets)
+      DICTIONARY.each do |key, different_fingerings|
+        return key if different_fingerings.include?(frets)
+      end
+      nil
+    end
+    
+    private
+      def self.normalize_frets(frets)
+        join_with = frets.any? { |f| f && f >= 10 } ? "-" : ""
+        frets.map { |f| f.nil? ? "x" : f.to_s }.join(join_with)
+      end
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Andr\xC3\xA9s Mej\xC3\xADa"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-20 00:00:00 +01:00
+date: 2010-12-21 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -107,6 +107,7 @@ files:
 - jamming.gemspec
 - lib/jamming.rb
 - lib/jamming/chord.rb
+- lib/jamming/dictionary.rb
 - lib/jamming/png_formatter.rb
 - test/helper.rb
 - test/test_jamming.rb
@@ -124,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 168576609755258433
+      hash: 2896660226921079104
       segments: 
       - 0
       version: "0"