dearchiver 0.0.1

data/.gitignore

@@ -0,0 +1,15 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+spec/reports
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+.idea
+.idea/**/*
+atlassian-ide-plugin.xml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=nested

data/.yardopts

@@ -0,0 +1,2 @@
+--markup markdown
+{lib}/**/*.rb

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    dearchiver (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dearchiver!
+  rake
+  rspec (~> 2.6)
+  simplecov (~> 0.5)
+  yard (~> 0.8.3)

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 eljuanchosf
+
+MIT License
+
+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.md

@@ -0,0 +1,58 @@
+# Dearchiver
+
+A simple Ruby Gem to decompress and check the CRC of compressed files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dearchiver'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dearchiver
+
+## Usage
+
+Dearchiver will use the command line of your operating system to perform the desired operations in the
+compressed files. This means that you **need** to have utilities installed (say *unzip*, *unrar*, *7zip* and *tar*).
+
+Usage is very simple.
+
+Just for now the gem will work only of the following type of files:
+
+    .zip
+    .rar
+    .tar.gz
+    .7z
+
+**TESTED ON Ubuntu 10.04**: No idea how it is going to behave in other OS.
+
+### Checking CRC
+
+    da = Dearchiver.new(:filename => "foo.zip")
+    da.crc_ok?
+
+If the filename doesn't have any extension, you can use:
+
+    da = Dearchiver.new(:filename => "foo", :archive_type => ".zip")
+    da.crc_ok?
+
+### Extracting files
+
+    da = Dearchiver.new(:filename => "foo.zip")
+    da.extract_to("/tmp")
+    puts da.list_of_files
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require 'bundler'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.pattern = 'spec/*_spec.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/dearchiver.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/dearchiver/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["eljuanchosf"]
+  gem.email         = ["juanpgenovese@gmail.com"]
+  gem.description   = %q{Ruby Gem to decompress and check the CRC of compressed files.}
+  gem.summary       = %q{A simple Ruby Gem to decompress and check the CRC of compressed files.}
+  gem.homepage      = "http://www.github.com/eljuanchosf/dearchiver"
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec',              '~> 2.6'
+  gem.add_development_dependency 'simplecov',          '~> 0.5'
+  gem.add_development_dependency 'yard',               '~> 0.8.3'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "dearchiver"
+  gem.require_paths = ["lib"]
+  gem.version       = Dearchiver::VERSION
+end

data/lib/dearchiver.rb

@@ -0,0 +1,15 @@
+require "dearchiver/processor"
+require "dearchiver/version"
+
+module Dearchiver
+
+  class << self
+    # Shorthand to Dearchiver::Processor.new
+    #
+    # @return [Dearchiver::Processor]
+    #
+    def new(options={})
+      Dearchiver::Processor.new(options)
+    end
+  end
+end

data/lib/dearchiver/processor.rb

@@ -0,0 +1,121 @@
+module Dearchiver
+  # @author Juan Pablo Genovese
+  #
+  class Processor
+
+    # Returns a String with the filename
+    attr_reader :filename
+    # Returns a String the archive type
+    attr_reader :archive_type
+    # Returns an Array of strings with the list of extracted files
+    attr_reader :list_of_files
+    # Returns a String with the command executed
+    attr_reader :executed_command
+    # Returns a String with the result of the executed command
+    attr_reader :execution_output
+
+    # Initialize a new Dearchiver::Processor object
+    #
+    # Possible values for **options**
+    #
+    #   **:filename**      - The complete filename (with included path) to work with.
+    #
+    #   **:archive_type**  - Optional. See archive_options for recognized file types.
+    #
+    # @param [Hash] options set of configuration options
+    #
+    # @return [Dearchiver::Processor]
+    #
+    def initialize(options = {})
+      @filename = options[:filename]
+      raise ArgumentError, "Processor: :filename required!" if @filename.nil? or @filename.empty?
+
+      if options[:archive_type].nil? or options[:archive_type].empty?
+        @archive_type = File.extname(@filename) if valid_file_type?
+      end
+      @archive_type ||= options[:archive_type]
+      raise ArgumentError, "Processor: :archive_type required. :filename does not contain a recognizable extension!" if @archive_type.nil? or @archive_type.empty?
+    end
+
+    # Checks the CRC of the file
+    #
+    # Returns true if the CRC is Ok, false otherwise
+    #
+    # @return [Boolean]
+    #
+    def crc_ok?
+      result = execute_command(archive_options[@archive_type][:crc_check].gsub("<filename>", filename))
+      result.include?(archive_options[@archive_type][:crc_ok]) ? true : false
+    end
+
+
+    # Extracts the content of the compressed file to the specified directory.
+    # Warning: it will overwrite the existing files without asking.
+    #
+    # @param [String] destination the directory with full path to extracts the files to.
+    #
+    # @return [Array] an array of strings with the extracted file list.
+    #
+    def extract_to(destination)
+      raise ArgumentError, "Processor: destination is required!" if destination.nil? or destination.empty?
+      raise RuntimeError, "destination directory is not valid" unless Dir.exists?(destination)
+
+      @list_of_files = []
+      result = execute_command(archive_options[@archive_type][:decompress].gsub("<filename>", filename).gsub("<extractdir>", destination))
+      result.scan(archive_options[@archive_type][:file_list_regex]).each do |slice|
+        # The gsub("\b","") is a hack to make the list file for unrar work.
+        @list_of_files << slice.first.gsub("\b","").strip
+      end
+      @list_of_files
+    end
+
+    private
+
+    def execute_command(command)
+      @executed_command = command
+      result = %x[#{command}]
+      @execution_output = result
+      result
+    end
+
+    def archive_options
+      {
+          ".zip" => {
+              :crc_check => "unzip -t <filename>",
+              :crc_ok => "No errors detected in compressed data",
+              :decompress => "unzip -o <filename> -d <extractdir>",
+              :file_list_regex => /extracting: (.+)/,
+              :compress => "zip <extractdir>/<filename> <extractdir>/<filename>"
+          },
+          ".rar" => {
+              :crc_check => "unrar t <filename>",
+              :crc_ok => "All OK",
+              :decompress => "unrar x -y <filename> <extractdir>",
+              :file_list_regex => /Extracting  ([\w\dA-Za-z\/\-\.]*)/,
+              :compress => ""
+          },
+          ".7z" => {
+              :crc_check => "7z t <filename>",
+              :crc_ok => "Everything is Ok",
+              :decompress => "7z x -y <filename> -o<extractdir>",
+              :file_list_regex => /Extracting + ([\d\w\.]+)/,
+              :compress => "7z a -mx9 <destination_filename> <filename>"
+
+          },
+          ".gz" => {
+              :crc_check => "gunzip -t <filename>",
+              :crc_ok => "",
+              :decompress => "tar xvzf <filename> --overwrite -C <extractdir>",
+              #/[\-rwx]+ \w+\/\w+ +\d+ [\d\-\/]+ [\d:]+ (.*)/  ->  For CRC only??
+              :file_list_regex => /(.*)/,
+              :compress => ""
+          }
+      }
+    end
+
+    def valid_file_type?
+      archive_options.has_key?(File.extname(@filename))
+    end
+
+  end
+end

data/lib/dearchiver/version.rb

@@ -0,0 +1,3 @@
+module Dearchiver
+  VERSION = "0.0.1"
+end

data/spec/dearchiver_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe "Dearchiver::Processor" do
+  it "should create an instance of Dearchiver via .new" do
+    Dearchiver.respond_to?(:new).should == true
+    Dearchiver.new(:filename => 'foo.zip').should be_a Dearchiver::Processor
+  end
+
+  it "should create an instance if all the argmuments are correct" do
+    Dearchiver.new(:filename => 'foo.bar', :archive_type => ".zip").should be_a Dearchiver::Processor
+  end
+
+  it "should raise an error if no filename is passed as an argument" do
+    expect { Dearchiver.new }.to raise_error(ArgumentError)
+  end
+
+  it "should raise an error if a file type is not recognized and type not passed" do
+    expect { Dearchiver.new(:filename => "foo.bar") }.to raise_error(ArgumentError)
+  end
+
+end

data/spec/processor_spec.rb

@@ -0,0 +1,96 @@
+require "spec_helper"
+
+describe "Dearchiver::Processor" do
+
+  before :all do
+    fixtures_dir = File.join(File.dirname(__FILE__),'fixtures')
+
+    @tmp_dir      = File.join(File.dirname(__FILE__),'tmp')
+
+    @extracted_test_file = File.join(@tmp_dir, "test.txt")
+
+    @zip_file    = File.join(fixtures_dir,'test.zip')
+    @rar_file    = File.join(fixtures_dir,'test.rar')
+    @sevenz_file = File.join(fixtures_dir,'test.7z')
+    @tar_file    = File.join(fixtures_dir,'test.tar.gz')
+    @zip_file_without_extension = File.join(fixtures_dir,'testzip')
+
+    # Create the tmp dir if doesn't exist
+    Dir.mkdir(@tmp_dir) unless Dir.exists?(@tmp_dir)
+  end
+
+  after :all do
+    # Delete the tmp dir if exists
+    Dir.rmdir(@tmp_dir) if Dir.exists?(@tmp_dir)
+  end
+
+  after :each do
+    # Clear the tmp directory
+    Dir.foreach(@tmp_dir) do |f|
+      unless File.directory?(File.join(@tmp_dir, f))
+        File.delete(File.join(@tmp_dir, f))
+      end
+    end
+  end
+
+  it "should verify a zip file crc" do
+    da = Dearchiver.new(:filename => @zip_file)
+    da.crc_ok?.should be true
+  end
+
+  it "should verify a rar file crc" do
+    da = Dearchiver.new(:filename => @rar_file)
+    da.crc_ok?.should be true
+  end
+
+  it "should verify a 7z file crc" do
+    da = Dearchiver.new(:filename => @sevenz_file)
+    da.crc_ok?.should be true
+  end
+
+  it "should verify a gz file crc" do
+    da = Dearchiver.new(:filename => @tar_file)
+    da.crc_ok?.should be true
+  end
+
+  it "should verify for crc without file extension" do
+    da = Dearchiver.new(:filename => @zip_file_without_extension, :archive_type => '.zip')
+    da.crc_ok?.should be true
+  end
+
+  it "should extract a zip file and return a list of files" do
+    da = Dearchiver.new(:filename => @zip_file)
+    da.extract_to(@tmp_dir).should be_an Array
+    da.list_of_files[0].should == @extracted_test_file
+  end
+
+  it "should extract a rar file and return a list of files" do
+    da = Dearchiver.new(:filename => @rar_file)
+    da.extract_to(@tmp_dir).should be_an Array
+    da.list_of_files[0].should == @extracted_test_file
+  end
+
+  it "should extract a 7z file and return a list of files" do
+    da = Dearchiver.new(:filename => @sevenz_file)
+    da.extract_to(@tmp_dir).should be_an Array
+    da.list_of_files[0].should == "test.txt"
+  end
+
+  it "should extract a gz file and return a list of files" do
+    da = Dearchiver.new(:filename => @tar_file)
+    da.extract_to(@tmp_dir).should be_an Array
+    da.list_of_files[0].should == "test.txt"
+  end
+
+  it "should maintain a execution command for inspection" do
+    da = Dearchiver.new(:filename => @zip_file)
+    da.extract_to(@tmp_dir)
+    da.execution_output.should be_a String
+  end
+
+  it "should raise an error if it is a non existing directory" do
+    da = Dearchiver.new(:filename => @zip_file)
+    expect { da.extract_to("/false/directory") }.to raise_error RuntimeError
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$:.unshift File.expand_path("../..", __FILE__)
+
+require 'dearchiver'
+require 'simplecov'
+
+SimpleCov.start do
+  add_group 'DeArchiver', 'lib/dearchiver'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: dearchiver
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- eljuanchosf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-26 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &14673760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14673760
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &14673040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *14673040
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &14672180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: *14672180
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &14671440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *14671440
+description: Ruby Gem to decompress and check the CRC of compressed files.
+email:
+- juanpgenovese@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .yardopts
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- dearchiver.gemspec
+- lib/dearchiver.rb
+- lib/dearchiver/processor.rb
+- lib/dearchiver/version.rb
+- spec/dearchiver_spec.rb
+- spec/fixtures/test.7z
+- spec/fixtures/test.rar
+- spec/fixtures/test.tar.gz
+- spec/fixtures/test.zip
+- spec/fixtures/testzip
+- spec/processor_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.github.com/eljuanchosf/dearchiver
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A simple Ruby Gem to decompress and check the CRC of compressed files.
+test_files:
+- spec/dearchiver_spec.rb
+- spec/fixtures/test.7z
+- spec/fixtures/test.rar
+- spec/fixtures/test.tar.gz
+- spec/fixtures/test.zip
+- spec/fixtures/testzip
+- spec/processor_spec.rb
+- spec/spec_helper.rb
+has_rdoc: