qb 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d706144a98f2797e7a3e769004fed6890b1b704f
-  data.tar.gz: d942bae9e4910084d0a347c86f38b626710fd1e3
+  metadata.gz: 80033c6e7eace5353695c0cf1239a972bff0c76f
+  data.tar.gz: 15a2d8f53620eba3538be272165fdda0eb11f51f
 SHA512:
-  metadata.gz: 09217bdb8cfc0226c872a77f4c36434bf03e5631ab4896161cd85cd89dfdc09e12043a896628068ac366d48861b74bba0933d246cda98c2ee7684e7933193028
-  data.tar.gz: 3d1a3cd57388a88a7d707096297a6c0e195df62b1de7428dbc8f3be62a70f4598f0d82d6ea505c2812ccad190a59947b5cd216bb8b3da1e11c1a1a539ef29d32
+  metadata.gz: 0d317ec3cade70ada821b6952efdf28aca34a8a6ce5b8da308e50270509717326422b7c19a3d4625aeb3ce6037cb095a4429b6ea390aaff36ebd27bf984b7391
+  data.tar.gz: 306fdab6c084efa4351eafdc4541f3f0e0b9e1983ce7153f8f471218aa4fb827abcbd150e3b4e0dd95b1b5fb6523e63ea60f5c19f2ee52e49b348a529a30bbd9

data/README.md

@@ -1,4 +1,43 @@
-qb
-==
+# qb #
 
 qb is all about projects. named after everyone's favorite projects.
+
+## meta/qb.yml ##
+
+if this file exists in a role `qb` sees it will make that role available.
+
+the contents of this file allow you to configure how `qb` uses the role.
+
+### var_prefix ###
+
+declare prefix to be added to variable names from the command line for
+use in the role.
+
+because all variables are pretty much global in ansible, you really want to prefix all your variables names to try and achieve uniqueness. the way i've been doing that is to prefix them with the 'namespaceless' part of the role name.
+
+for example, if you have a role named `qb.project`, the 'namespace' would be `qb` and the 'namespaceless' part would be `project`. it has been my convention to then name the role variables `project_*`, like `project_owner`, `project_name`, etc..
+
+`var_prefix` therefore defaults to the 'namespaceless' part of the role name, so that a call like
+
+    qb qb.project --owner=nrser --name=blah
+
+will pass variables
+
+    project_owner: "nrser"
+    project_name: "blah"
+
+to the `qb.project` role.
+
+however, this setting allows you to specify an alternative prefix. 
+
+if this is set to `null` or any varient of `false` the default will be used.
+
+### default_dir ###
+
+every invocation of `qb` must have a directory it's targeting where it will place a `.qb-options.yml` if applicable. this directory is passed to the role as the `dir` option
+
+this is often the project's root folder, and can sometimes be assembled from the values of other parameters.
+
+### vars ###
+
+TODO

data/ansible.cfg

@@ -1,5 +1,5 @@
 [defaults]
 
-roles_path = ./tmp/roles:./roles
-
+# roles_path = ./tmp/roles:./roles
 filter_plugins = ./roles/qb.gem/filter_plugins
+retry_files_enabled = False

data/bin/qb

@@ -1,4 +1,13 @@
 #!/usr/bin/env ruby
 # stub instead of `bundle exec qb ...`
-require 'bundler/setup'
-load 'exe/qb'
+
+# so you know you're using the local repo version (vs an installed gem)...
+puts "*** LOADING REPO VERSION ***\n\n"
+
+root = File.dirname(File.realpath(File.join(__FILE__, '..')))
+
+Dir.chdir root do
+  require 'bundler/setup'
+end
+
+load File.join(root, 'exe/qb')

data/dev/ansible.cfg

@@ -2,3 +2,4 @@
 
 roles_path = ./roles/tmp:./roles
 inventory = ./hosts
+retry_files_enabled = False

data/dev/requirements.yml

@@ -1,12 +1,12 @@
 - name: nrser.nodenv
   src: https://github.com/nrser/ansible-nrser.nodenv.git
-  version: v0.1.0
+  version: v0.1.2
 - name: nrser.rbenv_gem
   src: https://github.com/nrser/ansible-nrser.rbenv_gem.git
-  version: v0.1.1
+  version: v0.1.3
 - name: nrser.rbenv
   src: https://github.com/nrser/ansible-nrser.rbenv.git
-  version: v0.1.0
+  version: v0.1.2
 - name: nrser.dev_setup
   src: https://github.com/nrser/ansible-nrser.dev_setup.git
-  version: v0.1.1
+  version: v0.1.3

data/dev/setup.yml

@@ -17,6 +17,18 @@
       
     - owner: nrser
       name: ansible-nrser.dev_setup
+    
+    - owner: nrser
+      name: ansible-nrser.rbenv_gem
+    
+    - owner: nrser
+      name: cmds
+    
+    - owner: nrser
+      name: ansible-nrser.nodenv
+    
+    - owner: nrser
+      name: ansible-nrser.rbenv
 
     # sources that are used for reference only
     dev_setup_refs:

data/exe/qb

@@ -14,8 +14,8 @@ require 'qb'
 # constants
 # =========
 
-ROOT = (Pathname.new(__FILE__).dirname + '..').expand_path
-ROLES_DIR = ROOT + 'roles'
+ROOT = QB::ROOT
+ROLES_DIR = QB::ROLES_DIR
 ROLES = Pathname.glob(ROLES_DIR + 'qb.*').map {|path| path.basename.to_s}
 DEBUG_ARGS = ['-d', '--debug']
 TMP_DIR = ROOT + 'tmp'
@@ -23,8 +23,6 @@ TMP_DIR = ROOT + 'tmp'
 # globals
 # =======
 
-$debug = false
-
 # @api util
 # *pure*
 #
@@ -39,30 +37,21 @@ def format msg, dump = {}
   msg
 end
 
-def debug *args
-  return unless $debug
-  
-  msg, values = case args.length
-  when 0
-    raise ArgumentError, "debug needs at least one argument"
-  when 1
-    if args[0].is_a? Hash
-      ['', args[0]]
-    else
-      [args[0], {}]
-    end
-  when 2
-    [args[0], args[1]]
-  else
-    raise ArgumentError, "debug needs at least one argument"
-  end
+def role? pathname
+  pathname.directory? && pathname.join('meta', 'qb.yml').file?
+end
+
+def role_matches
   
-  $stderr.puts("DEBUG " + format(msg, values))
+end
+
+def debug *args
+  QB.debug *args
 end
 
 def set_debug! args
   if DEBUG_ARGS.any? {|arg| args.include? arg}
-    $debug = true
+    QB.debug = true
     debug "ON"
     DEBUG_ARGS.each {|arg| args.delete arg}
   end
@@ -84,7 +73,8 @@ def parse! role_arg, var_prefix, vars, defaults, args
   options = {}
   
   opt_parser = OptionParser.new do |opts|
-    opts.banner = "qb #{ role_arg } [OPTIONS]#{ positional_banner }"
+    # opts.banner = "qb #{ role_arg } [OPTIONS]#{ positional_banner }"
+    opts.banner = "qb #{ role_arg } [OPTIONS] DIRECTORY"
     
     vars.each do |var|
       arg_name = var.fetch 'name'
@@ -159,6 +149,15 @@ def parse! role_arg, var_prefix, vars, defaults, args
   options
 end
 
+# needed for to clean the env if using bundler (like in dev)
+def with_clean_env &block
+  if defined? Bundler
+    Bundler.with_clean_env &block
+  else
+    block.call
+  end
+end
+
 def help
   puts <<-END
 version: #{ QB::VERSION }
@@ -172,7 +171,7 @@ use `qb ROLE -h` for role options.
 available roles:
 
 END
-  puts ROLES
+  puts QB.available_roles
   puts
   exit 1
 end
@@ -186,9 +185,7 @@ def main args
   
   help if role_arg.nil? || ['-h', '--help', 'help'].include?(role_arg)
   
-  matches = ROLES.select {|role|
-    role.include? role_arg
-  }
+  matches = QB.role_matches role_arg
   debug "role matches" => matches
   
   role = case matches.length
@@ -205,41 +202,32 @@ def main args
   end
   debug role: role
   
-  role_dir = ROLES_DIR + role
+  defaults_path = role.path + 'defaults' + 'main.yml'
+  defaults = if defaults_path.file?
+    YAML.load(defaults_path.read) || {}
+  else
+    {}
+  end
   
-  defaults = YAML.load (role_dir + 'defaults' + 'main.yml').read
-  meta = YAML.load (role_dir + 'meta' + 'main.yml').read
+  qb_meta = YAML.load((role.path + 'meta' + 'qb.yml').read) || {}
   
-  qb_info = meta['qb_info'] || {}
-  vars = qb_info['vars'] || []
-  var_prefix = qb_info['var_prefix'] || role.split('.').last
+  vars = qb_meta['vars'] || []
+  var_prefix = qb_meta['var_prefix'] || role.namespaceless
   
   options = parse! role_arg, var_prefix, vars, defaults, args
   
   debug options: options
   
+  cwd = Dir.getwd
+  
   # get the target dir
   dir = case args.length
   when 0
     # in this case, a dir has not been provided
     # 
-    # in some cases (like projects) the dir can be figured out from other
-    # variables. i created a hacky-ass way of dealing with this:
-    # 
-    # when the sole positional arg is missing, we look for a `qb/get_dir`
-    # executable in the role. if it exists, call it with the JSON encoded
-    # options passed over STDIN. if the execuable succeeds, the result is
-    # taken as dir.
+    # in some cases (like projects) the dir can be figured out in other ways:
     # 
-    get_dir_path = role_dir + 'qb' + 'get_dir'
-    
-    unless get_dir_path.exist?
-      raise "no dir argument provided and no qb/get_dir exe found"
-    end
-    
-    Cmds.chomp! get_dir_path.to_s do
-      JSON.dump options
-    end
+    QB.get_default_dir role, qb_meta, cwd, options
     
   when 1
     # there is a single positional arg, which is used as dir
@@ -247,7 +235,7 @@ def main args
     
   else
     # there are multiple positional args, which is not allowed
-    raise "can't supply more than one argument"
+    raise "can't supply more than one argument: #{ args.inspect }"
     
   end
   
@@ -270,16 +258,18 @@ def main args
     {}
   end
   
-  if saved_options.key? role
-    options = saved_options[role].merge options
+  if saved_options.key? role.options_key
+    options = saved_options[role.options_key].merge options
   end
   
-  playbook_role = {'role' => role}
+  playbook_role = {'role' => role.name}
   options.each do |arg_name, arg_value|
     playbook_role["#{ var_prefix }_#{ arg_name }"] = arg_value
   end
   
   playbook_role['dir'] = dir
+  playbook_role['qb_dir'] = dir
+  playbook_role['qb_cwd'] = cwd
   
   playbook = [
     {
@@ -303,21 +293,38 @@ def main args
     f.write YAML.dump(playbook)
   end
   
-  unless options.empty?
-    saved_options[role] = options
+  unless (
+    options.empty? ||
+    (qb_meta.key?('save_options') && qb_meta['save_options'] == false)
+  )
+    saved_options[role.options_key] = options
     FileUtils.mkdir_p saved_options_path.dirname unless saved_options_path.dirname.exist?
     saved_options_path.open('w') do |f|
       f.write YAML.dump(saved_options)
     end
   end
   
+  tmp_roles_path = QB::ROOT + 'tmp' + 'roles'
+  
+  ansible_roles_path = (
+    [tmp_roles_path] +
+    QB.role_dirs
+  ).join(':')
+  
   Dir.chdir ROOT do
     # install requirements
     unless (TMP_DIR + 'roles').directory?
-      Cmds.stream! "ansible-galaxy install --ignore-errors -r %s", [ROOT + 'requirements.yml']
+      with_clean_env do
+        Cmds.stream! "ANSIBLE_ROLES_PATH=<%= roles_path %> ansible-galaxy install --ignore-errors -r <%= req_path%>",
+          req_path: (ROOT + 'requirements.yml'),
+          roles_path: tmp_roles_path.to_s
+      end
+    end
+    with_clean_env do
+      Cmds.stream! "ANSIBLE_ROLES_PATH=<%= roles_path %> ansible-playbook <%= playbook_path %>", 
+        roles_path: ansible_roles_path,
+        playbook_path: playbook_path.to_s
     end
-    
-    Cmds.stream! "ansible-playbook %s", [playbook_path.to_s]
   end
 end
 

data/lib/qb.rb

@@ -1,5 +1,124 @@
+require 'nrser/extras'
+
 require "qb/version"
 
 module QB
-  # Your code goes here...
+  ROOT = (Pathname.new(__FILE__).dirname + '..').expand_path
+  ROLES_DIR = ROOT + 'roles'
+  
+  # TODO this should be in an instance that is run instead of module global
+  # hack for now
+  @@debug = false
+  
+  def self.debug= bool
+    @@debug = !!bool
+  end
+  
+  def self.debug *args
+    return unless @@debug
+    
+    msg, values = case args.length
+    when 0
+      raise ArgumentError, "debug needs at least one argument"
+    when 1
+      if args[0].is_a? Hash
+        ['', args[0]]
+      else
+        [args[0], {}]
+      end
+    when 2
+      [args[0], args[1]]
+    else
+      raise ArgumentError, "debug needs at least one argument"
+    end
+    
+    $stderr.puts("DEBUG " + format(msg, values))
+  end
+  
+  def self.role_dirs
+    [
+      ROLES_DIR,
+      Pathname.new(Dir.getwd).join('roles'),
+      Pathname.new(Dir.getwd).join('dev', 'roles'),
+      Pathname.new(Dir.getwd).join('dev', 'roles', 'tmp'),
+    ]
+  end
+  
+  def self.available_roles
+    role_dirs.
+      select {|role_dir|
+        role_dir.directory?
+      }.
+      map {|role_dir|
+        role_dir.children.select {|child| role? child }
+      }.
+      flatten.
+      uniq.
+      map {|role_dir|
+        QB::Role.new role_dir
+      }
+  end
+  
+  def self.role_matches input
+    available_roles.each {|role|
+      # exact match to relitive path
+      return [role] if role.rel_path.to_s == input
+    }.each {|role|
+      # exact match to full name
+      return [role] if role.name == input
+    }.each {|role|
+      # exact match without the namespace prefix ('qb.' or similar)
+      return [role] if role.namespaceless == input
+    }.select {|role|
+      # select any that have that string in them
+      role.rel_path.to_s.include? input
+    }
+  end
+  
+  def self.get_default_dir role, qb_meta, cwd, options
+    debug "get_default_dir",  role: role,
+                              qb_meta: qb_meta,
+                              cwd: cwd,
+                              options: options
+    
+    key = 'default_dir'
+    case qb_meta[key]
+    when nil, false
+      # there is no get_dir info in meta/qb.yml, can't get the dir
+      raise "unable to infer default directory: no '#{ key }' key in meta/qb.yml"
+      
+    when 'git_root'
+      debug "returning the git root relative to cwd"
+      NRSER.git_root cwd
+    
+    when 'cwd'
+      debug "returing current working directory"
+      cwd
+      
+    when Hash
+      debug "qb meta option is a Hash"
+      
+      if qb_meta[key].key? 'exe'
+        exe_path = qb_meta[key]['exe']
+        exe_input_data = options
+        
+        unless exe_path.start_with?('~') || exe_path.start_with?('/')
+          exe_path = File.join(role.path, exe_path)
+          debug 'exe path is relative, basing off role dir', exe_path: exe_path
+        end
+        
+        debug "found 'exe' key, calling", exe_path: exe_path,
+                                          exe_input_data: exe_input_data
+        
+        Cmds.chomp! exe_path do
+          JSON.dump exe_input_data
+        end
+      else
+        raise "not sure to process '#{ key }' in metea/qb.yml"
+      end
+    end
+  end
 end
+
+# needs QB::ROLES_DIR
+require 'qb/role'