qb 0.3.8 → 0.3.9

data/lib/qb/role.rb

@@ -403,28 +403,40 @@ class QB::Role
   end
   
   
-  # @todo This was gonna be something at some point, but didn't get done.
+  # Do our best to figure out a role name from a path (that might not exist).
   # 
-  def self.guess_role_name dest
-    raise "TODO: Not implemented!!!"
-    
-    path = QB::Util.resolve dest
+  # We needs this for when we're creating a role.
+  # 
+  # @param [String | Pathname] path
+  #   
+  # 
+  # @return [String]
+  # 
+  def self.default_role_name path
+    resolved_path = QB::Util.resolve path
     
-    search_dirs = search_path.find_all { |pathname|
-      path.fnmatch?( pathname / '**' )
+    # Find the first directory in the search path that contains the path,
+    # if any do.
+    # 
+    # It *could* be in more than one in funky situations like overlapping 
+    # search paths or link silliness, but that doesn't matter - we consider 
+    # the first place we find it to be the relevant once, since the search
+    # path is most-important-first.
+    # 
+    search_dir = search_path.find { |pathname|
+      resolved_path.fnmatch? ( pathname / '**' ).to_s
     }
     
-    case search_dirs.length
-    when 0
+    if search_dir.nil?
       # It's not in any of the search directories
       # 
       # If it has 'roles' as a segment than use what's after the last occurrence
       # of that (unless there isn't anything).
       # 
-      segments = path.to_s.split File::SEPARATOR
+      segments = resolved_path.to_s.split File::SEPARATOR
       
       if index = segments.rindex( 'roles' )
-        name_segs = segments[index..-1]
+        name_segs = segments[( index + 1 )..( -1 )]
         
         unless name_segs.empty?
           return File.join name_segs
@@ -432,16 +444,15 @@ class QB::Role
       end
       
       # Ok, that didn't work... just return the basename I guess...
-      File.basename path
-      
-    when 1
-      
-    else
-      # Multiple matches?!?!?
-      
+      return File.basename resolved_path
       
     end
-  end # #guess_role_name
+    
+    # it's in the search path, return the relative path from the containing
+    # search dir to the resolved path (string version of it).
+    resolved_path.relative_path_from( search_dir ).to_s
+
+  end # #default_role_name
   
   
   # Instance Attributes
@@ -871,20 +882,53 @@ class QB::Role
   end
   
   
-  # Get the {Gem::Requirement} parse of the `qb_requirement` key in
-  # {#meta} (if it is defined), which specifies the required version of 
-  # `qb` for the role.
+  # Parsed tree structure of version requirements of the role from the 
+  # `requirements` value in the QB meta data.
   # 
-  # @return [Gem::Requirement, nil]
-  #   The requirement if `required_qb_version` key is in {#meta}, else `nil`.
+  # @return [Hash]
+  #   Tree where the leaves are {Gem::Requirement}.
   # 
-  def qb_requirement
-    if  meta['requirements'] &&
-        meta['requirements']['gems'] &&
-        meta['requirements']['gems']['qb']
-      Gem::Requirement.new meta['requirements']['gems']['qb']
+  def requirements
+    @requirements ||= NRSER.map_leaves(
+      meta_or 'requirements', {'gems' => {}}
+    ) { |key_path, req_str|
+      Gem::Requirement.new req_str
+    }
+  end # #requirements
+  
+  
+  # Check the role's requirements.
+  # 
+  # @return [nil]
+  # 
+  # @raise [QB::AnsibleVersionError]
+  #   If the version of Ansible found does not satisfy the role's requirements.
+  # 
+  # @raise [QB::QBVersionError]
+  #   If the the version of QB we're running does not satisfy the role's 
+  #   requirements.
+  # 
+  def check_requirements
+    if ansible_req = requirements['ansible']
+      unless ansible_req.satisfied_by? QB.ansible_version
+        raise QB::AnsibleVersionError.squished <<-END
+          QB #{ QB::VERSION } requires Ansible #{ ansible_req },
+          found version #{ QB.ansible_version  } at #{ `which ansible` }
+        END
+      end
     end
-  end
+    
+    if qb_req = requirements.dig( 'gems', 'qb' )
+      unless qb_req.satisfied_by? QB.gem_version
+        raise QB::QBVersionError.squished <<-END
+          Role #{ self } requires QB #{ qb_req },
+          using QB #{ QB.gem_version } from #{ QB::ROOT }.
+        END
+      end
+    end
+    
+    nil
+  end # #check_requirements
   
   
   # Language Inter-Op

data/lib/qb/util.rb

@@ -1,3 +1,4 @@
+require_relative './util/logging'
 require_relative './util/stdio'
 require_relative './util/interop'
 require_relative './util/bundler'
@@ -23,10 +24,6 @@ module QB
       
       full_string_words = words full_string
       
-      QB.debug "HERE",
-        input_words: input_words,
-        full_string_words: full_string_words
-      
       full_string_words.each_with_index {|word, start_index|
         # compute the end index in full_string_words
         end_index = start_index + input_words.length - 1

data/lib/qb/util/docker_mixin.rb

@@ -4,14 +4,42 @@ module QB
 module Util
 
 # Mixin to help working with Docker.
-module DockerMixin 
+module DockerMixin
+  
+  # Character limit for Docker image tags.
+  # 
+  # @return [Fixnum]
+  # 
   DOCKER_TAG_MAX_CHARACTERS = 128
+  
 
-  # Regexp to validate strings as Docker tags.
+  # Regexp to validate strings as Docker tags:
+  # 
+  # 1.  Must start with an ASCII alpha-numeric - `A-Z`, `a-z`, `0-9`.
+  #     
+  # 2.  The rest of the characters can be:
+  #     
+  #     1.  `A-Z`
+  #     2.  `a-z`
+  #     3.  `_`
+  #     4.  `.`
+  #     5.  `-`
+  #     
+  #     Note that it *can not* include `+`, so [Semver][] strings with
+  #     build info after the `+` are not legal.
+  #         
+  # 3.  Must be {QB::Util::DockerMixin::DOCKER_TAG_MAX_CHARACTERS} in length
+  #     or less.
+  # 
+  # [Semver]: https://semver.org/
+  # 
+  # @return [Regexp]
+  # 
   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

data/lib/qb/util/interop.rb

@@ -6,8 +6,24 @@ module QB
 module Util 
 
 module Interop
+  include SemanticLogger::Loggable
+  
   class << self
     
+    def send_to_instance data, method_name, *args
+      logger.debug "Starting #send_to_instance..."
+      
+      obj = if  data.is_a?( Hash ) &&
+                data.key?( NRSER::Meta::Props::DEFAULT_CLASS_KEY )
+        NRSER::Meta::Props.UNSAFE_load_instance_from_data data
+      else
+        data
+      end
+      
+      obj.send method_name, *args
+    end # #send_to_instance
+    
+    
     # @todo Document receive method.
     # 
     # @param [type] arg_name
@@ -16,28 +32,73 @@ module Interop
     # @return [return_type]
     #   @todo Document return value.
     # 
-    def receive      
+    def send_to_const name, method_name, *args
+      logger.debug "Starting #send_to_const..."
+      
+      const = name.to_const
+      
+      logger.debug "Found constant", const: const
+      
+      const.public_send method_name, *args
+      
+    end # #receive
+    
+    
+    # @todo Document receive method.
+    # 
+    # @param [type] arg_name
+    #   @todo Add name param description.
+    # 
+    # @return [return_type]
+    #   @todo Document return value.
+    # 
+    def receive
+      logger.debug "Starting #receive..."
+      
       # method body
       yaml = $stdin.read
       
       payload = YAML.load yaml
       
-      data = payload.fetch 'data'
+      logger.debug "Parsed",
+        payload: payload
+      
+      # data = payload.fetch 'data'
       method = payload.fetch 'method'
       args = payload['args'] || []
       kwds = payload['kwds'] || {}
       args << kwds.symbolize_keys unless kwds.empty?
       
-      obj = if data.is_a?(Hash) && data.key?(NRSER::Meta::Props::CLASS_KEY)
-        NRSER::Meta::Props.from_data data
+      result = if payload['data']
+        send_to_instance payload['data'], method, *args
+        
+      elsif payload['const']
+        send_to_const payload['const'], method, *args
+        
       else
-        data
+        raise ArgumentError.new binding.erb <<-ERB
+          Expected payload to have 'data' or 'const' keys, neither found:
+          
+          Payload:
+          
+              <%= payload.pretty_inspect %>
+          
+          Input YAML:
+          
+              <%= yaml %>
+          
+        ERB
       end
       
-      result = obj.send method, *args
+      logger.debug "send succeeded", result: result
+      
+      yaml = result.to_yaml # don't work: sort_keys: true, use_header: true
+      
+      logger.debug "writing YAML:\n\n#{ yaml }"
       
-      $stdout.write result.to_yaml
+      $stdout.write yaml
       
+      logger.debug "done."
     end # #receive
     
   end # class << self

data/lib/qb/util/logging.rb

@@ -0,0 +1,215 @@
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+require 'awesome_print'
+require 'semantic_logger'
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+
+# Refinements
+# =======================================================================
+
+
+# Declarations
+# =======================================================================
+
+module QB; end
+module QB::Util; end
+
+
+# Definitions
+# =======================================================================
+
+# Utility methods to setup logging with [semantic_logger][].
+# 
+# [semantic_logger]: http://rocketjob.github.io/semantic_logger/
+# 
+module QB::Util::Logging
+  include SemanticLogger::Loggable
+  
+  
+  # @todo document Formatters module.
+  module Formatters
+    
+    # Custom tweaked color formatter (for CLI output).
+    # 
+    # -   Turns on multiline output in Awesome Print by default.
+    # 
+    class Color < SemanticLogger::Formatters::Color
+      
+      # Constants
+      # ======================================================================
+      
+      
+      # Class Methods
+      # ======================================================================
+      
+      
+      # Attributes
+      # ======================================================================
+      
+      
+      # Constructor
+      # ======================================================================
+      
+      # Instantiate a new `ColorFormatter`.
+      def initialize **options
+        super ap: { multiline: true },
+              color_map: SemanticLogger::Formatters::Color::ColorMap.new(
+                debug: SemanticLogger::AnsiColors::MAGENTA,
+              ),
+              **options
+      end # #initialize
+      
+      
+      # Instance Methods
+      # ======================================================================
+      
+      
+      # Upcase the log level.
+      # 
+      # @return [String]
+      # 
+      def level
+        "#{ color }#{ log.level.upcase }#{ color_map.clear }"
+      end
+      
+      
+      # Create the log entry text. Overridden to customize appearance - 
+      # generally reduce amount of info and put payload on it's own line.
+      # 
+      # We need to replace *two* super functions, the first being 
+      # [SemanticLogger::Formatters::Color#call][]:
+      # 
+      #     def call(log, logger)
+      #       self.color = color_map[log.level]
+      #       super(log, logger)
+      #     end
+      # 
+      # [SemanticLogger::Formatters::Color#call]: https://github.com/rocketjob/semantic_logger/blob/v4.2.0/lib/semantic_logger/formatters/color.rb#L98
+      # 
+      # which doesn't do all too much, and the next being it's super-method,
+      # [SemanticLogger::Formatters::Default#call][]:
+      #     
+      #     # Default text log format
+      #     #  Generates logs of the form:
+      #     #    2011-07-19 14:36:15.660235 D [1149:ScriptThreadProcess] Rails -- Hello World
+      #     def call(log, logger)
+      #       self.log    = log
+      #       self.logger = logger
+      #     
+      #       [time, level, process_info, tags, named_tags, duration, name, message, payload, exception].compact.join(' ')
+      #     end
+      # 
+      # [SemanticLogger::Formatters::Default#call]: https://github.com/rocketjob/semantic_logger/blob/v4.2.0/lib/semantic_logger/formatters/default.rb#L64
+      # 
+      # which does most the real assembly.
+      # 
+      # @param [SemanticLogger::Log] log
+      #   The log entry to format.
+      #   
+      #   See [SemanticLogger::Log](https://github.com/rocketjob/semantic_logger/blob/v4.2.0/lib/semantic_logger/log.rb)
+      # 
+      # @param [SemanticLogger::Logger] logger
+      #   The logger doing the logging (pretty sure, haven't checked).
+      #   
+      #   See [SemanticLogger::Logger](https://github.com/rocketjob/semantic_logger/blob/v4.2.0/lib/semantic_logger/logger.rb)
+      # 
+      # @return [return_type]
+      #   @todo Document return value.
+      # 
+      def call log, logger
+        # SemanticLogger::Formatters::Color code
+        self.color = color_map[log.level]
+        
+        # SemanticLogger::Formatters::Default code
+        self.log    = log
+        self.logger = logger
+        
+        [
+          # time, annoyingly noisy and don't really need for local CLI app
+          level,
+          process_info,
+          tags,
+          named_tags,
+          duration,
+          name,
+        ].compact.join( ' ' ) + 
+        "\n" +
+        [
+          message,
+          payload,
+          exception,
+        ].compact.join(' ') + 
+        "\n" # I like extra newline to space shit out
+        
+      end # #call
+      
+      
+    end # class Color
+    
+  end # module Formatters
+  
+  
+
+  
+  # Module (Class) Methods
+  # =====================================================================
+  
+  # Setup logging.
+  # 
+  # @param [type] arg_name
+  #   @todo Add name param description.
+  # 
+  # @return [return_type]
+  #   @todo Document return value.
+  # 
+  def self.setup level: nil
+    if level.nil?
+      if ENV['QB_LOG_LEVEL']
+        level = ENV['QB_LOG_LEVEL'].to_sym
+      else
+        level = :info
+      end
+    end
+    
+    SemanticLogger.default_level = level
+    
+    @appender ||= SemanticLogger.add_appender(
+      io: $stderr,
+      formatter: Formatters::Color.new,
+    )
+    
+    # Set ENV vars (that Ansible modules will have access to!)
+    
+    ENV['QB_LOG_LEVEL'] = level.to_s
+    
+    if level == :debug
+      ENV['QB_DEBUG'] = 'true'
+      logger.debug "debug logging is ON"
+    else
+      ENV.delete 'QB_DEBUG'
+    end
+    
+    nil
+  end # .setup
+  
+  
+  def self.appender
+    @appender
+  end
+  
+  
+end # module QB::Util::Logging
+
+
+
+# Post-Processing
+# =======================================================================