and_feathers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1223a216ba02082494665468136a5511c39a9f1a
+  data.tar.gz: ab24c8bbac7301824b242bbb875c7ff88b3b60f4
+SHA512:
+  metadata.gz: ce15a3c45c91982cad44943259acd6575b49f28e639bfec316a307ab973434d61b50088604898f6ad0b618b42745c54cd7ac373185d2cf4b4c0bc27d774e883c
+  data.tar.gz: 3db4aa09d56d1d9829909d89bc5e246f2f38eeb112f4ed62643160319ac83375dda49a395ba3d7ee23563a2fffad723098837f6fb778d46a23396782c33d1f5a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,4 @@
+-I spec
+-I lib
+--color
+--order random

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in and_feathers.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,44 @@
+# AndFeathers
+
+Declaratively build in-memory gzipped tarballs.
+
+## Installation
+
+Either run:
+
+    $ gem install and_feathers
+
+Or, if you're using Bundler, add this line to your application's Gemfile:
+
+    gem 'and_feathers'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Suppose you want to create the equivalent of a Chef cookbook artifact created using knife:
+
+```ruby
+require 'and_feathers'
+require 'json'
+
+tarball = AndFeathers.build('redis') do |redis|
+  redis.file('README.md') { "README content" }
+  redis.file('metadata.json') { JSON.dump({}) }
+  redis.file('metadata.rb') { "# metadata.rb content" }
+  redis.dir('attributes') do |attributes|
+    attributes.file('default.rb') { '# default.rb content' }
+  end
+  redis.dir('recipes') do |recipes|
+    attributes.file('default.rb') { '# default.rb content' }
+  end
+  redis.dir('templates') do |templates|
+    templates.dir('default')
+  end
+end
+
+tarball.to_io # a gzipped, tarball StringIO
+```
+

data/Rakefile

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

data/and_feathers.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'and_feathers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "and_feathers"
+  spec.version       = AndFeathers::VERSION
+  spec.authors       = ["Brian Cobb"]
+  spec.email         = ["bcobb@uwalumni.com"]
+  spec.summary       = %q{Declaratively build GZipped Tarballs in memory}
+  spec.homepage      = "http://github.com/bcobb/and_feathers"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/and_feathers.rb

@@ -0,0 +1,36 @@
+require 'and_feathers/tarball/file'
+require 'and_feathers/tarball/directory'
+require 'and_feathers/tarball'
+require 'and_feathers/version'
+
+#
+# The entry-point to the builder DSL
+#
+module AndFeathers
+  #
+  # Builds a new +Tarball+. If +base+ is not given, the tarball's contents
+  # would be extracted to intermingle with whichever directory contains the
+  # tarball. If +base+ is given, the tarball's contents will live inside a
+  # directory with that name. This is just a convenient way to have a +dir+
+  # call wrap the tarball's contents
+  #
+  # @param base [String] name of the base directory containing the tarball's
+  #   contents
+  # @param base_mode [Fixnum] the mode of the base directory
+  #
+  # @yieldparam tarball [Tarball]
+  #
+  def self.build(base = nil, base_mode = 16877, &block)
+    if base && base_mode
+      Tarball.new.tap do |tarball|
+        tarball.dir(base, base_mode) do |dir|
+          block.call(dir)
+        end
+      end
+    else
+      Tarball.new.tap do |tarball|
+        block.call(tarball)
+      end
+    end
+  end
+end

data/lib/and_feathers/tarball.rb

@@ -0,0 +1,75 @@
+require 'and_feathers/tarball/contains_files'
+require 'and_feathers/tarball/contains_directories'
+require 'rubygems/package'
+require 'zlib'
+
+module AndFeathers
+  #
+  # The base tarball representation
+  #
+  class Tarball
+    include ContainsFiles
+    include ContainsDirectories
+    include Enumerable
+
+    #
+    # @!attribute [r] path
+    #   @return [String] the base tarball path
+    #
+
+    attr_reader :path
+
+    #
+    # Creates a new +Tarball+
+    #
+    # @param path [String] the base tarball path
+    #
+    def initialize(path = '.')
+      @path = path
+      @children = []
+    end
+
+    #
+    # Iterates through each entity in the tarball, depth-first
+    #
+    # @yieldparam child [File, Directory]
+    #
+    def each(&block)
+      @children.each do |child|
+        block.call(child)
+        child.each(&block)
+      end
+    end
+
+    #
+    # Returns this +Tarball+ as a GZipped and tarred +StringIO+
+    #
+    # @return [StringIO]
+    #
+    def to_io
+      tarball_io = StringIO.new("")
+
+      Gem::Package::TarWriter.new(tarball_io) do |tar|
+        each do |child|
+          case child
+          when File
+            tar.add_file(child.path, child.mode) do |file|
+              file.write child.read
+            end
+          when Directory
+            tar.mkdir(child.path, child.mode)
+          end
+        end
+      end
+
+      gzip_io = StringIO.new("")
+
+      Zlib::GzipWriter.new(gzip_io).tap do |writer|
+        writer.write(tarball_io.tap(&:rewind).string)
+        writer.close
+      end
+
+      StringIO.new(gzip_io.string)
+    end
+  end
+end

data/lib/and_feathers/tarball/contains_directories.rb

@@ -0,0 +1,24 @@
+module AndFeathers
+  class Tarball
+    #
+    # A module which gives instances of a class the +dir+ DSL method
+    #
+    module ContainsDirectories
+      #
+      # Add a +Directory+ named +name+ to this entity's list of children
+      #
+      # @param name [String] the directory name
+      # @param mode [Fixnum] the directory mode
+      #
+      # @yieldparam directory [Directory] the newly-created +Directory+
+      #
+      def dir(name, mode = 16877, &block)
+        Directory.new(name, mode, self).tap do |subdir|
+          block.call(subdir) if block
+
+          @children.push(subdir)
+        end
+      end
+    end
+  end
+end

data/lib/and_feathers/tarball/contains_files.rb

@@ -0,0 +1,27 @@
+module AndFeathers
+  class Tarball
+    #
+    # A module which gives instances of a class the +file+ DSL method
+    #
+    module ContainsFiles
+      #
+      # The default file content block, which returns an empty string
+      #
+      NO_CONTENT = Proc.new { "" }
+
+      #
+      # Add a +File+ named +name+ to this entity's list of children
+      #
+      # @param name [String] the file name
+      # @param mode [Fixnum] the file mode
+      #
+      # @yieldreturn [String] the file contents
+      #
+      def file(name, mode = 33188, &content)
+        content ||= NO_CONTENT
+
+        @children.push(File.new(name, mode, content, self))
+      end
+    end
+  end
+end

data/lib/and_feathers/tarball/directory.rb

@@ -0,0 +1,66 @@
+require 'and_feathers/tarball/contains_files'
+require 'and_feathers/tarball/contains_directories'
+
+module AndFeathers
+  class Tarball
+    #
+    # Represents a Directory inside the tarball
+    #
+    class Directory
+      include Tarball::ContainsFiles
+      include Tarball::ContainsDirectories
+
+      attr_reader :name, :mode
+
+      #
+      # @!attribute [r] name
+      #   @return [String] the directory name
+      #
+      # @!attribute [r] mode
+      #   @return [Fixnum] the directory mode
+      #
+
+      #
+      # Creates a new +Directory+
+      #
+      # @param name [String] the directory name
+      # @param mode [Fixnum] the directory mode
+      # @param parent [Directory, Tarball] the parent entity of this directory
+      #
+      def initialize(name, mode, parent)
+        @name = name
+        @mode = mode
+        @parent = parent
+        @children = []
+      end
+
+      #
+      # This +Directory+'s path
+      #
+      # @return [String]
+      #
+      def path
+        ::File.join(@parent.path, name)
+      end
+
+      #
+      # Iterates through this +Directory+'s children down to each leaf child.
+      #
+      # @yieldparam child [File, Directory]
+      #
+      def each(&block)
+        files, subdirectories = @children.partition do |child|
+          child.is_a?(File)
+        end
+
+        files.each(&block)
+
+        subdirectories.each do |subdirectory|
+          block.call(subdirectory)
+
+          subdirectory.each(&block)
+        end
+      end
+    end
+  end
+end

data/lib/and_feathers/tarball/file.rb

@@ -0,0 +1,60 @@
+module AndFeathers
+  class Tarball
+    #
+    # Represents a File inside the tarball
+    #
+    class File
+      include Enumerable
+
+      attr_reader :name, :mode
+
+      #
+      # @!attribute [r] name
+      #   @return [String] the directory name
+      #
+      # @!attribute [r] mode
+      #   @return [Fixnum] the directory mode
+      #
+
+      #
+      # Creates a new +File+
+      #
+      # @param name [String] the file name
+      # @param mode [Fixnum] the file mode
+      # @param content [Proc] a block which returns the file contents
+      # @param parent [Directory, Tarball] the entity which contains this file
+      #
+      def initialize(name, mode, content, parent)
+        @name = name
+        @mode = mode
+        @content = content
+        @parent = parent
+      end
+
+      #
+      # This +File+'s path
+      #
+      # @return [String]
+      #
+      def path
+        ::File.join(@parent.path, name)
+      end
+
+      #
+      # This +File+'s contents
+      #
+      def read
+        @content.call
+      end
+
+      #
+      # +Enumerable+ interface which simply yields this +File+ to the block
+      #
+      # @yieldparam file [File]
+      #
+      def each(&block)
+        block.call(self)
+      end
+    end
+  end
+end

data/lib/and_feathers/version.rb

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

data/spec/end_to_end_spec.rb

@@ -0,0 +1,106 @@
+require 'and_feathers'
+require 'support/in_memory_gzipped_tarball'
+
+describe AndFeathers do
+
+  describe 'a tarball with a base directory' do
+    let(:tarball) 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 'iterates through each directory breadth-first' do
+      expect(tarball.to_a.map(&:path)).to eql(tree)
+    end
+
+    it 'can build an in-memory tarred/gzipped IO stream' do
+      reader = InMemoryGzippedTarball.new(tarball.to_io)
+
+      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
+  end
+
+  describe 'a tarball without a base directory' do
+    let(:tarball) 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 'iterates through each directory breadth-first' do
+      expect(tarball.to_a.map(&:path)).to eql(tree)
+    end
+
+    it 'can build an in-memory tarred/gzipped IO stream' do
+      reader = InMemoryGzippedTarball.new(tarball.to_io)
+
+      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
+  end
+end

data/spec/support/in_memory_gzipped_tarball.rb

@@ -0,0 +1,35 @@
+require 'rubygems/package'
+require 'zlib'
+
+class InMemoryGzippedTarball
+  include Enumerable
+
+  NotUnzipped = Object.new
+
+  def initialize(file)
+    @file = file
+    @unzipped = NotUnzipped
+  end
+
+  def each
+    if NotUnzipped == @unzipped
+      reader = Zlib::GzipReader.new(@file)
+      @unzipped = StringIO.new(reader.read).tap do
+        reader.close
+      end
+    end
+
+    Gem::Package::TarReader.new(@unzipped)do |tar|
+      tar.each do |tarfile|
+        if tarfile.directory?
+          yield tarfile.full_name, ''
+        else
+          yield tarfile.full_name, tarfile.read
+        end
+      end
+    end
+  ensure
+    @unzipped.rewind
+  end
+end
+

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: and_feathers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Cobb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-21 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'
+description: 
+email:
+- bcobb@uwalumni.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- and_feathers.gemspec
+- lib/and_feathers.rb
+- lib/and_feathers/tarball.rb
+- lib/and_feathers/tarball/contains_directories.rb
+- lib/and_feathers/tarball/contains_files.rb
+- lib/and_feathers/tarball/directory.rb
+- lib/and_feathers/tarball/file.rb
+- lib/and_feathers/version.rb
+- spec/end_to_end_spec.rb
+- spec/support/in_memory_gzipped_tarball.rb
+homepage: http://github.com/bcobb/and_feathers
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Declaratively build GZipped Tarballs in memory
+test_files:
+- spec/end_to_end_spec.rb
+- spec/support/in_memory_gzipped_tarball.rb
+has_rdoc: