unpack 0.1.4

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,5 @@
+--color
+-fs
+-Ilib
+-Ispec
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in unpack.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,85 @@
+# Unpack*(er)* - *run files, run*
+
+## What is Unpack?
+
+Unpack makes it possible to unarchive rar and zip files using ruby.
+
+You pass a directory and it will find all your archive files, unpack and remove them (if you want to).
+
+## So how do I use it?
+
+### Start by installing the gem
+
+    sudo gem install unpack
+
+Start `irb` and include the gem, `require 'unpack'`
+
+### Unpack everything in the current directory
+
+    $ Unpack.runner!
+    => [#<Container:0x000001010ab458 @files=["dmd-tsa-cd2.avi"], @directory="/Downloads/Some.Super.Movie/CD2">]
+
+### Unpack everything in another directory
+
+    $ Unpack.runner!('/some/dir')
+    => [#<Container:0x000001010ab458 @files=["some_files.mov"], @directory="/some/dir">]
+
+### Unpack and delete archived file
+
+    $ Unpack.runner!('.', remove: true)
+    => [#<Container:0x000001010ab458 @files=["dmd-tsa-cd2.avi"], @directory="/Downloads/Some.Super.Movie/CD2">]
+    $ Unpack.runner!('.', remove: true)
+    => []
+
+### Remove every archive file, even if nothing where unpacked
+
+    $ Unpack.runner!('.', remove: true, force_remove: true)
+    => []
+    
+### Unpack all archived file, but not deeper 3 folders down
+    
+    $ Unpack.runner!('.', depth: 3)
+    => [#<Container:0x000001010ab458 @files=["dmd-tsa-cd2.avi"], @directory="/Downloads/Some.Super.Movie/CD2">]
+    
+### Unpack everything, even one file directories
+
+To prevent you from unarchive files in folders that contains subtitles and other nonrelevant files, the folder must contain 5 archive files or more.
+
+If you want to unpack everything, even subtitles directories, then you will have to specify the `min_files` option.
+
+    $ Unpack.runner!('.', min_files: 0)
+    => [#<Container:0x000001010ab458 @files=["english.str"], @directory="/Downloads/Subtitle/">]
+
+### Some configure alternatives
+
+- ** :min_files ** (Integer) The minimum amount of files in the directory you want to archive the files in. *Default is 5*.
+- ** :depth ** (Integer) The maximum folder depth. *Default is 2*.
+- ** :debugger ** (Boolean) Prints some debug output into the console. *Default is false*.
+- ** :force_remove ** (Boolean) Remove rarfiles, even if no files where unarchived. *Default is false*. **To get this to work you also have to set the `remove` option to true**.
+- ** :remove ** (Boolean) Removes archived files after they have been used. *Default is false*.
+- ** :absolute_path_to_unrar ** (String) The absolut path to the unrar binary. *Default is the [unrar](http://homepage.mac.com/pnoriega/unrar.html) binary that comes with the gem*.
+
+## What is being returned?
+
+The `runner!` method returns an `Array` of `Container` objects. 
+
+These are the accessors of the `Container` class.
+
+- **files** (String) The absolut path to the files that where unarchived.
+- **directory** (String) The absolut path to the folder containing the files.
+
+## This sounds supr, how do I help?
+
+- Start by copying the project or make your own branch.
+- Navigate to the root path of the project and run `bundle`.
+- Start by running all tests using rspec, `autotest`.
+- Implement your own code, write some tests, commit and do a pull request.
+
+## Requirements
+
+The gem is tested in OS X 10.6.6 using Ruby 1.9.2
+
+## Thanks to ...
+
+- the [UnRarX](http://homepage.mac.com/pnoriega/unrar.html) team that provies the unrar binary.
+- [NinoScript](https://github.com/NinoScript) that solved the console-escaping issue - [see this commit](https://github.com/oleander/Unpack/commit/dd7e46200a490c7af9fc5f770127291192a818f5).

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/unpack.rb

@@ -0,0 +1,146 @@
+require 'mimer_plus'
+require 'unpack/container'
+require 'fileutils'
+
+class Unpack
+  attr_accessor :files, :options
+  
+  def initialize(args)
+    args.keys.each { |name| instance_variable_set "@" + name.to_s, args[name] }
+    
+    @options = {
+      :min_files              => 5,
+      :depth                  => 2,
+      :debugger               => false,
+      :force_remove           => false,
+      :remove                 => false,
+      :absolute_path_to_unrar => "#{File.dirname(__FILE__)}/../bin/unrar"
+    }
+    
+    @removeable = {}
+    
+    @options.merge!(args[:options]) if args[:options]
+    
+    # If the path is relative
+    @directory = File.expand_path(@directory) unless @directory.match(/^\//)
+    
+    # Makes shure that every directory structure looks the same
+    @directory = Dir.new(@directory).path rescue nil
+    
+    raise Exception.new("You need to specify a valid path") if @directory.nil? or not Dir.exist?(@directory)
+    raise Exception.new("You need unzip to keep going") if %x{whereis unzip}.empty?
+  end
+  
+  def self.runner!(directory = '.', options = {})
+    unpack = Unpack.new(directory: directory, options: options) rescue nil
+    
+    # If the initializer raised any excetions
+    return [] if unpack.nil?
+    unpack.prepare!
+    unpack.clean!
+    unpack.unpack!
+    unpack.wipe! if options[:remove]
+    unpack.diff
+  end
+  
+  def prepare!
+    @directory.gsub!(/\s+/, '\ ')
+    @files = []
+    
+    ['zip', 'rar'].each do |type|
+      @files << find_file_type(type)
+    end
+    
+    @files.flatten!.map! {|file| File.absolute_path(file)}
+  end
+  
+  def clean!
+    # Removing all folders that have less then {@options[:lim]} files in them
+    # Those folders are offen subtitle folders 
+    folders = @files.map {|file| File.dirname(file)}.uniq.reject {|folder| Dir.entries(folder).count <= (@options[:min_files] + 2)}
+    @files.reject!{|file| not folders.include?(File.dirname(file))}    
+    results = []
+    
+    # Finding one rar file for every folder
+    @files.group_by{|file| File.dirname(file) }.each_pair{|_,file| results << file.sort.first }
+    @files = results
+  end
+  
+  def unpack!
+    @files.each  do |file|
+      type = Mimer.identify(file)
+      path = File.dirname(file)
+      before = Dir.new(path).entries
+
+      if type.zip?
+        @removeable.merge!(path => {:file_type => 'zip'})
+        self.unzip(path: path, file: file)
+      elsif type.rar?
+        @removeable.merge!(path => {:file_type => 'rar'})
+        self.unrar(path: path, file: file)
+      else
+        puts "Something went wrong, the mime type does not match zip or rar" if @options[:debugger]
+      end
+      
+      # What files/folders where unpacked?
+      diff = Dir.new(path).entries - before
+      
+      @removeable[path] ? @removeable[path].merge!(:diff => diff) : @removeable.delete(path)
+        
+      # Some debug info
+      if @options[:debugger] and diff.any? and @removeable[path]
+        puts "#{diff.count} where unpacked"
+        puts "The archive was of type #{@removeable[path][:file_type]}"
+        puts "The name of the file(s) are #{diff.join(', ')}"
+        puts "The path is #{path}"
+        STDOUT.flush
+      end
+    end
+  end
+  
+  # Removes the old rar and zip files
+  def wipe!
+    @removeable.each do |value|
+      path = value.first
+      type = value.last[:file_type]
+      
+      # Does not remove anything if nothing where unpacked
+      next if value.last[:diff].empty? and not @options[:force_remove]
+      
+      puts "Removing files in #{path}" if @options[:debugger]
+      
+      # Finding every file in this directory
+      Dir.glob(path + '/*').each do |file|
+        # Is the found file as the same type as the one that got unpacked?
+        FileUtils.rm(file) if Mimer.identify(file).send(:"#{type}?")
+      end
+    end
+  end
+  
+  def diff
+    # The code below this line can only be called once
+    return @removeable if @removeable.first.class == Container
+    
+    # Removing some non welcome data
+    @removeable.reject!{|item| @removeable[item][:diff].nil? or @removeable[item][:diff].empty?}
+    
+    @removeable = @removeable.map do |value|
+      Container.new(files: value.last[:diff], directory: value.first)
+    end
+    
+    # Never return the hash
+    @removeable.empty? ? [] : @removeable
+  end
+  
+  def unrar(args)
+    %x(cd '#{args[:path]}' && '#{@options[:absolute_path_to_unrar]}' e -y -o- '#{args[:file]}')
+  end
+
+  def unzip(args)
+    %x(unzip -n '#{args[:file]}' -d '#{args[:path]}')    
+  end
+  
+  def find_file_type(file_type)    
+    %x{cd '#{@directory}' && find '#{@directory}' -type f -maxdepth '#{(@options[:depth])}' -name \"*.#{file_type}\"}.split(/\n/)
+  end
+end

data/lib/unpack/container.rb

@@ -0,0 +1,15 @@
+class Container
+  attr_accessor :files, :directory
+  
+  def initialize(args)
+    args.keys.each { |name| instance_variable_set "@" + name.to_s, args[name] }
+  end
+  
+  def files
+    return @files if @called
+    @files.map! {|file| "#{@directory}/#{file}"}
+    @called = true
+    @files
+  end
+end
+  

data/spec/data/rar/110_accessible_.rar

@@ -0,0 +1 @@
+502

data/spec/data/rar/120_accessible_.rar

@@ -0,0 +1 @@
+54

data/spec/data/rar/167_accessible_.rar

@@ -0,0 +1 @@
+25

data/spec/data/rar/777_accessible_.rar

@@ -0,0 +1 @@
+732

data/spec/data/rar/918_accessible_.rar

@@ -0,0 +1 @@
+522

data/spec/data/rar/cd1/112_okey_.rar

@@ -0,0 +1 @@
+929

data/spec/data/rar/cd1/129_okey_.rar

@@ -0,0 +1 @@
+52

data/spec/data/rar/cd1/199_okey_.rar

@@ -0,0 +1 @@
+544

data/spec/data/rar/cd1/228_okey_.rar

@@ -0,0 +1 @@
+5

data/spec/data/rar/cd1/263_okey_.rar

@@ -0,0 +1 @@
+340

data/spec/data/rar/cd1/325_okey_.rar

@@ -0,0 +1 @@
+165

data/spec/data/rar/cd1/329_okey_.rar

@@ -0,0 +1 @@
+165

data/spec/data/rar/cd1/333_okey_.rar

@@ -0,0 +1 @@
+294

data/spec/data/rar/cd1/364_okey_.rar

@@ -0,0 +1 @@
+569

data/spec/data/rar/cd1/390_okey_.rar

@@ -0,0 +1 @@
+624

data/spec/data/rar/cd1/462_okey_.rar

@@ -0,0 +1 @@
+69

data/spec/data/rar/cd1/515_okey_.rar

@@ -0,0 +1 @@
+264

data/spec/data/rar/cd1/572_okey_.rar

@@ -0,0 +1 @@
+508

data/spec/data/rar/cd1/573_okey_.rar

@@ -0,0 +1 @@
+156

data/spec/data/rar/cd1/5_okey_.rar

@@ -0,0 +1 @@
+775

data/spec/data/rar/cd1/627_okey_.rar

@@ -0,0 +1 @@
+741

data/spec/data/rar/cd1/674_okey_.rar

@@ -0,0 +1 @@
+227

data/spec/data/rar/cd1/682_okey_.rar

@@ -0,0 +1 @@
+740

data/spec/data/rar/cd1/690_okey_.rar

@@ -0,0 +1 @@
+553

data/spec/data/rar/cd1/698_okey_.rar

@@ -0,0 +1 @@
+173

data/spec/data/rar/cd1/817_okey_.rar

@@ -0,0 +1 @@
+802

data/spec/data/rar/cd1/828_okey_.rar

@@ -0,0 +1 @@
+402

data/spec/data/rar/cd1/840_okey_.rar

@@ -0,0 +1 @@
+589

data/spec/data/rar/cd1/920_okey_.rar

@@ -0,0 +1 @@
+159

data/spec/data/rar/cd1/925_okey_.rar

@@ -0,0 +1 @@
+737

data/spec/data/rar/cd1/974_okey_.rar

@@ -0,0 +1 @@
+872

data/spec/data/rar/cd1/978_okey_.rar

@@ -0,0 +1 @@
+722

data/spec/data/rar/cd1/982_okey_.rar

@@ -0,0 +1 @@
+158

data/spec/data/rar/cd1/988_okey_.rar

@@ -0,0 +1 @@
+617

data/spec/data/rar/cd1/998_okey_.rar

@@ -0,0 +1 @@
+956

data/spec/data/rar/cd1/Unreachable/117_not_.rar

@@ -0,0 +1 @@
+360

data/spec/data/rar/cd1/Unreachable/12_not_.rar

@@ -0,0 +1 @@
+190

data/spec/data/rar/cd1/Unreachable/171_not_.rar

@@ -0,0 +1 @@
+236

data/spec/data/rar/cd1/Unreachable/178_not_.rar

@@ -0,0 +1 @@
+16

data/spec/data/rar/cd1/Unreachable/179_not_.rar

@@ -0,0 +1 @@
+107

data/spec/data/rar/cd1/Unreachable/202_not_.rar

@@ -0,0 +1 @@
+542

data/spec/data/rar/cd1/Unreachable/214_not_.rar

@@ -0,0 +1 @@
+765

data/spec/data/rar/cd1/Unreachable/423_not_.rar

@@ -0,0 +1 @@
+720

data/spec/data/rar/cd1/Unreachable/46_not_.rar

@@ -0,0 +1 @@
+584

data/spec/data/rar/cd1/Unreachable/477_not_.rar

@@ -0,0 +1 @@
+689

data/spec/data/rar/cd1/Unreachable/499_not_.rar

@@ -0,0 +1 @@
+782

data/spec/data/rar/cd1/Unreachable/531_not_.rar

@@ -0,0 +1 @@
+246

data/spec/data/rar/cd1/Unreachable/536_not_.rar

@@ -0,0 +1 @@
+767

data/spec/data/rar/cd1/Unreachable/554_not_.rar

@@ -0,0 +1 @@
+558