qb 0.1.88 → 0.3.1

data/lib/qb/role.rb

@@ -12,38 +12,136 @@ module QB
   # 
   # 
   class Role
-    # attrs
-    # =======================================================================
     
-    # @!attribute [r] path
-    #   @return [Pathname]
-    #     location of the role directory.
-    attr_reader :path
+    # Constants
+    # =====================================================================
     
-    # @!attribute [r] name
-    #   @return [String]
-    #     the role's ansible "name", which is it's directory name.
-    attr_reader :name
-    
-    # @!attribute [r] display_path
+    # Array of string paths to directories to search for roles or paths to 
+    # `ansible.cfg` files to look for an extract role paths from.
     # 
-    # the path to the role that we display. we only show the directory name
-    # for QB roles, and use {QB::Util.compact_path} to show `.` and `~` for
-    # paths relative to the current directory and home directory, respectively.
+    # For the moment at least you can just mutate this value like you would
+    # `$LOAD_PATH`:
     # 
-    #   @return [Pathname]
-    attr_reader :display_path
+    #     QB::Role::PATH.unshift '~/where/some/roles/be'
+    #     QB::Role::PATH.unshift '~/my/ansible.cfg'
+    # 
+    # The paths are searched from first to last.
+    # 
+    # **WARNING**
+    # 
+    #   Search is **deep** - don't point this at large directory trees and 
+    #   expect any sort of reasonable performance (any directory that 
+    #   contains `node_modules` is usually a terrible idea for instance).
+    # 
+    BUILTIN_PATH = [
+      
+      # Development Paths
+      # =================
+      # 
+      # These come first because:
+      # 
+      # 1.  They are working dir-local.
+      # 
+      # 2.  They should only be present in local development, and should be
+      #     capable of overriding roles in other local directories to allow
+      #     custom development behavior (the same way `./dev/bin` is put in
+      #     front or `./bin`).
+      # 
+      
+      # Role paths declared in ./dev/ansible.cfg, if it exists.
+      File.join('.', 'dev', 'ansible.cfg'),
+      
+      # Roles in ./dev/roles
+      File.join('.', 'dev', 'roles'),
+      
+      
+      # Working Directory Paths
+      # =======================
+      # 
+      # Next up, `ansible.cfg` and `roles` directory in the working dir.
+      # Makes sense, right?
+      # 
+      
+      # ./ansible.cfg
+      File.join('.', 'ansible.cfg'),
+      
+      # ./roles
+      File.join('.', 'roles'),
+      
+      
+      # Working Directory-Local Ansible Directory
+      # =========================================
+      # 
+      # `ansible.cfg` and `roles` in a `./ansible` directory, making a common
+      # place to put Ansible stuff in an project accessible when running from
+      # the project root.
+      # 
+      
+      # ./ansible/ansible.cfg
+      File.join('.', 'ansible', 'ansible.cfg'),
+      
+      # ./ansible/roles
+      File.join('.', 'ansible', 'roles'),
+      
+      # TODO  Git repo root relative?
+      #       Some sort of flag file for a find-up?
+      #       System Ansible locations?
+      
+      
+      # QB Gem Role Directories
+      # =======================
+      # 
+      # Last, but far from least, paths provided by the QB Gem to the user's
+      # QB role install location and the roles that come built-in to the gem.
+      
+      QB::USER_ROLES_DIR,
+      
+      QB::GEM_ROLES_DIR,
+    ].freeze
     
-    # @!attribute [r] meta_path
-    #   @return [String, nil]
-    #     the path qb metadata was load from. `nil` if it's never been loaded
-    #     or doesn't exist.
-    attr_reader :meta_path
+    
+    # Array of string paths to directories to search for roles or paths to 
+    # `ansible.cfg` files to look for an extract role paths from.
+    # 
+    # Value is a duplicate of the frozen {QB::Role::BUILTIN_PATH}. You can
+    # reset to those values at any time via {QB::Role.reset_path!}.
+    # 
+    # For the moment at least you can just mutate this value like you would
+    # `$LOAD_PATH`:
+    # 
+    #     QB::Role::PATH.unshift '~/where/some/roles/be'
+    #     QB::Role::PATH.unshift '~/my/ansible.cfg'
+    # 
+    # The paths are searched from first to last.
+    # 
+    # **WARNING**
+    # 
+    #   Search is **deep** - don't point this at large directory trees and 
+    #   expect any sort of reasonable performance (any directory that 
+    #   contains `node_modules` is usually a terrible idea for instance).
+    # 
+    PATH = BUILTIN_PATH.dup
 
     
-    # static role utils
+    # Class Methods
     # =======================================================================
     
+    
+    # Reset {QB::Role::PATH} to the original built-in values in 
+    # {QB::Role::BUILTIN_PATH}.
+    # 
+    # Created for testing but might be useful elsewhere as well.
+    # 
+    # @return [Array<String>]
+    #   The reset {QB::Role::PATH}.
+    # 
+    def self.reset_path!
+      PATH.clear
+      BUILTIN_PATH.each { |path| PATH << path }
+      PATH
+    end # .reset_path!
+    
+    
     # true if pathname is a QB role directory.
     def self.role_dir? pathname
       # must be a directory
@@ -52,14 +150,15 @@ module QB
       ['qb.yml', 'qb'].any? {|filename| pathname.join('meta', filename).file?}
     end
     
-    # get role paths from ansible.cfg if it exists in a directory.
+    # Get role paths from ansible.cfg if it exists in a directory.
     # 
     # @param dir [Pathname] directory to look for ansible.cfg in.
     # 
-    # @return [Array<String>] role paths
+    # @return [Array<String>]
+    #   Absolute role paths.
     # 
-    def self.cfg_roles_path dir
-      path = dir.join 'ansible.cfg'
+    def self.cfg_roles_paths path
+      path = File.join(path, 'ansible.cfg') unless File.basename(path) == 'ansible.cfg'
       
       if path.file?
         config = ParseConfig.new path.to_s
@@ -89,14 +188,8 @@ module QB
     # 2.  paths specific to the current directory:
     #     a.  paths specified in ./ansible.cfg (if it exists)
     #     b.  ./roles
-    #     c.  ./roles/tmp
-    #         -   used for roles that are downloaded but shouldn't be included
-    #             in source control.
     #     d.  paths specified in ./ansible/ansible.cfg (if it exists)
     #     e.  ./ansible/roles
-    #     f.  ./ansible/roles/tmp
-    #         -   used for roles that are downloaded but shouldn't be included
-    #             in source control.
     #     g.  paths specified in ./dev/ansible.cfg (if it exists)
     #     h.  ./dev/roles
     #     i.  ./dev/roles/tmp
@@ -108,17 +201,18 @@ module QB
     #   places to look for role dirs.
     # 
     def self.search_path
-      [
-        QB::USER_ROLES_DIR,
-        QB::GEM_ROLES_DIR
-      ] + [
-        QB::Util.resolve,
-        QB::Util.resolve('ansible'),
-        QB::Util.resolve('dev'),
-      ].map {|dir|
-        roles_paths dir
-      }.
-      flatten
+      QB::Role::PATH.
+        map { |path|
+          if QB::Ansible::ConfigFile.file_path?(path)
+            if File.file?(path)
+              QB::Ansible::ConfigFile.new(path).defaults.roles_path
+            end
+          else
+            QB::Util.resolve path
+          end
+        }.
+        flatten.
+        reject(&:nil?)
     end
     
     # array of QB::Role found in search path.
@@ -129,12 +223,14 @@ module QB
           search_dir.directory?
         }.
         map {|search_dir|
-          # grab all the child directories that are role directories
-          search_dir.children.select {|child| role_dir? child }
+          Pathname.glob(search_dir.join '**', 'meta', 'qb.yml').
+            map {|meta_path|
+              [meta_path.dirname.dirname, search_dir: search_dir] 
+            }
         }.
-        flatten.
-        map {|role_dir|
-          QB::Role.new role_dir
+        flatten(1).
+        map {|args|
+          QB::Role.new *args
         }.
         uniq
     end
@@ -170,41 +266,47 @@ module QB
       separator_variations = [
         input,
         input.gsub('-', '_'),
-        input.gsub('_', '_'),
+        input.gsub('_', '-'),
       ]
       
-      separator_variations.each {|variation|
-        available.each {|role|
+      separator_variations.each { |variation|
+        available.each { |role|
           # exact match to full name
           return [role] if role.name == variation
-        }.each {|role|
+        }.each { |role|
           # exact match without the namespace prefix ('qb.' or similar)
           return [role] if role.namespaceless == variation
         }  
       }
       
       # see if we prefix match any full names
-      name_prefix_matches = available.select {|role|
-        role.name.start_with? input
+      separator_variations.each { |variation|
+        name_prefix_matches = available.select { |role|
+          role.name.start_with? variation
+        }
+        return name_prefix_matches unless name_prefix_matches.empty?
       }
-      return name_prefix_matches unless name_prefix_matches.empty?
       
       # see if we prefix match any name
-      namespaceless_prefix_matches = available.select {|role|
-        role.namespaceless.start_with? input
+      separator_variations.each { |variation|
+        namespaceless_prefix_matches = available.select { |role|
+          role.namespaceless.start_with? variation
+        }
+        unless namespaceless_prefix_matches.empty?
+          return namespaceless_prefix_matches 
+        end
       }
-      unless namespaceless_prefix_matches.empty?
-        return namespaceless_prefix_matches 
-      end
       
       # see if we prefix match any display paths
-      path_prefix_matches = available.select {|role|
-        role.display_path.start_with? input
+      separator_variations.each { |variation|
+        path_prefix_matches = available.select { |role|
+          role.display_path.start_with? variation
+        }
+        return path_prefix_matches unless path_prefix_matches.empty?
       }
-      return path_prefix_matches unless path_prefix_matches.empty?
       
-      # see if we word match any display` paths
-      name_word_matches = available.select {|role|
+      # see if we word match any display paths
+      name_word_matches = available.select { |role|
         QB::Util.words_start_with? role.display_path.to_s, input
       }
       return name_word_matches unless name_word_matches.empty?
@@ -287,14 +389,53 @@ module QB
       end
     end
     
-    # instance methods
+    
+    # Attributes
+    # =======================================================================
+    
+    # @!attribute [r] path
+    #   @return [Pathname]
+    #     location of the role directory.
+    attr_reader :path
+    
+    
+    # @!attribute [r] name
+    #   @return [String]
+    #     the role's ansible "name", which is it's directory name.
+    attr_reader :name
+    
+    
+    # @!attribute [r] display_path
+    # 
+    # the path to the role that we display. we only show the directory name
+    # for QB roles, and use {QB::Util.compact_path} to show `.` and `~` for
+    # paths relative to the current directory and home directory, respectively.
+    # 
+    #   @return [Pathname]
+    attr_reader :display_path
+    
+    
+    # @!attribute [r] meta_path
+    #   @return [String, nil]
+    #     the path qb metadata was load from. `nil` if it's never been loaded
+    #     or doesn't exist.
+    attr_reader :meta_path
+    
+    
+    # Constructor
     # =======================================================================
     
+    # Instantiate a Role.
     # 
     # @param [String|Pathname] path
     #   location of the role directory
     # 
-    def initialize path
+    # @param [nil, Pathname] search_dir
+    #   Directory in {QB::Role.search_path} that the role was found in.
+    #   Used to figure out it's name correctly when using directory-structure
+    #   namespacing.
+    # 
+    def initialize path, search_dir: nil
       @path = if path.is_a?(Pathname) then path else Pathname.new(path) end
       
       # check it...
@@ -316,23 +457,36 @@ module QB
         raise Errno::ENOENT.new "#{ @path.join('meta').to_s }/[qb|qb.yml]"
       end
       
-      @name = @path.to_s.split(File::SEPARATOR).last
-    end
+      
+      if search_dir.nil?
+        @name = @path.to_s.split(File::SEPARATOR).last
+      else
+        @name = @path.relative_path_from(search_dir).to_s
+      end
+    end # #initialize
+    
+    
+    # Instance Methods
+    # =====================================================================
     
     def to_s
       @display_path.to_s
     end
     
     def namespace
-      if @name.include? '.'
-        @name.split('.').first
-      else
+      *namespace_segments, last = @name.split File::Separator
+      
+      namespace_segments << last.split('.').first if last.include?('.')
+       
+      if namespace_segments.empty?
         nil
+      else
+        File.join *namespace_segments
       end
     end
     
     def namespaceless
-      @name.split('.', 2).last
+      File.basename(@name).split('.', 2).last
     end
     
     def options_key

data/lib/qb/util.rb

@@ -1,15 +1,15 @@
 require_relative './util/stdio'
 require_relative './util/interop'
+require_relative './util/bundler'
 
 require 'nrser'
-
 using NRSER
 
 module QB
   module Util
     # split a string into 'words' for word-based matching
     def self.words string
-      string.split(/[\W_-]+/).reject {|w| w.empty?}
+      string.split(/[\W_\-\/]+/).reject {|w| w.empty?}
     end # .words
     
     # see if words from an input match words 

data/lib/qb/util/bundler.rb

@@ -0,0 +1,56 @@
+module QB; end
+module QB::Util; end
+
+module QB::Util::Bundler 
+  # needed for to clean the env if using bundler (like in dev).
+  # 
+  # this is because the ansible gem module doesn't work right with the bundler
+  # env vars set, so we need to remove them, but when running in dev we want
+  # modules written in ruby like nrser.state_mate's `state` script to have
+  # access to them so it can fire up bundler and get the right libraries.
+  # 
+  # to accomplish this, we detect Bundler, and when it's present we copy the
+  # bundler-related env vars (which i found by looking at 
+  # https://github.com/bundler/bundler/blob/master/lib/bundler.rb#L257)
+  # into a hash to pass around the env sanitization, then copy them into
+  # corresponding 'QB_DEV_ENV_<NAME>' vars that modules can restore.
+  # 
+  # we also set a 'QB_DEV_ENV=true' env var for modules to easily detect that
+  # we're running in dev and restore the variables.
+  # 
+  def self.with_clean_env &block
+    if defined? ::Bundler
+      # copy the Bundler env vars into a hash
+      dev_env = ENV.select {|k, v|
+        k.start_with?("BUNDLE_") ||
+        [
+          'GEM_HOME',
+          'GEM_PATH',
+          'MANPATH',
+          'RUBYOPT',
+          'RUBYLIB',
+        ].include?(k)
+      }
+      
+      qb_env = ENV.select {|k, v| k.start_with? 'QB_'}
+      
+      ::Bundler.with_clean_env do
+        # now that we're in a clean env, copy the Bundler env vars into 
+        # 'QB_DEV_ENV_<NAME>' vars.
+        dev_env.each {|k, v| ENV["QB_DEV_ENV_#{ k }"] = v}
+        
+        # set the flag that will be used by modules to know to restore the 
+        # variables
+        ENV['QB_DEV_ENV'] = 'true'
+        
+        qb_env.each {|k, v| ENV[k] = v}
+        
+        # invoke the block
+        block.call
+      end
+    else
+      # bundler isn't loaded, so no env var silliness to deal with 
+      block.call
+    end
+  end # .with_clean_env
+end # module QB::Util::Bundler