coltrane 2.2.1 → 3.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73fefa27f1153e68849f503990c62b0f37d66a58f5979b6c8eca4292166ece20
-  data.tar.gz: f83f2490b0402555ef13f7d04790c4982e7e7f8274fcfd9f4290e497d357b3ed
+  metadata.gz: 7b31feba198134bfc6fb460384f54e2ab64673195da1d8a49387b0330992d684
+  data.tar.gz: 0185a37862223cf82da552d1b93ba2b0423044cf788956fc2c3d66a8cc9cb19a
 SHA512:
-  metadata.gz: 3aec21519141e0e6fd73a5bec77acbbc510cde319b16d1f6544a3fa256bb78d858dfa2525e049cd40b4d7f4acb5c480963906dd3aada7d3f6539f3ed5a14b7d1
-  data.tar.gz: 2ded1ec625ec59cc2cfb519128806b45b9e953ef123bb1822268a7a74f87b83e66027d0771e5e1bbf5c7ce26e1d63b6e901725cc68df71b0404378082de83265
+  metadata.gz: ecdcbace2c6c7cf71c39acec0768728ac92fc46250310fecb046309e5b97a12b6f2f3c987be29a0a72e88e3c72781a3e867b56a781159db11d62f6110fb16a85
+  data.tar.gz: 3ddfd6129273dc69b6e20a176129cb86d079735ad47cdcb98a5b16c6706d12ea29414a834c0a488be1273b7dc73d3328416b2575064a6870c47a737a1086c9c7

data/.travis.yml

@@ -1,10 +1,25 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=ef9987fd97eefaf4017a8b88e063e9376b408e93b170ad4610c8fce4370f4be2
+
 language: ruby
 git:
   depth: 1
+
 rvm:
 - 2.5.0
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
 script:
 - bin/rspec spec
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+
 deploy:
   provider: rubygems
   api_key:
@@ -14,4 +29,4 @@ deploy:
     repo: pedrozath/coltrane
 notifications:
   slack:
-    secure: A4qliXrG8AgvMi9skLwfTfGgRxeVRBIBS8O6tIF2k0oLn+i0XRCEPWYnK4Xa1YufgCnMTFlGA144sxsvuf3spBuwCJkOefA7YhJJVhKQTCpmkSq0IPEaF8+KpwESI1W1hBJuEWmCAxwL1Z+tZa7CON2ELyKgHukxEtUTfQsbXMY1eeISRm7a73xi4DlfTM4UEV2Cfd/Rg9cpP4QGsWANowDsaNm33aQ611BIokfVSZtKf7A4IPAthZOrXkGqD0R4FjUxbDUtQEd5gg3tpcPmWrHIxunlvJow/XBXtv+/qDlbo8LzUUxtkElcGjj1g3hsQEZmevoNxZdGW/8/F5DMMLYYQRfph7Ot9Xm6dNYj3rIUcHjNob1qUNb0ON2pko4gcO6HiU8VZ/oQUsUtBBrB7ddf1htXVdO3jHH2josFTCWgFCzPwgxsCuyP71lieDBolyaKFOyWGaWj6cZhqGUfkSosLZNyDoUEWERkImOHyqvi5TQaPVteZvUeCDkD6ZtCTyEjZI8zXdyPKKweBLxRuGMjUgpsA5QEyo3dlIguLe7OYCLWyYYmEcF+2QjYLevEBFNM1rl6tK8VEF6aost0pa6Rq6/VHRNEEKn0ejYTqbiPGljmOiDOwWSCxQWhlJ9tw692wnpLN5/y0Cda40PQ87hi1tXyvcvLrrvETfYfXcU=
+    secure: Z1DrNRL47BvEB/PWyb+EsVlAwVsGapytLGCiyQeTlNBTK7iCfP3N57fkVZDyaMYWJ7oweCk16aTBxljnP6SPNaqQhKWilDXiwnX9s3uWxz06ONgg8TE46hGyplD5fmt/liIxQ/XeJoCA8C6qWJRAc94Y0b42yK23eFbCU3632ISt1wVwipOcuAyCD0TTjQUHRjWT4Zbg6gqytG+U3rsx2+wGUDbu2Nu5r6C90uU0vbmHyhcmf2S7V7is7Kpc24aDhPhBBrP44uWXLEXh8Hgthca95jVm2CoL2GVK+f6W/mAkQugkg0Rz//d8+9M5SJcHQiUBwNIXxfgEQKkVFSuiMcySdG0RFBh9dyPPem3AUWEO9HwNlF+juMkwP+Wavj9eoN3cWNeVJrT00mXaTzmPdxFKxvRKp/NSJQIKI7dzg74oggyzu5BSmTlth2YGgNzEhKbAjOGL+B2ClE5KeR4ZIUsEH7Z/KAoHH4EPERYqec+aSsbLuoAAQiuRIqul+MyZiz0ox/kA1hFVndbDg7avxqZUzBSBZ7f9nMzKxQeUGSJYS3f5XWYpIDCxEiub5LiLMkltaM2AGAzZfFhLYEC96J/HoyF7xxHZNWbEJiv+bLuQGcD8BUCTNfRZM15nQbaKNBpyx/lC0h4kRAGnaGAnfGYCuKHjHPWsSAc8jcmW3Bw=

data/CHANGELOG.md

@@ -5,6 +5,17 @@
 - Fix chords so that they generate a barre and a non-barre version and prevent
   barre chords from picking notes before the barre.
 
+## [3.0.0]
+
+### Changes
+
+- This is a huge architectural refactor. Hopefully the last big one. All code were redivided into the modules:
+
+  1. Coltrane::Theory concentrates all music theory logic
+  2. Coltrane::Representation contain musical instruments and any other needed musical-related abstract representations.
+  3. Coltrane::Renderers right now contains the TextRenderer which has the ability of rendering Theory Objects, Representation Objects, etc
+  4. Coltrane::Commands are ways of fetching Theory and Representation objects. They also glue Mercenary (the gem used for the CLI) into everything else.
+
 ## [2.2.0]
 
 - Intervals were completely refactored according to [#11](https://github.com/pedrozath/coltrane/issues/11) and (https://github.com/pedrozath/coltrane/issues/12). Thanks [@art-of-dom](https://github.com/art-of-dom) for the valuable information. We now have new interval classes and new ways on how to deal with them.

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    coltrane (2.2.1)
+    coltrane (3.0.0.pre)
       color (~> 1.8)
       dry-monads (~> 0.4)
-      paint (~> 2.0)
+      paint (~> 2.0.1)
       pedrozath-mercenary (~> 0.3)
+      tty-prompt (~> 0.16.0)
 
 GEM
   remote: https://rubygems.org/
@@ -25,12 +26,14 @@ GEM
     dry-monads (0.4.0)
       dry-core (~> 0.3, >= 0.3.3)
       dry-equalizer
+    equatable (0.5.0)
     faraday (0.14.0)
       multipart-post (>= 1.2, < 3)
     gitlab (3.6.1)
       httparty
       terminal-table
     hike (1.2.3)
+    hitimes (1.2.6)
     httparty (0.16.1)
       multi_xml (>= 0.5.2)
     interception (0.5)
@@ -38,6 +41,7 @@ GEM
     method_source (0.9.0)
     multi_xml (0.6.0)
     multipart-post (2.0.0)
+    necromancer (0.4.0)
     octokit (4.8.0)
       sawyer (~> 0.8.0, >= 0.5.3)
     opal (0.10.5)
@@ -51,6 +55,9 @@ GEM
     parallel (1.12.1)
     parser (2.4.0.2)
       ast (~> 2.3)
+    pastel (0.7.2)
+      equatable (~> 0.5.0)
+      tty-color (~> 0.4.0)
     pedrozath-mercenary (0.3.6)
     powerpack (0.1.1)
     pronto (0.6.0)
@@ -112,7 +119,23 @@ GEM
       unicode-display_width (~> 1.1, >= 1.1.1)
     thor (0.19.4)
     tilt (2.0.8)
+    timers (4.1.2)
+      hitimes
+    tty-color (0.4.2)
+    tty-cursor (0.5.0)
+    tty-prompt (0.16.0)
+      necromancer (~> 0.4.0)
+      pastel (~> 0.7.0)
+      timers (~> 4.0)
+      tty-cursor (~> 0.5.0)
+      tty-reader (~> 0.2.0)
+    tty-reader (0.2.0)
+      tty-cursor (~> 0.5.0)
+      tty-screen (~> 0.6.4)
+      wisper (~> 2.0.0)
+    tty-screen (0.6.4)
     unicode-display_width (1.3.0)
+    wisper (2.0.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,4 +1,7 @@
 [![Build Status](https://travis-ci.org/pedrozath/coltrane.svg?branch=master)](https://travis-ci.org/pedrozath/coltrane)
+[![Gem Version](https://badge.fury.io/rb/coltrane.svg)](https://badge.fury.io/rb/coltrane)
+[![Maintainability](https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/maintainability)](https://codeclimate.com/github/pedrozath/coltrane/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/test_coverage)](https://codeclimate.com/github/pedrozath/coltrane/test_coverage)
 
 # Coltrane
 

data/bin/console

@@ -3,10 +3,14 @@ $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
 
 require "bundler/setup"
 require "coltrane"
-require "coltrane_instruments"
-# require "coltrane_synth"
+require "coltrane/representation"
+require "coltrane/renderers"
 
 require "pry"
 
 include Coltrane
+include Coltrane::Theory
+include Coltrane::Representation
+include Coltrane::Renderers
+
 Pry.start

data/coltrane.gemspec

@@ -32,8 +32,9 @@ 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-prompt',          '~> 0.16.0'
   spec.add_runtime_dependency 'dry-monads',          '~> 0.4'
-  spec.add_runtime_dependency 'paint',               '~> 2.0'
+  spec.add_runtime_dependency 'paint',               '~> 2.0.1'
   spec.add_runtime_dependency 'color',               '~> 1.8'
   spec.add_runtime_dependency 'pedrozath-mercenary', '~> 0.3'
   spec.add_development_dependency "bundler",         '~> 1.14'

data/exe/coltrane

@@ -1,20 +1,15 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/BlockLength
-
 $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
 
-require 'cli'
-
-full_color_terminals = %w[iTerm.app]
-safe_mode_terminals = %w[Unsupported]
+require 'paint'
+require 'color'
+require 'mercenary'
+require 'coltrane/commands'
+require 'pry'
 
-if full_color_terminals.include?(ENV['TERM_PROGRAM'])
-  Paint.mode = 0xFFFFFF
-elsif safe_mode_terminals.include?(ENV['TERM_PROGRAM'])
-  Paint.mode = 0
-end
+Paint.mode = 0xFFFFFF
 
 Mercenary.program(:Coltrane) do |p|
   p.version Coltrane::VERSION
@@ -22,226 +17,21 @@ Mercenary.program(:Coltrane) do |p|
     A music querying interface
     by Pedro Maciel (pedro@pedromaciel.com)
 
-    Check the chat room for project discussion/help: https://gitter.im/coltrane-music/Lobby
+    Check the chat room for project help/discussion/contribution: https://coltrane-ruby.herokuapp.com
   DESC
   p.syntax 'coltrane <subcommand> [options]'
 
-  @instrument_option = [
-    :on,
-    '--on guitar INSTRUMENT',
-    'Shows the notes on the given instrument/representation type. Can be piano, guitar, ukulele, bass or text'
-  ]
-
-  @flavor_option = [
-    :flavor,
-    '--flavor FLAVOR',
-    'Chooses which additional information to display: marks, notes, intervals or degrees'
-  ]
-
-  @sound_option = [
-    :sound,
-    '--sound',
-    'beta/macOS only: plays the sound of related notes/chords'
-  ]
-
-  p.command(:note) do |c|
-    c.alias(:notes)
-    c.syntax 'notes <notes separated by space> [--on <instrument>]'
-    c.description 'Shows the given notes.'
-    c.option(*@instrument_option)
-    c.option(*@flavor_option)
-    c.option(*@sound_option)
-    c.action do |(notes), on: 'text', flavor: 'notes'|
-      Coltrane::Cli.config do |c|
-        c.on     = on.to_sym
-        c.flavor = flavor.to_sym
-      end
-
-      raise 'Provide some notes. Ex: coltrane notes C-D-Gb' if notes.empty?
-      notes = Coltrane::NoteSet[*notes.split('-')]
-      Coltrane::Cli::Notes.new(notes)
-    end
-  end
-
-  p.command(:chord) do |c|
-    c.alias(:chords)
-    c.syntax 'chord <chord-name> [--on <instrument>]'
-    c.description 'Shows the given chord. Ex: coltrane chord Cmaj7 --on piano'
-    c.option(*@instrument_option)
-    c.option(*@flavor_option)
-    c.option(*@sound_option)
-    c.option :notes, '--notes C-D-E', 'finds chords with those notes, provided they are separated by dashes'
-    c.action do |(chords), notes: nil, on: 'text', flavor: 'notes', sound: nil|
-      Coltrane::Cli.config do |c|
-        c.on     = on.to_sym
-        c.flavor = flavor.to_sym
-        c.sound  = sound
-      end
-
-      chords = chords&.split('-')
-      Coltrane::Cli::Chord.new(*chords, notes: notes&.split('-'))
-    end
-  end
-
-  p.command(:scale) do |c|
-    c.syntax 'scale <name of scale>-<root note> [--on <instrument>]'
-    c.description 'Gives you information about a scale. Ex: coltrane scale natural-minor-Db --on guitar'
-    c.option(*@instrument_option)
-    c.option(*@flavor_option)
-    c.option(*@sound_option)
-    c.option :triads,   '--triads',        'Outputs triads from the scale'
-    c.option :sevenths, '--sevenths',      'Outputs seventh chords from the scale'
-    c.option :pentads,  '--pentads',       'Outputs pentad chords from the scale'
-    c.option :tertians, '--tertians SIZE', 'Outputs all tertian chords from the given size from the scale'
-    c.option :chords,   '--chords [SIZE]', 'Outputs all chords from given size from the scale. Leave size empty to retrieve all'
-    c.action do |(scale_str), flavor: 'degrees', on: 'text', sound: false, **options|
-      Coltrane::Cli.config do |c|
-        c.on     = on.to_sym
-        c.flavor = flavor.to_sym
-        c.sound  = sound
-      end
-
-      scale = Coltrane::Cli::Scale.parse(scale_str)
-      if options.include?(:triads)
-        chords = scale.triads
-        Coltrane::Cli::Chord.new(*chords, **keyword_args)
-      elsif options.include?(:sevenths)
-        chords = scale.sevenths
-        Coltrane::Cli::Chord.new(*chords, **keyword_args)
-      elsif options.include?(:pentads)
-        chords = scale.pentads
-        Coltrane::Cli::Chord.new(*chords, **keyword_args)
-      elsif options.include?(:tertians)
-        chords = scale.tertians(options[:tertians].to_i)
-        Coltrane::Cli::Chord.new(*chords, **keyword_args)
-      elsif options.include?(:chords)
-        chords = if options[:chords].nil?
-                   scale.all_chords
-                 else
-                   scale.chords(options[:chords])
-                 end
-        Coltrane::Cli::Chord.new(*chords)
-      else
-        Coltrane::Cli::Scale.new(scale)
-      end
-    end
-  end
-
-  p.command(:progression) do |c|
-    c.syntax 'progression <roman numeral notation> in <key> [--on <instrument>]'
-    c.description 'Gives you chords of a progression in a key. Ex: coltrane progression I-IV-iv-V in Am --on guitar'
-    c.option(*@instrument_option)
-    c.option(*@flavor_option)
-    c.option(*@sound_option)
-    c.action do |(prog, _, key), on: 'text', flavor: 'notes', sound: nil|
-      Coltrane::Cli.config do |c|
-        c.on     = on.symbolize
-        c.flavor = flavor.symbolize
-        c.sound  = sound
-      end
-
-      possible_method = prog.tr('-', '_')
-      progression = if Coltrane::Progression.respond_to?(possible_method)
-                      Coltrane::Progression.send(possible_method, key)
-                    else
-                      Coltrane::Progression.new(prog, key: key)
-                    end
-
-      Coltrane::Cli::Chord.new(*progression.chords)
-    end
+  Coltrane::Commands::Command.subclasses.each do |command|
+    command.mercenary_init(p)
   end
 
-  p.command(:'find-progression') do |c|
-    c.syntax 'find-progression <list of chords>'
-    c.description 'Find progressions in scales. Ex: coltrane find-progression AM-DM-F#m-EM'
-    c.action do |(chord_notation)|
-      progressions   = Coltrane::Progression.find(*chord_notation.split('-'))
-      notation_width = progressions.map(&:notation).map(&:size).max
-      progressions.each do |progression|
-        puts "#{progression.notation.ljust(notation_width + 1, ' ')} in #{progression.scale} (#{progression.notes_out.size} notes out)"
-      end
+  p.command(:about) do |c|
+    c.description 'Shows this screen'
+    c.action do
+      puts p
     end
   end
 
-  p.command(:list) do |list|
-    list.syntax 'list [scales, flavors, instruments (used in --on options), chord-qualities]'
-    list.description 'List information.'
-    list.action do |(arg)|
-      puts case arg
-           when 'scales' then Coltrane::Scale.known_scales
-           when 'flavors' then %w[marks notes intervals degrees]
-           when 'instruments' then %w[guitar bass ukulele piano text]
-           when 'chords', 'chord-qualities' then Coltrane::ChordQuality.intervals_per_name.keys.join(' ')
-           end
-    end
-  end
-
-  p.command(:'find-scale') do |c|
-    c.syntax 'find-scale --notes C-D-E-...] OR --chord Cmaj7-Db7'
-    c.description 'finds scales with the provided --notes or --chord'
-    c.option :notes, '--notes C-D-E', 'Find scales with those notes'
-    c.option :chords, '--chords Cmaj7-D11', 'find scales with those chords'
-    c.action do |(_arg), options|
-      options[:notes]  = (options[:notes]).to_s.split('-')
-      options[:chords] = (options[:chords]).to_s.split('-')
-      Coltrane::Cli::Scale.find(**options)
-    end
-  end
-
-  p.command(:'common-chords') do |c|
-    c.syntax 'common-chords <SCALE1 SCALE2 [SCALE3]>'
-    c.description 'Finds chords that are shared between the given scales'
-    c.option(*@instrument_option)
-    c.option(*@flavor_option)
-    c.action do |(*scale_strings), on: 'text', flavor: 'notes'|
-      raise 'Provide at least 2 scales' if scale_strings.size < 2
-      first_scale_str, *other_scales_strs = scale_strings
-      first_scale = Coltrane::Cli::Scale.parse(first_scale_str)
-      chords = other_scales_strs.reduce(first_scale.all_chords.map(&:name)) do |memo, scale_str|
-        scale = Coltrane::Cli::Scale.parse(scale_str)
-        memo & scale.all_chords.map(&:name)
-      end
-      raise 'No common chords were found' if chords.empty?
-      Coltrane::Cli::Chord.new(*chords)
-    end
-  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."
-        end
-      end
-    end
-  end
-
-  # p.command(:start) do |c|
-  #   c.description 'Starts interactive mode'
-  #   c.action do
-  #     begin
-  #       Coltrane::Cli.erase_config
-  #       puts "\n"
-  #       print Paint['coltrane ', '#F88550']
-  #       cmd = gets.chomp
-  #       return if %w[exit exit q quit stop].include?(cmd)
-  #       puts "\n"
-  #       p.go(cmd.split(' '))
-  #     rescue Exception
-  #     ensure
-  #       p.instance_variable_set :'@config', {}
-  #     end
-  #     p.execute(['start'], {})
-  #   end
-  # end
-
-  # p.default_command(:start)
+  p.default_command(:about)
 end
 
-# rubocop:enable Metrics/BlockLength

data/lib/coltrane.rb

@@ -1,58 +1,11 @@
 # frozen_string_literal: true
 
+require 'coltrane/version'
+
 require 'json'
 require 'forwardable'
 require 'core_ext'
 require 'ostruct'
 require 'dry-monads'
 
-# The main module for working with Music Theory
-module Coltrane
-  autoload :Frequency, 'coltrane/frequency'
-
-  BASE_OCTAVE = 4
-  BASE_PITCH_INTEGER = 9
-
-  def self.tuning=(f)
-    @base_tuning = Frequency[f].octave(-4)
-  end
-
-  def self.base_tuning
-    @base_tuning
-  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 :FrequencyInterval,      'coltrane/frequency_interval'
-  autoload :IntervalClass,          'coltrane/interval_class'
-  autoload :Interval,               'coltrane/interval'
-  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
+require 'coltrane/theory'