fretboard_drawer 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in guitar_cli_drawer.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Michal Wrobel
+
+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,84 @@
+# FretboardDrawer
+
+Draw fretboard structure
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fretboard_drawer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fretboard_drawer
+
+## Usage
+
+```
+FretboardDrawer.number_of_frets = 6
+```
+
+```
+FretboardDrawer.draw
+```
+
+<pre>
+                3           5
+e|-----|-----|-----|-----|-----|-----|
+b|-----|-----|-----|-----|-----|-----|
+g|-----|-----|-----|-----|-----|-----|
+d|-----|-----|-----|-----|-----|-----|
+a|-----|-----|-----|-----|-----|-----|
+e|-----|-----|-----|-----|-----|-----|
+</pre>
+
+```
+sounds = { 1 => { 3 => "g" }, 6 => { 5 => "a" } }
+```
+
+```
+FretboardDrawer.draw(sounds)
+```
+
+<pre>
+                3           5
+e|-----|-----|--g--|-----|-----|-----|
+b|-----|-----|-----|-----|-----|-----|
+g|-----|-----|-----|-----|-----|-----|
+d|-----|-----|-----|-----|-----|-----|
+a|-----|-----|-----|-----|-----|-----|
+e|-----|-----|-----|-----|--a--|-----|
+</pre>
+
+## Config
+
+```
+  FretboardDrawer::Config.number_of_strings # 6
+```
+
+```
+  FretboardDrawer::Config.number_of_frets # 20
+```
+
+```
+  FretboardDrawer::Config.use_stdout # true
+```
+
+
+By default FretboardDrawer.draw use puts to draw to stdout, to disable it: 
+
+```
+FretboardDrawer::Config.use_stdout = false
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/fretboard_drawer.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/fretboard_drawer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Michal Wrobel"]
+  gem.email         = ["sparrovv@gmail.com"]
+  gem.description   = %q{Command line fretboard drawer}
+  gem.summary       = %q{Command line fretbarod drawer}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "fretboard_drawer"
+  gem.require_paths = ["lib"]
+  gem.version       = FretboardDrawer::VERSION
+  gem.add_development_dependency('rspec')
+end

data/lib/fretboard_drawer.rb

@@ -0,0 +1,62 @@
+require_relative "fretboard_drawer/version"
+require_relative "fretboard_drawer/fretboard"
+require_relative "fretboard_drawer/fretboard_string"
+
+module FretboardDrawer
+  STRINGS = ["e", "b", "g", "d", "a", "e"]
+
+  def self.draw(sounds={})
+    result = fretboard.result(sounds)
+    if Config.use_stdout
+      puts result
+    else
+      result
+    end
+  end
+
+  # reload @@fretboard if config was changed
+  def self.reload
+    @fretboard = nil
+  end
+
+  # this should be private
+  def self.fretboard
+    @fretboard ||=
+      FretboardDrawer::Fretboard.new(
+        Config.number_of_strings,
+        Config.number_of_frets
+    )
+  end
+
+  module Config
+    extend self
+
+    def number_of_strings
+      @number_of_strings || 6
+    end
+
+    def number_of_strings=(strings)
+      @number_of_strings = strings
+    end
+
+    def number_of_frets
+      @number_of_frets || 20
+    end
+
+    def number_of_frets=(frets)
+      @number_of_frets = frets
+    end
+
+    # if not set then true
+    def use_stdout
+      return true if @use_stdout.nil?
+
+      @use_stdout
+    end
+
+    # true / false
+    def use_stdout=(flag)
+      @use_stdout = flag
+    end
+  end
+end

data/lib/fretboard_drawer/fretboard.rb

@@ -0,0 +1,58 @@
+module FretboardDrawer
+  class Fretboard
+    attr_reader :strings, :frets
+
+    def initialize(strings, frets)
+      @strings = strings
+      @frets = frets
+    end
+
+    def result(sounds = {})
+      result = ""
+      result << frets_description << "\n"
+      result << build_strings(sounds)
+
+      result
+    end
+
+    def strings_structure(strings_sounds)
+      result = []
+      (1..@strings).each do |string_number|
+        sounds = strings_sounds[string_number] || {}
+        result << generate_string_structure(string_number, sounds)
+      end
+      result
+    end
+
+    private
+
+    def build_strings(sounds)
+      structure = strings_structure(sounds)
+      structure.inject("") do |r, string|
+        r << string.join() << "\n"
+        r
+      end
+    end
+
+    def frets_description
+      frets_desc_numbers = [3, 5, 7, 9, 12, 14]
+      result = ["  "]
+
+      @frets.times do |f|
+        if frets_desc_numbers.include?(f + 1)
+          result << "  #{f+1}   "
+        else
+          result << " " * 6
+        end
+      end
+      result.join()
+    end
+
+    def generate_string_structure(string_number, sounds_on_string)
+      sound = STRINGS[string_number - 1]
+      string = FretboardString.new(sound, @frets, sounds_on_string)
+      string.structure
+    end
+  end
+
+end

data/lib/fretboard_drawer/fretboard_string.rb

@@ -0,0 +1,43 @@
+module FretboardDrawer
+  class FretboardString
+    def initialize(sound, frets, sounds_on_frets={})
+      @sound = sound
+      @frets = frets
+      @sounds_on_frets = sounds_on_frets
+    end
+
+    def structure
+      head = "#{@sound}"
+      result = [head, "|"]
+
+      (1..@frets).each do |f|
+        if draw_on_fret?(f)
+          symbol = fret_symbol(f)
+          result << fret_symbol_part(symbol)
+        else
+          result << "-" * 5
+        end
+        result << "|"
+      end
+
+      result
+    end
+
+    private
+
+    def fret_symbol_part(symbol)
+      if symbol.size == 1
+        "--#{symbol}--"
+      else
+        "-#{symbol}--"
+      end
+    end
+    def fret_symbol(fret)
+      @sounds_on_frets[fret]
+    end
+
+    def draw_on_fret?(fret)
+      @sounds_on_frets.keys.include?(fret)
+    end
+  end
+end

data/lib/fretboard_drawer/version.rb

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

data/spec/fretboard_drawer/fretboard_drawer_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe FretboardDrawer do
+
+  let(:sounds) { {} }
+  let(:result) { "-----" }
+
+  describe ".draw" do
+    before do
+      FretboardDrawer::Fretboard.any_instance.
+        should_receive(:result).and_return(result)
+    end
+
+    it "draws to sdtout" do
+      $stdout.should_receive(:puts).with(result).and_return(true)
+
+      FretboardDrawer.draw
+    end
+  end
+
+  describe ".reload" do
+    it "reloads Fretboard instance and use proper config values" do
+      FretboardDrawer.reload
+
+      FretboardDrawer::Config.number_of_strings = 4
+      FretboardDrawer.fretboard.strings.should == 4
+
+      FretboardDrawer::Config.number_of_strings = 5
+      FretboardDrawer.fretboard.strings.should == 4
+
+      FretboardDrawer.reload
+
+      FretboardDrawer.fretboard.strings.should == 5
+    end
+  end
+
+  describe "Config" do
+    it "sets number of strings" do
+      FretboardDrawer::Config.number_of_strings = 4
+      FretboardDrawer::Config.number_of_strings.should == 4
+    end
+
+    it "sets number of frets" do
+      FretboardDrawer::Config.number_of_frets = 13
+      FretboardDrawer::Config.number_of_frets.should == 13
+    end
+  end
+end

data/spec/fretboard_drawer/fretboard_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe FretboardDrawer::Fretboard do
+
+  let(:strings_number) { 6 }
+  let(:frets_number) { 20 }
+
+  subject { FretboardDrawer::Fretboard.new(strings_number, frets_number) }
+
+  describe "#result" do
+    context "when no sounds to draw" do
+      let(:frets_number) { 10 }
+
+      it "returns string" do
+        expected = "                3           5           7           9         \n"
+        expected << "e|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|\n"
+        expected << "b|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|\n"
+        expected << "g|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|\n"
+        expected << "d|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|\n"
+        expected << "a|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|\n"
+        expected << "e|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|\n"
+
+        subject.result.should == expected
+      end
+    end
+
+    context "when there are sounds to draw" do
+      let(:frets_number) { 10 }
+      let(:sounds) do
+        { 1 => { 2 => "f#", 9 => "c#"}, 6 => { 1 => "f" } }
+      end
+
+      it "returns string" do
+        expected = "                3           5           7           9         \n"
+        expected << "e|-----|-f#--|-----|-----|-----|-----|-----|-----|-c#--|-----|\n"
+        expected << "b|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|\n"
+        expected << "g|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|\n"
+        expected << "d|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|\n"
+        expected << "a|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|\n"
+        expected << "e|--f--|-----|-----|-----|-----|-----|-----|-----|-----|-----|\n"
+
+        subject.result(sounds).should == expected
+      end
+    end
+  end
+
+  describe "#strings_structure" do
+    context "when no sounds" do
+      let(:sounds) { {} }
+      it "generates strings structure" do
+        structure = subject.strings_structure(sounds)
+        structure.size.should == strings_number
+      end
+    end
+  end
+
+end

data/spec/fretboard_drawer/fretboard_string_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe FretboardDrawer::FretboardString do
+
+  let(:sounds) { {} }
+  subject { FretboardDrawer::FretboardString.new("e", 2, sounds) }
+
+  describe "#structure" do
+    context "when no sounds" do
+
+      it "generate structure of string" do
+        subject.structure.should == ["e", "|", "-"*5, '|', "-"*5, '|']
+      end
+
+    end
+
+    context "when there is one sound" do
+      let(:sounds) {  { 1 => "o" } }
+
+      it "generate structure of string" do
+        subject.structure.should == ["e", "|", "--o--", '|', "-"*5, '|']
+      end
+
+    end
+
+    context "when there is 2 sound" do
+      let(:sounds) {  { 1 => "o", 2 => "d#" } }
+
+      it "generate structure of string" do
+        subject.structure.should == ["e", "|", "--o--", '|', "-d#--", '|']
+      end
+
+    end
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'rspec'
+
+require File.expand_path('../../lib/fretboard_drawer', __FILE__)
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: fretboard_drawer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michal Wrobel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70248779197700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70248779197700
+description: Command line fretboard drawer
+email:
+- sparrovv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fretboard_drawer.gemspec
+- lib/fretboard_drawer.rb
+- lib/fretboard_drawer/fretboard.rb
+- lib/fretboard_drawer/fretboard_string.rb
+- lib/fretboard_drawer/version.rb
+- spec/fretboard_drawer/fretboard_drawer_spec.rb
+- spec/fretboard_drawer/fretboard_spec.rb
+- spec/fretboard_drawer/fretboard_string_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.10
+signing_key: 
+specification_version: 3
+summary: Command line fretbarod drawer
+test_files:
+- spec/fretboard_drawer/fretboard_drawer_spec.rb
+- spec/fretboard_drawer/fretboard_spec.rb
+- spec/fretboard_drawer/fretboard_string_spec.rb
+- spec/spec_helper.rb
+has_rdoc: