coltrane 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0d89db41e5429721884671402e8cf17f2b25c461
-  data.tar.gz: 2d17e5909962dd7c1c737f55cb216bd426602311
+SHA256:
+  metadata.gz: 512414fa0854b3ef1215953cbea3d5c545da0cef7978f098b4fbb945ea490ef0
+  data.tar.gz: a9b854252e121e7f1a3a74b3c51b9470cdb8205f7f6328247a6b213e3e60f1c3
 SHA512:
-  metadata.gz: 2717d0aa492aefc42486ec1548aab3d7ad1c4ac236c33f26201d9bd19b29357681da70acd721b4c05455852a1fd9192550a47e05e1f8c805a65855ecdbd5bc17
-  data.tar.gz: eeee10c3e63d7bc8b94d11b4f1cbf4adac076b375d7bc800bc4b43b56b416ed5dcb10c012a65c07798a5d0971d7754f876e51268c989c6752d64148d6e30b1e1
+  metadata.gz: fa8eb9cc7e52398c4566717d86ff2291fc2793b1a5348c5f495acb7dc932ad1956f584791a5f0992e7e8cf5edb6bfc6f014fff9a20e34f69280319427dbcbf63
+  data.tar.gz: '09eb103f1df2e6c7294b74c2f21e9690fa1a21d1ce8c6da5ea7b9407614c44643d093241f0b5d964849c32972b05db57ab59579f8b6549ff2243bdb4422646cf'

data/.gitignore

@@ -0,0 +1,2 @@
+coverage
+cache

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/Gemfile

@@ -2,16 +2,21 @@
 
 source 'https://rubygems.org'
 
-gem 'sqlite3'
-gem 'standalone_migrations', '5.2.0'
+gem 'facets', require: false
 
-gem 'guard'
-gem 'guard-rspec'
-gem 'paint'
-gem 'pry'
-gem 'pry-stack_explorer'
-gem 'pry-rescue'
-gem 'rspec'
-gem 'rubocop', require: false
+group :cli do
+  gem 'paint'
+  gem 'chroma'
+  gem 'mercenary'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'pry'
+  gem 'pry-byebug'
+  gem 'pry-rescue'
+  gem 'simplecov', require: false
+  gem 'rubocop',   require: false
+end
 
 gemspec

data/Gemfile.lock

@@ -1,164 +1,83 @@
 PATH
   remote: .
   specs:
-    coltrane (0.0.2)
+    coltrane (1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.1.0)
-      actionview (= 5.1.0)
-      activesupport (= 5.1.0)
-      rack (~> 2.0)
-      rack-test (~> 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.1.0)
-      activesupport (= 5.1.0)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activemodel (5.1.0)
-      activesupport (= 5.1.0)
-    activerecord (5.1.0)
-      activemodel (= 5.1.0)
-      activesupport (= 5.1.0)
-      arel (~> 8.0)
-    activesupport (5.1.0)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    arel (8.0.0)
     ast (2.3.0)
-    binding_of_caller (0.7.2)
-      debug_inspector (>= 0.0.1)
-    builder (3.2.3)
-    coderay (1.1.1)
-    concurrent-ruby (1.0.5)
-    debug_inspector (0.0.2)
+    byebug (9.1.0)
+    chroma (0.2.0)
+    coderay (1.1.2)
     diff-lcs (1.3)
-    erubi (1.6.0)
-    ffi (1.9.18)
-    formatador (0.2.5)
-    guard (2.14.1)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, < 4.0)
-      lumberjack (~> 1.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.9.12)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-compat (1.2.1)
-    guard-rspec (4.7.3)
-      guard (~> 2.1)
-      guard-compat (~> 1.1)
-      rspec (>= 2.99.0, < 4.0)
-    i18n (0.8.1)
+    docile (1.1.5)
+    facets (3.1.0)
     interception (0.5)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
-    loofah (2.0.3)
-      nokogiri (>= 1.5.9)
-    lumberjack (1.0.11)
-    method_source (0.8.2)
-    mini_portile2 (2.1.0)
-    minitest (5.10.1)
-    nenv (0.3.0)
-    nokogiri (1.7.1)
-      mini_portile2 (~> 2.1.0)
-    notiffany (0.1.1)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
-    paint (2.0.0)
-    parser (2.4.0.0)
-      ast (~> 2.2)
+    json (2.1.0)
+    mercenary (0.3.6)
+    method_source (0.9.0)
+    paint (2.0.1)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
     powerpack (0.1.1)
-    pry (0.10.4)
+    pry (0.11.3)
       coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
+      method_source (~> 0.9.0)
+    pry-byebug (3.5.1)
+      byebug (~> 9.1)
+      pry (~> 0.10)
     pry-rescue (1.4.5)
       interception (>= 0.5)
       pry
-    pry-stack_explorer (0.4.9.2)
-      binding_of_caller (>= 0.7)
-      pry (>= 0.9.11)
-    rack (2.0.1)
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rails-dom-testing (2.0.2)
-      activesupport (>= 4.2.0, < 6.0)
-      nokogiri (~> 1.6)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.0)
-    railties (5.1.0)
-      actionpack (= 5.1.0)
-      activesupport (= 5.1.0)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rainbow (2.2.2)
-      rake
+    rainbow (3.0.0)
     rake (10.5.0)
-    rb-fsevent (0.9.8)
-    rb-inotify (0.9.8)
-      ffi (>= 0.5.0)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
-    rubocop (0.48.1)
-      parser (>= 2.3.3.1, < 3.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
       powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
+      rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.1)
-    ruby_dep (1.5.0)
-    shellany (0.0.1)
-    slop (3.6.0)
-    sqlite3 (1.3.13)
-    standalone_migrations (5.2.0)
-      activerecord (>= 4.2.7, < 5.2.0)
-      railties (>= 4.2.7, < 5.2.0)
-      rake (~> 10.0)
-    thor (0.19.4)
-    thread_safe (0.3.6)
-    tzinfo (1.2.3)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.2.1)
+    ruby-progressbar (1.9.0)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.14)
+  chroma
   coltrane!
-  guard
-  guard-rspec
+  facets
+  mercenary
   paint
   pry
+  pry-byebug
   pry-rescue
-  pry-stack_explorer
   rake (~> 10.0)
   rspec
   rubocop
-  sqlite3
-  standalone_migrations (= 5.2.0)
+  simplecov
 
 BUNDLED WITH
-   1.15.0
+   1.16.1

data/README.md

@@ -1,8 +1,9 @@
 # Coltrane
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/coltrane`. To experiment with that code, run `bin/console` for an interactive prompt.
+A musical abacus written in ruby.
 
-TODO: Delete this and the text above, and describe your gem
+More info, story and purpose of the library:
+https://medium.com/@pedrozath/so-i-wrote-a-library-to-help-me-compose-music-ddb4ae7c8227
 
 ## Installation
 
@@ -20,20 +21,41 @@ Or install it yourself as:
 
     $ gem install coltrane
 
-## Usage
+## CLI (Command Line Interface)
 
-TODO: Write usage instructions here
+When you install the gem on your system, you automatically gain access to the
+CLI.
 
-## Development
+You can run it on terminal:
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```bash
+$ coltrane help
+```
+
+## Roadmap
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+There's a lot of things that need to be done on this library, specially on the CLI:
+
++ Refactor the CLI into a more succinct and elegantly organized architecture
++ Amplify the test coverage
++ Move Scale#chords method to NoteSet
++ Write tests for the caching
++ Write up a caching cleaning command
++ Include CLI commands to output chord progressions
++ Include a command to output a pretty HTML document containing the query
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/coltrane. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+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
+```
 
+Make sure the specs pass and submit a PR.
 
 ## License
 

data/Rakefile

@@ -1,6 +1,2 @@
-ENV['RAILS_ENV'] = 'production'
-ENV['DISABLE_DATABASE_ENVIRONMENT_CHECK'] = '1'
-require 'standalone_migrations'
-StandaloneMigrations::Tasks.load_tasks
 require "bundler/gem_tasks"
 task :default => :spec

data/bin/bundle

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+    module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1 || ">= 0.a"
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||= begin
+      env_var_version || cli_arg_version ||
+        lockfile_version || "#{Gem::Requirement.default}.a"
+    end
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    # must dup string for RG < 1.8 compatibility
+    activate_bundler(bundler_version.dup)
+  end
+
+  def activate_bundler(bundler_version)
+    if Gem::Version.correct?(bundler_version) && Gem::Version.new(bundler_version).release < Gem::Version.new("2.0")
+      bundler_version = "< 2"
+    end
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_version
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_version).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_version}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_version}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/bin/byebug

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