qb 0.3.8 → 0.3.9

data/lib/qb/path.rb

@@ -16,7 +16,7 @@ require 'nrser'
 # Package
 # -----------------------------------------------------------------------
 
-require_relative './repo/git'
+require 'qb/repo/git'
 
 
 # Refinements
@@ -278,7 +278,7 @@ class QB::Path < Pathname
   
   def gem
     unless instance_variable_defined? :@gem
-      @gem = QB::Package::Gem.from_root_path path
+      @gem = QB::Package::Gem.from_root_path path, repo: git
     end
     
     @gem

data/lib/qb/repo.rb

@@ -1 +1,137 @@
-require_relative './repo/git'
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+
+# 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
+  
+  # Constants
+  # ======================================================================
+  
+  
+  # Class Methods
+  # ======================================================================
+  
+  # Get an instance for whatever repo `path` is in.
+  # 
+  # @param [String, Pathname] path
+  #   A path that may be in a repo.
+  # 
+  # @return [nil]
+  #   If `path` *is not* a part of repo we can recognize (`git` only at the
+  #   moment, sorry).
+  # 
+  # @return [QB::Repo]
+  #   If `path` *is* not a part of repo we can recognize.
+  # 
+  def self.from_path path, git: {}
+    QB::Repo::Git.from_path path, **git
+  end # .from_path
+  
+  
+  # Instantiate a {QB::Repo} for the repo `path` is in or raise if it's not in
+  # any single recognizable repo.
+  # 
+  # @param path see .from_path
+  # @param **opts see .from_path
+  # 
+  # @return [QB::Repo]
+  # 
+  # @raise [QB::FSStateError]
+  #   If `path` is not in a repo.
+  # 
+  def self.from_path! path, **opts
+    from_path( path, **opts ).tap { |repo|
+      if repo.nil?
+        raise QB::FSStateError,
+              "Path #{ path.inspect } does not appear to be in a repo."
+      end
+    }
+  end # .from_path!
+  
+  
+  # Properties
+  # ======================================================================
+  
+  # @!attribute [r] ref_path
+  #   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 
+  #   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 
+  #     argument.
+  #   
+  prop  :ref_path, type: t.maybe( t.path )
+  
+  
+  # @!attribute [r] root_path
+  #   Absolute path to the gem's root directory.
+  #   
+  #   @return [Pathname]
+  #   
+  prop  :root_path, type: t.dir_path
+  
+  
+  # @!attribute [r] name
+  #   The string name of the repo.
+  # 
+  #   @return [String]
+  #     Non-empty string.
+  # 
+  prop  :name, type: t.maybe( t.non_empty_str )
+  
+  
+  # Instance Methods
+  # ======================================================================
+  
+  # @todo Document tags method.
+  # 
+  # @param [type] arg_name
+  #   @todo Add name param description.
+  # 
+  # @return [Array<String>]
+  # 
+  def tags
+    raise NotImplementedError
+  end # #tags
+  
+  
+end # class QB::Repo
+
+
+# Post-Processing
+# =======================================================================
+
+require 'qb/repo/git'

data/lib/qb/repo/git.rb

@@ -7,9 +7,11 @@
 # Deps
 # -----------------------------------------------------------------------
 require 'cmds'
+require 'git'
 
 # Project / Package
 # -----------------------------------------------------------------------
+require 'qb/util/resource'
 
 
 # Refinements
@@ -26,7 +28,7 @@ using NRSER::Types
 # =======================================================================
 
 module QB; end
-module QB::Repo; end
+class QB::Repo < QB::Util::Resource; end
 
 
 # Definitions
@@ -37,11 +39,11 @@ module QB::Repo; end
 # 
 # The main entry point is {QB::Repo::Git.from_path}, which creates a 
 # 
-class QB::Repo::Git < NRSER::Meta::Props::Base
+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$/
   
-  class User < NRSER::Meta::Props::Base
+  class User < QB::Util::Resource
     prop :name, type: t.maybe(t.str), default: nil
     prop :email, type: t.maybe(t.str), default: nil
   end
@@ -119,6 +121,13 @@ class QB::Repo::Git < NRSER::Meta::Props::Base
   # Class Methods
   # =====================================================================
   
+  # Factories
+  # ---------------------------------------------------------------------
+  # 
+  # Class methods that instantiate an instance of {QB::Repo::Git}, specializing
+  # it as a subclass when appropriate.
+  # 
+  
   # Instantiate a {QB::Package::Git} resource for whatever Git repo `path`
   # is in, or return `nil` if `path` is not in a Git repo.
   # 
@@ -145,10 +154,10 @@ class QB::Repo::Git < NRSER::Meta::Props::Base
   #       `input_path`.
   # 
   def self.from_path path, use_github_api: false
-    raw_input_path = path
+    ref_path = path
     
     # Create a Pathname from the input
-    input_path = Pathname.new raw_input_path
+    input_path = Pathname.new ref_path
     
     # input_path may point to a file, or something that doesn't even exist.
     # We want to ascend until we find an existing directory that we can cd into.
@@ -158,7 +167,7 @@ class QB::Repo::Git < NRSER::Meta::Props::Base
     if closest_dir.nil?
       raise QB::FSStateError,
             "Unable to find any existing directory from path " +
-            "#{ raw_input_path.inspect }"
+            "#{ ref_path.inspect }"
     end
     
     # Change into the directory to make shell life easier
@@ -169,7 +178,7 @@ class QB::Repo::Git < NRSER::Meta::Props::Base
         return nil
       end
       
-      root = Pathname.new root_result.out.chomp
+      root_path = Pathname.new root_result.out.chomp
       
       user = User.new **NRSER.map_values(User.props.keys) {|key, _|
         begin
@@ -205,13 +214,9 @@ class QB::Repo::Git < NRSER::Meta::Props::Base
       name = nil
       github = nil
       
-      if origin && match = (
-            GITHUB_SSH_URL_RE.match(origin) ||
-            GITHUB_HTTPS_URL_RE.match(origin)
-          )
+      if origin && QB::Repo::Git::GitHub.url?( origin )
         
-        owner = match['owner']
-        name = match['name']
+        repo_id = QB::Repo::Git::GitHub.parse_url origin
         
         if use_github_api
           github = OpenStruct.new
@@ -231,12 +236,27 @@ class QB::Repo::Git < NRSER::Meta::Props::Base
           github = github.to_h
         end
         
+        return QB::Repo::Git::GitHub.new(
+          ref_path: ref_path,
+          input_path: input_path,
+          root_path: root_path,
+          user: user,
+          is_clean: is_clean,
+          head: head,
+          branch: branch,
+          origin: origin,
+          repo_id: repo_id,
+          owner: repo_id.owner,
+          name: repo_id.name,
+          github: github,
+        )
+        
       end
       
       new(
-        raw_input_path: raw_input_path,
+        ref_path: ref_path,
         input_path: input_path,
-        root: root,
+        root_path: root_path,
         user: user,
         is_clean: is_clean,
         head: head,
@@ -283,16 +303,13 @@ class QB::Repo::Git < NRSER::Meta::Props::Base
   # Props
   # =====================================================================
   
-  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
-  prop :branch, type: t.maybe(t.str), default: nil
-  prop :origin, type: t.maybe(t.str), default: nil
-  prop :owner, type: t.maybe(t.str), default: nil
-  prop :name, type: t.maybe(t.str), default: nil
-  prop :github, type: t.maybe(t.hash_), default: nil
+  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
@@ -318,6 +335,10 @@ class QB::Repo::Git < NRSER::Meta::Props::Base
     !github.nil?
   end
   
+  def api    
+    @api ||= ::Git.open root_path
+  end
+  
   
   # Reading Repo State
   # ---------------------------------------------------------------------
@@ -329,4 +350,15 @@ class QB::Repo::Git < NRSER::Meta::Props::Base
     is_clean
   end
   
+  
+  def tags
+    api.tags.map &:name
+  end
+  
 end # class QB::Repo::Git
+
+
+# Post-Processing
+# =======================================================================
+
+require 'qb/repo/git/github'

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

@@ -0,0 +1,137 @@
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+
+# Project / Package
+# -----------------------------------------------------------------------
+require 'qb/github'
+require 'qb/repo/git'
+
+# Refinements
+# =======================================================================
+
+require 'nrser/refinements'
+using NRSER
+
+require 'nrser/refinements/types'
+using NRSER::Types
+
+
+# Definitions
+# =======================================================================
+
+# 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
+  
+  # Constants
+  # ======================================================================
+  
+  SSH_URL_RE = /^git@github\.com\:(?<owner>.*)\/(?<name>.*)\.git$/
+  HTTPS_URL_RE = /^https:\/\/github\.com\/(?<owner>.*)\/(?<name>.*)\.git$/
+  
+  
+  # Props
+  # ---------------------------------------------------------------------
+  
+  ### Primary Properties
+  
+  prop :repo_id, type: QB::GitHub::RepoID
+  
+  
+  ### Derived Properties
+  
+  
+  # Class Methods
+  # ======================================================================
+  
+  # Helpers
+  # ---------------------------------------------------------------------
+  
+  def self.ssh_url? string
+    SSH_URL_RE =~ string
+  end
+  
+  
+  def self.https_url? string
+    HTTPS_URL_RE =~ string
+  end
+  
+  
+  def self.url? string
+    ssh_url?( string ) || https_url?( string )
+  end
+  
+  
+  def self.parse_ssh_url string
+    parse_url_with SSH_URL_RE, string
+  end
+  
+  
+  def self.parse_https_url string
+    parse_url_with HTTPS_URL_RE, string
+  end
+  
+  
+  # Extract owner and name from Git remote URL string pointing to GitHub.
+  # 
+  # @return [nil]
+  #   If the URL is not recognized.
+  # 
+  # @return [QB::GitHub::RepoID]
+  #   If the URL successfully parses.
+  # 
+  def self.parse_url string
+    parse_ssh_url( string ) || parse_https_url( string )
+  end
+  
+  
+  # Eigenclass (Singleton Class)
+  # ========================================================================
+  # 
+  class << self
+    protected
+    # ========================================================================
+      
+      
+      # @todo Document parse_url_with method.
+      # 
+      # @param [type] arg_name
+      #   @todo Add name param description.
+      # 
+      # @return [return_type]
+      #   @todo Document return value.
+      # 
+      def parse_url_with regexp, string
+        if match = regexp.match( string )
+          QB::GitHub::RepoID.new owner: match['owner'], name: match['name']
+        end
+      end # #parse_url_with
+      
+      
+    # end protected
+  end # class << self (Eigenclass)
+  
+  
+  # Instance Methods
+  # ======================================================================
+  
+  def api
+    QB::GitHub::API.client.repo repo_id.path
+  end
+  
+  
+  def issue number
+    # QB::GitHub::API.client.issue( repo_id.path, number ).to_h.stringify_keys
+    QB::GitHub::Issue.find_by repo_id: repo_id, number: number
+  end
+  
+  
+end # class QB::Repo::Git::GitHub
+