anchord 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da0eac170f371b10085e127d047add833bf3bb2f
+  data.tar.gz: d8a0d2f4cab96bbb511de056f536b3577e6e2828
+SHA512:
+  metadata.gz: ecea87554eabcf14630223e9d3f732cd3034f40baf4b600586129c899ef507e21e19bca8661c8951654b3fc2489bf5433c4b3bbe5126794a23b18d70ea635136
+  data.tar.gz: 14fbcd7561dae6324d8f2cb1c7ecc30b6be67b2fcc988223f504ffda9d45b1451642f1d06a5f30cbd11be618be301c6d5e311ea54c6b241426a8922c7840d68a

data/.editorconfig

@@ -0,0 +1,36 @@
+# EditorConfig is awesome: http://EditorConfig.org
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+# 4 space indentation
+[*.py]
+indent_style = space
+indent_size = 4
+
+[*.js]
+indent_style = space
+indent_size = 4
+
+[*.rb]
+indent_style = space
+indent_size = 2
+
+[*.haml]
+indent_style = space
+indent_size = 2
+
+[*.scss]
+indent_style = space
+indent_size = 4
+
+# Indentation override for all JS under lib directory
+[lib/**.js]
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ejay Canaria
+
+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,48 @@
+# Anchord
+
+The geekiest way to print guitar chords. Simple and just works.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'anchord'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install anchord
+
+## Usage
+
+1. Include Anchord in your ruby file: `require 'anchord'`
+2. Use `Anchord.play [chord_symbol]` to play a chord: `Anchord.play :G`
+
+### Usage on IRB
+1. Include Anchord upon running IRB: `irb -Ilib -r anchord`
+2. Use `Anchord.play [chord_symbol]` to play a chord: `Anchord.play :G`
+
+## Contributing
+
+1. Fork it ( https://github.com/ejaypcanaria/anchord/fork )
+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 a new Pull Request
+
+### Adding additional chords to the library
+
+1. Create a file that ends with `_chords.rb` and put it under `lib/achord/chords` directory.
+2. Add a chord using the following DSL:
+
+```
+add_chord do
+	name 			"chord name"
+	coordinate 		[1,2,3,4,5,6] # Finger position with the following string format: E A D G B e
+end
+```

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+task :spec do
+  system 'rspec --color --format documentation'
+end

data/anchord.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'anchord/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "anchord"
+  spec.version       = Anchord::VERSION
+  spec.authors       = ["Ejay Canaria"]
+  spec.email         = ["ejaypcanaria@gmail.com"]
+  spec.summary       = %q{Simple guitar chord generator library for Ruby.}
+  spec.description   = %q{The simpliest way to turn letters into human readable guitar chords.}
+  spec.homepage      = "http://github.com/ejaypcanaria/anchord"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/anchord.rb

@@ -0,0 +1,34 @@
+Dir[File.dirname(__FILE__) + '/anchord/**/*.rb']
+  .reject{|f| f[File.dirname(__FILE__) + '/anchord/chords']}
+  .each {|file| require file }
+
+module Anchord
+  class << self
+    attr_writer :library, :tuning
+
+    def library
+      @library ||= Library.load_from_chord_files
+    end
+
+    def chord(tuning=Anchord.tuning, &block)
+      Chord.new(tuning, &block)
+    end
+
+    def tuning
+      @tuning ||= Tuning.standard
+    end
+
+    def play(chord_sym)
+      chord = library[chord_sym]
+      unless chord
+        puts "We cannot find the chord '#{chord_sym}' in our chord library."
+      else
+        puts Anchord::Fretboard.play_as_tab chord
+      end
+    end
+
+    def chord_files
+      Dir[File.dirname(__FILE__) + '/anchord/chords/**/*_chords.rb']
+    end
+  end
+end

data/lib/anchord/chord.rb

@@ -0,0 +1,37 @@
+module Anchord
+	class Chord
+
+    attr_accessor :tuning
+
+    def initialize(tuning, &block)
+      instance_eval(&block)
+      @tuning = tuning
+      @symbol = name.to_sym unless @symbol
+      define_strings
+    end
+
+    def name(val=nil)
+      @name ||= val
+    end
+
+    def symbol(val=nil)
+      @symbol ||= val
+    end
+
+    def coordinates(val=nil)
+      @coordinates ||= val
+    end
+
+    private
+
+    def define_strings
+      Anchord.tuning.each_with_index do |tune, position|
+        method_name = "#{tune}_string".to_sym
+        Chord.send(:define_method, method_name) do
+          @coordinates[position]
+        end
+        Chord.send(:alias_method, "play_#{tune}".to_sym,method_name)
+      end
+    end
+	end
+end

data/lib/anchord/chords/g_chords.rb

@@ -0,0 +1,15 @@
+add_chord do
+  name          "G"
+  coordinates   [3, 2, 0, 0, 3, 3]
+end
+
+add_chord do
+  name          "G Minor"
+  symbol        :Gm
+  coordinates   [3, 5, 5, 3, 3, 3]
+end
+
+add_chord do
+  name          "G7"
+  coordinates   [3, 2, 0, 0, 0, 1]
+end

data/lib/anchord/fretboard.rb

@@ -0,0 +1,12 @@
+module Anchord
+  class Fretboard
+    class << self
+      def play_as_tab(chord)
+        chord.tuning.reverse.inject("") do |output, tune|
+          plot = chord.send("play_#{tune}")
+          output << "#{tune} |-#{plot}-|\n"
+        end.chomp
+      end
+    end
+  end
+end

data/lib/anchord/library.rb

@@ -0,0 +1,41 @@
+module Anchord
+  class Library
+
+    def initialize(chords=[])
+      @chords_hash = {}
+      populate_chords_hash unless chords.empty?
+    end
+
+    def add_chord(tuning=Anchord.tuning, &block)
+      chord = Chord.new(tuning, &block)
+      @chords_hash[chord.symbol] = chord
+      chord
+    end
+
+    def [](key)
+      @chords_hash[key]
+    end
+
+    def chords
+      @chords_hash.values
+    end
+
+    private
+
+      def populate_chords_hash
+        chords.inject(@chords_hash) do |chords_hash, chord|
+          chords_hash[chord.symbol] = chord
+        end
+      end
+
+    class << self
+      def load_from_chord_files(chord_files=Anchord.chord_files, reader=File)
+        lib_instance = new
+        chord_files.each do |chord_file|
+          lib_instance.instance_eval(reader.read(chord_file))
+        end
+        lib_instance
+      end
+    end
+  end
+end

data/lib/anchord/tuning.rb

@@ -0,0 +1,14 @@
+module Anchord
+  module Tuning
+    TUNES = {
+      standard:   [:E,  :A, :D, :G, :b, :e],
+      half_step:  [:Eb, :Ab, :Db, :Gb, :bb, :eb]
+    }
+
+    TUNES.keys.each do |key|
+      define_singleton_method(key) do
+        TUNES[key]
+      end
+    end
+  end
+end

data/lib/anchord/version.rb

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

data/spec/anchord_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Anchord do
+  let(:chord) do
+    Anchord.chord do
+      name        "G"
+      coordinates [3, 2, 0, 0, 3, 3]
+    end
+  end
+
+  describe ".chord" do
+    it "creates a chord object" do
+      expect(chord).to be_a Anchord::Chord
+      expect(chord.name).to eq "G"
+      expect(chord.coordinates).to eq [3, 2, 0, 0, 3, 3]
+    end
+  end
+end

data/spec/chord_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Anchord::Chord do
+
+  let(:chord) do
+    Anchord.chord do
+      name "G"
+      coordinates [3, 2, 0, 0, 3, 3]
+    end
+  end
+
+  it "has fretboard string tuning as methods" do
+    expected_methods = chord.tuning.map {|string| ["#{string}_string".to_sym, "play_#{string}".to_sym] }
+    expect(chord.methods).to include *(expected_methods.flatten)
+  end
+
+  context "when symbol is not given" do
+    it "converts the name of the chord to symbol" do
+      expect(chord.symbol).to eq :G
+    end
+  end
+
+end

data/spec/fretboard_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Anchord::Fretboard do
+
+  let(:g_chord) do
+    Anchord.chord do
+      name "G"
+      coordinates [3, 2, 0, 0, 3, 3]
+    end
+  end
+
+  describe '.play' do
+    it "plays the chord in a chord chart format"
+    # do
+    #   chord_chart_format = "e |---|---|-*-|---|---|---|\n"\
+    #                        "b |---|---|-*-|---|---|---|\n"\
+    #                        "G |---|---|---|---|---|---|\n"\
+    #                        "D |---|---|---|---|---|---|\n"\
+    #                        "A |---|-*-|---|---|---|---|\n"\
+    #                        "E |---|---|-*-|---|---|---|"
+
+    #   expect(Anchord::Fretboard.play(g_chord)).to eq chord_chart_format
+    # end
+  end
+
+  describe '.play_as_tab' do
+    it "plays the chord in tab format" do
+      tab_format = "e |-3-|\n"\
+                   "b |-3-|\n"\
+                   "G |-0-|\n"\
+                   "D |-0-|\n"\
+                   "A |-2-|\n"\
+                   "E |-3-|"
+      expect(Anchord::Fretboard.play_as_tab(g_chord)).to eq tab_format
+    end
+  end
+end

data/spec/library_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Anchord::Library do
+
+  before :each do
+    chord_files = ['tmp/e_chords.rb']
+    reader = double('File',
+                basename: 'e_chords.rb',
+                read: %q{
+                  add_chord do
+                    name        "E"
+                    coordinates [0, 2, 2, 1, 0, 0]
+                  end
+                  })
+    Anchord.library = Anchord::Library.load_from_chord_files(chord_files, reader)
+  end
+
+  describe "#add_chord" do
+    it "adds the chord to the chord library" do
+      Anchord::library
+      chord = Anchord::library.add_chord do
+        name "G"
+        coordinates [3, 2, 0, 0, 3, 3]
+      end
+
+      expect(Anchord.library.chords).to include chord
+    end
+  end
+
+  describe ".load_from_chord_files" do
+    it "reads a chord file and adds it to the library" do
+      expect(Anchord.library.chords.first.name).to eq "E"
+    end
+  end
+
+  describe ".[]" do
+    it "access the chords array inside the library using chord symbol as a key" do
+      expect(Anchord.library[:E]).to eq Anchord.library.chords.find {|chord| chord.symbol == :E}
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'anchord'

data/spec/tuning_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Anchord::Tuning do
+
+  it "has tuning methods" do
+    expect(Anchord::Tuning.methods(false)).to include *Anchord::Tuning::TUNES.keys
+  end
+
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: anchord
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ejay Canaria
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: The simpliest way to turn letters into human readable guitar chords.
+email:
+- ejaypcanaria@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- anchord.gemspec
+- lib/anchord.rb
+- lib/anchord/chord.rb
+- lib/anchord/chords/g_chords.rb
+- lib/anchord/fretboard.rb
+- lib/anchord/library.rb
+- lib/anchord/tuning.rb
+- lib/anchord/version.rb
+- spec/anchord_spec.rb
+- spec/chord_spec.rb
+- spec/fretboard_spec.rb
+- spec/library_spec.rb
+- spec/spec_helper.rb
+- spec/tuning_spec.rb
+homepage: http://github.com/ejaypcanaria/anchord
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple guitar chord generator library for Ruby.
+test_files:
+- spec/anchord_spec.rb
+- spec/chord_spec.rb
+- spec/fretboard_spec.rb
+- spec/library_spec.rb
+- spec/spec_helper.rb
+- spec/tuning_spec.rb