qb 0.1.50 → 0.1.51

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d9c34a19d57f54943675da647f3cd7b5bcaf7c4
-  data.tar.gz: 46160ea3fde30678adf3a5e602d72dcef823e34b
+  metadata.gz: 8354a2e7a722ed65253867f9ba61d18f32548c7e
+  data.tar.gz: c3b3a05ac92ff16657beb5e53c01e5d29ad3a43d
 SHA512:
-  metadata.gz: f3372997b5606c548da8350f1769eac58880379f3715c394f50c11796beaa664d0948670c7e6c6441f2ef9c8d7b284b5b019d1bbc4d28fe0f76b07a386c0c29d
-  data.tar.gz: b815260aaeed6ac5ee541f3ca1bc9867a622d74494f5c1da7ba9a56bbd7cf7adb69ecaf7f250b7d552a517a5c5eb250f4212120d52460fdf2b4c0f4d8b2586c4
+  metadata.gz: 7f22505b21269bc2b63b14cbb9c9dfddf16d9fd4a046dc797d1609adda79598d9ff6778eb7486bfccbd44e8e80dce046aaf91fdbdaa56b9092663c3c6e4fd1e4
+  data.tar.gz: '048192659773f4e26e6de355ffa1b32c9f5af7507bf4245adcfa3a6566ab7f80fbb70c4b965759997966c0a12ae923e541f9ad349f4f7c2a6e7ecf8f709d5c1b'

data/exe/qb

@@ -160,7 +160,7 @@ def main args
       # 
       # in some cases (like projects) the dir can be figured out in other ways:
       # 
-      QB.get_default_dir role, cwd, options
+      role.default_dir cwd, options
       
     when 1
       # there is a single positional arg, which is used as dir
@@ -320,6 +320,10 @@ def main args
     template << "-#{ 'v' * qb_options['verbose'] }"
   end
   
+  if qb_options['ask_vault_pass'] || role.ask_vault_pass?
+    template << "--ask-vault-pass"
+  end
+  
   template << "<%= playbook_path %>"
   
   cmd = Cmds.sub template.join(" "), [], {

data/lib/qb.rb

@@ -36,83 +36,6 @@ module QB
     $stderr.puts dumpObj.pretty_inspect
   end
   
-  def self.get_default_dir role, cwd, options
-    debug "get_default_dir",  role: role,
-                              meta: role.meta,
-                              cwd: cwd,
-                              options: options
-    
-    key = 'default_dir'
-    value = role.meta[key]
-    case value
-    when nil
-      # 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 false
-      # this method should not get called when the value is false (an entire
-      # section is skipped in exe/qb when `default_dir = false`)
-      raise "role does not use default directory (meta/qb.yml:default_dir = false)"
-    
-    when 'git_root'
-      debug "returning the git root relative to cwd"
-      NRSER.git_root cwd
-    
-    when 'cwd'
-      debug "returning current working directory"
-      cwd
-      
-    when Hash
-      debug "qb meta option is a Hash"
-      
-      unless value.length == 1
-        raise "#{ role.meta_path.to_s }:default_dir invalid: #{ value.inspect }"
-      end
-      
-      hash_key, hash_value = value.first
-      
-      case hash_key
-      when 'exe'
-        exe_path = hash_value
-        
-        # supply the options to the exe so it can make work off those values
-        # if it wants.
-        exe_input_data = Hash[
-          options.map {|option|
-            [option.cli_option_name, option.value]
-          }
-        ]
-        
-        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
-        
-      when 'find_up'
-        filename = hash_value
-        
-        unless filename.is_a? String
-          raise "find_up filename must be string, found #{ filename.inspect }"
-        end
-        
-        debug "found 'find_up', looking for file named #{ filename }"
-        
-        Util.find_up filename
-        
-      else
-        raise "bad key: #{ hash_key } in #{ role.meta_path.to_s }:default_dir"
-        
-      end
-    end
-  end # get_default_dir
-  
   def self.check_ansible_version
     out = Cmds.out! 'ansible --version'
     version_str = out[/ansible\ ([\d\.]+)/, 1]

data/lib/qb/options.rb

@@ -23,10 +23,34 @@ module QB
     class MetadataError < Error
     end
     
+    # turn a name into a "command line" version by replacing underscores with
+    # dashes.
+    # 
+    # @param [String] option_name
+    #   the input option name.
+    # 
+    # @return [String]
+    #   the CLI-ized name.
+    # 
+    # @example
+    #   QB::Options.cli_ize_name "my_var" # => "my-var"
+    # 
     def self.cli_ize_name option_name
       option_name.gsub '_', '-'
     end
     
+    # turn a name into a "ruby / ansible variable" version by replacing
+    # dashes with underscores.
+    # 
+    # @param [String] option_name
+    #   the input option name.
+    # 
+    # @return [String]
+    #   the ruby / ansible var-ized name.
+    # 
+    # @example
+    #   QB::Options.cli_ize_name "my-var" # => "my_var"
+    # 
     def self.var_ize_name option_name
       option_name.gsub '-', '_'
     end
@@ -156,6 +180,25 @@ module QB
       end # each var
     end # add 
     
+    # destructively removes options from `args` and populates hashes of
+    # role-specific options and general qb ones.
+    # 
+    # @param [QB::Role] role
+    #   the role to parse the options for.
+    # 
+    # @param [Array<String>] args
+    #   CLI args -- `ARGV` with the role arg shifted off.
+    # 
+    # @return [Array<Hash<String, Option|Object>>]
+    #   a two-element array:
+    #   
+    #   1.  the options for the role, hash of Option#cli_name to Option
+    #       instances.
+    #       
+    #   2.  the general qb options, hash of String key to option values.
+    #   
+    # @raise if bad options are found.
+    # 
     def self.parse! role, args      
       role_options = {}
       
@@ -246,6 +289,13 @@ module QB
           qb_options['run'] = false
         end
         
+        opts.on(
+          '--ASK-VAULT-PASS',
+          "ask for the vault password.",
+        ) do |value|
+          qb_options['ask_vault_pass'] = true
+        end
+        
         add opts, role_options, role
         
         opts.on_tail("-h", "--help", "Show this message") do

data/lib/qb/role.rb

@@ -481,6 +481,98 @@ module QB
       puts "\n" + format_examples + "\n"
     end
     
+    # should qb ask for an ansible vault password?
+    # 
+    # @see http://docs.ansible.com/ansible/playbooks_vault.html
+    # 
+    # @return [Boolean]
+    #   `true` if qb should ask for a vault password.
+    # 
+    def ask_vault_pass?
+      !!@meta['ask_vault_pass']
+    end
+    
+    # gets the default `qb_dir` value, raising an error if the role doesn't
+    # define how to get one or there is a problem getting it.
+    # 
+    # 
+    def default_dir cwd, options
+      debug "get_default_dir",  role: self,
+                                meta: self.meta,
+                                cwd: cwd,
+                                options: options
+      
+      key = 'default_dir'
+      value = self.meta[key]
+      case value
+      when nil
+        # 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 false
+        # this method should not get called when the value is false (an entire
+        # section is skipped in exe/qb when `default_dir = false`)
+        raise "role does not use default directory (meta/qb.yml:default_dir = false)"
+      
+      when 'git_root'
+        debug "returning the git root relative to cwd"
+        NRSER.git_root cwd
+      
+      when 'cwd'
+        debug "returning current working directory"
+        cwd
+        
+      when Hash
+        debug "qb meta option is a Hash"
+        
+        unless value.length == 1
+          raise "#{ meta_path.to_s }:default_dir invalid: #{ value.inspect }"
+        end
+        
+        hash_key, hash_value = value.first
+        
+        case hash_key
+        when 'exe'
+          exe_path = hash_value
+          
+          # supply the options to the exe so it can make work off those values
+          # if it wants.
+          exe_input_data = Hash[
+            options.map {|option|
+              [option.cli_option_name, option.value]
+            }
+          ]
+          
+          unless exe_path.start_with?('~') || exe_path.start_with?('/')
+            exe_path = File.join(self.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
+          
+        when 'find_up'
+          filename = hash_value
+          
+          unless filename.is_a? String
+            raise "find_up filename must be string, found #{ filename.inspect }"
+          end
+          
+          debug "found 'find_up', looking for file named #{ filename }"
+          
+          QB::Util.find_up filename
+          
+        else
+          raise "bad key: #{ hash_key } in #{ self.meta_path.to_s }:default_dir"
+          
+        end
+      end
+    end # default_dir
+    
     private
     
     # get the value at the first found of the keys or the default.

data/lib/qb/version.rb

@@ -1,7 +1,7 @@
 module QB
   GEM_NAME = 'qb'
   
-  VERSION = "0.1.50"
+  VERSION = "0.1.51"
   
   def self.gemspec
     Gem.loaded_specs[GEM_NAME]

data/roles/qb.qb_role/templates/qb.yml.j2

@@ -42,6 +42,9 @@ default_user: null
 # set to false to not save options in .qb-options.yml files
 save_options: true
 
+# ask for an ansible vault password
+ask_vault_pass: false
+
 options: []
 # - name: example
 #   description: an example of a variable.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qb
 version: !ruby/object:Gem::Version
-  version: 0.1.50
+  version: 0.1.51
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-17 00:00:00.000000000 Z
+date: 2017-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler