coltrane 3.4.2 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32946013238830132b204f366ee7b647033bc899d46326634a51a639dcd29dbc
-  data.tar.gz: b67609e215a09f1e9b2f4a4346e0f0b37f6d89f0cea3b06a4266f838f0e17cdc
+  metadata.gz: d2dce8fab34c2d90d0317a80349b7fd3bec643bd0f32c491a351a0251251349b
+  data.tar.gz: de1772b25200811627df8937663417db2c9a9ad5f8106e05ba0c6a41f6ccc96d
 SHA512:
-  metadata.gz: 19aa9d773da33d5b2adf560071c0d3bd6ab3cb7e936014ff8065cda097b0d6ffb959f15eba5e26ca1bc0de3970fcb76a2e5b03a7ee9b01ff34dfccf9b7241cb8
-  data.tar.gz: b3f307536e4a287135ace9901c7707cbb94c6138e05eaa7b1799c07e1162fc11eda8f854e06b0530fe9320d8e228e0de2f31072e0d275a7c1d0decc2c968081a
+  metadata.gz: 6d0ed0415983d75c7fce264111e014e2c2bb3d2f0ae949c7579743668ea09678e93df6e85c450f66c4543fd13f60c89dd6711bc023cfb08c00a83300228713c5
+  data.tar.gz: 45fe81700b815b8762c39ad4d365ccafebfc8d7afa4d5e225f6344f70de713ce23d9d601273ee08a38f59bdb696815d2dd27cfd7920eae9f15f36f6fb3feb9eb

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/CHANGELOG.md

@@ -5,6 +5,9 @@
 - Fix chords so that they generate a barre and a non-barre version and prevent
   barre chords from picking notes before the barre.
 
+## [4.0.0]
+- Includes totally revamped, easy to use command line interface.
+
 ## [3.4.2]
 - Fixes guitar strings rendering order (#41)
 

data/Gemfile.lock

@@ -1,18 +1,24 @@
 PATH
   remote: .
   specs:
-    coltrane (3.4.2)
+    coltrane (4.0.3)
+      activesupport (> 5.2)
+      cli-ui (~> 1.1)
       color (~> 1.8)
       dry-monads (~> 0.4)
       paint (~> 2.0)
-      pedrozath-mercenary (= 0.3.8)
-      tty-reader (~> 0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
     ast (2.4.0)
     byebug (10.0.2)
+    cli-ui (1.1.4)
     coderay (1.1.2)
     color (1.8)
     concurrent-ruby (1.0.5)
@@ -27,8 +33,11 @@ GEM
     equatable (0.5.0)
     hike (1.2.3)
     hitimes (1.2.6)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
     json (2.1.0)
     method_source (0.9.0)
+    minitest (5.11.3)
     necromancer (0.4.0)
     opal (0.10.5)
       hike (~> 1.2)
@@ -44,7 +53,6 @@ GEM
     pastel (0.7.2)
       equatable (~> 0.5.0)
       tty-color (~> 0.4.0)
-    pedrozath-mercenary (0.3.8)
     powerpack (0.1.1)
     pry (0.11.3)
       coderay (~> 1.1.0)
@@ -85,6 +93,7 @@ GEM
     sprockets (3.7.1)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
+    thread_safe (0.3.6)
     tilt (2.0.8)
     timers (4.1.2)
       hitimes
@@ -101,6 +110,8 @@ GEM
       tty-screen (~> 0.6.4)
       wisper (~> 2.0.0)
     tty-screen (0.6.4)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
     unicode-display_width (1.3.0)
     wisper (2.0.0)
 

data/bin/old-coltrane

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'old-coltrane' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("coltrane", "old-coltrane")

data/coltrane.gemspec

@@ -32,11 +32,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'tty-reader',  '~> 0.2'
   spec.add_runtime_dependency 'dry-monads',  '~> 0.4'
   spec.add_runtime_dependency 'paint',       '~> 2.0'
   spec.add_runtime_dependency 'color',       '~> 1.8'
-  spec.add_runtime_dependency 'pedrozath-mercenary', '0.3.8'
-  spec.add_development_dependency "bundler", '~> 1.14'
-  spec.add_development_dependency "rake",    '~> 10.0'
+  spec.add_runtime_dependency 'cli-ui',      '~> 1.1'
+  spec.add_runtime_dependency 'activesupport', '> 5.2'
+  spec.add_development_dependency "bundler",   '~> 1.14'
+  spec.add_development_dependency "rake",      '~> 10.0'
 end

data/exe/coltrane

@@ -1,65 +1,95 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
-
 $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
 
-require 'paint'
-require 'color'
+require 'coltrane/ui'
 
-require 'pedrozath-mercenary'
-require 'coltrane/commands'
+module Coltrane
+  module UI
+    class App
+      attr_reader :router
 
-if ENV['COLORTERM'] == 'truecolor'
-  Paint.mode = 0xFFFFFF
-else
-  Paint.mode = 0
-  puts "This terminal doesn't seem to support true color. " \
-       "Try something like iTerm2 (for macOS), VTE or Konsole (for linux) or Hyper" \
-       " (for Windows) and you'll see the true magic!"
-end
+      def self.start(initial_route)
+        if ENV['COLORTERM'] == 'truecolor'
+          Paint.mode = 0xFFFFFF
+        else
+          Paint.mode = 0
+          puts "This terminal doesn't seem to support true color. " \
+               "Try something like iTerm2 (for macOS), VTE or Konsole (for linux) or Hyper" \
+               " (for Windows) and you'll see the true magic!"
+        end
 
-Mercenary.program(:Coltrane) do |p|
-  p.version Coltrane::VERSION
-  p.description <<~DESC
-    A music querying interface
-    by Pedro Maciel (pedro@pedromaciel.com)
+        path, params = initial_route.split(' ').each_with_object([nil, {}]) do |segment, memo|
+          if segment =~ /:/
+            key, value = segment.split(':')
+            memo[1].merge!([[key.to_sym, value.gsub('-', ' ')]].to_h)
+          else
+            memo[0] = [memo[0], segment].compact.join(' ')
+          end
+        end
 
-    Check the chat room for project help/discussion/contribution: https://coltrane-ruby.herokuapp.com
-  DESC
-  p.syntax 'coltrane <subcommand> [options]'
+        response = {path: (path || ''), **params}
+        loop { response = app.flow(**response) }
+      end
 
-  Coltrane::Commands::Command.subclasses.each do |command|
-    command.mercenary_init(p)
-  end
+      def self.app
+        @app ||= new
+      end
 
-  p.command(:about) do |c|
-    c.description 'Shows this screen'
-    c.action { puts p }
-  end
+      def initialize
+        @router = Router.new
+      end
 
-  p.command(:shell) do |c|
-    c.description 'Starts an interactive shell'
-    c.action do
-      system File.expand_path('../../bin', __FILE__) + "/coltrane-interactive"
-    end
-  end
+      def ask_questions(questions)
+        questions.map { |name, question| [name, ask_question(question)] }.to_h
+      end
+
+      def ask_question(question)
+        CLI::UI::Prompt.ask(question[:statement], options: question[:options])
+      end
 
-  p.command(:help) do |c|
-    c.description 'May give you some help.'
-    c.syntax 'help <command> [subcommand, sub-subcommand, ...]'
-    c.action do |(*command_path), _options|
-      if command_path.empty?
-        puts p
-      else
-        puts begin
-          command_path.reduce(p) do |memo, key|
-            memo.commands.delete(key.to_sym)
-          end || "\n Sorry, command found."
+      def navigation(params)
+        return {} if params.empty?
+        CLI::UI::Prompt.ask('What to do now?') do |h|
+          params.each do |key, _value|
+            h.option("Different #{key}") { params[key] = nil }
+          end
+          h.option("Go back") { params[:path] = '' }
         end
+        params
+      end
+
+      def output(response)
+        return unless response[:content]
+        puts [
+          nil,
+          "-> coltrane #{router.url}",
+          nil,
+          response[:content],
+          nil
+        ]
+      end
+
+      def flow(response)
+        raise 'Response is empty' unless response
+        output(response)
+        response.delete(:content)
+        questions = response&.delete(:questions) || {}
+        response.merge!(navigation(response)) unless response.has_key?(:path) || questions.any?
+        response.merge!(ask_questions(questions)) if questions.any?
+        exit if response[:path] == 'exit'
+        router.get(**response.compact)
+      rescue => e
+        response.delete(:path)
+        puts e
+        retry
+      end
+
+      def exit
+        Kernel.exit(0)
       end
     end
   end
-
-  p.default_command(:shell)
 end
 
+Coltrane::UI::App.start(ARGV.join(' '))

data/lib/coltrane/commands.rb

@@ -3,13 +3,8 @@
 require 'coltrane'
 require 'coltrane/representation'
 require 'coltrane/renderers'
-
 require 'coltrane/commands/command'
-require 'coltrane/commands/notes'
-require 'coltrane/commands/chords'
-require 'coltrane/commands/scale'
-require 'coltrane/commands/progression'
-require 'coltrane/commands/common_chords'
-require 'coltrane/commands/find_scale'
-require 'coltrane/commands/find_progression'
-require 'coltrane/commands/find_guitar_chord'
+
+Dir[File.expand_path('../commands/*', __FILE__)].map do |f|
+  require(f)
+end

data/lib/coltrane/commands/available_chord_representations.rb

@@ -0,0 +1,9 @@
+module Coltrane
+  module Commands
+    class AvailableChordRepresentations < Command
+      def run
+        return ['GuitarChordChart'] + AvailableRepresentations.run
+      end
+    end
+  end
+end

data/lib/coltrane/commands/available_classic_scales.rb

@@ -0,0 +1,9 @@
+module Coltrane
+  module Commands
+    class AvailableClassicScales < Command
+      def run
+        Theory::Scale.known_scales
+      end
+    end
+  end
+end

data/lib/coltrane/commands/available_notable_progressions.rb

@@ -0,0 +1,9 @@
+module Coltrane
+  module Commands
+    class AvailableNotableProgressions < Command
+      def run
+        Theory::NotableProgressions::PROGRESSIONS.keys
+      end
+    end
+  end
+end

data/lib/coltrane/commands/available_representations.rb

@@ -0,0 +1,9 @@
+module Coltrane
+  module Commands
+    class AvailableRepresentations < Command
+      def run
+        ['Text'] + Representation.constants.map(&:to_s)
+      end
+    end
+  end
+end

data/lib/coltrane/commands/command.rb

@@ -1,61 +1,10 @@
 module Coltrane
   module Commands
     class Command
-      COMMON_OPTIONS = {
-        on: [
-          '--on <INSTRUMENT>',
-          'Shows the notes on the given instrument/representation type. ' \
-          'Can be text, piano, guitar, ukulele, bass.' \
-          'You can also provide a custom guitar using the following format:' \
-          '--on custom_guitar=D2-A3-D3-B3-C3'
-        ],
+      attr_reader :error
 
-        flavor: [
-          '--flavor <FLAVOR>',
-          'Chooses which additional information to display: ' \
-          'marks, notes, intervals or degrees'
-        ],
-
-        voicings: [
-          '--voicings <NUMBER>',
-          'Number of voicings for guitar like instruments. Default is 6' \
-          'provided they are separated by dashes'
-        ]
-      }
-
-      def custom_guitar
-        on
-        .to_s
-        .split('=')
-        .fetch(1)
-        .split('-')
-        .yield_self { |tuning| Representation::Guitar.new(tuning: tuning) }
-      end
-
-      def render
-        puts "\n" + Renderers::TextRenderer.render(
-          representation, **renderer_options
-        )
-      end
-
-      def renderer_options
-        {}
-      end
-
-      class << self
-
-        def subclasses
-          @subclasses ||= []
-        end
-
-        def inherited(base)
-          subclasses << base
-          super(base)
-        end
-
-        def add_shared_option(option_name, mercenary_command)
-          mercenary_command.option(option_name, *COMMON_OPTIONS[option_name])
-        end
+      def self.run(*args)
+        new.run(*args)
       end
     end
   end

data/lib/coltrane/commands/find_chord_by_notes.rb

@@ -0,0 +1,9 @@
+module Coltrane
+  module Commands
+    class FindChordByNotes < Command
+      def run(notes)
+        Theory::Chord.new(notes: notes)
+      end
+    end
+  end
+end

data/lib/coltrane/commands/find_common_chords.rb

@@ -0,0 +1,9 @@
+module Coltrane
+  module Commands
+    class FindCommonChords < Command
+      def run(*scales)
+        scales.map(&:chords).reduce(&:&)
+      end
+    end
+  end
+end

data/lib/coltrane/commands/find_progressions_from_chords.rb

@@ -0,0 +1,9 @@
+module Coltrane
+  module Commands
+    class FindProgressionsFromChords < Command
+      def run(*chords)
+        Theory::Progression.find(*chords)
+      end
+    end
+  end
+end

data/lib/coltrane/commands/find_scale_by_chords.rb

@@ -0,0 +1,9 @@
+module Coltrane
+  module Commands
+    class FindScaleByChords < Command
+      def run(chords)
+        Theory::Scale.having_chords(*chords)
+      end
+    end
+  end
+end