qb 0.1.69 → 0.1.70

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d67fbe281a2360e617563b65cff02b777e5fe0ea
-  data.tar.gz: fdb83e48ac561d01d86f4943a29e79903a58f7b3
+  metadata.gz: a96dba86d6f78961f1b98a546a2c322344b2e16f
+  data.tar.gz: c1ce84a3f5d8d5864c6f0a72e30eb119188803da
 SHA512:
-  metadata.gz: 5187065635c8f370f0de852ece43088bd20320e70984a592a175452b97b151565c69b93f8fe0ad62e4b7d654e7b206e20c766172e65f633b338d688b7f284ff8
-  data.tar.gz: 7139f9c5b84e21165ba26f0627f7dedddbeeb17803933bd55545585c058b935fd3622d4ce4d6b9ce35f0387ddcf2c73242384534ddfd13ed75023ae257a5ee57
+  metadata.gz: 986b7bf9fdea777e0d32bf5c7cad71d1842917c6c98ca58423121eb3e1a076024f949ce339025a24580afd97da005faa11b7646ffc6f9413d9d2537b8dfba8c9
+  data.tar.gz: 2e378c83dc28305371a331d889302a93206920422907fea50e067d1a2d813af67a1d7c277bfefe222a5e90865435c83111321549f15f02b127c1034e3d26aac3

data/exe/qb

@@ -126,6 +126,8 @@ def main args
     exit 1
   end
   
+  QB.check_qb_version role
+  
   options = QB::Options.new role, args
   
   QB.debug "role options set on cli", options.role_options.select {|k, o|

data/lib/qb.rb

@@ -1,18 +1,16 @@
 require 'nrser/extras'
 
-require "qb/version"
-require "qb/util"
-require 'qb/util/stdio'
-require "qb/ansible_module"
+require_relative './qb/errors'
+require_relative "./qb/version"
+require_relative "./qb/util"
+require_relative './qb/util/stdio'
+require_relative "./qb/ansible_module"
 
 module QB
   ROOT = (Pathname.new(__FILE__).dirname + '..').expand_path
   GEM_ROLES_DIR = ROOT + 'roles'
   USER_ROLES_DIR = Pathname.new(ENV['HOME']).join '.ansible', 'roles'
-  MIN_ANSIBLE_VERSION = Gem::Version.new '2.1.2'
   
-  class Error < StandardError
-  end
   
   def self.debug *args
     return unless ENV['QB_DEBUG'] && args.length > 0
@@ -35,28 +33,7 @@ module QB
     # $stderr.puts("DEBUG " + format(msg, values))
     $stderr.puts dumpObj.pretty_inspect
   end
-  
-  def self.check_ansible_version
-    out = Cmds.out! 'ansible --version'
-    version_str = out[/ansible\ ([\d\.]+)/, 1]
-    
-    if version_str.nil?
-      raise NRSER.dedent <<-END
-        could not parse ansible version from `ansible --version` output:
-        
-        #{ out }
-      END
-    end
     
-    version = Gem::Version.new version_str
-    
-    if version < QB::MIN_ANSIBLE_VERSION
-      raise NRSER.squish <<-END
-        qb #{ QB::VERSION } requires ansible #{ QB::MIN_ANSIBLE_VERSION },
-        found version #{ version_str } at #{ `which ansible` }
-      END
-    end
-  end
 end
 
 # needs QB::*_ROLES_DIR

data/lib/qb/errors.rb

@@ -0,0 +1,19 @@
+module QB
+  # Base class for QB errors.
+  class Error < StandardError; end
+  
+  # Raised when a version mismatch occurs.
+  class VersionError < Error; end
+  
+  # Raised when the current Ansible version doesn't satisfy:
+  # 
+  # 1.  A role as defined in `<role_dir>/meta/main.yml:min_ansible_version`)
+  #     
+  # 2.  QB itself as defined in {QB::MIN_ANSIBLE_VERSION}
+  # 
+  class AnsibleVersionError < VersionError; end
+  
+  # Raised when the current QB version doesn't satisfy a role as defined
+  # in `<role_dir>/meta/qb[.yml]:required_qb_version`).
+  class QBVersionError < VersionError; end
+end # module QB

data/lib/qb/role.rb

@@ -617,6 +617,23 @@ module QB
       meta_or 'ansible_options', {}
     end
     
+    
+    # Get the {Gem::Requirement} parse of the `qb_requirement` key in
+    # {#meta} (if it is defined), which specifies the required version of 
+    # `qb` for the role.
+    # 
+    # @return [Gem::Requirement, nil]
+    #   The requirement if `required_qb_version` key is in {#meta}, else `nil`.
+    # 
+    def qb_requirement
+      if  meta['requirements'] &&
+          meta['requirements']['gems'] &&
+          meta['requirements']['gems']['qb']
+        Gem::Requirement.new meta['requirements']['gems']['qb']
+      end
+    end
+    
+    
     # language inter-op
     # -----------------------------------------------------------------------
     

data/lib/qb/version.rb

@@ -1,9 +1,79 @@
 module QB
+  # Constants
+  # =====================================================================
+  
   GEM_NAME = 'qb'
   
-  VERSION = "0.1.69"
+  VERSION = "0.1.70"
+  
+  MIN_ANSIBLE_VERSION = Gem::Version.new '2.1.2'
+  
+  
+  
+  # Class Methods
+  # =====================================================================
   
   def self.gemspec
     Gem.loaded_specs[GEM_NAME]
   end
-end
+  
+  
+  # Get the {Gem::Version} parse of {QB::VERSION}.
+  # 
+  # @return [Gem::Version]
+  # 
+  def self.gem_version
+    Gem::Version.new VERSION
+  end
+  
+  
+  # Check that the Ansible version is not less than {QB::MIN_ANSIBLE_VERSION}.
+  # 
+  # @raise [QB::AnsibleVersionError]
+  #   If the version of Ansible found is less than {QB::MIN_ANSIBLE_VERSION}.
+  # 
+  def self.check_ansible_version
+    out = Cmds.out! 'ansible --version'
+    version_str = out[/ansible\ ([\d\.]+)/, 1]
+    
+    if version_str.nil?
+      raise NRSER.dedent <<-END
+        could not parse ansible version from `ansible --version` output:
+        
+        #{ out }
+      END
+    end
+    
+    version = Gem::Version.new version_str
+    
+    if version < QB::MIN_ANSIBLE_VERSION
+      raise QB::AnsibleVersionError, NRSER.squish(
+        <<-END
+          QB #{ QB::VERSION } requires Ansible #{ QB::MIN_ANSIBLE_VERSION },
+          found version #{ version_str } at #{ `which ansible` }
+        END
+      )
+    end
+  end # .check_ansible_version
+  
+  
+  # If `role` has a {QB::Role#qb_requirement} raise an error if this version of
+  # QB doesn't satisfy it.
+  # 
+  # @raise [QB::QBVersionError]
+  #   If this version of QB doesn't satisfy the role's requirements.
+  # 
+  def self.check_qb_version role
+    unless  role.qb_requirement.nil? ||
+            role.qb_requirement.satisfied_by?(QB.gem_version)    
+      raise QB::QBVersionError, NRSER.squish(
+        <<-END
+          Role #{ role } requires QB #{ role.qb_requirement }, using QB
+          #{ QB.gem_version } from #{ QB::ROOT }.
+        END
+      )
+    end
+  end # .check_qb_version
+  
+  
+end # module QB

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

@@ -7,6 +7,12 @@
 # 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.1.69
+
 # prefix for role variables
 var_prefix: null
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qb
 version: !ruby/object:Gem::Version
-  version: 0.1.69
+  version: 0.1.70
 platform: ruby
 authors:
 - nrser
@@ -181,6 +181,7 @@ files:
 - exe/qb
 - lib/qb.rb
 - lib/qb/ansible_module.rb
+- lib/qb/errors.rb
 - lib/qb/options.rb
 - lib/qb/options/option.rb
 - lib/qb/package/version.rb