qb 0.1.13 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9b701329529f078964cbe45228492216b6bb764
-  data.tar.gz: be835698732b5193d85befda5a6ae70545a51d51
+  metadata.gz: eff9442acda19ad45e2a0fc85dde3fa21f34d33a
+  data.tar.gz: 0ca507c08588f891232f983b45e10b953281dce8
 SHA512:
-  metadata.gz: 4b00d86a4b0c90a8d0e94b6489327aa90a141b00be216549660474f9360d7d75d92045b479f17579f6e91dd80f44f30426d54bf591cc4144e5587ac43edc0834
-  data.tar.gz: ac43dde773b412798bc80e84c412a057e56bfdfd55ecc27d343225ad0533a189aff389e9edba3f908187636d30b8eecf4c80589e9b01bedfc3535d9488eb00f5
+  metadata.gz: c05d0cf7fad902ca2a4988170b614a1c21444bf51d0c16ce0e6c63b5a17a826a93014bf6ef65adefb5507cd9c4ecc04ef79f51725464e7612fb269eeb014393d
+  data.tar.gz: 22d00588741f03b6044dddb945388e12e08f07428ed8168ce6faa5aeb6494f3e01afc64096e2947cde146dbb6c90a4b8233a19bcbcb48a0776dd884b76aa6df0

data/exe/qb

@@ -3,7 +3,6 @@
 require 'pathname'
 require 'pp'
 require 'yaml'
-require 'optparse'
 require 'json'
 require 'fileutils'
 
@@ -37,15 +36,6 @@ def format msg, dump = {}
   msg
 end
 
-def role? pathname
-  pathname.directory? &&
-  ['qb.yml', 'qb'].any? {|fn| pathname.join('meta', fn).file?}
-end
-
-def role_matches
-  
-end
-
 def debug *args
   QB.debug *args
 end
@@ -58,129 +48,6 @@ def set_debug! args
   end
 end
 
-def parse! role, var_prefix, vars, defaults, args
-  positional = vars.select do |var|
-    var['positional'] == true
-  end
-  
-  positional_banner = if positional.empty?
-    ''
-  else
-    ' ' + positional.map {|var|
-      var['name'].upcase
-    }.join(' ')
-  end
-  
-  options = {}
-  
-  opt_parser = OptionParser.new do |opts|
-    # opts.banner = "qb #{ role.name } [OPTIONS]#{ positional_banner }"
-    opts.banner = "qb #{ role.name } [OPTIONS] DIRECTORY"
-    
-    vars.each do |var|
-      arg_name = var.fetch 'name'
-      var_name = "#{ var_prefix }_#{ arg_name }"
-      required = var['required'] || false
-      arg_style = required ? :REQUIRED : :OPTIONAL
-      
-      # on_args = [arg_style]
-      on_args = []
-      
-      if var['type'] == 'boolean'
-        if var['short']
-          on_args << "-#{ var['short'] }"
-        end
-        
-        on_args << "--[no-]#{ var['name'] }"
-        
-      else
-        ruby_type = case var['type']
-        when 'string'
-          String
-        when Hash
-          if var['type'].key? 'one_of'
-            klass = Class.new
-            opts.accept(klass) {|value|
-              if var['type']['one_of'].include? value
-                value
-              else
-                raise ArgumentError, "argument '#{ var['name'] }' must be " +
-                  "one of: #{ var['type']['one_of'].join(', ') }"
-              end
-            }
-            klass
-          else 
-            raise ArgumentError, "bad type: #{ var['type'].inspect }"
-          end
-        else
-          raise ArgumentError, "bad type: #{ var['type'].inspect }"
-        end
-        
-        if var['short']
-          on_args << "-#{ var['short'] } #{ arg_name.upcase }"
-        end
-        
-        on_args << "--#{ var['name'] }=#{ arg_name.upcase }"
-        
-        on_args << ruby_type
-      end
-      
-      # description
-      description = if var.key? 'description'
-        var['description'] 
-      else
-        "set the #{ var_name } variable"
-      end
-      
-      if var['type'].is_a?(Hash) && var['type'].key?('one_of')
-        lb = "\n" + "\t" * 5
-        description += " options:" + 
-          "#{ lb }#{ var['type']['one_of'].join(lb) }"
-      end
-      
-      on_args << description
-      
-      if defaults.key? var_name
-        on_args << if var['type'] == 'boolean'
-          if defaults[var_name]
-            "default --#{ var['name'] }"
-          else
-            "default --no-#{ var['name'] }"
-          end
-        else
-          "default = #{ defaults[var_name] }"
-        end
-      end
-      
-      debug "adding option", name: arg_name, on_args: on_args
-      
-      opts.on(*on_args) do |value|
-        options[var['name']] = value
-      end
-    end
-    
-    # No argument, shows at tail.  This will print an options summary.
-    # Try it and see!
-    opts.on_tail("-h", "--help", "Show this message") do
-      puts opts
-      exit
-    end
-  end
-  
-  opt_parser.parse! args
-  
-  # args.each_with_index do |value, index|
-  #   var_name = positional[index]['name']
-  #   if options.key? var_name
-  #     raise ArgumentError, "don't supply #{ var_name } as option and positionaly"
-  #   else
-  #     options[var_name] = value
-  #   end
-  # end
-  
-  options
-end
-
 # needed for to clean the env if using bundler (like in dev)
 def with_clean_env &block
   if defined? Bundler
@@ -212,7 +79,7 @@ use `qb ROLE -h` for role options.
 available roles:
 
 END
-  puts QB.available_roles
+  puts QB::Role.available
   puts
   exit 1
 end
@@ -226,44 +93,20 @@ def main args
   
   help if role_arg.nil? || ['-h', '--help', 'help'].include?(role_arg)
   
-  matches = QB.role_matches role_arg
-  debug "role matches" => matches
-  
-  role = case matches.length
-  when 0
-    puts "ERROR - no roles match arg #{ role_arg.inspect }\n\n"
+  begin
+    role = QB::Role.require role_arg
+  rescue QB::Role::NoMatchesError => e
+    puts "ERROR - #{ e.message }\n\n"
+    # exits with status code 1
     help
-  when 1
-    matches[0]
-  else
-    puts "ERROR - multiple role matches:\n\n"
-    puts matches
-    puts
+  rescue QB::Role::MultipleMatchesError => e
+    puts "ERROR - #{ e.message }\n\n"
     exit 1
   end
-  debug role: role
-  
-  defaults_path = role.path + 'defaults' + 'main.yml'
-  defaults = if defaults_path.file?
-    YAML.load(defaults_path.read) || {}
-  else
-    {}
-  end
-  
-  qb_meta = if (role.path + 'meta' + 'qb').exist?
-    YAML.load Cmds.out! (role.path + 'meta' + 'qb').realpath.to_s
-  elsif (role.path + 'meta' + 'qb.yml').exist?
-    YAML.load (role.path + 'meta' + 'qb.yml').read
-  else
-    {}
-  end
   
-  vars = qb_meta['vars'] || []
-  var_prefix = qb_meta['var_prefix'] || role.namespaceless
+  options = QB::Options.parse! role, args
   
-  options = parse! role, var_prefix, vars, defaults, args
-  
-  debug options: options
+  debug "options set on cli", options.select {|k, o| !o.value.nil?}
   
   cwd = Dir.getwd
   
@@ -274,7 +117,7 @@ def main args
     # 
     # in some cases (like projects) the dir can be figured out in other ways:
     # 
-    QB.get_default_dir role, qb_meta, cwd, options
+    QB.get_default_dir role, cwd, options
     
   when 1
     # there is a single positional arg, which is used as dir
@@ -286,12 +129,12 @@ def main args
     
   end
   
-  debug input_dir: dir
+  debug "input_dir", dir
   
   # normalize to expanded path (has no trailing slash)
   dir = File.expand_path dir
   
-  debug normalized_dir: dir
+  debug "normalized_dir", dir
   
   # create the dir if it doesn't exist (so don't have to cover this in
   # every role)
@@ -300,28 +143,58 @@ def main args
   saved_options_path = Pathname.new(dir) + '.qb-options.yml'
   
   saved_options = if saved_options_path.exist?
-    YAML.load saved_options_path.read
+    YAML.load(saved_options_path.read).tap {|saved_options|
+      debug "found saved options", saved_options
+    }
   else
+    debug "no saved options"
     {}
   end
   
   if saved_options.key? role.options_key
-    options = saved_options[role.options_key].merge options
+    role_saved_options = saved_options[role.options_key]
+    
+    debug "found saved options for role", role_saved_options
+    
+    role_saved_options.each do |cli_option_name, value|
+      option = options[cli_option_name]
+      
+      if option.value.nil?
+        debug "setting from saved options", option: option, value: value
+        
+        option.value = value
+      end
+    end
   end
   
+  set_options = options.select {|k, o| !o.value.nil?}
+  
+  debug "set options", set_options
+  
   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_vars = {
+    'qb_dir' => dir,
+    # depreciated due to mass potential for conflict
+    'dir' => dir,
+    'qb_cwd' => cwd,
+  }
+  
+  set_options.values.each do |option|
+    playbook_role[option.ansible_var_name] = option.value
+  end
   
   playbook = [
     {
       'hosts' => 'localhost',
+      'vars' => playbook_vars,
       'pre_tasks' => [
+        # need ansible 2.1.2.0 at least to run
+        {
+          'assert' => {
+            'that' => "'ansible 2.1.2' in lookup('pipe', 'ansible --version')",
+          },
+        },
         {'qb_facts' => nil},
       ],
       'roles' => [
@@ -331,7 +204,7 @@ def main args
     }
   ]
   
-  debug playbook: playbook
+  debug "playbook", playbook
   
   playbook_path = ROOT + '.qb-playbook.yml'
   debug playbook_path: playbook_path.to_s
@@ -340,12 +213,23 @@ def main args
     f.write YAML.dump(playbook)
   end
   
-  unless (
-    options.empty? ||
-    (qb_meta.key?('save_options') && qb_meta['save_options'] == false)
+  # save the options back
+  if (
+    # we set some options that we can save
+    set_options.values.select {|o| o.save }.length > 0 &&
+    # the role says to save options
+    role.save_options
   )
-    saved_options[role.options_key] = options
-    FileUtils.mkdir_p saved_options_path.dirname unless saved_options_path.dirname.exist?
+    saved_options[role.options_key] = set_options.select{|key, option|
+      option.save
+    }.map {|key, option|
+      [key, option.value]
+    }.to_h
+    
+    unless saved_options_path.dirname.exist?
+      FileUtils.mkdir_p saved_options_path.dirname
+    end
+    
     saved_options_path.open('w') do |f|
       f.write YAML.dump(saved_options)
     end
@@ -355,7 +239,7 @@ def main args
   
   ansible_roles_path = (
     [tmp_roles_path] +
-    QB.role_dirs
+    QB::Role.search_path
   ).join(':')
   
   Dir.chdir ROOT do

data/lib/qb.rb

@@ -6,6 +6,9 @@ module QB
   ROOT = (Pathname.new(__FILE__).dirname + '..').expand_path
   ROLES_DIR = ROOT + 'roles'
   
+  class Error < StandardError
+  end
+  
   # TODO this should be in an instance that is run instead of module global
   # hack for now
   @@debug = false
@@ -15,74 +18,35 @@ module QB
   end
   
   def self.debug *args
-    return unless @@debug
+    return unless @@debug && args.length > 0
     
-    msg, values = case args.length
+    header = 'DEBUG'
+    
+    if args[0].is_a? String
+      header += " " + args.shift
+    end
+    
+    dumpObj = case args.length
     when 0
-      raise ArgumentError, "debug needs at least one argument"
+      header
     when 1
-      if args[0].is_a? Hash
-        ['', args[0]]
-      else
-        [args[0], {}]
-      end
-    when 2
-      [args[0], args[1]]
+      {header => args[0]}
     else
-      raise ArgumentError, "debug needs at least one argument"
+      {header => args}
     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
-    }
+    # $stderr.puts("DEBUG " + format(msg, values))
+    $stderr.puts YAML.dump(dumpObj)
   end
   
-  def self.get_default_dir role, qb_meta, cwd, options
+  def self.get_default_dir role, cwd, options
     debug "get_default_dir",  role: role,
-                              qb_meta: qb_meta,
+                              meta: role.meta,
                               cwd: cwd,
                               options: options
     
     key = 'default_dir'
-    case qb_meta[key]
+    case role.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"
@@ -98,9 +62,13 @@ module QB
     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
+      if role.meta[key].key? 'exe'
+        exe_path = role.meta[key]['exe']
+        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)
@@ -121,4 +89,5 @@ module QB
 end
 
 # needs QB::ROLES_DIR
-require 'qb/role'
+require 'qb/role'
+require 'qb/options'

data/lib/qb/options.rb

@@ -0,0 +1,189 @@
+require 'optparse'
+
+module QB
+  module Options
+    # small struct to hold the differnt names of the option now that including
+    # makes it more complicated
+    Option = Struct.new :qb_meta_name,
+                        :cli_option_name,
+                        :ansible_var_name,
+                        :required,
+                        :save,
+                        :value
+    
+    # errors
+    # ======
+    
+    # base for errors in the module, extends QB:Error
+    class Error < QB::Error
+    end
+    
+    # raised when an included role includes another, which we don't support
+    # (for now)
+    class NestedIncludeError < Error
+      def initialize
+        super "can't nest role includes"
+      end
+    end
+    
+    def self.include_role opts, options, include_var
+      role_name = include_var['include']
+      role = QB::Role.require role_name
+      include_as = include_var['as'] || role.namespaceless
+      
+      QB.debug "including #{ role.name } as #{ include_as }"
+      
+      add opts, options, role, include_as
+    end
+    
+    # add the options from a role to the OptionParser
+    def self.add opts, options, role, include_as = nil
+      QB.debug "adding options", "role" => role
+      
+      role.vars.each do |var|
+        if var.key? 'include'
+          # we don't support nested includes
+          unless include_as.nil?
+            raise NestedIncludeError.new
+          end
+          
+          include_role opts, options, var
+          
+        else
+          # create an option
+          
+          # variable's name in meta
+          qb_meta_name = var.fetch 'name'
+          
+          # name that will be used in QB cli
+          cli_option_name = if include_as
+            "#{ include_as }_#{ qb_meta_name }"
+          else
+            qb_meta_name
+          end
+          
+          # name that is passed to ansible role
+          ansible_var_name = "#{ role.var_prefix }_#{ qb_meta_name }"
+          
+          required = var['required'] || false
+          save = if var.key? 'save'
+            !!var['save']
+          else
+            true
+          end
+          
+          option = options[cli_option_name] = Option.new qb_meta_name,
+                                                cli_option_name,
+                                                ansible_var_name,
+                                                required,
+                                                save,
+                                                nil
+          
+          arg_style = required ? :REQUIRED : :OPTIONAL
+          
+          # on_args = [arg_style]
+          on_args = []
+          
+          if var['type'] == 'boolean'
+            # don't use short names when included (for now)
+            if include_as.nil? && var['short']
+              on_args << "-#{ var['short'] }"
+            end
+            
+            on_args << "--[no-]#{ cli_option_name }"
+            
+          else
+            ruby_type = case var['type']
+            when 'string'
+              String
+            when Hash
+              if var['type'].key? 'one_of'
+                klass = Class.new
+                opts.accept(klass) {|value|
+                  if var['type']['one_of'].include? value
+                    value
+                  else
+                    raise ArgumentError, "argument '#{ cli_option_name }' must be " +
+                      "one of: #{ var['type']['one_of'].join(', ') }"
+                  end
+                }
+                klass
+              else 
+                raise ArgumentError, "bad type: #{ var['type'].inspect }"
+              end
+            else
+              raise ArgumentError, "bad type: #{ var['type'].inspect }"
+            end
+            
+            # don't use short names when included (for now)
+            if include_as.nil? && var['short']
+              on_args << "-#{ var['short'] } #{ cli_option_name.upcase }"
+            end
+            
+            on_args << "--#{ cli_option_name }=#{ cli_option_name.upcase }"
+            
+            on_args << ruby_type
+          end
+          
+          # description
+          description = if var.key? 'description'
+            var['description'] 
+          else
+            "set the #{ ansible_var_name } variable"
+          end
+          
+          if var['type'].is_a?(Hash) && var['type'].key?('one_of')
+            lb = "\n" + "\t" * 5
+            description += " options:" + 
+              "#{ lb }#{ var['type']['one_of'].join(lb) }"
+          end
+          
+          on_args << description
+          
+          if role.defaults.key? ansible_var_name
+            on_args << if var['type'] == 'boolean'
+              if role.defaults[ansible_var_name]
+                "default --#{ cli_option_name }"
+              else
+                "default --no-#{ cli_option_name }"
+              end
+            else
+              "default = #{ role.defaults[ansible_var_name] }"
+            end
+          end
+          
+          QB.debug "adding option", option: option, on_args: on_args
+          
+          opts.on(*on_args) do |value|
+            QB.debug  "setting option",
+                      option: option,
+                      value: value
+            
+            option.value = value
+          end
+        end
+      end # each var
+    end # add 
+    
+    def self.parse! role, args      
+      options = {}
+      
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = "qb #{ role.name } [OPTIONS] DIRECTORY"
+        
+        add opts, options, role
+        
+        # No argument, shows at tail.  This will print an options summary.
+        # Try it and see!
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+      end
+      
+      opt_parser.parse! args
+      
+      options
+    end # parse!
+  end # Options
+end # QB

data/lib/qb/role.rb

@@ -1,7 +1,121 @@
+require 'yaml'
+require 'cmds'
+
 module QB
   class Role
     attr_accessor :path, :name, :rel_path
     
+    # errors
+    # ======
+    
+    # base for errors in the module, extends QB:Error
+    class Error < QB::Error
+    end
+    
+    # raised by `.require` when no roles match input
+    class NoMatchesError < Error
+      attr_accessor :input
+      
+      def initialize input
+        @input = input
+        
+        super "no roles match input #{ @input.inspect }"
+      end
+    end
+    
+    # rasied by `.require` when multiple roles match
+    class MultipleMatchesError < Error
+      attr_accessor :input, :matches
+      
+      def initialize input, matches
+        @input = input
+        @matches = matches
+        
+        super "mutiple roles match input #{ @input.inspect }:\n#{ @matches.join("\n") }"
+      end
+    end
+    
+    # static role utils
+    # =================
+    
+    # true if pathname is a QB role directory.
+    def self.role_dir? pathname
+      # must be a directory
+      pathname.directory? &&
+      # and must have meta/qb.yml or meta/qb file
+      ['qb.yml', 'qb'].any? {|filename| pathname.join('meta', filename).file?}
+    end
+    
+    # array of Pathname places to look for role dirs.
+    def self.search_path
+      [
+        QB::ROLES_DIR,
+        Pathname.new(Dir.getwd).join('roles'),
+        Pathname.new(Dir.getwd).join('dev', 'roles'),
+        Pathname.new(Dir.getwd).join('dev', 'roles', 'tmp'),
+      ]
+    end
+    
+    # array of QB::Role found in search path.
+    def self.available
+      search_path.
+        select {|search_dir|
+          # make sure it's there (and a direcotry)
+          search_dir.directory?
+        }.
+        map {|search_dir|
+          # grab all the child directories that are role directories
+          search_dir.children.select {|child| role_dir? child }
+        }.
+        flatten.
+        # needed when qb is run from the qb repo since QB::ROLES_DIR and
+        # ./roles are the same dir
+        uniq.
+        map {|role_dir|
+          QB::Role.new role_dir
+        }
+    end
+    
+    # get an array of QB::Role that match an input string
+    def self.matches input
+      available.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
+      }.tap {|matches|
+        QB.debug "role matches" => matches
+      }
+    end
+    
+    # find exactly one matching role for the input string or raise.
+    def self.require input
+      matches = self.matches input
+      
+      role = case matches.length
+      when 0
+        raise NoMatchesError.new input
+      when 1
+        matches[0]
+      else
+        raise MultipleMatchesError.new input, matches
+      end
+      
+      QB.debug "role match" => role
+      
+      role
+    end
+    
+    # instance methods
+    # ================
+    
     def initialize path
       @path = path
       
@@ -35,5 +149,72 @@ module QB
     def options_key
       @rel_path.to_s
     end
+    
+    # load qb metadata from meta/qb.yml or from executing meta/qb and parsing
+    # the YAML written to stdout.
+    #
+    # if `cache` is true caches it as `@meta`
+    # 
+    def load_meta cache = true
+      meta = if (@path + 'meta' + 'qb').exist?
+        YAML.load(Cmds.out!((@path + 'meta' + 'qb').realpath.to_s)) || {}
+      elsif (@path + 'meta' + 'qb.yml').exist?
+        YAML.load((@path + 'meta' + 'qb.yml').read) || {}
+      else
+        {}
+      end
+      
+      if cache
+        @meta = meta
+      end
+      
+      meta
+    end
+    
+    # gets the qb metadata for the role
+    def meta
+      @meta || load_meta
+    end
+    
+    # gets the variable prefix that will be appended to cli options before
+    # passing them to the role. defaults to `#namespaceless` unless specified
+    # in meta.
+    def var_prefix
+      meta['var_prefix'] || namespaceless
+    end
+    
+    # gets the vars from the metadata, defaulting to [] if noe defined.
+    def vars
+      meta['vars'] || []
+    end
+    
+    # loads the defaults from defaults/main.yml, caching by default
+    def load_defaults cache = true
+      defaults_path = @path + 'defaults' + 'main.yml'
+      defaults = if defaults_path.file?
+        YAML.load(defaults_path.read) || {}
+      else
+        {}
+      end
+      
+      if cache
+        @defaults = defaults
+      end
+      
+      defaults
+    end
+    
+    # gets the role variable defaults from defaults/main.yml, or {}
+    def defaults
+      @defaults || load_defaults
+    end
+    
+    def save_options
+      if meta.key? 'save_options'
+        !!meta['save_options']
+      else
+        true
+      end
+    end
   end
 end

data/lib/qb/version.rb

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

data/library/git_mkdir.py

@@ -38,13 +38,15 @@ def cd(newdir):
 def main():
     module = AnsibleModule(
         argument_spec = dict(
-            path=dict(required=True),
+            path=dict(required = True),
+            commit=dict(required = False, default = False, type = 'bool'),
         ),
         supports_check_mode = False,
     )
     
     changed = False
     path = module.params['path']
+    commit = module.params['commit']
     
     if os.path.isdir(path) is False:
         mkdir_p(path)
@@ -54,8 +56,9 @@ def main():
     
     if (not os.path.exists(keep_path)) and (not contians_files(path)):
         open(os.path.join(path, '.gitkeep'), 'a').close()
-        with cd(path):
-            subprocess.check_call(['git', 'add', '-f', '.gitkeep'])
+        if commit is True:
+            with cd(path):
+                subprocess.check_call(['git', 'add', '-f', '.gitkeep'])
         changed = True
 
     module.exit_json(

data/roles/qb.git_repo/meta/main.yml

@@ -1,5 +1,7 @@
 ---
 # meta file for qb.git_repo
 
-dependencies: []
-# - role: role-name
+dependencies:
+- role: qb.gitignore
+  gitignore_name: Global/OSX
+  when: ansible_distribution == "MacOSX"

data/roles/qb.gitignore/meta/main.yml

@@ -3,5 +3,4 @@
 
 allow_duplicates: yes
 
-dependencies:
-- role: qb.git_repo
+dependencies: []

data/roles/qb.npm/defaults/main.yml

@@ -0,0 +1,16 @@
+---
+# defaults file for qb.npm
+npm_force: false
+
+# package.json stuff
+npm_name: "{{ qb_dir | basename }}"
+npm_scoped_name: "{{ ('@' + npm_scope + '/' + npm_name) if (npm_scope is defined) else npm_name }}"
+npm_private: true
+npm_version: "0.1.0"
+npm_description: "{{ npm_scoped_name }} package"
+npm_main: "index.js"
+npm_keywords: []
+npm_license: "{{ 'UNLICENSED' if npm_private else 'ISC' }}"
+npm_author: "{{ npm_scope if (npm_scope is defined) else ansible_env.GITHUB_USER }}"
+
+npm_project: false

data/roles/qb.npm/meta/main.yml

@@ -0,0 +1,14 @@
+---
+# meta file for qb.npm
+
+allow_duplicates: yes
+
+dependencies:
+- role: qb.gitignore
+  gitignore_name: Node
+  gitignore_force: "{{ npm_force }}"
+  
+- role: qb.project
+  project_private: "{{ npm_private }}"
+  project_force: "{{ npm_force }}"
+  when: npm_project

data/roles/qb.npm/meta/qb.yml

@@ -0,0 +1,71 @@
+---
+# meta/qb.yml file for qb.npm
+# 
+# qb settings for this role. see README.md for more info.
+#
+
+# prefix for role variables
+var_prefix: null
+
+# how to get a default for `dir` if it's not provided as the 
+default_dir: null
+
+# set to false to not save options in /Users/nrser/dev/gh/nrser/qb/roles/qb.npm/.qb-options.yml
+save_options: true
+
+vars:
+# - name: example
+#   description: an example of a variable.
+#   required: false
+#   type: boolean # boolean (default) | string
+#   short: e
+- name: force
+  description: force stuff (npm init, qb.gitigore, qb.project).
+  type: boolean
+  short: f
+  save: false
+
+- name: scope
+  description: npm scope to create the module under.
+  type: string
+  short: s
+
+- name: name
+  description: name of npm module.
+  type: string
+
+- name: private
+  description: mark the npm module private in package.json
+  type: boolean
+
+- name: version
+  description: package.json version.
+  type: string
+
+- name: description
+  description: package.json description.
+  type: string
+
+- name: main
+  description: pacakge.json main (entry point).
+  type: string
+
+# TODO lists don't work
+# - name: keywords
+#   description: package.json keywords
+#   type: Array<string>
+
+- name: license
+  description: package.json license.
+  type: string
+
+- name: author
+  description: pacakge.json author.
+  type: string
+
+- name: project
+  description: include qb.project role.
+  type: boolean
+  short: p
+
+- include: qb.project

data/roles/qb.npm/tasks/main.yml

@@ -0,0 +1,8 @@
+---
+# tasks file for qb.npm_module
+
+- name: create package.json
+  template:
+    src: package.json.j2
+    dest: "{{ qb_dir }}/package.json"
+    force: "{{ npm_force }}"

data/roles/qb.npm/templates/package.json.j2

@@ -0,0 +1,13 @@
+{
+  "name": "{{ npm_scoped_name }}",
+  "private": {{ 'true' if npm_private else 'false' }},
+  "version": "{{ npm_version }}",
+  "description": "{{ npm_description }}",
+  "main": "{{ npm_main }}",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": {{ npm_keywords | to_json }},
+  "author": "{{ npm_author }}",
+  "license": "{{ npm_license }}"
+}

data/roles/qb.project/meta/main.yml

@@ -2,7 +2,4 @@
 # meta file for qb.project
 
 dependencies:
-- role: qb.gitignore
-  gitignore_name: Global/OSX
-  gitignore_force: "{{ project_force }}"
-    
+- role: qb.git_repo

data/roles/qb.project/tasks/main.yml

@@ -21,6 +21,8 @@
 - name: create tmp directory
   git_mkdir:
     path: "{{ qb_dir }}/tmp"
+    # have to explicitly commit it since it's ignored 
+    commit: true
   when: project_tmp
     
 - name: ignore tmp dir in git

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qb
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-02 00:00:00.000000000 Z
+date: 2016-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,6 +109,7 @@ files:
 - dev/setup.yml
 - exe/qb
 - lib/qb.rb
+- lib/qb/options.rb
 - lib/qb/role.rb
 - lib/qb/version.rb
 - library/git_mkdir.py
@@ -419,6 +420,11 @@ files:
 - roles/qb.install_gem/meta/main.yml
 - roles/qb.install_gem/meta/qb.yml
 - roles/qb.install_gem/tasks/main.yml
+- roles/qb.npm/defaults/main.yml
+- roles/qb.npm/meta/main.yml
+- roles/qb.npm/meta/qb.yml
+- roles/qb.npm/tasks/main.yml
+- roles/qb.npm/templates/package.json.j2
 - roles/qb.project/.qb-options.yml
 - roles/qb.project/defaults/main.yml
 - roles/qb.project/files/ansible.cfg