qb 0.3.25 → 0.4.0

data/lib/qb/util/resource.rb

@@ -5,13 +5,7 @@
 # -----------------------------------------------------------------------
 
 require 'nrser'
-
-
-# Refinements
-# =======================================================================
-
-require 'nrser/refinements'
-using NRSER
+require 'nrser/props/immutable/instance_variables'
 
 
 # Declarations
@@ -27,10 +21,15 @@ module QB::Util; end
 # Base class for QB "resources" - object representations of outside structures
 # and concepts: things that live on disk, in remote systems or other runtimes.
 # 
-# At the moment, it's simply an extension of {NRSER::Meta::Props::Base}, but 
-# it is here to serve as a centralized point to implement common behaviors,
-# some of which would be lifted up to the {NRSER} properties system if they 
-# prove sufficiently useful and general.
-# 
-class QB::Util::Resource < NRSER::Meta::Props::Base
+class QB::Util::Resource
+  
+  # Mixins
+  # =====================================================================
+  
+  include NRSER::Props::Immutable::InstanceVariables
+  
+  
+  def initialize values = {}
+    initialize_props values
+  end # #initialize
 end # class QB::Util::Resource

data/lib/qb/version.rb

@@ -34,6 +34,16 @@ module QB
   # Class Methods
   # =====================================================================
   
+  # Are we running in local development? Looks for the `//dev` directory's
+  # presence.
+  # 
+  # @return [Boolean]
+  # 
+  def self.local_dev?
+    (QB::ROOT / 'dev').directory?
+  end
+  
+  
   def self.gemspec
     Gem.loaded_specs[GEM_NAME]
   end

data/library/path_facts

@@ -1,19 +1,14 @@
 #!/usr/bin/env ruby
 # WANT_JSON
 
-# init bundler in dev env
-if ENV['QB_DEV_ENV']
-  ENV.each {|k, v|
-    if k.start_with? 'QB_DEV_ENV_'
-      ENV[k.sub('QB_DEV_ENV_', '')] = v
-    end
-  }
-  require 'bundler/setup'
-end
+# Reinstate Bundler ENV vars if they have been moved
+load ENV['QB_REBUNDLE_PATH'] if ENV['QB_REBUNDLE_PATH']
+
 
 require 'ostruct'
 
 require 'qb'
+require 'qb/ansible/module'
 require 'qb/package/version'
 require 'cmds'
 require 'pathname'
@@ -283,4 +278,4 @@ class PathFacts < QB::Ansible::Module
   end
 end
 
-PathFacts.new.run
+PathFacts.run!

data/library/qb.module.rb

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+# WANT_JSON
+
+# Reinstate Bundler ENV vars if they have been moved
+load ENV['QB_REBUNDLE_PATH'] if ENV['QB_REBUNDLE_PATH']
+
+require 'qb/ansible/module'
+
+require 'nrser'
+require 'nrser/core_ext/string'
+require 'nrser/types'
+
+def t; NRSER::Types; end
+
+QB::Ansible::Module.setup_io!
+
+class QB_Ansible_Module_Runner < QB::Ansible::Module
+  
+  
+  # @!attribute [r] name
+  #   Name of module to run (relative path from `//lib/qb/ansible/modules`)
+  #   
+  #   @return [PropRubyType]
+  #   
+  arg :module_name,
+      type: t.non_empty_str,
+      aliases: [ :name ],
+      reader: { name: false }
+  
+  arg :module_require,
+      type: (
+        t.nil | # Guess and try the require path
+        t.false | # Don't require anything; module class must already be loaded
+        t.non_empty_str | # String to require
+        t.list( t.non_empty_str ) # List of strings to require
+      ),
+      aliases: [ :require ],
+      reader: { require: false }
+  
+  arg :module_args,
+      type: t.map,
+      aliases: [ :args ],
+      reader: { args: false },
+      default: ->{ {} }
+  
+  def main
+    class_name = module_name.camelize
+    class_path = module_name.underscore
+    
+    logger.trace "Received module argument",
+      module_name: module_name,
+      class_name: class_name,
+      class_path: class_path,
+      module_require: module_require
+    
+    unless class_name.start_with? '::'
+      class_name = "QB::Ansible::Modules::#{ class_name }"
+    end
+    
+    require_paths = case module_require
+    when nil
+      if class_path.start_with? '/'
+        [ class_path[1..-1] ]
+      else
+        [ "qb/ansible/modules/#{ class_path }" ]
+      end
+    when false
+      []
+    when String
+      [ module_require ]
+    when Array
+      module_require
+    end
+    
+    if require_paths.empty?
+      logger.trace "No requiring any paths"
+    else
+      logger.trace "Requiring paths...",
+        require_paths: require_paths
+      
+      require_paths.each do |require_path|
+        begin
+          require require_path
+        rescue LoadError => error
+          logger.warn "Failed to require #{ require_path.inspect }", error
+        end
+      end
+    end
+    
+    module_class = class_name.to_const!
+    
+    logger.trace "Loaded class",
+      module_class: module_class.to_s
+    
+    instance = module_class.from_data module_args
+    instance.args_source = args_source
+    instance.args = args['args'] || args['module_args'] || {}
+    
+    instance.run!
+  end
+    
+end # class QB_Ansible_Module_Runner
+
+
+QB_Ansible_Module_Runner.run!

data/library/stream

@@ -1,29 +1,14 @@
 #!/usr/bin/env ruby
 # WANT_JSON
 
-# init bundler in dev env
-
-# HACK  Keep track of the ENV vars we overwrite so we can swap them back in
-#       later when we need to run the command.
-#       
-$replaced_env_vars = {}
-
-if ENV['QB_DEV_ENV']
-  ENV.each {|k, v|
-    if k.start_with? 'QB_DEV_ENV_'
-      key = k.sub('QB_DEV_ENV_', '')
-      $replaced_env_vars[key] = [ENV[key], v]
-      ENV[key] = v
-    end
-  }
-  require 'bundler/setup'
-end
+# Reinstate Bundler ENV vars if they have been moved
+load ENV['QB_REBUNDLE_PATH'] if ENV['QB_REBUNDLE_PATH']
 
+require 'nrser'
 require 'qb'
+require 'qb/ansible/module'
 require 'cmds'
 
-using NRSER
-
 class Stream < QB::Ansible::Module
   def main
     template = @args['template'] || @args['cmd']
@@ -71,15 +56,10 @@ class Stream < QB::Ansible::Module
       END
     end
     
-    # HACK  Swap any ENV vars we replaced at the top back in
-    $replaced_env_vars.each do |key, (original, replacement)|
-      ENV[key] = original
-    end
-      
-    cmd.stream!
+    qb_unbundle! { cmd.stream! }
     
     changed!
   end
 end
 
-Stream.new.run
+Stream.run!

data/load/ansible/module/autorun.rb

@@ -0,0 +1,25 @@
+
+# Reinstate Bundler ENV vars if they have been moved
+load ENV['QB_REBUNDLE_PATH'] if ENV['QB_REBUNDLE_PATH']
+
+require 'active_support/core_ext/class/subclasses'
+require 'qb/ansible/module'
+
+require 'nrser'
+require 'nrser/types'
+
+def t; NRSER::Types; end
+
+QB::Ansible::Module.setup_io!
+
+at_exit do
+  if $!
+    QB::Ansible::Module.logger.fatal "Error raised pre-execution", $!
+  else
+    QB::Ansible::Module.descendants.find_only { |klass|
+      begin
+        klass.instance_method( :main ).source_location[0] == $0
+      rescue; end
+    }.run!
+  end
+end

data/load/ansible/module/script.rb

@@ -0,0 +1,123 @@
+
+# Reinstate Bundler ENV vars if they have been moved
+load ENV['QB_REBUNDLE_PATH'] if ENV['QB_REBUNDLE_PATH']
+
+require 'qb/ansible/module'
+require 'nrser/types'
+require 'nrser/core_ext/exception'
+
+
+# Constants
+# ========================================================================
+
+MAIN = self
+NAME = File.basename( $0 ).gsub( '.', '/' ).camelize
+LOGGER = NRSER::Log[ NAME ]
+RAW_ARGS, ARGS_SOURCE = QB::Ansible::Module.load_args
+ARG_DEFS = {}
+ARGS = {}
+
+
+# Global Variables
+# ============================================================================
+
+$response = QB::Ansible::Module::Response.new
+
+
+# Global Methods
+# ============================================================================
+
+# Constant Readers
+# ----------------------------------------------------------------------------
+# 
+# Just to make 'em feel familiar...
+# 
+
+def logger;     LOGGER;         end
+def t;          NRSER::Types;   end
+def name;       NAME;           end
+def raw_args;   RAW_ARGS;       end
+def arg_defs;   ARG_DEFS;       end
+def args;       ARGS;           end
+def response;   $response;      end
+
+
+def arg name, **opts
+  t.non_empty_sym.check! name
+  
+  prop = NRSER::Props::Prop.new \
+    MAIN,
+    name,
+    reader: true,
+    writer: false, **opts
+  
+  arg_defs[name] = prop
+  
+  args[prop.name] = if raw_args.key? prop.name
+    prop.check! raw_args[prop.name]
+  else
+    prop.default **args
+  end
+  
+  prop.names.each do |name|
+    MAIN.send :define_method, name do
+      args[prop.name]
+    end
+  end
+end
+
+
+def fail! msg, **values
+  $response = response.to_failure \
+    msg: msg,
+    **values
+  
+  exit false
+end
+
+
+def response_sent?
+  !!$response_sent
+end
+
+
+def send_response!
+  if response_sent?
+    logger.warn "Response has already been sent, ignoring..."
+    return
+  end
+  
+  # NOTE  *Need* to assign here or it disappears after the `logger.fatal`
+  #       call!
+  if (error = $!) && !error.is_a?( SystemExit )
+    # We failed!
+    
+    # Log it
+    logger.fatal error
+    
+    # Create a new response; don't want to carry whatever the current one
+    # has in it back? Maybe we do? Ans'y doesn't set facts when modules fail,
+    # it seems, so might not hurt...
+    $response = response.to_failure \
+      msg: error.to_s,
+      exception: error.format
+  end
+
+  response_data = response.to_data( add_class: false ).compact
+
+  logger.debug "Responding", response_data
+  STDOUT.print JSON.pretty_generate( response_data )
+
+  exit !response.failed
+rescue SystemExit
+  raise
+rescue Exception => error
+  logger.error "Internal QB Error: Failed to send response", error
+  exit false
+end
+
+
+at_exit { send_response! unless response_sent? }
+
+
+QB::Ansible::Module.setup_io!

data/load/rebundle.rb

@@ -0,0 +1,39 @@
+# Restores Bundler ENV vars that were moved when spawning the Ansible process.
+# 
+# See `//lib/qb/util/bundler.rb` for documentation on how and why we do this.
+# 
+
+# Keep track of the ENV vars we overwrite so we can swap them back in
+# later when we need to do things like shell out.
+#       
+$qb_replaced_env_vars = {}
+
+
+def qb_rebundle!
+  ENV.each do |k, v|
+    if k.start_with? 'QB_BUNDLER_ENV_'
+      key = k.sub 'QB_BUNDLER_ENV_', ''
+      $qb_replaced_env_vars[key] = [ENV[key], v]
+      ENV[key] = v
+    end
+  end
+end
+
+
+def qb_unbundle! &block
+  $qb_replaced_env_vars.each do |key, (original, replacement)|
+    ENV[key] = original
+  end
+  
+  $qb_replaced_env_vars = {}
+  
+  if block
+    block.call.tap { qb_rebundle! }
+  end
+end
+
+
+qb_rebundle!
+
+
+require 'bundler/setup'

data/plugins/filter/dict_filters.py

@@ -0,0 +1,56 @@
+# Imports
+# ============================================================================
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import sys
+import re
+import os
+
+from ansible.errors import AnsibleError
+from jinja2.filters import contextfilter
+
+def to_dict( value ):
+    '''Call Python's built-in `dict()` on the value.
+    
+    Can't believe this shit isn't built-in to Jinja/Ansible :/
+    '''
+    
+    return dict( value )
+
+
+@contextfilter
+def select_by_keys( context, dct, test_name, *args, **kwds ):
+    # raise StandardError(
+    #     "args: {}, kwds: {}".format( args, kwds )
+    # )
+    
+    test = lambda key: context.environment.call_test(
+        test_name, key, args, kwds
+    )
+    
+    new_dct = {}
+    
+    for key, value in dct.iteritems():
+        if test( key ):
+            new_dct[key] = value
+    
+    return new_dct
+
+
+class FilterModule(object):
+    '''Some dict filters'''
+    
+    def filters(self):
+        return {
+            'dict': to_dict,
+            'select_by_keys': select_by_keys,
+        }
+
+
+# testing - call camel_case on first cli arg and print result
+if __name__ == '__main__':
+    import doctest
+    doctest.testmod()
+