Class: Jekyll::GitHubMetadata::Repository
- Inherits:
-
Object
- Object
- Jekyll::GitHubMetadata::Repository
- Defined in:
- lib/jekyll-github-metadata/repository.rb
Instance Attribute Summary collapse
-
#name ⇒ Object
readonly
Returns the value of attribute name.
-
#nwo ⇒ Object
readonly
Returns the value of attribute nwo.
-
#owner ⇒ Object
readonly
Returns the value of attribute owner.
Instance Method Summary collapse
- #cname ⇒ Object
- #contributors ⇒ Object
- #default_user_domain ⇒ Object
- #domain ⇒ Object
- #git_ref ⇒ Object
- #github_repo? ⇒ Boolean
- #html_url ⇒ Object
-
#initialize(name_with_owner) ⇒ Repository
constructor
A new instance of Repository.
- #issues_url ⇒ Object
- #language ⇒ Object
- #organization_public_members ⇒ Object
- #organization_repository? ⇒ Boolean
- #owner_gravatar_url ⇒ Object
- #owner_public_repositories ⇒ Object
- #owner_url ⇒ Object
- #primary? ⇒ Boolean
- #project_page? ⇒ Boolean
- #releases ⇒ Object
- #releases_url ⇒ Object
- #repo_clone_url ⇒ Object
- #repo_compat ⇒ Object
- #repo_info ⇒ Object
- #repo_pages_info ⇒ Object
- #repo_pages_info_opts ⇒ Object
- #repository_url ⇒ Object
- #show_downloads? ⇒ Boolean
- #tagline ⇒ Object
- #tar_url ⇒ Object
- #uri ⇒ Object
- #url_scheme ⇒ Object
- #user_page? ⇒ Boolean
- #user_page_domains ⇒ Object
- #wiki_url ⇒ Object
- #zip_url ⇒ Object
Constructor Details
#initialize(name_with_owner) ⇒ Repository
Returns a new instance of Repository.
5 6 7 8 9 |
# File 'lib/jekyll-github-metadata/repository.rb', line 5 def initialize(name_with_owner) @nwo = name_with_owner @owner = nwo.split("/").first @name = nwo.split("/").last end |
Instance Attribute Details
#name ⇒ Object (readonly)
Returns the value of attribute name.
4 5 6 |
# File 'lib/jekyll-github-metadata/repository.rb', line 4 def name @name end |
#nwo ⇒ Object (readonly)
Returns the value of attribute nwo.
4 5 6 |
# File 'lib/jekyll-github-metadata/repository.rb', line 4 def nwo @nwo end |
#owner ⇒ Object (readonly)
Returns the value of attribute owner.
4 5 6 |
# File 'lib/jekyll-github-metadata/repository.rb', line 4 def owner @owner end |
Instance Method Details
#cname ⇒ Object
141 142 143 144 |
# File 'lib/jekyll-github-metadata/repository.rb', line 141 def cname return nil unless Pages.custom_domains_enabled? repo_pages_info["cname"] end |
#contributors ⇒ Object
93 94 95 |
# File 'lib/jekyll-github-metadata/repository.rb', line 93 def contributors memoize_value :@contributors, Value.new(proc { |c| c.contributors(nwo) }) end |
#default_user_domain ⇒ Object
131 132 133 134 135 136 137 138 139 |
# File 'lib/jekyll-github-metadata/repository.rb', line 131 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 |
#domain ⇒ Object
154 155 156 |
# File 'lib/jekyll-github-metadata/repository.rb', line 154 def domain uri.host end |
#git_ref ⇒ Object
101 102 103 |
# File 'lib/jekyll-github-metadata/repository.rb', line 101 def git_ref user_page? ? 'master' : 'gh-pages' end |
#github_repo? ⇒ Boolean
113 114 115 |
# File 'lib/jekyll-github-metadata/repository.rb', line 113 def github_repo? !Pages.enterprise? && owner.eql?('github') end |
#html_url ⇒ Object
146 147 148 |
# File 'lib/jekyll-github-metadata/repository.rb', line 146 def html_url @html_url ||= (repo_pages_info["html_url"] || repo_compat.pages_url).chomp("/") end |
#issues_url ⇒ Object
67 68 69 |
# File 'lib/jekyll-github-metadata/repository.rb', line 67 def issues_url "#{repository_url}/issues" if repo_info["has_issues"] end |
#language ⇒ Object
31 32 33 |
# File 'lib/jekyll-github-metadata/repository.rb', line 31 def language repo_info["language"] end |
#organization_public_members ⇒ Object
87 88 89 90 91 |
# File 'lib/jekyll-github-metadata/repository.rb', line 87 def organization_public_members memoize_value :@organization_public_members, Value.new(proc { |c| c.organization_public_members(owner) if organization_repository? }) end |
#organization_repository? ⇒ Boolean
79 80 81 |
# File 'lib/jekyll-github-metadata/repository.rb', line 79 def organization_repository? memoize_value :@is_organization_repository, Value.new(proc { |c| !!c.organization(owner) }) end |
#owner_gravatar_url ⇒ Object
43 44 45 |
# File 'lib/jekyll-github-metadata/repository.rb', line 43 def owner_gravatar_url "#{owner_url}.png" end |
#owner_public_repositories ⇒ Object
83 84 85 |
# File 'lib/jekyll-github-metadata/repository.rb', line 83 def owner_public_repositories memoize_value :@owner_public_repositories, Value.new(proc { |c| c.list_repos(owner, "type" => "public") }) end |
#owner_url ⇒ Object
39 40 41 |
# File 'lib/jekyll-github-metadata/repository.rb', line 39 def owner_url "#{Pages.github_url}/#{owner}" end |
#primary? ⇒ Boolean
117 118 119 120 121 122 123 |
# File 'lib/jekyll-github-metadata/repository.rb', line 117 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
109 110 111 |
# File 'lib/jekyll-github-metadata/repository.rb', line 109 def project_page? !user_page? end |
#releases ⇒ Object
97 98 99 |
# File 'lib/jekyll-github-metadata/repository.rb', line 97 def releases memoize_value :@releases, Value.new(proc { |c| c.releases(nwo) }) end |
#releases_url ⇒ Object
63 64 65 |
# File 'lib/jekyll-github-metadata/repository.rb', line 63 def releases_url "#{repository_url}/releases" end |
#repo_clone_url ⇒ Object
47 48 49 |
# File 'lib/jekyll-github-metadata/repository.rb', line 47 def repo_clone_url "#{repository_url}.git" end |
#repo_compat ⇒ Object
11 12 13 |
# File 'lib/jekyll-github-metadata/repository.rb', line 11 def repo_compat @repo_compat ||= Jekyll::GitHubMetadata::RepositoryCompat.new(self) end |
#repo_info ⇒ Object
15 16 17 |
# File 'lib/jekyll-github-metadata/repository.rb', line 15 def repo_info @repo_info ||= (Value.new(proc { |c| c.repository(nwo) }).render || Hash.new) end |
#repo_pages_info ⇒ Object
19 20 21 |
# File 'lib/jekyll-github-metadata/repository.rb', line 19 def repo_pages_info @repo_pages_info ||= (Value.new(proc { |c| c.pages(nwo, repo_pages_info_opts) }).render || Hash.new) end |
#repo_pages_info_opts ⇒ Object
23 24 25 26 27 28 29 |
# File 'lib/jekyll-github-metadata/repository.rb', line 23 def repo_pages_info_opts if Pages.repo_pages_html_url_preview? { :accept => "application/vnd.github.mister-fantastic-preview+json" } else {} end end |
#repository_url ⇒ Object
51 52 53 |
# File 'lib/jekyll-github-metadata/repository.rb', line 51 def repository_url "#{owner_url}/#{name}" end |
#show_downloads? ⇒ Boolean
75 76 77 |
# File 'lib/jekyll-github-metadata/repository.rb', line 75 def show_downloads? !!repo_info["has_downloads"] end |
#tagline ⇒ Object
35 36 37 |
# File 'lib/jekyll-github-metadata/repository.rb', line 35 def tagline repo_info["description"] end |
#tar_url ⇒ Object
59 60 61 |
# File 'lib/jekyll-github-metadata/repository.rb', line 59 def tar_url "#{repository_url}/tarball/#{git_ref}" end |
#uri ⇒ Object
150 151 152 |
# File 'lib/jekyll-github-metadata/repository.rb', line 150 def uri @uri ||= URI(html_url) end |
#url_scheme ⇒ Object
158 159 160 |
# File 'lib/jekyll-github-metadata/repository.rb', line 158 def url_scheme uri.scheme end |
#user_page? ⇒ Boolean
105 106 107 |
# File 'lib/jekyll-github-metadata/repository.rb', line 105 def user_page? primary? end |
#user_page_domains ⇒ Object
125 126 127 128 129 |
# File 'lib/jekyll-github-metadata/repository.rb', line 125 def user_page_domains domains = [default_user_domain] domains.push "#{owner}.github.com".downcase unless Pages.enterprise? domains end |
#wiki_url ⇒ Object
71 72 73 |
# File 'lib/jekyll-github-metadata/repository.rb', line 71 def wiki_url "#{repository_url}/wiki" if repo_info["has_wiki"] end |
#zip_url ⇒ Object
55 56 57 |
# File 'lib/jekyll-github-metadata/repository.rb', line 55 def zip_url "#{repository_url}/zipball/#{git_ref}" end |