qb 0.1.88 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5723177f21a7a76d3c4eac339f7e87f24235f080
-  data.tar.gz: a39e95984a295ac9b39b1f8df157fbbb64be69ef
+  metadata.gz: 58d2c1fbf4d57fdd1b607cf1c8716104b61a9909
+  data.tar.gz: 0b845dc2f323e3fb3e0f00a006af1f04f5d1a6a9
 SHA512:
-  metadata.gz: 48f81a50982b092f1f776516225a77321c15f8ab5a5060e868847356c107f2b51d9139f56eaf955ed84d656ea4f26655a050df30e1b085d8ca3d5b181b3d4f83
-  data.tar.gz: 35b50434cd7e57c4a57b8efea0f727238f852887d680a7c899dc8252be25495cb9f7c999da3680ea4f776efc9de07cb7f5f6910fb2620bd940e8dac0fc247eb9
+  metadata.gz: b3491012bb23264bc31f2f7c52f655f9b4a5a30e26c5efcaca05ed83f8240bad2402e8b1d14700be7433a30f14bbd2b990997b9b0a960b2244803117ac972f29
+  data.tar.gz: 2386308ce3bb76e0eea32a7dc6f6f9ca44c85d9cf90ef035b86e8cb3bd4f638d7b0bdf8b01e7653d601c775df4ffa73081fa8c6f27652754a65319b5a8fd2413

data/exe/qb

@@ -26,58 +26,6 @@ def set_debug! args
   end
 end
 
-# 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 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
-
 def metadata
   if QB.gemspec.metadata && !QB.gemspec.metadata.empty?
     "metadata:\n" + QB.gemspec.metadata.map {|key, value|
@@ -115,6 +63,8 @@ def main args
   
   help if role_arg.nil? || ['-h', '--help', 'help'].include?(role_arg)
   
+  return QB::CLI.play(args) if role_arg == 'play'
+  
   begin
     role = QB::Role.require role_arg
   rescue QB::Role::NoMatchesError => e
@@ -411,7 +361,7 @@ def main args
     end
   end
   
-  with_clean_env do
+  QB::Util::Bundler.with_clean_env do
     # boot up stdio out services so that ansible modules can stream to our
     # stdout and stderr to print stuff (including debug lines) in real-time
     stdio_out_services = {'out' => $stdout, 'err' => $stderr}.

data/lib/qb.rb

@@ -38,4 +38,6 @@ end
 # needs QB::*_ROLES_DIR
 require 'qb/role'
 require 'qb/options'
-require_relative './qb/repo'
+require_relative './qb/repo'
+require_relative './qb/cli'
+require_relative './qb/ansible'

data/lib/qb/ansible.rb

@@ -0,0 +1,5 @@
+
+module QB; end
+module QB::Ansible; end
+
+require_relative './ansible/config_file'

data/lib/qb/ansible/config_file.rb

@@ -0,0 +1,147 @@
+# Requirements
+# =====================================================================
+
+# stdlib
+require 'ostruct'
+
+# deps
+require 'parseconfig'
+
+# project
+require 'qb/util'
+
+
+# Refinements
+# =====================================================================
+
+require 'nrser/refinements'
+using NRSER
+
+
+module QB; end
+module QB::Ansible; end
+
+
+# A parse of an `ansible.cfg` file, extending {ParseConfig}.
+# 
+# We need these to read role path and other Ansible variables so we can setup
+# paths correctly.
+# 
+class QB::Ansible::ConfigFile < ParseConfig
+  
+  # Sub-Scopes
+  # =====================================================================
+  
+  
+  # Wrapper around the Hash from the `[defaults]` group in an Asnible 
+  # config file.
+  # 
+  # Instances are returned from {QB::Ansible::ConfigFile#defaults}.
+  # 
+  class Defaults < Hash
+    
+    # Attributes
+    # =====================================================================
+    
+    # @!attribute [r] rel_root
+    #   @return [Pathname]
+    #     Absolute path to use as root for relative paths.
+    attr_reader :rel_root
+    
+    
+    # Constructor
+    # =====================================================================
+    
+    # Instantiate a new `QB::Ansible::ConfigFile`.
+    # 
+    # @param [#each_pair] source
+    #   Source for the keys and values.
+    # 
+    def initialize source, rel_root:
+      super()
+      source.each_pair { |k, v| self[k] = v }
+      @rel_root = rel_root
+    end # #initialize
+    
+    
+    # Instance Methods
+    # =====================================================================
+    
+    # @return [Array<Pathname>]
+    #   Array of resolved (absolute) {Pathname} instances parsed from the 
+    #   `roles_path` value. Empty array `roles_path` key is missing.
+    # 
+    def roles_path
+      if key? 'roles_path'
+        self['roles_path'].
+          split(':').
+          map { |path| QB::Util.resolve @rel_root, path }
+      else
+        []
+      end
+    end # #roles_path
+    
+  end # class Defaults
+  
+  
+  # Constants
+  # =====================================================================
+  
+  # The "well-known" name we look for.
+  FILE_NAME = 'ansible.cfg'
+  
+  
+  # Class Methods
+  # =====================================================================
+  
+  
+  # @todo Document path? method.
+  # 
+  # @param [String, Pathname] file_path
+  #   
+  # 
+  # @return [Boolean]
+  #   `true` 
+  # 
+  def self.file_path? file_path
+    File.basename(file_path).to_s == FILE_NAME
+  end # .path?
+  
+  
+  # Attributes
+  # =====================================================================
+  
+  # @!attribute [r] rel_root
+  #   @return [Pathname]
+  #     Absolute path to the directory `ansible.cfg` is in; used as the
+  #     root for relative paths found in there.
+  attr_reader :rel_root
+  
+  
+  # Constructor
+  # =====================================================================
+  
+  # Instantiate a new `QB::Ansible::ConfigFile`.
+  def initialize path
+    super path
+    @rel_root = QB::Util.resolve(path).dirname
+  end # #initialize
+  
+  
+  # Instance Methods
+  # =====================================================================
+  
+  # @todo Document defaults method.
+  # 
+  # @return [QB::Ansible::ConfigFile::Defaults]
+  #   @todo Document return value.
+  # 
+  def defaults
+    Defaults.new (self['defaults'] || {}), rel_root: @rel_root
+  end # #defaults
+  
+  
+end # class QB::Ansible::ConfigFile
+
+
+

data/lib/qb/ansible/env.rb

@@ -0,0 +1,49 @@
+module QB; end
+module QB::Ansible; end
+
+
+# @todo document QB::Ansible::Env class.
+class QB::Ansible::Env < Hash
+  
+  # Constants
+  # ======================================================================
+  
+  VAR_NAME_PREFIX = 'ANSIBLE'
+  
+  
+  # Class Methods
+  # ======================================================================
+  
+  
+  # @todo Document to_var_name method.
+  # 
+  # @param [type] name
+  #   @todo Add name param description.
+  # 
+  # @return [return_type]
+  #   @todo Document return value.
+  # 
+  def self.to_var_name name
+    "#{ VAR_NAME_PREFIX }_ #{ name.to_s.upcase }"
+  end # .to_var_name
+  
+  
+  
+  # Attributes
+  # ======================================================================
+  
+  
+  # Constructor
+  # ======================================================================
+  
+  # Instantiate a new `QB::Ansible::Env`.
+  def initialize
+    
+  end # #initialize
+  
+  
+  # Instance Methods
+  # ======================================================================
+  
+  
+end # class QB::Ansible::Env

data/lib/qb/ansible/playbook.rb

@@ -0,0 +1,4 @@
+module QB; end
+module QB::Ansible; end
+
+

data/lib/qb/cli.rb

@@ -0,0 +1,4 @@
+module QB; end
+module QB::CLI; end 
+
+require_relative './cli/play'

data/lib/qb/cli/play.rb

@@ -0,0 +1,33 @@
+
+module QB; end
+
+# @todo document QB::CLI module.
+module QB::CLI 
+  
+  # Play an Ansible playbook (like `state.yml`) in the QB environment 
+  # (sets up path env vars, IO streams, etc.).
+  # 
+  # @param [type] arg_name
+  #   @todo Add name param description.
+  # 
+  # @return [return_type]
+  #   @todo Document return value.
+  # 
+  def self.play args
+    if args.empty?
+      raise "Need path to playbook in first arg."
+    end
+    
+    path = QB::Util.resolve args[0]
+    
+    unless path.file?
+      raise "Can't find Ansible playbook at #{ path.to_s }"
+    end
+    
+    
+    
+  end # .play
+  
+end # module QB::CLI
+
+

data/lib/qb/options.rb

@@ -4,6 +4,10 @@ require_relative "role/errors"
 require_relative "options/option"
 require 'qb/package/version'
 
+require 'nrser/refinements'
+using NRSER
+
+
 module QB
   class Options
     # constants
@@ -126,33 +130,69 @@ module QB
           else
             ruby_type = case option.meta['type']
             when nil
-              raise QB::Role::MetadataError,
-                "must provide type in qb metadata for option #{ option.meta_name }"
+              raise QB::Role::MetadataError.squished <<-END
+                must provide type in QB metadata for option
+                #{ option.meta_name }
+              END
+              
             when 'string', 'str'
               String
+              
             when 'array', 'list'
               Array
+              
             when 'integer', 'int'
               Integer
+              
             when 'version'
               QB::Package::Version
+              
             when 'hash', 'dict'
               Class.new.tap { |klass|
-                opts.accept(klass) {|value|
+                opts.accept(klass) { |value|
                   value.split(',').map { |pair_str|
                     split = pair_str.split ':'
                     if split.length > 2
-                      raise "Can only have a single ':' in hash options, " +
-                            "found #{ pair_str.inspect } in #{ value.inspect }"
+                      raise ArgumentError.dedented <<-END
+                        
+                        Can only have a single ':' in `hash` options.
+                        
+                        Found #{ pair_str.inspect }
+                        
+                        In #{ value.inspect }
+                        
+                      END
                     end
                     [split[0], split[1]]
                   }.to_h
                 }
               }
+              
+            when 'path'
+              String
+              # Class.new.tap { |klass|
+              #   opts.accept(klass) { |value|
+              #     
+              #   }
+              # }
+            
+            when 'glob'
+              Class.new.tap { |klass|
+                opts.accept(klass) { |glob|
+                  if glob.start_with? '//'
+                    glob = NRSER.git_root(Dir.getwd).
+                      join(glob[2..-1]).
+                      to_s
+                  end
+                  
+                  Dir[glob]
+                }
+              }
+              
             when Hash
               if option.meta['type'].key? 'one_of'
                 Class.new.tap { |klass|
-                  opts.accept(klass) {|value|
+                  opts.accept(klass) { |value|
                     if option.meta['type']['one_of'].include? value
                       value
                     else
@@ -209,7 +249,8 @@ module QB
             option.examples.each_with_index {|example, index|
               lines = example.lines.to_a
               
-              pp lines
+              # was this debuggin? had to be...
+              # pp lines
               
               on_args << ((index + 1).to_s + '.').ljust(4) + lines.first.chomp