piotrmurach/github_cli

View on GitHub
lib/github_cli/commands/commits.rb

Summary

Maintainability
A
40 mins
Test Coverage
# frozen_string_literal: true

require_relative "../apis/commit"
require_relative "../util"
require_relative "../command"

module GithubCLI
  module Commands
    class Commits < Command

      namespace :commit

      desc "get <user> <repo> <sha>", "Get a Commit"
      def get(user, repo, sha)
        global_options = options.dup
        params = options[:params].dup
        Util.hash_without!(global_options, params.keys + ["params"])
        Commit.get user, repo, sha, params, global_options
      end

      desc "create <user> <repo>", "Create a Commit"
      option :message, :type => :string, :aliases => ["-m"],
        :desc => "String of the commit message."
      option :tree, :type => :string, :aliases => ["-t"], :banner => "<sha>",
        :desc => "String of the SHA of the tree object this commit points to."
      option :parents, :type => :array, :banner => "<sha1> <sha2> ...",
        :desc => "Array of the SHAs of the commits that were the parents of this commit. "
      option :author, :type => :hash,
        :desc => "If the author section is omitted, it will be filled in with the authenticated user’s information and the current date."
      option :committer, :type => :hash,
        :desc => "The committer section is optional and will be filled with the author data if omitted."
      option :signature, :type => :string,
        :desc => "The PGP signature of the commit"
      long_desc <<-DESC
        Parameters

        message - String of the commit message \n
        tree - String of the SHA of the tree object this commit points to \n
        parents - Array of the SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided, for a merge commit, an array of more than one should be provided. \n

          Optional Parameters

          The committer section is optional and will be filled with the author data if omitted. If the author section is omitted, it will be filled in with the authenticated users information and the current date.

          author.name - String of the name of the author of the commit \n
          author.email - String of the email of the author of the commit \n
          author.date - Timestamp of when this commit was authored \n
          committer.name - String of the name of the committer of the commit \n
          committer.email - String of the email of the committer of the commit \n
          committer.date - Timestamp of when this commit was committed
      DESC
      def create(user, repo)
        global_options = options.dup
        params = options[:params].dup
        params["message"]   = options[:message]   if options.key?("message")
        params["tree"]      = options[:tree]      if options.key?("tree")
        params["parents"]   = options[:parents]   if options.key?("parents")
        params["author"]    = options[:author]    if options.key?("author")
        params["committer"] = options[:committer] if options.key?("committer")
        params["signature"] = options[:signature] if options.key?("signature")
        Util.hash_without!(global_options, params.keys + ["params"])
        Commit.create user, repo, params, global_options
      end
    end # Commit
  end # Commands
end # GithubCLI