imp3 0.1.1 → 0.1.2

data/README.rdoc

@@ -13,18 +13,42 @@ iMp3 is an application for batch processing and fixing common issues when dealin
 
 == 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
+    NAME:
+    
+      imp3
+
+    DESCRIPTION:
+
+      Application for batch processing and fixing common issues when dealing with a large iTunes library
+
+    COMMANDS:
+
+      artists misspelled   Fix misspelled artist names
+      genres fetch         Fetch last.fm artist top tags and tag track genre
+      genres fetch-cache   Lists genres present on the cache and not in the ignore list
+      genres ignore-add    Add specified genre to ignore list so is no longer used for tagging tracks
+      genres ignore-del    Remove specified genre from ignore list
+      genres ignore-list   Lists all ignored genres
+      genres list          Lists all genres tagged in iTunes
+      help                 Display global or [command] help documentation.
+
+    GLOBAL OPTIONS:
+
+      -s, --selection
+          Apply only to current iTunes selection
+
+      -h, --help
+          Display help documentation
+
+      -v, --version
+          Display version information
+
+      -t, --trace
+          Display backtrace when an error occurs
+
+    AUTHORS:
+
+      Víctor Martínez
 
 == FEATURES
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/bin/imp3

@@ -10,39 +10,52 @@ 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
+program :help, 'Authors', 'Víctor Martínez'
 
 default_command :help
 
+global_option('-s', '--selection', "Apply only to current iTunes selection") { IMP3::CLI.instance.source_origin = :selection }
+
 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
+    IMP3::CLI.instance.genres_list_command
   end
 end
 
 command "genres fetch" do |c|
-  c.syntax = 'genres fetch'
-  c.description = 'Fetch and tag track genres from last.fm top tag'
+  c.syntax = 'genres fetch [options]'
+  c.description = 'Fetch last.fm artist top tags and tag track genre'
+  c.option '--flush-cache', 'Re-create last.fm artist tags cache'
+  c.when_called do |args, options|
+    IMP3::CLI.instance.genres_fetch_command(options)
+  end
+end
+
+command "genres fetch-cache" do |c|
+  c.syntax = 'genres fetch-cache [options]'
+  c.description = 'Lists genres present on the cache and not in the ignore list'
+  c.option '--limit VALUE', Integer, 'Limit to [VALUE] results'
   c.when_called do |args, options|
-    IMP3::CLI.new.genres_tag
+    options.default :limit => 25
+    IMP3::CLI.instance.genres_fetch_cache_command(options)
   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.description = 'Add specified genre to ignore list so is no longer used for tagging tracks'
   c.when_called do |args, options|
-    IMP3::CLI.new.genres_ignore_add(args.first)
+    IMP3::CLI.instance.genres_ignore_add_command(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.description = 'Remove specified genre from ignore list'
   c.when_called do |args, options|
-    IMP3::CLI.new.genres_ignore_del(args.first)
+    IMP3::CLI.instance.genres_ignore_del_command(args.first)
   end
 end
 
@@ -50,7 +63,7 @@ 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
+    IMP3::CLI.instance.genres_ignore_list_command
   end
 end
 
@@ -58,6 +71,6 @@ 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
+    IMP3::CLI.instance.artists_misspelled_command
   end
 end

data/lib/imp3/cache.rb

@@ -0,0 +1,28 @@
+require "singleton"
+
+class IMP3::Cache
+  include Singleton
+
+  CACHE_FILE = File.join(IMP3::APP_DIR, "cache.yml")
+
+  def initialize
+    @data = {}
+
+    if File.exist?(CACHE_FILE)
+      begin
+        @data = YAML.load_file(CACHE_FILE)
+      rescue
+        raise "Unable to read cache file #{CACHE_FILE}"
+      end
+    end
+  end
+
+  def artist_genres
+    @data[:artist_genres] ||= {}
+    @data[:artist_genres]
+  end
+
+  def save
+    File.new(CACHE_FILE, "w+").write(@data.to_yaml)
+  end
+end

data/lib/imp3/cli.rb

@@ -7,166 +7,55 @@ require 'friendly_id/slug_string'
 require 'rbosa'
 require 'pp'
 require 'commander/user_interaction'
+require 'singleton'
+require 'lib/imp3/config'
+require 'lib/imp3/cache'
+require 'lib/imp3/commands.rb'
 
 OSA.utf8_strings = true
 
 class IMP3::CLI
-  CONFIG_FILE = File.expand_path(File.join("~", ".imp3"))
+  include Singleton
+  attr_reader :config, :cache
+  attr_accessor :source_origin
 
-  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
+  def initialize
+    @source_origin = :library
+    @config = IMP3::Config.instance
+    @cache = IMP3::Cache.instance
   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
+  include IMP3::Commands
 
   protected
 
   def itunes
-    @itunes ||= OSA.app('iTunes')
-  end
-
-  def library
-    @library ||= itunes.sources.find {|s| s.kind == OSA::ITunes::ESRC::LIBRARY }.playlists[0]
+    OSA.app('iTunes') rescue raise "Can't locate iTunes! It's installed?"
   end
 
   def tracks
-    @tracks ||= library.tracks
+    case source_origin
+      when :library
+        @library ||= itunes.sources.find {|s| s.kind == OSA::ITunes::ESRC::LIBRARY }.playlists[0] rescue raise "Unable to contact iTunes, please make sure it is open."
+        @library.tracks 
+      when :selection
+        itunes.selection
+      else
+        raise "Invalid source origin: #{source_origin}"
+    end
   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)
+  def create_app_dir
+    Dir.mkdir(APP_DIR) unless File.directory?(APP_DIR) rescue "Unable to create application directory: #{APP_DIR}"
   end
 
   def summary(opts = {})
     puts
-    puts "#{opts[:artist] || tracks.map{|t| t.artist}.uniq.size} artists."
+    puts "#{opts[:artist] || artists.size} artists."
     puts "#{opts[:tracks] || tracks.size} tracks."
     puts "#{opts[:tracks_tagged] || 0} tracks tagged."
     puts "#{opts[:requests] || 0} requests."
@@ -175,11 +64,9 @@ class IMP3::CLI
 end
 
 class String
-  STRIP_WORDS = %w(the a of in)
-
   def strip_meaningless_words
     string = self
-    STRIP_WORDS.each do |w|
+    Config.instance.strip_words.each do |w|
       string = string.gsub(/\b#{w}\b/i, '')
     end
     string.strip

data/lib/imp3/commands/artists.rb

@@ -0,0 +1,39 @@
+module IMP3::Commands::Artists
+
+  #
+  # For every artist in iTunes, 
+  def artists_misspelled_command
+    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
+end

data/lib/imp3/commands/genres.rb

@@ -0,0 +1,116 @@
+module IMP3::Commands::Genres
+  def genres_fetch_command (options)
+    if options.flush_cache
+      cache.artist_genres.clear
+      puts "Flushing artist genres cache."
+    end
+
+    tagged, requests, errors = 0, 0, 0
+
+    progress_bar tracks do |track, bar|
+      normalized_artist_name = track.artist.normalize
+      begin
+        unless cache.artist_genres.has_key?(normalized_artist_name)
+          raise "Track has no artist name set" if track.artist.empty?
+          requests += 1
+          bar.refresh(:title => "Quering last.fm for '#{track.artist}'")
+          response = Nokogiri(open("http://ws.audioscrobbler.com/1.0/artist/#{URI.escape(CGI.escape(track.artist))}/toptags.xml"))
+          cache.artist_genres[normalized_artist_name] = response.search("//toptags/tag/name").map{|t| t.text.normalize }.uniq
+          cache.save
+        end
+      rescue => e
+        errors += 1
+        bar.refresh(:title => "Error: #{e}")
+        cache.artist_genres[normalized_artist_name] = nil
+      end
+
+      if (cache.artist_genres.has_key?(normalized_artist_name) and not cache.artist_genres[normalized_artist_name].nil?)
+        genre = (cache.artist_genres[normalized_artist_name] - config.ignore_genres).first
+
+        if track.genre.eql?(genre)
+          bar.refresh(:title => "Skipping track #{track.persistent_id}. Genre is already '#{genre}'")
+        else
+          bar.refresh(:title => "Tagging track #{track.persistent_id} with genre '#{genre}'")
+          tagged += 1
+          track.genre = ""
+          track.genre = genre
+        end
+      end
+
+      bar.increment
+    end
+    summary(:tracks_tagged => tagged, :requests => requests, :errors => errors)
+  end
+
+  def genres_fetch_cache_command(options)
+    genres = {}
+    (cache.artist_genres.map{|artist, tags| tags}.flatten - config.ignore_genres).each do |tag|
+      genres[tag] ||= 0
+      genres[tag] += 1
+    end
+
+    genres = genres.sort{|a, b| b[1] <=> a[1]}
+
+    if genres.any?
+      genre_table = table do |t|
+        t.headings = 'Genre', 'Artist count'
+        genres.to_a[0..[genres.size, options.limit].min].each do |g, c|
+          t << [g, c]
+        end
+      end
+      puts genre_table
+    else
+      puts "No genres cached yet."
+    end
+
+    summary
+  end
+
+  def genres_list_command
+    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_command (genre)
+    raise "Please specify a genre" unless genre
+    genre.strip!
+    config.ignore_genres << genre unless config.ignore_genres.include?(genre)
+    config.save
+    puts "Genre '#{genre}' added to ignore list"
+  end
+
+  def genres_ignore_del_command (genre)
+    raise "Please specify a genre" unless genre
+    genre.strip!
+    config.ignore_genres.delete(genre) if config.ignore_genres.include?(genre)
+    config.save
+    puts "Genre '#{genre}' deleted from ignore list"
+  end
+
+  def genres_ignore_list_command
+    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
+end

data/lib/imp3/commands.rb

@@ -0,0 +1,8 @@
+module IMP3::Commands
+  require "lib/imp3/commands/genres"
+  require "lib/imp3/commands/artists"
+
+  include IMP3::Commands::Artists
+  include IMP3::Commands::Genres
+end
+

data/lib/imp3/config.rb

@@ -0,0 +1,33 @@
+require "singleton"
+
+class IMP3::Config
+  include Singleton
+
+  CONFIG_FILE = File.join(IMP3::APP_DIR, "config.yml")
+
+  def initialize
+    @data = {}
+
+    if File.exist?(CONFIG_FILE)
+      begin
+        @data = YAML.load_file(CONFIG_FILE)
+      rescue
+        raise "Unable to read config file #{CONFIG_FILE}"
+      end
+    end
+  end
+
+  def ignore_genres
+    @data[:ignore_genres] ||= {}
+    @data[:ignore_genres]
+  end
+
+  def strip_words
+    @data[:strip_words] ||= %w(the a of in)
+    @data[:strip_words]
+  end
+
+  def save
+    File.new(CONFIG_FILE, "w+").write(@data.to_yaml)
+  end
+end

data/lib/imp3.rb

@@ -1,5 +1,6 @@
 module IMP3
-  VERSION = "0.1.1"
+  VERSION = "0.1.2".freeze
+  APP_DIR = File.expand_path(File.join("~", ".imp3"))
 end
 
 require 'lib/imp3/cli'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: imp3
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - "V\xC3\xADctor Mart\xC3\xADnez"
@@ -80,7 +80,12 @@ files:
 - VERSION
 - bin/imp3
 - lib/imp3.rb
+- lib/imp3/cache.rb
 - lib/imp3/cli.rb
+- lib/imp3/commands.rb
+- lib/imp3/commands/artists.rb
+- lib/imp3/commands/genres.rb
+- lib/imp3/config.rb
 - test/helper.rb
 - test/test_normalization.rb
 has_rdoc: true