jekyll 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5510f33edfed966c633c208d23735d3e38c48ff9
-  data.tar.gz: 52f440324622ff8b6ec21b9f3be4e1389ce1f5c4
+  metadata.gz: a31f65d756e5aebe4d34d37dfa1a94f6d1ca51bf
+  data.tar.gz: 20cc0c111cf0f43655be2e14ec523709606d8ff8
 SHA512:
-  metadata.gz: 7e9ae32caf9787927f2cfec615b614d523c40948c7b7795a1387bc57b073459483babe3cf52ac1a525813d1c2cf9f0a3f0ee30e20919c91a38316338dda1dccf
-  data.tar.gz: fa070a7a332ad16d5671da91a1e9f739b7911b32baa87e6f882fd1920a4db39de70847d7bf679386a9f5ac027094cbce4e6b58c061a379ba7634d814a5a50dec
+  metadata.gz: 7bf6846863ee71fd92d708c9bfc5f86227a411b529b2e5f3028bcd6788991823cdd8dceb54cd7d76369f27c0c27e694de998da8a7da6d7036c52d09ede9e9789
+  data.tar.gz: 5a10ab501a2df020e5f2fbdacf614a3512f50f9bbe963a70c58b046a8dc3cdb78c55224f1e646950c4b56df6b99863ef4c04d215ba805c2d7372ad34835fd93b

data/History.markdown

@@ -10,6 +10,39 @@
 
 ### Site Enhancements
 
+## 2.2.0 / 2014-07-29
+
+### Minor Enhancements
+
+  * Throw a warning if the specified layout does not exist (#2620)
+  * Whitelist Pygments options in safe mode (#2642)
+
+### Bug Fixes
+
+  * Remove unnecessary `Jekyll::Tags::IncludeTag#blank?` method (#2625)
+  * Categories in the path are ignored (#2633)
+
+### Development Fixes
+
+  * Refactoring Errors & Requires of Third-Party stuff (#2591)
+  * Add further tests for categories (#2584)
+  * Proof site with html-proofer on change (#2605)
+  * Fix up bug in #2605 which caused proofing the site not to function (#2608)
+  * Use `bundle exec` in `script/proof` (#2610)
+
+### Site Enhancements
+
+  * Update Kramdown urls (#2588)
+  * Add `Jekyll::AutolinkEmail` and `Jekyll::GitMetadata` to the list of
+    third-party plugins (#2596)
+  * Fix a bunch of broken links in the site (#2601)
+  * Replace dead links with working links (#2611)
+  * Add jekyll-hook to deployment methods (#2617)
+  * Added kramdown-with-pygments plugin to the list of third-party plugins (#2623)
+  * Update outdated "Extras" page and remove duplicate documentation (#2622)
+  * Add co2 plugin to list of third-party plugins (#2639)
+  * Attempt to clarify the way Sass imports happen (#2642)
+
 ## 2.1.1 / 2014-07-01
 
 ### Bug Fixes
@@ -1118,9 +1151,9 @@
   * Configuration options set in config.yml are now available through the
       site payload (@vilcans)
   * Posts can now have an empty YAML front matter or none at all
-      (@bahuvrihi)
+      (@ bahuvrihi)
   * Bug Fixes
-  * Fixing Ruby 1.9 issue that requires to_s on the err object
+  * Fixing Ruby 1.9 issue that requires `#to_s` on the err object
       (@Chrononaut)
   * Fixes for pagination and ordering posts on the same day (@ujh)
   * Made pages respect permalinks style and permalinks in yml front matter
@@ -1130,7 +1163,7 @@
   * Added trailing slash to pretty permalink style so Apache is happy
       (@eugenebolshakov)
   * Bad markdown processor in config fails sooner and with better message
-      (@gcnovus)
+      (@ gcnovus)
   * Allow CRLFs in yaml frontmatter (@juretta)
   * Added Date#xmlschema for Ruby versions < 1.9
 

data/Rakefile

@@ -53,13 +53,32 @@ def liquid_escape(markdown)
   markdown.gsub(/(`{[{%].+[}%]}`)/, "{% raw %}\\1{% endraw %}")
 end
 
+def custom_release_header_anchors(markdown)
+  header_regexp = /^(\d{1,2})\.(\d{1,2})\.(\d{1,2}) \/ \d{4}-\d{2}-\d{2}/
+  section_regexp = /^### \w+ \w+$/
+  markdown.split(/^##\s/).map do |release_notes|
+    _, major, minor, patch = *release_notes.match(header_regexp)
+    release_notes
+      .gsub(header_regexp, "\\0\n{: #v\\1-\\2-\\3}")
+      .gsub(section_regexp) { |section| "#{section}\n{: ##{sluffigy(section)}-v#{major}-#{minor}-#{patch}}" }
+  end.join("\n## ")
+end
+
+def sluffigy(header)
+  header.gsub(/#/, '').strip.downcase.gsub(/\s+/, '-')
+end
+
 def remove_head_from_history(markdown)
   index = markdown =~ /^##\s+\d+\.\d+\.\d+/
   markdown[index..-1]
 end
 
 def converted_history(markdown)
-  remove_head_from_history(liquid_escape(linkify(normalize_bullets(markdown))))
+  remove_head_from_history(
+    custom_release_header_anchors(
+      liquid_escape(
+        linkify(
+          normalize_bullets(markdown)))))
 end
 
 #############################################################################

data/features/post_data.feature

@@ -70,18 +70,42 @@ Feature: Post data
     Then the _site directory should exist
     And I should see "Post category: movies" in "_site/movies/2009/03/27/star-wars.html"
 
-  Scenario: Use post.categories variable when category is in a folder and has categories in YAML
+  Scenario: Use post.categories variable when category is in a folder and has category in YAML
     Given I have a movies directory
     And I have a movies/_posts directory
     And I have a _layouts directory
     And I have the following post in "movies":
-      | title     | date       | layout | categories | content                 |
-      | Star Wars | 2009-03-27 | simple | [film]     | Luke, I am your father. |
+      | title     | date       | layout | category | content                 |
+      | Star Wars | 2009-03-27 | simple | film     | Luke, I am your father. |
     And I have a simple layout that contains "Post category: {{ page.categories }}"
     When I run jekyll build
     Then the _site directory should exist
     And I should see "Post category: movies" in "_site/movies/film/2009/03/27/star-wars.html"
 
+  Scenario: Use post.categories variable when category is in a folder and has categories in YAML
+    Given I have a movies directory
+    And I have a movies/_posts directory
+    And I have a _layouts directory
+    And I have the following post in "movies":
+      | title     | date       | layout | categories        | content                 |
+      | Star Wars | 2009-03-27 | simple | [film, scifi]     | Luke, I am your father. |
+    And I have a simple layout that contains "Post category: {{ page.categories }}"
+    When I run jekyll build
+    Then the _site directory should exist
+    And I should see "Post category: movies" in "_site/movies/film/scifi/2009/03/27/star-wars.html"
+
+  Scenario: Use post.categories variable when category is in a folder and duplicated category is in YAML
+    Given I have a movies directory
+    And I have a movies/_posts directory
+    And I have a _layouts directory
+    And I have the following post in "movies":
+      | title     | date       | layout | category | content                 |
+      | Star Wars | 2009-03-27 | simple | movies   | Luke, I am your father. |
+    And I have a simple layout that contains "Post category: {{ page.categories }}"
+    When I run jekyll build
+    Then the _site directory should exist
+    And I should see "Post category: movies" in "_site/movies/2009/03/27/star-wars.html"
+
   Scenario: Use post.tags variable
     Given I have a _posts directory
     And I have a _layouts directory
@@ -141,12 +165,23 @@ Feature: Post data
     Then the _site directory should exist
     And I should see "Post category: movies" in "_site/movies/2009/03/27/star-wars.html"
 
-  Scenario: Use post.categories variable when category is in YAML
+  Scenario: Use post.categories variable when categories are in YAML
     Given I have a _posts directory
     And I have a _layouts directory
     And I have the following post:
-      | title     | date       | layout | category | content                 |
-      | Star Wars | 2009-03-27 | simple | movies   | Luke, I am your father. |
+      | title     | date       | layout | categories          | content                 |
+      | Star Wars | 2009-03-27 | simple | ['scifi', 'movies'] | Luke, I am your father. |
+    And I have a simple layout that contains "Post categories: {{ page.categories | array_to_sentence_string }}"
+    When I run jekyll build
+    Then the _site directory should exist
+    And I should see "Post categories: scifi and movies" in "_site/scifi/movies/2009/03/27/star-wars.html"
+
+  Scenario: Use post.categories variable when categories are in YAML and are duplicated
+    Given I have a _posts directory
+    And I have a _layouts directory
+    And I have the following post:
+      | title     | date       | layout | categories           | content                 |
+      | Star Wars | 2009-03-27 | simple | ['movies', 'movies'] | Luke, I am your father. |
     And I have a simple layout that contains "Post category: {{ page.categories }}"
     When I run jekyll build
     Then the _site directory should exist

data/jekyll.gemspec

@@ -28,13 +28,16 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.extra_rdoc_files = %w[README.markdown LICENSE]
 
-  s.add_runtime_dependency('liquid', "~> 2.6.1")
-  s.add_runtime_dependency('classifier', "~> 1.3")
-  s.add_runtime_dependency('kramdown', "~> 1.3")
-  s.add_runtime_dependency('pygments.rb', "~> 0.6.0")
+  s.add_runtime_dependency('liquid',    "~> 2.6.1")
+  s.add_runtime_dependency('kramdown',  "~> 1.3")
   s.add_runtime_dependency('mercenary', "~> 0.3.3")
   s.add_runtime_dependency('safe_yaml', "~> 1.0")
   s.add_runtime_dependency('colorator', "~> 0.1")
+
+  # Before 3.0 drops, phase the following gems out as dev dependencies
+  # and gracefully handle their absence.
+  s.add_runtime_dependency('classifier', "~> 1.3")
+  s.add_runtime_dependency('pygments.rb', "~> 0.6.0")
   s.add_runtime_dependency('redcarpet', "~> 3.1")
   s.add_runtime_dependency('toml', '~> 0.1.0')
   s.add_runtime_dependency('jekyll-paginate', '~> 1.0')

data/lib/jekyll.rb

@@ -18,69 +18,56 @@ require 'rubygems'
 # stdlib
 require 'fileutils'
 require 'time'
-require 'safe_yaml/load'
 require 'English'
 require 'pathname'
 require 'logger'
 
 # 3rd party
+require 'safe_yaml/load'
 require 'liquid'
 require 'kramdown'
 require 'colorator'
-require 'toml'
-
-# internal requires
-require 'jekyll/version'
-require 'jekyll/utils'
-require 'jekyll/log_adapter'
-require 'jekyll/stevenson'
-require 'jekyll/deprecator'
-require 'jekyll/configuration'
-require 'jekyll/document'
-require 'jekyll/collection'
-require 'jekyll/plugin_manager'
-require 'jekyll/frontmatter_defaults'
-require 'jekyll/site'
-require 'jekyll/convertible'
-require 'jekyll/url'
-require 'jekyll/layout'
-require 'jekyll/page'
-require 'jekyll/post'
-require 'jekyll/excerpt'
-require 'jekyll/draft'
-require 'jekyll/filters'
-require 'jekyll/static_file'
-require 'jekyll/errors'
-require 'jekyll/related_posts'
-require 'jekyll/cleaner'
-require 'jekyll/entry_filter'
-require 'jekyll/layout_reader'
-require 'jekyll/publisher'
-require 'jekyll/renderer'
-
-# extensions
-require 'jekyll/plugin'
-require 'jekyll/converter'
-require 'jekyll/generator'
-require 'jekyll/command'
-require 'jekyll/liquid_extensions'
-
-require_all 'jekyll/commands'
-require_all 'jekyll/converters'
-require_all 'jekyll/converters/markdown'
-require_all 'jekyll/generators'
-require_all 'jekyll/tags'
-
-# plugins
-require 'jekyll-coffeescript'
-require 'jekyll-sass-converter'
-require 'jekyll-paginate'
-require 'jekyll-gist'
 
 SafeYAML::OPTIONS[:suppress_warnings] = true
 
 module Jekyll
 
+  # internal requires
+  autoload :Cleaner,             'jekyll/cleaner'
+  autoload :Collection,          'jekyll/collection'
+  autoload :Configuration,       'jekyll/configuration'
+  autoload :Convertible,         'jekyll/convertible'
+  autoload :Deprecator,          'jekyll/deprecator'
+  autoload :Document,            'jekyll/document'
+  autoload :Draft,               'jekyll/draft'
+  autoload :EntryFilter,         'jekyll/entry_filter'
+  autoload :Errors,              'jekyll/errors'
+  autoload :Excerpt,             'jekyll/excerpt'
+  autoload :Filters,             'jekyll/filters'
+  autoload :FrontmatterDefaults, 'jekyll/frontmatter_defaults'
+  autoload :Layout,              'jekyll/layout'
+  autoload :LayoutReader,        'jekyll/layout_reader'
+  autoload :LogAdapter,          'jekyll/log_adapter'
+  autoload :Page,                'jekyll/page'
+  autoload :PluginManager,       'jekyll/plugin_manager'
+  autoload :Post,                'jekyll/post'
+  autoload :Publisher,           'jekyll/publisher'
+  autoload :RelatedPosts,        'jekyll/related_posts'
+  autoload :Renderer,            'jekyll/renderer'
+  autoload :Site,                'jekyll/site'
+  autoload :StaticFile,          'jekyll/static_file'
+  autoload :Stevenson,           'jekyll/stevenson'
+  autoload :URL,                 'jekyll/url'
+  autoload :Utils,               'jekyll/utils'
+  autoload :VERSION,             'jekyll/version'
+
+  # extensions
+  require 'jekyll/plugin'
+  require 'jekyll/converter'
+  require 'jekyll/generator'
+  require 'jekyll/command'
+  require 'jekyll/liquid_extensions'
+
   # Public: Tells you which Jekyll environment you are building in so you can skip tasks
   # if you need to.  This is useful when doing expensive compression tasks on css and
   # images and allows you to skip that when working in development.
@@ -143,3 +130,19 @@ module Jekyll
     end
   end
 end
+
+require_all 'jekyll/commands'
+require_all 'jekyll/converters'
+require_all 'jekyll/converters/markdown'
+require_all 'jekyll/generators'
+require_all 'jekyll/tags'
+
+# Eventually remove these for 3.0 as non-core
+Jekyll::Deprecator.gracefully_require(%w[
+  classifier
+  toml
+  jekyll-paginate
+  jekyll-gist
+  jekyll-coffeescript
+  jekyll-sass-converter
+])

data/lib/jekyll/command.rb

@@ -51,7 +51,7 @@ module Jekyll
       # Returns nothing
       def process_site(site)
         site.process
-      rescue Jekyll::FatalException => e
+      rescue Jekyll::Errors::FatalException => e
         Jekyll.logger.error "ERROR:", "YOUR SITE COULD NOT BE BUILT:"
         Jekyll.logger.error "", "------------------------------------"
         Jekyll.logger.error "", e.message

data/lib/jekyll/commands/build.rb

@@ -58,7 +58,7 @@ module Jekyll
         #
         # Returns nothing.
         def watch(site, options)
-          require 'jekyll-watch'
+          Deprecator.gracefully_require 'jekyll-watch'
           Jekyll::Commands::Watch.watch(site, options)
         end
 

data/lib/jekyll/converters/markdown.rb

@@ -11,22 +11,41 @@ module Jekyll
         @parser =
           case @config['markdown'].downcase
             when 'redcarpet' then RedcarpetParser.new(@config)
-            when 'kramdown' then KramdownParser.new(@config)
+            when 'kramdown'  then KramdownParser.new(@config)
             when 'rdiscount' then RDiscountParser.new(@config)
-            when 'maruku' then MarukuParser.new(@config)
+            when 'maruku'    then MarukuParser.new(@config)
           else
             # So they can't try some tricky bullshit or go down the ancestor chain, I hope.
             if allowed_custom_class?(@config['markdown'])
               self.class.const_get(@config['markdown']).new(@config)
             else
               Jekyll.logger.error "Invalid Markdown Processor:", "#{@config['markdown']}"
-              Jekyll.logger.error "", "Valid options are [ maruku | rdiscount | kramdown | redcarpet ]"
-              raise FatalException, "Invalid Markdown Processor: #{@config['markdown']}"
+              Jekyll.logger.error "", "Valid options are [ #{valid_processors.join(" | ")} ]"
+              raise Errors::FatalException, "Invalid Markdown Processor: #{@config['markdown']}"
             end
           end
         @setup = true
       end
 
+      def valid_processors
+        %w[
+          maruku
+          rdiscount
+          kramdown
+          redcarpet
+        ] + third_party_processors
+      end
+
+      def third_party_processors
+        self.class.constants - %w[
+          KramdownParser
+          MarukuParser
+          RDiscountParser
+          RedcarpetParser
+          PRIORITIES
+        ].map(&:to_sym)
+      end
+
       def matches(ext)
         rgx = '^\.(' + @config['markdown_ext'].gsub(',','|') +')$'
         ext =~ Regexp.new(rgx, Regexp::IGNORECASE)

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

@@ -8,7 +8,7 @@ module Jekyll
         rescue LoadError
           STDERR.puts 'You are missing a library required for Markdown. Please run:'
           STDERR.puts '  $ [sudo] gem install kramdown'
-          raise FatalException.new("Missing dependency: kramdown")
+          raise Errors::FatalException.new("Missing dependency: kramdown")
         end
 
         def convert(content)

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

@@ -15,7 +15,7 @@ module Jekyll
         rescue LoadError
           STDERR.puts 'You are missing a library required for Markdown. Please run:'
           STDERR.puts '  $ [sudo] gem install maruku'
-          raise FatalException.new("Missing dependency: maruku")
+          raise Errors::FatalException.new("Missing dependency: maruku")
         end
 
         def load_divs_library

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

@@ -3,13 +3,9 @@ module Jekyll
     class Markdown
       class RDiscountParser
         def initialize(config)
-          require 'rdiscount'
+          Jekyll::Deprecator.gracefully_require "rdiscount"
           @config = config
           @rdiscount_extensions = @config['rdiscount']['extensions'].map { |e| e.to_sym }
-        rescue LoadError
-          STDERR.puts 'You are missing a library required for Markdown. Please run:'
-          STDERR.puts '  $ [sudo] gem install rdiscount'
-          raise FatalException.new("Missing dependency: rdiscount")
         end
 
         def convert(content)

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

@@ -14,7 +14,7 @@ module Jekyll
         module WithPygments
           include CommonMethods
           def block_code(code, lang)
-            require 'pygments'
+            Jekyll::Deprecator.gracefully_require("pygments")
             lang = lang && lang.split.first || "text"
             add_code_tags(
               Pygments.highlight(code, :lexer => lang, :options => { :encoding => 'utf-8' }),
@@ -55,45 +55,40 @@ module Jekyll
 
 
         def initialize(config)
-          require 'redcarpet'
+          Deprecator.gracefully_require("redcarpet")
           @config = config
           @redcarpet_extensions = {}
           @config['redcarpet']['extensions'].each { |e| @redcarpet_extensions[e.to_sym] = true }
 
-          @renderer ||= case @config['highlighter']
-                        when 'pygments'
-                          Class.new(Redcarpet::Render::HTML) do
-                            include WithPygments
-                          end
-                        when 'rouge'
-                          Class.new(Redcarpet::Render::HTML) do
-                            begin
-                              require 'rouge'
-                              require 'rouge/plugins/redcarpet'
-                            rescue LoadError => e
-                              Jekyll.logger.error "You are missing the 'rouge' gem. Please run:"
-                              Jekyll.logger.error " $ [sudo] gem install rouge"
-                              Jekyll.logger.error "Or add 'rouge' to your Gemfile."
-                              raise FatalException.new("Missing dependency: rouge")
-                            end
-
-                            if Rouge.version < '1.3.0'
-                              abort "Please install Rouge 1.3.0 or greater and try running Jekyll again."
-                            end
-
-                            include Rouge::Plugins::Redcarpet
-                            include CommonMethods
-                            include WithRouge
-                          end
-                        else
-                          Class.new(Redcarpet::Render::HTML) do
-                            include WithoutHighlighting
-                          end
-                        end
-        rescue LoadError
-          STDERR.puts 'You are missing a library required for Markdown. Please run:'
-          STDERR.puts '  $ [sudo] gem install redcarpet'
-          raise FatalException.new("Missing dependency: redcarpet")
+          @renderer ||= class_with_proper_highlighter(@config['highlighter'])
+        end
+
+        def class_with_proper_highlighter(highlighter)
+          case highlighter
+          when "pygments"
+            Class.new(Redcarpet::Render::HTML) do
+              include WithPygments
+            end
+          when "rouge"
+            Class.new(Redcarpet::Render::HTML) do
+              Jekyll::Deprecator.gracefully_require(%w[
+                rouge
+                rouge/plugins/redcarpet
+              ])
+
+              if Rouge.version < '1.3.0'
+                abort "Please install Rouge 1.3.0 or greater and try running Jekyll again."
+              end
+
+              include Rouge::Plugins::Redcarpet
+              include CommonMethods
+              include WithRouge
+            end
+          else
+            Class.new(Redcarpet::Render::HTML) do
+              include WithoutHighlighting
+            end
+          end
         end
 
         def convert(content)