songbookize 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5804912b54b4f7e9eb0e75b4ed611e7a7d94aa4
-  data.tar.gz: 4472d45c0fa525c07e2b88a7aecf15da0b8d77a1
+  metadata.gz: 17bb2cdb82cadab3871c628e9a5e2b5f27df93da
+  data.tar.gz: 2f2f873b506e890dd6eacbe4f1dd4501cfcb0720
 SHA512:
-  metadata.gz: 3be94c1a03624d912a90f56bbd2d6639b249e227c03732fda99a0407d9932716410a897a4084dacd32a2fc2e2ae7a7bffb19f1e9dd0a0b887ce0003521f172eb
-  data.tar.gz: 6df99920eaf27c4c96bcdff1717ecd0fff62d1131532d96d536a64394327283ba67906bb3dc25fcc8d7667f0bc750fa5aeec761ca0433f3b0033814cf16e4243
+  metadata.gz: da3d29f7e87ba694d2173692d67aecacf745473c65107fa65afd396d73614e77d53565a9d4c4487f5bff735f072eee6173c52287bc1d2ee069783f83c4b63389
+  data.tar.gz: 7217631176f13d507bb3ebe8be51775593e7121ebea536352cff66fdd55a5060092b4f78fd914fff27625dcaf0ee5f1f1e6aa0af96d89afb73ded70cb55fd8f9

data/Creator/capo.rb

@@ -2,17 +2,17 @@ class Song
   def capo!(fret)
     capo_melody!(fret) unless melody.nil? or melody.empty?
     verses.each{|v| v.capo!(fret)}
-    %[key K].each{|k| info[k] = Song.capo(info[k], fret) if info.include?(k)}
+    %w[key K].each{|k| info[k] = Song.capo(info[k], fret) if info.include?(k)}
     return self
   end
 
   OCTAVE ||= %w[A Bb B C Db D Eb E F Gb G Ab]
   def self.capo(chord, fret)
-    idx = OCTAVE.index(chord[0])
-    range = 0
+    idx = OCTAVE.index(chord[0..1])
+    range = 0..1
     if idx.nil? then
-      idx =  OCTAVE.index(chord[0..1])
-      range = 0..1
+      idx =  OCTAVE.index(chord[0])
+      range = 0
     end
     raise StandardError.new("Unknown Chords #{chord}!") if idx.nil?
 

data/Creator/html_formatter.rb

@@ -4,6 +4,7 @@ require 'date'
 require 'slim'
 require 'ostruct'
 require 'kramdown'
+require 'coffee-script'
 require_relative 'song'
 
 class Song
@@ -70,6 +71,10 @@ class SongBook
       File.write("#{dir}/#{song.slug}.html", Slim::Template.new(File.join(File.dirname(__FILE__),'song.slim')).render(scope))
       File.write("#{dir}/#{song.slug}_slideable.html", Slim::Template.new(File.join(File.dirname(__FILE__),'slideable_song.slim')).render(scope))
     end
+    Dir["#{File.dirname(__FILE__)}/*.coffee"].each do |c|
+      log.debug "Compiling #{c}"
+      File.write("#{dir}/#{File.basename(c, ".coffee")}.js", CoffeeScript.compile(File.read(c)))
+    end
     FileUtils.cp Dir["#{File.dirname(__FILE__)}/resources/*"], "#{dir}/"
   end
 end

data/Creator/latex_formatter.rb

@@ -10,7 +10,7 @@ class Song
       res = lyrics.dup
       chords.each do |chord, pos|
         cmd = %|\\ch{#{chord}}|
-        res = res.ljust(pos + offset + 1).insert(pos + offset, cmd)
+        res = res.ljust(pos + offset + 1, " ").insert(pos + offset, cmd) # Note, this is a unicode emspace
         offset += cmd.length
       end
 
@@ -40,7 +40,7 @@ class Song
     end
     parts << "\\section{#{title}}"
     parts << "\\songdesc{#{desc}}\n\n" if desc
-    parts << "\\#{(melody.nil? or melody.empty?) ? "nm" : ""}songinfo{#{"Key of #{key}"}}{#{author}}"
+    parts << "\\#{(melody.nil? or melody.empty?) ? "nm" : ""}songinfo{#{key.empty? ? "No Key Specified" : "Key of #{key}"}}{#{author}}"
     parts << "\\melody{#{slug}001.eps}" unless melody.nil? or melody.empty?
     # parts << "\\begin{abc}[name=#{title.downcase.gsub(/[^\w]/, "")}]\n#{melody}\\end{abc}" unless melody.nil? or melody.empty?
     # parts << "\\begin{lilypond}[quoted,staffsize=26]\n#{lilypond}\\end{lilypond}" unless melody.nil? or melody.empty?

data/Creator/slideable_song.slim

@@ -10,6 +10,7 @@ html
     javascript:
       window.ABCJS.plugin.auto_render_threshold = 100;
       window.ABCJS.plugin.hide_abc = true;
+    script src="songbook.js"
     sass:
       body
         max-width: 1000px
@@ -131,4 +132,8 @@ coffee:
         verse_index++ if verse_index < verses.length - 1
       when "Backspace"
         window.history.back()
+      when "ArrowUp"
+        window.transposeUp()
+      when "ArrowDown"
+        window.transposeDown()
     updateVerses()

data/Creator/song.slim

@@ -5,68 +5,71 @@ html
     / style type="text/css"==open(URI.encode("https://fonts.googleapis.com/css?family=Bitter:400,700|Muli:300,400,i|Montserrat:400,700|Fira+Mono|Junge")).read
     script src="abcjs_basic_2.3-min.js"
     script src="abcjs_plugin_2.3-min.js"
+    script src="https://d3js.org/d3.v4.min.js"
     javascript:
       window.ABCJS.plugin.auto_render_threshold = 100;
       window.ABCJS.plugin.hide_abc = true;
-  sass:
-    body
-      max-width: 1000px
-      margin: auto
-      padding-top: 50px
-      font-family: 'Junge'
-    .lyrics
-      line-height: 140%
-      font-size: 140%
-      overflow-y: hidden
-      transform-origin: top
-      clear: both
-      font-family: 'Junge'
-      margin: auto
-      width: fit-content
-      padding-top: 1em
+    script src="songbook.js"
 
-    .chordlyrics
-      font-family: 'Fira Mono', monospace
-    .abcrendered
-      margin: auto
-    h2
-      text-align: center
-    .order
-      position: relative
-      top: 10
-      left: 0
-      float: right
-      font-size: 26px
-      font-family: 'Fira Mono', sans
-    .chords
-      font-family: 'Fira Mono', monospace
-      font-weight: bold
-      color: #08c
-    .chorusindicator
-      color: #0a5
-      font-weight: bold
-      text-align: center
-    .chorus
-      color: #083
-    .author, .key
-      font-family: 'Lora', serif
-      font-size: 140%
-      text-align: center
-      font-style: italic
+    sass:
+      body
+        max-width: 1000px
+        margin: auto
+        padding-top: 50px
+        font-family: 'Junge'
+      .lyrics
+        line-height: 140%
+        font-size: 140%
+        overflow-y: hidden
+        transform-origin: top
+        clear: both
+        font-family: 'Junge'
+        margin: auto
+        width: fit-content
+        padding-top: 1em
 
-    .author
-      float: right
-      margin-right: 120px
-    .key
-      float: left
-      margin-left: 120px
-    .desc
-      clear: both
-      margin-bottom: 2em
-    .melody
-      background: none
-      border: none
-      clear: both
+      .chordlyrics
+        font-family: 'Fira Mono', monospace
+      .abcrendered
+        margin: auto
+      h2
+        text-align: center
+      .order
+        position: relative
+        top: 10
+        left: 0
+        float: right
+        font-size: 26px
+        font-family: 'Fira Mono', sans
+      .chords
+        font-family: 'Fira Mono', monospace
+        font-weight: bold
+        color: #08c
+      .chorusindicator
+        color: #0a5
+        font-weight: bold
+        text-align: center
+      .chorus
+        color: #083
+      .author, .key
+        font-family: 'Lora', serif
+        font-size: 140%
+        text-align: center
+        font-style: italic
+
+      .author
+        float: right
+        margin-right: 120px
+      .key
+        float: left
+        margin-left: 120px
+      .desc
+        clear: both
+        margin-bottom: 2em
+      .melody
+        background: none
+        border: none
+        clear: both
   body
     .order=song.order
     a name=song.slug

data/Creator/songbook.coffee

@@ -0,0 +1,22 @@
+OCTAVE = "A Bb B C Db D Eb E F Gb G Ab".split(" ")
+window.capo = (chord, fret) ->
+  idx = OCTAVE.indexOf(chord[0..1])
+  start = 2
+  if idx < 0
+    idx = OCTAVE.indexOf(chord[0])
+    start = 1
+  throw new Exception("Unknown chord #{chord}") if idx < 0
+  return "#{OCTAVE[(idx + fret) % OCTAVE.length]}#{chord[start..-1]}"
+
+window.transpose = (steps) ->
+  d3.selectAll(".chords").each (c) ->
+    $(this).text $(this).text().replace(/[^\s]+/g, (t) -> capo(t, steps))
+
+window.currentTranspose = 0
+window.transposeUp = ->
+  window.currentTranspose += 1
+  window.transpose 1
+
+window.transposeDown = ->
+  window.currentTranspose -= 1
+  window.transpose -1

data/Rakefile

@@ -1,5 +1,6 @@
 # encoding: UTF-8
 require_relative 'Creator/parser.rb'
+require_relative 'Creator/capo.rb'
 require_relative 'Creator/latex_formatter.rb'
 require_relative 'Creator/html_formatter.rb'
 require_relative 'Creator/midi_formatter.rb'
@@ -7,6 +8,7 @@ require_relative 'Creator/midi_formatter.rb'
 def book
   unless $book
     $book = SongBook.parse("Songs")
+    # $book.songs.each{|s| s.capo!(2) }
     $book.preface = `tail -n+3 Readme.md | pandoc -t latex`
   end
   $book
@@ -37,35 +39,47 @@ task :preview => [:parse, :eps, :reorder] do
   end
 end
 
-task :build => [:parse, :eps, :reorder] do
+desc "Builds PDF out of songbook."
+task :pdf => [:parse, :eps, :reorder] do
   Dir.chdir("latex") do
     book.build(filename:book_name)
   end
 end
 
+desc "Builds a booklet PDF out of songbook."
 task :booklet => [:parse, :eps, :reorder] do
   Dir.chdir("latex") do
     book.build(booklet:true, filename:"#{book_name}let")
   end
 end
 
+desc "Converts songbook into HTML"
 task :html => [:parse, :reorder] do
   book.to_html("html")
 end
 
+desc "Creates midi files for all songs with .abc tunes"
 task :midi => [:parse, :reorder] do
   book.to_midi("html/midi")
 end
 
+desc "Creates javascript / JSON descriptions of the songbook"
 task :info => [:parse] do
   File.write("html/#{book_name}.json", book.json_info)
   File.write("html/#{book_name}.js", book.jsonp_info)
   File.write("html/songbook.json", book.json_info)
 end
 
-task :default => [:midi, :html, :info, :build, :booklet] do
+desc "Creates a portable single file archive of the songbook"
+task :yaml => [:parse] do
+  File.write("html/#{book_name}.yml", book.to_yaml)
 end
 
+desc "Attempts full build of all output types"
+task :default => [:midi, :html, :info, :pdf, :booklet] do
+end
+
+desc "Creates a tex file for each individual song"
 task :songtex do
   b = SongBook.parse("Songs")
   Dir.chdir("latex") do
@@ -91,5 +105,5 @@ end
 task :publish => [:preview, :booklet, :info] do
   raise StandardError.new("Uncommited changes") unless `git status -s`.empty?
   system("git push")
-  system("scp -r latex/#{book_name}.pdf latex/#{book_name}let.pdf latex/#{book_name}.json zachcapalbo.com:/var/www/files/")
+  system("scp -r latex/#{book_name}.pdf latex/#{book_name}let.pdf latex/#{book_name}.json #{book.info["remote_location"]}")
 end

data/Songbookize.md

@@ -0,0 +1,154 @@
+# Songbookize
+
+## Overview
+
+`songbookize` is a ruby gem and command for generating songbooks in the same
+style as [Zach's Songbook](http://zachcapalbo.com/projects/songbook.html). You
+can refer to the [source code for Zach's Songbook](https://gitlab.com/zach-geek/songbook)
+for reference.
+
+## Installation
+
+### Songbookize Gem
+
+Installing the `songbookize` command is as simple as
+
+```
+gem install songbookize
+```
+
+This is enough to compile songbooks into HTML or YAML.
+
+### Latex Dependencies
+
+In order to generate the nice pdf songbooks and songbooklets, you'll need to
+have LaTeX and a number of packages installed. If you're on Linux, the best
+way to install everything is to install everything in the [Dockerfile](https://hub.docker.com/r/zachgeek/songbook-builder/~/dockerfile/).
+
+On Windows, you can make it work with a LaTeX package like [MiKTeX](https://miktex.org/),
+but it's tricky. Good luck.
+
+### Docker Image
+
+If installing all of the dependencies is too much work, there's a handy
+[Docker Image](https://hub.docker.com/r/zachgeek/songbook-builder/) you can use
+instead.
+
+To use it, run something like:
+
+```
+docker run --rm -ti -v /path/to/your/songbook:/songbook zachgeek/songbook-builder
+```
+
+## Songbook Layout
+
+Your songbook should be contained in its own folder, with all of the `.chords`
+and `.abc` files living in the `Songs` subdirectory.
+
+### Chords Format
+
+The `.chords` format for songs is intended to be an easy, human readable way for
+encoding song lyrics and chords.
+
+#### Header
+
+`.chords` files begin with a small yaml header:
+
+```
+---
+title: A Song
+key: A
+desc: This is an example song
+---
+```
+
+None of the header items are required, but some common ones are
+
+- **title**: The song's title
+- **key**: The musical key that the song is played in
+- **desc**: A description of the song
+
+#### Chords and Lyrics
+
+After the header, chords are written with the chords on the line directly above
+the lyrics that they correspond to. This is a format that has been commonplace
+on the internet for decades. E.g.:
+
+```
+C         F          G
+This is a song about nothing
+C          F    G           Am
+It doesn't mean anything at all
+```
+
+Lyrics don't have to have chords corresponding to them. Simply omit the chord
+lines, and the verses will be picked up as being without chords. E.g.:
+
+```
+This is the second verse
+But you know the chords from the first
+```
+
+You can denote that the a chorus by putting `[Chorus:]` before it. Then, to
+refer to the chorus, you can just use `[Chorus]`
+
+#### Example
+
+So, our whole demo song from before might come out looking like:
+
+```
+---
+title: A Song
+key: A
+desc: This is an example song
+---
+
+C         F          G
+This is a song about nothing
+C          F    G           Am
+It doesn't mean anything at all
+
+[Chorus:]
+F           G
+This is the chorus
+D                C
+It has different chords
+
+This is the second verse
+But you know the chords from the first
+
+[Chorus]
+
+And here's one more verse
+Just for good measure, for good measure!
+```
+
+### ABC Format
+
+[ABC Notation](http://abcnotation.com/) is a popular text format for inscribing
+melodies. Songbookize will use standard tools to parse it, so you should refer
+to [online references](http://abcnotation.com/) for more information on writing
+ABC notation.
+
+A song can have a `.abc` file, a `.chords`, file, or both. If both files are
+specified for a given song, both the melody and the chords will be displayed.
+
+### songbook.yml
+
+`songbook.yml` describes the songbook. There are a few important keys:
+
+- **title**: Sets the title of the song book
+- **include**: Specifies a table of paths with a list of songs to copy.
+
+For instance, you might have:
+
+```
+---
+title: An Example Songbook
+include:
+  "/path/to/other/songbook/Songs":
+    - a_song
+    - a_nother_song
+  "/path/to/other/otherSongbook/Songs":
+   - a_nother_nother_song
+```

data/bin/songbookize

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+require 'rake'
+require 'pry'
+
+Rake::TaskManager.record_task_metadata = true
+load "#{File.dirname(__FILE__)}/../Rakefile"
+
+if ARGV.include?('-h') or ARGV.include?('--help') then
+  puts "songbookize compiles a song book into html and pdf files."
+  puts "usage: songbookize [task]"
+  puts "task may be:"
+  puts
+  Rake.application.tasks.reject {|t| t.comment.nil?}.each do |t|
+    puts "  #{t.name.ljust(20)} #{t.comment}"
+  end
+  puts
+  puts "default is used if no task is specified."
+  exit
+end
+
+yml_file = ARGV.find{|a| a.downcase.end_with?(".yml") and  File.exist?(a) }
+
+unless yml_file.nil? then
+  $book = YAML.load(File.read(yml_file))
+  ARGV.delete(yml_file)
+end
+
+Rake.application[ARGV[0] || 'default'].invoke

data/template.tex

@@ -9,6 +9,7 @@
 \setlength{\columnsep}{0.1cm}
 
 \newunicodechar{☺}{{\fontspec{DejaVu Sans}☺}}
+\newunicodechar{ }{{\fontspec{DejaVu Sans} }}
 
 \setlength{\oddsidemargin}{2.0cm}
 \setlength{\evensidemargin}{2.5cm}
@@ -20,6 +21,8 @@
 \setdvipstargetpages
 \fi
 
+\setpdftargetpages
+
 \ifprintoption % tweak dvi output only for final printing
 \special{!TeXDict begin /landplus90{true}store end}
 \special{!TeXDict begin <</Tumble true>> setpagedevice end}

metadata

@@ -1,19 +1,103 @@
 --- !ruby/object:Gem::Specification
 name: songbookize
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Zach Capalbo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-29 00:00:00.000000000 Z
-dependencies: []
+date: 2018-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: coffee-script
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 description: Generate your own PDF/HTML songbook.
 email: zach.geek@gmail.com
 executables:
-- bookize
+- songbookize
 extensions: []
 extra_rdoc_files: []
 files:
@@ -25,14 +109,16 @@ files:
 - Creator/slideable_song.slim
 - Creator/song.rb
 - Creator/song.slim
+- Creator/songbook.coffee
 - Creator/songbook.slim
 - Creator/tv.slim
 - LICENSE
 - Rakefile
 - Readme.md
-- bin/bookize
+- Songbookize.md
+- bin/songbookize
 - template.tex
-homepage: https://github.com/zach-capalbo/zachs-songbook
+homepage: https://gitlab.com/zach-geek/songbook
 licenses:
 - MIT
 metadata: {}

data/bin/bookize

@@ -1,6 +0,0 @@
-#!/usr/bin/env ruby
-require 'rake'
-require 'pry'
-load "#{File.dirname(__FILE__)}/../Rakefile"
-
-Rake.application[ARGV[0] || 'default'].invoke