fretboard 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e693a29f4bdd5acf2f84f4fe9cf1a550636ab1a642ae0919a8c8e7fa35eb790e
+  data.tar.gz: 7c60bf49fda12e0d7c1daae56bffbb2c2b663c9ef0edd7c0a0ef7a500433135c
+SHA512:
+  metadata.gz: b11b6cb3ff18495b1866e15637c9ea1bd3c8c04f5043f647f56a77cb8527f69ec117a6c69afc09999c18e20586c090e0f4c22d6785b677e35be26802503b20f0
+  data.tar.gz: c42ebced988ef825dda2a06177f3e8be257d1244828238ef0fee8fd41dde33e2b2ca1aa014e793650a3807cf2df8a27e200fd092342322b5dfb02be6b6e723b5

data/LICENSE.md

@@ -0,0 +1,21 @@
+# 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/README.md

@@ -0,0 +1,45 @@
+# Fretboard for Guitar
+
+Tools for working with the guitar fretboard.
+
+![Demo](https://raw.githubusercontent.com/afuno/fretboard/dev/images/demo1.png)
+
+[Documentation](https://www.rubydoc.info/gems/fretboard)
+
+## Installation
+
+```ruby
+gem 'fretboard'
+```
+
+## Using
+
+### Creates a fretboard with the specified tuning
+
+```ruby
+fretboard = Fretboard::Builder.new(:standart)
+# or
+fretboard = Fretboard::Builder.standart
+```
+
+Creating the fretboard data:
+
+```ruby
+fretboard.build
+```
+
+Get the created data:
+
+```ruby
+fretboard.data
+```
+
+Drawing the fretboard in the console:
+
+```ruby
+fretboard.draw
+```
+
+### Available tunings:
+
+- standart

data/fretboard.gemspec

@@ -0,0 +1,25 @@
+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 images`.split("\x0")
+  spec.require_paths = ['lib']
+
+  # spec.executables   = ['fretboard']
+
+  # 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

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

data/lib/fretboard/builder.rb

@@ -0,0 +1,98 @@
+require 'terminal-table'
+
+module Fretboard
+  class Builder
+    # fretboard = Fretboard::Builder.new(:standart)
+    # fretboard = Fretboard::Builder.standart
+    # fretboard.build
+    # fretboard.data
+    # fretboard.draw
+
+    attr_reader :data
+
+    def self.standart(number_of_frets = 12)
+      new(:standart, number_of_frets)
+    end
+
+    def initialize(tuning, number_of_frets = 12)
+      @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'
+        return
+      end
+
+      tuning = Fretboard::Constants::GUITAR_TUNINGS[@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: :both,
+            formated: true
+          )
+
+          puts "Fret: #{fret} (#{next_note})"
+
+          @data[string_number][fret] = next_note
+
+          current_note = next_note
+        end
+      end
+
+      puts
+      puts 'done'
+    end
+
+    def draw
+      headings = []
+      rows = []
+
+      @data.each_pair do |string_number, string_notes|
+        row = []
+
+        headings << '№'
+        row << string_number
+
+        headings << 0
+        row << string_notes[0]
+
+        string_notes.except(0).each_pair do |fret, note|
+          headings << fret
+          row << note
+        end
+
+        rows << row
+      end
+
+      table = Terminal::Table.new(
+        headings: headings.uniq,
+        rows: rows,
+        style: { border_x: '~', border_i: '~' }
+      )
+
+      puts table
+
+      nil
+    end
+  end
+end

data/lib/fretboard/constants.rb

@@ -0,0 +1,44 @@
+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

@@ -0,0 +1,42 @@
+require 'fretboard/notes'
+
+module Fretboard
+  class Note
+    # Fretboard::Note.next_for('C')
+
+    def self.next_for(note, sharp_or_flat: :sharp, formated: false)
+      all_notes = Fretboard::Notes.all(
+        sharp_or_flat,
+        formated: formated
+      )
+
+      current_index = all_notes.find_index(note)
+      next_index = current_index + 1
+
+      next_note = all_notes[next_index]
+      next_note = all_notes.first if next_note.blank?
+
+      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

@@ -0,0 +1,63 @@
+module Fretboard
+  class Notes
+    # Fretboard::Notes.all(:both)
+    # Fretboard::Notes.all(:sharp)
+    # Fretboard::Notes.all(:flat)
+
+    BASIS_NOTES = {
+      1 => 'C',
+      2 => [
+        'C sharp',
+        'D flat'
+      ],
+      3 => 'D',
+      4 => [
+        'D sharp',
+        'E flat'
+      ],
+      5 => 'E',
+      6 => 'F',
+      7 => [
+        'F sharp',
+        'G flat'
+      ],
+      8 => 'G',
+      9 => [
+        'G sharp',
+        'A flat'
+      ],
+      10 => 'A',
+      11 => [
+        'A sharp',
+        'B flat'
+      ],
+      12 => 'B'
+    }.freeze
+
+    def self.all(sharp_or_flat = :sharp, formated: false)
+      BASIS_NOTES.map do |_key, value|
+        result = value
+
+        if value.is_a?(Array)
+          result = if sharp_or_flat == :both
+                     value.join('/')
+                   elsif sharp_or_flat == :sharp
+                     value.first
+                   else
+                     value.last
+                   end
+        end
+
+        if formated
+          Fretboard::Note.formated(result)
+        else
+          result
+        end
+      end
+    end
+
+    def self.first
+      all.first
+    end
+  end
+end

data/lib/fretboard/version.rb

@@ -0,0 +1,11 @@
+module Fretboard
+  MAJOR = 1
+  MINOR = 0
+  PATCH = 0
+
+  VERSION = [
+    MAJOR,
+    MINOR,
+    PATCH
+  ].join('.')
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: fretboard
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Anton Sokolov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.88'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.88'
+description: Tools for working with the guitar fretboard
+email:
+- anton@sokolov.digital
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- fretboard.gemspec
+- images/demo1.png
+- lib/fretboard.rb
+- lib/fretboard/builder.rb
+- lib/fretboard/constants.rb
+- lib/fretboard/note.rb
+- lib/fretboard/notes.rb
+- lib/fretboard/version.rb
+homepage: https://github.com/afuno/fretboard
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Tools for working with the guitar fretboard
+test_files: []