Class: Jekyll::GitHubMetadata::Repository

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/jekyll-github-metadata/repository.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name_with_owner) ⇒ Repository

Returns a new instance of Repository



36
37
38
39
40
# File 'lib/jekyll-github-metadata/repository.rb', line 36

def initialize(name_with_owner)
  @nwo   = name_with_owner
  @owner = nwo.split("/").first
  @name  = nwo.split("/").last
end

Instance Attribute Details

#nameObject (readonly)

Returns the value of attribute name



6
7
8
# File 'lib/jekyll-github-metadata/repository.rb', line 6

def name
  @name
end

#nwoObject (readonly)

Returns the value of attribute nwo



6
7
8
# File 'lib/jekyll-github-metadata/repository.rb', line 6

def nwo
  @nwo
end

#ownerObject (readonly)

Returns the value of attribute owner



6
7
8
# File 'lib/jekyll-github-metadata/repository.rb', line 6

def owner
  @owner
end

Class Method Details

.def_hash_delegator(hash, key, method) ⇒ Object

Defines an instance method that delegates to a hash's key

hash - a symbol representing the instance method to delegate to. The

instance method should return a hash or respond to #[]

key - the key to call within the hash method - (optional) the instance method the key should be aliased to.

If not specified, defaults to the hash key

Returns a symbol representing the instance method



17
18
19
20
21
# File 'lib/jekyll-github-metadata/repository.rb', line 17

def self.def_hash_delegator(hash, key, method)
  define_method(method) do
    public_send(hash)[key.to_s]
  end
end

Instance Method Details

#cnameObject



168
169
170
171
172
# File 'lib/jekyll-github-metadata/repository.rb', line 168

def cname
  return nil unless Pages.custom_domains_enabled?

  repo_pages_info["cname"]
end

#contributorsObject



119
120
121
# File 'lib/jekyll-github-metadata/repository.rb', line 119

def contributors
  memoize_value :@contributors, Value.new("contributors", proc { |c| c.contributors(nwo) })
end

#default_user_domainObject



158
159
160
161
162
163
164
165
166
# File 'lib/jekyll-github-metadata/repository.rb', line 158

def default_user_domain
  if github_repo?
    "#{owner}.#{Pages.github_hostname}".downcase
  elsif Pages.enterprise?
    Pages.pages_hostname.downcase
  else
    "#{owner}.#{Pages.pages_hostname}".downcase
  end
end

#forks_countObject



190
191
192
# File 'lib/jekyll-github-metadata/repository.rb', line 190

def forks_count
  repo_pages_info["forks_count"] || 0
end

#github_repo?Boolean

Returns:

  • (Boolean)


139
140
141
# File 'lib/jekyll-github-metadata/repository.rb', line 139

def github_repo?
  !Pages.enterprise? && owner.eql?("github")
end

#html_urlObject



174
175
176
# File 'lib/jekyll-github-metadata/repository.rb', line 174

def html_url
  @html_url ||= (repo_pages_info["html_url"] || repo_compat.pages_url).chomp("/")
end

#issues_urlObject



97
98
99
# File 'lib/jekyll-github-metadata/repository.rb', line 97

def issues_url
  "#{repository_url}/issues" if repo_info["has_issues"]
end

#latest_releaseObject



127
128
129
# File 'lib/jekyll-github-metadata/repository.rb', line 127

def latest_release
  memoize_value :@latest_release, Value.new("latest_release", proc { |c| c.latest_release(nwo) })
end

#organization_public_membersObject



113
114
115
116
117
# File 'lib/jekyll-github-metadata/repository.rb', line 113

def organization_public_members
  memoize_value :@organization_public_members, Value.new("organization_public_members", proc do |c|
    c.organization_public_members(owner) if organization_repository?
  end)
end

#organization_repository?Boolean

Returns:

  • (Boolean)


105
106
107
# File 'lib/jekyll-github-metadata/repository.rb', line 105

def organization_repository?
  memoize_value :@is_organization_repository, Value.new("organization_repository?", proc { |c| !!c.organization(owner) })
end

#owner_gravatar_urlObject



73
74
75
# File 'lib/jekyll-github-metadata/repository.rb', line 73

def owner_gravatar_url
  "#{owner_url}.png"
end

#owner_metadataObject



65
66
67
# File 'lib/jekyll-github-metadata/repository.rb', line 65

def 
  @owner_metadata ||= Jekyll::GitHubMetadata::Owner.new(owner)
end

#owner_public_repositoriesObject



109
110
111
# File 'lib/jekyll-github-metadata/repository.rb', line 109

def owner_public_repositories
  memoize_value :@owner_public_repositories, Value.new("owner_public_repositories", proc { |c| c.list_repos(owner, "type" => "public") })
end

#owner_urlObject



69
70
71
# File 'lib/jekyll-github-metadata/repository.rb', line 69

def owner_url
  "#{Pages.github_url}/#{owner}"
end

#primary?Boolean Also known as: user_page?

Returns:

  • (Boolean)


143
144
145
146
147
148
149
# File 'lib/jekyll-github-metadata/repository.rb', line 143

def primary?
  if Pages.enterprise?
    name.downcase == "#{owner.to_s.downcase}.#{Pages.github_hostname}"
  else
    user_page_domains.include? name.downcase
  end
end

#project_page?Boolean

Returns:

  • (Boolean)


135
136
137
# File 'lib/jekyll-github-metadata/repository.rb', line 135

def project_page?
  !user_page?
end

#releasesObject



123
124
125
# File 'lib/jekyll-github-metadata/repository.rb', line 123

def releases
  memoize_value :@releases, Value.new("releases", proc { |c| c.releases(nwo) })
end

#releases_urlObject



93
94
95
# File 'lib/jekyll-github-metadata/repository.rb', line 93

def releases_url
  "#{repository_url}/releases"
end

#repo_clone_urlObject



77
78
79
# File 'lib/jekyll-github-metadata/repository.rb', line 77

def repo_clone_url
  "#{repository_url}.git"
end

#repo_compatObject



42
43
44
# File 'lib/jekyll-github-metadata/repository.rb', line 42

def repo_compat
  @repo_compat ||= Jekyll::GitHubMetadata::RepositoryCompat.new(self)
end

#repo_infoObject



46
47
48
49
50
51
# File 'lib/jekyll-github-metadata/repository.rb', line 46

def repo_info
  @repo_info ||= begin
    options = { :accept => "application/vnd.github.drax-preview+json" }
    (Value.new("repo_info", proc { |c| c.repository(nwo, options) }).render || {})
  end
end

#repo_pages_infoObject



53
54
55
# File 'lib/jekyll-github-metadata/repository.rb', line 53

def repo_pages_info
  @repo_pages_info ||= (Value.new("repo_pages_info", proc { |c| c.pages(nwo, repo_pages_info_opts) }).render || {})
end

#repo_pages_info_optsObject



57
58
59
60
61
62
63
# File 'lib/jekyll-github-metadata/repository.rb', line 57

def repo_pages_info_opts
  if Pages.repo_pages_html_url_preview?
    { :accept => "application/vnd.github.mister-fantastic-preview+json" }
  else
    {}
  end
end

#repository_urlObject



81
82
83
# File 'lib/jekyll-github-metadata/repository.rb', line 81

def repository_url
  "#{owner_url}/#{name}"
end

#sourceObject



131
132
133
# File 'lib/jekyll-github-metadata/repository.rb', line 131

def source
  repo_pages_info["source"] || repo_compat.source
end

#stargazers_countObject



186
187
188
# File 'lib/jekyll-github-metadata/repository.rb', line 186

def stargazers_count
  repo_pages_info["stargazers_count"] || 0
end

#tar_urlObject



89
90
91
# File 'lib/jekyll-github-metadata/repository.rb', line 89

def tar_url
  "#{repository_url}/tarball/#{git_ref}"
end

#uriObject



178
179
180
# File 'lib/jekyll-github-metadata/repository.rb', line 178

def uri
  @uri ||= URI(html_url)
end

#url_without_pathObject



182
183
184
# File 'lib/jekyll-github-metadata/repository.rb', line 182

def url_without_path
  uri.dup.tap { |u| u.path = "" }.to_s
end

#user_page_domainsObject



152
153
154
155
156
# File 'lib/jekyll-github-metadata/repository.rb', line 152

def user_page_domains
  domains = [default_user_domain]
  domains.push "#{owner}.github.com".downcase unless Pages.enterprise?
  domains
end

#wiki_urlObject



101
102
103
# File 'lib/jekyll-github-metadata/repository.rb', line 101

def wiki_url
  "#{repository_url}/wiki" if repo_info["has_wiki"]
end

#zip_urlObject



85
86
87
# File 'lib/jekyll-github-metadata/repository.rb', line 85

def zip_url
  "#{repository_url}/zipball/#{git_ref}"
end