scene-toolkit 0.1.0

data/.gitignore

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

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,17 @@
+= Scene-Toolkit
+
+Tool to assist scene MP3 library maintenance
+
+== 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.
+
+== Copyright
+
+Copyright (c) 2010 Víctor Martínez. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,20 @@
+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.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.7"
+    gem.add_dependency "activesupport", ">= 2.3.5"
+    gem.add_dependency "rainbow", ">= 1.1"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/scene-toolkit

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+
+require 'rubygems'
+require 'optitron'
+require 'scene_toolkit'
+
+
+Optitron.dispatch(SceneToolkit::CLI.new) do
+
+  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 "checksum", "Validate release CRC-32 checksum"
+    opt "display-valid", "Display valid releases too"
+    opt "flush-cache", "Flush file modification cache"
+    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
+end

data/lib/scene_toolkit.rb

@@ -0,0 +1,8 @@
+require 'active_support'
+
+module SceneToolkit
+  require 'scene_toolkit/cache'
+  require 'scene_toolkit/ext'
+  require 'scene_toolkit/release'
+  require 'scene_toolkit/cli'
+end

data/lib/scene_toolkit/cache.rb

@@ -0,0 +1,4 @@
+module SceneToolkit::Cache
+  require 'scene_toolkit/cache/base'
+  require 'scene_toolkit/cache/releases'
+end

data/lib/scene_toolkit/cache/base.rb

@@ -0,0 +1,10 @@
+require 'pstore'
+
+class SceneToolkit::Cache::Base < PStore
+  attr_reader :releases
+
+  def initialize
+    super(File.expand_path(File.join("~", ".scene-toolkit")))
+    @releases = SceneToolkit::Cache::Releases.new(self)
+  end
+end

data/lib/scene_toolkit/cache/releases.rb

@@ -0,0 +1,65 @@
+class SceneToolkit::Cache::Releases
+  def initialize(cache, cache_key = :releases)
+    @cache = cache
+    @cache_key = cache_key
+    @cache.transaction do
+      @cache[@cache_key] ||= {}
+    end
+  end
+
+  def modified?(release)
+    @cache.transaction(true) do
+      if @cache[@cache_key].has_key?(release.path)
+        @cache[@cache_key][release.path][:files].each do |filename, mtime|
+          file_path = File.join(release.path, filename)
+          unless File.exists?(file_path) and (@cache[@cache_key][release.path][:files].has_key?(filename) and File.stat(file_path).mtime.eql?(mtime))
+            flush(release)
+            return true
+          end
+        end
+        false
+      else
+        true
+      end
+    end
+  end
+
+  def errors(release)
+    @cache.transaction(true) do
+      if @cache[@cache_key].has_key?(release.path)
+        @cache[@cache_key][release.path][:errors]
+      else
+        raise RuntimeError.new("Release not catched")
+      end
+    end
+  end
+
+  def files(release)
+    @cache.transaction(true) do
+      @cache[@cache_key][release.path][:files]
+    end
+  end
+
+  def flush(release)
+    @cache.transaction do
+      @cache[@cache_key].delete(release.path) if @cache[@cache_key].has_key?(release.path)
+    end
+  end
+
+  def flush_all
+    @cache.transaction do
+      @cache[@cache_key] = {}
+    end
+  end
+
+  def store(release)
+    @cache.transaction do
+      @cache[@cache_key][release.path] = {}
+      @cache[@cache_key][release.path][:errors] = release.errors
+      @cache[@cache_key][release.path][:files] = Dir.glob(File.join(release.path, "*")).inject({}) do |collection, f|
+        collection[File.basename(f)] = File.stat(f).mtime
+        collection
+      end
+    end
+  end
+end

data/lib/scene_toolkit/cli.rb

@@ -0,0 +1,118 @@
+require 'fileutils'
+require 'rainbow'
+
+class SceneToolkit::CLI
+  def initialize
+    @cache = SceneToolkit::Cache::Base.new
+  end
+
+  def flush_cache
+    @cache.releases.flush_all
+  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
+
+    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
+
+
+    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
+
+    flush_cache if opts.delete(:flush_cache)
+
+    release_count = 0
+    valid_releases = 0
+    invalid_releases = 0
+
+    each_release(directory) do |release|
+      release_count += 1
+
+      if release.valid?(validations)
+        valid_releases += 1
+        if opts[:display_valid]
+          puts release.name.foreground(:green)
+          puts release.path
+          puts
+        end
+
+        unless valid_target_directory.nil?
+          move_release(release, valid_target_directory)
+        end
+      else
+        invalid_releases += 1
+        puts release.name.foreground(:red)
+        puts release.path
+        release.errors.each do |error|
+          puts " - #{error}"
+        end
+
+        puts
+
+        unless invalid_target_directory.nil?
+          move_release(release, invalid_target_directory)
+        end
+
+        puts
+      end
+    end
+
+    puts "#{valid_releases} of #{release_count} releases valid".foreground(:yellow)
+    puts "#{invalid_releases} of #{release_count} releases invalid".foreground(:yellow)
+  end
+
+  protected
+
+  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
+    puts
+  end
+
+  def each_release(source, &block)
+    raise ArgumentError unless block_given?
+    raise ArgumentError("#{source} is not a directory") unless File.directory?(source)
+
+    releases = []
+    uids = {}
+
+    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, @cache)
+        releases << release_path
+        yield(release)
+
+        if uids.has_key?(release.uid)
+          release.errors << "Duplicate release of #{uids[release.uid]}"
+        else
+          uids[release.uid] = release.path
+        end
+      end
+    end
+  end
+end

data/lib/scene_toolkit/ext.rb

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

data/lib/scene_toolkit/ext/hash.rb

@@ -0,0 +1,10 @@
+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)
+    end
+    self.symbolize_keys!
+  end
+end
+
+Hash.send(:include, SceneToolkit::Ext::Hash)

data/lib/scene_toolkit/release.rb

@@ -0,0 +1,93 @@
+require 'digest/md5'
+require 'zlib'
+
+class SceneToolkit::Release
+  REQUIRED_FILES = [:sfv, :nfo, :m3u]
+  VALIDATIONS = [:name, :required_files, :checksum]
+  
+  attr_accessor :name, :path, :uid
+  attr_accessor :errors
+
+  class << self
+    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
+
+  def initialize(path, cache)
+    @cache = cache
+    @path = path
+    @name = File.basename(path)
+    @uid = Digest::MD5.hexdigest(@name.downcase.gsub(/[^A-Z0-9]/i, ' ').gsub(/\s+/, ' '))
+    @errors = []
+  end
+
+  def valid?(validate = VALIDATIONS)
+    if @cache.releases.modified?(self)
+      @errors = []
+      validate.each do |validation|
+        send("valid_#{validation}?")
+      end
+      @cache.releases.store(self)
+    else
+      @errors = @cache.releases.errors(self)
+    end
+    @errors.none?
+  end
+
+  def valid_required_files?
+    REQUIRED_FILES.each do |ext|
+      file_count = send("#{ext}_files")
+      @errors << "No #{ext} found." if file_count.none?
+      @errors << "Multiple #{ext} found." if file_count.size > 1
+    end
+  end
+
+  def files
+    Dir.glob(File.join(@path, "*"))
+  end
+
+  def valid_checksum?
+    sfv_file = sfv_files.first
+
+    return if sfv_file.nil?
+
+    files_to_check = files.inject({}) do |collection, file|
+      collection[File.basename(file).downcase] = File.expand_path(file)
+      collection
+    end
+
+    #todo: set warning if no matches were found on sfv file
+    matched_something = false
+
+    File.read(sfv_file).split(/[\r\n]+/).each do |line|
+#        if (/(generated|raped)/i =~ line and not /MorGoTH/i =~ line)
+#          @errors << "Possibly tampered SFV: #{line.strip}"
+#        end
+
+      if match = /^(.+?)\s+([\dA-Fa-f]{8})$/.match(line)
+        filename, checksum = match.captures
+        if files_to_check.has_key?(filename.downcase)
+          unless Zlib.crc32(File.read(files_to_check[filename.downcase])).eql?(checksum.hex)
+            @errors << "#{filename} is corrupted"
+          end
+        else
+          @errors << "File #{filename} not found"
+        end
+        matched_something = true
+      end
+    end
+  end
+
+  def valid_name?
+    @errors << "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 << "Release name is lowercased" if @name.eql?(@name.downcase)
+    @errors << "Release name is uppercased" if @name.eql?(@name.upcase)
+  end
+end
+

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: scene-toolkit
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "V\xC3\xADctor Mart\xC3\xADnez"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-18 00:00:00 +02:00
+default_executable: scene-toolkit
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: optitron
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 0
+        - 0
+        - 7
+        version: 0.0.7
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  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
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rainbow
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 1
+        version: "1.1"
+  type: :runtime
+  version_requirements: *id003
+description: Tool to assist scene MP3 library maintenance
+email: knoopx@gmail.com
+executables: 
+- scene-toolkit
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/scene-toolkit
+- lib/scene_toolkit.rb
+- lib/scene_toolkit/cache.rb
+- lib/scene_toolkit/cache/base.rb
+- lib/scene_toolkit/cache/releases.rb
+- lib/scene_toolkit/cli.rb
+- lib/scene_toolkit/ext.rb
+- lib/scene_toolkit/ext/hash.rb
+- lib/scene_toolkit/release.rb
+has_rdoc: true
+homepage: http://github.com/knoopx/scene-toolkit
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Tool to assist scene MP3 library maintenance
+test_files: []
+