fretboard 1.4.3 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2aeb1806f3f22ec8707add870368e8485214f99090e6c19c219ae6771d96a9a
-  data.tar.gz: 6cb78c994692eeb29d30f366a15020114608e2cf3c1f82170ca1fff17be8e630
+  metadata.gz: 032557dece35cf1703114d36c92d5c5cd24bff99f3b359423559503630dcd5f6
+  data.tar.gz: 622a072b59c2d7f0e232e20032bd454651ffe89a25f5c0efb1686372c9416873
 SHA512:
-  metadata.gz: c45b527d086a79808cd21a980ca863446c434825bfb194aaf5a6fd1c17e90d82e121175da5fb797b4e963af96aa4ca98a6395d0c9602db8230c603b777c3da6b
-  data.tar.gz: 33762c5bea84f8609e430313e7791998ef0c7d430b8f70f1955d3b3ceb671e2bb37fb5d3ada4b32bc86820b6127951a9de58a478d0acc1abb97d709faac7eb4e
+  metadata.gz: 37ef216fad26e45060ac600273bc4a078fa677b13231b8aed014814c27bfbad5e15543136593823ab0e2262ee366ab958e982cefb0bfc88e8b3a8fa6294c3a71
+  data.tar.gz: 5744d31b2ab94f6307d42e02362c40288744780cd1056fcc1837bbd1225205a8c3bf191beb1f7b88d36c4897d5c1941764a4f790b756fd2e3234c08af495d46a

data/README.md

@@ -1,4 +1,4 @@
-# Fretboard for Guitar
+# Fretboard
 
 Tools for working with the guitar fretboard.
 
@@ -7,7 +7,7 @@ Tools for working with the guitar fretboard.
 ## Installation
 
 ```ruby
-gem 'fretboard'
+gem "fretboard"
 ```
 
 ## Using
@@ -15,12 +15,12 @@ gem 'fretboard'
 ### Creates a fretboard with the specified tuning
 
 ```ruby
-fretboard = Fretboard::Builder.new(:standart)
+fretboard = Fretboard::Builder.new(:standard)
 # or
-fretboard = Fretboard::Builder.standart
+fretboard = Fretboard::Builder.standard
 ```
 
-[Available tunings](#available-tunings)
+[Supported guitar tunings](#supported-guitar-tunings)
 
 Creating the fretboard data:
 
@@ -55,17 +55,80 @@ fretboard.draw
 
 ### Using from the console
 
+#### Drawing the fretboard
+
 ```
-bundle exec fretboard --draw-tuning standart
+bundle exec fretboard --draw-tuning standard
 ```
 
-## Available tunings
+<details>
+  <summary>Result</summary>
+
+  ```
+  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  | № | 0 | 1     | 2     | 3     | 4     | 5 | 6     | 7     | 8     | 9     | 10 | 11    | 12 |
+  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  | 1 | E | F     | F#/Gb | G     | G#/Ab | A | A#/Bb | B     | C     | C#/Db | D  | D#/Eb | E  |
+  | 2 | B | C     | C#/Db | D     | D#/Eb | E | F     | F#/Gb | G     | G#/Ab | A  | A#/Bb | B  |
+  | 3 | G | G#/Ab | A     | A#/Bb | B     | C | C#/Db | D     | D#/Eb | E     | F  | F#/Gb | G  |
+  | 4 | D | D#/Eb | E     | F     | F#/Gb | G | G#/Ab | A     | A#/Bb | B     | C  | C#/Db | D  |
+  | 5 | A | A#/Bb | B     | C     | C#/Db | D | D#/Eb | E     | F     | F#/Gb | G  | G#/Ab | A  |
+  | 6 | E | F     | F#/Gb | G     | G#/Ab | A | A#/Bb | B     | C     | C#/Db | D  | D#/Eb | E  |
+  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  ```
+</details>
+
+#### Getting a list of supported guitar tunings
+
+```
+bundle exec fretboard --draw-tuning standard
+```
+
+<details>
+  <summary>Result</summary>
+
+  ```
+  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  | Tuning        | Notes                                |
+  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  | STANDARD      | E, B, G, D, A, E                     |
+  | TUNING_A      | A, E, C, G, D, A                     |
+  | OPEN_A        | E, A, E, C#/Db, A, E                 |
+  | DROP_A        | B, F#/Gb, D, A, E, A                 |
+  | DROP_A_SHARP  | C, G, D#/Eb, A#/Bb, F, A#/Bb         |
+  | DROP_A_FLAT   | A#/Bb, F, C#/Db, G#/Ab, D#/Eb, G#/Ab |
+  | TUNING_B      | B, F#/Gb, D, A, E, B                 |
+  | OPEN_B        | D#/Eb, B, F#/Gb, B, F#/Gb, B         |
+  | DROP_B        | C#/Db, G#/Ab, E, B, F#/Gb, B         |
+  | DROP_B_FLAT   | C, G, D#/Eb, A#/Bb, F, A#/Bb         |
+  | TUNING_C      | C, G, D#/Eb, A#/Bb, F, C             |
+  | OPEN_C        | E, C, G, C, G, C                     |
+  | DROP_C        | D, A, F, C, G, C                     |
+  | TUNING_D      | D, A, F, C, G, D                     |
+  | OPEN_D        | D, A, F#/Gb, D, A, D                 |
+  | OPEN_D_MINOR  | D, A, F, D, A, D                     |
+  | DROP_D        | E, B, G, D, A, D                     |
+  | DOUBLE_DROP_D | D, B, G, D, A, D                     |
+  | MODAL_D       | D, A, G, D, A, D                     |
+  | OPEN_E        | E, B, G#/Ab, E, B, E                 |
+  | TUNING_F      | F, C, G#/Ab, D#/Eb, A#/Bb, F         |
+  | TUNING_G      | G, D, A#/Bb, F, C, G                 |
+  | OPEN_F        | F, C, F, C, A, F                     |
+  | OPEN_G        | D, B, G, D, G, D                     |
+  | OPEN_G_MINOR  | D, A#/Bb, G, D, G, D                 |
+  | DROP_G_SHARP  | A#/Bb, F, C#/Db, G#/Ab, D#/Eb, G#/Ab |
+  | MODAL_G       | D, C, G, D, G, D                     |
+  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  ```
+</details>
+
+## Supported guitar tunings
 
 <details>
-  <summary>Standart (standart)</summary>
+  <summary>Standard (standard)</summary>
 
   ```
-  bundle exec fretboard --draw-tuning standart
+  bundle exec fretboard --draw-tuning standard
   ```
 
   ```

data/bin/fretboard

@@ -1,14 +1,12 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-unless File.exist?('./Gemfile')
-  abort 'Please run fretboard from the root of the project'
-end
+abort "Please run fretboard from the root of the project" unless File.exist?("./Gemfile")
 
-require 'rubygems'
+require "rubygems"
 
 begin
-  require 'bundler'
+  require "bundler"
   Bundler.setup
 rescue StandardError
   # ...
@@ -16,6 +14,6 @@ end
 
 $LOAD_PATH << "#{__dir__}/../lib"
 
-require 'fretboard/parser'
+require "fretboard/parser"
 
 Fretboard::Parser.parse(ARGV)

data/lib/fretboard/builder.rb

@@ -2,12 +2,12 @@
 
 # require 'active_support/core_ext/hash'
 
-require 'fretboard/console'
+require "fretboard/console"
 
 module Fretboard
-  class Builder # rubocop:disable Style/Documentation, Metrics/ClassLength
-    # fretboard = Fretboard::Builder.new(:standart)
-    # fretboard = Fretboard::Builder.standart
+  class Builder # rubocop:disable Metrics/ClassLength
+    # fretboard = Fretboard::Builder.new(:standard)
+    # fretboard = Fretboard::Builder.standard
     # fretboard = Fretboard::Builder.tuning_a
     # fretboard = Fretboard::Builder.open_a
     # fretboard = Fretboard::Builder.drop_a
@@ -42,7 +42,7 @@ module Fretboard
     DEFAULT_NUMBER_OF_FRETS = 12
 
     # METHODS_NAMES = %i[
-    #   standart
+    #   standard
     #   tuning_a
     #   open_a
     #   drop_a
@@ -79,8 +79,8 @@ module Fretboard
     #   end
     # end
 
-    def self.standart(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:standart, number_of_frets)
+    def self.standard(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
+      new(:standard, number_of_frets)
     end
 
     def self.tuning_a(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
@@ -196,24 +196,24 @@ module Fretboard
 
     def build(sharp_or_flat: :both) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       unless Fretboard::Tunings.exists?(@tuning)
-        Fretboard::Console.danger('Unable to detect guitar tuning')
+        Fretboard::Console.danger("Unable to detect guitar tuning")
         return
       end
 
-      tuning = Fretboard::Tunings.get(@tuning)
+      tuning = Fretboard::Tunings.fetch(@tuning)
       strings = tuning[:STRINGS]
       number_of_strings = strings.size
 
       (1..number_of_strings).each do |string_number|
-        puts
-        puts "String: #{string_number}"
-        puts
+        # puts
+        # puts "String: #{string_number}"
+        # puts
 
         current_note = strings[string_number][:NOTE]
 
         @data[string_number] = {}
 
-        puts "Fret: 0 (#{current_note})"
+        # puts "Fret: 0 (#{current_note})"
 
         @data[string_number][0] = current_note
 
@@ -223,7 +223,7 @@ module Fretboard
             sharp_or_flat: sharp_or_flat
           )
 
-          puts "Fret: #{fret} (#{next_note})"
+          # puts "Fret: #{fret} (#{next_note})"
 
           @data[string_number][fret] = next_note
 
@@ -231,13 +231,13 @@ module Fretboard
         end
       end
 
-      puts
-      puts 'done'
+      # puts
+      # puts 'done'
     end
 
     def draw(sharp_or_flat: :both) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       unless @data.any?
-        Fretboard::Console.danger('Create the data')
+        Fretboard::Console.danger("Build the guitar fretboard data for drawing")
         return
       end
 
@@ -247,7 +247,7 @@ module Fretboard
       @data.each_pair do |string_number, string_notes|
         row = []
 
-        headings << '№'
+        headings << "№"
         row << string_number
 
         headings << 0
@@ -257,7 +257,7 @@ module Fretboard
         if open_note.is_a?(Array)
           open_note = case sharp_or_flat
                       when :both
-                        open_note.join('/')
+                        open_note.join("/")
                       when :sharp
                         open_note.first
                       else

data/lib/fretboard/console.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'colorize'
-require 'terminal-table'
+require "colorize"
+require "terminal-table"
 
 module Fretboard
-  class Console # rubocop:disable Style/Documentation
+  class Console
     def self.log(text)
       new(text, nil).print
     end
@@ -25,7 +25,7 @@ module Fretboard
       table = Terminal::Table.new(
         headings: headings,
         rows: rows,
-        style: { border_x: '~', border_i: '~' }
+        style: { border_x: "~", border_i: "~" }
       )
 
       new(table.to_s, nil).print

data/lib/fretboard/note.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'fretboard/notes'
+require "fretboard/notes"
 
 module Fretboard
-  class Note # rubocop:disable Style/Documentation
+  class Note
     # Fretboard::Note.next_for('C')
     # Fretboard::Note.next_for(['F#', 'Gb'])
     # Fretboard::Note.next_for('F#/Gb')
@@ -14,7 +14,7 @@ module Fretboard
       if note.is_a?(Array)
         note = case sharp_or_flat
                when :both
-                 note.join('/')
+                 note.join("/")
                when :sharp
                  note.first
                else

data/lib/fretboard/notes.rb

@@ -1,34 +1,34 @@
 # frozen_string_literal: true
 
 module Fretboard
-  class Notes # rubocop:disable Style/Documentation
+  class Notes
     # Fretboard::Notes.all(:both)
     # Fretboard::Notes.all(:sharp)
     # Fretboard::Notes.all(:flat)
 
-    BASIS_NOTES = {
-      1 => 'C',
-      2 => ['C#', 'Db'],
-      3 => 'D',
-      4 => ['D#', 'Eb'],
-      5 => 'E',
-      6 => 'F',
-      7 => ['F#', 'Gb'],
-      8 => 'G',
-      9 => ['G#', 'Ab'],
-      10 => 'A',
-      11 => ['A#', 'Bb'],
-      12 => 'B'
+    BASIC_NOTES = {
+      1 => "C",
+      2 => %w[C# Db],
+      3 => "D",
+      4 => %w[D# Eb],
+      5 => "E",
+      6 => "F",
+      7 => %w[F# Gb],
+      8 => "G",
+      9 => %w[G# Ab],
+      10 => "A",
+      11 => %w[A# Bb],
+      12 => "B"
     }.freeze
 
     def self.all(sharp_or_flat = :sharp) # rubocop:disable Metrics/MethodLength
-      BASIS_NOTES.map do |_key, value|
+      BASIC_NOTES.map do |_key, value|
         result = value
 
         if value.is_a?(Array)
           result = case sharp_or_flat
                    when :both
-                     value.join('/')
+                     value.join("/")
                    when :sharp
                      value.first
                    else

data/lib/fretboard/parser.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require 'active_support/core_ext/object/blank'
-require 'optparse'
+require "active_support/core_ext/object/blank"
+require "optparse"
 
-require 'fretboard/builder'
-require 'fretboard/console'
-require 'fretboard/note'
-require 'fretboard/tunings'
+require "fretboard/builder"
+require "fretboard/console"
+require "fretboard/note"
+require "fretboard/tunings"
 
 module Fretboard
-  class Parser # rubocop:disable Style/Documentation
+  class Parser
     attr_reader :args
 
     def self.parse(args)
@@ -30,23 +30,27 @@ module Fretboard
 
     def parser # rubocop:disable Metrics/MethodLength
       OptionParser.new do |opts|
-        opts.banner = 'Usage: fretboard [options]'
+        opts.banner = "Usage: fretboard [options]"
 
-        opts.on('-v', '--version', 'The current version of the gem') do
+        opts.on("-v", "--version", "The current version of the gem") do
           Fretboard::Console.log(Fretboard::VERSION)
           exit
         end
 
-        opts.on('-h', '--help', 'Prints this help') do
+        opts.on("-h", "--help", "Prints this help") do
           Fretboard::Console.log(opts.to_s)
           exit
         end
 
-        opts.on('--draw-tuning CODE', 'Build a guitar tuning') do |code|
+        opts.on("-d", "--draw-tuning CODE", "Build a guitar tuning") do |code|
           fretboard = Fretboard::Builder.new(code.to_sym)
           fretboard.build
           fretboard.draw
         end
+
+        opts.on("-l", "--tunings-list", "List of supported guitar tunings") do
+          Fretboard::Tunings.draw_list
+        end
       end
     end
   end

data/lib/fretboard/tunings.rb

@@ -1,311 +1,345 @@
 # frozen_string_literal: true
 
 module Fretboard
-  class Tunings # rubocop:disable Style/Documentation, Metrics/ClassLength
-    # Fretboard::Tunings.get(:standart)
-    # Fretboard::Tunings.exists?(:standart)
+  class Tunings # rubocop:disable Metrics/ClassLength
+    # Fretboard::Tunings.fetch(:standard)
+    # Fretboard::Tunings.exists?(:standard)
 
     TUNINGS = {
-      STANDART: {
+      STANDARD: {
         STRINGS: {
-          1 => { NOTE: 'E' },
-          2 => { NOTE: 'B' },
-          3 => { NOTE: 'G' },
-          4 => { NOTE: 'D' },
-          5 => { NOTE: 'A' },
-          6 => { NOTE: 'E' }
+          1 => { NOTE: "E" },
+          2 => { NOTE: "B" },
+          3 => { NOTE: "G" },
+          4 => { NOTE: "D" },
+          5 => { NOTE: "A" },
+          6 => { NOTE: "E" }
         }
       },
 
       TUNING_A: {
         STRINGS: {
-          1 => { NOTE: 'A' },
-          2 => { NOTE: 'E' },
-          3 => { NOTE: 'C' },
-          4 => { NOTE: 'G' },
-          5 => { NOTE: 'D' },
-          6 => { NOTE: 'A' }
+          1 => { NOTE: "A" },
+          2 => { NOTE: "E" },
+          3 => { NOTE: "C" },
+          4 => { NOTE: "G" },
+          5 => { NOTE: "D" },
+          6 => { NOTE: "A" }
         }
       },
 
       OPEN_A: {
         STRINGS: {
-          1 => { NOTE: 'E' },
-          2 => { NOTE: 'A' },
-          3 => { NOTE: 'E' },
-          4 => { NOTE: ['C#', 'Db'] },
-          5 => { NOTE: 'A' },
-          6 => { NOTE: 'E' }
+          1 => { NOTE: "E" },
+          2 => { NOTE: "A" },
+          3 => { NOTE: "E" },
+          4 => { NOTE: %w[C# Db] },
+          5 => { NOTE: "A" },
+          6 => { NOTE: "E" }
         }
       },
 
       DROP_A: {
         STRINGS: {
-          1 => { NOTE: 'B' },
-          2 => { NOTE: ['F#', 'Gb'] },
-          3 => { NOTE: 'D' },
-          4 => { NOTE: 'A' },
-          5 => { NOTE: 'E' },
-          6 => { NOTE: 'A' }
+          1 => { NOTE: "B" },
+          2 => { NOTE: %w[F# Gb] },
+          3 => { NOTE: "D" },
+          4 => { NOTE: "A" },
+          5 => { NOTE: "E" },
+          6 => { NOTE: "A" }
         }
       },
 
       DROP_A_SHARP: {
         STRINGS: {
-          1 => { NOTE: 'C' },
-          2 => { NOTE: 'G' },
-          3 => { NOTE: ['D#', 'Eb'] },
-          4 => { NOTE: ['A#', 'Bb'] },
-          5 => { NOTE: 'F' },
-          6 => { NOTE: ['A#', 'Bb'] }
+          1 => { NOTE: "C" },
+          2 => { NOTE: "G" },
+          3 => { NOTE: %w[D# Eb] },
+          4 => { NOTE: %w[A# Bb] },
+          5 => { NOTE: "F" },
+          6 => { NOTE: %w[A# Bb] }
         }
       },
 
       DROP_A_FLAT: {
         STRINGS: {
-          1 => { NOTE: ['A#', 'Bb'] },
-          2 => { NOTE: 'F' },
-          3 => { NOTE: ['C#', 'Db'] },
-          4 => { NOTE: ['G#', 'Ab'] },
-          5 => { NOTE: ['D#', 'Eb'] },
-          6 => { NOTE: ['G#', 'Ab'] }
+          1 => { NOTE: %w[A# Bb] },
+          2 => { NOTE: "F" },
+          3 => { NOTE: %w[C# Db] },
+          4 => { NOTE: %w[G# Ab] },
+          5 => { NOTE: %w[D# Eb] },
+          6 => { NOTE: %w[G# Ab] }
         }
       },
 
       TUNING_B: {
         STRINGS: {
-          1 => { NOTE: 'B' },
-          2 => { NOTE: ['F#', 'Gb'] },
-          3 => { NOTE: 'D' },
-          4 => { NOTE: 'A' },
-          5 => { NOTE: 'E' },
-          6 => { NOTE: 'B' }
+          1 => { NOTE: "B" },
+          2 => { NOTE: %w[F# Gb] },
+          3 => { NOTE: "D" },
+          4 => { NOTE: "A" },
+          5 => { NOTE: "E" },
+          6 => { NOTE: "B" }
         }
       },
 
       OPEN_B: {
         STRINGS: {
-          1 => { NOTE: ['D#', 'Eb'] },
-          2 => { NOTE: 'B' },
-          3 => { NOTE: ['F#', 'Gb'] },
-          4 => { NOTE: 'B' },
-          5 => { NOTE: ['F#', 'Gb'] },
-          6 => { NOTE: 'B' }
+          1 => { NOTE: %w[D# Eb] },
+          2 => { NOTE: "B" },
+          3 => { NOTE: %w[F# Gb] },
+          4 => { NOTE: "B" },
+          5 => { NOTE: %w[F# Gb] },
+          6 => { NOTE: "B" }
         }
       },
 
       DROP_B: {
         STRINGS: {
-          1 => { NOTE: ['C#', 'Db'] },
-          2 => { NOTE: ['G#', 'Ab'] },
-          3 => { NOTE: 'E' },
-          4 => { NOTE: 'B' },
-          5 => { NOTE: ['F#', 'Gb'] },
-          6 => { NOTE: 'B' }
+          1 => { NOTE: %w[C# Db] },
+          2 => { NOTE: %w[G# Ab] },
+          3 => { NOTE: "E" },
+          4 => { NOTE: "B" },
+          5 => { NOTE: %w[F# Gb] },
+          6 => { NOTE: "B" }
         }
       },
 
       DROP_B_FLAT: {
         STRINGS: {
-          1 => { NOTE: 'C' },
-          2 => { NOTE: 'G' },
-          3 => { NOTE: ['D#', 'Eb'] },
-          4 => { NOTE: ['A#', 'Bb'] },
-          5 => { NOTE: 'F' },
-          6 => { NOTE: ['A#', 'Bb'] }
+          1 => { NOTE: "C" },
+          2 => { NOTE: "G" },
+          3 => { NOTE: %w[D# Eb] },
+          4 => { NOTE: %w[A# Bb] },
+          5 => { NOTE: "F" },
+          6 => { NOTE: %w[A# Bb] }
         }
       },
 
       TUNING_C: {
         STRINGS: {
-          1 => { NOTE: 'C' },
-          2 => { NOTE: 'G' },
-          3 => { NOTE: ['D#', 'Eb'] },
-          4 => { NOTE: ['A#', 'Bb'] },
-          5 => { NOTE: 'F' },
-          6 => { NOTE: 'C' }
+          1 => { NOTE: "C" },
+          2 => { NOTE: "G" },
+          3 => { NOTE: %w[D# Eb] },
+          4 => { NOTE: %w[A# Bb] },
+          5 => { NOTE: "F" },
+          6 => { NOTE: "C" }
         }
       },
 
       OPEN_C: {
         STRINGS: {
-          1 => { NOTE: 'E' },
-          2 => { NOTE: 'C' },
-          3 => { NOTE: 'G' },
-          4 => { NOTE: 'C' },
-          5 => { NOTE: 'G' },
-          6 => { NOTE: 'C' }
+          1 => { NOTE: "E" },
+          2 => { NOTE: "C" },
+          3 => { NOTE: "G" },
+          4 => { NOTE: "C" },
+          5 => { NOTE: "G" },
+          6 => { NOTE: "C" }
         }
       },
 
       DROP_C: {
         STRINGS: {
-          1 => { NOTE: 'D' },
-          2 => { NOTE: 'A' },
-          3 => { NOTE: 'F' },
-          4 => { NOTE: 'C' },
-          5 => { NOTE: 'G' },
-          6 => { NOTE: 'C' }
+          1 => { NOTE: "D" },
+          2 => { NOTE: "A" },
+          3 => { NOTE: "F" },
+          4 => { NOTE: "C" },
+          5 => { NOTE: "G" },
+          6 => { NOTE: "C" }
         }
       },
 
       TUNING_D: {
         STRINGS: {
-          1 => { NOTE: 'D' },
-          2 => { NOTE: 'A' },
-          3 => { NOTE: 'F' },
-          4 => { NOTE: 'C' },
-          5 => { NOTE: 'G' },
-          6 => { NOTE: 'D' }
+          1 => { NOTE: "D" },
+          2 => { NOTE: "A" },
+          3 => { NOTE: "F" },
+          4 => { NOTE: "C" },
+          5 => { NOTE: "G" },
+          6 => { NOTE: "D" }
         }
       },
 
       OPEN_D: {
         STRINGS: {
-          1 => { NOTE: 'D' },
-          2 => { NOTE: 'A' },
-          3 => { NOTE: ['F#', 'Gb'] },
-          4 => { NOTE: 'D' },
-          5 => { NOTE: 'A' },
-          6 => { NOTE: 'D' }
+          1 => { NOTE: "D" },
+          2 => { NOTE: "A" },
+          3 => { NOTE: %w[F# Gb] },
+          4 => { NOTE: "D" },
+          5 => { NOTE: "A" },
+          6 => { NOTE: "D" }
         }
       },
 
       OPEN_D_MINOR: {
         STRINGS: {
-          1 => { NOTE: 'D' },
-          2 => { NOTE: 'A' },
-          3 => { NOTE: 'F' },
-          4 => { NOTE: 'D' },
-          5 => { NOTE: 'A' },
-          6 => { NOTE: 'D' }
+          1 => { NOTE: "D" },
+          2 => { NOTE: "A" },
+          3 => { NOTE: "F" },
+          4 => { NOTE: "D" },
+          5 => { NOTE: "A" },
+          6 => { NOTE: "D" }
         }
       },
 
       DROP_D: {
         STRINGS: {
-          1 => { NOTE: 'E' },
-          2 => { NOTE: 'B' },
-          3 => { NOTE: 'G' },
-          4 => { NOTE: 'D' },
-          5 => { NOTE: 'A' },
-          6 => { NOTE: 'D' }
+          1 => { NOTE: "E" },
+          2 => { NOTE: "B" },
+          3 => { NOTE: "G" },
+          4 => { NOTE: "D" },
+          5 => { NOTE: "A" },
+          6 => { NOTE: "D" }
         }
       },
 
       DOUBLE_DROP_D: {
         STRINGS: {
-          1 => { NOTE: 'D' },
-          2 => { NOTE: 'B' },
-          3 => { NOTE: 'G' },
-          4 => { NOTE: 'D' },
-          5 => { NOTE: 'A' },
-          6 => { NOTE: 'D' }
+          1 => { NOTE: "D" },
+          2 => { NOTE: "B" },
+          3 => { NOTE: "G" },
+          4 => { NOTE: "D" },
+          5 => { NOTE: "A" },
+          6 => { NOTE: "D" }
         }
       },
 
       MODAL_D: {
         STRINGS: {
-          1 => { NOTE: 'D' },
-          2 => { NOTE: 'A' },
-          3 => { NOTE: 'G' },
-          4 => { NOTE: 'D' },
-          5 => { NOTE: 'A' },
-          6 => { NOTE: 'D' }
+          1 => { NOTE: "D" },
+          2 => { NOTE: "A" },
+          3 => { NOTE: "G" },
+          4 => { NOTE: "D" },
+          5 => { NOTE: "A" },
+          6 => { NOTE: "D" }
         }
       },
 
       OPEN_E: {
         STRINGS: {
-          1 => { NOTE: 'E' },
-          2 => { NOTE: 'B' },
-          3 => { NOTE: ['G#', 'Ab'] },
-          4 => { NOTE: 'E' },
-          5 => { NOTE: 'B' },
-          6 => { NOTE: 'E' }
+          1 => { NOTE: "E" },
+          2 => { NOTE: "B" },
+          3 => { NOTE: %w[G# Ab] },
+          4 => { NOTE: "E" },
+          5 => { NOTE: "B" },
+          6 => { NOTE: "E" }
         }
       },
 
       TUNING_F: {
         STRINGS: {
-          1 => { NOTE: 'F' },
-          2 => { NOTE: 'C' },
-          3 => { NOTE: ['G#', 'Ab'] },
-          4 => { NOTE: ['D#', 'Eb'] },
-          5 => { NOTE: ['A#', 'Bb'] },
-          6 => { NOTE: 'F' }
+          1 => { NOTE: "F" },
+          2 => { NOTE: "C" },
+          3 => { NOTE: %w[G# Ab] },
+          4 => { NOTE: %w[D# Eb] },
+          5 => { NOTE: %w[A# Bb] },
+          6 => { NOTE: "F" }
         }
       },
 
       TUNING_G: {
         STRINGS: {
-          1 => { NOTE: 'G' },
-          2 => { NOTE: 'D' },
-          3 => { NOTE: ['A#', 'Bb'] },
-          4 => { NOTE: 'F' },
-          5 => { NOTE: 'C' },
-          6 => { NOTE: 'G' }
+          1 => { NOTE: "G" },
+          2 => { NOTE: "D" },
+          3 => { NOTE: %w[A# Bb] },
+          4 => { NOTE: "F" },
+          5 => { NOTE: "C" },
+          6 => { NOTE: "G" }
         }
       },
 
       OPEN_F: {
         STRINGS: {
-          1 => { NOTE: 'F' },
-          2 => { NOTE: 'C' },
-          3 => { NOTE: 'F' },
-          4 => { NOTE: 'C' },
-          5 => { NOTE: 'A' },
-          6 => { NOTE: 'F' }
+          1 => { NOTE: "F" },
+          2 => { NOTE: "C" },
+          3 => { NOTE: "F" },
+          4 => { NOTE: "C" },
+          5 => { NOTE: "A" },
+          6 => { NOTE: "F" }
         }
       },
 
       OPEN_G: {
         STRINGS: {
-          1 => { NOTE: 'D' },
-          2 => { NOTE: 'B' },
-          3 => { NOTE: 'G' },
-          4 => { NOTE: 'D' },
-          5 => { NOTE: 'G' },
-          6 => { NOTE: 'D' }
+          1 => { NOTE: "D" },
+          2 => { NOTE: "B" },
+          3 => { NOTE: "G" },
+          4 => { NOTE: "D" },
+          5 => { NOTE: "G" },
+          6 => { NOTE: "D" }
         }
       },
 
       OPEN_G_MINOR: {
         STRINGS: {
-          1 => { NOTE: 'D' },
-          2 => { NOTE: ['A#', 'Bb'] },
-          3 => { NOTE: 'G' },
-          4 => { NOTE: 'D' },
-          5 => { NOTE: 'G' },
-          6 => { NOTE: 'D' }
+          1 => { NOTE: "D" },
+          2 => { NOTE: %w[A# Bb] },
+          3 => { NOTE: "G" },
+          4 => { NOTE: "D" },
+          5 => { NOTE: "G" },
+          6 => { NOTE: "D" }
         }
       },
 
       DROP_G_SHARP: {
         STRINGS: {
-          1 => { NOTE: ['A#', 'Bb'] },
-          2 => { NOTE: 'F' },
-          3 => { NOTE: ['C#', 'Db'] },
-          4 => { NOTE: ['G#', 'Ab'] },
-          5 => { NOTE: ['D#', 'Eb'] },
-          6 => { NOTE: ['G#', 'Ab'] }
+          1 => { NOTE: %w[A# Bb] },
+          2 => { NOTE: "F" },
+          3 => { NOTE: %w[C# Db] },
+          4 => { NOTE: %w[G# Ab] },
+          5 => { NOTE: %w[D# Eb] },
+          6 => { NOTE: %w[G# Ab] }
         }
       },
 
       MODAL_G: {
         STRINGS: {
-          1 => { NOTE: 'D' },
-          2 => { NOTE: 'C' },
-          3 => { NOTE: 'G' },
-          4 => { NOTE: 'D' },
-          5 => { NOTE: 'G' },
-          6 => { NOTE: 'D' }
+          1 => { NOTE: "D" },
+          2 => { NOTE: "C" },
+          3 => { NOTE: "G" },
+          4 => { NOTE: "D" },
+          5 => { NOTE: "G" },
+          6 => { NOTE: "D" }
         }
       }
     }.freeze
 
-    def self.get(tuning_name)
-      new(tuning_name).get
+    private_constant :TUNINGS
+
+    def self.list
+      TUNINGS
+    end
+
+    def self.draw_list # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      headings = []
+      rows = []
+
+      headings << "Tuning"
+      headings << "Notes"
+
+      list.each do |tuning_code, tuning_data|
+        row = []
+
+        row << tuning_code
+
+        prepared_string_notes = tuning_data[:STRINGS].map do |_string_number, string_notes|
+          note = string_notes[:NOTE]
+
+          note.is_a?(Array) ? note.join("/") : note
+        end.join(", ")
+
+        row << prepared_string_notes
+
+        rows << row
+      end
+
+      Fretboard::Console.print_table(headings.uniq, rows)
+
+      nil
+    end
+
+    def self.fetch(tuning_name)
+      new(tuning_name).fetch
     end
 
     def self.exists?(tuning_name)
@@ -316,7 +350,7 @@ module Fretboard
       @tuning_name = tuning_name.upcase.to_sym
     end
 
-    def get
+    def fetch
       TUNINGS[@tuning_name]
     end
 

data/lib/fretboard/version.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
 module Fretboard
-  MAJOR = 1
-  MINOR = 4
-  PATCH = 3
+  module VERSION
+    MAJOR = 1
+    MINOR = 5
+    PATCH = 1
 
-  VERSION = [
-    MAJOR,
-    MINOR,
-    PATCH
-  ].join('.')
+    STRING = [MAJOR, MINOR, PATCH].join(".")
+  end
 end

data/lib/fretboard.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'fretboard/builder'
+require "fretboard/builder"
 # require 'fretboard/constants'
-require 'fretboard/note'
-require 'fretboard/notes'
-require 'fretboard/tunings'
+require "fretboard/note"
+require "fretboard/notes"
+require "fretboard/tunings"
 
 module Fretboard
   # extend Constants

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fretboard
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.1
 platform: ruby
 authors:
 - Anton Sokolov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-20 00:00:00.000000000 Z
+date: 2023-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,69 +16,80 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.0.3
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.0.3
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.29.1
+        version: '1.50'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.29.1
+        version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
 description: Tools for working with the guitar fretboard
 email:
-- anton@sokolov.digital
+- profox.rus@gmail.com
 executables:
 - fretboard
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE.md
 - README.md
-- RELEASE.md
 - bin/fretboard
-- fretboard.gemspec
 - lib/fretboard.rb
 - lib/fretboard/builder.rb
 - lib/fretboard/console.rb
@@ -91,7 +102,12 @@ files:
 homepage: https://github.com/afuno/fretboard
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/afuno/fretboard
+  documentation_uri: https://github.com/afuno/fretboard
+  source_code_uri: https://github.com/afuno/fretboard
+  bug_tracker_uri: https://github.com/afuno/fretboard/issues
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -100,7 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/LICENSE.md

@@ -1,21 +0,0 @@
-# MIT LICENSE
-
-Copyright (c) 2020 Anton Sokolov <anton@sokolov.digital>
-
-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/RELEASE.md

@@ -1,7 +0,0 @@
-```shell
-gem build fretboard.gemspec
-
-gem push fretboard-1.4.3.gem
-
-gem push --key github --host https://rubygems.pkg.github.com/afuno fretboard-1.4.3.gem
-```

data/fretboard.gemspec

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'fretboard/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'fretboard'
-  spec.version       = Fretboard::VERSION
-  spec.platform      = Gem::Platform::RUBY
-  spec.authors       = ['Anton Sokolov']
-  spec.email         = ['anton@sokolov.digital']
-  spec.homepage      = 'https://github.com/afuno/fretboard'
-  spec.licenses      = ['MIT']
-  spec.summary       = 'Tools for working with the guitar fretboard'
-  spec.description   = 'Tools for working with the guitar fretboard'
-
-  spec.files         = `git ls-files -z *.md *.gemspec bin lib`.split("\x0")
-  spec.require_paths = ['lib']
-
-  spec.executables   = ['fretboard']
-
-  spec.required_ruby_version = '>= 3.1.0'
-
-  spec.add_dependency 'activesupport', '~> 7.0.3'
-  spec.add_dependency 'colorize', '~> 0.8.1'
-  spec.add_dependency 'terminal-table', '~> 3.0.1'
-  spec.add_development_dependency 'rubocop', '~> 1.29.1'
-end