qb 0.3.11 → 0.3.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1678a4a6dfc757aecb5af77047d7297a904fb31
-  data.tar.gz: 3625a1a8927af9408f0a86bf835f3036edd232e8
+  metadata.gz: cad865997a7d3c28a43696a18d61845343640f57
+  data.tar.gz: 862f3381e5233eb4958e534beeeeb6e8713f70b5
 SHA512:
-  metadata.gz: 41154f9bdd64ad770b27dec333ab1a17eb972ac3611518b2a79e945ab35b0f8e19ab4a41fadea8a3e54731ec3c030216ccf4f61b1eee70d445b6f1b28ea14e81
-  data.tar.gz: 3a123e89b2ea5b62b67b6ba07b4296f9d1a5288cb99a30effd91d58a393e902de16c0d2fd5d4d96a5151857ab367a2b99ac43b791e151140beeba3dc7609a976
+  metadata.gz: e84892a7b62dad0a3f7d4dfb4a5aa5dd5c865a3412ef8b6f1e1f70ada799e61b3f7397511a8e3aa6275c3927ff0c32c21fd1aae179bc6551689d2251db047275
+  data.tar.gz: c40a7c516e791e845d335ad3a8aa31dfc8537c3a5f7d72010cd28f1e2bd4dc04fe40c829fd600f974e72ec3f27e035dce51fbd3e1d06744c1b3b9c00a34db310

data/lib/python/qb/strings.py

@@ -0,0 +1,147 @@
+# -*- coding: utf-8 -*-
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import re
+
+
+
+# Constants
+# ============================================================================
+
+# Regular expression to split strings into their module namespace pieces by
+# `::` (Ruby) or `.` (Python, Javascript).
+# 
+NAMESPACE_SPLIT_RE = re.compile(r'(?:\:\:)|\.|\#')
+
+
+# Functions
+# ============================================================================
+
+def words(string):
+    '''break a string into words
+    
+    >>> words('git_submodule_update')
+    ['git', 'submodule', 'update']
+    
+    >>> words("qb.DoSomething")
+    ['qb', 'Do', 'Something']
+    
+    >>> words("TestGem::SomeClass")
+    ['Test', 'Gem', 'Some', 'Class']
+    
+    >>> words("MyAPIClass")
+    ['My', 'API', 'Class']
+    
+    >>> words('ThisIsAName')
+    ['This', 'Is', 'A', 'Name']
+    
+    >>> words('404Error')
+    ['404', 'Error']
+    
+    >>> words('MyPackageV1')
+    ['My', 'Package', 'V', '1']
+    
+    # Don't work with doctest I guess..?
+    # >>> [print(_) for _ in words(u'中文')]
+    # [u'中文']
+    '''
+    
+    consumers = [
+        [tag, [re.compile(pattern, re.U) for pattern in patterns]]
+        for tag, patterns in 
+        [
+            ['break', [r'([\W\_]+)']],
+            ['lower_case', [r'([a-z]+)']],
+            ['capitalized', [r'([A-Z][a-z]+)']],
+            ['acronym', [
+                r'([A-Z]+)[A-Z][a-z]',
+                r'([A-Z]+)[0-9]',
+                r'([A-Z]+)\z',
+            ]],
+            ['number', [r'([0-9]+)']],
+            ['other', [r'([^0-9a-zA-Z]+)']],
+        ]
+    ]
+    
+    def find(remaining):
+        for tag, exps in consumers:
+            for exp in exps:            
+                # print("matching %s %s %s" % (tag, exp, remaining))
+                match = exp.match(remaining)
+                if match:
+                    # print("matched %s! %s" % (tag, match.group(0)))
+                    return [tag, exp, match]
+        raise StandardError("bad string: %s" % remaining)
+    
+    index = 0
+    results = []
+    remaining = string
+    
+    while len(remaining) > 0:
+        [tag, exp, match] = find(remaining)
+        if tag != 'break':
+            results.append(remaining[:match.end(1)])
+        remaining = remaining[match.end(1):]
+    
+    return results
+
+
+def snake(name):
+    '''
+    Turn a name into underscore-separated lower case.
+    
+    >>> snake('git_submodule_update')
+    'git_submodule_update'
+    
+    >>> snake("qb.DoSomething")
+    'qb_do_something'
+    
+    >>> snake("TestGem::SomeClass")
+    'test_gem_some_class'
+    
+    >>> snake("MyAPIClass")
+    'my_api_class'
+    
+    >>> snake('ThisIsAName')
+    'this_is_a_name'
+    
+    >>> snake('404Error')
+    '404_error'
+    
+    >>> snake('MyPackageV1')
+    'my_package_v_1'
+    
+    '''
+    return '_'.join([part.lower() for part in words(name)])
+
+
+def filepath(name):
+    '''
+    Turn a name into a file path.
+
+    >>> filepath('TestGem::SomeClass')
+    'test_gem/some_class'
+    
+    >>> filepath('TestGem::SomeClass#that_method')
+    'test_gem/some_class/that_method'
+    
+    # TODO
+    # >>> filepath("TestGem::SomeClass How to do something")
+    # 'test_gem/some_class/how_to_do_something'
+    
+    >>> filepath('qb.strings.filepath')
+    'qb/strings/filepath'
+    
+    '''
+    namespaces = NAMESPACE_SPLIT_RE.split(name)
+    snaked = [snake(words_) for words_ in namespaces]
+    joined = "/".join(snaked)
+    return joined
+
+
+# testing - call camel_case on first cli arg and print result
+if __name__ == '__main__':
+    import doctest
+    doctest.testmod()

data/lib/qb/github/issue.rb

@@ -52,6 +52,20 @@ class QB::GitHub::Issue < QB::GitHub::Resource
   def self.find_by repo_id:, number:
     new QB::GitHub::API.client.issue( repo_id.path, number )
   end # .find
+
+  
+  
+  # @todo Document list method.
+  # 
+  # @param [type] arg_name
+  #   @todo Add name param description.
+  # 
+  # @return [return_type]
+  #   @todo Document return value.
+  # 
+  def self.list arg_name
+    # method body
+  end # .list
   
   
   

data/lib/qb/version.rb

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

data/plugins/filter_plugins/string_plugins.py

@@ -17,14 +17,41 @@
 # https://stackoverflow.com/questions/35139025/can-not-handle-attributeerror-module-object-has-no-attribute-maketrans
 # 
 
+
+# Imports
+# ============================================================================
+
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 import sys
 import re
+import os
 
 from ansible.errors import AnsibleError
 
+
+# Project Imports Setup
+# ----------------------------------------------------------------------------
+
+PROJECT_ROOT = os.path.realpath(
+    os.path.join(
+        os.path.dirname(os.path.realpath(__file__)), # //plugins/filter_plugins
+        '..', # //plugins
+        '..', # //
+    )
+)
+
+LIB_PYTHON_DIR = os.path.join( PROJECT_ROOT, 'lib', 'python' )
+
+if not (LIB_PYTHON_DIR in sys.path):
+    sys.path.insert(0, LIB_PYTHON_DIR)
+
+# Now we can import from `//lib/python`...
+
+import qb.strings
+
+
 def cap(string):
     '''just upper-case the first damn letter.
     
@@ -37,17 +64,6 @@ def cap(string):
     return string[0].upper() + string[1:]
     
 
-def words(string):
-    '''break a string into words
-    
-    >>> words('git_submodule_update')
-    ['git', 'submodule', 'update']
-    
-    >>> words("qb.DoSomething")
-    ['qb', 'DoSomething']
-    '''
-    return re.split('[\W\_]+', string)
-
 
 def camel_case(string):
     '''convert a name to camel case.
@@ -71,13 +87,13 @@ def camel_case(string):
 def cap_camel_case(string):
     '''convert a string to camel case with a leading capital.
     
-    >>> upper_camel_case("git_submodule_update")
+    >>> cap_camel_case("git_submodule_update")
     'GitSubmoduleUpdate'
     
-    >>> upper_camel_case("git-submodule-update")
+    >>> cap_camel_case("git-submodule-update")
     'GitSubmoduleUpdate'
     
-    >>> upper_camel_case("qb.do_something")
+    >>> cap_camel_case("qb.do_something")
     'QbDoSomething'
     '''
     return cap(camel_case(string))
@@ -89,10 +105,11 @@ class FilterModule(object):
     def filters(self):
         return {
             'cap': cap,
-            'words': words,
+            'words': qb.strings.words,
             'camel_case': camel_case,
             'cap_camel_case': cap_camel_case,
             'class_case': cap_camel_case,
+            'to_filepath': qb.strings.filepath,
         }
 
 

data/qb.gemspec

@@ -97,8 +97,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "yard"
   spec.add_development_dependency "pry"
   
-  spec.add_dependency "cmds", '~> 0.0', ">= 0.2.3"
-  spec.add_dependency "nrser", '~> 0.0', ">= 0.0.28"
+  spec.add_dependency "cmds", '~> 0.0', ">= 0.2.4"
+  spec.add_dependency "nrser", '~> 0.0', ">= 0.0.29"
   spec.add_dependency "nrser-extras", '~> 0.0', ">= 0.0.3"
   spec.add_dependency "state_mate", '~> 0.0', ">= 0.0.9"
   spec.add_dependency 'parseconfig', '~> 1.0', '>= 1.0.8'

data/roles/qb/rspex/generate/defaults/main.yml

@@ -0,0 +1,10 @@
+---
+# defaults file for qb/rspex/generate
+
+gem_root: >-
+  {{ qb_dir }}
+
+spec_dir: spec
+
+spec_abs_dir: >-
+  {{ gem_root | path_resolve( spec_dir ) }}

data/roles/qb/rspex/generate/meta/main.yml

@@ -0,0 +1,8 @@
+---
+# meta file for qb/rspex/generate
+
+allow_duplicates: yes
+
+dependencies:
+- role: nrser.rb
+

data/roles/qb/rspex/generate/meta/qb.yml

@@ -0,0 +1,91 @@
+---
+# meta/qb.yml file for qb/rspex/generate
+# 
+# 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: false # Don't prefix variables
+
+# 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: null
+
+# 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
+
+- name: spec_dir
+  description: >-
+    Directory that specs go in. May be relative to the gem root or absolute.
+  required: false
+  type: path
+  short: d
+
+- name: require
+  description: >-
+    Explicitly specify files to require at the top of spec files.
+    When not provided, will add all `<spec_dir>/*_helper.rb` files that 
+    are NOT auto-required via `<gem_root>/.rspec`.
+  required: false
+  type: list
+  short: r
+
+- name: class
+  description: >-
+    Generate spec file for a class.
+  required: false
+  type: string
+  short: c
+  

data/roles/qb/rspex/generate/tasks/class.yml

@@ -0,0 +1,22 @@
+---
+
+- name: >-
+    Set `dest` for `class={{ class }}` relative to 
+    `spec_abs_dir={{ spec_abs_dir }}`
+  set_fact:
+    dest: >-
+      {{ spec_abs_dir | path_join( (class | to_filepath) + '_spec.rb' ) }}
+
+- name: >-
+    Make sure the destination directory `{{ dest | dirname }}` exists
+  file:
+    dest: >-
+      {{ dest | dirname }}
+    state: directory
+
+- name: >-
+    Render spec file template
+  template:
+    src: class_spec.rb.j2
+    dest: >-
+      {{ dest }}

data/roles/qb/rspex/generate/tasks/helpers.yml

@@ -0,0 +1,96 @@
+---
+##
+# Figure out what's going on with helpers, which are files like
+# 
+#     <gem_root>/spec/*_helper.rb
+# 
+# They may be auto-required in `<gem_root>/.rspec` with lines like
+# 
+#     --require spec_helper.rb
+# 
+# These tasks determine what helpers a generated spec file should require.
+# 
+# Expects:
+# 
+# @var [str] spec_abs_dir
+#   Absolute path to the target gem's spec directory.
+# 
+# @var [list<str>?] require
+#   Optional list of string names to require in spec files. If not defined,
+#   it will be set - see details below.
+#   
+# 
+# Provides:
+# 
+# @var [list<str>] available_helpers
+#   List of "requirable" strings pulled from any `<spec_dir>/*_helper.rb` files
+#   found.
+# 
+# @var [list<str>] auto_require_helpers
+#   List of "auto-required" helpers parsed from `--require *_helper` lines in
+#   `<gem_root>/.rspec` (if it exists). Will be `[]` if `.rspec` doesn't exist
+#   or has not `--require *_helper` lines.
+# 
+# @var [list<str>] require
+#   List of string names to require in spec files. If this variables is *not*
+#   defined it will be set to all available helpers that are *not* 
+#   auto-required in `.rspec`.
+# 
+##
+
+- name: >-
+    Get a list of available `*_helper.rb` files in 
+    `spec_abs_dir={{ spec_abs_dir }}`
+  find:
+    paths: >-
+      {{ spec_abs_dir }}
+    patterns: '*_helper.rb'
+  register: found_helpers
+
+
+- name: >-
+    Set `available_helpers` to the extension-less basenames of each file in
+    `found_helpers.files`
+  set_fact:
+    available_helpers: >-
+      {{
+        found_helpers.files
+        | map( attribute='path' )
+        | map( 'basename' )
+        | map( 'splitext' )
+        | map( 'first' )
+        | list
+      }}
+
+
+- name: >-
+    Set `auto_require_helpers` to the list of spec helpers files that are 
+    auto-required via `--require <name>_helper` lines in `<gem_root>/.rspec`
+  set_fact_with_ruby:
+    var_name: auto_require_helpers
+    bind:
+      gem_root: >-
+        {{ gem_root }}
+    src: |
+      require 'pathname'
+      
+      path = Pathname.new( gem_root ) / '.rspec'
+      
+      if path.file?
+        path.read.scan( /^\-\-require(?:\ |\=)(.*_helper)$/ ).map &:first
+      else
+        []
+      end
+
+
+- when: require is not defined
+  name: >-
+    Set `require` to all the `available_helpers` that are not 
+    `auto_require_helpers={{ auto_require_helpers }}`
+  set_fact:
+    require: >-
+      {{ available_helpers | difference( auto_require_helpers ) }}
+
+
+# - debug: var=require
+

data/roles/qb/rspex/generate/tasks/main.yml

@@ -0,0 +1,9 @@
+---
+# tasks file for qb/rspex/generate
+
+- include_tasks: >-
+    {{ role_path }}/tasks/helpers.yml
+
+- when: class
+  include_tasks: >-
+    {{ role_path }}/tasks/class.yml

data/roles/qb/rspex/generate/templates/class_spec.rb.j2

@@ -0,0 +1,10 @@
+{% for name in require %}
+require {{ name | string | to_json }}
+{% endfor %}
+
+describe_class {{ class }} do
+##############################################################################
+  
+  # Examples and groups...
+  
+end # describe_class {{ class }}

data/roles/qb/rspex/issue/defaults/main.yml

@@ -0,0 +1,2 @@
+---
+# defaults file for qb/rspex/issue

data/roles/qb/{test/rspec/spec → rspex}/issue/meta/main.yml

@@ -1,5 +1,5 @@
 ---
-# meta file for qb/test/rspec/spec/issue
+# meta file for qb/rspex/issue
 
 allow_duplicates: yes
 

data/roles/qb/{test/rspec/spec → rspex}/issue/meta/qb.yml

@@ -1,5 +1,5 @@
 ---
-# meta/qb.yml file for qb/test/rspec/spec/issue
+# meta/qb.yml file for qb/rspex/issue
 # 
 # qb settings for this role. see README.md for more info.
 #
@@ -40,7 +40,7 @@ var_prefix: null
 #     -   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: null
+default_dir: git_root
 
 # If `true`, QB will ensure the default dir exists before starting the play.
 # 
@@ -59,9 +59,11 @@ save_options: true
 # options to pass to ansible-playbook
 ansible_options: {}
 
-options: []
+options:
 # - name: example
 #   description: an example of a variable.
 #   required: false
 #   type: boolean # boolean (default) | string
 #   short: e
+
+- name: 

data/roles/qb/{test/rspec/spec → rspex}/issue/tasks/main.yml

@@ -1,5 +1,5 @@
 ---
-# tasks file for qb/test/rspec/spec/issue
+# tasks file for qb/rspex/issue
 
 - set_fact:
     issue: >-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qb
 version: !ruby/object:Gem::Version
-  version: 0.3.11
+  version: 0.3.12
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-10 00:00:00.000000000 Z
+date: 2017-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,7 +89,7 @@ dependencies:
         version: '0.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -99,7 +99,7 @@ dependencies:
         version: '0.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
   name: nrser
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +109,7 @@ dependencies:
         version: '0.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.28
+        version: 0.0.29
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -119,7 +119,7 @@ dependencies:
         version: '0.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.28
+        version: 0.0.29
 - !ruby/object:Gem::Dependency
   name: nrser-extras
   requirement: !ruby/object:Gem::Requirement
@@ -252,6 +252,7 @@ files:
 - exe/qb
 - lib/python/qb/__init__.py
 - lib/python/qb/interop.py
+- lib/python/qb/strings.py
 - lib/qb.rb
 - lib/qb/ansible.rb
 - lib/qb/ansible/cmds/playbook.rb
@@ -749,10 +750,17 @@ files:
 - roles/qb/role/qb/tasks/main.yml
 - roles/qb/role/qb/templates/.gitkeep
 - roles/qb/role/qb/templates/qb.yml.j2
-- roles/qb/test/rspec/spec/issue/defaults/main.yml
-- roles/qb/test/rspec/spec/issue/meta/main.yml
-- roles/qb/test/rspec/spec/issue/meta/qb.yml
-- roles/qb/test/rspec/spec/issue/tasks/main.yml
+- roles/qb/rspex/generate/defaults/main.yml
+- roles/qb/rspex/generate/meta/main.yml
+- roles/qb/rspex/generate/meta/qb.yml
+- roles/qb/rspex/generate/tasks/class.yml
+- roles/qb/rspex/generate/tasks/helpers.yml
+- roles/qb/rspex/generate/tasks/main.yml
+- roles/qb/rspex/generate/templates/class_spec.rb.j2
+- roles/qb/rspex/issue/defaults/main.yml
+- roles/qb/rspex/issue/meta/main.yml
+- roles/qb/rspex/issue/meta/qb.yml
+- roles/qb/rspex/issue/tasks/main.yml
 - roles/qb/yarn/setup/README.md
 - roles/qb/yarn/setup/defaults/main.yml
 - roles/qb/yarn/setup/meta/main.yml

data/roles/qb/test/rspec/spec/issue/defaults/main.yml

@@ -1,2 +0,0 @@
----
-# defaults file for qb/test/rspec/spec/issue