class Agate::Object

• Agate::Object
• Reference
• Object

Overview

Base class for git objects (commits, trees, blobs, tags).

Included Modules

• Comparable(Agate::Object)

Defined in:

Constructors

• .from_obj(obj : C::GitObject) : Object

  Wraps a raw C object pointer.

• .lookup(repo : Repository, oid : OID, type : Type = Type::Any) : Object

  Looks up an object by OID in the given repository.

• .rev_parse(repo : Repository, spec : String) : Object

  Parses a revision spec (e.g., "HEAD", "HEAD~2", a SHA) and returns the matching object.

Class Method Summary

• .lookup?(repo : Repository, oid : OID, type : Type = Type::Any) : Object | Nil

  Looks up an object by OID, returning nil if not found.

• .rev_parse?(repo : Repository, spec : String) : Object | Nil

  Parses a revision spec, returning nil if it cannot be resolved.

• .rev_parse_oid(repo : Repository, spec : String) : OID

  Parses a revision spec and returns just the OID.

• .rev_parse_oid?(repo : Repository, spec : String) : OID | Nil

  Parses a revision spec and returns just the OID, or nil.

• .rev_parse_range(repo : Repository, spec : String) : Tuple(Object, Object | Nil, RevparseMode)

  Parses a range revision spec (e.g., "HEAD~3..HEAD", "v1.0...v2.0") and returns {from, to, mode}.

Instance Method Summary

• #<=>(other : Object) : Int32

  Three-way comparison by OID.

• #==(other : Object) : Bool

  Compares two objects by OID.

• #oid : OID

  Returns the OID of this object.

• #read_raw(repo : Repository) : OdbObject

  Reads the raw ODB data for this object.

• #type : Type

  Returns the type of this object.

Constructor Detail

obj = Object.rev_parse(repo, "HEAD~2")
obj.type # => Object::Type::Commit

Class Method Detail

from, to, mode = Object.rev_parse_range(repo, "HEAD~3..HEAD")
mode.range? # => true

Instance Method Detail

obj = Object.lookup(repo, oid)
raw = obj.read_raw(repo)
raw.type # => Object::Type::Commit
raw.data # => Bytes