jekyll-remote-theme 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c9167cea38476d7fc4ef44836e821cb07d5bcabb665e834a8df9f1cae315b70
-  data.tar.gz: 28698c0255ba7c3b9b85758e7ed52c899ffbdd49460064513d8a28a19d174b49
+  metadata.gz: 4abb7a44afc1640f9d22b6ee47386bf6181a167f579924b7092d1f151e2f2b6f
+  data.tar.gz: 89efc46a4dcaf23298a058e5366b512ae3934a0cc0a0b1fb34b7d7dd1bdc29db
 SHA512:
-  metadata.gz: 5c9f12811ead638abbb9022f63221ef49fd6bd2f743e42d58645431aa0565946b74324131710d76ed9567adc812b316425f47e41c55ba379a4073f7812ec5b0a
-  data.tar.gz: 4ae168e2f471af7bfa0cdc39a479f3bb05fe4420d30a3036206f29b50f49f267004fa8ac4deaa4da26f887eae3f3b5e38b521cb189ed479d5262aa289d33dc11
+  metadata.gz: 986f1ac1e5c28c63e7c62cee0a1c42b2c896f1459b85edbca13fa49e80c18935753133645e98cfa3e520e37f02f10adb2175112aa502c4d0b18c1594d4f1b0a9
+  data.tar.gz: 88da41af030eab9c282f8633b24d6906fbb63f5add53fc93cd87d123a42015b25de003295e737c6952ad55961851b77fc82014903a00f7969eb9b885e88583d0

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

@@ -9,6 +9,7 @@ module Jekyll
       NET_HTTP_ERRORS = [
         Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::OpenTimeout,
         Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError,
+        OpenSSL::SSL::SSLError,
       ].freeze
 
       def initialize(theme)
@@ -16,6 +17,11 @@ module Jekyll
       end
 
       def run
+        if theme.local_theme?
+          Jekyll.logger.debug LOG_KEY, "Using local theme at #{theme.root}"
+          return
+        end
+
         if downloaded?
           Jekyll.logger.debug LOG_KEY, "Using existing #{theme.name_with_owner}"
           return
@@ -26,6 +32,8 @@ module Jekyll
       end
 
       def downloaded?
+        return true if theme.local_theme?
+
         @downloaded ||= theme_dir_exists? && !theme_dir_empty?
       end
 
@@ -37,11 +45,12 @@ module Jekyll
         @zip_file ||= Tempfile.new([TEMP_PREFIX, ".zip"], :binmode => true)
       end
 
+      # rubocop:disable Metrics/AbcSize
       def download
         Jekyll.logger.debug LOG_KEY, "Downloading #{zip_url} to #{zip_file.path}"
-        Net::HTTP.start(zip_url.host, zip_url.port, :use_ssl => true) do |http|
+        http_class.start(zip_url.host, zip_url.port, :use_ssl => true) do |http|
           http.request(request) do |response|
-            raise_unless_sucess(response)
+            raise_unless_success(response)
             enforce_max_file_size(response.content_length)
             response.read_body do |chunk|
               zip_file.write chunk
@@ -52,6 +61,7 @@ module Jekyll
       rescue *NET_HTTP_ERRORS => e
         raise DownloadError, e.message
       end
+      # rubocop:enable Metrics/AbcSize
 
       def request
         return @request if defined? @request
@@ -61,10 +71,18 @@ module Jekyll
         @request
       end
 
-      def raise_unless_sucess(response)
+      def raise_unless_success(response)
         return if response.is_a?(Net::HTTPSuccess)
 
-        raise DownloadError, "#{response.code} - #{response.message} - Loading URL: #{zip_url}"
+        case response.code
+        when "404"
+          raise DownloadError, "The repository '#{theme.name_with_owner}' could not be found. " \
+                             "Please check that the repository name is correct, " \
+                             "publicly accessible, and contains a valid Jekyll theme. " \
+                             "URL: #{zip_url}"
+        else
+          raise DownloadError, "#{response.code} - #{response.message} - Loading URL: #{zip_url}"
+        end
       end
 
       def enforce_max_file_size(size)
@@ -96,6 +114,52 @@ module Jekyll
         ).normalize
       end
 
+      # Returns an HTTP class that respects proxy environment variables
+      def http_class
+        @http_class ||= Net::HTTP::Proxy(proxy_host, proxy_port, proxy_user, proxy_pass)
+      end
+
+      # Extracts proxy settings from environment variables
+      def proxy_uri
+        return @proxy_uri if defined?(@proxy_uri)
+
+        proxy_env = find_proxy_env_var
+        @proxy_uri = parse_proxy_uri(proxy_env)
+      end
+
+      def find_proxy_env_var
+        # Check for HTTPS proxy first if the URL uses HTTPS
+        if theme.scheme == "https"
+          ENV["https_proxy"] || ENV["HTTPS_PROXY"] || ENV["http_proxy"] || ENV["HTTP_PROXY"]
+        else
+          ENV["http_proxy"] || ENV["HTTP_PROXY"]
+        end
+      end
+
+      def parse_proxy_uri(proxy_env)
+        return nil unless proxy_env
+
+        Addressable::URI.parse(proxy_env)
+      rescue Addressable::URI::InvalidURIError
+        nil
+      end
+
+      def proxy_host
+        proxy_uri&.host
+      end
+
+      def proxy_port
+        proxy_uri&.port
+      end
+
+      def proxy_user
+        proxy_uri&.user
+      end
+
+      def proxy_pass
+        proxy_uri&.password
+      end
+
       def theme_dir_exists?
         theme.root && Dir.exist?(theme.root)
       end

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

@@ -12,6 +12,15 @@ module Jekyll
       DEPENDENCY_PREFIX = %r!^\s*[a-z]+\.add_(?:runtime_)?dependency!.freeze
       DEPENDENCY_REGEX = %r!#{DEPENDENCY_PREFIX}\(?\s*["']([a-z_-]+)["']!.freeze
 
+      # Regex patterns for extracting gemspec metadata
+      AUTHORS_REGEX = %r!^\s*[a-z_]+\.authors\s*=\s*\[(.*?)\]!m.freeze
+      VERSION_REGEX = %r!^\s*[a-z_]+\.version\s*=\s*["']([^"']+)["']!.freeze
+      SUMMARY_REGEX = %r!^\s*[a-z_]+\.summary\s*=\s*["'](.*?)["']!.freeze
+      DESCRIPTION_REGEX = %r!^\s*[a-z_]+\.description\s*=\s*["'](.*?)["']!.freeze
+
+      # Default version when gemspec is missing or version cannot be determined
+      DEFAULT_VERSION = "0.0.0"
+
       def initialize(theme)
         @theme = theme
       end
@@ -22,6 +31,63 @@ module Jekyll
         end
       end
 
+      # Returns an array of authors from the gemspec
+      def authors
+        @authors ||= begin
+          return [] unless contents
+
+          match = contents.match(AUTHORS_REGEX)
+          return [] unless match
+
+          # Extract author names from the array string
+          match[1].scan(%r!["']([^"']+)["']!).flatten
+        end
+      end
+
+      # Returns the version from the gemspec as a Gem::Version object
+      # Note: This extracts literal version strings like "1.2.3" from the gemspec.
+      # It cannot evaluate version constants like MyGem::VERSION.
+      def version
+        @version ||= begin
+                       return Gem::Version.new(DEFAULT_VERSION) unless contents
+
+                       match = contents.match(VERSION_REGEX)
+                       return Gem::Version.new(DEFAULT_VERSION) unless match
+
+                       # Extract the version string and convert to Gem::Version
+                       Gem::Version.new(match[1])
+                     rescue ArgumentError
+                       # If the version string is invalid, return default
+                       Gem::Version.new(DEFAULT_VERSION)
+                     end
+      end
+
+      # Returns the summary from the gemspec
+      def summary
+        @summary ||= begin
+          return "" unless contents
+
+          match = contents.match(SUMMARY_REGEX)
+          match ? match[1] : ""
+        end
+      end
+
+      # Returns the description from the gemspec
+      def description
+        @description ||= begin
+          return nil unless contents
+
+          match = contents.match(DESCRIPTION_REGEX)
+          match ? match[1] : nil
+        end
+      end
+
+      # Returns metadata hash from the gemspec
+      # Note: Metadata parsing is not currently implemented
+      def metadata
+        @metadata ||= {}
+      end
+
       private
 
       def contents

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

@@ -55,9 +55,22 @@ module Jekyll
         site.theme.configure_sass if site.theme.respond_to?(:configure_sass)
         site.send(:configure_include_paths)
         site.plugin_manager.require_theme_deps
+        initialize_github_metadata
+      end
+
+      # Initialize GitHub metadata munger if it was loaded after :after_init hook
+      def initialize_github_metadata
+        return unless defined?(Jekyll::GitHubMetadata::SiteGitHubMunger)
+        return if Jekyll::GitHubMetadata::SiteGitHubMunger.global_munger
+
+        munger = Jekyll::GitHubMetadata::SiteGitHubMunger.new(site)
+        munger.munge!
+        Jekyll::GitHubMetadata::SiteGitHubMunger.global_munger = munger
       end
 
       def enqueue_theme_cleanup
+        return if theme.local_theme? # Don't clean up local theme directories
+
         at_exit do
           Jekyll.logger.debug LOG_KEY, "Cleaning up #{theme.root}"
           FileUtils.rm_rf theme.root

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

@@ -5,7 +5,7 @@ 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, or commit
+      REF_REGEX   = %r!@(?<ref>[a-z0-9\._\-]+)!i.freeze # May be a branch, tag, commit, or "latest"
       THEME_REGEX = %r!\A#{OWNER_REGEX}/#{NAME_REGEX}(?:#{REF_REGEX})?\z!i.freeze
 
       # Initializes a new Jekyll::RemoteTheme::Theme
@@ -18,16 +18,25 @@ module Jekyll
       # - An enterprise GitHub instance + a GitHub owner + a theme-name string
       # 4. http[s]://github.<yourEnterprise>.com/owner/theme-name@git_ref
       # - An enterprise GitHub instance + a GitHub owner + a theme-name + Git ref string
+      # 5. /absolute/path/to/theme - an absolute local file path
+      # 6. ../relative/path/to/theme - a relative local file path
+      # 7. ~/path/to/theme - a home directory relative path
       def initialize(raw_theme)
-        @raw_theme = raw_theme.to_s.downcase.strip
+        original_theme = raw_theme.to_s.strip
+        local_path = looks_like_local_path?(original_theme)
+        @raw_theme = local_path ? original_theme : original_theme.downcase
         super(@raw_theme)
       end
 
       def name
+        return File.basename(expanded_local_path) if local_theme?
+
         theme_parts[:name]
       end
 
       def owner
+        return "local" if local_theme?
+
         theme_parts[:owner]
       end
 
@@ -45,17 +54,23 @@ module Jekyll
       alias_method :nwo, :name_with_owner
 
       def valid?
-        return false unless uri && theme_parts && name && owner
+        return local_path_valid? if local_theme?
 
-        host && valid_hosts.include?(host)
+        remote_theme_valid?
       end
 
       def git_ref
-        theme_parts[:ref] || "HEAD"
+        return "HEAD" if local_theme?
+
+        parsed_ref = theme_parts[:ref]
+        return "HEAD" unless parsed_ref
+        return resolve_latest_release if parsed_ref == "latest"
+
+        parsed_ref
       end
 
       def root
-        @root ||= File.realpath Dir.mktmpdir(TEMP_PREFIX)
+        @root ||= local_theme? ? expanded_local_path : File.realpath(Dir.mktmpdir(TEMP_PREFIX))
       end
 
       def inspect
@@ -63,10 +78,35 @@ module Jekyll
         " ref=\"#{git_ref}\" root=\"#{root}\">"
       end
 
+      def local_theme?
+        @local_theme ||= looks_like_local_path?(@raw_theme)
+      end
+
       private
 
+      def looks_like_local_path?(path)
+        # Check if it looks like a local path
+        # Supports: /, ./, ../, ~/ (Unix-style) and drive letters (Windows-style)
+        path.start_with?("/", "./", "../", "~/") || path.match?(%r!\A[a-z]:[/\\]!i)
+      end
+
+      def expanded_local_path
+        @expanded_local_path ||= File.expand_path(@raw_theme)
+      end
+
+      def local_path_valid?
+        Dir.exist?(expanded_local_path)
+      end
+
+      def remote_theme_valid?
+        return false unless uri && theme_parts && name && owner
+
+        host && valid_hosts.include?(host)
+      end
+
       def uri
         return @uri if defined? @uri
+        return @uri = nil if local_theme?
 
         @uri = if THEME_REGEX.match?(@raw_theme)
                  Addressable::URI.new(
@@ -82,6 +122,8 @@ module Jekyll
       end
 
       def theme_parts
+        return nil if local_theme?
+
         @theme_parts ||= uri.path[1..-1].match(THEME_REGEX) if uri
       end
 
@@ -96,6 +138,100 @@ module Jekyll
           ENV["GITHUB_HOSTNAME"],
         ].compact.to_set
       end
+
+      def resolve_latest_release
+        return @resolved_latest_release if defined? @resolved_latest_release
+
+        Jekyll.logger.debug LOG_KEY, "Resolving @latest for #{name_with_owner}"
+
+        @resolved_latest_release = fetch_latest_release_tag || "HEAD"
+      end
+
+      def fetch_latest_release_tag
+        api_url = build_api_url
+        response = make_api_request(api_url)
+
+        if response.is_a?(Net::HTTPSuccess)
+          parse_tag_from_response(response)
+        else
+          log_no_releases_warning
+          nil
+        end
+      rescue StandardError => e
+        log_api_error(e)
+        nil
+      end
+
+      def build_api_url
+        Addressable::URI.new(
+          :scheme => scheme,
+          :host   => api_host,
+          :path   => api_path
+        )
+      end
+
+      def make_api_request(api_url)
+        Net::HTTP.start(
+          api_url.host,
+          api_url.port,
+          :use_ssl => api_url.scheme == "https"
+        ) do |http|
+          request = Net::HTTP::Get.new(api_url.request_uri)
+          request["Accept"] = "application/vnd.github.v3+json"
+          request["User-Agent"] = Downloader::USER_AGENT
+          http.request(request)
+        end
+      end
+
+      def parse_tag_from_response(response)
+        data = JSON.parse(response.body)
+        tag = data["tag_name"]
+
+        if tag.nil? || tag.empty?
+          Jekyll.logger.warn LOG_KEY,
+                             "No tag_name in API response for #{name_with_owner}, using HEAD"
+          return nil
+        end
+
+        Jekyll.logger.debug LOG_KEY, "Resolved @latest to #{tag} for #{name_with_owner}"
+        tag
+      rescue JSON::ParserError => e
+        Jekyll.logger.warn LOG_KEY,
+                           "Failed to parse API response for #{name_with_owner}: " \
+                           "#{e.message}, using HEAD"
+        nil
+      end
+
+      def log_no_releases_warning
+        Jekyll.logger.warn LOG_KEY,
+                           "No releases found for #{name_with_owner}, using HEAD"
+      end
+
+      def log_api_error(error)
+        Jekyll.logger.warn LOG_KEY,
+                           "Failed to fetch latest release for #{name_with_owner}: " \
+                           "#{error.message}, using HEAD"
+      end
+
+      def api_host
+        case host
+        when "github.com"
+          "api.github.com"
+        else
+          # For GitHub Enterprise, API is typically at hostname/api/v3
+          host
+        end
+      end
+
+      def api_path
+        case host
+        when "github.com"
+          "/repos/#{name_with_owner}/releases/latest"
+        else
+          # For GitHub Enterprise
+          "/api/v3/repos/#{name_with_owner}/releases/latest"
+        end
+      end
     end
   end
 end

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

@@ -2,6 +2,6 @@
 
 module Jekyll
   module RemoteTheme
-    VERSION = "0.4.3"
+    VERSION = "0.5.0"
   end
 end

data/lib/jekyll-remote-theme.rb

@@ -4,8 +4,10 @@ require "jekyll"
 require "fileutils"
 require "tempfile"
 require "addressable"
+require "openssl"
 require "net/http"
 require "zip"
+require "json"
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-remote-theme
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Ben Balter
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -51,9 +50,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '4.0'
     - - "!="
       - !ruby/object:Gem::Version
         version: 2.0.0
@@ -64,12 +63,32 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '4.0'
     - - "!="
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.2
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -202,7 +221,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description:
 email:
 - ben.balter@github.com
 executables: []
@@ -219,7 +237,6 @@ homepage: https://github.com/benbalter/jekyll-remote-theme
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -234,8 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.14
-signing_key:
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Jekyll plugin for building Jekyll sites with any GitHub-hosted theme
 test_files: []