spfy 0.1.4 → 0.1.5

data/README.md

@@ -1,7 +1,7 @@
 #Spfy ("spiffy")
 
 ##Overview
-**Spfy** is a command-line ruby tool for generating XSPF playlists from metadata stored in several popular audio formats.
+**Spfy** is a command-line tool for generating XSPF playlists from metadata stored in several popular audio formats, developed entirely in [Ruby](http://www.ruby-lang.org/).
 
 ##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:
@@ -12,17 +12,15 @@
 > | Fedora/RHEL   | `sudo yum install taglib-devel`    |
 > | Brew          | `brew install taglib`              |
 > | MacPorts      | `sudo port install taglib`         |
-> 
-> Windows users on Ruby 1.9 don't need that, because there is a pre-compiled binary gem available which bundles taglib.
 
-With the prerequisites out of the way install spfy by typing:
+With the prerequisites taken care of spfy can be installed with the following command:
 
 	gem install spfy
 	
 ##Using spfy
-By default, spfy will output a formatted [XSPF](http://xspf.org/) playlist to the standard output stream that will include _title_, _artist_, and _album_ tags for each audio file where available.
+By default, spfy will output a formatted [XSPF](http://xspf.org/) 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 running spfy is `spfy [options] [source]`, where _source_ is a valid path to a directory containing audio files.
+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:
 
@@ -34,6 +32,7 @@ For example:
 	<playlist version="1" xmlns="http://xspf.org/ns/0/">
 		<trackList>
 			<track>
+				<location>file:///Users/spfy/music/03%20A%20Stitch%20In%20Time.mp3</location>
 				<title>A Stitch In Time</title>
 				<creator>The Smashing Pumpkins</creator>
 				<album>Teargarden by Kaleidyscope</album>
@@ -41,9 +40,11 @@ For example:
 		</trackList>
 	</playlist>
 	
-Command-line arguments are available to output to a file on disk or suppress unwanted tags:
+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.
 
-    -o, --output FILE                File to output XSPF data to
+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
     -a, --no-artist                  Suppress artist name in output
     -l, --no-album                   Suppress album name in output

data/lib/spfy.rb

@@ -17,7 +17,7 @@
 #  GNU General Public License for more details.
 #
 #  You should have received a copy of the GNU General Public License
-#  along with Spfy.  If not, see <http:#www.gnu.org/licenses/>.
+#  along with Spfy.  If not, see <http://www.gnu.org/licenses/>.
 
 require "spfy/optionreader"
 require "optparse"
@@ -26,7 +26,7 @@ require "taglib"
 require 'find'
 require 'uri'
 
-$version = "0.1.4"
+$version = "0.1.5"
 $dirs = []
 
 # The main Spfy class

data/lib/spfy/optionreader.rb

@@ -1,3 +1,24 @@
+#
+#  optionreader.rb
+#  Spfy ("spiffy")
+#
+#  Copyright (c) 2012, Marc Ransome <marc.ransome@fidgetbox.co.uk>
+#
+#  This file is part of Spfy.
+#
+#  Spfy is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  Spfy is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with Spfy.  If not, see <http://www.gnu.org/licenses/>.
+
 class OptionReader
 
 	def self.parse(args)

data/spfy.gemspec

@@ -17,11 +17,11 @@
 #  GNU General Public License for more details.
 #
 #  You should have received a copy of the GNU General Public License
-#  along with Spfy.  If not, see <http:#www.gnu.org/licenses/>.
+#  along with Spfy.  If not, see <http://www.gnu.org/licenses/>.
 
 Gem::Specification.new do |s|
 	s.name			= 'spfy'
-	s.version		= '0.1.4'
+	s.version		= '0.1.5'
 	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.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors: