and_feathers-zip 1.0.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 224035664c022a59680fc4a7fc812ea1909deb09
+  data.tar.gz: 3c54fab55be5e069537898545fad61efa4f7c1ef
+SHA512:
+  metadata.gz: 622bdce1ae22b2a45f08b32b98c97b77d269b1cf660c01cd3666c6980ede1aa147d5a162fe42c326a3a2e80a45a258bd43c3293d36a3800ea472af6a4fa41afc
+  data.tar.gz: 72f89c310ef0416be931488c8116c27ef645a3e4038912d4857f8203c41e81e3158767424fb6536a8ab2e1dacca8741e7771903535c4ab9050dacf84d658804f

data/.gitignore

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

data/.rspec

@@ -0,0 +1,5 @@
+-I spec
+-I lib
+--color
+-r byebug
+-r support/cleanliness

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brian Cobb
+
+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,51 @@
+# AndFeathers::Zip
+
+Works with [and-feathers](http://github.com/bcobb/and_feathers) to turn in-memory archives into zip files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'and_feathers-zip'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install and_feathers-zip
+
+## Usage
+
+### Writing a ZIP to disk
+
+```ruby
+require 'and_feathers'
+require 'and_feathers/zip'
+
+# This is a simple archive
+archive = AndFeathers.build('archive') do |root|
+  root.file('README')
+end
+
+File.open('archive.zip', 'w+') do |f|
+  f << archive.to_io(AndFeathers::Zip).read
+end
+```
+
+### Zip an existing directory, plus a few changes/additions
+
+```ruby
+require 'and_feathers'
+require 'and_feathers/zip'
+
+archive = AndFeathers.from_path('spec') do |spec|
+  spec.file('end_to_end_spec.rb') { '# whoops' }
+  spec.file('spec_helper.rb') { '# everyone needs one of these' }
+end
+
+File.open('spec.zip', 'w+') do |f|
+  f << archive.to_io(AndFeathers::Zip).read
+end
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/and_feathers-zip.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'and_feathers/zip/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "and_feathers-zip"
+  spec.version       = AndFeathers::Zip::VERSION
+  spec.authors       = ["Brian Cobb"]
+  spec.email         = ["bcobb@uwalumni.com"]
+  spec.description   = %q{Turn AndFeathers archives into zip archives}
+  spec.summary       = %q{Zip AndFeathers archives}
+  spec.homepage      = "http://github.com/bcobb/and_feathers-zip"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "and_feathers", ">= 1.0.0.pre", "< 2"
+  spec.add_runtime_dependency "rubyzip"
+end

data/lib/and_feathers/zip.rb

@@ -0,0 +1,56 @@
+require 'zip'
+
+module AndFeathers
+  #
+  # Conforms to the interface expected by +Archive#to_io+ in the service of
+  # turning +Archive+s into .zip files
+  #
+  class Zip
+    #
+    # Yields a +Zip+ ready for adding files and directories.
+    #
+    # @yieldparam zip [AndFeathers::Zip]
+    #
+    # @return [StringIO]
+    #
+    def self.open(&block)
+      io = StringIO.new('')
+
+      ::Zip::OutputStream.write_buffer(io) do |zip|
+        block.call(new(zip))
+      end.tap(&:rewind)
+    end
+
+    #
+    # Creates a new +Zip+. Provides the interface require by
+    # +AndFeathers::Zip#to_io+
+    #
+    # @param zip [Zip::File]
+    #
+    def initialize(zip)
+      @zip = zip
+    end
+
+    #
+    # Adds the given file to the zip
+    #
+    # @param file [AndFeathers::File]
+    #
+    def add_file(file)
+      @zip.put_next_entry(file.path)
+      @zip.write(file.read)
+    end
+
+    #
+    # Adds the given directory to the zip
+    #
+    # @note Directories are added to the zip with a trailing slash. Otherwise,
+    #   they would manifest as empty files.
+    #
+    # @param directory [AndFeathers::Directory]
+    #
+    def add_directory(directory)
+      @zip.put_next_entry(::File.join(directory.path, ''))
+    end
+  end
+end

data/lib/and_feathers/zip/version.rb

@@ -0,0 +1,11 @@
+module AndFeathers
+  class Zip
+    #
+    # and_feathers-zip is versioned independently of and_feathers. The only
+    # breaking change in and_feathers that would affect and_feathers-zip at
+    # this point is a change to the protocol expected of the argument passed to
+    # +AndFeathers::Archive#to_io+
+    #
+    VERSION = "1.0.0.pre"
+  end
+end

data/spec/end_to_end_spec.rb

@@ -0,0 +1,129 @@
+require 'and_feathers'
+require 'and_feathers/zip'
+require 'support/in_memory_zip'
+
+describe AndFeathers::Zip do
+  describe 'an archive with a base directory' do
+    let(:archive) do
+      AndFeathers.build('redis') do |redis|
+        redis.dir('cookbooks') do |cookbooks|
+          cookbooks.dir('redis') do |redis|
+            redis.file('README') { 'README contents' }
+            redis.file('CHANGELOG') { 'CHANGELOG contents' }
+            redis.file('metadata.rb') { 'metadata.rb contents' }
+            redis.dir('recipes') do |recipes|
+              recipes.file('default.rb') { 'default.rb contents' }
+            end
+            redis.dir('templates') do |templates|
+              templates.dir('default')
+            end
+          end
+        end
+      end
+    end
+
+    let(:tree) do
+      [
+        './redis/',
+        './redis/cookbooks/',
+        './redis/cookbooks/redis/',
+        './redis/cookbooks/redis/README',
+        './redis/cookbooks/redis/CHANGELOG',
+        './redis/cookbooks/redis/metadata.rb',
+        './redis/cookbooks/redis/recipes/',
+        './redis/cookbooks/redis/recipes/default.rb',
+        './redis/cookbooks/redis/templates/',
+        './redis/cookbooks/redis/templates/default/'
+      ]
+    end
+
+    it 'can build an in-memory zip IO stream' do
+      zip = archive.to_io(AndFeathers::Zip)
+      reader = InMemoryZip.new(zip)
+
+      expect(reader.to_a.map(&:first)).to eql(tree)
+    end
+
+    it 'produces an in-memory IO stream that can be saved to disk' do
+      file = ::File.join("spec", "tmp", "#{Time.now.to_f}.zip")
+      zip = archive.to_io(AndFeathers::Zip)
+
+      ::File.open(file, 'w+') { |f| f << zip.read }
+
+      zipped_files = []
+
+      ::Zip::File.open(file) do |files|
+        files.each do |file|
+          zipped_files << file.name
+        end
+      end
+
+      expect(zipped_files).to eql(tree)
+    end
+  end
+
+  describe 'an archive without a base directory' do
+    let(:archive) do
+      AndFeathers.build do |redis|
+        redis.dir('cookbooks') do |cookbooks|
+          cookbooks.dir('redis') do |redis|
+            redis.file('README') { 'README contents' }
+            redis.file('CHANGELOG') { 'CHANGELOG contents' }
+            redis.file('metadata.rb') { 'metadata.rb contents' }
+            redis.dir('recipes') do |recipes|
+              recipes.file('default.rb') { 'default.rb contents' }
+            end
+            redis.dir('templates') do |templates|
+              templates.dir('default')
+            end
+          end
+        end
+      end
+    end
+
+    let(:tree) do
+      [
+        './',
+        './cookbooks/',
+        './cookbooks/redis/',
+        './cookbooks/redis/README',
+        './cookbooks/redis/CHANGELOG',
+        './cookbooks/redis/metadata.rb',
+        './cookbooks/redis/recipes/',
+        './cookbooks/redis/recipes/default.rb',
+        './cookbooks/redis/templates/',
+        './cookbooks/redis/templates/default/'
+      ]
+    end
+
+    it 'can build an in-memory zip IO stream' do
+      zip = archive.to_io(AndFeathers::Zip)
+      reader = InMemoryZip.new(zip)
+
+      expect(reader.to_a.map(&:first)).to eql(tree)
+      expect(reader.to_a.map(&:last).reject(&:empty?)).to eq([
+        'README contents',
+        'CHANGELOG contents',
+        'metadata.rb contents',
+        'default.rb contents'
+      ])
+    end
+
+    it 'produces an in-memory IO stream that can be saved to disk' do
+      file = ::File.join("spec", "tmp", "#{Time.now.to_f}.zip")
+      zip = archive.to_io(AndFeathers::Zip)
+
+      ::File.open(file, 'w+') { |f| f << zip.read }
+
+      zipped_files = []
+
+      ::Zip::File.open(file) do |files|
+        files.each do |file|
+          zipped_files << file.name
+        end
+      end
+
+      expect(zipped_files).to eql(tree)
+    end
+  end
+end

data/spec/support/cleanliness.rb

@@ -0,0 +1,7 @@
+RSpec.configure do |config|
+  config.after(:suite) do
+    Dir['spec/tmp/*.{zip,tgz}'].each do |archive|
+      File.unlink(archive)
+    end
+  end
+end

data/spec/support/in_memory_zip.rb

@@ -0,0 +1,29 @@
+require 'zip'
+
+class InMemoryZip
+  include Enumerable
+
+  NotUnzipped = Object.new
+
+  def initialize(io)
+    @io = io
+    @unzipped = NotUnzipped
+    @entries = []
+  end
+
+  def each
+    if NotUnzipped == @unzipped
+      ::Zip::InputStream.open(@io) do |zip|
+        while entry = zip.get_next_entry
+          @entries.push([entry, zip.read])
+        end
+      end
+
+      @unzipped = true
+    end
+
+    @entries.each do |entry, content|
+      yield entry.name, content
+    end
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: and_feathers-zip
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre
+platform: ruby
+authors:
+- Brian Cobb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: and_feathers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Turn AndFeathers archives into zip archives
+email:
+- bcobb@uwalumni.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- and_feathers-zip.gemspec
+- lib/and_feathers/zip.rb
+- lib/and_feathers/zip/version.rb
+- spec/end_to_end_spec.rb
+- spec/support/cleanliness.rb
+- spec/support/in_memory_zip.rb
+homepage: http://github.com/bcobb/and_feathers-zip
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Zip AndFeathers archives
+test_files:
+- spec/end_to_end_spec.rb
+- spec/support/cleanliness.rb
+- spec/support/in_memory_zip.rb
+has_rdoc: