imp3 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.idea
+*.gemspec 

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Víctor Martínez
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,129 @@
+== DESCRIPTION
+
+iMp3 is an application for batch processing and fixing common issues when dealing with a large iTunes library
+
+== REQUIREMENTS
+
+* Mac OS X 10.6
+* iTunes 9
+
+== INSTALL
+
+    sudo gem install imp3
+
+== SYNOPSIS
+
+  Application for batch processing and fixing common issues when dealing with a large iTunes library
+
+  Commands:
+    fix genres           Tags all tracks genres using last.fm
+    fix misspelled-artists Fixes misspelled artist names
+    help                 Display global or [command] help documentation.
+    stats genres         Lists all genres tagged in iTunes
+
+  Global Options:
+    -h, --help           Display help documentation
+    -v, --version        Display version information
+    -t, --trace          Display backtrace when an error occurs
+
+== FEATURES
+
+    $ imp3 genres fetch
+    53% |=============............| Tagging track 911DA9F96A9D7003 with genre 'sludge'
+
+    $ imp3 artists misspelled
+    Misspelled artist name scan complete.
+
+    What is the correct artist name for L'Antietam
+    1. L'Antietam
+    2. L'antietam
+    3. (Skip)
+    ?  1
+    Tagging track 851744AFF27C75D1 with artist name 'L'Antietam'
+
+    177 artists.
+    1479 tracks.
+    1 tracks tagged.
+    0 requests.
+    0 errors.
+
+    $ imp3 genres ignore-add singer-songwriter
+    Genre 'singer-songwriter' added to ignore list
+
+    $ imp3 genres ignore-list
+    +-------------------+
+    | Genre             |
+    +-------------------+
+    | singer-songwriter |
+    | polish            |
+    | swedish           |
+    +-------------------+
+
+    $ imp3 genres list
+    +-------------------+--------+
+    | Genre             | Tracks |
+    +-------------------+--------+
+    | screamo           | 398    |
+    | post-rock         | 252    |
+    | hardcore          | 116    |
+    | post-hardcore     | 81     |
+    | sludge            | 72     |
+    | indie             | 67     |
+    | rock              | 58     |
+    | math-rock         | 44     |
+    | thrashcore        | 38     |
+    | emo               | 36     |
+    | electronic        | 33     |
+    | crust             | 32     |
+    | mathcore          | 29     |
+    | post-metal        | 26     |
+    | metalcore         | 23     |
+    | punk              | 21     |
+    | grindcore         | 21     |
+    | crustcore         | 15     |
+    | ska               | 11     |
+    | indie-rock        | 11     |
+    | deathcore         | 10     |
+    | black-metal       | 9      |
+    | experimental      | 8      |
+    | ambient           | 7      |
+    | emo-violence      | 6      |
+    | death-metal       | 5      |
+    | pop-punk          | 5      |
+    | swedish           | 3      |
+    | psychedelic       | 3      |
+    | pop               | 2      |
+    | polish            | 2      |
+    | punk-rock         | 1      |
+    | acoustic          | 1      |
+    | post-punk         | 1      |
+    +-------------------+--------+
+
+== TODO
+
+* Issue solver: Misspelled album names
+* Issue solver: Lower-cased track names
+* Issue solver: Same artist, different genre
+* Issue solver: Fetch missing album art using images.google.com
+* Issue solver: Duplicate tracks
+* Issue solver: Remove sort artist (I personally hate this feature)
+* Switch to only process current iTunes selection
+* Switch to skip/force already processed tracks
+* Cache last.fm requests
+* Windows support through Win32OLE
+* (your feature request here)
+* ...
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== LICENSE
+
+Copyright (c) 2010 Víctor Martínez. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+require 'lib/imp3'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "imp3"
+    gem.summary = %Q{Application for batch processing and fixing common issues when dealing with a large iTunes library}
+    gem.description = %Q{An application for batch processing and fixing common issues when dealing with a large iTunes library}
+    gem.email = "knoopx@gmail.com"
+    gem.homepage = "http://github.com/knoopx/imp3"
+    gem.authors = ["Víctor Martínez"]
+    gem.add_dependency('commander', '~> 4.0.2')
+    gem.add_dependency('terminal-table', '~> 1.4.2')
+    gem.add_dependency('nokogiri', '~> 1.4.1')
+    gem.add_dependency('pbosetti-rubyosa', '~> 0.5.3')
+    gem.add_dependency('friendly_id', '~> 2.3.3')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "imp3 #{IMP3::VERSION}"
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/bin/imp3

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+
+require 'rubygems'
+require "lib/imp3"
+require 'commander/import'
+
+program :name, 'imp3'
+program :version, IMP3::VERSION
+program :description, 'Application for batch processing and fixing common issues when dealing with a large iTunes library'
+program :help_formatter, :compact
+
+default_command :help
+
+command "genres list" do |c|
+  c.syntax = 'genres list'
+  c.description = 'Lists all genres tagged in iTunes'
+  c.when_called do |args, options|
+    IMP3::CLI.new.genres_list
+  end
+end
+
+command "genres fetch" do |c|
+  c.syntax = 'genres fetch'
+  c.description = 'Fetch and tag track genres from last.fm top tag'
+  c.when_called do |args, options|
+    IMP3::CLI.new.genres_tag
+  end
+end
+
+command "genres ignore-add" do |c|
+  c.syntax = 'genres ignore-add GENRE'
+  c.description = 'Ignore specified genre so is no longer used and the next one is taken for tagging tracks'
+  c.when_called do |args, options|
+    IMP3::CLI.new.genres_ignore_add(args.first)
+  end
+end
+
+command "genres ignore-del" do |c|
+  c.syntax = 'genres ignore-del GENRE'
+  c.description = 'Ignore specified genre so is no longer used and the next one is taken for tagging tracks'
+  c.when_called do |args, options|
+    IMP3::CLI.new.genres_ignore_del(args.first)
+  end
+end
+
+command "genres ignore-list" do |c|
+  c.syntax = 'genres ignore-list'
+  c.description = 'Lists all ignored genres'
+  c.when_called do |args, options|
+    IMP3::CLI.new.genres_ignore_list
+  end
+end
+
+command "artists misspelled" do |c|
+  c.syntax = 'artists misspelled'
+  c.description = 'Fix misspelled artist names'
+  c.when_called do |args, options|
+    IMP3::CLI.new.artists_misspelled
+  end
+end

data/lib/imp3/cli.rb

@@ -0,0 +1,208 @@
+require 'cgi'
+require 'open-uri'
+require 'nokogiri'
+require 'terminal-table/import'
+require 'active_support'
+require 'friendly_id/slug_string'
+require 'rbosa'
+require 'pp'
+require 'commander/user_interaction'
+
+OSA.utf8_strings = true
+
+class IMP3::CLI
+  CONFIG_FILE = File.expand_path(File.join("~", ".imp3"))
+
+  def genres_tag
+    artist_genres = {}
+    tagged, requests, errors = 0, 0, 0
+
+    progress_bar tracks do |track, bar|
+      normalized_artist_name = track.artist.normalize
+
+      begin
+        unless artist_genres.has_key?(normalized_artist_name)
+          requests += 1
+          bar.refresh(:title => "Quering last.fm for '#{track.artist}'")
+          tags = Nokogiri(open("http://ws.audioscrobbler.com/1.0/artist/#{URI.escape(CGI.escape(track.artist))}/toptags.xml")).search("//toptags/tag/name").map{|t| t.text.normalize }.uniq
+          tags = tags - config[:ignore_genres] if config[:ignore_genres]
+          artist_genres[normalized_artist_name] = tags.first
+        end
+      rescue => e
+        errors += 1
+        bar.refresh(:title => e)
+        artist_genres[normalized_artist_name] = nil
+      end
+
+      if (artist_genres.has_key?(normalized_artist_name) and not artist_genres[normalized_artist_name].nil?)
+        tagged += 1
+        bar.increment(:title => "Tagging track #{track.persistent_id} with genre '#{artist_genres[normalized_artist_name]}'")
+        track.genre = ""
+        track.genre = artist_genres[normalized_artist_name]
+      end
+
+    end
+    summary(:tracks_tagged => tagged, :requests => requests, :errors => errors)
+  end
+
+  def genres_list
+    genres = {}
+    tracks.each do |track|
+      genres[track.genre] ||= 0
+      genres[track.genre] += 1
+    end
+
+    genre_table = table do |t|
+      t.headings = 'Genre', 'Tracks'
+      genres.sort{|a, b| b[1] <=> a[1]}.each do |g, c|
+        t << [g, c]
+      end
+    end
+
+    puts genre_table
+    summary
+  end
+
+  def genres_ignore_add(genre)
+    raise "Please specify a genre" unless genre
+    genre.strip!
+    config[:ignore_genres] ||= []
+    config[:ignore_genres] << genre unless config[:ignore_genres].include?(genre)
+    save_config
+    puts "Genre '#{genre}' added to ignore list"
+  end
+
+  def genres_ignore_del(genre)
+    raise "Please specify a genre" unless genre
+    genre.strip!
+    config[:ignore_genres].delete(genre) if config[:ignore_genres].include?(genre)
+    save_config
+    puts "Genre '#{genre}' deleted from ignore list"
+  end
+
+  def genres_ignore_list
+    if config[:ignore_genres].any?
+      genre_table = table do |t|
+        t.headings = 'Genre'
+        config[:ignore_genres].each do |g|
+          t << [g]
+        end
+      end
+      puts genre_table
+    else
+      puts "No ignored genres."
+    end
+  end
+
+  def artists_misspelled
+    artist_choices = {}
+    tagged = 0
+
+    progress_bar artists, :complete_message => "Misspelled artist name scan complete." do |artist, bar|
+      bar.increment :title => "Scanning artist '#{artist}'"
+      normalized_artist_name = artist.normalized_without_words
+      artist_choices[normalized_artist_name] ||= []
+      artist_choices[normalized_artist_name] << artist.strip unless artist_choices[normalized_artist_name].include?(artist)
+    end
+
+    artist_names = {}
+    tracks.each do |track|
+      normalized_artist_name = track.artist.normalized_without_words
+      unless artist_names.has_key?(normalized_artist_name)
+        if artist_choices[normalized_artist_name] && artist_choices[normalized_artist_name].size > 1
+          puts
+          artist_name = choose("What is the correct artist name for #{track.artist}", *(artist_choices[normalized_artist_name] << :"(Skip)"))
+          artist_names[normalized_artist_name] = artist_name
+        else
+          artist_names[normalized_artist_name] = track.artist
+        end
+      end
+
+      unless artist_names[normalized_artist_name].eql?(:"(Skip)") or track.artist.eql?(artist_names[normalized_artist_name])
+        tagged += 1
+        puts "Tagging track #{track.persistent_id} with artist name '#{artist_names[normalized_artist_name]}'"
+        track.artist = ""
+        track.artist = artist_names[normalized_artist_name]
+      end
+    end
+
+    summary :tracks_tagged => tagged
+  end
+
+  protected
+
+  def itunes
+    @itunes ||= OSA.app('iTunes')
+  end
+
+  def library
+    @library ||= itunes.sources.find {|s| s.kind == OSA::ITunes::ESRC::LIBRARY }.playlists[0]
+  end
+
+  def tracks
+    @tracks ||= library.tracks
+  end
+
+  def artists
+    @artists ||= tracks.map{|t| t.artist}.uniq.sort
+  end
+
+  def config
+    return @config if @config
+    if File.exist?(CONFIG_FILE)
+      begin
+        @config = YAML.load_file(CONFIG_FILE)
+      rescue
+        raise "Unable to read config file #{CONFIG_FILE}"
+      end
+    else
+      @config = { :ignore_genres => [] }
+    end
+  end
+
+  def save_config
+    File.new(CONFIG_FILE, "w+").write(config.to_yaml)
+  end
+
+  def summary(opts = {})
+    puts
+    puts "#{opts[:artist] || tracks.map{|t| t.artist}.uniq.size} artists."
+    puts "#{opts[:tracks] || tracks.size} tracks."
+    puts "#{opts[:tracks_tagged] || 0} tracks tagged."
+    puts "#{opts[:requests] || 0} requests."
+    puts "#{opts[:errors] || 0} errors."
+  end
+end
+
+class String
+  STRIP_WORDS = %w(the a of in)
+
+  def strip_meaningless_words
+    string = self
+    STRIP_WORDS.each do |w|
+      string = string.gsub(/\b#{w}\b/i, '')
+    end
+    string.strip
+  end
+
+  def normalized_without_words
+    self.strip_meaningless_words.normalize
+  end
+
+  def normalize
+    FriendlyId::SlugString.new(self).normalize!.approximate_ascii!.to_s
+  end
+end
+
+def progress_bar arr, options = {:format => ":percent_complete% |:progress_bar| :title"}, &block
+  bar = ProgressBar.new arr.size, options
+  bar.show
+  arr.each { |v| yield(v, bar) }
+end
+
+class Commander::UI::ProgressBar
+  def refresh(tokens)
+    @tokens.merge! tokens if tokens.is_a? Hash
+    show
+  end
+end

data/lib/imp3.rb

@@ -0,0 +1,5 @@
+module IMP3
+  VERSION = "0.1.1"
+end
+
+require 'lib/imp3/cli'

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'lib/imp3'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'imp3'
+
+class Test::Unit::TestCase
+end

data/test/test_normalization.rb

@@ -0,0 +1,16 @@
+require 'helper'
+
+class TestNormalization < Test::Unit::TestCase
+  def test_normalization
+    fixtures = {
+            "the fall of troy" => "fall-troy",
+            "The Fall of Troy" => "fall-troy",
+            "Daïtro" => "daitro",
+            "té" => "te"
+    }
+
+    fixtures.each do |string, expected|
+      assert_equal expected, string.normalized_without_words
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: imp3
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- "V\xC3\xADctor Mart\xC3\xADnez"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-14 00:00:00 +01:00
+default_executable: imp3
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: commander
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 4.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: terminal-table
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.4.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.4.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: pbosetti-rubyosa
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.5.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: friendly_id
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: An application for batch processing and fixing common issues when dealing with a large iTunes library
+email: knoopx@gmail.com
+executables: 
+- imp3
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/imp3
+- lib/imp3.rb
+- lib/imp3/cli.rb
+- test/helper.rb
+- test/test_normalization.rb
+has_rdoc: true
+homepage: http://github.com/knoopx/imp3
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Application for batch processing and fixing common issues when dealing with a large iTunes library
+test_files: 
+- test/helper.rb
+- test/test_normalization.rb