stringed 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+*idea

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p194@stringed"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.14.2 ()" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stringed.gemspec
+gemspec
+
+gem 'music'
+
+group :development, :test do
+  gem "pry"
+end

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    stringed (0.0.1)
+      music (~> 0.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.11)
+      activesupport (= 3.2.11)
+      builder (~> 3.0.0)
+    activesupport (3.2.11)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.4)
+    coderay (1.0.8)
+    diff-lcs (1.1.3)
+    i18n (0.6.1)
+    method_source (0.8.1)
+    multi_json (1.5.0)
+    music (0.6.2)
+      activemodel (~> 3.2)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    slop (3.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  music
+  pry
+  rspec (~> 2.0)
+  stringed!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 pmacydna@gmail.com
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# Stringed
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'stringed'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stringed
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')

data/lib/stringed/instrument.rb

@@ -0,0 +1,38 @@
+module Stringed
+
+  class Instrument
+
+    attr_accessor :strings, :neck_length
+
+    def initialize(strings,neck_length)
+      @strings = strings.map{ |string| InstrumentString.new(string.to_s)}
+      @neck_length = neck_length
+    end
+
+    def matches(note)
+      matches = []
+      strings.each do |string|
+        matches << string.matches(note, {limit: @neck_length})
+      end
+      matches
+    end
+
+    def chord_matches(chord)
+      matches = []
+      strings.each do |string|
+        string_matches = []
+        chord.notes.each do |note|
+          string_matches << string.matches(note.name,{ limit: @neck_length })
+        end
+        matches << string_matches.flatten.compact.sort
+      end
+      matches
+    end
+
+    def in_range?(fret_no)
+      fret_no >= 0 and fret_no <= neck_length
+    end
+
+  end
+
+end

data/lib/stringed/instrument_string.rb

@@ -0,0 +1,44 @@
+module Stringed
+
+  class InstrumentString
+    include Music
+
+    attr_reader :root_note
+
+    def initialize(root_note)
+      @root_note = Music::Note.new(root_note.to_s)
+    end
+
+    def fret_note(fret_no)
+      fret_note = @root_note
+      fret_no.times{ fret_note = fret_note.next }
+      fret_note
+    end
+
+    def fret_no(fret_note)
+      Music::Note.note_distance(@root_note.to_s, fret_note.to_s)
+    end
+
+    def self.octave_up(fret_no)
+      fret_no + 12
+    end
+
+    def self.octave_down(fret_no)
+      fret_no - 12
+    end
+
+    def to_s
+      @root_note.to_s
+    end
+
+    def matches(note_name, options={})
+      limit = options.has_key?(:limit) ? options[:limit] : 20
+      matches = []
+      (0..limit).each do |fret|
+        matches.push fret if fret_note(fret).name == note_name
+      end
+      matches
+    end
+
+  end
+end

data/lib/stringed/version.rb

@@ -0,0 +1,3 @@
+module Stringed
+  VERSION = "0.0.1"
+end

data/lib/stringed.rb

@@ -0,0 +1,15 @@
+require "music"
+require "stringed/version"
+require "stringed/instrument"
+require "stringed/instrument_string"
+
+module Stringed
+  # Your code goes here...
+
+  class Music::Note
+    def name
+      self.to_s.delete(self.octave.to_s)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'pry'
+
+require File.dirname(__FILE__) + '/../lib/stringed.rb'
+
+include Stringed
+include Music
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end

data/spec/stringed/instrument_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Stringed::Instrument do
+
+  let(:guitar) { Stringed::Instrument.new(%w( E2 A2 D3 G3 B3 E4 ), 20) }
+
+  it "should have strings" do
+    guitar.strings.count.should == 6
+  end
+
+  it "should have a neck length" do
+    guitar.neck_length.should == 20
+  end
+
+  it "should know where all the matches for a given note are" do
+    guitar.matches('F').should eq [[1,13], [8,20], [3,15], [10], [6,18], [1,13]]
+    guitar.matches('D').should eq [[10], [5, 17], [0, 12], [7, 19], [3, 15], [10]]
+  end
+
+  it "should know where all the matches for a given chord are" do
+    guitar.chord_matches(Chord.new(['C4', 'E4', 'G4'])).should eq [[0, 3, 8, 12, 15, 20],
+                                                                   [3, 7, 10, 15, 19],
+                                                                   [2, 5, 10, 14, 17],
+                                                                   [0, 5, 9, 12, 17],
+                                                                   [1, 5, 8, 13, 17, 20],
+                                                                   [0, 3, 8, 12, 15, 20]]
+  end
+
+end

data/spec/stringed/instrument_string_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe InstrumentString do
+
+  let(:e2){ InstrumentString.new('E2')  }
+
+  context "InstrumentString#new" do
+    it { 
+      e2.root_note.should eq Note.new('E2') 
+    }
+    it { InstrumentString.new(Note.new('A2')).root_note.to_s.should eq 'A2' }
+  end
+
+  it "should know what note is at any fret" do
+    e2.fret_note(4).should eq Note.new('G#2')
+    e2.fret_note(5).should eq Note.new('A2' )
+  end
+
+  it "should know what fret to use for a pitch" do
+    e2.fret_no('G2').should eq 3
+    e2.fret_no('D#3').should eq 11
+  end
+
+  it "should know how the fret_no an octave up from any given fret_no" do
+    InstrumentString.octave_up(0).should == 12
+  end
+
+  it "should know how the fret_no an octave down from any given fret_no" do
+    InstrumentString.octave_down(12).should == 0
+  end
+
+  it { e2.to_s.should eq "E2" }
+
+  it "should know the matches for a note name" do
+    e2.matches("F", :limit => 20).should eq [1,13]
+    e2.matches("F", :limit => 30).should eq [1,13,25]
+  end
+
+  it "should know the matches for a chord"
+
+end

data/stringed.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stringed/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "stringed"
+  gem.version       = Stringed::VERSION
+  gem.authors       = ["andrewthomascampbell@gmail.com"]
+  gem.email         = ["andrewthomascampbell.com"]
+  gem.description   = %q{A library for Stringed instruments.}
+  gem.summary       = %q{Recognizes chords and notes for any stringed instrument and any tuning.}
+  gem.homepage      = "https://github.com/andycamp/stringed"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency 'music', '~> 0.6'
+  gem.add_development_dependency 'rspec', '~> 2.0'
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: stringed
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- andrewthomascampbell@gmail.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: music
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A library for Stringed instruments.
+email:
+- andrewthomascampbell.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stringed.rb
+- lib/stringed/instrument.rb
+- lib/stringed/instrument_string.rb
+- lib/stringed/version.rb
+- spec/spec_helper.rb
+- spec/stringed/instrument_spec.rb
+- spec/stringed/instrument_string_spec.rb
+- stringed.gemspec
+homepage: https://github.com/andycamp/stringed
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Recognizes chords and notes for any stringed instrument and any tuning.
+test_files:
+- spec/spec_helper.rb
+- spec/stringed/instrument_spec.rb
+- spec/stringed/instrument_string_spec.rb