jamming 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "rmagick"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    rmagick (2.13.1)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  rcov
+  rmagick
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Andrés Mejía
+
+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.markdown

@@ -0,0 +1,52 @@
+jamming
+===
+
+Jamming is a Ruby library to generate images of guitar chords.
+
+Installation
+---
+
+    gem install jamming
+
+or if you are using Bundler, add this line to your Gemfile:
+
+    gem "jamming"
+    
+Usage
+---
+
+    File.open("/tmp/old_good_jimi.png", 'w') do |f|
+       chord = Jamming::Chord.new("0-7-6-7-8-x")
+       f.write chord.to_png(:label => "Em7#9")
+    end
+    
+This will write Em7#9, <em>The Jimi Hendrix Chord</em>, to <tt>tmp/old_good_jimi.png</tt>:
+
+![Em7#9 - The Jimi Hendrix Chord](https://github.com/andmej/jamming/raw/master/examples/Em7%239.png)
+
+Thanks
+---
+
+Some code based on [ander/chords](https://github.com/ander/chords), thanks!
+
+Contributing to jamming
+---
+ 
+* 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.
+* 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.
+
+Copyright
+---
+
+Copyright (c) 2010 Andrés Mejía. See LICENSE.txt for
+further details.
+
+Other important notes
+---
+
+You suck if you don't play guitar, kthxbai.

data/Rakefile

@@ -0,0 +1,54 @@
+# 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'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "jamming"
+  gem.homepage = "http://github.com/andmej@gmail.com/jamming"
+  gem.license = "MIT"
+  gem.summary = %Q{A Ruby library to generate images of guitar chords}
+  gem.description = %Q{A Ruby library to generate images of guitar chords}
+  gem.email = "andmej@gmail.com"
+  gem.authors = ["Andrés Mejía"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+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
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "jamming #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/jamming.rb

@@ -0,0 +1,2 @@
+require 'jamming/chord'
+require 'jamming/png_formatter'

data/lib/jamming/chord.rb

@@ -0,0 +1,23 @@
+require 'jamming/png_formatter'
+
+module Jamming
+  class Chord
+    attr_reader :frets
+    
+    def initialize(chord_as_string)
+      @frets = parse(chord_as_string)
+    end
+  
+    def to_png(options = {})
+      Jamming::PNGFormatter.new(frets).print(options)
+    end
+  
+    protected
+  
+    def parse(chord)
+      frets = chord.split(chord =~ /-/ ? "-" : "")
+      raise ArgumentError.new("'#{chord}' is not a valid chord expression.") unless frets.size == 6
+      frets.collect { |f| f =~ /[0-9]+/ ? f.to_i : nil }
+    end
+  end
+end

data/lib/jamming/png_formatter.rb

@@ -0,0 +1,108 @@
+require 'rvg/rvg' # rmagick's RVG (Ruby Vector Graphics) 
+
+module Jamming
+  Magick::RVG::dpi = 72
+  # Formats a single fingering as png data
+  class PNGFormatter
+
+    def initialize(frets)
+      @frets = frets
+      @strings = ["E", "A", "D", "G", "B", "e"]
+    end
+
+    def print(options={})
+      @label = options[:label]
+      
+      @max_fret = @frets.compact.max
+      @min_fret = @frets.compact.delete_if { |f| f == 0 }.min
+      @min_fret = 1 if @max_fret <= 4
+
+      @number_of_frets = [@max_fret - @min_fret + 1, 4].max
+      
+      get_png_data
+    end
+
+    private
+
+    def get_png_data
+      width = 400
+      height = 300
+      
+      rvg = Magick::RVG.new(280, 210).viewbox(0,0,width,height) do |canvas|
+        canvas.background_fill = 'white'
+        x_div = @strings.size - 1
+        
+        width_of_chord = 260
+        margin_side_of_chord = (width - width_of_chord) / 2
+
+        height_of_chord = 200
+        margin_top_of_chord = ((height - height_of_chord) * 2 / 3.0).floor
+        margin_bottom_of_chord = ((height - height_of_chord) / 3.0).ceil
+        
+        height_of_fret = height_of_chord / @number_of_frets
+        radius_of_finger = (height_of_fret * 0.6) / 2
+        
+        width_of_fret = width_of_chord / x_div
+
+        # Draw all horizontal lines
+        (@number_of_frets+1).times do |n|
+          canvas.line(margin_side_of_chord, n*height_of_fret+margin_top_of_chord, width - margin_side_of_chord, n*height_of_fret+margin_top_of_chord)
+        end
+        
+        (@number_of_frets).times do |i|
+          canvas.text(margin_side_of_chord - radius_of_finger - 4, i*height_of_fret+margin_top_of_chord + height_of_fret / 2 + 10) do |txt|
+            txt.tspan(@min_fret + i).styles(
+              :text_anchor => 'end',
+              :font_size => 24,
+              :font_family => 'helvetica',
+              :fill => 'black')
+          end
+        end
+
+        @strings.each_with_index do |note, i|
+          # Draw vertical lines
+          canvas.line(i*width_of_fret+margin_side_of_chord, margin_top_of_chord, i*width_of_fret+margin_side_of_chord, height - margin_bottom_of_chord)
+
+          
+          if [0,nil].include?(@frets[i])
+            # Add a text at the top. Either an X or O
+            canvas.text(i*width_of_fret+margin_side_of_chord, margin_top_of_chord - 6) do |txt| 
+              txt.tspan((@frets[i] == 0 ? "O" : 'X').to_s).styles(
+              :text_anchor => 'middle',
+              :font_size => 24, 
+              :font_family => 'helvetica',
+              :fill => 'black')
+            end            
+          else
+            # Add a finger
+            canvas.circle(radius_of_finger, i*width_of_fret+margin_side_of_chord,
+            (@frets[i] - @min_fret + 1)*height_of_fret - (height_of_fret / 2) + margin_top_of_chord)
+          end
+          
+          canvas.text(i*width_of_fret+margin_side_of_chord, height - margin_bottom_of_chord + 20) do |txt| 
+            txt.tspan(note).styles(:text_anchor => 'middle',
+            :font_size => 18, 
+            :font_family => 'helvetica',
+            :fill => 'black')
+          end
+        end
+        
+        if @label
+          canvas.text(width / 2, margin_top_of_chord / 2) do |txt|
+            txt.tspan(@label).styles(:text_anchor => 'middle',
+              :font_size => 36,
+              :font_family => 'helvetica',
+              :fill => 'black',
+              :font_weight => 'bold',
+            )
+          end
+        end
+
+      end
+      img = rvg.draw
+      img.format = 'PNG'
+      img.to_blob
+    end
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'jamming'
+
+class Test::Unit::TestCase
+end

data/test/test_jamming.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestJamming < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification 
+name: jamming
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Andr\xC3\xA9s Mej\xC3\xADa"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-20 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rmagick
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: A Ruby library to generate images of guitar chords
+email: andmej@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.markdown
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- examples/Em7#9.png
+- lib/jamming.rb
+- lib/jamming/chord.rb
+- lib/jamming/png_formatter.rb
+- test/helper.rb
+- test/test_jamming.rb
+has_rdoc: true
+homepage: http://github.com/andmej@gmail.com/jamming
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -2157425641403757243
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Ruby library to generate images of guitar chords
+test_files: 
+- test/helper.rb
+- test/test_jamming.rb