Class: Jekyll::GitHubMetadata::Pages

Inherits:
Object
  • Object
show all
Defined in:
lib/jekyll-github-metadata/pages.rb

Constant Summary collapse

DEFAULTS = 
{
  'PAGES_ENV'              => 'dotcom'.freeze,
  'PAGES_API_URL'          => 'https://api.github.com'.freeze,
  'PAGES_HELP_URL'         => 'https://help.github.com'.freeze,
  'PAGES_GITHUB_HOSTNAME'  => 'github.com'.freeze,
  'PAGES_PAGES_HOSTNAME'   => 'github.io'.freeze,
  'SSL'                    => 'false'.freeze,
  'SUBDOMAIN_ISOLATION'    => 'false'.freeze,
  'PAGES_PREVIEW_HTML_URL' => nil
}.freeze

Class Method Summary collapse

Class Method Details

.api_url ⇒ Object 



56
57
58
 
# File 'lib/jekyll-github-metadata/pages.rb', line 56

def api_url
  trim_last_slash env_var('PAGES_API_URL', ENV['API_URL'])
end

.custom_domains_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


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

def custom_domains_enabled?
  dotcom? || test?
end

.dotcom? ⇒ Boolean

Returns:

  • (Boolean) 


33
 
# File 'lib/jekyll-github-metadata/pages.rb', line 33

def dotcom?;     env == 'dotcom' end

.enterprise? ⇒ Boolean

Returns:

  • (Boolean) 


34
 
# File 'lib/jekyll-github-metadata/pages.rb', line 34

def enterprise?; env == 'enterprise' end

.env ⇒ Object 



40
41
42
 
# File 'lib/jekyll-github-metadata/pages.rb', line 40

def env
  env_var 'PAGES_ENV'
end

.github_hostname ⇒ Object 



64
65
66
 
# File 'lib/jekyll-github-metadata/pages.rb', line 64

def github_hostname
  trim_last_slash env_var('PAGES_GITHUB_HOSTNAME', ENV['GITHUB_HOSTNAME'])
end

.github_url ⇒ Object 



48
49
50
51
52
53
54
 
# File 'lib/jekyll-github-metadata/pages.rb', line 48

def github_url
  if dotcom?
    "https://github.com".freeze
  else
    "#{scheme}://#{github_hostname}"
  end
end

.help_url ⇒ Object 



60
61
62
 
# File 'lib/jekyll-github-metadata/pages.rb', line 60

def help_url
  trim_last_slash env_var('PAGES_HELP_URL', ENV['HELP_URL'])
end

.pages_hostname ⇒ Object 



68
69
70
 
# File 'lib/jekyll-github-metadata/pages.rb', line 68

def pages_hostname
  trim_last_slash env_var('PAGES_PAGES_HOSTNAME', ENV['PAGES_HOSTNAME'])
end

.repo_pages_html_url_preview? ⇒ Boolean

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/jekyll-github-metadata/pages.rb', line 44

def repo_pages_html_url_preview?
  env_var "PAGES_PREVIEW_HTML_URL"
end

.scheme ⇒ Object 



24
25
26
 
# File 'lib/jekyll-github-metadata/pages.rb', line 24

def scheme
  ssl? ? "https" : "http"
end

.ssl? ⇒ Boolean

Whether the GitHub instance supports HTTPS Note: this will be the same as how sites are served in Enterprise, but may be different from how sites are served on GitHub.com. See Repository#url_scheme

Returns:

  • (Boolean) 


20
21
22
 
# File 'lib/jekyll-github-metadata/pages.rb', line 20

def ssl?
  env_var('SSL') == 'true' || test?
end

.subdomain_isolation? ⇒ Boolean

Returns:

  • (Boolean) 


28
29
30
 
# File 'lib/jekyll-github-metadata/pages.rb', line 28

def subdomain_isolation?
  env_var('SUBDOMAIN_ISOLATION').eql? 'true'
end

.test? ⇒ Boolean

Returns:

  • (Boolean) 


32
 
# File 'lib/jekyll-github-metadata/pages.rb', line 32

def test?;       env == 'test' end