qb 0.3.15 → 0.3.16

data/lib/qb/repo/git/github.rb

@@ -25,7 +25,7 @@ using NRSER::Types
 # Definitions
 # =======================================================================
 
-# Git repo where the `origin` remote points to GitHub, which is used to 
+# Git repo where the `origin` remote points to GitHub, which is used to
 # determine it's owner and name.
 # 
 class QB::Repo::Git::GitHub < QB::Repo::Git
@@ -55,12 +55,12 @@ class QB::Repo::Git::GitHub < QB::Repo::Git
   # ---------------------------------------------------------------------
   
   def self.ssh_url? string
-    SSH_URL_RE =~ string
+    !!(SSH_URL_RE =~ string)
   end
   
   
   def self.https_url? string
-    HTTPS_URL_RE =~ string
+    !!(HTTPS_URL_RE =~ string)
   end
   
   
@@ -122,6 +122,15 @@ class QB::Repo::Git::GitHub < QB::Repo::Git
   # Instance Methods
   # ======================================================================
   
+  # Part of the {QB::Repo::Git} API, always `true` for GitHub instances.
+  # 
+  # @return [true]
+  # 
+  def github?
+    true
+  end
+  
+  
   def api
     QB::GitHub::API.client.repo repo_id.path
   end
@@ -134,4 +143,3 @@ class QB::Repo::Git::GitHub < QB::Repo::Git
   
   
 end # class QB::Repo::Git::GitHub
-

data/lib/qb/repo/git/user.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+require 'nrser'
+
+# Project / Package
+# -----------------------------------------------------------------------
+require 'qb/util/resource'
+
+# Refinements
+# =======================================================================
+
+using NRSER
+using NRSER::Types
+
+
+# Definitions
+# =======================================================================
+
+class QB::Repo::Git::User < QB::Util::Resource
+  prop :name, type: t.maybe(t.str), default: nil
+  prop :email, type: t.maybe(t.str), default: nil
+end
+
+# Post-Processing
+# =======================================================================

data/lib/qb/role.rb

@@ -47,7 +47,7 @@ class QB::Role
   # Constants
   # =====================================================================
   
-  # Array of string paths to directories to search for roles or paths to 
+  # Array of string paths to directories to search for roles or paths to
   # `ansible.cfg` files to look for an extract role paths from.
   # 
   # For the moment at least you can just mutate this value like you would
@@ -60,8 +60,8 @@ class QB::Role
   # 
   # **WARNING**
   # 
-  #   Search is **deep** - don't point this at large directory trees and 
-  #   expect any sort of reasonable performance (any directory that 
+  #   Search is **deep** - don't point this at large directory trees and
+  #   expect any sort of reasonable performance (any directory that
   #   contains `node_modules` is usually a terrible idea for instance).
   # 
   BUILTIN_PATH = [
@@ -131,7 +131,7 @@ class QB::Role
   ].freeze
   
   
-  # Array of string paths to directories to search for roles or paths to 
+  # Array of string paths to directories to search for roles or paths to
   # `ansible.cfg` files to look for an extract role paths from.
   # 
   # Value is a duplicate of the frozen {QB::Role::BUILTIN_PATH}. You can
@@ -147,8 +147,8 @@ class QB::Role
   # 
   # **WARNING**
   # 
-  #   Search is **deep** - don't point this at large directory trees and 
-  #   expect any sort of reasonable performance (any directory that 
+  #   Search is **deep** - don't point this at large directory trees and
+  #   expect any sort of reasonable performance (any directory that
   #   contains `node_modules` is usually a terrible idea for instance).
   # 
   PATH = BUILTIN_PATH.dup
@@ -157,7 +157,7 @@ class QB::Role
   # Class Methods
   # =======================================================================
   
-  # Reset {QB::Role::PATH} to the original built-in values in 
+  # Reset {QB::Role::PATH} to the original built-in values in
   # {QB::Role::BUILTIN_PATH}.
   # 
   # Created for testing but might be useful elsewhere as well.
@@ -206,7 +206,7 @@ class QB::Role
   #     i.  ./dev/roles/tmp
   #         -   used for roles that are downloaded but shouldn't be included
   #             in source control.
-  # 3.  
+  # 3.
   # 
   # @return [Array<Pathname>]
   #   places to look for role dirs.
@@ -237,7 +237,7 @@ class QB::Role
         ['', '.yml', '.yaml'].flat_map { |ext|
           Pathname.glob(search_dir.join '**', 'meta', "qb#{ ext }").
             map {|meta_path|
-              [meta_path.dirname.dirname, search_dir: search_dir] 
+              [meta_path.dirname.dirname, search_dir: search_dir]
             }
         }
       }.
@@ -261,19 +261,19 @@ class QB::Role
       return [role] if role.display_path.to_s == input
     }
     
-    # create an array of "separator" variations to try *exact* matching 
+    # create an array of "separator" variations to try *exact* matching
     # against. in order of preference:
     # 
     # 1.  exact input
     #     -   this means if you ended up with roles that actually *are*
-    #         differnetiated by '_/-' differences (which, IMHO, is a 
+    #         differnetiated by '_/-' differences (which, IMHO, is a
     #         horrible fucking idea), you can get exactly what you ask for
     #         as a first priority
     # 2.  input with '-' changed to '_'
     #     -   prioritized because convetion is to underscore-separate
     #         role names.
     # 3.  input with '_' changed to '-'
-    #     -   really just for convience's sake so you don't really have to 
+    #     -   really just for convience's sake so you don't really have to
     #         remember what separator is used.
     #     
     separator_variations = [
@@ -289,7 +289,7 @@ class QB::Role
       }.each { |role|
         # exact match without the namespace prefix ('qb.' or similar)
         return [role] if role.namespaceless == variation
-      }  
+      }
     }
     
     # see if we prefix match any full names
@@ -306,7 +306,7 @@ class QB::Role
         role.namespaceless.start_with? variation
       }
       unless namespaceless_prefix_matches.empty?
-        return namespaceless_prefix_matches 
+        return namespaceless_prefix_matches
       end
     }
     
@@ -370,7 +370,7 @@ class QB::Role
   end # .require
   
   
-  # Get the include path for an included role based on the 
+  # Get the include path for an included role based on the
   # option metadata that defines the include and the current
   # include path.
   # 
@@ -385,7 +385,7 @@ class QB::Role
   # @return [Array<string>]
   #   include path for the included role.
   # 
-  def self.get_include_path role, option_meta, current_include_path      
+  def self.get_include_path role, option_meta, current_include_path
     new_include_path = if option_meta.key? 'as'
       case option_meta['as']
       when nil, false
@@ -549,7 +549,7 @@ class QB::Role
   # in meta.
   def var_prefix
     # ugh, i was generating meta/qb.yml files that set 'var_prefix' to
-    # `null`, but it would be nice to 
+    # `null`, but it would be nice to
     # 
     meta_or 'var_prefix', namespaceless
   end
@@ -744,7 +744,7 @@ class QB::Role
   end
   
   
-  # Parsed tree structure of version requirements of the role from the 
+  # Parsed tree structure of version requirements of the role from the
   # `requirements` value in the QB meta data.
   # 
   # @return [Hash]
@@ -767,7 +767,7 @@ class QB::Role
   #   If the version of Ansible found does not satisfy the role's requirements.
   # 
   # @raise [QB::QBVersionError]
-  #   If the the version of QB we're running does not satisfy the role's 
+  #   If the the version of QB we're running does not satisfy the role's
   #   requirements.
   # 
   def check_requirements
@@ -825,7 +825,7 @@ class QB::Role
     # all. you need to use `false` if you want to tell QB not to do something.
     # 
     # @param [String | Symbol | Array<String | Symbol>] keys
-    #   Single 
+    #   Single
     # 
     # @return [Object]
     # 
@@ -858,7 +858,7 @@ class QB::Role
       end
       
       raise QB::Role::MetadataError.squished <<-END
-        Expected metadata for role #{ self } to define (non-null) value for 
+        Expected metadata for role #{ self } to define (non-null) value for
         one of keys #{ keys.inspect }.
       END
     end # need_meta
@@ -866,4 +866,4 @@ class QB::Role
     
   # end private
   
-end # class QB::Role
+end # class QB::Role

data/lib/qb/version.rb

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

data/library/path_facts

@@ -26,9 +26,6 @@ class Result < OpenStruct
   end
 end
 
-GITHUB_SSH_URL_RE = /^git@github\.com\:(?<owner>.*)\/(?<name>.*)\.git$/
-GITHUB_HTTPS_URL_RE = /^https:\/\/github\.com\/(?<owner>.*)\/(?<name>.*)\.git$/
-
 
 class PathFacts < QB::Ansible::Module
   # Add a bunch of useful things to know about the path
@@ -65,93 +62,6 @@ class PathFacts < QB::Ansible::Module
   end
   
   
-  # If the path is part of a Git repo, as well as useful general
-  # Git environment facts.
-  def add_git_facts_old
-    # see if we're in a git repo. first, we need a directory that exists
-    dir = @path.expand_path.ascend.find {|p| p.directory? }
-    
-    Dir.chdir(dir) do
-      root_result = Cmds.capture "git rev-parse --show-toplevel"
-      
-      unless root_result.ok?
-        @result.in_git_repo = false
-        @result.is_git_root = false
-        return
-      end
-      
-      @result.in_git_repo = true
-      
-      git = @result.git = Result.new
-      git.root = Pathname.new root_result.out.chomp
-      @result.is_git_root = @path == git.root
-      
-      user = git.user = Result.new
-      
-      ['name', 'email'].each {|key|
-        user[key] = begin
-          Cmds.chomp! "git config user.#{ key }"
-        rescue
-        end
-      }
-      
-      git.is_clean = Cmds.chomp!('git status --porcelain 2>/dev/null').empty?
-      
-      rev_parse = Cmds.capture 'git rev-parse HEAD'
-      
-      if rev_parse.ok?
-        git.head = rev_parse.out.chomp
-        git.head_short = git.head[0...7]
-      else
-        git.head = git.head_short = nil
-      end
-      
-      branch = Cmds.capture 'git branch --no-color 2> /dev/null'
-      
-      git.branch = if branch.ok?
-        if line = branch.out.lines.find {|line| line.start_with? '*'}
-          if m = line.match(/\*\s+(\S+)/)
-            m[1]
-          end
-        end
-      end
-      
-      git.origin = begin
-        Cmds.chomp! "git remote get-url origin"
-      rescue
-      end
-      
-      match = GITHUB_SSH_URL_RE.match(git.origin) ||
-              GITHUB_HTTPS_URL_RE.match(git.origin)
-      
-      git.is_github = !! match
-      
-      return unless match
-      
-      git.owner = match['owner']
-      git.name = match['name']
-      git.full_name = "#{ git.owner }/#{ git.name }"
-      
-      if true == @args['github_api']
-        github = git.github = Result.new
-        github.api_url = "https://api.github.com/repos/#{ git.owner }/#{ git.name }"
-        
-        response = Net::HTTP.get_response URI(github.api_url)
-        
-        if response.is_a? Net::HTTPSuccess
-          # parse response body and add everything to github result
-          parsed = JSON.parse response.body
-          parsed.each {|k, v| github[k] = v}
-        else
-          # assume it's private if we failed to find it
-          github.private = true
-        end
-        
-      end
-    end
-  end
-  
-  
   # Find the only *.gemspec path in the `@path` directory. Warns and returns
   # `nil` if there is more than one match.
   def gemspec_path

data/qb.gemspec

@@ -194,8 +194,8 @@ Gem::Specification.new do |spec|
   # Runtime Dependencies
   # ----------------------------------------------------------------------------
   
-  spec.add_dependency "cmds",             '~> 0.0', ">= 0.2.5"
-  spec.add_dependency "nrser",            '~> 0.1', ">= 0.1.1"
+  spec.add_dependency "cmds",             '~> 0.0', ">= 0.2.7"
+  spec.add_dependency "nrser",            '~> 0.1', ">= 0.1.2"
   spec.add_dependency "nrser-extras",     '~> 0.0', ">= 0.0.3"
   spec.add_dependency "state_mate",       '~> 0.0', ">= 0.1.0"
   

data/roles/qb/git/check/clean/defaults/main.yml

@@ -0,0 +1,7 @@
+
+# When true allow submodules to be dirty
+git_root: >-
+  {{ qb_dir }}
+
+git_check_clean_ignore_submodules: false
+git_check_clean_ignore: []

data/roles/qb/git/check/clean/meta/qb.yml

@@ -0,0 +1,48 @@
+---
+##############################################################################
+# QB metadata for `qb/git/check/clean` 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/git/check/clean role
+
+# Gemspec-style requirements. Right now only `.gems.qb` is used.
+requirements:
+  gems:
+    qb: ~> 0.3.0
+
+# Prefix for role variables
+var_prefix: git_check_clean
+
+# 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: null # means use *must* provide `DIRECTORY` arg
+
+# 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: false
+
+# Options to pass to `ansible-playbook`
+ansible_options: {}
+
+# Role CLI options that become Ansible vars
+options:
+- name: ignore
+  description: >-
+    File glob patterns to ignore (allow to be dirty)
+  required: false
+  type: list
+  short: i

data/roles/qb/git/check/clean/tasks/main.yml

@@ -1,19 +1,35 @@
 ---
 # tasks file for qb/git/check/clean
 
-- name: >
-    Get git status for repo {{ git_root }}
-  shell: git status --porcelain 2>/dev/null
-  args:
-    chdir: "{{ git_root }}"
-  register: git_check_clean_status
-  changed_when: false
+- path_facts:
+    path: >-
+      {{ git_root }}
+  register: git_root_facts
 
-- name: >
+- set_fact:
+    git_check_is_clean: >-
+      {{
+        git_root_facts.git
+          | qb_send( 'clean?', ignore=git_check_clean_ignore )
+      }}
+
+# - name: >
+#     Get git status for repo {{ git_root }}
+#   shell: >-
+#     git status
+#     {% if git_check_clean_ignore_submodules %}
+#       --ignore-submodules
+#     {% endif %}
+#     --porcelain 2>/dev/null
+#   args:
+#     chdir: "{{ git_root }}"
+#   register: git_check_clean_status
+#   changed_when: false
+
+- when: not git_check_is_clean
+  name: >
     Fail if the repo at {{ git_root }} has any untracked or modified files.
   fail:
     msg: >
       Repo at {{ git_root }} can not have any untracked or
       modified files, please commit or stash and retry.
-  when: (git_check_clean_status.stdout_lines | length) != 0
-