RubyGems - ngage - Versions diffs - 0.0.0 - Mend

ngage 0.0.0

Files changed (109) hide show

checksums.yaml +7 -0
data/LICENSE +22 -0
data/exe/ngage +55 -0
data/lib/ngage.rb +3 -0
data/lib/ngage/jekyll.rb +204 -0
data/lib/ngage/jekyll/cleaner.rb +111 -0
data/lib/ngage/jekyll/collection.rb +235 -0
data/lib/ngage/jekyll/command.rb +103 -0
data/lib/ngage/jekyll/commands/build.rb +93 -0
data/lib/ngage/jekyll/commands/clean.rb +45 -0
data/lib/ngage/jekyll/commands/doctor.rb +173 -0
data/lib/ngage/jekyll/commands/help.rb +34 -0
data/lib/ngage/jekyll/commands/new.rb +157 -0
data/lib/ngage/jekyll/commands/new_theme.rb +42 -0
data/lib/ngage/jekyll/commands/serve.rb +354 -0
data/lib/ngage/jekyll/commands/serve/live_reload_reactor.rb +122 -0
data/lib/ngage/jekyll/commands/serve/livereload_assets/livereload.js +1183 -0
data/lib/ngage/jekyll/commands/serve/servlet.rb +203 -0
data/lib/ngage/jekyll/commands/serve/websockets.rb +81 -0
data/lib/ngage/jekyll/configuration.rb +391 -0
data/lib/ngage/jekyll/converter.rb +54 -0
data/lib/ngage/jekyll/converters/identity.rb +41 -0
data/lib/ngage/jekyll/converters/markdown.rb +116 -0
data/lib/ngage/jekyll/converters/markdown/kramdown_parser.rb +122 -0
data/lib/ngage/jekyll/converters/smartypants.rb +70 -0
data/lib/ngage/jekyll/convertible.rb +253 -0
data/lib/ngage/jekyll/deprecator.rb +50 -0
data/lib/ngage/jekyll/document.rb +503 -0
data/lib/ngage/jekyll/drops/collection_drop.rb +20 -0
data/lib/ngage/jekyll/drops/document_drop.rb +69 -0
data/lib/ngage/jekyll/drops/drop.rb +209 -0
data/lib/ngage/jekyll/drops/excerpt_drop.rb +15 -0
data/lib/ngage/jekyll/drops/jekyll_drop.rb +32 -0
data/lib/ngage/jekyll/drops/site_drop.rb +56 -0
data/lib/ngage/jekyll/drops/static_file_drop.rb +14 -0
data/lib/ngage/jekyll/drops/unified_payload_drop.rb +26 -0
data/lib/ngage/jekyll/drops/url_drop.rb +89 -0
data/lib/ngage/jekyll/entry_filter.rb +127 -0
data/lib/ngage/jekyll/errors.rb +20 -0
data/lib/ngage/jekyll/excerpt.rb +180 -0
data/lib/ngage/jekyll/external.rb +76 -0
data/lib/ngage/jekyll/filters.rb +390 -0
data/lib/ngage/jekyll/filters/date_filters.rb +110 -0
data/lib/ngage/jekyll/filters/grouping_filters.rb +64 -0
data/lib/ngage/jekyll/filters/url_filters.rb +68 -0
data/lib/ngage/jekyll/frontmatter_defaults.rb +233 -0
data/lib/ngage/jekyll/generator.rb +5 -0
data/lib/ngage/jekyll/hooks.rb +106 -0
data/lib/ngage/jekyll/layout.rb +62 -0
data/lib/ngage/jekyll/liquid_extensions.rb +22 -0
data/lib/ngage/jekyll/liquid_renderer.rb +63 -0
data/lib/ngage/jekyll/liquid_renderer/file.rb +56 -0
data/lib/ngage/jekyll/liquid_renderer/table.rb +98 -0
data/lib/ngage/jekyll/log_adapter.rb +151 -0
data/lib/ngage/jekyll/mime.types +825 -0
data/lib/ngage/jekyll/page.rb +185 -0
data/lib/ngage/jekyll/page_without_a_file.rb +14 -0
data/lib/ngage/jekyll/plugin.rb +92 -0
data/lib/ngage/jekyll/plugin_manager.rb +115 -0
data/lib/ngage/jekyll/publisher.rb +23 -0
data/lib/ngage/jekyll/reader.rb +154 -0
data/lib/ngage/jekyll/readers/collection_reader.rb +22 -0
data/lib/ngage/jekyll/readers/data_reader.rb +75 -0
data/lib/ngage/jekyll/readers/layout_reader.rb +70 -0
data/lib/ngage/jekyll/readers/page_reader.rb +25 -0
data/lib/ngage/jekyll/readers/post_reader.rb +72 -0
data/lib/ngage/jekyll/readers/static_file_reader.rb +25 -0
data/lib/ngage/jekyll/readers/theme_assets_reader.rb +51 -0
data/lib/ngage/jekyll/regenerator.rb +195 -0
data/lib/ngage/jekyll/related_posts.rb +52 -0
data/lib/ngage/jekyll/renderer.rb +266 -0
data/lib/ngage/jekyll/site.rb +476 -0
data/lib/ngage/jekyll/static_file.rb +169 -0
data/lib/ngage/jekyll/stevenson.rb +60 -0
data/lib/ngage/jekyll/tags/highlight.rb +108 -0
data/lib/ngage/jekyll/tags/include.rb +226 -0
data/lib/ngage/jekyll/tags/link.rb +40 -0
data/lib/ngage/jekyll/tags/post_url.rb +104 -0
data/lib/ngage/jekyll/theme.rb +73 -0
data/lib/ngage/jekyll/theme_builder.rb +121 -0
data/lib/ngage/jekyll/url.rb +160 -0
data/lib/ngage/jekyll/utils.rb +370 -0
data/lib/ngage/jekyll/utils/ansi.rb +57 -0
data/lib/ngage/jekyll/utils/exec.rb +26 -0
data/lib/ngage/jekyll/utils/internet.rb +37 -0
data/lib/ngage/jekyll/utils/platforms.rb +82 -0
data/lib/ngage/jekyll/utils/thread_event.rb +31 -0
data/lib/ngage/jekyll/utils/win_tz.rb +75 -0
data/lib/ngage/site_template/.gitignore +5 -0
data/lib/ngage/site_template/404.html +25 -0
data/lib/ngage/site_template/_config.yml +47 -0
data/lib/ngage/site_template/_posts/0000-00-00-welcome-to-jekyll.markdown.erb +29 -0
data/lib/ngage/site_template/about.markdown +18 -0
data/lib/ngage/site_template/index.markdown +6 -0
data/lib/ngage/theme_template/CODE_OF_CONDUCT.md.erb +74 -0
data/lib/ngage/theme_template/Gemfile +4 -0
data/lib/ngage/theme_template/LICENSE.txt.erb +21 -0
data/lib/ngage/theme_template/README.md.erb +52 -0
data/lib/ngage/theme_template/_layouts/default.html +1 -0
data/lib/ngage/theme_template/_layouts/page.html +5 -0
data/lib/ngage/theme_template/_layouts/post.html +5 -0
data/lib/ngage/theme_template/example/_config.yml.erb +1 -0
data/lib/ngage/theme_template/example/_post.md +12 -0
data/lib/ngage/theme_template/example/index.html +14 -0
data/lib/ngage/theme_template/example/style.scss +7 -0
data/lib/ngage/theme_template/gitignore.erb +6 -0
data/lib/ngage/theme_template/theme.gemspec.erb +19 -0
data/lib/ngage/version.rb +5 -0
metadata +328 -0

data/lib/ngage/jekyll/commands/serve/servlet.rb ADDED

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+require "webrick"
+module Jekyll
+  module Commands
+    class Serve
+      # This class is used to determine if the Servlet should modify a served file
+      # to insert the LiveReload script tags
+      class SkipAnalyzer
+        BAD_USER_AGENTS = [%r!MSIE!].freeze
+        def self.skip_processing?(request, response, options)
+          new(request, response, options).skip_processing?
+        end
+        def initialize(request, response, options)
+          @options = options
+          @request = request
+          @response = response
+        end
+        def skip_processing?
+          !html? || chunked? || inline? || bad_browser?
+        end
+        def chunked?
+          @response["Transfer-Encoding"] == "chunked"
+        end
+        def inline?
+          @response["Content-Disposition"] =~ %r!^inline!
+        end
+        def bad_browser?
+          BAD_USER_AGENTS.any? { |pattern| @request["User-Agent"] =~ pattern }
+        end
+        def html?
+          @response["Content-Type"] =~ %r!text/html!
+        end
+      end
+      # This class inserts the LiveReload script tags into HTML as it is served
+      class BodyProcessor
+        HEAD_TAG_REGEX = %r!<head>|<head[^(er)][^<]*>!
+        attr_reader :content_length, :new_body, :livereload_added
+        def initialize(body, options)
+          @body = body
+          @options = options
+          @processed = false
+        end
+        def processed?
+          @processed
+        end
+        # rubocop:disable Metrics/MethodLength
+        def process!
+          @new_body = []
+          # @body will usually be a File object but Strings occur in rare cases
+          if @body.respond_to?(:each)
+            begin
+              @body.each { |line| @new_body << line.to_s }
+            ensure
+              @body.close
+            end
+          else
+            @new_body = @body.lines
+          end
+          @content_length = 0
+          @livereload_added = false
+          @new_body.each do |line|
+            if !@livereload_added && line["<head"]
+              line.gsub!(HEAD_TAG_REGEX) do |match|
+                %(#{match}#{template.result(binding)})
+              end
+              @livereload_added = true
+            end
+            @content_length += line.bytesize
+            @processed = true
+          end
+          @new_body = @new_body.join
+        end
+        # rubocop:enable Metrics/MethodLength
+        def template
+          # Unclear what "snipver" does. Doc at
+          # https://github.com/livereload/livereload-js states that the recommended
+          # setting is 1.
+          # Complicated JavaScript to ensure that livereload.js is loaded from the
+          # same origin as the page.  Mostly useful for dealing with the browser's
+          # distinction between 'localhost' and 127.0.0.1
+          template = <<-TEMPLATE
+          <script>
+            document.write(
+              '<script src="http://' +
+              (location.host || 'localhost').split(':')[0] +
+              ':<%=@options["livereload_port"] %>/livereload.js?snipver=1<%= livereload_args %>"' +
+              '></' +
+              'script>');
+          </script>
+          TEMPLATE
+          ERB.new(Jekyll::Utils.strip_heredoc(template))
+        end
+        def livereload_args
+          # XHTML standard requires ampersands to be encoded as entities when in
+          # attributes. See http://stackoverflow.com/a/2190292
+          src = ""
+          if @options["livereload_min_delay"]
+            src += "&amp;mindelay=#{@options["livereload_min_delay"]}"
+          end
+          if @options["livereload_max_delay"]
+            src += "&amp;maxdelay=#{@options["livereload_max_delay"]}"
+          end
+          src += "&amp;port=#{@options["livereload_port"]}" if @options["livereload_port"]
+          src
+        end
+      end
+      class Servlet < WEBrick::HTTPServlet::FileHandler
+        DEFAULTS = {
+          "Cache-Control" => "private, max-age=0, proxy-revalidate, " \
+            "no-store, no-cache, must-revalidate",
+        }.freeze
+        def initialize(server, root, callbacks)
+          # So we can access them easily.
+          @jekyll_opts = server.config[:JekyllOptions]
+          set_defaults
+          super
+        end
+        def search_index_file(req, res)
+          super ||
+            search_file(req, res, ".html") ||
+            search_file(req, res, ".xhtml")
+        end
+        # Add the ability to tap file.html the same way that Nginx does on our
+        # Docker images (or on GitHub Pages.) The difference is that we might end
+        # up with a different preference on which comes first.
+        def search_file(req, res, basename)
+          # /file.* > /file/index.html > /file.html
+          super ||
+            super(req, res, "#{basename}.html") ||
+            super(req, res, "#{basename}.xhtml")
+        end
+        # rubocop:disable Naming/MethodName
+        def do_GET(req, res)
+          rtn = super
+          if @jekyll_opts["livereload"]
+            return rtn if SkipAnalyzer.skip_processing?(req, res, @jekyll_opts)
+            processor = BodyProcessor.new(res.body, @jekyll_opts)
+            processor.process!
+            res.body = processor.new_body
+            res.content_length = processor.content_length.to_s
+            if processor.livereload_added
+              # Add a header to indicate that the page content has been modified
+              res["X-Rack-LiveReload"] = "1"
+            end
+          end
+          validate_and_ensure_charset(req, res)
+          res.header.merge!(@headers)
+          rtn
+        end
+        # rubocop:enable Naming/MethodName
+        private
+        def validate_and_ensure_charset(_req, res)
+          key = res.header.keys.grep(%r!content-type!i).first
+          typ = res.header[key]
+          unless typ =~ %r!;\s*charset=!
+            res.header[key] = "#{typ}; charset=#{@jekyll_opts["encoding"]}"
+          end
+        end
+        def set_defaults
+          hash_ = @jekyll_opts.fetch("webrick", {}).fetch("headers", {})
+          DEFAULTS.each_with_object(@headers = hash_) do |(key, val), hash|
+            hash[key] = val unless hash.key?(key)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ngage/jekyll/commands/serve/websockets.rb ADDED

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+require "http/parser"
+module Jekyll
+  module Commands
+    class Serve
+      # The LiveReload protocol requires the server to serve livereload.js over HTTP
+      # despite the fact that the protocol itself uses WebSockets.  This custom connection
+      # class addresses the dual protocols that the server needs to understand.
+      class HttpAwareConnection < EventMachine::WebSocket::Connection
+        attr_reader :reload_body, :reload_size
+        def initialize(_opts)
+          # If EventMachine SSL support on Windows ever gets better, the code below will
+          # set up the reactor to handle SSL
+          #
+          # @ssl_enabled = opts["ssl_cert"] && opts["ssl_key"]
+          # if @ssl_enabled
+          #   em_opts[:tls_options] = {
+          #   :private_key_file => Jekyll.sanitized_path(opts["source"], opts["ssl_key"]),
+          #   :cert_chain_file  => Jekyll.sanitized_path(opts["source"], opts["ssl_cert"])
+          #   }
+          #   em_opts[:secure] = true
+          # end
+          # This is too noisy even for --verbose, but uncomment if you need it for
+          # a specific WebSockets issue.  Adding ?LR-verbose=true onto the URL will
+          # enable logging on the client side.
+          # em_opts[:debug] = true
+          em_opts = {}
+          super(em_opts)
+          reload_file = File.join(Serve.singleton_class::LIVERELOAD_DIR, "livereload.js")
+          @reload_body = File.read(reload_file)
+          @reload_size = @reload_body.bytesize
+        end
+        # rubocop:disable Metrics/MethodLength
+        def dispatch(data)
+          parser = Http::Parser.new
+          parser << data
+          # WebSockets requests will have a Connection: Upgrade header
+          if parser.http_method != "GET" || parser.upgrade?
+            super
+          elsif parser.request_url =~ %r!^\/livereload.js!
+            headers = [
+              "HTTP/1.1 200 OK",
+              "Content-Type: application/javascript",
+              "Content-Length: #{reload_size}",
+              "",
+              "",
+            ].join("\r\n")
+            send_data(headers)
+            # stream_file_data would free us from keeping livereload.js in memory
+            # but JRuby blocks on that call and never returns
+            send_data(reload_body)
+            close_connection_after_writing
+          else
+            body = "This port only serves livereload.js over HTTP.\n"
+            headers = [
+              "HTTP/1.1 400 Bad Request",
+              "Content-Type: text/plain",
+              "Content-Length: #{body.bytesize}",
+              "",
+              "",
+            ].join("\r\n")
+            send_data(headers)
+            send_data(body)
+            close_connection_after_writing
+          end
+        end
+        # rubocop:enable Metrics/MethodLength
+      end
+    end
+  end
+end

data/lib/ngage/jekyll/configuration.rb ADDED

@@ -0,0 +1,391 @@
+# frozen_string_literal: true
+module Jekyll
+  class Configuration < Hash
+    # Default options. Overridden by values in _config.yml.
+    # Strings rather than symbols are used for compatibility with YAML.
+    DEFAULTS = Configuration[{
+      # Where things are
+      "source"              => Dir.pwd,
+      "destination"         => File.join(Dir.pwd, "_site"),
+      "collections_dir"     => "",
+      "cache_dir"           => ".jekyll-cache",
+      "plugins_dir"         => "_plugins",
+      "layouts_dir"         => "_layouts",
+      "data_dir"            => "_data",
+      "includes_dir"        => "_includes",
+      "collections"         => {},
+      # Handling Reading
+      "safe"                => false,
+      "include"             => [".htaccess"],
+      "exclude"             => %w(
+        Gemfile Gemfile.lock node_modules vendor/bundle/ vendor/cache/ vendor/gems/
+        vendor/ruby/
+      ),
+      "keep_files"          => [".git", ".svn"],
+      "encoding"            => "utf-8",
+      "markdown_ext"        => "markdown,mkdown,mkdn,mkd,md",
+      "strict_front_matter" => false,
+      # Filtering Content
+      "show_drafts"         => nil,
+      "limit_posts"         => 0,
+      "future"              => false,
+      "unpublished"         => false,
+      # Plugins
+      "whitelist"           => [],
+      "plugins"             => [],
+      # Conversion
+      "markdown"            => "kramdown",
+      "highlighter"         => "rouge",
+      "lsi"                 => false,
+      "excerpt_separator"   => "\n\n",
+      "incremental"         => false,
+      # Serving
+      "detach"              => false, # default to not detaching the server
+      "port"                => "4000",
+      "host"                => "127.0.0.1",
+      "baseurl"             => nil, # this mounts at /, i.e. no subdirectory
+      "show_dir_listing"    => false,
+      # Output Configuration
+      "permalink"           => "date",
+      "paginate_path"       => "/page:num",
+      "timezone"            => nil, # use the local timezone
+      "quiet"               => false,
+      "verbose"             => false,
+      "defaults"            => [],
+      "liquid"              => {
+        "error_mode"       => "warn",
+        "strict_filters"   => false,
+        "strict_variables" => false,
+      },
+      "kramdown"            => {
+        "auto_ids"      => true,
+        "toc_levels"    => "1..6",
+        "entity_output" => "as_char",
+        "smart_quotes"  => "lsquo,rsquo,ldquo,rdquo",
+        "input"         => "GFM",
+        "hard_wrap"     => false,
+        "footnote_nr"   => 1,
+        "show_warnings" => false,
+      },
+    }.map { |k, v| [k, v.freeze] }].freeze
+    class << self
+      # Static: Produce a Configuration ready for use in a Site.
+      # It takes the input, fills in the defaults where values do not
+      # exist, and patches common issues including migrating options for
+      # backwards compatiblity. Except where a key or value is being fixed,
+      # the user configuration will override the defaults.
+      #
+      # user_config - a Hash or Configuration of overrides.
+      #
+      # Returns a Configuration filled with defaults and fixed for common
+      # problems and backwards-compatibility.
+      def from(user_config)
+        Utils.deep_merge_hashes(DEFAULTS, Configuration[user_config].stringify_keys)
+          .add_default_collections
+      end
+    end
+    # Public: Turn all keys into string
+    #
+    # Return a copy of the hash where all its keys are strings
+    def stringify_keys
+      reduce({}) { |hsh, (k, v)| hsh.merge(k.to_s => v) }
+    end
+    def get_config_value_with_override(config_key, override)
+      override[config_key] || self[config_key] || DEFAULTS[config_key]
+    end
+    # Public: Directory of the Jekyll source folder
+    #
+    # override - the command-line options hash
+    #
+    # Returns the path to the Jekyll source directory
+    def source(override)
+      get_config_value_with_override("source", override)
+    end
+    def quiet(override = {})
+      get_config_value_with_override("quiet", override)
+    end
+    alias_method :quiet?, :quiet
+    def verbose(override = {})
+      get_config_value_with_override("verbose", override)
+    end
+    alias_method :verbose?, :verbose
+    def safe_load_file(filename)
+      case File.extname(filename)
+      when %r!\.toml!i
+        Jekyll::External.require_with_graceful_fail("tomlrb") unless defined?(Tomlrb)
+        Tomlrb.load_file(filename)
+      when %r!\.ya?ml!i
+        SafeYAML.load_file(filename) || {}
+      else
+        raise ArgumentError, "No parser for '#{filename}' is available.
+          Use a .y(a)ml or .toml file instead."
+      end
+    end
+    # Public: Generate list of configuration files from the override
+    #
+    # override - the command-line options hash
+    #
+    # Returns an Array of config files
+    def config_files(override)
+      # Adjust verbosity quickly
+      Jekyll.logger.adjust_verbosity(
+        :quiet   => quiet?(override),
+        :verbose => verbose?(override)
+      )
+      # Get configuration from <source>/_config.yml or <source>/<config_file>
+      config_files = override["config"]
+      if config_files.to_s.empty?
+        default = %w(yml yaml).find(-> { "yml" }) do |ext|
+          File.exist?(Jekyll.sanitized_path(source(override), "_config.#{ext}"))
+        end
+        config_files = Jekyll.sanitized_path(source(override), "_config.#{default}")
+        @default_config_file = true
+      end
+      Array(config_files)
+    end
+    # Public: Read configuration and return merged Hash
+    #
+    # file - the path to the YAML file to be read in
+    #
+    # Returns this configuration, overridden by the values in the file
+    def read_config_file(file)
+      next_config = safe_load_file(file)
+      check_config_is_hash!(next_config, file)
+      Jekyll.logger.info "Configuration file:", file
+      next_config
+    rescue SystemCallError
+      if @default_config_file ||= nil
+        Jekyll.logger.warn "Configuration file:", "none"
+        {}
+      else
+        Jekyll.logger.error "Fatal:", "The configuration file '#{file}'
+          could not be found."
+        raise LoadError, "The Configuration file '#{file}' could not be found."
+      end
+    end
+    # Public: Read in a list of configuration files and merge with this hash
+    #
+    # files - the list of configuration file paths
+    #
+    # Returns the full configuration, with the defaults overridden by the values in the
+    # configuration files
+    def read_config_files(files)
+      configuration = clone
+      begin
+        files.each do |config_file|
+          next if config_file.nil? || config_file.empty?
+          new_config = read_config_file(config_file)
+          configuration = Utils.deep_merge_hashes(configuration, new_config)
+        end
+      rescue ArgumentError => err
+        Jekyll.logger.warn "WARNING:", "Error reading configuration. " \
+                     "Using defaults (and options)."
+        warn err
+      end
+      configuration.backwards_compatibilize.add_default_collections
+    end
+    # Public: Split a CSV string into an array containing its values
+    #
+    # csv - the string of comma-separated values
+    #
+    # Returns an array of the values contained in the CSV
+    def csv_to_array(csv)
+      csv.split(",").map(&:strip)
+    end
+    # Public: Ensure the proper options are set in the configuration to allow for
+    # backwards-compatibility with Jekyll pre-1.0
+    #
+    # Returns the backwards-compatible configuration
+    def backwards_compatibilize
+      config = clone
+      # Provide backwards-compatibility
+      check_auto(config)
+      check_server(config)
+      check_plugins(config)
+      renamed_key "server_port", "port", config
+      renamed_key "gems", "plugins", config
+      renamed_key "layouts", "layouts_dir", config
+      renamed_key "data_source", "data_dir", config
+      check_pygments(config)
+      check_include_exclude(config)
+      check_coderay(config)
+      check_maruku(config)
+      config
+    end
+    # DEPRECATED.
+    def fix_common_issues
+      self
+    end
+    def add_default_collections
+      config = clone
+      # It defaults to `{}`, so this is only if someone sets it to null manually.
+      return config if config["collections"].nil?
+      # Ensure we have a hash.
+      if config["collections"].is_a?(Array)
+        config["collections"] = Hash[config["collections"].map { |c| [c, {}] }]
+      end
+      config["collections"] = Utils.deep_merge_hashes(
+        { "posts" => {} }, config["collections"]
+      ).tap do |collections|
+        collections["posts"]["output"] = true
+        if config["permalink"]
+          collections["posts"]["permalink"] ||= style_to_permalink(config["permalink"])
+        end
+      end
+      config
+    end
+    def renamed_key(old, new, config, _ = nil)
+      if config.key?(old)
+        Jekyll::Deprecator.deprecation_message "The '#{old}' configuration" \
+          " option has been renamed to '#{new}'. Please update your config" \
+          " file accordingly."
+        config[new] = config.delete(old)
+      end
+    end
+    private
+    def style_to_permalink(permalink_style)
+      case permalink_style.to_sym
+      when :pretty
+        "/:categories/:year/:month/:day/:title/"
+      when :none
+        "/:categories/:title:output_ext"
+      when :date
+        "/:categories/:year/:month/:day/:title:output_ext"
+      when :ordinal
+        "/:categories/:year/:y_day/:title:output_ext"
+      else
+        permalink_style.to_s
+      end
+    end
+    # Private: Checks if a given config is a hash
+    #
+    # extracted_config - the value to check
+    # file - the file from which the config was extracted
+    #
+    # Raises an ArgumentError if given config is not a hash
+    def check_config_is_hash!(extracted_config, file)
+      unless extracted_config.is_a?(Hash)
+        raise ArgumentError, "Configuration file: (INVALID) #{file}".yellow
+      end
+    end
+    def check_auto(config)
+      if config.key?("auto") || config.key?("watch")
+        Jekyll::Deprecator.deprecation_message "Auto-regeneration can no longer" \
+                            " be set from your configuration file(s). Use the" \
+                            " --[no-]watch/-w command-line option instead."
+        config.delete("auto")
+        config.delete("watch")
+      end
+    end
+    def check_server(config)
+      if config.key?("server")
+        Jekyll::Deprecator.deprecation_message "The 'server' configuration option" \
+                            " is no longer accepted. Use the 'jekyll serve'" \
+                            " subcommand to serve your site with WEBrick."
+        config.delete("server")
+      end
+    end
+    def check_pygments(config)
+      if config.key?("pygments")
+        Jekyll::Deprecator.deprecation_message "The 'pygments' configuration option" \
+                            " has been renamed to 'highlighter'. Please update your" \
+                            " config file accordingly. The allowed values are 'rouge', " \
+                            "'pygments' or null."
+        config["highlighter"] = "pygments" if config["pygments"]
+        config.delete("pygments")
+      end
+    end
+    def check_include_exclude(config)
+      %w(include exclude).each do |option|
+        if config[option].is_a?(String)
+          Jekyll::Deprecator.deprecation_message "The '#{option}' configuration option" \
+            " must now be specified as an array, but you specified" \
+            " a string. For now, we've treated the string you provided" \
+            " as a list of comma-separated values."
+          config[option] = csv_to_array(config[option])
+        end
+        config[option]&.map!(&:to_s)
+      end
+    end
+    def check_coderay(config)
+      if (config["kramdown"] || {}).key?("use_coderay")
+        Jekyll::Deprecator.deprecation_message "Please change 'use_coderay'" \
+          " to 'enable_coderay' in your configuration file."
+        config["kramdown"]["use_coderay"] = config["kramdown"].delete("enable_coderay")
+      end
+    end
+    def check_maruku(config)
+      if config.fetch("markdown", "kramdown").to_s.casecmp("maruku").zero?
+        Jekyll.logger.abort_with "Error:", "You're using the 'maruku' " \
+          "Markdown processor, which has been removed as of 3.0.0. " \
+          "We recommend you switch to Kramdown. To do this, replace " \
+          "`markdown: maruku` with `markdown: kramdown` in your " \
+          "`_config.yml` file."
+      end
+    end
+    # Private: Checks if the `plugins` config is a String
+    #
+    # config - the config hash
+    #
+    # Raises a Jekyll::Errors::InvalidConfigurationError if the config `plugins`
+    # is a string
+    def check_plugins(config)
+      if config.key?("plugins") && config["plugins"].is_a?(String)
+        Jekyll.logger.error "Configuration Error:", "You specified the" \
+          " `plugins` config in your configuration file as a string, please" \
+          " use an array instead. If you wanted to set the directory of your" \
+          " plugins, use the config key `plugins_dir` instead."
+        raise Jekyll::Errors::InvalidConfigurationError,
+              "'plugins' should not be a string, but was: " \
+              "#{config["plugins"].inspect}. Use 'plugins_dir' instead."
+      end
+    end
+  end
+end