mikowitz-webern 0.1.0

data/History.txt

@@ -0,0 +1,3 @@
+2008-11-16
+
+Development started. Base dev files created.

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/webern
+lib/webern.rb
+lib/webern/lilypond_builder.rb
+lib/webern/matrix.rb
+lib/webern/version.rb
+lib/webern/webern.rb
+test/test_webern.rb
+webern.gemspec

data/README.txt

@@ -0,0 +1,64 @@
+= Webern
+
+http://github.com/mikowitz/webern
+
+== DESCRIPTION:
+
+Taking a 12-tone row generated from user input (see SYNOPSIS below), Webern will create the full matrix based upon this row, and then output all 48 possible rows created by that matrix out to a .pdf file using the LilyPond notational language.
+
+
+Rake Tasks Provided:
+
+* clear_ly_files			- Removes rows.ly, rows.ps, and rows.pdf
+*	update_lib					- Updates your lib/project_name.rb file to include all files in your lib/project_name/ folder
+* update_manifest			- Updates the gems Manifest.txt file to include any added files
+
+== FEATURES/PROBLEMS:
+
+* Not yet packaged as an installable gem. Coming soon, though. In the meantime, see the INSTALL section below.
+
+== SYNOPSIS:
+
+Webern can accept three different types of input.
+
+* A full 12 tone row:
+	$ webern 9 1 4 7 8 2 0 10 5 6 11 3
+	
+* An incomplete row, in which case the missing numbers will be added sequentially following what you have provided. See Webern::Webern.finish_partial_row:
+	$ webern 0 6 10 9 4 7 (1 2 3 5 8 11 will be added by Webern)
+	
+* A string, which will be converted to a 12-tone row. See Webern::Webern.make_row_from_string:
+	$ webern michael berkowitz
+	
+== REQUIREMENTS:
+
+* No other gems, but you do need lilypond (http://lilypond.org/web/) to generate the .pdf file.
+
+== INSTALL:
+
+* Not packaged as a gem yet. Run rake install_gem from project root to install as a gem on your computer.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+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/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'hoe'
+require 'fileutils'
+require File.dirname(__FILE__) + '/lib/webern.rb'
+
+PKG_NAME = 'webern'
+PKG_VER = Webern::Version::STRING
+
+Hoe.new('webern', Webern::Version::STRING) do |p|
+  p.name = PKG_NAME
+  p.version = PKG_VER
+  p.developer('Michael Berkowitz', 'michael.berkowitz@gmail.com')
+  p.email = 'michael.berkowitz@gmail.com'
+  p.author = 'Michael Berkowitz'
+  p.description = %q{ Taking a 12-tone row generated from user input, Webern will create the full matrix based upon this row, and then output all 48 possible rows created by that matrix out to a .pdf file using the LilyPond notational language. }
+end      
+
+desc "Updates Manifest.txt"
+task :update_manifest do
+  files = Dir.glob('**/*') - ["bin", "lib", "lib/webern", "test"]
+  puts "Cleaning gem. Removing extraneous pkg and doc files that should not be included in your Manifest.txt file."
+  `rake clean`
+  File.open('Manifest.txt', 'w') do |f|
+    puts "Updating Manifest.txt. Re-run this task as you add files to your gem."
+    files.sort.each do |file|
+      puts "Adding #{file} to Manifest.txt"
+      f << file << "\n"
+    end
+  end
+end      
+
+desc "Updates lib/webern.rb to include all files contained in lib/webern/"
+task :update_lib do
+  files = Dir.glob('lib/webern/*.rb')
+  File.open('lib/webern.rb', 'w') do |f|
+    files.each do |file|
+      f << "require File.dirname(__FILE__) + '#{file[3..-1]}'\n"
+    end
+  end
+end
+
+desc "Removes rows.ly, rows.pdf, rows.ps"
+task :clear_ly_files do
+  Dir.glob('rows.*').each do |file|
+    rm file
+  end
+end

data/bin/webern

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# webern       
+# created by Michael Berkowitz
+
+require File.dirname(__FILE__) + '/../lib/webern'
+
+Webern::Webern.new(*ARGV)
+puts "rows.ly generated" unless !File.exists?('rows.ly')
+print "Path to lilypond binary: "
+lilypond_path = STDIN.gets.chomp
+`#{lilypond_path} rows.ly`

data/lib/webern.rb

@@ -0,0 +1,4 @@
+require File.dirname(__FILE__) + '/webern/lilypond_builder.rb'
+require File.dirname(__FILE__) + '/webern/matrix.rb'
+require File.dirname(__FILE__) + '/webern/version.rb'
+require File.dirname(__FILE__) + '/webern/webern.rb'

data/lib/webern/lilypond_builder.rb

@@ -0,0 +1,74 @@
+require 'fileutils'
+
+module Webern
+  class LilypondBuilder
+    include FileUtils
+
+    NOTES = {
+      0 => "c",
+      1 => "cs",
+      2 => "d",
+      3 => "ef",
+      4 => "e",
+      5 => "f",
+      6 => "fs",
+      7 => "g",
+      8 => "af",
+      9 => "a",
+      10 => "bf",
+      11 => "b"
+    }
+    
+    LILYPOND_PREAMBLE = <<-LILYPOND
+\\version "2.11.57"
+\\include "english.ly"
+#(set-global-staff-size 13)
+
+rows = {
+  \\override Score.TimeSignature #'stencil = ##f
+  \\time 12/4
+    LILYPOND
+    
+    LILYPOND_POSTAMBLE = <<-LILYPOND
+}
+
+\\book {
+  \\score {
+    <<
+    \\new Staff \\rows
+    >>
+  }
+}
+    LILYPOND
+    
+    attr_reader :matrix # An instance of Webern::Matrix
+    
+    def initialize(matrix)
+      @matrix = matrix
+      build_lilypond_file
+    end
+    
+    # Converts an array of rows into vaild LilyPond code.
+    def build_rows(row_type)
+      str = ''
+      abbrev = row_type.scan(/^[a-z]|_[a-z]/).join("")
+      @matrix.send(row_type).sort { |a, b| a[0] <=> b[0] }.each do |row|
+        str += "#{NOTES[row[0]]}'^\\markup{#{abbrev}#{row[0]}} "
+        str += row[1..-1].map { |n| NOTES[n] }.join("' ") + "'\n"
+      end
+      str += "\\break\n"
+      str
+    end
+
+    # Generates a valid LilyPond file from the Webern::Matrix object passed into the LilypondBuilder
+    def build_lilypond_file
+      File.open('rows.ly', 'w') do |f|
+        f << LILYPOND_PREAMBLE
+        ['primes', 'retrogrades', 'inversions', 'retrograde_inversions'].each do |row_type|
+          f << build_rows(row_type)
+        end
+        f << LILYPOND_POSTAMBLE
+      end
+    end
+  end
+end  

data/lib/webern/matrix.rb

@@ -0,0 +1,37 @@
+module Webern
+  class Matrix
+    attr_reader :primes, :retrogrades, :inversions, :retrograde_inversions
+    def initialize p0
+      create_primes(p0)
+      create_retrogrades
+      create_inversions
+      create_retrograde_inversions
+    end
+    
+    def create_primes(p0)
+      @primes = []
+      p0.each do |offset|
+        @primes << p0.map { |c| (12 - offset + c) % 12 }
+      end
+    end
+    
+    def create_retrogrades
+      @retrogrades = @primes.map { |row| row.reverse }
+    end
+    
+    def create_inversions
+      @inversions = []
+      (0...12).each do |i|
+        i_row = []
+        @primes.each do |row|
+          i_row << row[i]
+        end
+        @inversions << i_row
+      end
+    end
+    
+    def create_retrograde_inversions
+      @retrograde_inversions = @inversions.map { |row| row.reverse }
+    end
+  end
+end

data/lib/webern/version.rb

@@ -0,0 +1,9 @@
+module Webern
+  module Version #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY = 0
+    
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/webern/webern.rb

@@ -0,0 +1,41 @@
+module Webern
+  class Webern
+    attr_reader :row
+    
+    # Takes either a full or partial row of integers 0-11 or a string that can be
+    # converted into a row of integers
+    def initialize(*args)
+      begin
+        if args.map { |c| c.to_i }.sort == (0...12).to_a
+          row = args.map { |c| c.to_i }
+        elsif args.map { |c| c.to_i }.uniq == [0]
+          row = make_row_from_string args.join("")
+        else
+          row = finish_partial_row args
+        end
+        offset = row.first
+        @row = row.map { |c| (c + 12 - offset) % 12 }
+        m = Matrix.new(@row)
+        LilypondBuilder.new(m)
+      end
+    end
+
+    # Creates a 12-tone row from a string provided as an original argument.
+    def make_row_from_string(str)
+      working_row, row = str.downcase.gsub(/[^a-z]/, '').split('') + ('a'..'z').to_a, []
+      while row.size < 12
+        (row << working_row.shift).uniq!
+      end
+      alph_row = row.dup.sort
+      row.map { |c| alph_row.index(c) }
+    end
+    
+    # Completes a 12-tone row if only a partial row was provided
+    # as the original argument.
+    def finish_partial_row(row)
+      working_row = row.map { |c| c.to_i }
+      missing = (0...12).to_a - working_row
+      working_row + missing
+    end
+  end
+end

data/test/test_webern.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/../lib/webern.rb'
+require 'test/unit'
+
+class WebernTest < Test::Unit::TestCase
+  def test_create_row
+    # Test full row beginning with 0
+    w = Webern::Webern.new("0", "2", "8", "1", "3", "11", "10", "7", "4", "6", "9", "5")
+    assert_equal [0,2,8,1,3,11,10,7,4,6,9,5], w.row
+    
+    # Test full row not starting with 0
+    w = Webern::Webern.new("1", "2", "4", "5", "8", "10", "11", "6", "0", "3", "7", "9")
+    assert_equal [0,1,3,4,7,9,10,5,11,2,6,8], w.row
+    
+    # Test starting string that provides 12 unique characters
+    w = Webern::Webern.new("Michael", "Berkowitz")
+    assert_equal [0,9,6,8,4,7,11,5,2,10,1,3], w.row
+    
+    # Test starting string that does not provide 12 unique characters
+    w = Webern::Webern.new('Erica', 'Smith')
+    assert_equal [0,5,3,10,8,6,4,7,2,9,11,1], w.row
+    
+    # Test incomplete row beginning with 0
+    w = Webern::Webern.new("0", "2", "4", "6", "8", "10")
+    assert_equal [0,2,4,6,8,10,1,3,5,7,9,11], w.row
+  end
+end

data/webern.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name = "webern"
+  s.version = "0.1.0"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ['Michael Berkowitz']
+  s.date = "2008-11-16"
+  s.description = %q{ Taking a 12-tone row generated from user input, Webern will create the full matrix based upon this row, and then output all 48 possible rows created by that matrix out to a .pdf file using the LilyPond notational language. }
+  s.email = 'michael.berkowitz@gmail.com'
+  s.executables = ['webern']
+  s.extra_rdoc_files = ['History.txt', 'Manifest.txt', 'README.txt']
+  s.files = ["History.txt", "Manifest.txt", "README.txt", "Rakefile", "bin/webern", "lib/webern.rb", "lib/webern/lilypond_builder.rb", "lib/webern/matrix.rb", "lib/webern/version.rb", "lib/webern/webern.rb", "test/test_webern.rb", "webern.gemspec"]
+  s.has_rdoc = true
+  s.require_paths = ['lib']
+  s.summary = s.description
+  s.test_files = ["test/test_webern.rb"]
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: mikowitz-webern
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Berkowitz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-16 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Taking a 12-tone row generated from user input, Webern will create the full matrix based upon this row, and then output all 48 possible rows created by that matrix out to a .pdf file using the LilyPond notational language.
+email: michael.berkowitz@gmail.com
+executables: 
+- webern
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/webern
+- lib/webern.rb
+- lib/webern/lilypond_builder.rb
+- lib/webern/matrix.rb
+- lib/webern/version.rb
+- lib/webern/webern.rb
+- test/test_webern.rb
+- webern.gemspec
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Taking a 12-tone row generated from user input, Webern will create the full matrix based upon this row, and then output all 48 possible rows created by that matrix out to a .pdf file using the LilyPond notational language.
+test_files: 
+- test/test_webern.rb