jekyll-remote-theme 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8229e0bedfef52dba41d17eff8eb8e4bba23972c
+  data.tar.gz: 3f0cb3209952df98c3d7db8fac598590f83e6fcc
+SHA512:
+  metadata.gz: 75fef7047c3d3f2d5a6727e53a6079ca45f45d6e3340f769d95d4f4874c89df97735e905d6f9b59eca401aae8057b5ac06859bbd0a884818bcf933a115bdcf63
+  data.tar.gz: 68995b0baa3a99fc41682e74ac5a6c4cdb953a0b814461e03cac599dad36ff26f4c5d107994ac06ebd62cbff4ae76621aa114a18b890025b67a560d25b9f9b57

data/lib/jekyll-remote-theme.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "fileutils"
+require "tempfile"
+require "addressable"
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+module Jekyll
+  module RemoteTheme
+    autoload :Downloader,  "jekyll-remote-theme/downloader"
+    autoload :Executor,    "jekyll-remote-theme/executor"
+    autoload :MockGemspec, "jekyll-remote-theme/mock_gemspec"
+    autoload :Munger,      "jekyll-remote-theme/munger"
+    autoload :Theme,       "jekyll-remote-theme/theme"
+    autoload :VERSION,     "jekyll-remote-theme/version"
+
+    CONFIG_KEY = "remote_theme".freeze
+    LOG_KEY    = "Remote Theme:".freeze
+
+    def self.init(site)
+      Munger.new(site).munge!
+    end
+  end
+end
+
+Jekyll::Hooks.register :site, :after_reset do |site|
+  Jekyll::RemoteTheme.init(site)
+end

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

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module RemoteTheme
+    class Downloader
+      include RemoteTheme::Executor
+
+      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
+
+      attr_reader :theme
+      private :theme
+
+      def initialize(theme)
+        @theme = theme
+      end
+
+      def run
+        if downloaded?
+          Jekyll.logger.debug LOG_KEY, "Using existing #{theme.name_with_owner}"
+          return
+        end
+
+        download
+        unzip
+        set_theme_root
+
+        @downloaded = true
+      end
+
+      def downloaded?
+        @downloaded ||= theme_dir_exists? && !theme_dir_empty?
+      end
+
+      def temp_dir
+        @temp_dir ||= File.realpath Dir.mktmpdir(TEMP_PREFIX)
+      end
+
+      private
+
+      def zip_file
+        @zip_file ||= Tempfile.new([TEMP_PREFIX, ".zip"])
+      end
+
+      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)
+      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
+
+      # 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}"
+      end
+
+      # Full URL to codeload zip download endpoint for the given theme
+      def zip_url
+        Addressable::URI.join(
+          HOST, "#{theme.owner}/", "#{theme.name}/", "zip/", theme.git_ref
+        ).normalize
+      end
+
+      def theme_dir_exists?
+        theme.root && Dir.exist?(theme.root)
+      end
+
+      def theme_dir_empty?
+        Dir["#{theme.root}/*"].empty?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module Jekyll
+  module RemoteTheme
+    module Executor
+      class ExecutionError < StandardError; end
+
+      TIMEOUT = 3600
+      TIMEOUT_COMMANDS = %w(timeout gtimeout).freeze
+
+      def run_command(*cmds)
+        stdout, stderr, status = Open3.capture3(*cmds)
+
+        if status.exitstatus != 0
+          Jekyll.logger.error LOG_KEY, "Error running command #{cmds.join(" ")}"
+          Jekyll.logger.debug LOG_KEY, stdout
+          raise ExecutionError, stderr
+        end
+
+        stdout
+      end
+
+      def timeout_command
+        @timeout_command ||= begin
+          cmd = TIMEOUT_COMMANDS.find { |exe| executable_exists?(exe) }
+          cmd ? [cmd, TIMEOUT.to_s].freeze : [].freeze
+        end
+      end
+
+      private
+
+      def executable_exists?(executable)
+        ENV["PATH"].split(File::PATH_SEPARATOR).any? do |dir|
+          exe = File.join(dir, executable)
+          File.file?(exe) && File.executable?(exe)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module RemoteTheme
+    # Jekyll::Theme expects the theme's gemspec to tell it things like
+    # the path to the theme and runtime dependencies. MockGemspec serves as a
+    # stand in, since remote themes don't have Gemspecs
+    class MockGemspec
+      extend Forwardable
+      def_delegator :theme, :root, :full_gem_path
+
+      def initialize(theme)
+        @theme = theme
+      end
+
+      def runtime_dependencies
+        []
+      end
+
+      private
+
+      attr_reader :theme
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module RemoteTheme
+    class Munger
+      extend Forwardable
+      def_delegator :site, :config
+      attr_reader :site
+
+      def initialize(site)
+        @site = site
+      end
+
+      def munge!
+        return unless raw_theme
+
+        unless theme.valid?
+          Jekyll.logger.error LOG_KEY, "#{raw_theme.inspect} is not a valid remote theme"
+          return
+        end
+
+        Jekyll.logger.info LOG_KEY, "Using theme #{theme.name_with_owner}"
+        return if munged?
+
+        downloader.run
+        configure_theme
+        enqueue_theme_cleanup
+
+        theme
+      end
+
+      private
+
+      def munged?
+        site.theme && site.theme.is_a?(Jekyll::RemoteTheme::Theme)
+      end
+
+      def theme
+        @theme ||= Theme.new(raw_theme)
+      end
+
+      def raw_theme
+        config[CONFIG_KEY]
+      end
+
+      def downloader
+        @downloader ||= Downloader.new(theme)
+      end
+
+      def configure_theme
+        return unless theme
+        site.config["theme"] = theme.name
+        site.theme = theme
+        site.theme.configure_sass
+        site.send(:configure_include_paths)
+      end
+
+      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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+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
+
+      # Initializes a new Jekyll::RemoteTheme::Theme
+      #
+      # raw_theme can be in the form of:
+      #
+      # 1. owner/theme-name - a GitHub owner + theme-name string
+      # 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
+      end
+
+      def name
+        theme_parts[:name]
+      end
+
+      def owner
+        theme_parts[:owner]
+      end
+
+      def name_with_owner
+        [owner, name].join("/")
+      end
+      alias_method :nwo, :name_with_owner
+
+      def valid?
+        theme_parts && name && owner
+      end
+
+      def git_ref
+        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)
+      end
+
+      def inspect
+        "#<Jekyll::RemoteTheme::Theme owner=\"#{owner}\" name=\"#{name}\"" \
+        " ref=\"#{git_ref}\" root=\"#{root}\">"
+      end
+
+      private
+
+      def theme_parts
+        @theme_parts ||= @raw_theme.match(THEME_REGEX)
+      end
+
+      def gemspec
+        @gemspec ||= MockGemspec.new(self)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module RemoteTheme
+    VERSION = "0.1.0".freeze
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-remote-theme
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Balter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: jekyll-theme-primer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: 
+email:
+- ben.balter@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll-remote-theme.rb
+- lib/jekyll-remote-theme/downloader.rb
+- lib/jekyll-remote-theme/executor.rb
+- lib/jekyll-remote-theme/mock_gemspec.rb
+- lib/jekyll-remote-theme/munger.rb
+- lib/jekyll-remote-theme/theme.rb
+- lib/jekyll-remote-theme/version.rb
+homepage: https://github.com/benbalter/jekyll-remote-theme
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Jekyll plugin for building Jekyll sites with any GitHub-hosted theme
+test_files: []