Module: Git::Repository::Logging Private

Included in:
Git::Repository
Defined in:
lib/git/repository/logging.rb

Overview

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Facade methods for querying commit history

Included by Git::Repository.

Instance Method Summary collapse

Instance Method Details

#full_log_commits(opts = {}) ⇒ Array<Hash>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

On Git for Windows, git's default regex engine matches bytes rather than characters, so a metacharacter such as . or a POSIX class such as [[:alpha:]] never matches a whole multi-byte character in a :grep or :author pattern. The match fails silently: git exits zero and the result is empty. Pass perl_regexp: true to select PCRE, which does match characters. PCRE is a different dialect than git's default, so this is a deliberate choice by the caller rather than a transparent substitution.

Returns commits within the given revision range

Examples:

Return commits from all refs

repo.full_log_commits(all: true).first['sha']
#=> "a1b2c3d4..."

Return commits between two revisions

repo.full_log_commits(between: ['v1.0.0', 'HEAD']).map { |c| c['sha'] }
#=> ["d4e5f6...", "a1b2c3..."]

Parameters:

  • opts (Hash) (defaults to: {}) —

    options for the log query

Options Hash (opts):

  • :count (Integer, nil) — default: nil —

    maximum number of commits to return

  • :all (Boolean, nil) — default: nil —

    include commits reachable from any ref

  • :cherry (Boolean, nil) — default: nil —

    omit commits equivalent to cherry-picked commits

  • :since (String) — default: nil —

    include commits newer than this date expression

  • :until (String) — default: nil —

    include commits older than this date expression

  • :grep (String) — default: nil —

    only include commits whose message matches this pattern

  • :author (String) — default: nil —

    only include commits whose author matches this pattern

  • :between (Array(String, String), nil) — default: nil —

    revision range as two commit-ish values

    When both :between and :object are provided, :between takes precedence.

  • :object (String) — default: nil —

    single revision range expression for git log

    Ignored when :between is provided.

  • :path_limiter (String, Pathname, Array<String, Pathname>, nil) — default: nil —

    only include commits that impact files from the specified path(s)

  • :skip (Integer, nil) — default: nil —

    skip this many commits before output

  • :merges (Boolean, nil) — default: nil —

    include only merge commits

  • :perl_regexp (Boolean, nil) — default: nil —

    interpret the :grep and :author patterns as Perl-compatible regular expressions (PCRE) instead of git's default POSIX basic regular expressions

    Requires a git built with PCRE support; git otherwise fails with "cannot use Perl-compatible regexes...".

Returns:

  • (Array<Hash>) —

    the parsed raw log output for each commit

Raises:

  • (ArgumentError) —

    if unsupported options are provided

  • (ArgumentError) —

    if :count is not an Integer

  • (Git::FailedError) —

    if git exits with a non-zero exit status

See Also:



96
97
98
99
100
101
102
103
104
 
# File 'lib/git/repository/logging.rb', line 96

def full_log_commits(opts = {})
  SharedPrivate.assert_valid_opts!(FULL_LOG_COMMITS_ALLOWED_OPTS, **opts)
  Private.validate_log_count_option!(opts)
  Private.validate_log_between_option!(opts)

  call_opts = Private.log_base_call_options(opts, skip: opts[:skip], merges: opts[:merges])
  revision_range_args = Private.log_revision_range_args(opts)
  Private.run_log_command(@execution_context, revision_range_args, call_opts)
end

#log(count = 30) ⇒ Git::Log

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new Log query builder scoped to this repository

Examples:

Build a log query and execute it

results = repo.log(50).author('Alice').since('2 weeks ago').execute
results.each { |commit| puts commit.sha }

Parameters:

  • count (Integer, Symbol, nil) (defaults to: 30) —

    the maximum number of commits to return, or :all / nil to return all commits; passed directly to Log#initialize

Returns:

  • (Git::Log) —

    a new log query builder

See Also:



119
120
121
 
# File 'lib/git/repository/logging.rb', line 119

def log(count = 30)
  Git::Log.new(self, count)
end