kbl 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7675c0becfd84f2bc39016316d19c9cca200daeb
-  data.tar.gz: f3df0ab1a649a300f7ac996f342160cd47f34aa9
+  metadata.gz: e852e61e09bff3e8f49b0b67999c00f03c748dc6
+  data.tar.gz: 011283369cf6e2aca80718485037472c6dcf46ab
 SHA512:
-  metadata.gz: a405a118a81a11dcf0a564fe3060358e117bd2d643a72013430ffb95ea69c6cf198f16f2ca31f34ee8b871112965bb3fe0dda9a26333bba877e6b9bff06b2e32
-  data.tar.gz: de489185b4a7ce05520c8b0f4959c207d37f4886eba8b198095923584188a19a143fdf6763ef27ee15fe92ca0d86b193f61d51a9548f6dc3512147434b1c6943
+  metadata.gz: 613a8f0deac003c24877f13ee87b87e4244a2af4917a1da4317f9f02aa5162062bc6c01db555b53a033b14acbab31afc30c1a08567173d9beab42de4bbdbd19d
+  data.tar.gz: bafdad4ab784c08a475e80f5d41bc8f36c33841bebab12a38c0c73144a1449c84774f2e2d1d396d38f80ed2fd61d76e3e1b59b4fa3364b2f737132ea813156a9

data/README.md

@@ -42,20 +42,80 @@ end
 puts kbl.to_kbl #=> the KBL source code (in XML)
 ```
 
-### CLI Tool
+## CLI Tool
 
 This gem provides a CLI tool `kbl` that simplifies playlist importing / dumping via Song IDs (pathname).
 
-Usage:
+### Import
 
-```txt
-# Import KKBOX Songs from a list of IDs through [FILENAME] or STDIN.
-kbl import [INPUT_FILE or STDIN]
+Import KKBOX Songs from a list of IDs in a file or STDIN.
 
-# Dump meta data of KKBOX songs from your local KKBOX client database.
-kbl dump [INPUT_FILE or STDIN] [-o=OUTPUT_FILE or STDOUT] [-f=tsv]
+**Important**: this will add songs to your Temporary Playlist and after running, your Now Playing will become the last song in the list.
+
+```shell-session
+$ kbl import [INPUT_FILE or STDIN]
 ```
 
+Sample Input:
+
+    17645049
+    22021717
+    38369455
+    30772971
+    30772977
+
+Which maps to these songs:
+
+| Song ID | Artist | Song Name | Album |
+|---------|--------|-----------|-------|
+| 17645049 | 日笠陽子 | 美しき残酷な世界 | 美しき残酷な世界 |
+| 22021717 | 水樹奈々×T.M.Revolution | 革命デュアリズム | 革命デュアリズム |
+| 38369455 | 喜多村英梨 | Birth | 証×明 -SHOMEI- |
+| 30772971 | 藍井エイル | サンビカ | AUBE |
+| 30772977 | 藍井エイル | シリウス | AUBE |
+
+Result:
+
+* The above songs will be added to the bottom of Temporary Playlist.
+* Your Now Playing song will become シリウス by 藍井エイル from AUBE album.
+
+### Dump
+
+Dump meta data of KKBOX songs from your local KKBOX client database.
+
+**Important:** You have to run `dump` immediately after `import` command. If you ran `import` and start playing another album or artist hot songs within KKBOX, your Temporary Playlist will be cleaned up and you'll lose the meta data, unless you have other playlists containing those songs.
+
+```shell-session
+$ kbl dump [INPUT_FILE or STDIN] [-o=OUTPUT_FILE or STDOUT] [-f=tsv]
+```
+
+The default output format is TSV (Tab-Separated Values, the Tab version of CSV.)
+
+For tabular output like TSV and CSV, the order of columns will be:
+
+* Song ID (pathname)
+* Song Name
+* Artist ID
+* Artist Name
+* Album ID
+* Album Name
+
+Sample Input:
+
+    17645049
+    22021717
+    38369455
+    30772971
+    30772977
+
+Sample Output (TSV):
+
+    17645049	美麗殘酷的世界 (「進擊的巨人」片尾曲)	945776	日笠陽子(Hikasa Yoko)	1685970	美麗殘酷的世界
+    22021717	革命 Dualism	1176631	水樹奈奈 × T.M.Revolution	2084207	革命 Dualism (特別盤)
+    38369455	Birth	830288	喜多村英梨 (Eri Kitamura)	3847501	証×明-SHOMEI-
+    30772971	聖歌（動畫『雙斬少女KILL la KILL』插曲）	475589	藍井艾露 (Eir Aoi)	2828979	Aube初回限定盤
+    30772977	天狼星（動畫『雙斬少女KILL la KILL』片頭曲）	475589	藍井艾露 (Eir Aoi)	2828979	Aube初回限定盤
+
 ## Required Song Meta Data
 
 To generate a working KBL file, the following data for every song must be provided.
@@ -102,9 +162,9 @@ Can exist multiple times across multiple playlists.
 
 ## TODO
 
-* Make a CLI tool for generating KBL files.
-* Scraping meta data from KKBOX client database from given Song IDs.
 * A workflow for how to build a KBL file from Song IDs.
+* More output formats for `kbl dump` command, e.g. CSV, JSON.
+* In Dump command, warn when there are some IDs returns 0, which means it is required to remove those songs from Library and import again.
 
 ## License
 

data/kbl.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'nokogiri', '~> 1.6.1'
+  spec.add_dependency 'haml', '~> 4.0.5'
   spec.add_dependency 'thor', '~> 0.19.1'
   spec.add_dependency 'sqlite3',  '~> 1.3.9'
 

data/lib/kbl.rb

@@ -5,9 +5,5 @@ module KBL
   autoload :Playlist, "kbl/playlist"
   autoload :Song,     "kbl/song"
 
-  module Serializable
-    autoload :Package,  "kbl/serializable/package"
-    autoload :Playlist, "kbl/serializable/playlist"
-    autoload :Song,     "kbl/serializable/song"
-  end
+  autoload :Serializable, "kbl/serializable"
 end

data/lib/kbl/package.rb

@@ -1,6 +1,6 @@
 module KBL
   class Package
-    include KBL::Serializable::Package
+    include KBL::Serializable
 
     attr_reader :kkbox_version, :version, :description, :date, :playlists
 

data/lib/kbl/playlist.rb

@@ -1,6 +1,6 @@
 module KBL
   class Playlist
-    include KBL::Serializable::Playlist
+    include KBL::Serializable
 
     attr_reader :songs
     attr_accessor :name, :description, :id

data/lib/kbl/serializable.rb

@@ -0,0 +1,26 @@
+require 'haml'
+
+module KBL::Serializable
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+
+  def to_xml
+    self.class.template.render(self)
+  end
+
+  module ClassMethods
+    def template
+      @template ||= load_template
+    end
+
+    def load_template
+      filename = File.expand_path("templates/#{template_name}.haml", File.dirname(__FILE__))
+      template = Haml::Engine.new(File.read(filename))
+    end
+
+    def template_name
+      self.to_s.downcase.split("::").last
+    end
+  end
+end

data/lib/kbl/song.rb

@@ -1,6 +1,6 @@
 module KBL
   class Song
-    include KBL::Serializable::Song
+    include KBL::Serializable
 
     attr_accessor :name, :artist, :album, :genre, :preference,
                 :play_count, :pathname, :type, :has_lyrics,

data/lib/kbl/templates/package.haml

@@ -0,0 +1,13 @@
+%utf-8_data
+  %kkbox_package
+  %kkbox_ver= self.kkbox_version
+
+  - @playlists.each do |playlist|
+    = playlist.to_xml
+
+  %package
+    %ver 1.0
+    %descr 包裝說明
+    %packdate= self.date.strftime("%Y%m%d%H%M%S") 
+    %playlistcnt= self.playlists.size 
+    %songcnt= self.total_songs 

data/lib/kbl/templates/playlist.haml

@@ -0,0 +1,7 @@
+%playlist
+  %playlist_id= self.id
+  %playlist_name= self.name
+  %playlist_descr= self.description
+  %playlist_data
+    - @songs.each do |song|
+      = song.to_xml

data/lib/kbl/templates/song.haml

@@ -0,0 +1,13 @@
+%song_data
+  %song_name= self.name
+  %song_artist= self.artist
+  %song_album= self.album
+  %song_genre= self.genre
+  %song_preference= self.preference
+  %song_playcnt= self.play_count
+  %song_pathname= self.pathname
+  %song_type= self.type
+  %song_lyricsexist= self.has_lyrics
+  %song_artist_id= self.artist_id
+  %song_album_id= self.album_id
+  %song_song_idx= self.song_index

data/lib/kbl/version.rb

@@ -1,3 +1,3 @@
 module KBL
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: kbl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yu-Cheng Chuang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-11 00:00:00.000000000 Z
+date: 2014-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: haml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 4.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 4.0.5
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -99,10 +99,11 @@ files:
 - lib/kbl/cli.rb
 - lib/kbl/package.rb
 - lib/kbl/playlist.rb
-- lib/kbl/serializable/package.rb
-- lib/kbl/serializable/playlist.rb
-- lib/kbl/serializable/song.rb
+- lib/kbl/serializable.rb
 - lib/kbl/song.rb
+- lib/kbl/templates/package.haml
+- lib/kbl/templates/playlist.haml
+- lib/kbl/templates/song.haml
 - lib/kbl/version.rb
 homepage: ''
 licenses:

data/lib/kbl/serializable/package.rb

@@ -1,37 +0,0 @@
-module KBL::Serializable
-  module Package
-    def to_kbl
-      to_kbl_node.to_xml({
-        :encoding => 'UTF-8',
-        :indent => 2,
-        :indent_text => " "
-      }).gsub(/<(.+)\/>/, '<\1></\1>')
-    end
-
-    def to_kbl_node
-      doc = Nokogiri::XML.parse(<<-XML, nil, nil, Nokogiri::XML::ParseOptions::NOBLANKS)
-        <utf-8_data><kkbox_package></kkbox_package></utf-8_data>
-      XML
-
-      package_node = doc.css("kkbox_package").first
-
-      package_node << "<kkbox_ver>#{self.kkbox_version}</kkbox_ver>"
-
-      @playlists.each do |playlist|
-        package_node << playlist.to_kbl_node
-      end
-
-      package_node << Nokogiri::XML.parse(<<-XML, nil, nil, Nokogiri::XML::ParseOptions::NOBLANKS).root
-        <package>
-          <ver>1.0</ver>
-          <descr>包裝說明</descr>
-          <packdate>#{ self.date.strftime("%Y%m%d%H%M%S") }</packdate>
-          <playlistcnt>#{ self.playlists.size }</playlistcnt>
-          <songcnt>#{ self.total_songs }</songcnt>
-        </package>
-      XML
-
-      doc.root
-    end
-  end
-end

data/lib/kbl/serializable/playlist.rb

@@ -1,24 +0,0 @@
-require 'nokogiri'
-
-module KBL::Serializable
-  module Playlist
-    def to_kbl_node
-      node = Nokogiri::XML.parse(<<-XML, nil, nil, Nokogiri::XML::ParseOptions::NOBLANKS)
-        <playlist>
-          <playlist_id>#{ self.id }</playlist_id>
-          <playlist_name>#{ self.name }</playlist_name>
-          <playlist_descr>#{ self.description }</playlist_descr>
-          <playlist_data></playlist_data>
-        </playlist>
-      XML
-
-      data_node = node.css("playlist_data").first
-
-      @songs.each do |song|
-        data_node << song.to_kbl_node
-      end
-
-      node.root
-    end
-  end
-end

data/lib/kbl/serializable/song.rb

@@ -1,26 +0,0 @@
-require 'nokogiri'
-
-module KBL::Serializable
-  module Song
-    def to_kbl_node
-      doc = Nokogiri::XML.parse(<<-XML, nil, nil, Nokogiri::XML::ParseOptions::NOBLANKS)
-        <song_data>
-          <song_name>#{ self.name }</song_name>
-          <song_artist>#{ self.artist }</song_artist>
-          <song_album>#{ self.album }</song_album>
-          <song_genre>#{ self.genre }</song_genre>
-          <song_preference>#{ self.preference }</song_preference>
-          <song_playcnt>#{ self.play_count }</song_playcnt>
-          <song_pathname>#{ self.pathname }</song_pathname>
-          <song_type>#{ self.type }</song_type>
-          <song_lyricsexist>#{ self.has_lyrics }</song_lyricsexist>
-          <song_artist_id>#{ self.artist_id }</song_artist_id>
-          <song_album_id>#{ self.album_id }</song_album_id>
-          <song_song_idx>#{ self.song_index }</song_song_idx>
-        </song_data>
-      XML
-
-      doc.root
-    end
-  end
-end