jekyll-github-metadata 2.5.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7599832c0da04777d8df487934a7bf90436c42c
-  data.tar.gz: d3e6945ccad14b6c206b5c47e6959f02337f122d
+  metadata.gz: 2d2c8a4d83077bd33381eed7bd0d71a7a8e5d247
+  data.tar.gz: 8950850bbb6509507e2e0a23bde092dad36bfc5a
 SHA512:
-  metadata.gz: 428ffff9aca6dfb23ae60b90eb55310671488e1c3fc221b788572537d7138e38e430144a1341ee01ec0d6397790696bff650d588d197f1b30b61912817ba3521
-  data.tar.gz: 110d37f9827f58ac70ecca2bbe4a51cf03cda000f804fea62797ce2a093e7db1ee17bb1b0ef64df8bb99fa97cb668fd5b2d464cf246f25671d5f205ec5c6a418
+  metadata.gz: 8a53d6ba55983aea9549fdba81ee41f60da3625f38aca9f79023f790d9653bf9237aa7c3737388c9c4940dcf7373c2aff00208bb1e5669c5de86e36ce66ab87b
+  data.tar.gz: 46051024d33c1024d3893af0b6530473545c96edd8650f80e87c17dcbac31dd8746b6358bc1e57e177374c1109af78e0915c9d62c546bc0e15bd4a7ca96da093

data/lib/jekyll-github-metadata.rb

@@ -18,25 +18,30 @@ module Jekyll
   end
 
   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 :RepositoryFinder, "jekyll-github-metadata/repository_finder"
     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"
 
+    NoRepositoryError = RepositoryFinder::NoRepositoryError
+
     if Jekyll.const_defined? :Site
       require_relative "jekyll-github-metadata/site_github_munger"
     end
 
     class << self
-      attr_accessor :repository
+      attr_reader :repository_finder
       attr_writer :client, :logger
 
+      def site
+        repository_finder.site
+      end
+
       def environment
         Jekyll.respond_to?(:env) ? Jekyll.env : (Pages.env || "development")
       end
@@ -61,9 +66,19 @@ module Jekyll
         @client ||= Client.new
       end
 
+      def repository
+        @repository ||= GitHubMetadata::Repository.new(repository_finder.nwo).tap do |repo|
+          Jekyll::GitHubMetadata.log :debug, "Generating for #{repo.nwo}"
+        end
+      end
+
+      def site=(new_site)
+        reset!
+        @repository_finder = GitHubMetadata::RepositoryFinder.new(new_site)
+      end
+
       def reset!
-        @logger = nil
-        @client = nil
+        @logger = @client = @repository = @nwo = @site = nil
       end
     end
   end

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

@@ -58,7 +58,7 @@ module Jekyll
         method = method_name.to_s
         if accepts_client_method?(method_name)
           key = cache_key(method_name, args)
-          Jekyll::GitHubMetadata.log :debug, "Calling @client.#{method}(#{args.map(&:inspect).join(", ")})"
+          GitHubMetadata.log :debug, "Calling @client.#{method}(#{args.map(&:inspect).join(", ")})"
           cache[key] ||= save_from_errors { @client.public_send(method_name, *args, &block) }
         elsif @client.respond_to?(method_name)
           raise InvalidMethodError, "#{method_name} is not whitelisted on #{inspect}"
@@ -68,24 +68,44 @@ module Jekyll
       end
 
       def save_from_errors(default = false)
+        unless internet_connected?
+          GitHubMetadata.log :warn, "No internet connection. GitHub metadata may be missing or incorrect."
+          return default
+        end
+
         yield @client
       rescue Octokit::Unauthorized
         raise BadCredentialsError, "The GitHub API credentials you provided aren't valid."
       rescue Faraday::Error::ConnectionFailed, Octokit::TooManyRequests => e
-        Jekyll::GitHubMetadata.log :warn, e.message
+        GitHubMetadata.log :warn, e.message
         default
       rescue Octokit::NotFound
         default
       end
 
       def inspect
-        "#<#{self.class.name} @client=#{client_inspect}>"
+        "#<#{self.class.name} @client=#{client_inspect} @internet_connected=#{internet_connected?}>"
       end
 
       def authenticated?
         !@client.access_token.to_s.empty?
       end
 
+      def internet_connected?
+        return @internet_connected if defined?(@internet_connected)
+
+        require "resolv"
+        begin
+          Resolv::DNS.open do |dns|
+            dns.timeouts = 2
+            dns.getaddress("api.github.com")
+          end
+          @internet_connected = true
+        rescue Resolv::ResolvError
+          @internet_connected = false
+        end
+      end
+
       private
 
       def client_inspect
@@ -102,7 +122,7 @@ module Jekyll
         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." \
+          GitHubMetadata.log :warn, "No GitHub API authentication could be found." \
             " Some fields may be missing or have incorrect data."
           {}.freeze
         end

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

@@ -8,11 +8,6 @@ module Jekyll
 
       mutable true
 
-      def initialize(site)
-        @site = site
-        super(nil)
-      end
-
       def to_s
         require "json"
         JSON.pretty_generate to_h
@@ -34,20 +29,7 @@ module Jekyll
       def_delegator :"Jekyll::GitHubMetadata::Pages", :api_url, :api_url
       def_delegator :"Jekyll::GitHubMetadata::Pages", :help_url, :help_url
 
-      def versions
-        @versions ||= begin
-          require "github-pages"
-          GitHubPages.versions
-        rescue LoadError
-          {}
-        end
-      end
-
-      def build_revision
-        @build_revision ||= begin
-          ENV["JEKYLL_BUILD_REVISION"] || `git rev-parse HEAD`.strip
-        end
-      end
+      private def_delegator :"Jekyll::GitHubMetadata", :repository
 
       def_delegator :repository, :owner_public_repositories,   :public_repositories
       def_delegator :repository, :organization_public_members, :organization_members
@@ -74,67 +56,24 @@ module Jekyll
       def_delegator :repository, :contributors,                :contributors
       def_delegator :repository, :releases,                    :releases
       def_delegator :repository, :latest_release,              :latest_release
+      def_delegator :repository, :private?,                    :private
 
-      private
-      attr_reader :site
-
-      def repository
-        @repository ||= GitHubMetadata::Repository.new(nwo(site)).tap do |repo|
-          Jekyll::GitHubMetadata.log :debug, "Generating for #{repo.nwo}"
+      def versions
+        @versions ||= begin
+          require "github-pages"
+          GitHubPages.versions
+        rescue LoadError
+          {}
         end
       end
 
-      def git_exe_path
-        ENV["PATH"].to_s.split(File::PATH_SEPARATOR).map { |path| File.join(path, "git") }.find { |path| File.exist?(path) }
-      end
-
-      def git_remotes
-        return [] if git_exe_path.nil?
-        `#{git_exe_path} remote --verbose`.to_s.strip.split("\n")
-      end
-
-      def git_remote_url
-        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" || Jekyll.env == "test"
-        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"]
-      end
-
-      def nwo_from_config(site)
-        repo = site.config["repository"]
-        repo if repo && repo.is_a?(String) && repo.include?("/")
+      def build_revision
+        @build_revision ||= begin
+          ENV["JEKYLL_BUILD_REVISION"] || `git rev-parse HEAD`.strip
+        end
       end
 
-      # Public: fetches the repository name with owner to fetch metadata for.
-      # In order of precedence, this method uses:
-      # 1. the environment variable $PAGES_REPO_NWO
-      # 2. 'repository' variable in the site config
-      # 3. the 'origin' git remote's URL
-      #
-      # site - the Jekyll::Site being processed
-      #
-      # Return the name with owner (e.g. 'parkr/my-repo') or raises an
-      # error if one cannot be found.
-      def nwo(site)
-        nwo_from_env || \
-          nwo_from_config(site) || \
-          nwo_from_git_origin_remote || \
-          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."
-          end.call
-      end
+      private
 
       # Nothing to see here.
       def fallback_data

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

@@ -80,6 +80,10 @@ module Jekyll
         !!repo_info["has_downloads"]
       end
 
+      def private?
+        !!repo_info["private"]
+      end
+
       def organization_repository?
         memoize_value :@is_organization_repository, Value.new(proc { |c| !!c.organization(owner) })
       end

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

@@ -0,0 +1,71 @@
+module Jekyll
+  module GitHubMetadata
+    class RepositoryFinder
+      NoRepositoryError = Class.new(Jekyll::Errors::FatalException)
+
+      attr_reader :site
+      def initialize(site)
+        @site = site
+      end
+
+      # Public: fetches the repository name with owner to fetch metadata for.
+      # In order of precedence, this method uses:
+      # 1. the environment variable $PAGES_REPO_NWO
+      # 2. 'repository' variable in the site config
+      # 3. the 'origin' git remote's URL
+      #
+      # site - the Jekyll::Site being processed
+      #
+      # Return the name with owner (e.g. 'parkr/my-repo') or raises an
+      # error if one cannot be found.
+      def nwo
+        @nwo ||= begin
+          nwo_from_env || \
+            nwo_from_config || \
+            nwo_from_git_origin_remote || \
+            proc do
+              raise 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."
+            end.call
+        end
+      end
+
+      private
+
+      def nwo_from_env
+        ENV["PAGES_REPO_NWO"]
+      end
+
+      def nwo_from_config
+        repo = site.config["repository"]
+        repo if repo && repo.is_a?(String) && repo.include?("/")
+      end
+
+      def git_exe_path
+        ENV["PATH"].to_s
+          .split(File::PATH_SEPARATOR)
+          .map { |path| File.join(path, "git") }
+          .find { |path| File.exist?(path) }
+      end
+
+      def git_remotes
+        return [] if git_exe_path.nil?
+        `#{git_exe_path} remote --verbose`.to_s.strip.split("\n")
+      end
+
+      def git_remote_url
+        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" || Jekyll.env == "test"
+        matches = git_remote_url.chomp(".git").match %r!github.com(:|/)([\w-]+)/([\w\.-]+)!
+        matches[2..3].join("/") if matches
+      end
+    end
+  end
+end

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

@@ -4,10 +4,13 @@ require "uri"
 module Jekyll
   module GitHubMetadata
     class SiteGitHubMunger
-      attr_reader :site
+      extend Forwardable
+
+      def_delegators :"Jekyll::GitHubMetadata", :site
+      private def_delegator :"Jekyll::GitHubMetadata", :repository
 
       def initialize(site)
-        @site = site
+        Jekyll::GitHubMetadata.site = site
       end
 
       def munge!
@@ -16,9 +19,8 @@ module Jekyll
         # This is the good stuff.
         site.config["github"] = github_namespace
 
-        return unless should_add_fallbacks?
-        add_url_and_baseurl_fallbacks!
         add_title_and_description_fallbacks!
+        add_url_and_baseurl_fallbacks! if should_add_url_fallbacks?
       end
 
       private
@@ -35,13 +37,14 @@ module Jekyll
       end
 
       def drop
-        @drop ||= MetadataDrop.new(site)
+        @drop ||= MetadataDrop.new(GitHubMetadata.site)
       end
 
       # Set `site.url` and `site.baseurl` if unset.
       def add_url_and_baseurl_fallbacks!
-        site.config["url"] ||= repository.url_without_path
-        site.config["baseurl"] = repository.baseurl if should_set_baseurl?
+        site.config["url"] ||= Value.new("url", proc { |_c, r| r.url_without_path })
+        return unless should_set_baseurl?
+        site.config["baseurl"] = Value.new("baseurl", proc { |_c, r| r.baseurl })
       end
 
       # Set the baseurl only if it is `nil` or `/`
@@ -51,17 +54,13 @@ module Jekyll
       end
 
       def add_title_and_description_fallbacks!
-        site.config["title"] ||= repository.name
-        site.config["description"] ||= repository.tagline
+        site.config["title"] ||= Value.new("title", proc { |_c, r| r.name })
+        site.config["description"] ||= Value.new("description", proc { |_c, r| r.tagline })
       end
 
-      def should_add_fallbacks?
+      def should_add_url_fallbacks?
         Jekyll.env == "production" || Pages.page_build?
       end
-
-      def repository
-        drop.send(:repository)
-      end
     end
   end
 end

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

@@ -3,6 +3,9 @@ require "json"
 module Jekyll
   module GitHubMetadata
     class Value
+      extend Forwardable
+      def_delegators :render, :+, :to_s, :to_json, :eql?, :hash
+
       attr_reader :key, :value
 
       def initialize(*args)
@@ -19,48 +22,39 @@ module Jekyll
       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, "Whoa, arity of 0, 1, or 2 please in your procs."
-                   end
-                 else
-                   @value
-                 end
-        @value = Sanitizer.sanitize(@value)
+        return @rendered if defined? @rendered
+        @rendered = @value = Sanitizer.sanitize(call_or_value)
       rescue RuntimeError, NameError => e
         Jekyll::GitHubMetadata.log :error, "Error processing value '#{key}':"
         raise e
       end
 
-      def to_s
-        render.to_s
-      end
-
-      def to_json(*)
-        render.to_json
-      end
-
       def to_liquid
         case render
-        when nil
-          nil
-        when true, false
-          value
-        when Hash
-          value
-        when String, Numeric, Array
+        when nil, true, false, Hash, String, Numeric, Array
           value
         else
           to_json
         end
       end
+
+      private
+
+      # Calls the value Proc with the appropriate number of arguments
+      # or returns the raw value if it's a literal
+      def call_or_value
+        return value unless 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, "Whoa, arity of 0, 1, or 2 please in your procs."
+        end
+      end
     end
   end
 end

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

@@ -1,5 +1,5 @@
 module Jekyll
   module GitHubMetadata
-    VERSION = "2.5.1".freeze
+    VERSION = "2.6.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-github-metadata
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.6.0
 platform: ruby
 authors:
 - Parker Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-17 00:00:00.000000000 Z
+date: 2017-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -127,6 +127,7 @@ files:
 - lib/jekyll-github-metadata/pages.rb
 - lib/jekyll-github-metadata/repository.rb
 - lib/jekyll-github-metadata/repository_compat.rb
+- lib/jekyll-github-metadata/repository_finder.rb
 - lib/jekyll-github-metadata/sanitizer.rb
 - lib/jekyll-github-metadata/site_github_munger.rb
 - lib/jekyll-github-metadata/value.rb