fretboards 0.0.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f74b94171d59d8205ea78288d485e0456c0cec05235384b1467031d55f8e16e
-  data.tar.gz: 77b288c138152851fb1c9ec3b3d888f78ce9a1cd81b9361e2128031f74b03b6d
+  metadata.gz: 2709f5ecdfcb4e12f5befb04ed0e9a69d5538c2500f395ef8dff2617ace3d5d7
+  data.tar.gz: 493db44900e76c4a7f92c20aaeff8d5824faa39a31824e7ae6b30f24a0ed81a3
 SHA512:
-  metadata.gz: 2b193399564a8ed351a954ee6198b493846cd89f3671da04fa84d992934b9f65fc767f3e0b0cab0a818f14c4eaf02accbcd1e317b1ac8c9cb82620677680f433
-  data.tar.gz: a64774090babf06d96e2811f33600488a0d61739bc868645a3ef2a145aae18ce4145198c3e160cdb29b6c45bb210822db35abe700dd22611ae1015101b63de0c
+  metadata.gz: abf0ddda617a1d3ddba69a8a45eb48d7596552fa2b73a6a1f870516435bcb74ffc0ef2d0429cca8c57d1746b959d5bcb577c6eead32048bb9d621129cd79fcc8
+  data.tar.gz: 4057730a7f52ebb0ca18771036fb8bd4d2a623254857297d752c88d0e2e4f084b7c3c4f4e2a71773ad8815a2cb46abdb71f828e535848170f52d5dc50de3102a

data/bin/fretboards_render

@@ -2,12 +2,95 @@
 
 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].
+  --offset=<offset>   Offset of the fretboard [default: 0].
+  --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)
+
+if arguments['--offset']
+  fb.set_offset(arguments['--offset'].to_i)
+end
+
+
+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/fretboard.rb

@@ -75,12 +75,12 @@ module Fretboards
       @offset = n
       self
     end
-    
+
     def set_label_offset(n)
       @label_offset = n
       self
     end
-    
+
 
     def mark(s, f = nil, settings = {})
       if !s.is_a? Hash
@@ -196,15 +196,17 @@ module Fretboards
       if marks.empty?
         [1, size]
       else
-        min = marks.inject { |sum, i| i[:fret] < sum[:fret] ? i : sum }[:fret]
+        min = marks.inject { |sum, i| (i[:fret] < sum[:fret]) ? i : sum }[:fret]
         max = marks.inject { |sum, i| i[:fret] > sum[:fret] ? i : sum }[:fret]
         if size >= max
           [1, size]
         else
-          # puts "#{self.title} pasa por el segundo hilo"
-          min = 1 if min == 0
-          max = (min + size) if (size > (max - min) )
-          [min + offset, max + offset]
+          if offset > 0
+            [ offset, offset + size - 1 ]
+          else
+            min = 1 if min == 0
+            [min, max]
+          end
         end
       end
     end
@@ -213,4 +215,4 @@ module Fretboards
 
 
   end
-end
+end

data/lib/fretboards/fretboard_collection.rb

@@ -10,7 +10,7 @@ module Fretboards
       @tuning = %w{ g' c' e' a' }
       @table = "default"
     end
-    
+
     def set_tuning(a)
       @tuning = a
     end
@@ -20,14 +20,14 @@ module Fretboards
       @col << fb
       fb
     end
-    
+
     def define(title, a, attrs = {})
       form_add(title, a, { :title => title }.merge(attrs))
     end
 
     def use(title)
       raise "#{title} form not available" unless @forms[title]
-      @forms[title] 
+      @forms[title]
     end
 
 
@@ -45,6 +45,9 @@ module Fretboards
         fb = Fretboard.new(:tuning => @tuning)
         fb.terse(dots, attrs)
       end
+      if attrs[:offset]
+        fb.set_offset(attrs[:offset])
+      end
       fb
     end
 
@@ -71,4 +74,4 @@ module Fretboards
 
   end
 
-end
+end

data/lib/fretboards/renderer/svg.rb

@@ -4,7 +4,7 @@ require "fretboards/ext/hash"
 module Fretboards
   module Renderer
     class Svg < Base
-      
+
       def initialize(opts = {})
         # TODO configuration should merge recursively
         @opts = {
@@ -48,7 +48,7 @@ module Fretboards
           :open_margin_bottom => 4,
         }.deep_merge(opts)
       end
-      
+
       def render(fb)
         @fb = fb
         require "builder"
@@ -75,7 +75,7 @@ module Fretboards
         # @svg
         # xml
       end
-      
+
       def landscape_attributes
         if @opts[:landscape]
           {
@@ -85,23 +85,23 @@ module Fretboards
           {}
         end
       end
-      
+
       def string_attrs
         @opts[:string_attrs]
       end
-      
+
       def fret_attrs
         @opts[:fret_attrs]
       end
-      
+
       def nut_attrs
         @opts[:nut_attrs]
       end
-      
+
       def string_spacing
         (@opts[:width] - @opts[:padding_left] - @opts[:padding_right]) / ((@fb.string_count - 1).to_f)
       end
-      
+
       def draw_strings(svg)
         (0..@fb.string_count-1).each do |sn|
           # x = @opts[:padding_left] + sn * string_spacing(fb)
@@ -109,24 +109,24 @@ module Fretboards
           y1 = @opts[:padding_top]
           y2 = @opts[:height] - @opts[:padding_bottom]
           attrs = string_attrs.merge(:x1 => x, :x2 => x, :y1 => y1, :y2 => y2, :class => 'string')
-          if (!@opts[:string_widths].empty?) 
+          if (!@opts[:string_widths].empty?)
             attrs = attrs.merge({ :"stroke-width" => @opts[:string_widths][sn] })
           end
           svg.line(attrs)
         end
       end
-      
+
       def draw_title(svg)
         # TODO calculate ideal gap
-        gap = @opts[:title_attrs][:"font-size"] 
+        gap = @opts[:title_attrs][:"font-size"]
         svg.text(@fb.title, { :x => @opts[:width] * 0.5 + ((@opts[:padding_left] - @opts[:padding_right])*0.5), :y => @opts[:padding_top] - gap, :class => 'title' }.merge(@opts[:title_attrs]))
       end
-      
+
       def get_string_x(sn)
         sn = @fb.string_number_to_index(sn)
         @opts[:padding_left] + sn * string_spacing
       end
-      
+
       def draw_frets(svg)
         fret_range = @fb.fret_range(@opts[:fret_count])
         total_frets = fret_range.last - fret_range.first + 1
@@ -141,7 +141,7 @@ module Fretboards
           draw_fret(svg, n+1)
         end
       end
-      
+
       def draw_labels(svg)
         fret_range = @fb.fret_range(@opts[:fret_count])
         if fret_range.first > 1
@@ -151,7 +151,7 @@ module Fretboards
           svg.text(fret_range.first + @fb.label_offset, { :y => y, :x => x, :class => 'label' }.merge(@opts[:label_attrs]))
         end
       end
-      
+
       def draw_fret(svg, n)
         y = get_fret_y(n)
         if @opts[:rectangular_frets]
@@ -160,14 +160,14 @@ module Fretboards
           svg.line(fret_attrs.merge(:x1 => @opts[:padding_left], :x2 => @opts[:width] - @opts[:padding_right], :y1 => y, :y2 => y, :class => 'fret'))
         end
       end
-      
+
       def draw_nut(svg)
         y = @opts[:padding_top] - @opts[:nut_attrs][:"stroke-width"] * 0.5
         extra_first = 0 # @opts[:string_widths][0] * 0.5
         extra_last = 0 # @opts[:string_widths].last * 0.5
         svg.line(nut_attrs.merge(:x1 => @opts[:padding_left] - extra_first, :x2 => @opts[:width] - @opts[:padding_right] + extra_last, :y1 => y, :y2 => y, :class => 'nut'))
       end
-      
+
       def get_fret_y(fret_number)
         fret_range = @fb.fret_range(@opts[:fret_count])
         avail = @opts[:height] - @opts[:padding_top] - @opts[:padding_bottom] - @opts[:string_ext_bottom]
@@ -184,7 +184,7 @@ module Fretboards
         end
         y
       end
-      
+
       def get_first_fret_size(gaps, factor, avail)
         sum = 0
         (0..gaps-1).each do |t|
@@ -192,8 +192,8 @@ module Fretboards
         end
         avail.to_f/sum.to_f
       end
-      
-      
+
+
       def draw_marks(svg)
         @fb.marks.each do |m|
           if m[:fret] == 0
@@ -209,13 +209,13 @@ module Fretboards
           end
         end
       end
-      
+
       def draw_blue_note_symbol(svg, x, y, m)
         svg.rect(:x => x - 4, :y => y - 4, :width => 8, :height => 8, :fill => "#000", :stroke => "", :transform => "rotate(-45 #{x} #{y})")
         # svg.circle(:cx => x, :cy => y, :r => 3, :fill => "blue")
       end
-      
-      
+
+
       def draw_dot(svg, x, y, m)
         cnames = %w[dot]
         cnames << "dot-#{m[:symbol]}" if m[:symbol]
@@ -223,7 +223,7 @@ module Fretboards
         attrs = attrs.merge(@opts[(m[:symbol].to_s + "_symbol_attrs").to_sym]) if (m[:symbol] && @opts[(m[:symbol].to_s + "_symbol_attrs").to_sym])
         svg.circle(attrs)
       end
-      
+
       def get_dot_position(string, fret)
         fret_range = @fb.fret_range(@opts[:fret_count])
         diff = fret_range.first == 1 ? 0 : fret_range.first - 1
@@ -232,7 +232,7 @@ module Fretboards
         y = 0.5 * (get_fret_y(fret - 1) + get_fret_y(fret))
         [x, y]
       end
-      
+
       def draw_in_dots(svg, name)
         # TODO allow rotating dot text on rotated fretboards
         sym = name.to_sym
@@ -250,7 +250,7 @@ module Fretboards
           end
         end
       end
-      
+
       def draw_in_bottom(svg, name)
         # TODO allow rotating bottom text on rotated fretboards
         sym = name.to_sym
@@ -264,7 +264,7 @@ module Fretboards
           end
         end
       end
-      
+
       def draw_open(svg, m)
         margin_bottom = @opts[:open_margin_bottom]
         y = @opts[:padding_top] - @opts[:open_attrs][:r] - @opts[:nut_attrs][:"stroke-width"] - margin_bottom
@@ -274,7 +274,7 @@ module Fretboards
         attrs = attrs.merge(@opts[symbol_attrs]) if (m[:symbol] && @opts[symbol_attrs])
         svg.circle(attrs)
       end
-      
+
       def draw_mutes(svg)
         margin_bottom = @opts[:open_margin_bottom]
         cy = @opts[:padding_top] - @opts[:open_attrs][:r] - @opts[:nut_attrs][:"stroke-width"] - margin_bottom
@@ -286,7 +286,7 @@ module Fretboards
           # svg.text("x", { :x => cx, :y => cy })
         end
       end
-      
+
       def draw_barres(svg)
         barre_attrs = @opts[:barre_attrs]
         @fb.barres.each do |b|
@@ -297,8 +297,8 @@ module Fretboards
           svg.rect({:y => y, :x => x, :width => w, :class => :barre}.merge(barre_attrs))
         end
       end
-            
-      
+
+
     end
   end
-end
+end

data/lib/fretboards/version.rb

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

data/test/test_fretboard.rb

@@ -1,11 +1,11 @@
 require 'test/unit'
+$:<< File.dirname(__FILE__) + '/../lib'
 require 'fretboards'
-
 include Fretboards
 
 # TODO write useful tests
 class FretboardTest < Test::Unit::TestCase
-  
+
   def test_string_count
     uke = Fretboard.new()
     assert_equal(4, uke.string_count)
@@ -13,71 +13,71 @@ class FretboardTest < Test::Unit::TestCase
     guit = Fretboard.new(:tuning => Fretboards::Tuning::GUITAR)
     assert_equal(6, guit.string_count)
   end
-  
+
   def test_mark
     fb = Fretboard.new
     fb.mark :string => 1, :fret => 5
     assert_equal([{:string => 1, :fret => 5}], fb.marks)
   end
-  
+
   def test_barre
     fb = Fretboard.new(:tuning => %w{ g' c' e' a' })
     fb.barre 1
     assert_equal([{:fret => 1, :from => 4, :to => 1 }], fb.barres)
   end
-  
+
   def test_mute
     fb = Fretboard.new
     fb.mute(1)
     assert_equal([1], fb.mutes)
   end
-  
+
   def test_open
     fb = Fretboard.new
     fb.open(1)
     assert_equal([{:string => 1, :fret => 0}], fb.marks)
   end
-  
+
   def test_terse_full
     fb = Fretboard.new
     fb.terse %w{ 1/4-3(5) }
     assert_equal([{:string => 4, :finger => 3, :function => "5", :fret => 1}], fb.marks)
   end
-  
+
   def test_terse_minimal
     fb = Fretboard.new
     fb.terse %w{ 1 }
     assert_equal([{ :string => 4, :fret => 1 } ], fb.marks)
   end
-  
+
   def test_terse_barre
     fb = Fretboard.new
     fb.terse %w{ 3 1[ 1] 0 }
     assert_equal([{:fret => 1, :from => 3, :to => 2 }], fb.barres)
   end
-  
+
   def test_terse_unfinished_barre
     fb = Fretboard.new
     fb.terse %w{ 3 1[ 1 1 }
     assert_equal([{:fret => 1, :from => 3, :to => 1 }], fb.barres)
   end
-  
+
   def test_terse_symbols
     # puts "symbols"
     fb = Fretboard.new
     fb.terse %w{ 3! }
     assert_equal(:root, fb.marks.first[:symbol])
-    
+
     fb = Fretboard.new
     fb.terse %w{ 3? }
     assert_equal(:phantom, fb.marks.first[:symbol])
-    
+
     fb = Fretboard.new
     fb.terse %w{ 3!? }
     assert_equal(:phantom_root, fb.marks.first[:symbol])
-    
+
   end
-  
+
   def test_fret_range
     fb = Fretboard.new
     fb.terse %w{ 0 0 0 3 }
@@ -89,5 +89,12 @@ class FretboardTest < Test::Unit::TestCase
     fb.terse %w{ 7 6 5 9 }
     assert_equal([5, 9], fb.fret_range)
   end
-  
-end
+
+  def test_fret_range_with_offset
+    fb = Fretboard.new
+    fb.terse %w{ 0 5 7 7 }
+    fb.set_offset 5
+    assert_equal([5, 8], fb.fret_range)
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fretboards
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Choan Galvez
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-18 00:00:00.000000000 Z
+date: 2023-10-28 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: