kadryll 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+drills
+.approvals
+*.received.txt

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in kadryll.gemspec
+gemspec

data/README.md

@@ -0,0 +1,33 @@
+# Kadryll
+
+Drill notation generator for drums, with particular relevance to independence drills.
+
+## Input
+
+The drill generator takes a block of text on 5 lines.
+
+The first line consists of the exercise name and the time signature, and the four subsequent lines define the drill for the right hand, left hand, right foot, and left foot respectively. E.g.
+
+    ex1 4/4
+    tt4 r4 tt4 r4
+    r4 tt4 r4 tt4
+    r1
+    r1
+
+This will create a lilypond file named `ex1.ly`, and a score called `ex1.png`.
+
+## Configuration
+
+You can configure the location of the input directory (where the `*.ly` files go -- default is `drills/data/`) and the output directory (where the `*.png` files go - default is `drills/scores/`).
+
+
+    Kadryll.configure do |c|
+      c.output_dir = 'my/images/'
+      c.input_dir = 'my/lilypond/files/'
+    end
+
+In addition, you should set the copyright text which will be listed at the bottom of the score.
+
+    Kadryll.configure do |c|
+      c.copyright = 'Copyright 2012 - Chet'
+    end

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/TODO

@@ -0,0 +1 @@
+[ ] executable to generate a collection of exercises from a file

data/bin/kadryll

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'thor'
+require "kadryll"
+require "kadryll/cli"
+
+Kadryll::CLI.start

data/kadryll.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "kadryll"
+  s.version     = "0.0.1"
+  s.authors     = ["Katrina Owen"]
+  s.email       = ["katrina.owen@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Score generator for drum independence drills.}
+  s.description = %q{Score generator for drum independence drills.}
+
+  s.rubyforge_project = "kadryll"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "approvals"
+  s.add_development_dependency "timecop"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/kadryll.rb

@@ -0,0 +1,68 @@
+require 'fileutils'
+require 'singleton'
+require 'date'
+require 'kadryll/drill'
+require 'kadryll/shorthand_reader'
+
+module Kadryll
+  class << self
+
+    def initialize
+      FileUtils.mkdir_p(output_dir) unless File.exists?(output_dir)
+      FileUtils.mkdir_p(input_dir) unless File.exists?(input_dir)
+    end
+
+    def output_dir
+      config.output_dir
+    end
+
+    def input_dir
+      config.input_dir
+    end
+
+    def copyright
+      config.copyright
+    end
+
+    def configure(&block)
+      block.call Kadryll::Configuration.instance
+    end
+
+    def config
+      Kadryll::Configuration.instance
+    end
+  end
+
+  class Configuration
+    include Singleton
+
+    def output_dir=(dir = '')
+      @output_dir = sanitize(dir)
+    end
+
+    def output_dir
+      @output_dir ||= 'drills/scores/'
+    end
+
+    def input_dir=(dir = '')
+      @input_dir = sanitize(dir)
+    end
+
+    def input_dir
+      @input_dir ||= 'drills/data/'
+    end
+
+    def copyright
+      @copyright ||= "Copyright #{Date.today.year} YourName"
+    end
+
+    def copyright=(copyright)
+      @copyright = copyright
+    end
+
+    private
+    def sanitize(directory)
+      directory.nil? ? directory : directory.chomp('/') + '/'
+    end
+  end
+end

data/lib/kadryll/cli.rb

@@ -0,0 +1,21 @@
+module Kadryll
+
+  class CLI < Thor
+
+    desc "generate", "Generate drills from a file with score shorthand"
+    method_option :input, :type => :string, :aliases => "-i", :required => true, :desc => "path to template file"
+    method_option :output, :type => :string, :default => './', :aliases => "-o", :desc => "path to output directory"
+    method_option :prefix, :type => :string, :default => nil, :aliases => "-p", :desc => "file prefix for the .png output"
+    def generate
+      Kadryll.configure do |c|
+        c.output_dir = options[:output]
+      end
+      exercises = Kadryll::ShorthandReader.read(options[:input])
+      exercises.each do |exercise|
+        drill = Kadryll::Drill.from_string(exercise, :prefix => options[:prefix])
+        drill.generate_png
+      end
+    end
+  end
+end
+

data/lib/kadryll/drill.rb

@@ -0,0 +1,135 @@
+module Kadryll
+  class Drill
+
+    class << self
+      def lilypond_file(name)
+        "#{Kadryll.input_dir}#{name}.ly"
+      end
+
+      def from_string(template, options = {})
+        drill = parse template, options
+        drill.write
+        drill
+      end
+
+      def parse(template, options = {})
+        data, *measures = template.split("\n").map(&:strip)
+        name, time = data.split(" ")
+        new(name, time, measures, options)
+      end
+    end
+
+    attr_accessor :name, :time, :right_hand, :left_hand, :right_foot, :left_foot
+    def initialize(name, time, measures, options = {})
+      self.name = build_name(name, options[:prefix])
+      self.time = time
+      self.right_hand, self.left_hand, self.right_foot, self.left_foot = measures
+    end
+
+    def command
+      "lilypond --png --output=#{output_to} #{lilypond_file}"
+    end
+
+    def generate_png
+      system(command)
+      "#{output_to}.png"
+    end
+
+    def output_to
+      "#{Kadryll.output_dir}#{name}"
+    end
+
+    def write
+      Kadryll.initialize
+      File.open(lilypond_file, 'w') do |file|
+        file.write template
+      end
+    end
+
+    def lilypond_file
+      Drill.lilypond_file(name)
+    end
+
+    def template
+      <<-DRILL.gsub(/^\ {6}/, '')
+      \\version "2.14.2"
+
+      \\header {
+        tagline = \\markup {
+          \\fill-line {
+            \\line { \\null }
+            \\line { \\null }
+            \\line { \\tiny \\with-color #(x11-color 'gray80) { #{Kadryll.copyright} \\char ##x00A9 } }
+
+          }
+        }
+      }
+
+      #(set! paper-alist (cons '("drill" . (cons (* 190 mm) (* 80 mm))) paper-alist))
+      \\paper {
+        #(set-paper-size "drill")
+        #(define top-margin (* 7 mm))
+        #(define line-width (* 140 mm))
+      }
+
+      signature = \\time #{time}
+
+      rh = \\drummode { #{right_hand} }
+      lh = \\drummode { #{left_hand} }
+      rf = \\drummode { #{right_foot} }
+      lf = \\drummode { #{left_foot} }
+
+      #(define quake '((tamtam default #t 0)))
+      quakestaff = {
+        \\override DrumStaff.StaffSymbol #'line-positions = #'( 0 )
+        \\override DrumStaff.BarLine #'bar-extent = #'(-1 . 1.5)
+        \\override DrumStaff.InstrumentName #'self-alignment-X = #LEFT
+        \\set DrumStaff.drumStyleTable = #(alist->hash-table quake)
+        \\set fontSize = #-2
+        \\signature
+        \\override DrumStaff.Rest #'staff-position = #0
+      }
+
+      <<
+      \\new DrumStaff {
+        \\quakestaff
+        \\set DrumStaff.instrumentName = "Right Hand "
+        \\override Stem #'direction = #UP
+        \\rh | \\rh | \\rh | \\rh |
+      }
+      \\new DrumStaff {
+        \\quakestaff
+        \\set DrumStaff.instrumentName = \\markup \\left-column {
+          "Left Hand "
+        }
+        \\override Stem #'direction = #DOWN
+        \\lh | \\lh | \\lh | \\lh |
+      }
+      \\new DrumStaff {
+        \\quakestaff
+        \\set DrumStaff.instrumentName = \\markup \\left-column {
+          "Right Foot "
+        }
+        \\override Stem #'direction = #UP
+        \\rf | \\rf | \\rf | \\rf |
+      }
+      \\new DrumStaff {
+        \\quakestaff
+        \\set DrumStaff.instrumentName = \\markup \\left-column {
+          "Left Foot "
+        }
+        \\override Stem #'direction = #DOWN
+        \\lf | \\lf | \\lf | \\lf |
+      }
+      >>
+
+      DRILL
+    end
+
+    private
+    def build_name(name, prefix)
+      [prefix, name].compact.join('_').gsub(/[^\w\.\-]/, '')
+    end
+
+  end
+end

data/lib/kadryll/shorthand_reader.rb

@@ -0,0 +1,19 @@
+module Kadryll
+  class ShorthandReader
+    def self.read(file)
+      exercises = []
+      current_exercise = []
+      lines = File.readlines(file)
+      lines.each do |line|
+        if line.gsub(/\W/, '').empty?
+          exercises << current_exercise.join
+          current_exercise = []
+        else
+          current_exercise << line
+        end
+      end
+      exercises << current_exercise.join
+      exercises.compact.reject {|e| e.empty?}
+    end
+  end
+end

data/spec/drill_spec.rb

@@ -0,0 +1,51 @@
+require 'approvals'
+require 'kadryll'
+
+def default_template
+  <<-DRILL
+    e42 4/4
+    tt4 r4 tt4-> r4
+    r4 tt4 r4 tt4
+    tt4 r4 r4 tt4
+    r1
+  DRILL
+end
+
+describe Kadryll::Drill do
+  before(:all) do
+    Approvals.configure do |c|
+      c.approvals_path = 'spec/fixtures/approvals/'
+    end
+  end
+
+  describe "the name" do
+    it "it defaults to the name passed in" do
+      Kadryll::Drill.new("whatever", nil, nil).name.should eq("whatever")
+    end
+
+    it "adds a prefix if there is one" do
+      Kadryll::Drill.new("whatever", nil, nil, :prefix => 'level1').name.should eq("level1_whatever")
+    end
+
+    it "sanitizes the name" do
+      Kadryll::Drill.new("w_^h%$a&t.ev-er !", nil, nil).name.should eq("w_hat.ev-er")
+    end
+  end
+
+  it "creates the correct lilypond command" do
+    drill = Kadryll::Drill.from_string(default_template)
+    executable = Approvals::Executable.new(drill.command) do |command|
+      Approvals::Reporters::FilelauncherReporter.report(drill.generate_png)
+    end
+    Approvals.verify(executable, :name => 'drill uses the correct command')
+  end
+
+
+  it "generates a png" do
+    drill = Kadryll::Drill.from_string(default_template)
+    executable = Approvals::Executable.new(drill.template) do |command|
+      Approvals::Reporters::FilelauncherReporter.report(drill.generate_png)
+    end
+    Approvals.verify(executable, :name => 'drill generates the template')
+  end
+end

data/spec/fixtures/approvals/drill_generates_the_template.approved.txt

@@ -0,0 +1,71 @@
+\version "2.14.2"
+
+\header {
+  tagline = \markup {
+    \fill-line {
+      \line { \null }
+      \line { \null }
+      \line { \tiny \with-color #(x11-color 'gray80) { Copyright 2012 YourName \char ##x00A9 } }
+
+    }
+  }
+}
+
+#(set! paper-alist (cons '("drill" . (cons (* 190 mm) (* 80 mm))) paper-alist))
+\paper {
+  #(set-paper-size "drill")
+  #(define top-margin (* 7 mm))
+  #(define line-width (* 140 mm))
+}
+
+signature = \time 4/4
+
+rh = \drummode { tt4 r4 tt4-> r4 }
+lh = \drummode { r4 tt4 r4 tt4 }
+rf = \drummode { tt4 r4 r4 tt4 }
+lf = \drummode { r1 }
+
+#(define quake '((tamtam default #t 0)))
+quakestaff = {
+  \override DrumStaff.StaffSymbol #'line-positions = #'( 0 )
+  \override DrumStaff.BarLine #'bar-extent = #'(-1 . 1.5)
+  \override DrumStaff.InstrumentName #'self-alignment-X = #LEFT
+  \set DrumStaff.drumStyleTable = #(alist->hash-table quake)
+  \set fontSize = #-2
+  \signature
+  \override DrumStaff.Rest #'staff-position = #0
+}
+
+<<
+\new DrumStaff {
+  \quakestaff
+  \set DrumStaff.instrumentName = "Right Hand "
+  \override Stem #'direction = #UP
+  \rh | \rh | \rh | \rh |
+}
+\new DrumStaff {
+  \quakestaff
+  \set DrumStaff.instrumentName = \markup \left-column {
+    "Left Hand "
+  }
+  \override Stem #'direction = #DOWN
+  \lh | \lh | \lh | \lh |
+}
+\new DrumStaff {
+  \quakestaff
+  \set DrumStaff.instrumentName = \markup \left-column {
+    "Right Foot "
+  }
+  \override Stem #'direction = #UP
+  \rf | \rf | \rf | \rf |
+}
+\new DrumStaff {
+  \quakestaff
+  \set DrumStaff.instrumentName = \markup \left-column {
+    "Left Foot "
+  }
+  \override Stem #'direction = #DOWN
+  \lf | \lf | \lf | \lf |
+}
+>>
+

data/spec/fixtures/approvals/drill_uses_the_correct_command.approved.txt

@@ -0,0 +1 @@
+lilypond --png --output=drills/scores/e42 drills/data/e42.ly

data/spec/fixtures/approvals/exercises_from_file.approved.txt

@@ -0,0 +1,2 @@
+[0] "exercise1 4/4\r\nr1\r\nr4 tt4 r4 4\r\nr1\r\nr1\r\n"
+[1] "exercise2 4/4\r\nr2 tt4 r4\r\nr4 tt4 r4 tt4\r\ntt4 r4 tt4 r4\r\nr1\r\n"

data/spec/fixtures/approvals/exercises_with_blanks_from_file.approved.txt

@@ -0,0 +1,2 @@
+[0] "exercise1 4/4\r\nr1\r\nr4 tt4 r4 4\r\nr1\r\nr1\r\n"
+[1] "exercise2 4/4\r\nr2 tt4 r4\r\nr4 tt4 r4 tt4\r\ntt4 r4 tt4 r4\r\nr1\r\n"

data/spec/fixtures/exercises.txt

@@ -0,0 +1,11 @@
+exercise1 4/4
+r1
+r4 tt4 r4 4
+r1
+r1
+
+exercise2 4/4
+r2 tt4 r4
+r4 tt4 r4 tt4
+tt4 r4 tt4 r4
+r1

data/spec/fixtures/exercises_with_blank_lines.txt

@@ -0,0 +1,13 @@
+exercise1 4/4
+r1
+r4 tt4 r4 4
+r1
+r1
+
+
+exercise2 4/4
+r2 tt4 r4
+r4 tt4 r4 tt4
+tt4 r4 tt4 r4
+r1
+

data/spec/kadryll_spec.rb

@@ -0,0 +1,71 @@
+require 'kadryll'
+require 'timecop'
+
+describe Kadryll do
+
+  describe "output dir" do
+    after(:each) do
+      Kadryll.configure do |c|
+        c.output_dir = nil
+      end
+    end
+
+    it "is drills/ by default" do
+      Kadryll.output_dir.should eq('drills/scores/')
+    end
+
+    it "handles trailing slashes" do
+      Kadryll.configure do |c|
+        c.output_dir = 'other/dir'
+      end
+
+      Kadryll.output_dir.should eq('other/dir/')
+    end
+  end
+
+  describe "input dir" do
+    after(:each) do
+      Kadryll.configure do |c|
+        c.input_dir = nil
+      end
+    end
+
+    it "is drills/data/ by default" do
+      Kadryll.input_dir.should eq('drills/data/')
+    end
+
+    it "can be overridden" do
+      Kadryll.configure do |c|
+        c.input_dir = 'other/dir'
+      end
+
+      Kadryll.input_dir.should eq('other/dir/')
+    end
+  end
+
+  describe "copyright" do
+    before(:each) do
+      Timecop.travel(Time.utc(2012, 2, 7, 18, 28, 18))
+    end
+
+    after(:each) do
+      Kadryll.configure do |c|
+        c.copyright = nil
+      end
+      Timecop.return
+    end
+
+    it "defaults to kadryll" do
+      Kadryll.copyright.should eq('Copyright 2012 YourName')
+    end
+
+    it "can be overridden" do
+      Kadryll.configure do |c|
+        c.copyright = 'ALL NOTES ARE BELONG TO ME'
+      end
+      Kadryll.copyright.should eq('ALL NOTES ARE BELONG TO ME')
+    end
+
+  end
+
+end

data/spec/shorthand_reader_spec.rb

@@ -0,0 +1,20 @@
+require 'approvals'
+require 'kadryll/shorthand_reader'
+describe Kadryll::ShorthandReader do
+  before(:all) do
+    Approvals.configure do |c|
+      c.approvals_path = 'spec/fixtures/approvals/'
+    end
+  end
+
+  it "breaks an input file into exercise templates" do
+    exercises = Kadryll::ShorthandReader.read("spec/fixtures/exercises.txt")
+    Approvals.verify(exercises, :name => 'exercises from file')
+  end
+
+  it "ignores double blank lines" do
+    exercises = Kadryll::ShorthandReader.read("spec/fixtures/exercises_with_blank_lines.txt")
+    Approvals.verify(exercises, :name => 'exercises with blanks from file')
+  end
+
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: kadryll
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Katrina Owen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70323596785480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70323596785480
+- !ruby/object:Gem::Dependency
+  name: approvals
+  requirement: &70323596784080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70323596784080
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &70323596782100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70323596782100
+description: Score generator for drum independence drills.
+email:
+- katrina.owen@gmail.com
+executables:
+- kadryll
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- TODO
+- bin/kadryll
+- kadryll.gemspec
+- lib/kadryll.rb
+- lib/kadryll/cli.rb
+- lib/kadryll/drill.rb
+- lib/kadryll/shorthand_reader.rb
+- spec/drill_spec.rb
+- spec/fixtures/approvals/drill_generates_a_png.approved.txt
+- spec/fixtures/approvals/drill_generates_the_template.approved.txt
+- spec/fixtures/approvals/drill_uses_the_correct_command.approved.txt
+- spec/fixtures/approvals/exercises_from_file.approved.txt
+- spec/fixtures/approvals/exercises_with_blanks_from_file.approved.txt
+- spec/fixtures/exercises.txt
+- spec/fixtures/exercises_with_blank_lines.txt
+- spec/kadryll_spec.rb
+- spec/shorthand_reader_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: kadryll
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Score generator for drum independence drills.
+test_files:
+- spec/drill_spec.rb
+- spec/fixtures/approvals/drill_generates_a_png.approved.txt
+- spec/fixtures/approvals/drill_generates_the_template.approved.txt
+- spec/fixtures/approvals/drill_uses_the_correct_command.approved.txt
+- spec/fixtures/approvals/exercises_from_file.approved.txt
+- spec/fixtures/approvals/exercises_with_blanks_from_file.approved.txt
+- spec/fixtures/exercises.txt
+- spec/fixtures/exercises_with_blank_lines.txt
+- spec/kadryll_spec.rb
+- spec/shorthand_reader_spec.rb