jekyll 3.0.5 → 3.1.0.pre.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddbc11845878ea9db18f6417f18dd359b33e54da
-  data.tar.gz: 2c9c6dd7446f39fa3e71a3f85c39adbfdb418bac
+  metadata.gz: d1829f10339d166e837fcab131e2a71f8b7354ef
+  data.tar.gz: 9e9401c86a39df7af91aa72ce6f427fcbbff3c48
 SHA512:
-  metadata.gz: 3cb98db7e488b274d6a517b265832971543b9f60aaa145b646ca416ea5d7e1a02d27b9f236f90957952480c0b1141b1b3942d5c5427fdc6ef044e958dd8966ae
-  data.tar.gz: 8578324c400324af7915929d82e11390cfbd765e9ecf7f8fc9e4cf3f951c66730aff22c2ec29ce59798f4563afbd272371a896e59413173af78b20bc2098abed
+  metadata.gz: 57d2d84faf740f163963b8649ae08b1dc27f84352e4f9e6539bef4ce0eb20582efe75a15b16b05aab41369f2cdcab7b0d3f371bd6ab1b2cdeabcd31d0dfe504c
+  data.tar.gz: 440f77af890b49b98f74f389b204c0f3c920215ad366fab6727fcea45c562113a8decd99de82c5ce1fe5fb32ad8755727d5705ee60ffe663bb213de7cf2354be

data/README.markdown

@@ -3,7 +3,7 @@
 [![Gem Version](https://img.shields.io/gem/v/jekyll.svg)](https://rubygems.org/gems/jekyll)
 [![Build Status](https://img.shields.io/travis/jekyll/jekyll/master.svg)](https://travis-ci.org/jekyll/jekyll)
 [![Code Climate](https://img.shields.io/codeclimate/github/jekyll/jekyll.svg)](https://codeclimate.com/github/jekyll/jekyll)
-[![Dependency Status](https://img.shields.io/gemnasium/jekyll/jekyll.svg)](https://gemnasium.com/jekyll/jekyll)
+[![Dependency Status](https://gemnasium.com/jekyll/jekyll.svg)](https://gemnasium.com/jekyll/jekyll)
 [![Security](https://hakiri.io/github/jekyll/jekyll/master.svg)](https://hakiri.io/github/jekyll/jekyll/master)
 
 By Tom Preston-Werner, Nick Quaranto, Parker Moore, and many [awesome contributors](https://github.com/jekyll/jekyll/graphs/contributors)!

data/lib/jekyll.rb

@@ -16,6 +16,7 @@ end
 require 'rubygems'
 
 # stdlib
+require 'forwardable'
 require 'fileutils'
 require 'time'
 require 'English'
@@ -32,7 +33,6 @@ require 'colorator'
 SafeYAML::OPTIONS[:suppress_warnings] = true
 
 module Jekyll
-
   # internal requires
   autoload :Cleaner,             'jekyll/cleaner'
   autoload :Collection,          'jekyll/collection'
@@ -96,13 +96,14 @@ module Jekyll
     #
     # Returns the final configuration Hash.
     def configuration(override = Hash.new)
-      config = Configuration.new
+      config = Configuration[Configuration::DEFAULTS]
+      override = Configuration[override].stringify_keys
       unless override.delete('skip_config_files')
         config = config.read_config_files(config.config_files(override))
       end
 
       # Merge DEFAULTS < _config.yml < override
-      config = Configuration.from Utils.deep_merge_hashes(config, override).stringify_keys
+      config = Utils.deep_merge_hashes(config, override).stringify_keys
       set_timezone(config['timezone']) if config['timezone']
 
       config
@@ -152,9 +153,8 @@ module Jekyll
     def sanitized_path(base_directory, questionable_path)
       return base_directory if base_directory.eql?(questionable_path)
 
-      questionable_path.insert(0, '/') if questionable_path.start_with?('~')
       clean_path = File.expand_path(questionable_path, "/")
-      clean_path.sub!(/\A\w\:\//, '/')
+      clean_path = clean_path.sub(/\A\w\:\//, '/')
 
       unless clean_path.start_with?(base_directory.sub(/\A\w\:\//, '/'))
         File.join(base_directory, clean_path)
@@ -172,6 +172,7 @@ end
 require_all 'jekyll/commands'
 require_all 'jekyll/converters'
 require_all 'jekyll/converters/markdown'
+require_all 'jekyll/drops'
 require_all 'jekyll/generators'
 require_all 'jekyll/tags'
 

data/lib/jekyll/cleaner.rb

@@ -40,7 +40,7 @@ module Jekyll
       regex = keep_file_regex
       dirs = keep_dirs
 
-      Dir.glob(site.in_dest_dir("**", "*"), File::FNM_DOTMATCH) do |file|
+      Utils.safe_glob(site.in_dest_dir, ["**", "*"], File::FNM_DOTMATCH).each do |file|
         next if file =~ HIDDEN_FILE_REGEX || file =~ regex || dirs.include?(file)
         files << file
       end

data/lib/jekyll/collection.rb

@@ -32,7 +32,7 @@ module Jekyll
     # Override of method_missing to check in @data for the key.
     def method_missing(method, *args, &blck)
       if docs.respond_to?(method.to_sym)
-        Jekyll.logger.warn "Deprecation:", "Collection##{method} should be called on the #docs array directly."
+        Jekyll.logger.warn "Deprecation:", "#{label}.#{method} should be changed to #{label}.docs.#{method}."
         Jekyll.logger.warn "", "Called by #{caller.first}."
         docs.public_send(method.to_sym, *args, &blck)
       else
@@ -58,7 +58,11 @@ module Jekyll
         if Utils.has_yaml_header? full_path
           doc = Jekyll::Document.new(full_path, { site: site, collection: self })
           doc.read
-          docs << doc if site.publisher.publish?(doc) || !write?
+          if site.publisher.publish?(doc) || !write?
+            docs << doc
+          else
+            Jekyll.logger.debug "Skipped From Publishing:", doc.relative_path
+          end
         else
           relative_dir = Jekyll.sanitized_path(relative_directory, File.dirname(file_path)).chomp("/.")
           files << StaticFile.new(site, site.source, relative_dir, File.basename(full_path), self)
@@ -74,7 +78,7 @@ module Jekyll
     def entries
       return Array.new unless exists?
       @entries ||=
-        Dir.glob(collection_dir("**", "*.*")).map do |entry|
+        Utils.safe_glob(collection_dir, ["**", "*.*"]).map do |entry|
           entry["#{collection_dir}/"] = ''; entry
         end
     end
@@ -166,14 +170,7 @@ module Jekyll
     #
     # Returns a representation of this collection for use in Liquid.
     def to_liquid
-      metadata.merge({
-        "label"     => label,
-        "docs"      => docs,
-        "files"     => files,
-        "directory" => directory,
-        "output"    => write?,
-        "relative_directory" => relative_directory
-      })
+      Drops::CollectionDrop.new self
     end
 
     # Whether the collection's documents ought to be written as individual

data/lib/jekyll/commands/clean.rb

@@ -10,8 +10,8 @@ module Jekyll
 
             add_build_options(c)
 
-            c.action do |args, _|
-              Jekyll::Commands::Clean.process({})
+            c.action do |args, options|
+              Jekyll::Commands::Clean.process(options)
             end
           end
         end

data/lib/jekyll/commands/doctor.rb

@@ -32,7 +32,8 @@ module Jekyll
           [
             fsnotify_buggy?(site),
             !deprecated_relative_permalinks(site),
-            !conflicting_urls(site)
+            !conflicting_urls(site),
+            !urls_only_differ_by_case(site)
           ].all?
         end
 
@@ -76,6 +77,20 @@ module Jekyll
           true
         end
 
+        def urls_only_differ_by_case(site)
+          urls_only_differ_by_case = false
+          urls = case_insensitive_urls(site.pages + site.docs_to_write, site.dest)
+          urls.each do |case_insensitive_url, real_urls|
+            if real_urls.uniq.size > 1
+              urls_only_differ_by_case = true
+              Jekyll.logger.warn "Warning:", "The following URLs only differ" +
+                " by case. On a case-insensitive file system one of the URLs" +
+                " will be overwritten by the other: #{real_urls.join(", ")}"
+            end
+          end
+          urls_only_differ_by_case
+        end
+
         private
         def collect_urls(urls, things, destination)
           things.each do |thing|
@@ -89,6 +104,13 @@ module Jekyll
           urls
         end
 
+        def case_insensitive_urls(things, destination)
+          things.inject(Hash.new) do |memo, thing|
+            dest = thing.destination(destination)
+            (memo[dest.downcase] ||= []) << dest
+            memo
+          end
+        end
       end
 
     end

data/lib/jekyll/commands/serve.rb

@@ -1,151 +1,196 @@
-# -*- encoding: utf-8 -*-
 module Jekyll
   module Commands
     class Serve < Command
-
       class << self
+        COMMAND_OPTIONS = {
+          "ssl_cert" => ["--ssl-cert [CERT]", "X.509 (SSL) certificate."],
+          "host"     => ["host", "-H", "--host [HOST]", "Host to bind to"],
+          "open_url" => ["-o", "--open-url", "Launch your browser with your site."],
+          "detach"   => ["-B", "--detach", "Run the server in the background (detach)"],
+          "ssl_key"  => ["--ssl-key [KEY]", "X.509 (SSL) Private Key."],
+          "port"     => ["-P", "--port [PORT]", "Port to listen on"],
+          "baseurl"  => ["-b", "--baseurl [URL]", "Base URL"],
+          "skip_initial_build" => ["skip_initial_build", "--skip-initial-build",
+            "Skips the initial site build which occurs before the server is started."]
+        }
+
+        #
 
         def init_with_program(prog)
-          prog.command(:serve) do |c|
-            c.syntax 'serve [options]'
-            c.description 'Serve your site locally'
-            c.alias :server
-            c.alias :s
-
-            add_build_options(c)
-
-            c.option 'detach', '-B', '--detach', 'Run the server in the background (detach)'
-            c.option 'port', '-P', '--port [PORT]', 'Port to listen on'
-            c.option 'host', '-H', '--host [HOST]', 'Host to bind to'
-            c.option 'baseurl', '-b', '--baseurl [URL]', 'Base URL'
-            c.option 'skip_initial_build', '--skip-initial-build', 'Skips the initial site build which occurs before the server is started.'
-
-            c.action do |args, options|
-              options["serving"] = true
-              options["watch"] = true unless options.key?("watch")
-              Jekyll::Commands::Build.process(options)
-              Jekyll::Commands::Serve.process(options)
+          prog.command(:serve) do |cmd|
+            cmd.description "Serve your site locally"
+            cmd.syntax "serve [options]"
+            cmd.alias :server
+            cmd.alias :s
+
+            add_build_options(cmd)
+            COMMAND_OPTIONS.each do |key, val|
+              cmd.option key, *val
+            end
+
+            cmd.action do |_, opts|
+              opts["serving"] = true
+              opts["watch"  ] = true unless opts.key?("watch")
+              Build.process(opts)
+              Serve.process(opts)
             end
           end
         end
 
-        # Boot up a WEBrick server which points to the compiled site's root.
-        def process(options)
-          options = configuration_from_options(options)
-          destination = options['destination']
-          setup(destination)
+        #
 
-          s = WEBrick::HTTPServer.new(webrick_options(options))
-          s.unmount("")
-
-          s.mount(
-            options['baseurl'],
-            custom_file_handler,
-            destination,
-            file_handler_options
-          )
-
-          Jekyll.logger.info "Server address:", server_address(s, options)
+        def process(opts)
+          opts = configuration_from_options(opts)
+          destination = opts["destination"]
+          setup(destination)
 
-          if options['detach'] # detach the server
-            pid = Process.fork { s.start }
-            Process.detach(pid)
-            Jekyll.logger.info "Server detached with pid '#{pid}'.", "Run `pkill -f jekyll' or `kill -9 #{pid}' to stop the server."
-          else # create a new server thread, then join it with current terminal
-            t = Thread.new { s.start }
-            trap("INT") { s.shutdown }
-            t.join
-          end
+          server = WEBrick::HTTPServer.new(webrick_opts(opts)).tap { |o| o.unmount("") }
+          server.mount(opts["baseurl"], Servlet, destination, file_handler_opts)
+          Jekyll.logger.info "Server address:", server_address(server, opts)
+          launch_browser server, opts if opts["open_url"]
+          boot_or_detach server, opts
         end
 
+        # Do a base pre-setup of WEBRick so that everything is in place
+        # when we get ready to party, checking for an setting up an error page
+        # and making sure our destination exists.
+
+        private
         def setup(destination)
-          require 'webrick'
+          require_relative "serve/servlet"
 
           FileUtils.mkdir_p(destination)
-
-          # monkey patch WEBrick using custom 404 page (/404.html)
-          if File.exist?(File.join(destination, '404.html'))
+          if File.exist?(File.join(destination, "404.html"))
             WEBrick::HTTPResponse.class_eval do
               def create_error_page
-                @header['content-type'] = "text/html; charset=UTF-8"
-                @body = IO.read(File.join(@config[:DocumentRoot], '404.html'))
+                @header["Content-Type"] = "text/html; charset=UTF-8"
+                @body = IO.read(File.join(@config[:DocumentRoot], "404.html"))
               end
             end
           end
         end
 
-        def webrick_options(config)
+        #
+
+        private
+        def webrick_opts(opts)
           opts = {
-            :BindAddress        => config['host'],
-            :DirectoryIndex     => %w(index.html index.htm index.cgi index.rhtml index.xml),
-            :DocumentRoot       => config['destination'],
+            :JekyllOptions      => opts,
             :DoNotReverseLookup => true,
             :MimeTypes          => mime_types,
-            :Port               => config['port'],
-            :StartCallback      => start_callback(config['detach'])
+            :DocumentRoot       => opts["destination"],
+            :StartCallback      => start_callback(opts["detach"]),
+            :BindAddress        => opts["host"],
+            :Port               => opts["port"],
+            :DirectoryIndex     => %W(
+              index.htm
+              index.html
+              index.rhtml
+              index.cgi
+              index.xml
+            )
           }
 
-          if config['verbose']
-            opts.merge!({
-              :Logger => WEBrick::Log.new($stdout, WEBrick::Log::DEBUG)
-            })
+          enable_ssl(opts)
+          enable_logging(opts)
+          opts
+        end
+
+        # Recreate NondisclosureName under utf-8 circumstance
+
+        private
+        def file_handler_opts
+          WEBrick::Config::FileHandler.merge({
+            :FancyIndexing     => true,
+            :NondisclosureName => [
+              '.ht*','~*'
+            ]
+          })
+        end
+
+        #
+
+        private
+        def server_address(server, opts)
+          address = server.config[:BindAddress]
+          baseurl = "#{opts["baseurl"]}/" if opts["baseurl"]
+          port = server.config[:Port]
+
+          "http://#{address}:#{port}#{baseurl}"
+        end
+
+        #
+
+        private
+        def launch_browser(server, opts)
+          command = Utils::Platforms.windows?? "start" : Utils::Platforms.osx?? "open" : "xdg-open"
+          system command, server_address(server, opts)
+        end
+
+        # Keep in our area with a thread or detach the server as requested
+        # by the user.  This method determines what we do based on what you
+        # ask us to do.
+
+        private
+        def boot_or_detach(server, opts)
+          if opts["detach"]
+            pid = Process.fork do
+              server.start
+            end
+
+            Process.detach(pid)
+            Jekyll.logger.info "Server detached with pid '#{pid}'.", \
+              "Run `pkill -f jekyll' or `kill -9 #{pid}' to stop the server."
           else
-            opts.merge!({
-              :AccessLog => [],
-              :Logger => WEBrick::Log.new([], WEBrick::Log::WARN)
-            })
+            t = Thread.new { server.start }
+            trap("INT") { server.shutdown }
+            t.join
           end
+        end
 
-          opts
+        # Make the stack verbose if the user requests it.
+
+        private
+        def enable_logging(opts)
+          opts[:AccessLog] = []
+          level = WEBrick::Log.const_get(opts[:JekyllOptions]["verbose"] ? :DEBUG : :WARN)
+          opts[:Logger] = WEBrick::Log.new($stdout, level)
         end
 
-        # Custom WEBrick FileHandler servlet for serving "/file.html" at "/file"
-        # when no exact match is found. This mirrors the behavior of GitHub
-        # Pages and many static web server configs.
-        def custom_file_handler
-          Class.new WEBrick::HTTPServlet::FileHandler do
-            def search_file(req, res, basename)
-              if file = super
-                file
-              else
-                super(req, res, "#{basename}.html")
-              end
-            end
+        # Add SSL to the stack if the user triggers --enable-ssl and they
+        # provide both types of certificates commonly needed.  Raise if they
+        # forget to add one of the certificates.
+
+        private
+        def enable_ssl(opts)
+          return if !opts[:JekyllOptions]["ssl_cert"] && !opts[:JekyllOptions]["ssl_key"]
+          if !opts[:JekyllOptions]["ssl_cert"] || !opts[:JekyllOptions]["ssl_key"]
+            raise RuntimeError, "--ssl-cert or --ssl-key missing."
           end
+
+          require "openssl"; require "webrick/https"
+          source_key = Jekyll.sanitized_path(opts[:JekyllOptions]["source"], opts[:JekyllOptions]["ssl_key" ])
+          source_certificate = Jekyll.sanitized_path(opts[:JekyllOptions]["source"], opts[:JekyllOptions]["ssl_cert"])
+          opts[:SSLCertificate] = OpenSSL::X509::Certificate.new(File.read(source_certificate))
+          opts[:SSLPrivateKey ] = OpenSSL::PKey::RSA.new(File.read(source_key))
+          opts[:EnableSSL] = true
         end
 
+        private
         def start_callback(detached)
           unless detached
-            Proc.new { Jekyll.logger.info "Server running...", "press ctrl-c to stop." }
+            proc do
+              Jekyll.logger.info("Server running...", "press ctrl-c to stop.")
+            end
           end
         end
 
+        private
         def mime_types
-          mime_types_file = File.expand_path('../mime.types', File.dirname(__FILE__))
-          WEBrick::HTTPUtils::load_mime_types(mime_types_file)
-        end
-
-        def server_address(server, options)
-          baseurl = "#{options['baseurl']}/" if options['baseurl']
-          [
-            "http://",
-            server.config[:BindAddress],
-            ":",
-            server.config[:Port],
-            baseurl || ""
-          ].map(&:to_s).join("")
-        end
-
-        # recreate NondisclosureName under utf-8 circumstance
-        def file_handler_options
-          WEBrick::Config::FileHandler.merge({
-            :FancyIndexing     => true,
-            :NondisclosureName => ['.ht*','~*']
-          })
+          file = File.expand_path('../mime.types', File.dirname(__FILE__))
+          WEBrick::HTTPUtils.load_mime_types(file)
         end
-
       end
-
     end
   end
 end