qb 0.3.7 → 0.3.8

data/lib/qb/path.rb

@@ -16,6 +16,8 @@ require 'nrser'
 # Package
 # -----------------------------------------------------------------------
 
+require_relative './repo/git'
+
 
 # Refinements
 # =======================================================================
@@ -36,8 +38,9 @@ module QB; end
 # Definitions
 # =======================================================================
 
-
-# @todo document QB::Path class.
+# An extension of {Pathname} that implements the facts we want about paths
+# as {NRSER::Meta::Props}.
+# 
 class QB::Path < Pathname
   
   # Mixins
@@ -46,29 +49,137 @@ class QB::Path < Pathname
   include NRSER::Meta::Props
   
   
-  # Constants
+  # Props
   # ======================================================================
   
+  # Principle path properties
+  # ---------------------------------------------------------------------
+  # 
+  # Values stored as variables on the instance.
+  # 
   
-  # Class Methods
-  # ======================================================================
+  # The current working directory *relevant* to the path - basically, when
+  # 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 
+  #       weirdness, but it seems like we need something like this to make
+  #       instances transportable. Issues with relative paths come to mind...
+  # 
+  prop  :cwd,
+        type: t.pathname,
+        to_data: :to_s
   
+  # 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 
+  #       symbols and strings all become strings when run through {JSON}
+  #       dump and load.
+  # 
+  prop  :raw,
+        type: t.path,
+        to_data: :to_s
   
-  # Props
-  # ======================================================================
   
-  prop :raw, type: t.
-  prop :expanded, type: t.pathname, source: :expand_path
-  prop :exists, type: t.bool, source: :exists?
-  prop :is_expanded, type: t.bool, source: :expanded?
+  # Derived path properties
+  # ---------------------------------------------------------------------
+  # 
+  # On-demand values computed via method calls.
+  # 
+  
+  prop  :expanded,
+        type: t.path,
+        source: ->() { expand_path.to_s }
+  
+  prop  :exists,
+        type: t.bool,
+        source: :exist?
+  
+  prop  :is_expanded,
+        type: t.bool,
+        source: :expanded?
+  
+  prop  :is_absolute,
+        type: t.bool,
+        source: :absolute?
+  
+  prop  :is_relative,
+        type: t.bool,
+        source: :relative?
+  
+  prop  :is_dir,
+        type: t.bool,
+        source: :directory?
+  
+  prop  :is_file,
+        type: t.bool,
+        source: :file?
+  
+  prop  :is_cwd,
+        type: t.bool,
+        source: :cwd?
+  
+  prop  :relative,
+        type: t.maybe( t.path ),
+        source: :relative,
+        to_data: :to_s
+  
+  prop  :realpath,
+        type: t.maybe( t.path ),
+        source: :try_realpath,
+        to_data: :to_s
+  
+  prop  :is_realpath,
+        type: t.bool,
+        source: :realpath?
+  
+  
+  # Composed properties
+  # ---------------------------------------------------------------------
+  # 
+  # On-demand values that point to other {NRSER::Meta::Props} instances.
+  # 
+  
+  prop  :git,
+        type: QB::Repo::Git,
+        source: :git
+  
   
   # Constructor
   # ======================================================================
   
-  # Instantiate a new `QB::Path`.
-  def initialize raw:, cwd: Pathname.getwd
-    @raw = raw
-    super @raw
+  # @overload initialize path
+  #   Initialize in the same way as you would a {Pathname}. {#cwd} is set to
+  #   the current directory (via {Pathname#getwd}) and the `path` argument is
+  #   assigned to {#raw}.
+  #   
+  #   @param [String | Pathname] path
+  #     Target path.
+  # 
+  # @overload initialize **values
+  #   Initialize by invoking {NRSER::Meta::Props#initialize_props}.
+  #   
+  #   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 
+  #   one that data was constructed against.
+  #   
+  #   {#cwd} defaults to the current directory (via {Pathname.getwd}) if not
+  #   provided.
+  # 
+  # @param **values see {NRSER::Meta::Props#initialize_props}
+  #   
+  def initialize arg
+    case arg
+    when Hash
+      super arg[:raw]
+      initialize_props cwd: Pathname.getwd, **arg
+    else
+      super arg
+      initialize_props raw: arg, cwd: Pathname.getwd
+    end
   end # #initialize
   
   
@@ -76,13 +187,102 @@ class QB::Path < Pathname
   # ======================================================================
   
   # @return [Boolean]
-  #   `true` if 
+  #   `true` if `self` is equal to {#expand_path}.
+  # 
   def expanded?
+    self == expand_path
+  end
+  
+  
+  # @return [Boolean]
+  #   `true` if `self` is equal to {#cwd}.
+  # 
+  def cwd?
+    self == cwd
+  end
+  
+  
+  # Relative path from {#cwd} to `self`, if one exists.
+  # 
+  # @return [QB::Path]
+  #   If a relative path from {#cwd} to `self` exists.
+  # 
+  # @return [nil]
+  #   If no relative path from {#cwd} to `self` exists. Can't recall exactly
+  #   how this happens, but I guess it can...
+  # 
+  def relative
+    begin
+      relative_path_from cwd
+    rescue ArgumentError => error
+      nil
+    end
+  end
+  
+  
+  # Like {Pathname#realpath} but returns {nil} instead of raising if there
+  # isn't one.
+  # 
+  # @return [nil]
+  #   If there is no real path.
+  # 
+  # @return [Pathname]
+  #   If there is a real path.
+  # 
+  def try_realpath
+    begin
+      realpath
+    rescue SystemCallError => error
+      nil
+    end
+  end
+  
+  
+  # Is `self` already it's real path?
+  # 
+  # @return [Boolean]
+  #   `true` if `self` and {#try_realpath} are equal.
+  # 
+  def realpath?
+    self == try_realpath
+  end # #realpath?
+  
+  
+  # @return [Pathname]
+  #   A regular (non-{QB::Path}) {Pathname} version of `self`.
+  def path
+    Pathname.new self
+  end
+  
+  
+  # Composed Sub-Instances
+  # ---------------------------------------------------------------------
+  
+  # {QB::Repo::Git} resource for the Git repo {#path} is in one, or {nil} if
+  # it isn't.
+  # 
+  # @return [QB::Repo::Git]
+  #   If {#path} is in a Git repo.
+  # 
+  # @return [nil]
+  #   If {#path} is not in a Git repo.
+  # 
+  def git
+    unless instance_variable_defined? :@git
+      @git = QB::Repo::Git.from_path path
+    end
     
+    @git
+  end
+  
+  
+  def gem
+    unless instance_variable_defined? :@gem
+      @gem = QB::Package::Gem.from_root_path path
+    end
+    
+    @gem
   end
   
 end # class QB::Path
 
-
-# Post-Processing
-# =======================================================================

data/lib/qb/repo/git.rb

@@ -1,17 +1,43 @@
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
 require 'cmds'
-require 'nrser/refinements/types'
 
+# Project / Package
+# -----------------------------------------------------------------------
+
+
+# Refinements
+# =======================================================================
+
+require 'nrser/refinements'
+using NRSER
+
+require 'nrser/refinements/types'
 using NRSER::Types
 
-module QB 
-module Repo
+
+# Declarations
+# =======================================================================
+
+module QB; end
+module QB::Repo; end
+
+
+# Definitions
+# =======================================================================
 
 # 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 
 # 
-class Git < NRSER::Meta::Props::Base
+class QB::Repo::Git < NRSER::Meta::Props::Base
   GITHUB_SSH_URL_RE = /^git@github\.com\:(?<owner>.*)\/(?<name>.*)\.git$/
   GITHUB_HTTPS_URL_RE = /^https:\/\/github\.com\/(?<owner>.*)\/(?<name>.*)\.git$/
   
@@ -93,19 +119,30 @@ class Git < NRSER::Meta::Props::Base
   # Class Methods
   # =====================================================================
   
-  # @todo Document from_path method.
+  # Instantiate a {QB::Package::Git} resource for whatever Git repo `path`
+  # is in, or return `nil` if `path` is not in a Git repo.
   # 
-  # @param [String, Pathname] input_path
-  #   A path that is in the Git repo.
+  # @param [String, Pathname] path
+  #   A path that may be in the Git repo.
+  # 
+  # @param [Boolean] use_github_api:
+  #   When `true` will will contact the GitHub API for information to populate
+  #   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 
+  #   `{private: true}`.
   # 
   # @return [QB::Repo::Git]
+  #   If `path` is in a Git repo.
+  # 
+  # @return [nil]
+  #   If `path` is not in a Git repo.
   # 
   # @raise [QB::FSStateError]
   #   -   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
-  #       a Git repo.
   # 
   def self.from_path path, use_github_api: false
     raw_input_path = path
@@ -129,9 +166,7 @@ class Git < NRSER::Meta::Props::Base
       root_result = Cmds.capture "git rev-parse --show-toplevel"
       
       unless root_result.ok?
-        raise QB::FSStateError,
-              "Path #{ raw_input_path.inspect } does not appear to be in a " +
-              "Git repo (looked in #{ closest_dir.inspect })."
+        return nil
       end
       
       root = Pathname.new root_result.out.chomp
@@ -217,11 +252,39 @@ class Git < NRSER::Meta::Props::Base
   end # .from_path
   
   
+  # Instantiate a {QB::Package::Git} resource for whatever Git repo `path`
+  # is in, raising an error if it's not in one.
+  # 
+  # @param [String, Pathname] path
+  #   A path that is in the Git repo.
+  # 
+  # @param use_github_api: see #from_path
+  # 
+  # @return [QB::Repo::Git]
+  # 
+  # @raise [QB::FSStateError]
+  #   -   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
+  #       a Git repo.
+  # 
+  def from_path! path, use_github_api: false
+    from_path( path, use_github_api: use_github_api ).tap { |git|
+      if git.nil?
+        raise QB::FSStateError,
+              "Path #{ path.inspect } does not appear to be in a " +
+              "Git repo."
+      end
+    }
+  end # #from_path!
+  
+  
   # Props
   # =====================================================================
   
-  prop :raw_input_path, type: t.maybe(t.union(Pathname, t.str)), default: nil
-  prop :root, type: Pathname
+  prop :raw_input_path, type: t.path, default: nil, to_data: :to_s
+  prop :root, type: t.pathname, to_data: :to_s
   prop :user, type: User
   prop :is_clean, type: t.bool
   prop :head, type: t.maybe(t.str), default: nil
@@ -231,6 +294,10 @@ class Git < NRSER::Meta::Props::Base
   prop :name, type: t.maybe(t.str), default: nil
   prop :github, type: t.maybe(t.hash_), default: nil
   
+  
+  # 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?
@@ -251,11 +318,15 @@ class Git < NRSER::Meta::Props::Base
     !github.nil?
   end
   
+  
+  # Reading Repo State
+  # ---------------------------------------------------------------------
+  
+  # @return [Boolean]
+  #   `false` if the repo has any uncommitted changes or untracked files.
+  # 
   def clean?
     is_clean
   end
   
-end # class Git
-
-end # module Repo
-end # module QB
+end # class QB::Repo::Git

data/lib/qb/role.rb

@@ -411,19 +411,37 @@ class QB::Role
     path = QB::Util.resolve dest
     
     search_dirs = search_path.find_all { |pathname|
-      path.fnmatch? pathname.join('**')
+      path.fnmatch?( pathname / '**' )
     }
     
     case search_dirs.length
     when 0
       # It's not in any of the search directories
       # 
-      # If it has 'roles' as a segment than use what's after that
+      # If it has 'roles' as a segment than use what's after the last occurrence
+      # of that (unless there isn't anything).
       # 
-      split = path.to_s.split('/roles/')
+      segments = path.to_s.split File::SEPARATOR
+      
+      if index = segments.rindex( 'roles' )
+        name_segs = segments[index..-1]
+        
+        unless name_segs.empty?
+          return File.join name_segs
+        end
+      end
+      
+      # Ok, that didn't work... just return the basename I guess...
+      File.basename path
+      
+    when 1
+      
+    else
+      # Multiple matches?!?!?
+      
       
     end
-  end
+  end # #guess_role_name
   
   
   # Instance Attributes