jekyll-github-metadata 2.13.0 → 2.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60dcc741766ebde9c73e6f2d2d65a07a23d60e6eb1b7f5b88f2da4505c548a92
-  data.tar.gz: b3b67b1a6be141ce3558f431e44053c7f0c74c7b03079486601390204c03a0ee
+  metadata.gz: f7fec78b3d7152f227abf153c8e5674df5a15567fb9b4280e038003fd61318d1
+  data.tar.gz: b8bea93f19967c470cf07ca91794cb212b00861b84abc0a610891562ed2c1287
 SHA512:
-  metadata.gz: 3e8806b3cd7cf27ae282de1dd54d0055eef93d1dffcaf3644478440b729501125f8da1d655c33a503f5dd9215b09c850c0bc28e9ff4553f63e0e2044f5e41268
-  data.tar.gz: fa82e7d311dd2f720007e2d242211ee17831c34181b20dbf781859cee7241c0bdf469b1d3de18757317010c8649f815d240825b8ec4f5ef564a5a7b0ee80cc51
+  metadata.gz: 3531515a02ef10355ce54fc39d688d71ce6a97c8db80bca3336d65e3f3de10a0c3ecf816cdaccaec3aaa25e7dd62d890502df71ccc52444e0007d64cb724f726
+  data.tar.gz: fc0991efa00a317ceaf1b84876840dc389c1514924acd7a15bcc5624e9eba3dd82899a91bf6342fb6a74a75bcb8dd9ee0479a8522991e4dbfd6b8dcf7527d7e6

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

@@ -68,14 +68,20 @@ module Jekyll
         end
       end
 
-      # NOTE: Faraday's error classes has been promoted to under Faraday module from v1.0.0.
-      # This patch aims to prevent on locking specific version of Faraday.
+      # NOTE: Faraday's error classes have been simplified from v1.0.0.
+      #
+      # In older versions, both `Faraday::Error::ConnectionFailed` and `Faraday::ConnectionFailed`
+      # were valid and equivalent to each other.
+      # From v1.0.0 onwards, `Faraday::Error::ConnectionFailed` no longer exists.
+      #
+      # TODO: Remove in v2.0 of this plugin.
       FARADAY_FAILED_CONNECTION =
         begin
           Faraday::Error::ConnectionFailed
         rescue NameError
           Faraday::ConnectionFailed
         end
+      deprecate_constant :FARADAY_FAILED_CONNECTION
 
       def save_from_errors(default = false)
         unless internet_connected?
@@ -86,7 +92,7 @@ module Jekyll
         yield @client
       rescue Octokit::Unauthorized
         raise BadCredentialsError, "The GitHub API credentials you provided aren't valid."
-      rescue FARADAY_FAILED_CONNECTION, Octokit::TooManyRequests => e
+      rescue Faraday::ConnectionFailed, Octokit::TooManyRequests => e
         GitHubMetadata.log :warn, e.message
         default
       rescue Octokit::NotFound
@@ -130,11 +136,11 @@ module Jekyll
       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")
+        elsif !ENV["NO_NETRC"] && File.exist?(File.join(Dir.home, ".netrc")) && safe_require("netrc")
           { :netrc => true }
         else
-          GitHubMetadata.log :warn, "No GitHub API authentication could be found." \
-            " Some fields may be missing or have incorrect data."
+          GitHubMetadata.log :warn, "No GitHub API authentication could be found. " \
+                                    "Some fields may be missing or have incorrect data."
           {}.freeze
         end
       end

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

@@ -48,6 +48,7 @@ module Jekyll
       def_delegator :repository, :tagline,                     :project_tagline
       def_delegator :repository, :owner_metadata,              :owner
       def_delegator :repository, :owner,                       :owner_name
+      def_delegator :repository, :owner_display_name,          :owner_display_name
       def_delegator :repository, :owner_url,                   :owner_url
       def_delegator :repository, :owner_gravatar_url,          :owner_gravatar_url
       def_delegator :repository, :repository_url,              :repository_url

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

@@ -7,7 +7,7 @@ module Jekyll
         DEFAULTS = {
           "PAGES_ENV"              => "development",
           "PAGES_API_URL"          => "https://api.github.com",
-          "PAGES_HELP_URL"         => "https://help.github.com",
+          "PAGES_HELP_URL"         => "https://docs.github.com",
           "PAGES_GITHUB_HOSTNAME"  => "github.com",
           "PAGES_PAGES_HOSTNAME"   => "github.io",
           "SSL"                    => "false",

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

@@ -64,6 +64,10 @@ module Jekyll
         end
       end
 
+      def owner_display_name
+        owner_metadata.name
+      end
+
       def owner_metadata
         @owner_metadata ||= Jekyll::GitHubMetadata::Owner.new(owner)
       end
@@ -113,7 +117,14 @@ module Jekyll
           :type   => "public",
           :accept => "application/vnd.github.mercy-preview+json",
         }
-        memoize_value :@owner_public_repositories, Value.new("owner_public_repositories", proc { |c| c.list_repos(owner, options) })
+        memoize_value :@owner_public_repositories, Value.new("owner_public_repositories", proc do |c|
+          repos = c.list_repos(owner, options) || []
+          repos.map do |r|
+            r[:releases] = Value.new("owner_public_repositories_releases", proc { c.releases(r[:full_name]) })
+            r[:contributors] = Value.new("owner_public_repositories_contributors", proc { c.contributors(r[:full_name]) })
+            r
+          end
+        end)
       end
 
       def organization_public_members

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

@@ -27,9 +27,9 @@ module Jekyll
             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."
+                                       "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

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

@@ -16,7 +16,7 @@ module Jekyll
       # resource - an Object
       #
       # Returns the sanitized resource.
-      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
       def sanitize(resource)
         case resource
         when Array
@@ -31,6 +31,8 @@ module Jekyll
           nil
         when String
           resource
+        when Value
+          resource.render
         else
           if resource.respond_to?(:to_hash)
             sanitize_resource(resource)
@@ -39,7 +41,7 @@ module Jekyll
           end
         end
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength
 
       # Sanitize the Sawyer Resource or Hash
       # Note: the object must respond to :to_hash for this to work.

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

@@ -6,33 +6,43 @@ module Jekyll
     class SiteGitHubMunger
       extend Forwardable
 
+      class << self
+        attr_accessor :global_munger
+      end
+
       def_delegators Jekyll::GitHubMetadata, :site, :repository
       private :repository
 
       def initialize(site)
         Jekyll::GitHubMetadata.site = site
+        @original_config = site.config["github"]
       end
 
       def munge!
         Jekyll::GitHubMetadata.log :debug, "Initializing..."
 
-        # This is the good stuff.
-        site.config["github"] = github_namespace
-
         add_title_and_description_fallbacks!
         add_url_and_baseurl_fallbacks! if should_add_url_fallbacks?
       end
 
+      def inject_metadata!(payload)
+        payload.site["github"] = github_namespace
+      end
+
+      def uninject_metadata!(payload)
+        payload.site["github"] = @original_config
+      end
+
       private
 
       def github_namespace
-        case site.config["github"]
+        case @original_config
         when nil
           drop
         when Hash
-          Jekyll::Utils.deep_merge_hashes(drop, site.config["github"])
+          drop.merge(@original_config)
         else
-          site.config["github"]
+          @original_config
         end
       end
 
@@ -55,7 +65,13 @@ module Jekyll
           msg << "Jekyll GitHub Metadata will not set site.title to the repository's name."
           Jekyll::GitHubMetadata.log :warn, msg
         else
-          site.config["title"] ||= Value.new("title", proc { |_c, r| r.name })
+          site.config["title"] ||= Value.new("title", proc { |_context, repository|
+            if repository.project_page?
+              repository.name
+            else
+              repository.owner_display_name || repository.owner
+            end
+          })
         end
         site.config["description"] ||= Value.new("description", proc { |_c, r| r.tagline })
       end
@@ -74,9 +90,18 @@ module Jekyll
         site.config["name"] && !site.config["title"]
       end
     end
-  end
-end
 
-Jekyll::Hooks.register :site, :after_init do |site|
-  Jekyll::GitHubMetadata::SiteGitHubMunger.new(site).munge!
+    Jekyll::Hooks.register :site, :after_init do |site|
+      SiteGitHubMunger.global_munger = SiteGitHubMunger.new(site)
+      SiteGitHubMunger.global_munger.munge!
+    end
+
+    Jekyll::Hooks.register :site, :pre_render do |_site, payload|
+      SiteGitHubMunger.global_munger.inject_metadata!(payload)
+    end
+
+    Jekyll::Hooks.register :site, :post_render do |_site, payload|
+      SiteGitHubMunger.global_munger.uninject_metadata!(payload)
+    end
+  end
 end

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

@@ -2,6 +2,6 @@
 
 module Jekyll
   module GitHubMetadata
-    VERSION = "2.13.0"
+    VERSION = "2.16.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-github-metadata
 version: !ruby/object:Gem::Version
-  version: 2.13.0
+  version: 2.16.1
 platform: ruby
 authors:
 - Parker Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-15 00:00:00.000000000 Z
+date: 2023-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -34,22 +34,28 @@ dependencies:
   name: octokit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4'
     - - "!="
       - !ruby/object:Gem::Version
         version: 4.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4'
     - - "!="
       - !ruby/object:Gem::Version
         version: 4.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -112,28 +118,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: rubocop-jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.13.0
 description: 
 email:
 - parkrmoore@gmail.com
@@ -173,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: The site.github namespace