spfy 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf17141af7094be0bea0539178739b64a2026191
-  data.tar.gz: 3b4de8e6335d3c118ac4a3198faa16190c7820bc
+  metadata.gz: bf086944e45afbf5e0b3518d00b3ebaaaa261f9b
+  data.tar.gz: f32cc7491b140891272a0c56bc25968b1a7a69ad
 SHA512:
-  metadata.gz: 10913f7fd7750d4983345aeb4957395b5529f4a41b2984b06906cb239fdd70662858e67ee0d806e2215e7dea6e3269483e2e95717c0940279612586c19727427
-  data.tar.gz: ab139fee487a2c809465c9b8d4c244ebb0e71bbf7ecf88ef848943027e33cc7fffbda5748d4f8f9b886b8a218108c771f33d7ecb2004adf09702347055c56609
+  metadata.gz: d2357fef3dae3191e26b38a30e0a6852b19bfb675271aa52958d59d336a834cdafefad75653811bda4fa7b8b1d05580878e1063f6a9d24267365dd89c4ea66b2
+  data.tar.gz: 65d1bf4328dacaf7ca232a5b9db632daccc1d9f294f01afba9fccaf1a8c6180b565f5798f6571f901a0d4827539f6b54c0cf85e0596a85a6141680c4e801fcac

data/README.md

@@ -1,9 +1,10 @@
-# Spfy ("spiffy")
+## Spfy ("spiffy")
+[![Code Climate](https://codeclimate.com/github/marcransome/Spfy.png)](https://codeclimate.com/github/marcransome/Spfy)
 
-## 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 +16,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.
@@ -58,13 +59,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?
+### 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/lib/spfy.rb

@@ -18,6 +18,7 @@
 #
 #  You should have received a copy of the GNU General Public License
 #  along with Spfy.  If not, see <http://www.gnu.org/licenses/>.
+#
 
 require "spfy/optionreader"
 require "optparse"
@@ -28,18 +29,18 @@ require "uri"
 
 class Spfy
   
-  VERSION = "0.3.1"
+  VERSION = "1.0.0"
   USAGE = "Use `#{File.basename($0)} --help` for available options."
     
-  @xspf_tags = {
+  @xml_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",
+    :artist_start =>   "\t\t\t<creator>",
+    :artist_end =>     "</creator>\n",
     :album_start =>     "\t\t\t<album>",
     :album_end =>       "</album>\n",
     :location_start =>  "\t\t\t<location>file://",
@@ -52,9 +53,8 @@ class Spfy
   
   def self.parse_args
     begin
-      # test for zero arguments
       if ARGV.empty? then
-        self.exit_with_banner
+        exit_with_banner
       end
       
       # parse command-line arguments
@@ -64,62 +64,77 @@ class Spfy
       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
+    @tracks_processed = 0
 
     if @options.output.any?
       puts "Generating XML..."
-      self.capture_stdout
+      capture_stdout
     end
     
-    puts @xspf_tags[:header]
-    tracks_processed = 0
-    
+    puts @xml_tags[:header]
     @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
+      catch :MaxTracksReached do
+        begin
+          Find.find(dir) do |path|
+            xml_for_path(path)
           end
+        rescue Interrupt
+          abort("\nCancelled, exiting..")
         end
-      rescue Interrupt
-        abort("\nCancelled, exiting..")
       end
     end
-    puts @xspf_tags[:footer]
+    puts @xml_tags[:footer]
     
     $stdout = STDOUT if @options.output.any?
   end
 
+  def self.xml_for_path(path)    
+    TagLib::FileRef.open(path) do |fileref|  
+      tags = fileref.tag
+      
+      next if tags.nil? # skip files with no tags
+      
+      puts "#{@xml_tags[:track_start]}"      
+      parse_location(path)
+      parse_tag(tags.title, @options.hide_title, @xml_tags[:title_start], @xml_tags[:title_end])
+      parse_tag(tags.artist, @options.hide_artist, @xml_tags[:artist_start], @xml_tags[:artist_end])
+      parse_tag(tags.album, @options.hide_album, @xml_tags[:album_start], @xml_tags[:album_end])
+      parse_track_num(tags.track)
+      puts "#{@xml_tags[:track_end]}"
+      
+      @tracks_processed += 1
+      throw :MaxTracksReached if @options.tracks_to_process[0].to_i > 0 and @tracks_processed == @options.tracks_to_process[0].to_i
+    end
+  end
+  
+  def self.parse_location(path)
+    if !@options.hide_location
+      encoded_path = URI.escape(path).sub("%5C", "/") # percent encode string for local path
+      puts "#{@xml_tags[:location_start]}#{encoded_path}#{@xml_tags[:location_end]}"
+    end
+  end
+  
+  def self.parse_tag(tag, suppress_output, start_xml, end_xml)
+    if !tag.nil? and !suppress_output
+      puts "#{start_xml}#{tag}#{end_xml}"      
+    end
+  end
+  
+  def self.parse_track_num(track_num)
+    if !@options.hide_tracknum and !track_num.nil?
+      if track_num > 0
+        puts "#{@xml_tags[:track_num_start]}#{track_num}#{@xml_tags[:track_num_end]}"
+      end
+    end
+  end
+
   def self.exit_with_message(message)
     puts message if message
     exit_with_banner
@@ -133,5 +148,5 @@ class Spfy
   def self.capture_stdout
     $stdout = File.open(@options.output[0], "w")
   end
-  
+  private_class_method :xml_for_path, :parse_location, :parse_tag, :parse_track_num, :exit_with_message, :exit_with_banner, :capture_stdout
 end

data/spfy.gemspec

@@ -21,7 +21,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'spfy'
-  s.version     = '0.3.1'
+  s.version     = '1.0.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.'

data/test.sh

@@ -20,7 +20,7 @@
 #  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 )
+version_from_gemspec=$( grep 's.version' spfy.gemspec | cut -c 20-24 )
 gem_file="spfy-$version_from_gemspec.gem"
 
 echo "Removing outdated gem files.."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spfy
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Marc Ransome