stringed 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,6 @@
 # Stringed
 
-TODO: Write a gem description
+A library for Stringed instruments. Recognizes chords and notes for any stringed instrument.
 
 ## Installation
 
@@ -18,7 +18,8 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    guitar = Stringed::Instrument.new(%w( E2 A2 D3 G3 B3 E4 ))
+    guitar.
 
 ## Contributing
 

data/lib/stringed/instrument.rb

@@ -2,35 +2,31 @@ module Stringed
 
   class Instrument
 
-    attr_accessor :strings, :neck_length
+    attr_accessor :strings, :fret_count
 
-    def initialize(strings,neck_length)
-      @strings = strings.map{ |string| InstrumentString.new(string.to_s)}
-      @neck_length = neck_length
+    def initialize(strings,options={})
+      @strings = strings.map{ |string| InstrumentString.new(string.to_s, options)}
+      @fret_count = options.fetch(:fret_count,14)
     end
 
-    def matches(note)
+    def find(note)
       matches = []
       strings.each do |string|
-        matches << string.matches(note, {limit: @neck_length})
+        matches << string.find(note)
       end
       matches
     end
 
-    def chord_matches(chord)
+    def find_chord(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
+        matches << string.find_chord(chord)
       end
       matches
     end
 
     def in_range?(fret_no)
-      fret_no >= 0 and fret_no <= neck_length
+      fret_no >= 0 and fret_no <= fret_count
     end
 
   end

data/lib/stringed/instrument_string.rb

@@ -3,10 +3,11 @@ module Stringed
   class InstrumentString
     include Music
 
-    attr_reader :root_note
+    attr_reader :root_note, :fret_count
 
-    def initialize(root_note)
+    def initialize(root_note, options={})
       @root_note = Music::Note.new(root_note.to_s)
+      @fret_count = options.fetch(:fret_count,14)
     end
 
     def fret_note(fret_no)
@@ -31,14 +32,21 @@ module Stringed
       @root_note.to_s
     end
 
-    def matches(note_name, options={})
-      limit = options.has_key?(:limit) ? options[:limit] : 20
+    def find(note_name)
       matches = []
-      (0..limit).each do |fret|
+      (0..(fret_count)).each do |fret|
         matches.push fret if fret_note(fret).name == note_name
       end
       matches
     end
 
+    def find_chord(chord)
+      matches = []
+      chord.notes.each do |note|
+        matches << find(note.name)
+      end
+      matches.flatten.compact.sort
+    end
+
   end
 end

data/lib/stringed/version.rb

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

data/spec/stringed/instrument_spec.rb

@@ -2,23 +2,23 @@ require 'spec_helper'
 
 describe Stringed::Instrument do
 
-  let(:guitar) { Stringed::Instrument.new(%w( E2 A2 D3 G3 B3 E4 ), 20) }
+  let(:guitar) { Stringed::Instrument.new(%w( E2 A2 D3 G3 B3 E4 ), fret_count: 20) }
 
   it "should have strings" do
     guitar.strings.count.should == 6
   end
 
-  it "should have a neck length" do
-    guitar.neck_length.should == 20
+  it "should have a fret count" do
+    guitar.fret_count.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]]
+    guitar.find('F').should eq [[1,13], [8,20], [3,15], [10], [6,18], [1,13]]
+    guitar.find('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],
+    guitar.find_chord(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],

data/spec/stringed/instrument_string_spec.rb

@@ -2,40 +2,42 @@ require 'spec_helper'
 
 describe InstrumentString do
 
-  let(:e2){ InstrumentString.new('E2')  }
+  let(:e2){ InstrumentString.new('E2', :fret_count => 20)  }
 
-  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' }
+  it "should have a root note" do
+    e2.root_note.should eq Note.new('E2')
   end
 
-  it "should know what note is at any fret" do
+  it "should have a fret_count" do
+    e2.fret_count.should eq 20
+  end
+
+  it "should know the note 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
+  it "should know the fret no of a given note" do
     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
+  it "should know an octave up from a given fret" do
+    InstrumentString.octave_up(2).should == 14
   end
 
-  it "should know how the fret_no an octave down from any given fret_no" do
-    InstrumentString.octave_down(12).should == 0
+  it "should know an octave down from a given fret" do
+    InstrumentString.octave_down(14).should == 2
   end
 
-  it { e2.to_s.should eq "E2" }
+  it "should know to_s" do
+    e2.to_s.should eq "E2"
+  end
 
-  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]
+  it "should be able to find a note" do
+    e2.find("F").should eq [1,13]
   end
 
-  it "should know the matches for a chord"
+  it "should be able to find a chord" do
+    e2.find_chord(Chord.new(["D3","F#3","A3"])).should eq [2,5,10,14,17]
+  end
 
 end

data/stringed.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
   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.summary       = %q{Recognizes chords and notes for any stringed instrument.}
   gem.homepage      = "https://github.com/andycamp/stringed"
 
   gem.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stringed
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -88,7 +88,7 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Recognizes chords and notes for any stringed instrument and any tuning.
+summary: Recognizes chords and notes for any stringed instrument.
 test_files:
 - spec/spec_helper.rb
 - spec/stringed/instrument_spec.rb