fretboard 1.5.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 032557dece35cf1703114d36c92d5c5cd24bff99f3b359423559503630dcd5f6
-  data.tar.gz: 622a072b59c2d7f0e232e20032bd454651ffe89a25f5c0efb1686372c9416873
+  metadata.gz: 8fe73d0ec9fe65459863a1d69c89db528176f618484ade07d35b171662e337a2
+  data.tar.gz: 50a49bb50600ddeb7921d09188339a750a83657dcd453e051c2acab32ac5eb98
 SHA512:
-  metadata.gz: 37ef216fad26e45060ac600273bc4a078fa677b13231b8aed014814c27bfbad5e15543136593823ab0e2262ee366ab958e982cefb0bfc88e8b3a8fa6294c3a71
-  data.tar.gz: 5744d31b2ab94f6307d42e02362c40288744780cd1056fcc1837bbd1225205a8c3bf191beb1f7b88d36c4897d5c1941764a4f790b756fd2e3234c08af495d46a
+  metadata.gz: 01bdd0af72cb6b621dd6a9232397253f5aceed7aafd416863bdcf4e61a4d6505b0a4df6987f3000ed17e1c7e99a46fdbef3ff787d8288fce41fe2cef597957eb
+  data.tar.gz: fd464320449062acd34e8da6218297fa8787783b0812506980db6ce595291bd836f7514e31cef832831135c0de00d53ac118242cc3c1014b98e28c57eaef188b

data/README.md

@@ -1,18 +1,40 @@
+<div align="center">
+
 # Fretboard
 
 Tools for working with the guitar fretboard.
 
-[Documentation](https://www.rubydoc.info/gems/fretboard)
+</div>
+
+<div align="center">
+
+[![Gem version](https://img.shields.io/gem/v/fretboard?logo=rubygems&logoColor=fff)](https://rubygems.org/gems/fretboard)
+[![Release Date](https://img.shields.io/github/release-date/afuno/fretboard)](https://github.com/afuno/fretboard/releases)
+[![Downloads](https://img.shields.io/gem/dt/fretboard)](https://rubygems.org/gems/fretboard)
+[![Ruby version](https://img.shields.io/badge/Ruby-3.2+-red)](https://github.com/afuno/fretboard)
+
+</div>
+
+## 💡 Why Fretboard?
+
+- 🎸 **27 Guitar Tunings** — Standard, Open, Drop, Modal and more
+- 🎹 **Chromatic Notes** — Full sharp/flat notation support
+- 📊 **Visual Fretboard** — ASCII table rendering in console
+- ⚡ **CLI Tool** — Draw any tuning from the command line
+- 🔧 **Ruby API** — Programmable fretboard data builder
+- 🛤️ **Rails Ready** — Built-in Rails::Engine for integration
+
+## 🚀 Quick Start
 
-## Installation
+### Installation
 
 ```ruby
 gem "fretboard"
 ```
 
-## Using
+### Ruby API
 
-### Creates a fretboard with the specified tuning
+Creates a fretboard with the specified tuning:
 
 ```ruby
 fretboard = Fretboard::Builder.new(:standard)
@@ -20,7 +42,7 @@ fretboard = Fretboard::Builder.new(:standard)
 fretboard = Fretboard::Builder.standard
 ```
 
-[Supported guitar tunings](#supported-guitar-tunings)
+[Supported guitar tunings](#-supported-guitar-tunings)
 
 Creating the fretboard data:
 
@@ -53,9 +75,9 @@ fretboard.draw
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 ```
 
-### Using from the console
+### CLI
 
-#### Drawing the fretboard
+Drawing the fretboard:
 
 ```
 bundle exec fretboard --draw-tuning standard
@@ -78,10 +100,10 @@ bundle exec fretboard --draw-tuning standard
   ```
 </details>
 
-#### Getting a list of supported guitar tunings
+Getting a list of supported guitar tunings:
 
 ```
-bundle exec fretboard --draw-tuning standard
+bundle exec fretboard --tunings-list
 ```
 
 <details>
@@ -122,7 +144,39 @@ bundle exec fretboard --draw-tuning standard
   ```
 </details>
 
-## Supported guitar tunings
+## 🎵 Supported Guitar Tunings
+
+| 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# | C, G, D#/Eb, A#/Bb, F, A#/Bb |
+| Drop Ab | 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 Bb | 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# | A#/Bb, F, C#/Db, G#/Ab, D#/Eb, G#/Ab |
+| Modal G | D, C, G, D, G, D |
+
+### Fretboard Diagrams
 
 <details>
   <summary>Standard (standard)</summary>
@@ -146,7 +200,7 @@ bundle exec fretboard --draw-tuning standard
 </details>
 
 <details>
-  <summary>A Tuning (tuning_a)</summary>
+  <summary>Tuning A (tuning_a)</summary>
 
   ```
   bundle exec fretboard --draw-tuning tuning_a
@@ -251,7 +305,7 @@ bundle exec fretboard --draw-tuning standard
 </details>
 
 <details>
-  <summary>B Tuning (tuning_b)</summary>
+  <summary>Tuning B (tuning_b)</summary>
 
   ```
   bundle exec fretboard --draw-tuning tuning_b
@@ -335,7 +389,7 @@ bundle exec fretboard --draw-tuning standard
 </details>
 
 <details>
-  <summary>C Tuning (tuning_c)</summary>
+  <summary>Tuning C (tuning_c)</summary>
 
   ```
   bundle exec fretboard --draw-tuning tuning_c
@@ -398,7 +452,7 @@ bundle exec fretboard --draw-tuning standard
 </details>
 
 <details>
-  <summary>D Tuning (tuning_d)</summary>
+  <summary>Tuning D (tuning_d)</summary>
 
   ```
   bundle exec fretboard --draw-tuning tuning_d
@@ -545,7 +599,7 @@ bundle exec fretboard --draw-tuning standard
 </details>
 
 <details>
-  <summary>F Tuning (tuning_f)</summary>
+  <summary>Tuning F (tuning_f)</summary>
 
   ```
   bundle exec fretboard --draw-tuning tuning_f
@@ -565,6 +619,27 @@ bundle exec fretboard --draw-tuning standard
   ```
 </details>
 
+<details>
+  <summary>Tuning G (tuning_g)</summary>
+
+  ```
+  bundle exec fretboard --draw-tuning tuning_g
+  ```
+
+  ```
+  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  | № | 0     | 1     | 2 | 3     | 4     | 5     | 6     | 7 | 8     | 9 | 10    | 11    | 12    |
+  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  | 1 | G     | G#/Ab | A | A#/Bb | B     | C     | C#/Db | D | D#/Eb | E | F     | F#/Gb | G     |
+  | 2 | D     | D#/Eb | E | F     | F#/Gb | G     | G#/Ab | A | A#/Bb | B | C     | C#/Db | D     |
+  | 3 | A#/Bb | B     | C | C#/Db | D     | D#/Eb | E     | F | F#/Gb | G | G#/Ab | A     | A#/Bb |
+  | 4 | F     | F#/Gb | G | G#/Ab | A     | A#/Bb | B     | C | C#/Db | D | D#/Eb | E     | F     |
+  | 5 | C     | C#/Db | D | D#/Eb | E     | F     | F#/Gb | G | G#/Ab | A | A#/Bb | B     | C     |
+  | 6 | G     | G#/Ab | A | A#/Bb | B     | C     | C#/Db | D | D#/Eb | E | F     | F#/Gb | G     |
+  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  ```
+</details>
+
 <details>
   <summary>Open F (open_f)</summary>
 
@@ -586,27 +661,6 @@ bundle exec fretboard --draw-tuning standard
   ```
 </details>
 
-<details>
-  <summary>G Tuning (tuning_g)</summary>
-
-  ```
-  bundle exec fretboard --draw-tuning tuning_g
-  ```
-
-  ```
-  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-  | № | 0     | 1     | 2 | 3     | 4     | 5     | 6     | 7 | 8     | 9 | 10    | 11    | 12    |
-  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-  | 1 | G     | G#/Ab | A | A#/Bb | B     | C     | C#/Db | D | D#/Eb | E | F     | F#/Gb | G     |
-  | 2 | D     | D#/Eb | E | F     | F#/Gb | G     | G#/Ab | A | A#/Bb | B | C     | C#/Db | D     |
-  | 3 | A#/Bb | B     | C | C#/Db | D     | D#/Eb | E     | F | F#/Gb | G | G#/Ab | A     | A#/Bb |
-  | 4 | F     | F#/Gb | G | G#/Ab | A     | A#/Bb | B     | C | C#/Db | D | D#/Eb | E     | F     |
-  | 5 | C     | C#/Db | D | D#/Eb | E     | F     | F#/Gb | G | G#/Ab | A | A#/Bb | B     | C     |
-  | 6 | G     | G#/Ab | A | A#/Bb | B     | C     | C#/Db | D | D#/Eb | E | F     | F#/Gb | G     |
-  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-  ```
-</details>
-
 <details>
   <summary>Open G (open_g)</summary>
 
@@ -690,3 +744,23 @@ bundle exec fretboard --draw-tuning standard
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   ```
 </details>
+
+## 🤝 Contributing
+
+We welcome contributions! Here are some ways you can help:
+
+- 🐛 Report bugs and issues
+- 💡 Suggest new features
+- 📝 Improve documentation
+- 🧪 Add test cases
+- 🔧 Submit pull requests
+
+Please read our [Contributing Guide](./CONTRIBUTING.md) before submitting a pull request.
+
+## 🙏 Acknowledgments
+
+Thank you to all [contributors](https://github.com/afuno/fretboard/graphs/contributors) who have helped make Fretboard better!
+
+## 📄 License
+
+Fretboard is available as open source under the terms of the [MIT License](./LICENSE.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/fretboard

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

data/lib/fretboard/builder.rb

@@ -1,190 +1,15 @@
 # frozen_string_literal: true
 
-# require 'active_support/core_ext/hash'
-
-require "fretboard/console"
-
 module Fretboard
-  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
-    # fretboard = Fretboard::Builder.drop_a_sharp
-    # fretboard = Fretboard::Builder.drop_a_flat
-    # fretboard = Fretboard::Builder.tuning_b
-    # fretboard = Fretboard::Builder.open_b
-    # fretboard = Fretboard::Builder.drop_b
-    # fretboard = Fretboard::Builder.drop_b_flat
-    # fretboard = Fretboard::Builder.tuning_c
-    # fretboard = Fretboard::Builder.open_c
-    # fretboard = Fretboard::Builder.drop_c
-    # fretboard = Fretboard::Builder.tuning_d
-    # fretboard = Fretboard::Builder.open_d
-    # fretboard = Fretboard::Builder.open_d_minor
-    # fretboard = Fretboard::Builder.drop_d
-    # fretboard = Fretboard::Builder.double_drop_d
-    # fretboard = Fretboard::Builder.modal_d
-    # fretboard = Fretboard::Builder.open_e
-    # fretboard = Fretboard::Builder.tuning_f
-    # fretboard = Fretboard::Builder.open_f
-    # fretboard = Fretboard::Builder.tuning_g
-    # fretboard = Fretboard::Builder.open_g
-    # fretboard = Fretboard::Builder.open_g_minor
-    # fretboard = Fretboard::Builder.drop_g_sharp
-    # fretboard = Fretboard::Builder.modal_g
-
-    # fretboard.build
-    # fretboard.data
-    # fretboard.draw
-
+  class Builder
     DEFAULT_NUMBER_OF_FRETS = 12
 
-    # METHODS_NAMES = %i[
-    #   standard
-    #   tuning_a
-    #   open_a
-    #   drop_a
-    #   drop_a_sharp
-    #   drop_a_flat
-    #   tuning_b
-    #   open_b
-    #   drop_b
-    #   drop_b_flat
-    #   tuning_c
-    #   open_c
-    #   drop_c
-    #   tuning_d
-    #   open_d
-    #   open_d_minor
-    #   drop_d
-    #   double_drop_d
-    #   modal_d
-    #   open_e
-    #   tuning_f
-    #   open_f
-    #   tuning_g
-    #   open_g
-    #   open_g_minor
-    #   drop_g_sharp
-    #   modal_g
-    # ].freeze
-
     attr_reader :data
 
-    # METHODS_NAMES.each do |method_name|
-    #   define_method(method_name) do |number_of_frets = DEFAULT_NUMBER_OF_FRETS|
-    #     new(method_name, number_of_frets)
-    #   end
-    # end
-
-    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)
-      new(:tuning_a, number_of_frets)
-    end
-
-    def self.open_a(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:open_a, number_of_frets)
-    end
-
-    def self.drop_a(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:drop_a, number_of_frets)
-    end
-
-    def self.drop_a_sharp(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:drop_a_sharp, number_of_frets)
-    end
-
-    def self.drop_a_flat(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:drop_a_flat, number_of_frets)
-    end
-
-    def self.tuning_b(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:tuning_b, number_of_frets)
-    end
-
-    def self.open_b(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:open_b, number_of_frets)
-    end
-
-    def self.drop_b(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:drop_b, number_of_frets)
-    end
-
-    def self.drop_b_flat(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:drop_b_flat, number_of_frets)
-    end
-
-    def self.tuning_c(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:tuning_c, number_of_frets)
-    end
-
-    def self.open_c(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:open_c, number_of_frets)
-    end
-
-    def self.drop_c(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:drop_c, number_of_frets)
-    end
-
-    def self.tuning_d(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:tuning_d, number_of_frets)
-    end
-
-    def self.open_d(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:open_d, number_of_frets)
-    end
-
-    def self.open_d_minor(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:open_d_minor, number_of_frets)
-    end
-
-    def self.drop_d(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:drop_d, number_of_frets)
-    end
-
-    def self.double_drop_d(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:double_drop_d, number_of_frets)
-    end
-
-    def self.modal_d(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:modal_d, number_of_frets)
-    end
-
-    def self.open_e(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:open_e, number_of_frets)
-    end
-
-    def self.tuning_f(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:tuning_f, number_of_frets)
-    end
-
-    def self.open_f(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:open_f, number_of_frets)
-    end
-
-    def self.tuning_g(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:tuning_g, number_of_frets)
-    end
-
-    def self.open_g(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:open_g, number_of_frets)
-    end
-
-    def self.open_g_minor(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:open_g_minor, number_of_frets)
-    end
-
-    def self.drop_g_sharp(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:drop_g_sharp, number_of_frets)
-    end
-
-    def self.modal_g(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
-      new(:modal_g, number_of_frets)
+    Fretboard::Tunings.list.each_key do |tuning_name|
+      define_singleton_method(tuning_name.downcase) do |number_of_frets = DEFAULT_NUMBER_OF_FRETS|
+        new(tuning_name, number_of_frets)
+      end
     end
 
     def initialize(tuning, number_of_frets = DEFAULT_NUMBER_OF_FRETS)
@@ -195,51 +20,37 @@ module Fretboard
     end
 
     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")
-        return
-      end
+      raise Fretboard::Exceptions::UnknownTuning, @tuning unless Fretboard::Tunings.exists?(@tuning)
+
+      @sharp_or_flat = sharp_or_flat
 
       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
-
         current_note = strings[string_number][:NOTE]
 
         @data[string_number] = {}
-
-        # 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})"
-
           @data[string_number][fret] = next_note
 
           current_note = next_note
         end
       end
 
-      # puts
-      # puts 'done'
+      self
     end
 
-    def draw(sharp_or_flat: :both) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-      unless @data.any?
-        Fretboard::Console.danger("Build the guitar fretboard data for drawing")
-        return
-      end
+    def draw(sharp_or_flat: @sharp_or_flat || :both) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      raise Fretboard::Exceptions::NotBuilt unless @data.any?
 
       headings = []
       rows = []
@@ -252,18 +63,7 @@ module Fretboard
 
         headings << 0
 
-        open_note = string_notes[0]
-
-        if open_note.is_a?(Array)
-          open_note = case sharp_or_flat
-                      when :both
-                        open_note.join("/")
-                      when :sharp
-                        open_note.first
-                      else
-                        open_note.last
-                      end
-        end
+        open_note = Fretboard::NoteFormatter.format(string_notes[0], sharp_or_flat:)
 
         row << open_note
 

data/lib/fretboard/console.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require "colorize"
-require "terminal-table"
-
 module Fretboard
   class Console
     def self.log(text)
@@ -23,8 +20,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/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Fretboard
+  class Engine < Rails::Engine
+    isolate_namespace Fretboard
+  end
+end

data/lib/fretboard/exceptions/base.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Fretboard
+  module Exceptions
+    class Base < StandardError; end
+  end
+end

data/lib/fretboard/exceptions/not_built.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Fretboard
+  module Exceptions
+    class NotBuilt < Base
+      def initialize(msg = nil)
+        super(msg || "Build the guitar fretboard data for drawing")
+      end
+    end
+  end
+end

data/lib/fretboard/exceptions/unknown_note.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Fretboard
+  module Exceptions
+    class UnknownNote < Base
+      def initialize(note = nil)
+        message = "Unknown note"
+        message = "#{message}: #{note}" if note
+        super(message)
+      end
+    end
+  end
+end

data/lib/fretboard/exceptions/unknown_tuning.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Fretboard
+  module Exceptions
+    class UnknownTuning < Base
+      def initialize(tuning_name = nil)
+        message = "Unable to detect guitar tuning"
+        message = "#{message}: #{tuning_name}" if tuning_name
+        super(message)
+      end
+    end
+  end
+end

data/lib/fretboard/note.rb

@@ -1,38 +1,21 @@
 # frozen_string_literal: true
 
-require "fretboard/notes"
-
 module Fretboard
   class Note
-    # Fretboard::Note.next_for('C')
-    # Fretboard::Note.next_for(['F#', 'Gb'])
-    # Fretboard::Note.next_for('F#/Gb')
-
-    def self.next_for(note, sharp_or_flat: :both) # rubocop:disable Metrics/MethodLength
+    def self.next_for(note, sharp_or_flat: :both)
       all_notes = Fretboard::Notes.all(sharp_or_flat)
 
-      if note.is_a?(Array)
-        note = case sharp_or_flat
-               when :both
-                 note.join("/")
-               when :sharp
-                 note.first
-               else
-                 note.last
-               end
-      end
+      note = Fretboard::NoteFormatter.format(note, sharp_or_flat:)
 
       current_index = all_notes.find_index(note)
+      raise Fretboard::Exceptions::UnknownNote, note if current_index.nil?
+
       next_index = current_index + 1
 
       next_note = all_notes[next_index]
-      next_note = all_notes.first if next_note.blank?
+      next_note = all_notes.first if next_note.nil?
 
       next_note
     end
-
-    def initialize(note)
-      @note = note
-    end
   end
 end

data/lib/fretboard/note_formatter.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Fretboard
+  module NoteFormatter
+    def self.format(note, sharp_or_flat: :both)
+      return note unless note.is_a?(Array)
+
+      case sharp_or_flat
+      when :both then note.join("/")
+      when :sharp then note.first
+      else note.last
+      end
+    end
+  end
+end

data/lib/fretboard/notes.rb

@@ -2,10 +2,6 @@
 
 module Fretboard
   class Notes
-    # Fretboard::Notes.all(:both)
-    # Fretboard::Notes.all(:sharp)
-    # Fretboard::Notes.all(:flat)
-
     BASIC_NOTES = {
       1 => "C",
       2 => %w[C# Db],
@@ -21,22 +17,9 @@ module Fretboard
       12 => "B"
     }.freeze
 
-    def self.all(sharp_or_flat = :sharp) # rubocop:disable Metrics/MethodLength
+    def self.all(sharp_or_flat = :sharp)
       BASIC_NOTES.map do |_key, value|
-        result = value
-
-        if value.is_a?(Array)
-          result = case sharp_or_flat
-                   when :both
-                     value.join("/")
-                   when :sharp
-                     value.first
-                   else
-                     value.last
-                   end
-        end
-
-        result
+        Fretboard::NoteFormatter.format(value, sharp_or_flat:)
       end
     end
 

data/lib/fretboard/parser.rb

@@ -1,13 +1,5 @@
 # frozen_string_literal: true
 
-require "active_support/core_ext/object/blank"
-require "optparse"
-
-require "fretboard/builder"
-require "fretboard/console"
-require "fretboard/note"
-require "fretboard/tunings"
-
 module Fretboard
   class Parser
     attr_reader :args
@@ -22,8 +14,10 @@ module Fretboard
 
     def parse
       parser.parse!(args)
+    rescue Fretboard::Exceptions::Base, OptionParser::ParseError => e
+      Fretboard::Console.danger(e.message)
     rescue StandardError => e
-      Fretboard::Console.danger("Ambiguously completable string is encountered\n#{e}")
+      Fretboard::Console.danger("Unexpected error: #{e.message}")
     end
 
     private
@@ -33,7 +27,7 @@ module Fretboard
         opts.banner = "Usage: fretboard [options]"
 
         opts.on("-v", "--version", "The current version of the gem") do
-          Fretboard::Console.log(Fretboard::VERSION)
+          Fretboard::Console.log(Fretboard::VERSION::STRING)
           exit
         end
 

data/lib/fretboard/tunings.rb

@@ -31,9 +31,9 @@ module Fretboard
       OPEN_A: {
         STRINGS: {
           1 => { NOTE: "E" },
-          2 => { NOTE: "A" },
-          3 => { NOTE: "E" },
-          4 => { NOTE: %w[C# Db] },
+          2 => { NOTE: %w[C# Db] },
+          3 => { NOTE: "A" },
+          4 => { NOTE: "E" },
           5 => { NOTE: "A" },
           6 => { NOTE: "E" }
         }

data/lib/fretboard/version.rb

@@ -2,9 +2,9 @@
 
 module Fretboard
   module VERSION
-    MAJOR = 1
-    MINOR = 5
-    PATCH = 1
+    MAJOR = 2
+    MINOR = 0
+    PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end

data/lib/fretboard.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
-require "fretboard/builder"
-# require 'fretboard/constants'
-require "fretboard/note"
-require "fretboard/notes"
-require "fretboard/tunings"
-
-module Fretboard
-  # extend Constants
-end
+require "zeitwerk"
+
+require "colorize"
+require "optparse"
+require "terminal-table"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module Fretboard; end
+
+require "fretboard/engine" if defined?(Rails::Engine)

metadata

@@ -1,85 +1,98 @@
 --- !ruby/object:Gem::Specification
 name: fretboard
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Anton Sokolov
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: terminal-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: terminal-table
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.50'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.50'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: servactory-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0.9'
 description: Tools for working with the guitar fretboard
 email:
 - profox.rus@gmail.com
@@ -89,12 +102,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- Rakefile
 - bin/fretboard
 - lib/fretboard.rb
 - lib/fretboard/builder.rb
 - lib/fretboard/console.rb
-- lib/fretboard/constants.rb
+- lib/fretboard/engine.rb
+- lib/fretboard/exceptions/base.rb
+- lib/fretboard/exceptions/not_built.rb
+- lib/fretboard/exceptions/unknown_note.rb
+- lib/fretboard/exceptions/unknown_tuning.rb
 - lib/fretboard/note.rb
+- lib/fretboard/note_formatter.rb
 - lib/fretboard/notes.rb
 - lib/fretboard/parser.rb
 - lib/fretboard/tunings.rb
@@ -108,7 +127,6 @@ metadata:
   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:
 - lib
@@ -116,15 +134,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Tools for working with the guitar fretboard
 test_files: []

data/lib/fretboard/constants.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-# module Fretboard
-#   module Constants
-#     # Fretboard::Constants.constants
-#   end
-# end