tagomatic 0.1.2 → 0.1.3

data/README.rdoc

@@ -7,12 +7,14 @@ Another mp3 tagger the world does not need.
 But I needed it. I have a large collection of old mp3 files. From times when tagging was mostly
 based on the file and folder names. When v2 tags where nowhere close..
 
+== Overview
+
 Modes of operation:
 
 * The tagger will try to guess the tags from the full file path by applying a set of known formats.
 * The tagger will apply specific tags given on the command-line.
 * The tagger will match specific formats given on the command-line.
-* Arbitraty combination of the before-mentioned modes.
+* Arbitrary combination of the before-mentioned modes.
 
 The scanner supports recursive folder handling. Of course.
 
@@ -20,6 +22,33 @@ Right now v2 tags are the focus.
 
 It is probably best to call this alpha ware.
 
+== Usage
+
+For my genre/artist/album/track.mp3 collection I use this invocation pattern:
+
+tagomatic --underscores --guess --recurse --showtags --errorstops --cleantags /media/music/
+
+Then I add folder-specific .tagomatic or .format= files whenever an error occurs.
+
+== The .tagomatic file
+
+You can put the (long version) of the command line options into folder-specific .tagomatic files.
+These options are then valid only for this folder and sub-folders.
+
+This is useful - for example - if you want to switch guessing off for sub-folders.
+
+== The .format= files
+
+You can add files named .format= to sub-folders. They will be picked up by tagomatic and added as
+custom formats just as if you would have passed them on the command line using the --format option.
+
+Because the slash is not allowed in file names you have to replace it with a vertical dash like in
+this example:
+
+.format=%g|%a|%b|%n - %t.mp3
+
+These formats are valid only for this folder and sub-folders.
+
 == Copyright
 
 Copyright (c) 2009 Daniel Lukic. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/lib/tagomatic/format_compiler.rb

@@ -1,15 +1,10 @@
+require 'tagomatic/tags'
+
 module Tagomatic
 
   class FormatCompiler
 
-    FORMAT_REGEXP_ARTIST = '([^\/]+)'
-    FORMAT_REGEXP_ALBUM = '([^\/]+)'
-    FORMAT_REGEXP_DISC = '\s*([0-9]+)\s*'
-    FORMAT_REGEXP_GENRE = '([^\/]+)'
-    FORMAT_REGEXP_IGNORE = '([^\/]+)'
-    FORMAT_REGEXP_TITLE = '([^\/]+)'
-    FORMAT_REGEXP_TRACKNUM = '\s*([0-9]+)\s*'
-    FORMAT_REGEXP_YEAR = '\s*([0-9]+)\s*'
+    include Tagomatic::Tags
 
     def initialize(format_matcher_factory)
       @format_matcher_factory = format_matcher_factory
@@ -24,14 +19,14 @@ module Tagomatic
         tag = tag_and_tail[0, 1]
         tail = tag_and_tail[1..-1]
         tag_mapping << tag
-        regexp << FORMAT_REGEXP_ALBUM if tag == Tagomatic::Tagger::FORMAT_ID_ALBUM
-        regexp << FORMAT_REGEXP_ARTIST if tag == Tagomatic::Tagger::FORMAT_ID_ARTIST
-        regexp << FORMAT_REGEXP_DISC if tag == Tagomatic::Tagger::FORMAT_ID_DISC
-        regexp << FORMAT_REGEXP_GENRE if tag == Tagomatic::Tagger::FORMAT_ID_GENRE
-        regexp << FORMAT_REGEXP_IGNORE if tag == Tagomatic::Tagger::FORMAT_ID_IGNORE
-        regexp << FORMAT_REGEXP_TITLE if tag == Tagomatic::Tagger::FORMAT_ID_TITLE
-        regexp << FORMAT_REGEXP_TRACKNUM if tag == Tagomatic::Tagger::FORMAT_ID_TRACKNUM
-        regexp << FORMAT_REGEXP_YEAR if tag == Tagomatic::Tagger::FORMAT_ID_YEAR
+        regexp << FORMAT_REGEXP_ALBUM if tag == FORMAT_ID_ALBUM
+        regexp << FORMAT_REGEXP_ARTIST if tag == FORMAT_ID_ARTIST
+        regexp << FORMAT_REGEXP_DISC if tag == FORMAT_ID_DISC
+        regexp << FORMAT_REGEXP_GENRE if tag == FORMAT_ID_GENRE
+        regexp << FORMAT_REGEXP_IGNORE if tag == FORMAT_ID_IGNORE
+        regexp << FORMAT_REGEXP_TITLE if tag == FORMAT_ID_TITLE
+        regexp << FORMAT_REGEXP_TRACKNUM if tag == FORMAT_ID_TRACKNUM
+        regexp << FORMAT_REGEXP_YEAR if tag == FORMAT_ID_YEAR
         regexp << Regexp.escape(tail)
       end
 

data/lib/tagomatic/known_formats.rb

@@ -0,0 +1,45 @@
+module Tagomatic
+
+  module KnownFormats
+
+    KNOWN_FORMATS = [
+            "%g/%a/%b/Disc%d/%n-%t.mp3",
+            "%g/%a/%b/Disc%d/%n%t.mp3",
+            "%g/%a/%b/Disc%d/%t.mp3",
+            "%g/%a/%b/CD%d/%n-%t.mp3",
+            "%g/%a/%b/CD%d/%n%t.mp3",
+            "%g/%a/%b/CD%d/%t.mp3",
+            "%g/%a/%b/cd%d/%n-%t.mp3",
+            "%g/%a/%b/cd%d/%n%t.mp3",
+            "%g/%a/%b/cd%d/%t.mp3",
+
+            "%g/%a/%b[%y]/%a-%b-%n-%t.mp3",
+            "%g/%a/%b[%y]/%n-%t.mp3",
+            "%g/%a/%b[%y]/%n%t.mp3",
+
+            "%g/%a/%b(%y)/%a-%b-%n-%t.mp3",
+            "%g/%a/%b(%y)/%n-%t.mp3",
+            "%g/%a/%b(%y)/%n%t.mp3",
+
+            "%g/%a/(%y)%b/%a-%b-%n-%t.mp3",
+            "%g/%a/(%y)%b/%n-%t.mp3",
+            "%g/%a/(%y)%b/%n%t.mp3",
+
+            "%g/%a/%y - %b/%a-%b-%n-%t.mp3",
+            "%g/%a/%y - %b/%n-%t.mp3",
+            "%g/%a/%y - %b/%n%t.mp3",
+
+            "%g/%a/%b/%a-%b-%n-%t.mp3",
+            "%g/%a/%b/%a-%b-%n-%t.MP3",
+            "%g/%a/%b/%n-%t.mp3",
+            "%g/%a/%b/%n-%t.MP3",
+            "%g/%a/%b/%n%t.mp3",
+            "%g/%a/%b/%n%t.MP3",
+
+            "%g/%a/%b/%t.mp3",
+            "%g/%a/%b/%t.MP3",
+    ]
+
+  end
+
+end

data/lib/tagomatic/options_parser.rb

@@ -53,41 +53,45 @@ module Tagomatic
           @options[:formats] << format
         end
 
-        opts.on("-c", "--cleantags", "Clean up tags by removing artist and album from title for example.") do |cleantags|
+        opts.on("-c", "--[no-]cleantags", "Clean up tags by removing artist and album from title for example.") do |cleantags|
           @options[:cleantags]= cleantags
         end
-        opts.on("-k", "--cleartags", "Clear any existing v1 and v2 tags.") do |cleartags|
+        opts.on("-k", "--[no-]cleartags", "Clear any existing v1 and v2 tags.") do |cleartags|
           @options[:cleartags]= cleartags
         end
-        opts.on("-e", "--errorstops", "Stop execution if an error occurs.") do |errorstops|
+        opts.on("-e", "--[no-]errorstops", "Stop execution if an error occurs.") do |errorstops|
           @options[:errorstops]= errorstops
         end
-        opts.on("-s", "--guess", "Use format guessing. Can be combined with --format.") do |guess|
+        opts.on("-s", "--[no-]guess", "Use format guessing. Can be combined with --format.") do |guess|
           @options[:guess] = guess
         end
-        opts.on("-l", "--list", "List available formats for guessing.") do |list|
+        opts.on("-l", "--[no-]list", "List available formats for guessing.") do |list|
           @options[:list] = list
         end
-        opts.on("-r", "--recurse", "Scan for files recursively.") do |recurse|
+        opts.on("-r", "--[no-]recurse", "Scan for files recursively.") do |recurse|
           @options[:recurse] = recurse
         end
-        opts.on("-w", "--showtags", "Show the resulting tags.") do |showtags|
+        opts.on("-w", "--[no-]showtags", "Show the resulting tags.") do |showtags|
           @options[:showtags] = showtags
         end
-        opts.on("-u", "--underscores", "Replace underscores with spaces before processing a file name.") do |underscores|
+        opts.on("-u", "--[no-]underscores", "Replace underscores with spaces before processing a file name.") do |underscores|
           @options[:underscores] = underscores
         end
 
         opts.separator ""
         opts.separator "Common options:"
 
-        opts.on("-v", "--verbose", "Run verbosely.") do |verbose|
+        opts.on("-v", "--[no-]verbose", "Run verbosely.") do |verbose|
           @options[:verbose] = verbose
         end
         opts.on_tail("-h", "--help", "Show this message") do
           puts opts
           exit
         end
+        opts.on_tail("--help-format", "Show help on writing --format strings") do
+          puts File.read(File.join(File.dirname($0), '..', 'lib/tagomatic/tags.rb'))
+          exit
+        end
       end
     end
 

data/lib/tagomatic/tagger.rb

@@ -2,57 +2,15 @@ require 'fileutils'
 
 require 'monkey/id3v2'
 require 'tagomatic/info_updater'
+require 'tagomatic/known_formats'
+require 'tagomatic/tags'
 
 module Tagomatic
 
   class Tagger
 
-    FORMAT_ID_ARTIST = 'a'
-    FORMAT_ID_ALBUM = 'b'
-    FORMAT_ID_DISC = 'd'
-    FORMAT_ID_GENRE = 'g'
-    FORMAT_ID_IGNORE = 'i'
-    FORMAT_ID_TITLE = 't'
-    FORMAT_ID_TRACKNUM = 'n'
-    FORMAT_ID_YEAR = 'y'
-
-    KNOWN_FORMATS = [
-            "%g/%a/%b/Disc%d/%n-%t.mp3",
-            "%g/%a/%b/Disc%d/%n%t.mp3",
-            "%g/%a/%b/Disc%d/%t.mp3",
-            "%g/%a/%b/CD%d/%n-%t.mp3",
-            "%g/%a/%b/CD%d/%n%t.mp3",
-            "%g/%a/%b/CD%d/%t.mp3",
-            "%g/%a/%b/cd%d/%n-%t.mp3",
-            "%g/%a/%b/cd%d/%n%t.mp3",
-            "%g/%a/%b/cd%d/%t.mp3",
-
-            "%g/%a/%b[%y]/%a-%b-%n-%t.mp3",
-            "%g/%a/%b[%y]/%n-%t.mp3",
-            "%g/%a/%b[%y]/%n%t.mp3",
-
-            "%g/%a/%b(%y)/%a-%b-%n-%t.mp3",
-            "%g/%a/%b(%y)/%n-%t.mp3",
-            "%g/%a/%b(%y)/%n%t.mp3",
-
-            "%g/%a/(%y)%b/%a-%b-%n-%t.mp3",
-            "%g/%a/(%y)%b/%n-%t.mp3",
-            "%g/%a/(%y)%b/%n%t.mp3",
-
-            "%g/%a/%y - %b/%a-%b-%n-%t.mp3",
-            "%g/%a/%y - %b/%n-%t.mp3",
-            "%g/%a/%y - %b/%n%t.mp3",
-
-            "%g/%a/%b/%a-%b-%n-%t.mp3",
-            "%g/%a/%b/%a-%b-%n-%t.MP3",
-            "%g/%a/%b/%n-%t.mp3",
-            "%g/%a/%b/%n-%t.MP3",
-            "%g/%a/%b/%n%t.mp3",
-            "%g/%a/%b/%n%t.MP3",
-
-            "%g/%a/%b/%t.mp3",
-            "%g/%a/%b/%t.MP3",
-    ]
+    include Tagomatic::Tags
+    include Tagomatic::KnownFormats
 
     def initialize(options, compiler, mp3info, info_updater_factory, logger)
       @options = options

data/lib/tagomatic/tags.rb

@@ -0,0 +1,39 @@
+module Tagomatic
+
+  module Tags
+
+    # Use these like this on the command line:
+    # --format "%g/%a/%b (%y)/%n - %t.mp3"
+    #
+    # Or use them like this in folder-specific .format= file names:
+    # touch ".format=%g|%a|%b (%y)|%n - %t.mp3"
+    #
+    # Some more examples showing what you can do:
+    #
+    # * Using %i (ignore) to swallow trash after album name:
+    #   --format "%g/%a/%b - %i - %y/%n - %t.mp3"
+    #
+    # * Specifying text to be skipped:
+    #   --format "%g/%a/%b - encoded by noone - %y/%n - %t.mp3"
+
+    FORMAT_ID_ARTIST = 'a'
+    FORMAT_ID_ALBUM = 'b'
+    FORMAT_ID_DISC = 'd'
+    FORMAT_ID_GENRE = 'g'
+    FORMAT_ID_IGNORE = 'i'
+    FORMAT_ID_TITLE = 't'
+    FORMAT_ID_TRACKNUM = 'n'
+    FORMAT_ID_YEAR = 'y'
+
+    FORMAT_REGEXP_ARTIST = '([^\/]+)'
+    FORMAT_REGEXP_ALBUM = '([^\/]+)'
+    FORMAT_REGEXP_DISC = '\s*([0-9]+)\s*'
+    FORMAT_REGEXP_GENRE = '([^\/]+)'
+    FORMAT_REGEXP_IGNORE = '([^\/]+)'
+    FORMAT_REGEXP_TITLE = '([^\/]+)'
+    FORMAT_REGEXP_TRACKNUM = '\s*([0-9]+)\s*'
+    FORMAT_REGEXP_YEAR = '\s*([0-9]+)\s*'
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tagomatic
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Daniel Lukic
@@ -42,12 +42,14 @@ description: |
   But I needed it. I have a large collection of old mp3 files. From times when tagging was mostly
   based on the file and folder names. When v2 tags where nowhere close..
   
+  == Overview
+  
   Modes of operation:
   
   * The tagger will try to guess the tags from the full file path by applying a set of known formats.
   * The tagger will apply specific tags given on the command-line.
   * The tagger will match specific formats given on the command-line.
-  * Arbitraty combination of the before-mentioned modes.
+  * Arbitrary combination of the before-mentioned modes.
   
   The scanner supports recursive folder handling. Of course.
   
@@ -55,6 +57,33 @@ description: |
   
   It is probably best to call this alpha ware.
   
+  == Usage
+  
+  For my genre/artist/album/track.mp3 collection I use this invocation pattern:
+  
+  tagomatic --underscores --guess --recurse --showtags --errorstops --cleantags /media/music/
+  
+  Then I add folder-specific .tagomatic or .format= files whenever an error occurs.
+  
+  == The .tagomatic file
+  
+  You can put the (long version) of the command line options into folder-specific .tagomatic files.
+  These options are then valid only for this folder and sub-folders.
+  
+  This is useful - for example - if you want to switch guessing off for sub-folders.
+  
+  == The .format= files
+  
+  You can add files named .format= to sub-folders. They will be picked up by tagomatic and added as
+  custom formats just as if you would have passed them on the command line using the --format option.
+  
+  Because the slash is not allowed in file names you have to replace it with a vertical dash like in
+  this example:
+  
+  .format=%g|%a|%b|%n - %t.mp3
+  
+  These formats are valid only for this folder and sub-folders.
+  
   == Copyright
   
   Copyright (c) 2009 Daniel Lukic. See LICENSE for details.
@@ -89,6 +118,7 @@ files:
 - lib/tagomatic/format_compiler.rb
 - lib/tagomatic/format_matcher.rb
 - lib/tagomatic/info_updater.rb
+- lib/tagomatic/known_formats.rb
 - lib/tagomatic/local_options_matcher.rb
 - lib/tagomatic/logger.rb
 - lib/tagomatic/main.rb
@@ -99,6 +129,7 @@ files:
 - lib/tagomatic/scanner.rb
 - lib/tagomatic/system_configuration.rb
 - lib/tagomatic/tagger.rb
+- lib/tagomatic/tags.rb
 - lib/tasks/test_data.rb
 - test/data/mp3_template_file
 - test/data/sorted/80s/Peter_Schilling/1982 Fehler im System/album.dat