spfy 0.1.9 → 0.2.0

data/README.md

@@ -21,7 +21,7 @@ With the prerequisites above taken care of Spfy can be installed with the follow
 	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.
+By default, Spfy will output a formatted XSPF playlist to the standard output stream that will include _location_, _title_, _creator_, _album_, and _trackNum_ 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.
 
@@ -39,11 +39,12 @@ For example:
 				<title>A Stitch In Time</title>
 				<creator>The Smashing Pumpkins</creator>
 				<album>Teargarden by Kaleidyscope</album>
+				<trackNum>3</trackNum>
 			</track>
 		</trackList>
 	</playlist>
 	
-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.
+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:
 
@@ -51,11 +52,12 @@ Command-line arguments allow you to control which elements Spfy outputs:
     -t, --no-title                   Suppress track title in output
     -a, --no-artist                  Suppress artist name in output
     -l, --no-album                   Suppress album name in output
+    -n, --no-tracknum                Suppress track number in output
 
 For additional options use `spfy --help`.
 
 ##License
-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.
+Spfy 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:

data/lib/spfy/optionreader.rb

@@ -31,6 +31,8 @@ class OptionReader
 		options.hide_album = false
 		options.hide_location = false
 		options.hide_tracknum = false
+		options.dirs = []
+		options.tracks_to_process = []
 	
 		opts = OptionParser.new do |opts|
 			opts.banner = "Usage: #{File.basename($0)} [options] dir1 ... dirN"
@@ -67,11 +69,16 @@ class OptionReader
 				options.hide_tracknum = true
 			end
 			
+			opts.on("-m", "--max-tracks NUM", "Limit the output to NUM tracks") do |num|
+				options.tracks_to_process << num
+				options.track_limit = true
+			end
+			
 			opts.separator ""
 			opts.separator "Misc options:"
 			
 			opts.on("-v", "--version", "Display version information") do
-				puts "#{File.basename($0).capitalize} #{$version} Copyright (c) 2012 Marc Ransome <marc.ransome@fidgetbox.co.uk>"
+				puts "#{File.basename($0).capitalize} #{$spfy_version} Copyright (c) 2012 Marc Ransome <marc.ransome@fidgetbox.co.uk>"
 				puts "This program comes with ABSOLUTELY NO WARRANTY, use it at your own risk."
 				puts "This is free software, and you are welcome to redistribute it under"
 				puts "certain conditions; type `#{File.basename($0)} --license' for details."
@@ -92,7 +99,7 @@ class OptionReader
 		
 			# add path to global dirs variable
 			if File.directory?(dir)
-				$dirs << dir
+				options.dirs << dir
 			end
 			
 		end

data/lib/spfy.rb

@@ -26,8 +26,7 @@ require "taglib"
 require 'find'
 require 'uri'
 
-$version = "0.1.9"
-$dirs = []
+$spfy_version = "0.2.0"
 
 # The main Spfy class
 class Spfy
@@ -52,8 +51,11 @@ class Spfy
 			# parse command-line arguments
 			options = OptionReader.parse(ARGV)
 			
+			# dirs for traversing
+			dirs = options.dirs
+			
 			# test for zero source paths
-			if $dirs.empty?
+			if dirs.empty?
 				puts "No source path specified."
 				puts simple_usage
 				exit
@@ -89,8 +91,11 @@ class Spfy
 			xmlFile.write("<playlist version=\"1\" xmlns=\"http://xspf.org/ns/0/\">\n")
 			xmlFile.write("\t<trackList>\n")
 			
+			# track count for track limit option
+			tracks_processed = 0
+			
 			# repeat for each source dir argument
-			$dirs.each do |dir|
+			dirs.each do |dir|
 	
 				begin
 					
@@ -124,14 +129,25 @@ class Spfy
 							end
 							
 							xmlFile.write("\t\t</track>\n")
+							
+							# increment our track processed count
+							tracks_processed += 1
+							
+							# if a maximum number track numbe has been set, test whether we have reached the limit
+							if options.tracks_to_process[0].to_i > 0 and tracks_processed == options.tracks_to_process[0].to_i 
+								# write XSPF footer
+								xmlFile.write("\t</trackList>\n")
+								xmlFile.write("</playlist>\n")
+								xmlFile.close
+								print " success\n"
+								exit
+							end
 						end
 					end
-				rescue SystemExit, Interrupt
+				rescue Interrupt
 					abort("\nCancelled, exiting..")
-				rescue Exception => e
-					next
 				end # begin
-			end # $dirs.each do |dir|
+			end # dirs.each do |dir|
 			
 			# write XSPF footer
 			xmlFile.write("\t</trackList>\n")
@@ -149,8 +165,11 @@ class Spfy
 			puts "<playlist version=\"1\" xmlns=\"http://xspf.org/ns/0/\">\n"
 			puts "\t<trackList>\n"
 			
+			# track count for track limit option
+			tracks_processed = 0
+			
 			# repeat for each source dir argument
-			$dirs.each do |dir|
+			dirs.each do |dir|
 
 				begin
 				
@@ -183,14 +202,23 @@ class Spfy
 							end
 							
 							puts "\t\t</track>\n"
+							
+							# increment our track processed count
+							tracks_processed += 1
+
+							# if a maximum number track numbe has been set, test whether we have reached the limit
+							if options.tracks_to_process[0].to_i > 0 and tracks_processed == options.tracks_to_process[0].to_i 
+								# output XSPF footer
+								puts "\t</trackList>\n"
+								puts "</playlist>\n"
+								exit
+							end
 						end
 					end
-				rescue SystemExit, Interrupt
+				rescue Interrupt
 					abort("\nCancelled, exiting..")
-				rescue Exception => e
-					next
 				end # begin
-			end # $dirs.each do |dir|
+			end # dirs.each do |dir|
 			
 			# write XSPF footer
 			puts "\t</trackList>\n"

data/spfy.gemspec

@@ -21,7 +21,7 @@
 
 Gem::Specification.new do |s|
 	s.name			= 'spfy'
-	s.version		= '0.1.9'
+	s.version		= '0.2.0'
 	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.'
@@ -31,4 +31,5 @@ Gem::Specification.new do |s|
 	s.executables		<< 'spfy' 
 	s.add_runtime_dependency 'taglib-ruby', '>= 0.5.0'
 	s.homepage		= 'http://marcransome.github.com/spfy'
-end
+	s.license		= 'GPL-3'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spfy
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -42,7 +42,8 @@ files:
 - license.txt
 - spfy.gemspec
 homepage: http://marcransome.github.com/spfy
-licenses: []
+licenses:
+- GPL-3
 post_install_message: 
 rdoc_options: []
 require_paths: