github-pages 61 → 62

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 947979e5fe5eabfdfa234fd3f042b1a40b94fab6
-  data.tar.gz: ed1fcd0afb78520c9c957ae83e4a78aba8fbb2f8
+  metadata.gz: 236cdbaaf5f3c69fe54ebb00dd8806661bd66f89
+  data.tar.gz: 24918367d9f67c809bd4190fdc70ec0605853852
 SHA512:
-  metadata.gz: b0cba9eaa7e7fd9287335cf8663a289feff67a2b599fb34b0fd292218d9d25df1b65b01620306d54a1d9c5d2516af8824cbe2e05cace5c8aaea78eb50675b8e5
-  data.tar.gz: c6e6d5f4b04d6116863c931ee1fc9f44c0f85ef7675f07731e978082534156979240c6355512e622be7fc78972fc4f644928987d379d0d1c7d3957d6dd734abe
+  metadata.gz: 2fb4e897495fdbe09956c5b88f59b3cfa32b4eef9137b5ee35b00e24c003cb31647f3075524e1f3e7688ec5720e6b990ffb4068a700ffe08f8f09659a733d228
+  data.tar.gz: d785bf11c96d2761db3f2f707163c29ceb740399366a30b7e9a164fe594e98b61df86f68bed2983691a94c1ee9519fbff56fd5b384af4f870d0d9839b8596af6

data/lib/github-pages/configuration.rb

@@ -0,0 +1,132 @@
+module GitHubPages
+  #
+  class Configuration
+    # Plugins which are activated by default
+    DEFAULT_PLUGINS = %w(
+      jekyll-coffeescript
+      jekyll-gist
+      jekyll-github-metadata
+      jekyll-paginate
+      jekyll-textile-converter
+    ).freeze
+
+    # Plugins allowed by GitHub Pages
+    PLUGIN_WHITELIST = %w(
+      jekyll-coffeescript
+      jekyll-feed
+      jekyll-gist
+      jekyll-github-metadata
+      jekyll-mentions
+      jekyll-paginate
+      jekyll-redirect-from
+      jekyll-seo-tag
+      jekyll-sitemap
+      jekyll-textile-converter
+      jemoji
+    ).freeze
+
+    # Default, user overwritable options
+    DEFAULTS = {
+      "jailed"   => false,
+      "gems"     => DEFAULT_PLUGINS,
+      "kramdown" => {
+        "input"     => "GFM",
+        "hard_wrap" => false
+      }
+    }.freeze
+
+    # Jekyll defaults merged with Pages defaults.
+    MERGED_DEFAULTS = Jekyll::Utils.deep_merge_hashes(
+      Jekyll::Configuration::DEFAULTS,
+      DEFAULTS
+    ).freeze
+
+    # Options which GitHub Pages sets, regardless of the user-specified value
+    #
+    # The following values are also overridden by GitHub Pages, but are not
+    # overridden locally, for practical purposes:
+    # * source
+    # * destination
+    # * jailed
+    # * verbose
+    # * incremental
+    # * GH_ENV
+    OVERRIDES = {
+      "lsi"         => false,
+      "safe"        => true,
+      "plugins"     => SecureRandom.hex,
+      "whitelist"   => PLUGIN_WHITELIST,
+      "highlighter" => "rouge",
+      "kramdown"    => {
+        "template"          => "",
+        "math_engine"       => "mathjax",
+        "syntax_highligher" => "rouge"
+      },
+      "gist"        => {
+        "noscript"  => false
+      }
+    }.freeze
+
+    # These configuration settings have corresponding instance variables on
+    # Jekyll::Site and need to be set properly when the config is updated.
+    CONFIGS_WITH_METHODS = %w(
+      safe lsi highlighter baseurl exclude include future unpublished
+      show_drafts limit_posts keep_files gems
+    ).freeze
+
+    class << self
+      def processed?(site)
+        site.instance_variable_get(:@_github_pages_processed) == true
+      end
+
+      def processed(site)
+        site.instance_variable_set :@_github_pages_processed, true
+      end
+
+      # Given a user's config, determines the effective configuration by building a user
+      # configuration sandwhich with our overrides overriding the user's specified
+      # values which themselves override our defaults.
+      #
+      # Returns the effective Configuration
+      #
+      # Note: this is a highly modified version of Jekyll#configuration
+      def effective_config(user_config)
+        # Merge user config into defaults
+        config = Jekyll::Utils.deep_merge_hashes(MERGED_DEFAULTS, user_config)
+          .fix_common_issues
+          .add_default_collections
+
+        # Merge overwrites into user config
+        config = Jekyll::Utils.deep_merge_hashes config, OVERRIDES
+
+        # Ensure we have those gems we want.
+        config["gems"] = Array(config["gems"]) | DEFAULT_PLUGINS
+
+        config
+      end
+
+      # Set the site's configuration. Implemented as an `after_reset` hook.
+      # Equivalent #set! function contains the code of interest. This function
+      # guards against double-processing via the value in #processed.
+      def set(site)
+        return if processed? site
+        set!(site)
+        processed(site)
+      end
+
+      # Set the site's configuration with all the proper defaults and overrides.
+      # Should be called by #set to protect against multiple processings.
+      def set!(site)
+        config = effective_config(site.config)
+
+        # Assign everything to the site
+        site.instance_variable_set :@config, config
+
+        # Ensure all
+        CONFIGS_WITH_METHODS.each do |opt|
+          site.public_send("#{opt}=", site.config[opt])
+        end
+      end
+    end
+  end
+end

data/lib/github-pages/dependencies.rb

@@ -0,0 +1,67 @@
+module GitHubPages
+  # Dependencies is where all the public dependencies for GitHub Pages are defined,
+  # and versions locked. Any plugin for Pages must be specified here with a
+  # corresponding version to which it shall be locked in the runtime dependencies.
+  class Dependencies
+    VERSIONS = {
+      # Jekyll
+      "jekyll"                    => "3.0.3",
+      "jekyll-sass-converter"     => "1.3.0",
+      "jekyll-textile-converter"  => "0.1.0",
+
+      # Converters
+      "kramdown"                  => "1.10.0",
+      "rdiscount"                 => "2.1.8",
+      "redcarpet"                 => "3.3.3",
+      "RedCloth"                  => "4.2.9",
+
+      # Liquid
+      "liquid"                    => "3.0.6",
+
+      # Highlighters
+      "rouge"                     => "1.10.1",
+
+      # Plugins
+      "jemoji"                    => "0.5.1",
+      "jekyll-mentions"           => "1.0.1",
+      "jekyll-redirect-from"      => "0.9.1",
+      "jekyll-sitemap"            => "0.10.0",
+      "jekyll-feed"               => "0.4.0",
+      "jekyll-gist"               => "1.4.0",
+      "jekyll-paginate"           => "1.1.0",
+      "github-pages-health-check" => "1.1.0",
+      "jekyll-coffeescript"       => "1.0.1",
+      "jekyll-seo-tag"            => "1.3.2",
+      "jekyll-github-metadata"    => "1.9.0"
+    }.freeze
+
+    # Jekyll and related dependency versions as used by GitHub Pages.
+    # For more information see:
+    # https://help.github.com/articles/using-jekyll-with-pages
+    def self.gems
+      VERSIONS
+    end
+
+    # Versions used by GitHub Pages, including github-pages gem and ruby version
+    # Useful for programmatically querying for the current-running version
+    def self.versions
+      gems.merge version_report
+    end
+
+    def self.version_report
+      require "html/pipeline/version"
+      require "sass/version"
+      require "safe_yaml/version"
+
+      {
+        "ruby" => RUBY_VERSION,
+
+        # Gem versions we're curious about
+        "github-pages"  => VERSION.to_s,
+        "html-pipeline" => HTML::Pipeline::VERSION,
+        "sass"          => Sass.version[:number],
+        "safe_yaml"     => SafeYAML::VERSION
+      }
+    end
+  end
+end

data/lib/github-pages/version.rb

@@ -0,0 +1,3 @@
+module GitHubPages
+  VERSION = 62
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github-pages
 version: !ruby/object:Gem::Version
-  version: '61'
+  version: '62'
 platform: ruby
 authors:
 - GitHub, Inc.
@@ -355,6 +355,9 @@ extra_rdoc_files: []
 files:
 - bin/github-pages
 - lib/github-pages.rb
+- lib/github-pages/configuration.rb
+- lib/github-pages/dependencies.rb
+- lib/github-pages/version.rb
 homepage: https://github.com/github/pages-gem
 licenses:
 - MIT
@@ -381,7 +384,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.6.1
 signing_key: 
 specification_version: 4
 summary: Track GitHub Pages dependencies.