docker-template 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a041995698dcbe6253e4c997a940e1e7eb492e4b
-  data.tar.gz: 39b3a79d100a7ddb4f75d7352b1dac9db157ee94
+  metadata.gz: b98454a6b84d7f5e7b2e63e11270b21b92576e41
+  data.tar.gz: 02fd327a52266fdba7d9f8e69b5eb26ab982ac24
 SHA512:
-  metadata.gz: 1e2949a9cd7ce54000508599cd1c31b07dbdbf654596b3d6984977f2bfa75cc7932bb1a6cd097af97f77122fd5434f150f00b10011cf689edb35455013fd69e8
-  data.tar.gz: e2997be78cc2d37d48cd7ef3184b6481992fcc6befc0d595835d396d7935230e852a76128b933f55aeaa618b1fa31fbf5e16b3416fecd01d325cfbe0ec38e888
+  metadata.gz: f4d9b67269a7e314c2f3ffb39b5af079289489af980b9006eeebd4289071eb0ff533ed26ce98d7c773e5e402987ebfd2a53632edb91c9931a1ede2abc4b5190b
+  data.tar.gz: 27559d9dcaf2a2bdf488b506f4991f6d9273cd428237f293551b57115299724f6885778d92ea8093700ab2de5d37746dea640f60d3b801f3b2a4b6cad4e559ee

data/Gemfile

@@ -1,13 +1,39 @@
+# ----------------------------------------------------------------------------
 # Frozen-string-literal: true
-# Copyright: 2015 Jordon Bedwell - Apache v2.0 License
+# Copyright: 2015 - 2016 Jordon Bedwell - Apache v2.0 License
 # Encoding: utf-8
+# ----------------------------------------------------------------------------
 
 source "https://rubygems.org"
 gem "rake", :require => false
 gemspec
 
-group :development do
-  gem "guard-rspec", :require => false
+group :test do
+  gem "rspec", :require => false
+  gem "memory_profiler", :require => false
+  gem "luna-rspec-formatters", :require => false
+  gem "codeclimate-test-reporter", :require => false
+  gem "rubocop", :github => "bbatsov/rubocop", :branch => :master, :require => false
+  gem "luna-rubocop-formatters", :require => false
   gem "benchmark-ips", :require => false
-  gem "pry", :require => false
+  gem "rspec-helpers", :require => false
+  gem "cucumber", :require => false
+end
+
+group :development do
+  unless ENV["CI"]
+    gem "pry", :require => false
+    gem "msgpack", {
+      :require => false
+    }
+  end
+end
+
+group :travis, :optional => true do
+  gem "travis"
+end
+
+group :site, :optional => true do
+  gem "jekyll-assets", :github => "jekyll/jekyll-assets"
+  gem "jekyll", :github => "jekyll/jekyll"
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2015 Jordon Bedwell
+Copyright 2015 - 2016 Jordon Bedwell
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -1,20 +1,85 @@
-[![Build Status](https://travis-ci.org/envygeeks/docker-template.svg?branch=master)][travis]
-[![Coverage Status](https://coveralls.io/repos/envygeeks/docker-template/badge.svg?branch=master&service=github)][coveralls]
-[![Code Climate](https://codeclimate.com/github/envygeeks/docker-template/badges/gpa.svg)][codeclimate]
+# Docker Template
+
+[![Build](https://travis-ci.org/envygeeks/docker-template.svg?branch=master)][travis]
+[![Test](https://codeclimate.com/github/envygeeks/docker-template/badges/coverage.svg)][coverage]
+[![Code](https://codeclimate.com/github/envygeeks/docker-template/badges/gpa.svg)][codeclimate]
+[![Dependency](https://gemnasium.com/envygeeks/docker-template.svg)][gemnasium]
 
+[gemnasium]: https://gemnasium.com/envygeeks/docker-template
 [codeclimate]: https://codeclimate.com/github/envygeeks/docker-template
-[coveralls]: https://coveralls.io/github/envygeeks/docker-template?branch=master
+[coverage]: https://codeclimate.com/github/envygeeks/docker-template/coverage
 [travis]: https://travis-ci.org/envygeeks/docker-template
 
-# Docker Template
+Docker Template is an organization and templating system for Docker images. A way to make your life easier and more organized by having repositories within repositories that share data among multiple sets of images.  It is currently used to build all the images for Jekyll and EnvyGeeks.  To see the full docs instead of synapsis and snippets please visit https://github.com/envygeeks/docker-template/tree/master/docs
+
+<!-- TOC depthFrom:1 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->
+
+- [Docker Template](#docker-template)
+	- [Installation](#installation)
+	- [[Organization](https://github.com/envygeeks/docker-template/tree/master/docs/organization.md)](#organizationhttpsgithubcomenvygeeksdocker-templatetreemasterdocsorganizationmd)
+	- [[Metadata](https://github.com/envygeeks/docker-template/tree/master/docs/metadata.md)](#metadatahttpsgithubcomenvygeeksdocker-templatetreemasterdocsmetadatamd)
+	- [[Normal](https://github.com/envygeeks/docker-template/tree/master/docs/templates/normal.md)](#normalhttpsgithubcomenvygeeksdocker-templatetreemasterdocstemplatesnormalmd)
+	- [[Scratch](https://github.com/envygeeks/docker-template/tree/master/docs/templates/scratch.md)](#scratchhttpsgithubcomenvygeeksdocker-templatetreemasterdocstemplatesscratchmd)
+	- [[Copy/](https://github.com/envygeeks/docker-template/tree/master/docs/copy.md)](#copyhttpsgithubcomenvygeeksdocker-templatetreemasterdocscopymd)
+	- [Commands](#commands)
+		- [Build](#build)
+		- [List](#list)
+
+<!-- /TOC -->
+
+## Installation
+
+```bash
+sudo gem install docker-template  
+```
+
+From Gemfile
+
+```ruby
+gem "docker-template", {
+  :github => "envygeeks/docker-template"
+}
+```
+
+<!--
+## [Organization](https://github.com/envygeeks/docker-template/tree/master/docs/organization.md)
+## [Metadata](https://github.com/envygeeks/docker-template/tree/master/docs/metadata.md)
+## [Normal](https://github.com/envygeeks/docker-template/tree/master/docs/templates/normal.md)
+## [Scratch](https://github.com/envygeeks/docker-template/tree/master/docs/templates/scratch.md)
+## [Copy/](https://github.com/envygeeks/docker-template/tree/master/docs/copy.md)
+-->
+
+## Commands
+
+### Build
+
+You can build a template by sending either `image`, `user/image`, `image:tag` or `user/image:tag`: `docker-template build image`.  Build supports the following arguments:
+
+```
+Usage:
+  docker-template build [REPOS [OPTS]]
+
+Options:
+  [--cache-only], [--no-cache-only]  # Only cache your repositories, don't build.
+  [--clean-only], [--no-clean-only]  # Only clean your repositories, don't build.
+  [--push-only], [--no-push-only]    # Only push  your repositories, don't build.
+  [--profile], [--no-profile]        # Profile Memory.
+  [--tty], [--no-tty]                # Enable TTY Output.
+  [--push], [--no-push]              # Push Repo After Building.
+  [--cache], [--no-cache]            # Cache your repositories to cache.
+  [--mocking], [--no-mocking]        # Disable Certain Actions.
+  [--clean], [--no-clean]            # Cleanup your caches.
+
+Build all (or some) of your repositories
+```
+
+***You can send as many repos/images as you like, or you can send none, the lack of any repos/images will result in all of the possible images being built from your repos/ folder.  This is good for automated building. NOTE: When building images we sort them, in that scratch images are built first, normal images are built second and aliases are done last, so that if you have dependencies within your dependencies hopefully they will get built first, however this is not always likely if your images rely on another normal image.  In that case you might want to send a manual list for us.***
+
+### List
 
-Docker template is a way to organize your Docker repos into multiple types with
-multiple templates for multiple tags but those templates aren't actually templates,
-they are JSON or YAML files and copy folders with tons of shared or split data.
-The idea is that you can have many tags for a single repo and that each tag
-can have many different things going on.
+You can get a list of the possible images that can be built, an example:
 
-Docker template makes it so that you can facilitate and organize those things in
-a clean way and just get work done.  It also makes building "scratch" images 100%
-easier for anybody by doing most of the work for you and just asking that you
-build the file system script that pumps out a tar.gz file.
+```
+envygeeks/alpine:3.3
+envygeeks/alpine:latest -> envygeeks/alpine:3.3
+```

data/Rakefile

@@ -1,57 +1,134 @@
+# ----------------------------------------------------------------------------
 # Frozen-string-literal: true
-# Copyright: 2015 Jordon Bedwell - Apache v2.0 License
+# Copyright: 2015 - 2016 Jordon Bedwell - Apache v2.0 License
 # Encoding: utf-8
+# ----------------------------------------------------------------------------
 
-$LOAD_PATH.unshift(File.expand_path("../lib", __FILE__))
-require "docker/template/ansi"
+$LOAD_PATH.unshift(File.expand_path(
+  "../lib", __FILE__
+))
+
+# ----------------------------------------------------------------------------
+
+require "simple/ansi"
 require "rspec/core/rake_task"
+require "luna/rubocop/rake/task"
 require "open3"
 
+# ----------------------------------------------------------------------------
+
 task :default => [:spec]
 RSpec::Core::RakeTask.new :spec
 task :test => :spec
 
-task :build do
-  exec "bundle", "exec", "bin/docker-template", *ARGV[
-    1..-1
-  ]
-end
+# ----------------------------------------------------------------------------
 
-task :pry do
-  sh "bundle", "exec", "pry", "-Ilib/", \
-    "-rdocker/template"
-end
+module CompList
+  module_function
+
+  # --------------------------------------------------------------------------
+  # Update the pak file to have all the completions.
+  # --------------------------------------------------------------------------
+
+  def update(data = get_commands, msgp = data.to_msgpack)
+    pak_file.binwrite(
+      msgp
+    )
+  end
 
-task :analysis do
-  ansi = Docker::Template::Ansi
-  cmd = [
-    "docker", "run", "--rm", "--env=CODE_PATH=#{Dir.pwd}", \
-    "--volume=#{Dir.pwd}:/code", "--volume=/var/run/docker.sock:/var/run/docker.sock", \
-    "--volume=/tmp/cc:/tmp/cc", "-i", "codeclimate/codeclimate", "analyze"
-  ]
-
-  file = File.open(".analysis", "w+")
-  Open3.popen3(cmd.shelljoin) do |_, out, err, _|
-    while data = out.gets
-      file.write data
-      if data =~ /\A==/
-        $stdout.print ansi.yellow(data)
-
-      elsif data !~ %r!\A[0-9\-]+!
-        $stdout.puts data
-
-      else
-        h, d = data.split(":", 2)
-        $stdout.print ansi.cyan(h)
-        $stdout.print ":", d
+  # --------------------------------------------------------------------------
+
+  def normalize_command(command)
+    if command.is_a?(Array)
+      then command.map do |key|
+        key.gsub(
+          /_/, "-"
+        )
       end
+    else
+      command.gsub(
+        /_/, "-"
+      )
     end
+  end
+
+  # --------------------------------------------------------------------------
+  # Provides the base "_reply" for your auto-complete data output.
+  # --------------------------------------------------------------------------
+
+  def base(const, skip = %w(help))
+    keys = const.all_commands.keys
+    return "_reply" => normalize_command(keys), "help" => {
+      "_reply" => normalize_command(keys) - skip
+    }
+  end
+
+  # --------------------------------------------------------------------------
+
+  def add_opts(out, const)
+    const.all_commands.each do |key, val, command = normalize_command(key)|
+      val.options.map do |_, opt|
+        out[command] ||= { "_reply" => [] }
+        ary = out[command][
+          "_reply"
+        ]
+
+        if !opt.boolean?
+          ary << "#{
+            opt.switch_name
+          }="
 
-    while data = err.gets
-      file.write data
-      $stderr.print ansi.red(data)
+        else
+          ary << opt.switch_name
+          ary << "--no-#{opt.switch_name.gsub(
+            /\A--/, ""
+          )}"
+        end
+
+        ary |= \
+        opt.aliases
+      end
     end
+
+    out
   end
 
-  file.close
+  # --------------------------------------------------------------------------
+  # Recursively pulls out and set's up your commands and opts.
+  # --------------------------------------------------------------------------
+
+  def get_commands(const = Docker::Template::CLI)
+    out = base(
+      const
+    )
+
+    const.subcommands.each do |key, command = normalize_command(key)|
+      const_list = const.to_namespace.push(command.to_namespace)
+      out[command] = send(__method__, Thor::Namespace.resolv(
+        const_list
+      ))
+    end
+
+    add_opts(
+      out, const
+    )
+  end
+
+  # --------------------------------------------------------------------------
+
+  def pak_file
+    Pathutil.new("bin/comp-list.pak").expand_path.tap(
+      &:touch
+    )
+  end
+end
+
+# ----------------------------------------------------------------------------
+
+namespace :update do
+  task "comp-list" do
+    require "msgpack"
+    require "docker/template"
+    CompList.update
+  end
 end

data/bin/docker-template

@@ -1,22 +1,36 @@
 #!/usr/bin/env ruby
+# ----------------------------------------------------------------------------
 # Frozen-string-literal: true
-# Copyright: 2015 Jordon Bedwell - Apache v2.0 License
+# Copyright: 2015 - 2016 Jordon Bedwell - Apache v2.0 License
 # Encoding: utf-8
+# ----------------------------------------------------------------------------
 
-$LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
+$LOAD_PATH.unshift(File.expand_path(
+  "../lib", __dir__
+))
+
+# ----------------------------------------------------------------------------
 
 trap :SIGINT do
-  $stderr.puts "\nApparently that's all for now."
-  $stderr.puts "Bye bye and good luck."
+  $stderr.puts Simple::Ansi.red(
+    "\nBye"
+  )
+
   exit
 end
 
-require "pathname"
-begin require "docker/template"
-rescue LoadError
-  require "bundler/setup"
+# ----------------------------------------------------------------------------
+
+begin
   require "docker/template"
+rescue LoadError
+  %w(bundler/setup docker/template).each do |k|
+    require k
+  end
 end
 
-Docker::Template::Interface \
-  .start($PROGRAM_NAME)
+# ----------------------------------------------------------------------------
+# Time to play the game.
+# ----------------------------------------------------------------------------
+
+Docker::Template::CLI.start

data/comp/bin

@@ -0,0 +1,9 @@
+#!/bin/bash
+_docker_template() {
+  comp=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/list
+  COMPREPLY=($(compgen -W "$($comp ${COMP_WORDS[@]})" -- \
+    ${COMP_WORDS[COMP_CWORD]}))
+}
+
+complete -F _docker_template \
+  docker-template

data/comp/list

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+# ----------------------------------------------------------------------------
+# Frozen-string-literal: true
+# Copyright: 2016 Jordon Bedwell - MIT License
+# Encoding: utf-8
+# ----------------------------------------------------------------------------
+# rubocop:disable Style/ElseAlignment
+# ----------------------------------------------------------------------------
+
+
+ARGV.shift
+require "pathutil"
+require "msgpack"
+
+# ----------------------------------------------------------------------------
+
+list = MessagePack.unpack(
+  Pathutil.new(__dir__).expand_path.join("list.pak").read
+)
+
+# ----------------------------------------------------------------------------
+
+if ARGV.first == "build"
+  dir = Pathutil.new("repos").expand_path
+
+  if dir.directory?
+    list["build"] ||= { "_reply" => [] }
+    list["build"]["_reply"].push(*dir.children.map(
+      &:basename
+    ))
+  end
+end
+
+# ----------------------------------------------------------------------------
+
+def key?(obj, key)
+  obj["_reply"].include?(
+    key
+  )
+end
+
+# ----------------------------------------------------------------------------
+
+def contains?(obj, key)
+  result = obj["_reply"].grep(/#{Regexp.escape(
+    key
+  )}/)
+
+  !result.empty?
+end
+
+# ----------------------------------------------------------------------------
+
+def opt?(key)
+  key =~ /\A-{1,2}/
+end
+
+# ----------------------------------------------------------------------------
+
+if ARGV.empty?
+  $stdout.puts list["_reply"].join(
+    " "
+  )
+else
+  none = false
+  rtrn = list
+
+  ARGV.each_with_index do |key, index|
+    if rtrn.key?(key) then rtrn = rtrn[key]
+      elsif key?(rtrn, key) && !opt?(key) then none = true
+      elsif index + 1 == ARGV.size && contains?(rtrn, key) then next
+      elsif key?(rtrn, key) && opt?(key) then next
+      else none = true
+    end
+  end
+
+  unless none
+    rtrn = rtrn["_reply"]
+    $stdout.puts rtrn.join(
+      " "
+    )
+  end
+end