qb 0.3.3 → 0.3.4

data/lib/qb/util/stdio.rb

@@ -1,15 +1,67 @@
+# Requirements
+# =====================================================================
+
+# stdlib
 require 'thread'
 require 'socket'
 require 'securerandom'
 require 'fileutils'
 require 'nrser'
 
+# Refinements
+# =====================================================================
+
+require 'nrser/refinements'
 using NRSER
 
+
+# Declarations
+# =====================================================================
+
 module QB; end
 module QB::Util; end
 
+
+# Definitions
+# =====================================================================
+
+# Utilities for QB's standard-IO (`stdio`) handling feature.
+# 
+# Normally, Ansible modules can't really do much with `stdio` - they return 
+# results by writing JSON to `stdout`, can't do anything useful with `stdin`,
+# and I think things written to `stderr` don't go anywhere useful.
+# 
+# This makes dealing with logging, error reporting and wrapping executables
+# that report useful progress info to `stdout` or `stderr` pretty shitty.
+# 
+# So, what we do is create streaming sockets for `stdout`, `stderr` and 
+# `stdin` in the QB process and write their paths to environment variables,
+# which will be available to modules.
+# 
+# {QB::Ansible::Module} automatically detects these variables and sets up
+# `$stdout`, `$stderr` and `$stdin` to point to the sockets, which proxy 
+# back to the QB process' `stdio`.
+# 
+# Of course other modules written in any language can also connect to these
+# file sockets in the same manner.
+# 
+# @note
+#   This feature only works for `localhost`. I have no idea what it will do
+#   in other cases. It doesn't seem like it should break anything, but remotely
+#   executing modules definitely won't be able to connect to the sockets on 
+#   the host.
+# 
+# @todo
+#   `stdin` support is pretty experimental / broken at this point. That would
+#   be nice to fix in the future so that programs that make use of user 
+#   interaction work seamlessly through QB. This will probably require 
+#   using pseudo-TTY streams or whatever.
+# 
 module QB::Util::STDIO
+  
+  # Constants
+  # =====================================================================
+  
   SOCKET_DIR = Pathname.new('/').join 'tmp', 'qb-stdio'
   
   # STDIO as a service exposed on a UNIX socket so that modules can stream

data/lib/qb/version.rb

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

data/library/path_facts

@@ -30,7 +30,7 @@ GITHUB_SSH_URL_RE = /^git@github\.com\:(?<owner>.*)\/(?<name>.*)\.git$/
 GITHUB_HTTPS_URL_RE = /^https:\/\/github\.com\/(?<owner>.*)\/(?<name>.*)\.git$/
 
 
-class PathFacts < QB::AnsibleModule
+class PathFacts < QB::Ansible::Module
   # Add a bunch of useful things to know about the path
   def add_path_facts
     @result.expanded = @path.expand_path

data/library/stream

@@ -14,7 +14,7 @@ end
 require 'qb'
 require 'cmds'
 
-class Stream < QB::AnsibleModule
+class Stream < QB::Ansible::Module
   def main
     template = @args['template'] || @args['cmd']
     

data/node_modules/.bin/semver

@@ -1 +1 @@
-../semver/bin/semver
+node_modules/.bin/../semver/bin/semver

data/qb.gemspec

@@ -94,8 +94,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "yard"
   spec.add_development_dependency "pry"
   
-  spec.add_dependency "cmds",'~> 0.0', ">= 0.2.1"
-  spec.add_dependency "nrser",'~> 0.0', ">= 0.0.21"
+  spec.add_dependency "cmds",'~> 0.0', ">= 0.2.2"
+  spec.add_dependency "nrser",'~> 0.0', ">= 0.0.22"
   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/nrser.blockinfile/tests/expected/test-follow/link2.txt

@@ -1 +1 @@
-real2.txt
+roles/nrser.blockinfile/tests/expected/test-follow/real2.txt

data/roles/nrser.blockinfile/tests/fixtures/test-follow/link0.txt

@@ -1 +1 @@
-real0.txt
+roles/nrser.blockinfile/tests/fixtures/test-follow/real0.txt

data/roles/nrser.blockinfile/tests/fixtures/test-follow/link1.txt

@@ -1 +1 @@
-real1.txt
+roles/nrser.blockinfile/tests/fixtures/test-follow/real1.txt

data/roles/nrser.blockinfile/tests/fixtures/test-follow/link2.txt

@@ -1 +1 @@
-real2.txt
+roles/nrser.blockinfile/tests/fixtures/test-follow/real2.txt

data/roles/nrser.blockinfile/tests/roles/yaegashi.blockinfile

@@ -1 +1 @@
-../..
+roles/nrser.blockinfile/tests/roles/../..

data/roles/qb.bump/library/bump

@@ -86,7 +86,7 @@ class Version
   # ------------------------------------------------------------------------
   
   def to_json options
-    QB::AnsibleModule.stringify_keys(to_hash).to_json options
+    QB::Ansible::Module.stringify_keys(to_hash).to_json options
   end # #to_json
 end # Version
 
@@ -179,7 +179,7 @@ class NodeBumper < Bumper
 end # NodeBumper
 
 
-class Bump < QB::AnsibleModule
+class Bump < QB::Ansible::Module
   
   def check_repo_clean!
     unless Cmds.chomp!('git status --porcelain 2>/dev/null') == ''

data/roles/qb.git_submodule_update/library/git_submodule_update

@@ -19,7 +19,7 @@ require 'nrser'
 
 using NRSER
 
-class GitSubmoduleUpdate < QB::AnsibleModule
+class GitSubmoduleUpdate < QB::Ansible::Module
   def main_dir
     File.realpath @args['dir']
   end

data/roles/qb.gitignore/files/gitignore/Clojure.gitignore

@@ -1 +1 @@
-Leiningen.gitignore
+roles/qb.gitignore/files/gitignore/Leiningen.gitignore

data/roles/qb.gitignore/files/gitignore/Fortran.gitignore

@@ -1 +1 @@
-C++.gitignore
+roles/qb.gitignore/files/gitignore/C++.gitignore

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

@@ -79,7 +79,7 @@ vars:
   
 - name: modules
   description: >-
-    create ruby module boilerplate(s) in library using QB::AnsibleModule.
+    create ruby module boilerplate(s) in library using QB::Ansible::Module.
   type: array
   required: false
   # TODO not yet implemented

data/roles/qb.role/templates/library/module.rb.j2

@@ -14,7 +14,7 @@ end
 require 'qb'
 require 'nrser'
 
-class {{ role_module_class }} < QB::AnsibleModule
+class {{ role_module_class }} < QB::Ansible::Module
   # define arg names to NRSER::Types::Type instances here and they
   # will be type checked and set as @<name>
   # 

data/roles/qb/gem/release/tasks/main.yml

@@ -18,6 +18,33 @@
       {{ gem_root }}
 
 
+- name: >-
+    See if a pre-release script exists at `//dev/hooks/pre-release`.
+  stat:
+    path: >-
+      {{ gem_root | path_join( 'dev', 'hooks', 'pre-release' ) }}
+  register: gem_pre_release_script_stat
+
+- debug: var=gem_pre_release_script_stat
+
+
+# NOTE  Contrary to how it might seems in the [docs][1],
+#       the `stat` object seems to *only* have the `exists` property if the
+#       path does not exist (set to `false`), necessitating we 
+# 
+# [1]: http://docs.ansible.com/ansible/latest/stat_module.html
+# 
+- when: >-
+    gem_pre_release_script_stat.stat.exists and
+      gem_pre_release_script_stat.stat.executable
+  name: >-
+    Execute `//dev/hooks/pre-release` script.
+  stream:
+    cmd: ./dev/hooks/pre-release
+    chdir: >-
+      {{ gem_root }}
+
+
 - name: >-
     Get gem and version info
   vars.rb:
@@ -32,8 +59,6 @@
         raise "No gemspec found for pattern #{ spec_pattern }"
       end
       
-      spec = Gem::Specification.load spec_path
-      
       # The gem *may already be loaded*, which would break the standard gemspec
       # approach because the `require` will be a no-op, resulting in the 
       # already loaded version number being used instead of the one in the
@@ -71,68 +96,102 @@
         'version_path' => "#{ gem_root }/lib/#{ name }/version.rb",
         'spec_path' => spec_path,
       }
-  
+
+
 - debug:
     msg:
-    # - spec_path: >-
-    #     {{ gem_spec_path }}
-    # - version_path: >-
-    #     {{ gem_version_path }}
     - current: >-
         {{ gem_current_version }}
     - release: >-
         {{ gem_release_version }}
     - next: >-
         {{ gem_next_version }}
+    # - spec_path: >-
+    #     {{ gem_spec_path }}
+    # - version_path: >-
+    #     {{ gem_version_path }}
 
-- name: "change version to release version {{ gem_release_version }}"
-  replace:
-    dest: "{{ gem_version_path }}"
-    regexp: "VERSION\\s*=\\s*\"{{ gem_current_version }}\""
-    replace: "VERSION = \"{{ gem_release_version }}\""
-  when: gem_current_version != gem_release_version
 
+- when: gem_current_version != gem_release_version
+  name: >-
+    Change version in `{{ gem_version_path }}` from current 
+    `{{ gem_current_version }}` to `{{ gem_release_version }}`.
+  block:
+  - name: >-
+      Change version to release version `{{ gem_release_version }}`.
+    replace:
+      dest: >-
+        {{ gem_version_path }}
+      regexp: >-
+        VERSION\s*=\s*["']{{ gem_current_version }}["']
+      replace: >-
+        VERSION = "{{ gem_release_version }}"
+  
+  
+  - name: >-
+      Add version file `{{ gem_version_path }}` to Git.
+    command: >-
+      git add {{ gem_version_path }}
+    args:
+      chdir: >-
+        {{ gem_root }}
+    when: gem_current_version != gem_release_version
 
-- name: >-
-    Add version file {{ gem_version_path }} to Git.
-  command: "git add {{ gem_version_path }}"
-  args:
-    chdir: "{{ gem_root }}"
-  when: gem_current_version != gem_release_version
+  
+  - name: >-
+      Commit version file `{{ gem_version_path }}` in Git.
+    command: git commit -m "bump to v{{ gem_release_version }}"
+    args:
+      chdir: >-
+        {{ gem_root }}
+    when: gem_current_version != gem_release_version
+  # /block
 
 
 - name: >-
-    Commit version file {{ gem_version_path }} in Git.
-  command: git commit -m "bump to v{{ gem_release_version }}"
-  args:
-    chdir: "{{ gem_root }}"
-  when: gem_current_version != gem_release_version
-
-- name: release with bundler
+    Release with Bundler via `bundle exec rake release`.
   shell: bundle exec rake release
   args:
-    chdir: "{{ gem_root }}"
+    chdir: >-
+      {{ gem_root }}
 
-- name: "change version to next version {{ gem_next_version }}"
+
+- name: >-
+    Change version to next version `{{ gem_next_version }}`.
   replace:
-    dest: "{{ gem_version_path }}"
-    regexp: "VERSION\\s*=\\s*\"{{ gem_release_version }}\""
-    replace: "VERSION = \"{{ gem_next_version }}\""
+    dest: >-
+      {{ gem_version_path }}
+    regexp: >-
+      VERSION\s*=\s*["']{{ gem_release_version }}["']
+    replace: >-
+      VERSION = "{{ gem_next_version }}"
+
 
-- name: add next dev version to git
-  command: "git add {{ gem_version_path }}"
+- name: >-
+    Add next dev version to git.
+  command: >-
+    git add {{ gem_version_path }}
   args:
-    chdir: "{{ gem_root }}"
+    chdir: >-
+      {{ gem_root }}
+
 
-- name: commit next dev version
-  command: git commit -m "start {{ gem_next_version }}"
+- name: >-
+    Commit next dev version.
+  command: >-
+    git commit -m "start {{ gem_next_version }}"
   args:
-    chdir: "{{ gem_root }}"
+    chdir: >-
+      {{ gem_root }}
 
-- name: push next dev version
+
+- name: >-
+    Push next dev version.
   command: git push
   args:
-    chdir: "{{ gem_root }}"
+    chdir: >-
+      {{ gem_root }}
+
 
 - debug:
     msg: >

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qb
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-11 00:00:00.000000000 Z
+date: 2017-09-16 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.1
+        version: 0.2.2
   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.1
+        version: 0.2.2
 - !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.21
+        version: 0.0.22
   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.21
+        version: 0.0.22
 - !ruby/object:Gem::Dependency
   name: nrser-extras
   requirement: !ruby/object:Gem::Requirement
@@ -195,12 +195,14 @@ files:
 - exe/qb
 - lib/qb.rb
 - lib/qb/ansible.rb
+- lib/qb/ansible/cmds/playbook.rb
 - lib/qb/ansible/config_file.rb
 - lib/qb/ansible/env.rb
-- lib/qb/ansible/playbook.rb
+- lib/qb/ansible/module.rb
 - lib/qb/ansible_module.rb
 - lib/qb/cli.rb
 - lib/qb/cli/play.rb
+- lib/qb/cli/run.rb
 - lib/qb/errors.rb
 - lib/qb/options.rb
 - lib/qb/options/option.rb
@@ -693,7 +695,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: qb is all about projects. named after everyone's favorite projects.

data/lib/qb/ansible/playbook.rb

@@ -1,4 +0,0 @@
-module QB; end
-module QB::Ansible; end
-
-