coltrane 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 512414fa0854b3ef1215953cbea3d5c545da0cef7978f098b4fbb945ea490ef0
-  data.tar.gz: a9b854252e121e7f1a3a74b3c51b9470cdb8205f7f6328247a6b213e3e60f1c3
+  metadata.gz: f36865eb44c71e77285388f63b71fcc3e7a4920aed4b1ab77db7574e07839f07
+  data.tar.gz: 4a4088466a6747155d4506e1f166f464a8dfb7af3e5c6c04f6374e0bf456980f
 SHA512:
-  metadata.gz: fa8eb9cc7e52398c4566717d86ff2291fc2793b1a5348c5f495acb7dc932ad1956f584791a5f0992e7e8cf5edb6bfc6f014fff9a20e34f69280319427dbcbf63
-  data.tar.gz: '09eb103f1df2e6c7294b74c2f21e9690fa1a21d1ce8c6da5ea7b9407614c44643d093241f0b5d964849c32972b05db57ab59579f8b6549ff2243bdb4422646cf'
+  metadata.gz: d693c0f87aca2f0b1135ce2443f45c0e436d728d6cb98f196cc99d2c6c0e7552406df8f44f899ce92240b7c0f494e9b1b1fc318c975de20b8c748b02f7d447bd
+  data.tar.gz: f0930fb449dfd0d18410b1859dbc5ee531f489de1837ffc62a42882f74a4c9c100ec97f166b2979cfdddc90a3f6dcb7668420226670276b05c30d31413733db5

data/.gitignore

@@ -1,2 +1,3 @@
 coverage
 cache
+pkg

data/Gemfile

@@ -2,14 +2,6 @@
 
 source 'https://rubygems.org'
 
-gem 'facets', require: false
-
-group :cli do
-  gem 'paint'
-  gem 'chroma'
-  gem 'mercenary'
-end
-
 group :test do
   gem 'rspec'
   gem 'pry'

data/Gemfile.lock

@@ -2,6 +2,10 @@ PATH
   remote: .
   specs:
     coltrane (1.0.0)
+      chroma (~> 0.2)
+      facets (~> 3.1)
+      mercenary (~> 0.3)
+      paint (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -66,11 +70,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.14)
-  chroma
   coltrane!
-  facets
-  mercenary
-  paint
   pry
   pry-byebug
   pry-rescue

data/README.md

@@ -2,10 +2,34 @@
 
 A musical abacus written in ruby.
 
-More info, story and purpose of the library:
-https://medium.com/@pedrozath/so-i-wrote-a-library-to-help-me-compose-music-ddb4ae7c8227
+![Coltrane](img/coltrane-logo.png)
 
-## Installation
+More info, story and purpose of the library [here](https://medium.com/@pedrozath/so-i-wrote-a-library-to-help-me-compose-music-ddb4ae7c8227).
+
+## CLI (Command Line Interface)
+
+```bash
+$ gem install coltrane
+```
+
+When you install the gem on your system, you automatically gain access to the
+CLI.
+
+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).
+
+Some screenshot examples:
+![Screenshot](img/screen-3.png)
+![Screenshot](img/screen-2.png)
+![Screenshot](img/screen-9.png)
+![Screenshot](img/screen-8.png)
+![Screenshot](img/screen-10.png)
+![Screenshot](img/screen-1.png)
+![Screenshot](img/screen-4.png)
+![Screenshot](img/screen-5.png)
+![Screenshot](img/screen-6.png)
+
+
+## As a library
 
 Add this line to your application's Gemfile:
 
@@ -14,35 +38,35 @@ gem 'coltrane'
 ```
 
 And then execute:
+```sh
+$ bundle
+```
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install coltrane
-
-## CLI (Command Line Interface)
+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:
 
-When you install the gem on your system, you automatically gain access to the
-CLI.
+```ruby
+require 'coltrane'
 
-You can run it on terminal:
+puts Coltrane::Scale.major('C').sevenths.map(&:name)
+# => ["CM7", "Dm7", "Em7", "FM7", "G7", "Am7", "Bm7b5"]
 
-```bash
-$ coltrane help
+puts Coltrane::Scale.having_chord('Cmaj7').scales.map(&:name)
+# => ["C Major", "G Major", "E Natural Minor", "A Natural Minor", "E Harmonic Minor", "B Flamenco"]
 ```
 
 ## Roadmap
 
 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
+- [ ] Separate into 2 gems: `coltrane` and `coltrane-cli`
+- [ ] Make all output more colorful
+- [ ] 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
 

data/coltrane.gemspec

@@ -30,6 +30,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
+  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 'mercenary',   '~> 0.3'
+  spec.add_development_dependency "bundler", '~> 1.14'
+  spec.add_development_dependency "rake",    '~> 10.0'
 end

data/exe/coltrane

@@ -1,10 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'bundler'
-require 'pry'
-
-Bundler.require(:cli)
-
 $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
 
 require 'core_ext'

data/lib/coltrane/version.rb

@@ -1,3 +1,3 @@
 module Coltrane
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coltrane
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Pedro Maciel
@@ -10,6 +10,62 @@ bindir: exe
 cert_chain: []
 date: 2018-01-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: chroma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: mercenary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -92,6 +148,17 @@ files:
 - db/config.yml
 - db/schema.rb
 - exe/coltrane
+- img/coltrane-logo.png
+- img/screen-1.png
+- img/screen-10.png
+- img/screen-2.png
+- img/screen-3.png
+- img/screen-4.png
+- img/screen-5.png
+- img/screen-6.png
+- img/screen-7.png
+- img/screen-8.png
+- img/screen-9.png
 - lib/cli/bass_guitar.rb
 - lib/cli/chord.rb
 - lib/cli/errors.rb