and_feathers 0.0.1 → 1.0.0.pre

data/spec/end_to_end/and_feathers_spec.rb

@@ -0,0 +1,162 @@
+require 'and_feathers'
+
+describe AndFeathers do
+
+  describe 'building 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/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 depth-first' do
+      expect(archive.to_a.map(&:path)).to eql(tree)
+    end
+
+    it 'loads file content' do
+      files = archive.to_a.select { |e| e.is_a?(AndFeathers::File) }
+      expect(files.map(&:read)).to eql(
+        [
+          'README contents',
+          'CHANGELOG contents',
+          'metadata.rb contents',
+          'default.rb contents'
+        ]
+      )
+    end
+  end
+
+  describe 'building 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 'iterates through each directory depth-first' do
+      expect(archive.to_a.map(&:path)).to eql(tree)
+    end
+
+    it 'loads file content' do
+      files = archive.to_a.select { |e| e.is_a?(AndFeathers::File) }
+      expect(files.map(&:read)).to eql(
+        [
+          'README contents',
+          'CHANGELOG contents',
+          'metadata.rb contents',
+          'default.rb contents'
+        ]
+      )
+    end
+  end
+
+  describe 'loading an archive from an existing tree' do
+    let(:tree) do
+      [
+        './archiveme/README.md',
+        './archiveme/lib',
+        './archiveme/lib/archiveme.rb'
+      ]
+    end
+
+    it 'iterates through a directory depth-first' do
+      archive = AndFeathers.from_path('spec/fixtures/archiveme')
+
+      expect(archive.to_a.map(&:path)).to eql(tree)
+    end
+
+    it 'loads file content' do
+      archive = AndFeathers.from_path('spec/fixtures/archiveme')
+
+      files = archive.to_a.select { |e| e.is_a?(AndFeathers::File) }
+
+      expect(files.map(&:read)).to eql(
+        ["# Hello\n", "class Archiveme\nend\n"]
+      )
+    end
+
+    it 'iterates through "." in the same way' do
+      archive = []
+
+      Dir.chdir('spec/fixtures/archiveme') do
+        archive = AndFeathers.from_path('.')
+      end
+
+      expect(archive.to_a.map(&:path)).to eql(tree)
+    end
+
+    it 'raises when the given path does not exist' do
+      expect do
+        AndFeathers.from_path('app')
+      end.to raise_error(ArgumentError)
+    end
+
+    it 'yields the resulting archive for modification', focus: true  do
+      archive = AndFeathers.from_path('spec/fixtures/archiveme')
+      archive.file('lib/archiveme/version.rb') do
+        "class Archiveme\n  VERSION='0.0.1'\nend"
+      end
+      archive.dir('tmp')
+
+      new_tree = [
+        './archiveme/lib/archiveme',
+        './archiveme/lib/archiveme/version.rb',
+        './archiveme/tmp'
+      ]
+
+      expect(archive.to_a.map(&:path)).to eql(tree + new_tree)
+    end
+  end
+end

data/spec/fixtures/archiveme/README.md

@@ -0,0 +1 @@
+# Hello

data/spec/fixtures/archiveme/lib/archiveme.rb

@@ -0,0 +1,2 @@
+class Archiveme
+end

data/spec/unit/directory_spec.rb

@@ -0,0 +1,103 @@
+require 'and_feathers/file'
+require 'and_feathers/directory'
+
+module AndFeathers
+  describe Directory do
+    it 'can be unioned with another directory' do
+      one = Directory.new
+      two = Directory.new
+      one.dir('a') do |a|
+        a.dir('b') do |b|
+          b.file('c')
+        end
+        a.dir('c')
+      end
+
+      two.dir('a') do |a|
+        a.dir('b') do |b|
+          b.file('d')
+        end
+      end
+
+      three = one | two
+
+      expect(three.to_a.map(&:path)).
+        to eql(['./a', './a/b', './a/b/c', './a/b/d', './a/c'])
+    end
+
+    it 'allows for manually nesting directories' do
+      archive = Directory.new
+      archive.dir('a') do |a|
+        a.dir('b') do |b|
+          b.dir('c')
+        end
+      end
+
+      expect(archive.to_a.map(&:path)).to eql(['./a', './a/b', './a/b/c'])
+    end
+
+    it 'allows for convenient nesting of directories' do
+      archive = Directory.new
+      archive.dir('a/b/c')
+
+      expect(archive.to_a.map(&:path)).to eql(['./a', './a/b', './a/b/c'])
+    end
+
+    it 'only creates a given path once' do
+      archive = Directory.new
+      archive.dir('a/b/c')
+      archive.dir('a/b/c/d')
+
+      expect(archive.to_a.map(&:path)).
+        to eql(['./a', './a/b', './a/b/c', './a/b/c/d'])
+    end
+
+    it 'takes the most recent duplicate directory as authoritative' do
+      archive = Directory.new
+      archive.dir('a/b/c')
+      archive.dir('a/b/d')
+
+      expect(archive.to_a.map(&:path)).to eql(['./a', './a/b', './a/b/d'])
+    end
+
+    it 'allows for manually nesting files in directories' do
+      archive = Directory.new
+      archive.dir('a') do |a|
+        a.dir('b') do |b|
+          b.dir('c') do |c|
+            c.file 'README'
+          end
+        end
+      end
+
+      expect(archive.to_a.map(&:path)).
+        to eql(['./a', './a/b', './a/b/c', './a/b/c/README'])
+    end
+
+    it 'allows for convenient nesting of files in directories' do
+      archive = Directory.new
+      archive.file('a/b/c/README')
+
+      expect(archive.to_a.map(&:path)).
+        to eql(['./a', './a/b', './a/b/c', './a/b/c/README'])
+    end
+
+    it 'only creates a given file once' do
+      archive = Directory.new
+      archive.file('a/README')
+      archive.file('a/README')
+
+      expect(archive.to_a.map(&:path)).to eql(['./a', './a/README'])
+    end
+
+    it 'takes the most recent file as the authoritative file' do
+      archive = Directory.new
+      archive.file('a/README') { '1' }
+      archive.file('a/README') { '2' }
+
+      readme = archive.to_a.find { |e| e.is_a?(File) }
+
+      expect(readme.read).to eql('2')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: and_feathers
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0.pre
 platform: ruby
 authors:
 - Brian Cobb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-21 00:00:00.000000000 Z
+date: 2014-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,8 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: Declaratively and iteratively build archive structures which easily serialize
+  to on-disk formats such as zip and tgz.
 email:
 - bcobb@uwalumni.com
 executables: []
@@ -68,14 +69,15 @@ files:
 - 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/archive.rb
+- lib/and_feathers/directory.rb
+- lib/and_feathers/file.rb
+- lib/and_feathers/sugar.rb
 - lib/and_feathers/version.rb
-- spec/end_to_end_spec.rb
-- spec/support/in_memory_gzipped_tarball.rb
+- spec/end_to_end/and_feathers_spec.rb
+- spec/fixtures/archiveme/README.md
+- spec/fixtures/archiveme/lib/archiveme.rb
+- spec/unit/directory_spec.rb
 homepage: http://github.com/bcobb/and_feathers
 licenses:
 - MIT
@@ -91,16 +93,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Declaratively build GZipped Tarballs in memory
+summary: In-memory archive structures
 test_files:
-- spec/end_to_end_spec.rb
-- spec/support/in_memory_gzipped_tarball.rb
+- spec/end_to_end/and_feathers_spec.rb
+- spec/fixtures/archiveme/README.md
+- spec/fixtures/archiveme/lib/archiveme.rb
+- spec/unit/directory_spec.rb
 has_rdoc: 

data/lib/and_feathers/tarball/contains_directories.rb

@@ -1,24 +0,0 @@
-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

@@ -1,27 +0,0 @@
-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

@@ -1,66 +0,0 @@
-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

@@ -1,60 +0,0 @@
-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/tarball.rb

@@ -1,75 +0,0 @@
-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