chord_diagrams 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c83de466241bba4b2f58a900ebe70cca5c6f8961edb74ddd020caed64e28d154
+  data.tar.gz: a33cd628d31d85f6676df5cd6d4dc05994f5801c418386fa6268ab6a3b1efdaa
+SHA512:
+  metadata.gz: 628d39f5e1efaa35e5804fc065b2bc5688fa76d6d8adf52f0a7e5a292eaeb43bd3252e0d718b9a978552d67df4099997f0ecb5c8ea3895ed6ccd29abca68c7f9
+  data.tar.gz: 26fd9de06972e59cca82612d6fe288647aa45e4aa65daf5f7b9a9f4148f0a70e9249e724b3c899cef70d7e68e43f166b781e2b5fb9c3a1ba6965ed90d3067919

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Brian Kelly
+
+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,42 @@
+# ChordDiagrams
+
+Generate SVGs of Guitar Chord Diagrams
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chord_diagrams'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chord_diagrams
+
+## Usage
+
+```ruby
+require 'chord_diagrams'
+puts ChordDiagrams.chord_svg('Am')
+```
+
+<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>
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/spilth/chord_diagrams.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "chord_diagrams"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/chord_diagrams.gemspec

@@ -0,0 +1,42 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chord_diagrams/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'chord_diagrams'
+  spec.version       = ChordDiagrams::VERSION
+  spec.authors       = ['Brian Kelly']
+  spec.email         = ['bkelly@carbonfive.com']
+
+  spec.summary       = 'Generate Chord Diagrams for Guitar'
+  spec.description   = 'Generate Chord Diagrams for Guitar'
+  spec.homepage      = 'https://github.com/spilth/chord_diagrams'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/spilth/chord_diagrams'
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'victor', '0.2.4'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/chord_diagrams.rb

@@ -0,0 +1,235 @@
+require 'chord_diagrams/version'
+require 'victor'
+
+module ChordDiagrams
+  LINE_STYLE = {
+    stroke: :black,
+    stroke_width: 2,
+    stroke_linecap: :square
+  }.freeze
+
+  class << self
+    def chord_svg(name, fingerings = nil)
+      svg = Victor::SVG.new template: :html, width: 100, height: 100, viewBox: '0 0 200 200'
+
+      ChordDiagrams.draw_name(name, svg)
+      ChordDiagrams.draw_frets(svg)
+      ChordDiagrams.draw_strings(svg)
+
+      fingerings = CHORD_FINGERINGS[name.to_sym] if fingerings.nil?
+
+      if !fingerings.nil?
+        ChordDiagrams.draw_chord_diagram(fingerings, svg)
+      else
+        ChordDiagrams.draw_missing_chord_diagram(svg)
+      end
+
+      svg.render
+    end
+
+    def draw_missing_chord_diagram(svg)
+      puts "Could't find fingerings for the chord '#{name}'"
+
+      svg.text '?', x: 102, 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.min
+
+      if lowest_fret.to_i > 2
+        svg.text lowest_fret, x: 35, y: 96, text_anchor: :end, style: { font_size: 20 }
+
+        fingerings = fingerings.map do |fingering|
+          if fingering != 'x'
+            fingering.to_i - lowest_fret.to_i + 1
+          else
+            fingering
+          end
+        end
+      else
+        draw_nut(svg)
+      end
+
+      fingerings.each_with_index do |fingering, index|
+        offset = 50 + (20 * index)
+
+        if fingering == 'x'
+          draw_muted_string(offset, svg)
+        elsif fingering == '0'
+          draw_open_string(offset, svg)
+        else
+          draw_fingered_string(fingering, offset, svg)
+        end
+      end
+    end
+
+    def draw_name(name, svg)
+      svg.text name, x: 100, y: 40, text_anchor: :middle, style: {
+        font_size: 36,
+        font_weight: :bold
+      }
+    end
+
+    def draw_nut(svg)
+      svg.line x1: 49, y1: 77, x2: 151, y2: 77, style: {
+        stroke: :black,
+        stroke_width: 8
+      }
+    end
+
+    def draw_fingered_string(fingering, offset, svg)
+      svg.circle cx: offset, cy: 70 + (fingering.to_i * 20), r: 8, style: {
+        fill: :black
+      }
+    end
+
+    def draw_open_string(offset, svg)
+      svg.circle cx: offset, cy: 61, r: 6, style: {
+        stroke: :black, fill: :white, stroke_width: 2
+      }
+    end
+
+    def draw_muted_string(offset, svg)
+      svg.line x1: offset - 4, y1: 61 - 4, x2: offset + 4, y2: 61 + 4, style: LINE_STYLE
+      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
+
+    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
+    end
+  end
+
+  CHORD_FINGERINGS = {
+    # Major Chords
+    'A': '002220',
+    'B': 'x24442',
+    'Bb': 'x13331',
+    'C': 'x32010',
+    'C#': 'x46664',
+    'D': 'x00232',
+    '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
+    '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 Suspended 2nd Chords
+    'Dsus2': 'xx0230',
+    'Asus2': 'x02200',
+
+    # Major Suspended 4th Chords
+    'Asus4': 'x02230',
+    'Dsus4': 'xx0233',
+    'Esus4': '022200',
+
+    # 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 Eleventh Chords
+    'Bm11': 'x20220',
+    'F#m11': '202200',
+
+    # Major 9th Chords
+    'Cadd9': 'x32033',
+
+    # Major Chords with Bass Notes
+    'A/C#': '002220',
+    'A/E': '04222x',
+    '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',
+
+    # Minor Chords with Bass Notes
+    'Am/D': 'xx0210',
+    'Am/G': '302210',
+    'A#m/D#': 'xx1321',
+    'Dm/F': '10323x',
+    'Gm/Bb': 'x10333',
+
+    # Diminished Chords
+    'G#dim': '4564xx',
+
+    # Diminished Seventh Chords
+    'D#dim7': 'xx1212',
+    'G#dim7': '456464'
+  }.freeze
+end

data/lib/chord_diagrams/version.rb

@@ -0,0 +1,3 @@
+module ChordDiagrams
+  VERSION = '0.0.3'.freeze
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: chord_diagrams
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Brian Kelly
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: victor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: Generate Chord Diagrams for Guitar
+email:
+- bkelly@carbonfive.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chord_diagrams.gemspec
+- lib/chord_diagrams.rb
+- lib/chord_diagrams/version.rb
+homepage: https://github.com/spilth/chord_diagrams
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/spilth/chord_diagrams
+  source_code_uri: https://github.com/spilth/chord_diagrams
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Generate Chord Diagrams for Guitar
+test_files: []