stringed 0.0.2 → 0.0.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stringed (0.0.1)
+    stringed (0.0.2)
       music (~> 0.6)
 
 GEM

data/README.md

@@ -18,8 +18,7 @@ Or install it yourself as:
 
 ## Usage
 
-    guitar = Stringed::Instrument.new(%w( E2 A2 D3 G3 B3 E4 ))
-    guitar.
+    See specs for usage.
 
 ## Contributing
 
@@ -27,4 +26,4 @@ Or install it yourself as:
 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
+5. Create new Pull Request. Please provide tests.

data/lib/stringed.rb

@@ -2,9 +2,9 @@ require "music"
 require "stringed/version"
 require "stringed/instrument"
 require "stringed/instrument_string"
+require "stringed/formatters"
 
 module Stringed
-  # Your code goes here...
 
   class Music::Note
     def name

data/lib/stringed/formatters.rb

@@ -0,0 +1,67 @@
+module Stringed
+
+  module Formatters
+
+    module ASCII
+      def self.fret_numbers(string)
+        fret_numbers = " "*(string.to_s.length)
+        string.frets.each{ |fret| fret_numbers << " "*6 << fret.to_s }
+        fret_numbers << "\n"
+      end
+    end
+
+    class ASCIIString
+      include ASCII
+
+      def initialize(string,options)
+        @selected_frets = options.fetch(:selected_frets,[])
+        @output = "#{string.to_s} |"
+        @string = string
+        @string.frets.each do |fret|
+          if @selected_frets.include?(fret) then
+            @output <<  "--x--|"
+          else
+            @output <<  "-----|"
+          end
+        end
+        @output << "\n"
+        @output << fret_numbers if options.has_key? :numbered_frets
+      end
+
+      def fret_numbers
+        ASCII.fret_numbers(@string)
+      end
+
+      def to_s
+        @output
+      end
+
+    end
+
+  class ASCIIInstrument
+    include ASCII
+
+    def initialize(instrument, options={})
+      @selected_frets = options.fetch(:selected_frets,[])
+      @output = ""
+      @instrument = instrument
+      @instrument.strings.each_with_index do |string,i|
+        selected_frets =  @selected_frets[i] ? @selected_frets[i] : []
+        @output << string.to(:ascii,selected_frets: selected_frets ).to_s
+      end
+      @output << fret_numbers if options.fetch(:numbered_frets,true)
+    end
+
+    def fret_numbers
+      ASCII.fret_numbers(@instrument.strings[@instrument.strings.map{|i| i.to_s.length}.each_with_index.max[1]])
+    end
+
+    def to_s
+      @output
+    end
+
+  end
+
+  end
+
+end

data/lib/stringed/instrument.rb

@@ -29,6 +29,13 @@ module Stringed
       fret_no >= 0 and fret_no <= fret_count
     end
 
+    def to(format,options={})
+      require "stringed/formatters"
+      if format == :ascii then
+        Formatters::ASCIIInstrument.new(self,options)
+      end
+    end
+
   end
 
 end

data/lib/stringed/instrument_string.rb

@@ -3,11 +3,12 @@ module Stringed
   class InstrumentString
     include Music
 
-    attr_reader :root_note, :fret_count
+    attr_reader :root_note, :fret_count, :frets
 
     def initialize(root_note, options={})
       @root_note = Music::Note.new(root_note.to_s)
       @fret_count = options.fetch(:fret_count,14)
+      @frets =* (1..@fret_count)
     end
 
     def fret_note(fret_no)
@@ -48,5 +49,12 @@ module Stringed
       matches.flatten.compact.sort
     end
 
+    def to(format,options={})
+      require "stringed/formatters"
+      if format == :ascii then
+        Formatters::ASCIIString.new(self,options)
+      end
+    end
+
   end
 end

data/lib/stringed/version.rb

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

data/spec/stringed/instrument_spec.rb

@@ -4,20 +4,20 @@ describe Stringed::Instrument do
 
   let(:guitar) { Stringed::Instrument.new(%w( E2 A2 D3 G3 B3 E4 ), fret_count: 20) }
 
-  it "should have strings" do
+  it "has strings" do
     guitar.strings.count.should == 6
   end
 
-  it "should have a fret count" do
+  it "has a fret count" do
     guitar.fret_count.should == 20
   end
 
-  it "should know where all the matches for a given note are" do
+  it "knows where all the matches for a given note are" do
     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
+  it "knows where all the matches for a given chord are" do
     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],
@@ -26,4 +26,26 @@ describe Stringed::Instrument do
                                                                    [0, 3, 8, 12, 15, 20]]
   end
 
+  describe "formatting"
+    context "ascii" do
+      let(:nano) { Stringed::Instrument.new(%w( C4 G4 ), fret_count: 6)}
+
+      it "can print an ascii fretboard" do
+        nano.to(:ascii).to_s.should eq <<-ASCII
+C4 |#{"-----|" * 6}
+G4 |#{"-----|" * 6}
+        1      2      3      4      5      6
+        ASCII
+      end
+
+      it "can print selected frets" do
+        nano.to(:ascii, selected_frets: [[1,4],[3]]).to_s.should eq <<-ASCII
+C4 |--x--|-----|-----|--x--|-----|-----|
+G4 |-----|-----|--x--|-----|-----|-----|
+        1      2      3      4      5      6
+        ASCII
+      end
+
+    end
+
 end

data/spec/stringed/instrument_string_spec.rb

@@ -40,4 +40,21 @@ describe InstrumentString do
     e2.find_chord(Chord.new(["D3","F#3","A3"])).should eq [2,5,10,14,17]
   end
 
+  context "formatting" do
+    let(:e2){ Stringed::InstrumentString.new('E2', { :fret_count => 6 } ) }
+
+    it "can produce an Ascii format" do
+      e2.to(:ascii).to_s.should eq "E2 " << "|-----" * 6 << "|\n"
+    end
+
+    it "can produce an Ascii format with selected notes" do
+      e2.to(:ascii, selected_frets: [2,5]).to_s.should eq "E2 |-----|--x--|-----|-----|--x--|-----|\n"
+    end
+
+    it "can number the frets" do
+      e2.to(:ascii, numbered_frets: true).to_s.should eq "E2 " << "|-----" * 6 << "|\n" << "        1      2      3      4      5      6\n"
+    end
+
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stringed
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-03 00:00:00.000000000 Z
+date: 2013-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: music
@@ -58,6 +58,7 @@ files:
 - README.md
 - Rakefile
 - lib/stringed.rb
+- lib/stringed/formatters.rb
 - lib/stringed/instrument.rb
 - lib/stringed/instrument_string.rb
 - lib/stringed/version.rb