jekyll-remote-theme 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8229e0bedfef52dba41d17eff8eb8e4bba23972c
-  data.tar.gz: 3f0cb3209952df98c3d7db8fac598590f83e6fcc
+  metadata.gz: f143d51ba614a2d6ee6050d17b36942e09f3a6ba
+  data.tar.gz: 6920fee94da6e9cdc86e84fb64a80991ea8d1e84
 SHA512:
-  metadata.gz: 75fef7047c3d3f2d5a6727e53a6079ca45f45d6e3340f769d95d4f4874c89df97735e905d6f9b59eca401aae8057b5ac06859bbd0a884818bcf933a115bdcf63
-  data.tar.gz: 68995b0baa3a99fc41682e74ac5a6c4cdb953a0b814461e03cac599dad36ff26f4c5d107994ac06ebd62cbff4ae76621aa114a18b890025b67a560d25b9f9b57
+  metadata.gz: 1e0c47f5100f3abb9948fc3c24cd5dbba8673ddc3f554793b278d4cc7f7d53a3257a1dd684d7122330d999145540d338008b289aec938ccd92be94460ab6e2ea
+  data.tar.gz: 136a0edffff8009838810ac562ea521f2fa01a39ea4222382f5f6c03cbb11b85caaa60c357deba097d5f8504b06c45e05f366ad6ad996f8e7c56135b5eac003e

data/lib/jekyll-remote-theme.rb

@@ -4,11 +4,15 @@ require "jekyll"
 require "fileutils"
 require "tempfile"
 require "addressable"
+require "typhoeus"
+require "zip"
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 module Jekyll
   module RemoteTheme
+    class DownloadError < StandardError; end
+
     autoload :Downloader,  "jekyll-remote-theme/downloader"
     autoload :Executor,    "jekyll-remote-theme/executor"
     autoload :MockGemspec, "jekyll-remote-theme/mock_gemspec"
@@ -16,8 +20,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
+    CONFIG_KEY  = "remote_theme".freeze
+    LOG_KEY     = "Remote Theme:".freeze
+    TEMP_PREFIX = "jekyll-remote-theme-".freeze
 
     def self.init(site)
       Munger.new(site).munge!
@@ -28,3 +33,5 @@ end
 Jekyll::Hooks.register :site, :after_reset do |site|
   Jekyll::RemoteTheme.init(site)
 end
+
+Ethon.logger = Jekyll.logger.writer

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

@@ -7,8 +7,12 @@ module Jekyll
 
       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
-      TEMP_PREFIX = "jekyll-remote-theme-".freeze
+      TYPHOEUS_OPTIONS = {
+        :headers => {
+          :user_agent => "Jekyll Remote Theme/#{VERSION} (+#{PROJECT_URL})",
+        },
+        :verbose => (Jekyll.logger.level == :verbose),
+      }.freeze
 
       attr_reader :theme
       private :theme
@@ -25,7 +29,6 @@ module Jekyll
 
         download
         unzip
-        set_theme_root
 
         @downloaded = true
       end
@@ -34,10 +37,6 @@ module Jekyll
         @downloaded ||= theme_dir_exists? && !theme_dir_empty?
       end
 
-      def temp_dir
-        @temp_dir ||= File.realpath Dir.mktmpdir(TEMP_PREFIX)
-      end
-
       private
 
       def zip_file
@@ -46,29 +45,24 @@ module Jekyll
 
       def download
         Jekyll.logger.debug LOG_KEY, "Downloading #{zip_url} to #{zip_file.path}"
-        cmd = [
-          *timeout_command, "curl", "--url", zip_url, "--output", zip_file.path,
-          "--user-agent", USER_AGENT, "--fail", "--silent", "--show-error",
-        ]
-        run_command(*cmd)
+        request = Typhoeus::Request.new zip_url, TYPHOEUS_OPTIONS
+        request.on_headers  { |response| raise_if_unsuccessful(response) }
+        request.on_body     { |chunk| zip_file.write(chunk) }
+        request.on_complete { |response| raise_if_unsuccessful(response) }
+        request.run
       end
 
       def unzip
-        Jekyll.logger.debug LOG_KEY, "Unzipping #{zip_file.path} to #{temp_dir}"
-        cmd = [*timeout_command, "unzip", zip_file.path, "-d", temp_dir]
-        run_command(*cmd)
-        zip_file.unlink
-      end
+        Jekyll.logger.debug LOG_KEY, "Unzipping #{zip_file.path} to #{theme.root}"
 
-      # Codeload generated zip files contain a top level folder in the form of
-      # THEME_NAME-GIT_REF/. While requests for Git repos are case incensitive,
-      # the zip subfolder will respect the case in the repository's name, thus
-      # making it impossible to predict the true path to the theme. In case we're
-      # on a case-sensitive file system, set the theme's root to the true theme
-      # directory, after we've extracted the zip and can determine its actual path.
-      def set_theme_root
-        theme.root = Dir["#{temp_dir}/*"].first
-        Jekyll.logger.debug LOG_KEY, "Setting theme root to #{theme.root}"
+        # File IO is already open, rewind pointer to start of file to read
+        zip_file.rewind
+
+        Zip::File.open(zip_file) do |archive|
+          archive.each { |file| file.extract path_without_name_and_ref(file.name) }
+        end
+
+        zip_file.unlink
       end
 
       # Full URL to codeload zip download endpoint for the given theme
@@ -85,6 +79,26 @@ module Jekyll
       def theme_dir_empty?
         Dir["#{theme.root}/*"].empty?
       end
+
+      def raise_if_unsuccessful(response)
+        if response.timed_out?
+          raise DownloadError, "Request timed out"
+        elsif response.code.zero?
+          raise DownloadError, response.return_message
+        elsif response.code != 200
+          msg = "Request failed with #{response.code} - #{response.status_message}"
+          raise DownloadError, msg
+        end
+      end
+
+      # Codeload generated zip files contain a top level folder in the form of
+      # THEME_NAME-GIT_REF/. While requests for Git repos are case incensitive,
+      # the zip subfolder will respect the case in the repository's name, thus
+      # making it impossible to predict the true path to the theme. In case we're
+      # on a case-sensitive file system, strip the parent folder from all paths.
+      def path_without_name_and_ref(path)
+        Jekyll.sanitized_path theme.root, path.split("/").drop(1).join("/")
+      end
     end
   end
 end

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

@@ -58,8 +58,8 @@ module Jekyll
       def enqueue_theme_cleanup
         at_exit do
           return unless munged? && downloader.downloaded?
-          Jekyll.logger.debug LOG_KEY, "Cleaning up #{downloader.temp_dir}"
-          FileUtils.rm_rf downloader.temp_dir
+          Jekyll.logger.debug LOG_KEY, "Cleaning up #{theme.root}"
+          FileUtils.rm_rf theme.root
         end
       end
     end

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

@@ -16,6 +16,7 @@ module Jekyll
       # 2. owner/theme-name@git_ref - a GitHub owner + theme-name + Git ref string
       def initialize(raw_theme)
         @raw_theme = raw_theme.to_s.downcase.strip
+        super(@raw_theme)
       end
 
       def name
@@ -39,13 +40,8 @@ module Jekyll
         theme_parts[:ref] || "master"
       end
 
-      # Override Jekyll::Theme's native #root which calls gemspec.full_gem_path
       def root
-        defined?(@root) ? @root : nil
-      end
-
-      def root=(path)
-        @root = File.realpath(path)
+        @root ||= File.realpath Dir.mktmpdir(TEMP_PREFIX)
       end
 
       def inspect

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

@@ -2,6 +2,6 @@
 
 module Jekyll
   module RemoteTheme
-    VERSION = "0.1.0".freeze
+    VERSION = "0.2.0".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-remote-theme
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben Balter
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: jekyll-theme-primer
   requirement: !ruby/object:Gem::Requirement