fretboard 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7435bd0a766a28745a79a3741e0b08f3793ca8566ed0ab6cca5c864cba776fd
-  data.tar.gz: 1e6935842f0d1f730c7d9a7fdfd3e5cc18bb525e725b761cd66b3a4b97207dab
+  metadata.gz: 8ce78fbd618190dec7aab13a7f9c8a2d58bc074cd90a035eabfc03a9091ca435
+  data.tar.gz: bdfff345ca8d38dd4739061595e5f7cbf92ce0cf624237a8580ad2e83c10ce16
 SHA512:
-  metadata.gz: e66075625a1147938126d904ad1f37a5f4b7d44fd18608c87e9c3199a055ada3c401f6d305c5d266ac1b18a4dfdc5dbc68b5d11c1d2d94a37f7538b82b422991
-  data.tar.gz: 8359c7422823e670980a0bde6add31442a7e739f4e725a33053e9db870088feace52360c7fa9f2388db2afcafbb328ff6d623151764885bc5e77f91be406441d
+  metadata.gz: a4175ec01b4eac24ae120b1dd6b41ed5f1ceff0fe9fd32edea143cf04c7a59b5dcd6b75f1a6035e88e766ab6ccfa8ac90519c9dd10501bd6ec9971b45d6d991b
+  data.tar.gz: f664ab61567eec56eb49dfb9f9a52da3d1e72d5518def62e6716cea380ed136ec2de2cccb0c60d6fa940b87c820f2ca0932cccc0d5246b08cd09029904da0982

data/README.md

@@ -53,12 +53,23 @@ fretboard.draw
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 ```
 
+### Using from the console
+
+```
+bundle exec fretboard --draw-tuning standart
+```
+
 ### Available tunings:
 
 - Standart (`standart`)
 - Drop C (`drop_c`)
 - Drop D (`drop_d`)
 - Double Drop D (`double_drop_d`)
+- Open A (`open_a`)
 - Open C (`open_c`)
 - Open D (`open_d`)
+- Open D Minor (`open_d_minor`)
 - Open G (`open_g`)
+- Open G Minor (`open_g_minor`)
+- Modal D (`modal_d`)
+- Modal G (`modal_g`)

data/bin/fretboard

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

data/fretboard.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z *.md *.gemspec bin lib`.split("\x0")
   spec.require_paths = ['lib']
 
-  # spec.executables   = ['fretboard']
+  spec.executables   = ['fretboard']
 
   spec.add_dependency 'colorize', '~> 0.8.1'
   spec.add_dependency 'terminal-table', '~> 1.8.0'

data/lib/fretboard/builder.rb

@@ -1,3 +1,5 @@
+# require 'active_support/core_ext/hash'
+
 require 'fretboard/console'
 
 module Fretboard
@@ -7,9 +9,14 @@ module Fretboard
     # fretboard = Fretboard::Builder.drop_c
     # fretboard = Fretboard::Builder.drop_d
     # fretboard = Fretboard::Builder.double_drop_d
+    # fretboard = Fretboard::Builder.open_a
     # fretboard = Fretboard::Builder.open_c
     # fretboard = Fretboard::Builder.open_d
+    # fretboard = Fretboard::Builder.open_d_minor
     # fretboard = Fretboard::Builder.open_g
+    # fretboard = Fretboard::Builder.open_g_minor
+    # fretboard = Fretboard::Builder.modal_d
+    # fretboard = Fretboard::Builder.modal_g
 
     # fretboard.build
     # fretboard.data
@@ -22,9 +29,14 @@ module Fretboard
     #   drop_c
     #   drop_d
     #   double_drop_d
+    #   open_a
     #   open_c
     #   open_d
+    #   open_d_minor
     #   open_g
+    #   open_g_minor
+    #   modal_d
+    #   modal_g
     # ].freeze
 
     attr_reader :data
@@ -51,6 +63,10 @@ module Fretboard
       new(:double_drop_d, number_of_frets)
     end
 
+    def self.open_a(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
+      new(:open_a, number_of_frets)
+    end
+
     def self.open_c(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
       new(:open_c, number_of_frets)
     end
@@ -59,10 +75,26 @@ module Fretboard
       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.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.modal_d(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
+      new(:modal_d, number_of_frets)
+    end
+
+    def self.modal_g(number_of_frets = DEFAULT_NUMBER_OF_FRETS)
+      new(:modal_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/lib/fretboard/console.rb

@@ -3,9 +3,9 @@ require 'terminal-table'
 
 module Fretboard
   class Console
-    # def self.log(text)
-    #   new(text, nil).print
-    # end
+    def self.log(text)
+      new(text, nil).print
+    end
 
     # def self.success(text)
     #   new(text, :green).print

data/lib/fretboard/parser.rb

@@ -0,0 +1,51 @@
+require 'active_support/core_ext'
+require 'optparse'
+
+require 'fretboard/builder'
+require 'fretboard/console'
+require 'fretboard/note'
+require 'fretboard/tunings'
+
+module Fretboard
+  class Parser
+    attr_reader :args
+
+    def self.parse(args)
+      new(args).parse
+    end
+
+    def initialize(args)
+      @args = args
+    end
+
+    def parse
+      parser.parse!(args)
+    rescue StandardError => e
+      Fretboard::Console.danger("Ambiguously completable string is encountered\n#{e}")
+    end
+
+    private
+
+    def parser
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: fretboard [options]'
+
+        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
+          Fretboard::Console.log(opts.to_s)
+          exit
+        end
+
+        opts.on('--draw-tuning CODE', 'Build a guitar tuning') do |code|
+          fretboard = Fretboard::Builder.new(code.to_sym)
+          fretboard.build
+          fretboard.draw
+        end
+      end
+    end
+  end
+end

data/lib/fretboard/tunings.rb

@@ -3,40 +3,26 @@ module Fretboard
     # Fretboard::Tunings.get(:standart)
     # Fretboard::Tunings.exists?(:standart)
 
-    # SPN   =>  Scientific pitch notation
-
     TUNINGS = {
       STANDART: {
         STRINGS: {
           1 => {
-            NOTE: 'E',
-            # FREQUENCY: '329.63 Hz',
-            SPN: 'E4'
+            NOTE: 'E'
           },
           2 => {
-            NOTE: 'B',
-            # FREQUENCY: '246.94 Hz',
-            SPN: 'B3'
+            NOTE: 'B'
           },
           3 => {
-            NOTE: 'G',
-            # FREQUENCY: '196.00 Hz',
-            SPN: 'G3'
+            NOTE: 'G'
           },
           4 => {
-            NOTE: 'D',
-            # FREQUENCY: '146.83 Hz',
-            SPN: 'D3'
+            NOTE: 'D'
           },
           5 => {
-            NOTE: 'A',
-            # FREQUENCY: '110.00 Hz',
-            SPN: 'A2'
+            NOTE: 'A'
           },
           6 => {
-            NOTE: 'E',
-            # FREQUENCY: '82.41 Hz',
-            SPN: 'E2'
+            NOTE: 'E'
           }
         }
       },
@@ -44,28 +30,22 @@ module Fretboard
       DROP_C: {
         STRINGS: {
           1 => {
-            NOTE: 'D',
-            SPN: 'D4'
+            NOTE: 'D'
           },
           2 => {
-            NOTE: 'A',
-            SPN: 'A3'
+            NOTE: 'A'
           },
           3 => {
-            NOTE: 'F',
-            SPN: 'F3'
+            NOTE: 'F'
           },
           4 => {
-            NOTE: 'C',
-            SPN: 'C3'
+            NOTE: 'C'
           },
           5 => {
-            NOTE: 'G',
-            SPN: 'G2'
+            NOTE: 'G'
           },
           6 => {
-            NOTE: 'C',
-            SPN: 'C2'
+            NOTE: 'C'
           }
         }
       },
@@ -73,28 +53,22 @@ module Fretboard
       DROP_D: {
         STRINGS: {
           1 => {
-            NOTE: 'E',
-            SPN: 'E4'
+            NOTE: 'E'
           },
           2 => {
-            NOTE: 'B',
-            SPN: 'B3'
+            NOTE: 'B'
           },
           3 => {
-            NOTE: 'G',
-            SPN: 'G3'
+            NOTE: 'G'
           },
           4 => {
-            NOTE: 'D',
-            SPN: 'D3'
+            NOTE: 'D'
           },
           5 => {
-            NOTE: 'A',
-            SPN: 'A2'
+            NOTE: 'A'
           },
           6 => {
-            NOTE: 'D',
-            SPN: 'D2'
+            NOTE: 'D'
           }
         }
       },
@@ -102,28 +76,48 @@ module Fretboard
       DOUBLE_DROP_D: {
         STRINGS: {
           1 => {
-            NOTE: 'D',
-            SPN: 'D4'
+            NOTE: 'D'
+          },
+          2 => {
+            NOTE: 'B'
+          },
+          3 => {
+            NOTE: 'G'
+          },
+          4 => {
+            NOTE: 'D'
+          },
+          5 => {
+            NOTE: 'A'
+          },
+          6 => {
+            NOTE: 'D'
+          }
+        }
+      },
+
+      OPEN_A: {
+        STRINGS: {
+          1 => {
+            NOTE: 'E'
           },
           2 => {
-            NOTE: 'B',
-            SPN: 'B3'
+            NOTE: 'A'
           },
           3 => {
-            NOTE: 'G',
-            SPN: 'G3'
+            NOTE: 'E'
           },
           4 => {
-            NOTE: 'D',
-            SPN: 'D3'
+            NOTE: [
+              'C#',
+              'Db'
+            ]
           },
           5 => {
-            NOTE: 'A',
-            SPN: 'A2'
+            NOTE: 'A'
           },
           6 => {
-            NOTE: 'D',
-            SPN: 'D2'
+            NOTE: 'E'
           }
         }
       },
@@ -131,28 +125,22 @@ module Fretboard
       OPEN_C: {
         STRINGS: {
           1 => {
-            NOTE: 'E',
-            SPN: 'E4'
+            NOTE: 'E'
           },
           2 => {
-            NOTE: 'C',
-            SPN: 'C4'
+            NOTE: 'C'
           },
           3 => {
-            NOTE: 'G',
-            SPN: 'G3'
+            NOTE: 'G'
           },
           4 => {
-            NOTE: 'C',
-            SPN: 'C3'
+            NOTE: 'C'
           },
           5 => {
-            NOTE: 'G',
-            SPN: 'G2'
+            NOTE: 'G'
           },
           6 => {
-            NOTE: 'C',
-            SPN: 'C2'
+            NOTE: 'C'
           }
         }
       },
@@ -160,34 +148,48 @@ module Fretboard
       OPEN_D: {
         STRINGS: {
           1 => {
-            NOTE: 'D',
-            SPN: 'D4'
+            NOTE: 'D'
           },
           2 => {
-            NOTE: 'A',
-            SPN: 'A3'
+            NOTE: 'A'
           },
           3 => {
             NOTE: [
               'F#',
               'Gb'
-            ],
-            SPN: [
-              'F#3',
-              'Gb3'
             ]
           },
           4 => {
-            NOTE: 'D',
-            SPN: 'D3'
+            NOTE: 'D'
           },
           5 => {
-            NOTE: 'A',
-            SPN: 'A2'
+            NOTE: 'A'
           },
           6 => {
-            NOTE: 'D',
-            SPN: 'D2'
+            NOTE: 'D'
+          }
+        }
+      },
+
+      OPEN_D_MINOR: {
+        STRINGS: {
+          1 => {
+            NOTE: 'D'
+          },
+          2 => {
+            NOTE: 'A'
+          },
+          3 => {
+            NOTE: 'F'
+          },
+          4 => {
+            NOTE: 'D'
+          },
+          5 => {
+            NOTE: 'A'
+          },
+          6 => {
+            NOTE: 'D'
           }
         }
       },
@@ -195,28 +197,94 @@ module Fretboard
       OPEN_G: {
         STRINGS: {
           1 => {
-            NOTE: 'D',
-            SPN: 'D4'
+            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'
+          }
+        }
+      },
+
+      MODAL_D: {
+        STRINGS: {
+          1 => {
+            NOTE: 'D'
+          },
+          2 => {
+            NOTE: 'A'
+          },
+          3 => {
+            NOTE: 'G'
+          },
+          4 => {
+            NOTE: 'D'
+          },
+          5 => {
+            NOTE: 'A'
+          },
+          6 => {
+            NOTE: 'D'
+          }
+        }
+      },
+
+      MODAL_G: {
+        STRINGS: {
+          1 => {
+            NOTE: 'D'
           },
           2 => {
-            NOTE: 'B',
-            SPN: 'B3'
+            NOTE: 'C'
           },
           3 => {
-            NOTE: 'G',
-            SPN: 'G3'
+            NOTE: 'G'
           },
           4 => {
-            NOTE: 'D',
-            SPN: 'D3'
+            NOTE: 'D'
           },
           5 => {
-            NOTE: 'G',
-            SPN: 'G2'
+            NOTE: 'G'
           },
           6 => {
-            NOTE: 'D',
-            SPN: 'D2'
+            NOTE: 'D'
           }
         }
       }

data/lib/fretboard/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fretboard
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Anton Sokolov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-26 00:00:00.000000000 Z
+date: 2020-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -55,12 +55,14 @@ dependencies:
 description: Tools for working with the guitar fretboard
 email:
 - anton@sokolov.digital
-executables: []
+executables:
+- fretboard
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.md
 - README.md
+- bin/fretboard
 - fretboard.gemspec
 - lib/fretboard.rb
 - lib/fretboard/builder.rb
@@ -68,6 +70,7 @@ files:
 - lib/fretboard/constants.rb
 - lib/fretboard/note.rb
 - lib/fretboard/notes.rb
+- lib/fretboard/parser.rb
 - lib/fretboard/tunings.rb
 - lib/fretboard/version.rb
 homepage: https://github.com/afuno/fretboard