coltrane 2.0.0 → 2.1.0

data/lib/cli.rb

@@ -1,17 +1,23 @@
 # frozen_string_literal: true
 
+require 'os'
 require 'mercenary'
 require 'paint'
 require 'color'
 
-require 'cli/errors'
+require 'coltrane'
+require 'coltrane_instruments'
+require 'coltrane_synth'
 
+require 'cli/config'
+require 'cli/errors'
 require 'cli/representation'
 require 'cli/text'
 require 'cli/piano'
 require 'cli/guitar'
 require 'cli/bass_guitar'
 require 'cli/ukulele'
+require 'cli/guitar_chords'
 
 require 'cli/notes'
 require 'cli/chord'

data/lib/cli/bass_guitar.rb

@@ -4,7 +4,7 @@ module Coltrane
   module Cli
     # Renders notes in a bass guitar scheme
     class BassGuitar < Guitar
-      def initialize(notes, flavor, tuning: %w[E A D G])
+      def initialize(notes, tuning: %w[E A D G])
         super
       end
     end

data/lib/cli/chord.rb

@@ -4,7 +4,15 @@ module Coltrane
   module Cli
     # Interfaces chord functionality with the lib
     class Chord
-      def initialize(*chords, on: :text, flavor: 'intervals', notes: nil)
+      def initialize(*chords, notes: nil)
+        Cli.config do |c|
+          if c.on == :guitar
+            c.on = :guitar_chords
+          elsif c.on == :guitar_arm
+            c.on = :guitar
+          end
+        end
+
         @chords =
           if !chords.empty?
             if chords[0].is_a?(String)
@@ -18,9 +26,8 @@ module Coltrane
 
         @chords.each do |chord|
           desc = "#{chord.name} chord:"
-          Coltrane::Cli::Notes.new chord.notes, on: on,
-                                                desc: desc,
-                                                flavor: flavor
+          Coltrane::Cli::Notes.new chord.notes, desc: desc
+          ColtraneSynth::Base.play(chord, 1) if Cli.config.sound
         end
       end
     end

data/lib/cli/config.rb

@@ -0,0 +1,38 @@
+module Coltrane
+  module Cli
+    class Config
+      DEFAULTS = {
+        flavor: :notes,
+        sound: false,
+        on: :text
+      }
+
+      attr_accessor :flavor, :degrees, :sound
+      attr_reader :on
+
+      def initialize(defaults = DEFAULTS)
+        defaults.each do |key, val|
+          instance_variable_set(:"@#{key}", val)
+        end
+      end
+
+      def on=(instrument)
+        @on = case instrument
+              when :ukelele then :ukulele
+              when :bass then :bass_guitar
+              else instrument
+              end
+      end
+
+    end
+
+    def self.config
+      @config = Config.new if @config.nil?
+      block_given? ? yield(@config) : @config
+    end
+
+    def self.erase_config
+      @config = nil
+    end
+  end
+end

data/lib/cli/guitar.rb

@@ -7,11 +7,10 @@ module Coltrane
       SPECIAL_FRETS = [3, 5, 7, 9, 12, 15, 17, 19].freeze
 
       include Color
-      def initialize(notes, flavor, tuning: %w[E A D G B E], frets: 22)
+      def initialize(notes, tuning: %w[E A D G B E], frets: 22)
         @notes    = notes
         @tuning   = tuning.reverse
         @frets    = frets
-        @flavor   = flavor
         @ref_note = @notes.first
       end
 
@@ -48,14 +47,13 @@ module Coltrane
       end
 
       def place_mark(note)
-        mark =
-          case @flavor
-          when :notes     then note.pretty_name.ljust(2, ' ')
-          when :intervals then (@ref_note - note).name.ljust(2, '-')
-          when :degrees   then @notes.degree(note).to_s.rjust(2, '0')
-          when :marks     then '  ' # '◼◼'
-          else raise WrongFlavorError
-          end
+        mark = case Cli.config.flavor
+               when :notes     then note.pretty_name.ljust(2, ' ')
+               when :intervals then (@ref_note - note).name.ljust(2, '-')
+               when :degrees   then @notes.degree(note).to_s.rjust(2, '0')
+               when :marks     then '  ' # '◼◼'
+               else raise WrongFlavorError
+               end
 
         base_hue = (180 + note.integer * 10) % 360 # + 260
         Paint[

data/lib/cli/guitar_chords.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Coltrane
+  module Cli
+    # Renders notes in a common most popular ukulele scheme
+    class GuitarChords < Representation
+      include Color
+
+      def initialize(notes, tuning: %w[E2 A2 D3 G3 B3 E4], frets: 23)
+        @notes    = notes
+        @tuning   = tuning.reverse
+        @frets    = frets
+
+        target_chord = Coltrane::Chord.new(notes: @notes)
+        chords = ColtraneInstruments::Guitar::Base.find_chords(target_chord)
+        @chords = chords.sort[-6..-1].reverse
+        @chords.each { |c| ColtraneSynth::Base.play(c.voicing) } if false
+      end
+
+      def chord_height
+        ColtraneInstruments::Guitar::Chord::MAX_FRET_SPAN
+      end
+
+      def render
+        render_horizontally
+        # render_vertically
+      end
+
+      def render_vertically
+        @chords.map { |c| render_chord(c) }
+      end
+
+      def render_horizontally
+        rchords = @chords.map { |c| render_chord(c).split("\n") }
+        rchords.max_by(&:size).size.times.reduce('') do |memo1, l|
+          memo1 +
+          rchords.reduce('') do |memo2, c|
+            memo2 +
+            (c[l].nil? ? " " * (c.map(&:size).max) + '  ' : "#{c[l]}  ")
+          end +
+          "\n"
+        end
+      end
+
+      def render_chord(chord)
+        render_top(chord) +
+        (chord.lowest_fret..chord.lowest_fret+chord_height)
+          .each_with_index.reduce('') do |memo1, (f, y)|
+            memo1 +
+            '   ' +
+            (chord.guitar.strings.size*2).times.map {|x| base_color border(x,y) }.join('') +
+            "\n" +
+            chord.guitar.strings.reduce(base_color f.to_s.ljust(2, ' ')) do |memo2, s|
+              memo2 +
+              ' ' +
+              render_note(chord.guitar_notes.select do |n|
+                n.string == s && n.fret == f
+              end.any?)
+            end +
+            " \n"
+          end + '   ' +
+          (chord.guitar.strings.size*2).times.map do |x|
+            base_color border(x, chord_height + 1)
+          end.join('')
+      end
+
+      def border(x, y)
+        edge = [@tuning.size * 2 - 2, chord_height + 1]
+        x_on_start  = x == 0
+        y_on_start  = y == 0
+        x_on_edge   = x == edge[0]
+        y_on_edge   = y == edge[1]
+        x_on_middle = (0...edge[0]).include?(x)
+        y_on_middle = (0...edge[1]).include?(y)
+
+        if    x_on_start  && y_on_start  then '┍'
+        elsif x_on_middle && y_on_start  then x.odd? ? '━' : '┯'
+        elsif x_on_edge   && y_on_start  then '┑'
+        elsif x_on_start  && y_on_middle then '┝'
+        elsif x_on_middle && y_on_middle then x.odd? ? '━' : '┿'
+        elsif x_on_edge   && y_on_middle then '┥'
+        elsif x_on_start  && y_on_edge   then '┕'
+        elsif x_on_middle && y_on_edge   then x.odd? ? '━' : '┷'
+        elsif x_on_edge   && y_on_edge   then '┙'
+        else ' '
+        end
+        # puts edge.inspect
+        # "#{x},#{y} "
+      end
+
+      def base_color(str)
+        Paint[str, '#6A4AC2']
+      end
+
+      def highlight(str)
+        Paint[str, '#E67831']
+      end
+
+      def alt(str)
+        Paint[str, '#2DD380']
+      end
+
+      def render_top(chord)
+        chord.guitar.strings.reduce('   ') do |memo, s|
+          memo +
+          if chord.guitar_notes.select {|n|
+            n.string == s && n.fret == 0 }.any?
+            highlight '⬤ '
+          elsif chord.guitar_notes.select {|n| n.string == s && n.fret == nil }.any?
+            alt 'x '
+          else
+            '  '
+          end
+        end + "\n"
+      end
+
+      def render_note(found)
+        found ? highlight('⬤') : base_color('│')
+      end
+    end
+  end
+end

data/lib/cli/notes.rb

@@ -4,13 +4,12 @@ module Coltrane
   module Cli
     # Interfaces notes outputting functionality with the lib
     class Notes
-      def initialize(notes, on: 'text', desc: nil, flavor: 'notes')
+      def initialize(notes, desc: nil)
         @desc   = desc || 'The notes you supplied:'
-        flavor  = flavor.underscore.to_sym
-        on      = on.to_sym
         notes   = Coltrane::NoteSet.new(notes)
-        @representation = Representation.build(on, notes, flavor)
+        @representation = Representation.build(notes)
         render
+        # notes.each {|n| ColtraneSynth::Base.play(n, 0.1) } if Cli.config.sound
       end
 
       def render

data/lib/cli/piano.rb

@@ -37,7 +37,7 @@ module Coltrane
 
       def replacer(note)
         # TODO: Maybe extract this method into its own class/module
-        case @flavor
+        case Cli.config.flavor
         when :intervals then (@ref_note - note).name
         when :marks then '◼ '
         when :degrees then @notes.degree(note).to_s.rjust(2, '0')

data/lib/cli/representation.rb

@@ -11,26 +11,20 @@ module Coltrane
         @@types[subclass.to_s.split('::').last.underscore.to_sym] = subclass
       end
 
-      def self.build(type, notes, flavor)
-        raise WrongFlavorError unless ACCEPTED_FLAVORS.include?(flavor)
-        type = case type
-               when :ukelele then :ukulele
-               when :bass then :bass_guitar
-               else type
-               end
-
+      def self.build(notes)
+        type = Cli.config.on
+        raise WrongFlavorError unless ACCEPTED_FLAVORS.include?(Cli.config.flavor)
         raise(WrongRepresentationTypeError, type) unless @@types.include?(type)
-        @@types[type].new(notes, flavor)
+        @@types[type].new(notes)
       end
 
-      def initialize(notes, flavor)
+      def initialize(notes)
         @notes    = notes
-        @flavor   = flavor
         @ref_note = notes.first
       end
 
       def hint
-        case @flavor
+        case Cli.config.flavor
         when :marks then ''
         # when :notes     then "(\u266E means the note is natural, not flat nor sharp)"
         when :intervals

data/lib/cli/scale.rb

@@ -27,8 +27,8 @@ module Coltrane
       def self.render_search(searched_notes)
         search = Coltrane::Scale.having_notes(searched_notes)
         output = []
-        scale_width = search.results.keys.map(&:size).max
-        search.results.each do |name, scales_by_tone|
+        scale_width = search[:results].keys.map(&:size).max
+        search[:results].each do |name, scales_by_tone|
           output << name.ljust(scale_width + 1, ' ')
           scales_by_tone.each do |tone_number, notes|
             p     = (notes.size.to_f / searched_notes.size) * 100
@@ -43,9 +43,9 @@ module Coltrane
         puts output.join
       end
 
-      def initialize(scale, on: :text, flavor: 'degrees')
+      def initialize(scale)
         desc = "This is the #{scale.tone.name} #{scale.name} scale:"
-        Coltrane::Cli::Notes.new(scale.notes, on: on, desc: desc, flavor: flavor)
+        Coltrane::Cli::Notes.new(scale.notes)
       end
     end
   end

data/lib/cli/text.rb

@@ -5,7 +5,7 @@ module Coltrane
     # A text representation
     class Text < Representation
       def render
-        case @flavor
+        case Cli.config.flavor
         when :marks, :notes, :degrees then @notes.pretty_names.join(' ')
         when :intervals then @notes.map { |n| (@notes.first - n).name }.join(' ')
         else raise WrongFlavorError

data/lib/cli/ukulele.rb

@@ -6,7 +6,7 @@ module Coltrane
     class Ukulele < Guitar
       SPECIAL_FRETS = [5, 7, 9, 12].freeze
 
-      def initialize(notes, flavor, tuning: %w[G C E A], frets: 12)
+      def initialize(notes, tuning: %w[G C E A], frets: 12)
         super
       end
     end

data/lib/coltrane.rb

@@ -1,44 +1,15 @@
 # frozen_string_literal: true
 
-require 'yaml'
-
+require 'json'
 require 'forwardable'
-require 'facets/multiton'
 require 'core_ext'
 require 'ostruct'
 
-require 'coltrane/version'
-require 'coltrane/errors'
-require 'coltrane/cadence'
-
-require 'coltrane/frequency'
-require 'coltrane/pitch'
-require 'coltrane/pitch_class'
-require 'coltrane/note'
-require 'coltrane/note_set'
-
-require 'coltrane/interval'
-require 'coltrane/interval_class'
-require 'coltrane/unordered_interval_class'
-require 'coltrane/interval_sequence'
-
-require 'coltrane/chord_quality'
-
-require 'coltrane/chord_substitutions'
-require 'coltrane/chord'
-require 'coltrane/roman_chord'
-
-require 'coltrane/classic_scales'
-require 'coltrane/scale'
-
-require 'coltrane/notable_progressions'
-require 'coltrane/changes'
-require 'coltrane/progression'
-
-require 'coltrane/mode'
 
 # The main module for working with Music Theory
 module Coltrane
+  autoload :Frequency,              'coltrane/frequency'
+
   BASE_OCTAVE = 4
   BASE_PITCH_INTEGER = 9
 
@@ -51,4 +22,36 @@ module Coltrane
   end
 
   @base_tuning = Frequency[440].octave(-4)
+
+  require 'coltrane/version'
+  require 'coltrane/errors'
+
+  autoload :Pitch,                  'coltrane/pitch'
+  autoload :Voicing,                'coltrane/voicing'
+
+  autoload :PitchClass,             'coltrane/pitch_class'
+  autoload :Note,                   'coltrane/note'
+  autoload :NoteSet,                'coltrane/note_set'
+
+  autoload :Interval,               'coltrane/interval'
+  autoload :IntervalClass,          'coltrane/interval_class'
+  autoload :UnorderedIntervalClass, 'coltrane/unordered_interval_class'
+  autoload :IntervalSequence,       'coltrane/interval_sequence'
+  autoload :Qualities,              'coltrane/qualities'
+  autoload :ChordQuality,           'coltrane/chord_quality'
+  autoload :Chord,                  'coltrane/chord'
+  autoload :ChordSubstitutions,     'coltrane/chord_substitutions'
+  autoload :RomanChord,             'coltrane/roman_chord'
+
+  autoload :ClassicScales,          'coltrane/classic_scales'
+  autoload :Scale,                  'coltrane/scale'
+  autoload :CircleOfFifths,         'coltrane/circle_of_fifths'
+  autoload :DiatonicScale,          'coltrane/diatonic_scale'
+  autoload :Key,                    'coltrane/key'
+
+  autoload :NotableProgressions,    'coltrane/notable_progressions'
+  autoload :Changes,                'coltrane/changes'
+  autoload :Cadence,                'coltrane/cadence'
+  autoload :Progression,            'coltrane/progression'
+  autoload :Mode,                   'coltrane/mode'
 end