jekyll-remote-theme 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 246733cb4cbde4092301d6629e1e8d9fbb35b7c53f90be780167f8afcda9c337
-  data.tar.gz: f36b9531b746707298468a67b02b225c7d32059f03884878e3dbc3df8d6b6c47
+  metadata.gz: db842baa8db191bebfceb51b6c6ccc6893872d14cdeafe70b7979907df93d49f
+  data.tar.gz: 822dd49434a52f18f326f9a39930dc0b09ea7ad1e23c7f99dd8c07a4d4c21eeb
 SHA512:
-  metadata.gz: fca934add7f3719eda06c8520e4344fc39e22b5bd9b798b5e35fec56f607a5f559a4749ff0b9401eba67b127fe06b79fb139ef15cb47409150294017b53e009b
-  data.tar.gz: f136e8fed5e3fefe87c19de32c62b80be4b699d0931f59d7c8dfd8d4390b3e60110e112325a704c5e5af20805d26b5dae45ac2d7da4993d59803a9988414c1df
+  metadata.gz: 8f411c8649bef2a2bd4d7d1382f8fdaeb55f258f68ea1a0751a3ed66d8f5da67aab708cee6cb2bbf5a046a09080719c11c77c6df230b2510789d6cf378a7ffcd
+  data.tar.gz: 61392d3287b1c86089b583a0f12ba8bd60da7dbe03c224d3a7294b35f6781b6908ebb77f9cd2bf7e4867eac45a4c923d8a5627924274a897bec1861e77e174b9

data/lib/jekyll-remote-theme.rb

@@ -19,9 +19,9 @@ module Jekyll
     autoload :Theme,       "jekyll-remote-theme/theme"
     autoload :VERSION,     "jekyll-remote-theme/version"
 
-    CONFIG_KEY  = "remote_theme".freeze
-    LOG_KEY     = "Remote Theme:".freeze
-    TEMP_PREFIX = "jekyll-remote-theme-".freeze
+    CONFIG_KEY  = "remote_theme"
+    LOG_KEY     = "Remote Theme:"
+    TEMP_PREFIX = "jekyll-remote-theme-"
 
     def self.init(site)
       Munger.new(site).munge!

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

@@ -3,18 +3,14 @@
 module Jekyll
   module RemoteTheme
     class Downloader
-      HOST = "https://codeload.github.com".freeze
-      PROJECT_URL = "https://github.com/benbalter/jekyll-remote-theme".freeze
-      USER_AGENT = "Jekyll Remote Theme/#{VERSION} (+#{PROJECT_URL})".freeze
+      PROJECT_URL = "https://github.com/benbalter/jekyll-remote-theme"
+      USER_AGENT = "Jekyll Remote Theme/#{VERSION} (+#{PROJECT_URL})"
       MAX_FILE_SIZE = 1 * (1024 * 1024 * 1024) # Size in bytes (1 GB)
       NET_HTTP_ERRORS = [
         Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::OpenTimeout,
         Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError,
       ].freeze
 
-      attr_reader :theme
-      private :theme
-
       def initialize(theme)
         @theme = theme
       end
@@ -35,6 +31,8 @@ module Jekyll
 
       private
 
+      attr_reader :theme
+
       def zip_file
         @zip_file ||= Tempfile.new([TEMP_PREFIX, ".zip"], :binmode => true)
       end
@@ -57,6 +55,7 @@ module Jekyll
 
       def request
         return @request if defined? @request
+
         @request = Net::HTTP::Get.new zip_url.request_uri
         @request["User-Agent"] = USER_AGENT
         @request
@@ -64,11 +63,13 @@ module Jekyll
 
       def raise_unless_sucess(response)
         return if response.is_a?(Net::HTTPSuccess)
+
         raise DownloadError, "#{response.code} - #{response.message}"
       end
 
       def enforce_max_file_size(size)
         return unless size && size > MAX_FILE_SIZE
+
         raise DownloadError, "Maximum file size of #{MAX_FILE_SIZE} bytes exceeded"
       end
 
@@ -88,8 +89,10 @@ module Jekyll
 
       # Full URL to codeload zip download endpoint for the given theme
       def zip_url
-        @zip_url ||= Addressable::URI.join(
-          HOST, "#{theme.owner}/", "#{theme.name}/", "zip/", theme.git_ref
+        @zip_url ||= Addressable::URI.new(
+          :scheme => theme.scheme,
+          :host   => "codeload.#{theme.host}",
+          :path   => [theme.owner, theme.name, "zip", theme.git_ref].join("/")
         ).normalize
       end
 

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

@@ -9,8 +9,8 @@ module Jekyll
       extend Forwardable
       def_delegator :theme, :root, :full_gem_path
 
-      DEPENDENCY_PREFIX = %r!^\s*[a-z]+\.add_(?:runtime_)?dependency!
-      DEPENDENCY_REGEX = %r!#{DEPENDENCY_PREFIX}\(?\s*["']([a-z_-]+)["']!
+      DEPENDENCY_PREFIX = %r!^\s*[a-z]+\.add_(?:runtime_)?dependency!.freeze
+      DEPENDENCY_REGEX = %r!#{DEPENDENCY_PREFIX}\(?\s*["']([a-z_-]+)["']!.freeze
 
       def initialize(theme)
         @theme = theme

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

@@ -32,7 +32,7 @@ module Jekyll
       private
 
       def munged?
-        site.theme && site.theme.is_a?(Jekyll::RemoteTheme::Theme)
+        site.theme&.is_a?(Jekyll::RemoteTheme::Theme)
       end
 
       def theme
@@ -49,6 +49,7 @@ module Jekyll
 
       def configure_theme
         return unless theme
+
         site.config["theme"] = theme.name
         site.theme = theme
         site.theme.configure_sass
@@ -59,6 +60,7 @@ module Jekyll
       def enqueue_theme_cleanup
         at_exit do
           return unless munged? && downloader.downloaded?
+
           Jekyll.logger.debug LOG_KEY, "Cleaning up #{theme.root}"
           FileUtils.rm_rf theme.root
         end

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

@@ -3,10 +3,10 @@
 module Jekyll
   module RemoteTheme
     class Theme < Jekyll::Theme
-      OWNER_REGEX = %r!(?<owner>[a-z0-9\-]+)!i
-      NAME_REGEX  = %r!(?<name>[a-z0-9\._\-]+)!i
-      REF_REGEX   = %r!@(?<ref>[a-z0-9\._\-]+)!i # May be a branch, tag, or commit
-      THEME_REGEX = %r!\A#{OWNER_REGEX}/#{NAME_REGEX}(?:#{REF_REGEX})?\z!i
+      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
+      THEME_REGEX = %r!\A#{OWNER_REGEX}/#{NAME_REGEX}(?:#{REF_REGEX})?\z!i.freeze
 
       # Initializes a new Jekyll::RemoteTheme::Theme
       #
@@ -14,6 +14,10 @@ module Jekyll
       #
       # 1. owner/theme-name - a GitHub owner + theme-name string
       # 2. owner/theme-name@git_ref - a GitHub owner + theme-name + Git ref string
+      # 3. http[s]://github.<yourEnterprise>.com/owner/theme-name
+      # - 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
       def initialize(raw_theme)
         @raw_theme = raw_theme.to_s.downcase.strip
         super(@raw_theme)
@@ -27,13 +31,23 @@ module Jekyll
         theme_parts[:owner]
       end
 
+      def host
+        uri&.host
+      end
+
+      def scheme
+        uri&.scheme
+      end
+
       def name_with_owner
         [owner, name].join("/")
       end
       alias_method :nwo, :name_with_owner
 
       def valid?
-        theme_parts && name && owner
+        return false unless uri && theme_parts && name && owner
+
+        host && valid_hosts.include?(host)
       end
 
       def git_ref
@@ -45,19 +59,43 @@ module Jekyll
       end
 
       def inspect
-        "#<Jekyll::RemoteTheme::Theme owner=\"#{owner}\" name=\"#{name}\"" \
+        "#<Jekyll::RemoteTheme::Theme host=\"#{host}\" owner=\"#{owner}\" name=\"#{name}\"" \
         " ref=\"#{git_ref}\" root=\"#{root}\">"
       end
 
       private
 
+      def uri
+        return @uri if defined? @uri
+
+        @uri = if @raw_theme =~ THEME_REGEX
+                 Addressable::URI.new(
+                   :scheme => "https",
+                   :host   => "github.com",
+                   :path   => @raw_theme
+                 )
+               else
+                 Addressable::URI.parse @raw_theme
+               end
+      rescue Addressable::URI::InvalidURIError
+        @uri = nil
+      end
+
       def theme_parts
-        @theme_parts ||= @raw_theme.match(THEME_REGEX)
+        @theme_parts ||= uri.path[1..-1].match(THEME_REGEX) if uri
       end
 
       def gemspec
         @gemspec ||= MockGemspec.new(self)
       end
+
+      def valid_hosts
+        @valid_hosts ||= [
+          "github.com",
+          ENV["PAGES_GITHUB_HOSTNAME"],
+          ENV["GITHUB_HOSTNAME"],
+        ].compact.to_set
+      end
     end
   end
 end

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

@@ -2,6 +2,6 @@
 
 module Jekyll
   module RemoteTheme
-    VERSION = "0.3.1".freeze
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-remote-theme
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-14 00:00:00.000000000 Z
+date: 2019-06-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -106,20 +120,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: '0.59'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
-    - - ">="
+        version: '0.59'
+- !ruby/object:Gem::Dependency
+  name: rubocop-jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -159,15 +181,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Jekyll plugin for building Jekyll sites with any GitHub-hosted theme