spfy 0.2.2 → 0.3.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZWYwZjMxOGMyZjUyYzlhZGU2MDc0NTllYTFiMGUzMWMyNTY0YWY3Nw==
-  data.tar.gz: !binary |-
-    MWUyMGIyZTQwNGUwNGU4M2IwNWQyOTNkY2FjZDljZjRlYmQwMzkzOA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    Y2MzMzQzZmYwOGJmYmU1OTRiNzNiMDRlYmE3ZTlkOGRhZDRkZTJmYjNlNzFm
-    MjNjMmM2ZWQ0ZmZiNTZiNzIzNTkxM2VlNDIyMmIyNThmYzQxMzQ1MWZkMjM5
-    MjRmYWVkMjI5MzRhMDgxZWI4YmY5ZWU3OGI3MjIyOTVlZDA4MWE=
-  data.tar.gz: !binary |-
-    YmY2OTZmZmQ1ODJkZDc5ZTFhMDc4YzM2YzY2MTA2ZjMwYzNjZGFkMjVlOGFi
-    NTA2YWM0YWEyM2ZkY2Q5NzBiN2EyYTliNzAwZWIyMjc3OGJiZjdkNmMyMTE0
-    YWEzYmRhNTMwMTI5Yjg4NzMxYTk1Mjk2MGNkNTljZjkxZDQzMDM=
+SHA1:
+  metadata.gz: 263a54780311ead337a8a6fa7af294972a71cce2
+  data.tar.gz: d024e138047f87c0b32fe67734f16aad97b30e5c
+SHA512:
+  metadata.gz: f9da4cce5e4d769b51ac5cfed7798c676a42e2061b45774c78400195071eaf07b0615e9196d524b6916aedeef407ddcdfc63b573c38781f3e61bf041ba710d07
+  data.tar.gz: af57dea93b88002ca38f8d1ee2d666dc455c6375030eaa53695cdfa6af8ee91bd49b0f96164e7e6945c0dab32020f5eabba2475dbe9bda5434a0950c695af797

data/README.md

@@ -1,9 +1,9 @@
-#Spfy ("spiffy")
+# Spfy ("spiffy")
 
-##Overview
+## 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.
 
-##Prerequisites
+## Prerequisites
 A working Ruby installation (version 1.9 or greater) is required 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.  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:
@@ -15,12 +15,12 @@ A working Ruby installation (version 1.9 or greater) is required for Spfy to wor
 | Brew          | `brew install taglib`              |
 | MacPorts      | `sudo port install taglib`         |
 
-##Installation
+## Installation
 With the prerequisites above taken care of Spfy can be installed with the following command:
 
 	$ gem install spfy
 
-##Using Spfy
+## Using Spfy
 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.
@@ -31,19 +31,21 @@ For example:
 	
 ..will produce the following output (where ~/music contains one audio file with valid metadata):
 
-	<?xml version="1.0" encoding="UTF-8"?>
-	<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>
-				<trackNum>3</trackNum>
-			</track>
-		</trackList>
-	</playlist>
-	
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<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>
+			<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.
 
 Command-line arguments allow you to control which elements Spfy outputs:
@@ -56,13 +58,13 @@ Command-line arguments allow you to control which elements Spfy outputs:
 
 For additional options use `spfy --help`.
 
-##License
+## License
 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
+## Acknowledgments
 Spfy uses the following third party software components:
  
 * [taglib-ruby](http://robinst.github.com/taglib-ruby/) by Robin Stocker
 
-##Comments or suggestions?
-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.
+## Comments or suggestions?
+Email me at [marc.ransome@fidgetbox.co.uk](mailto://marc.ransome@fidgetbox.co.uk) with bug reports, feature requests or general comments and follow [@marcransome](http://www.twitter.com/marcransome) for updates.

data/bin/spfy

@@ -2,4 +2,5 @@
 
 require 'spfy'
 
-Spfy.generate
+Spfy.parse_args
+Spfy.generate_xml

data/lib/spfy.rb

@@ -23,208 +23,115 @@ require "spfy/optionreader"
 require "optparse"
 require "ostruct"
 require "taglib"
-require 'find'
-require 'uri'
+require "find"
+require "uri"
 
-# The main Spfy class
 class Spfy
-	
-	VERSION = "0.2.2"
+  
+  VERSION = "1.0.0"
+  USAGE = "Use `#{File.basename($0)} --help` for available options."
+    
+  @xspf_tags = {
+    :header =>          "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"\
+                        "<playlist version=\"1\" xmlns=\"http://xspf.org/ns/0/\">\n"\
+                        "\t<trackList>\n",
+    :footer =>          "\t</trackList>\n</playlist>\n",              
+    :title_start =>     "\t\t\t<title>",
+    :title_end =>       "</title>\n",
+    :creator_start =>   "\t\t\t<creator>",
+    :creator_end =>     "</creator>\n",
+    :album_start =>     "\t\t\t<album>",
+    :album_end =>       "</album>\n",
+    :location_start =>  "\t\t\t<location>file://",
+    :location_end =>    "</location>\n",
+    :track_start =>     "\t\t<track>\n",
+    :track_end =>       "\t\t</track>\n",
+    :track_num_start => "\t\t\t<trackNum>",
+    :track_num_end =>   "</trackNum>\n"
+  }
+  
+  def self.parse_args
+    begin
+      # test for zero arguments
+      if ARGV.empty? then
+        self.exit_with_banner
+      end
+      
+      # parse command-line arguments
+      @options = OptionReader.parse(ARGV)
+      
+      # test for zero source paths
+      if @options.dirs.empty?
+        exit_with_message("No source path(s) specified.")
+      end
+      
+    rescue OptionParser::InvalidOption, OptionParser::MissingArgument => error
+      exit_with_message(error.to_s.capitalize)
+    end
+  end
+  
+  def self.generate_xml
 
-	##
-	# Starts the XSPF generator.
-	#
-	def self.generate
+    if @options.output.any?
+      puts "Generating XML..."
+      self.capture_stdout
+    end
+    
+    puts @xspf_tags[:header]
+    tracks_processed = 0
+    
+    @options.dirs.each do |dir|
+      begin
+        Find.find(dir) do |path|
+          TagLib::FileRef.open(path) do |fileref|  
+            tag = fileref.tag
+            
+            next if tag.nil? # skip files with no tags
+            
+            puts "#{@xspf_tags[:track_start]}"
+            
+            if !@options.hide_location
+              encoded_path = URI.escape(path).sub("%5C", "/") # percent encode string for local path
+              puts "#{@xspf_tags[:location_start]}#{encoded_path}#{@xspf_tags[:location_end]}"
+            end
+            
+            puts "#{@xspf_tags[:title_start]}#{tag.title}#{@xspf_tags[:title_end]}" if !@options.hide_title and !tag.title.nil?
+            puts "#{@xspf_tags[:creator_start]}#{tag.artist}#{@xspf_tags[:creator_end]}" if !@options.hide_artist and !tag.artist.nil?
+            puts "#{@xspf_tags[:album_start]}#{tag.album}#{@xspf_tags[:album_end]}" if !@options.hide_album and !tag.album.nil?
+            
+            if !@options.hide_tracknum and !tag.track.nil?
+              if tag.track > 0
+                puts "#{@xspf_tags[:track_num_start]}#{tag.track}#{@xspf_tags[:track_num_end]}"
+              end
+            end
+            
+            puts "#{@xspf_tags[:track_end]}"
+            
+            tracks_processed += 1
+            break if @options.tracks_to_process[0].to_i > 0 and tracks_processed == options.tracks_to_process[0].to_i
+          end
+        end
+      rescue Interrupt
+        abort("\nCancelled, exiting..")
+      end
+    end
+    puts @xspf_tags[:footer]
+    
+    $stdout = STDOUT if @options.output.any?
+  end
 
-		# start processing command line arguments
-		begin
-		
-			# short usage banner
-			simple_usage = "Use `#{File.basename($0)} --help` for available options."
-		
-			# test for zero arguments
-			if ARGV.empty? then
-				puts simple_usage
-				exit
-			end
-			
-			# parse command-line arguments
-			options = OptionReader.parse(ARGV)
-			
-			# dirs for traversing
-			dirs = options.dirs
-			
-			# test for zero source paths
-			if dirs.empty?
-				puts "No source path specified."
-				puts simple_usage
-				exit
-			end
-			
-		rescue OptionParser::InvalidOption => t
-			puts t
-			puts simple_usage
-			exit
-		rescue OptionParser::MissingArgument => m
-			puts m
-			puts simple_usage
-			exit
-		end
-		
-		# start processing source paths
-		if options.output.any?
-			# source path(s) provided, output should be to disk
-			
-			# open output file for writing
-			begin
-				xmlFile = File.open(options.output[0], "w")
-			rescue
-				puts "Unable to open output file for writing."
-				puts simple_usage
-				exit
-			end
-			
-			print "Generating XML.."
-
-			# write XSPF header
-			xmlFile.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n")
-			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|
-	
-				begin
-					
-					# repeat for each file recursively
-					Find.find(dir) do |path|
-					
-						TagLib::FileRef.open(path) do |fileref|
-							
-							tag = fileref.tag
-							
-							# skip files with no tags
-							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).sub("%5C", "/")
-								xmlFile.write("\t\t\t<location>file://#{encoded_path}</location>\n")
-							end
-							
-							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")
-							
-							# 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 Interrupt
-					abort("\nCancelled, exiting..")
-				end # begin
-			end # dirs.each do |dir|
-			
-			# write XSPF footer
-			xmlFile.write("\t</trackList>\n")
-			xmlFile.write("</playlist>\n")
-			
-			xmlFile.close
-			
-			print " success\n"
-			
-		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"
-			
-			# track count for track limit option
-			tracks_processed = 0
-			
-			# repeat for each source dir argument
-			dirs.each do |dir|
-
-				begin
-				
-					# repeat for each file recursively
-					Find.find(dir) do |path|
-					
-						TagLib::FileRef.open(path) do |fileref|
-						
-							tag = fileref.tag
-		
-							# skip files with no tags
-							next if tag.nil?
-							
-							# output track metadata
-							puts "\t\t<track>\n"
-							
-							if !options.hide_location
-								encoded_path = URI.escape(path).sub("%5C", "/")
-								puts "\t\t\t<location>file://#{encoded_path}</location>\n"
-							end
-							
-							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"
-							
-							# 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 Interrupt
-					abort("\nCancelled, exiting..")
-				end # begin
-			end # dirs.each do |dir|
-			
-			# write XSPF footer
-			puts "\t</trackList>\n"
-			puts "</playlist>\n"
-		end
-
-	end # def self.generate
-
-end # class Spyf
+  def self.exit_with_message(message)
+    puts message if message
+    exit_with_banner
+  end
+  
+  def self.exit_with_banner
+    puts USAGE
+    exit
+  end
+    
+  def self.capture_stdout
+    $stdout = File.open(@options.output[0], "w")
+  end
+  
+end

data/spfy.gemspec

@@ -20,16 +20,16 @@
 #  along with Spfy.  If not, see <http://www.gnu.org/licenses/>.
 
 Gem::Specification.new do |s|
-	s.name			= 'spfy'
-	s.version		= '0.2.2'
-	s.date			= '2013-02-26'
-	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.'
-	s.authors		= ["Marc Ransome"]
-	s.email			= 'marc.ransome@fidgetbox.co.uk'
-	s.files			= `git ls-files`.split("\n")
-	s.executables		<< 'spfy' 
-	s.add_runtime_dependency 'taglib-ruby', '>= 0.5.0'
-	s.homepage		= 'http://marcransome.github.com/spfy'
-	s.license		= 'GPL-3'
+  s.name        = 'spfy'
+  s.version     = '0.3.0'
+  s.date        = '2013-07-28'
+  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.'
+  s.authors     = ["Marc Ransome"]
+  s.email       = 'marc.ransome@fidgetbox.co.uk'
+  s.files       = `git ls-files`.split("\n")
+  s.executables << 'spfy' 
+  s.add_runtime_dependency 'taglib-ruby', '>= 0.5.0'
+  s.homepage    = 'http://marcransome.github.com/spfy'
+  s.license     = 'GPL-3'
 end

data/test.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+#
+#  test.sh
+#  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/>.
+
+version_from_gemspec=$( grep 's.version' spfy.gemspec | cut -c 16-20 )
+gem_file="spfy-$version_from_gemspec.gem"
+
+echo "Removing outdated gem files.."
+rm *.gem
+
+echo "Uninstalling previous versions.."
+gem uninstall -a -x spfy
+
+echo "Building gem.."
+gem build spfy.gemspec
+
+echo "Installing gem file.."
+gem install $gem_file

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: spfy
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Marc Ransome
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-26 00:00:00.000000000 Z
+date: 2013-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: taglib-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.5.0
 description: Spfy is a simple command-line tool for generating XSPF playlists from
@@ -38,6 +38,7 @@ files:
 - lib/spfy.rb
 - lib/spfy/optionreader.rb
 - spfy.gemspec
+- test.sh
 homepage: http://marcransome.github.com/spfy
 licenses:
 - GPL-3
@@ -48,17 +49,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: XSPF playlist generator