coltrane 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80404f5ec9c45b649eae4fb0dd47bbb5b9349ca344a8d72b06561f689f9d9c56
-  data.tar.gz: 9e733b52b1f1d4466849fa5ef724ad4947ab93b1b60dee01475e3f9abeac043f
+  metadata.gz: aee4f6c4975a8d1c27e1c7d8b55bc89d58a73e65e93f9df8831cfbb68f0da689
+  data.tar.gz: 3345417f778a55d64dc1d7bdf9348fdb98d7b60c9eb6eb1f8a8969ae6933e7ca
 SHA512:
-  metadata.gz: 87cab0e8294560a0185b9d2d960d36690208112b775b36002381e98bf5a93c2e6e215c00332dc0f7fd55b17dbda6a268c4069951237732b4b44dd53c2f517bbb
-  data.tar.gz: e3b5c7fdb14798100386449aab19bbf34442247bda37364df7601ddcf6d2196234876c0e7f27dd2af435bcd8453d1fdd24ed2e928ae2607088eebfbed1fa237c
+  metadata.gz: 2c41d660a8d4d4d877a1614030196cca1c2f7b8b823795a259378b962e3f9dc5e22fbaa32086ff0d4cc830b7aa81ec7783c4e242552c94ee5bc069499bd055c5
+  data.tar.gz: d0658a0f30b263a19f7d2f190ed4ac17906e80ee9a2c99c87f18c407bd2e2f60db5adaac96705271d761dd7b3602242cd4bf690307b4d379d3dfa2fdebfdda6f

data/CHANGELOG.md

@@ -1,7 +1,33 @@
 # Changelog
 
 ## [Unreleased]
-- Correct Flat/Sharp on scales
+
+- Fix chords so that they generate a barre and a non-barre version and prevent
+  barre chords from picking notes before the barre.
+
+## [2.1.0]
+
+- Correct Flat/Sharp on Diatonic Scales
+
+- Fix chords so that they generate a barre and a non-barre version and prevent
+  barre chords from picking notes before the barre.
+
+### Adds
+
+- Pitches and Voicings. Pitches are a way of expressing notes in a specific
+  octave. Voicings are a way of expressing a chord with the exact pitches
+
+- Introduces a little sound synthesizer (experimental, macOS-only).
+  Use `--sound` to activate it wherever the program outputs chords.
+
+- Introduces some modules classes to provide Guitar Chord finding.
+  `ColtraneInstruments::Guitar::Base.find('C6/9')`
+
+- Introduces DiatonicScale and Key classes.
+
+### Changes
+
+- Guitar Chords are now outputted using the default guitar chord notation
 
 ## [2.0.0]
 

data/Gemfile

@@ -9,6 +9,7 @@ group :test, :development do
   gem 'pronto'
   gem 'pronto-flay'
   gem 'pronto-rubocop'
+  gem 'opal-rspec'
 end
 
 group :test do

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    coltrane (1.2.4)
+    coltrane (2.1.0)
       color (~> 1.8)
-      facets (~> 3.1)
+      coreaudio
       paint (~> 2.0)
       pedrozath-mercenary (~> 0.3)
 
@@ -16,10 +16,12 @@ GEM
     byebug (9.1.0)
     coderay (1.1.2)
     color (1.8)
+    concurrent-ruby (1.0.5)
+    coreaudio (0.0.12)
+      narray (~> 0.6.0.0)
     diff-lcs (1.3)
     docile (1.1.5)
     erubis (2.7.0)
-    facets (3.1.0)
     faraday (0.14.0)
       multipart-post (>= 1.2, < 3)
     flay (2.10.0)
@@ -30,6 +32,7 @@ GEM
     gitlab (3.6.1)
       httparty
       terminal-table
+    hike (1.2.3)
     httparty (0.16.0)
       multi_xml (>= 0.5.2)
     interception (0.5)
@@ -37,8 +40,16 @@ GEM
     method_source (0.9.0)
     multi_xml (0.6.0)
     multipart-post (2.0.0)
+    narray (0.6.0.9)
     octokit (4.8.0)
       sawyer (~> 0.8.0, >= 0.5.3)
+    opal (0.10.5)
+      hike (~> 1.2)
+      sourcemap (~> 0.1.0)
+      sprockets (~> 3.1)
+      tilt (>= 1.4)
+    opal-rspec (0.6.1)
+      opal (>= 0.10.0, < 0.12)
     paint (2.0.1)
     parallel (1.12.1)
     parser (2.4.0.2)
@@ -67,6 +78,7 @@ GEM
       interception (>= 0.5)
       pry
     public_suffix (3.0.2)
+    rack (2.0.4)
     rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.7.0)
@@ -102,9 +114,14 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    sourcemap (0.1.1)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     thor (0.19.4)
+    tilt (2.0.8)
     unicode-display_width (1.3.0)
 
 PLATFORMS
@@ -113,6 +130,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.14)
   coltrane!
+  opal-rspec
   pronto
   pronto-flay
   pronto-rubocop

data/README.md

@@ -15,13 +15,6 @@ https://gitter.im/coltrane-music/Lobby
 
 ### Installation
 
-#### Compiled binary
-
-There's an experimental compiled version you can [download here](https://raw.githubusercontent.com/pedrozath/coltrane/master/dist/coltrane). It has been tested only macOS High Sierra so far, but it should work on Linux and Windows as well.
-
-macOS & Linux: You probably will need `chmod +x coltrane` before running it.
-Windows users: Please add the `.exe` extension to it before running it (via command prompt).
-
 #### Ruby command
 
 ```bash

data/Rakefile

@@ -1,2 +1,7 @@
 # require "bundler/gem_tasks"
 task :default => :spec
+
+require 'opal/rspec/rake_task'
+Opal::RSpec::RakeTask.new(:opal_specs) do |server, task|
+  task.pattern = 'spec/{coltrane_instruments,lib}/**/*_spec.rb'
+end

data/bin/console

@@ -3,6 +3,8 @@ $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
 
 require "bundler/setup"
 require "coltrane"
+require "coltrane_instruments"
+require "coltrane_synth"
 
 require "pry"
 

data/bin/opal

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'opal' 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, 150) =~ /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("opal", "opal")

data/bin/opal-build

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'opal-build' 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, 150) =~ /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("opal", "opal-build")

data/bin/opal-mspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'opal-mspec' 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, 150) =~ /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("opal", "opal-mspec")

data/bin/opal-repl

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'opal-repl' 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, 150) =~ /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("opal", "opal-repl")

data/bin/rackup

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 #
 # This file was generated by Bundler.
 #
@@ -11,6 +12,17 @@ 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, 150) =~ /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"
 

data/bin/sprockets

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 #
 # This file was generated by Bundler.
 #
@@ -11,6 +12,17 @@ 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, 150) =~ /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"
 

data/bin/tilt

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 #
 # This file was generated by Bundler.
 #
@@ -11,6 +12,17 @@ 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, 150) =~ /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"
 

data/coltrane.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'facets',              '~> 3.1'
+  spec.add_runtime_dependency 'coreaudio'
   spec.add_runtime_dependency 'paint',               '~> 2.0'
   spec.add_runtime_dependency 'color',               '~> 1.8'
   spec.add_runtime_dependency 'pedrozath-mercenary', '~> 0.3'

data/config.ru

@@ -0,0 +1,10 @@
+require 'opal/rspec'
+
+# or use Opal::RSpec::SprocketsEnvironment.new(spec_pattern='spec/opal/**/*_spec.{rb,opal}') to customize the pattern
+sprockets_env = Opal::RSpec::SprocketsEnvironment.new
+run Opal::Server.new(sprockets: sprockets_env) { |s|
+  s.main = 'opal/rspec/sprockets_runner'
+  sprockets_env.spec_exclude_pattern = 'spec/exe/**/*_spec.rb'
+  sprockets_env.add_spec_paths_to_sprockets
+  s.debug = true
+}

data/exe/coltrane

@@ -5,8 +5,6 @@
 
 $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
 
-require 'core_ext'
-require 'coltrane'
 require 'cli'
 
 full_color_terminals = %w[iTerm.app]
@@ -37,7 +35,13 @@ Mercenary.program(:Coltrane) do |p|
   @flavor_option = [
     :flavor,
     '--flavor FLAVOR',
-    'Chooses which <additional></additional> information to display: marks, notes, intervals or degrees'
+    '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|
@@ -46,10 +50,16 @@ Mercenary.program(:Coltrane) do |p|
     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, on: on, flavor: flavor)
+      Coltrane::Cli::Notes.new(notes)
     end
   end
 
@@ -59,10 +69,17 @@ Mercenary.program(:Coltrane) do |p|
     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'|
+    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('-'), on: on, flavor: flavor)
+      Coltrane::Cli::Chord.new(*chords, notes: notes&.split('-'))
     end
   end
 
@@ -71,14 +88,20 @@ Mercenary.program(:Coltrane) do |p|
     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', **options|
+    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)
-      keyword_args = { flavor: flavor, on: on }
       if options.include?(:triads)
         chords = scale.triads
         Coltrane::Cli::Chord.new(*chords, **keyword_args)
@@ -97,9 +120,9 @@ Mercenary.program(:Coltrane) do |p|
                  else
                    scale.chords(options[:chords])
                  end
-        Coltrane::Cli::Chord.new(*chords, **keyword_args)
+        Coltrane::Cli::Chord.new(*chords)
       else
-        Coltrane::Cli::Scale.new(scale, **keyword_args)
+        Coltrane::Cli::Scale.new(scale)
       end
     end
   end
@@ -109,7 +132,14 @@ Mercenary.program(:Coltrane) do |p|
     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.action do |(prog, _, key), on: 'text', flavor: 'notes'|
+    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)
@@ -117,7 +147,7 @@ Mercenary.program(:Coltrane) do |p|
                       Coltrane::Progression.new(prog, key: key)
                     end
 
-      Coltrane::Cli::Chord.new(*progression.chords, on: on, flavor: flavor)
+      Coltrane::Cli::Chord.new(*progression.chords)
     end
   end
 
@@ -172,7 +202,7 @@ Mercenary.program(:Coltrane) do |p|
         memo & scale.all_chords.map(&:name)
       end
       raise 'No common chords were found' if chords.empty?
-      Coltrane::Cli::Chord.new(*chords, on: on, flavor: flavor)
+      Coltrane::Cli::Chord.new(*chords)
     end
   end
 
@@ -196,6 +226,7 @@ Mercenary.program(:Coltrane) do |p|
     c.description 'Starts interactive mode'
     c.action do
       begin
+        Coltrane::Cli.erase_config
         puts "\n"
         print Paint['coltrane ', '#F88550']
         cmd = gets.chomp