dockly 0.0.4 → 0.0.5

data/README.md

@@ -1,3 +1,7 @@
+[![Gem Version](https://badge.fury.io/rb/dockly.png)](http://badge.fury.io/rb/dockly)
+[![Build Status](https://travis-ci.org/swipely/dockly.png?branch=refactor_setup)](https://travis-ci.org/swipely/dockly)
+[![Dependency Status](https://gemnasium.com/swipely/dockly.png)](https://gemnasium.com/swipely/dockly)
+
 Dockly
 =======
 
@@ -21,11 +25,11 @@ docker :test_docker do
 end
 ```
 
-Each object has an enumeration of valid attributes. The following code sets the `repo` attribute in a `docker` called `test_docker`:
+Each object has an enumeration of valid attributes. The following code sets the `repository` attribute in a `docker` called `test_docker`:
 
 ```ruby
 docker :test_docker do
-  repo 'an-awesome-repo'
+  repository 'an-awesome-name'
 end
 ```
 
@@ -33,7 +37,7 @@ Finally, each object has zero or more valid references to other DSL objects. The
 
 ```ruby
 docker :my_docker do
-  repo 'my-repo'
+  repository 'my-name'
 end
 
 deb :my_deb do
@@ -46,11 +50,40 @@ Below is an alternative syntax that accomplishes the same thing:
 ```ruby
 deb :my_deb do
   docker do
-    repo 'my-repo'
+    repository 'my-name'
   end
 end
 ```
 
+`build_cache`
+-------------
+
+The `build_cache` DSL is used to prevent rebuilding assets every build and used cached assets.
+
+- `s3_bucket`
+    - required: `true`
+    - description: the bucket name to download and upload build caches to
+- `s3_object_prefix`
+    - required: `true`
+    - description: the name prepended to the package; allows for namespacing your caches
+- `hash_command`
+    - required: `true`
+    - description: command run inside of the Docker image to determine if the build cache is up to date (eg. `md5sum ... | awk '{ print $1 }'`)
+- `build_command`
+    - required: `true`
+    - description: command run inside of the Docker image when the build cache is out of date
+- `output_dir`
+    - required: `true`
+    - description: where the cache is located in the Docker image filesystem
+- `tmp_dir`
+    - required: `true`
+    - default: `/tmp`
+    - description: where the build cache files are stored locally; this should be able to be removed easily since they all exist in S3 as well
+- `use_latest`
+    - required: `false`
+    - default: `false`
+    - description: when using S3, will insert the S3 object tagged as latest in your "s3://s3_bucket/s3_object_prefix" before running the build command to quicken build times
+
 `docker`
 --------
 
@@ -58,7 +91,6 @@ The `docker` DSL is used to define Docker containers. It has the following attri
 
 - `import`
     - required: `true`
-    - default: `nil`
     - description: the location (url or S3 path) of the base image to start building from
 - `git_archive`:
     - required: `false`
@@ -66,15 +98,15 @@ The `docker` DSL is used to define Docker containers. It has the following attri
     - description: the relative file path of git repo that should be added to the container
 - `build`
     - required: `true`
-    - default: `nil`
     - description: aditional Dockerfile commands that you'd like to pass to `docker build`
-- `repo`
+- `repository`
     - required: `true`
     - default: `'dockly'`
     - description: the repository of the created image
+- `name`
+    - alias for: `repository`
 - `tag`
     - required: `true`
-    - default: `nil`
     - description: the tag of the created image
 - `build_dir`
     - required: `true`
@@ -93,6 +125,13 @@ The `docker` DSL is used to define Docker containers. It has the following attri
     - default: `[]`
     - description: a listing of references to build caches to run
 
+In addition to the above attributes, `docker` has the following references:
+
+- `build_cache`
+    - required: `false`
+    - class: `Dockly::BuildCache`
+    - description: a caching system to stop rebuilding/compiling the same files every time
+
 `foreman`
 ---------
 
@@ -133,7 +172,6 @@ The `deb` DSL is used to define Debian packages. It has the following attributes
 
 - `package_name`
     - required: `true`
-    - default: `nil`
     - description: the name of the created package
 - `version`
     - required: `true`
@@ -185,7 +223,6 @@ deb :dockly_package do
 
   docker do
     name :dockly_docker
-    tag 'dockly_docker'
     import 's3://dockly-bucket-name/base-image.tar.gz'
     git_archive '/app'
     timeout 120

data/lib/dockly/docker.rb

@@ -10,10 +10,10 @@ class Dockly::Docker
   include Dockly::Util::Logger::Mixin
 
   logger_prefix '[dockly docker]'
-  dsl_attribute :import, :git_archive, :build, :repo, :tag, :build_dir, :package_dir,
+  dsl_attribute :name, :import, :git_archive, :build, :tag, :build_dir, :package_dir,
     :timeout, :cleanup_images, :build_caches
 
-  default_value :repo, 'dockly'
+  default_value :tag, nil
   default_value :build_dir, 'build/docker'
   default_value :package_dir, '/opt/docker'
   default_value :build_caches, []
@@ -38,7 +38,7 @@ class Dockly::Docker
   end
 
   def export_filename
-    "#{repo}-#{tag}-image.tgz"
+    "#{name}-image.tgz"
   end
 
   def run_build_caches(image)
@@ -66,7 +66,7 @@ class Dockly::Docker
   end
 
   def make_git_archive
-    ensure_present! :tag, :git_archive
+    ensure_present! :git_archive
     info "initializing"
 
     prefix = git_archive
@@ -110,16 +110,16 @@ class Dockly::Docker
   end
 
   def build_image(image)
-    ensure_present! :repo, :tag, :build
+    ensure_present! :name, :build
     info "starting build from #{image.id}"
     out_image = ::Docker::Image.build("from #{image.id}\n#{build}")
     info "built the image: #{out_image.id}"
-    out_image.tag(:repo => repo, :tag => tag)
+    out_image.tag(:repo => name, :tag => tag)
     out_image
   end
 
   def export_image(image)
-    ensure_present! :repo, :tag, :build_dir
+    ensure_present! :name, :build_dir
     container = ::Docker::Container.create('Image' => image.id, 'Cmd' => %w[true])
     info "created the container: #{container.id}"
     Zlib::GzipWriter.open(tar_path) do |file|
@@ -131,7 +131,7 @@ class Dockly::Docker
   end
 
   def fetch_import
-    ensure_present! :tag, :import
+    ensure_present! :import
     path = "/tmp/dockly-docker-import.#{name}.#{File.basename(import)}"
 
     if File.exist?(path)
@@ -162,6 +162,10 @@ class Dockly::Docker
     build_caches << Dockly::BuildCache.new(&block)
   end
 
+  def repository(value = nil)
+    name(value)
+  end
+
 private
   def connection
     Dockly::AWS.s3

data/lib/dockly/version.rb

@@ -1,3 +1,3 @@
 module Dockly
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/spec/dockly/deb_spec.rb

@@ -48,11 +48,10 @@ describe Dockly::Deb do
     context 'when it has a docker', :docker do
       before do
         subject.docker do
-          name 'my-docker-for-deb'
+          name 'deb_test'
           import 'https://s3.amazonaws.com/swipely-pub/docker-export-ubuntu-latest.tgz'
           git_archive '.'
           build 'touch /deb_worked'
-          tag 'deb_test'
           build_dir 'build/docker'
         end
       end

data/spec/dockly/docker_spec.rb

@@ -149,7 +149,7 @@ describe Dockly::Docker do
   end
 
   describe '#generate!', :docker do
-    let(:docker_file) { 'build/docker/dockly_test-generate-image.tgz' }
+    let(:docker_file) { 'build/docker/dockly_test-image.tgz' }
     before { FileUtils.rm_rf(docker_file) }
 
     context 'without cleaning up' do
@@ -158,8 +158,7 @@ describe Dockly::Docker do
           import 'https://s3.amazonaws.com/swipely-pub/docker-export-ubuntu-latest.tgz'
           git_archive '.'
           build "run touch /it_worked"
-          repo 'dockly_test'
-          tag 'generate'
+          repository 'dockly_test'
           build_dir 'build/docker'
           cleanup_images false
         end
@@ -188,8 +187,7 @@ describe Dockly::Docker do
           import 'https://s3.amazonaws.com/swipely-pub/docker-export-ubuntu-latest.tgz'
           git_archive '.'
           build "run touch /it_worked"
-          repo 'dockly_test'
-          tag 'generate'
+          repository 'dockly_test'
           build_dir 'build/docker'
           cleanup_images true
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dockly
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-07 00:00:00.000000000 Z
+date: 2013-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp