GTP 0.0.1 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c95f11dd3b8984c35d4a5689256f044d63efd63b
+  data.tar.gz: 2f350da3f47500d24a2a9467b6f9d004b9dc6a44
+SHA512:
+  metadata.gz: f5b9655918545ae36cf5c75948c70e89030226cf52638b1d1905051a1c5adfaba7ab98cee2322a76856e40a7d9f8047a936ef97a214adddb96f2a7a15ff3f680
+  data.tar.gz: 14165f6937a8825c3bea4fb3be97a6d660101ed45eeb6d349a72b3999cbb9ca1813e92a543cf69f2c0ff1c6b9e48fbf9379b28f80a4ac64448a1601affc56a91

data/GTP.gemspec

@@ -20,4 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'json'
 end

data/lib/GTP.rb

@@ -1,6 +1,10 @@
 require "GTP/version"
 require "GTP/gp4"
+require "GTP/measure"
+require "GTP/io/reader"
 
 module GTP
-   
+  def configure(&block)
+    block.call self
+  end
 end

data/lib/GTP/gp4.rb

@@ -1,117 +1,198 @@
+require "json"
+
 module GTP
   class GP4
+    FIELDS = %w(title subtitle artist album author copyright tab instruction notice triplet_feel)
+
+    attr_accessor :file, :version, :offset, :lyrics, :tempo, :key, :octave, :num_measures, :num_tracks, :measures
+
+    attr_accessor *FIELDS
 
-    attr_accessor :file,
-                  :version,
-                  :title,
-                  :subtitle,
-                  :artist,
-                  :album,
-                  :author,
-                  :copyright,
-                  :tab,
-                  :instruction,
-                  :notice,
-                  :triplet_feel,
-                  :offset
     attr_reader :file_path
 
     INTEGER_SIZE = 4
 
     def initialize(tab_path)
+      @reader = Reader.new tab_path
       @file = File.open(tab_path, "r")
-      @offset = 31
     end
 
-    def read_string
-
-      self.offset = self.offset+INTEGER_SIZE
+    def call
+      parse_version
+      parse_info
+      parse_lyrics
+    end
 
-      length = IO.binread(self.file, 1, self.offset).bytes.to_a[0].to_i
+    def fix_header header
 
-      self.offset = self.offset + 1
+      counter = 0
 
-      string = IO.binread(self.file, length, self.offset)
+      new_header = header.reverse
 
-      self.offset = self.offset + length
+      while 8 > new_header.size
+        new_header << "0"
+      end
 
-      return string
+      return new_header
     end
 
     def parse_version
-
-      size = IO.binread(self.file, 1).bytes.to_a[0].to_i
-
-      self.version = IO.binread(self.file, size, 1).strip
+      self.version = @reader.read_string
     end
 
     def parse_info
-      parse_title
-      parse_subtitle
-      parse_artist
-      parse_album
-      parse_author
-      parse_copyright
-      parse_tab
-      parse_instruction
-      parse_notice
-      parse_triplet_feel
+      FIELDS.each do |field|
+        self.public_send "parse_#{field}"
+      end
     end
 
-    def parse_title
-      self.title = read_string
+    FIELDS.each do |field|
+      define_method "parse_#{field}" do
+        self.public_send "#{field}=", @reader.read_default_string
+      end
     end
 
-    def parse_subtitle
-      self.subtitle = read_string
-    end
+    def parse_notice
+      linesCount = @reader.read_integer
 
-    def parse_artist
-      self.artist = read_string
-    end
+      notice = ""
 
-    def parse_album
-      self.album = read_string
-    end
+      linesCount.times do
+        notice << @reader.read_default_string << "\n"
+      end
 
-    def parse_author
-      self.author = read_string
+      self.notice = notice
     end
 
-    def parse_copyright
-      self.copyright = read_string
+    def parse_triplet_feel
+      self.triplet_feel = @reader.read_byte.to_s
     end
 
-    def parse_tab
-      self.tab = read_string
+    def parse_lyrics
+      track = @reader.read_integer
+      self.lyrics = []
+
+      5.times do
+
+        bar = @reader.read_integer
+        content = @reader.read_int_string
+
+        tuple = {}
+        tuple.store(bar, content.gsub("\r\n", "\n"))
+
+        self.lyrics.push(tuple)
+      end
     end
 
-    def parse_instruction
-      self.instruction = read_string
+    def parse_tempo
+      self.tempo = @reader.read_integer.to_i
     end
 
-    def parse_notice
-      lines = IO.binread(self.file, INTEGER_SIZE, self.offset).unpack("L")[0]
+    def parse_key
+      self.key = @reader.read_integer
+    end
 
-      self.offset = self.offset+INTEGER_SIZE
+    def parse_octave
+      self.octave = @reader.read_byte
+    end
 
-      notice = ""
+    def parse_midi_channels
+      @reader.increment_offset (12 * 16 * 4) # TODO
+    end
 
-      for i in 1..lines-1
-        notice << read_string << "\n"
-      end
+    def parse_number_of_measures
+      self.num_measures = @reader.read_integer.to_i
+    end
 
-      notice << read_string
-      
-      self.notice = notice
+    def parse_number_of_tracks
+      self.num_tracks = @reader.read_integer
     end
 
-    def parse_triplet_feel
-      self.triplet_feel = IO.binread(self.file, 1, self.offset).bytes.to_a[0].to_s
+    def parse_measures
+
+      self.measures = []
+
+      for n in 1..self.num_measures do
+
+        header = fix_header read_byte.to_s(2)
+        numerator = nil
+        denominator = nil
+        begin_repeat = nil
+        end_repeat = nil
+        marker_name = nil
+        marker_color = nil
+        tonality = nil
+        double_bar = nil
+
+        if header[0] == "1"
+          numerator = read_byte
+        end
+
+        if header[1] == "1"
+          denominator = read_byte
+        end
+
+        if header[2] == "1"
+          begin_repeat = true
+        end
+
+        if header[3] == "1"
+          end_repeat = read_byte
+        end
+
+        if header[4] == "1"
+          num_alt_ending = read_byte
+        end
+
+        if header[5] == "1"
+          marker_name = @reader.read_string
+          marker_color = read_integer
+        end
+
+        if header[6] == "1"
+          tonality = read_byte
+          @reader.increment_offset 1
+        end
+
+        if header[7] == "1"
+          double_bar = true
+        end
+
+        measure = Measure.new
+        measure.numerator = numerator
+        measure.denominator = denominator
+        measure.begin_repeat = begin_repeat
+        measure.end_repeat = end_repeat
+        measure.num_alt_ending = num_alt_ending
+        measure.marker_name = marker_name
+        measure.marker_color = marker_color
+        measure.tonality = tonality
+        measure.double_bar = double_bar
+
+        self.measures.push(measure)
+      end
     end
 
     def to_json
-      
+    {
+
+      "score" => {
+
+        "info" => {
+          "version" => self.version,
+          "title" => self.title,
+          "subtitle" => self.subtitle,
+          "artist" => self.artist,
+          "album" => self.album,
+          "author" => self.author,
+          "copyright" => self.copyright
+        },
+        "tempo" => self.tempo,
+        "key" => self.key,
+        "num_track" => self.num_tracks,
+        "num_measures" => self.num_measures
+      }
+    }.to_json
     end
   end
-end
+end

data/lib/GTP/io/reader.rb

@@ -0,0 +1,78 @@
+module GTP
+  class Reader
+
+    attr_accessor :offset, :file
+    INTEGER_SIZE = 4
+
+    def initialize(file)
+      @file = File.open(file, "r")
+      @offset = 0
+    end
+
+    def read_next_chunk_with_offset(size, offset)
+      increment_offset size
+      IO.binread(self.file, size, offset)
+    end
+
+    def read_integer
+      result = IO.binread(self.file, INTEGER_SIZE, self.offset).unpack('L').first
+      increment_offset INTEGER_SIZE
+      result
+    end
+
+    def increment_offset(delta)
+      self.offset = self.offset + delta
+    end
+
+    def read_default_string(amount_to_read=1)
+      skip_useless_bytes
+      read_next_string amount_to_read
+    end
+
+    def read_string
+      value = read_next_string
+      skip_bytes value.length
+      value
+    end
+
+    def read_first_string_and_unpack
+      read_next_string.unpack("L")
+    end
+
+    def read_int_string
+      read_next_string INTEGER_SIZE
+    end
+
+    def read_byte
+
+      result = IO.binread(self.file, 1, self.offset).bytes.to_a
+
+      increment_offset 1
+
+      raise "Byte is greather than expected" if result.size > 1
+
+      result.first.to_i
+    end
+
+    def skip_integer
+      increment_offset INTEGER_SIZE
+    end
+
+    protected
+    def skip_useless_bytes
+      increment_offset INTEGER_SIZE
+    end
+
+    def skip_bytes(size)
+      increment_offset 30-size
+    end
+
+    def read_next_string(amount_to_read=1)
+      size = IO.binread(self.file, amount_to_read, self.offset).bytes.to_a.first.to_i
+      increment_offset amount_to_read
+      value = IO.binread(self.file, size, self.offset).strip
+      increment_offset size
+      value
+    end
+  end
+end

data/lib/GTP/measure.rb

@@ -0,0 +1,18 @@
+module GTP
+  class Measure
+    FIELDS = %w(double_bar tonality marker_name marker_color num_alt_ending end_repeat begin_repeat denominator numerator)
+    attr_accessor *FIELDS
+
+    def ==(o)
+      o.class == self.class && o.state == state
+    end
+
+  protected
+    def state
+      info = Array.new
+      FIELDS.each do |f|
+        info.push(f)
+      end
+    end
+  end
+end

data/lib/GTP/version.rb

@@ -1,3 +1,6 @@
 module GTP
-  VERSION = "0.0.1"
+  MAJOR = 0
+  MINOR = 1
+  PATCH = 1
+  VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}"
 end

data/test/lib/GTP/gp4_test.rb

@@ -1,53 +1,119 @@
 require "test_helper"
 
-describe GTP::GP4 do
+module GTP
+  describe GP4 do
 
-  it "must read the file version" do
-    parser = GTP::GP4.new "test/tabs/test.gp4"
+    it "must read the file version" do
+      parser = GP4.new "test/tabs/test.gp4"
+      parser.parse_version
 
-    parser.parse_version
+      # p parser.version
+      parser.version.must_match %r/FICHIER GUITAR PRO v4./
+    end
 
-    parser.version.must_match %r/FICHIER GUITAR PRO v4./
-  end
+    let(:parser) { GP4.new "test/tabs/test.gp4" }
 
-  it "must read the tablature info" do
-    parser = GTP::GP4.new "test/tabs/test.gp4"
-
-    parser.parse_info
-
-    parser.title.must_equal "Title"
-    parser.subtitle.must_equal "Subtitle"
-    parser.artist.must_equal "Artist"
-    parser.album.must_equal "Album"
-    parser.author.must_equal "Author"
-    parser.copyright.must_equal "Copyright"
-    parser.tab.must_equal "Tab"
-    parser.instruction.must_equal "Instruction"
-    parser.notice.must_equal "N line 1\nN line 2\nN line 3\nN line 4"
-    parser.triplet_feel.must_match "0"
-  end
+    before { parser.call }
 
-  it "must read the tablature lyrics" do
-    
-  end
+    describe 'tablature info' do
+      it "must read the tablature info" do
+        parser.title.must_equal "Title"
+        parser.subtitle.must_equal "Subtitle"
+        parser.artist.must_equal "Artist"
+        parser.album.must_equal "Album"
+        parser.author.must_equal "Author"
+        parser.copyright.must_equal "Copyright"
+        parser.tab.must_equal "Tab"
+        parser.instruction.must_equal "Instruction"
+        parser.notice.must_equal "N line 1\nN line 2\nN line 3\nN line 4\n"
+        parser.triplet_feel.must_match "0"
+      end
+    end
 
-  it "must read the tablature extra info" do
-    
-  end
+    describe "Lyrics" do
+      it "must read the tablature lyrics" do
+        parser.lyrics.must_equal [
+                                   {1=>"1111\n1111\n1111\n1111"},
+                                   {2=>"2222\n2222\n2222\n2222"},
+                                   {1=>"3333\n3333\n3333"},
+                                   {2=>"4444\n4444"},
+                                   {1=>"5555"}
+                                 ]
+      end
+    end
 
-  it "must read the tablature measures" do
-    
-  end
+    describe "Other information" do
+      it "about the piece" do
+        parser.parse_tempo
+        parser.parse_key
+        parser.parse_octave
+        parser.parse_midi_channels # <----- PARSE ME PLEASE!!!
+        parser.parse_number_of_measures
+        parser.parse_number_of_tracks
 
-  it "must read the tablature tracks" do
-    
-  end
+        parser.tempo.must_equal 120
+        parser.key.must_equal 1
+        parser.octave.must_equal 0
+        # parser.midi_channels
+        parser.num_measures.must_equal 2
+        parser.num_tracks.must_equal 1
+      end
+    end
 
-  it "must read the tablature song" do
-    
-  end
+    describe "Serialization" do
+      it "must serialize as json" do
+        parser.to_json.must_equal "{\"score\":{\"info\":{\"version\":\"FICHIER GUITAR PRO v4.06\",\"title\":\"Title\",\"subtitle\":\"Subtitle\",\"artist\":\"Artist\",\"album\":\"Album\",\"author\":\"Author\",\"copyright\":\"Copyright\"},\"tempo\":null,\"key\":null,\"num_track\":null,\"num_measures\":null}}"
+      end
+    end
+
+    # describe "Measures" do
+    #   first_measure = Measure.new
+    #   second_measure = Measure.new
+
+    #   before do
+    #     parser.parse_version
+    #     parser.parse_info
+    #     parser.parse_lyrics
+    #     parser.parse_tempo
+    #     parser.parse_key
+    #     parser.parse_octave
+    #     parser.parse_midi_channels
+    #     parser.parse_number_of_measures
+    #     parser.parse_number_of_tracks
+
+    #     first_measure.numerator = 4
+    #     first_measure.denominator = 4
+    #     first_measure.begin_repeat = true
+    #     first_measure.end_repeat = nil
+    #     first_measure.num_alt_ending = nil
+    #     first_measure.marker_name = nil
+    #     first_measure.marker_color = nil
+    #     first_measure.tonality = 1
+    #     first_measure.double_bar = nil
+
+    #     second_measure.numerator = 7
+    #     second_measure.denominator = 8
+    #     second_measure.begin_repeat = nil
+    #     second_measure.end_repeat = nil
+    #     second_measure.num_alt_ending = nil
+    #     second_measure.marker_name = nil
+    #     second_measure.marker_color = nil
+    #     second_measure.tonality = nil
+    #     second_measure.double_bar = nil
+
+    #   end
+
+    #   it "must get the tab measures" do
+    #     parser.parse_measures
+
+    #     expected_measures = Array.new
+    #     expected_measures.push(first_measure)
+    #     expected_measures.push(second_measure)
+
+    #     # require "pry"; binding.pry
 
-  it "must read the tablature chord diagrams" do
-    
+    #     parser.measures.must_equal expected_measures
+    #   end
+    # end
   end
-end
+end

data/test/lib/GTP/measure_test.rb

@@ -0,0 +1,21 @@
+require "test_helper"
+
+module GTP
+  describe Measure do
+    
+    it "must setup its attributes properly" do
+      # measures = Measure.new "11100010"
+
+      # measures.header.must_equal
+      # measures.double_bar.must_equal false
+      # measures.tonality.must_equal
+      # measures.marker.must_equal false
+      # measures.num_alt_ending.must_equal false
+      # measures.end_repeat.must_equal false
+      # measures.begin_repeat.must_equal true
+      # measures.den_key.must_equal 4
+      # measures.num_key.must_equal 4
+
+    end
+  end
+end

metadata

@@ -1,57 +1,78 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: GTP
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.1.1
 platform: ruby
-authors: 
+authors:
 - Thiago Rocha
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-06-30 00:00:00 -03:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 3
-        version: "1.3"
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
   name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Guitar Pro file parser
-email: 
+email:
 - kimo@kimo.io
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - GTP.gemspec
 - Gemfile
@@ -60,46 +81,44 @@ files:
 - Rakefile
 - lib/GTP.rb
 - lib/GTP/gp4.rb
+- lib/GTP/io/reader.rb
+- lib/GTP/measure.rb
 - lib/GTP/version.rb
 - test/lib/GTP/gp4_test.rb
+- test/lib/GTP/measure_test.rb
 - test/lib/GTP/version_test.rb
 - test/tabs/test.gp3
 - test/tabs/test.gp4
 - test/tabs/test.gp5
 - test/tabs/test2.gp4
 - test/test_helper.rb
-has_rdoc: true
-homepage: ""
-licenses: 
+homepage: ''
+licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+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"
+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: 1.3.6
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: It parses gtp files
-test_files: 
+test_files:
 - test/lib/GTP/gp4_test.rb
+- test/lib/GTP/measure_test.rb
 - test/lib/GTP/version_test.rb
 - test/tabs/test.gp3
 - test/tabs/test.gp4