dry-dock 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f2e43155c83ad0b25eb7ee30a1da32697c0b270
-  data.tar.gz: fe24886ba40a3d093989f2c03f0068026698dcdf
+  metadata.gz: 2627cbab1b9589543ec9a8997d95eb6071ecd17a
+  data.tar.gz: 6fe87f56623532901d4fb285a8cc07a584007cb0
 SHA512:
-  metadata.gz: daf3a6b9aea72c10fb072740f97c2682df12f6378d88f768d0de43ffd16fd4f2f4bb92cb43190598e9d3e04d6c48bdd964c6edcd7ea8e8c1594e5c883a9968ba
-  data.tar.gz: b300b19d4869daf770dd612f7524ce5a8cbf909d3812be2feb9661ee42a01f55ec639071e2f2515c4d6c6b7e4d23823321be501bc234457cb26597e8ad74dafe
+  metadata.gz: f4360c64a1b7d07b36ef1e6e79fc6fb65d73b14ecea226be78bc75819f0fe77b7fbe4f24b0572bfcb4d84900167f442f1709d332d6d5f71cee5b6d66660e5495
+  data.tar.gz: b28fa39b7acbe2e4044b7f75748d314b198f9f90b9da2098bb96552c5495da6548a9daf53080cc672984368464ac343d1124892443587cb5c879bcf975a7b16d

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Metrics/LineLength:
+  Max: 120
+Style/FormatString:
+  EnforcedStyle: sprintf

data/Gemfile

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 
 group :development do
   gem 'rake', '~> 10.0'
+  gem 'rubocop', '~> 0.34'
   gem 'jeweler', '~> 2.0'
   gem 'pry', '~> 0.10'
 
@@ -17,5 +18,7 @@ group :test do
   gem 'fakefs', require: false
 end
 
+gem 'attr_extras', '~> 4.4'
 gem 'docker-api', '~> 1.22', require: 'docker'
 gem 'excon', '~> 0.45'
+gem 'memoist', '~> 0.12'

data/Gemfile.lock

@@ -2,6 +2,10 @@ GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.3.8)
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
+    attr_extras (4.4.0)
     builder (3.2.2)
     codeclimate-test-reporter (0.4.8)
       simplecov (>= 0.7.1, < 1.0.0)
@@ -39,6 +43,7 @@ GEM
       rdoc
     json (1.8.3)
     jwt (1.5.1)
+    memoist (0.12.0)
     method_source (0.8.2)
     mini_portile (0.6.2)
     multi_json (1.11.2)
@@ -52,11 +57,15 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
+    parser (2.2.2.6)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
     pry (0.10.1)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
     rack (1.6.4)
+    rainbow (2.0.0)
     rake (10.4.2)
     rdoc (4.2.0)
       json (~> 1.4)
@@ -75,6 +84,13 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
+    rubocop (0.34.2)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
     simplecov (0.10.0)
       docile (~> 1.1.0)
       json (~> 1.8)
@@ -89,15 +105,18 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  attr_extras (~> 4.4)
   codeclimate-test-reporter
   docker-api (~> 1.22)
   excon (~> 0.45)
   fakefs
   jeweler (~> 2.0)
+  memoist (~> 0.12)
   pry (~> 0.10)
   rake (~> 10.0)
   rspec (~> 3.0)
   rspec-collection_matchers
+  rubocop (~> 0.34)
   simplecov (~> 0.9)
   simplecov-rcov (~> 0.2)
 

data/README.md

@@ -3,11 +3,13 @@
 WORK IN PROGRESS — ALPHA-RELEASE SOFTWARE
 SOME FEATURES REQUIRE DOCKER 1.8.0 OR NEWER
 
-![Automated Build Status](https://travis-ci.org/ripta/drydock.svg)
+[![Automated Build Status](https://travis-ci.org/ripta/drydock.svg)](https://travis-ci.org/ripta/drydock)
+[![Code Climate](https://codeclimate.com/github/ripta/drydock/badges/gpa.svg)](https://codeclimate.com/github/ripta/drydock)
 
 A ruby DSL to build your own docker images. Images are built based on instructions
 contained in your project's `Drydockfile`.
 
+
 ## Why not Dockerfile?
 
 [Dockerfiles](https://docs.docker.com/reference/builder/) are great to start out
@@ -27,6 +29,7 @@ it would be nice to import a configurably-older image, import the new Gemfile,
 and re-run the build. On the other hand, it would be important to be able to limit
 the age of the cache.
 
+
 ## Why Drydock?
 
 Drydock interfaces directly with the [Docker Remote API](https://docs.docker.com/reference/api/docker_remote_api/)
@@ -39,20 +42,24 @@ in your project being built by Drydock.
 
 Drydockfiles are written in ruby.
 
-## Production Installation
+
+## Installation
 
 Either (a) `gem install dry-dock`, or (b) add "dry-dock" to your project's Gemfile,
-and run `bundle`. Sorry, but the gem name `drydock` was already taken by a defunct
-gem, and I'm too lazy to contact them; the binary and name of the project, however,
-are both `drydock`.
+and run `bundle`.
+
+Sorry, but the gem name `drydock` was already taken by a defunct gem, and I'm too
+lazy to contact them; the binary and name of the project, however, are both `drydock`.
 
 In your project's root directory, you'll want to create a `Drydockfile` containing
-drydock functions. When you're ready, build an image using:
+drydock functions. When you're ready, from your project's directory, build an image using:
 
 ```
-$ drydock
+$ bundle exec drydock
 ```
 
+or `drydock` directly if you're not using bundler.
+
 Alternatively, point drydock to a directory containing the `Drydockfile`, or to any
 file to treat it as the `Drydockfile`, e.g.:
 
@@ -61,22 +68,14 @@ $ drydock ~/source/miniproject # project directory expects a file named Drydockf
 $ drydock ~/source/miniproject/drydock-definition.rb # expects a drydock-definition.rb
 ```
 
-Example `Drydockfile`s may be seen in `examples/`.
-
-## Development Installation
+**Example `Drydockfile`s may be seen in the `examples/` directory of the source repo.**
 
-This is needed if you plan on hacking drydock:
-
-```
-$ git clone git@github.com:ripta/drydock.git
-$ bundle
-```
 
 ## Drydockfile Syntax
 
 As previously mentioned, Drydockfiles are ruby. The contents of Drydockfile are
-evaluated in the context of an instance of `Drydock::Project`; you can refer to
-the documentation for it for more in-depth information.
+evaluated in the context of an instance of {Drydock::Project}; you can refer to
+the documentation for it for more in-depth information on each instruction.
 
 Because Drydockfiles are ruby, most constructs should work as-is: you can declare
 constants and refer to them later; call `Kernel#abort` to exit the program and
@@ -93,7 +92,18 @@ methods of the {Drydock::Project} class or head to the
 [automatically-generated ruby docs](http://www.rubydoc.info/gems/dry-dock).
 
 
+## Contributing
+
+If you plan on hacking or contributing to drydock, fork the project, create a new
+branch, make your changes, commit, and open a pull request.
+
+After cloning your repo, `bundle` should take care of it.
+
+
 ## Roadmap
 
-1. Customizable caching subsystem.
-4. Customizable caching rules.
+1. Customizable caching subsystem with pluggable caching strategies.
+2. Squashing layers together, with cache support.
+3. Unarchiving a file directly into a container.
+4. Proper `ONBUILD` implementation and expanded support for hooks.
+5. Drydock instructions corresponding to `LABEL`, `VOLUME`, `USER`, and `WORKDIR` Docker instructions.

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.6

data/dry-dock.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: dry-dock 0.1.5 ruby lib
+# stub: dry-dock 0.1.6 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "dry-dock"
-  s.version = "0.1.5"
+  s.version = "0.1.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Ripta Pasay"]
-  s.date = "2015-10-07"
+  s.date = "2015-10-08"
   s.description = "A Dockerfile-replacement DSL for building complex images"
   s.email = "github@r8y.org"
   s.executables = ["drydock", "json-test-consumer.rb", "json-test-producer.rb", "test-tar-writer-digest.rb"]
@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
     ".dockerignore",
     ".pryrc",
     ".rspec",
+    ".rubocop.yml",
     ".travis.yml",
     ".yardopts",
     "Dockerfile",
@@ -52,6 +53,8 @@ Gem::Specification.new do |s|
     "lib/drydock/formatters.rb",
     "lib/drydock/ignorefile_definition.rb",
     "lib/drydock/image_repository.rb",
+    "lib/drydock/instructions/base.rb",
+    "lib/drydock/instructions/copy.rb",
     "lib/drydock/logger.rb",
     "lib/drydock/object_caches/base.rb",
     "lib/drydock/object_caches/filesystem_cache.rb",
@@ -109,26 +112,35 @@ Gem::Specification.new do |s|
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<attr_extras>, ["~> 4.4"])
       s.add_runtime_dependency(%q<docker-api>, ["~> 1.22"])
       s.add_runtime_dependency(%q<excon>, ["~> 0.45"])
+      s.add_runtime_dependency(%q<memoist>, ["~> 0.12"])
       s.add_development_dependency(%q<rake>, ["~> 10.0"])
+      s.add_development_dependency(%q<rubocop>, ["~> 0.34"])
       s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
       s.add_development_dependency(%q<pry>, ["~> 0.10"])
       s.add_development_dependency(%q<simplecov>, ["~> 0.9"])
       s.add_development_dependency(%q<simplecov-rcov>, ["~> 0.2"])
     else
+      s.add_dependency(%q<attr_extras>, ["~> 4.4"])
       s.add_dependency(%q<docker-api>, ["~> 1.22"])
       s.add_dependency(%q<excon>, ["~> 0.45"])
+      s.add_dependency(%q<memoist>, ["~> 0.12"])
       s.add_dependency(%q<rake>, ["~> 10.0"])
+      s.add_dependency(%q<rubocop>, ["~> 0.34"])
       s.add_dependency(%q<jeweler>, ["~> 2.0"])
       s.add_dependency(%q<pry>, ["~> 0.10"])
       s.add_dependency(%q<simplecov>, ["~> 0.9"])
       s.add_dependency(%q<simplecov-rcov>, ["~> 0.2"])
     end
   else
+    s.add_dependency(%q<attr_extras>, ["~> 4.4"])
     s.add_dependency(%q<docker-api>, ["~> 1.22"])
     s.add_dependency(%q<excon>, ["~> 0.45"])
+    s.add_dependency(%q<memoist>, ["~> 0.12"])
     s.add_dependency(%q<rake>, ["~> 10.0"])
+    s.add_dependency(%q<rubocop>, ["~> 0.34"])
     s.add_dependency(%q<jeweler>, ["~> 2.0"])
     s.add_dependency(%q<pry>, ["~> 0.10"])
     s.add_dependency(%q<simplecov>, ["~> 0.9"])

data/lib/drydock.rb

@@ -1,7 +1,9 @@
 
+require 'attr_extras/explicit'
 require 'docker'
 require 'excon'
 require 'fileutils'
+require 'memoist'
 
 require_relative 'drydock/docker_api_patch'
 
@@ -26,6 +28,8 @@ require_relative 'drydock/project'
 require_relative 'drydock/stream_monitor'
 require_relative 'drydock/tar_writer'
 
+require_relative 'drydock/instructions/copy'
+
 require_relative 'drydock/object_caches/filesystem_cache'
 require_relative 'drydock/object_caches/in_memory_cache'
 require_relative 'drydock/object_caches/no_cache'

data/lib/drydock/docker_api_patch.rb

@@ -8,17 +8,17 @@ module Docker
       log_request(request)
       resource.request(request)
     rescue Excon::Errors::BadRequest => ex
-      raise ClientError, ex.response.body
+      fail ClientError, ex.response.body
     rescue Excon::Errors::Unauthorized => ex
-      raise UnauthorizedError, ex.response.body
+      fail UnauthorizedError, ex.response.body
     rescue Excon::Errors::NotFound => ex
-      raise NotFoundError, ex.response.body
+      fail NotFoundError, ex.response.body
     rescue Excon::Errors::Conflict => ex
-      raise ConflictError, ex.response.body
+      fail ConflictError, ex.response.body
     rescue Excon::Errors::InternalServerError => ex
-      raise ServerError, ex.response.body
+      fail ServerError, ex.response.body
     rescue Excon::Errors::Timeout => ex
-      raise TimeoutError, ex.message
+      fail TimeoutError, ex.message
     end
 
   end

data/lib/drydock/drydock.rb

@@ -1,13 +1,29 @@
 
+# Drydock is a command line program that provides a DSL for you to create your
+# own build pipeline for your docker images. See {file:README.md} for more
+# information and background on the design.
 module Drydock
 
+  # The application's banner.
+  #
+  # @return [String] the banner
   def self.banner
     "Drydock v#{Drydock.version}"
   end
 
-  def self.build(opts = {}, &blk)
-    Project.new(opts).tap do |project|
-      dryfile, dryfilename = yield
+  # Create a new project, then run and finalize the build.
+  #
+  # @param (see Project#initialize)
+  # @option (see Project#initialize)
+  # @yield [project] A block that describes the logic on how to search for a
+  #   Drydockfile.
+  # @yieldparam project [Project] A newly-instantiated project object.
+  # @yieldreturn [Array<String>] An array of exactly two elements: the contents
+  #   of the Drydockfile, and the path to the Drydockfile. The directory of
+  #   the path will be made as the working directory.
+  def self.build(build_opts = {}, &blk)
+    Project.new(build_opts).tap do |project|
+      dryfile, dryfilename = yield project
 
       Dir.chdir(File.dirname(dryfilename))
       Drydock.logger.info("Working directory set to #{Dir.pwd}")
@@ -47,10 +63,6 @@ module Drydock
     @logger = logger
   end
 
-  def self.using(project)
-    raise NotImplementedError, "TODO(rpasay)"
-  end
-
   def self.version
     version_file = File.join(File.dirname(__FILE__), '..', '..', 'VERSION')
     File.exist?(version_file) ? File.read(version_file).chomp : ""

data/lib/drydock/instructions/base.rb

@@ -0,0 +1,13 @@
+
+module Drydock
+  module Instructions
+    # Base class for instruction implementation.
+    # **Do not use this class directly.**
+    #
+    # @see Project
+    class Base
+      extend AttrExtras.mixin
+      extend Memoist
+    end
+  end
+end

data/lib/drydock/instructions/copy.rb

@@ -0,0 +1,117 @@
+
+require_relative 'base'
+
+module Drydock
+  module Instructions
+    # The concrete implementation of the COPY instruction.
+    # **Do not use this class directly.**
+    #
+    # @see Project#copy
+    class Copy < Base
+
+      attr_accessor :chmod, :ignorefile, :no_cache, :recursive
+
+      attr_reader :chain, :source_path, :target_path
+      attr_initialize :chain, :source_path, :target_path do
+        @chmod      = false
+        @ignorefile = '.dockerignore'
+        @no_cache   = false
+        @recursive  = true
+      end
+
+      # @raise [InvalidInstructionError] when the `source_path` does not exist
+      # @raise [InvalidInstructionError] when the `source_path` is an empty directory
+      #   with nothing to copy
+      # @raise [InvalidInstructionError] when the `target_path` does not exist in the
+      #   container
+      # @raise [InvalidInstructionError] when the `target_path` exists in the container,
+      #   but is not actually a directory
+      def run!
+        if source_path.start_with?('/')
+          Drydock.logger.warn("#{source_path.inspect} is an absolute path; we recommend relative paths")
+        end
+
+        fail InvalidInstructionError, "#{source_path} does not exist" unless File.exist?(source_path)
+
+        buffer = build_tar_from_source!
+        digest = calculate_digest(buffer)
+        write_to_container(buffer, digest)
+      end
+
+      private
+
+      def build_tar_from_source!
+        buffer = StringIO.new
+        log_info("Processing #{source_files.size} files in tree")
+
+        TarWriter.new(buffer) do |tar|
+          source_files.each do |source_file|
+            File.open(source_file, 'r') do |input|
+              stat = input.stat
+              mode = chmod || stat.mode
+              tar.add_entry(source_file, mode: mode, mtime: stat.mtime) do |tar_file|
+                tar_file.write(input.read)
+              end
+            end
+          end
+        end
+
+        buffer.rewind
+        buffer
+      end
+
+      def calculate_digest(buffer)
+        Digest::MD5.hexdigest(buffer.read).tap do |digest|
+          log_info("Tree digest is md5:#{digest}")
+          buffer.rewind
+        end
+      end
+
+      def log_info(msg, indent: 0)
+        Drydock.logger.info(indent: indent, message: msg)
+      end
+
+      # Retrieve all files inside {#source_path} not matching the {#ignorefile} rules.
+      def source_files
+        files =
+          if File.directory?(source_path)
+            FileManager.find(source_path, ignorefile, prepend_path: true, recursive: recursive).sort
+          else
+            [source_path]
+          end
+
+        fail InvalidInstructionError, "#{source_path} is empty or does not match a path" if files.empty?
+
+        files
+      end
+      memoize :source_files
+
+      # Create a new container on the `chain`, and then write the contents of
+      # `buffer`, whose digest is `digest`.
+      def write_to_container(buffer, digest)
+        label = "# COPY #{recursive ? 'dir' : 'file'}:md5:#{digest} TO #{target_path}"
+
+        chain.run(label, no_cache: no_cache) do |container|
+          target_stat = container.archive_head(target_path)
+
+          # TODO(rpasay): cannot autocreate the target, because `container` here is already dead
+          unless target_stat
+            fail InvalidInstructionError, "Target path #{target_path.inspect} does not exist"
+          end
+
+          unless target_stat.directory?
+            Drydock.logger.debug(target_stat)
+            fail InvalidInstructionError,
+                "Target path #{target_path.inspect} exists, " +
+                "but is not a directory in the container"
+          end
+
+          container.archive_put(target_path) do |output|
+            output.write(buffer.read)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/drydock/object_caches/base.rb

@@ -4,19 +4,19 @@ module Drydock
     class Base
 
       def clear
-        raise NotImplementedError, '#clear must be overridden in the subclass'
+        fail NotImplementedError, '#clear must be overridden in the subclass'
       end
 
       def fetch(key, &blk)
-        raise NotImplementedError, '#fetch must be overridden in the subclass'
+        fail NotImplementedError, '#fetch must be overridden in the subclass'
       end
 
       def get(key, &blk)
-        raise NotImplementedError, '#get must be overridden in the subclass'
+        fail NotImplementedError, '#get must be overridden in the subclass'
       end
 
       def set(key, value = nil, &blk)
-        raise NotImplementedError, '#set must be overridden in the subclass'
+        fail NotImplementedError, '#set must be overridden in the subclass'
       end
 
     end

data/lib/drydock/phase.rb

@@ -14,7 +14,9 @@ module Drydock
     def self.from(hsh)
       h = hsh.to_h
       extra_keys = h.keys - members
-      raise ArgumentError, "unknown options: #{extra_keys.join(', ')}" unless extra_keys.empty?
+
+      fail ArgumentError, "unknown options: #{extra_keys.join(', ')}" unless extra_keys.empty?
+
       new(*h.values_at(*members))
     end
 

data/lib/drydock/phase_chain.rb

@@ -106,15 +106,15 @@ module Drydock
           results = c.wait(timeout)
 
           unless results
-            raise InvalidCommandExecutionError, {container: c.id, message: "Container did not return anything (API BUG?)"}
+            fail InvalidCommandExecutionError, {container: c.id, message: "Container did not return anything (API BUG?)"}
           end
 
           unless results.key?('StatusCode')
-            raise InvalidCommandExecutionError, {container: c.id, message: "Container did not return a status code (API BUG?)"}
+            fail InvalidCommandExecutionError, {container: c.id, message: "Container did not return a status code (API BUG?)"}
           end
 
           unless results['StatusCode'] == 0
-            raise InvalidCommandExecutionError, {container: c.id, message: "Container exited with code #{results['StatusCode']}"}
+            fail InvalidCommandExecutionError, {container: c.id, message: "Container exited with code #{results['StatusCode']}"}
           end
         rescue
           # on error, kill the streaming logs and reraise the exception

data/lib/drydock/plugins/package_manager.rb

@@ -6,23 +6,23 @@ module Drydock
     class PackageManager < Base
 
       def add(*pkgs)
-        raise NotImplementedError, '#add must be overridde in the subclass'
+        fail NotImplementedError, '#add must be overridde in the subclass'
       end
 
       def clean
-        raise NotImplementedError, '#clean must be overridde in the subclass'
+        fail NotImplementedError, '#clean must be overridde in the subclass'
       end
 
       def remove(*pkgs)
-        raise NotImplementedError, '#remove must be overridde in the subclass'
+        fail NotImplementedError, '#remove must be overridde in the subclass'
       end
 
       def update
-        raise NotImplementedError, '#update must be overridde in the subclass'
+        fail NotImplementedError, '#update must be overridde in the subclass'
       end
 
       def upgrade
-        raise NotImplementedError, '#upgrade must be overridde in the subclass'
+        fail NotImplementedError, '#upgrade must be overridde in the subclass'
       end
 
     end

data/lib/drydock/project.rb

@@ -1,5 +1,10 @@
 
 module Drydock
+  # A project defines the methods available in a `Drydockfile`. When run using
+  # the binary `drydock`, this object will be instantiated automatically for you.
+  #
+  # The contents of a `Drydockfile` is automatically evaluated in the context
+  # of a project, so you don't need to instantiate the object manually.
   class Project
 
     DEFAULT_OPTIONS = {
@@ -17,11 +22,11 @@ module Drydock
     # @option build_opts [Boolean] :auto_remove Whether intermediate images
     #   created during the build of this project should be automatically removed.
     # @option build_opts [String] :author The default author field when an
-    #   author is not provided explicitly with {#author}.
+    #   author is not provided explicitly with {Project#author}.
     # @option build_opts [ObjectCaches::Base] :cache An object cache manager.
     # @option build_opts [#call] :event_handler A handler that responds to a
     #   `#call` message with four arguments: `[event, is_new, serial_no, event_type]`
-    #   most useful to override logging or 
+    #   most useful to override logging.
     # @option build_opts [PhaseChain] :chain A phase chain manager.
     # @option build_opts [String] :ignorefile The name of the ignore-file to load.
     def initialize(build_opts = {})
@@ -52,7 +57,7 @@ module Drydock
     # @raise [InvalidInstructionArgumentError] when neither name nor email is provided
     def author(name: nil, email: nil)
       if (name.nil? || name.empty?) && (email.nil? || name.empty?)
-        raise InvalidInstructionArgumentError, 'at least one of `name:` or `email:` must be provided'
+        fail InvalidInstructionArgumentError, 'at least one of `name:` or `email:` must be provided'
       end
 
       value = email ? "#{name} <#{email}>" : name.to_s
@@ -128,73 +133,24 @@ module Drydock
     #   the mode provided (in integer octal form) will be used to override *all*
     #   file and directory modes.
     # @param [Boolean] no_cache When `false` (the default), the hash digest of the
-    #   source path—taking into account all its files, directories, and contents—is
+    #   source path--taking into account all its files, directories, and contents--is
     #   used as the cache key. When `true`, the image is rebuilt *every* time.
     # @param [Boolean] recursive When `true`, then `source_path` is expected to be
     #   a directory, at which point all its contents would be recursively searched.
     #   When `false`, then `source_path` is expected to be a file.
     #
-    # @raise [InvalidInstructionError] when the `source_path` does not exist
-    # @raise [InvalidInstructionError] when the `source_path` is an empty directory
-    #   with nothing to copy
-    # @raise [InvalidInstructionError] when the `target_path` does not exist in the
-    #   container
-    # @raise [InvalidInstructionError] when the `target_path` exists in the container,
-    #   but is not actually a directory
+    # @raise (see Instructions::Copy#run!)
     def copy(source_path, target_path, chmod: false, no_cache: false, recursive: true)
       requires_from!(:copy)
       log_step('copy', source_path, target_path, chmod: (chmod ? sprintf('%o', chmod) : false))
 
-      if source_path.start_with?('/')
-        Drydock.logger.warn("#{source_path.inspect} is an absolute path; we recommend relative paths")
-      end
-
-      raise InvalidInstructionError, "#{source_path} does not exist" unless File.exist?(source_path)
+      Instructions::Copy.new(chain, source_path, target_path).tap do |ins|
+        ins.chmod      = chmod if chmod
+        ins.ignorefile = ignorefile
+        ins.no_cache   = no_cache
+        ins.recursive  = recursive
 
-      source_files = if File.directory?(source_path)
-        FileManager.find(source_path, ignorefile, prepend_path: true, recursive: recursive)
-      else
-        [source_path]
-      end
-      source_files.sort!
-
-      raise InvalidInstructionError, "#{source_path} is empty or does not match a path" if source_files.empty?
-
-      buffer = StringIO.new
-      log_info("Processing #{source_files.size} files in tree")
-      TarWriter.new(buffer) do |tar|
-        source_files.each do |source_file|
-          File.open(source_file, 'r') do |input|
-            stat = input.stat
-            mode = chmod || stat.mode
-            tar.add_entry(source_file, mode: stat.mode, mtime: stat.mtime) do |tar_file|
-              tar_file.write(input.read)
-            end
-          end
-        end
-      end
-
-      buffer.rewind
-      digest = Digest::MD5.hexdigest(buffer.read)
-
-      log_info("Tree digest is md5:#{digest}")
-      chain.run("# COPY #{source_path} #{target_path} DIGEST #{digest}", no_cache: no_cache) do |container|
-        target_stat = container.archive_head(target_path)
-
-        # TODO(rpasay): cannot autocreate the target, because `container` here is already dead
-        unless target_stat
-          raise InvalidInstructionError, "Target path #{target_path.inspect} does not exist"
-        end
-
-        unless target_stat.directory?
-          Drydock.logger.debug(target_stat)
-          raise InvalidInstructionError, "Target path #{target_path.inspect} exists, but is not a directory in the container"
-        end
-
-        container.archive_put(target_path) do |output|
-          buffer.rewind
-          output.write(buffer.read)
-        end
+        ins.run!
       end
 
       self
@@ -225,7 +181,7 @@ module Drydock
 
       unless cache.key?(source_url)
         cache.set(source_url) do |obj|
-          chunked = Proc.new do |chunk, remaining_bytes, total_bytes|
+          chunked = proc do |chunk, _remaining_bytes, _total_bytes|
             obj.write(chunk)
           end
           Excon.get(source_url, response_block: chunked)
@@ -236,7 +192,8 @@ module Drydock
 
       # TODO(rpasay): invalidate cache when the downloaded file changes,
       # and then force rebuild
-      chain.run("# DOWNLOAD #{source_url} #{target_path}") do |container|
+      digest = Digest::MD5.hexdigest(source_url)
+      chain.run("# DOWNLOAD file:md5:#{digest} #{target_path}") do |container|
         container.archive_put do |output|
           TarWriter.new(output) do |tar|
             cache.get(source_url) do |input|
@@ -252,7 +209,7 @@ module Drydock
     end
 
     # **This instruction is *optional*, but if specified, must appear at the
-    # beginning of the file.** 
+    # beginning of the file.**
     #
     # This instruction is used to restrict the version of `drydock` required to
     # run the `Drydockfile`. When not specified, any version of `drydock` is
@@ -266,20 +223,20 @@ module Drydock
     #   drydock '~> 0.5'
     # @param [String] version The version specification to use.
     def drydock(version = '>= 0')
-      raise InvalidInstructionError, '`drydock` must be called before `from`' if chain
+      fail InvalidInstructionError, '`drydock` must be called before `from`' if chain
       log_step('drydock', version)
       
       requirement = Gem::Requirement.create(version)
       current     = Gem::Version.create(Drydock.version)
 
       unless requirement.satisfied_by?(current)
-        raise InsufficientVersionError, "build requires #{version.inspect}, but you're on #{Drydock.version.inspect}"
+        fail InsufficientVersionError, "build requires #{version.inspect}, but you're on #{Drydock.version.inspect}"
       end
 
       self
     end
 
-    # Sets the entrypoint command for an image. 
+    # Sets the entrypoint command for an image.
     #
     # {#entrypoint} corresponds to the `ENTRYPOINT` Dockerfile instruction. This
     # instruction does **not** run the command, but rather provides the default
@@ -303,7 +260,7 @@ module Drydock
 
     # Set an environment variable, which will be persisted in future images
     # (unless it is specifically overwritten) and derived projects.
-    # 
+    #
     # Subsequent commands can refer to the environment variable by preceeding
     # the variable with a `$` sign, e.g.:
     #
@@ -315,7 +272,7 @@ module Drydock
     #
     # Multiple calls to this instruction will build on top of one another.
     # That is, after the following two instructions:
-    # 
+    #
     # ```
     #   env 'APP_ROOT',   '/app'
     #   env 'BUILD_ROOT', '/build'
@@ -419,13 +376,13 @@ module Drydock
     # the project,** although non-instructions may appear before this.
     #
     # If the `drydock` instruction is provided, `from` should come after it.
-    # 
+    #
     # @param [#to_s] repo The name of the repository, which may be any valid docker
     #   repository name, and may optionally include the registry address, e.g.,
     #   `johndoe/thing` or `quay.io/jane/app`. The name *must not* contain the tag name.
     # @param [#to_s] tag The tag to use.
     def from(repo, tag = 'latest')
-      raise InvalidInstructionError, '`from` must only be called once per project' if chain
+      fail InvalidInstructionError, '`from` must only be called once per project' if chain
 
       repo = repo.to_s
       tag  = tag.to_s
@@ -506,8 +463,10 @@ module Drydock
     # when `Gemfile` changes but `package.json` does not, only the first
     # derived project will be rebuilt (and following that, the third as well).
     #
+    # @param (see #initialize)
+    # @option (see #initialize)
     def derive(opts = {}, &blk)
-      clean_opts  = build_opts.delete_if { |k, v| v.nil? }
+      clean_opts  = build_opts.delete_if { |_, v| v.nil? }
       derive_opts = clean_opts.merge(opts).merge(chain: chain)
 
       Project.new(derive_opts).tap do |project|
@@ -538,8 +497,8 @@ module Drydock
       mkdir(path)
 
       requires_from!(:import)
-      raise InvalidInstructionError, 'cannot `import` from `/`' if path == '/' && !force
-      raise InvalidInstructionError, '`import` requires a `from:` option' if from.nil?
+      fail InvalidInstructionError, 'cannot `import` from `/`' if path == '/' && !force
+      fail InvalidInstructionError, '`import` requires a `from:` option' if from.nil?
       log_step('import', path, from: from.last_image.id)
 
       total_size = 0
@@ -597,8 +556,12 @@ module Drydock
       end
     end
 
+    # **NOT SUPPORTED YET**
+    #
     # @todo on_build instructions should be deferred to the end.
-    def on_build(instruction = nil, &blk)
+    def on_build(instruction = nil, &_blk)
+      fail NotImplementedError, "on_build is not yet supported"
+
       requires_from!(:on_build)
       log_step('on_build', instruction)
       chain.run("# ON_BUILD #{instruction}", on_build: instruction)
@@ -623,7 +586,7 @@ module Drydock
     # Additional `opts` are also recognized:
     #
     # * `author`, a string, preferably in the format of "Name <email@domain.com>".
-    #   If provided, this overrides 
+    #   If provided, this overrides the author name set with {#author}.
     # * `comment`, an arbitrary string used as a comment for the resulting image
     #
     # If `run` results in a container being created and `&blk` is provided, the
@@ -645,9 +608,9 @@ module Drydock
     # Set project options.
     def set(key, value = nil, &blk)
       key = key.to_sym
-      raise ArgumentError, "unknown option #{key.inspect}" unless build_opts.key?(key)
-      raise ArgumentError, "one of value or block is required" if value.nil? && blk.nil?
-      raise ArgumentError, "only one of value or block may be provided" if value && blk
+      fail ArgumentError, "unknown option #{key.inspect}" unless build_opts.key?(key)
+      fail ArgumentError, "one of value or block is required" if value.nil? && blk.nil?
+      fail ArgumentError, "only one of value or block may be provided" if value && blk
 
       build_opts[key] = value || blk
     end
@@ -673,7 +636,7 @@ module Drydock
     #     apk.update
     #   end
     # ```
-    # 
+    #
     # In cases of single commands, the above is the same as:
     #
     # ```
@@ -681,11 +644,12 @@ module Drydock
     # ```
     def with(plugin, &blk)
       (@plugins[plugin] ||= plugin.new(self)).tap do |instance|
-        yield instance if block_given?
+        blk.call(instance) if blk
       end
     end
 
     private
+
     attr_reader :chain, :build_opts, :stream_monitor
 
     def build_cmd(cmd)
@@ -718,7 +682,7 @@ module Drydock
     end
 
     def requires_from!(instruction)
-      raise InvalidInstructionError, "`#{instruction}` cannot be called before `from`" unless chain
+      fail InvalidInstructionError, "`#{instruction}` cannot be called before `from`" unless chain
     end
 
   end

data/lib/drydock/tar_writer.rb

@@ -5,7 +5,7 @@ module Drydock
     def add_entry(name, mode: 0644, mtime: Time.now, uid: 0, gid: 0)
       check_closed
 
-      raise Gem::Package::NonSeekableIO unless @io.respond_to?(:pos=)
+      fail Gem::Package::NonSeekableIO unless @io.respond_to?(:pos=)
 
       name, prefix = split_name(name)
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: dry-dock
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Ripta Pasay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-07 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: attr_extras
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
 - !ruby/object:Gem::Dependency
   name: docker-api
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.45'
+- !ruby/object:Gem::Dependency
+  name: memoist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
@@ -124,6 +166,7 @@ files:
 - ".dockerignore"
 - ".pryrc"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
 - Dockerfile
@@ -152,6 +195,8 @@ files:
 - lib/drydock/formatters.rb
 - lib/drydock/ignorefile_definition.rb
 - lib/drydock/image_repository.rb
+- lib/drydock/instructions/base.rb
+- lib/drydock/instructions/copy.rb
 - lib/drydock/logger.rb
 - lib/drydock/object_caches/base.rb
 - lib/drydock/object_caches/filesystem_cache.rb