coltrane 2.1.0 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aee4f6c4975a8d1c27e1c7d8b55bc89d58a73e65e93f9df8831cfbb68f0da689
-  data.tar.gz: 3345417f778a55d64dc1d7bdf9348fdb98d7b60c9eb6eb1f8a8969ae6933e7ca
+  metadata.gz: 1af07ab95dbc675d21b3543f87c30389a38a95685d963a6f6b0af48b60fb5653
+  data.tar.gz: d066a320b2d192feafcc7bea90e0aaee0977c7bb5284392c555de1689afc900f
 SHA512:
-  metadata.gz: 2c41d660a8d4d4d877a1614030196cca1c2f7b8b823795a259378b962e3f9dc5e22fbaa32086ff0d4cc830b7aa81ec7783c4e242552c94ee5bc069499bd055c5
-  data.tar.gz: d0658a0f30b263a19f7d2f190ed4ac17906e80ee9a2c99c87f18c407bd2e2f60db5adaac96705271d761dd7b3602242cd4bf690307b4d379d3dfa2fdebfdda6f
+  metadata.gz: 20d76f287e71bf910e9ca40e8d586ea35e03f30d9598ab6ed7ee249b9341ad0ff99269ff73ea2dc2b945af8d97e8941bc9da87a88cba39913f71ab42c3c371ec
+  data.tar.gz: 3b43103aa6830b80faa581586b87099a56186dfa4bfa7e6f9fa19da388f119ae88e6a20b8a7e83de5ff2afbc7d2ad342a176a885853ce744989209095237cc67

data/README.md

@@ -1,75 +1,53 @@
 # Coltrane
 
-A musical abacus written in ruby.
+A music calculation library/CLI written in Ruby.
 
 ![Coltrane](img/coltrane-logo.png)
 
-More info, story and purpose of the library [here](https://medium.com/@pedrozath/so-i-wrote-a-library-to-help-me-compose-music-ddb4ae7c8227).
-
-Chat room for discussing the project, answering questions, etc:
-https://gitter.im/coltrane-music/Lobby
+* [How to use this library](https://github.com/pedrozath/coltrane/wiki/Core-music-theory-library).
+* [Why did I wrote this library](https://medium.com/@pedrozath/so-i-wrote-a-library-to-help-me-compose-music-ddb4ae7c8227).
+* [Chat room for discussing the project, answering questions, etc.](https://gitter.im/coltrane-music/Lobby)
 
 ## CLI (Command Line Interface)
 
 ![Screenshot](img/using-coltrane.gif)
+![Screenshot](img/guitar-chords.png)
+
+## Features
 
-### Installation
+* Generate chord progressions for Jazz, Blues, Pop, or custom and see how to play them
+* Seek chords, see their notes and how to play them
+* Seek scales, see their notes and see how to play them
+* Find chords that are common between 2 scales
+* Find scales containing a chord or a set of notes
+* Find possible progressions of a chord sequence
+* All of the above can be seen on guitar, bass, piano or ukelele representations, no sheet music needed
 
-#### Ruby command
+## Installation
 
 ```bash
 $ gem install coltrane
 ```
 
-Once you install the gem the CLI is instaled in your system and it's ready to be used.
-
-### Usage
-
-It allows you to query for notes and chords and display them on your favorite instrument. No sheet music reading skills needed. It also allows you to find scales with a chord and find chords shared between two scales (that is actually the main goal when I did this project).
-
-## As a library
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'coltrane'
-```
-
-And then execute:
-```sh
-$ bundle
-```
-
-The whole library will be available under the `Coltrane` module. The CLI code won't be imported to your application as default. Here's a quick example on how to use it:
-
-```ruby
-require 'coltrane'
-
-puts Coltrane::Scale.major('C').sevenths.map(&:name)
-# => ["CM7", "Dm7", "Em7", "FM7", "G7", "Am7", "Bm7b5"]
-
-puts Coltrane::Scale.having_chord('CM7').scales.map(&:name)
-# => ["C Major", "G Major", "E Natural Minor", "A Natural Minor", "E Harmonic Minor", "B Flamenco"]
-```
+PS: Once you install the gem the CLI is instaled in your system and it's ready to be used.
 
 ## Changelog
 
-See the changelog [here](CHANGELOG.md)
+[See the changelog](CHANGELOG.md)
 
 ## Contributing
 
-Install the test suite (RSpec) by running good old `bundle` command
-
-Fork the code, make your changes and maybe write a test or two. Then run:
-
-Then run:
-```
-bundle exec rspec spec
-```
+We are looking for contributors. Find me on [our chatroom](https://gitter.im/coltrane-music/Lobby) if you need any kind of information.
 
-Make sure the specs pass and submit a PR.
+### How to contribute
+1. Fork this code
+2. Install the test suite (RSpec) by running good old `bundle` command
+3. Make your changes and maybe write a test or two.
+4. Check if specs pass `bundle exec rspec spec`
+5. Submit a PR.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+by Pedro Maciel | [twitter](http://twitter.com/pedrozath) | pedro@pedromaciel.com

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 'coreaudio'
+  # 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/exe/coltrane

@@ -222,26 +222,26 @@ Mercenary.program(:Coltrane) do |p|
     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.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)
 end
 
 # rubocop:enable Metrics/BlockLength

data/lib/cli/chord.rb

@@ -24,6 +24,8 @@ module Coltrane
             [Coltrane::Chord.new(notes: notes)]
           end
 
+        raise BadChordError unless @chords
+
         @chords.each do |chord|
           desc = "#{chord.name} chord:"
           Coltrane::Cli::Notes.new chord.notes, desc: desc

data/lib/cli/errors.rb

@@ -28,6 +28,18 @@ module Coltrane
               'is not available at the moment.'
       end
     end
+
+    class BadScaleError < ColtraneCliError
+      def initialize(msg = nil)
+        super msg || 'Incorrect scale, please specify scale and root separated by `-`. Ex: `coltrane scale major-C'
+      end
+    end
+
+    class BadChordError < ColtraneCliError
+      def initialize(msg = nil)
+        super msg || 'Incorrect chord, please specify a set of chords separated by `-`. Ex: coltrane chord CM7'
+      end
+    end
   end
 end
 

data/lib/cli/scale.rb

@@ -5,6 +5,7 @@ module Coltrane
     # Interfaces commands with the scales functionality
     class Scale
       def self.parse(str)
+        raise BadScaleError unless str && str.include?('-')
         *scale_name, tone = str.split('-')
         Coltrane::Scale.fetch(scale_name.join('_'), tone)
       end

data/lib/coltrane/chord.rb

@@ -48,15 +48,15 @@ module Coltrane
     end
 
     def next_inversion
-      Chord.new(notes.rotate(1))
+      Chord.new(notes: notes.rotate(1))
     end
 
     def invert(n = 1)
-      Chord.new(notes.rotate(n))
+      Chord.new(notes: notes.rotate(n))
     end
 
     def previous_inversion
-      Chord.new(notes.rotate(-1))
+      Chord.new(notes: notes.rotate(-1))
     end
 
     def +(other)

data/lib/coltrane/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Coltrane
-  VERSION = '2.1.0'
+  VERSION = '2.1.5'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: coltrane
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.5
 platform: ruby
 authors:
 - Pedro Maciel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-14 00:00:00.000000000 Z
+date: 2018-03-19 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: coreaudio
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: paint
   requirement: !ruby/object:Gem::Requirement