qb 0.3.12 → 0.3.13

data/roles/{qb.role → qb/role}/defaults/main.yml

@@ -7,7 +7,10 @@ role_force: false
 # Call `QB::Role.default_role_name role_dest` to get the default name
 # 
 role_role_name: >-
-  {{ 'QB::Role' | qb_send_const( 'default_role_name', role_dest ) }}
+  {{ 'QB::Role' | qb_send_const( 'default_name_for', role_dest ) }}
+
+role_namespaceless: >-
+  {{ 'QB::Role' | qb_send_const( 'namespaceless_for', role_role_name ) }}
 
 role_defaults: true
 role_files: false

data/roles/{qb.role → qb/role}/meta/main.yml

@@ -2,5 +2,5 @@
 # meta file for qb.role
 
 dependencies:
-- role: qb.project
+- role: qb/project
   when: role_project

data/roles/{qb.role → qb/role}/meta/qb.yml

@@ -5,7 +5,7 @@
 #
 
 # prefix for role variables
-var_prefix: null
+var_prefix: role
 
 # how to get a default for `dir` if it's not provided as the 
 default_dir: null
@@ -102,5 +102,5 @@ vars:
     
     
 
-- include: qb.project
+- include: qb/project
   

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

@@ -4,4 +4,4 @@
 allow_duplicates: yes
 
 dependencies: 
-- role: qb.role
+- role: qb/role

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

@@ -11,5 +11,5 @@ var_prefix: null
 default_dir: null
 
 options:  
-- include: qb.role
+- include: qb/role
   as: false

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

@@ -9,6 +9,8 @@
 - name: create meta/qb.yml
   template:
     src: qb.yml.j2
-    dest: "{{ role_dest }}/meta/qb.yml"
-    force: false
+    dest: >-
+      {{ role_dest }}/meta/qb.yml
+    force: >-
+      {{ role_force }}
   

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

@@ -14,7 +14,7 @@ requirements:
     qb: ~> 0.3.0
 
 # prefix for role variables
-var_prefix: null
+var_prefix: {{ role_namespaceless }}
 
 # how to get a default for `dir` if it's not provided as the only
 # positional argument. if a positional argument is provided it will

data/roles/{qb.role → qb/role}/tasks/main.yml

@@ -145,7 +145,8 @@
 # modules
 # =======
   
-- include: module.yml 
+- include_tasks: >-
+    {{ role_path }}/tasks/module.yml 
   with_items: "{{ role_modules }}"
   loop_control:
     loop_var: role_module
@@ -160,7 +161,7 @@
 - when: role_filter_plugins|length > 0
   name: >-
     Generate filter plugin files.
-  include: >-
+  include_tasks: >-
     {{ role_path }}/tasks/plugins/filter_plugins.yml
   
 

data/roles/{qb.role → qb/role}/tasks/plugins/filter_plugins.yml

@@ -20,19 +20,19 @@
 
 - when: role_filter_plugins_default
   name: >-
-    Create default `filter_plugins/{{ role_role_name }}_plugins.py`
-  include: >-
+    Create default `filter_plugins/{{ role_namespaceless }}_plugins.py`
+  include_tasks: >-
     {{ role_path }}/tasks/plugins/_filter_plugin.yml
   vars:
     name: >-
-      {{ role_role_name }}
+      {{ role_namespaceless }}
 
 - when: not role_filter_plugins_default
   name: >-
-    Create each of filter plugins sepcified in `role_filter_plugins`.
+    Create each of filter plugins specified in `role_filter_plugins`.
   with_items: >-
     {{ role_filter_plugins }}
   loop_control:
     loop_var: name
-  include: >-
+  include_tasks: >-
     {{ role_path }}/tasks/plugins/_filter_plugin.yml

data/roles/{qb.role → qb/role}/vars/main.yml

@@ -1,7 +1,7 @@
 ---
 # vars file for qb.role
 
-# overriding the qb.project defaults has to happen here - values in 
+# 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>"

data/roles/qb/ruby/bundler/.qb-options.yml

@@ -0,0 +1,4 @@
+---
+qb/role/qb:
+  filter-plugins:
+  - '1'

data/roles/qb/ruby/bundler/defaults/main.yml

@@ -0,0 +1,7 @@
+---
+# defaults file for qb/ruby/bundler
+
+bundle_gemfile: >-
+  {{ qb_dir }}/Gemfile
+
+bundle_gems: {}

data/roles/qb/ruby/bundler/filter_plugins/bundler_filters.py

@@ -0,0 +1,157 @@
+#!/usr/bin/env python2
+
+# `bundler` Ansible/Jinja2 Filters for `qb/ruby/bundler` Role.
+# 
+
+
+# Imports
+# ============================================================================
+
+# Make Python 2 more Python 3-like
+# from __future__ import (absolute_import, division, print_function)
+# __metaclass__ = type
+
+# from ansible.errors import AnsibleError
+
+# Some imports you may often want:
+# import sys
+# improt os
+# import subprocess
+# import yaml
+# improt json
+
+
+# Functions
+# ============================================================================
+# 
+# Suggested practice seems to be to define each filter as a top-level function
+# then expose them via the `FilterModule#filters` method below.
+# 
+
+def gem_group_option( group ):
+    '''
+    Returns the Ruby string for the `group:` option value.
+    
+    :rtype: str
+    
+    >>> gem_group_option( 'jekyll_plugins' )
+    ':jekyll_plugins'
+    
+    >>> gem_group_option( ['jekyll_plugins', 'blah'] )
+    '[:blah, :jekyll_plugins]'
+    '''
+    
+    if isinstance(group, list):
+        return "[{}]".format(
+            ", ".join( ":{}".format( s ) for s in sorted(group))
+        )
+    else:
+        return ":{}".format( group )
+
+
+'''
+Map of `gem` call option names to handlers that convert their values to 
+Ruby source stings
+'''
+gem_option_handlers = {
+    'group': gem_group_option,
+}
+
+
+def gem_option_value( name, data ):
+    '''
+    Returns the Ruby source string for value of an option to a `gem` call
+    in a Gemfile.
+    
+    Implementation just calls the function mapped to by `name` in 
+    `gem_option_handlers`.
+    
+    :rtype: str
+    
+    >>> gem_option_value( 'group', 'jekyll_plugins' )
+    ':jekyll_plugins'
+    '''
+    
+    return gem_option_handlers[name]( data )
+
+
+def gem_line( item ):
+    '''
+    Turn an `bundle_gems` item into a Gemfile line.
+    
+    >>> gem_line({
+    ...     'key': 'github-pages',
+    ...     'value': {
+    ...         'state': 'present',
+    ...         'group': 'jekyll_plugins',
+    ...     }
+    ... })
+    "gem 'github-pages', group: :jekyll_plugins"
+    
+    >>> gem_line({
+    ...     'key': 'github-pages',
+    ...     'value': {
+    ...         'state': 'present',
+    ...     }
+    ... })
+    "gem 'github-pages'"
+    '''
+    
+    line = "gem '{}'".format( item['key'] )
+    
+    options = {
+        key: data
+        for key, data
+        in item['value'].items()
+        if key != 'state'
+    }
+    
+    if len( options ) > 0:
+        option_values = ", ".join(
+            "{name}: {value}".format(
+                name = name,
+                value = gem_option_value( name, options[name])
+            )
+            for name
+            in sorted( options.keys() )
+        )
+        
+        line = "{line}, {option_values}".format(
+            line = line,
+            option_values = option_values,
+        )
+    
+    return line
+
+
+# Module
+# ============================================================================
+# 
+# How Ansible finds the filters. It looks like it gets instantiated with
+# no arguments, at least most of the time, so it pretty much just serves as
+# a well-known name to obtain the function references from.
+# 
+class FilterModule(object):
+    '''
+    `bundler` Ansible/Jinja2 filters for `qb/ruby/bundler` role.
+    '''
+
+    def filters(self):
+        return {
+            'bundle_gem_line': gem_line,
+        }
+    # filters()
+# FilterModule
+
+
+# Testing
+# ============================================================================
+# 
+# This is not standard Ansible-ness - they use `unittest.TestCase` in separate
+# files - but `doctest` seemed like a really easy way to add and run tests 
+# for these typically simple functions.
+# 
+if __name__ == '__main__':
+    import doctest
+    doctest.testmod()
+    

data/roles/qb/ruby/bundler/meta/main.yml

@@ -0,0 +1,8 @@
+---
+# meta file for qb/ruby/bundler
+
+allow_duplicates: yes
+
+dependencies: []
+# - role: role-name
+

data/roles/qb/ruby/bundler/meta/qb.yml

@@ -0,0 +1,69 @@
+---
+# meta/qb.yml file for qb/ruby/bundler
+# 
+# qb settings for this role. see README.md for more info.
+#
+
+# description of the role to show in it's help output.
+description: null
+
+# Gemspec-style requirements. Right now only `gems:qb` is used, but plan to
+# generalize in the future.
+requirements:
+  gems:
+    qb: ~> 0.3.0
+
+# prefix for role variables
+var_prefix: null
+
+# how to get a default for `dir` if it's not provided as the only
+# positional argument. if a positional argument is provided it will
+# override the method defined here.
+# 
+# options:
+# 
+# -   null
+#     -   require the value on the command line.
+# -   false
+#     -   don't provide qb_dir (means doesn't load or save options either).
+# -   git_root
+#     -   use the git root of the directory that the `qb` command is invoked
+#         from. useful for 'project-centric' commands so they can be invoked
+#         from anywhere in the repo.
+# -   cwd
+#     -   use the directory the `qb` command is invoked form.
+# -   {exe: PATH}
+#     -   invoke an executable, passing a JSON serialization of the options 
+#         mapping their CLI names to values. path can be relative to role
+#         directory.
+# -   {find_up: FILENAME}
+#     -   starting at the current directory and climbing up to parent 
+#         directories, use the first one that contains FILENAME. error
+#         if none is found.
+default_dir:
+- find_up: Gemfile
+- git_root
+
+# If `true`, QB will ensure the default dir exists before starting the play.
+# 
+# For legacy reasons, this defaults to `true` if not present, but we want to 
+# default declare it as `false` here so new roles can turn it on only if 
+# they need it.
+# 
+mkdir: false
+
+# default user to become for play
+default_user: null
+
+# set to false to not save options in .qb-options.yml files
+save_options: true
+
+# options to pass to ansible-playbook
+ansible_options: {}
+
+options: []
+# - name: example
+#   description: an example of a variable.
+#   required: false
+#   type: boolean # boolean (default) | string
+#   short: e

data/roles/qb/ruby/bundler/tasks/gems.yml

@@ -0,0 +1,12 @@
+
+- with_dict: >-
+    {{ bundle_gems }}
+  lineinfile:
+    dest: >-
+      {{ bundle_gemfile }}
+    line: >-
+      {{ item | bundle_gem_line }}
+    state: >-
+      {{ item.value.state }}
+    regexp: >-
+      ^gem '{{ item.key }}'

data/roles/qb/ruby/bundler/tasks/main.yml

@@ -0,0 +1,12 @@
+---
+# tasks file for qb/ruby/bundler
+
+- name: >-
+    Do basic setup
+  include_tasks: >-
+    {{ role_path }}/tasks/setup.yml
+
+- name: >-
+    Ensure `gem` declaration states
+  include_tasks: >-
+    {{ role_path }}/tasks/gems.yml

data/roles/qb/ruby/bundler/tasks/setup.yml

@@ -0,0 +1,13 @@
+##
+#
+##
+
+- name: >-
+    Run `bundle init` in {{ bundle_gemfile | dirname }}
+  stream:
+    cmd: bundle init
+    chdir: >-
+      {{ bundle_gemfile | dirname }}
+    creates: >-
+      {{ bundle_gemfile }}
+