scene-toolkit 0.1.6 → 0.1.7

data/Rakefile

@@ -1,18 +1,19 @@
+# encoding: utf-8
 require 'rubygems'
 require 'rake'
 
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
-    gem.name = "scene-toolkit"
-    gem.summary = %Q{Tool to assist scene MP3 library maintenance}
+    gem.name        = "scene-toolkit"
+    gem.summary     = %Q{Tool to assist scene MP3 library maintenance}
     gem.description = %Q{Tool to assist scene MP3 library maintenance}
-    gem.email = "knoopx@gmail.com"
-    gem.homepage = "http://github.com/knoopx/scene-toolkit"
-    gem.authors = ["Víctor Martínez"]
-    gem.add_dependency "optitron", "~> 0.0.9"
-    gem.add_dependency "activesupport", "~> 2.3.5"
+    gem.email       = "knoopx@gmail.com"
+    gem.homepage    = "http://github.com/knoopx/scene-toolkit"
+    gem.authors     = ["Víctor Martínez"]
+    gem.add_dependency "activesupport", "~> 3.0.0"
     gem.add_dependency "rainbow", "~> 1.1"
+    gem.add_dependency "optitron", "~> 0.2.2"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.1.7

data/bin/scene-toolkit

@@ -4,22 +4,4 @@ $:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
 
 require 'scene_toolkit'
 
-Optitron.dispatch(SceneToolkit::CLI.new) do
-  help
-  cmd "verify", "Verify library or release. Executes all validations if none specified" do
-    arg "directory", "The root directory to verify"
-    opt "name", "Validate release name"
-    opt "required-files", "Validate inclusion of required files"
-    opt "playlist", "Validate playlist against existing files"
-    opt "checksum", "Validate release CRC-32 checksum"
-    opt "hide-valid", "Do not display valid releases"
-    opt "move-invalid-to", "Move INVALID releases to specified folder", :type => :string
-    opt "move-valid-to", "Move VALID releases to specified folder", :type => :string
-  end
-
-  cmd "repair", "Repair releases" do
-    arg "directory", "The root directory to repair"
-    opt "playlist", "Repair wrong playlist or generate missing ones"
-    opt "force", "Force the modification of existing files"
-  end
-end
+SceneToolkit::CLI.dispatch

data/lib/scene_toolkit.rb

@@ -1,8 +1,7 @@
-gem "activesupport", "~> 2.3.5"
-require 'active_support'
+gem "activesupport", "~> 3.0.0"
 
-module SceneToolkit
-  require 'scene_toolkit/ext'
-  require 'scene_toolkit/release'
-  require 'scene_toolkit/cli'
-end
+require 'active_support/all'
+
+require 'scene_toolkit/ext/hash'
+require 'scene_toolkit/release'
+require 'scene_toolkit/cli'

data/lib/scene_toolkit/cli.rb

@@ -1,152 +1,168 @@
+# encoding: utf-8
+
 require 'fileutils'
 
 gem 'rainbow', "~> 1.1"
-gem "optitron", "~> 0.0.9"
+gem "optitron", "~> 0.2.2"
 
 require 'optitron'
 require 'rainbow'
 
-class SceneToolkit::CLI
-  def repair(directory, opts)
-    opts.underscore_and_symbolize_keys!
-
-    each_release(directory) do |release|
-      if opts[:playlist]
-        unless release.valid_playlist?
-          puts release.name.foreground(:red)
-          puts release.path
-          print_errors(release)
-
-          candidates = release.files.select { |f| %w(.nfo .m3u .sfv).include?(File.extname(f).downcase) }.group_by { |f| File.basename(f, '.*') }
-          if candidates.none?
-            puts "  ✕ Unable to guess playlist filename".foreground(:red)
-            next
-          end
-
-          playlist_filename = [candidates.max { |k, v| v.size }.first, ".m3u"].join
+module SceneToolkit
+  class CLI < Optitron::CLI
+    desc "Repair releases"
+    opt "playlist", "Repair wrong playlist or generate missing ones"
+    opt "force", "Force the modification of existing files"
+
+    def repair(directory_string)
+      params.underscore_and_symbolize_keys!
+
+      each_release(directory_string) do |release|
+        if params[:playlist]
+          unless release.valid_playlist?
+            puts release.name.foreground(:red)
+            puts release.path
+            print_errors(release)
+
+            candidates = release.files.select { |f| %w(.nfo .m3u .sfv).include?(File.extname(f).downcase) }.group_by { |f| File.basename(f, '.*') }
+            if candidates.none?
+              puts "  ✕ Unable to guess playlist filename".foreground(:red)
+              next
+            end
 
-          playlist_path = File.join(release.path, playlist_filename)
-          if File.exist?(playlist_path) and not opts[:force]
-            puts "  ✕ Playlist #{playlist_filename} already exists. Use --force to replace it.".foreground(:red)
-          else
-            puts "  ■ Generating new playlist: #{playlist_filename}".foreground(:yellow)
-            File.open(playlist_path, "w") do |playlist_file|
-              release.mp3_files.map { |f| File.basename(f) }.each do |mp3_file|
-                playlist_file.puts mp3_file
+            playlist_filename = [candidates.max { |k, v| v.size }.first, ".m3u"].join
+
+            playlist_path     = File.join(release.path, playlist_filename)
+            if File.exist?(playlist_path) and not params[:force]
+              puts "  ✕ Playlist #{playlist_filename} already exists. Use --force to replace it.".foreground(:red)
+            else
+              puts "  ■ Generating new playlist: #{playlist_filename}".foreground(:yellow)
+              File.open(playlist_path, "w") do |playlist_file|
+                release.mp3_files.map { |f| File.basename(f) }.each do |mp3_file|
+                  playlist_file.puts mp3_file
+                end
               end
             end
+            puts
           end
-          puts
         end
       end
     end
-  end
-
-  def verify(directory, opts)
-    opts.underscore_and_symbolize_keys!
-    validations = []
-    SceneToolkit::Release::VALIDATIONS.each do |validation|
-      validations << validation if opts.delete(validation).eql?(true)
-    end
 
-    if validations.none?
-      validations = SceneToolkit::Release::VALIDATIONS
-    end
+    desc "Verify library or release. Executes all validations if none specified"
+    opt "name", "Validate release name"
+    opt "required-files", "Validate inclusion of required files"
+    opt "playlist", "Validate playlist against existing files"
+    opt "checksum", "Validate release CRC-32 checksum"
+    opt "hide-valid", "Do not display valid releases"
+    opt "move-invalid-to", "Move INVALID releases to specified folder", :type => :string
+    opt "move-valid-to", "Move VALID releases to specified folder", :type => :string
+
+    def verify(directory_string)
+      params.underscore_and_symbolize_keys!
+      validations = []
+      SceneToolkit::Release::VALIDATIONS.each do |validation|
+        validations << validation if params.delete(validation).eql?(true)
+      end
 
-    invalid_target_directory = opts.delete(:move_invalid_to)
-    unless invalid_target_directory.nil?
-      raise ArgumentError.new("#{invalid_target_directory} does not exist") unless File.directory?(invalid_target_directory)
-    end
+      if validations.none?
+        validations = SceneToolkit::Release::VALIDATIONS
+      end
 
-    valid_target_directory = opts.delete(:move_valid_to)
-    unless valid_target_directory.nil?
-      raise ArgumentError.new("#{invalid_target_directory} does not exist") unless File.directory?(valid_target_directory)
-    end
+      invalid_target_directory = params.delete(:move_invalid_to)
+      unless invalid_target_directory.nil?
+        raise ArgumentError.new("#{invalid_target_directory} does not exist") unless File.directory?(invalid_target_directory)
+      end
 
-    release_count = 0
-    valid_releases = 0
-    invalid_releases = 0
+      valid_target_directory = params.delete(:move_valid_to)
+      unless valid_target_directory.nil?
+        raise ArgumentError.new("#{invalid_target_directory} does not exist") unless File.directory?(valid_target_directory)
+      end
 
-    each_release(directory) do |release|
-      release_count += 1
-      if release.valid?(validations)
-        valid_releases += 1
-        if not opts[:hide_valid] or not valid_target_directory.nil?
-          puts release.name.foreground(:green)
+      release_count    = 0
+      valid_releases   = 0
+      invalid_releases = 0
+
+      each_release(directory_string) do |release|
+        release_count += 1
+        if release.valid?(validations)
+          valid_releases += 1
+          if not params[:hide_valid] or not valid_target_directory.nil?
+            puts release.name.foreground(:green)
+            puts release.path
+            print_errors(release)
+            print_warnings(release)
+            unless valid_target_directory.nil?
+              move_release(release, valid_target_directory)
+            end
+            puts
+          end
+        else
+          invalid_releases += 1
+          puts release.name.foreground(:red)
           puts release.path
           print_errors(release)
           print_warnings(release)
-          unless valid_target_directory.nil?
-            move_release(release, valid_target_directory)
+          unless invalid_target_directory.nil?
+            move_release(release, invalid_target_directory)
           end
           puts
         end
-      else
-        invalid_releases += 1
-        puts release.name.foreground(:red)
-        puts release.path
-        print_errors(release)
-        print_warnings(release)
-        unless invalid_target_directory.nil?
-          move_release(release, invalid_target_directory)
-        end
-        puts
       end
-    end
 
-    puts
-    puts "#{valid_releases} of #{release_count} releases valid".foreground(:yellow)
-    puts "#{invalid_releases} of #{release_count} releases invalid".foreground(:yellow)
-  end
+      puts
+      puts "#{valid_releases} of #{release_count} releases valid".foreground(:yellow)
+      puts "#{invalid_releases} of #{release_count} releases invalid".foreground(:yellow)
+    end
 
-  protected
+    protected
 
-  def print_errors(release)
-    release.errors.each do |validation, errors|
-      errors.each do |error|
-        puts "  ✕ [#{validation.to_s.humanize}] #{error}".foreground(:red)
+    def print_errors(release)
+      release.errors.each do |validation, errors|
+        errors.each do |error|
+          puts "  ✕ [#{validation.to_s.humanize}] #{error}".foreground(:red)
+        end
       end
     end
-  end
 
-  def print_warnings(release)
-    release.warnings.each do |validation, warnings|
-      warnings.each do |warning|
-        puts "  ✕ [#{validation.to_s.humanize}] #{warning}".foreground(:yellow)
+    def print_warnings(release)
+      release.warnings.each do |validation, warnings|
+        warnings.each do |warning|
+          puts "  ✕ [#{validation.to_s.humanize}] #{warning}".foreground(:yellow)
+        end
       end
     end
-  end
 
-  def move_release(release, destination)
-    target_dir = File.join(destination, release.name)
-    puts "  ■ Moving release to #{target_dir}".foreground(:yellow)
-
-    if File.directory?(target_dir)
-      puts "  ✕ Target directory already exists. Skipping.".foreground(:red)
-    else
-      begin
-        FileUtils.mv(release.path, target_dir)
-      rescue => e
-        puts e.message.foreground(:red)
+    def move_release(release, destination)
+      target_dir = File.join(destination, release.name)
+      puts "  ■ Moving release to #{target_dir}".foreground(:yellow)
+
+      if File.directory?(target_dir)
+        puts "  ✕ Target directory already exists. Skipping.".foreground(:red)
+      else
+        begin
+          FileUtils.mv(release.path, target_dir)
+        rescue => e
+          puts e.message.foreground(:red)
+        end
       end
     end
-  end
 
-  def each_release(source, &block)
-    raise ArgumentError unless block_given?
-    raise ArgumentError("#{source} is not a directory") unless File.directory?(source)
+    def each_release(source, &block)
+      raise ArgumentError unless block_given?
+      raise ArgumentError("#{source} is not a directory") unless File.directory?(source)
 
-    releases = []
+      releases = []
 
-    Dir.glob(File.join(source, "**", "*.mp3")).each do |file|
-      release_path = File.expand_path(File.dirname(file))
+      Dir.glob(File.join(source, "**", "*.mp3")).each do |file|
+        release_path = File.expand_path(File.dirname(file))
 
-      unless releases.include?(release_path)
-        release = SceneToolkit::Release.new(release_path)
-        releases << release_path
-        yield(release)
+        unless releases.include?(release_path)
+          release = SceneToolkit::Release.new(release_path)
+          releases << release_path
+          yield(release)
+        end
       end
     end
   end
-
 end

data/lib/scene_toolkit/ext.rb

@@ -1,3 +1 @@
-module SceneToolkit::Ext
-  require 'scene_toolkit/ext/hash'
-end
+require 'scene_towolkit/ext/hash'

data/lib/scene_toolkit/ext/hash.rb

@@ -1,9 +1,14 @@
-module SceneToolkit::Ext::Hash
-  def underscore_and_symbolize_keys!(specials={})
-    self.each_key do |k|
-      self[specials.has_key?(k) ? specials[k] : k.underscore] = self.delete(k)
+module SceneToolkit
+  module Ext
+    module Hash
+      def underscore_and_symbolize_keys!
+        result = self.dup
+        self.each_key do |k|
+          result[k.underscore] = self[k]
+        end
+        result.symbolize_keys!
+      end
     end
-    self.symbolize_keys!
   end
 end
 

data/lib/scene_toolkit/release.rb

@@ -1,118 +1,119 @@
 require 'digest/md5'
 require 'zlib'
 
-class SceneToolkit::Release
-  REQUIRED_FILES = [:sfv, :nfo, :m3u]
-  VALIDATIONS = [:name, :required_files, :playlist, :checksum]
-
-  attr_accessor :name, :path, :uid
-  attr_accessor :errors, :warnings
-
-  def initialize(path)
-    @path = path
-    @name = File.basename(path)
-    @uid = Digest::MD5.hexdigest(@name.downcase.gsub(/[^A-Z0-9]/i, ' ').gsub(/\s+/, ' '))
-    @errors, @warnings = {}, {}
-  end
-
-  def valid?(validations = VALIDATIONS)
-    @errors, @warnings = {}, {}
-    validations.each do |validation|
-      send("valid_#{validation}?")
+module SceneToolkit
+  class Release
+    REQUIRED_FILES = [:sfv, :nfo, :m3u]
+    VALIDATIONS = [:name, :required_files, :playlist, :checksum]
+
+    attr_accessor :name, :path, :uid
+    attr_accessor :errors, :warnings
+
+    def initialize(path)
+      @path = path
+      @name = File.basename(path)
+      @uid = Digest::MD5.hexdigest(@name.downcase.gsub(/[^A-Z0-9]/i, ' ').gsub(/\s+/, ' '))
+      @errors, @warnings = {}, {}
     end
-    @errors.sum { |validation, errors| errors.size }.zero?
-  end
 
-  def valid_required_files?
-    @errors[:required_files], @warnings[:required_files] = [], []
-    REQUIRED_FILES.each do |ext|
-      file_count = send("#{ext}_files")
-      @errors[:required_files] << "No *.#{ext} files found." if file_count.none?
-      @warnings[:required_files] << "Multiple *.#{ext} files found." if file_count.size > 1
+    def valid?(validations = VALIDATIONS)
+      @errors, @warnings = {}, {}
+      validations.each do |validation|
+        send("valid_#{validation}?")
+      end
+      @errors.sum { |validation, errors| errors.size }.zero?
     end
-    @warnings[:required_files].empty?
-  end
 
-  def valid_playlist?
-    @errors[:playlist], @warnings[:playlist] = [], []
-    if m3u_files.any?
-      m3u_files.each do |playlist|
-        File.read(playlist).split(/[\r\n]+/).each do |filename|
-          filename.strip!
-          next if filename.blank? or filename.start_with?("#") or filename.start_with?(";")
-          @errors[:playlist] << "File #{filename} not found" unless File.exist?(File.join(@path, filename))
-        end
+    def valid_required_files?
+      @errors[:required_files], @warnings[:required_files] = [], []
+      REQUIRED_FILES.each do |ext|
+        file_count = send("#{ext}_files")
+        @errors[:required_files] << "No *.#{ext} files found." if file_count.none?
+        @warnings[:required_files] << "Multiple *.#{ext} files found." if file_count.size > 1
       end
-    else
-      @errors[:playlist] << "No *.m3u files found"
+      @warnings[:required_files].empty?
     end
-    @errors[:playlist].empty?
-  end
-
-  def valid_checksum?
-    @errors[:checksum], @warnings[:checksum] = [], []
 
-    if sfv_files.any?
-      sfv_files.each do |sfv|
-        files_to_check = files.inject({}) do |collection, file|
-          collection[File.basename(file).downcase] = File.expand_path(file)
-          collection
+    def valid_playlist?
+      @errors[:playlist], @warnings[:playlist] = [], []
+      if m3u_files.any?
+        m3u_files.each do |playlist|
+          File.read(playlist).split(/[\r\n]+/).each do |filename|
+            filename.strip!
+            next if filename.blank? or filename.start_with?("#") or filename.start_with?(";")
+            @errors[:playlist] << "File #{filename} not found" unless File.exist?(File.join(@path, filename))
+          end
         end
+      else
+        @errors[:playlist] << "No *.m3u files found"
+      end
+      @errors[:playlist].empty?
+    end
 
-        matched_something = false
-        File.read(sfv).split(/[\r\n]+/).each do |line|
-          line.strip!
+    def valid_checksum?
+      @errors[:checksum], @warnings[:checksum] = [], []
 
-          if (/(generated|raped)/i =~ line and not /MorGoTH/i =~ line)
-            @warnings[:checksum] << "Possibly tampered SFV: #{line.strip}"
+      if sfv_files.any?
+        sfv_files.each do |sfv|
+          files_to_check = files.inject({}) do |collection, file|
+            collection[File.basename(file).downcase] = File.expand_path(file)
+            collection
           end
 
-          if match = /^(.+?)\s+([\dA-Fa-f]{8})$/.match(line)
-            matched_something = true
-            filename, checksum = match.captures
-            filename.strip!
-            filename.downcase!
+          matched_something = false
+          File.read(sfv).split(/[\r\n]+/).each do |line|
+            line.strip!
+
+            if (/(generated|raped)/i =~ line and not /MorGoTH/i =~ line)
+              @warnings[:checksum] << "Possibly tampered SFV: #{line.strip}"
+            end
 
-            if files_to_check.has_key?(filename)
-              unless Zlib.crc32(File.read(files_to_check[filename])).eql?(checksum.hex)
-                @errors[:checksum] << "File #{filename} is corrupted"
+            if match = /^(.+?)\s+([\dA-Fa-f]{8})$/.match(line)
+              matched_something = true
+              filename, checksum = match.captures
+              filename.strip!
+              filename.downcase!
+
+              if files_to_check.has_key?(filename)
+                unless Zlib.crc32(File.read(files_to_check[filename])).eql?(checksum.hex)
+                  @errors[:checksum] << "File #{filename} is corrupted"
+                end
+              else
+                @errors[:checksum] << "File #{filename} not found"
               end
-            else
-              @errors[:checksum] << "File #{filename} not found"
             end
           end
+          @warnings[:checksum] << "No files to verify found" unless matched_something
         end
-        @warnings[:checksum] << "No files to verify found" unless matched_something
+      else
+        @errors[:checksum] << "No *.sfv files found"
       end
-    else
-      @errors[:checksum] << "No *.sfv files found"
+      @errors[:checksum].empty?
     end
-    @errors[:checksum].empty?
-  end
 
-  def valid_name?
-    @errors[:name], @warnings[:name] = [], []
-    @errors[:name] << "Release name is not a valid scene release name" unless @name =~ /^([A-Z0-9\-_.()&]+)\-(\d{4}|\d{3}x|\d{2}xx)\-([A-Z0-9_]+)$/i
-    @errors[:name] << "Release name is lowercased" if @name.eql?(@name.downcase)
-    @errors[:name] << "Release name is uppercased" if @name.eql?(@name.upcase)
-    @errors[:name].empty?
-  end
+    def valid_name?
+      @errors[:name], @warnings[:name] = [], []
+      @errors[:name] << "Release name is not a valid scene release name" unless @name =~ /^([A-Z0-9\-_.()&]+)\-(\d{4}|\d{3}x|\d{2}xx)\-([A-Z0-9_]+)$/i
+      @errors[:name] << "Release name is lowercased" if @name.eql?(@name.downcase)
+      @errors[:name] << "Release name is uppercased" if @name.eql?(@name.upcase)
+      @errors[:name].empty?
+    end
 
-  def files
-    Dir.glob(File.join(@path, "*"))
-  end
+    def files
+      Dir.glob(File.join(@path, "*"))
+    end
 
-  class << self
-    protected
+    class << self
+      protected
 
-    def has_files_with_extension(*exts)
-      exts.each do |ext|
-        define_method "#{ext}_files" do
-          files.select { |f| File.extname(f).downcase.eql?(".#{ext}") }
+      def has_files_with_extension(*exts)
+        exts.each do |ext|
+          define_method "#{ext}_files" do
+            files.select { |f| File.extname(f).downcase.eql?(".#{ext}") }
+          end
         end
       end
     end
+    has_files_with_extension :mp3, :sfv, :nfo, :m3u
   end
-  has_files_with_extension :mp3, :sfv, :nfo, :m3u
-end
-
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: scene-toolkit
 version: !ruby/object:Gem::Version 
-  hash: 23
   prerelease: false
   segments: 
   - 0
   - 1
-  - 6
-  version: 0.1.6
+  - 7
+  version: 0.1.7
 platform: ruby
 authors: 
 - "V\xC3\xADctor Mart\xC3\xADnez"
@@ -15,54 +14,51 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-25 00:00:00 +02:00
+date: 2010-12-31 00:00:00 +01:00
 default_executable: scene-toolkit
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: optitron
+  name: activesupport
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 13
         segments: 
+        - 3
         - 0
         - 0
-        - 9
-        version: 0.0.9
+        version: 3.0.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: rainbow
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 9
         segments: 
-        - 2
-        - 3
-        - 5
-        version: 2.3.5
+        - 1
+        - 1
+        version: "1.1"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rainbow
+  name: optitron
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 13
         segments: 
-        - 1
-        - 1
-        version: "1.1"
+        - 0
+        - 2
+        - 2
+        version: 0.2.2
   type: :runtime
   version_requirements: *id003
 description: Tool to assist scene MP3 library maintenance
@@ -75,7 +71,6 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
-- .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -91,8 +86,8 @@ homepage: http://github.com/knoopx/scene-toolkit
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -100,7 +95,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -109,7 +103,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"

data/.gitignore

@@ -1,4 +0,0 @@
-.DS_Store
-coverage
-rdoc
-pkg