uke 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8871351a22290ca9b4d067e90e823ccb1e47854b
-  data.tar.gz: 41d03d9d191759de0aba43e6b504538f94d4a242
+SHA256:
+  metadata.gz: 1cc145040676501d82ce76b94f686243de901e1041d31b815471f020eb8fe9e3
+  data.tar.gz: 1bdefdf83073f3eea3a109e654ff7b08639906aa9195fbfa9b34aefd2e76778c
 SHA512:
-  metadata.gz: 46a8e567cb15b1753306e90d8ec8e7df2355f3750a77e4655fa3b607702a52aed908382f8df04f181b627295be5490cf40fc75d24ab4a15a92b07e5237048919
-  data.tar.gz: 50b6816c7eeff4e7e0d83c5e7b6e27b60d9ddb54eac2ff469baf742d0b00bb11b1e97d591936984083706847f6645719b6509d5e4585a342db3d1ee789ab0923
+  metadata.gz: 8ff1ca0b9df7c22b9d28aaace4e5b88c01981cbc27a177b8dabf7db1826043cef578f349c0055b5df5bec91a4048079c90d6b650fcffb00bc81edcb9ff668091
+  data.tar.gz: 7c8ba0f08b1ac2849f335688f9cf753df72c33a98885783ca40ca0adf2ccaba813dad427aa85973f80f59c1cb78532d3514d54f8081ee728aa8888d5c110a6eb

data/.gitignore

@@ -1 +1,2 @@
 Gemfile.lock
+/pkg

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 ## CHANGELOG
 
+### 1.0.1
+
+- Support "fingering" output style
+
 ### 1.0.0
 
-* Inital release
+- Initial release
 

data/README.md

@@ -54,6 +54,23 @@ $ uke-chords G B7 C Cm
 
 ```
 
+You can also get suggestions which fingers to use with the `--style fingering` option:
+
+```
+$ uke-chords --style fingering C
+
+           	 ◯  ◯  ◯   	 ◯     ◯   	 ◯         
+           	 ╒══╤══╤══╕	 ╒══╤══╤══╕	 ╒══╤══╤══╕
+     _____ 	 │  │  │  │	 │  │  │  │	 │  │  │  │
+    / ____|	 ├──┼──┼──┤	 ├──┼──┼──┤	 ├──┼──┼──┤
+   | |     	 │  │  │  │	 │  │  │  │	 │  │  │  │
+   | |     	 ├──┼──┼──┤	 ├──┼──┼──┤	 ├──┼──┼──┤
+   | |____ 	 │  │  │ ➊	 │  │  │ ➊	 │  │  ➊ ➊
+    \_____|	 ├──┼──┼──┤	 ├──┼──┼──┤	 ├──┼──┼──┤
+           	 │  │  │  │	 │  ➋  │  │	 │  ➋  │  │
+           	 └──┴──┴──┘	 └──┴──┴──┘	 └──┴──┴──┘
+```
+
 ## Setup
 
 Make sure that your computer has [Ruby 2.0 or higher installed](http://ruby.about.com/od/tutorials/a/installruby.htm).

data/lib/uke/chords.rb

@@ -1,195 +1,206 @@
 class Uke
+  class Chord
+    attr_reader :name, :positions, :fingers
+
+    def initialize(line)
+      parts = line.split(/\s{2,}/).map { |part| part.split(',') }
+
+      @name =  parts[0].join.tr(' ', '')
+      @positions = parts[1].map(&:to_i)
+      @fingers = parts[2] && parts[2].map(&:to_i)
+    end
+  end
+
   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   2,1,0,0  2,1,-,-
+A   2,1,0,4  2,1,-,4
+A   2,4,0,4  1,3,-,4
+A#    3,2,1,1  3,2,1,1
+A 5   2,4,0,0  1,3,-,-
+A 7   0,1,0,0  -,1,-,-
+A 7   2,4,3,4  1,2,3,4
+A# 7  1,2,1,1  1,2,1,1
+A 7sus  0,2,0,0  -,1,-,-
+A# 7sus   1,3,1,1  1,3,1,1
+A 9   2,1,0,2  1,2,0,3
+A 9   4,1,0,0  4,1,-,-
+A# 9  3,2,1,3  1,2,3,4
+A aug   2,1,1,0  3,1,2,-
+A aug   2,1,1,4  3,1,2,4
+A# aug  3,2,2,1  4,3,2,1
+A# dim  3,1,0,1  4,1,-,2
+A# dim  3,1,0,4  3,1,-,4
+A# dim  3,4,0,4  1,2,-,3
+A# dim7   0,1,0,1  -,1,-,2
+A# dim7   3,4,3,4  1,3,2,4
+A dim7  2,3,2,3  1,3,2,4
+A m   2,0,0,0  1,-,-,-
+A m   2,0,0,3  1,-,-,3
+A m   2,4,0,3  1,3,-,2
+A# m  3,1,1,1  3,1,1,1
+A# m  3,1,1,4  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
+A m7  2,4,3,3  1,4,2,3
+A# m7   1,1,1,1  1,1,1,1
+A# m7b5   1,1,0,1  1,2,-,3
+A# m7b5   3,4,4,4  1,2,3,4
+A m7b5  2,3,3,3  1,2,3,4
+A maj7  1,1,0,0  1,2,-,-
+A maj7  2,4,4,4  1,2,3,4
+A# maj7   2,2,1,1  3,1,4,2
+A# maj7   3,2,1,0  3,2,1,-
+A sus   2,2,0,0  1,2,-,-
+A# sus  3,3,1,1  3,4,1,1
+B   4,3,2,2  3,2,1,1
+B 7   2,3,2,2  1,2,1,1
+B 7   4,3,2,0  3,2,1,-
+B 7sus  2,4,2,2  1,3,1,1
+B 7sus  4,4,2,0  3,4,1,-
+B 9   4,3,2,4  3,2,1,4
+B aug   0,3,3,2  -,2,3,1
+B aug   4,3,3,2  4,2,3,1
+B dim   4,2,1,2  4,3,1,2
+B dim7  1,2,1,2  1,3,2,4
+B m   4,2,2,2  3,1,1,1
+B m7  2,2,2,2  1,1,1,1
+B m7  4,2,2,0  4,1,2,-
+B m7b5  2,2,1,2  2,3,1,4
+B m7b5  4,2,1,0  4,2,1,-
+B maj7  3,3,2,2  2,3,1,1
+B maj7  4,3,2,1  4,3,2,1
+B sus   4,4,2,2  3,4,1,1
+C   0,0,0,3  -,-,-,1
+C   0,4,0,3  -,2,-,1
+C   0,4,3,3  -,2,1,1
+C#    1,1,1,4  1,1,1,4
+C 5   0,0,3,3  -,-,1,1
+C# 5  1,1,4,4  1,1,3,4
+C 7   0,0,0,1  -,-,-,1
+C 7   3,4,3,3  1,2,1,1
+C# 7  1,1,1,2  1,1,1,2
+C 7sus  0,0,1,1  -,-,1,1
+C# 7sus   1,1,2,2  1,2,3,4
+C 9   0,2,0,3  -,1,-,2
+C# 9  1,3,1,4  1,3,1,4
+C aug   1,0,0,3  1,-,-,4
+C aug   1,4,0,3  1,4,-,3
+C aug   1,4,4,3  1,3,4,2
+C# dim  0,1,0,4  -,1,-,4
+C# dim  0,4,0,4  -,1,-,2
+C# dim  0,4,3,4  -,2,1,3
+C m   0,3,3,3  -,1,1,1
+C# m  1,1,0,4  1,2,-,4
+C# m  1,4,0,4  1,3,-,4
+C# m  1,4,4,4  1,4,4,4
+C# m7   1,1,0,2  1,2,-,4
+C m7  3,3,3,3  1,1,1,1
+C# m7   4,4,4,4  1,1,1,1
+C# m7b5   0,1,0,2  -,1,-,2
+C m7b5  3,3,2,3  2,3,1,4
+C# m7b5   4,4,3,4  2,3,1,4
+C maj7  0,0,0,2  -,-,-,1
+C# maj7   1,0,1,4  1,-,2,4
+C# maj7   1,1,1,3  1,1,1,3
+C maj7  4,4,3,3  2,3,1,1
+C sus   0,0,1,3  -,-,1,3
+C# sus  1,1,2,4  1,1,2,4
+D#    0,3,3,1  -,3,4,1
+D   2,2,2,0  1,2,3,-
+D#    3,3,3,1  2,3,4,1
+D 7   2,2,2,3  1,1,1,2
+D# 7  3,3,3,4  1,1,1,2
+D 7sus  2,2,3,3  1,1,2,3
+D# 7sus   3,3,4,4  1,1,2,3
+D# 9  0,3,1,1  -,3,1,1
+D# dim  2,3,2,0  1,3,2,-
+D m   2,2,1,0  2,3,1,-
+D# m  3,3,2,1  3,4,2,1
+D m7  2,2,1,3  2,3,1,4
+D# m7   3,3,2,4  2,3,1,4
+D m7b5  1,2,1,3  1,3,2,4
+D# m7b5   2,3,2,4  1,3,2,4
+D maj7  2,2,2,4  1,1,1,3
+D sus   0,2,3,0  -,1,2,-
+D# sus  1,3,4,1  1,3,4,1
+D sus   2,2,3,0  1,2,3,-
+D# sus  3,3,4,1  2,3,4,1
+E   1,4,0,2  1,4,-,2
+E   1,4,4,2  1,4,3,2
+E   4,4,4,2  2,3,4,1
+E 5   4,4,0,2  3,4,-,1
+E 7   1,2,0,2  1,2,-,3
+E 7sus  2,2,0,2  1,2,-,3
+E 7sus  4,2,0,0  3,1,-,-
+E 9   1,4,2,2  1,4,2,3
+E dim   0,4,0,1  -,4,-,1
+E dim   0,4,3,1  -,4,3,1
+E dim   3,4,3,1  2,4,3,1
+E m   0,4,0,2  -,3,-,1
+E m   0,4,3,2  -,3,2,1
+E m   4,4,3,2  3,4,2,1
+E m7  0,2,0,2  -,1,-,2
+E m7b5  0,2,0,1  -,2,-,1
+E maj7  1,3,0,2  1,3,-,2
+E sus   2,4,0,2  1,4,-,2
+E sus   4,4,0,0  3,4,-,-
+F   2,0,1,0  2,-,1,-
+F   2,0,1,3  2,-,1,4
+F#    3,1,2,1  3,1,2,1
+F#    3,1,2,4  3,1,2,4
+F 7   2,3,1,3  2,3,1,4
+F# 7  3,4,2,4  2,3,1,4
+F 7sus  3,3,1,3  2,3,1,4
+F# 7sus   4,4,2,4  2,3,1,4
+F 9   0,0,1,0  -,-,1,-
+F# 9  1,1,2,1  1,1,2,1
+F# dim  2,0,2,0  1,-,2,-
+F# dim  2,0,2,3  1,-,2,4
+F m   1,0,1,3  1,-,2,4
+F# m  2,1,2,0  2,1,3,-
+F# m  2,1,2,4  2,1,3,4
+F m7  1,3,1,3  1,3,1,4
+F# m7   2,4,2,4  1,3,1,4
+F m7b5  1,3,1,2  1,3,1,2
+F# m7b5   2,4,2,3  1,3,1,2
+F maj7  2,4,1,3  2,4,1,3
+F sus   3,0,1,1  3,-,1,1
+F sus   3,0,1,3  3,-,1,4
+F# sus  4,1,2,2  4,1,3,2
+F# sus  4,1,2,4  3,1,2,4
+G   0,2,3,2  -,1,3,2
+G#    1,3,4,3  1,2,4,3
+G   4,2,3,2  3,1,2,1
+G 7   0,2,1,2  -,2,1,3
+G# 7  1,3,2,3  1,3,2,4
+G 7sus  0,2,1,3  -,2,1,4
+G# 7sus   1,3,2,4  1,3,2,4
+G 9   2,2,3,2  1,1,2,1
+G# 9  3,3,4,3  1,1,2,1
+G 9   4,2,3,0  3,1,2,-
+G dim   0,1,3,1  -,1,3,1
+G# dim  1,2,4,2  1,2,4,3
+G dim   3,1,3,1  4,1,3,1
+G dim   3,1,3,4  2,1,3,4
+G# dim  4,2,4,2  3,1,4,1
+G m   0,2,3,1  -,2,3,1
+G# m  1,3,4,2  1,3,4,2
+G m   3,2,3,1  2,3,4,1
+G# m  4,3,4,2  3,2,4,1
+G m7  0,2,1,1  -,2,1,1
+G# m7   1,3,2,2  1,4,2,3
+G m7b5  0,1,1,1  -,1,1,1
+G# m7b5   1,2,2,2  1,2,3,4
+G maj7  0,2,2,2  -,1,1,1
+G# maj7   0,3,4,3  -,1,3,2
+G# maj7   1,3,3,3  1,2,3,4
+G sus   0,2,3,3  -,1,2,3
+G# sus  1,3,4,4  1,2,3,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
+    chord = Chord.new(line)
+    CHORDS[chord.name] << chord
   }
 end

data/lib/uke/fretboard.rb

@@ -1,8 +1,10 @@
 class Uke
   class Fretboard
     STYLES = {
-      small: { open: " ⚪", finger: " ●" },
-      large: { open: " ￮", finger: "⬤ " },
+      small: { open: " ∘", finger: " •" },
+      medium: { open: " ⚪", finger: " ⚫"},
+      large: { open: " ◯", finger: " " },
+      fingering: {open: " ◯", finger: [" ➊", " ➋", " ➌", " ➍"]}
     }
 
     def initialize(chord, style = nil)
@@ -13,23 +15,49 @@ class Uke
     end
 
     def lines
-      (TEMPLATE % @config).split($/)
+      (TEMPLATE % @config).split($/).map do |line|
+        matches = line.match(/(([➊➋➌➍]\s{2,})+[^│])/)
+
+        if matches
+          part = matches.captures.first
+          line.gsub(part, part.gsub(/\s{2}/, ' '))
+        else
+          line
+        end
+      end
     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]
+
+      chord.positions.each_with_index do |position, index|
+        if position == 0
+          config[index] = STYLES[@style][:open]
         else
-          config[n*4+i] = STYLES[@style][:finger]
+          finger = finger_symbol(chord, index)
+          finger = index === 3 && @style != :small ? finger.strip : finger
+          config[position * 4 + index] = finger
         end
-      }
+      end
+
       config
     end
 
+    def finger_symbol(chord, index)
+      finger = STYLES[@style][:finger]
+
+      if @style == :fingering
+        return STYLES[:large][:finger] unless chord.fingers
+
+        finger_index = chord.fingers[index] - 1
+        finger_index.negative? ? STYLES[:large][:finger] : finger[finger_index]
+      else
+        STYLES[@style][:finger]
+      end
+    end
+
     DEFAULT_CONFIG = [
       "  ", "  ", "  ", "  ",
       " │", " │", " │", " │",
@@ -54,4 +82,4 @@ class Uke
 
 TEMPLATE
   end
-end
+end

data/lib/uke/version.rb

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

data/uke.gemspec

@@ -5,8 +5,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.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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uke
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jan Lelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-02 00:00:00.000000000 Z
+date: 2018-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rationalist
@@ -38,7 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-description: Displays popular ukulele chords for the popular `GCEA` tuning
+description: "\U0001D11D Displays popular ukulele chords for the popular `GCEA` tuning"
 email:
 - mail@janlelis.de
 executables:
@@ -79,9 +79,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Displays popular ukulele chords
+summary: "\U0001D11D Displays popular ukulele chords"
 test_files: []
-has_rdoc: