fretboard 1.4.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2aeb1806f3f22ec8707add870368e8485214f99090e6c19c219ae6771d96a9a
-  data.tar.gz: 6cb78c994692eeb29d30f366a15020114608e2cf3c1f82170ca1fff17be8e630
+  metadata.gz: e986ef81e9af0a26b46ff706a6cd63cb4b9f9635eb61fe4a52c0b4e2056d2d63
+  data.tar.gz: 07b4ef762cc5b654cae33669c91a9f96c32e2b1bc1e068328600ff2eefa874c4
 SHA512:
-  metadata.gz: c45b527d086a79808cd21a980ca863446c434825bfb194aaf5a6fd1c17e90d82e121175da5fb797b4e963af96aa4ca98a6395d0c9602db8230c603b777c3da6b
-  data.tar.gz: 33762c5bea84f8609e430313e7791998ef0c7d430b8f70f1955d3b3ceb671e2bb37fb5d3ada4b32bc86820b6127951a9de58a478d0acc1abb97d709faac7eb4e
+  metadata.gz: c6fcfc957583acdc5208c9e1cb44d2ed4f1d3e0ea28399a55890388a772cca48cd6ef3a90ac27ff130e784de41cae9ab90a5b4085f6bce0b2c1346d25c18bf4f
+  data.tar.gz: dceda2b4fa1cc80172c4f5ee060cd8d849613b5fd7c9bd676152e5ebf01f56639bb4b7e44f00aa78bd0879bb327b111cb671e15cdbdc6493b8be6398242fe785

data/README.md

@@ -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/RELEASE.md

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

data/bin/fretboard

@@ -1,9 +1,7 @@
 #!/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'
 

data/fretboard.gemspec

@@ -21,10 +21,12 @@ Gem::Specification.new do |spec|
 
   spec.executables   = ['fretboard']
 
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
   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'
+  spec.add_dependency 'terminal-table', '~> 3.0.2'
+  spec.add_development_dependency 'rubocop', '~> 1.37.1'
 end

data/lib/fretboard/builder.rb

@@ -6,8 +6,8 @@ require 'fretboard/console'
 
 module Fretboard
   class Builder # rubocop:disable Style/Documentation, Metrics/ClassLength
-    # fretboard = Fretboard::Builder.new(:standart)
-    # fretboard = Fretboard::Builder.standart
+    # 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)
@@ -200,30 +200,30 @@ module Fretboard
         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
 
         (1..@number_of_frets).each do |fret|
           next_note = Fretboard::Note.next_for(
             current_note,
-            sharp_or_flat: 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
 

data/lib/fretboard/console.rb

@@ -23,8 +23,8 @@ module Fretboard
 
     def self.print_table(headings, rows)
       table = Terminal::Table.new(
-        headings: headings,
-        rows: rows,
+        headings:,
+        rows:,
         style: { border_x: '~', border_i: '~' }
       )
 

data/lib/fretboard/parser.rb

@@ -42,11 +42,15 @@ module Fretboard
           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

@@ -2,11 +2,11 @@
 
 module Fretboard
   class Tunings # rubocop:disable Style/Documentation, Metrics/ClassLength
-    # Fretboard::Tunings.get(:standart)
-    # Fretboard::Tunings.exists?(:standart)
+    # Fretboard::Tunings.fetch(:standard)
+    # Fretboard::Tunings.exists?(:standard)
 
     TUNINGS = {
-      STANDART: {
+      STANDARD: {
         STRINGS: {
           1 => { NOTE: 'E' },
           2 => { NOTE: 'B' },
@@ -304,8 +304,42 @@ module Fretboard
       }
     }.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

@@ -2,8 +2,8 @@
 
 module Fretboard
   MAJOR = 1
-  MINOR = 4
-  PATCH = 3
+  MINOR = 5
+  PATCH = 0
 
   VERSION = [
     MAJOR,

data/lib/fretboard.rb

@@ -6,6 +6,6 @@ require 'fretboard/note'
 require 'fretboard/notes'
 require 'fretboard/tunings'
 
-module Fretboard
+module Fretboard # rubocop:disable Style/Documentation
   # extend Constants
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fretboard
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.0
 platform: ruby
 authors:
 - Anton Sokolov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-20 00:00:00.000000000 Z
+date: 2022-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 3.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 3.0.2
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.29.1
+        version: 1.37.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.29.1
+        version: 1.37.1
 description: Tools for working with the guitar fretboard
 email:
 - anton@sokolov.digital
@@ -91,7 +91,8 @@ files:
 homepage: https://github.com/afuno/fretboard
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: