docker-rainbow 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55bae159f151f0549936929a29e1ba2eeafca2e5
-  data.tar.gz: 978c3fab0d41b6305d9fdebd0658f5318b6913a3
+  metadata.gz: 730c043f484f68f40d55db9b10a193f345e0b29e
+  data.tar.gz: 4aff75bd0074a35c1e99d7c95277c811b8e8a007
 SHA512:
-  metadata.gz: 84f102ec3ce7d0ab4eefdae00a92c0fa271d7a931e9724aaffb62ccbb9e2c72ac3496c9c341285347714e0809daff1924f7b74e6da643fcb87ecac4bbb49d4b8
-  data.tar.gz: b11826896fc7628a459a9faed451e25ca885aa1d01bd2468c4041f42d0dc924a66f0c585de6302ca12f6ec40642ecb357e376e6cc073fb6015fa1b2d1785928c
+  metadata.gz: 885ac7ae6efadb0d61907f6f78ffdc40e4f74091c2d70dfabfffb1c4968a78686cb39d7d80bb8f13f4b7f79159b74a8c24984c2184fc171321c1fb4a46f3cc73
+  data.tar.gz: 97897f515b6ed46e9d7a57f3ec8993c1e57f7f12fc4b8a0ddcaa905ce8f29f65ff7cf8051330ffbf7cf5a14174a5f91666f6100999cd91d690669aa585474b22

data/README.md

@@ -45,7 +45,7 @@ names = rainbow.name_containers('spotify/cassandra:latest', count:3)
 
 
 names.each do |name|
-  system("docker run -n #{name} spotify/cassandra:latest")
+  system("docker run --name #{name} spotify/cassandra:latest")
 end
 ```
 
@@ -73,7 +73,12 @@ box. (How often would you have six different revisions of software running
 on one box at once time?)
 
 If you will handle naming conflicts yourself, you can ask the rainbow to ignore
-them and/or opt out of the built-in garbage collection.
+them with `reuse:true`; rather than raising an exception for in-use names, it
+will simply return the existing names.
+
+If you use this option, then you almost certainly also want to use `gc:false`
+to prevent the rainbow from garbage-collecting dead containers whose names it
+will reuse.
 
 ```ruby
   rainbow.name_containers('spotify/cassandra:latest', reuse:true, gc:false)
@@ -104,9 +109,9 @@ might find it super interesting that you invoked busybox as `/bin/sh -c ls foo`,
 but the people who look at `docker ps` output probably don't care to see a
 container named `busybox_bin-sh-c-ls-foo`!
 
-To encourage you to choose terse names, Rainbow will extract the _first_
-alphanumeric word from the cmd and use it alone as a suffix for your container
-named. If this is an issue, refer to "Customizing Container Names", below.
+Although we encourage you to choose terse names, Rainbow will helpfully modify
+any value you provide with underscores in place of any non alpha-numeric value.
+If this is an issue, refer to "Customizing Container Names", below.
 
 ### Multi-tenancy
 
@@ -152,5 +157,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/docker-rainbow. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/xeger/docker-rainbow. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 

data/docker-rainbow.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["tony@rightscale.com"]
 
   spec.summary       = %q{An Ops-friendly container naming scheme for Docker.}
-  spec.description   = %q{Chooses terse, meaningful, unique names for containers based on base image, existing containers, and other factors.}
+  spec.description   = %q{Generates terse, meaningful, unique names for your Docker containers.}
   spec.homepage      = "https://github.com/xeger/docker-rainbow"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

data/lib/docker/rainbow.rb

@@ -26,6 +26,9 @@ module Docker
     # of the world. (That's what `docker logs` is for...)
     PALETTE = ['blue', 'green', 'orange', 'red', 'yellow', 'violet'].freeze
 
+    # Pattern that matches any container name allowed by Docker.
+    VALID_NAME = /^[a-zA-Z0-9][a-zA-Z0-9_.-]+$/.freeze
+
     # Execute a shell command and return its output. If the command fails,
     # raise RuntimeError with details of the command that failed.
     # TODO use a pretty gem to do this, and/or a Ruby docker CLI wrapper
@@ -128,14 +131,17 @@ module Docker
       base
     end
 
-    # Transform a cmd into a valid container name fragment. Split cmd into
-    # words and return ONLY the first word.
-    # This assumes that the first word of the command is sufficient to
-    # uniquely identify the container's role, and that any remaining words are
-    # noise.
+    # Transform a cmd into a valid container name fragment, or use it verbatim
+    # if it is already valid.
     private def cmd_suffix(cmd)
-      words = cmd.split(/[^A-Za-z0-9]+/)
-      words.first
+      if cmd =~ VALID_NAME
+        cmd
+      else
+        mod = cmd.gsub(/\W+/,'_')
+        mod.gsub!(/^_+/, '')
+        mod.gsub!(/_+$/, '')
+        mod
+      end
     end
 
     def remove_dead(containers)

data/lib/docker/rainbow/version.rb

@@ -1,5 +1,5 @@
 module Docker
   class Rainbow
-    VERSION = "0.1.4"
+    VERSION = "0.1.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-rainbow
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Tony Spataro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-11 00:00:00.000000000 Z
+date: 2015-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,8 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Chooses terse, meaningful, unique names for containers based on base
-  image, existing containers, and other factors.
+description: Generates terse, meaningful, unique names for your Docker containers.
 email:
 - tony@rightscale.com
 executables: []