swathe 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+.rvmrc
+.DS_Store

data/.ruby-gemset

@@ -0,0 +1 @@
+swathe

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p374

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sam Schenkman-Moore
+
+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,27 @@
+# Swathe
+
+An archive extraction tool. Intends to support tar, zip, tgz, etc without much fuss.
+
+Presently crude ... but effective? Maybe!
+
+## Installation
+
+    gem 'swathe'
+
+## Usage
+
+    # This should work from the root of this checked out project.
+    %w(tar tgz zip).each do |archive_type|
+      archive = Swathe::Archive.open("samples/sample.#{archive_type}")
+      puts "Opening: sample.#{archive_type}"
+      puts "First file is #{archive.first.full_name}"
+      p "Contents are: #{archive.first.read}"
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,28 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+namespace 'test' do
+  test_files             = FileList['test/**/*_test.rb']
+  integration_test_files = FileList['test/**/*_integration_test.rb']
+  unit_test_files        = test_files - integration_test_files
+
+  desc "Run unit tests"
+  Rake::TestTask.new('unit') do |t|
+    t.libs.push "lib"
+    t.test_files = unit_test_files
+    t.verbose = false
+  end
+
+  desc "Run integration tests"
+  Rake::TestTask.new('integration') do |t|
+    t.libs.push "lib"
+    t.test_files = integration_test_files
+    t.verbose = false
+  end
+end
+
+#Rake::Task['test'].clear
+desc "Run all tests"
+task 'test' => %w[test:unit test:integration]
+task 'default' => 'test'

data/lib/swathe.rb

@@ -0,0 +1,17 @@
+require_relative "swathe/version"
+require_relative "swathe/archive"
+require_relative "swathe/extractor"
+require_relative "swathe/tar"
+require_relative "swathe/gzip"
+require_relative "swathe/zip"
+
+
+module Swathe
+  def self.root
+    File.dirname(__FILE__)
+  end
+
+  def self.project_root
+    File.expand_path(File.join(root, '..'))
+  end
+end

data/lib/swathe/archive.rb

@@ -0,0 +1,33 @@
+module Swathe
+  class Archive
+    attr_accessor :file_name
+
+    def self.open(file_name)
+      case File.extname(file_name)
+      when '.gz', '.tgz'
+        Gzip.open(file_name)
+      when '.tar'
+        Tar.open(file_name)
+      when '.zip'
+        Zip.open(file_name)
+      end
+    end
+
+    def tar?
+      false
+    end
+
+    def gz?
+      false
+    end
+
+    def zip?
+      false
+    end
+
+    def extractor(default_destination = nil)
+      Extractor.new(self, default_destination)
+    end
+
+  end
+end

data/lib/swathe/extractor.rb

@@ -0,0 +1,38 @@
+require 'fileutils'
+
+module Swathe
+  class Extractor
+    attr_accessor :source, :default_destination
+    def initialize(source, default_destination = '.')
+      self.source = source
+      self.default_destination = default_destination
+    end
+
+    def target_path(destination)
+      case destination
+      when nil then default_destination
+      when %r(\A/) then destination
+      else
+        "#{default_destination}/#{destination}"
+      end
+    end
+      
+    def extract(file_path, destination = nil)
+      # Need to make this able to ignore the file's path if need be.
+      base_destination_directory = destination || default_destination
+      entry = source.entry(file_path)
+      if entry
+        target = "#{base_destination_directory}/#{entry.full_name}"
+        ensure_target_directory_exists_for(target)
+        File.open target, "wb" do |f|
+          entry.read
+        end
+      end
+    end
+
+    def ensure_target_directory_exists_for(path)
+      target_directory = File.dirname(path)
+      FileUtils.mkdir_p(target_directory) unless File.directory?(target_directory)
+    end
+  end
+end

data/lib/swathe/gzip.rb

@@ -0,0 +1,51 @@
+require 'zlib'
+require 'forwardable'
+
+module Swathe
+  class Gzip < Archive
+    attr_accessor :gzip_reader
+
+    extend Forwardable
+    def_delegators :tar, :entry, :each, :files, :directories
+    include Enumerable
+
+    def initialize(io)
+      self.gzip_reader = Zlib::GzipReader.open(io)
+    end
+
+    def self.open(filename)
+      new(File.open(filename))
+    end
+
+    def gzip?
+      true
+    end
+
+    def tar
+      if contains_tar?
+        @tar ||= Tar.new(gzip_reader)
+      else
+        # Need something that acts like an archive of one file.
+      end
+    end
+
+    def contains_tar?
+      (%r(\.tar\Z) === gzip_reader.orig_name) ||
+      (%r(\.tgz\Z) === File.extname(gzip_reader.path))
+    end
+
+    def each(*args, &blk)
+      return enum_for(__callee__) unless block_given?
+      contains_tar? ?  tar.each(*args, &blk) : [gzip_reader].each(*args, &blk)
+    end
+
+    def self.gzip?(file)
+      begin
+        Zlib::GzipReader.open(file)
+      rescue Zlib::GzipFile::Error
+        false
+      end
+    end
+
+  end
+end

data/lib/swathe/tar.rb

@@ -0,0 +1,47 @@
+require 'rubygems/package'
+
+# was helpful http://old.thoughtsincomputation.com/posts/tar-and-a-few-feathers-in-ruby
+module Swathe
+  class Tar < Archive
+    attr_accessor :tar_reader
+    include Enumerable
+
+    def initialize(io)
+      self.tar_reader = Gem::Package::TarReader.new(io)
+    end
+
+    def self.open(file_name)
+      new(File.open(file_name))
+    end
+
+    def tar?
+      true
+    end
+
+    def each
+      return enum_for(__callee__) unless block_given?
+      tar_reader.rewind
+      tar_reader.each {|e| yield(e) }
+    end
+
+    def subset
+      Enumerator.new do |files|
+        each do |entry|
+          files << entry if yield(entry)
+        end
+      end
+    end
+
+    def files
+      subset {|e| e.file? }
+    end
+
+    def directories
+      subset {|e| e.directory? }
+    end
+
+    def entry(filename)
+      detect {|f| filename === f.full_name }
+    end
+  end
+end

data/lib/swathe/tar_entry.rb

@@ -0,0 +1,6 @@
+class TarEntry
+  attr_accessor :entry
+  def initialize(entry)
+    self.entry = entry
+  end
+end

data/lib/swathe/version.rb

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

data/lib/swathe/zip.rb

@@ -0,0 +1,70 @@
+require 'zip/zip'
+require 'forwardable'
+
+module Swathe
+  class Zip < Archive
+    attr_accessor :zip_reader
+    include Enumerable
+
+    def initialize(io)
+      @zip_reader = ::Zip::ZipFile.open(io)
+    end
+
+    def self.open(file_name)
+      new(file_name)
+    end
+
+    def zip?
+      true
+    end
+
+    def each(*args, &blk)
+      return enum_for(__callee__) unless block_given?
+      # zip_reader.each(*args, &blk)
+      zip_reader.each(*args) do |entry|
+        blk.call(FileInZip.new(entry))
+      end
+    end
+
+    def subset
+      Enumerator.new do |files|
+        each do |entry|
+          files << entry if yield(entry)
+        end
+      end
+    end
+
+    def files
+      subset {|e| e.file? }
+    end
+
+    def directories
+      subset {|e| e.directory? }
+    end
+
+    def entry(filename)
+      detect {|f| filename === f.full_name }
+    end
+
+  end
+
+  class FileInZip
+    attr_reader :entry
+
+    extend Forwardable
+    def_delegators :entry, :file?, :directory?
+
+    def initialize(entry)
+      @entry = entry
+    end
+
+    def full_name
+      entry.name
+    end
+
+    def read
+      entry.get_input_stream.read
+    end
+
+  end
+end

data/samples/file.txt

@@ -0,0 +1 @@
+This is a sample file to test extraction.

data/swathe.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swathe/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "swathe"
+  gem.version       = Swathe::VERSION
+  gem.authors       = ["Sam Schenkman-Moore"]
+  gem.email         = ["samsm@samsm.com"]
+  gem.description   = %q{An abstraction for dealing with common archive tasks.}
+  gem.summary       = %q{Copies files out of archives.}
+  gem.homepage      = ""
+
+  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.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "rubyzip"
+
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "rake"
+
+end

data/test/archive_test.rb

@@ -0,0 +1,15 @@
+require_relative 'minitest_helper'
+
+class TestArchive < MiniTest::Unit::TestCase
+  def setup
+  end
+
+  def test_that_kitty_can_eat
+    assert_kind_of Class, Swathe::Archive
+  end
+
+  def test_archive_open
+    gz = Swathe::Archive.open("#{samples_path}/sample.tgz")
+    assert gz.gzip?
+  end
+end

data/test/extractor_test.rb

@@ -0,0 +1,21 @@
+require_relative 'minitest_helper'
+
+class TestExtractorIntegration < MiniTest::Unit::TestCase
+  def teardown
+    FileUtils.rm_r(Dir.glob("#{cleanup_path}*"))
+  end
+
+  def extractor(path = "#{samples_path}/tar_with_directory.tar")
+    @extractor ||= Swathe::Tar.open(path).extractor
+  end
+
+  def cleanup_path
+    "#{Swathe.project_root}/tmp/"
+  end
+
+  def test_write_file
+    extractor.extract('samples/file.txt', 'tmp/')
+    assert File.exists?("tmp/samples/file.txt")
+  end
+
+end

data/test/gzip_test.rb

@@ -0,0 +1,21 @@
+require_relative 'minitest_helper'
+
+class TestGzipIntegration < MiniTest::Unit::TestCase
+
+  def gzip(path = "#{samples_path}/sample.tgz")
+    @gzip ||= Swathe::Gzip.open(path)
+  end
+
+  def test_is_a_gzip
+    assert gzip.gzip?
+  end
+
+  def test_has_a_tar
+    assert gzip.tar.tar?
+  end
+
+  def test_read_file
+    assert_match %r(This is a sample file to test extraction), gzip.entry('file.txt').read
+  end
+
+end

data/test/minitest_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+gem 'minitest' # ensures you're using the gem, and not the built in MT
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'minitest/mock'
+
+require 'swathe'
+
+def samples_path
+  "#{Swathe.project_root}/samples"
+end

data/test/swathe_test.rb

@@ -0,0 +1,10 @@
+require_relative 'minitest_helper'
+
+class TestSwathe < MiniTest::Unit::TestCase
+  def setup
+  end
+
+  def test_that_kitty_can_eat
+    assert_kind_of Module, Swathe
+  end
+end

data/test/tar_test.rb

@@ -0,0 +1,33 @@
+require_relative 'minitest_helper'
+
+class TestTarIntegration < MiniTest::Unit::TestCase
+
+  def tar(path = "#{samples_path}/tar_with_directory.tar")
+    @tar ||= Swathe::Tar.open(path)
+  end
+
+  def test_is_a_tar
+    assert tar.tar?
+  end
+
+  def test_file_count
+    assert_equal 1, tar.files.count
+  end
+
+  def test_file_list
+    assert_equal ["samples/file.txt"], tar.files.collect(&:full_name)
+  end
+
+  def test_directory_list
+    assert_equal ["samples/"], tar.directories.collect(&:full_name)
+  end
+
+  def test_read_file
+    assert_match %r(This is a sample file to test extraction), tar.entry('samples/file.txt').read
+  end
+
+  def test_extractor
+    assert_kind_of Swathe::Extractor, tar.extractor
+  end
+
+end

data/test/zip_test.rb

@@ -0,0 +1,31 @@
+require_relative 'minitest_helper'
+
+class TestZipIntegration < MiniTest::Unit::TestCase
+
+  def zip(path = "#{samples_path}/sample.zip")
+    @zip ||= Swathe::Zip.open(path)
+  end
+
+  def test_is_a_zip
+    assert zip.zip?
+  end
+
+  def test_file_count
+    assert_equal 1, zip.files.count
+  end
+
+  def test_file_list
+    assert_equal ["samples/file.txt"], zip.files.collect(&:full_name)
+  end
+
+  # TODO: Apparently zip directories don't work this way.
+  # Or I screwed up the sample zip. Figure this out.
+  # def test_directory_list
+  #   assert_equal ["samples/"], zip.directories.collect(&:full_name)
+  # end
+
+  def test_read_file
+    assert_match %r(This is a sample file to test extraction), zip.entry('samples/file.txt').read
+  end
+
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: swathe
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sam Schenkman-Moore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An abstraction for dealing with common archive tasks.
+email:
+- samsm@samsm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/swathe.rb
+- lib/swathe/archive.rb
+- lib/swathe/extractor.rb
+- lib/swathe/gzip.rb
+- lib/swathe/tar.rb
+- lib/swathe/tar_entry.rb
+- lib/swathe/version.rb
+- lib/swathe/zip.rb
+- samples/file.txt
+- samples/sample.tar
+- samples/sample.tgz
+- samples/sample.zip
+- samples/tar_with_directory.tar
+- swathe.gemspec
+- test/archive_test.rb
+- test/extractor_test.rb
+- test/gzip_test.rb
+- test/minitest_helper.rb
+- test/swathe_test.rb
+- test/tar_test.rb
+- test/zip_test.rb
+homepage: ''
+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'
+      segments:
+      - 0
+      hash: 3367134578741255156
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3367134578741255156
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Copies files out of archives.
+test_files:
+- test/archive_test.rb
+- test/extractor_test.rb
+- test/gzip_test.rb
+- test/minitest_helper.rb
+- test/swathe_test.rb
+- test/tar_test.rb
+- test/zip_test.rb