jekyll 3.1.6 → 3.2.0.pre.beta1

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

@@ -7,7 +7,7 @@ module Jekyll
         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.
@@ -25,8 +25,7 @@ module Jekyll
           super || super(req, res, "#{basename}.html")
         end
 
-        #
-
+        # rubocop:disable Style/MethodName
         def do_GET(req, res)
           rtn = super
           validate_and_ensure_charset(req, res)

data/lib/jekyll/configuration.rb

@@ -44,6 +44,7 @@ module Jekyll
       'port'          => '4000',
       'host'          => '127.0.0.1',
       'baseurl'       => '',
+      'show_dir_listing' => false,
 
       # Output Configuration
       'permalink'     => 'date',
@@ -71,24 +72,7 @@ module Jekyll
         'hard_wrap'      => false,
         'footnote_nr'    => 1
       }
-    }.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).
-          fix_common_issues.add_default_collections
-      end
-    end
+    }]
 
     # Public: Turn all keys into string
     #
@@ -165,7 +149,7 @@ module Jekyll
       Jekyll.logger.info "Configuration file:", file
       next_config
     rescue SystemCallError
-      if @default_config_file
+      if @default_config_file ||= nil
         Jekyll.logger.warn "Configuration file:", "none"
         {}
       else
@@ -185,7 +169,6 @@ module Jekyll
 
       begin
         files.each do |config_file|
-          next if config_file.nil? or config_file.empty?
           new_config = read_config_file(config_file)
           configuration = Utils.deep_merge_hashes(configuration, new_config)
         end
@@ -245,6 +228,7 @@ module Jekyll
       end
 
       %w(include exclude).each do |option|
+        config[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" \
@@ -252,7 +236,7 @@ module Jekyll
             " as a list of comma-separated values."
           config[option] = csv_to_array(config[option])
         end
-        config[option].map!(&:to_s) if config[option]
+        config[option].map!(&:to_s)
       end
 
       if (config['kramdown'] || {}).key?('use_coderay')
@@ -287,22 +271,14 @@ module Jekyll
     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['collections']['posts'] ||= {}
+      config['collections']['posts']['output'] = true
+      config['collections']['posts']['permalink'] = style_to_permalink(config['permalink'])
 
       config
     end
@@ -310,8 +286,8 @@ module Jekyll
     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."
+          " option has been renamed to '#{new}'. Please update your config" \
+          " file accordingly."
         config[new] = config.delete(old)
       end
     end

data/lib/jekyll/converter.rb

@@ -8,7 +8,9 @@ module Jekyll
     #
     # Returns the String prefix.
     def self.highlighter_prefix(highlighter_prefix = nil)
-      @highlighter_prefix = highlighter_prefix if highlighter_prefix
+      if !defined?(@highlighter_prefix) || !highlighter_prefix.nil?
+        @highlighter_prefix = highlighter_prefix
+      end
       @highlighter_prefix
     end
 
@@ -20,7 +22,9 @@ module Jekyll
     #
     # Returns the String suffix.
     def self.highlighter_suffix(highlighter_suffix = nil)
-      @highlighter_suffix = highlighter_suffix if highlighter_suffix
+      if !defined?(@highlighter_suffix) || !highlighter_suffix.nil?
+        @highlighter_suffix = highlighter_suffix
+      end
       @highlighter_suffix
     end
 

data/lib/jekyll/converters/markdown.rb

@@ -6,7 +6,7 @@ module Jekyll
       safe true
 
       def setup
-        return if @setup
+        return if @setup ||= false
         unless (@parser = get_processor)
           Jekyll.logger.error "Invalid Markdown processor given:", @config["markdown"]
           Jekyll.logger.info  "", "Custom processors are not loaded in safe mode" if @config["safe"]

data/lib/jekyll/converters/markdown/kramdown_parser.rb

@@ -18,6 +18,7 @@ module Jekyll
           Jekyll::External.require_with_graceful_fail "kramdown"
           @main_fallback_highlighter = config["highlighter"] || "rouge"
           @config = config["kramdown"] || {}
+          @highlighter = nil
           setup
         end
 

data/lib/jekyll/convertible.rb

@@ -39,9 +39,9 @@ module Jekyll
       filename = File.join(base, name)
 
       begin
-        self.content = File.read(site.in_source_dir(base, name),
+        self.content = File.read(@path || site.in_source_dir(base, name),
                                  Utils.merged_file_read_opts(site, opts))
-        if content =~ /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m
+        if content =~ Document::YAML_FRONT_MATTER_REGEXP
           self.content = $POSTMATCH
           self.data = SafeYAML.load(Regexp.last_match(1))
         end
@@ -209,18 +209,15 @@ module Jekyll
 
       used = Set.new([layout])
 
-      # Reset the payload layout data to ensure it starts fresh for each page.
-      payload["layout"] = nil
-
       while layout
         Jekyll.logger.debug "Rendering Layout:", path
         payload["content"] = output
-        payload["layout"]  = Utils.deep_merge_hashes(layout.data, payload["layout"] || {})
+        payload["layout"]  = Utils.deep_merge_hashes(payload["layout"] || {}, layout.data)
 
         self.output = render_liquid(layout.content,
-                                         payload,
-                                         info,
-                                         File.join(site.config['layouts_dir'], layout.name))
+                                    payload,
+                                    info,
+                                    layout.relative_path)
 
         # Add layout to dependency tree
         site.regenerator.add_dependency(

data/lib/jekyll/document.rb

@@ -68,7 +68,11 @@ module Jekyll
     end
 
     def date
-      data['date'] ||= site.time
+      data['date'] ||= (draft? ? source_file_mtime : site.time)
+    end
+
+    def source_file_mtime
+      @source_file_mtime ||= File.mtime(path)
     end
 
     # Returns whether the document is a draft. This is only the case if

data/lib/jekyll/drops/document_drop.rb

@@ -5,12 +5,10 @@ module Jekyll
     class DocumentDrop < Drop
       extend Forwardable
 
-      NESTED_OBJECT_FIELD_BLACKLIST = %w{
-        content output excerpt next previous
-      }.freeze
-
       mutable false
 
+      def_delegator :@obj, :next_doc, :next
+      def_delegator :@obj, :previous_doc, :previous
       def_delegator :@obj, :relative_path, :path
       def_delegators :@obj, :id, :output, :content, :to_s, :relative_path, :url
 
@@ -22,35 +20,11 @@ module Jekyll
         fallback_data['excerpt'].to_s
       end
 
-      def previous
-        @obj.previous_doc.to_liquid
-      end
-
-      def next
-        @obj.next_doc.to_liquid
-      end
-
-      # Generate a Hash for use in generating JSON.
-      # This is useful if fields need to be cleared before the JSON can generate.
-      #
-      # Returns a Hash ready for JSON generation.
-      def hash_for_json(state = nil)
-        to_h.tap do |hash|
-          if state && state.depth >= 2
-            hash["previous"] = collapse_document(hash["previous"]) if hash["previous"]
-            hash["next"]     = collapse_document(hash["next"]) if hash["next"]
-          end
-        end
-      end
-
-      # Generate a Hash which breaks the recursive chain.
-      # Certain fields which are normally available are omitted.
-      #
-      # Returns a Hash with only non-recursive fields present.
-      def collapse_document(doc)
-        doc.keys.each_with_object({}) do |(key, _), result|
-          result[key] = doc[key] unless NESTED_OBJECT_FIELD_BLACKLIST.include?(key)
-        end
+      def <=>(other)
+        return nil unless other.is_a? DocumentDrop
+        cmp = self['date'] <=> other['date']
+        cmp = self['path'] <=> other['path'] if cmp.nil? || cmp == 0
+        cmp
       end
 
       private

data/lib/jekyll/drops/drop.rb

@@ -3,9 +3,7 @@
 module Jekyll
   module Drops
     class Drop < Liquid::Drop
-      include Enumerable
-
-      NON_CONTENT_METHODS = [:fallback_data, :collapse_document].freeze
+      NON_CONTENT_METHODS = [:[], :[]=, :inspect, :to_h, :fallback_data].freeze
 
       # Get or set whether the drop class is mutable.
       # Mutability determines whether or not pre-defined fields may be
@@ -88,7 +86,7 @@ module Jekyll
       # Returns an Array of strings which represent method-specific keys.
       def content_methods
         @content_methods ||= (
-          self.class.instance_methods - Jekyll::Drops::Drop.instance_methods - NON_CONTENT_METHODS
+          self.class.instance_methods(false) - NON_CONTENT_METHODS
         ).map(&:to_s).reject do |method|
           method.end_with?("=")
         end
@@ -140,22 +138,6 @@ module Jekyll
         JSON.pretty_generate to_h
       end
 
-      # Generate a Hash for use in generating JSON.
-      # This is useful if fields need to be cleared before the JSON can generate.
-      #
-      # Returns a Hash ready for JSON generation.
-      def hash_for_json(state = nil)
-        to_h
-      end
-
-      # Generate a JSON representation of the Drop.
-      #
-      # Returns a JSON representation of the Drop in a String.
-      def to_json(state = nil)
-        require 'json'
-        JSON.generate(hash_for_json(state), state)
-      end
-
       # Collects all the keys and passes each to the block in turn.
       #
       # block - a block which accepts one argument, the key
@@ -165,12 +147,6 @@ module Jekyll
         keys.each(&block)
       end
 
-      def each(&block)
-        each_key.each do |key|
-          yield key, self[key]
-        end
-      end
-
       def merge(other, &block)
         self.dup.tap do |me|
           if block.nil?

data/lib/jekyll/drops/jekyll_drop.rb

@@ -16,18 +16,6 @@ module Jekyll
       def environment
         Jekyll.env
       end
-
-      def to_h
-        @to_h ||= {
-          "version" => version,
-          "environment" => environment
-        }
-      end
-
-      def to_json(state = nil)
-        require 'json'
-        JSON.generate(to_h, state)
-      end
     end
   end
 end

data/lib/jekyll/drops/site_drop.rb

@@ -28,7 +28,7 @@ module Jekyll
       end
 
       def collections
-        @site_collections ||= @obj.collections.values.sort_by(&:label).map(&:to_liquid)
+        @site_collections ||= @obj.collections.values.map(&:to_liquid)
       end
 
       private

data/lib/jekyll/entry_filter.rb

@@ -1,12 +1,15 @@
 module Jekyll
   class EntryFilter
-    SPECIAL_LEADING_CHARACTERS = ['.', '_', '#'].freeze
-
     attr_reader :site
+    SPECIAL_LEADING_CHARACTERS = [
+      '.', '_', '#', '~'
+    ].freeze
 
     def initialize(site, base_directory = nil)
       @site = site
-      @base_directory = derive_base_directory(@site, base_directory.to_s.dup)
+      @base_directory = derive_base_directory(
+        @site, base_directory.to_s.dup
+      )
     end
 
     def base_directory
@@ -14,14 +17,14 @@ module Jekyll
     end
 
     def derive_base_directory(site, base_dir)
-      if base_dir.start_with?(site.source)
-        base_dir[site.source] = ""
-      end
+      base_dir[site.source] = "" if base_dir.start_with?(site.source)
       base_dir
     end
 
     def relative_to_source(entry)
-      File.join(base_directory, entry)
+      File.join(
+        base_directory, entry
+      )
     end
 
     def filter(entries)
@@ -33,7 +36,9 @@ module Jekyll
     end
 
     def included?(entry)
-      glob_include?(site.include, entry)
+      glob_include?(site.include,
+        entry
+      )
     end
 
     def special?(entry)
@@ -51,21 +56,62 @@ module Jekyll
       excluded
     end
 
+    # --
+    # Check if a file is a symlink.
+    # NOTE: This can be converted to allowing even in safe,
+    #   since we use Pathutil#in_path? now.
+    # --
     def symlink?(entry)
-      File.symlink?(entry) && site.safe
+      site.safe && File.symlink?(entry) && symlink_outside_site_source?(entry)
     end
 
-    def ensure_leading_slash(path)
-      path[0..0] == "/" ? path : "/#{path}"
+    # --
+    # NOTE: Pathutil#in_path? gets the realpath.
+    # @param [<Anything>] entry the entry you want to validate.
+    # Check if a path is outside of our given root.
+    # --
+    def symlink_outside_site_source?(entry)
+      !Pathutil.new(entry).in_path?(
+        site.in_source_dir
+      )
     end
 
+    # --
+    # Check if an entry matches a specific pattern and return true,false.
     # Returns true if path matches against any glob pattern.
-    # Look for more detail about glob pattern in method File::fnmatch.
+    # --
     def glob_include?(enum, e)
-      entry = ensure_leading_slash(e)
+      entry = Pathutil.new(site.in_source_dir).join(e)
       enum.any? do |exp|
-        item = ensure_leading_slash(exp)
-        File.fnmatch?(item, entry) || entry.start_with?(item)
+
+        # Users who send a Regexp knows what they want to
+        # exclude, so let them send a Regexp to exclude files,
+        # we will not bother caring if it works or not, it's
+        # on them at this point.
+
+        if exp.is_a?(Regexp)
+          entry =~ exp
+
+        else
+          item = Pathutil.new(site.in_source_dir).join(exp)
+
+          # If it's a directory they want to exclude, AKA
+          # ends with a "/" then we will go on to check and
+          # see if the entry falls within that path and
+          # exclude it if that's the case.
+
+          if e.end_with?("/")
+            entry.in_path?(
+              item
+            )
+
+          else
+            File.fnmatch?(item, entry) ||
+              entry.to_path.start_with?(
+                item
+              )
+          end
+        end
       end
     end
   end