qb 0.3.15 → 0.3.16

data/roles/qb/ruby/yard/config/library/yard.get_output_dir

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+# WANT_JSON
+
+# init bundler in dev env
+if ENV['QB_DEV_ENV']
+  ENV.each {|k, v|
+    if k.start_with? 'QB_DEV_ENV_'
+      ENV[k.sub('QB_DEV_ENV_', '')] = v
+    end
+  }
+  require 'bundler/setup'
+end
+
+require 'qb'
+require 'nrser'
+
+class YardGetOutputDir < QB::Ansible::Module
+
+  arg :bundle_root, NRSER::Types.abs_path
+  
+  def facts_for rel_dir
+    {
+      yard_output_dir: rel_dir,
+      yard_output_abs_dir: File.expand_path( rel_dir, @bundle_root ),
+    }
+  end
+  
+  def default_facts
+    facts_for( 'doc' ).merge yard_output_dir_is_default: true
+  end
+  
+  # entry point for the module. invoked by {\#run}.
+  # 
+  # @return [nil | {Symbol => #to_json}]
+  #   when returning:
+  #   
+  #   -   `nil`: module will successfully exit with no additional changes.
+  #       
+  #   -   `{Symbol => #to_json}`: Hash will be merged over @facts that
+  #       are returned by the module to be set in the Ansible runtime and
+  #       the module will exit successfully.
+  #       
+  def main
+    path = File.join @bundle_root, '.yardopts'
+    
+    if File.exists?  path
+      contents = File.read path
+      match = /^\-\-output-dir[\s\=](.*)$/.match contents
+      
+      if match
+        return facts_for( match[1] )
+      end
+    end
+    
+    default_facts
+  end # #main
+end # YardGetOutputDir
+
+YardGetOutputDir.new.run

data/roles/qb/ruby/yard/config/meta/main.yml

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

data/roles/qb/ruby/yard/config/meta/qb.yml

@@ -0,0 +1,49 @@
+---
+##############################################################################
+# QB metadata for `qb/ruby/yard/config` 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/yard/config role
+
+# Gemspec-style requirements. Right now only `.gems.qb` is used.
+requirements:
+  gems:
+    qb: ~> 0.3.0
+
+# Prefix for role variables
+var_prefix: config
+
+# 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/yard/config/tasks/get_yard_output_dir.yml

@@ -0,0 +1,10 @@
+##
+# Get the output dir for a `yard` installation
+##
+
+- name: >-
+    See if `output-dir` is specified in `{{ yard_opts_file_path }}`
+  vars.rb:
+    bind:
+      path: >-
+        {{ yard_opts_file_path }}

data/roles/qb/ruby/yard/config/tasks/main.yml

@@ -0,0 +1,4 @@
+---
+##############################################################################
+# Main tasks for `qb/ruby/yard/config` role
+##############################################################################

data/roles/qb/ruby/yard/setup/defaults/main.yml

@@ -0,0 +1,6 @@
+---
+# defaults file for qb/ruby/yard
+
+yard_version: '0.9'
+
+yard_output_rel_dir: doc/site

data/roles/qb/ruby/yard/{meta → setup/meta}/main.yml

@@ -3,6 +3,7 @@
 
 allow_duplicates: yes
 
-dependencies: []
+dependencies:
+- role: qb/ruby/yard/config
 # - role: qb/__init__
 #   qb_role_name: qb/ruby/yard

data/roles/qb/ruby/yard/{meta → setup/meta}/qb.yml

@@ -5,7 +5,8 @@
 #
 
 # description of the role to show in it's help output.
-description: null
+description: >-
+  Setup the `yard` Ruby documentation system for a gem or app.
 
 # Gemspec-style requirements. Right now only `gems:qb` is used, but plan to
 # generalize in the future.
@@ -14,7 +15,7 @@ requirements:
     qb: ~> 0.3.0
 
 # prefix for role variables
-var_prefix: null
+var_prefix: yard
 
 # 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
@@ -41,8 +42,7 @@ var_prefix: null
 #         directories, use the first one that contains FILENAME. error
 #         if none is found.
 default_dir:
-- find_up: '*.gemspec'
-- find_up: Gemfile
+  from_role: qb/ruby/yard/config
 
 # If `true`, QB will ensure the default dir exists before starting the play.
 #
@@ -58,7 +58,7 @@ default_user: null
 # set to false to not save options in .qb-options.yml files
 save_options: true
 
-call_role: true
+# call_role: true
 
 # options to pass to ansible-playbook
 ansible_options: {}

data/roles/qb/ruby/yard/setup/tasks/main.yml

@@ -0,0 +1,35 @@
+---
+# tasks file for qb/ruby/yard
+
+- name: >-
+    Include tasks for Yard version {{ yard_version }}
+  include_tasks: >-
+    {{ role_path }}/tasks/versions/v{{ yard_version }}.yml
+
+
+- name: >-
+    Configure `{{ yard_opts_file_path }}`
+  include_tasks: >-
+    {{ role_path }}/tasks/yardopts.yml
+
+
+- name: >-
+    Ensure `{{ bundle_root }}/doc` is a directory
+  file:
+    path: >-
+      {{ bundle_root }}/doc
+    state: directory
+
+
+- name: >-
+    Add overrides to `{{ bundle_root }}/.gitignore` to make sure `/doc/` is
+    tracked and ignore `/doc/site/`
+  with_items:
+  - "!/doc/"
+  - "/{{ yard_output_rel_dir }}/"
+  lineinfile:
+    dest: >-
+      {{ bundle_root }}/.gitignore
+    line: >-
+      {{ item }}
+    insertafter: EOF

data/roles/qb/ruby/yard/setup/tasks/versions/v0.9.yml

@@ -0,0 +1,32 @@
+---
+
+- name: >-
+    Manage dependencies
+  with_dict:
+    yard:
+      version: '~> 0.9.12'
+      comment: Doc site generation with `yard`
+    
+    github-markup:
+      version: '~> 1.6'
+      comment: GitHub-Flavored Markdown (GFM) for use with `yard`
+    
+    yard-commonmarker:
+      version: '~> 0.3.0'
+      comment: Provider for `commonmarker`, the new GFM lib
+    
+    redcarpet:
+      state: absent
+  
+  loop_control:
+    loop_var: dep
+  
+  include_role:
+    name: qb/ruby/dependency
+  
+  vars:
+    ruby_dep_name:      "{{ dep.key }}"
+    ruby_dep_state:     "{{ dep.value.state | default( 'present' ) }}"
+    ruby_dep_version:   "{{ dep.value.version | default( None ) }}"
+    ruby_dep_dev:       true
+    ruby_dep_comment:   "{{ dep.value.comment | default( None ) }}"

data/roles/qb/ruby/yard/setup/tasks/yardopts.yml

@@ -0,0 +1,59 @@
+##
+# Create
+##
+
+- name: >-
+    Make sure the `yard` opts file at `{{ yard_opts_file_path }}` contains
+    the "-" line that separates options from args, creating if needed
+  lineinfile:
+    path: >-
+      {{ yard_opts_file_path }}
+    line: '-'
+    insertafter: EOF
+    create: true
+
+
+- name: >-
+    Stat README.md
+  stat:
+    path: >-
+      {{ bundle_root | path_join( 'README.md' ) }}
+  register: yard_setup_readme_stat
+
+
+- when: >-
+    yard_setup_readme_stat.stat.exists
+  name: >-
+    Add README.md to `{{ yard_opts_file_path }}`
+  lineinfile:
+    dest: >-
+      {{ yard_opts_file_path }}
+    line: README.md
+    insertafter: '^\-\s?$'
+
+
+- name: >-
+    Add `doc/**/*.md` extra files to `{{ yard_opts_file_path }}`
+  lineinfile:
+    dest: >-
+      {{ yard_opts_file_path }}
+    line: 'doc/**/*.md'
+    insertafter: '^\-\s?$'
+
+
+- name: >-
+    Set `plugin`, `markup-provider`, `output-dir` and `markup` settings in
+    {{ yard_opts_file_path }}
+  with_dict:
+    output-dir: >-
+      {{ yard_output_rel_dir }}
+    plugin: yard-commonmarker
+    markup-provider: commonmarker
+    markup: markdown
+  lineinfile:
+    path: >-
+      {{ yard_opts_file_path }}
+    line: >-
+      --{{ item.key }} {{ item.value }}
+    regexp: '^--{{ item.key | regex_escape() }}[\ \=]'
+    insertbefore: '^\-\s?$'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qb
 version: !ruby/object:Gem::Version
-  version: 0.3.15
+  version: 0.3.16
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-13 00:00:00.000000000 Z
+date: 2018-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,7 +123,7 @@ dependencies:
         version: '0.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.2.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -133,7 +133,7 @@ dependencies:
         version: '0.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.2.7
 - !ruby/object:Gem::Dependency
   name: nrser
   requirement: !ruby/object:Gem::Requirement
@@ -143,7 +143,7 @@ dependencies:
         version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -153,7 +153,7 @@ dependencies:
         version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: nrser-extras
   requirement: !ruby/object:Gem::Requirement
@@ -326,6 +326,7 @@ files:
 - lib/qb/repo.rb
 - lib/qb/repo/git.rb
 - lib/qb/repo/git/github.rb
+- lib/qb/repo/git/user.rb
 - lib/qb/role.rb
 - lib/qb/role/default_dir.rb
 - lib/qb/role/errors.rb
@@ -456,32 +457,10 @@ files:
 - roles/qb/facts/meta/main.yml
 - roles/qb/facts/meta/qb.yml
 - roles/qb/facts/tasks/main.yml
-- roles/qb/gem/bin_stubs/defaults/main.yml
-- roles/qb/gem/bin_stubs/meta/main.yml
-- roles/qb/gem/bin_stubs/meta/qb.yml
-- roles/qb/gem/bin_stubs/tasks/main.yml
-- roles/qb/gem/bin_stubs/templates/console
-- roles/qb/gem/bin_stubs/templates/rake
-- roles/qb/gem/bin_stubs/templates/rspec
-- roles/qb/gem/build/defaults/main.yml
-- roles/qb/gem/build/meta/main.yml
-- roles/qb/gem/build/meta/qb.yml
-- roles/qb/gem/build/tasks/main.yml
-- roles/qb/gem/install/defaults/main.yml
-- roles/qb/gem/install/meta/main.yml
-- roles/qb/gem/install/meta/qb.yml
-- roles/qb/gem/install/tasks/main.yml
-- roles/qb/gem/new/defaults/main.yml
-- roles/qb/gem/new/meta/main.yml
-- roles/qb/gem/new/meta/qb.yml
-- roles/qb/gem/new/tasks/bundle_gem.yml
-- roles/qb/gem/new/tasks/main.yml
-- roles/qb/gem/release/defaults/main.yml
-- roles/qb/gem/release/meta/main.yml
-- roles/qb/gem/release/meta/qb.yml
-- roles/qb/gem/release/tasks/main.yml
 - roles/qb/git/check/clean/README.md
+- roles/qb/git/check/clean/defaults/main.yml
 - roles/qb/git/check/clean/meta/main.yml
+- roles/qb/git/check/clean/meta/qb.yml
 - roles/qb/git/check/clean/tasks/main.yml
 - roles/qb/git/ignore/defaults/main.yml
 - roles/qb/git/ignore/files/gitignore/.github/PULL_REQUEST_TEMPLATE.md
@@ -760,11 +739,62 @@ files:
 - roles/qb/ruby/bundler/tasks/gems.yml
 - roles/qb/ruby/bundler/tasks/main.yml
 - roles/qb/ruby/bundler/tasks/setup.yml
-- roles/qb/ruby/yard/defaults/args.yml
-- roles/qb/ruby/yard/defaults/main.yml
-- roles/qb/ruby/yard/meta/main.yml
-- roles/qb/ruby/yard/meta/qb.yml
-- roles/qb/ruby/yard/tasks/main.yml
+- roles/qb/ruby/dependency/.qb-options.yml
+- roles/qb/ruby/dependency/defaults/main.yml
+- roles/qb/ruby/dependency/filter_plugins/dependency_filters.py
+- roles/qb/ruby/dependency/meta/main.yml
+- roles/qb/ruby/dependency/meta/qb.yml
+- roles/qb/ruby/dependency/tasks/detect_type.yml
+- roles/qb/ruby/dependency/tasks/main.yml
+- roles/qb/ruby/dependency/tasks/types/gemfile.yml
+- roles/qb/ruby/dependency/tasks/types/gemspec.yml
+- roles/qb/ruby/gem/bin_stubs/defaults/main.yml
+- roles/qb/ruby/gem/bin_stubs/meta/main.yml
+- roles/qb/ruby/gem/bin_stubs/meta/qb.yml
+- roles/qb/ruby/gem/bin_stubs/tasks/main.yml
+- roles/qb/ruby/gem/bin_stubs/templates/console
+- roles/qb/ruby/gem/bin_stubs/templates/rake
+- roles/qb/ruby/gem/bin_stubs/templates/rspec
+- roles/qb/ruby/gem/build/defaults/main.yml
+- roles/qb/ruby/gem/build/meta/main.yml
+- roles/qb/ruby/gem/build/meta/qb.yml
+- roles/qb/ruby/gem/build/tasks/main.yml
+- roles/qb/ruby/gem/install/defaults/main.yml
+- roles/qb/ruby/gem/install/meta/main.yml
+- roles/qb/ruby/gem/install/meta/qb.yml
+- roles/qb/ruby/gem/install/tasks/main.yml
+- roles/qb/ruby/gem/new/defaults/main.yml
+- roles/qb/ruby/gem/new/meta/main.yml
+- roles/qb/ruby/gem/new/meta/qb.yml
+- roles/qb/ruby/gem/new/tasks/bundle_gem.yml
+- roles/qb/ruby/gem/new/tasks/main.yml
+- roles/qb/ruby/gem/release/defaults/main.yml
+- roles/qb/ruby/gem/release/meta/main.yml
+- roles/qb/ruby/gem/release/meta/qb.yml
+- roles/qb/ruby/gem/release/tasks/main.yml
+- roles/qb/ruby/gem/release/tasks/release.yml
+- roles/qb/ruby/rspec/setup/defaults/main.yml
+- roles/qb/ruby/rspec/setup/meta/main.yml
+- roles/qb/ruby/rspec/setup/meta/qb.yml
+- roles/qb/ruby/rspec/setup/tasks/main.yml
+- roles/qb/ruby/rspec/setup/tasks/persistence.yml
+- roles/qb/ruby/yard/clean/defaults/main.yml
+- roles/qb/ruby/yard/clean/meta/main.yml
+- roles/qb/ruby/yard/clean/meta/qb.yml
+- roles/qb/ruby/yard/clean/tasks/main.yml
+- roles/qb/ruby/yard/config/.qb-options.yml
+- roles/qb/ruby/yard/config/defaults/main.yml
+- roles/qb/ruby/yard/config/library/yard.get_output_dir
+- roles/qb/ruby/yard/config/meta/main.yml
+- roles/qb/ruby/yard/config/meta/qb.yml
+- roles/qb/ruby/yard/config/tasks/get_yard_output_dir.yml
+- roles/qb/ruby/yard/config/tasks/main.yml
+- roles/qb/ruby/yard/setup/defaults/main.yml
+- roles/qb/ruby/yard/setup/meta/main.yml
+- roles/qb/ruby/yard/setup/meta/qb.yml
+- roles/qb/ruby/yard/setup/tasks/main.yml
+- roles/qb/ruby/yard/setup/tasks/versions/v0.9.yml
+- roles/qb/ruby/yard/setup/tasks/yardopts.yml
 - roles/qb/yarn/setup/README.md
 - roles/qb/yarn/setup/defaults/main.yml
 - roles/qb/yarn/setup/meta/main.yml