coltrane 3.0.0.rc1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5d1a8621e3e0f3c4b9b7841ea9f353c8195865a02049d0f5c5739efceaab92d
-  data.tar.gz: 2c6cea9e60d30e64d01d69270af7bc6c58f7c44fc9d3511d813856538e341aca
+  metadata.gz: 24aa3d9be0bb2cdecadedb502c16276e1d749cb59cd0e58be75ec92ba49e61f7
+  data.tar.gz: b5cb786fc245433adec30d304aa13017a975bf031802082f82a43738e2e7ccfb
 SHA512:
-  metadata.gz: e95088c4907c8014e78b55d5b30da64ac61363643b8ba07ddd3354be49ffb22a23e5942cdd129d7c0a4f06698fd55420736a8fd149c7a1edf8fa2c7776fae124
-  data.tar.gz: 2b01cdd22465ad3f722447854aa3b1d6eb195f53063dbab2cc1a48bc55e331731c730b5c72227eb69cd2ee59d42cb0138989428a5067686cd58777bce4f8ef2e
+  metadata.gz: f8364216d8f087301c4d9576f5f2722e6635a194e8bd4910d2114ff68bd79dbc1091a5a894680dc11e004063132d6add3bb5f43029dd6391b147db1ffc1c723a
+  data.tar.gz: 05127ca168287aff2d5754eeb0f2cddce7ed27f0fa4b36bf149c1d6725b16bedc592df1a1842b0504904bf467a51e65255879175b8bd527b1d122316a5afc80e

data/Gemfile

@@ -6,13 +6,12 @@ group :test, :development do
   gem 'pry'
   gem 'pry-byebug'
   gem 'pry-rescue'
-  # gem 'pronto'
-  gem 'pronto-rubocop'
   gem 'opal-rspec'
 end
 
 group :test do
   gem 'rspec'
+  gem 'tty-prompt'
   gem 'simplecov', require: false
   gem 'rubocop',   require: false
 end

data/Gemfile.lock

@@ -1,18 +1,15 @@
 PATH
   remote: .
   specs:
-    coltrane (3.0.0.rc1)
+    coltrane (3.0.0)
       color (~> 1.8)
       dry-monads (~> 0.4)
+      mercenary (~> 0.3)
       paint (~> 2.0.1)
-      pedrozath-mercenary (~> 0.3)
-      tty-prompt (~> 0.16.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
     ast (2.3.0)
     byebug (9.1.0)
     coderay (1.1.2)
@@ -27,23 +24,13 @@ GEM
       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)
     json (2.1.0)
+    mercenary (0.3.6)
     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)
       hike (~> 1.2)
       sourcemap (~> 0.1.0)
@@ -58,16 +45,7 @@ GEM
     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)
-      gitlab (~> 3.6, >= 3.4.0)
-      octokit (~> 4.3, >= 4.1.0)
-      rugged (~> 0.24, >= 0.23.0)
-      thor (~> 0.19.0)
-    pronto-rubocop (0.6.2)
-      pronto (~> 0.6.0)
-      rubocop (~> 0.38, >= 0.35.0)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -77,7 +55,6 @@ GEM
     pry-rescue (1.4.5)
       interception (>= 0.5)
       pry
-    public_suffix (3.0.2)
     rack (2.0.4)
     rainbow (3.0.0)
     rake (10.5.0)
@@ -102,10 +79,6 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.9.0)
-    rugged (0.26.0)
-    sawyer (0.8.1)
-      addressable (>= 2.3.5, < 2.6)
-      faraday (~> 0.8, < 1.0)
     simplecov (0.15.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
@@ -115,9 +88,6 @@ GEM
     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)
     timers (4.1.2)
       hitimes
@@ -144,7 +114,6 @@ DEPENDENCIES
   bundler (~> 1.14)
   coltrane!
   opal-rspec
-  pronto-rubocop
   pry
   pry-byebug
   pry-rescue
@@ -152,6 +121,7 @@ DEPENDENCIES
   rspec
   rubocop
   simplecov
+  tty-prompt
 
 BUNDLED WITH
    1.16.1

data/README.md

@@ -11,7 +11,7 @@ A music calculation library/CLI written in Ruby.
 
 * [How to use this library](https://github.com/pedrozath/coltrane/wiki/Core-music-theory-library).
 * [Why did I write 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)
+* [Chat room for discussing the project, answering questions, etc.](http://coltrane-ruby.herokuapp.com/)
 
 ## CLI (Command Line Interface)
 
@@ -42,7 +42,7 @@ PS: Once you install the gem the CLI is instaled in your system and it's ready t
 
 ## Contributing
 
-We are looking for contributors. Find me on [our chatroom](https://gitter.im/coltrane-music/Lobby) if you need any kind of information.
+We are looking for contributors. Find me on [our chatroom](http://coltrane-ruby.herokuapp.com/) if you need any kind of information.
 
 ### How to contribute
 1. Fork this code

data/coltrane.gemspec

@@ -32,11 +32,10 @@ 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.1'
   spec.add_runtime_dependency 'color',               '~> 1.8'
-  spec.add_runtime_dependency 'pedrozath-mercenary', '~> 0.3'
+  spec.add_runtime_dependency 'mercenary',           '~> 0.3'
   spec.add_development_dependency "bundler",         '~> 1.14'
   spec.add_development_dependency "rake",            '~> 10.0'
 end

data/lib/coltrane/commands/chords.rb

@@ -1,13 +1,14 @@
 module Coltrane
   module Commands
     class Chords < Command
-      attr_reader :chord, :flavor, :on, :preface
+      attr_reader :chord, :flavor, :on, :preface, :voicings
 
       def initialize(chord = nil,
                      flavor: :notes,
                      on: :text,
                      notes: nil,
                      preface: nil,
+                     voicings: 4,
                      **options)
         if chord
           @chord = chord.is_a?(Theory::Chord) ? chord : Theory::Chord.new(name: chord)
@@ -18,9 +19,10 @@ module Coltrane
                 'or coltrane chords --notes C-E-G'
         end
 
-        @flavor  = flavor.to_sym
-        @preface = preface || @chord.name
-        @on      = on.to_sym
+        @flavor   = flavor.to_sym
+        @preface  = preface || @chord.name
+        @on       = on.to_sym
+        @voicings = voicings.to_i
       end
 
       def representation
@@ -31,10 +33,12 @@ module Coltrane
       def on_model
         case on
         when :text              then chord
-        when :guitar            then Representation::Guitar.find_chords(chord).first(6)
-        when :ukulele, :ukelele then Representation::Ukulele.find_chords(chord).first(6)
-        when :bass              then Representation::Bass.find_chords(chord).first(6)
+        when :guitar            then Representation::Guitar.find_chords(chord).first(voicings)
+        when :ukulele, :ukelele then Representation::Ukulele.find_chords(chord).first(voicings)
+        when :bass              then Representation::Bass.find_notes(chord.notes)
         when :piano             then Representation::Piano.find_notes(chord.notes)
+        when :'guitar-frets'    then Representation::Guitar.find_notes(chord.notes)
+        when :'ukulele-frets', :'ukelele-frets' then Representation::Ukulele.find_notes(chord.notes)
         end
       end
 
@@ -48,7 +52,7 @@ module Coltrane
           (
             {
               layout: :horizontal,
-              per_row: 6,
+              per_row: 4,
             } if layout_horizontal?
           )
         ]
@@ -67,8 +71,11 @@ module Coltrane
 
           add_shared_option(:flavor, c)
           add_shared_option(:on, c)
+          add_shared_option(:voicings, c)
           c.action { |(chords), **options|
-            (chords&.split('-') || [nil]).each { |chord| new(chord, **options).render }
+            (chords&.split('-') || [nil]).each { |chord|
+              new(chord, **options).render
+            }
           }
         end
       end

data/lib/coltrane/commands/command.rb

@@ -3,15 +3,21 @@ module Coltrane
     class Command
       COMMON_OPTIONS = {
         on: [
-          '--on guitar INSTRUMENT',
+          '--on <INSTRUMENT>',
           'Shows the notes on the given instrument/representation type. ' \
           'Can be piano, guitar, ukulele, bass or text'
         ],
 
         flavor: [
-          '--flavor 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'
         ]
       }
 

data/lib/coltrane/commands/notes.rb

@@ -34,6 +34,7 @@ module Coltrane
           c.alias(:note)
           c.syntax 'notes <notes separated by space> [--on <instrument>]'
           c.description 'Shows the given notes.'
+          add_shared_option(:voicings, c)
           add_shared_option(:flavor, c)
           add_shared_option(:on, c)
           c.action { |(notes), **options| new(notes, **options).render }

data/lib/coltrane/commands/progression.rb

@@ -7,6 +7,7 @@ module Coltrane
           c.description 'Gives you chords of a progression in a key. Ex: coltrane progression I-IV-iv-V in Am --on guitar'
           add_shared_option(:flavor, c)
           add_shared_option(:on, c)
+          add_shared_option(:voicings, c)
           c.action do |(prog, _, key), **options|
             prog
             .tr('-', '_')

data/lib/coltrane/commands/scale.rb

@@ -18,10 +18,11 @@ module Coltrane
         program.command(:scale) do |c|
           c.syntax 'scale <root_note> <scale name> [--on <instrument>]'
           c.description 'Gives you information about a scale. Ex: coltrane scale D Natural Minor --on guitar'
-          c.option :tertians, '--tertians SIZE', 'Outputs all tertian chords from the given size 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'
           add_shared_option(:flavor, c)
           add_shared_option(:on, c)
+          add_shared_option(:voicings, c)
 
           c.action { |scale_notation, **options|
             parse(scale_notation.join(' '))

data/lib/coltrane/theory/notable_progressions.rb

@@ -6,15 +6,15 @@ module Coltrane
     # based on common standards and practices.
     module NotableProgressions
       PROGRESSIONS = {
-        'Pop' => ['I-V-vi-IV', :major],
-        'Jazzy Pop' =>  ['IM7-V7-vi7-IVM7',      :major],
-        'Jazz' =>       ['ii7-V7-I7',            :major],
+        'Pop'        => ['I-V-vi-IV', :major],
+        'Jazzy Pop'  => ['IM7-V7-vi7-IVM7',      :major],
+        'Jazz'       => ['ii7-V7-I7',            :major],
         'Jazz Minor' => ['ii7-V7-i7',            :major],
-        'Blues' =>      ['IM7-IV7-I7-V7-IV7-I7', :major],
+        'Blues'      => ['IM7-IV7-I7-V7-IV7-I7', :major],
         'Jazz Blues' => ['I7-IV7-I7-V7-IV7-I7',  :major],
-        'Fifties' =>    ['I-vi-IV-V',            :major],
-        'Circle' =>     ['vi-ii-V-I',            :major],
-        'Tune Up' =>    ['ii7-V7-IM7-i7-IV7-IVM7-VIIM7', :minor]
+        'Fifties'    => ['I-vi-IV-V',            :major],
+        'Circle'     => ['vi-ii-V-I',            :major],
+        'Tune Up'    => ['ii7-V7-IM7-i7-IV7-IVM7-VIIM7', :minor]
       }.freeze
 
       PROGRESSIONS.each do |name, values|

data/lib/coltrane/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Coltrane
-  VERSION = '3.0.0.rc1'
+  VERSION = '3.0.0'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: coltrane
 version: !ruby/object:Gem::Version
-  version: 3.0.0.rc1
+  version: 3.0.0
 platform: ruby
 authors:
 - Pedro Maciel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-01 00:00:00.000000000 Z
+date: 2018-04-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: tty-prompt
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: dry-monads
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: pedrozath-mercenary
+  name: mercenary
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -182,7 +168,6 @@ files:
 - lib/coltrane/commands/find_scale.rb
 - lib/coltrane/commands/notes.rb
 - lib/coltrane/commands/progression.rb
-- lib/coltrane/commands/representation.rb
 - lib/coltrane/commands/scale.rb
 - lib/coltrane/renderers.rb
 - lib/coltrane/renderers/renderer.rb
@@ -259,9 +244,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6

data/lib/coltrane/commands/representation.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Coltrane
-  module Cli
-    # It manages notes representations, most of times instruments
-    class Representation
-      ACCEPTED_FLAVORS = %i[marks notes intervals degrees].freeze
-
-      def self.inherited(subclass)
-        @@types ||= {}
-        @@types[subclass.to_s.split('::').last.underscore.to_sym] = subclass
-      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)
-      end
-
-      def initialize(notes)
-        @notes    = notes
-        @ref_note = notes.first
-      end
-
-      def hint
-        case Cli.config.flavor
-        when :marks then ''
-        # when :notes     then "(\u266E means the note is natural, not flat nor sharp)"
-        when :intervals
-          <<~DESC
-            The letters represent the intervals relative to the root tone
-            Ex: 1P = Perfect First / 3m = Minor Third / 4A = Augmented Fourth
-          DESC
-
-        when :degrees then '(The numbers represent the degree of the note in the scale)'
-        end
-      end
-    end
-  end
-end