octokitted 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f1a1eec4292305ffb36ee14107f171a44eb4c4ec36b681ac1cbb43239fee2ca
-  data.tar.gz: f11e7f4e512223b975247f83720d6d9a465f5126e70e8928007c8be2e01fb350
+  metadata.gz: f50897f06c435796e586cc57693cd25e312344890f209d463df1a967879b36e3
+  data.tar.gz: 7895d7418b7baaf86e33ac9cd457e3d80c9df0b16776cc4a23e9eec2183e02f2
 SHA512:
-  metadata.gz: 520b1c0f16cb7ff369e287eeebeb8c27efbca078ca31fc16825682dd4bc4cd30594532c63eaf76787af5245092fa5a092a7c71f1e0faa07ea1efc48503ec973a
-  data.tar.gz: f2b6bf07d1a3463b960daaa02aded2db981bb0640affb5b87afc78a3c7726040f907e915bb3e3c2796c404b35ec9c3d08c666e6347c8ba54dde612eaa7ec3014
+  metadata.gz: 32fc230ed082aebecc9c20a046a19dee3f98d1863385506d8cd12b1be5ac86a40bed13a55cabcd561fd0b865db7d7509e34fd4ec34f31993e306812df415aa8c
+  data.tar.gz: 233c1748bfcba805594a9158ec56ef8197d4df432b8024fbf72756d38187b6e9d503e0bb68248b824760333f85e04dd9bf79ae40fead940bdba13d78055c951e

data/lib/octokitted/git_plugin.rb

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
 
 require "git"
+require "contracts"
 
 class GitPlugin
   attr_reader :login
 
+  include Contracts::Core
+  include Contracts::Builtin
+
   # Initialize the class
+  Contract KeywordArgs[logger: Any, login: Maybe[String], token: Maybe[String]] => Any
   def initialize(logger:, login:, token:)
     @log = logger
     @login = login
@@ -14,25 +19,32 @@ class GitPlugin
 
   # Removes / cleans up all repos that this class has cloned
   # :param cloned_repos: An array of paths to cloned repos to remove
+  # :return: true to indicate success
+  Contract ArrayOf[String] => true
   def remove_all_clones!(cloned_repos)
     @log.debug("removing all cloned repos")
     cloned_repos.each do |path|
       @log.debug("removing cloned repo: #{path}")
       FileUtils.rm_r(path)
     end
+    true
   end
 
   # Removes a single cloned repo
   # :param path: The path to the cloned repo to remove (String)
+  # :return: true to indicate success
+  Contract String => true
   def remove_clone!(path)
     @log.debug("removing cloned repo: #{path}")
     FileUtils.rm_r(path)
+    return true
   end
 
   # Clone a repository
   # :param path: The relative path to clone the repo to - (default: ".")
   # :param options: The options to pass to the Git.clone method (default: {} - https://rubydoc.info/gems/git/Git#clone-class_method)
   # :return: Hash of the Git Object, and the path to the cloned repo
+  Contract KeywordArgs[org: String, repo: String, path: Maybe[String], options: Maybe[Hash]] => Hash
   def clone(org:, repo:, path: ".", options: {})
     @log.debug("cloning #{org}/#{repo}")
     git_object = Git.clone("https://#{@token}@github.com/#{org}/#{repo}.git", repo, path:, log: @log, **options)

data/lib/octokitted.rb

@@ -2,6 +2,7 @@
 
 require "octokit"
 require "logger"
+require "contracts"
 
 require_relative "octokitted/git_plugin"
 
@@ -9,6 +10,9 @@ class Octokitted
   # A Octokitted class to interact with the GitHub API
   attr_reader :login, :org, :repo, :org_and_repo, :octokit, :cloned_repos
 
+  include Contracts::Core
+  include Contracts::Builtin
+
   # Initialize the class
   # :param login: The login to use for GitHubAPI interactions (defaults to the owner of the token)
   # :param org: The org to use with the Octokitted class
@@ -16,6 +20,7 @@ class Octokitted
   # :param token: The token to use to authenticate with the GitHub API
   # :param logger: The logger to use for logging
   def initialize(login: nil, org: nil, repo: nil, token: nil, logger: nil)
+    @log = logger || setup_logger
     @cloned_repos = []
     org_and_repo_hash = fetch_org_and_repo
     @login = login
@@ -23,7 +28,6 @@ class Octokitted
     @repo = repo || org_and_repo_hash[:repo]
     @token = token || fetch_token
     @octokit = setup_octokit_client
-    @log = logger || setup_logger
     @org_and_repo = org_and_repo_hash[:org_and_repo]
     @login = @octokit.login if @login.nil? # reset the login to the owner of the token if not provided
 
@@ -38,8 +42,9 @@ class Octokitted
 
   # Setter method for the repo instance variable
   # :param repo: The repo to set
-  # :return: the new org/repo
+  # :return: it does not return as it is a setter method
   # Example: gh.repo = "test"
+  Contract String => Any
   def repo=(repo)
     @repo = repo
     @org_and_repo = "#{@org}/#{@repo}"
@@ -48,8 +53,9 @@ class Octokitted
 
   # Setter method for the org instance variable
   # :param org: The org to set
-  # :return: the new org/repo
+  # :return: it does not return as it is a setter method
   # Example: gh.org = "test"
+  Contract String => Any
   def org=(org)
     @org = org
     @org_and_repo = "#{@org}/#{@repo}"
@@ -60,12 +66,17 @@ class Octokitted
   # :param path: The relative path to clone the repo to - (default: ".")
   # :param options: The options to pass (default: {} - https://rubydoc.info/gems/git/Git#clone-class_method)
   # :return: The Git object to operate with
+  Contract Maybe[String], Maybe[Hash] => Git::Base
   def clone(path: ".", options: {})
     result = @git.clone(org: @org, repo: @repo, path:, options:)
     @cloned_repos << result[:path]
     return result[:git_object]
   end
 
+  # Remove a cloned repository
+  # :param path: The relative path to the cloned repo to remove (String)
+  # :return: true to indicate success
+  Contract String => true
   def remove_clone!(path)
     valid = false
 
@@ -82,11 +93,16 @@ class Octokitted
 
     @git.remove_clone!(path)
     @cloned_repos.delete(path)
+    true
   end
 
+  # Remove all cloned repositories that have been cloned with this instance of Octokitted
+  # :return: true to indicate success
+  Contract None => true
   def remove_all_clones!
     @git.remove_all_clones!(@cloned_repos)
     @cloned_repos = []
+    true
   end
 
   private
@@ -99,6 +115,7 @@ class Octokitted
 
   # Fetch the org and repo from the environment
   # :return: A hash containing the org and repo, and the org and repo separately
+  Contract None => HashOf[Symbol, String]
   def fetch_org_and_repo
     org_and_repo = ENV.fetch("GITHUB_REPOSITORY", nil)
     org = nil
@@ -111,7 +128,8 @@ class Octokitted
   end
 
   # fetch the GitHub token from the environment
-  # :return: The GitHub token
+  # :return: The GitHub token or nil if not found
+  Contract None => Maybe[String]
   def fetch_token
     # first try to use the OCTOKIT_ACCESS_TOKEN env var if it exists
     token = ENV.fetch("OCTOKIT_ACCESS_TOKEN", nil) # if running in actions
@@ -121,7 +139,10 @@ class Octokitted
     token = ENV.fetch("GITHUB_TOKEN", nil) # if running in actions
     return token unless token.nil?
 
-    raise "No GitHub token found"
+    # if we get here, we don't have a token - this is okay because we can still do some things...
+    # ... without a token, rate limiting can be an issue
+    @log.warn("No GitHub token found")
+    return nil
   end
 
   # Setup an Octokit client

data/lib/version.rb

@@ -2,6 +2,6 @@
 
 module Octokitted
   module Version
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokitted
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Grant Birkinbine