jekyll-github-metadata 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53e700215c67954ca3037fddd6766fcd6e6c86f7
-  data.tar.gz: 5041bdbf06942910b6520d46176edae8c97a5184
+  metadata.gz: 552e948d80c87cc232d4e5174c01b67865d39d80
+  data.tar.gz: f0616b53308ff040e37ae03579447188d960070b
 SHA512:
-  metadata.gz: b10f6f1f148b3792ba1806c58c28a20bdf99e1621acfc8650c9e543d2b361f4f0ff1fe65385c3130b97aa13690738bd0e348bf7595f382dbdb9b45f29f7befee
-  data.tar.gz: 2fb3576ef8e5713f77f2821443faf3182d2a77a288501d8cf672cdef0a9bca9b315522cf05c9f36462b1406b80348fb83fe2d02e317d46557c219464deb2fdb0
+  metadata.gz: a7121114126260d7ab0863786f2f2f4700cb81017f7225b40ee36dadddbb4654d49e2bf1db75cd5f14e1447624554cbe8b5f79e11a9adf6c923f07dcc604db9e
+  data.tar.gz: 5a94679c3e92759b9929f0c3f44e15745f2e8eefa9e3268d24b3e5bc5274473760823d7f8ca2b4d6d9978aecffbeae26a14cd7c2b2404d1ea5f9266429ffd515

data/lib/jekyll-github-metadata.rb

@@ -1,7 +1,10 @@
+require 'jekyll'
 require 'octokit'
 
 module Jekyll
   module GitHubMetadata
+    NoRepositoryError = Class.new(Jekyll::Errors::FatalException)
+
     autoload :Client,     'jekyll-github-metadata/client'
     autoload :Pages,      'jekyll-github-metadata/pages'
     autoload :Repository, 'jekyll-github-metadata/repository'
@@ -28,6 +31,11 @@ module Jekyll
         @values = Hash.new
       end
 
+      def reset!
+        clear_values!
+        @client = nil
+      end
+
       def [](key)
         values[key.to_s]
       end
@@ -43,46 +51,59 @@ module Jekyll
       def register_value(key, value)
         values[key.to_s] = Value.new(key.to_s, value)
       end
+
+      # Reset our values hash.
+      def init!
+        reset!
+
+        # Environment-Specific
+        register_value('environment', proc { environment })
+        register_value('hostname', proc { Pages.github_hostname })
+        register_value('pages_env', proc { Pages.env })
+        register_value('pages_hostname', proc { Pages.pages_hostname })
+        register_value('api_url', proc { Pages.api_url })
+        register_value('help_url', proc { Pages.help_url })
+
+        register_value('versions', proc {
+          begin
+            require 'github-pages'
+            GitHubPages.versions
+          rescue LoadError; Hash.new end
+        })
+
+        # The Juicy Stuff
+        register_value('public_repositories',  proc { |c,r| c.list_repos(r.owner, "type" => "public") })
+        register_value('organization_members', proc { |c,r|
+          c.organization_public_members(r.owner) if r.organization_repository?
+        })
+        register_value('build_revision',       proc {
+          ENV['JEKYLL_BUILD_REVISION'] || `git rev-parse HEAD`.strip
+        })
+        register_value('project_title',        proc { |_,r| r.name })
+        register_value('project_tagline',      proc { |_,r| r.tagline })
+        register_value('owner_name',           proc { |_,r| r.owner })
+        register_value('owner_url',            proc { |_,r| r.owner_url })
+        register_value('owner_gravatar_url',   proc { |_,r| r.owner_gravatar_url })
+        register_value('repository_url',       proc { |_,r| r.repository_url })
+        register_value('repository_nwo',       proc { |_,r| r.nwo })
+        register_value('repository_name',      proc { |_,r| r.name})
+        register_value('zip_url',              proc { |_,r| r.zip_url })
+        register_value('tar_url',              proc { |_,r| r.tar_url })
+        register_value('clone_url',            proc { |_,r| r.repo_clone_url })
+        register_value('releases_url',         proc { |_,r| r.releases_url })
+        register_value('issues_url',           proc { |_,r| r.issues_url })
+        register_value('wiki_url',             proc { |_,r| r.wiki_url })
+        register_value('language',             proc { |_,r| r.language })
+        register_value('is_user_page',         proc { |_,r| r.user_page? })
+        register_value('is_project_page',      proc { |_,r| r.project_page? })
+        register_value('show_downloads',       proc { |_,r| r.show_downloads? })
+        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) })
+      end
     end
 
-    # Environment-Specific
-    register_value('environment', proc { environment })
-    register_value('hostname', proc { Pages.github_hostname })
-    register_value('pages_hostname', proc { Pages.pages_hostname })
-    register_value('api_url', proc { Pages.api_url })
-
-    register_value('versions', proc {
-      begin
-        require 'github-pages'
-        GitHubPages.versions
-      rescue LoadError; Hash.new end
-    })
-
-    # The Juicy Stuff
-    register_value('public_repositories',  proc { |c,r| c.list_repos(r.owner, "type" => "public") })
-    register_value('organization_members', proc { |c,r| c.organization_public_members(r.owner) if r.organization_repository? })
-    register_value('build_revision',       proc { `git rev-parse HEAD`.strip })
-    register_value('project_title',        proc { |_,r| r.name })
-    register_value('project_tagline',      proc { |_,r| r.tagline })
-    register_value('owner_name',           proc { |_,r| r.owner })
-    register_value('owner_url',            proc { |_,r| r.owner_url })
-    register_value('owner_gravatar_url',   proc { |_,r| r.owner_gravatar_url })
-    register_value('repository_url',       proc { |_,r| r.repository_url })
-    register_value('repository_nwo',       proc { |_,r| r.nwo })
-    register_value('repository_name',      proc { |_,r| r.name})
-    register_value('zip_url',              proc { |_,r| r.zip_url })
-    register_value('tar_url',              proc { |_,r| r.tar_url })
-    register_value('clone_url',            proc { |_,r| r.repo_clone_url })
-    register_value('releases_url',         proc { |_,r| r.releases_url })
-    register_value('issues_url',           proc { |_,r| r.issues_url })
-    register_value('wiki_url',             proc { |_,r| r.wiki_url })
-    register_value('language',             proc { |_,r| r.language })
-    register_value('is_user_page',         proc { |_,r| r.user_page? })
-    register_value('is_project_page',      proc { |_,r| r.project_page? })
-    register_value('show_downloads',       proc { |_,r| r.show_downloads? })
-    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) })
+    init!
   end
 end
 

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

@@ -16,7 +16,7 @@ module Jekyll
         options = options || Hash.new
         if ENV['JEKYLL_GITHUB_TOKEN'] || Octokit.access_token
           options.merge!(:access_token => ENV['JEKYLL_GITHUB_TOKEN'] || Octokit.access_token)
-        elsif File.exist?(File.join(ENV['HOME'], '.netrc')) && safe_require('netrc')
+        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." +

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

@@ -4,7 +4,9 @@ module Jekyll
   module GitHubMetadata
     class GHPMetadataGenerator < Jekyll::Generator
       def generate(site)
-        GitHubMetadata.repository = GitHubMetadata::Repository.new(site.config.fetch('repository'))
+        Jekyll.logger.debug "Generator:", "Calling GHPMetadataGenerator"
+        GitHubMetadata.repository = GitHubMetadata::Repository.new(nwo(site))
+        GitHubMetadata.init!
         site.config['github'] =
           case site.config['github']
           when nil
@@ -15,6 +17,15 @@ module Jekyll
             site.config['github']
           end
       end
+
+      def nwo(site)
+        ENV['PAGES_REPO_NWO'] || \
+          site.config['repository'] || \
+          proc {
+            raise GitHubMetadata::NoRepositoryError, "No repo name found. "
+              "Specify using PAGES_REPO_NWO or 'repository' in your configuration."
+          }.call
+      end
     end
   end
 end

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

@@ -2,23 +2,48 @@ module Jekyll
   module GitHubMetadata
     class Pages
       class << self
+        DEFAULTS = {
+          '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_PAGES_HOSTNAME'  => 'github.io'.freeze,
+          'SSL'                   => 'false'.freeze
+        }.freeze
+
+        def ssl?
+          env_var('SSL').eql? 'true'
+        end
+
+        def scheme
+          ssl? ? "https" : "http"
+        end
+
         def env
-          ENV.fetch('PAGES_ENV', 'dotcom')
+          env_var 'PAGES_ENV'
         end
 
         def api_url
-          trim_last_slash(ENV['PAGES_API_URL'] || Octokit.api_endpoint || 'https://api.github.com')
+          trim_last_slash env_var('PAGES_API_URL', Octokit.api_endpoint)
+        end
+
+        def help_url
+          trim_last_slash env_var('PAGES_HELP_URL')
         end
 
         def github_hostname
-          trim_last_slash(ENV['PAGES_GITHUB_HOSTNAME'] || Octokit.web_endpoint || 'https://github.com')
+          trim_last_slash env_var('PAGES_GITHUB_HOSTNAME', Octokit.web_endpoint)
         end
 
         def pages_hostname
-          trim_last_slash(ENV.fetch('PAGES_PAGES_HOSTNAME', 'github.io'))
+          trim_last_slash env_var('PAGES_PAGES_HOSTNAME')
         end
 
         private
+        def env_var(key, intermediate_default = nil)
+          !ENV[key].to_s.empty? ? ENV[key] : (intermediate_default || DEFAULTS[key])
+        end
+
         def trim_last_slash(url)
           if url[-1] == "/"
             url[0..-2]

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

@@ -101,9 +101,9 @@ module Jekyll
 
       def pages_url
         if cname || primary?
-          "http://#{domain}"
+          "#{Pages.scheme}://#{domain}"
         else
-          File.join("http://#{domain}", name, "")
+          URI.join("#{Pages.scheme}://#{domain}", "#{name}/")
         end
       end
 

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-github-metadata
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Parker Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-08 00:00:00.000000000 Z
+date: 2016-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -129,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: The site.github namespace