qb 0.3.15 → 0.3.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 003b446aa520075c83fc445695b0babad54437b3
-  data.tar.gz: c994400156228766aeec6ea26103e7ee6217ad3c
+  metadata.gz: 2c65f9c354ec520a8f1ac149b0cd94584b17f597
+  data.tar.gz: 7627ef3fee17449eeed1421aa99c31fda9c8c4b5
 SHA512:
-  metadata.gz: 2e379e64f336af6be769dc44e14654e598c01aa21b03e2148f5e82c51c23f8ece9808c0943459eb39158515b5b6e3c0f4c8ce6e27785ee2b30846543c8f6ba58
-  data.tar.gz: '0813dfb291517540ac560d6dabf4aafb4bb328b1abf54cd61dab3b858aea28833e3060be8c6ac057a505f78371a970ebcbe1b7656abe5e678191147d6da346e2'
+  metadata.gz: 1f61779f264ece1c9d6bc5f6dbfce675b0d8603d9dca96ea5b8653cd169a4c041cb5a1eafa108f0356c8b2482e41c8edcde8394324367b7742ff15d763d7270b
+  data.tar.gz: 0b5caaf19c3ce3ccba500b16289aac12e09ceae5f9eabf1d1a93371ea4ea79646f337af00adaa8e6c8f008289b2f80b8baaddbaf2f63d9edd0449fe21b265234

data/lib/qb/ansible/module.rb

@@ -2,6 +2,13 @@ require 'json'
 require 'pp'
 
 
+# Refinements
+# =======================================================================
+
+using NRSER
+using NRSER::Types
+
+
 # Declarations
 # =====================================================================
 
@@ -33,14 +40,16 @@ class QB::Ansible::Module
   end
   
   
-  # Constructor
+  # Construction
   # =====================================================================
   
   def initialize
     @changed = false
-    @input_file = ARGV[0]
-    @input = File.read @input_file
-    @args = JSON.load @input
+    # @input_file = ARGV[0]
+    # @input = File.read @input_file
+    # @args = JSON.load @input
+    init_set_args!
+    
     @facts = {}
     @warnings = []
     
@@ -82,12 +91,73 @@ class QB::Ansible::Module
         END
       end
       
-      instance_variable_set var_name,
-                            type.check(@args.fetch(key.to_s))
+      value = type.check( @args[key.to_s] ) do |type:, value:|
+        all_args = @args
+        
+        binding.erb <<-END
+          Value
+          
+              <%= value.pretty_inspect %>
+          
+          for argument <%= key.inspect %> is not valid for type
+          
+              <%= type %>
+          
+          Arguments:
+          
+              <%= all_args.pretty_inspect %>
+          
+        END
+      end
+      
+      instance_variable_set var_name, value
     }
   end
   
   
+  protected
+  # ========================================================================
+    
+  def init_set_args!
+    if ARGV.length == 1 && File.file?( ARGV[0] )
+      # "Standard" Ansible-invoked mode, where the args written in JSON format
+      # to a file and the path is provided as the only CLI argument
+      # 
+      @input_file = ARGV[0]
+      @input = File.read @input_file
+      @args = JSON.load @input
+      
+    else
+      # QB-specific "fiddle-mode": if we don't have a single valid file path
+      # as CLI arguments, parse the CLI options we have in the common
+      # 
+      #     `--name=value`
+      # 
+      # format into the `@args` hash.
+      # 
+      # This lets us run the module file **directly** from the terminal, which
+      # is just a quick and dirty way of flushing things out.
+      # 
+      @fiddle_mode = true
+      @args = {}
+      
+      ARGV.each do |arg|
+        if arg.start_with? '--'
+          key, value = arg[2..-1].split( '=', 2 )
+          
+          @args[key] = begin
+            JSON.load value
+          rescue
+            value
+          end
+        end
+      end
+    end
+  end # #init_set_args!
+    
+  # end protected
+  public
+  
   
   # Instance Methods
   # =====================================================================
@@ -102,10 +172,10 @@ class QB::Ansible::Module
   # 
   # When run inside of QB (targeting localhost only at the moment, sadly)
   # we expose additional IO channels for STDIN, STDOUT and STDERR through
-  # opening unix socket files that the main QB process spawns threads to 
+  # opening unix socket files that the main QB process spawns threads to
   # listen to, and we provide those file paths via environment variables
   # so modules can pick those up and interact with those streams, allowing
-  # them to act like regular scripts inside Ansible-world (see 
+  # them to act like regular scripts inside Ansible-world (see
   # QB::Util::STDIO for details and implementation).
   # 
   # We use those channels if present to provide logging mechanisms.
@@ -170,7 +240,7 @@ class QB::Ansible::Module
   def exit_json hash
     # print JSON response to process' actual STDOUT (instead of $stdout,
     # which may be pointing to the qb parent process)
-    STDOUT.print JSON.dump(self.class.stringify_keys(hash))
+    STDOUT.print JSON.pretty_generate(self.class.stringify_keys(hash))
     
     [
       [:stdin, @qb_stdio_in],
@@ -191,4 +261,4 @@ class QB::Ansible::Module
   def fail msg
     exit_json failed: true, msg: msg, warnings: @warnings
   end
-end # class QB::Ansible::Module
+end # class QB::Ansible::Module

data/lib/qb/package.rb

@@ -18,19 +18,10 @@ require_relative './package/version'
 # Refinements
 # =======================================================================
 
-require 'nrser/refinements'
 using NRSER
-
-require 'nrser/refinements/types'
 using NRSER::Types
 
 
-# Declarations
-# =======================================================================
-
-module QB; end
-
-
 # Definitions
 # =======================================================================
 
@@ -54,14 +45,14 @@ class QB::Package < QB::Util::Resource
   #   User-provided path value used to construct the resource instance, if any.
   #   
   #   This may not be the same as a root path for the resource, such as with
-  #   resource classes that can be constructed from any path *inside* the 
+  #   resource classes that can be constructed from any path *inside* the
   #   directory, like a {QB::Repo::Git}.
   #   
   #   @return [String | Pathname]
   #     If the resource instance was constructed based on a path argument.
   #   
   #   @return [nil]
-  #     If the resource instance was *not* constructed based on a path 
+  #     If the resource instance was *not* constructed based on a path
   #     argument.
   #   
   prop  :ref_path, type: t.maybe( t.dir_path )
@@ -144,7 +135,7 @@ class QB::Package < QB::Util::Resource
   
   # Relative path from the {#repo} root to the {#root_path}.
   # 
-  # Used as the version tag prefix (unless it's `.` - when the repo root is 
+  # Used as the version tag prefix (unless it's `.` - when the repo root is
   # the root path).
   # 
   # @return [Pathname]
@@ -159,7 +150,7 @@ class QB::Package < QB::Util::Resource
   # Only makes any sense if the package is in a recognized repo, and will error
   # out if that's not the case.
   # 
-  # The most basic prefix is "v" for packages located at the root of the 
+  # The most basic prefix is "v" for packages located at the root of the
   # repository.
   # 
   # @example
@@ -230,4 +221,3 @@ end # class QB::Package
 # =======================================================================
 
 require_relative './package/gem'
-

data/lib/qb/path.rb

@@ -3,38 +3,24 @@
 
 # Stdlib
 # -----------------------------------------------------------------------
-
 require 'pathname'
 
-
 # Deps
 # -----------------------------------------------------------------------
-
 require 'nrser'
 
-
 # Package
 # -----------------------------------------------------------------------
-
 require 'qb/repo/git'
 
 
 # Refinements
 # =======================================================================
 
-require 'nrser/refinements'
 using NRSER
-
-require 'nrser/refinements/types'
 using NRSER::Types
 
 
-# Declarations
-# =======================================================================
-
-module QB; end
-
-
 # Definitions
 # =======================================================================
 
@@ -62,7 +48,7 @@ class QB::Path < Pathname
   # and where the instance was created, which may be on a totally different
   # system if the instance was loaded from data.
   # 
-  # TODO  Not totally flushed out yet, could imagine a lot of problems and 
+  # TODO  Not totally flushed out yet, could imagine a lot of problems and
   #       weirdness, but it seems like we need something like this to make
   #       instances transportable. Issues with relative paths come to mind...
   # 
@@ -73,7 +59,7 @@ class QB::Path < Pathname
   # The raw path argument used to instantiate the path object.
   # 
   # NOTE  Because we reduce {Pathname} instances to {String} when converting
-  #       to data, there is some lossy-ness. I guess it's similar to how 
+  #       to data, there is some lossy-ness. I guess it's similar to how
   #       symbols and strings all become strings when run through {JSON}
   #       dump and load.
   # 
@@ -120,6 +106,10 @@ class QB::Path < Pathname
         type: t.bool,
         source: :cwd?
   
+  prop  :is_symlink,
+        type: t.bool,
+        source: :symlink?
+  
   prop  :relative,
         type: t.maybe( t.path ),
         source: :relative,
@@ -146,6 +136,18 @@ class QB::Path < Pathname
         source: :git
   
   
+  # # Value would be *loadable* via init
+  # prop  :packages,
+  #       type: t.map( keys: t.sym, values: QB::Package ),
+  #       default: ->() { QB::Package.all_from_path self }
+  # 
+  # 
+  # # Value would be ignored by init and re-computed
+  # prop  :packages,
+  #       type: t.map( keys: t.sym, values: QB::Package ),
+  #       source: ->() { QB::Package.all_from_path self },
+  #       cache: true
+  
   # Constructor
   # ======================================================================
   
@@ -163,7 +165,7 @@ class QB::Path < Pathname
   #   The {#raw} value is passed up to {Pathname#initialize}.
   #   
   #   {#cwd} is accepted in `values`, allowing a re-instantiated object to
-  #   "make sense" when the process' current directory may no longer be the 
+  #   "make sense" when the process' current directory may no longer be the
   #   one that data was constructed against.
   #   
   #   {#cwd} defaults to the current directory (via {Pathname.getwd}) if not
@@ -254,6 +256,8 @@ class QB::Path < Pathname
     Pathname.new self
   end
   
+  alias_method :pathname, :path
+  
   
   # Composed Sub-Instances
   # ---------------------------------------------------------------------
@@ -285,4 +289,3 @@ class QB::Path < Pathname
   end
   
 end # class QB::Path
-

data/lib/qb/repo.rb

@@ -6,30 +6,26 @@
 
 # Deps
 # -----------------------------------------------------------------------
+require 'nrser'
 
 # Project / Package
 # -----------------------------------------------------------------------
+require 'qb/util/resource'
 
 
 # Refinements
 # =======================================================================
 
-require 'nrser/refinements'
 using NRSER
-
-require 'nrser/refinements/types'
 using NRSER::Types
 
 
-# Declarations
-# =======================================================================
-
-
 # Definitions
 # =======================================================================
 
 # @todo document QB::Repo class.
 class QB::Repo < QB::Util::Resource
+  autoload :Git, 'qb/repo/git'
   
   # Constants
   # ======================================================================
@@ -83,14 +79,14 @@ class QB::Repo < QB::Util::Resource
   #   User-provided path value used to construct the resource instance, if any.
   #   
   #   This may not be the same as a root path for the resource, such as with
-  #   resource classes that can be constructed from any path *inside* the 
+  #   resource classes that can be constructed from any path *inside* the
   #   directory, like a {QB::Repo::Git}.
   #   
   #   @return [String | Pathname]
   #     If the resource instance was constructed based on a path argument.
   #   
   #   @return [nil]
-  #     If the resource instance was *not* constructed based on a path 
+  #     If the resource instance was *not* constructed based on a path
   #     argument.
   #   
   prop  :ref_path, type: t.maybe( t.path )
@@ -129,9 +125,3 @@ class QB::Repo < QB::Util::Resource
   
   
 end # class QB::Repo
-
-
-# Post-Processing
-# =======================================================================
-
-require 'qb/repo/git'

data/lib/qb/repo/git.rb

@@ -17,10 +17,7 @@ require 'qb/util/resource'
 # Refinements
 # =======================================================================
 
-require 'nrser/refinements'
 using NRSER
-
-require 'nrser/refinements/types'
 using NRSER::Types
 
 
@@ -37,16 +34,33 @@ class QB::Repo < QB::Util::Resource; end
 # Encapsulate information about a Git repository and expose useful operations as
 # instance methods.
 # 
-# The main entry point is {QB::Repo::Git.from_path}, which creates a 
+# The main entry point is {QB::Repo::Git.from_path}, which creates a
 # 
 class QB::Repo::Git < QB::Repo
-  GITHUB_SSH_URL_RE = /^git@github\.com\:(?<owner>.*)\/(?<name>.*)\.git$/
-  GITHUB_HTTPS_URL_RE = /^https:\/\/github\.com\/(?<owner>.*)\/(?<name>.*)\.git$/
+  autoload :User, 'qb/repo/git/user'
+  autoload :GitHub, 'qb/repo/git/github'
   
-  class User < QB::Util::Resource
-    prop :name, type: t.maybe(t.str), default: nil
-    prop :email, type: t.maybe(t.str), default: nil
-  end
+  # Props
+  # =====================================================================
+  
+  prop :user, type: User
+  prop :head, type: t.maybe(t.str)
+  prop :branch, type: t.maybe(t.str)
+  prop :origin, type: t.maybe(t.str)
+  prop :owner, type: t.maybe(t.str)
+  prop :github, type: t.maybe(t.hash_)
+  
+  
+  # Derived Properties
+  # ---------------------------------------------------------------------
+  
+  prop :head_short, type: t.maybe(t.str), source: :head_short
+  prop :full_name,  type: t.maybe(t.str), source: :full_name
+  prop :is_github,  type: t.bool,         source: :github?
+  prop :is_clean,   type: t.bool,         source: :clean?
+  
+  
+
   
   
   # class GitHubRemote < NRSER::Meta::Props::Base
@@ -64,11 +78,11 @@ class QB::Repo::Git < QB::Repo
   #   # =====================================================================
   #   
   #   # Test if a Git SSH or HTTPS remote url points to GitHub.
-  #   # 
+  #   #
   #   # @param [String] url
-  #   # 
+  #   #
   #   # @return [Boolean]
-  #   # 
+  #   #
   #   def self.url? url
   #     SSH_URL_RE.match(url) || HTTPS_URL_RE.match(url)
   #   end # .url?
@@ -76,13 +90,13 @@ class QB::Repo::Git < QB::Repo
   #   
   #   # Instantiate an instance from a Git SSH or HTTPS remote url that points
   #   # to GitHub.
-  #   # 
+  #   #
   #   # @param [type] arg_name
   #   #   @todo Add name param description.
-  #   # 
+  #   #
   #   # @return [QB::Repo::Git::GitHubRemote]
   #   #   @todo Document return value.
-  #   # 
+  #   #
   #   def self.from_url url, use_api: false
   #     match = SSH_URL_RE.match(git.origin) ||
   #             HTTPS_URL_RE.match(git.origin)
@@ -104,13 +118,13 @@ class QB::Repo::Git < QB::Repo
   #   
   #   
   #   # @todo Document full_name method.
-  #   # 
+  #   #
   #   # @param [type] arg_name
   #   #   @todo Add name param description.
-  #   # 
+  #   #
   #   # @return [return_type]
   #   #   @todo Document return value.
-  #   # 
+  #   #
   #   def full_name arg_name
   #     "#{ owner }/#{ name }"
   #   end # #full_name
@@ -139,8 +153,8 @@ class QB::Repo::Git < QB::Repo
   #   the {QB::Repo::Git#github} property for repos that have a GitHub origin
   #   URL.
   #   
-  #   Otherwise we will just assume GitHub repos are private since it's the 
-  #   safe guess, resulting in a {QB::Repo::Git#github} value of 
+  #   Otherwise we will just assume GitHub repos are private since it's the
+  #   safe guess, resulting in a {QB::Repo::Git#github} value of
   #   `{private: true}`.
   # 
   # @return [QB::Repo::Git]
@@ -150,7 +164,7 @@ class QB::Repo::Git < QB::Repo
   #   If `path` is not in a Git repo.
   # 
   # @raise [QB::FSStateError]
-  #   -   If we can't find any existing directory to look in based on 
+  #   -   If we can't find any existing directory to look in based on
   #       `input_path`.
   # 
   def self.from_path path, use_github_api: false
@@ -283,7 +297,7 @@ class QB::Repo::Git < QB::Repo
   # @return [QB::Repo::Git]
   # 
   # @raise [QB::FSStateError]
-  #   -   If we can't find any existing directory to look in based on 
+  #   -   If we can't find any existing directory to look in based on
   #       `input_path`.
   #       
   #   -   If the directory we do find to look in does not seems to be part of
@@ -300,26 +314,6 @@ class QB::Repo::Git < QB::Repo
   end # #from_path!
   
   
-  # Props
-  # =====================================================================
-  
-  prop :user, type: User
-  prop :is_clean, type: t.bool
-  prop :head, type: t.maybe(t.str)
-  prop :branch, type: t.maybe(t.str)
-  prop :origin, type: t.maybe(t.str)
-  prop :owner, type: t.maybe(t.str)
-  prop :github, type: t.maybe(t.hash_)
-  
-  
-  # Derived Properties
-  # ---------------------------------------------------------------------
-  
-  prop :head_short, type: t.maybe(t.str), source: :head_short
-  prop :full_name, type: t.maybe(t.str), source: :full_name
-  prop :is_github, type: t.bool, source: :github?
-  
-  
   # Instance Methods
   # =====================================================================
   
@@ -331,11 +325,22 @@ class QB::Repo::Git < QB::Repo
     head[0...7] if head
   end
   
+  
+  # Always returns `false`, where {QB::Repo::Git::GitHub#github?} always
+  # returns `true`.
+  # 
+  # Use {.from_path} to construct instances so you end up with the right
+  # class.
+  # 
+  # @return [false]
+  # 
   def github?
-    !github.nil?
+    # origin && QB::Repo::Git::GitHub.url?( origin )
+    false
   end
   
-  def api    
+  
+  def api
     @api ||= ::Git.open root_path
   end
   
@@ -343,11 +348,28 @@ class QB::Repo::Git < QB::Repo
   # Reading Repo State
   # ---------------------------------------------------------------------
   
+  def status
+    Cmds.new( 'git status --porcelain', chdir: root_path ).
+      out!.lines.map( &:chomp ).map { |line|
+        m = /\A\s*(?<mode>\S+)\s*(?<path>.*)\z/.match line
+        
+        [m['path'], m['mode']]
+      }.to_h
+  end
+  
+  
   # @return [Boolean]
   #   `false` if the repo has any uncommitted changes or untracked files.
   # 
-  def clean?
-    is_clean
+  def clean? ignore: nil
+    if ignore
+      ignore = [*ignore]
+      status.reject { |path, mode|
+        ignore.any? { |pattern| File.fnmatch? pattern, path }
+      }.empty?
+    else
+      status.empty?
+    end
   end
   
   
@@ -356,9 +378,3 @@ class QB::Repo::Git < QB::Repo
   end
   
 end # class QB::Repo::Git
-
-
-# Post-Processing
-# =======================================================================
-
-require 'qb/repo/git/github'