fretboard 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0a46ecd63bcdc0c371eb2dd055dd49866342e21f44143a1c251e295dc481a25
-  data.tar.gz: da4cf2a0618c6933e2bbd1cf6c9fe5bae055473675afeed7e3970962025a2ba9
+  metadata.gz: b7435bd0a766a28745a79a3741e0b08f3793ca8566ed0ab6cca5c864cba776fd
+  data.tar.gz: 1e6935842f0d1f730c7d9a7fdfd3e5cc18bb525e725b761cd66b3a4b97207dab
 SHA512:
-  metadata.gz: d24330355134a4adf64dc87baff7f992fa2b3e22c409232830079a692686ca590670527f4963d201e8dafe7ae764043e28aa79d422f7c98244c8415f0a8fc17a
-  data.tar.gz: bcb1765254dea7013edab1c462c198c4b140fc73f52bc33b54f4f44bebb99199eec8a3910c9d153bff6be76452087a67ad1d790c9eae89951a947909adb96929
+  metadata.gz: e66075625a1147938126d904ad1f37a5f4b7d44fd18608c87e9c3199a055ada3c401f6d305c5d266ac1b18a4dfdc5dbc68b5d11c1d2d94a37f7538b82b422991
+  data.tar.gz: 8359c7422823e670980a0bde6add31442a7e739f4e725a33053e9db870088feace52360c7fa9f2388db2afcafbb328ff6d623151764885bc5e77f91be406441d

data/README.md

@@ -55,4 +55,10 @@ fretboard.draw
 
 ### Available tunings:
 
-- standart
+- Standart (`standart`)
+- Drop C (`drop_c`)
+- Drop D (`drop_d`)
+- Double Drop D (`double_drop_d`)
+- Open C (`open_c`)
+- Open D (`open_d`)
+- Open G (`open_g`)

data/fretboard.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
 
   # spec.executables   = ['fretboard']
 
-  # spec.add_dependency 'colorize', '~> 0.8.1'
+  spec.add_dependency 'colorize', '~> 0.8.1'
   spec.add_dependency 'terminal-table', '~> 1.8.0'
   spec.add_development_dependency 'rubocop', '= 0.88'
 end

data/lib/fretboard.rb

@@ -1,7 +1,8 @@
-require 'fretboard/constants'
+require 'fretboard/builder'
+# require 'fretboard/constants'
 require 'fretboard/note'
 require 'fretboard/notes'
-require 'fretboard/builder'
+require 'fretboard/tunings'
 
 module Fretboard
   # extend Constants

data/lib/fretboard/builder.rb

@@ -1,33 +1,82 @@
-require 'terminal-table'
+require 'fretboard/console'
 
 module Fretboard
   class Builder
     # fretboard = Fretboard::Builder.new(:standart)
     # fretboard = Fretboard::Builder.standart
+    # fretboard = Fretboard::Builder.drop_c
+    # fretboard = Fretboard::Builder.drop_d
+    # fretboard = Fretboard::Builder.double_drop_d
+    # fretboard = Fretboard::Builder.open_c
+    # fretboard = Fretboard::Builder.open_d
+    # fretboard = Fretboard::Builder.open_g
+
     # fretboard.build
     # fretboard.data
     # fretboard.draw
 
+    DEFAULT_NUMBER_OF_FRETS = 12
+
+    # METHODS_NAMES = %i[
+    #   standart
+    #   drop_c
+    #   drop_d
+    #   double_drop_d
+    #   open_c
+    #   open_d
+    #   open_g
+    # ].freeze
+
     attr_reader :data
 
-    def self.standart(number_of_frets = 12)
+    # 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.standart(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
       new(:standart, number_of_frets)
     end
 
-    def initialize(tuning, number_of_frets = 12)
+    def self.drop_c(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
+      new(:drop_c, 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.open_c(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
+      new(:open_c, 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_g(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
+      new(:open_g, number_of_frets)
+    end
+
+    def initialize(tuning, number_of_frets = DEFAULT_NUMBER_OF_FRETS)
       @tuning = tuning.upcase.to_sym
       @number_of_frets = number_of_frets
 
       @data = {}
     end
 
-    def build
-      unless Fretboard::Constants::GUITAR_TUNINGS.key?(@tuning)
-        puts 'Unable to detect guitar tuning'
+    def build(sharp_or_flat: :both)
+      unless Fretboard::Tunings.exists?(@tuning)
+        Fretboard::Console.danger('Unable to detect guitar tuning')
         return
       end
 
-      tuning = Fretboard::Constants::GUITAR_TUNINGS[@tuning]
+      tuning = Fretboard::Tunings.get(@tuning)
       strings = tuning[:STRINGS]
       number_of_strings = strings.size
 
@@ -47,8 +96,7 @@ module Fretboard
         (1..@number_of_frets).each do |fret|
           next_note = Fretboard::Note.next_for(
             current_note,
-            sharp_or_flat: :both,
-            formated: true
+            sharp_or_flat: sharp_or_flat
           )
 
           puts "Fret: #{fret} (#{next_note})"
@@ -63,7 +111,12 @@ module Fretboard
       puts 'done'
     end
 
-    def draw
+    def draw(sharp_or_flat: :both)
+      unless @data.any?
+        Fretboard::Console.danger('Create the data')
+        return
+      end
+
       headings = []
       rows = []
 
@@ -74,7 +127,20 @@ module Fretboard
         row << string_number
 
         headings << 0
-        row << string_notes[0]
+
+        open_note = string_notes[0]
+
+        if open_note.is_a?(Array)
+          open_note = if sharp_or_flat == :both
+                        open_note.join('/')
+                      elsif sharp_or_flat == :sharp
+                        open_note.first
+                      else
+                        open_note.last
+                      end
+        end
+
+        row << open_note
 
         string_notes.except(0).each_pair do |fret, note|
           headings << fret
@@ -84,13 +150,7 @@ module Fretboard
         rows << row
       end
 
-      table = Terminal::Table.new(
-        headings: headings.uniq,
-        rows: rows,
-        style: { border_x: '~', border_i: '~' }
-      )
-
-      puts table
+      Fretboard::Console.print_table(headings.uniq, rows)
 
       nil
     end

data/lib/fretboard/console.rb

@@ -0,0 +1,41 @@
+require 'colorize'
+require 'terminal-table'
+
+module Fretboard
+  class Console
+    # def self.log(text)
+    #   new(text, nil).print
+    # end
+
+    # def self.success(text)
+    #   new(text, :green).print
+    # end
+
+    # def self.warning(text)
+    #   new(text, :yellow).print
+    # end
+
+    def self.danger(text)
+      new(text, :red).print
+    end
+
+    def self.print_table(headings, rows)
+      table = Terminal::Table.new(
+        headings: headings,
+        rows: rows,
+        style: { border_x: '~', border_i: '~' }
+      )
+
+      new(table.to_s, nil).print
+    end
+
+    def initialize(text, color = nil)
+      @text = text
+      @color = color
+    end
+
+    def print
+      puts @text.colorize(@color)
+    end
+  end
+end

data/lib/fretboard/constants.rb

@@ -1,44 +1,5 @@
 module Fretboard
   module Constants
     # Fretboard::Constants.constants
-
-    # SPN   =>  Scientific pitch notation
-
-    GUITAR_TUNINGS = {
-      STANDART: {
-        STRINGS: {
-          1 => {
-            NOTE: 'E',
-            FREQUENCY: '329.63 Hz',
-            SPN: 'E4'
-          },
-          2 => {
-            NOTE: 'B',
-            FREQUENCY: '246.94 Hz',
-            SPN: 'B3'
-          },
-          3 => {
-            NOTE: 'G',
-            FREQUENCY: '196.00 Hz',
-            SPN: 'G3'
-          },
-          4 => {
-            NOTE: 'D',
-            FREQUENCY: '146.83 Hz',
-            SPN: 'D3'
-          },
-          5 => {
-            NOTE: 'A',
-            FREQUENCY: '110.00 Hz',
-            SPN: 'A2'
-          },
-          6 => {
-            NOTE: 'E',
-            FREQUENCY: '82.41 Hz',
-            SPN: 'E2'
-          }
-        }
-      }
-    }.freeze
   end
 end

data/lib/fretboard/note.rb

@@ -3,13 +3,24 @@ 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: :sharp, formated: false)
+    def self.next_for(note, sharp_or_flat: :both)
       all_notes = Fretboard::Notes.all(
-        sharp_or_flat,
-        formated: formated
+        sharp_or_flat
       )
 
+      if note.is_a?(Array)
+        note = if sharp_or_flat == :both
+                 note.join('/')
+               elsif sharp_or_flat == :sharp
+                 note.first
+               else
+                 note.last
+               end
+      end
+
       current_index = all_notes.find_index(note)
       next_index = current_index + 1
 
@@ -19,24 +30,8 @@ module Fretboard
       next_note
     end
 
-    def self.formated(note)
-      new(note).formated
-    end
-
     def initialize(note)
       @note = note
     end
-
-    def formated
-      result = @note
-
-      result = result.gsub('sharp', '#') if result.include?('sharp')
-
-      if result.include?('flat')
-        result = result.gsub('flat', 'b') # ♭
-      end
-
-      result.gsub(' ', '')
-    end
   end
 end

data/lib/fretboard/notes.rb

@@ -7,34 +7,34 @@ module Fretboard
     BASIS_NOTES = {
       1 => 'C',
       2 => [
-        'C sharp',
-        'D flat'
+        'C#',
+        'Db'
       ],
       3 => 'D',
       4 => [
-        'D sharp',
-        'E flat'
+        'D#',
+        'Eb'
       ],
       5 => 'E',
       6 => 'F',
       7 => [
-        'F sharp',
-        'G flat'
+        'F#',
+        'Gb'
       ],
       8 => 'G',
       9 => [
-        'G sharp',
-        'A flat'
+        'G#',
+        'Ab'
       ],
       10 => 'A',
       11 => [
-        'A sharp',
-        'B flat'
+        'A#',
+        'Bb'
       ],
       12 => 'B'
     }.freeze
 
-    def self.all(sharp_or_flat = :sharp, formated: false)
+    def self.all(sharp_or_flat = :sharp)
       BASIS_NOTES.map do |_key, value|
         result = value
 
@@ -48,11 +48,7 @@ module Fretboard
                    end
         end
 
-        if formated
-          Fretboard::Note.formated(result)
-        else
-          result
-        end
+        result
       end
     end
 

data/lib/fretboard/tunings.rb

@@ -0,0 +1,245 @@
+module Fretboard
+  class Tunings
+    # Fretboard::Tunings.get(:standart)
+    # Fretboard::Tunings.exists?(:standart)
+
+    # SPN   =>  Scientific pitch notation
+
+    TUNINGS = {
+      STANDART: {
+        STRINGS: {
+          1 => {
+            NOTE: 'E',
+            # FREQUENCY: '329.63 Hz',
+            SPN: 'E4'
+          },
+          2 => {
+            NOTE: 'B',
+            # FREQUENCY: '246.94 Hz',
+            SPN: 'B3'
+          },
+          3 => {
+            NOTE: 'G',
+            # FREQUENCY: '196.00 Hz',
+            SPN: 'G3'
+          },
+          4 => {
+            NOTE: 'D',
+            # FREQUENCY: '146.83 Hz',
+            SPN: 'D3'
+          },
+          5 => {
+            NOTE: 'A',
+            # FREQUENCY: '110.00 Hz',
+            SPN: 'A2'
+          },
+          6 => {
+            NOTE: 'E',
+            # FREQUENCY: '82.41 Hz',
+            SPN: 'E2'
+          }
+        }
+      },
+
+      DROP_C: {
+        STRINGS: {
+          1 => {
+            NOTE: 'D',
+            SPN: 'D4'
+          },
+          2 => {
+            NOTE: 'A',
+            SPN: 'A3'
+          },
+          3 => {
+            NOTE: 'F',
+            SPN: 'F3'
+          },
+          4 => {
+            NOTE: 'C',
+            SPN: 'C3'
+          },
+          5 => {
+            NOTE: 'G',
+            SPN: 'G2'
+          },
+          6 => {
+            NOTE: 'C',
+            SPN: 'C2'
+          }
+        }
+      },
+
+      DROP_D: {
+        STRINGS: {
+          1 => {
+            NOTE: 'E',
+            SPN: 'E4'
+          },
+          2 => {
+            NOTE: 'B',
+            SPN: 'B3'
+          },
+          3 => {
+            NOTE: 'G',
+            SPN: 'G3'
+          },
+          4 => {
+            NOTE: 'D',
+            SPN: 'D3'
+          },
+          5 => {
+            NOTE: 'A',
+            SPN: 'A2'
+          },
+          6 => {
+            NOTE: 'D',
+            SPN: 'D2'
+          }
+        }
+      },
+
+      DOUBLE_DROP_D: {
+        STRINGS: {
+          1 => {
+            NOTE: 'D',
+            SPN: 'D4'
+          },
+          2 => {
+            NOTE: 'B',
+            SPN: 'B3'
+          },
+          3 => {
+            NOTE: 'G',
+            SPN: 'G3'
+          },
+          4 => {
+            NOTE: 'D',
+            SPN: 'D3'
+          },
+          5 => {
+            NOTE: 'A',
+            SPN: 'A2'
+          },
+          6 => {
+            NOTE: 'D',
+            SPN: 'D2'
+          }
+        }
+      },
+
+      OPEN_C: {
+        STRINGS: {
+          1 => {
+            NOTE: 'E',
+            SPN: 'E4'
+          },
+          2 => {
+            NOTE: 'C',
+            SPN: 'C4'
+          },
+          3 => {
+            NOTE: 'G',
+            SPN: 'G3'
+          },
+          4 => {
+            NOTE: 'C',
+            SPN: 'C3'
+          },
+          5 => {
+            NOTE: 'G',
+            SPN: 'G2'
+          },
+          6 => {
+            NOTE: 'C',
+            SPN: 'C2'
+          }
+        }
+      },
+
+      OPEN_D: {
+        STRINGS: {
+          1 => {
+            NOTE: 'D',
+            SPN: 'D4'
+          },
+          2 => {
+            NOTE: 'A',
+            SPN: 'A3'
+          },
+          3 => {
+            NOTE: [
+              'F#',
+              'Gb'
+            ],
+            SPN: [
+              'F#3',
+              'Gb3'
+            ]
+          },
+          4 => {
+            NOTE: 'D',
+            SPN: 'D3'
+          },
+          5 => {
+            NOTE: 'A',
+            SPN: 'A2'
+          },
+          6 => {
+            NOTE: 'D',
+            SPN: 'D2'
+          }
+        }
+      },
+
+      OPEN_G: {
+        STRINGS: {
+          1 => {
+            NOTE: 'D',
+            SPN: 'D4'
+          },
+          2 => {
+            NOTE: 'B',
+            SPN: 'B3'
+          },
+          3 => {
+            NOTE: 'G',
+            SPN: 'G3'
+          },
+          4 => {
+            NOTE: 'D',
+            SPN: 'D3'
+          },
+          5 => {
+            NOTE: 'G',
+            SPN: 'G2'
+          },
+          6 => {
+            NOTE: 'D',
+            SPN: 'D2'
+          }
+        }
+      }
+    }.freeze
+
+    def self.get(tuning_name)
+      new(tuning_name).get
+    end
+
+    def self.exists?(tuning_name)
+      new(tuning_name).exists?
+    end
+
+    def initialize(tuning_name)
+      @tuning_name = tuning_name.upcase.to_sym
+    end
+
+    def get
+      TUNINGS[@tuning_name]
+    end
+
+    def exists?
+      TUNINGS.key?(@tuning_name)
+    end
+  end
+end

data/lib/fretboard/version.rb

@@ -1,7 +1,7 @@
 module Fretboard
   MAJOR = 1
-  MINOR = 0
-  PATCH = 1
+  MINOR = 2
+  PATCH = 0
 
   VERSION = [
     MAJOR,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fretboard
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Anton Sokolov
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2020-07-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
@@ -50,9 +64,11 @@ files:
 - fretboard.gemspec
 - lib/fretboard.rb
 - lib/fretboard/builder.rb
+- lib/fretboard/console.rb
 - lib/fretboard/constants.rb
 - lib/fretboard/note.rb
 - lib/fretboard/notes.rb
+- lib/fretboard/tunings.rb
 - lib/fretboard/version.rb
 homepage: https://github.com/afuno/fretboard
 licenses: