qb 0.1.80 → 0.1.81

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf03e970df417441d4a76b74959bdcdcb3529083
-  data.tar.gz: 178dc4067ed6526dae586a5768148009c713cd1a
+  metadata.gz: bba65080a724f81277adc9a2a56f8e6ba62c165c
+  data.tar.gz: be45317a1716f484e9040ef0830d02cd0439d3f2
 SHA512:
-  metadata.gz: 49011243189114d15ce05087b5c8c168df517678240310ede118a9360765089e7a40260b7b283513f8df5568bf0ae3bccc782321e91daac80da74b4502a70051
-  data.tar.gz: d63066f007fad95b6cdf6152b23888dbd8a60cb189bd0a800507ea59c43475923eb8a8720fcad616fd7a71ed4f47b2654f54ebabc00537cd285fc4b4bdcf918a
+  metadata.gz: da5cacdac63f70bd0aa391c97ab289e35f1596cf7fdc7a48ccee6c943a6cf91da896505c18d97339ca7b4e2357a61757e48cdef8c3c2f584c202b7a2e30d0314
+  data.tar.gz: e46d091cc8abb4800c1734a6d2f643852dbd7375d6dff4eb1509ae4331b6905f80e9b4bd2242431e6c229ff85566a10d9ceb6d69180020ef522aface45cf6d92

data/lib/qb/version.rb

@@ -4,7 +4,7 @@ module QB
   
   GEM_NAME = 'qb'
   
-  VERSION = "0.1.80"
+  VERSION = "0.1.81"
   
   MIN_ANSIBLE_VERSION = Gem::Version.new '2.1.2'
   

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

@@ -16,6 +16,9 @@ role_library: false
 # modules
 role_modules: []
 
+# filter plugins
+role_filter_plugins: []
+
 # galaxy
 role_galaxy: false
 role_author: "{{ git_user_name }}"

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

@@ -90,5 +90,17 @@ vars:
     
     --modules=some_module
 
+- name: filter_plugins
+  description: >-
+    Generate `filter_plugins` directory and file boilerplate(s).
+  type: array
+  examples:
+  - |
+    Generates a `filter_plugins/filter_plugins.py`
+    
+    qb qb.role roles/owner.new_role --filter-plugins
+    
+    
+
 - include: qb.project
   

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

@@ -148,4 +148,19 @@
 - include: module.yml 
   with_items: "{{ role_modules }}"
   loop_control:
-    loop_var: role_module
+    loop_var: role_module
+
+
+# Plugins
+# =====================================================================
+
+# Filter PLugins
+# ---------------------------------------------------------------------
+
+- when: role_filter_plugins|length > 0
+  name: >-
+    Generate filter plugin files.
+  include: >-
+    {{ role_path }}/tasks/plugins/filter_plugins.yml
+  
+

data/roles/qb.role/tasks/plugins/_filter_plugin.yml

@@ -0,0 +1,12 @@
+---
+# Generate a filter plugin boilerplate file.
+
+- name: >-
+    Generate `filter_plugins/{{ name }}_filters.py` filter plugin file.
+  template:
+    src: >-
+      {{ role_path }}/templates/filter_plugins/filter_plugin.py.j2
+    dest: >-
+      {{ role_dest }}/filter_plugins/{{ name }}_plugins.py
+    force: >-
+      {{ role_force }}

data/roles/qb.role/tasks/plugins/filter_plugins.yml

@@ -0,0 +1,38 @@
+---
+# Generate filter plugins boilerplate(s).
+
+- name: >-
+    Create `filter_plugins` directory.
+  file:
+    dest: >-
+      {{ role_dest }}/filter_plugins
+    state: directory
+
+- name: >-
+    Figure out if we received a single truthy value that indicates we should
+    use the default filter plugin name.
+  set_fact:
+    role_filter_plugins_default: >-
+      {{
+        role_filter_plugins|length == 1 and
+        role_filter_plugins[0].lower() in ['1', 'true', 't', 'yes', 'y']
+      }}
+
+- when: role_filter_plugins_default
+  name: >-
+    Create default `filter_plugins/{{ role_role_name }}_plugins.py`
+  include: >-
+    {{ role_path }}/tasks/plugins/_filter_plugin.yml
+  vars:
+    name: >-
+      {{ role_role_name }}
+
+- when: not role_filter_plugins_default
+  name: >-
+    Create each of filter plugins sepcified in `role_filter_plugins`.
+  with_items: >-
+    {{ role_filter_plugins }}
+  loop_control:
+    loop_var: name
+  include: >-
+    {{ role_path }}/tasks/plugins/_filter_plugin.yml

data/roles/qb.role/templates/filter_plugins/filter_plugin.py.j2

@@ -0,0 +1,67 @@
+# `{{ name }}` Ansible/Jinja2 Filters for `{{ role_role_name }}` 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 my_{{ name }}_filter(subject, *args, **kwds):
+    '''
+    TODO doc me!
+    '''
+    
+    raise NotImplementedError("Implement me!")
+
+
+# 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):
+    '''
+    `{{ name }}` Ansible/Jinja2 filters for `{{ role_role_name }}` role.
+    '''
+
+    def filters(self):
+        return {
+            'my_{{ name }}_filter': my_{{ name }}_filter,
+        }
+    # 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()
+    

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qb
 version: !ruby/object:Gem::Version
-  version: 0.1.80
+  version: 0.1.81
 platform: ruby
 authors:
 - nrser
@@ -621,9 +621,12 @@ files:
 - roles/qb.role/meta/qb.yml
 - roles/qb.role/tasks/main.yml
 - roles/qb.role/tasks/module.yml
+- roles/qb.role/tasks/plugins/_filter_plugin.yml
+- roles/qb.role/tasks/plugins/filter_plugins.yml
 - roles/qb.role/templates/.gitkeep
 - roles/qb.role/templates/README.md.j2
 - roles/qb.role/templates/defaults/main.yml.j2
+- roles/qb.role/templates/filter_plugins/filter_plugin.py.j2
 - roles/qb.role/templates/handlers/main.yml.j2
 - roles/qb.role/templates/library/module.rb.j2
 - roles/qb.role/templates/meta/main.yml.j2