qb 0.1.76 → 0.1.77

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 278f4d439b1c8ed74ea0316095723d51e2000449
-  data.tar.gz: '08c472b627d62061061b14da42ef7db029e5a975'
+  metadata.gz: 5034072491c569409a8d336f915896be6a6d0b0e
+  data.tar.gz: 121e0e57dc4eeb6b1f35e5ce2695c7f6c1b2380b
 SHA512:
-  metadata.gz: f896170a886b41e19be31d1cf8e0b3e5de895781f825d90dc78b0f3d303fd42b6eb89b9207f0d5ec536a1e5946f0345f0eac6bb1c98d197ea88f51e14558780a
-  data.tar.gz: ec44ca9cf50006219d52060a8c690cd4513647a5423851a050ba5a5998af95bfab944e5e6b6681e00322a2852afecd7762cdb82a7c10ab012b1b10252a7c1e68
+  metadata.gz: b49a812b695412a1d0eaced107e01ea49d978fdc4266ebb87e89fb8db0738aed30db5c9d3e45db6d4fbccfa3d881e912ab4f19baf2ad717938d56fa8e009b852
+  data.tar.gz: 392d529ac62f2fc62b76983f87819207f2a7022ce444f4de48b6e53b8ab6205ae5e4a035748d6c5bdb98187cc3afbdced6a87a3ac3f88eb5e5d1efe3095113d2

data/lib/qb/package/version.rb

@@ -2,6 +2,8 @@ require 'time'
 
 require 'nrser/types'
 
+require 'qb/util/docker_mixin'
+
 T = NRSER::Types
 
 module QB
@@ -12,6 +14,7 @@ module QB
     # Intended to be immutable for practical purposes.
     # 
     class Version
+      include QB::Util::DockerMixin
       
       # Class Methods
       # =====================================================================
@@ -26,6 +29,7 @@ module QB
         time.utc.iso8601.gsub /[^0-9A-Za-z]/, ''
       end
       
+      
       # Instance Builders
       # ---------------------------------------------------------------------
       
@@ -78,9 +82,34 @@ module QB
             build: parse['build']
       end
       
+      
+      # Parse Docker image tag version into a string. Reverse of 
+      # {QB::Package::Version#docker_tag}.
+      # 
+      # @param [String] version
+      #   String version to parse.
+      # 
+      # @return [QB::Package::Version]
+      # 
+      def self.from_docker_tag version
+        from_string version.gsub('_', '+')
+      end # .from_docker_tag
+      
+      
+      
+      # Parse string version into an instance. Accept Semver, Ruby Gem and 
+      # Docker image tag formats.
+      # 
+      # @param [String]
+      #   String version to parse.
+      # 
+      # @return [QB::Package::Version]
+      # 
       def self.from_string string
         if string.include? '-'
           self.from_npm_version string
+        elsif string.include? '_'
+          self.from_docker_tag string
         else
           self.from_gem_version Gem::Version.new(string)
         end
@@ -233,9 +262,10 @@ module QB
       # ---------------------------------------------------------------------
       
       # @return [String]
-      #   A normalized raw version string in
-      #   `Major.minor.patch-prerelease+build` format.
-      def normalized
+      #   The Semver version string
+      #   (`Major.minor.patch-prerelease+build` format).
+      # 
+      def semver
         result = release
         
         unless prerelease.empty?
@@ -247,7 +277,9 @@ module QB
         end
         
         result
-      end # #normalized
+      end # #semver
+      
+      alias_method :normalized, :semver
       
       
       # @return [QB::Package::Version]
@@ -286,6 +318,17 @@ module QB
         merge raw: nil, build: segments
       end
       
+      # Docker image tag for the version.
+      # 
+      # See {QB::Util::DockerMixin::ClassMethods#to_docker_tag}.
+      # 
+      # @return [String]
+      #   
+      def docker_tag
+        self.class.to_docker_tag semver
+      end # #docker_tag
+      
+      
       
       # Language Interface
       # =====================================================================
@@ -365,7 +408,8 @@ module QB
           is_dev: dev?,
           is_rc: rc?,
           has_level: level?,
-          normalized: normalized,
+          semver: semver,
+          docker_tag: docker_tag,
         ).to_json *args
       end
       

data/lib/qb/util/docker_mixin.rb

@@ -0,0 +1,102 @@
+require 'nrser'
+
+module QB 
+module Util
+
+# Mixin to help working with Docker.
+module DockerMixin 
+  DOCKER_TAG_MAX_CHARACTERS = 128
+
+  # Regexp to validate strings as Docker tags.
+  DOCKER_TAG_VALID_RE = \
+    /\A[A-Za-z0-9_][A-Za-z0-9_\.\-]{0,#{ DOCKER_TAG_MAX_CHARACTERS - 1}}\z/.
+    freeze
+  
+  # Class methods to extend the receiver with when {QB::Util::DockerMixin}
+  # is included.
+  module ClassMethods
+    
+    # Test if `string` is a valid Docker image tag by seeing if it matches 
+    # {QB::Util::DockerMixin::DOCKER_TAG_VALID_RE}
+    # 
+    # @param [String] string
+    #   String to test.
+    # 
+    # @return [Boolean]
+    #   True if `string` is a valid Docker image tag.
+    # 
+    def valid_docker_tag? string
+      DockerMixin::DOCKER_TAG_VALID_RE =~ string
+    end
+    
+    
+    # Check that `string` is a valid Docker image tag, raising an error if not.
+    # 
+    # Check is performed via
+    # {QB::Util::DockerMixin::ClassMethods#valid_docker_tag}.
+    # 
+    # @param string see QB::Util::DockerMixin::ClassMethods#valid_docker_tag
+    # 
+    # @return [nil]
+    def check_docker_tag string
+      unless valid_docker_tag? string
+        raise ArgumentError.new NRSER.squish <<-END
+          Argument #{ string.inspect } is not a valid Docker image tag.
+        END
+      end
+      nil
+    end
+    
+    
+    # Convert a [Semver][] version string to a string suitable for use as 
+    # a Docker image tag, which, as of writing, are restricted to
+    # 
+    #     [A-Za-z0-9_.-]
+    # 
+    # and 128 characters max (used to be 30, but seems it's been increased).
+    # 
+    # [Docker image tag]: https://github.com/moby/moby/issues/8445
+    # [Docker image tag (archive)]: https://archive.is/40soa
+    # 
+    # This restriction prohibits [Semver][] strings that use `+` to separate
+    # the build segments.
+    # 
+    # We replace `+` with `_`.
+    #
+    # `_` is *not* a legal character in [Semver][] *or* Ruby Gem versions,
+    # making it clear that the resulting string is for Docker use, and
+    # allowing parsing to get back to an equal {QB::Package::Version}
+    # instance.
+    # 
+    # [Semver]: http://semver.org/
+    # 
+    # @param [String] semver
+    #   A legal [Semver][] version string to convert.
+    # 
+    # @return [String]
+    #   Legal Docker image tag corresponding to `semver`.
+    #
+    # @raise [ArgumentError]
+    #   If the resulting string is longer than 
+    #   {QB::Package::Version::DOCKER_TAG_MAX_CHARACTERS}.
+    # 
+    # @raise [ArgumentError]
+    #   If the resulting string still contains invalid characters for a Docker
+    #   image tag after the substitution.
+    # 
+    def to_docker_tag semver
+      semver.gsub('+', '_').tap { |docker_tag|
+        check_docker_tag docker_tag
+      }
+    end # .to_docker_tag
+    
+  end # module ClassMethods
+  
+  def self.included base
+    base.extend ClassMethods
+  end
+  
+end # module DockerMixin
+
+end # module Util
+end # module QB

data/lib/qb/version.rb

@@ -4,7 +4,7 @@ module QB
   
   GEM_NAME = 'qb'
   
-  VERSION = "0.1.76"
+  VERSION = "0.1.77"
   
   MIN_ANSIBLE_VERSION = Gem::Version.new '2.1.2'
   

data/roles/nrser.rb/library/set_fact_with_ruby.rb

@@ -1,39 +1,48 @@
 #!/usr/bin/env ruby
+# 
+# 
+# 
+ 
 # WANT_JSON
-# ^ i think this is something telling ansible to provide JSON args?
+# ^ tell Ansible to provide args as JSON encoded file.
+
+# init bundler in dev env
+if ENV['QB_DEV_ENV']
+  ENV.each {|k, v|
+    if k.start_with? 'QB_DEV_ENV_'
+      ENV[k.sub('QB_DEV_ENV_', '')] = v
+    end
+  }
+  require 'bundler/setup'
+end
 
 # stdlib
 require 'json'
 require 'shellwords'
 require 'pp'
 
-# deps
-require 'nrser'
-
+# Global var to append warning messages to.
 $warnings = []
 
-def namespace prefix, hash
-  Hash[
-    hash.map {|key, value|
-      ["#{ prefix }_#{ key }", value]
-    }
-  ]
-end
-
+# Add a warning to $warnings to be sent back to Ansible and displayed to the
+# user.
 def warn msg, **details
   unless details.empty?
-    
+    msg += ", details: " + details.pretty_inspect
   end
   
   $warnings << msg
 end
 
+
+# Entry point
 def main
   input = nil
   args = nil
 
   begin
     input = File.read ARGV[0]
+    
     args = JSON.load input
     
     var_name = args.fetch 'var_name'
@@ -43,6 +52,10 @@ def main
     ['bind', 'vars'].each do |key|
       if args.key? key
         args[key].each {|k, v|
+          # Ansible sends null/None values as empty strings, so convert those
+          # to nil. This does prevent passing the empty string as a value, but
+          # it seems like a more reasonable / intuitive way to treat it.
+          v = nil if v == ''
           b.local_variable_set k, v
         }
       end
@@ -60,26 +73,32 @@ def main
     
   rescue Exception => e
     path = File.join Dir.pwd, "ansible-error.log"
-    msg = NRSER.squish <<-END
-      set_fact_with_ruby failed: #{ e.message } (#{ e.class.name }).
-      See #{ path } for details.
-    END
+    msg = "set_fact_with_ruby failed: #{ e.message } (#{ e.class.name }). " +
+          "See #{ path } for details."
     
-    formatted = NRSER.format_exception(e)
+    formatted = \
+      "#{ e.message } (#{ e.class }):\n  #{ e.backtrace.join("\n  ") }"
+    
+    indent = ->(str) { str.gsub(/^/, '  ') }
     
     File.open(path, 'w') {|f|
       f.puts "ERROR:\n\n"
-      f.puts NRSER.indent(formatted)
+      f.puts indent.(formatted)
       
       f.puts "\nINPUT:\n\n"
-      f.puts NRSER.indent(input) if defined? input
+      f.puts indent.(input) if defined? input
       
       f.puts "\nARGS:\n\n"
-      f.puts NRSER.indent(args.pretty_inspect) if defined? args
+      f.puts indent.(args.pretty_inspect) if defined? args
       
       f.puts "\nRUBY:\n"
-      f.puts NRSER.indent("VERSION: #{ RUBY_VERSION }")
-      f.puts NRSER.indent("PATH: #{ RbConfig.ruby }")
+      f.puts indent.("VERSION: #{ RUBY_VERSION }")
+      f.puts indent.("PATH: #{ RbConfig.ruby }")
+      
+      f.puts "\nENV:\n"
+      ENV.sort.each {|name, value|
+        f.puts indent.("#{ name }: #{ value.inspect }")
+      }
     }
     
     print JSON.dump({
@@ -89,6 +108,7 @@ def main
       'exception' => formatted,
     })
   end
-end
+end # main
 
-main if __FILE__ == $0
+# Execute when run as executable
+main if __FILE__ == $0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qb
 version: !ruby/object:Gem::Version
-  version: 0.1.76
+  version: 0.1.77
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2017-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -188,6 +188,7 @@ files:
 - lib/qb/role.rb
 - lib/qb/role/errors.rb
 - lib/qb/util.rb
+- lib/qb/util/docker_mixin.rb
 - lib/qb/util/stdio.rb
 - lib/qb/version.rb
 - library/git_mkdir.py