docker-compose 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39373275b82cf434210606a3f6f11d69677db295
-  data.tar.gz: b504d7029a2a6150eb5a4e5994d87bf48fa1a03d
+  metadata.gz: 03253ecae7a727eaba835a5042ec07bd4af06aee
+  data.tar.gz: f82b24d7ade2a1621eab41bb8dc8da1188b7afef
 SHA512:
-  metadata.gz: 652113dd63815d7e8261b02e5029d81fc49e6fb0edfd65ffd1f70aa03c3a3f068be1b4d8b361cbb048f7ffff2dd1018ce98ce20d5c82ce15b69df3dd65873f3c
-  data.tar.gz: 734de8b8783c44a666e6485b5bce36d5d81a9158d421f2721f27a165ed5fb6d7cf53de0027b1223960a2b7dc475a91fe2b1c9d7ae5d3defa4b4d258474d51df9
+  metadata.gz: 49ae1c849beb8c5b9623faea4fd73057be4660979f1ea570e4ce013deb4d4e6807498090ae741859a530036ce420b068a587153514aa7b77b9c41072e7d72f59
+  data.tar.gz: 3350c7abbd3ae4fcefba35661b82abc314de369f8b7105b0430c10fd7b7031efc9e10e550d47da23898250fc00d76c9bb715d224fe8ebcf0cfbace0623f00d54

data/docker-compose.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "backticks", "~> 0.1"
+
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"

data/lib/docker/compose.rb

@@ -1,6 +1,5 @@
 require_relative 'compose/version'
 require_relative 'compose/error'
-require_relative 'compose/shell'
 require_relative 'compose/session'
 require_relative 'compose/net_info'
 require_relative 'compose/mapper'

data/lib/docker/compose/rake_tasks.rb

@@ -53,7 +53,7 @@ module Docker::Compose
       self.extra_server_env = {}
       yield self if block_given?
 
-      @shell = Docker::Compose::Shell.new
+      @shell = Backticks::Runner.new
       @session = Docker::Compose::Session.new(@shell, dir:dir, file:file)
       @net_info = Docker::Compose::NetInfo.new
 

data/lib/docker/compose/session.rb

@@ -1,3 +1,5 @@
+require 'backticks'
+
 module Docker::Compose
   # A Ruby OOP interface to a docker-compose session. A session is bound to
   # a particular directory and docker-compose file (which are set at initialize
@@ -13,7 +15,7 @@ module Docker::Compose
   class Session
     attr_reader :dir, :file
 
-    def initialize(shell=Docker::Compose::Shell.new,
+    def initialize(shell=Backticks::Runner.new,
                    dir:Dir.pwd, file:'docker-compose.yml')
       @shell = shell
       @dir = dir
@@ -89,20 +91,20 @@ module Docker::Compose
     #
     # @see Docker::Compose::Shell#command
     #
-    # @param [Array] cmd subcommand words and options in the format accepted by
-    #   Shell#command
+    # @param [Array] args command-line arguments in the format accepted by
+    #   Backticks::Runner#command
     # @return [String] output of the command
     # @raise [RuntimeError] if command fails
-    def run!(*cmd)
+    def run!(*args)
       project_opts = {
         file: @file
       }
 
       Dir.chdir(@dir) do
-        result, output, error =
-          @shell.command('docker-compose', project_opts, *cmd)
-        (result == 0) || raise(Error.new(cmd.first, result, error))
-        output
+        cmd = @shell.command('docker-compose', project_opts, *args).join
+        status, out, err= cmd.status, cmd.captured_output, cmd.captured_error
+        status.success? || raise(Error.new(args.first, status, err))
+        out
       end
     end
   end

data/lib/docker/compose/version.rb

@@ -1,5 +1,5 @@
 module Docker
   module Compose
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docker-compose
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Tony Spataro
@@ -10,6 +10,20 @@ bindir: exe
 cert_chain: []
 date: 2015-12-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: backticks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -78,7 +92,6 @@ files:
 - lib/docker/compose/net_info.rb
 - lib/docker/compose/rake_tasks.rb
 - lib/docker/compose/session.rb
-- lib/docker/compose/shell.rb
 - lib/docker/compose/version.rb
 homepage: https://github.com/xeger/docker-compose
 licenses:

data/lib/docker/compose/shell.rb

@@ -1,210 +0,0 @@
-require 'open3'
-require 'pty'
-
-module Docker::Compose
-  # An easy-to-use interface for invoking commands and capturing their output.
-  # Instances of Shell can be interactive, which prints the command's output
-  # to the terminal and also allows the user to interact with the command.
-  class Shell
-    # If true, commands run in the shell will have their stdio streams tied
-    # to the parent process so the user can view their output and send input
-    # to them. Commands' stdout is still captured normally when they are
-    # interactive.
-    #
-    # Note that interactivity doesn't work very well because we use popen,
-    # which uses pipes to communicate with the child process and pipes have
-    # a fixed buffer size; the displayed output tends to "lag" behind the
-    # actual program, and bytes sent to stdin may not arrive until you send
-    # a lot of them!
-    #
-    # @return [Boolean]
-    attr_accessor :interactive
-
-    # Convert Ruby keyword arguments into CLI parameters that are compatible
-    # with the syntax of golang's flags package.
-    #
-    # Options are translated to CLI parameters using the following convention:
-    # 1) Snake-case symbols are hyphenated, e.g. :no_foo => "--no-foo"
-    # 2) boolean values indicate a CLI flag; true includes the flag, false or nil omits it
-    # 3) other values indicate a CLI option that has a value.
-    # 4) single character values are passed as short options e.g. "-X V"
-    # 5) multi-character values are passed as long options e.g. "--XXX=V"
-    #
-    def self.options(**opts)
-      flags = []
-
-      # Transform opts into golang flags-style command line parameters;
-      # append them to the command.
-      opts.each do |kw, arg|
-        if kw.length == 1
-          if arg == true
-            # true: boolean flag
-            flags << "-#{kw}"
-          elsif arg
-            # truthey: option that has a value
-            flags << "-#{kw}" << arg.to_s
-          else
-            # falsey: omit boolean flag
-          end
-        else
-          kw = kw.to_s.gsub('_','-')
-          if arg == true
-            # true: boolean flag
-            flags << "--#{kw}"
-          elsif arg
-            # truthey: option that has a value
-            flags << "--#{kw}=#{arg}"
-          else
-            # falsey: omit boolean flag
-          end
-        end
-      end
-
-      flags
-    end
-
-    # Create an instance of Shell.
-    def initialize
-      @interactive = false
-    end
-
-    # Run a shell command whose arguments and flags are expressed using some
-    # Rubyish sugar. This method accepts an arbitrary number of positional
-    # parameters; each parameter can be a Hash, an array, or a simple Object.
-    # Arrays and simple objects are appended to argv as "bare" words; Hashes
-    # are translated to golang flags and then appended to argv.
-    #
-    # @return [Array] an (Integer,String,String) triple of exitstatus, stdout and stderr
-    #
-    # @example Run docker-compose with complex parameters
-    #   command('docker-compose', {file: 'joe.yml'}, 'up', {d:true}, 'mysvc')
-    #
-    # @see #options for information on Hash-to-flag translation
-    def command(*cmd)
-      argv = []
-
-      cmd.each do |item|
-        case item
-        when Array
-          # list of words to append to argv
-          argv.concat(item.map { |e| e.to_s })
-        when Hash
-          # list of options to convert to CLI parameters
-          argv.concat(self.class.options(item))
-        else
-          # single word to append to argv
-          argv << item.to_s
-        end
-      end
-
-      run(argv)
-    end
-
-    # Run a simple command.
-    #
-    # @param [Array] argv list of command words
-    # @return [Array] triple of integer exitstatus, string stdout, and stderr
-    private def run(argv)
-      if self.interactive
-        run_interactive(argv)
-      else
-        run_noninteractive(argv)
-      end
-    end
-
-    # Run a shell command. Use a pty to capture the unbuffered output.
-    #
-    # @param [Array] argv command to run; argv[0] is program name and the
-    #   remaining elements are parameters and flags
-    # @return [Array] an (Integer,String,String) triple of exitstatus, stdout and (empty) stderr
-    private def run_interactive(argv)
-      stdout, stdout_w = PTY.open
-      stdin_r, stdin = IO.pipe
-      stderr, stderr_w = IO.pipe
-      pid = spawn(*argv, in: stdin_r, out: stdout_w, err: stderr_w)
-      stdin_r.close
-      stdout_w.close
-      stderr_w.close
-
-      output, error = run_inner(stdin, stdout, stderr)
-
-      Process.waitpid(pid)
-
-      [$?.exitstatus, output, error]
-    end
-
-    # Run a shell command. Perform no translation or substitution. Use a pipe
-    # to read the output, which may be buffered by the OS. Return the program's
-    # exit status and stdout.
-    #
-    # TODO eliminate interactive path (it can't happen anymore) and move flourishes to run_interactive
-    #
-    # @param [Array] argv command to run; argv[0] is program name and the
-    #   remaining elements are parameters and flags
-    # @return [Array] an (Integer,String,String) triple of exitstatus, stdout and stderr
-    private def run_noninteractive(argv)
-      stdin, stdout, stderr, thr = Open3.popen3(*argv)
-
-      output, error = run_inner(stdin, stdout, stderr)
-
-      # This blocks until the process exits (which probably already happened,
-      # given that we have received EOF on its output streams).
-      status = thr.value.exitstatus
-
-      [status, output, error]
-    rescue Interrupt
-      # Proxy Ctrl+C to our child process
-      Process.kill('INT', thr.pid) rescue nil
-      raise
-    end
-
-    private def run_inner(stdin, stdout, stderr)
-      streams = [stdout, stderr]
-
-      if @interactive
-        streams << STDIN
-      else
-        stdin.close
-      end
-
-      output = String.new.force_encoding(Encoding::BINARY)
-      error = String.new.force_encoding(Encoding::BINARY)
-
-      until streams.empty? || (streams.length == 1 && streams.first == STDIN)
-        ready, _, _ = IO.select(streams, [], [], 1)
-
-        if ready && ready.include?(STDIN)
-          input = STDIN.readpartial(1_024) rescue nil
-          if input
-            stdin.write(input)
-          else
-            # our own STDIN got closed; proxy to child's stdin
-            stdin.close
-          end
-        end
-
-        if ready && ready.include?(stderr)
-          data = stderr.readpartial(1_024) rescue nil
-          if data
-            error << data
-            STDERR.write(data) if @interactive
-          else
-            streams.delete(stderr)
-          end
-        end
-
-        if ready && ready.include?(stdout)
-          data = stdout.readpartial(1_024) rescue nil
-          if data
-            output << data
-            STDOUT.write(data) if @interactive
-          else
-            streams.delete(stdout)
-          end
-        end
-      end
-
-      [output, error]
-    end
-  end
-end