fretboards 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: acdbd086f02d7a43a325ae37cb55286d1dcd6aba
-  data.tar.gz: f57a83258298b07ec0493ad6b2767449561f36c3
+SHA256:
+  metadata.gz: 2f74b94171d59d8205ea78288d485e0456c0cec05235384b1467031d55f8e16e
+  data.tar.gz: 77b288c138152851fb1c9ec3b3d888f78ce9a1cd81b9361e2128031f74b03b6d
 SHA512:
-  metadata.gz: 38822205e32348e2303ef7cc0014cb4b7d0657f39f50a498e5cd0ca033a796492048a03a901ab77085305fc2714b21219343fc28bade9d0085015cbf1a948796
-  data.tar.gz: 37d3ab744e72c69c6737258d56a761165c70308023fb4b91bb0f9b117b7ff557fd46a47fa720e6342fcd27d87deee2e4c57b2ff729f5cb66cd93baa47306e269
+  metadata.gz: 2b193399564a8ed351a954ee6198b493846cd89f3671da04fa84d992934b9f65fc767f3e0b0cab0a818f14c4eaf02accbcd1e317b1ac8c9cb82620677680f433
+  data.tar.gz: a64774090babf06d96e2811f33600488a0d61739bc868645a3ef2a145aae18ce4145198c3e160cdb29b6c45bb210822db35abe700dd22611ae1015101b63de0c

data/LICENSE.txt

@@ -0,0 +1,8 @@
+Copyright (c) 2019 Choan Gálvez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/Readme.md

@@ -0,0 +1,67 @@
+# Fretboards
+
+Fretboards is a Ruby library to programatically define fretboard diagrams of string instruments and render them to SVG and other formats.
+
+
+## Installation
+
+This package is available in RubyGems and can be installed with:
+
+    gem install fretboards
+
+For users working with the source from GitHub, you can run:
+
+    rake install
+
+Which will build and install the gem (you may need sudo/root permissions). You can also chose to build the gem manually if you want:
+
+    rake build
+
+
+## Usage
+
+```ruby
+require 'fretboards'
+
+# initialize the fretboard with a set tuning
+# number of strings is taken from the tuning
+fb = Fretboards::Fretboard.new(tuning: Fretboards::Tuning::UKULELE)
+
+# use the `terse` method for adding marks
+# marks are passed as an array and added sequentially
+# from bottom to first string
+fb.terse(%w{ 1 2 1 1 })
+
+# use an opening square bracket to signal the top string of a barre
+fb.terse(%w{ 1[ 2 1 1 })
+
+# use an exclamation mark on any of the dots to set it as featured (root, i.e.)
+fb.terse(%w{ 1[ 2 1 1! })
+
+# fingerings ar preceded by a `-`
+fb.terse(%w{ 1-1 2-3 1-2 3-4 })
+
+# use a renderer subclass to turn the definition into a representation
+# the task of getting the output into a file is up to the library user
+renderer = Fretboards::Renderer::Svg.new
+renderer.render(fb)
+```
+
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+
+
+## License
+
+This project is licensed under the MIT license, a copy of which can be found in the LICENSE.txt file.
+
+
+## Support
+
+Users looking for support should file an issue on the GitHub issue tracking page (https://github.com/choan/fretboards/issues), or file a pull request (https://github.com/choan/fretboards/pulls) if you have a fix available.
+
+Those who wish to contribute directly to the project can contact me at <choan.galvez@gmail.com> to talk about getting repository access granted.

data/fretboards.gemspec

@@ -1,13 +1,14 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "fretboards/version"
+require 'fretboards/version'
 
 Gem::Specification.new do |s|
-  s.name        = "fretboards"
+  s.name        = 'fretboards'
   s.version     = Fretboards::VERSION
-  s.authors     = ["Choan Galvez"]
-  s.email       = ["choan.galvez@gmail.com"]
-  s.homepage    = ""
+  s.authors     = ['Choan Galvez']
+  s.email       = ['choan.galvez@gmail.com']
+  s.licenses    = ['MIT']
+  s.homepage    = ''
   s.summary     = 'Define and draw fretboards'
   s.description = 'Allows defining instrument fretboard structures and representing them as highly customizable SVG graphics.'
 

data/lib/fretboards/renderer/svg.rb

@@ -17,7 +17,7 @@ module Fretboards
           :open_root_symbol_attrs => { :"stroke-width" => 2, :r => 3 },
           :open_phantom_root_symbol_attrs => { :"stroke-width" => 1, :r => 3, :"stroke-dasharray" => "1 1" },
           :svg_attrs => { :xmlns => "http://www.w3.org/2000/svg", :version => "1.1" },
-          :in_dot_attrs => { :"text-anchor" => "middle", :fill => "#fff", :"font-weight" => "normal", :"font-size" => 10, :"font-family" => "sans-serif", :"font-weight" => "bold"},
+          :in_dot_attrs => { :"text-anchor" => "middle", :fill => "#fff",  :"font-size" => 10, :"font-family" => "sans-serif", :"font-weight" => "bold"},
           :in_dot_root_symbol_attrs => { :fill => "#000", :"font-weight" => "bold" },
           :in_bottom_attrs => { :"text-anchor" => "middle", :fill => "#000", :"font-weight" => "normal", :"font-size" => 8, :"font-family" => "sans-serif" },
           :label_attrs => { :"text-anchor" => "end", :fill => "#000", :"font-size" => 10, :"font-family" => 'sans-serif' },

data/lib/fretboards/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fretboards
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Choan Galvez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-25 00:00:00.000000000 Z
+date: 2019-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -35,7 +35,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- LICENSE.txt
 - Rakefile
+- Readme.md
 - bin/fretboards_render
 - fretboards.gemspec
 - lib/..rb
@@ -49,11 +51,11 @@ files:
 - lib/fretboards/renderer/text.rb
 - lib/fretboards/tuning.rb
 - lib/fretboards/version.rb
-- readme.mdown
 - test/test_fretboard.rb
 - test/test_text_renderer.rb
 homepage: ''
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -70,8 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: fretboards
-rubygems_version: 2.4.2
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Define and draw fretboards

data/readme.mdown

@@ -1,5 +0,0 @@
-# Fretboards
-
-Define and draw instrument fretboards.
-
-To be continued...