jekyll-github-metadata 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 552e948d80c87cc232d4e5174c01b67865d39d80
-  data.tar.gz: f0616b53308ff040e37ae03579447188d960070b
+  metadata.gz: efed2aebc358aaa6e7cee8d1c5e03e0eca432453
+  data.tar.gz: 424595a71e84aa1917bfb2198b73d0e95132268c
 SHA512:
-  metadata.gz: a7121114126260d7ab0863786f2f2f4700cb81017f7225b40ee36dadddbb4654d49e2bf1db75cd5f14e1447624554cbe8b5f79e11a9adf6c923f07dcc604db9e
-  data.tar.gz: 5a94679c3e92759b9929f0c3f44e15745f2e8eefa9e3268d24b3e5bc5274473760823d7f8ca2b4d6d9978aecffbeae26a14cd7c2b2404d1ea5f9266429ffd515
+  metadata.gz: 3253b80572e5551d4635c4d878374839be39bbc42af2e756e67b9664e82fe7967b6242501c9b4e62294eed007f7eb9946343e9848df9f2bc379f02f020c39daf
+  data.tar.gz: e81fe89c4d4912f1a0450a3c2df85d6f3511beb0bed3ec0f8a610208aee198e2680dc5ea7d58439abd6ca15db3cf1f77be1ff553e2cc26a3f8d8158c050ce2d3

data/lib/jekyll-github-metadata.rb

@@ -1,7 +1,12 @@
-require 'jekyll'
 require 'octokit'
 
 module Jekyll
+  unless const_defined? :Errors
+    module Errors
+      FatalException = Class.new(::RuntimeError) unless const_defined? :FatalException
+    end
+  end
+
   module GitHubMetadata
     NoRepositoryError = Class.new(Jekyll::Errors::FatalException)
 
@@ -14,9 +19,10 @@ module Jekyll
 
     class << self
       attr_accessor :repository
+      attr_writer :client
 
       def environment
-        Jekyll.env || Pages.env || 'development'
+        Jekyll.respond_to?(:env) ? Jekyll.env : (Pages.env || 'development')
       end
 
       def client
@@ -26,6 +32,8 @@ module Jekyll
       def values
         @values ||= Hash.new
       end
+      alias_method :to_h, :values
+      alias_method :to_liquid, :to_h
 
       def clear_values!
         @values = Hash.new
@@ -34,27 +42,20 @@ module Jekyll
       def reset!
         clear_values!
         @client = nil
+        @repository = nil
       end
 
       def [](key)
         values[key.to_s]
       end
 
-      def to_h
-        values
-      end
-
-      def to_liquid
-        to_h
-      end
-
       def register_value(key, value)
         values[key.to_s] = Value.new(key.to_s, value)
       end
 
       # Reset our values hash.
       def init!
-        reset!
+        clear_values!
 
         # Environment-Specific
         register_value('environment', proc { environment })
@@ -100,11 +101,15 @@ module Jekyll
         register_value('url',                  proc { |_,r| r.pages_url })
         register_value('contributors',         proc { |c,r| c.contributors(r.nwo) })
         register_value('releases',             proc { |c,r| c.releases(r.nwo) })
+
+        values
+      end
+
+      if Jekyll.const_defined? :Site
+        require_relative 'jekyll-github-metadata/ghp_metadata_generator'
       end
     end
 
     init!
   end
 end
-
-require_relative 'jekyll-github-metadata/ghp_metadata_generator'

data/lib/jekyll-github-metadata/client.rb

@@ -14,21 +14,18 @@ module Jekyll
 
       def build_octokit_client(options = nil)
         options = options || Hash.new
-        if ENV['JEKYLL_GITHUB_TOKEN'] || Octokit.access_token
-          options.merge!(:access_token => ENV['JEKYLL_GITHUB_TOKEN'] || Octokit.access_token)
-        elsif !ENV['NO_NETRC'] && File.exist?(File.join(ENV['HOME'], '.netrc')) && safe_require('netrc')
-          options.merge!(:netrc => true)
-        else
-          Jekyll.logger.warn "GitHubMetadata:", "No GitHub API authentication could be found." +
-            " Some fields may be missing or have incorrect data."
+        unless options.key? :access_token
+          options.merge! pluck_auth_method
         end
         Octokit::Client.new({:auto_paginate => true}.merge(options))
       end
 
       def method_missing(meth, *args, &block)
         if @client.respond_to?(meth)
-          instance_variable_get(:"@#{meth}") ||
-            instance_variable_set(:"@#{meth}", save_from_errors { @client.send(meth, *args, &block) })
+          instance_var_name = meth.to_s.sub('?', '_')
+          Jekyll.logger.debug "GitHub Metadata:", "Calling @client.#{meth}(#{args.map(&:inspect).join(", ")})"
+          instance_variable_get(:"@#{instance_var_name}") ||
+            instance_variable_set(:"@#{instance_var_name}", save_from_errors { @client.send(meth, *args, &block) })
         else
           super(meth, *args, &block)
         end
@@ -46,6 +43,20 @@ module Jekyll
         Octokit::TooManyRequests
         default
       end
+
+      private
+
+      def pluck_auth_method
+        if ENV['JEKYLL_GITHUB_TOKEN'] || Octokit.access_token
+          { :access_token => ENV['JEKYLL_GITHUB_TOKEN'] || Octokit.access_token }
+        elsif !ENV['NO_NETRC'] && File.exist?(File.join(ENV['HOME'], '.netrc')) && safe_require('netrc')
+          { :netrc => true }
+        else
+          Jekyll.logger.warn "GitHub Metadata:", "No GitHub API authentication could be found." +
+            " Some fields may be missing or have incorrect data."
+          {}.freeze
+        end
+      end
     end
   end
 end

data/lib/jekyll-github-metadata/ghp_metadata_generator.rb

@@ -1,12 +1,11 @@
-require 'jekyll'
-
 module Jekyll
   module GitHubMetadata
     class GHPMetadataGenerator < Jekyll::Generator
       def generate(site)
         Jekyll.logger.debug "Generator:", "Calling GHPMetadataGenerator"
-        GitHubMetadata.repository = GitHubMetadata::Repository.new(nwo(site))
-        GitHubMetadata.init!
+        initialize_repo! nwo(site)
+        Jekyll.logger.debug "GitHub Metadata:", "Generating for #{GitHubMetadata.repository.nwo}"
+
         site.config['github'] =
           case site.config['github']
           when nil
@@ -18,6 +17,15 @@ module Jekyll
           end
       end
 
+      private
+
+      def initialize_repo!(repo_nwo)
+        if GitHubMetadata.repository.nil? || GitHubMetadata.repository.nwo != repo_nwo
+          GitHubMetadata.init!
+          GitHubMetadata.repository = GitHubMetadata::Repository.new(repo_nwo)
+        end
+      end
+
       def nwo(site)
         ENV['PAGES_REPO_NWO'] || \
           site.config['repository'] || \

data/lib/jekyll-github-metadata/pages.rb

@@ -6,37 +6,58 @@ module Jekyll
           'PAGES_ENV'             => 'dotcom'.freeze,
           'PAGES_API_URL'         => 'https://api.github.com'.freeze,
           'PAGES_HELP_URL'        => 'https://help.github.com'.freeze,
-          'PAGES_GITHUB_HOSTNAME' => 'https://github.com'.freeze,
+          'PAGES_GITHUB_HOSTNAME' => 'github.com'.freeze,
           'PAGES_PAGES_HOSTNAME'  => 'github.io'.freeze,
-          'SSL'                   => 'false'.freeze
+          'SSL'                   => 'false'.freeze,
+          'SUBDOMAIN_ISOLATION'   => 'false'.freeze
         }.freeze
 
         def ssl?
-          env_var('SSL').eql? 'true'
+          env_var('SSL') == 'true' || test?
         end
 
         def scheme
           ssl? ? "https" : "http"
         end
 
+        def subdomain_isolation?
+          env_var('SUBDOMAIN_ISOLATION').eql? 'true'
+        end
+
+        def test?;       env == 'test' end
+        def dotcom?;     env == 'dotcom' end
+        def enterprise?; env == 'enterprise' end
+
+        def custom_domains_enabled?
+          dotcom? || test?
+        end
+
         def env
           env_var 'PAGES_ENV'
         end
 
+        def github_url
+          if dotcom?
+            "https://github.com".freeze
+          else
+            "#{scheme}://#{github_hostname}"
+          end
+        end
+
         def api_url
-          trim_last_slash env_var('PAGES_API_URL', Octokit.api_endpoint)
+          trim_last_slash env_var('PAGES_API_URL', ENV['API_URL'])
         end
 
         def help_url
-          trim_last_slash env_var('PAGES_HELP_URL')
+          trim_last_slash env_var('PAGES_HELP_URL', ENV['HELP_URL'])
         end
 
         def github_hostname
-          trim_last_slash env_var('PAGES_GITHUB_HOSTNAME', Octokit.web_endpoint)
+          trim_last_slash env_var('PAGES_GITHUB_HOSTNAME', ENV['GITHUB_HOSTNAME'])
         end
 
         def pages_hostname
-          trim_last_slash env_var('PAGES_PAGES_HOSTNAME')
+          trim_last_slash env_var('PAGES_PAGES_HOSTNAME', ENV['PAGES_HOSTNAME'])
         end
 
         private

data/lib/jekyll-github-metadata/repository.rb

@@ -9,7 +9,7 @@ module Jekyll
       end
 
       def organization_repository?
-        !!GitHubMetadata.client.organization(owner)
+        !!Value.new(proc { |c| c.organization(owner) }).render
       end
 
       def git_ref
@@ -29,7 +29,7 @@ module Jekyll
       end
 
       def owner_url
-        "#{Pages.github_hostname}/#{owner}"
+        "#{Pages.github_url}/#{owner}"
       end
 
       def owner_gravatar_url
@@ -41,7 +41,7 @@ module Jekyll
       end
 
       def repository_url
-        "#{Pages.github_hostname}/#{nwo}"
+        "#{owner_url}/#{name}"
       end
 
       def zip_url
@@ -73,46 +73,79 @@ module Jekyll
       end
 
       def project_page?
-        !primary?
+        !user_page?
       end
 
-      def primary?
-        user_page_domains.include? name.downcase
+      def github_repo?
+        !Pages.enterprise? && owner.eql?('github')
       end
 
-      def github_repo?
-        owner.eql?('github')
+      def primary?
+        if Pages.enterprise?
+          name.downcase == "#{owner.to_s.downcase}.#{Pages.github_hostname}"
+        else
+          user_page_domains.include? name.downcase
+        end
       end
 
       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
 
       def user_page_domains
-        [
-          default_user_domain,
-          "#{owner}.github.com".downcase # legacy
-        ]
+        domains = [default_user_domain]
+        domains.push "#{owner}.github.com".downcase unless Pages.enterprise?
+        domains
+      end
+
+      def user_domain
+        domain = default_user_domain
+        user_page_domains.each do |user_repo|
+          candidate_nwo = "#{owner}/#{user_repo}"
+          next unless Value.new(proc { |client| client.repository? candidate_nwo }).render
+          domain = self.class.new(candidate_nwo).domain
+        end
+        domain
       end
 
       def pages_url
-        if cname || primary?
+        if !Pages.custom_domains_enabled?
+          path = user_page? ? owner : nwo
+          if Pages.subdomain_isolation?
+            URI.join("#{Pages.scheme}://#{Pages.pages_hostname}/", path).to_s
+          else
+            URI.join("#{Pages.github_url}/pages/", path).to_s
+          end
+        elsif cname || primary?
           "#{Pages.scheme}://#{domain}"
         else
-          URI.join("#{Pages.scheme}://#{domain}", "#{name}/")
+          URI.join("#{Pages.scheme}://#{domain}", name).to_s
         end
       end
 
       def cname
+        return @cname if defined?(@cname)
+        return unless Pages.custom_domains_enabled?
         @cname ||= (Value.new('cname', proc { |c| c.pages(nwo) }).render || {'cname' => nil})['cname']
       end
 
       def domain
-        cname || default_user_domain
+        @domain ||=
+          if !Pages.custom_domains_enabled?
+            Pages.github_hostname
+          elsif cname # explicit CNAME
+            cname
+          elsif primary? # user/org repo
+            default_user_domain
+          else # project repo
+            user_domain
+          end
       end
     end
   end

data/lib/jekyll-github-metadata/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module GitHubMetadata
-    VERSION = '1.2.0'
+    VERSION = '1.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-github-metadata
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Parker Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-05 00:00:00.000000000 Z
+date: 2016-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit