uke 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8871351a22290ca9b4d067e90e823ccb1e47854b
+  data.tar.gz: 41d03d9d191759de0aba43e6b504538f94d4a242
+SHA512:
+  metadata.gz: 46a8e567cb15b1753306e90d8ec8e7df2355f3750a77e4655fa3b607702a52aed908382f8df04f181b627295be5490cf40fc75d24ab4a15a92b07e5237048919
+  data.tar.gz: 50b6816c7eeff4e7e0d83c5e7b6e27b60d9ddb54eac2ff469baf742d0b00bb11b1e97d591936984083706847f6645719b6509d5e4585a342db3d1ee789ab0923

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## CHANGELOG
+
+### 1.0.0
+
+* Inital release
+

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'minitest'

data/MIT-LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Jan Lelis, mail@janlelis.de
+
+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,76 @@
+# uke gem [![[version]](https://badge.fury.io/rb/uke.svg)](http://badge.fury.io/rb/uke)
+
+Displays popular ukulele chords for the popular `GCEA` tuning like this:
+
+```
+$ uke-chords G B7 C Cm
+           
+             ⚪                     
+             ╒══╤══╤══╕  ╒══╤══╤══╕
+     _____   │  │  │  │  │  │  │  │
+    / ____|  ├──┼──┼──┤  ├──┼──┼──┤
+   | |  __   │  ●  │  ●  │  ●  │  ●
+   | | |_ |  ├──┼──┼──┤  ├──┼──┼──┤
+   | |__| |  │  │  ●  │  │  │  ●  │
+    \_____|  ├──┼──┼──┤  ├──┼──┼──┤
+             │  │  │  │  ●  │  │  │
+             └──┴──┴──┘  └──┴──┴──┘
+           
+                
+                                        ⚪
+                   ╒══╤══╤══╕  ╒══╤══╤══╕
+    ____ ______    │  │  │  │  │  │  │  │
+   |  _ \____  |   ├──┼──┼──┤  ├──┼──┼──┤
+   | |_) |  / /    ●  │  ●  ●  │  │  ●  │
+   |  _ <  / /     ├──┼──┼──┤  ├──┼──┼──┤
+   | |_) |/ /      │  ●  │  │  │  ●  │  │
+   |____//_/       ├──┼──┼──┤  ├──┼──┼──┤
+                   │  │  │  │  ●  │  │  │
+                   └──┴──┴──┘  └──┴──┴──┘
+                
+           
+             ⚪  ⚪  ⚪     ⚪     ⚪     ⚪         
+             ╒══╤══╤══╕  ╒══╤══╤══╕  ╒══╤══╤══╕
+     _____   │  │  │  │  │  │  │  │  │  │  │  │
+    / ____|  ├──┼──┼──┤  ├──┼──┼──┤  ├──┼──┼──┤
+   | |       │  │  │  │  │  │  │  │  │  │  │  │
+   | |       ├──┼──┼──┤  ├──┼──┼──┤  ├──┼──┼──┤
+   | |____   │  │  │  ●  │  │  │  ●  │  │  ●  ●
+    \_____|  ├──┼──┼──┤  ├──┼──┼──┤  ├──┼──┼──┤
+             │  │  │  │  │  ●  │  │  │  ●  │  │
+             └──┴──┴──┘  └──┴──┴──┘  └──┴──┴──┘
+           
+                     
+                       ⚪         
+                       ╒══╤══╤══╕
+     _____             │  │  │  │
+    / ____|            ├──┼──┼──┤
+   | |     _ __ ___    │  │  │  │
+   | |    | '_ ` _ \   ├──┼──┼──┤
+   | |____| | | | | |  │  ●  ●  ●
+    \_____|_| |_| |_|  ├──┼──┼──┤
+                       │  │  │  │
+                       └──┴──┴──┘
+
+```
+
+## Setup
+
+Make sure that your computer has [Ruby 2.0 or higher installed](http://ruby.about.com/od/tutorials/a/installruby.htm).
+
+Then run
+
+```ruby
+gem install uke
+```
+
+## Usage
+
+On the command-line, run `uke-chords`, followed by the chords you want to display (see the example at top).
+
+Run `uke-chords` without any parameters for a list of included chords.
+
+## MIT License
+
+Except for the chords, copyright (C) 2015 Jan Lelis <http://janlelis.com>. Released under the MIT license.
+

data/Rakefile

@@ -0,0 +1,30 @@
+# # #
+# Get gemspec info
+
+gemspec_file = Dir['*.gemspec'].first 
+gemspec = eval File.read(gemspec_file), binding, gemspec_file
+info = "#{gemspec.name} | #{gemspec.version} | " \
+       "#{gemspec.runtime_dependencies.size} dependencies | " \
+       "#{gemspec.files.size} files"
+
+
+# # #
+# Gem build and install task
+
+desc info
+task :gem do
+  puts info + "\n\n"
+  print "  "; sh "gem build #{gemspec_file}"
+  FileUtils.mkdir_p 'pkg'
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+  puts; sh %{gem install --no-document pkg/#{gemspec.name}-#{gemspec.version}.gem}
+end
+
+
+# # #
+# Start an IRB session with the gem loaded
+
+desc "#{gemspec.name} | IRB"
+task :irb do
+  sh "irb -I ./lib -r #{gemspec.name.gsub '-','/'}"
+end

data/bin/uke-chords

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+#require 'uke'
+require_relative '../lib/uke'
+require 'rationalist'
+
+args = Rationalist.parse(
+  boolean: [:help, :version],
+  string: [:style],
+  default: { style: :small },
+  alias: { s: :style, v: :version }
+)
+
+case
+when args[:v]
+  $stderr.puts Uke::VERSION
+when args[:help]
+  puts <<BANNER
+
+ DESCRIPTION
+
+    Displays popular ukulele chords
+
+ USAGE
+
+    Pass the chords to display as arguments
+
+    Run without arguments for a list of included chords
+
+ EXAMPLE
+
+    uke-chords G B7 C Cm
+
+BANNER
+when args[:_].empty?
+  Uke.new.print_chord_list
+else
+  Uke.new.print_chords args[:_], args[:style]
+end

data/lib/uke.rb

@@ -0,0 +1,39 @@
+require 'artii'
+
+require_relative "uke/version"
+require_relative "uke/chords"
+require_relative "uke/fretboard"
+
+class Uke
+  def print_chord_list
+    puts Uke::CHORDS.keys.join " "
+  end
+
+  def print_chords(which, style = nil)
+    Array(which).each{ |chord_name|
+      chords = CHORDS[chord_name]
+      if !chords.empty?
+        puts chords.reduce(
+          chord_name_to_ascii_lines(chord_name)
+        ){ |old_lines, chord|
+          old_lines.zip(Fretboard.new(chord, style).lines).map(&:join)
+        }.join($/)
+      else
+        $stderr.puts "\n   #{chord_name} not found"
+      end
+    }
+  end
+
+  private
+
+  def chord_name_to_ascii_lines(chord)
+    a = Artii::Base.new# font: 'roman'
+    res = [" ", " ", " "]
+    res += a.asciify(chord).split($/)
+    res += [" "]
+
+    max = res.max_by(&:size).size
+
+    res.map{ |l| "  " + l.ljust(max) }
+  end
+end

data/lib/uke/chords.rb

@@ -0,0 +1,195 @@
+class Uke
+  CHORDS_RAW = <<CHORDS_RAW # stolen from https://github.com/zimolzak/ukulele/blob/master/lotsachords.txt
+A   2,1,0,0
+A   2,1,0,4
+A   2,4,0,4
+A#    3,2,1,1
+A 5   2,4,0,0
+A 7   0,1,0,0
+A# 7  1,2,1,1
+A 7   2,4,3,4
+A 7sus  0,2,0,0
+A# 7sus   1,3,1,1
+A 9   2,1,0,2
+A# 9  3,2,1,3
+A 9   4,1,0,0
+A aug   2,1,1,0
+A aug   2,1,1,4
+A# aug  3,2,2,1
+A# dim  3,1,0,1
+A# dim  3,1,0,4
+A# dim  3,4,0,4
+A# dim7   0,1,0,1
+A dim7  2,3,2,3
+A# dim7   3,4,3,4
+A m   2,0,0,0
+A m   2,0,0,3
+A m   2,4,0,3
+A# m  3,1,1,1
+A# m  3,1,1,4
+A m7  0,0,0,0
+A# m7   1,1,1,1
+A m7  2,4,3,3
+A# m7b5   1,1,0,1
+A m7b5  2,3,3,3
+A# m7b5   3,4,4,4
+A maj7  1,1,0,0
+A# maj7   2,2,1,1
+A maj7  2,4,4,4
+A# maj7   3,2,1,0
+A sus   2,2,0,0
+A# sus  3,3,1,1
+B   4,3,2,2
+B 7   2,3,2,2
+B 7   4,3,2,0
+B 7sus  2,4,2,2
+B 7sus  4,4,2,0
+B 9   4,3,2,4
+B aug   0,3,3,2
+B aug   4,3,3,2
+B dim   4,2,1,2
+B dim7  1,2,1,2
+B m   4,2,2,2
+B m7  2,2,2,2
+B m7  4,2,2,0
+B m7b5  2,2,1,2
+B m7b5  4,2,1,0
+B maj7  3,3,2,2
+B maj7  4,3,2,1
+B sus   4,4,2,2
+C   0,0,0,3
+C   0,4,0,3
+C   0,4,3,3
+C#    1,1,1,4
+C 5   0,0,3,3
+C# 5  1,1,4,4
+C 7   0,0,0,1
+C# 7  1,1,1,2
+C 7   3,4,3,3
+C 7sus  0,0,1,1
+C# 7sus   1,1,2,2
+C 9   0,2,0,3
+C# 9  1,3,1,4
+C aug   1,0,0,3
+C aug   1,4,0,3
+C aug   1,4,4,3
+C# dim  0,1,0,4
+C# dim  0,4,0,4
+C# dim  0,4,3,4
+C m   0,3,3,3
+C# m  1,1,0,4
+C# m  1,4,0,4
+C# m  1,4,4,4
+C# m7   1,1,0,2
+C m7  3,3,3,3
+C# m7   4,4,4,4
+C# m7b5   0,1,0,2
+C m7b5  3,3,2,3
+C# m7b5   4,4,3,4
+C maj7  0,0,0,2
+C# maj7   1,0,1,4
+C# maj7   1,1,1,3
+C maj7  4,4,3,3
+C sus   0,0,1,3
+C# sus  1,1,2,4
+D#    0,3,3,1
+D   2,2,2,0
+D#    3,3,3,1
+D 7   2,2,2,3
+D# 7  3,3,3,4
+D 7sus  2,2,3,3
+D# 7sus   3,3,4,4
+D# 9  0,3,1,1
+D# dim  2,3,2,0
+D m   2,2,1,0
+D# m  3,3,2,1
+D m7  2,2,1,3
+D# m7   3,3,2,4
+D m7b5  1,2,1,3
+D# m7b5   2,3,2,4
+D maj7  2,2,2,4
+D sus   0,2,3,0
+D# sus  1,3,4,1
+D sus   2,2,3,0
+D# sus  3,3,4,1
+E   1,4,0,2
+E   1,4,4,2
+E   4,4,4,2
+E 5   4,4,0,2
+E 7   1,2,0,2
+E 7sus  2,2,0,2
+E 7sus  4,2,0,0
+E 9   1,4,2,2
+E dim   0,4,0,1
+E dim   0,4,3,1
+E dim   3,4,3,1
+E m   0,4,0,2
+E m   0,4,3,2
+E m   4,4,3,2
+E m7  0,2,0,2
+E m7b5  0,2,0,1
+E maj7  1,3,0,2
+E sus   2,4,0,2
+E sus   4,4,0,0
+F   2,0,1,0
+F   2,0,1,3
+F#    3,1,2,1
+F#    3,1,2,4
+F 7   2,3,1,3
+F# 7  3,4,2,4
+F 7sus  3,3,1,3
+F# 7sus   4,4,2,4
+F 9   0,0,1,0
+F# 9  1,1,2,1
+F# dim  2,0,2,0
+F# dim  2,0,2,3
+F m   1,0,1,3
+F# m  2,1,2,0
+F# m  2,1,2,4
+F m7  1,3,1,3
+F# m7   2,4,2,4
+F m7b5  1,3,1,2
+F# m7b5   2,4,2,3
+F maj7  2,4,1,3
+F sus   3,0,1,1
+F sus   3,0,1,3
+F# sus  4,1,2,2
+F# sus  4,1,2,4
+G   0,2,3,2
+G#    1,3,4,3
+G   4,2,3,2
+G 7   0,2,1,2
+G# 7  1,3,2,3
+G 7sus  0,2,1,3
+G# 7sus   1,3,2,4
+G 9   2,2,3,2
+G# 9  3,3,4,3
+G 9   4,2,3,0
+G dim   0,1,3,1
+G# dim  1,2,4,2
+G dim   3,1,3,1
+G dim   3,1,3,4
+G# dim  4,2,4,2
+G m   0,2,3,1
+G# m  1,3,4,2
+G m   3,2,3,1
+G# m  4,3,4,2
+G m7  0,2,1,1
+G# m7   1,3,2,2
+G m7b5  0,1,1,1
+G# m7b5   1,2,2,2
+G maj7  0,2,2,2
+G# maj7   0,3,4,3
+G# maj7   1,3,3,3
+G sus   0,2,3,3
+G# sus  1,3,4,4
+CHORDS_RAW
+
+  CHORDS = Hash.new{ |h, k| h[k] = [] }
+
+  CHORDS_RAW.split($/).each{ |line|
+    fingers = line[/\d,\d,\d,\d$/].split(',').map(&:to_i)
+    chord = $`.tr ' ', ''
+    CHORDS[chord] << fingers
+  }
+end

data/lib/uke/fretboard.rb

@@ -0,0 +1,57 @@
+class Uke
+  class Fretboard
+    STYLES = {
+      small: { open: " ⚪", finger: " ●" },
+      large: { open: " ￮", finger: "⬤ " },
+    }
+
+    def initialize(chord, style = nil)
+      @chord  = chord
+      @style = style.to_sym
+      raise ArgumentError, 'Unknown style' unless STYLES[@style]
+      @config = chord_to_config(@chord)
+    end
+
+    def lines
+      (TEMPLATE % @config).split($/)
+    end
+
+    private
+
+    def chord_to_config(chord)
+      config = DEFAULT_CONFIG.dup
+      chord.each_with_index{ |n, i|
+        if n == 0
+          config[i] = STYLES[@style][:open]
+        else
+          config[n*4+i] = STYLES[@style][:finger]
+        end
+      }
+      config
+    end
+
+    DEFAULT_CONFIG = [
+      "  ", "  ", "  ", "  ",
+      " │", " │", " │", " │",
+      " │", " │", " │", " │",
+      " │", " │", " │", " │",
+      " │", " │", " │", " │",
+      " │", " │", " │", " │",
+    ]
+
+    TEMPLATE = <<TEMPLATE
+
+\t%s %s %s %s
+\t ╒══╤══╤══╕
+\t%s %s %s %s
+\t ├──┼──┼──┤
+\t%s %s %s %s
+\t ├──┼──┼──┤
+\t%s %s %s %s
+\t ├──┼──┼──┤
+\t%s %s %s %s
+\t └──┴──┴──┘
+
+TEMPLATE
+  end
+end

data/lib/uke/version.rb

@@ -0,0 +1,4 @@
+class Uke
+  VERSION = "1.0.0".freeze
+end
+

data/uke.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+
+require File.dirname(__FILE__) + "/lib/uke/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "uke"
+  gem.version       = Uke::VERSION
+  gem.summary       = "Displays popular ukulele chords"
+  gem.description   = "Displays popular ukulele chords for the popular `GCEA` tuning"
+  gem.authors       = ["Jan Lelis"]
+  gem.email         = ["mail@janlelis.de"]
+  gem.homepage      = "https://github.com/janlelis/uke"
+  gem.license       = "MIT"
+
+  gem.files         = Dir["{**/}{.*,*}"].select{ |path| File.file?(path) && path !~ /^pkg/ }
+  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.required_ruby_version = "~> 2.0"
+  gem.add_dependency 'rationalist', '~> 2.0'
+  gem.add_dependency 'artii', '~> 2.1'
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: uke
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jan Lelis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rationalist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: artii
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Displays popular ukulele chords for the popular `GCEA` tuning
+email:
+- mail@janlelis.de
+executables:
+- uke-chords
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE.txt
+- README.md
+- Rakefile
+- bin/uke-chords
+- lib/uke.rb
+- lib/uke/chords.rb
+- lib/uke/fretboard.rb
+- lib/uke/version.rb
+- uke.gemspec
+homepage: https://github.com/janlelis/uke
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Displays popular ukulele chords
+test_files: []
+has_rdoc: