Release 💎 3.0.3

Release v3.0.3

History.markdown

@@ -1,4 +1,18 @@
-## HEAD
+## 3.0.3 / 2016-02-08
+
+### Bug Fixes
+
+* Fix extension weirdness with folders (#4493)
+* EntryFilter: only include 'excluded' log on excluded files (#4479)
+* `Jekyll.sanitized_path`: escape tildes before sanitizing a questionable path (#4468)
+* `LiquidRenderer#parse`: parse with line numbers (#4453)
+* `Document#<=>`: protect against nil comparison in dates. (#4446)
+
+## 3.0.2 / 2016-01-20
+
+### Bug Fixes
+
+  * Document: throw a useful error when an invalid date is given (#4378)
 
 ### Development Fixes
 

Rakefile

@@ -288,13 +288,13 @@ end
 
 desc "Release #{name} v#{version}"
 task :release => :build do
-  unless `git branch` =~ /^\* master$/
-    puts "You must be on the master branch to release!"
+  unless `git branch` =~ /^\* 3\.0-stable$/
+    puts "You must be on the 3.0-stable branch to release!"
     exit!
   end
   sh "git commit --allow-empty -m 'Release :gem: #{version}'"
   sh "git tag v#{version}"
-  sh "git push origin master"
+  sh "git push origin 3.0-stable"
   sh "git push origin v#{version}"
   sh "gem push pkg/#{name}-#{version}.gem"
 end
@@ -315,8 +315,8 @@ end
 namespace :docs do
   desc "Release #{docs_name} v#{version}"
   task :release => :build do
-    unless `git branch` =~ /^\* master$/
-      puts "You must be on the master branch to release!"
+  unless `git branch` =~ /^\* 3\.0-stable$/
+    puts "You must be on the 3.0-stable branch to release!"
       exit!
     end
     sh "gem push pkg/#{docs_name}-#{version}.gem"

features/post_data.feature

@@ -36,6 +36,20 @@ Feature: Post data
     Then the _site directory should exist
     And I should see "Post date: 27 Mar 2009" in "_site/2009/03/27/star-wars.html"
 
+  Scenario: Use post.date variable with invalid
+    Given I have a _posts directory
+    And I have a "_posts/2016-01-01-test.md" page with date "tuesday" that contains "I have a bad date."
+    When I run jekyll build
+    Then the _site directory should not exist
+    And I should see "Document '_posts/2016-01-01-test.md' does not have a valid date in the YAML front matter." in the build output
+
+  Scenario: Invalid date in filename
+    Given I have a _posts directory
+    And I have a "_posts/2016-22-01-test.md" page that contains "I have a bad date."
+    When I run jekyll build
+    Then the _site directory should not exist
+    And I should see "Document '_posts/2016-22-01-test.md' does not have a valid date in the filename." in the build output
+
   Scenario: Use post.id variable
     Given I have a _posts directory
     And I have a _layouts directory

lib/jekyll.rb

@@ -153,8 +153,9 @@ 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 = clean_path.sub(/\A\w\:\//, '/')
+      clean_path.sub!(/\A\w\:\//, '/')
 
       unless clean_path.start_with?(base_directory.sub(/\A\w\:\//, '/'))
         File.join(base_directory, clean_path)

lib/jekyll/document.rb

@@ -58,7 +58,7 @@ module Jekyll
     # Merge some data in with this document's data.
     #
     # Returns the merged data.
-    def merge_data!(other)
+    def merge_data!(other, source: "YAML front matter")
       if other.key?('categories') && !other['categories'].nil?
         if other['categories'].is_a?(String)
           other['categories'] = other['categories'].split(" ").map(&:strip)
@@ -67,7 +67,7 @@ module Jekyll
       end
       Utils.deep_merge_hashes!(data, other)
       if data.key?('date') && !data['date'].is_a?(Time)
-         data['date'] = Utils.parse_date(data['date'].to_s, "Document '#{relative_path}' does not have a valid date in the YAML front matter.")
+        data['date'] = Utils.parse_date(data['date'].to_s, "Document '#{relative_path}' does not have a valid date in the #{source}.")
       end
       data
     end
@@ -235,8 +235,11 @@ module Jekyll
     def destination(base_directory)
       dest = site.in_dest_dir(base_directory)
       path = site.in_dest_dir(dest, URL.unescape_path(url))
-      path = File.join(path, "index.html") if url.end_with?("/")
-      path << output_ext unless path.end_with?(output_ext)
+      if url.end_with? "/"
+        path = File.join(path, "index.html")
+      else
+        path << output_ext unless path.end_with?(output_ext)
+      end
       path
     end
 
@@ -287,20 +290,23 @@ module Jekyll
       else
         begin
           defaults = @site.frontmatter_defaults.all(url, collection.label.to_sym)
-          merge_data!(defaults) unless defaults.empty?
+          merge_data!(defaults, source: "front matter defaults") unless defaults.empty?
 
           self.content = File.read(path, merged_file_read_opts(opts))
           if content =~ YAML_FRONT_MATTER_REGEXP
             self.content = $POSTMATCH
             data_file = SafeYAML.load($1)
-            merge_data!(data_file) if data_file
+            merge_data!(data_file, source: "YAML front matter") if data_file
           end
 
           post_read
         rescue SyntaxError => e
-          puts "YAML Exception reading #{path}: #{e.message}"
+          Jekyll.logger.error "Error:", "YAML Exception reading #{path}: #{e.message}"
         rescue Exception => e
-          puts "Error reading file #{path}: #{e.message}"
+          if e.is_a? Jekyll::Errors::FatalException
+            raise e
+          end
+          Jekyll.logger.error "Error:", "could not read file #{path}: #{e.message}"
         end
       end
     end
@@ -311,8 +317,10 @@ module Jekyll
         merge_data!({
           "slug" => slug,
           "ext"  => ext
-        })
-        merge_data!({"date" => date}) if data['date'].nil? || data['date'].to_i == site.time.to_i
+        }, source: "filename")
+        if data['date'].nil? || data['date'].to_i == site.time.to_i
+          merge_data!({"date" => date}, source: "filename")
+        end
         data['title'] ||= slug.split('-').select {|w| w.capitalize! || w }.join(' ')
       end
       populate_categories
@@ -332,7 +340,7 @@ module Jekyll
       superdirs = relative_path.sub(/#{special_dir}(.*)/, '').split(File::SEPARATOR).reject do |c|
         c.empty? || c.eql?(special_dir) || c.eql?(basename)
       end
-      merge_data!({ 'categories' => superdirs })
+      merge_data!({ 'categories' => superdirs }, source: "file path")
     end
 
     def populate_categories
@@ -393,7 +401,7 @@ module Jekyll
     def <=>(other)
       return nil if !other.respond_to?(:data)
       cmp = data['date'] <=> other.data['date']
-      cmp = path <=> other.path if cmp == 0
+      cmp = path <=> other.path if cmp.nil? || cmp == 0
       cmp
     end
 

lib/jekyll/entry_filter.rb

@@ -47,7 +47,7 @@ module Jekyll
 
     def excluded?(entry)
       excluded = glob_include?(site.exclude, relative_to_source(entry))
-      Jekyll.logger.debug "EntryFilter:", "excluded?(#{relative_to_source(entry)}) ==> #{excluded}"
+      Jekyll.logger.debug "EntryFilter:", "excluded #{relative_to_source(entry)}" if excluded
       excluded
     end
 

lib/jekyll/liquid_renderer/file.rb

@@ -8,7 +8,7 @@ module Jekyll
 
       def parse(content)
         measure_time do
-          @template = Liquid::Template.parse(content)
+          @template = Liquid::Template.parse(content, line_numbers: true)
         end
 
         self

lib/jekyll/page.rb

@@ -135,8 +135,11 @@ module Jekyll
     # Returns the destination file path String.
     def destination(dest)
       path = site.in_dest_dir(dest, URL.unescape_path(url))
-      path = File.join(path, "index.html") if url.end_with?("/")
-      path << output_ext unless path.end_with?(output_ext)
+      if url.end_with? "/"
+        path = File.join(path, "index.html")
+      else
+        path << output_ext unless path.end_with?(output_ext)
+      end
       path
     end
 

lib/jekyll/site.rb

@@ -224,7 +224,7 @@ module Jekyll
       # Build a hash map based on the specified post attribute ( post attr =>
       # array of posts ) then sort each array in reverse order.
       hash = Hash.new { |h, key| h[key] = [] }
-      posts.docs.each { |p| p.data[post_attr].each { |t| hash[t] << p } }
+      posts.docs.each { |p| p.data[post_attr].each { |t| hash[t] << p } if p.data[post_attr] }
       hash.values.each { |posts| posts.sort!.reverse! }
       hash
     end

lib/jekyll/version.rb

@@ -1,3 +1,3 @@
 module Jekyll
-  VERSION = '3.0.1'
+  VERSION = '3.0.3'
 end

site/_docs/history.md

@@ -4,6 +4,33 @@ title: History
 permalink: "/docs/history/"
 ---
 
+## 3.0.3 / 2016-02-08
+{: #v3-0-3}
+
+### Bug Fixes
+{: #bug-fixes-v3-0-3}
+
+* Fix extension weirdness with folders ([#4493]({{ site.repository }}/issues/4493))
+* EntryFilter: only include 'excluded' log on excluded files ([#4479]({{ site.repository }}/issues/4479))
+* `Jekyll.sanitized_path`: escape tildes before sanitizing a questionable path ([#4468]({{ site.repository }}/issues/4468))
+* `LiquidRenderer#parse`: parse with line numbers ([#4453]({{ site.repository }}/issues/4453))
+* `Document#<=>`: protect against nil comparison in dates. ([#4446]({{ site.repository }}/issues/4446))
+
+
+## 3.0.2 / 2016-01-20
+{: #v3-0-2}
+
+### Bug Fixes
+{: #bug-fixes-v3-0-2}
+
+- Document: throw a useful error when an invalid date is given ([#4378]({{ site.repository }}/issues/4378))
+
+### Development Fixes
+{: #development-fixes-v3-0-2}
+
+- `jekyll-docs` should be easily release-able ([#4152]({{ site.repository }}/issues/4152))
+
+
 ## 3.0.1 / 2015-11-17
 {: #v3-0-1}
 

site/_posts/2016-01-20-jekyll-3-0-2-released.markdown

@@ -0,0 +1,14 @@
+---
+layout: news_item
+title: 'Jekyll 3.0.2 Released'
+date: 2016-01-20 14:08:18 -0800
+author: parkr
+version: 3.0.2
+categories: [release]
+---
+
+A crucial bug was found in v3.0.1 which caused invalid post dates to go
+unnoticed in the build chain until the error that popped up was unhelpful.
+v3.0.2 [throws errors as you'd expect](https://github.com/jekyll/jekyll/issues/4375)
+when there is a post like `_posts/2016-22-01-future.md` or a post has an
+invalid date like `date: "tuesday"` in their front matter.

site/_posts/2016-02-08-jekyll-3-0-3-released.markdown

@@ -0,0 +1,31 @@
+---
+layout: news_item
+title: 'Jekyll 3.0.3 Released'
+date: 2016-02-08 10:39:08 -0800
+author: parkr
+version: 3.0.3
+categories: [release]
+---
+
+[GitHub Pages upgraded to Jekyll 3.0.2][1] last week and there has been a
+joyous reception so far! This release is to address some bugs that affected
+some users during the cut-over. The fixes include:
+
+* Fix problem where outputting to a folder would have two extensions
+* Handle tildes (`~`) in filenames properly
+* Fix issue when comparing documents without dates
+* Include line numbers in liquid error output
+
+Read more on the [changelog](/docs/history/#v3-0-3) with links to the
+related patches.
+
+Please keep [submitting bugs][2] as you find them! Please do take a look
+[in our various help resources](/help/) before filing a bug and use [our
+forum][3] for asking questions and getting help on a specific problem
+you're having.
+
+Happy Jekylling!
+
+[1]: https://github.com/blog/2100-github-pages-now-faster-and-simpler-with-jekyll-3-0
+[2]: {{ site.repository }}/issues
+[3]: https://talk.jekyllrb.com/

site/latest_version.txt

@@ -1 +1 @@
-3.0.1
+3.0.2

test/source/_with.dots/mit.txt

@@ -0,0 +1,4 @@
+---
+---
+
+I should be output to `/with.dots/mit/index.html`.

test/source/contacts/humans.txt

@@ -0,0 +1,5 @@
+---
+permalink: /contacts/humans/
+---
+
+I should be output to `/contacts/humans/index.html`.

test/test_collections.rb

@@ -203,7 +203,7 @@ class TestCollections < JekyllUnitTest
     end
 
     should "contain one document" do
-      assert_equal 2, @collection.docs.size
+      assert_equal 3, @collection.docs.size
     end
 
     should "allow dots in the filename" do

test/test_document.rb

@@ -380,4 +380,33 @@ class TestDocument < JekyllUnitTest
 
   end
 
+  context "a document in a collection with a non-HTML-able filename" do
+    setup do
+      @site = fixture_site({
+        "collections" => {
+          "with.dots" => {
+            "output" => true,
+            "permalink" => "/:collection/:path/"
+          }
+        },
+      })
+      @site.process
+      @document = @site.collections["with.dots"].docs.find { |doc| doc.relative_path == "_with.dots/mit.txt" }
+      @dest_file = dest_dir("with.dots", "mit", "index.html")
+    end
+
+    should "produce the right URL" do
+      assert_equal "/with.dots/mit/", @document.url
+    end
+
+    should "produce the right destination" do
+      assert_equal @dest_file, @document.destination(dest_dir)
+    end
+
+    should "be output in the correct place" do
+      assert_equal true, File.file?(@dest_file)
+    end
+
+  end
+
 end

test/test_filters.rb

@@ -257,7 +257,7 @@ class TestFilters < JekyllUnitTest
             assert_equal 2, g["items"].size
           when ""
             assert g["items"].is_a?(Array), "The list of grouped items for '' is not an Array."
-            assert_equal 11, g["items"].size
+            assert_equal 12, g["items"].size
           end
         end
       end

test/test_page.rb

@@ -310,6 +310,18 @@ class TestPage < JekyllUnitTest
           assert File.directory?(dest_dir)
           assert File.exist?(File.join(dest_dir, 'contacts', 'bar', 'index.html'))
         end
+
+        should "write properly without html extension in source file" do
+          page = setup_page('/contacts', 'humans.txt')
+          page.site.permalink_style = "/:categories/:year/:month/:day/:title/"
+          do_render(page)
+          page.write(dest_dir)
+          dest = dest_dir('contacts', 'humans', 'index.html')
+
+          assert File.directory?(dest_dir)
+          assert_equal dest, page.destination(dest_dir)
+          assert File.exist?(dest), "contacts/humans/index.html should exist"
+        end
       end
     end
 

test/test_path_sanitization.rb

@@ -15,4 +15,13 @@ class TestPathSanitization < JekyllUnitTest
       assert_equal "/tmp/foobar/jail/..c:/..c:/..c:/etc/passwd", Jekyll.sanitized_path("/tmp/foobar/jail", "..c:/..c:/..c:/etc/passwd")
     end
   end
+
+  should "escape tilde" do
+    assert_equal source_dir("~hi.txt"), Jekyll.sanitized_path(source_dir, "~hi.txt")
+    assert_equal source_dir("files", "~hi.txt"), Jekyll.sanitized_path(source_dir, "files/../files/~hi.txt")
+  end
+
+  should "remove path traversals" do
+    assert_equal source_dir("files", "hi.txt"), Jekyll.sanitized_path(source_dir, "f./../../../../../../files/hi.txt")
+  end
 end

test/test_site.rb

@@ -177,6 +177,7 @@ class TestSite < JekyllUnitTest
         environment.html
         exploit.md
         foo.md
+        humans.txt
         index.html
         index.html
         main.scss