jekyll-remote-theme 0.6.1 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e01afd90316ec162cddd29765466d934ae241d626f473bcd9acfd9976a1fd01
-  data.tar.gz: '00945458c1ed12cb8bdc2a21aa41d11d22e3cc8060a67eb65b494e9bc1ac0775'
+  metadata.gz: e03229a94b9e765b76cb5dee2b5838ab13a58098e33fa73d5e5733570102e828
+  data.tar.gz: 77020e301b78ebe789c608a29e7217f722c53b25275afec32c876a8c9bf2d370
 SHA512:
-  metadata.gz: 12c833b553ab123f001a1ec6610a01551265b675349045cd322e73816e2f421e3033174cad40a542b18087272f30edb945c838fe24b4e1d21b095d0453d2c9e4
-  data.tar.gz: 267ffe076935719f7e91cfc4ce4673ff29d437a908068b89b296e456d17d9a61128af54ddda2008e1d1fff5e58e430542d623b7925ae39e6b722afdbee1a2d4c
+  metadata.gz: c3a79a33a692b97472f6cdd2a42af44f623bf769772beee69f0488611d0e47a5e55697a7baf9e17be88841a1d712288bdf73e91e3e98f42dc57830037f224be7
+  data.tar.gz: f368911a263cc85af35d168a64e20796c0c81b906b68e7dca041a7bb81f1c58ee9daaa2bd4bcff236f3ff2afd3dff85ffc8535e7184f49625c667e7df6ac78af

data/lib/jekyll-remote-theme/munger.rb

@@ -15,7 +15,7 @@ module Jekyll
         return unless raw_theme
 
         unless theme.valid?
-          Jekyll.logger.error LOG_KEY, "#{raw_theme.inspect} is not a valid remote theme"
+          Jekyll.logger.error LOG_KEY, invalid_theme_message
           return
         end
 
@@ -33,6 +33,14 @@ module Jekyll
 
       private
 
+      def invalid_theme_message
+        message = "#{raw_theme.inspect} is not a valid remote theme"
+        return message unless theme.disallowed_host?
+
+        "#{message}; host #{theme.host.inspect} is not allowed. " \
+          "Set PAGES_GITHUB_HOSTNAME or GITHUB_HOSTNAME to #{theme.host.inspect}"
+      end
+
       def munged?
         site.theme&.is_a?(Jekyll::RemoteTheme::Theme)
       end

data/lib/jekyll-remote-theme/theme.rb

@@ -5,8 +5,14 @@ module Jekyll
     class Theme < Jekyll::Theme
       OWNER_REGEX = %r!(?<owner>[a-z0-9\-]+)!i.freeze
       NAME_REGEX  = %r!(?<name>[a-z0-9\._\-]+)!i.freeze
-      REF_REGEX   = %r!@(?<ref>[a-z0-9\._\-]+)!i.freeze # May be a branch, tag, commit, or "latest"
+      # A ref segment can't be "." or "..": the ref goes into a normalized download
+      # URL, where those segments would point at a different path.
+      REF_SEGMENT_REGEX = %r!(?\!\.\.?(?:/|\z))[a-z0-9\._\-]+!i.freeze
+      # May be a branch, tag, commit, or "latest". Branches may contain "/", as in
+      # "feature/new-layout", but not at the start or end, or twice in a row.
+      REF_REGEX   = %r!@(?<ref>#{REF_SEGMENT_REGEX}(?:/#{REF_SEGMENT_REGEX})*)!i.freeze
       THEME_REGEX = %r!\A#{OWNER_REGEX}/#{NAME_REGEX}(?:#{REF_REGEX})?\z!i.freeze
+      REF_SUFFIX_REGEX = %r!\A#{REF_REGEX}\z!.freeze
 
       # Initializes a new Jekyll::RemoteTheme::Theme
       #
@@ -27,7 +33,7 @@ module Jekyll
         @site = site
         original_theme = raw_theme.to_s.strip
         local_path = looks_like_local_path?(original_theme)
-        @raw_theme = local_path ? original_theme : original_theme.downcase
+        @raw_theme = local_path ? original_theme : normalize_remote_theme(original_theme)
         super(@raw_theme)
       end
 
@@ -67,11 +73,17 @@ module Jekyll
 
         parsed_ref = theme_parts[:ref]
         return "HEAD" unless parsed_ref
-        return resolve_latest_release if parsed_ref == "latest"
+        return resolve_latest_release if parsed_ref.casecmp?("latest")
 
         parsed_ref
       end
 
+      def disallowed_host?
+        return false unless uri && theme_parts && name && owner
+
+        host && !valid_hosts.include?(host)
+      end
+
       def root
         return (expanded_local_path if local_path_valid?) if local_theme?
 
@@ -98,6 +110,16 @@ module Jekyll
         super
       end
 
+      # Owners and repo names are case-insensitive on GitHub, so normalize them,
+      # but leave the git ref alone: branch and tag names are case-sensitive, and
+      # downcasing them points codeload at a ref that doesn't exist.
+      def normalize_remote_theme(theme)
+        theme_without_ref, separator, ref = theme.rpartition("@")
+        return theme.downcase if separator.empty? || !"@#{ref}".match?(REF_SUFFIX_REGEX)
+
+        "#{theme_without_ref.downcase}@#{ref}"
+      end
+
       def looks_like_local_path?(path)
         # Check if it looks like a local path
         # Supports: /, ./, ../, ~/ (Unix-style) and drive letters (Windows-style)
@@ -172,7 +194,7 @@ module Jekyll
         if response.is_a?(Net::HTTPSuccess)
           parse_tag_from_response(response)
         else
-          log_no_releases_warning
+          log_failed_response_warning(response)
           nil
         end
       rescue StandardError => e
@@ -221,6 +243,19 @@ module Jekyll
                            "No releases found for #{name_with_owner}, using HEAD"
       end
 
+      def log_failed_response_warning(response)
+        if response.code == "404"
+          log_no_releases_warning
+        else
+          message = "Unexpected HTTP #{response.code} response " \
+                    "for #{name_with_owner}, using HEAD"
+          if %w(403 429).include?(response.code)
+            message += "; this is likely caused by GitHub API rate limiting"
+          end
+          Jekyll.logger.warn LOG_KEY, message
+        end
+      end
+
       def log_api_error(error)
         Jekyll.logger.warn LOG_KEY,
                            "Failed to fetch latest release for #{name_with_owner}: " \

data/lib/jekyll-remote-theme/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module RemoteTheme
-    VERSION = "0.6.1"
+    VERSION = "0.6.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-remote-theme
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.3
 platform: ruby
 authors:
 - Ben Balter
@@ -159,6 +159,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -271,6 +285,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+description: Jekyll plugin to build a site with any public GitHub-hosted theme, set
+  via the remote_theme config key. Supported on GitHub Pages.
 email:
 - ben.balter@github.com
 executables: []
@@ -287,7 +303,11 @@ files:
 homepage: https://github.com/benbalter/jekyll-remote-theme
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/benbalter/jekyll-remote-theme
+  source_code_uri: https://github.com/benbalter/jekyll-remote-theme
+  bug_tracker_uri: https://github.com/benbalter/jekyll-remote-theme/issues
+  changelog_uri: https://github.com/benbalter/jekyll-remote-theme/releases
 rdoc_options: []
 require_paths:
 - lib
@@ -302,7 +322,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Jekyll plugin for building Jekyll sites with any GitHub-hosted theme
 test_files: []