lygre 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c100850289adec3dc56f49db675050c9363706e0
-  data.tar.gz: a47121a23251de440329e1866dbacb532dd07152
+  metadata.gz: b246c70e332e42827f7747ab0439d890b368b720
+  data.tar.gz: 6029592482f7d71440f9a5dd402715ad4f504f12
 SHA512:
-  metadata.gz: 38b9473ca607f631bd91e10138d5492bb5b72e4ecaceab71d70c13ee7bc8caa521e494f2b1f30889c81412e495dfdf1eae144539982b1e56af80315453fb9d10
-  data.tar.gz: f697b60699d01c32a0eeb2150351e4765357fbba409917a940b7c1c421a37bf90c4061c1b38a83661412ccf3b336054ca7f269f5fc2c6727cbd1da666b3ffeb9
+  metadata.gz: b6bb4e396985f00612b94be4e3b53bbdc4adfdaebd2f7a950e66824aa7d979d966008fb08eb69678e2850e3680352dc562052e7646d8d841f783a77242b53c81
+  data.tar.gz: 2fca20a9e491d4b5d33f87d95cdd1a6239a65b49ca797f0cb236dd435595da19112b813a8dc5adc84debebad70bbb8c49ce046a789cb7b6e84bb38dd99616020

data/lib/grely.rb

@@ -4,10 +4,7 @@
 gabcscore 
 gabcsemantics
 gabcpitchreader
+gabcparser
 lilypondconvertor
+musictheory
 }.each {|f| require_relative File.join('lygre', f)}
-
-# gabc parser
-require 'polyglot'
-require 'treetop'
-Treetop.load File.expand_path('../lib/lygre/gabcgrammar', File.dirname(__FILE__))

data/lib/lygre/gabcparser.rb

@@ -0,0 +1,4 @@
+# load treetop grammar, emit class GabcParser
+require 'polyglot'
+require 'treetop'
+Treetop.load File.expand_path('gabcgrammar', File.dirname(__FILE__))

data/lib/lygre/gabcpitchreader.rb

@@ -1,7 +1,5 @@
 # encoding: UTF-8
 
-require 'rb-music-theory'
-
 # responsible for converting the 'visual pitch' information
 # contained in gabc to absolute musical pitch
 class GabcPitchReader
@@ -55,18 +53,13 @@ class NoteFactory
       note = notesym[0]
       octaves = notesym[1..-1]
 
-      n = RBMusicTheory::Note.new note.upcase
       sign = 0
-      base_octave_shift = -1 # Note.new('C') returns c'=60, not c=48
+      octave = 0
       if octaves then
         sign = (octaves[0] == ',' ? -1 : 1)
-        octave_shift = (octaves.size * sign) + base_octave_shift
-      else
-        octave_shift = base_octave_shift
+        octave += (octaves.size * sign)
       end
-      n += octave_shift * RBMusicTheory::NoteInterval.octave.value # strangely, NoteInterval cannot be multiplied
-
-      return n
+      return MusicTheory::Note.new note.to_sym, octave
     end
 
     alias :create_note :create
@@ -78,57 +71,8 @@ class NoteFactory
     # #create translates lilypond pitch to Note and #lily_abs_pitch
     # does the reverse translation, so maybe just the class should be renamed
     def lily_abs_pitch(note)
-      octave_shifts = ''
-      octave_diff = note.value - create('c').value
-
-      octave_value = RBMusicTheory::NoteInterval.octave.value
-      octave_shift = octave_diff.abs / octave_value
-      if octave_diff < 0 and (octave_diff.abs % octave_value) > 0 then
-        octave_shift += 1
-      end
-
-      octave_signs = (octave_diff >= 0 ? "'" : ",") * octave_shift
-      note.name.downcase + octave_signs
-    end
-  end
-end
-
-# monkey-patch Note to add step arithmetics
-module RBMusicTheory
-
-  class Note
-
-    def diatonic_steps(steps, scale=nil)
-      if scale.nil? then
-        scale = self.class.new('C').major_scale
-      end
-
-      deg = self.degree_in(scale)
-
-      return scale.degree(deg + steps)
-    end
-
-    # note's degree in a scale
-    def degree_in(scale)
-      degree = scale.note_names.index(self.name)
-      if degree.nil? then
-        raise ArgumentError.new("#{name} is not a member of #{scale.note_names} scale")
-      end
-      degree += 1 # degrees start with 1
-
-      in_base_octave = scale.degree(degree)
-      octave_steps = scale.note_names.size
-      octave_value = RBMusicTheory::NoteInterval.octave.value
-
-      value_difference = self.value - in_base_octave.value
-      octave_difference = value_difference.abs / octave_value
-      if value_difference < 0 then
-        octave_difference *= -1
-      end
-
-      degree += octave_difference * octave_steps
-
-      return degree
+      octave_signs = (note.octave >= 0 ? "'" : ",") * note.octave.abs
+      note.pitch.to_s + octave_signs
     end
   end
 end

data/lib/lygre/gabcscore.rb

@@ -15,6 +15,8 @@ class Immutable
 
     freeze
   end
+
+  attr_accessor :text_value
 end
 
 # clean and easy to use music data produced by

data/lib/lygre/gabcsemantics.rb

@@ -100,16 +100,19 @@ module Gabc
         if ele.is_a? NoteNode then
           arr << GabcNote.new do |n|
             n.pitch = ele.note_pitch.text_value.downcase.to_sym
+            n.text_value = ele.text_value
           end
         elsif ele.is_a? DivisioNode then
           arr << GabcDivisio.new do |d|
             d.type = ele.text_value
+            d.text_value = ele.text_value
           end
         elsif ele.is_a? ClefNode then
           arr << GabcClef.new do |c|
             c.pitch = ele.clef_symbol.text_value.to_sym
             c.bemol = ele.bemol.text_value == 'b'
             c.line = ele.line_number.text_value.to_i
+            c.text_value = ele.text_value
           end
         else
           collect_notes ele, arr

data/lib/lygre/musictheory.rb

@@ -0,0 +1,44 @@
+# Simple diatonic music theory necessary for parsing of Gregorian chant scores
+module MusicTheory
+  PITCHES = [:c, :d, :e, :f, :g, :a, :b]
+  VALUES = [0, 2, 4, 5, 7, 9, 11]
+
+  class Note
+    def initialize(pitch=:c, octave=1)
+      @pitch = pitch
+      @pitch_numeric = PITCHES.index @pitch
+      @octave = octave
+
+      if @pitch_numeric.nil?
+        raise ArgumentError.new("Invalid pitch #{pitch.inspect}")
+      end
+    end
+
+    attr_reader :pitch, :octave
+
+    def diatonic_steps(steps)
+      base_steps = steps % PITCHES.size
+      octaves = steps / PITCHES.size
+      new_step = @pitch_numeric + base_steps
+      if new_step >= PITCHES.size
+        new_step -= PITCHES.size
+        octaves += 1
+      end
+      new_pitch = PITCHES[new_step]
+      self.class.new(new_pitch, @octave + octaves)
+    end
+
+    def value
+      (@octave + 4) * 12 + VALUES[@pitch_numeric]
+    end
+
+    def ==(other)
+      other.pitch == @pitch &&
+        other.octave == @octave
+    end
+
+    def hash
+      [@pitch, @octave].hash
+    end
+  end
+end

data/spec/gabcpitchreader_spec.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+require 'spec_helper'
 
 describe GabcPitchReader do
 
@@ -70,9 +71,9 @@ describe NoteFactory do
   end
 
   describe '.lily_abs_pitch' do
-    it 'operates exactly reverse to .create' do
+    describe 'operates exactly reverse to .create' do
       %w{ c d g c' f' a' b' g'' d''' c, c,, c,,, d, e, e,, b, }.each do |lypitch|
-        @f.lily_abs_pitch(@f[lypitch]).should eq lypitch
+        it { @f.lily_abs_pitch(@f[lypitch]).should eq lypitch }
       end
     end
   end
@@ -82,55 +83,3 @@ describe NoteFactory do
     it { @f["c''"].value.should eq 72 }
   end
 end
-
-describe 'monkey-patched RBMusicTheory' do
-
-  before :each do
-    @f = NoteFactory
-    @s = @f["c''"].major_scale
-  end
-
-  describe 'Note#diatonic_steps' do
-    it { @f["c'"].diatonic_steps(1).should eq @f["d'"] }
-    it { @f["c'"].diatonic_steps(0).should eq @f["c'"] }
-    it { @f["c'"].diatonic_steps(7).should eq @f["c''"] }
-    it { @f["c'"].diatonic_steps(8).should eq @f["d''"] }
-    it { @f["c'"].diatonic_steps(-2).should eq @f["a"] }
-    it { @f["c''"].diatonic_steps(-9).should eq @f["a"] }
-    it { @f["c'''"].diatonic_steps(-9).should eq @f["a'"] }
-    it { @f["c,"].diatonic_steps(-9).should eq @f["a,,,"] }
-    it { @f["c,"].diatonic_steps(-10).should eq @f["g,,,"] }
-  end
-
-  describe 'Note#degree_in' do
-    it { @f["c''"].degree_in(@s).should eq 1 }
-    it { @f["d''"].degree_in(@s).should eq 2 }
-
-    it { @f["c'''"].degree_in(@s).should eq 8 }
-    it { @f["e'''"].degree_in(@s).should eq 10 }
-    it { @f["b'"].degree_in(@s).should eq 0 }
-    it { @f["a'"].degree_in(@s).should eq -1 }
-    it { @f["a"].degree_in(@s).should eq -8 }
-
-    it 'behaves consistently with Scale#degree' do
-      [2, 8, -1, -12].each do |deg|
-        @s.degree(deg).degree_in(@s).should eq deg
-      end
-    end
-  end
-
-  describe 'Scale#degree' do
-    describe 'for positive degrees it behaves as expected' do
-      it { @s.degree(1).should eq @f["c''"] }
-      it { @s.degree(2).should eq @f["d''"] }
-      it { @s.degree(8).should eq @f["c'''"] }
-    end
-
-    describe 'and then there is zero and negative numbers' do
-      it { @s.degree(0).should eq @f["b'"] }
-      it { @s.degree(-1).should eq @f["a'"] }
-      it { @s.degree(-8).should eq @f["a"] }
-      it { @s.degree(-15).should eq @f["a,"] }
-    end
-  end
-end

data/spec/musictheory_spec.rb

@@ -0,0 +1,44 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe MusicTheory do
+  describe MusicTheory::Note do
+    let(:c1) { described_class.new(:c) }
+    let(:c2) { described_class.new(:c, 2) }
+
+    describe '#diatonic_steps' do
+      it 'step in the base octave' do
+        c1.diatonic_steps(1).should eq described_class.new(:d)
+      end
+
+      it 'octave step' do
+        c1.diatonic_steps(7).should eq c2
+      end
+
+      it 'single step to the next octave' do
+        b = described_class.new(:b)
+        b.diatonic_steps(1).should eq c2
+      end
+
+      it 'single step to the previous octave' do
+        c1.diatonic_steps(-1).should eq described_class.new(:b, 0)
+      end
+
+      it 'preserve octave' do
+        c = described_class.new(:c, -1)
+        c.diatonic_steps(1).should eq described_class.new(:d, -1)
+      end
+    end
+
+    describe '#value' do
+      it { c1.value.should eq 60 }
+      it { described_class.new(:d).value.should eq 62 }
+      it { described_class.new(:e).value.should eq 64 }
+      it { described_class.new(:f).value.should eq 65 }
+      it { described_class.new(:g).value.should eq 67 }
+      it { described_class.new(:a).value.should eq 69 }
+      it { described_class.new(:b).value.should eq 71 }
+      it { described_class.new(:c, 2).value.should eq 72 }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -15,17 +15,8 @@ RSpec.configure do |config|
   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(
@@ -34,3 +25,6 @@ def load_example(fname)
                             )
            )
 end
+
+# load the tested code
+require_relative '../lib/grely'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lygre
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jakub Pavlík
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-02 00:00:00.000000000 Z
+date: 2016-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: treetop
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !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
@@ -74,10 +60,6 @@ description: |
   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
@@ -87,16 +69,19 @@ files:
 - bin/grely.rb
 - lib/grely.rb
 - lib/lygre/gabcgrammar.treetop
+- lib/lygre/gabcparser.rb
 - lib/lygre/gabcpitchreader.rb
 - lib/lygre/gabcscore.rb
 - lib/lygre/gabcsemantics.rb
 - lib/lygre/lilypondconvertor.rb
+- lib/lygre/musictheory.rb
 - spec/gabcgrammar_spec.rb
 - spec/gabcparser_spec.rb
 - spec/gabcpitchreader_spec.rb
 - spec/gabcscore_spec.rb
 - spec/lilypondconvertor_spec.rb
 - spec/matchers.rb
+- spec/musictheory_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/igneus/lygre
 licenses:
@@ -119,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: converts music formats gabc -> lilypond