class Rugged::Walker

Public Class Methods

new(repository) → walker click to toggle source

Create a new Walker instance able to walk commits found in repository, which is a Rugged::Repository instance.

static VALUE rb_git_walker_new(VALUE klass, VALUE rb_repo)
{
        git_repository *repo;
        git_revwalk *walk;
        int error;

        Data_Get_Struct(rb_repo, git_repository, repo);

        error = git_revwalk_new(&walk, repo);
        rugged_exception_check(error);

        return rugged_walker_new(klass, rb_repo, walk);;
}

Public Instance Methods

each { |commit| block } click to toggle source
each → Iterator

Perform the walk through the repository, yielding each one of the commits found as a Rugged::Commit instance to block.

If no block is given, an Iterator will be returned.

The walker must have been previously set-up before a walk can be performed (i.e. at least one commit must have been pushed).

walker.push("92b22bbcb37caf4f6f53d30292169e84f5e4283b")
walker.each { |commit| puts commit.oid }

generates:

92b22bbcb37caf4f6f53d30292169e84f5e4283b
6b750d5800439b502de669465b385e5f469c78b6
ef9207141549f4ffcd3c4597e270d32e10d0a6bc
cb75e05f0f8ac3407fb3bd0ebd5ff07573b16c9f
...
static VALUE rb_git_walker_each(int argc, VALUE *argv, VALUE self)
{
        return rb_git_walker_each_with_opts(argc, argv, self, 0);
}
each_oid { |commit| block } click to toggle source
each_oid → Iterator

Perform the walk through the repository, yielding each one of the commit oids found as a String to block.

If no block is given, an Iterator will be returned.

The walker must have been previously set-up before a walk can be performed (i.e. at least one commit must have been pushed).

walker.push("92b22bbcb37caf4f6f53d30292169e84f5e4283b")
walker.each { |commit_oid| puts commit_oid }

generates:

92b22bbcb37caf4f6f53d30292169e84f5e4283b
6b750d5800439b502de669465b385e5f469c78b6
ef9207141549f4ffcd3c4597e270d32e10d0a6bc
cb75e05f0f8ac3407fb3bd0ebd5ff07573b16c9f
...
static VALUE rb_git_walker_each_oid(int argc, VALUE *argv, VALUE self)
{
        return rb_git_walker_each_with_opts(argc, argv, self, 1);
}
hide(commit) → nil click to toggle source

Hide the given commit (and all its parents) from the output in the revision walk.

static VALUE rb_git_walker_hide(VALUE self, VALUE rb_commit)
{
        git_revwalk *walk;
        git_commit *commit;
        int error;

        Data_Get_Struct(self, git_revwalk, walk);

        commit = (git_commit *)rugged_object_get(
                git_revwalk_repository(walk), rb_commit, GIT_OBJ_COMMIT);

        error = git_revwalk_hide(walk, git_object_id((git_object *)commit));

        git_commit_free(commit);
        rugged_exception_check(error);

        return Qnil;
}
push(commit) → nil click to toggle source

Push one new commit to start the walk from. commit must be a String with the OID of a commit in the repository, or a Rugged::Commit instance.

More than one commit may be pushed to the walker (to walk several branches simulataneously).

Duplicate pushed commits will be ignored; at least one commit must have been pushed as a starting point before the walk can begin.

walker.push("92b22bbcb37caf4f6f53d30292169e84f5e4283b")
static VALUE rb_git_walker_push(VALUE self, VALUE rb_commit)
{
        git_revwalk *walk;
        git_commit *commit;
        int error;

        Data_Get_Struct(self, git_revwalk, walk);

        commit = (git_commit *)rugged_object_get(
                git_revwalk_repository(walk), rb_commit, GIT_OBJ_COMMIT);

        error = git_revwalk_push(walk, git_object_id((git_object *)commit));

        git_commit_free(commit);
        rugged_exception_check(error);

        return Qnil;
}
push_range(p1) click to toggle source
static VALUE rb_git_walker_push_range(VALUE self, VALUE range)
{
        git_revwalk *walk;
        Data_Get_Struct(self, git_revwalk, walk);
        rugged_exception_check(git_revwalk_push_range(walk, StringValueCStr(range)));
        return Qnil;
}
reset → nil click to toggle source

Remove all pushed and hidden commits and reset the walker back into a blank state.

static VALUE rb_git_walker_reset(VALUE self)
{
        git_revwalk *walk;
        Data_Get_Struct(self, git_revwalk, walk);
        git_revwalk_reset(walk);
        return Qnil;
}
simplify_first_parent() → nil click to toggle source

Simplify the walk to the first parent of each commit.

static VALUE rb_git_walker_simplify_first_parent(VALUE self)
{
        git_revwalk *walk;
        Data_Get_Struct(self, git_revwalk, walk);
        git_revwalk_simplify_first_parent(walk);
        return Qnil;
}
sorting(sort_mode) → nil click to toggle source

Change the sorting mode for the revision walk.

This will cause walker to be reset.

static VALUE rb_git_walker_sorting(VALUE self, VALUE ruby_sort_mode)
{
        git_revwalk *walk;
        Data_Get_Struct(self, git_revwalk, walk);
        git_revwalk_sorting(walk, FIX2INT(ruby_sort_mode));
        return Qnil;
}
each { |commit| block } click to toggle source
each → Iterator

Perform the walk through the repository, yielding each one of the commits found as a Rugged::Commit instance to block.

If no block is given, an Iterator will be returned.

The walker must have been previously set-up before a walk can be performed (i.e. at least one commit must have been pushed).

walker.push("92b22bbcb37caf4f6f53d30292169e84f5e4283b")
walker.each { |commit| puts commit.oid }

generates:

92b22bbcb37caf4f6f53d30292169e84f5e4283b
6b750d5800439b502de669465b385e5f469c78b6
ef9207141549f4ffcd3c4597e270d32e10d0a6bc
cb75e05f0f8ac3407fb3bd0ebd5ff07573b16c9f
...
static VALUE rb_git_walker_each(int argc, VALUE *argv, VALUE self)
{
        return rb_git_walker_each_with_opts(argc, argv, self, 0);
}