traktor-nml 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a3afb8e98241015e5d186c1e309f84f5a28dbd5
-  data.tar.gz: 2f487b2db2e9cf1a06ce61c45035fc660b83a42a
+  metadata.gz: a975f0344949062aa901da4cfb09178e10877377
+  data.tar.gz: 325b02f803405a3a7dc7015a0b5f4c79cd09d1bd
 SHA512:
-  metadata.gz: dbbfb8e69974494ca670824c8fde3a41e04d799c7b0fd5822e0feec62be13db7defb6b9971046e228eb83fcf4c63975c9c198f0c31c3a600a2cfec167fa84628
-  data.tar.gz: 4f99c1e87c39c7dcb19c9d820746cf1b1dea1ffc8e66767cee8a3350459774b1f2ec9280cbe7027e5bded3e4e622bbe425ff0a468ceaafe5ca7fcdcfb9b623f5
+  metadata.gz: 213163283d378e4d088ff1ce248323590e50c0c9de164bcc723b9b66f2477ac97023a9b032069a8aa203bd14cc57e4f6589a8c57124c0965dd28adfb354b6f50
+  data.tar.gz: a18161acdadb9157f9e89a1bfde78c6ec1c16f2b987f425aa2643347b375bfe7cc96ebe8f14a43042fd414dee4d994dc5d9c05042c4fb6cc8a4966e756eddd43

data/README.md

@@ -27,44 +27,95 @@ Or install it yourself as:
 require 'traktor/nml'
 
 Traktor::NML.parse File.open("path/to/playlist.nml")
+Traktor::NML.load "path/to/playlist.nml"
 # or
 Traktor::NML.parse content_of_nml
 ```
 
 `Traktor::NML.parse` will return array of hash like this:
 
-```ruby
-[{:title=>"Green Night Parade (PandaBoY Remix)",
-  :artist=>"fu_mou",
-  :album=>"Green Night Parade EP",
-  :primarykey=>
-   "G:/:Music/:fu_mou/:Green Night Parade EP/:06 Green Night Parade (PandaBoY Remi.mp3",
-  :genre=>"ALTEMA Records",
-  :label=>"",
-  :playtime=>371.0,
-  :release_date=>"2011/1/1",
-  :bpm=>131.999},
- {:title=>"Sweet Tear(Y calla K Cut Electro Remix)",
-  :artist=>"Calla Soiled",
-  :album=>"Sweet Tear EP",
-  :primarykey=>
-   "G:/:Music/:Calla Soiled/:Sweet Tear EP/:02 Sweet Tear(Y calla K Cut Electro.mp3",
-  :genre=>"ALTEMA Records",
-  :label=>"",
-  :playtime=>320.0,
-  :release_date=>"2010/1/1",
-  :bpm=>132.0},
- {:title=>"もしも星屑が泣いたとして",
-  :artist=>"Calla Soiled",
-  :album=>"Dirty Nucleus",
-  :primarykey=>"G:/:Music/:Calla Soiled/:Dirty Nucleus/:07 もしも星屑が泣いたとして.mp3",
-  :genre=>"",
-  :label=>"",
-  :playtime=>362.0,
-  :release_date=>"2010/1/1",
-  :bpm=>139.005}]
+```irb
+irb(main):001:0> require 'traktor/nml'
+=> true
+irb(main):002:0> Traktor::NML.parse(File.read(File.expand_path "./spec/traktor/traktor-nml-demo.nml"))
+=> #<Traktor::NML::Playlist:0x007f8f3bbdd270 @tracks=[
+  #<Traktor::NML::Track:0x007f8f3bbfc058
+    @title="Green Night Parade (PandaBoY Remix)",
+    @artist="fu_mou",
+    @album={:title=>"Green Night Parade EP", :track=>"6"},
+    @primarykey="G:/:Music/:fu_mou/:Green Night Parade EP/:06 Green Night Parade (PandaBoY Remi.mp3",
+    @genre="ALTEMA Records",
+    @label="",
+    @release_date="2011/1/1",
+    @playtime=371.0,
+    @bpm=131.999,
+    @key="3d",
+    @musical_key="2",
+    @cues=[
+      #<Traktor::NML::Cue:0x007f8f3bbfeb28 @name="n.n.", @type=0, @start=483.713, @length=0.0, @repeats=-1, @hotcue=0>,
+      #<Traktor::NML::Cue:0x007f8f3bbfe538 @name="n.n.", @type=4, @start=4119.93, @length=0.0, @repeats=-1, @hotcue=1>,
+      #<Traktor::NML::Cue:0x007f8f3bbfdf48 @name="n.n.", @type=0, @start=33211.1, @length=0.0, @repeats=-1, @hotcue=2>,
+      #<Traktor::NML::Cue:0x007f8f3bbfd958 @name="n.n.", @type=0, @start=47756.6, @length=0.0, @repeats=-1, @hotcue=3>,
+      #<Traktor::NML::Cue:0x007f8f3bbfd340 @name="n.n.", @type=0, @start=76847.6, @length=0.0, @repeats=-1, @hotcue=4>,
+      #<Traktor::NML::Cue:0x007f8f3bbfcd00 @name="n.n.", @type=0, @start=91393.2, @length=0.0, @repeats=-1, @hotcue=5>,
+      #<Traktor::NML::Cue:0x007f8f3bbfc6c0 @name="n.n.", @type=0, @start=120484.0,@length=0.0, @repeats=-1, @hotcue=6>,
+      #<Traktor::NML::Cue:0x007f8f3bbfc0a8 @name="n.n.", @type=0, @start=149576.0, @length=0.0, @repeats=-1, @hotcue=7>
+    ]
+  >,
+  #<Traktor::NML::Track:0x007f8f3bc14dd8
+    @title="Sweet Tear(Y calla K Cut Electro Remix)",
+    @artist="Calla Soiled",
+    @album={:title=>"Sweet Tear EP", :track=>"2"},
+    @primarykey="G:/:Music/:Calla Soiled/:Sweet Tear EP/:02 Sweet Tear(Y calla K Cut Electro.mp3",
+    @genre="ALTEMA Records",
+    @label="",
+    @release_date="2010/1/1",
+    @playtime=320.0,
+    @bpm=132.0,
+    @key="12d",
+    @musical_key="5",
+    @cues=[
+      #<Traktor::NML::Cue:0x007f8f3bc74b48 @name="n.n.", @type=0, @start=26.5843, @length=0.0, @repeats=-1, @hotcue=0>,
+      #<Traktor::NML::Cue:0x007f8f3bc74558 @name="n.n.", @type=4, @start=3666.41, @length=0.0, @repeats=-1, @hotcue=1>,
+      #<Traktor::NML::Cue:0x007f8f3bc17e98 @name="n.n.", @type=0, @start=18208.4, @length=0.0, @repeats=-1, @hotcue=2>,
+      #<Traktor::NML::Cue:0x007f8f3bc17330 @name="n.n.", @type=0, @start=32753.9, @length=0.0, @repeats=-1, @hotcue=3>,
+      #<Traktor::NML::Cue:0x007f8f3bc167c8 @name="n.n.", @type=0, @start=47299.3, @length=0.0, @repeats=-1, @hotcue=4>,
+      #<Traktor::NML::Cue:0x007f8f3bc15cb0 @name="n.n.", @type=0, @start=90935.7, @length=0.0, @repeats=-1, @hotcue=5>,
+      #<Traktor::NML::Cue:0x007f8f3bc15468 @name="n.n.", @type=0, @start=120027.0, @length=0.0, @repeats=-1, @hotcue=6>,
+      #<Traktor::NML::Cue:0x007f8f3bc14e28 @name="n.n.", @type=0, @start=149117.0, @length=0.0, @repeats=-1, @hotcue=7>
+    ]
+  >,
+  #<Traktor::NML::Track:0x007f8f3bbde620
+    @title="もしも星屑が泣いたとして",
+    @artist="Calla Soiled",
+    @album={:title=>"Dirty Nucleus", :track=>"7"},
+    @primarykey="G:/:Music/:Calla Soiled/:Dirty Nucleus/:07 もしも星屑が泣いたとして.mp3",
+    @genre="",
+    @label="",
+    @release_date="2010/1/1",
+    @playtime=362.0,
+    @bpm=139.005,
+    @key="11m",
+    @musical_key="19",
+    @cues=[
+      #<Traktor::NML::Cue:0x007f8f3bbe5948 @name="Beat Marker", @type=4, @start=434.042, @length=0.0, @repeats=-1, @hotcue=-1>,
+      #<Traktor::NML::Cue:0x007f8f3bbe52e0 @name="n.n.", @type=4, @start=434.042, @length=0.0, @repeats=-1, @hotcue=0>,
+      #<Traktor::NML::Cue:0x007f8f3bbe4bd8 @name="n.n.", @type=0, @start=14246.2, @length=0.0, @repeats=-1, @hotcue=1>,
+      #<Traktor::NML::Cue:0x007f8f3bbe4520 @name="n.n.", @type=0, @start=28058.7, @length=0.0, @repeats=-1, @hotcue=2>,
+      #<Traktor::NML::Cue:0x007f8f3bbdfe80 @name="n.n.", @type=0, @start=41871.4, @length=0.0, @repeats=-1, @hotcue=3>,
+      #<Traktor::NML::Cue:0x007f8f3bbdf840 @name="n.n.", @type=0, @start=55683.6, @length=0.0, @repeats=-1, @hotcue=4>,
+      #<Traktor::NML::Cue:0x007f8f3bbdf250 @name="n.n.", @type=0, @start=83308.5, @length=0.0, @repeats=-1, @hotcue=5>,
+      #<Traktor::NML::Cue:0x007f8f3bbdec60 @name="n.n.", @type=0, @start=97121.0, @length=0.0, @repeats=-1, @hotcue=6>,
+      #<Traktor::NML::Cue:0x007f8f3bbde670 @name="n.n.", @type=0, @start=124746.0,@length=0.0, @repeats=-1, @hotcue=7>
+    ]
+  >
+]>
 ```
 
+## Notice
+
+* Release date may be like `YYYY/1/1` when only YEAR is specified in file
+
 ## Contributing
 
 1. Fork it ( https://github.com/polamjag/traktor-nml/fork )

data/lib/traktor/nml.rb

@@ -1,15 +1,15 @@
-require "traktor/nml/collection"
-require "traktor/nml/playlist"
-require "traktor/nml/version"
-require "oga"
+require "traktor/nml/file"
 
 module Traktor
   module NML
-    def self.parse(content)
-      doc = Oga.parse_xml content
-      col = Traktor::NML::Collection.new doc.xpath('NML/COLLECTION/ENTRY')
-      setlist = Traktor::NML::Playlist.new doc.xpath('NML/PLAYLISTS'), col
-      setlist.tracks
+    class << self
+      def parse(content)
+        Traktor::NML::File.new(content).playlist
+      end
+
+      def load(filepath)
+        Traktor::NML::File.new(::File.read filepath).playlist
+      end
     end
   end
 end

data/lib/traktor/nml/collection.rb

@@ -1,13 +1,18 @@
 require "oga"
+require "date"
+require "traktor/nml/track"
+require "traktor/nml/cue"
 
 module Traktor
   module NML
     class Collection
+      include Enumerable
+
       attr_reader :collection
 
       def initialize(node)
         @collection = node.map do |el|
-          {
+          Traktor::NML::Track.new({
             title: try_text(el.attribute('TITLE')),
             artist: try_text(el.attribute('ARTIST')),
             album: {
@@ -20,30 +25,47 @@ module Traktor
             genre: el.xpath('INFO[@GENRE]').attribute('GENRE').map{ |e| e.text }.join(", "),
             label: el.xpath('INFO[@LABEL]').attribute('LABEL').map{ |e| e.text }.join(", "),
             playtime: el.xpath('INFO[@PLAYTIME]').attribute('PLAYTIME').map{ |e| e.text.to_f }.first,
-            release_date: el.xpath('INFO[@RELEASE_DATE]').attribute('RELEASE_DATE').map{ |e| e.text }.join(", "),
+            release_date: parse_date(el.xpath('INFO[@RELEASE_DATE]').attribute('RELEASE_DATE').map{ |e| e.text }.join(", ")),
             bpm: el.xpath('TEMPO[@BPM]').attribute('BPM').map{ |e| e.text.to_f }.first,
             key: try_text(el.xpath('INFO[@KEY]').attribute('KEY').first),
             musical_key: try_text(el.xpath('MUSICAL_KEY[@VALUE]').attribute('VALUE').first),
             cues: el.xpath('CUE_V2').map do |cue|
-              {
+              Traktor::NML::Cue.new({
                 name: cue.attribute('NAME').value,
                 type: cue.attribute('TYPE').value.to_i,
                 start: cue.attribute('START').value.to_f,
                 length: cue.attribute('LEN').value.to_f,
                 repeats: cue.attribute('REPEATS').value.to_i,
                 hotcue: cue.attribute('HOTCUE').value.to_i
-              }
+              })
             end
-          }
+          })
         end
       end
 
       def track_from_primarykey(primarykey)
         @collection.select do |track|
-          track[:primarykey] == primarykey
+          track.primarykey == primarykey
         end.first
       end
 
+      def length
+        @collection.length
+      end
+      alias_method :size, :length
+
+      def each
+        @collection.each do |track|
+          yield track
+        end
+      end
+
+      def [](i)
+        @collection[i]
+      end
+
+
+      private
       def try_text(elm)
         if elm.nil?
           ""
@@ -51,6 +73,10 @@ module Traktor
           elm.text
         end
       end
+
+      def parse_date(date)
+        Date.parse date unless date.empty?
+      end
     end
   end
 end

data/lib/traktor/nml/cue.rb

@@ -0,0 +1,20 @@
+module Traktor
+  module NML
+    class Cue
+      attr_reader :name, :type, :start, :length, :repeats, :hotcue
+
+      def initialize(info)
+        @name    = info[:name]
+        @type    = info[:type]
+        @start   = info[:start]
+        @length  = info[:length]
+        @repeats = info[:repeats]
+        @hotcue  = info[:hotcue]
+      end
+
+      def [](key)
+        return self.instance_variable_get("@#{key.to_s}")
+      end
+    end
+  end
+end

data/lib/traktor/nml/file.rb

@@ -0,0 +1,18 @@
+require "oga"
+require "traktor/nml/collection"
+require "traktor/nml/playlist"
+
+module Traktor
+  module NML
+    class File
+      attr_reader :collection, :playlist
+
+      def initialize(content)
+        doc = Oga.parse_xml content
+
+        @collection = Traktor::NML::Collection.new doc.xpath('NML/COLLECTION/ENTRY')
+        @playlist   = Traktor::NML::Playlist.new doc.xpath('NML/PLAYLISTS'), @collection
+      end
+    end
+  end
+end

data/lib/traktor/nml/playlist.rb

@@ -3,13 +3,32 @@ require "oga"
 module Traktor
   module NML
     class Playlist
+      include Enumerable
+
       attr_reader :tracks
+
       def initialize(node, collection)
         @tracks = (find_playlist node).first.xpath('PLAYLIST/ENTRY/PRIMARYKEY').map do |track|
           collection.track_from_primarykey track.attribute('KEY').text
         end.compact
       end
 
+      def length
+        @tracks.length
+      end
+      alias_method :size, :length
+
+      def each
+        @tracks.each do |track|
+          yield track
+        end
+      end
+
+      def [](i)
+        @tracks[i]
+      end
+
+      private
       def find_playlist(node)
         node.each do |nd|
           nd.xpath('NODE/SUBNODES').each do |elm|

data/lib/traktor/nml/track.rb

@@ -0,0 +1,30 @@
+module Traktor
+  module NML
+    class Track
+      attr_reader :title, :artist, :album,
+        :primarykey,
+        :genre, :label, :release_date,
+        :playtime, :bpm, :key, :musical_key,
+        :cues
+
+      def initialize(info)
+        @title        = info[:title]
+        @artist       = info[:artist]
+        @album        = info[:album]
+        @primarykey   = info[:primarykey]
+        @genre        = info[:genre]
+        @label        = info[:label]
+        @release_date = info[:release_date]
+        @playtime     = info[:playtime]
+        @bpm          = info[:bpm]
+        @key          = info[:key]
+        @musical_key  = info[:musical_key]
+        @cues         = info[:cues]
+      end
+
+      def [](key)
+        return self.instance_variable_get("@#{key.to_s}")
+      end
+    end
+  end
+end

data/lib/traktor/nml/version.rb

@@ -1,5 +1,5 @@
 module Traktor
   module NML
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/spec/traktor/nml_spec.rb

@@ -1,17 +1,51 @@
 require 'spec_helper'
 
 describe Traktor::NML do
+  before do
+    @path_nml_win = (File.join File.dirname(__FILE__), "win.nml")
+    @path_nml_win_embedded = (File.join File.dirname(__FILE__), "win_in_folder.nml")
+    @path_nml_osx = (File.join File.dirname(__FILE__), "osx.nml")
+  end
+
   it 'has a version number' do
     expect(Traktor::NML::VERSION).not_to be nil
   end
 
   it 'can parse nml file ver 18' do
-    expect((Traktor::NML.parse File.open (File.join File.dirname(__FILE__), "win.nml")).length).to eq(40)
+    expect((Traktor::NML.parse File.open @path_nml_win).length).to eq(40)
   end
   it 'can parse nml file ver 18, playlist is in directory' do
-    expect((Traktor::NML.parse File.open (File.join File.dirname(__FILE__), "win_in_folder.nml")).length).to eq(43)
+    expect((Traktor::NML.parse File.open @path_nml_win_embedded).length).to eq(43)
   end
   it 'can parse nml file of OSX, ver 16' do
-    expect((Traktor::NML.parse File.open (File.join File.dirname(__FILE__), "osx.nml")).length).to eq(34)
+    expect((Traktor::NML.parse File.open @path_nml_osx).length).to eq(34)
+  end
+
+  describe Traktor::NML::Playlist do
+    before do
+      @playlist = Traktor::NML.load @path_nml_win
+    end
+
+    it 'has length' do
+      expect(@playlist.length).to eq 40
+    end
+
+    it 'is Enumerable' do
+      expect(@playlist.map{|pl| pl.title }.length).to eq 40
+    end
+  end
+
+  describe Traktor::NML::Collection do
+    before do
+      @file = Traktor::NML::File.new ::File.read @path_nml_win
+    end
+
+    it 'has length' do
+      expect(@file.collection.length).to eq 40
+    end
+
+    it 'is Enumerable' do
+      expect(@file.collection.map{|pl| pl.title }.length).to eq 40
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: traktor-nml
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - polamjag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-06 00:00:00.000000000 Z
+date: 2015-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oga
@@ -97,7 +97,10 @@ files:
 - circle.yml
 - lib/traktor/nml.rb
 - lib/traktor/nml/collection.rb
+- lib/traktor/nml/cue.rb
+- lib/traktor/nml/file.rb
 - lib/traktor/nml/playlist.rb
+- lib/traktor/nml/track.rb
 - lib/traktor/nml/version.rb
 - spec/spec_helper.rb
 - spec/traktor/nml_spec.rb