rumrunner 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21ff1aee760e860283bf640e87bbdd97f5e6995caa5cdce7187c829e29417a67
-  data.tar.gz: f2acce2d5a033fce78a9010395063a8f44c8a45348de6eb08728aea43d873720
+  metadata.gz: 1167b81015a97308cc3d5e9be344d455ffbc0d9d8966a9c392a2385d91930293
+  data.tar.gz: a4cc455763338c7f4a45ab80291f9f496c9deb44e76af5998a43d3272a0b1200
 SHA512:
-  metadata.gz: 3b04b16707b81b88364e880fd3ba15dab605853735eaa67b537a1f9f293824a341befbceea5634ef1d8b6bbcdcf9bd63be841c0dfb768af97a8d662ad0870456
-  data.tar.gz: c9116ff64a6b9f4d77e724f49ec903f3c917a81acaab9b7905d4a96c0623aae6c77a3c9503dcb7aae4597c65458ee269dbf755ff629d4208d3df9ba7a4cfaa3d
+  metadata.gz: 4488ca01b9c39cea03ceb77db44997acc91554262813cd96c9edc952165ddf3b32a91cc8fd9fee526edc81c94b5919c6e3213707d55fc3667a20e17d2a2cc23e
+  data.tar.gz: 1984f5ccd2768f7df0d75e18ac39d374b687920e2a434362c2ef32e2bbdb198ef68e4fbc0fb54acb264588ad7ca3e123b6039bb5b2eb5f943864bc180f7347fd

data/README.md

@@ -1,8 +1,9 @@
-
-![Rum Runner](https://github.com/amancevice/rumrunner/blob/master/rumrunner.png?raw=true)
+[![Rum Runner](https://github.com/amancevice/rumrunner/blob/master/rumrunner.png?raw=true)](https://github.com/amancevice/rumrunner)
 [![Build Status](https://travis-ci.com/amancevice/rumrunner.svg?branch=master)](https://travis-ci.com/amancevice/rumrunner)
-[![codecov](https://codecov.io/gh/amancevice/rumrunner/branch/master/graph/badge.svg)](https://codecov.io/gh/amancevice/rumrunner)
 [![Gem Version](https://badge.fury.io/rb/rumrunner.svg)](https://badge.fury.io/rb/rumrunner)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/4b56853acc5cbb254125/test_coverage)](https://codeclimate.com/github/amancevice/rumrunner/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/4b56853acc5cbb254125/maintainability)](https://codeclimate.com/github/amancevice/rumrunner/maintainability)
+
 
 Rum Runner is a Rake-based utility for building multi-stage Dockerfiles.
 
@@ -36,16 +37,8 @@ gem install rumrunner
 Use the `Rum.init` helper to create a template Rumfile for your project:
 
 ```bash
-# Install the gem
 gem install rumrunner
-
-# Navigate to the location of your Dockerfile
-cd /path/to/your/Dockerfile/project/
-
-# Create a basic Rumfile
 ruby -r rumrunner -e Rum.init > Rumfile
-
-# View available tasks
 rum --tasks
 ```
 
@@ -145,8 +138,8 @@ rum :image_name do
     cmd   %w{echo hello}
   end
 
-  # rake fizz => docker build --tag image_name .
-  # rake buzz => docker run --rm image_name echo hello
+  # rum fizz => docker build --tag image_name .
+  # rum buzz => docker run --rm image_name echo hello
 end
 ```
 

data/lib/rumrunner/docker.rb

@@ -133,8 +133,7 @@ module Rum
       #
       def each
         @data.each do |name, values|
-          option = name.length == 1 ? "-#{name}" : "--#{name.to_s.gsub(/_/, "-")}"
-          yield option if values.empty?
+          option = flagify name
           values.each do |value|
             if value.is_a?(Hash)
               value.map{|kv| kv.join("=") }.each do |val|
@@ -163,6 +162,14 @@ module Rum
       def to_s
         to_a.join(" ")
       end
+
+      private
+
+      ##
+      # Convert +OPTION+ to +--option+
+      def flagify(name)
+        name.length == 1 ? "-#{name}" : "--#{name.to_s.gsub(/_/, "-")}"
+      end
     end
 
     ##
@@ -249,7 +256,7 @@ module Rum
       ##
       # Get the image reference without the @tag component.
       def family
-        File.join *[@registry, @username, @name].compact.map(&:to_s)
+        File.join(*[@registry, @username, @name].compact.map(&:to_s))
       end
 
       ##
@@ -272,25 +279,22 @@ module Rum
         #   Image.parse("registry:5000/username/image:tag")
         #
         def parse(string_or_symbol)
-          string = string_or_symbol.to_s
-          if string.count("/").zero? && string.count(":").zero?
-            # image
-            new name: string
-          elsif string.count("/").zero?
-            # image:tag
+          string      = string_or_symbol.to_s
+          slash_count = string.count("/")
+
+          # image[:tag]
+          if slash_count.zero?
             name, tag = string.split(/:/)
             new name: name, tag: tag
-          elsif string.count("/") == 1 && string.count(":").zero?
-            # username/image
-            username, name = string.split(/\//)
-            new name: name, username: username
-          elsif string.count("/") == 1
-            # username/image:tag
+
+          # username/image[:tag]
+          elsif slash_count == 1
             username, name_tag = string.split(/\//)
             name, tag          = name_tag.split(/:/)
             new name: name, username: username, tag: tag
+
+          # registry/username/image[:tag]
           else
-            # registry/username/image[:tag]
             registry, username, name_tag = string.split(/\//)
             name, tag                    = name_tag.split(/:/)
             new name: name, registry: registry, username: username, tag: tag

data/lib/rumrunner/init.rb

@@ -10,29 +10,37 @@ module Rum
     #   $ ruby -r rumrunner -e Rum.init > Rumfile
     #
     def init(input = nil, stdin = $stdin, stdout = $stdout, stderr = $stderr)
-      # Get image name from stdin
-      stderr.write "Docker image name [#{default = File.split(Dir.pwd).last}]: "
-      input ||= stdin.gets.chomp
-      image   = Docker::Image.parse(input.empty? ? default : input)
+      # Get image name from $stdin
+      image = gets_image input, stdin, stderr
 
       # Begin Rumfile
       stdout.write "#!/usr/bin/env ruby\n"
       stdout.write "rum :\"#{image.family}\" do\n"
+      stdout.write parse_stages "Dockerfile" if File.exist? "Dockerfile"
+      stdout.write "end\n"
+    end
 
-      # Put stages
-      if File.exists? "Dockerfile"
-        stages = File.read("Dockerfile").scan(/^FROM .*? AS (.*?)$/).flatten
-        stages.reverse.zip(stages.reverse[1..-1]).reverse.each do |stage, dep|
-          if dep.nil?
-            stdout.write "  stage :\"#{stage}\"\n"
-          else
-            stdout.write "  stage :\"#{stage}\" => :\"#{dep}\"\n"
-          end
-        end unless stages.empty?
+    private
+
+    ##
+    # Get Docker image from input (taken from <tt>$stdin</tt> if nil)
+    def gets_image(input = nil, stdin = $stdin, stderr = $stderr)
+      if input.nil?
+        default = File.split(Dir.pwd).last
+        stderr.write "Docker image name [#{default}]: "
+        input = stdin.gets.chomp
       end
+      Docker::Image.parse(input.empty? ? default : input)
+    end
 
-      # Fin
-      stdout.write "end\n"
+    ##
+    # Parse stages from Dockerfile
+    def parse_stages(dockerfile)
+      stages = File.read(dockerfile).scan(/^FROM .*? AS (.*?)$/).flatten
+      deps   = [nil] + stages[0..-2]
+      lines  = stages.zip(deps).map do |stage, dep|
+        dep.nil? ? %{  stage :"#{stage}"\n} : %{  stage :"#{stage}" => :"#{dep}"\n}
+      end.join
     end
   end
 end

data/lib/rumrunner/manifest.rb

@@ -96,44 +96,16 @@ module Rum
       end
 
       # Build stage and save digest in iidfile
-      file iidfile => iiddeps do
-        build = Docker::Build.new(options: build_options, &block)
-        build.with_defaults(iidfile: iidfile, tag: image, target: name)
-        sh build.to_s
-      end
+      stage_file iidfile, iiddeps, tag: image, target: name, &block
 
       # Shortcut to build stage by name
-      desc "Build `#{name}` stage"
-      task name => iidfile
+      stage_task name, iidfile
 
       # Shell into stage
-      desc "Shell into `#{name}` stage"
-      task :"#{name}:shell", [:shell] => iidfile do |t,args|
-        digest = File.read(iidfile)
-        shell  = args.any? ? args.to_a.join(" ") : "/bin/sh"
-        run    = Docker::Run.new(options: run_options)
-          .entrypoint(shell)
-          .interactive(true)
-          .rm(true)
-          .tty(true)
-          .image(digest)
-        sh run.to_s
-      end
+      stage_shell name, iidfile
 
       # Clean stage
-      desc "Remove any temporary images and products from `#{name}` stage"
-      task :"#{name}:clean" do
-        if File.exists? iidfile
-          sh "docker", "image", "rm", "--force", File.read(iidfile)
-          rm iidfile
-        end
-      end
-
-      # Add stage to general clean
-      task :clean => :"#{name}:clean"
-
-      # Ensure subsequent stages are cleaned before this one
-      deps.each{|dep| task :"#{dep}:clean" => :"#{name}:clean" }
+      stage_clean name, iidfile, deps
     end
 
     ##
@@ -158,19 +130,9 @@ module Rum
         deps << path
       end
 
-      desc "Build `#{name}`"
-      file name => deps do
-        digest = File.read(iidfile)
-        run = Docker::Run.new(options: run_options, image: digest, cmd: ["cat", name], &block)
-        run.with_defaults(rm: true)
-        sh "#{run} > #{name}"
-      end
+      artifact_file name, deps, iidfile, &block
 
-      desc "Remove any generated files"
-      task :clobber do
-        rm name if File.exists?(name)
-        rm_r path if Dir.exists?(path) && path != "."
-      end
+      artifact_clobber name, path
     end
 
     ##
@@ -230,8 +192,96 @@ module Rum
           sh "docker", "image", "rm", "--force", File.read(name) if File.file?(name)
           rm_r name
         end
-        rm_r root if Dir.exists?(root)
+        rm_r root if Dir.exist?(root)
+      end
+    end
+
+    ##
+    # Install file task for stage and save digest in iidfile
+    def stage_file(iidfile, iiddeps, tag:, target:, &block)
+      file iidfile => iiddeps do
+        build = Docker::Build.new(options: build_options, &block)
+        build.with_defaults(iidfile: iidfile, tag: tag, target: target)
+        sh build.to_s
+      end
+    end
+
+    ##
+    # Install alias task for building stage
+    def stage_task(name, iidfile)
+      desc "Build `#{name}` stage"
+      task name => iidfile
+    end
+
+    ##
+    # Install shell task for shelling into stage
+    def stage_shell(name, iidfile)
+      desc "Shell into `#{name}` stage"
+      task task_name(shell: name), [:shell] => iidfile do |t,args|
+        digest = File.read(iidfile)
+        shell  = args.any? ? args.to_a.join(" ") : "/bin/sh"
+        run    = Docker::Run.new(options: run_options)
+          .entrypoint(shell)
+          .interactive(true)
+          .rm(true)
+          .tty(true)
+          .image(digest)
+        sh run.to_s
+      end
+    end
+
+    ##
+    # Install clean tasks for cleaning up stage image and iidfile
+    def stage_clean(name, iidfile, deps)
+      # Clean stage image
+      desc "Remove any temporary images and products from `#{name}` stage"
+      task task_name(clean: name) do
+        if File.exist? iidfile
+          sh "docker", "image", "rm", "--force", File.read(iidfile)
+          rm iidfile
+        end
       end
+
+      # Add stage to general clean
+      task :clean => task_name(clean: name)
+
+      # Ensure subsequent stages are cleaned before this one
+      deps.each{|dep| task task_name(clean: dep) => task_name(clean: name) }
+    end
+
+    ##
+    # Install file task for artifact
+    def artifact_file(name, deps, iidfile, &block)
+      desc "Build `#{name}`"
+      file name => deps do
+        digest = File.read(iidfile)
+        run = Docker::Run.new(options: run_options, image: digest, cmd: ["cat", name], &block)
+        run.with_defaults(rm: true)
+        sh "#{run} > #{name}"
+      end
+    end
+
+    ##
+    # Install clobber tasks for cleaning up generated files
+    def artifact_clobber(name, path)
+      desc "Remove any generated files"
+      task :clobber do
+        rm name if File.exist?(name)
+        rm_r path if Dir.exist?(path) && path != "."
+      end
+    end
+
+    ##
+    # Get name of support task
+    def task_name(verb_stage)
+      case ENV["RUM_TASK_NAME"]&.upcase
+      when "STAGE_FIRST"
+        verb_stage.first.reverse
+      when "VERB_FIRST"
+        verb_stage.first
+      else
+        verb_stage.first.reverse
+      end.join(":").to_sym
     end
   end
 end

data/lib/rumrunner/version.rb

@@ -1,5 +1,5 @@
 module Rum
   ##
   # Rum Runner gem version.
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rumrunner
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Alexander Mancevice
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-24 00:00:00.000000000 Z
+date: 2019-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake