qb 0.3.15 → 0.3.16

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

@@ -7,7 +7,7 @@
 # prefix for role variables
 var_prefix: role
 
-# how to get a default for `dir` if it's not provided as the 
+# how to get a default for `dir` if it's not provided as the
 default_dir: null
 
 vars:
@@ -98,9 +98,9 @@ vars:
   - |
     Generates a `filter_plugins/filter_plugins.py`
     
-    qb qb.role roles/owner.new_role --filter-plugins
+    qb qb.role roles/owner.new_role --filter-plugins=true
     
     
 
 - include: qb/project
-  
+  

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

@@ -39,7 +39,7 @@ save_options: true
 ansible_options: {}
 
 # Role CLI options that become Ansible vars
-options: []
+options:
 # - name: example
 #   description: an example of a variable.
 #   required: false

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

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

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

@@ -0,0 +1,23 @@
+---
+##############################################################################
+# Variable defaults for `qb/ruby/dependency` role
+#
+# @see http://docs.ansible.com/ansible/latest/playbooks_reuse_roles.html#role-default-variables
+# 
+##############################################################################
+
+# Default to target the QB DIRECTORY
+bundle_root: >-
+  {{ qb_dir }}
+
+# Default to present
+ruby_dep_state: present
+
+# Default to no version spec
+ruby_dep_version: null
+
+# Default to no comment
+ruby_dep_comment: null
+
+# Default to a runtime dependency
+ruby_dep_dev: false

data/roles/qb/ruby/dependency/filter_plugins/dependency_filters.py

@@ -0,0 +1,207 @@
+#!/usr/bin/env python2
+##############################################################################
+# `dependency` Ansible/Jinja2 filters for `qb/ruby/dependency` 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
+
+
+# Utilities
+# ============================================================================
+
+def kwd_args(f):
+    '''
+    Decorator to convert a single dict arg to keyword args.
+    
+    Allows usage of filter with keyword args as "subject" or whatever you
+    call it:
+    
+        {
+            'owner': 'beiarea',
+            'name': 'www-rails_web',
+            'tag': '0.1.2'
+        } | to_image_id
+        
+    '''
+    def new_f(*args, **kwds):
+        if len(args) == 1 and isinstance(args[0], dict):
+            return f(**args[0])
+        else:
+            return f(*args, **kwds)
+    
+    return new_f
+
+
+def quote(string):
+    '''
+    A dumb and bad sinlge quoert that relies on the argument not having any
+    single quotes in it.
+    
+    :param string: str String to quote
+    :rtype: str
+    '''
+    return "'{}'".format(string)
+
+
+def gemspec_dep_call(dev):
+    '''
+    Get the correct 'spec.add_dependency' or 'spec.add_development_dependency'
+    depending on `dev`.
+    
+    :param dev: bool
+    :rtype: str
+    '''
+    
+    if dev:
+        return 'spec.add_development_dependency'
+    else:
+        return 'spec.add_dependency'
+
+
+# Filter 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 gemspec_dep_line(name, version = None, dev = False, indent = '  '):
+    '''
+    Generate a dependency line for a `.gemspec` file.
+    
+    :param name: The gem name
+    :type name: str
+    
+    :param version: The optional version spec(s)
+    :type version: None | str | list<str>
+    
+    :param dev: If the dependency is development or not
+    :type dev: bool
+    
+    :return: The dependency line for the `.gemspec` file.
+    :rtype: str
+    
+    >>> gemspec_dep_line(name = 'yard')
+    "  spec.add_dependency 'yard'"
+    
+    >>> gemspec_dep_line(
+    ...     name = 'yard',
+    ...     version = '~> 0.9.12',
+    ... )
+    "  spec.add_dependency 'yard', '~> 0.9.12'"
+    
+    >>> gemspec_dep_line(
+    ...     name = 'yard',
+    ...     version = '~> 0.9.12',
+    ...     dev = True,
+    ... )
+    "  spec.add_development_dependency 'yard', '~> 0.9.12'"
+    
+    >>> gemspec_dep_line(
+    ...     name = 'bundler',
+    ...     version = ['~> 1.16', '>= 1.16.1'],
+    ...     dev = True,
+    ... )
+    "  spec.add_development_dependency 'bundler', '~> 1.16', '>= 1.16.1'"
+    '''
+    
+    call = gemspec_dep_call(dev)
+    args = [quote(name)]
+    
+    if not version is None:
+        if isinstance(version, list):
+            for condition in version:
+                args.append(
+                    quote(condition)
+                )
+        else:
+            args.append(quote(version))
+        
+    return "{}{} {}".format(indent, call, ", ".join(args))
+
+
+def gemspec_dep_re_str(name, version = None, dev = False):
+    '''
+    Generate a regex string for Ansible's `lineinfile` module to match
+    a dependency line for a `.gemspec` file.
+    
+    Params
+    
+    :rtype: str
+    
+    Does not doctest well due to backslashness.
+    '''
+    
+    call = gemspec_dep_call(dev)
+    
+    return "^\\s+{call}\s+[\\'\\\"]{name}[\\'\\\"]".format(
+        call = call,
+        name = name,
+    )
+
+
+def gemspec_dep_insert_after(name, version = None, dev = False):
+    '''
+    Generate a regex string for Ansible's `lineinfile` module to match
+    the last `spec.add_dependency` or `spec.add_development_dependency`,
+    depending on `dev`.
+    
+    Does not doctest well due to backslashness.
+    
+    :rtype: str
+    '''
+    
+    call = gemspec_dep_call(dev)
+    
+    return "^\\s+{call}".format(call = call)
+
+
+
+# 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):
+    '''
+    Ansible/Jinja2 filters for `qb/ruby/dependency` role.
+    '''
+
+    def filters(self):
+        return {
+            'to_gemspec_dep_line':          kwd_args(gemspec_dep_line),
+            'to_gemspec_dep_re_str':        kwd_args(gemspec_dep_re_str),
+            'to_gemspec_dep_insert_after':  kwd_args(gemspec_dep_insert_after),
+        }
+    # 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/dependency/meta/main.yml

@@ -0,0 +1,10 @@
+---
+##############################################################################
+# Ansible metadata for `qb/ruby/dependency` role
+##############################################################################
+
+allow_duplicates: yes
+
+dependencies: []
+# - role: role-name
+

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

@@ -0,0 +1,49 @@
+---
+##############################################################################
+# QB metadata for `qb/ruby/dependency` role.
+# 
+# QB settings for this role.
+# 
+# @see http://www.rubydoc.info/gems/qb/file/doc/qb_roles/metadata.md
+#
+##############################################################################
+
+# Shown in help output, etc.
+description: >-
+  TODO describe qb/ruby/dependency role
+
+# Gemspec-style requirements. Right now only `.gems.qb` is used.
+requirements:
+  gems:
+    qb: ~> 0.3.0
+
+# Prefix for role variables
+var_prefix: dependency
+
+# How to get a default for `DIRECTORY` arg if not provided by user.
+# 
+# @see http://www.rubydoc.info/gems/qb/file/doc/qb_roles/metadata/default_dir.md
+# 
+default_dir:
+- find_up: '*.gemspec'
+- find_up: Gemfile
+
+# If `true`, QB will ensure `DIRECTORY` exists before starting the play.
+mkdir: false
+
+# Default user to become for play
+default_user: null
+
+# Save options in `.qb-options.yml` files
+save_options: true
+
+# Options to pass to `ansible-playbook`
+ansible_options: {}
+
+# Role CLI options that become Ansible vars
+options: []
+# - name: example
+#   description: an example of a variable.
+#   required: false
+#   type: boolean # boolean (default) | string
+#   short: e

data/roles/qb/ruby/dependency/tasks/detect_type.yml

@@ -0,0 +1,18 @@
+---
+##
+# Detect the type of `bundle_root` - gemspec or gemfile
+##
+
+- when: bundle_root_path_facts is not defined
+  name: >-
+    Get QB path facts for the bundle root at `{{ bundle_root }}`
+  path_facts:
+    path: >-
+      {{ bundle_root }}
+  register: bundle_root_path_facts
+
+- name: >-
+    Set bundle_root_type based on `bundle_root_path_facts`
+  set_fact:
+    bundle_root_type: >-
+      {{ ('gem' in bundle_root_path_facts) | ternary('gemspec', 'gemfile') }}

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

@@ -0,0 +1,16 @@
+---
+##############################################################################
+# Main tasks for `qb/ruby/dependency` role
+##############################################################################
+
+- when: bundle_root_type is not defined
+  name: >-
+    Include tasks to detect type of `bundle_root={{ bundle_root}}`
+    (gemspec or gemfile)
+  include_tasks: >-
+    {{ role_path }}/tasks/detect_type.yml
+
+- name: >-
+    Include tasks to apply state to `{{ bundle_root_type }}` type
+  include_tasks: >-
+    {{ role_path }}/tasks/types/{{ bundle_root_type }}.yml

data/roles/qb/ruby/dependency/tasks/types/gemfile.yml

@@ -0,0 +1,6 @@
+---
+##
+# Apply state to a `Gemfile` file
+##
+
+- fail: msg="FIXME: NOT IMPLEMENTED"

data/roles/qb/ruby/dependency/tasks/types/gemspec.yml

@@ -0,0 +1,71 @@
+---
+##
+# Apply dep state to a `.gemspec` file
+##
+
+- name: >-
+    Apply `{{ ruby_dep_state }}` state to `{{ ruby_dep_name }}` dep in
+    gemspec at `{{ bundle_root_path_facts.gem.gemspec_path }}`
+  
+  lineinfile:
+    state: >-
+      {{ ruby_dep_state }}
+    
+    path: >-
+      {{ bundle_root_path_facts.gem.gemspec_path }}
+    
+    line: >-
+      {{
+        {
+          'name': ruby_dep_name,
+          'version': ruby_dep_version,
+          'dev': ruby_dep_dev,
+        } | to_gemspec_dep_line
+      }}
+    
+    # Match any dependency of this type (runtime vs dev) for this gem
+    regexp: >-
+      {{
+        {
+          'name': ruby_dep_name,
+          'version': ruby_dep_version,
+          'dev': ruby_dep_dev,
+        } | to_gemspec_dep_re_str
+      }}
+    
+    # Insert after the *last* `spec.add_dependency` or
+    # `spec.add_development_dependency` (depending on if the dep is dev)
+    insertafter: >-
+      {{
+        {
+          'name': ruby_dep_name,
+          'version': ruby_dep_version,
+          'dev': ruby_dep_dev,
+        } | to_gemspec_dep_insert_after
+      }}
+
+
+- when: >-
+    ruby_dep_comment and ruby_dep_state == 'present'
+  
+  name: >-
+    Add the comment above the dep line
+  
+  lineinfile:
+    state: present
+    
+    path: >-
+      {{ bundle_root_path_facts.gem.gemspec_path }}
+    
+    line: >-
+      {{ '  # ' + ruby_dep_comment }}
+    
+    # Insert it before the dep line, using the same regexp to find it
+    insertbefore: >-
+      {{
+        {
+          'name': ruby_dep_name,
+          'version': ruby_dep_version,
+          'dev': ruby_dep_dev,
+        } | to_gemspec_dep_re_str
+      }}