docker-compose 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5307fb75ebdc1b6f79b326c6d31ff1ba3e08e1d
-  data.tar.gz: 5df6cd398d2238151ad063545ba94a5f3a4d32f5
+  metadata.gz: d0fd6f058df23b81e91fb41201f8e8f6c0b46a1f
+  data.tar.gz: 2b4fa470ffa68b8ede08591129e0135d548effe8
 SHA512:
-  metadata.gz: 0a17412a0364656f01e2ff5efe203d5a961f156ad09c699155e11255560d6c0fd2d600c5cbbb08fb5fdde688e71939940dbefcee0aaad472af7a99a7331da8e6
-  data.tar.gz: d7a046c4c39b75fe2fb5a3b69264324debc58571f5a72d090b54896c03ca40ce80017c27b15eb636bc3dae6f3f71f79c176ba201b4084c5651202e3a3304f589
+  metadata.gz: 708ea8165969cf7b7e6b91b8707ff4b89ba1af98101a6d7bfb43e8d3f6dbbf85607159e1b20f29a4af9615ea90409292d0df830c7915b4de2dbfd011ce69eb47
+  data.tar.gz: 17793d4f5899fbc76c238965f5990609b12cad7fb5a7866d6ac8c8d402dd43c61cc245642f3eb39b5894634450b0156c388fc131075a1fbc3354d9cdcd813153

data/README.md

@@ -1,18 +1,16 @@
 # Docker::Compose
 
 This is a Ruby OOP wrapper for the [docker-compose](https://github.com/docker/compose)
-container orchestration tool from Docker Inc. It also contains some features that
-layer nicely on top of docker-compose to enhance your productivity.
+container orchestration tool from Docker Inc. 
 
-Distinctive features of this gem:
-
-1) Simulates environment-variable substitution in the style of docker-compose
-   1.5; sequences such as ${FOO} in your YML will be replaced with the
-   corresponding environment variable. (This feature will go away once 1.5
-   is released.)
-
-2) Environment-variable mapping that allows you to export environment variables
-   into your _host_ that point to network services published by containers.
+In addition to wrapping the CLI, this gem provides an environment-variable mapping 
+featurie that allows you to export environment variables into your _host_ that point
+to network services exposed by containers. This allows you to run an application on
+your host for quicker and easier development, but run all of its architectural
+dependencies -- database, cache, adjacent microservices -- in containers. The
+dependencies can even be running on another machine, e.g. a cloud instance or a
+container cluster, provided your development machine has TCP connectivity on every
+port exposed by a container.  
 
 Throughout this documentation we will refer to this gem as `Docker::Compose`
 as opposed to the `docker-compose` tool that this gem wraps.
@@ -40,8 +38,8 @@ Or install it yourself as:
 ```ruby
 require 'docker/compose'
 
-# Create a new session in Dir.pwd using the file "docker-compose.yml"
-# for fine-grained control over options, see Docker::Compose::Session#new
+# Create a new session in Dir.pwd using the file "docker-compose.yml".
+# For fine-grained control over options, see Docker::Compose::Session#new
 compose = Docker::Compose.new
 
 compose.version

data/lib/docker/compose/mapper.rb

@@ -59,11 +59,41 @@ module Docker::Compose
     # @example map just the port of MySQL on local docker host
     #   map("[db]:3306") # => "13847"
     #
-    # @param [String] value a URI or a host:port pair
+    # @example map an array of database hosts
+    #   map(["[db1]:3306", "[db2]:3306"])
+    #
+    # @param [String,#map] value a URI, host:port pair, or an array of either
+    #
+    # @return [String,Array] the mapped value with container-names and ports substituted
     #
     # @raise [BadSubstitution] if a substitution string can't be parsed
     # @raise [NoService] if service is not up or does not publish port
     def map(value)
+      if value.respond_to?(:map)
+        value.map { |e| map_scalar(e) }
+      else
+        map_scalar(value)
+      end
+    end
+
+    # Figure out which host port a given service's port has been published to,
+    # and/or whether that service is running. Cannot distinguish between the
+    # "service not running" case and the "container port not published" case!
+    #
+    # @raise [NoService] if service is not up or does not publish port
+    # @return [Integer] host port number, or nil if port not published
+    def published_port(service, port)
+      result = @session.port(service, port)
+      Integer(result.split(':').last.gsub("\n", ""))
+    rescue RuntimeError
+      raise NoService, "Service '#{service}' not running, or does not publish port '#{port}'"
+    end
+
+    # Map a single string, replacing service names with IPs and container ports
+    # with the host ports that they have been mapped to.
+    # @param [String] value
+    # @return [String]
+    private def map_scalar(value)
       uri = URI.parse(value) rescue nil
       pair = value.split(':')
 
@@ -97,18 +127,5 @@ module Docker::Compose
         return value
       end
     end
-
-    # Figure out which host port a given service's port has been published to,
-    # and/or whether that service is running. Cannot distinguish between the
-    # "service not running" case and the "container port not published" case!
-    #
-    # @raise [NoService] if service is not up or does not publish port
-    # @return [Integer] host port number, or nil if port not published
-    def published_port(service, port)
-      result = @session.port(service, port)
-      Integer(result.split(':').last.gsub("\n", ""))
-    rescue RuntimeError
-      raise NoService, "Service '#{service}' not running, or does not publish port '#{port}'"
-    end
   end
 end

data/lib/docker/compose/rake_tasks.rb

@@ -1,3 +1,4 @@
+require 'json'
 require 'rake/tasklib'
 
 # In case this file is required directly
@@ -115,7 +116,7 @@ module Docker::Compose
       Docker::Compose::Mapper.map(self.server_env,
                                   session:@session,
                                   net_info:@net_info) do |k, v|
-        ENV[k] = v
+        ENV[k] = serialize_for_env(v)
         print_env(k, v) if print
       end
 
@@ -123,11 +124,25 @@ module Docker::Compose
                                   strict:false,
                                   session:@session,
                                   net_info:@net_info) do |k, v|
-        ENV[k] = v
+        ENV[k] = serialize_for_env(v)
         print_env(k, v) if print
       end
     end
 
+    # Transform a Ruby value into a String that can be stored in the
+    # environment. This accepts nil, String, or Array and returns nil, String
+    # or JSON-serialized Array.
+    private def serialize_for_env(v)
+      case v
+      when String, NilClass
+        v
+      when Array
+        JSON.dump(v)
+      else
+        raise ArgumentError, "Can't represent a #{v.class} in the environment"
+      end
+    end
+
     # Print a bash export or unset statement
     private def print_env(k, v)
       if v

data/lib/docker/compose/version.rb

@@ -1,5 +1,5 @@
 module Docker
   module Compose
-    VERSION = "0.2.1"
+    VERSION = "0.2.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-compose
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Tony Spataro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-15 00:00:00.000000000 Z
+date: 2015-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler