coltrane 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f36865eb44c71e77285388f63b71fcc3e7a4920aed4b1ab77db7574e07839f07
-  data.tar.gz: 4a4088466a6747155d4506e1f166f464a8dfb7af3e5c6c04f6374e0bf456980f
+  metadata.gz: ea60cb4885291b3da70a6b6be31aa82a7e98f409615b74c5a7898df377c741b5
+  data.tar.gz: 938b8a0d42dfee3fe443d90065e8e437b6b4f57ec6ad5358a65c1fc325c7d4dc
 SHA512:
-  metadata.gz: d693c0f87aca2f0b1135ce2443f45c0e436d728d6cb98f196cc99d2c6c0e7552406df8f44f899ce92240b7c0f494e9b1b1fc318c975de20b8c748b02f7d447bd
-  data.tar.gz: f0930fb449dfd0d18410b1859dbc5ee531f489de1837ffc62a42882f74a4c9c100ec97f166b2979cfdddc90a3f6dcb7668420226670276b05c30d31413733db5
+  metadata.gz: 81c54ad075e562d37ed4929e8b07d951a738240dadd95a76d5f453fd37f2fd5f894fbe5052ddcc8e25ba36109e877ed366a237980373b3213c1b740ad988574a
+  data.tar.gz: da5f20ad56a53244e88a7408cdcf53bb50655d9af2ddb8e57725ed88dcdc8573eb85d8634289d7fce0fa8315ec5f4fa73da8428c9d78fd9933006f9f5b15112e

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  Include:
+    - 'lib/**/*'
+  Exclude:
+    - 'bin/**/*'
+    - '*'
+
+Metrics/AbcSize:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Lint/UnneededSplatExpansion:
+  Enabled: false
+Security/MarshalLoad:
+  Enabled: false

data/Gemfile

@@ -2,11 +2,14 @@
 
 source 'https://rubygems.org'
 
-group :test do
-  gem 'rspec'
+group :test, :development do
   gem 'pry'
   gem 'pry-byebug'
   gem 'pry-rescue'
+end
+
+group :test do
+  gem 'rspec'
   gem 'simplecov', require: false
   gem 'rubocop',   require: false
 end

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    coltrane (1.0.0)
-      chroma (~> 0.2)
+    coltrane (1.0.11)
+      color (~> 1.8)
       facets (~> 3.1)
       mercenary (~> 0.3)
       paint (~> 2.0)
@@ -12,8 +12,8 @@ GEM
   specs:
     ast (2.3.0)
     byebug (9.1.0)
-    chroma (0.2.0)
     coderay (1.1.2)
+    color (1.8)
     diff-lcs (1.3)
     docile (1.1.5)
     facets (3.1.0)

data/coltrane.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'facets',      '~> 3.1'
   spec.add_runtime_dependency 'paint',       '~> 2.0'
-  spec.add_runtime_dependency 'chroma',      '~> 0.2.0'
+  spec.add_runtime_dependency 'color',       '~> 1.8'
   spec.add_runtime_dependency 'mercenary',   '~> 0.3'
   spec.add_development_dependency "bundler", '~> 1.14'
   spec.add_development_dependency "rake",    '~> 10.0'

data/exe/coltrane

@@ -1,10 +1,13 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/BlockLength
 
 $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
 
 require 'core_ext'
 require 'coltrane'
-require 'coltrane-cli'
+require 'cli'
 
 full_color_terminals = %w[iTerm.app]
 safe_mode_terminals = %w[Unsupported]
@@ -71,9 +74,9 @@ Mercenary.program(:Coltrane) do |p|
     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', **options|
       scale = Coltrane::Cli::Scale.parse(scale_str)
-      keyword_args = {flavor: flavor, on: on }
+      keyword_args = { flavor: flavor, on: on }
       if options.include?(:triads)
         chords = scale.triads
         Coltrane::Cli::Chord.new(*chords, **keyword_args)
@@ -87,11 +90,11 @@ Mercenary.program(:Coltrane) do |p|
         chords = scale.tertians(options[:tertians].to_i)
         Coltrane::Cli::Chord.new(*chords, **keyword_args)
       elsif options.include?(:chords)
-        if options[:chords].nil?
-          chords = scale.all_chords
-        else
-          chords = scale.chords(options[:chords])
-        end
+        chords = if options[:chords].nil?
+                   scale.all_chords
+                 else
+                   scale.chords(options[:chords])
+                 end
         Coltrane::Cli::Chord.new(*chords, **keyword_args)
       else
         Coltrane::Cli::Scale.new(scale, **keyword_args)
@@ -104,11 +107,11 @@ Mercenary.program(:Coltrane) do |p|
     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::Qualities::CHORD_QUALITIES.keys.sort.join(' ')
-      end
+           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::Qualities::CHORD_QUALITIES.keys.sort.join(' ')
+           end
     end
   end
 
@@ -117,9 +120,9 @@ Mercenary.program(:Coltrane) do |p|
     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]}".split('-')
-      options[:chords] = "#{options[:chords]}".split('-')
+    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
@@ -145,14 +148,15 @@ Mercenary.program(:Coltrane) do |p|
   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|
+    c.action do |(*command_path), _options|
       if command_path.empty?
         puts p
-        return
       else
-        puts (command_path.reduce(p) do |memo, key|
-          memo.commands.delete(key.to_sym)
-        end || "\n Sorry, command found.")
+        puts begin
+          command_path.reduce(p) do |memo, key|
+            memo.commands.delete(key.to_sym)
+          end || "\n Sorry, command found."
+        end
       end
     end
   end
@@ -166,3 +170,5 @@ Mercenary.program(:Coltrane) do |p|
 
   p.default_command(:about)
 end
+
+# rubocop:enable Metrics/BlockLength

data/lib/{coltrane-cli.rb → cli.rb}

@@ -1,3 +1,9 @@
+# frozen_string_literal: true
+
+require 'mercenary'
+require 'paint'
+require 'color'
+
 require 'cli/errors'
 
 require 'cli/representation'
@@ -9,4 +15,4 @@ require 'cli/ukulele'
 
 require 'cli/notes'
 require 'cli/chord'
-require 'cli/scale'
+require 'cli/scale'

data/lib/cli/bass_guitar.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Coltrane
   module Cli
+    # Renders notes in a bass guitar scheme
     class BassGuitar < Guitar
       def initialize(notes, flavor, tuning: %w[E A D G])
         super
       end
     end
   end
-end
+end

data/lib/cli/chord.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module Coltrane
   module Cli
+    # Interfaces chord functionality with the lib
     class Chord
       def initialize(*chords, on: :text, flavor: 'intervals', notes: nil)
         @chords =
@@ -10,15 +13,19 @@ module Coltrane
               chords
             end
           elsif !notes.nil?
-             [Coltrane::Chord.new(notes: notes)]
+            [Coltrane::Chord.new(notes: notes)]
           end
 
         @chords.each do |chord|
           raise ChordNotFoundError unless chord.named?
           desc = "#{chord.name} chord:"
-          Coltrane::Cli::Notes.new(chord.notes, on: on, desc: desc, flavor: flavor)
+          Coltrane::Cli::Notes.new chord.notes, on: on,
+                                                desc: desc,
+                                                flavor: flavor
         end
       end
     end
   end
-end
+end
+
+# rubocop:enable Metrics/MethodLength

data/lib/cli/errors.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/Documentation
+
 module Coltrane
   module Cli
     class ColtraneCliError < StandardError
@@ -7,13 +11,13 @@ module Coltrane
     end
 
     class WrongFlavorError < ColtraneCliError
-      def initialize(msg=nil)
+      def initialize(msg = nil)
         super msg || 'Wrong flavor. Check possible flavors with `coltrane list flavors`.'
       end
     end
 
     class BadFindScales < ColtraneCliError
-      def initialize(msg=nil)
+      def initialize(msg = nil)
         super msg || 'Provide --notes or --chords. Ex: `coltrane find-scale --notes C E G`.'
       end
     end
@@ -21,8 +25,10 @@ module Coltrane
     class WrongRepresentationTypeError < ColtraneCliError
       def initialize(type)
         super "The provided representation type (#{type}) "\
-              "is not available at the moment."
+              'is not available at the moment.'
       end
     end
   end
-end
+end
+
+# rubocop:enable Style/Documentation

data/lib/cli/guitar.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module Coltrane
   module Cli
-    SPECIAL_FRETS = [3, 5, 7, 9, 12, 15, 17, 19]
+    SPECIAL_FRETS = [3, 5, 7, 9, 12, 15, 17, 19].freeze
 
+    # Renders notes in a common most popular ukulele scheme
     class Guitar < Representation
       def initialize(notes, flavor, tuning: %w[E A D G B E], frets: 22)
         @notes    = notes
@@ -12,34 +15,33 @@ module Coltrane
       end
 
       def render
-        [render_notes, render_special_frets, hint].join("\n"*2)
+        [render_notes, render_special_frets, hint].join("\n" * 2)
       end
 
       def render_notes
         @tuning.map do |string|
           string_note = Note[string]
-          (@frets+2).times.map do |i|
+          Array.new(@frets + 2) do |i|
             if i.zero?
               string
             else
               fret = i - 1
               note = string_note + fret
-              m = (@notes.include?(note) ? place_mark(note) : "--")
-              fret.zero? ? (m + " |") : m
+              m = (@notes.include?(note) ? place_mark(note) : '--')
+              fret.zero? ? (m + ' |') : m
             end
           end.join(' ')
         end.join("\n")
       end
 
       def render_special_frets
-        (@frets+1).times.map do |fret|
+        Array.new(@frets + 1) do |fret|
           m = SPECIAL_FRETS.include?(fret) ? fret.to_s.rjust(2, 0.to_s) : '  '
           "#{m}#{'  ' if fret.zero?}"
         end.join(' ')
       end
 
-      def render_dotted_frets
-      end
+      def render_dotted_frets; end
 
       def place_mark(note)
         case @flavor
@@ -47,9 +49,9 @@ module Coltrane
         when :intervals then (@ref_note - note).name.ljust(2, '-')
         when :degrees   then @notes.degree(note).to_s.rjust(2, '0')
         when :marks     then '◼◼'
-        else raise WrongFlavorError.new
+        else raise WrongFlavorError
         end
       end
     end
   end
-end
+end

data/lib/cli/notes.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 module Coltrane
   module Cli
+    # Interfaces notes outputting functionality with the lib
     class Notes
-      def initialize(notes, on: 'text', desc: 'The notes you supplied:', flavor: 'notes')
-        @desc   = desc
+      def initialize(notes, on: 'text', desc: nil, flavor: 'notes')
+        @desc   = desc || 'The notes you supplied:'
         flavor  = flavor.underscore.to_sym
         on      = on.to_sym
         notes   = Coltrane::NoteSet.new(notes)
@@ -11,8 +14,8 @@ module Coltrane
       end
 
       def render
-        puts "\n"+[@desc, @representation.render].join("\n"*2)
+        puts "\n" + [@desc, @representation.render].join("\n" * 2)
       end
     end
   end
-end
+end

data/lib/cli/piano.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module Coltrane
   module Cli
+    # It allows rendering notes in an ASCII piano
     class Piano < Representation
       PIANO_TEMPLATE = <<~ASCII
         ┌─┬─┬┬─┬─╥─┬─┬┬─┬┬─┬─╥─┬─┬┬─┬─╥─┬─┬┬─┬┬─┬─┐
@@ -24,11 +27,11 @@ module Coltrane
 
       private
 
-      def replace_x(line, notes, size, index=0)
-        line.gsub('X'*size).with_index do |match, i|
-          note = notes[i%notes.size]
-          next ' '*size unless @notes.include?(note)
-          Paint[replacer(note)[size == 2 ? 0..2 : index ], 'red']
+      def replace_x(line, notes, size, index = 0)
+        line.gsub('X' * size).with_index do |_match, i|
+          note = notes[i % notes.size]
+          next ' ' * size unless @notes.include?(note)
+          Paint[replacer(note)[size == 2 ? 0..2 : index], 'red']
         end
       end
 
@@ -37,7 +40,7 @@ module Coltrane
         case @flavor
         when :intervals then (@ref_note - note).name
         when :marks then '◼ '
-        when :degrees then @notes.degree(note).to_s.rjust(2,'0')
+        when :degrees then @notes.degree(note).to_s.rjust(2, '0')
         when :notes then note.pretty_name.to_s.ljust(2, "\u266E")
         end
       end
@@ -47,8 +50,8 @@ module Coltrane
       end
 
       def black_notes
-        Coltrane::Scale.pentatonic_major('C#',4).notes
+        Coltrane::Scale.pentatonic_major('C#', 4).notes
       end
     end
   end
-end
+end

data/lib/cli/representation.rb

@@ -1,7 +1,10 @@
+# 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]
+      ACCEPTED_FLAVORS = %i[marks notes intervals degrees].freeze
 
       def self.inherited(subclass)
         @@types ||= {}
@@ -9,18 +12,15 @@ module Coltrane
       end
 
       def self.build(type, notes, flavor)
-        raise WrongFlavorError.new unless ACCEPTED_FLAVORS.include?(flavor)
+        raise WrongFlavorError unless ACCEPTED_FLAVORS.include?(flavor)
         type = case type
-          when :ukelele then :ukulele
-          when :bass then :bass_guitar
-          else type
-        end
+               when :ukelele then :ukulele
+               when :bass then :bass_guitar
+               else type
+               end
 
-        if (the_class = @@types[type])
-          the_class.new(notes, flavor)
-        else
-          raise WrongRepresentationTypeError.new(type)
-        end
+        raise(WrongRepresentationTypeError, type) unless @@types.include?(type)
+        @@types[type].new(notes, flavor)
       end
 
       def initialize(notes, flavor)
@@ -31,7 +31,7 @@ module Coltrane
 
       def hint
         case @flavor
-        when :marks     then ""
+        when :marks     then ''
         when :notes     then "(\u266E means the note is natural, not flat nor sharp)"
         when :intervals
           <<~DESC
@@ -39,9 +39,9 @@ module Coltrane
             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)"
+        when :degrees then '(The numbers represent the degree of the note in the scale)'
         end
       end
     end
   end
-end
+end