Class: Toys::Utils::GitCache::RepoInfo

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/toys/utils/git_cache.rb

Overview

Information about a remote git repository in the cache.

This object is returned from #repo_info.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#base_dir ⇒ String (readonly)

The base directory of this git repository's cache entry. This directory contains all cached data related to this repo. Deleting it effectively removes the repo from the cache.

Returns:

  • (String) 


55
56
57
 
# File 'lib/toys/utils/git_cache.rb', line 55

def base_dir
  @base_dir
end

#last_accessed ⇒ Time? (readonly)

The last time any cached data from this repo was accessed, or nil if the information is unavailable.

Returns:

  • (Time, nil) 


70
71
72
 
# File 'lib/toys/utils/git_cache.rb', line 70

def last_accessed
  @last_accessed
end

#refs ⇒ Array<RefInfo> (readonly)

A list of git refs (branches, tags, shas) that have been accessed from this repo.

Returns:



78
79
80
 
# File 'lib/toys/utils/git_cache.rb', line 78

def refs
  @refs
end

#remote ⇒ String (readonly)

The git remote, usually a file system path or URL.

Returns:

  • (String) 


62
63
64
 
# File 'lib/toys/utils/git_cache.rb', line 62

def remote
  @remote
end

#sources ⇒ Array<SourceInfo> (readonly)

A list of shared source files and directories accessed for this repo.

Returns:



85
86
87
 
# File 'lib/toys/utils/git_cache.rb', line 85

def sources
  @sources
end

Instance Method Details

#<=>(other) ⇒ Integer

Comparison function

Parameters:

Returns:

  • (Integer) 


109
110
111
 
# File 'lib/toys/utils/git_cache.rb', line 109

def <=>(other)
  remote <=> other.remote
end

#to_h ⇒ Hash

Convert this RepoInfo to a hash suitable for JSON output

Returns:

  • (Hash) 


92
93
94
95
96
97
98
99
100
101
 
# File 'lib/toys/utils/git_cache.rb', line 92

def to_h
  result = {
    "remote" => remote,
    "base_dir" => base_dir,
  }
  result["last_accessed"] = last_accessed.to_i if last_accessed
  result["refs"] = refs.map(&:to_h)
  result["sources"] = sources.map(&:to_h)
  result
end