chord_diagrams 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 135386bd1af18078290e62fb0bc3792ddb07ff973717b4148ebead48e017bd2b
-  data.tar.gz: 6f2f12911358baae68cf0299a76348439619e757d428c8ccbccf0ad7bae0c332
+  metadata.gz: c4b24bca4ad95e9adaad3ef03c04795cadd130f174af421ad90e061a3fcc66b8
+  data.tar.gz: 40a547576fe43380cd46b0a063b3dc3aa2fcc5333085e969c3c615b5f41b3f4a
 SHA512:
-  metadata.gz: 317c76f9d1f67d9f0048fbb536c241ef25cc2e4a78bde7fe5d80afa2883d437ded28cb7b9ac1ac99b5835154eb3d654aa2b10d2e6b3b98e8af954c20280ecca2
-  data.tar.gz: 315b30e1547f28f0d104879e6bac1e2aeb218738f32fe5bff1de5b5988563ed30de3c1d51c39f03235778baa268dee12c49b0b22359b18db1792815426152075
+  metadata.gz: 5585f6225df041d60cbca67c5756254693ab6b89dcf4a618ed16d2645a8119c146b186caa0355a0397932b2a04c686fa82028c5e8124787c8c28292644ef4a6a
+  data.tar.gz: c9fc438228064e291ad436dce2fb5e857812bcaa29a208a52dda915bb757a27e5e25b1d470c008087652b0c06c3b86483df8613f31120dd85461d481f8bde430

data/.gitignore

@@ -12,4 +12,5 @@
 
 .idea
 Gemfile.lock
-sheet.html
+guitar.html
+ukulele.html

data/README.md

@@ -1,6 +1,6 @@
 # ChordDiagrams
 
-Generate SVGs of Guitar Chord Diagrams
+Generate SVGs for Guitar and Ukulele Chord Diagrams
 
 ## Installation
 
@@ -22,11 +22,18 @@ Or install it yourself as:
 
 ```ruby
 require 'chord_diagrams'
-puts ChordDiagrams.chord_svg('Am')
+puts ChordDiagrams.guitar_svg('Am')
+puts ChordDiagrams.ukulele_svg('Am')
 ```
 
+### Guitar
+
 <svg width="100" height="100" viewBox="0 0 200 200"><text x="100" y="40" text-anchor="middle" style="font-size:36; font-weight:bold">Am</text><line x1="50" y1="80" x2="150" y2="80" style="stroke:black; stroke-width:2; stroke-linecap:square"/><line x1="50" y1="100" x2="150" y2="100" style="stroke:black; stroke-width:2; stroke-linecap:square"/><line x1="50" y1="120" x2="150" y2="120" style="stroke:black; stroke-width:2; stroke-linecap:square"/><line x1="50" y1="140" x2="150" y2="140" style="stroke:black; stroke-width:2; stroke-linecap:square"/><line x1="50" y1="160" x2="150" y2="160" style="stroke:black; stroke-width:2; stroke-linecap:square"/><line x1="50" y1="80" x2="50" y2="160" style="stroke:black; stroke-width:2; stroke-linecap:square"/><line x1="70" y1="80" x2="70" y2="160" style="stroke:black; stroke-width:2; stroke-linecap:square"/><line x1="90" y1="80" x2="90" y2="160" style="stroke:black; stroke-width:2; stroke-linecap:square"/><line x1="110" y1="80" x2="110" y2="160" style="stroke:black; stroke-width:2; stroke-linecap:square"/><line x1="130" y1="80" x2="130" y2="160" style="stroke:black; stroke-width:2; stroke-linecap:square"/><line x1="150" y1="80" x2="150" y2="160" style="stroke:black; stroke-width:2; stroke-linecap:square"/><line x1="49" y1="77" x2="151" y2="77" style="stroke:black; stroke-width:8"/><circle cx="50" cy="61" r="6" style="stroke:black; fill:white; stroke-width:2"/><circle cx="70" cy="61" r="6" style="stroke:black; fill:white; stroke-width:2"/><circle cx="90" cy="110" r="8" style="fill:black"/><circle cx="110" cy="110" r="8" style="fill:black"/><circle cx="130" cy="90" r="8" style="fill:black"/><circle cx="150" cy="61" r="6" style="stroke:black; fill:white; stroke-width:2"/></svg>
 
+### Ukulele
+
+<svg width="80" height="100" viewBox="0 0 160 200"><text id="chordName" x="80" y="40" text-anchor="middle" style="font-size:36; font-weight:bold">Am</text><line x1="50" y1="80" x2="110" y2="80" style="stroke:black; stroke-width:2; stroke-linecap:square"/><line x1="50" y1="100" x2="110" y2="100" style="stroke:black; stroke-width:2; stroke-linecap:square"/><line x1="50" y1="120" x2="110" y2="120" style="stroke:black; stroke-width:2; stroke-linecap:square"/><line x1="50" y1="140" x2="110" y2="140" style="stroke:black; stroke-width:2; stroke-linecap:square"/><line x1="50" y1="160" x2="110" y2="160" style="stroke:black; stroke-width:2; stroke-linecap:square"/><line x1="50" y1="80" x2="50" y2="160" style="stroke:black; stroke-width:2; stroke-linecap:square"/><line x1="70" y1="80" x2="70" y2="160" style="stroke:black; stroke-width:2; stroke-linecap:square"/><line x1="90" y1="80" x2="90" y2="160" style="stroke:black; stroke-width:2; stroke-linecap:square"/><line x1="110" y1="80" x2="110" y2="160" style="stroke:black; stroke-width:2; stroke-linecap:square"/><line id="nut" x1="49" y1="77" x2="111" y2="77" style="stroke:black; stroke-width:8"/><circle cx="50" cy="90" r="8" style="fill:black"/><circle cx="70" cy="61" r="6" style="stroke:black; fill:white; stroke-width:2"/><circle cx="90" cy="61" r="6" style="stroke:black; fill:white; stroke-width:2"/><circle cx="110" cy="61" r="6" style="stroke:black; fill:white; stroke-width:2"/></svg>
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,19 +1,29 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'chord_diagrams'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
 
-task :sheet do
-  require 'chord_diagrams'
+task sheets: %i[guitar ukulele]
 
-  html = ""
+task :guitar do
+  html = ''
 
-  ChordDiagrams::FINGERINGS.each do |name, fingering|
-    diagram = ChordDiagrams.chord_svg(name, fingering)
-    html << diagram
+  ChordDiagrams::GUITAR_FINGERINGS.keys.each do |name|
+    html << ChordDiagrams.guitar_svg(name)
   end
 
-  File.open('sheet.html', 'w') { |file| file.write(html) }
-end
+  File.open('guitar.html', 'w') { |file| file.write(html) }
+end
+
+task :ukulele do
+  html = ''
+
+  ChordDiagrams::UKULELE_FINGERINGS.keys.each do |name|
+    html << ChordDiagrams.ukulele_svg(name)
+  end
+
+  File.open('ukulele.html', 'w') { |file| file.write(html) }
+end

data/lib/chord_diagrams.rb

@@ -10,28 +10,82 @@ module ChordDiagrams
   }.freeze
 
   class << self
-    def chord_svg(name, fingerings = nil)
-      svg = Victor::SVG.new template: :html, width: 100, height: 100, viewBox: '0 0 200 200'
+    def ukulele_svg(name, _fingering = nil)
+      svg = Victor::SVG.new template: :html, width: 80, height: 100, viewBox: '0 0 160 200'
+
+      ChordDiagrams.draw_ukulele_name(name, svg)
+      ChordDiagrams.draw_ukulele_frets(svg)
+      ChordDiagrams.draw_ukulele_strings(svg)
 
-      ChordDiagrams.draw_name(name, svg)
-      ChordDiagrams.draw_frets(svg)
-      ChordDiagrams.draw_strings(svg)
+      fingering = ChordDiagrams::UKULELE_FINGERINGS[name] if fingering.nil?
 
-      if fingerings.nil?
-        fingerings = ChordDiagrams::FINGERINGS[name.to_sym]
+      if !fingering.nil?
+        ChordDiagrams.draw_chord_diagram(fingering, svg)
+      else
+        ChordDiagrams.draw_ukulele_missing_chord_diagram(name, svg)
       end
 
-      if !fingerings.nil?
-        ChordDiagrams.draw_chord_diagram(fingerings, svg)
+      svg.render
+    end
+
+    def guitar_svg(name, fingering = nil)
+      svg = Victor::SVG.new template: :html, width: 100, height: 100, viewBox: '0 0 200 200'
+
+      ChordDiagrams.draw_guitar_name(name, svg)
+      ChordDiagrams.draw_guitar_frets(svg)
+      ChordDiagrams.draw_guitar_strings(svg)
+
+      fingering = ChordDiagrams::GUITAR_FINGERINGS[name] if fingering.nil?
+
+      if !fingering.nil?
+        ChordDiagrams.draw_chord_diagram(fingering, svg)
       else
-        ChordDiagrams.draw_missing_chord_diagram(svg)
+        ChordDiagrams.draw_guitar_missing_chord_diagram(name, svg)
       end
 
       svg.render
     end
 
-    def draw_missing_chord_diagram(svg)
-      puts "Could't find fingerings for the chord '#{name}'"
+    def draw_ukulele_name(name, svg)
+      svg.text name, id: 'chordName', x: 80, y: 40, text_anchor: :middle, style: {
+        font_size: 36,
+        font_weight: :bold
+      }
+    end
+
+    def draw_guitar_name(name, svg)
+      svg.text name, id: 'chordName', x: 100, y: 40, text_anchor: :middle, style: {
+        font_size: 36,
+        font_weight: :bold
+      }
+    end
+
+    def draw_guitar_frets(svg)
+      [80, 100, 120, 140, 160].each do |y|
+        svg.line x1: 50, y1: y, x2: 150, y2: y, style: LINE_STYLE
+      end
+    end
+
+    def draw_ukulele_frets(svg)
+      [80, 100, 120, 140, 160].each do |y|
+        svg.line x1: 50, y1: y, x2: 110, y2: y, style: LINE_STYLE
+      end
+    end
+
+    def draw_guitar_strings(svg)
+      [50, 70, 90, 110, 130, 150].each do |x|
+        svg.line x1: x, y1: 80, x2: x, y2: 160, style: LINE_STYLE
+      end
+    end
+
+    def draw_ukulele_strings(svg)
+      [50, 70, 90, 110].each do |x|
+        svg.line x1: x, y1: 80, x2: x, y2: 160, style: LINE_STYLE
+      end
+    end
+
+    def draw_guitar_missing_chord_diagram(name, svg)
+      puts "Could't find fingerings for the Guitar chord '#{name}'"
 
       svg.text '?', x: 102, y: 155, text_anchor: :middle, style: {
         font_size: 96,
@@ -40,17 +94,32 @@ module ChordDiagrams
       }
     end
 
+    def draw_ukulele_missing_chord_diagram(name, svg)
+      puts "Could't find fingerings for the Ukulele chord '#{name}'"
+
+      svg.text '?', x: 81, y: 155, text_anchor: :middle, style: {
+        font_size: 96,
+        font_weight: :bold,
+        fill: :gray
+      }
+    end
+
     def draw_chord_diagram(fingerings, svg)
       fingerings = fingerings.split('')
 
-      lowest_fret = fingerings.reject{ |fret| fret.to_i < 1 }.min
+      lowest_fret = fingerings.reject { |fret| fret.to_i < 1 }.min
+      highest_fret = fingerings.reject { |fret| fret.to_i < 1 }.max
 
-      if lowest_fret.to_i > 2
-        svg.text lowest_fret, id: 'fretNumber', x: 35, y: 96, text_anchor: :end, style: { font_size: 20 }
+      if lowest_fret.to_i > 3 || highest_fret.to_i > 4
+        draw_fret_number(lowest_fret, svg)
 
-        fingerings = shift_fingerings(fingerings, lowest_fret)
+        fingerings = shift_guitar_fingerings(fingerings, lowest_fret)
       else
-        draw_nut(svg)
+        if fingerings.size == 6
+          draw_guitar_nut(svg)
+        else
+          draw_ukulele_nut(svg)
+        end
       end
 
       fingerings.each_with_index do |fingering, index|
@@ -66,15 +135,15 @@ module ChordDiagrams
       end
     end
 
-    def draw_name(name, svg)
-      svg.text name, id: 'chordName', x: 100, y: 40, text_anchor: :middle, style: {
-        font_size: 36,
-        font_weight: :bold
+    def draw_guitar_nut(svg)
+      svg.line id: 'nut', x1: 49, y1: 77, x2: 151, y2: 77, style: {
+        stroke: :black,
+        stroke_width: 8
       }
     end
 
-    def draw_nut(svg)
-      svg.line id: 'nut', x1: 49, y1: 77, x2: 151, y2: 77, style: {
+    def draw_ukulele_nut(svg)
+      svg.line id: 'nut', x1: 49, y1: 77, x2: 111, y2: 77, style: {
         stroke: :black,
         stroke_width: 8
       }
@@ -97,21 +166,13 @@ module ChordDiagrams
       svg.line x1: offset - 4, y1: 61 + 4, x2: offset + 4, y2: 61 - 4, style: LINE_STYLE
     end
 
-    def draw_strings(svg)
-      [50, 70, 90, 110, 130, 150].each do |x|
-        svg.line x1: x, y1: 80, x2: x, y2: 160, style: LINE_STYLE
-      end
-    end
+    private
 
-    def draw_frets(svg)
-      [80, 100, 120, 140, 160].each do |y|
-        svg.line x1: 50, y1: y, x2: 150, y2: y, style: LINE_STYLE
-      end
+    def draw_fret_number(number, svg)
+      svg.text number, id: 'fretNumber', x: 37, y: 98, text_anchor: :end, style: {font_size: 24}
     end
 
-    private
-
-    def shift_fingerings(fingerings, lowest_fret)
+    def shift_guitar_fingerings(fingerings, lowest_fret)
       fingerings.map do |fingering|
         if fingering != 'x' && fingering != '0'
           fingering.to_i - lowest_fret.to_i + 1

data/lib/chord_diagrams/fingerings.csv

@@ -0,0 +1,90 @@
+chord,guitar,ukulele
+A,002220,2100
+B,x24442,4322
+Bb,x13331,3211
+C,x32010,0003
+C#,x46664,1114
+D,xx0232,2220
+D#,x68886,0331
+E,022100,4442
+Eb,x68886,0331
+F,133211,2010
+F#,244322,3121
+G,320003,0232
+G#,466544,1343
+C5,x355xx,0033
+D5,x577xx,2200
+D#5,x688xx,2255
+C6,x32210,0000
+D6,xx0202,2222
+E6,022120,4444
+G6,320000,0202
+A7,002020,0100
+B7,x21202,2322
+C7,x32310,0001
+C#7,x46464,1112
+D7,x00212,2223
+E7,020100,1202
+F7,131211,2313
+F#7,242322,3424
+G7,320001,0212
+G#7,464544,1323
+AM7,x02120,1100
+CM7,x32000,0002
+DM7,xx0222,2224
+EM7,xx2444,1302
+FM7,132211,2413
+Cadd9,x32033,0203
+Fadd9,xx3213,0010
+Dsus2,xx0230,2200
+Asus2,x02200,1341
+Asus4,x02230,2200
+Dsus4,xx0233,0230
+Esus4,022200,4400
+A7sus4,002030,0200
+G7sus4,353533,0213
+Am,002210,1000
+Bm,x24432,3222
+Cm,x35543,0333
+C#m,x46654,1104
+Dm,x00231,2210
+Em,022000,0432
+Fm,133111,1013
+F#m,244222,2120
+Gm,355333,0231
+G#m,466444,4342
+Am7,002010,0433
+A#m7,x13121,1111
+Bm7,x24232,2222
+Cm7,x35343,3333
+C#m7,x46454,1102
+Dm7,x00211,2213
+Em7,020030,0202
+Fm7,131111,1313
+F#m7,242222,2424
+Gm7,353333,0211
+Am9,x05557,1032
+Bm11,x20220,4200
+F#m11,202200,4420
+A/C#,042220,2100
+A/E,00222x,2100
+A/F#,202220,2100
+Bb/A,x00331,3210
+C/B,x22010,0002
+C/E,032010,0003
+D/A,x04232,2220
+D/F#,200232,2220
+F/A,x03211,2010
+G/B,x20003,4232
+C7/G,3323xx,0001
+D7/F#,200212,2223
+G7/F,123003,0212
+D9/F#,2x0210,5425
+Am/D,xx0210,2203
+Am/G,302210,0000
+A#m/D#,xx1321,2214
+Dm/F,10323x,2210
+Gm/Bb,x10333,0231
+G#dim,4564xx,1202
+D#dim7,xx1212,2323
+G#dim7,456464,1212

data/lib/chord_diagrams/fingerings.rb

@@ -1,130 +1,16 @@
-module ChordDiagrams
-  FINGERINGS = {
-      # Major Chords
-      'A': '002220',
-      'B': 'x24442',
-      'Bb': 'x13331',
-      'C': 'x32010',
-      'C#': 'x46664',
-      'D': 'xx0232',
-      'D#': 'x68886',
-      'E': '022100',
-      'Eb': 'x68886',
-      'F': '133211',
-      'F#': '244322',
-      'G': '320003',
-      'G#': '466544',
-
-      # Root/Five Chords
-      'C5': 'x355xx',
-      'D5': 'x577xx',
-      'D#5': 'x688xx',
-
-      # Six Chords
-      'C6': 'x32210',
-      'D6': 'xx0202',
-      'E6': '022120',
-      'G6': '320000',
-
-      # Seventh Chords
-      'A7': '002020',
-      'B7': 'x21202',
-      'C7': 'x32310',
-      'C#7': 'x46464',
-      'D7': 'x00212',
-      'E7': '020100',
-      'F7': '131211',
-      'F#7': '242322',
-      'G7': '320001',
-      'G#7': '464544',
-
-      # Major Seventh Chords
-      'AM7': 'x02120',
-      'CM7': 'x32000',
-      'DM7': 'xx0222',
-      'EM7': 'xx2444',
-      'FM7': '132211',
-
-      # Major 9th Chords
-      'Cadd9': 'x32033',
-      'Fadd9': 'xx3213',
-
-      # Major Suspended 2nd Chords
-      'Dsus2': 'xx0230',
-      'Asus2': 'x02200',
-
-      # Major Suspended 4th Chords
-      'Asus4': 'x02230',
-      'Dsus4': 'xx0233',
-      'Esus4': '022200',
+require 'csv'
 
-      # Seventh Suspended 4th Chords
-      'A7sus4': '002030',
-      'G7sus4': '353533',
-
-      # Minor Chords
-      'Am': '002210',
-      'Bm': 'x24432',
-      'Cm': 'x35543',
-      'C#m': 'x46654',
-      'Dm': 'x00231',
-      'Em': '022000',
-      'Fm': '133111',
-      'F#m': '244222',
-      'Gm': '355333',
-      'G#m': '466444',
-
-      # Minor Seventh Chords
-      'Am7': '002010',
-      'A#m7': 'x13121',
-      'Bm7': 'x24232',
-      'Cm7': 'x35343',
-      'C#m7': 'x46454',
-      'Dm7': 'x00211',
-      'Em7': '020030',
-      'Fm7': '131111',
-      'F#m7': '242222',
-      'Gm7': '353333',
-
-      # Minor Ninth Chotds
-      'Am9': "x05557",
-
-      # Minor Eleventh Chords
-      'Bm11': 'x20220',
-      'F#m11': '202200',
-
-      # Major Chords with Bass Notes
-      'A/C#': '042220',
-      'A/E': '00222x',
-      'A/F#': '202220',
-      'Bb/A': 'x00331',
-      'C/B': 'x22010',
-      'C/E': '032010',
-      'D/A': 'x04232',
-      'D/F#': '200232',
-      'F/A': 'x03211',
-      'G/B': 'x20003',
-
-      # Seventh Chords with Bass Notes
-      'C7/G': '3323xx',
-      'D7/F#': '200212',
-      'G7/F': '123003',
-
-      # Ninth Chords with Bass Notes
-      'D9/F#': '2x0210',
+module ChordDiagrams
+  guitar_fingerings = {}
+  ukulele_fingerings = {}
 
-      # Minor Chords with Bass Notes
-      'Am/D': 'xx0210',
-      'Am/G': '302210',
-      'A#m/D#': 'xx1321',
-      'Dm/F': '10323x',
-      'Gm/Bb': 'x10333',
+  fingerings_file = File.join(File.expand_path(File.dirname(__FILE__)), 'fingerings.csv')
 
-      # Diminished Chords
-      'G#dim': '4564xx',
+  CSV.foreach(fingerings_file, headers: true) do |row|
+    guitar_fingerings[row[0]] = row[1] unless row[1].nil?
+    ukulele_fingerings[row[0]] = row[2] unless row[2].nil?
+  end
 
-      # Diminished Seventh Chords
-      'D#dim7': 'xx1212',
-      'G#dim7': '456464'
-  }.freeze
-end
+  GUITAR_FINGERINGS = guitar_fingerings.freeze
+  UKULELE_FINGERINGS = ukulele_fingerings.freeze
+end

data/lib/chord_diagrams/version.rb

@@ -1,3 +1,3 @@
 module ChordDiagrams
-  VERSION = '0.0.5'.freeze
+  VERSION = '0.0.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chord_diagrams
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Brian Kelly
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-28 00:00:00.000000000 Z
+date: 2019-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: victor
@@ -98,6 +98,7 @@ files:
 - bin/setup
 - chord_diagrams.gemspec
 - lib/chord_diagrams.rb
+- lib/chord_diagrams/fingerings.csv
 - lib/chord_diagrams/fingerings.rb
 - lib/chord_diagrams/version.rb
 homepage: https://github.com/spilth/chord_diagrams