note-transpose 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34d45237ed688088cea474edda1664dd711f07ef1faef0de6b7d43fedb5c8935
-  data.tar.gz: 5e6f510857dafd65c8df058b9c58dcd6a9ab9e1c7e07a4c3f7dacfc04b509448
+  metadata.gz: 0bbc3b677dae36c2aaaa2393f654a9fe2b2163c13550ec6cdb3459d82f04e544
+  data.tar.gz: ce229a4e097d362523b077527d88ff99f55868f5f54e13c0fd849b925a83ae88
 SHA512:
-  metadata.gz: 9f514f4d0e3a5e9a470247c095c2d888d14e2aebbab59cf533e9a7da8d236cce68cacb51bb6d2c60c03d0c713d4750adb579f5c376c766c8915bbd14ea760bff
-  data.tar.gz: 90d79c48f039580910e7251f0383781dec1811057ef40cc5754e5b5f6c7368c94e3a2cb5483d974a7e598a63f8ec941e872ccfac2c55e7ce1b624ce7f3efbac5
+  metadata.gz: 70a02bfa6abdc76a894ccc09e6884a8b41e1c217769f639e89643dbf64669e8ab75bbf85e2510f617dac56497da36882960ea89cd6b99adecc6c4b67995b0634
+  data.tar.gz: 89396d0778695cf3b1453d701810ba46453b0fd720aac5f4c5bf2f3dda669db2f8a859df7e217becce0729924e459cc8b1faa81efe04c95e8be86623943a5bab

data/README.md

@@ -1,4 +1,7 @@
 # Note Transpose
+[![Gem Version](https://badge.fury.io/rb/note-transpose.svg)](https://badge.fury.io/rb/note-transpose)
+[![Build Status](https://travis-ci.org/vyder/note-transpose.svg?branch=master)](https://travis-ci.org/vyder/note-transpose)
+[![Inline docs](http://inch-ci.org/github/vyder/note-transpose.svg?branch=master)](http://inch-ci.org/github/vyder/note-transpose)
 
 A CLI tool to transpose notes by half steps
 
@@ -6,6 +9,7 @@ A CLI tool to transpose notes by half steps
 
 - [Install](#install)
 - [Usage](#usage)
+- [Documentation](#documentation)
 - [Support](#support)
 - [Contributing](#contributing)
 
@@ -18,27 +22,39 @@ A CLI tool to transpose notes by half steps
     ❯ note-transpose --help
 
     Usage: note-transpose [-]<number half steps> <notes> [--pref-flat]
-    --pref-flat     Always uses flat notes in output instead of sharp ones
 
-    Examples:
-    ❯ note-transpose +1 C G F Am
-    => Db Ab Gb Bbm
+      Options:
+        --pref-flat     Always uses flat notes in output instead of sharp ones
 
-    ❯ note-transpose 2 C G F Am
-    => D A G Bm
+      Examples:
+        ❯ note-transpose +1 C G F Am
+        => Db Ab Gb Bbm
 
-    ❯ note-transpose -2 D# G7 F Am7 Cadd7
-    => C# F7 Eb Gm7 Bbadd7
+        ❯ note-transpose 2 C G F Am
+        => D A G Bm
 
-    ❯ note-transpose -2 D# G7 F Am7 Cadd7 --pref-flat
-    => Db F7 Eb Gm7 Bbadd7
+        ❯ note-transpose -2 D# G7 F Am7 Cadd7
+        => C# F7 Eb Gm7 Bbadd7
+
+        ❯ note-transpose -2 D# G7 F Am7 Cadd7 --pref-flat
+        => Db F7 Eb Gm7 Bbadd7
 
 You can even include the module in your code if you need that for some reason:
 
     require 'note-transpose'
 
-    NoteTranspose.transpose(-3, "C", "F", "Am", "G")
-    # => ["A", "D", "Gbm", "E"]
+    NoteTranspose.transpose(3, "D#", "F", "Bm", "G7")
+    # => ["F#", "Ab", "Dm", "Bb7"]
+
+    NoteTranspose.transpose(3, "D#", "F", "Bm", "G7", pref_flat: true)
+    # => ["Gb", "Ab", "Dm", "Bb7"]
+
+## Documentation
+
+You can find the docs hosted at:
+
+- [This repo's Github pages](https://vyder.github.io/note-transpose/)
+- [RubyGems](https://rubygems.org/gems/note-transpose)
 
 ## Support
 

data/bin/note-transpose

@@ -8,21 +8,23 @@ def print_help
     basename = File.basename(__FILE__)
     puts <<EOF
 
-Usage: #{basename} [-]<number half steps> <notes> [#{PREF_FLAT_OPT}]
-#{PREF_FLAT_OPT}     Always uses flat notes in output instead of sharp ones
+Usage: #{basename} [-]<number half steps> <notes> [options]
 
-Example:
-❯ #{basename} +1 C G F Am
-=> #{NoteTranspose.transpose(1, %w(C G F Am))}
+  Options:
+    #{PREF_FLAT_OPT}     Always uses flat notes in output instead of sharp ones
 
-❯ #{basename} 2 C G F Am
-=> #{NoteTranspose.transpose(2, %w(C G F Am))}
+  Examples:
+    ❯ #{basename} +1 C G F Am
+    => #{NoteTranspose.transpose(1, %w(C G F Am))}
 
-❯ #{basename} -2 D# G7 F Am7 Cadd7
-=> #{NoteTranspose.transpose(-2, %w(D# G7 F Am7 Cadd7))}
+    ❯ #{basename} 2 C G F Am
+    => #{NoteTranspose.transpose(2, %w(C G F Am))}
 
-❯ #{basename} -2 D# G7 F Am7 Cadd7 --pref-flat
-=> #{NoteTranspose.transpose(-2, %w(D# G7 F Am7 Cadd7), pref_flat: true)}
+    ❯ #{basename} -2 D# G7 F Am7 Cadd7
+    => #{NoteTranspose.transpose(-2, %w(D# G7 F Am7 Cadd7))}
+
+    ❯ #{basename} -2 D# G7 F Am7 Cadd7 --pref-flat
+    => #{NoteTranspose.transpose(-2, %w(D# G7 F Am7 Cadd7), pref_flat: true)}
 EOF
 end
 
@@ -40,6 +42,5 @@ pref_flat = !input.delete(PREF_FLAT_OPT).nil?
 result = NoteTranspose.transpose(half_steps, input, pref_flat: pref_flat)
 
 puts <<EOF
-
 => #{result.join(' ')}
 EOF

data/lib/note-transpose.rb

@@ -1,4 +1,3 @@
-#!/usr/bin/env ruby
 
 # List of musical notes, as sharps and flats
 NOTES = {
@@ -59,8 +58,7 @@ module NoteTranspose
 
                 transposed_notes << note.gsub(actual_note, transposed_note).capitalize
             rescue
-                puts "'#{note.capitalize}' is not a valid note!"
-                exit 1
+                raise "'#{note.capitalize}' is not a valid note!"
             end
         end
 

metadata

@@ -1,15 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: note-transpose
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Vidur Murali
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-24 00:00:00.000000000 Z
-dependencies: []
+date: 2020-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
 description:
 email:
 - vidur@monkeychai.com
@@ -40,8 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: A CLI tool to transpose notes by half steps