docker-compose 0.0.0 → 0.1.0

data/lib/docker/compose/shell.rb

@@ -0,0 +1,165 @@
+require 'open3'
+
+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!
+    #
+    # TODO: solve pipe buffering issues, perhaps with a pty...
+    #
+    # @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.
+    #
+    # @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 shell command. Perform no translation or substitution. Return
+    # the program's exit status and stdout.
+    #
+    # @param [Array] argv command to run; argv[0] is program name and the
+    #   remaining elements are parameters and flags
+    # @return [Array] a pair of Integer exitstatus and String output
+    private def run(argv)
+      stdin, stdout, stderr, thr = Open3.popen3(*argv)
+
+      streams = [stdout, stderr]
+
+      if @interactive
+        streams << STDIN
+      else
+        stdin.close
+      end
+
+      output = 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
+            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
+
+      # 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]
+    rescue Interrupt
+      # Proxy Ctrl+C to our child process
+      Process.kill('INT', thr.pid) rescue nil
+      raise
+    end
+  end
+end

data/lib/docker/compose/version.rb

@@ -1,6 +1,5 @@
-# encoding: utf-8
 module Docker
   module Compose
-    VERSION = '0.0.0'
+    VERSION = "0.1.0"
   end
 end

data/lib/docker/compose.rb

@@ -1,17 +1,12 @@
-# encoding: utf-8
-require 'net/http'
-
 require_relative 'compose/version'
-require_relative 'compose/error'
-require_relative 'compose/container'
-require_relative 'compose/collection'
+require_relative 'compose/shell'
 require_relative 'compose/session'
 require_relative 'compose/net_info'
 require_relative 'compose/mapper'
 
 module Docker
   module Compose
-    # Create a new session with default options.
+    # Create a new session.
     def self.new
       Session.new
     end

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: docker-compose
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Tony Spataro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-01 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: backticks
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -74,14 +60,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
-- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".rspec"
-- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
-- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -90,18 +72,13 @@ files:
 - bin/console
 - bin/setup
 - docker-compose.gemspec
-- docker-compose.yml
 - lib/docker/compose.rb
-- lib/docker/compose/collection.rb
-- lib/docker/compose/container.rb
-- lib/docker/compose/error.rb
+- lib/docker/compose/future/session.rb
 - lib/docker/compose/mapper.rb
 - lib/docker/compose/net_info.rb
 - lib/docker/compose/rake_tasks.rb
 - lib/docker/compose/session.rb
-- lib/docker/compose/shell_printer.rb
-- lib/docker/compose/shell_printer/fish.rb
-- lib/docker/compose/shell_printer/posix.rb
+- lib/docker/compose/shell.rb
 - lib/docker/compose/version.rb
 homepage: https://github.com/xeger/docker-compose
 licenses:
@@ -115,17 +92,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
-  - - "<"
-    - !ruby/object:Gem::Version
-      version: '4.0'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubyforge_project: 
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Wrapper docker-compose with added Rake smarts.

data/.coveralls.yml

@@ -1 +0,0 @@
-repo_token: hMWX6XPNvG4Gfy9gCDEvrxhQVKdyN5e2m

data/.github/workflows/publish.yml

@@ -1,42 +0,0 @@
-name: publish
-
-on:
-  push:
-    branches: [actions]
-
-jobs:
-  publish:
-    name: publish
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
-
-    steps:
-      - uses: actions/checkout@v3
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.0.0
-          bundler-cache: true
-      - name: build
-        run: |
-          release='v0.0.0'
-          version=`echo $release | cut -b2-`
-          if ! echo $release | grep -q '^v[0-9]\+\.[0-9]\+\.[0-9]\+$'; then
-            echo "Release name must be in the format of 'vX.Y.Z', got '$release'"
-            exit 1
-          fi
-          sed -i -r "s/VERSION = '.+'/VERSION = '$version'/" lib/docker/compose/version.rb
-          bundle exec rake build
-      - name: push
-        run: |
-          mkdir -p $HOME/.gem
-          touch $HOME/.gem/credentials
-          chmod 0600 $HOME/.gem/credentials
-          printf -- "---\n:rubygems_api_key: ${RUBYGEMS_TOKEN}\n:github: Bearer ${GITHUB_TOKEN}\n" > $HOME/.gem/credentials
-          gem push pkg/*.gem
-          gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} pkg/*.gem
-        env:
-          GITHUB_TOKEN: "Bearer ${{ secrets.GITHUB_TOKEN }}"
-          OWNER: ${{ github.repository_owner }}
-          RUBYGEMS_TOKEN: "${{ secrets.RUBYGEMS_TOKEN }}"

data/.rubocop.yml

@@ -1,38 +0,0 @@
-# CODING CONVENTIONS
-#  - any cop that can be auto-corrected with `rubocop -a` is mandatory
-#  - other cops may be enabled if committer fixes all issues
-AllCops:
-  NewCops: enable
-  Exclude:
-    - features/**/*
-    - spec/**/*
-Style/Encoding:
-  Enabled: true
-Style/FormatString:
-  Enabled: false
-Style/GuardClause:
-  Enabled: false
-Layout/LineLength:
-  Enabled: false
-Lint/AmbiguousRegexpLiteral:
-  Enabled: false
-Metrics/AbcSize:
-  Enabled: false
-Metrics/BlockLength:
-  Enabled: false
-Metrics/ClassLength:
-  Enabled: false
-Metrics/MethodLength:
-  Enabled: false
-Metrics/CyclomaticComplexity:
-  Enabled: false
-Metrics/PerceivedComplexity:
-  Enabled: false
-Style/ClassAndModuleChildren:
-  Enabled: false
-Style/Documentation:
-  Enabled: false
-Style/RaiseArgs:
-  Enabled: false
-Style/Semicolon:
-  Enabled: false

data/CHANGELOG.md

@@ -1,32 +0,0 @@
-1.1
----
-
-#### New features
-
-Add `scale` command to Session methods.
-
-
-1.0
----
-
-No significant changes; the 1.0 increment is to indicate that Docker::Compose now has test coverage, and that we intend to maintain a stable API until 2.0.
-
-0.6
----
-
-#### Interface-breaking changes
-
-  - Replaced `docker:compose:server` Rake task with more general `docker:compose:host`
-    - Replaced `server_env` option with `host_env`
-    - Replaced `extra_server_env` option with `extra_host_env`
-  - Stopped mapping values in `extra_host_env`; they are now exported verbatim
-
-#### New features
-
-Produce `docker:compose:env` output that is compatible with user's login shell.
-
-0.5
----
-
-Initial public release of prototype. Features work well, but there is no test
-coverage.

data/docker-compose.yml

@@ -1,11 +0,0 @@
-# basic smoke test for the gem.
-# TODO: write cucumber features for comprehensive functional tests!
-apple:
-  image: busybox
-  command: /bin/sh -c 'sleep 3600'
-  ports:
-    - 123
-    - 456
-orange:
-  image: busybox
-  command: /bin/sh -c 'sleep 3600'

data/lib/docker/compose/collection.rb

@@ -1,13 +0,0 @@
-module Docker::Compose
-  class Collection < Array
-    # @example find containers that are up
-    #   who_is_up = coll.where { |c| c.up? }
-    # @example count space taken by all containers
-    #   coll.map { |c| c.size }.inject(0) { |a, x| a + x }
-    def where
-      hits = Collection.new
-      self.each { |c| hits << c if yield(c) }
-      hits
-    end
-  end
-end

data/lib/docker/compose/container.rb

@@ -1,80 +0,0 @@
-module Docker::Compose
-  class Container
-    # Format string for `docker ps`
-    PS_FMT     = '({{.ID}}) ({{.Image}}) ({{.Size}}) ({{.Status}}) ({{.Names}}) ({{.Labels}}) ({{.Ports}})'
-    # Number of template substitutions in PS_FMT
-    PS_FMT_LEN = PS_FMT.count('.')
-    # Pattern that parses human-readable values from ps .Status
-    PS_STATUS  = /^([A-Za-z]+) ?\(?([0-9]*)\)? ?(.*)$/i
-    # Pattern that parses FIRST occurrence of container size from a string,
-    # along with its units.
-    PS_SIZE = /^([0-9.]+)\s*([kmgt]?B)/i
-
-    attr_reader :id, :image, :size, :status, :exitstatus
-    attr_reader :names, :labels, :ports
-
-    # @param [String] id
-    # @param [String] image
-    # @param [String,Integer] size e.g. "0B (virtual 100MB)"
-    # @param [String,#map] status e.g. ['Exited', '0', '3 minutes ago']
-    # @param [String,Array] names list of container names (CSV)
-    # @param [String,Array] labels list of container labels (CSV)
-    # @param [String,Array] ports list of exposed ports (CSV)
-    def initialize(id, image, size, status, names, labels, ports)
-      if size.is_a?(String) && (m = PS_SIZE.match(size))
-        scalar, units = m[1], m[2]
-        scalar = scalar.to_f # lazy: invalid --> 0.0
-        mult = case units.downcase
-        when 'b'  then 1
-        when 'kb' then 1_024
-        when 'mb' then 1_024**2
-        when 'gb' then 1_024**3
-        when 'tb' then 1_024**4
-        else
-          raise Error.new('Service#new', units, 'Impossibly large unit')
-        end
-        size = scalar * mult
-      end
-
-      if status.is_a?(String)
-        status = PS_STATUS.match(status)
-        raise Error.new('Service#new', status, 'Unrecognized status') unless status
-      end
-
-      names = names.split(',').map{ |x| x.strip } if names.is_a?(String)
-      labels = labels.split(',').map{ |x| x.strip } if labels.is_a?(String)
-      ports = ports.split(',').map{ |x| x.strip } if ports.is_a?(String)
-
-      @id = id
-      @image = image
-      @size = size
-      @status = status[1].downcase.to_sym
-
-      @exitstatus = case @status
-      when :up
-        nil
-      else
-        status[2].to_i
-      end
-
-      @names = names
-      @labels = labels
-      @ports = ports
-    end
-
-    # static sanity checking ftw!
-    unless ( initarity = instance_method(:initialize).arity ) == PS_FMT_LEN
-      raise LoadError.new("#{__FILE__}:#{__LINE__} - arity(\#initialize) != PS_FMT_LEN; #{initarity} != #{PS_FMT_LEN}")
-    end
-
-    # @return [String]
-    def name
-      names.first
-    end
-
-    # @return [Boolean]
-    def up?
-      self.status == :up
-    end
-  end
-end

data/lib/docker/compose/error.rb

@@ -1,26 +0,0 @@
-# encoding: utf-8
-module Docker::Compose
-  class Error < RuntimeError
-    attr_reader :status, :detail
-
-    # @param [String] cmd
-    # @param [Integer] status
-    # @param [String] detail
-    def initialize(cmd, status, detail)
-      @status = status
-      @detail = detail
-
-      brief = detail.split(/[\r\n]+/).select { |l| !l.empty? }.first || '(no output)'
-
-      case status
-      when Numeric
-        status = status.to_s
-      else
-        status = "'#{status}'"
-      end
-
-      message = format("'%s' failed with status %s: %s", cmd, status, brief)
-      super(message)
-    end
-  end
-end

data/lib/docker/compose/shell_printer/fish.rb

@@ -1,17 +0,0 @@
-# encoding: utf-8
-module Docker::Compose::ShellPrinter
-  # Printer that works with the Friendly Interactive Shell (fish).
-  class Fish < Posix
-    def eval_output(command)
-      format('eval (%s)', command)
-    end
-
-    def export(name, value)
-      format('set -gx %s %s; ', name, single_quoted_escaped(value))
-    end
-
-    def unset(name)
-      format('set -ex %s; ', name)
-    end
-  end
-end

data/lib/docker/compose/shell_printer/posix.rb

@@ -1,33 +0,0 @@
-# encoding: utf-8
-module Docker::Compose::ShellPrinter
-  # Printer that works with any POSIX-compliant shell e.g. sh, bash, zsh
-  class Posix
-    def comment(value)
-      format('# %s', value)
-    end
-
-    def eval_output(command)
-      format('eval "$(%s)"', command)
-    end
-
-    def export(name, value)
-      format('export %s=%s', name, single_quoted_escaped(value))
-    end
-
-    def unset(name)
-      format('unset %s', name)
-    end
-
-    protected def single_quoted_escaped(value)
-      # "escape" any occurrences of ' in value by closing the single-quoted
-      # string, concatenating a single backslash-escaped ' character, and reopening
-      # the single-quoted string.
-      #
-      # This relies on the shell's willingness to concatenate adjacent string
-      # literals. Tested under sh, bash and zsh; should work elsewhere.
-      escaped = value.gsub("'") { "'\\''" }
-
-      "'#{escaped}'"
-    end
-  end
-end

data/lib/docker/compose/shell_printer.rb

@@ -1,26 +0,0 @@
-# encoding: utf-8
-require 'etc'
-
-module Docker::Compose
-  module ShellPrinter
-    def self.new
-      shell = Etc.getpwuid(Process.uid).shell
-      basename = File.basename(shell)
-
-      # Crappy titleize (bash -> Bash)
-      basename[0] = basename[0].upcase
-
-      # Find adapter class named after shell; default to posix if nothing found
-      klass = begin
-                const_get(basename.to_sym)
-              rescue
-                Posix
-              end
-
-      klass.new
-    end
-  end
-end
-
-require_relative 'shell_printer/posix'
-require_relative 'shell_printer/fish'