qb 0.3.25 → 0.4.0

data/roles/qb/git/submodule/update/library/git_submodule_update

@@ -1,23 +1,13 @@
-#!/usr/bin/env ruby
-
 #!/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
+# Load QB's Ansible module autorun harness
+load ENV['QB_AM_AUTORUN_PATH']
 
 require 'qb'
 require 'cmds'
 require 'nrser'
 
-using NRSER
 
 class GitSubmoduleUpdate < QB::Ansible::Module
   def main_dir
@@ -46,7 +36,7 @@ class GitSubmoduleUpdate < QB::Ansible::Module
         detached: detached?(dir),
         dirty: dirty?(dir),
       }
-    }.tap {|subs| QB.debug submodules: subs}
+    }.tap { |subs| logger.debug payload: { submodules: subs } }
   end
   
   def dirty? repo_dir
@@ -85,7 +75,7 @@ class GitSubmoduleUpdate < QB::Ansible::Module
   end
   
   def attach! submodule
-    QB.debug "attaching submodule #{ submodule[:rel_dir] }..."
+    logger.debug "attaching submodule #{ submodule[:rel_dir] }..."
     
     branch_heads = branch_heads_for_commit submodule
     branch_head = nil
@@ -107,17 +97,17 @@ class GitSubmoduleUpdate < QB::Ansible::Module
       return false
       
     when 1
-      QB.debug "commit is head of only one branch: #{ branch_heads[0][:ref] }"
+      logger.debug "commit is head of only one branch: #{ branch_heads[0][:ref] }"
       branch_head = branch_heads[0]
       
     else
-      QB.debug "commit is head of multiple branches..."
+      logger.debug "commit is head of multiple branches..."
       
       local = branch_heads.select {|bh| bh[:ref].start_with? 'refs/heads'}
       
       case local.length
       when 0
-        QB.debug "commit is head of multiple remote branches..."
+        logger.debug "commit is head of multiple remote branches..."
         
         # see if one is master
         branch_head = branch_heads.find {|bh| bh[:ref].end_with? 'master'}
@@ -133,15 +123,15 @@ class GitSubmoduleUpdate < QB::Ansible::Module
           return false
         end
         
-        QB.debug "commit is head of local master, using that."
+        logger.debug "commit is head of local master, using that."
         
       when 1
-        QB.debug "the commit is head of one local branch, using it."
+        logger.debug "the commit is head of one local branch, using it."
         
         branch_head = local[0]
       
       else
-        QB.debug "the commit heads multiple local branches..."
+        logger.debug "the commit heads multiple local branches..."
         
         # again, see if one is master
         branch_head = local.find {|b| b[:ref].end_with? 'master'}
@@ -157,28 +147,30 @@ class GitSubmoduleUpdate < QB::Ansible::Module
           return false
         end
         
-        QB.debug "commit is head of remote master, using that."
+        logger.debug "commit is head of remote master, using that."
       end # case local.length
     end # case branch_heads.length
     
-    QB.debug "attaching #{ submodule[:rel_dir] } to #{ branch_head[:ref] }..."
+    logger.debug \
+      "attaching #{ submodule[:rel_dir] } to #{ branch_head[:ref] }..."
     
     branch = branch_head[:ref].split('/')[-1]
     
     Dir.chdir submodule[:dir] do
-      QB.debug "checking out branch #{ branch } for #{ submodule[:rel_dir] }..."
+      logger.debug \
+        "checking out branch #{ branch } for #{ submodule[:rel_dir] }..."
       
       Cmds! "git checkout <%= branch %>", branch: branch
       
       # do a pull if the head was on the remote
       if branch_head[:ref].start_with? 'refs/remotes'
-        QB.debug "commit is head of remote branch, pulling..."
+        logger.debug "commit is head of remote branch, pulling..."
         
         Cmds! "git pull origin <%= branch %>", branch: branch
       end
     end
     
-    QB.debug "attached."
+    logger.debug "attached."
     @changed = true
     true
   end
@@ -193,5 +185,3 @@ class GitSubmoduleUpdate < QB::Ansible::Module
     nil
   end
 end
-
-GitSubmoduleUpdate.new.run

data/roles/qb/github/pages/setup/meta/qb.yml

@@ -11,7 +11,7 @@ description: null
 # generalize in the future.
 requirements:
   gems:
-    qb: ~> 0.3.0
+    qb: '>= 0.3.0'
 
 # prefix for role variables
 var_prefix: null

data/roles/qb/labs/atom/apm/meta/qb.yml

@@ -15,7 +15,7 @@ description: >-
 # Gemspec-style requirements. Right now only `.gems.qb` is used.
 requirements:
   gems:
-    qb: ~> 0.3.0
+    qb: '>= 0.3.0'
 
 # Prefix for role variables
 var_prefix: pkg

data/roles/qb/osx/git/change_case/meta/qb.yml

@@ -12,7 +12,7 @@ description: >-
 # generalize in the future.
 requirements:
   gems:
-    qb: ~> 0.3.0
+    qb: '>= 0.3.0'
 
 # prefix for role variables
 var_prefix: null

data/roles/qb/osx/notif/meta/qb.yml

@@ -11,7 +11,7 @@ description: null
 # generalize in the future.
 requirements:
   gems:
-    qb: ~> 0.3.0
+    qb: '>= 0.3.0'
 
 # prefix for role variables
 var_prefix: osx_notif

data/roles/qb/pkg/bump/library/bump

@@ -1,15 +1,8 @@
 #!/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
+# Load QB's Ansible module autorun harness
+load ENV['QB_AM_AUTORUN_PATH']
 
 require 'json'
 require 'pathname'
@@ -17,9 +10,6 @@ require 'pathname'
 require 'qb'
 require 'cmds'
 require 'nrser'
-require 'nrser/refinements'
-
-using NRSER
 
 class Version
   # raw version string if available (version was read from file or whatever),
@@ -91,7 +81,7 @@ class Version
 end # Version
 
 
-# abstract base class for bumpers - classes that implement reading and 
+# abstract base class for bumpers - classes that implement reading and
 # writing Version objects to a package directory.
 class Bumper
   # absolute path to the root directory of the package.
@@ -205,7 +195,7 @@ class Bump < QB::Ansible::Module
   end # #next_rc
   
   
-  def bump_rc    
+  def bump_rc
     @next_version = @bumper.bump! prerelease: ['rc', next_rc]
     @next_version_formatted = @bumper.class.format @next_version
     
@@ -268,5 +258,3 @@ class Bump < QB::Ansible::Module
   end
   
 end # Bump
-
-Bump.new.run

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

@@ -4,3 +4,5 @@
 # default the encapsulated qb.role's `role-dest` to `qb_dir` so we can be
 # sure to be able to use it here... not sure if needed.
 role_dest: "{{ qb_dir }}"
+
+qb_role_default_dir: null

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

@@ -5,11 +5,16 @@
 #
 
 # prefix for role variables
-var_prefix: null
+var_prefix: qb_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
 
-options:  
-- include: qb/role
-  as: false
+options:
+  - include: qb/role
+    as: false
+  
+  - name: default_dir
+    description: >-
+      Optional `default_dir` value for QB metadata (meta/qb.yml).
+    type: default_dir

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

@@ -15,7 +15,12 @@ description: >-
 # Gemspec-style requirements. Right now only `.gems.qb` is used.
 requirements:
   gems:
-    qb: ~> 0.3.0
+    # Role options taking advantage of the {NRSER::Types} system require
+    # QB 0.4.
+    # 
+    # TODO  Change this to `>= 0.4.0` when 0.4.0 is released.
+    # 
+    qb: '>= 0.4.0.dev'
 
 # Prefix for role variables
 var_prefix: {{ role_namespaceless }}
@@ -24,7 +29,7 @@ var_prefix: {{ role_namespaceless }}
 # 
 # @see http://www.rubydoc.info/gems/qb/file/doc/qb_roles/metadata/default_dir.md
 # 
-default_dir: null # means use *must* provide `DIRECTORY` arg
+default_dir: {{ qb_role_default_dir | to_json }}
 
 # If `true`, QB will ensure `DIRECTORY` exists before starting the play.
 mkdir: false

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

@@ -1,45 +1,34 @@
 #!/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'
+# Load QB's Ansible module autorun harness
+load ENV['QB_AM_AUTORUN_PATH']
 
 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>
-  # 
-  # example:
-  # 
-  #     arg :x, NRSER::Types.array(String)
+  
+  # Arguments
+  # ==========================================================================
   # 
-  # will check that the input json has a key named 'x' and that it's value
-  # is an Array of String instances, then set it's value as `@x`.
+  # Define arguments using the {NRSER::Props} system.
   # 
   
-  # entry point for the module. invoked by {\#run}.
+  # Execution
+  # ==========================================================================
+  
+  # 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 
+  #   -   `{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
     return nil
   end # #main
+  
 end # {{ role_module_class }}
 
-{{ role_module_class }}.new.run

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

@@ -3,7 +3,20 @@
 # Ansible metadata for `{{ role_role_name }}` role
 ##############################################################################
 
-allow_duplicates: yes
+# `no` means duplicate invocations with the *same* parameters (vars) will not
+# be run.
+# 
+# This is *usually* what you want for idempotent roles: if roles A
+# and B both want a resource R in a particular state, they can both include
+# or depend on a role C that accepts that state as paramters and C will be
+# run only once.
+# 
+# However, non-idemptent roles - say one that logs message - will want to set
+# this value to `yes`.
+# 
+# https://docs.ansible.com/ansible/devel/user_guide/playbooks_reuse_roles.html#role-duplication-and-execution
+# 
+allow_duplicates: no
 
 dependencies: []
 # - role: role-name

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

@@ -11,7 +11,7 @@ description: null
 # generalize in the future.
 requirements:
   gems:
-    qb: ~> 0.3.0
+    qb: '>= 0.3.0'
 
 # prefix for role variables
 var_prefix: null

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

@@ -15,7 +15,7 @@ description: >-
 # Gemspec-style requirements. Right now only `.gems.qb` is used.
 requirements:
   gems:
-    qb: ~> 0.3.0
+    qb: '>= 0.3.0'
 
 # Prefix for role variables
 var_prefix: dependency

data/roles/qb/ruby/gem/bin_stubs/meta/qb.yml

@@ -12,7 +12,7 @@ description: >-
 # generalize in the future.
 requirements:
   gems:
-    qb: ~> 0.3.0
+    qb: '>= 0.3.0'
 
 # prefix for role variables
 var_prefix: false

data/roles/qb/ruby/gem/bin_stubs/templates/console

@@ -1,6 +1,10 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
+# So that this script can be called from places other than the Gemfile dir,
+# like when it's in `//dev/bin/console` and the Gemfile is at `//dev/Gemfile`
+Dir.chdir __dir__ do
+  require "bundler/setup"
+end
 
 # Load `nrser` gem and use refinements if it's available
 begin
@@ -9,11 +13,13 @@ rescue LoadError => error
   puts "WARN -- Failed to load `nrser` gem."
   puts "WARN -- Add it do your dependencies or edit #{ __FILE__ }"
 else
-  using NRSER
+  require 'nrser/refinements/types'
   using NRSER::Types
 end
 
+{% if qb_gem_info is defined %}
 require '{{ qb_gem_info.name }}'
+{% endif %}
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/roles/qb/ruby/gem/build/meta/qb.yml

@@ -13,7 +13,7 @@ description: Build an installable `.gem` file from a source directory.
 # generalize in the future.
 requirements:
   gems:
-    qb: ~> 0.3.0
+    qb: '>= 0.3.0'
 
 # prefix for role variables
 var_prefix: gem_build

data/roles/qb/ruby/gem/new/meta/qb.yml

@@ -12,7 +12,7 @@ description: >-
 # generalize in the future.
 requirements:
   gems:
-    qb: ~> 0.3.0
+    qb: '>= 0.3.0'
 
 # prefix for role variables
 var_prefix: gem

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

@@ -11,7 +11,7 @@ description: null
 # generalize in the future.
 requirements:
   gems:
-    qb: ~> 0.3.0
+    qb: '>= 0.3.0'
 
 # prefix for role variables
 var_prefix: false # Don't prefix variables
@@ -33,11 +33,11 @@ var_prefix: false # Don't prefix variables
 # -   cwd
 #     -   use the directory the `qb` command is invoked form.
 # -   {exe: PATH}
-#     -   invoke an executable, passing a JSON serialization of the options 
+#     -   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 
+#     -   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
@@ -45,7 +45,7 @@ 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 
+# default declare it as `false` here so new roles can turn it on only if
 # they need it.
 # 
 mkdir: false
@@ -76,7 +76,7 @@ options:
 - 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 
+    When not provided, will add all `<spec_dir>/*_helper.rb` files that
     are NOT auto-required via `<gem_root>/.rspec`.
   required: false
   type: list