qb 0.3.8 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbc3b61137b1ac315d4a59b946216ffc49a698c5
-  data.tar.gz: 382fa7a1f0d99d90adfef8421811464811ecb855
+  metadata.gz: d3fd3a036ee3a1411833a1e6ac82066a7ee291c0
+  data.tar.gz: 9caacbd64094d48b491115d62a80940e1932438f
 SHA512:
-  metadata.gz: 2399c2e4af9def73a5589e91a005aff11085663fe388d16010f2eb1684b36073faed4c778958056a4b63f84e107e810b43141723b01c18980e97805a301f8808
-  data.tar.gz: ef7ef9dd5b12cd9c8aab404a5ede52e5afdb642b1a4205c8f1a5fdc0ea45aa60aee2f9ef7c3bcbdb11177a37739804635aeb550a13b74da2a18ae455481449bf
+  metadata.gz: bf5bbd2d09e43ba8be882cfbf5fee05669c124c7366eda20b31e1ad86e13ec844dc7c9a237d342475994a187c12565ab7f8d8d21d5f88ab92b79bf128dbfae1b
+  data.tar.gz: 4f6351760bb78e66626ea2870d74c48468d6b5a102d12371a5caab719718dd799178762c4ac0ec755c55b73f9aed756572ca708c191b859293703a57914c7e22

data/.yardopts

@@ -1 +1,5 @@
 --markup markdown
+lib/**/*.rb
+dev/packages/gems/nrser/lib/**/*.rb
+-
+README.md

data/exe/.qb_interop_receive

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+# This script is the entry point for the Ansible "Ruby Interop" filter plugins
+# that execute QB Ruby code via a sub-process to do shitty RPC.
+# 
+# @todo
+#   Should prob eventually be merged into `//exe/qb` under a command, but
+#   not gonna right now. At least it's not a string in the Python file anymore.
+# 
+
+# 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
+
+# Set the thread name so that logs make sense.
+require 'thread'
+Thread.current.name = "qb_interop_receive"
+
+require 'qb'
+
+# Connect to the master QB process for logging to CLI STDOUT (if it's there,
+# which it should be in this case).
+if ENV['QB_STDIO_ERR']
+  $stderr = UNIXSocket.new ENV['QB_STDIO_ERR']
+  
+  QB::Util::Logging.setup
+  
+  QB.debug "Connected to QB stderr stream at #{ ENV['QB_STDIO_ERR'] } #{ $stderr.path }."
+end
+
+# Kick off the interop. Payload will be read from STDIN and results written to
+# STDOUT (both YAML at the moment).
+QB::Util::Interop.receive

data/exe/qb

@@ -5,6 +5,7 @@ require 'pp'
 require 'yaml'
 require 'json'
 require 'fileutils'
+require 'thread'
 
 require 'cmds'
 
@@ -19,20 +20,22 @@ DEBUG_ARGS = ['-D', '--DEBUG']
 
 def set_debug! args
   if DEBUG_ARGS.any? {|arg| args.include? arg}
-    ENV['QB_DEBUG'] = 'true'
-    QB.debug "ON"
+    QB::Util::Logging.setup level: :debug
     DEBUG_ARGS.each {|arg| args.delete arg}
   end
 end
 
 
 def main args
+  Thread.current.name = 'main'
+  logger = SemanticLogger['qb/exe/qb#main']
+  
   set_debug! args
-  QB.debug args: args
+  logger.debug args: args
   
   QB.check_ansible_version
   
-  QB.debug "Switch arg", args[0]
+  logger.debug "Switch arg" => args[0]
   
   status = case args[0]
   when nil, '-h', '--help', 'help'
@@ -53,7 +56,7 @@ def main args
     QB::CLI.run args
   end
   
-  QB.debug "Exit status", status
+  logger.debug "Exit status", status
   
   # exit status
   exit status

data/lib/qb.rb

@@ -1,40 +1,84 @@
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
 require 'nrser/extras'
 
-require_relative './qb/errors'
-require_relative './qb/version'
-require_relative './qb/util'
-require_relative './qb/path'
+# Project / Package
+# -----------------------------------------------------------------------
+require 'qb/errors'
+require 'qb/version'
+require 'qb/util'
+require 'qb/path'
+
+
+# Refinements
+# =======================================================================
+
+require 'nrser/refinements'
+using NRSER
+
+require 'nrser/refinements/types'
+using NRSER::Types
+
+
+# Definitions
+# =======================================================================
 
 module QB
+  
+  # Constants
+  # =====================================================================
+  
   ROOT = (Pathname.new(__FILE__).dirname + '..').expand_path
   GEM_ROLES_DIR = ROOT + 'roles'
   USER_ROLES_DIR = Pathname.new(ENV['HOME']).join '.ansible', 'roles'
   
   
+  # Mixins
+  # =====================================================================
+  
+  include SemanticLogger::Loggable
+  
+  
   def self.debug *args
-    return unless ENV['QB_DEBUG'] && args.length > 0
-    
-    header = 'DEBUG'
-    
     if args[0].is_a? String
-      header += " " + args.shift
-    end
-    
-    dumpObj = case args.length
-    when 0
-      header
-    when 1
-      {header => args[0]}
+      logger.debug *args
     else
-      {header => args}
+      logger.debug payload: args
     end
     
-    # $stderr.puts("DEBUG " + format(msg, values))
-    $stderr.puts dumpObj.pretty_inspect
+    # return unless ENV['QB_DEBUG'] && args.length > 0
+    # 
+    # header = 'DEBUG'
+    # 
+    # if args[0].is_a? String
+    #   header += " " + args.shift
+    # end
+    # 
+    # dumpObj = case args.length
+    # when 0
+    #   header
+    # when 1
+    #   {header => args[0]}
+    # else
+    #   {header => args}
+    # end
+    # 
+    # # $stderr.puts("DEBUG " + format(msg, values))
+    # $stderr.puts dumpObj.pretty_inspect
   end
     
 end
 
+
+# Post-Processing
+# =======================================================================
+
 # needs QB::*_ROLES_DIR
 require 'qb/role'
 require 'qb/options'
@@ -47,3 +91,4 @@ require 'qb/ansible_module'
 
 require 'qb/package'
 
+require 'qb/github'

data/lib/qb/cli/run.rb

@@ -41,7 +41,7 @@ module QB::CLI
       return 1
     end
     
-    QB.check_qb_version role
+    role.check_requirements
     
     options = QB::Options.new role, args
     

data/lib/qb/github.rb

@@ -0,0 +1,4 @@
+require 'qb/github/types'
+require 'qb/github/repo_id'
+require 'qb/github/api'
+require 'qb/github/issue'

data/lib/qb/github/api.rb

@@ -0,0 +1,43 @@
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+require 'octokit'
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+
+# Refinements
+# =======================================================================
+
+
+# Declarations
+# =======================================================================
+
+
+# Definitions
+# =======================================================================
+
+
+# @todo document QB::GitHub::API module.
+module QB::GitHub::API
+  
+  def self.client
+    @client ||= if token = ENV['GH_TOKEN']
+      Octokit::Client.new access_token: token
+    else
+      Octokit::Client.new
+    end
+  end
+  
+end # module QB::GitHub::API
+
+
+
+# Post-Processing
+# =======================================================================

data/lib/qb/github/issue.rb

@@ -0,0 +1,83 @@
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+
+# Project / Package
+# -----------------------------------------------------------------------
+require 'qb/github/resource'
+
+
+# Refinements
+# =======================================================================
+
+require 'nrser/refinements'
+using NRSER
+
+require 'nrser/refinements/types'
+using NRSER::Types
+
+
+# Declarations
+# =======================================================================
+
+
+# Definitions
+# =======================================================================
+
+
+# @todo document QB::GitHub::Issue class.
+class QB::GitHub::Issue < QB::GitHub::Resource
+  
+  # Constants
+  # ======================================================================
+  
+  
+  # Class Methods
+  # ======================================================================
+  
+  
+  # @todo Document find method.
+  # 
+  # @param [type] arg_name
+  #   @todo Add name param description.
+  # 
+  # @return [return_type]
+  #   @todo Document return value.
+  # 
+  def self.find_by repo_id:, number:
+    new QB::GitHub::API.client.issue( repo_id.path, number )
+  end # .find
+  
+  
+  
+  # Properties
+  # ======================================================================
+  
+  prop :title, type: t.str, source: ->() { self[:title] }
+  prop :title_filename, source: :title_filename
+  
+  # Constructor
+  # ======================================================================
+  
+  # Instance Methods
+  # ======================================================================
+  
+  def [] key
+    @octokit_resource[key]
+  end
+  
+  def title_filename
+    
+  end
+  
+end # class QB::GitHub::Issue
+
+
+
+# Post-Processing
+# =======================================================================

data/lib/qb/github/repo_id.rb

@@ -0,0 +1,127 @@
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+
+# Project / Package
+# -----------------------------------------------------------------------
+require 'qb/util/resource'
+require 'qb/github/types'
+
+
+# Refinements
+# =======================================================================
+
+require 'nrser/refinements'
+using NRSER
+
+require 'nrser/refinements/types'
+using NRSER::Types
+
+
+# Definitions
+# =======================================================================
+
+
+# Unique identifier for a GitHub repo, which is a composite of an `owner`
+# and a `name` string.
+# 
+class QB::GitHub::RepoID < QB::Util::Resource
+  
+  # Configuration
+  # =====================================================================
+  
+  # Props
+  # ---------------------------------------------------------------------
+  
+  ### Primary Properties
+  
+  prop :owner, type: QB::GitHub::Types.repo_owner
+  prop :name, type: QB::GitHub::Types.repo_name
+  
+  
+  ### Derived Properties
+  
+  prop :path, type: t.non_empty_str, source: :path
+  prop :full_name, type: t.maybe(t.str), source: :full_name
+  
+  
+  # Class Methods
+  # ======================================================================
+  
+  
+  # Instance Methods
+  # ======================================================================
+  
+  # "Path" on GitHub for the repo - the `<owner>/<name>` part that comes 
+  # after the host in URLs. 
+  # 
+  # Called `full_name` in GitHub API (we include a `#full_name` method alias 
+  # as well).
+  # 
+  # This is also what we return for {#to_s}.
+  # 
+  # @example
+  #   repo_id = QB::GitHub::RepoID.new owner: 'nrser', name: 'qb'
+  #   repo_id.path
+  #   # => "nrser/qb"
+  # 
+  # @return [String]
+  # 
+  def path
+    "#{ owner }/#{ name }"
+  end # #path
+  
+  alias_method :full_name,  :path
+  alias_method :to_s,       :path
+  
+
+  # SSH protocol URL string for use as a Git remote.
+  # 
+  # @example
+  #   repo_id = QB::GitHub::RepoID.new owner: 'nrser', name: 'qb'
+  #   repo_id.git_ssh_url
+  #   # => "git@github.com:nrser/qb.git"
+  # 
+  # @return [String]
+  # 
+  def git_ssh_url
+    "git@github.com:#{ path }.git"
+  end # #to_git_ssh_url
+  
+  
+  # HTTPS protocol URL string for use as a Git remote.
+  # 
+  # @example
+  #   repo_id = QB::GitHub::RepoID.new owner: 'nrser', name: 'qb'
+  #   repo_id.git_https_url
+  #   # => "https://github.com/nrser/qb.git"
+  # 
+  # @return [String]
+  # 
+  def git_https_url
+    "https://github.com/#{ path }.git"
+  end
+  
+  
+  # Return {#git_ssh_url} or {#git_https_url} depending on `protocol`
+  # parameter.
+  # 
+  # @param [Symbol] protocol
+  #   `:ssh` or `:https`.
+  # 
+  # @return [String]
+  #   URL.
+  # 
+  def git_url protocol
+    t.match protocol,
+      :ssh,   ->( _ ) { git_ssh_url },
+      :https, ->( _ ) { git_https_url }
+  end # #to_url
+  
+  
+end # class QB::GitHub::RepoID