what_cd 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57e94a9b268eda29b46fedb523c52213a55c6168
-  data.tar.gz: 1ff28ee6644868e2e6dbfc0054957f0b685cafbe
+  metadata.gz: b0780f43cbdc8861be4195ee4812dcc80b7b9d8b
+  data.tar.gz: 618d617b22d2fef1d5f465ff1c75d1d068f45ade
 SHA512:
-  metadata.gz: 8c10517ee6d31ef8508cb25930d0495054a9c58fbd342d88f899947ac8557bdedd1ec787a5611192714b35a5e3bef9ea79ce6bfd87b3d47dfb152683e3b09f0d
-  data.tar.gz: 14bf5c332cfe9405bd532091727f8802c94a0474b1435267fcee2af835729b945dd755e1ff542c7589b23a25448a39fd5b3b3f3c475637374b6e259514598780
+  metadata.gz: 99d5643b3da74e5db694b6b3cf01289429782db57006b4556cb08d01d8ebeb0c331ae5aef9e65f4d94eb9732912900f61c9951c1046bc15dc0227c5fbf6ed6e1
+  data.tar.gz: a75af750dbe7330b7c588541b869d1e8cc8d14718636889836b14d28adf48e24503b2c5daa0324b0db6b22c3be4b2c01df18f2cad28d2de881702c63724db0e7

data/README.md

@@ -1,4 +1,26 @@
-what.cd-tools
-=============
+# what_cd
+What.CD uploader toolkit that makes your uploads squeaky clean.
 
-Making contributing to what.cd less tedious.
+## Installation
+```bash
+gem install what_cd
+```
+Create a default config file
+```bash
+cp what_cd/etc/.what_cd ~/.what_cd
+```
+
+## Usage
+```bash
+what_cd sanitize [dir]
+```
+Sanitizing a release will iterate over a number of plugins under lib/what_cd/sanitize_plugins. Each plugin may modify the files themselves, the file names, or the directory name to adhere to What.CD guidelines. They may also throw errors if there is an issue with the upload ie. a mutt rip.
+
+```bash
+what_cd metadata [dir]
+```
+The metadata command will generate metadata about the release information that makes it easy to fill out the upload form.
+
+## License
+
+Please see LICENSE at the top level of the repository.

data/bin/what_cd

@@ -1,40 +1,67 @@
 #!/usr/bin/env ruby
 
-begin
-  require 'rubygems'
-rescue LoadError
-  # no rubygems to load, so we fail silently
+require 'rubygems'
+require 'commander/import'
+require 'logging'
+require 'pathname'
+
+require '../lib/what_cd'
+require '../lib/what_cd/version'
+require '../lib/what_cd/sanitize'
+require '../lib/what_cd/better'
+require '../lib/what_cd/metadata'
+
+# :name is optional, otherwise uses the basename of this executable
+program :name, 'WHAT.CD'
+program :version, WhatCD::VERSION
+program :description, 'WHAT.CD tools'
+
+global_option('--verbose') { $verbose = true }
+
+command :sanitize do |c|
+  c.syntax = 'what_cd sanitize [dir]'
+  c.description = 'Sanitizes releases'
+  c.action do |args, options|
+    # Preconditions
+    raise ArgumentError.new("dir argument required") unless args.count > 0
+    path = sanitize_path(args[0])
+    Sanitize.run(path)
+  end
 end
 
-require 'optparse'
-require 'what_cd'
-
-OPTIONS = {}
-MANDATORY_OPTIONS = %w[]
-
-parser = OptionParser.new do |opts|
-  opts.banner = <<BANNER
-Usage: #{File.basename($0)} [directory]
-
-Options are:
-BANNER
-  opts.separator ''
-  opts.on('-v', '--version',
-          "Show the #{File.basename($0)} version number and exit") { require 'what-cd/version'; puts "what-cd #{WhatCD::VERSION}"; exit }
-  opts.on('-t', '--tracker',
-          "Create torrent file with tracker") { |tracker|  OPTIONS[:tracker] = tracker }
-  opts.on('-e', '--encoding', String,
-          "Set lame encoding options", "Default: #{WhatCD.default_encoding}") { |encoding|  OPTIONS[:encoding] = encoding }
-  opts.on('-h', '--help',
-          'Show this help message.') { puts opts; exit }  
-  opts.parse!(ARGV)
-
-  if MANDATORY_OPTIONS && MANDATORY_OPTIONS.find { |option| OPTIONS[option.to_sym].nil? }
-    puts opts; exit
+command :metadata do |c|
+  c.syntax = 'what_cd metadata [dir]'
+  c.description = 'Gets release metadata for uploading'
+  c.action do |args, options|
+    # Preconditions
+    raise ArgumentError.new("dir argument required") unless args.count > 0
+    path = sanitize_path(args[0])
+    Metadata.run(path)
   end
+end
 
-  # do stuff
-  dir = ARGV[0]
+command :better do |c|
+  c.syntax = 'what_cd better [args] [dir]'
+  c.description = 'Converts FLAC releases to MP3'
+  c.option '--quality [320/V0]', String, 'Specifies what quality MP3 to convert to'
+  c.action do |args, options|
+    # Preconditions
+    raise ArgumentError.new("dir argument required") unless args.count > 0
+    raise ArgumentError.new("quality option required") unless options.quality
+    raise ArgumentError.new("specified quality invalid. Must be 320 or V0") unless options.quality == "320" || options.quality == "V0"
+    path = sanitize_path(args[0])
+    Better.run(path, options.quality, $verbose)
+  end
+end
 
-  #WhatCD.convert(dir, OPTIONS)
+def sanitize_path(path)
+  # Force add a trailing '/'
+  #path = path.chomp('/')
+  #path << '/'
+
+  if (Pathname.new(path).absolute?)
+    return path
+  else 
+    return Dir.pwd + '/' + path
+  end
 end

data/lib/what_cd.rb

@@ -1,14 +1,10 @@
-#$:.unshift File.dirname(__FILE__)
+$:.unshift File.dirname(__FILE__)
 
-class WhatCD
+require 'logging'
 
-  def initialize(options = {})
-  end
+module WhatCD
+
+  # YAML config 
+  CONFIG = "#{Dir.home}/.what_cd"
 
-  class << self
-    # V0
-    def default_encoding
-      '--preset extreme'
-    end
-  end
 end

data/lib/what_cd/better.rb

@@ -0,0 +1,73 @@
+require 'logging'
+require 'active_support/all'
+require 'yaml'
+
+''' 
+  This tool is primarily for working through better.php with ease. 
+  Essentially this tool will look at an existing release directory with 
+  FLAC files and create a matching release with MP3 files. A best attempt
+  is made to create an appropriate folder name. Any non-flac files are moved
+  over and then flac files are converted to an MP3. 
+
+'''
+
+module Better
+
+  @log = Logging.logger[self]
+  @log.appenders = Logging.appenders.stdout
+
+  def self. setup_log(verbose)
+    if verbose
+      @log.level = :debug
+    else
+      @log.level = :info
+    end
+  end
+
+  # Load from config file
+  def self.run(path, quality, verbose=false)
+    setup_log(verbose)
+
+    # Load configured plugins
+    begin
+      # Get config
+      config = YAML.load_file(WhatCD::CONFIG)
+      # Get configured plugins
+      configured_plugins = config['commands']['better']['plugins']
+
+      if configured_plugins
+        # Run them
+        self.run_plugins(path, configured_plugins, quality)
+      else
+        @log.info "No plugins to run. Edit your config to enable plugins."
+      end
+    rescue Errno::ENOENT
+      @log.error "Missing gem config file '~/.what_cd'"
+    end 
+  end
+
+  def self.run_plugins(path, configured_plugins, quality)
+    # Get this directory
+    current_dir = File.dirname(__FILE__)
+
+    # Set the context to be passed around between plugins
+    context = {}
+    context[:path] = path
+    context[:quality] = quality
+
+    # Iterate over the configured plugins and dynamically execute them
+    configured_plugins.each do |configured_plugin|
+      file = "#{current_dir}/better_plugins/#{configured_plugin}.rb"
+      require file
+      file_name = File.basename(file, '.rb')
+       # using ActiveSupport for camelcase and constantize
+      plugin = file_name.camelcase.constantize
+      # Check to ensure ruby file defines a class
+      if plugin.class == Class
+        @log.info "Bettering with plugin #{plugin}"
+        context = plugin.new.better(context)
+        @log.debug "context returned as #{context}"
+      end
+    end
+  end
+end

data/lib/what_cd/better_plugins/better_plugin.rb

@@ -0,0 +1,10 @@
+module BetterPlugin
+
+  def better(context)
+    raise 'This method should be implemented by every better plugin and return the context, modified or not'
+  end
+
+  def description
+    raise 'This method should be implemented by every better plugin and describe the plugin'
+  end
+end

data/lib/what_cd/better_plugins/convert.rb

@@ -0,0 +1,60 @@
+require 'logging'
+
+require File.expand_path("../better_plugin", __FILE__)
+
+class Convert
+
+  include BetterPlugin
+
+  def initialize
+    @log = Logging.logger[self]
+    @log.appenders = Logging.appenders.stdout
+    if $verbose
+      @log.level = :debug
+    else
+      @log.level = :info
+    end
+  end
+
+  def better(context)
+    path = context[:path]
+    quality = context[:quality]
+
+    if quality == "320"
+      convert(path, "insane")
+    elsif quality == "V0"
+      convert(path, "extreme")
+    else 
+      # rage
+    end
+
+    # Remove old flac files
+    cleanup(path)
+
+    return context
+  end
+
+  def convert(path, preset) 
+
+    files = Dir.chdir(path) { Dir["*.flac"] }
+
+    files.each do |flac_file|
+      @log.info "Converting #{flac_file}"
+      cmd = "cd #{Shellwords.escape(path)}; flac2mp3 #{Shellwords.escape(flac_file)} --encoding='--preset #{preset}' > /dev/null 2>&1"
+      output = system "bash -c \"#{cmd}\""
+    end
+  end
+
+  def cleanup(path)
+    files = Dir.chdir(path) { Dir["*.flac"] }
+
+    files.each do |flac_file|
+      @log.info "Deleting #{flac_file}"
+      FileUtils.rm_rf(path + flac_file)
+    end
+  end
+
+  def description
+    "Creates a new directory for the MP3 files that will be converted from FLAC"
+  end
+end

data/lib/what_cd/better_plugins/new_dir.rb

@@ -0,0 +1,46 @@
+require 'logging'
+
+require File.expand_path("../better_plugin", __FILE__)
+
+class NewDir
+
+  include BetterPlugin
+
+  def initialize
+    @log = Logging.logger[self]
+    @log.appenders = Logging.appenders.stdout
+    if $verbose
+      @log.level = :debug
+    else
+      @log.level = :info
+    end
+  end
+
+  def better(context)
+    path = context[:path]
+    quality = context[:quality]
+    new_path = determine_new_dir_name(path, quality)
+
+    @log.info "Creating path for MP3 files at #{new_path} and copying files over"
+    # Create the new directory if it does not exist
+    FileUtils.cp_r path, new_path unless File.exists?(new_path)
+
+    context[:path] = new_path
+    return context
+  end
+
+    # Intelligently decide on a new directory name
+  def determine_new_dir_name(path, quality)
+    if path.include? 'FLAC'
+      return path.gsub 'FLAC', "MP3 #{quality}"
+    elsif path.include? 'flac'
+      return path.gsub! 'flac', "MP3 #{quality}"
+    else
+      return path.gsub! '/', " [MP3 #{quality}]"
+    end
+  end
+
+  def description
+    "Creates a new directory for the MP3 files that will be converted from FLAC"
+  end
+end

data/lib/what_cd/metadata.rb

@@ -0,0 +1,135 @@
+require 'logging'
+require 'active_support/all'
+require 'yaml'
+require 'mp3info'
+
+module Metadata
+
+  @log = Logging.logger[self]
+  @log.appenders = Logging.appenders.stdout
+  if $verbose
+    @log.level = :debug
+  else
+    @log.level = :info
+  end
+
+  # Load from config file
+  def self.run(path)
+
+    metadata = {}
+    metadata['album_title'] = self.get_album_title(path)
+    metadata['artists'] = self.get_artists(path)
+    metadata['year'] = self.get_year(path)
+    # We only handle MP3 files at the moment
+    metadata['format'] = 'MP3'
+    metadata ['bitrate'] = self.get_bitrate(path)
+
+
+    puts metadata
+  end
+
+  def self.get_artists(path)
+    artists = []
+
+    Dir.entries(path).each do |f|
+      if !File.directory? f
+        # Fix Tags
+        if File.extname(f) == ".mp3"
+          filename = File.basename(f, File.extname(f))
+          file_path = path + f
+          
+          Mp3Info.open(file_path) do |mp3|
+            if mp3.tag.artist
+              artists.push(mp3.tag.artist)
+            end
+          end
+        end
+      end
+    end
+
+    return artists
+  end
+
+  def self.get_year(path)
+    file_path = self.get_first_mp3(path)
+
+    if file_path
+      Mp3Info.open(file_path) do |mp3|
+        return mp3.tag.year
+      end
+    end
+  end
+
+  def self.get_album_title(path)
+    file_path = self.get_first_mp3(path)
+
+    if file_path
+      Mp3Info.open(file_path) do |mp3|
+        return mp3.tag.album
+      end
+    end
+  end
+
+  def self.get_first_mp3(path)
+    Dir.entries(path).each do |f|
+      if !File.directory? f
+        # Fix Tags
+        if File.extname(f) == ".mp3"
+          filename = File.basename(f, File.extname(f))
+          file_path = path + f
+          return file_path
+        end
+      end
+    end
+  end
+
+  def self.get_bitrate(path)
+    files = Dir.chdir(path) { Dir["*.mp3"] }
+    return if files.empty?
+
+    bitrates = {}
+
+    files.each do |file_name|
+      file_path = path + file_name
+      Mp3Info.open(file_path) do |mp3|
+        hash = {:bitrate => mp3.bitrate, :vbr => mp3.vbr}
+        bitrates[file_name] = hash
+      end
+    end
+
+    vbr_list = bitrates.values.map{|value| value[:vbr] }
+    # Will only have 1-2 count (true & false)
+    if vbr_list.uniq.count > 1
+      raise BitrateError.new("Release has both constant and variable bitrate tracks!")
+    else 
+      vbr = vbr_list.first
+    end
+
+    bitrate_list = bitrates.values.map{|value| value[:bitrate] }
+    # Remove duplicates
+    uniq_bitrate_list = bitrate_list.uniq
+
+    # If the only vbr value is false, this is CBR
+    if not vbr and uniq_bitrate_list.uniq.count > 1
+      raise BitrateError.new("Release tracks are constant bit rate but multiple bitrates found!")
+    elsif vbr 
+      puts  "Calculating average bitrate"
+      # Determine average VBR of release
+      avg_bitrate = bitrate_list.inject(:+) / bitrate_list.length
+      if avg_bitrate > 220
+        return 'V0 (VBR)'
+      elsif avg_bitrate > 192
+        return 'V2 (VBR)'
+      else 
+        raise BitrateError.new("Release average bit rate is too low")
+      end
+    else
+      return bitrate_list.first
+    end
+  end
+
+  class BitrateError < StandardError
+
+end
+
+end

data/lib/what_cd/sanitize.rb

@@ -0,0 +1,57 @@
+require 'logging'
+require 'active_support/all'
+require 'yaml'
+
+module Sanitize
+
+  @log = Logging.logger[self]
+  @log.appenders = Logging.appenders.stdout
+  if $verbose
+    @log.level = :debug
+  else
+    @log.level = :info
+  end
+
+  # Load from config file
+  def self.run(path)
+
+    # Load configured plugins
+    begin
+      # Get config
+      config = YAML.load_file(WhatCD::CONFIG)
+      # Get configured plugins
+      configured_plugins = config['commands']['sanitize']['plugins']
+      # Run them
+      self.run_plugins(path, configured_plugins)
+    rescue Errno::ENOENT
+      @log.error "Missing gem config file '~/.what_cd'"
+    end 
+  end
+
+  def self.run_plugins(path, configured_plugins)
+    @log.info "Sanitizing release located at #{path}"
+    # Get this directory
+    current_dir = File.dirname(__FILE__)
+
+    # Set the context to be passed around between plugins
+    context = {}
+    context[:path] = path
+
+    # Iterate over the configured plugins and dynamically execute them
+    configured_plugins.each do |configured_plugin|
+      file = "#{current_dir}/sanitize_plugins/#{configured_plugin}.rb"
+      require file
+      file_name = File.basename(file, '.rb')
+       # using ActiveSupport for camelcase and constantize
+      plugin = file_name.camelcase.constantize
+      # Check to ensure ruby file defines a class
+      if plugin.class == Class
+        @log.info "Sanitizing with plugin #{plugin}"
+        context = plugin.new.sanitize(context)
+        @log.debug "Context returned as #{context}"
+      end
+    end
+
+    @log.info "Sanitization finished. Sanitized release located at #{context[:path]}"
+  end
+end

data/lib/what_cd/sanitize_plugins/bitrate.rb

@@ -0,0 +1,66 @@
+require 'logging'
+require 'mp3info'
+
+require File.expand_path("../sanitize_plugin", __FILE__)
+
+class Bitrate
+
+  include SanitizePlugin
+
+  def initialize
+    @log = Logging.logger[self]
+    @log.appenders = Logging.appenders.stdout
+    if $verbose
+      @log.level = :debug
+    else
+      @log.level = :info
+    end
+  end
+
+  def sanitize(context)
+    path = context[:path]
+    files = Dir.chdir(path) { Dir["*.mp3"] }
+    return if files.empty?
+
+    bitrates = {}
+
+    files.each do |file_name|
+      file_path = path + file_name
+      Mp3Info.open(file_path) do |mp3|
+        hash = {:bitrate => mp3.bitrate, :vbr => mp3.vbr}
+        bitrates[file_name] = hash
+      end
+    end
+
+    # TODO: Improve this to print out the violating file name
+    vbr_list = bitrates.values.map{|value| value[:vbr] }
+    if vbr_list.uniq.count > 1
+      raise BitrateError.new("Release has both constant and variable bitrate tracks!")
+    else 
+      vbr = vbr_list.first
+    end
+
+    bitrate_list = bitrates.values.map{|value| value[:bitrate] }
+    # Remove duplicates
+    bitrate_list = bitrate_list.uniq
+
+    # If the only vbr value is false, this is CBR
+    if not vbr and bitrate_list.uniq.count > 1
+      raise BitrateError.new("Release tracks are constant bit rate but multiple bitrates found!")
+    else
+      bitrate = bitrate_list.first
+    end
+
+    if vbr
+      @log.info "Variable bitrate detected"
+    else
+      @log.info "Constant bitrate detected at #{bitrate} kbps"
+    end
+
+    return context
+  end
+end
+
+class BitrateError < StandardError
+
+end

data/lib/what_cd/sanitize_plugins/cover.rb

@@ -0,0 +1,36 @@
+require 'logging'
+
+require File.expand_path("../sanitize_plugin", __FILE__)
+
+class Cover 
+
+  include SanitizePlugin
+
+  def initialize
+    @log = Logging.logger[self]
+    @log.appenders = Logging.appenders.stdout
+    if $verbose
+      @log.level = :debug
+    else
+      @log.level = :info
+    end
+  end
+
+  def sanitize(context)
+    path = context[:path]
+    images = Dir.chdir(path) { Dir["*.jpg"] }
+
+    if images.count == 1
+      file_name = images[0]
+      file_path = path + file_name
+      new_file_path = path + '00. cover.jpg'
+      File.rename(file_path, new_file_path)
+    elsif images.count > 1
+      @log.info "Several .jpg files in release directory. Unable to determine cover art."
+    else
+      @log.debug "No .jpg files found in release directory."
+    end
+
+    return context
+  end
+end

data/lib/what_cd/sanitize_plugins/dir_name.rb

@@ -0,0 +1,76 @@
+require 'mp3info'
+require 'logging'
+
+require File.expand_path("../sanitize_plugin", __FILE__)
+
+class DirName
+  include SanitizePlugin
+
+  def initialize
+    @log = Logging.logger[self]
+    @log.appenders = Logging.appenders.stdout
+    if $verbose
+      @log.level = :debug
+    else
+      @log.level = :info
+    end
+  end
+
+  def sanitize(context)
+    path = context[:path]
+    # To get release info we need to look at an mp3
+    file_path = get_first_mp3_path(path)
+
+    if file_path
+      @log.debug "Opening file_path #{file_path}"
+      Mp3Info.open(file_path) do |mp3|
+        if mp3.tag.album
+          new_dir = mp3.tag.album
+          
+          # Add year if available
+          if mp3.tag.year 
+            new_dir = new_dir + " [#{mp3.tag.year}]"
+          end
+
+          quality = get_quality_string(mp3.bitrate, mp3.vbr)
+          new_dir = new_dir + " #{quality}"
+
+          parts = path.split("/")
+          parts[-1] = new_dir
+          new_path = parts.join("/")
+          # Add trailing '/' that was removed from splitting
+          new_path << '/'
+          if new_dir != path.chomp("/")
+            @log.debug "Renaming directory to #{new_dir}"
+            File.rename(path, new_path)
+            context[:path] = new_path
+          end
+        end
+      end
+    end
+    return context
+  end
+
+  def get_first_mp3_path(path)
+    Dir.entries(path).each do |f|
+      if !File.directory?(f) and File.extname(f) == ".mp3"
+        file_path = path + f
+        return file_path
+      end
+    end
+
+    return nil
+  end
+
+  def get_quality_string(bitrate, vbr)
+    if vbr
+      if bitrate > 230 
+        return "[MP3 V0]"
+      elsif bitrate > 190
+        return "[MP3 V2]"
+      end
+    else
+      return "[MP3 #{bitrate}]"
+    end
+  end
+end

data/lib/what_cd/sanitize_plugins/file_name.rb

@@ -0,0 +1,70 @@
+require 'mp3info'
+require 'logging'
+require 'active_support/all'
+
+require File.expand_path("../sanitize_plugin", __FILE__)
+
+class FileName
+  include SanitizePlugin
+
+  def initialize
+    @log = Logging.logger[self]
+    @log.appenders = Logging.appenders.stdout
+    if $verbose
+      @log.level = :debug
+    else
+      @log.level = :info
+    end
+  end
+
+  def sanitize(context)
+    path = context[:path]
+    Dir.chdir(path) { Dir["*.mp3"] }.each do |f|
+      file_name = f
+      file_path = path + file_name
+
+      new_file_name = get_fixed_file_name(file_path)
+
+      if new_file_name != file_name
+        new_file_path = path + new_file_name
+        File.rename(file_path, new_file_path)
+      end
+    end
+
+    return context
+  end
+
+  def get_fixed_file_name(file_path)
+    # Return the original file_path by default
+    new_file_path = file_path
+
+    Mp3Info.open(file_path) do |mp3|
+      if mp3.tag.title and mp3.tag.artist and mp3.tag.tracknum
+        @log.debug "Reconstructing file name for #{file_path}"
+        title = mp3.tag.title
+        artist = mp3.tag.artist
+        tracknum = mp3.tag.tracknum.to_s
+        # Append a 0 to tracknum if necessary
+        if tracknum.length == 1
+          tracknum = "0" + tracknum
+        end
+
+        # Append a period to the trackname
+        tracknum = tracknum + "."
+
+        # Handle any remix parenthesis
+        title_parts = title.split('-')
+        if title_parts.length > 1
+          title_part = title_parts[0].strip
+          remix_part = title_parts[1].strip
+          
+          title = title_part + " (#{remix_part})"
+        end
+
+        new_file_path = "#{tracknum} #{artist} - #{title}" + File.extname(file_path)
+      end
+    end
+
+    return new_file_path
+  end
+end

data/lib/what_cd/sanitize_plugins/hidden.rb

@@ -0,0 +1,35 @@
+require 'mp3info'
+require 'logging'
+require 'active_support/all'
+
+require File.expand_path("../sanitize_plugin", __FILE__)
+
+class Hidden
+  include SanitizePlugin
+
+  def initialize
+    @log = Logging.logger[self]
+    @log.appenders = Logging.appenders.stdout
+    if $verbose
+      @log.level = :debug
+    else
+      @log.level = :info
+    end
+  end
+
+  def sanitize(context)
+    path = context[:path]
+    Dir.entries(path).each do |entry|
+      # We only want to remove hidden files... not directories. ASK ME HOW I KNOW!
+      if !File.directory? entry
+        # Remove hidden files
+        if entry.start_with? "."
+          @log.debug "Deleting hidden file #{path + entry}"
+          FileUtils.rm_rf(path + entry)
+        end
+      end
+    end
+
+    return context
+  end
+end

data/lib/what_cd/sanitize_plugins/sanitize_plugin.rb

@@ -0,0 +1,6 @@
+module SanitizePlugin
+
+  def sanitize(path)
+    raise 'This method should be implemented by every sanitization plugin and return the context regardless of whether it has been modified or not'
+  end
+end

data/lib/what_cd/sanitize_plugins/tags.rb

@@ -0,0 +1,40 @@
+require 'mp3info'
+require 'logging'
+
+require File.expand_path("../sanitize_plugin", __FILE__)
+
+class Tags 
+
+  include SanitizePlugin
+
+  def initialize
+    @log = Logging.logger[self]
+    @log.appenders = Logging.appenders.stdout
+    if $verbose
+      @log.level = :debug
+    else
+      @log.level = :info
+    end
+  end
+
+  def sanitize(context)
+    path = context[:path]
+    
+    Dir.entries(path).each do |f|
+      if !File.directory?(f) and File.extname(f) == ".mp3"
+        file_path = path + f
+        Mp3Info.open(file_path) do |mp3|
+          # Remove all comments
+          if not mp3.tag.comments.nil? or not mp3.tag2.COMM.nil?
+            mp3.tag.comments = nil
+            mp3.tag2.COMM = nil
+          end
+
+          # Handle publisher tag
+          mp3.tag2.TPUB = nil         
+        end
+      end
+    end
+    return context
+  end
+end

data/lib/what_cd/version.rb

@@ -1,3 +1,3 @@
-class WhatCD
-  VERSION = "0.0.4"
+module WhatCD
+  VERSION = "0.0.5"
 end

metadata

@@ -1,41 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: what_cd
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Jason Parraga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-11 00:00:00.000000000 Z
+date: 2015-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: flac2mp3
+  name: commander
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mp3info
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mktorrent
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Useful CLI tools for What.cd
@@ -47,10 +61,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- lib/better.rb
-- lib/what_cd/version.rb
-- lib/what_cd.rb
 - bin/what_cd
+- lib/what_cd.rb
+- lib/what_cd/better.rb
+- lib/what_cd/better_plugins/better_plugin.rb
+- lib/what_cd/better_plugins/convert.rb
+- lib/what_cd/better_plugins/new_dir.rb
+- lib/what_cd/metadata.rb
+- lib/what_cd/sanitize.rb
+- lib/what_cd/sanitize_plugins/bitrate.rb
+- lib/what_cd/sanitize_plugins/cover.rb
+- lib/what_cd/sanitize_plugins/dir_name.rb
+- lib/what_cd/sanitize_plugins/file_name.rb
+- lib/what_cd/sanitize_plugins/hidden.rb
+- lib/what_cd/sanitize_plugins/sanitize_plugin.rb
+- lib/what_cd/sanitize_plugins/tags.rb
+- lib/what_cd/version.rb
 homepage: https://github.com/Sovietaced/what-cd
 licenses: []
 metadata: {}
@@ -60,17 +86,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Useful CLI tools for What.cd

data/lib/better.rb

@@ -1,122 +0,0 @@
-#!/usr/bin/ruby 
-require 'shellwords'
-require 'mktorrent'
-
-''' 
-  This tool is primarily for working through better.php with ease. 
-  Essentially this tool will look at an existing release directory with 
-  FLAC files and create a matching release with MP3 V0 files. A best attempt
-  is made to create an appropriate folder name. Any non-flac files are moved
-  over and then flac files are converted to MP3 V0. 
-
-  Dependencies: 
-    flac2mp3: https://github.com/ymendel/flac2mp3
-
-'''
-
-class Better
-
-  attr_reader :dir, :dir_name, :new_dir, :files, :tracker
-
-  def initialize(dir_name, tracker)
-    # dir will be modified later
-    @dir = dir_name
-    @dir_name = dir_name.chomp("/")
-    @tracker = tracker
-    @files = []
-    
-    run
-  end
-
-  def run
-
-    handle_dirs
-
-    load_flac_files
-
-    puts @files
-
-    copy_files(@dir, @new_dir)
-
-    # Finally, convert to MP3 V0 if necessary
-    convert(@dir, @new_dir)
-
-    #create_torrent
-
-    puts "Woot! Conversion successful!"
-    puts "Find your files in #{new_dir}"
-  end
-
-  def load_flac_files
-    flac_files = Dir.entries(dir).select { |e| e.include? '.flac' }
-
-    if flac_files.empty?
-      puts "No flac files found. Exiting..."
-      exit
-    end
-
-    flac_files.each do | flac_file|
-      @files.push(dir + flac_file)
-    end
-  end
-
-
-  def handle_dirs
-    # clear up inconsistencies
-    if @dir.chars.last != '/'
-      @dir = @dir + '/'
-    end
-
-    # Since mutable
-    @new_dir = @dir.dup
-
-    determine_new_dir_name(@new_dir)
-
-    # Attach to full path
-    @dir = Dir.pwd + "/" + @dir
-    @new_dir = Dir.pwd + "/" + @new_dir
-
-    # Create the new directory if it does not exist
-    Dir.mkdir(@new_dir) unless File.exists?(@new_dir)
-  end
-
-    # Intelligently decide on a new directory name
-  def determine_new_dir_name(new_dir)
-    if new_dir.include? 'FLAC'
-      new_dir.gsub! 'FLAC', 'MP3 V0'
-    elsif new_dir.include? 'flac'
-      new_dir.gsub! 'flac', 'MP3 V0'
-    else
-      new_dir.gsub! '/', ' [MP3 V0]/'
-    end
-  end
-
-  def convert(dir, new_dir) 
-
-    @files.each do |flac_file|
-      puts "Converting #{flac_file}"
-      cmd = "cd #{Shellwords.escape(new_dir)}; flac2mp3 #{Shellwords.escape(flac_file)} --encoding='--preset extreme' > /dev/null 2>&1"
-      output = system "bash -c \"#{cmd}\""
-    end
-  end
-
-  def copy_files(dir, new_dir)
-    # Copy all files from dir to new_dir
-    cmd = "cp -r #{Shellwords.escape(dir)}/* #{Shellwords.escape(new_dir)}"
-    system "bash -c \"#{cmd}\""
-
-    # Remove any flac files, as they will be replaced by MP#s
-    cmd = "rm #{Shellwords.escape(new_dir)}*.flac"
-    system "bash -c \"#{cmd}\""
-  end
-
-  def create_torrent
-    t = Torrent.new(@tracker)
-    @files.each do |flac_file|
-      t.add_file(flac_file)
-    end
-    t.defaultdir = @dir_name
-    t.set_private
-    t.write_torrent("#{@dir_name}.torrent")
-  end
-end