fretboards 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f74b94171d59d8205ea78288d485e0456c0cec05235384b1467031d55f8e16e
-  data.tar.gz: 77b288c138152851fb1c9ec3b3d888f78ce9a1cd81b9361e2128031f74b03b6d
+  metadata.gz: e8f38b4dde148fa6891ffe83e6013de5f53a405a5107bac0b0ede0c20fd4bc0d
+  data.tar.gz: 319ff9148fa863aeb67adceae38bc76287098919c85566e3b1e51276f5b2d7cf
 SHA512:
-  metadata.gz: 2b193399564a8ed351a954ee6198b493846cd89f3671da04fa84d992934b9f65fc767f3e0b0cab0a818f14c4eaf02accbcd1e317b1ac8c9cb82620677680f433
-  data.tar.gz: a64774090babf06d96e2811f33600488a0d61739bc868645a3ef2a145aae18ce4145198c3e160cdb29b6c45bb210822db35abe700dd22611ae1015101b63de0c
+  metadata.gz: 87ac886d83ec05402278f8377751e127d3c25948ae388131dac81e42664061e30a646a83cb80290c6c78179743f217a68393aaaf38425ca0eb257cc082ab22f7
+  data.tar.gz: 6d4b57ea5aceb769ef23a878818f89966ba03aa8ff0aa5352c9d62970321286c127b9cae9869b40934517e75ddb5fb125d9e70ad7a7c392bfbb16bec7ca3523e

data/bin/fretboards_render

@@ -2,12 +2,87 @@
 
 require "fretboards"
 require "fretboards/renderer/svg"
+require "docopt"
 
-# TODO make something useful
-terse = ARGV
-# puts terse.inspect
+doc = <<DOCOPT
+Output a SVG fretboard.
 
-fb = Fretboards::Fretboard.new(:tuning => %w{g' c' e' a'})
-fb.terse(ARGV)
-renderer = Fretboards::Renderer::Svg.new()
-puts renderer.render(fb)
+Usage:
+  #{__FILE__} [options] [<dots>...]
+  #{__FILE__} (--tuning=<tuning> | --guitar | --ukulele) [options] [<dots>...]
+  #{__FILE__} -h | --help
+  #{__FILE__} --version
+
+Options:
+  --tuning=<tuning>   Tuning of the instrument [default: g' c' e' a'].
+  --width=<width>     Width of the fretboard [default: 108].
+  --height=<height>   Height of the fretboard [default: 180].
+  --fret-count=<fret-count>   Number of frets [default: 4].
+  --title=<title>     Title of the fretboard [default: ].
+  -h --help           Show this screen.
+  --version           Show version.
+
+Arguments:
+  <dots>  Dots to be drawn on the fretboard. Defaults to 4 strings and ukulele tuning. Actual tuning pitches are only considered when passing the dot marks as pitches.
+
+Dots are specified as a sequence of numbers, one per string, starting from 0. Use x for a muted string.
+
+  #{__FILE__} 0 2 1 2
+
+You can also specify dots as pitches, a to g.
+
+- Use `is` suffix for sharp, `es` for flat.
+- Use `'` or `,` for octaves up or down. `c'` is middle C.
+
+  #{__FILE__} aes\\' d\\' f\\' b\\'
+
+Draw guitar fretboard passing `--guitar` or `--guitar-7`:
+
+  #{__FILE__} --guitar x 3 2 0 1 0
+
+Use `[` and `]` to indicate barres:
+
+  #{__FILE__} --guitar 1\\[ 3 3 2 1 1\\]
+
+Mark a dot as root with `!`:
+
+  #{__FILE__} --guitar 3! 2 0 0 3 3
+
+Annotate fingerings with `-`:
+
+  #{__FILE__} --guitar 3-2 2-1 0 0 3-3 3-4
+
+To place multiple dots on the same string, use `/`:
+
+  #{__FILE__} --guitar 5/6 8/6 5/5 7/5 5/4 7/4 5/3 7/3 5/2 8/2 5/1 8/1
+
+Report bugs at https://github.com/choan/fretboards/issues
+DOCOPT
+
+begin
+  arguments = Docopt::docopt(doc, version: ::Fretboards::VERSION)
+rescue Docopt::Exit => e
+  puts e.message
+  exit
+end
+
+if arguments['--guitar']
+  arguments['--tuning'] = "e, a, d g b e'"
+elsif arguments['--guitar-7']
+  arguments['--tuning'] = "b,, e, a, d g b e'"
+elsif arguments['--ukulele']
+  arguments['--tuning'] = "g' c' e' a'"
+end
+
+terse = arguments['<dots>']
+tuning = arguments['--tuning'].split(' ')
+title = arguments['--title']
+width = arguments['--width'].to_i
+height = arguments['--height'].to_i
+fret_count = arguments['--fret-count'].to_i
+
+fb = Fretboards::Fretboard.new(:tuning => tuning)
+fb.title = title unless title.empty?
+fb.terse(terse)
+renderer = Fretboards::Renderer::Svg.new(width: width, height: height, fret_count: fret_count)
+puts renderer.render(fb)

data/fretboards.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |s|
   # specify any dependencies here; for example:
   # s.add_development_dependency "rspec"
   s.add_runtime_dependency "builder"
+  s.add_runtime_dependency "docopt", "~> 0.6.0"
 end

data/lib/fretboards/version.rb

@@ -1,3 +1,3 @@
 module Fretboards
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fretboards
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Choan Galvez
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-18 00:00:00.000000000 Z
+date: 2023-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 description: Allows defining instrument fretboard structures and representing them
   as highly customizable SVG graphics.
 email:
@@ -57,7 +71,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -72,8 +86,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Define and draw fretboards
 test_files: