guitar_pro_parser 0.0.1

data/spec/lib/guitar_pro_parser/io/input_stream_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe GuitarProParser::InputStream do
+  subject { GuitarProParser::InputStream.new(test_tab_path(5)) }
+  
+  describe '#read_byte' do
+    let!(:result) { subject.read_byte }
+
+    its(:offset) { should == 1}
+    specify { result.should == 24 }
+  end
+
+  describe '#read_boolean' do
+    let!(:result) { subject.read_boolean }
+
+    its(:offset) { should == 1}
+    specify { result.should == true }
+  end
+
+  describe '#read_integer' do
+    before (:each) do
+      subject.offset = 31
+    end
+
+    let!(:result) { subject.read_integer }
+    
+    its(:offset) { should == 35}
+    specify { result.should == 11 }
+  end
+
+  describe '#read_short_integer' do
+    before (:each) do
+      subject.offset = 357
+    end
+
+    let!(:result) { subject.read_short_integer }
+    
+    its(:offset) { should == 359}
+    specify { result.should == 511 }
+  end
+
+  shared_examples 'read_string and read_chunk' do
+    its(:offset) { should == 46 }
+    specify { result.should == 'Song Title' }
+  end
+
+  describe '#read_string' do
+    before (:each) do
+      subject.offset = 36
+    end
+
+    let!(:result) { subject.read_string 10 }
+  
+    it_behaves_like 'read_string and read_chunk'
+  end
+
+  describe '#read_bitmask' do
+    let!(:result) { subject.read_bitmask }
+
+    its(:offset) { should == 1}
+    specify { result.should == [false, false, false, true, true, false, false, false] }
+  end
+
+  describe '#read_chunk' do
+    before (:each) do
+      subject.offset = 31
+    end
+
+    let!(:result) { subject.read_chunk }
+  
+    it_behaves_like 'read_string and read_chunk'
+  end
+
+  describe '#increment_offset' do
+    it 'changes offset' do
+      subject.increment_offset 5
+      subject.offset.should == 5
+    end
+  end
+
+  describe '#skip_integer' do
+    it 'changes offset' do
+      subject.skip_integer
+      subject.offset.should == 4
+    end
+  end
+
+  describe '#skip_short_integer' do
+    it 'changes offset' do
+      subject.skip_short_integer
+      subject.offset.should == 2
+    end
+  end
+
+  describe '#skip_byte' do
+    it 'changes offset' do
+      subject.skip_byte
+      subject.offset.should == 1
+    end
+  end
+end

data/spec/lib/guitar_pro_parser/note_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+# TODO: Rewrite these test when it will be possible to read all the beats and notes.
+
+def test_note(type)
+  refs = {
+    first: [0, '5']
+  }
+  beat_number = refs.fetch(type).fetch(0)
+  string_number = refs.fetch(type).fetch(1)
+  subject { song.tracks[0].bars[0].get_beat(beat_number).strings[string_number] }
+end
+
+describe GuitarProParser::Note do
+
+
+  shared_examples 'any Guitar Pro version' do
+    
+    context 'note of the 1 beat, 1 bar, 1 track' do
+      test_note :first
+
+      # Tested features
+      its(:accentuated) { should == false }
+      its(:ghost) { should == false }
+      its(:fingers) { should == { left: nil, right: nil } }
+      its(:dynamic) { should == 'f' }
+      its(:type) { should == :normal }
+      its(:fret) { should == 3 }
+      its(:hammer_or_pull) { should == false }
+      its(:let_ring) { should == false }
+      its(:bend) { should be_nil }
+      its(:grace) { should be_nil }
+      its(:staccato) { should == false }
+      its(:palm_mute) { should == false }
+      its(:tremolo) { should be_nil }
+      its(:slide) { should be_nil }
+      its(:harmonic) { should be_nil }
+      its(:vibrato) { should == false }
+      its(:trill) { should be_nil }
+    end
+
+  end
+
+  context 'Guitar Pro 5' do
+    subject(:song) { GuitarProParser::Song.new test_tab_path 5 }
+    it_behaves_like 'any Guitar Pro version'
+  end
+
+  context 'Guitar Pro 4' do
+    subject(:song) { GuitarProParser::Song.new test_tab_path 4 }
+    it_behaves_like 'any Guitar Pro version'
+  end
+  
+   
+end

data/spec/lib/guitar_pro_parser/page_setup_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe GuitarProParser::PageSetup do
+  subject { GuitarProParser::Song.new(test_tab_path(5)).page_setup }
+
+  its(:page_format_length) { should == 210 }
+  its(:page_format_width) { should == 297 }
+  its(:left_margin) { should == 10 }
+  its(:right_margin) { should == 10 }
+  its(:top_margin) { should == 15 }
+  its(:bottom_margin) { should == 10 }
+  its(:score_size) { should == 100 }
+
+  its(:title) { should == '%TITLE%' }
+  its(:subtitle) { should == '%SUBTITLE%' }
+  its(:artist) { should == '%ARTIST%' }
+  its(:album) { should == '%ALBUM%' }
+  its(:lyrics_author) { should == 'Words by %WORDS%' }
+  its(:music_author) { should == 'Music by %MUSIC%' }
+  its(:lyrics_and_music_author) { should == 'Words & Music by %WORDSMUSIC%' }
+  its(:copyright_line_1) { should == 'Copyright %COPYRIGHT%' }
+  its(:copyright_line_2) { should == 'All Rights Reserved - International Copyright Secured' }
+  its(:page_number) { should == 'Page %N%/%P%' }
+
+  its(:displayed_fields) { should == [:title, :subtitle, :artist, :album, :lyrics_author, :music_author, :lyrics_and_music_author, :copyright, :page_number] }
+end

data/spec/lib/guitar_pro_parser/song_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+
+describe GuitarProParser::Song do
+
+  shared_examples 'Any Guitar Pro version' do
+    its(:title) { should == 'Song Title' }
+    its(:subtitle) { should == 'Song Subtitle' }
+    its(:artist) { should == 'Artist' }
+    its(:composer) { should == 'Composer' }
+    its(:copyright) { should == 'Copyright' }
+    its(:transcriber) { should == 'Transcriber' }
+    its(:instructions) { should == 'Instructions' }
+    its(:notices) { should include('Notice 1', 'Notice 2', 'Notice 3') }
+    its(:master_volume) { should == 100 }
+    its(:tempo) { should == 'Moderate' }
+    its(:bpm) { should == 120 }
+    its(:page_setup) { should be_kind_of GuitarProParser::PageSetup }
+    its('channels.count') { should == 4 }
+    its('musical_directions.count') { should == 19 }
+    its(:equalizer) { should == Array.new(11, 0) }
+
+    its('bars_settings.count') { should == 18 }
+    its('tracks.count') { should == 10 }
+  end
+
+  shared_examples 'Guitar Pro 4 and 5' do
+    its(:lyrics_track) { should == 1 }
+
+    it 'should determine lyrics' do
+      5.times do |i|
+        subject.lyrics.should include( {text: "Lyrics line #{i+1}", bar: i+1} )
+      end
+    end
+
+    its(:key) { should == 1 }
+    its(:octave) { should == 0 }
+  end
+
+  shared_examples 'Guitar Pro 3 and 4' do
+    its(:lyricist) { should == '' }
+    its(:triplet_feel) { should == true }
+    its(:master_reverb) { should == 0 }
+  end
+
+
+  describe 'Guitar Pro 5' do
+    subject { GuitarProParser::Song.new test_tab_path 5 }
+
+    it_behaves_like 'Any Guitar Pro version'
+    it_behaves_like 'Guitar Pro 4 and 5'
+
+    its(:version) { should == 5.1 }
+    its(:lyricist) { should == 'Lyricist' }
+    its(:triplet_feel) { should == true }
+    
+    it 'has proper musical directions' do
+      subject.musical_directions.each do |key, value|
+        value.should == nil
+      end
+    end
+
+    its(:master_reverb) { should == 1 }
+  end
+
+  describe 'Guitar Pro 4' do
+    subject { GuitarProParser::Song.new test_tab_path 4 }
+    
+    it_behaves_like 'Any Guitar Pro version'
+    it_behaves_like 'Guitar Pro 3 and 4'
+    it_behaves_like 'Guitar Pro 4 and 5'
+
+    its(:version) { should == 4.06 }
+  end
+
+  describe 'Musical directions' do
+    subject { GuitarProParser::Song.new test_tab_path 5, 'test_musical_directions' }
+
+    it 'has proper musical directions' do
+      correct_values = {
+        coda: 1, 
+        double_coda: 2, 
+        segno: 3, 
+        segno_segno: 4, 
+        fine: 5, 
+        da_capo: 6,
+        da_capo_al_coda: 7, 
+        da_capo_al_double_coda: 8, 
+        da_capo_al_fine: 9,
+        da_segno: 10, 
+        da_segno_segno: 11, 
+        da_segno_al_coda: 12, 
+        da_segno_al_double_coda: 13,
+        da_segno_segno_al_coda: 14,
+        da_segno_segno_al_double_coda: 15, 
+        da_segno_al_fine: 16, 
+        da_segno_segno_al_fine: 17,
+        da_coda: 18, 
+        da_double_coda: 19
+      }
+
+      subject.musical_directions.each do |key, value|
+        value.should == correct_values[key]
+      end
+    end
+  end
+
+  # TODO: Create GP3 file for testing purposes
+  # describe 'Guitar Pro 3' do
+  #   subject { GuitarProParser::Song.new test_tab_path 3 }
+
+  #   it_behaves_like 'Any Guitar Pro version'
+  #   it_behaves_like 'Guitar Pro 3 and 4'
+
+  #   its(:version) { should == 3.0 }
+  #   its(:lyrics_track) { should be_nil }
+  #   its(:lyrics) { should be_nil }
+  #   its(:key) { should == 0 }
+  #   its(:octave) { should be_nil }
+  
+  # end
+end

data/spec/lib/guitar_pro_parser/track_spec.rb

@@ -0,0 +1,211 @@
+require 'spec_helper'
+
+def test_track(test_type)
+  refs = {
+    n1: 0,
+    n2: 1,
+    percussion: 2,
+    seven_strings: 3,
+    green_colored: 3,
+    drop_d: 4,
+    with_more_frets: 4,
+    with_capo: 4,
+    twelve_strings: 5,
+    banjo: 6,
+    with_all_styles: 7,
+    auto_let_ring: 3,
+    auto_brush: 4,
+    with_custom_midi_bank: 8,
+    with_human_playing: 9,
+    with_auto_accentuation: 9,
+    with_equalizer: 9,
+    with_custom_sound_bank: 9,
+    muted: 4
+  }
+
+  subject {song.tracks[refs[test_type]]}
+end
+
+describe GuitarProParser::Track do
+
+  shared_examples 'default track of any version' do
+    its(:drums) { should == false }
+    its(:twelve_stringed_guitar) { should == false }
+    its(:banjo) { should == false }
+    its(:solo_playback) { should == false }
+    its(:mute_playback) { should == false }
+    its(:rse_playback) { should == false }
+    its(:indicate_tuning) { should == false }
+    its(:strings) { should == %w(E5 B4 G4 D4 A3 E3) }
+    its(:midi_port) { should == 1 }
+    its(:frets_count) { should == 24 }
+    its(:capo) { should == 0 }
+    its(:color) { should == [255, 0, 0] }
+  end
+
+  shared_examples 'default track v5' do
+    its(:diagrams_below_the_standard_notation) { should == false }
+    its(:show_rythm_with_tab) { should == false }
+    its(:force_horizontal_beams) { should == false }
+    its(:force_channels_11_to_16) { should == false }
+    its(:diagrams_list_on_top_of_score) { should == true }
+    its(:diagrams_in_the_score) { should == false }
+    its(:extend_rhytmic_inside_the_tab) { should == false }
+    its(:auto_let_ring) { should == false }
+    its(:auto_brush) { should == false }
+    
+
+    its(:midi_bank) { should == 0 }
+    its(:human_playing) { should == 0 }
+    its(:auto_accentuation) { should == 0 }
+    its(:sound_bank) { should == 255 }
+    its(:equalizer) { should == [0, 0, 0, 0] }
+    
+  end
+ 
+  shared_examples 'Any Guitar Pro version' do
+    
+    context 'track 1' do
+      test_track :n1
+      it_behaves_like 'default track of any version'
+      its(:name) { should == 'Track 1' }
+      its(:midi_channel) { should == 1 }
+      its(:midi_channel_for_effects) { should == 2 }
+    end
+
+    context 'track 2' do
+      test_track :n2
+      it_behaves_like 'default track of any version'
+      its(:name) { should == 'Track 2' }
+      its(:midi_channel) { should == 3 }
+      its(:midi_channel_for_effects) { should == 4 }
+    end
+
+    context 'percussion' do
+      test_track :percussion
+      its(:drums) { should == true }
+      its(:name) { should == 'Percussion' }
+      its(:midi_channel) { should == 10 }
+      its(:midi_channel_for_effects) { should == 10 }
+    end
+
+    context '7 strings guitar' do
+      test_track :seven_strings
+      its(:name) { should == '7 string guitar' }
+      its(:strings) { should == %w(E5 B4 G4 D4 A3 E3 B2) }
+    end
+
+    context 'green colored' do
+      test_track :green_colored
+      its(:color) { should == [0, 255, 0] }
+    end
+
+    context 'drop D' do
+      test_track :drop_d
+      its(:strings) { should == %w(D5 A4 F4 C4 G3 C3) } # actually it is drop C
+    end
+
+    context 'with more frets' do
+      test_track :with_more_frets
+      its(:frets_count) { should == 27 }
+    end
+
+    context 'with capo' do
+      test_track :with_capo
+      its(:capo) { should == 3 }
+    end
+
+    context '12 strings' do
+      test_track :twelve_strings
+      its(:name) { should == '12 stringed guitar' }
+      its('strings.count') { should == 6 }
+      its(:twelve_stringed_guitar) { should == true }
+    end
+
+    context 'banjo' do
+      test_track :banjo
+      its(:name) { should == 'Banjo' }
+      its('strings.count') { should == 5 }
+      its(:banjo) { should == true }
+    end
+  end
+
+
+  describe 'Guitar Pro 5' do
+    subject(:song) { GuitarProParser::Song.new test_tab_path 5 }
+
+    it_behaves_like 'Any Guitar Pro version'
+
+    context 'track 1' do
+      test_track :n1
+      it_behaves_like 'default track v5'
+      its(:instrument_effect_1) { should == 'American Clean - Pi Distortion' }
+      its(:instrument_effect_2) { should == 'Amp Tones' }      
+    end
+
+    context 'track 2' do
+      test_track :n2
+      it_behaves_like 'default track v5'
+      its(:instrument_effect_1) { should == 'Acoustic - Default' }
+      its(:instrument_effect_2) { should == 'Acoustic Tones' }
+    end
+
+    context 'with all styles' do
+      test_track :with_all_styles
+      its(:diagrams_below_the_standard_notation) { should == true }
+      its(:show_rythm_with_tab) { should == true }
+      its(:force_horizontal_beams) { should == true }
+      its(:diagrams_list_on_top_of_score) { should == true }
+      its(:diagrams_in_the_score) { should == true }
+      its(:extend_rhytmic_inside_the_tab) { should == true }
+    end
+
+    context 'auto let ring' do
+      test_track :auto_let_ring
+      its(:auto_let_ring) { should == true }
+    end
+    
+    context 'auto brush' do
+      test_track :auto_brush
+      its(:auto_brush) { should == true }
+    end
+
+    context 'with custom midi bank' do
+      test_track :with_custom_midi_bank
+      its(:midi_bank) { should == 5 }
+    end
+
+    context 'with human playing' do
+      test_track :with_human_playing
+      its(:human_playing) { should == 15 }
+    end
+
+    pending 'with auto accentuation'
+
+    context 'with equalizer' do
+      test_track :with_equalizer
+      its(:equalizer) { should == [226, 60, 231, 246] }
+    end
+
+    context 'with custom sound bank' do
+      test_track :with_custom_sound_bank
+      its(:sound_bank) { should == 2 }
+    end
+
+    context 'muted' do
+      test_track :muted
+      its(:mute_playback) { should == true }
+    end
+  end  
+
+  describe 'Guitar Pro 4' do
+    subject(:song) { GuitarProParser::Song.new test_tab_path 4 }
+    it_behaves_like 'Any Guitar Pro version'
+
+    context 'muted' do
+      test_track :muted
+      its(:mute_playback) { should == false }
+    end
+  end  
+  
+end

data/spec/lib/guitar_pro_parser_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe GuitarProParser do
+  it 'should has a version' do
+    GuitarProParser::VERSION.should_not be_nil
+  end
+
+  shared_examples 'all Guitar Pro versions' do
+    it 'is a song object' do
+      subject.should be_kind_of GuitarProParser::Song
+    end
+
+    its(:title) { should == 'Song Title'}
+    its('tracks.count') { should == 10 }
+  end
+
+  shared_examples 'file with headers only' do
+    it 'has no data about notes' do
+      subject.tracks.each do |track|
+        track.bars.should be_empty
+      end
+    end
+  end
+
+
+  describe '.read_file' do
+    context 'Guitar Pro 5' do
+      subject { GuitarProParser.read_file(test_tab_path(5)) }
+      it_behaves_like 'all Guitar Pro versions'
+    end
+
+    context 'Guitar Pro 4' do
+      subject { GuitarProParser.read_file(test_tab_path(4)) }
+      it_behaves_like 'all Guitar Pro versions'
+    end
+  end
+
+  describe '.read_headers' do
+    context 'Header only Guitar Pro 5' do
+      subject { GuitarProParser.read_headers(test_tab_path(5)) }
+      it_behaves_like 'all Guitar Pro versions'
+      it_behaves_like 'file with headers only'
+    end
+
+    context 'Header only Guitar Pro 4' do
+      subject { GuitarProParser.read_headers(test_tab_path(4)) }
+      it_behaves_like 'all Guitar Pro versions'
+      it_behaves_like 'file with headers only'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'guitar_pro_parser'
+
+# 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
+
+def test_tab_path version, filename = 'tab'
+  "spec/tabs/#{filename}.gp#{version.to_s}"
+end