memtar 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d92f29c592d9d2ec4112e69e04f205a893dbc36b
+  data.tar.gz: f61512b2bf45450088ae1f58454319c32811bb4c
+SHA512:
+  metadata.gz: 4b0fbe8d37f910acb0727c2eb86dffd62daad06f52d9c4085af4914e10d0e0749b2eab32c5fa4f90d7b3643d0fa3538acfd256a8a76b5a7e08b34f30d29e14dc
+  data.tar.gz: 2a6fe9b0a17d1e2dbaf9a5bdc708a9f0cb8ad5a7cc3384d78c092d62c8c58a726ec9c3b58736376f828c1ef5b2b65df648b9f208c1eeb0e54dc5521e73edc9b0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.overcommit.yml

@@ -0,0 +1,31 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/causes/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/causes/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/causes/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+#PreCommit:
+#  Rubocop:
+#    on_warn: fail # Treat all warnings as failures
+#
+#  TrailingWhitespace:
+#    exclude:
+#      - '**/db/structure.sql' # Ignore trailing whitespace in generated files
+#
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#   quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Rafał Rzepecki
+
+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,44 @@
+# MemTar
+
+In-memory tar archive creation
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'memtar'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install memtar
+
+## Usage
+
+```ruby
+
+require 'memtar'
+
+archive = MemTar.new
+archive.default[:uname] = "nobody"
+
+archive.add_file "foo", "content", mode: 0640
+archive.add_file "bar/baz", "hi!"
+archive.add_symlink "bar/xyzzy", "baz"
+archive.add_file "this", File.new("/etc/passwd") # copies attributes and content
+
+File.write "test.tar", archive.to_s
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/memtar/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  task :spec
+end
+
+task default: :spec

data/lib/memtar.rb

@@ -0,0 +1,57 @@
+require 'archive/tar/minitar'
+require 'memtar/version'
+
+# In-memory tar archive writer.
+class MemTar
+  def initialize
+    @io = StringIO.new
+  end
+
+  def add_file path, content, opts = {}
+    return add_existing_file path, content if content.is_a?(File) && opts.empty?
+    fail ArgumentError, "handling of paths over 100 bytes long not implemented" if path.size > 100
+
+    size = content.size
+    @io.write header opts.merge size: size, name: path
+    @io.write content
+    @io.write "\0" * (512 - size % 512)
+  end
+
+  def add_symlink path, target
+    fail ArgumentError, "handling of paths over 100 bytes long not implemented" if path.size > 100
+    @io.write header typeflag: '2', size: 0, mode: 0777, name: path, linkname: target
+  end
+
+  def add_existing_file path, file
+    add_file path, file.read, MemTar.opts_of_stat(file.stat)
+  end
+
+  def self.opts_of_stat stat
+    uid, gid = [stat.uid, stat.gid]
+    {
+      mode: stat.mode & 0777,
+      uid: uid, gid: gid,
+      uname: Etc.getpwuid(uid).name,
+      gname: Etc.getgrgid(gid).name,
+      mtime: stat.mtime
+    }
+  end
+
+  def to_s
+    @io.string + "\0" * 1024
+  end
+
+  def header opts
+    Archive::Tar::PosixHeader.new(default.merge opts).to_s
+  end
+
+  def default
+    @default ||= {
+      mode: 0644,
+      uid: 0, gid: 0,
+      uname: 'wheel', gname: 'wheel',
+      mtime: Time.now,
+      prefix: ''
+    }
+  end
+end

data/lib/memtar/version.rb

@@ -0,0 +1,4 @@
+#
+class MemTar
+  VERSION = "0.0.1"
+end

data/memtar.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'memtar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "memtar"
+  spec.version       = MemTar::VERSION
+  spec.authors       = ["Rafał Rzepecki"]
+  spec.email         = ["rafal@conjur.net"]
+  spec.summary       = %q{In-memory tar archive creation}
+  spec.homepage      = "https://github.com/dividedmind/memtar"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "minitar", "~> 0.5"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

data/spec/memtar_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+require 'tempfile'
+
+require 'memtar'
+
+describe MemTar do
+  include SpecHelpers
+
+  describe '#add_file' do
+    it 'adds a file to the archive' do
+      subject.add_file 'some-file', 'foo', mode: 0600, uname: 'nobody'
+      has_file 'some-file', content: 'foo', mode: 0600, uname: 'nobody'
+    end
+
+    it 'handles File arguments' do
+      file = Tempfile.new 'foo'
+      file.chmod 0750
+      file.write 'bar'
+      file.close
+
+      subject.add_file 'xyzzy', File.new(file.path)
+      has_file 'xyzzy', content: 'bar', mode: 0750, uname: Etc.getlogin
+      file.unlink
+    end
+  end
+
+  describe '#add_symlink' do
+    it 'creates a symlink in the archive' do
+      subject.add_symlink 'password-file', '/etc/passwd'
+      has_symlink 'password-file'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,49 @@
+module SpecHelpers
+  def reader
+    @reader ||= Archive::Tar::Minitar::Reader.new StringIO.new subject.to_s
+  end
+
+  module TarEntryWithContent
+    attr_reader :content
+
+    def self.extended entry
+      entry.read
+    end
+
+    def read
+      @content ||= super
+    end
+  end
+
+  # Disregard spurious :reek:ControlParameter
+  def seek path
+    reader.rewind
+    reader.each do |entry|
+      return entry.extend TarEntryWithContent if entry.full_name == path
+    end
+  end
+
+  def has_file path, opts
+    file = seek path
+
+    expect(file).to be
+
+    opts.each do |key, value|
+      expect(file.send key).to eq value
+    end
+
+    file
+  end
+
+  def has_symlink path
+    file = seek path
+
+    expect(file).to be
+    expect(file.typeflag).to eq '2'
+
+    # linkname reading is broken in minitar
+    # expect(file.linkname).to eq target
+
+    file
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: memtar
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rafał Rzepecki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: 
+email:
+- rafal@conjur.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".overcommit.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/memtar.rb
+- lib/memtar/version.rb
+- memtar.gemspec
+- spec/memtar_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dividedmind/memtar
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: In-memory tar archive creation
+test_files:
+- spec/memtar_spec.rb
+- spec/spec_helper.rb