mp3renamer 0.0.1 → 0.0.3

data/History.txt

@@ -1,4 +1,3 @@
-== 1.0.0 / 2009-02-23
+== 0.0.1 / 2009-02-23
 
-* 1 major enhancement
-  * Birthday!
+* Initial release

data/README.txt

@@ -1,32 +1,130 @@
 mp3renamer
-    by FIXME (your name)
-    FIXME (url)
 
-== DESCRIPTION:
+    by Garry A Offord (garry.offord@hushmail.com)
+    http://rubyforge.org/projects/mp3renamer/
 
-FIXME (describe your package)
+== DESCRIPTION:
 
+This program takes an MP3 audiobook and renames the subdirs and files using a consistent naming convention.
+It also updates the ID3v1 and ID3v2 tags for artist, album, track number, track title, genre, and year.
+
+NOTES
+ 
+(1) The following source directory structure is assumed for this program:
+ 
+      <artist>
+          |
+          `--- <album>                   <==== this is the SOURCE-DIRECTORY command line parameter.
+                  |
+                  +--- <disc 1>
+                  |       |
+                  |       +--- <disc 1 track 1>.mp3
+                  |       +--- <disc 1 track 2>.mp3
+                  |       |           ...
+                  |       `--- <disc 1 track N1>.mp3
+                  |
+                  +--- <disc 2>
+                  |       |
+                  |       +--- <disc 2 track 1>.mp3
+                  |       +--- <disc 2 track 2>.mp3
+                  |       |           ...
+                  |       `--- <disc 2 track N1>.mp3
+                  |
+                  |      ...
+                  |
+                  `--- <disc M>
+                          |
+                          +--- <disc M track 1>.mp3
+                          +--- <disc M track 2>.mp3
+                          |           ...
+                          `--- <disc M track NM>.mp3
+ 
+ 
+(2) The following output directory structure will be created:
+ 
+      <output-directory>                 <==== this is value of the --output command line parameter.
+          |
+          `--- <artist>
+                  |
+                  `--- <album>
+                          |
+                          +--- <album> [D01.MM]
+                          |       |
+                          |       +--- D01.MM-T01.N1.mp3
+                          |       +--- D01.MM-T02.N1.mp3
+                          |       |           ...
+                          |       `--- D01.MM-TN1.N1.mp3
+                          |
+                          +--- <album> [D02.MM]
+                          |       |
+                          |       +--- D02.MM-T01.N2.mp3
+                          |       +--- D02.MM-T02.N2.mp3
+                          |       |           ...
+                          |       `--- D02.MM-TN2.N2.mp3
+                          |
+                          |      ...
+                          |
+                          `--- <album> [DMM.MM]
+                                  |
+                                  +--- DMM.MM-T01.NN.mp3
+                                  +--- DMM.MM-T02.NN.mp3
+                                  |           ...
+                                  `--- DMM.MM-TNN.NN.mp3
+ 
+ 
+ 
 == FEATURES/PROBLEMS:
 
-* FIXME (list of features or problems)
+* Renames folders and files using a consistent naming convention.
+* Sets the ID3v1 and ID3v2 tags for artist, album, track number, track title, genre, and year.
+  * Note that although the individual album folders are renamed to have the disc number as
+    a part of album name, the album name set in the ID3 tags do not include the disc number.
 
 == SYNOPSIS:
 
-  FIXME (code sample of usage)
+Usage: 
+    mp3renamer.rb [options] SOURCE-DIRECTORY
+ 
+Options
+ 
+    -o, --output DIRECTORY           Directory into which the renamed files will be written.
+                                     Default is: C:/DOCUME~1/ec2yvgm/LOCALS~1/Temp/renamed_mp3_files
+ 
+    -a, --artist ARTIST-NAME         Name of the album's artist.
+                                     Default is: base name of the PARENT directory
+ 
+    -t, --title ALBUM-TITLE          Title of the album.
+                                     Default is: base name of the CURRENT directory
+ 
+    -y, --year RELEASE-YEAR          Year of the album's release.
+                                     Default is: 2009
+ 
+    -c, --[no-]copy-files            Copy files from source directory into output directory.
+                                     Default is: true
+ 
+    -1, --[no-]update-id3v1-tags     Update ID3v1 tags for artist, album, track number, track title, genre, and year.
+                                     Default is: true
+ 
+    -2, --[no-]update-id3v2-tags     Update ID3v2 tags for artist, album, track number, track title, genre, and year.
+                                     Default is: true
+
+    -h, --help                       This help info.
 
 == REQUIREMENTS:
 
-* FIXME (list of requirements)
+* bones        (>= 2.4.0)
+* cooloptions  (>= 1.1.1)
+* ruby-mp3info (>= 0.6.12)
 
 == INSTALL:
 
-* FIXME (sudo gem install, anything else)
+* gem install mp3renamer
 
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2008 FIXME (different license?)
+Copyright (c) 2009 Garry A Offord
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -19,12 +19,45 @@ require 'mp3renamer'
 task :default => 'spec:run'
 
 PROJ.name = 'mp3renamer'
-PROJ.authors = 'FIXME (who is writing this software)'
-PROJ.email = 'FIXME (your e-mail)'
-PROJ.url = 'FIXME (project homepage)'
+PROJ.authors = 'Garry A Offord'
+PROJ.email = 'garry.offord@hushmail.com'
+PROJ.url = 'http://rubyforge.org/projects/mp3renamer/'
 PROJ.version = Mp3renamer::VERSION
 PROJ.rubyforge.name = 'mp3renamer'
+PROJ.exclude = %w(tmp$ bak$ ~$ CVS \.svn ^pkg ^doc Manifest.txt)
+
+depend_on 'cooloptions' , '1.1.1'
+depend_on 'ruby-mp3info', '0.6.12'
 
 PROJ.spec.opts << '--color'
 
+desc "Sets the 'svn:ignore' property on all subdirs in the current dir tree that contain an '.svnignore' file."
+task 'svn:ignore' do
+    Dir['**/.svnignore'].each do |entry|
+        here = Dir::pwd
+        Dir::chdir(File.dirname(entry))
+        sh %{svn propset svn:ignore -F .svnignore .} do |ok, res|
+            if ! ok
+                puts "Svn ignore property could not be set on #{Dir::pwd}: error code = #{res.exitstatus}"
+            end
+        end
+        Dir::chdir here
+    end
+end
+
+desc "Sets the 'svn:keywords' property to 'Id' on all source and text files in the current dir tree."
+task 'svn:keywords' do
+    Dir['**/*'].each do |entry|
+        next if entry =~ /\/\.svn\//
+        next if File.directory?(entry)
+        next if File.basename(entry) !~ /((Rakefile)|(.rb)|(.txt)|(.bat)|(.rake)|(.rdoc))$/i
+        next if not File.exist?(File.join(File.dirname(entry), '.svn', 'text-base', File.basename(entry) + '.svn-base'))
+        sh %{svn propset svn:keywords Id #{entry}} do |ok, res|
+            if ! ok
+                puts "Svn keywords property could not be set on #{entry}: error code = #{res.exitstatus}"
+            end
+        end
+    end
+end
+
 # EOF

data/bin/mp3renamer.rb

@@ -1,5 +1,9 @@
 #!C:\ruby\bin\ruby.exe
 
+#======================================================================
+# $Id: mp3renamer.rb 4 2009-03-06 04:54:38Z gofford $
+#======================================================================
+
 require File.expand_path(
     File.join(File.dirname(__FILE__), %w[.. lib mp3renamer]))
 require 'rubygems'
@@ -133,6 +137,7 @@ options = CoolOptions.parse!('[options] SOURCE-DIRECTORY') do |cooloptions|
     cooloptions.on 'update-id3v(1)-tags', 'Update ID3v1 tags for artist, album, track number, track title, genre, and year.', true
     cooloptions.desc ' '
     cooloptions.on 'update-id3v(2)-tags', 'Update ID3v2 tags for artist, album, track number, track title, genre, and year.', true
+    cooloptions.desc ' '
 
     cooloptions.after do |result|
         if result.year !~ /^(\d\d\d\d)$/
@@ -171,4 +176,4 @@ ARGV.each do |src_dir|
     renamer.write_album(target_dir)
     renamer.update_id3_tags(target_dir)
 end
-puts ''
+puts ''

data/lib/mp3/album.rb

@@ -1,3 +1,7 @@
+#======================================================================
+# $Id: album.rb 3 2009-03-06 04:51:49Z gofford $
+#======================================================================
+
 require 'mp3/disc'
 require 'utils/parser'
 
@@ -111,4 +115,4 @@ class Mp3
         
     end # Album
     
-end # Mp3
+end # Mp3

data/lib/mp3/disc.rb

@@ -1,3 +1,7 @@
+#======================================================================
+# $Id: disc.rb 3 2009-03-06 04:51:49Z gofford $
+#======================================================================
+
 require 'mp3/track'
 require 'utils/parser'
 require 'utils/formatter'
@@ -93,4 +97,4 @@ class Mp3
         
     end # Disc
     
-end # Mp3
+end # Mp3

data/lib/mp3/renamer.rb

@@ -1,3 +1,7 @@
+#======================================================================
+# $Id: renamer.rb 3 2009-03-06 04:51:49Z gofford $
+#======================================================================
+
 require 'fileutils'
 require 'find'
 require 'ftools'
@@ -110,4 +114,4 @@ class Mp3
         
     end # Renamer
 
-end # Mp3
+end # Mp3

data/lib/mp3/track.rb

@@ -1,3 +1,7 @@
+#======================================================================
+# $Id: track.rb 3 2009-03-06 04:51:49Z gofford $
+#======================================================================
+
 require 'mp3info'
 
 require 'utils/parser'
@@ -98,4 +102,4 @@ class Mp3
         
     end # Track 
     
-end # Mp3
+end # Mp3

data/lib/mp3renamer.rb

@@ -1,8 +1,11 @@
+#======================================================================
+# $Id: mp3renamer.rb 9 2009-03-11 05:14:24Z gofford $
+#======================================================================
 
 module Mp3renamer
 
   # :stopdoc:
-  VERSION = '0.0.1'
+  VERSION = '0.0.3'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/lib/utils/formatter.rb

@@ -1,3 +1,7 @@
+#======================================================================
+# $Id: formatter.rb 3 2009-03-06 04:51:49Z gofford $
+#======================================================================
+
 module Utils
 
     module Formatter

data/lib/utils/parser.rb

@@ -1,3 +1,7 @@
+#======================================================================
+# $Id: parser.rb 3 2009-03-06 04:51:49Z gofford $
+#======================================================================
+
 module Utils
 
     module Parser

data/mp3renamer.gemspec

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mp3renamer}
+  s.version = "0.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Garry A Offord"]
+  s.date = %q{2009-03-12}
+  s.default_executable = %q{mp3renamer.rb}
+  s.description = %q{This program takes an MP3 audiobook and renames the subdirs and files using a consistent naming convention. It also updates the ID3v1 and ID3v2 tags for artist, album, track number, track title, genre, and year.}
+  s.email = %q{garry.offord@hushmail.com}
+  s.executables = ["mp3renamer.rb"]
+  s.extra_rdoc_files = ["History.txt", "README.txt"]
+  s.files = ["History.txt", "README.txt", "Rakefile", "bin/mp3renamer.rb", "lib/mp3/album.rb", "lib/mp3/disc.rb", "lib/mp3/renamer.rb", "lib/mp3/track.rb", "lib/mp3renamer.rb", "lib/utils/formatter.rb", "lib/utils/parser.rb", "mp3renamer.gemspec", "spec/mp3renamer_spec.rb", "spec/spec_helper.rb", "test/test_mp3renamer.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://rubyforge.org/projects/mp3renamer/}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{mp3renamer}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{This program takes an MP3 audiobook and renames the subdirs and files using a consistent naming convention}
+  s.test_files = ["test/test_mp3renamer.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<cooloptions>, [">= 1.1.1"])
+      s.add_runtime_dependency(%q<ruby-mp3info>, [">= 0.6.12"])
+      s.add_development_dependency(%q<bones>, [">= 2.4.2"])
+    else
+      s.add_dependency(%q<cooloptions>, [">= 1.1.1"])
+      s.add_dependency(%q<ruby-mp3info>, [">= 0.6.12"])
+      s.add_dependency(%q<bones>, [">= 2.4.2"])
+    end
+  else
+    s.add_dependency(%q<cooloptions>, [">= 1.1.1"])
+    s.add_dependency(%q<ruby-mp3info>, [">= 0.6.12"])
+    s.add_dependency(%q<bones>, [">= 2.4.2"])
+  end
+end

data/spec/mp3renamer_spec.rb

@@ -1,3 +1,6 @@
+#======================================================================
+# $Id: mp3renamer_spec.rb 3 2009-03-06 04:51:49Z gofford $
+#======================================================================
 
 require File.join(File.dirname(__FILE__), %w[spec_helper])
 

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+#======================================================================
+# $Id: spec_helper.rb 3 2009-03-06 04:51:49Z gofford $
+#======================================================================
 
 require File.expand_path(
     File.join(File.dirname(__FILE__), %w[.. lib mp3renamer]))

data/tasks/rdoc.rake

@@ -19,10 +19,11 @@ namespace :doc do
             end
     rd.rdoc_files.push(*files)
 
-    title = "#{PROJ.name}-#{PROJ.version} Documentation"
-
+    name    = PROJ.name
     rf_name = PROJ.rubyforge.name
-    title = "#{rf_name}'s " + title if rf_name.valid? and rf_name != title
+
+    title = "#{name}-#{PROJ.version} Documentation"
+    title = "#{rf_name}'s " + title if rf_name.valid? and rf_name != name
 
     rd.options << "-t #{title}"
     rd.options.concat(rdoc.opts)

data/tasks/setup.rb

@@ -6,7 +6,7 @@ require 'fileutils'
 require 'ostruct'
 require 'find'
 
-class OpenStruct; undef :gem; end
+class OpenStruct; undef :gem if defined? :gem; end 
 
 # TODO: make my own openstruct type object that includes descriptions
 # TODO: use the descriptions to output help on the available bones options
@@ -124,9 +124,7 @@ import(*rakefiles)
 %w(lib ext).each {|dir| PROJ.libs << dir if test ?d, dir}
 
 # Setup some constants
-WIN32 = %r/djgpp|(cyg|ms|bcc)win|mingw/ =~ RUBY_PLATFORM unless defined? WIN32
-
-DEV_NULL = WIN32 ? 'NUL:' : '/dev/null'
+DEV_NULL = File.exist?('/dev/null') ? '/dev/null' : 'NUL:'
 
 def quiet( &block )
   io = [STDOUT.dup, STDERR.dup]
@@ -139,21 +137,15 @@ ensure
   $stdout, $stderr = STDOUT, STDERR
 end
 
-DIFF = if WIN32 then 'diff.exe'
-       else
-         if quiet {system "gdiff", __FILE__, __FILE__} then 'gdiff'
-         else 'diff' end
-       end unless defined? DIFF
-
-SUDO = if WIN32 then ''
-       else
-         if quiet {system 'which sudo'} then 'sudo'
-         else '' end
-       end
-
-RCOV = WIN32 ? 'rcov.bat' : 'rcov'
-RDOC = WIN32 ? 'rdoc.bat' : 'rdoc'
-GEM  = WIN32 ? 'gem.bat'  : 'gem'
+DIFF = if system("gdiff '#{__FILE__}' '#{__FILE__}' > #{DEV_NULL} 2>&1") then 'gdiff'
+       else 'diff' end unless defined? DIFF
+
+SUDO = if system("which sudo > #{DEV_NULL} 2>&1") then 'sudo'
+       else '' end unless defined? SUDO
+
+RCOV = "#{RUBY} -S rcov"
+RDOC = "#{RUBY} -S rdoc"
+GEM  = "#{RUBY} -S gem"
 
 %w(rcov spec/rake/spectask rubyforge bones facets/ansicode).each do |lib|
   begin

data/test/test_mp3renamer.rb

@@ -0,0 +1,4 @@
+#======================================================================
+# $Id: test_mp3renamer.rb 3 2009-03-06 04:51:49Z gofford $
+#======================================================================
+

metadata

@@ -1,17 +1,37 @@
 --- !ruby/object:Gem::Specification 
 name: mp3renamer
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors: 
-- FIXME (who is writing this software)
+- Garry A Offord
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-03-05 00:00:00 -06:00
+date: 2009-03-12 00:00:00 -05:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cooloptions
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-mp3info
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.12
+    version: 
 - !ruby/object:Gem::Dependency 
   name: bones
   type: :development
@@ -20,22 +40,19 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.4.0
+        version: 2.4.2
     version: 
-description: FIXME (describe your package)
-email: FIXME (your e-mail)
+description: This program takes an MP3 audiobook and renames the subdirs and files using a consistent naming convention. It also updates the ID3v1 and ID3v2 tags for artist, album, track number, track title, genre, and year.
+email: garry.offord@hushmail.com
 executables: 
 - mp3renamer.rb
 extensions: []
 
 extra_rdoc_files: 
 - History.txt
-- Manifest.txt
 - README.txt
 files: 
-- .svnignore
 - History.txt
-- Manifest.txt
 - README.txt
 - Rakefile
 - bin/mp3renamer.rb
@@ -46,6 +63,7 @@ files:
 - lib/mp3renamer.rb
 - lib/utils/formatter.rb
 - lib/utils/parser.rb
+- mp3renamer.gemspec
 - spec/mp3renamer_spec.rb
 - spec/spec_helper.rb
 - tasks/ann.rake
@@ -62,7 +80,7 @@ files:
 - tasks/test.rake
 - test/test_mp3renamer.rb
 has_rdoc: true
-homepage: FIXME (project homepage)
+homepage: http://rubyforge.org/projects/mp3renamer/
 post_install_message: 
 rdoc_options: 
 - --main
@@ -87,6 +105,6 @@ rubyforge_project: mp3renamer
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: FIXME (describe your package)
+summary: This program takes an MP3 audiobook and renames the subdirs and files using a consistent naming convention
 test_files: 
 - test/test_mp3renamer.rb

data/.svnignore

@@ -1,4 +0,0 @@
-#======================================================================
-# $Id: .svnignore 2 2009-03-05 22:19:20Z gofford $
-#======================================================================
-pkg