spfy 0.1.7 → 0.1.8

data/README.md

@@ -3,24 +3,27 @@
 ##Overview
 **Spfy** is a command-line tool for generating [XSPF](http://xspf.org/) playlists from metadata stored in several popular audio formats, and is developed entirely in [Ruby](http://www.ruby-lang.org/).  It takes one or more local directory paths as input, extracts metadata tags from any audio files that it encounters, and generates a valid XSPF playlist.
 
-##Installation
-[TagLib](http://developer.kde.org/~wheeler/taglib.html) is required for spfy to work.  Follow the steps below (taken from the [taglib-ruby installation guide](http://robinst.github.com/taglib-ruby/)) to install the necessary files for your respective system type:
+##Prerequisites
+A working Ruby installation version 1.9 or greater is assumed for Spfy to work, but this is outside the scope of this guide.  For more information refer to the [official installation procedure](http://www.ruby-lang.org/en/downloads/).
+
+[TagLib](http://developer.kde.org/~wheeler/taglib.html) is also required for Spfy to function.  Follow the steps below (taken from the [taglib-ruby installation guide](http://robinst.github.com/taglib-ruby/)) to install the necessary files for your respective system type:
 
-> | System:       |  Command:                          |
-> |---------------|------------------------------------|
-> | Debian/Ubuntu | `sudo apt-get install libtag1-dev` |
-> | Fedora/RHEL   | `sudo yum install taglib-devel`    |
-> | Brew          | `brew install taglib`              |
-> | MacPorts      | `sudo port install taglib`         |
+| System:       |  Command:                          |
+|---------------|------------------------------------|
+| Debian/Ubuntu | `sudo apt-get install libtag1-dev` |
+| Fedora/RHEL   | `sudo yum install taglib-devel`    |
+| Brew          | `brew install taglib`              |
+| MacPorts      | `sudo port install taglib`         |
 
-Spfy can then be installed with the following command:
+##Installation
+With the prerequisites above taken care of Spfy can be installed with the following command:
 
 	gem install spfy
-	
-##Using spfy
-By default, spfy will output a formatted XSPF playlist to the standard output stream that will include _location_, _title_, _artist_, and _album_ elements for each audio file where available.
 
-The general syntax for spfy is `spfy [options] dir1 ... dirN`, where _dir1 ... dirN_ is one or more paths to directories containing audio files.
+##Using Spfy
+By default, Spfy will output a formatted XSPF playlist to the standard output stream that will include _location_, _title_, _artist_, and _album_ elements for each audio file where available.
+
+The general syntax for Spfy is `spfy [options] dir1 ... dirN`, where _dir1 ... dirN_ is one or more paths to directories containing audio files.
 
 For example:
 
@@ -42,7 +45,7 @@ For example:
 	
 Spfy supports multiple directory paths (e.g. `spfy /dir1 /dir2`) and traverses each directory recursively by default.  Unsupported files and empty directories in a directory tree are silently ignored and will not impact spfy's output.
 
-Command-line arguments allow you to control which elements spfy outputs:
+Command-line arguments allow you to control which elements Spfy outputs:
 
     -f, --no-location                Suppress file location output
     -t, --no-title                   Suppress track title in output
@@ -52,7 +55,7 @@ Command-line arguments allow you to control which elements spfy outputs:
 For additional options use `spfy --help`.
 
 ##License
-Spfy is licensed under the [GNU General Public License v3.0](http://www.gnu.org/licenses/gpl.html).
+This is free software, and you are welcome to redistribute it under certain conditions.  See the [GNU General Public License](http://www.gnu.org/licenses/gpl.html) for more details.
 
 ##Acknowledgments
 Spfy uses the following third party software components:
@@ -60,6 +63,4 @@ Spfy uses the following third party software components:
 * [taglib-ruby](http://robinst.github.com/taglib-ruby/) by Robin Stocker
 
 ##Comments or suggestions?
-Feel free to contact me with bug reports, feature requests and general comments by emailing [marc.ransome@fidgetbox.co.uk](marc.ransome@fidgetbox.co.uk).
-
-Follow [@marcransome](http://www.twitter.com/marcransome) on Twitter for the latest news.
+Email me at [marc.ransome@fidgetbox.co.uk](marc.ransome@fidgetbox.co.uk) with bug reports, feature requests or general comments and follow [@marcransome](http://www.twitter.com/marcransome) for updates.

data/lib/spfy.rb

@@ -26,7 +26,7 @@ require "taglib"
 require 'find'
 require 'uri'
 
-$version = "0.1.7"
+$version = "0.1.8"
 $dirs = []
 
 # The main Spfy class
@@ -72,6 +72,7 @@ class Spfy
 		# start processing source paths
 		begin
 			if options.output.any?
+				# source path(s) provided, output should be to disk
 			
 				xmlFile = File.open(options.output[0], "w")
 				
@@ -94,12 +95,13 @@ class Spfy
 								tag = fileref.tag
 								
 								# skip files with no tags
-								next if tag.title.empty? and tag.artist.empty? and tag.album.empty?
+								next if tag.nil?
 								
 								# write track metadata
 								xmlFile.write("\t\t<track>\n")
 								
 								if !options.hide_location
+									# generate a percent encoded string from the local path
 									encoded_path = URI.escape(path)
 									xmlFile.write("\t\t\t<location>file://#{encoded_path}</location>\n")
 								end
@@ -107,6 +109,13 @@ class Spfy
 								xmlFile.write("\t\t\t<title>#{tag.title}</title>\n") if !options.hide_title and !tag.title.nil?
 								xmlFile.write("\t\t\t<creator>#{tag.artist}</creator>\n") if !options.hide_artist and !tag.artist.nil?
 								xmlFile.write("\t\t\t<album>#{tag.album}</album>\n") if !options.hide_album and !tag.album.nil?
+								
+								if !options.hide_tracknum and !tag.track.nil?
+									if tag.track > 0
+										xmlFile.write("\t\t\t<trackNum>#{tag.track}</trackNum>\n")
+									end
+								end
+								
 								xmlFile.write("\t\t</track>\n")
 							end
 						rescue Exception => e
@@ -123,7 +132,10 @@ class Spfy
 				
 				print " success\n"
 				
-			else		
+			else
+				# no source path(s) provided, output to stdout
+				
+				# write XSPF header
 				puts "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
 				puts "<playlist version=\"1\" xmlns=\"http://xspf.org/ns/0/\">\n"
 				puts "\t<trackList>\n"
@@ -140,8 +152,8 @@ class Spfy
 								tag = fileref.tag
 			
 								# skip files with no tags
-								next if tag.title.empty? and tag.artist.empty? and tag.album.empty?
-			
+								next if tag.nil?
+								
 								# output track metadata
 								puts "\t\t<track>\n"
 								
@@ -153,10 +165,15 @@ class Spfy
 								puts "\t\t\t<title>#{tag.title}</title>\n" if !options.hide_title and !tag.title.nil?
 								puts "\t\t\t<creator>#{tag.artist}</creator>\n" if !options.hide_artist and !tag.artist.nil?
 								puts "\t\t\t<album>#{tag.album}</album>\n" if !options.hide_album and !tag.album.nil?
+								
+								if !options.hide_tracknum and !tag.track.nil?
+									if tag.track > 0
+										puts "\t\t\t<trackNum>#{tag.track}</trackNum>\n"
+									end
+								end
+
 								puts "\t\t</track>\n"
 							end
-						rescue SystemExit, Interrupt
-							# allow user interrupt
 						rescue Exception => e
 							next
 						end

data/lib/spfy/optionreader.rb

@@ -30,6 +30,7 @@ class OptionReader
 		options.hide_artist = false
 		options.hide_album = false
 		options.hide_location = false
+		options.hide_tracknum = false
 	
 		opts = OptionParser.new do |opts|
 			opts.banner = "Usage: #{File.basename($0)} [options] dir1 ... dirN"
@@ -62,6 +63,10 @@ class OptionReader
 				options.hide_album = true
 			end
 			
+			opts.on("-n", "--no-tracknum", "Suppress track number in output") do
+				options.hide_tracknum = true
+			end
+			
 			opts.separator ""
 			opts.separator "Misc options:"
 			

data/spfy.gemspec

@@ -21,7 +21,7 @@
 
 Gem::Specification.new do |s|
 	s.name			= 'spfy'
-	s.version		= '0.1.7'
+	s.version		= '0.1.8'
 	s.date			= '2012-05-06'
 	s.summary		= 'XSPF playlist generator'
 	s.description	= 'Spfy is a simple command-line tool for generating XSPF playlists from metadata stored in several popular audio formats.'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spfy
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
   prerelease: 
 platform: ruby
 authors:
@@ -61,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: XSPF playlist generator