jekyll-github-metadata 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64dda7e04bd0e73a1b8c6d4304466c0323b64a47
-  data.tar.gz: 4148a68d05722efb654b62a8dde15a63cd5b41e7
+  metadata.gz: 0e2f07193bb80feccf89ea426bcd93d8188e3c0b
+  data.tar.gz: 9fa02218e3108a017a03337b8923b1357f8f3a50
 SHA512:
-  metadata.gz: 188b1dce70529a15f42ee4e9af3719b0f4753b50d126a886af2dd5146a4f404238b5c57a1efe45080974aab1a20dc1ee2ef97b68546907ec7cc7c55192857d5c
-  data.tar.gz: 2d5c8bf15b7259b0cec5a4c629af0e964afa95c533af126eb790df299010dac63cf6596215542305e807e2e5bb1192425d2d5fcc17272da4fcc6c9704d15bd11
+  metadata.gz: 58e40f5163d6f3e359f02c1aff7b5e87ee7ec87dfc8e94d59f004700bffe1092dcf4462e39ad6011ca56db4d6a9c0090b86c8e3351641e3295af465b061c2b86
+  data.tar.gz: cb6d03ce523c88e3ae3fac2bac8aa66b4b97e69e67ed89dca4715dc8c4c8431da3f42573ad4d86e79dd2fc8d1628447cf76c7c205c6bead14a27050dac99f22e

data/lib/jekyll-github-metadata.rb

@@ -1,11 +1,12 @@
-require 'octokit'
-require 'logger'
+require "octokit"
+require "logger"
 
-if defined?(Jekyll) && Jekyll.respond_to?(:env) && Jekyll.env == 'development'
+if defined?(Jekyll) && Jekyll.respond_to?(:env) && Jekyll.env == "development"
   begin
-    require 'dotenv'
+    require "dotenv"
     Dotenv.load
   rescue LoadError
+    Jekyll.logger.debug "Dotenv not found. Skipping"
   end
 end
 
@@ -19,17 +20,17 @@ module Jekyll
   module GitHubMetadata
     NoRepositoryError = Class.new(Jekyll::Errors::FatalException)
 
-    autoload :Client,           'jekyll-github-metadata/client'
-    autoload :MetadataDrop,     'jekyll-github-metadata/metadata_drop'
-    autoload :Pages,            'jekyll-github-metadata/pages'
-    autoload :Repository,       'jekyll-github-metadata/repository'
-    autoload :RepositoryCompat, 'jekyll-github-metadata/repository_compat'
-    autoload :Sanitizer,        'jekyll-github-metadata/sanitizer'
-    autoload :Value,            'jekyll-github-metadata/value'
-    autoload :VERSION,          'jekyll-github-metadata/version'
+    autoload :Client,           "jekyll-github-metadata/client"
+    autoload :MetadataDrop,     "jekyll-github-metadata/metadata_drop"
+    autoload :Pages,            "jekyll-github-metadata/pages"
+    autoload :Repository,       "jekyll-github-metadata/repository"
+    autoload :RepositoryCompat, "jekyll-github-metadata/repository_compat"
+    autoload :Sanitizer,        "jekyll-github-metadata/sanitizer"
+    autoload :Value,            "jekyll-github-metadata/value"
+    autoload :VERSION,          "jekyll-github-metadata/version"
 
     if Jekyll.const_defined? :Site
-      require_relative 'jekyll-github-metadata/ghp_metadata_generator'
+      require_relative "jekyll-github-metadata/ghp_metadata_generator"
     end
 
     class << self
@@ -37,15 +38,15 @@ module Jekyll
       attr_writer :client, :logger
 
       def environment
-        Jekyll.respond_to?(:env) ? Jekyll.env : (Pages.env || 'development')
+        Jekyll.respond_to?(:env) ? Jekyll.env : (Pages.env || "development")
       end
 
       def logger
         @logger ||= if Jekyll.respond_to?(:logger)
-          Jekyll.logger
-        else
-          Logger.new($stdout)
-        end
+                      Jekyll.logger
+                    else
+                      Logger.new($stdout)
+                    end
       end
 
       def log(severity, message)

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

@@ -1,4 +1,4 @@
-require 'digest'
+require "digest"
 
 module Jekyll
   module GitHubMetadata
@@ -6,7 +6,7 @@ module Jekyll
       InvalidMethodError = Class.new(NoMethodError)
 
       # Whitelisted API calls.
-      API_CALLS = Set.new(%w{
+      API_CALLS = Set.new(%w(
         repository
         organization
         repository?
@@ -15,7 +15,7 @@ module Jekyll
         releases
         list_repos
         organization_public_members
-      })
+      ))
 
       def initialize(options = nil)
         @client = build_octokit_client(options)
@@ -29,18 +29,18 @@ module Jekyll
       end
 
       def build_octokit_client(options = nil)
-        options = options || Hash.new
+        options ||= {}
         unless options.key? :access_token
           options.merge! pluck_auth_method
         end
-        Octokit::Client.new({:auto_paginate => true}.merge(options))
+        Octokit::Client.new({ :auto_paginate => true }.merge(options))
       end
 
       def accepts_client_method?(method_name)
         API_CALLS.include?(method_name.to_s) && @client.respond_to?(method_name)
       end
 
-      def respond_to?(method_name, include_private = false)
+      def respond_to_missing?(method_name, include_private = false)
         accepts_client_method?(method_name) || super
       end
 
@@ -57,16 +57,13 @@ module Jekyll
         end
       end
 
-      def save_from_errors(default = false, &block)
-        if block.arity == 1
-          block.call(@client)
-        else
-          block.call
-        end
-      rescue Faraday::Error::ConnectionFailed,
-        Octokit::NotFound,
-        Octokit::Unauthorized,
-        Octokit::TooManyRequests
+      def save_from_errors(default = false)
+        yield @client
+      rescue Faraday::Error::ConnectionFailed, Octokit::TooManyRequests => e
+        Jekyll::GitHubMetadata.log :warn, e.message
+        default
+      rescue Octokit::NotFound, Octokit::Unauthorized => e
+        Jekyll::GitHubMetadata.log :error, e.message
         default
       end
 
@@ -85,9 +82,9 @@ module Jekyll
       end
 
       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')
+        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::GitHubMetadata.log :warn, "No GitHub API authentication could be found." \

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

@@ -1,23 +1,41 @@
-require 'jekyll'
+require "jekyll"
 
 module Jekyll
   module GitHubMetadata
     class GHPMetadataGenerator < Jekyll::Generator
       safe true
 
+      attr_reader :site
+
       def generate(site)
         Jekyll::GitHubMetadata.log :debug, "Initializing..."
+        @site = site
+        site.config["github"] = github_namespace
+
+        # Set `site.url` and `site.baseurl` if unset and in production mode.
+        if Jekyll.env == "production"
+          site.config["url"] ||= drop.url
+          site.config["baseurl"] = drop.baseurl if site.config["baseurl"].to_s.empty?
+        end
+
+        @site = nil
+      end
+
+      private
+
+      def github_namespace
+        case site.config["github"]
+        when nil
+          drop
+        when Hash, Liquid::Drop
+          Jekyll::Utils.deep_merge_hashes(drop, site.config["github"])
+        else
+          site.config["github"]
+        end
+      end
 
-        drop = MetadataDrop.new(site)
-        site.config['github'] =
-          case site.config['github']
-          when nil
-            MetadataDrop.new(site)
-          when Hash, Liquid::Drop
-            Jekyll::Utils.deep_merge_hashes(MetadataDrop.new(site), site.config['github'])
-          else
-            site.config['github']
-          end
+      def drop
+        @drop ||= MetadataDrop.new(site)
       end
     end
   end

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

@@ -1,5 +1,5 @@
-require 'jekyll'
-require 'forwardable'
+require "jekyll"
+require "forwardable"
 
 module Jekyll
   module GitHubMetadata
@@ -26,7 +26,7 @@ module Jekyll
 
       def versions
         @versions ||= begin
-          require 'github-pages'
+          require "github-pages"
           GitHubPages.versions
         rescue LoadError
           {}
@@ -35,7 +35,7 @@ module Jekyll
 
       def build_revision
         @build_revision ||= (
-          ENV['JEKYLL_BUILD_REVISION'] || `git rev-parse HEAD`.strip
+          ENV["JEKYLL_BUILD_REVISION"] || `git rev-parse HEAD`.strip
         )
       end
 
@@ -60,6 +60,7 @@ module Jekyll
       def_delegator :repository, :project_page?,               :is_project_page
       def_delegator :repository, :show_downloads?,             :show_downloads
       def_delegator :repository, :html_url,                    :url
+      def_delegator :repository, :baseurl,                     :baseurl
       def_delegator :repository, :contributors,                :contributors
       def_delegator :repository, :releases,                    :releases
 
@@ -82,24 +83,24 @@ module Jekyll
       end
 
       def git_remote_url
-        git_remotes.grep(%r{\Aorigin\t}).map do |remote|
-          remote.sub(/\Aorigin\t(.*) \([a-z]+\)/, "\\1")
+        git_remotes.grep(%r!\Aorigin\t!).map do |remote|
+          remote.sub(%r!\Aorigin\t(.*) \([a-z]+\)!, "\\1")
         end.uniq.first || ""
       end
 
       def nwo_from_git_origin_remote
         return unless Jekyll.env == "development"
-        matches = git_remote_url.chomp(".git").match %r{github.com(:|/)([\w-]+)/([\w\.-]+)}
+        matches = git_remote_url.chomp(".git").match %r!github.com(:|/)([\w-]+)/([\w\.-]+)!
         matches[2..3].join("/") if matches
       end
 
       def nwo_from_env
-        ENV['PAGES_REPO_NWO']
+        ENV["PAGES_REPO_NWO"]
       end
 
       def nwo_from_config(site)
-        repo = site.config['repository']
-        repo if repo && repo.is_a?(String) && repo.include?('/')
+        repo = site.config["repository"]
+        repo if repo && repo.is_a?(String) && repo.include?("/")
       end
 
       # Public: fetches the repository name with owner to fetch metadata for.
@@ -116,12 +117,12 @@ module Jekyll
         nwo_from_env || \
           nwo_from_config(site) || \
           nwo_from_git_origin_remote || \
-          proc {
+          proc do
             raise GitHubMetadata::NoRepositoryError, "No repo name found. " \
               "Specify using PAGES_REPO_NWO environment variables, " \
               "'repository' in your configuration, or set up an 'origin' " \
               "git remote pointing to your github.com repository."
-          }.call
+          end.call
       end
 
       # Nothing to see here.

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

@@ -3,14 +3,14 @@ module Jekyll
     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'  => 'github.com'.freeze,
-          'PAGES_PAGES_HOSTNAME'   => 'github.io'.freeze,
-          'SSL'                    => 'false'.freeze,
-          'SUBDOMAIN_ISOLATION'    => 'false'.freeze,
-          'PAGES_PREVIEW_HTML_URL' => nil
+          "PAGES_ENV"              => "development".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
 
         # Whether the GitHub instance supports HTTPS
@@ -18,7 +18,7 @@ module Jekyll
         # but may be different from how sites are served on GitHub.com.
         # See Repository#url_scheme
         def ssl?
-          env_var('SSL') == 'true' || test?
+          env_var("SSL") == "true" || test?
         end
 
         def scheme
@@ -26,19 +26,23 @@ module Jekyll
         end
 
         def subdomain_isolation?
-          env_var('SUBDOMAIN_ISOLATION').eql? 'true'
+          env_var("SUBDOMAIN_ISOLATION").eql? "true"
         end
 
-        def test?;       env == 'test' end
-        def dotcom?;     env == 'dotcom' end
-        def enterprise?; env == 'enterprise' end
+        def test?;        env == "test" end
+
+        def dotcom?;      env == "dotcom" end
+
+        def enterprise?;  env == "enterprise" end
+
+        def development?; env == "development" end
 
         def custom_domains_enabled?
           dotcom? || test?
         end
 
         def env
-          env_var 'PAGES_ENV'
+          env_var "PAGES_ENV", ENV["JEKYLL_ENV"]
         end
 
         def repo_pages_html_url_preview?
@@ -54,19 +58,21 @@ module Jekyll
         end
 
         def api_url
-          trim_last_slash env_var('PAGES_API_URL', ENV['API_URL'])
+          trim_last_slash env_var("PAGES_API_URL", ENV["API_URL"])
         end
 
         def help_url
-          trim_last_slash env_var('PAGES_HELP_URL', ENV['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', ENV['GITHUB_HOSTNAME'])
+          trim_last_slash env_var("PAGES_GITHUB_HOSTNAME", ENV["GITHUB_HOSTNAME"])
         end
 
         def pages_hostname
-          trim_last_slash env_var('PAGES_PAGES_HOSTNAME', ENV['PAGES_HOSTNAME'])
+          intermediate_default = ENV["PAGES_HOSTNAME"]
+          intermediate_default ||= "localhost:4000" if development?
+          trim_last_slash env_var("PAGES_PAGES_HOSTNAME", intermediate_default)
         end
 
         private

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

@@ -13,11 +13,11 @@ module Jekyll
       end
 
       def repo_info
-        @repo_info ||= (Value.new(proc { |c| c.repository(nwo) }).render || Hash.new)
+        @repo_info ||= (Value.new(proc { |c| c.repository(nwo) }).render || {})
       end
 
       def repo_pages_info
-        @repo_pages_info ||= (Value.new(proc { |c| c.pages(nwo, repo_pages_info_opts) }).render || Hash.new)
+        @repo_pages_info ||= (Value.new(proc { |c| c.pages(nwo, repo_pages_info_opts) }).render || {})
       end
 
       def repo_pages_info_opts
@@ -85,9 +85,9 @@ module Jekyll
       end
 
       def organization_public_members
-        memoize_value :@organization_public_members, Value.new(proc { |c|
+        memoize_value :@organization_public_members, Value.new(proc do |c|
           c.organization_public_members(owner) if organization_repository?
-        })
+        end)
       end
 
       def contributors
@@ -99,7 +99,7 @@ module Jekyll
       end
 
       def git_ref
-        user_page? ? 'master' : 'gh-pages'
+        user_page? ? "master" : "gh-pages"
       end
 
       def user_page?
@@ -111,7 +111,7 @@ module Jekyll
       end
 
       def github_repo?
-        !Pages.enterprise? && owner.eql?('github')
+        !Pages.enterprise? && owner.eql?("github")
       end
 
       def primary?
@@ -159,6 +159,10 @@ module Jekyll
         uri.scheme
       end
 
+      def baseurl
+        uri.path
+      end
+
       private
 
       def memoize_value(var_name, value)

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

@@ -14,10 +14,10 @@ module Jekyll
       def url_scheme
         if Pages.enterprise?
           Pages.scheme
-        elsif repo.owner == 'github' && domain.end_with?('.github.com')
-          'https'
+        elsif repo.owner == "github" && domain.end_with?(".github.com")
+          "https"
         else
-          'http'
+          "http"
         end
       end
 
@@ -32,14 +32,9 @@ module Jekyll
       end
 
       def pages_url
-        if !Pages.custom_domains_enabled?
-          path = repo.user_page? ? repo.owner : repo.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 repo.cname || repo.primary?
+        return enterprise_url unless Pages.custom_domains_enabled?
+
+        if repo.cname || repo.primary?
           "#{url_scheme}://#{domain}"
         else
           URI.join("#{url_scheme}://#{domain}", repo.name).to_s
@@ -59,6 +54,17 @@ module Jekyll
             user_domain
           end
       end
+
+      private
+
+      def enterprise_url
+        path = repo.user_page? ? repo.owner : repo.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
+      end
     end
   end
 end

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

@@ -43,7 +43,7 @@ module Jekyll
       #
       # Returns the sanitized sawyer resource or hash as a hash.
       def sanitize_resource(resource)
-        resource.to_hash.inject({}) do |result, (k, v)|
+        resource.to_hash.each_with_object({}) do |(k, v), result|
           result[k.to_s] = sanitize(v)
           result
         end

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

@@ -1,4 +1,4 @@
-require 'json'
+require "json"
 
 module Jekyll
   module GitHubMetadata
@@ -8,31 +8,31 @@ module Jekyll
       def initialize(*args)
         case args.size
         when 1
-          @key = '{anonymous}'
+          @key = "{anonymous}"
           @value = args.first
         when 2
           @key = args.first.to_s
           @value = args.last
         else
-          raise ArgumentError.new("#{args.size} args given but expected 1 or 2")
+          raise ArgumentError, "#{args.size} args given but expected 1 or 2"
         end
       end
 
       def render
         @value = if @value.respond_to?(:call)
-          case @value.arity
-          when 0
-            @value.call
-          when 1
-            @value.call(GitHubMetadata.client)
-          when 2
-            @value.call(GitHubMetadata.client, GitHubMetadata.repository)
-          else
-            raise ArgumentError.new("Whoa, arity of 0, 1, or 2 please in your procs.")
-          end
-        else
-          @value
-        end
+                   case @value.arity
+                   when 0
+                     @value.call
+                   when 1
+                     @value.call(GitHubMetadata.client)
+                   when 2
+                     @value.call(GitHubMetadata.client, GitHubMetadata.repository)
+                   else
+                     raise ArgumentError, "Whoa, arity of 0, 1, or 2 please in your procs."
+                   end
+                 else
+                   @value
+                 end
         @value = Sanitizer.sanitize(@value)
       rescue RuntimeError, NameError => e
         Jekyll::GitHubMetadata.log :error, "Error processing value '#{key}':"

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

@@ -1,5 +1,5 @@
 module Jekyll
   module GitHubMetadata
-    VERSION = '2.0.2'
+    VERSION = "2.1.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-github-metadata
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Parker Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-22 00:00:00.000000000 Z
+date: 2016-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
 description: 
 email:
 - parkrmoore@gmail.com
@@ -131,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: The site.github namespace