qb 0.1.14 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eff9442acda19ad45e2a0fc85dde3fa21f34d33a
-  data.tar.gz: 0ca507c08588f891232f983b45e10b953281dce8
+  metadata.gz: ae9aeb0e2f878eadc6e1cf220a2a7e26783fd358
+  data.tar.gz: c13dd57a5475abe283a69ca5b941b14df7cf7394
 SHA512:
-  metadata.gz: c05d0cf7fad902ca2a4988170b614a1c21444bf51d0c16ce0e6c63b5a17a826a93014bf6ef65adefb5507cd9c4ecc04ef79f51725464e7612fb269eeb014393d
-  data.tar.gz: 22d00588741f03b6044dddb945388e12e08f07428ed8168ce6faa5aeb6494f3e01afc64096e2947cde146dbb6c90a4b8233a19bcbcb48a0776dd884b76aa6df0
+  metadata.gz: 94c65c40bee65ff720d9cb28ab0e119a4da69f62d831e0dbef002e0f9b77f4649d78ee97e85ca9e4d8f650e92075c81a80d3479d3db880185238fde38e18bdd2
+  data.tar.gz: 851f4d7785b1b68310b7003393d2deb1a638345da45de47912c85651f931936a79013132f90c79307f435a65ecf89d50254c91fa7b3a4ecacb4fb73abc200998

data/exe/qb

@@ -143,7 +143,15 @@ 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).tap {|saved_options|
+    # convert old _ separated names to - separated
+    YAML.load(saved_options_path.read).map {|role_options_key, role_options|
+      [
+        role_options_key,
+        role_options.map {|name, value|
+          [QB::Options.cli_ize_name(name), value]
+        }.to_h
+      ]
+    }.to_h.tap {|saved_options|
       debug "found saved options", saved_options
     }
   else
@@ -156,8 +164,8 @@ def main args
     
     debug "found saved options for role", role_saved_options
     
-    role_saved_options.each do |cli_option_name, value|
-      option = options[cli_option_name]
+    role_saved_options.each do |option_cli_name, value|
+      option = options[option_cli_name]
       
       if option.value.nil?
         debug "setting from saved options", option: option, value: value
@@ -181,7 +189,7 @@ def main args
   }
   
   set_options.values.each do |option|
-    playbook_role[option.ansible_var_name] = option.value
+    playbook_role[option.var_name] = option.value
   end
   
   playbook = [
@@ -216,12 +224,12 @@ def main args
   # save the options back
   if (
     # we set some options that we can save
-    set_options.values.select {|o| o.save }.length > 0 &&
+    set_options.values.select {|o| o.save? }.length > 0 &&
     # the role says to save options
     role.save_options
   )
     saved_options[role.options_key] = set_options.select{|key, option|
-      option.save
+      option.save?
     }.map {|key, option|
       [key, option.value]
     }.to_h

data/lib/qb/options.rb

@@ -1,16 +1,8 @@
 require 'optparse'
+require 'weakref'
 
 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
     # ======
     
@@ -26,129 +18,203 @@ module QB
       end
     end
     
-    def self.include_role opts, options, include_var
-      role_name = include_var['include']
+    # raised when there's bad option metadata 
+    class MetadataError < Error
+    end
+    
+    def self.cli_ize_name option_name
+      option_name.gsub '_', '-'
+    end
+    
+    def self.var_ize_name option_name
+      option_name.gsub '-', '_'
+    end
+    
+    # 
+    class Option
+      # the role that this option is for
+      # attr_reader :role
+      
+      # the entry from the qb metadata for this option
+      attr_reader :meta
+      
+      # array of strings representing how this option was included
+      # empty for top-level options
+      attr_reader :include_path
+      
+      # the name of the option in the qb metadata, equal to #meta['name']
+      attr_reader :meta_name
+      
+      # the name that this option will be available in the cli as
+      attr_reader :cli_name
+      
+      # the name that the value will be passed to ansible as
+      attr_reader :var_name
+      
+      # the value of the option, or `nil` if we never assign one
+      attr_accessor :value
+      
+      def initialize role, meta, include_path
+        # @role = WeakRef.new role
+        @meta = meta
+        @include_path = include_path
+        
+        @meta_name = meta.fetch 'name'
+        
+        @cli_name = if @include_path.empty?
+          Options.cli_ize_name @meta_name
+        else
+          "#{ @include_path.join('-') }-#{ Options.cli_ize_name @meta_name }"
+        end
+        
+        @var_name = if role.var_prefix
+          "#{ role.var_prefix }_#{ Options.var_ize_name @meta_name }"
+        else
+          Options.var_ize_name @meta_name
+        end
+        
+        @value = nil
+      end
+      
+      # if the option is required in the cli
+      def required?
+        !!meta_or(['required', 'require'], false)
+      end
+      
+      # if we should save the option value in .qb-options.yml
+      def save?
+        !!meta_or('save', true)
+      end
+      
+      def description
+        value = meta_or 'description',
+          "set the #{ @var_name } role variable"
+          
+        if @meta['type'].is_a?(Hash) && @meta['type'].key?('one_of')
+          line_break = "\n" + "\t" * 5
+          value += " options:" + 
+            "#{ line_break }#{ @meta['type']['one_of'].join(line_break) }"
+        end
+        
+        value
+      end
+      
+      private
+      
+      # get the value at the first found of the keys or the default.
+      def meta_or keys, default
+        keys = [keys] if keys.is_a? String
+        keys.each do |key|
+          if @meta.key? key
+            return @meta[key]
+          end
+        end
+        default
+      end
+      
+    end # Option
+    
+    def self.include_role opts, options, include_meta, include_path
+      role_name = include_meta['include']
       role = QB::Role.require role_name
-      include_as = include_var['as'] || role.namespaceless
+      new_include_path = if include_meta.key? 'as'
+        case include_meta['as']
+        when nil, false
+          # include it in with the parent role's options
+          include_path
+        when String
+          include_path + [include_meta['as']]
+        else
+          raise MetadataError.new,
+            "bad 'as' value: #{ include_meta.inspect }"
+        end
+      else
+        include_path + [role.namespaceless]
+      end
       
-      QB.debug "including #{ role.name } as #{ include_as }"
+      QB.debug "including #{ role.name } as #{ new_include_path.join('-') }"
       
-      add opts, options, role, include_as
+      add opts, options, role, new_include_path
     end
     
     # add the options from a role to the OptionParser
-    def self.add opts, options, role, include_as = nil
+    def self.add opts, options, role, include_path = []
       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
+      role.options.each do |option_meta|
+        if option_meta.key? 'include'
+          include_role opts, options, option_meta, include_path
           
         else
           # create an option
+          option = Option.new role, option_meta, include_path
           
-          # 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 }"
+          arg_style = if option.required?
+            :REQUIRED
           else
-            qb_meta_name
+            :OPTIONAL
           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'
+          if option.meta['type'] == 'boolean'
             # don't use short names when included (for now)
-            if include_as.nil? && var['short']
-              on_args << "-#{ var['short'] }"
+            if include_path.empty? && option.meta['short']
+              on_args << "-#{ option.meta['short'] }"
             end
             
-            on_args << "--[no-]#{ cli_option_name }"
+            on_args << "--[no-]#{ option.cli_name }"
             
           else
-            ruby_type = case var['type']
+            ruby_type = case option.meta['type']
+            when nil
+              raise MetadataError,
+                "must provide type in qb metadata for option #{ option.meta_name }"
             when 'string'
               String
             when Hash
-              if var['type'].key? 'one_of'
+              if option.meta['type'].key? 'one_of'
                 klass = Class.new
                 opts.accept(klass) {|value|
-                  if var['type']['one_of'].include? value
+                  if option.meta['type']['one_of'].include? value
                     value
                   else
-                    raise ArgumentError, "argument '#{ cli_option_name }' must be " +
-                      "one of: #{ var['type']['one_of'].join(', ') }"
+                    raise MetadataError,
+                      "option '#{ option.cli_name }' must be one of: #{ option.meta['type']['one_of'].join(', ') }"
                   end
                 }
                 klass
               else 
-                raise ArgumentError, "bad type: #{ var['type'].inspect }"
+                raise MetadataError,
+                  "bad type for option #{ option.meta_name }: #{ option.meta['type'].inspect }"
               end
             else
-              raise ArgumentError, "bad type: #{ var['type'].inspect }"
+              raise MetadataError,
+                "bad type for option #{ option.meta_name }: #{ option.meta['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 }"
+            if include_path.empty? && option.meta['short']
+              on_args << "-#{ option.meta['short'] } #{ option.cli_name.upcase }"
             end
             
-            on_args << "--#{ cli_option_name }=#{ cli_option_name.upcase }"
+            on_args << "--#{ option.cli_name }=#{ option.cli_name.upcase }"
             
             on_args << ruby_type
           end
           
-          # description
-          description = if var.key? 'description'
-            var['description'] 
-          else
-            "set the #{ ansible_var_name } variable"
-          end
+          on_args << option.description
           
-          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 }"
+          if role.defaults.key? option.var_name
+            on_args << if option.meta['type'] == 'boolean'
+              if role.defaults[option.var_name]
+                "default --#{ option.cli_name }"
               else
-                "default --no-#{ cli_option_name }"
+                "default --no-#{ option.cli_name }"
               end
             else
-              "default = #{ role.defaults[ansible_var_name] }"
+              "default = #{ role.defaults[option.var_name] }"
             end
           end
           
@@ -161,6 +227,8 @@ module QB
             
             option.value = value
           end
+          
+          options[option.cli_name] = option
         end
       end # each var
     end # add 

data/lib/qb/role.rb

@@ -183,11 +183,14 @@ module QB
       meta['var_prefix'] || namespaceless
     end
     
-    # gets the vars from the metadata, defaulting to [] if noe defined.
-    def vars
-      meta['vars'] || []
+    # get the options from the metadata, defaulting to [] if none defined
+    def options
+      meta['options'] || meta['opts'] || meta['vars'] || []
     end
     
+    # old name
+    alias_method :vars, :options
+    
     # loads the defaults from defaults/main.yml, caching by default
     def load_defaults cache = true
       defaults_path = @path + 'defaults' + 'main.yml'

data/lib/qb/version.rb

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

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

@@ -5,11 +5,3 @@ allow_duplicates: yes
 
 dependencies: 
 - role: qb.role
-  role_role_name: "{{ qb_role_name }}"
-  role_defaults: "{{ qb_role_defaults }}"
-  role_files: "{{ qb_role_files }}"
-  role_handlers: "{{ qb_role_handlers }}"
-  role_meta: "{{ qb_role_meta }}"
-  role_tasks: "{{ qb_role_tasks }}"
-  role_templates: "{{ qb_role_templates }}"
-  role_vars: "{{ qb_role_vars }}"

data/roles/qb.qb_role/meta/qb.yml

@@ -10,38 +10,6 @@ var_prefix: null
 # how to get a default for `dir` if it's not provided as the 
 default_dir: null
 
-vars:  
-- name: name
-  type: string
-  description: name of the role.
-  short: n
-
-- name: files
-  type: boolean
-  description: create a files directory.
-  short: f
-
-- name: handlers
-  type: boolean
-  description: create handlers/main.yml
-  short: a
-
-- name: meta
-  type: boolean
-  description: create meta/main.yml
-  short: m
-
-- name: tasks
-  type: boolean
-  description: create tasks/main.yml
-  short: t
-
-- name: templates
-  type: boolean
-  description: create a templates directory.
-  short: e
-
-- name: vars
-  type: boolean
-  description: create vars/main.yml
-  short: v
+options:
+- include: qb.role
+  as: null

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

@@ -1,5 +1,5 @@
 ---
-# meta/qb.yml file for {{ qb_role_name }}
+# meta/qb.yml file for {{ role_role_name }}
 # 
 # qb settings for this role. see README.md for more info.
 #
@@ -13,7 +13,7 @@ default_dir: null
 # set to false to not save options in {{ qb_dir }}/.qb-options.yml
 save_options: true
 
-vars: []
+options: []
 # - name: example
 #   description: an example of a variable.
 #   required: false

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

@@ -9,23 +9,12 @@ role_tasks: true
 role_templates: false
 role_vars: false
 
-# switch to init a project repo for the role
-role_project: false
-
-# owner if the repo, which defauts to the `GITHUB_USER` env var
-role_project_owner: "{{ ansible_env.GITHUB_USER }}"
+# galaxy
+role_galaxy: false
+role_author: "{{ git_user_name }}"
+role_description: "{{ role_role_name }} ansible role."
+role_license: "BSD"
+role_min_ansible_version: 2.1.2.0
 
-# the name of the project repo, which defaults to "ansible-<role-name>"
-role_project_name: "ansible-{{ role_role_name }}"
-
-# rest of the project variables default to false except readme
-role_project_bin: false
-role_project_dev: false
-role_project_dev_bin: false
-role_project_setup: false
-role_project_scratch: false
-role_project_tmp: false
-role_project_readme: true
-role_project_hub: false
-role_project_private: false
-role_project_force: false
+# init a project repo for the role
+role_project: false

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

@@ -3,16 +3,4 @@
 
 dependencies:
 - role: qb.project
-  project_owner: "{{ role_project_owner }}"
-  project_name: "{{ role_project_name }}"
-  project_bin: "{{ role_project_bin }}"
-  project_dev: "{{ role_project_dev }}"
-  project_dev_bin: "{{ role_project_dev_bin }}"
-  project_setup: "{{ role_project_setup }}"
-  project_scratch: "{{ role_project_scratch }}"
-  project_tmp: "{{ role_project_tmp }}"
-  project_readme: "{{ role_project_readme }}"
-  project_hub: "{{ role_project_hub }}"
-  project_private: "{{ role_project_private }}"
-  project_force: "{{ role_project_force }}"
   when: role_project

data/roles/qb.role/meta/qb.yml

@@ -16,6 +16,11 @@ vars:
   description: name of the role.
   short: n
 
+- name: defaults
+  type: boolean
+  description: create a defaults directory.
+  short: d
+
 - name: files
   type: boolean
   description: create a files directory.
@@ -46,19 +51,15 @@ vars:
   description: create vars/main.yml
   short: v
 
+- name: galaxy
+  type: boolean
+  description: include galaxy info in meta/main.yml
+  short: g
+
 - name: project
   type: boolean
   description: create a project repo for this role
+  short: p
 
-- name: project_owner
-  type: string
-  description: the github owner of the project repo
-  
-- name: project_name
-  type: string
-  description: the github name of the project repo
-
-- name: project_hub
-  type: boolean
-  description: switch to `hub create` the project repo
+- include: qb.project
   

data/roles/qb.role/templates/meta/main.yml.j2

@@ -5,3 +5,11 @@ allow_duplicates: yes
 
 dependencies: []
 # - role: role-name
+
+{% if role_galaxy %}
+galaxy_info:
+  author: {{ role_author | to_json }}
+  description: {{ role_description | to_json }}
+  license: {{ role_license | to_json }}
+  min_ansible_version: {{ role_min_ansible_version | to_json }}
+{% endif %}

data/roles/qb.role/vars/main.yml

@@ -0,0 +1,20 @@
+---
+# vars file for qb.role
+
+# overriding the qb.project defaults has to happen here - values in 
+# defaults/main.yml **will not** be visible to the included role
+
+# the name of the project repo, which defaults to "ansible-<role-name>"
+project_name: "ansible-{{ role_role_name }}"
+
+# rest of the project variables default to false except readme
+project_bin: false
+project_dev: false
+project_dev_bin: false
+project_setup: false
+project_scratch: false
+project_tmp: false
+project_readme: true
+project_hub: false
+project_private: false
+project_force: false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qb
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.15
 platform: ruby
 authors:
 - nrser
@@ -440,7 +440,6 @@ files:
 - roles/qb.project/templates/bootstrap.yml.j2
 - roles/qb.project/templates/setup.yml.j2
 - roles/qb.qb_role/.qb-options.yml
-- roles/qb.qb_role/defaults/main.yml
 - roles/qb.qb_role/meta/main.yml
 - roles/qb.qb_role/meta/qb.yml
 - roles/qb.qb_role/tasks/main.yml
@@ -461,6 +460,7 @@ files:
 - roles/qb.role/templates/meta/main.yml.j2
 - roles/qb.role/templates/tasks/main.yml.j2
 - roles/qb.role/templates/vars/main.yml.j2
+- roles/qb.role/vars/main.yml
 - temp.yml
 - tmp/.gitkeep
 homepage: https://github.com/nrser/qb

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

@@ -1,10 +0,0 @@
----
-# defaults file for qb.qb_role
-qb_role_name: "{{ dir | basename }}"
-qb_role_defaults: true
-qb_role_files: false
-qb_role_handlers: false
-qb_role_meta: true
-qb_role_tasks: true
-qb_role_templates: false
-qb_role_vars: false