webern 0.2.0

data/.document

@@ -0,0 +1,4 @@
+lib/**/*.rb
+-
+CHANGELOG.md
+LICENSE

data/.gitignore

@@ -0,0 +1,2 @@
+*.ly
+*.pdf

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.2.0 : 04/22/10
+
+* Reimplementation of code.

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gem "spec"
+gem "yard"

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Michael Berkowitz
+
+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,50 @@
+# webern
+
+### current version: 0.2.0
+
+[http://github.com/mikowitz/webern][webern]
+
+## 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 to a .pdf file using the LilyPond notational 
+language.
+
+## Installation
+
+Install the gemcutter gem
+
+    ~$ gem install gemcutter
+
+Add gemcutter.org to your gem remote sources
+
+    ~$ gem tumble
+
+Download and install this gem
+
+    ~$ gem install crayon
+
+## Requirements
+
+No other gems are required, but you do need [LilyPond][lilypond] to generate the .pdf file.
+
+## Usage
+
+`Webern` can accept a full 12-tone row, a partial 12-tone row, or a list of strings which will be parsed into a numeric row:
+
+    ~$ webern 9 1 4 7 8 2 0 10 5 6 11 3
+    ~$ webern 0 6 10 9 4 7
+    ~$ webern michael berkowitz
+
+In the instance where a partial row is given, or the strings given do not provide 12 distinct letters, `Webern` will complete the row with the missing numbers in ascending order. In the example above, `Webern` would complete the row like this: 
+
+    [0 6 10 9 4 7] #=> [0 6 10 9 4 7 1 2 3 5 8 11]
+
+`Webern` will take the completed row and create the full 12-tone matrix, then generate a LilyPond file containing all 48 possible rows contained in the matrix, and output them to a .pdf file.
+
+## Copyright
+
+Copyright (c) 2010 Michael Berkowitz. See LICENSE for details.
+
+[webern]: http://github.com/mikowitz/webern "Webern repository"
+[lilypond]: http://lilypond.org "LilyPond"

data/Rakefile

@@ -0,0 +1,85 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "webern"
+    gem.summary = %Q{Creates a .pdf reference sheet for all 12-tone rows generated from a given prime row's matrix.}
+    gem.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 to a .pdf file using the LilyPond notational language.}
+    gem.email = "michael.berkowitz@gmail.com"
+    gem.homepage = "http://github.com/mikowitz/webern"
+    gem.authors = ["Michael Berkowitz"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << "lib" << "spec"
+  spec.spec_opts = ["-cfs"]
+  spec.spec_files = FileList["spec/**/*_spec.rb"]
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << "lib" << "spec"
+  spec.pattern = "spec/**/*_spec.rb"
+  spec.rcov = true
+end
+
+task :test => :check_dependencies
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.options = %w{--no-private -mmarkdown}
+  end
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+
+begin
+  require 'hanna/rdoctask'
+  desc "generate hanna documentation"
+  Rake::RDocTask.new(:hanna) do |t|
+    t.rdoc_files.include("README.md", "License", "lib/**/*.rb")
+    t.main = "README.md"
+    t.rdoc_dir = "hanna"
+  end
+rescue LoadError
+  task :hanna do
+    abort "hanna is not available. In order to run this task, you must: sudo gem install hanna"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/bin/webern

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/webern'
+require 'optparse'
+
+if ARGV.is_all_integers?
+  Webern.new(*ARGV.map(&:to_i))
+else
+  Webern.new(*ARGV)
+end

data/lib/core_ext.rb

@@ -0,0 +1,11 @@
+class Array
+  def is_all_integers?
+    self.all?{|element| element.to_i.to_s == element }
+  rescue Exception
+    false
+  end
+
+  def generate_row_from_letters
+    self.map{|element| self.sort.index(element) }
+  end
+end

data/lib/webern/lilypond_builder.rb

@@ -0,0 +1,62 @@
+module Webern
+  module LilypondBuilder
+    NOTES = %w{c cs d ef e f fs g af a bf b}
+
+    class << self
+      attr_writer :zero_note
+    end
+
+    def self.current_lilypond_version
+      `lilypond --version`.match(/\d+\.\d+\.\d+/)[0]
+    end
+    
+    def self.zero_note
+      @zero_note ||= "c"
+    end
+
+    def self.convert_row(row)
+      row.map{|note| NOTES[(note + NOTES.index(self.zero_note)) % 12] }.join(" ")
+    end
+
+    def self.generate_file(matrix)
+      file = [PREAMBLE_BLOCK, "\n"]
+      file << STAFF_BLOCK
+      [:primes, :retrogrades, :inversions, :retrograde_inversions].each do |method|
+        abbrev = method.to_s.scan(/^\w|_\w/).join("").gsub(/_/, "").upcase
+        matrix.send(method).each do |row|
+          first = row[0]
+          row = self.convert_row(row)
+          row = row.sub(" ", "^\\markup{#{abbrev}#{first}} ")
+          file << "  #{row}"
+        end
+      end
+      file << "\}" << "\n" << SCORE_BLOCK
+      File.open("matrix.ly", "w") do |f|
+        f << file.join("\n")
+      end
+      # TODO: This unless seems a bit messy
+      system("lilypond matrix.ly") unless $0 =~ /spec|rcov/
+    end
+
+    PREAMBLE_BLOCK = <<-STR
+\\version \"#{self.current_lilypond_version}\"
+\\include \"english.ly\"
+#(set-global-staff-size 13)
+    STR
+
+    STAFF_BLOCK = <<-STR
+rows = {
+  \\override Score.TimeSignature #'stencil = ##f
+  \\clef bass
+  \\time 12/4
+    STR
+
+    SCORE_BLOCK = <<-STR
+\\score {
+  <<
+    \\new Staff \\rows
+  >>
+}
+    STR
+  end
+end

data/lib/webern/matrix.rb

@@ -0,0 +1,26 @@
+module Webern
+  class Matrix
+    attr_accessor :prime_row
+    BASIC_ROW = Array(0..11)
+
+    def initialize(row)
+      @prime_row = row
+    end
+
+    def primes
+      BASIC_ROW.map{|note| @prime_row.transpose(note) }
+    end
+
+    def inversions
+      BASIC_ROW.map{|note| @prime_row.transpose(note).inversion }
+    end
+
+    def retrogrades
+      BASIC_ROW.map{|note| @prime_row.transpose(note).retrograde }
+    end
+
+    def retrograde_inversions
+      BASIC_ROW.map{|note| @prime_row.transpose(note).retrograde_inversion }
+    end
+  end
+end

data/lib/webern/row.rb

@@ -0,0 +1,53 @@
+module Webern
+  class Row < Array
+    def initialize(*_row)
+      @row = _row
+      check_for_valid_row(@row)
+      @row = process_strings if @row.any?{|element| element.is_a?(String) }
+      @row = complete_row[0..11]
+      replace @row
+    end
+
+    def retrograde; Row.new *reverse; end
+
+    def inversion
+      Row.new *map{|note| (12 - note) % 12 }
+    end
+
+    def retrograde_inversion
+      Row.new *inversion.retrograde
+    end
+
+    def transpose(interval)
+      Row.new *map{|note| (note + interval) % 12 }
+    end
+
+    def complete_row
+      return @row if @row.size == 12
+      _remainder = Array(0..11) - @row
+      [@row, _remainder].flatten
+    end
+
+    def process_strings
+      full_string = @row.join("").split("")
+      _letters = full_string.uniq[0..11]
+      _letters.generate_row_from_letters
+    end
+
+    def check_for_valid_row(elements)
+      raise InvalidRow unless row_is_valid_numbers? or row_is_strings?
+    end
+
+    def row_is_valid_numbers?
+      @row.all?{|element| element.is_a?(Fixnum) } and (@row - Array(0..11)).empty?
+    end
+
+    def row_is_strings?
+      @row.all?{|element| element.is_a?(String) }
+    end
+
+    def zero_row
+      transpose(12-self[0])
+    end
+  end
+end

data/lib/webern.rb

@@ -0,0 +1,19 @@
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.dirname(__FILE__) + "/webern"
+
+%w{ core_ext lilypond_builder matrix row }.each {|file| require file }
+
+module Webern
+  class << self
+    attr_accessor :prime_row
+  end
+
+  def Webern.new(*row_elements)
+    @prime_row = Row.new(*row_elements).zero_row
+    @m = Matrix.new(@prime_row)
+    LilypondBuilder.generate_file(@m)
+    self
+  end
+
+  InvalidRow = Class.new(Exception)
+end

data/spec/array_spec.rb

@@ -0,0 +1,22 @@
+describe "Array" do
+  describe "is_all_integers?" do
+    before do
+      @all_ints   = %w{0 1 2 3 4 5 6 7 8 9 10 11}
+      @no_ints    = %w{a b c d e f g h i j k}
+      @mixed      = %w{a 1 b 2 c 3 d 4 5 6 7}
+      @bad_input  = [{1 => 2}, [1,2,3], :"45"]
+    end
+    it "should return true when all elements are strings of integers" do
+      @all_ints.is_all_integers?.should be_true
+    end
+    it "should return false when no elements are strings of integers" do
+      @no_ints.is_all_integers?.should_not be_true
+    end
+    it "should return false when only some elements are strings of integers" do
+      @mixed.is_all_integers?.should_not be_true
+    end
+    it "should return false when some elements do not have a :to_i method" do
+      @bad_input.is_all_integers?.should_not be_true
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,5 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'webern'

data/spec/lilypond_builder_spec.rb

@@ -0,0 +1,40 @@
+if system("lilypond --version")
+  describe "LilypondBuilder" do
+    it "should find the current lilypond version" do
+      Webern::LilypondBuilder.current_lilypond_version.should =~ /\d+\.\d+\.\d+/
+    end
+    it "should, by default, have 0 == c" do
+      Webern::LilypondBuilder.zero_note = "c"
+    end
+    describe "converting rows into lilypond" do
+      before { @row = Webern::Row.new(0,1,2,3,4,5,6,7,8,9,10,11) }
+      it "should be correctly converted by default to 'c cs d ef e f fs g af a bf b'" do
+        Webern::LilypondBuilder.convert_row(@row).should == "c cs d ef e f fs g af a bf b"
+      end
+      describe "when the zero_note is shifted" do
+        before { Webern::LilypondBuilder.zero_note = "d" }
+        it "should correct convert the chromatic scale to 'd ef e f fs g af a bf b c cs'" do
+          Webern::LilypondBuilder.convert_row(@row).should == "d ef e f fs g af a bf b c cs"
+        end
+      end
+    end
+    describe "generating lilypond file" do
+      before do
+        @row = Webern::Row.new(*Array(0..11))
+        @matrix = Webern::Matrix.new(@row)
+        @file_path = File.join(File.dirname(__FILE__), "..", "matrix.ly")
+        puts Webern::LilypondBuilder.generate_file(@matrix)
+      end
+      after do
+        File.delete(@file_path) if File.exists?(@file_path)
+      end
+      it "should create the file" do
+        File.exists?(@file_path).should be_true
+      end
+    end
+  end
+else
+  describe "LilypondBuilder" do
+    it "needs Lilypond to be installed. Check out http://www.lilypond.org"
+  end
+end

data/spec/matrix_spec.rb

@@ -0,0 +1,22 @@
+describe "Matrix" do
+  before { @m = Webern::Matrix.new(Webern::Row.new(0,1,2,3,4,5,6,7,8,9,10,11)) }
+  it "should have the correct prime row" do
+    @m.prime_row.should == Webern::Row.new(*Array(0..11))
+  end
+  it "should have the correct primes" do
+    @m.primes[0].should == @m.prime_row
+    @m.primes[3].should == @m.prime_row.transpose(3)
+  end
+  it "should have the correct inversions" do
+    @m.inversions[0].should == @m.prime_row.inversion
+    @m.inversions[6].should == @m.prime_row.inversion.transpose(6)
+  end
+  it "should have the correct retrogrades" do
+    @m.retrogrades[0].should == @m.prime_row.retrograde
+    @m.retrogrades[8].should == @m.prime_row.retrograde.transpose(8)
+  end
+  it "should have the correct retrograde inversions" do
+    @m.retrograde_inversions[0].should == @m.prime_row.retrograde_inversion
+    @m.retrograde_inversions[1].should == @m.prime_row.retrograde_inversion.transpose(11)
+  end
+end

data/spec/row_spec.rb

@@ -0,0 +1,29 @@
+describe "Row" do
+  describe "a basic row" do
+    before { @row = Webern::Row.new(*Array(0..11)) }
+    it "should create the correct retrograde: [11,10,9,8,7,6,5,4,3,2,1,0]" do
+      @row.retrograde.should == Array(0..11).reverse
+    end
+    it "should create the correct inversion: [0,11,10,9,8,7,6,5,4,3,2,1]" do
+      @row.inversion.should == [0,11,10,9,8,7,6,5,4,3,2,1]
+    end
+    it "should create the correct retrograde inversion: [1,2,3,4,5,6,7,8,9,10,11,0]" do
+      @row.retrograde_inversion.should == [1,2,3,4,5,6,7,8,9,10,11,0]
+    end
+    it "should transpose correctly" do
+      @row.transpose(2).should == [2,3,4,5,6,7,8,9,10,11,0,1]
+    end
+  end
+  describe "a more complex row" do
+    before { @row = Webern::Row.new(0,11,8,2,4,1,3,10,7,5,9,6) }
+    it "should create the correct retrograde: [6,9,5,7,10,3,1,4,2,8,11,0]" do
+      @row.retrograde.should == [6,9,5,7,10,3,1,4,2,8,11,0] 
+    end
+    it "should create the correct inversion: [0,1,4,10,8,11,9,2,5,7,3,6]" do
+      @row.inversion.should == [0,1,4,10,8,11,9,2,5,7,3,6] 
+    end
+    it "should create the correct retrograde inversion: [7,3,7,5,2,9,11,8,10,4,1,0]" do
+      @row.retrograde_inversion.should == [6,3,7,5,2,9,11,8,10,4,1,0]
+    end
+  end
+end

data/spec/webern_spec.rb

@@ -0,0 +1,55 @@
+require 'helper'
+
+def test_with_full_row(row, expected_result)
+  it "should return #{expected_result.inspect} for #{row.inspect}" do
+    Webern.new(*row).prime_row.should == expected_result
+  end
+end
+
+alias :test_with_incomplete_row :test_with_full_row
+alias :test_with_complete_string :test_with_full_row
+alias :test_with_incomplete_string :test_with_full_row
+
+describe "Webern" do
+  describe "parsing complete rows" do
+    # beginning with 0
+    test_with_full_row(Array(0..11), Array(0..11))
+    test_with_full_row([0,11,10,9,8,7,6,5,4,3,2,1], [0,11,10,9,8,7,6,5,4,3,2,1])
+    
+    # not beginning with 0
+    test_with_full_row([1,2,3,9,7,8,6,4,5,0,11,10], [0,1,2,8,6,7,5,3,4,11,10,9])
+    test_with_full_row(Array(0..11).reverse, [0,11,10,9,8,7,6,5,4,3,2,1])
+  end
+  
+  describe "parsing incomplete rows" do
+    # beginning with 0
+    test_with_incomplete_row(Array(0..6), Array(0..11))
+    test_with_incomplete_row([0,11,10,9,8,7], [0,11,10,9,8,7,1,2,3,4,5,6])
+    
+    # not beginning with 0
+    test_with_incomplete_row([1,2,3,9,7,8,6], [0,1,2,8,6,7,5,11,3,4,9,10])
+    test_with_incomplete_row([11,10,9,8,7,6], [0,11,10,9,8,7,1,2,3,4,5,6])
+  end
+
+  describe "parsing invalid rows" do
+    it "should raise an error for [1,2,3,4,5,6,7,8,9,10,11,12]" do
+      lambda { Webern.new(*Array(1..12)) }.should raise_error Webern::InvalidRow
+    end
+    it "should raise an error for [-1,0,1,2,3]" do
+      lambda { Webern.new(*Array(-1..3)) }.should raise_error Webern::InvalidRow
+    end
+    it "should raise an error for [0,1,2,3,4.5]" do
+      lambda { Webern.new(0,1,2,3,4.5) }.should raise_error Webern::InvalidRow
+    end
+  end
+
+  describe "parsing strings that provide a full row" do
+    test_with_complete_string(%w{a b c d e f g h i j k l}, Array(0..11))
+    test_with_complete_string(%w{michael rowe berkowitz}, [0,9,6,8,4,7,11,2,1,3,5,10])
+  end
+
+  describe "parsing strings that do not provide a full row" do
+    test_with_incomplete_string(%w{a b c d e f g}, Array(0..11))
+    test_with_incomplete_string(%w{michael rowe}, [0,10,7,9,6,8,11,2,1,3,4,5])
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: webern
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Michael Berkowitz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-22 00:00:00 -04:00
+default_executable: webern
+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 to a .pdf file using the LilyPond notational language.
+email: michael.berkowitz@gmail.com
+executables: 
+- webern
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bin/webern
+- lib/core_ext.rb
+- lib/webern.rb
+- lib/webern/lilypond_builder.rb
+- lib/webern/matrix.rb
+- lib/webern/row.rb
+- spec/array_spec.rb
+- spec/helper.rb
+- spec/lilypond_builder_spec.rb
+- spec/matrix_spec.rb
+- spec/row_spec.rb
+- spec/webern_spec.rb
+has_rdoc: true
+homepage: http://github.com/mikowitz/webern
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Creates a .pdf reference sheet for all 12-tone rows generated from a given prime row's matrix.
+test_files: 
+- spec/array_spec.rb
+- spec/helper.rb
+- spec/lilypond_builder_spec.rb
+- spec/matrix_spec.rb
+- spec/row_spec.rb
+- spec/webern_spec.rb