lygre 0.0.1

data/spec/lilypondconvertor_spec.rb

@@ -0,0 +1,144 @@
+# encoding: UTF-8
+
+require_relative 'spec_helper'
+
+def gabc2score(str)
+  return GabcParser.new.parse(str).create_score
+end
+
+describe LilypondConvertor do
+
+  before :each do
+    @c = LilypondConvertor.new(version: false)
+  end
+
+  describe '#convert_min' do
+
+    describe 'basics' do
+
+      it 'converts empty gabc to empty lilypond score' do
+        @c.convert_min(gabc2score("%%\n\n")).should eq '\score { }'
+      end
+
+      it 'converts one-note score' do
+        @c.convert_min(gabc2score("%%\n(c4) (j)")).should \
+          eq '\score { \absolute { c\'\' } \addlyrics { } }'
+      end
+
+      it 'converts two-note score' do
+        @c.convert_min(gabc2score("%%\n(c4) (j) (h)")).should \
+          eq '\score { \absolute { c\'\' a\' } \addlyrics { } }'
+      end
+
+      it 'converts two-note score with lyrics' do
+        @c.convert_min(gabc2score("%%\n(c4) ti(j)bi(h)")).should \
+          eq '\score { \absolute { c\'\' a\' } \addlyrics { ti -- bi } }'
+      end
+
+      it 'converts two-note score with lyrics - separate words' do
+        @c.convert_min(gabc2score("%%\n(c4) non(j) tu(h)")).should \
+          eq '\score { \absolute { c\'\' a\' } \addlyrics { non tu } }'
+      end
+
+      it 'converts two-note melisma' do
+        @c.convert_min(gabc2score("%%\n(c4) (jh)")).should \
+          eq '\score { \absolute { c\'\'( a\') } \addlyrics { } }'
+      end
+
+    end
+
+    describe 'clefs and their positions' do
+
+      it 'handles c4' do
+        @c.convert_min(gabc2score("%%\n(c4) (h) (d)")).should \
+          eq "\\score { \\absolute { a' d' } \\addlyrics { } }"
+      end
+
+      it 'handles c3' do
+        @c.convert_min(gabc2score("%%\n(c3) (h) (d)")).should \
+          eq "\\score { \\absolute { c'' f' } \\addlyrics { } }"
+      end
+
+      it 'handles c2' do
+        @c.convert_min(gabc2score("%%\n(c2) (h) (d)")).should \
+          eq "\\score { \\absolute { e'' a' } \\addlyrics { } }"
+      end
+
+      it 'handles c1' do
+        @c.convert_min(gabc2score("%%\n(c1) (h) (d)")).should \
+          eq "\\score { \\absolute { g'' c'' } \\addlyrics { } }"
+      end
+
+      it 'handles f3' do
+        @c.convert_min(gabc2score("%%\n(f3) (h) (d)")).should \
+          eq "\\score { \\absolute { f' b } \\addlyrics { } }"
+      end
+
+      it 'handles f2' do
+        @c.convert_min(gabc2score("%%\n(f2) (h) (d)")).should \
+          eq "\\score { \\absolute { a' d' } \\addlyrics { } }"
+      end
+    end
+
+    describe 'barlines' do
+
+      it 'translates : to \bar "|"' do
+        @c.convert_min(gabc2score("%%\n(c4) (j) (:)")).should \
+          eq "\\score { \\absolute { c'' \\bar \"|\" } \\addlyrics { } }"
+      end
+
+      it 'translates ; to \bar "|"' do
+        @c.convert_min(gabc2score("%%\n(c4) (j) (;)")).should \
+          eq "\\score { \\absolute { c'' \\bar \"|\" } \\addlyrics { } }"
+      end
+
+      it 'translates :: to \bar "||"' do
+        @c.convert_min(gabc2score("%%\n(c4) (j) (::)")).should \
+          eq "\\score { \\absolute { c'' \\bar \"||\" } \\addlyrics { } }"
+      end
+
+      it 'translates , to \bar "|"' do
+        @c.convert_min(gabc2score("%%\n(c4) (j) (,)")).should \
+          eq "\\score { \\absolute { c'' \\bar \"'\" } \\addlyrics { } }"
+      end
+    end
+
+    describe 'handles special cases of lyrics: ' do
+
+      it 'quotes syllable beginning with asterisk' do
+        @c.convert_min(gabc2score("%%\n(c4) *la(j)")).should \
+          eq "\\score { \\absolute { c'' } \\addlyrics { \"*la\" } }"
+      end
+
+      it 'handles lyrics under a divisio' do
+        @c.convert_min(gabc2score("%%\n(c4) Ps.(::)")).should \
+          eq "\\score { \\absolute { \\bar \"||\" } \\addlyrics { \\set stanza = \\markup{Ps.} } }"
+      end
+
+      it 'handles italic in plain lyrics' do
+        @c.convert_min(gabc2score("%%\n(c4) <i>heu</i>(j)")).should \
+          eq "\\score { \\absolute { c'' } \\addlyrics { \\markup{\\italic{heu}} } }"
+      end
+
+      it 'handles italic in lyrics under a divisio' do
+        @c.convert_min(gabc2score("%%\n(c4) <i>Ps.</i>(::)")).should \
+          eq "\\score { \\absolute { \\bar \"||\" } \\addlyrics { \\set stanza = \\markup{\\italic{Ps.}} } }"
+      end
+    end
+
+    describe 'optional features' do
+
+      it 'cadenza' do
+        LilypondConvertor.new(version: false, cadenza: true) \
+          .convert_min(gabc2score("%%\n(c4) (j)\n")).should \
+          eq '\score { \absolute { \cadenzaOn c\'\' } \addlyrics { } }'
+      end
+
+      it 'lily version' do
+        LilypondConvertor.new(version: true) \
+          .convert_min(gabc2score("%%\n(c4) (j)\n")).should \
+          eq '\version "2.16.0" \score { \absolute { c\'\' } \addlyrics { } }'
+      end
+    end
+  end
+end

data/spec/matchers.rb

@@ -0,0 +1,20 @@
+# custom matchers
+
+# Treetop parser's #parse returns SyntaxNode on success,
+# nil on fail.
+#
+# usage:
+# @parser.parse(text).should compile
+RSpec::Matchers.define :compile do
+  match do |actual|
+    GabcParser.new.parse(actual).kind_of? Treetop::Runtime::SyntaxNode
+  end
+end
+
+RSpec::Matchers.define :contain_a do |expected_kind|
+  match do |actual_collection|
+    found = false
+    actual_collection.each {|e| found = true if e.is_a? expected_kind }
+    found
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+require 'polyglot'
+require 'treetop'
+
+require_relative 'matchers'
+
+
+$: << '../lib'
+require 'grely'
+
+Treetop.load File.expand_path('../lib/lygre/gabcgrammar', File.dirname(__FILE__))
+
+def load_example(fname)
+  File.read(
+            File.expand_path(
+                             File.join('examples', fname), 
+                             File.dirname(__FILE__)
+                            )
+           )
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: lygre
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jakub Pavlík
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: polyglot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rb-music-theory
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: |
+  two of the free music typesetting applications most popular
+  among church musicians are LilyPond and Gregorio.
+
+  lygre gem currently provides tool *grely* converting Gregorio's
+  input format (gabc) to simple LilyPond input.
+
+  In future another tool for the other direction of conversion may be added.
+
+  As rb-music-theory is not at RubyGems, either install it before
+  attempting to 'gem install lygre', or get lygre's source from github
+  and install the dependencies by 'bundle install'.
+email: jkb.pavlik@gmail.com
+executables:
+- grely.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/grely.rb
+- lib/grely.rb
+- lib/lygre/lilypondconvertor.rb
+- lib/lygre/gabcsemantics.rb
+- lib/lygre/gabcpitchreader.rb
+- lib/lygre/gabcscore.rb
+- spec/gabcpitchreader_spec.rb
+- spec/spec_helper.rb
+- spec/gabcparser_spec.rb
+- spec/gabcgrammar_spec.rb
+- spec/gabcscore_spec.rb
+- spec/lilypondconvertor_spec.rb
+- spec/matchers.rb
+homepage: http://github.com/igneus/lygre
+licenses:
+- LGPL-3.0
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: converts music formats gabc -> lilypond
+test_files: []