jekyll 1.1.2 → 1.2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NzE0ZjEzYzM3ZGZhYmJjODMyZDNkYTUxNWY5ZThjMWVlM2M3NWI5Yg==
-  data.tar.gz: !binary |-
-    NGU1MDcwYjliYjlhMjNmMjk5ZTNkZTA2ODgxMmQ5Y2E3NGM3Y2Y5Yw==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    N2Y5YmY5NDJjMGVhMGJkZDMyMmEyNWQ2ZGZlMzNlY2MxN2U1ZDY0NjVhY2U0
-    OGY4NjE1MmYwOWRlM2E1MTU1YmYyYWY3M2MwNGYwZmYyZTI5MDQ5OTdlMmQ5
-    OWVmMDQ0M2U5NDk1N2Y2ODEwODY5Y2I0MzkyNjdjNDE3NzBiNTg=
-  data.tar.gz: !binary |-
-    MzdkNjFjZjllNmI4NzIzMjJhNjU1MjY4ZjI4ZGIwNjU5Mjc4YzZjMDY1ODY1
-    M2QxMDIwYzkzNDY0M2Y2NWYwZDUxZDcyZGM0ZTNlNGQyMmU3ZDg4NmYwNzNl
-    ZmY5YTJlZWZlNmRiMjE4ZmEwZGZkYmU0NDMzNTFhYzRhNzM2ODY=
+SHA1:
+  metadata.gz: aab2c87d69fc03f3df6a6b6a2baefc5e46fe5904
+  data.tar.gz: ae32a99eb79b9c36914dabe91b2ef4e504a2097d
+SHA512:
+  metadata.gz: 1ce28ae2b4c0dfd9d8042f636629748ee89db13afab6b1cb913969cb64d1351ccf7630d246b27c2bd361014b26836a535893907ad89f6018058815bab7a80d47
+  data.tar.gz: d5e9b0f6bb303512011243caacf34e369a832d4bf26d518455798463f5885398e9877ee6433818ebd83a2f11f81502476b5716eeec8e754f2456727d51ee35b4

data/History.markdown

@@ -8,6 +8,77 @@
 
 ### Development Fixes
 
+### Site Enhancements
+
+## v1.2.0 / 2013-09-06
+
+### Major Enhancements
+  * Disable automatically-generated excerpts when `excerpt_separator` is `""`. (#1386)
+  * Add checking for URL conflicts when running `jekyll doctor` (#1389)
+
+### Minor Enhancements
+  * Catch and fix invalid `paginate` values (#1390)
+  * Remove superfluous `div.container` from the default html template for
+    `jekyll new` (#1315)
+  * Add -D short-form switch for the drafts option (#1394)
+  * Update the links in the site template for Twitter and GitHub (#1400)
+  * Update dummy email address to example.com domain (#1408)
+  * Update normalize.css to v2.1.2 and minify; add rake task to update
+    normalize.css with greater ease. (#1430)
+  * Add the ability to detach the server ran by `jekyll serve` from it's
+    controlling terminal (#1443)
+  * Improve permalink generation for URLs with special characters (#944)
+  * Expose the current Jekyll version to posts and pages via a new
+    `jekyll.version` variable (#1481)
+
+### Bug Fixes
+  * Markdown extension matching matches only exact matches (#1382)
+  * Fixed NoMethodError when message passed to `Stevenson#message` is nil (#1388)
+  * Use binary mode when writing file (#1364)
+  * Fix 'undefined method `encoding` for "mailto"' errors w/ Ruby 1.8 and
+    Kramdown > 0.14.0 (#1397)
+  * Do not force the permalink to be a dir if it ends on .html (#963)
+  * When a Liquid Exception is caught, show the full path rel. to site source (#1415)
+  * Properly read in the config options when serving the docs locally
+    (#1444)
+  * Fixed `--layouts` option for `build` and `serve` commands (#1458)
+  * Remove kramdown as a runtime dependency since it's optional (#1498)
+  * Provide proper error handling for invalid file names in the include
+    tag (#1494)
+
+### Development Fixes
+  * Remove redundant argument to
+    Jekyll::Commands::New#scaffold_post_content (#1356)
+  * Add new dependencies to the README (#1360)
+  * Fix link to contributing page in README (#1424)
+  * Update TomDoc in Pager#initialize to match params (#1441)
+  * Refactor `Site#cleanup` into `Jekyll::Site::Cleaner` class (#1429)
+  * Several other small minor refactorings (#1341)
+  * Ignore `_site` in jekyllrb.com deploy (#1480)
+  * Add Gem version and dependency badge to README (#1497)
+
+### Site Enhancements
+  * Add info about new releases (#1353)
+  * Update plugin list with jekyll-rss plugin (#1354)
+  * Update the site list page with Ruby's official site (#1358)
+  * Add `jekyll-ditaa` to list of third-party plugins (#1370)
+  * Add `postfiles` to list of third-party plugins (#1373)
+  * For internal links, use full path including trailing `/` (#1411)
+  * Use curly apostrophes in the docs (#1419)
+  * Update the docs for Redcarpet in Jekyll (#1418)
+  * Add `pluralize` and `reading_time` filters to docs (#1439)
+  * Fix markup for the Kramdown options (#1445)
+  * Fix typos in the History file (#1454)
+  * Add trailing slash to site's post URL (#1462)
+  * Clarify that --config will take multiple files (#1474)
+  * Fix docs/templates.md private gist example (#1477)
+  * Use `site.repository` for Jekyll's GitHub URL (#1463)
+  * Add `jekyll-pageless-redirects` to list of third-party plugins (#1486)
+  * Clarify that `date_to_xmlschema` returns an ISO 8601 string (#1488)
+  * Add `jekyll-good-include` to list of third-party plugins (#1491)
+  * XML escape the blog post title in our feed (#1501)
+  * Add `jekyll-toc-generator` to list of third-party plugins (#1506)
+
 ## v1.1.2 / 2013-07-25
 
 ### Bug Fixes

data/README.markdown

@@ -1,7 +1,10 @@
 # Jekyll
 
+[![Gem Version](https://badge.fury.io/rb/jekyll.png)](http://badge.fury.io/rb/jekyll)
+
 [![Build Status](https://secure.travis-ci.org/mojombo/jekyll.png)](https://travis-ci.org/mojombo/jekyll)
 [![Code Climate](https://codeclimate.com/github/mojombo/jekyll.png)](https://codeclimate.com/github/mojombo/jekyll)
+[![Dependency Status](https://gemnasium.com/mojombo/jekyll.png)](https://gemnasium.com/mojombo/jekyll)
 
 By Tom Preston-Werner, Nick Quaranto, and many awesome contributors!
 
@@ -12,8 +15,8 @@ Jekyll is a simple, blog aware, static site generator. It takes a template direc
 * [Install](http://jekyllrb.com/docs/installation/) the gem
 * Read up about its [Usage](http://jekyllrb.com/docs/usage/) and [Configuration](http://jekyllrb.com/docs/configuration/)
 * Take a gander at some existing [Sites](http://wiki.github.com/mojombo/jekyll/sites)
-* Fork and [Contribute](https://github.com/mojombo/jekyll/blob/master/CONTRIBUTING.md) your own modifications
-* Have questions? Post them on the [Mailing List](http://groups.google.com/group/jekyll-rb)
+* Fork and [Contribute](http://jekyllrb.com/docs/contributing/) your own modifications
+* Have questions? Check out `#jekyll` on irc.freenode.net.
 
 ## Diving In
 
@@ -26,19 +29,26 @@ Jekyll is a simple, blog aware, static site generator. It takes a template direc
 
 ## Runtime Dependencies
 
+* Commander: Command-line interface constructor (Ruby)
+* Colorator: Colorizes command line output (Ruby)
 * Classifier: Generating related posts (Ruby)
 * Directory Watcher: Auto-regeneration of sites (Ruby)
-* Kramdown: Markdown-superset converter (Ruby)
 * Liquid: Templating system (Ruby)
 * Maruku: Default markdown engine (Ruby)
+* Pygments.rb: Syntax highlighting (Ruby/Python)
+* RedCarpet: Markdown engine (Ruby)
+* Safe YAML: YAML Parser built for security (Ruby)
 
 ## Developer Dependencies
 
+* Kramdown: Markdown-superset converter (Ruby)
+* Launchy: Cross-platform file launcher (Ruby)
 * RDiscount: Discount Markdown Processor (Ruby)
 * RedCloth: Textile support (Ruby)
 * RedGreen: Nicer test output (Ruby)
 * RR: Mocking (Ruby)
 * Shoulda: Test framework (Ruby)
+* SimpleCov: Coverage framework (Ruby)
 
 ## License
 

data/Rakefile

@@ -51,7 +51,7 @@ end
 
 def linkify_prs(markdown)
   markdown.gsub(/#(\d+)/) do |word|
-    "[#{word}](https://github.com/mojombo/jekyll/issues/#{word.delete("#")})"
+    "[#{word}]({{ site.repository }}/issues/#{word.delete("#")})"
   end
 end
 
@@ -147,6 +147,15 @@ namespace :site do
     end
   end
 
+  desc "Update normalize.css library to the latest version and minify"
+  task :update_normalize_css do
+    Dir.chdir("site/css") do
+      sh 'curl "http://necolas.github.io/normalize.css/latest/normalize.css" -o "normalize.scss"'
+      sh 'sass "normalize.scss":"normalize.css" --style compressed'
+      sh 'rm "normalize.scss"'
+    end
+  end
+
   desc "Commit the local site to the gh-pages branch and publish to GitHub Pages"
   task :publish => [:history] do
     # Ensure the gh-pages dir exists so we can generate into it.
@@ -167,7 +176,7 @@ namespace :site do
     # Copy to gh-pages dir.
     puts "Copying site to gh-pages branch..."
     Dir.glob("site/*") do |path|
-      next if path == "_site"
+      next if path.include? "_site"
       sh "cp -R #{path} gh-pages/"
     end
 

data/bin/jekyll

@@ -18,7 +18,7 @@ global_option '-s', '--source [DIR]', 'Source directory (defaults to ./)'
 global_option '-d', '--destination [DIR]', 'Destination directory (defaults to ./_site)'
 global_option '--safe', 'Safe mode (defaults to false)'
 global_option '-p', '--plugins PLUGINS_DIR1[,PLUGINS_DIR2[,...]]', Array, 'Plugins directory (defaults to ./_plugins)'
-global_option '--layouts', 'Layouts directory (defaults to ./_layouts)'
+global_option '--layouts DIR', String, 'Layouts directory (defaults to ./_layouts)'
 
 # Option names don't always directly match the configuration value we'd like.
 # This method will rename options to match what Jekyll configuration expects.
@@ -64,7 +64,7 @@ command :build do |c|
   c.option '--limit_posts MAX_POSTS', Integer, 'Limits the number of posts to parse and publish'
   c.option '-w', '--watch', 'Watch for changes and rebuild'
   c.option '--lsi', 'Use LSI for improved related posts'
-  c.option '--drafts', 'Render posts in the _drafts folder'
+  c.option '-D', '--drafts', 'Render posts in the _drafts folder'
 
   c.action do |args, options|
     options = normalize_options(options.__hash__)
@@ -82,7 +82,8 @@ command :serve do |c|
   c.option '--limit_posts MAX_POSTS', Integer, 'Limits the number of posts to parse and publish'
   c.option '-w', '--watch', 'Watch for changes and rebuild'
   c.option '--lsi', 'Use LSI for improved related posts'
-  c.option '--drafts', 'Render posts in the _drafts folder'
+  c.option '-B', '--detach', 'Run the server in the background (detach)'
+  c.option '-D', '--drafts', 'Render posts in the _drafts folder'
 
   c.option '-P', '--port [PORT]', 'Port to listen on'
   c.option '-H', '--host [HOST]', 'Host to bind to'
@@ -122,10 +123,10 @@ command :docs do |c|
 
   c.action do |args, options|
     options = normalize_options(options.__hash__)
-    options = Jekyll.configuration(options).merge({
+    options = Jekyll.configuration(options.merge!({
       'source' => File.expand_path("../site", File.dirname(__FILE__)),
       'destination' => File.expand_path("../site/_site", File.dirname(__FILE__))
-    })
+    }))
     puts options
     Jekyll::Commands::Build.process(options)
     Jekyll::Commands::Serve.process(options)

data/features/permalinks.feature

@@ -63,3 +63,23 @@ Feature: Fancy permalinks
     When I run jekyll
     Then the _site directory should exist
     And I should see "Totally custom." in "_site/03-27-2009/custom-permalink-schema.html"
+
+  Scenario: Use per-post permalink
+    Given I have a _posts directory
+    And I have the following post:
+      | title     | date      | permalink       | content |
+      | Some post | 2013-04-14 | /custom/posts/1 | bla bla |
+    When I run jekyll
+    Then the _site directory should exist
+    And the _site/custom/posts/1 directory should exist
+    And I should see "bla bla" in "_site/custom/posts/1/index.html"
+
+  Scenario: Use per-post ending in .html
+    Given I have a _posts directory
+    And I have the following post:
+      | title     | date      | permalink               | content |
+      | Some post | 2013-04-14 | /custom/posts/some.html | bla bla |
+    When I run jekyll
+    Then the _site directory should exist
+    And the _site/custom/posts directory should exist
+    And I should see "bla bla" in "_site/custom/posts/some.html"

data/features/site_data.feature

@@ -99,3 +99,9 @@ Feature: Site data
     When I run jekyll
     Then the _site directory should exist
     And I should see "http://mysite.com" in "_site/index.html"
+
+  Scenario: Access Jekyll version via jekyll.version
+    Given I have an "index.html" page that contains "{{ jekyll.version }}"
+    When I run jekyll
+    Then the _site directory should exist
+    And I should see "\d+\.\d+\.\d+" in "_site/index.html"

data/features/step_definitions/jekyll_steps.rb

@@ -65,7 +65,7 @@ Given /^I have the following (draft|post)s?(?: (in|under) "([^"]+)")?:$/ do |sta
     path = File.join(before, folder_post, after, filename)
 
     matter_hash = {}
-    %w(title layout tag tags category categories published author path date).each do |key|
+    %w(title layout tag tags category categories published author path date permalink).each do |key|
       matter_hash[key] = post[key] if post[key]
     end
     matter = matter_hash.map { |k, v| "#{k}: #{v}\n" }.join.chomp

data/jekyll.gemspec

@@ -4,9 +4,9 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
 
   s.name              = 'jekyll'
-  s.version           = '1.1.2'
+  s.version           = '1.2.0'
   s.license           = 'MIT'
-  s.date              = '2013-07-25'
+  s.date              = '2013-09-06'
   s.rubyforge_project = 'jekyll'
 
   s.summary     = "A simple, blog aware, static site generator."
@@ -27,7 +27,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('classifier', "~> 1.3")
   s.add_runtime_dependency('directory_watcher', "~> 1.4.1")
   s.add_runtime_dependency('maruku', "~> 0.5")
-  s.add_runtime_dependency('kramdown', "~> 1.0.2")
   s.add_runtime_dependency('pygments.rb', "~> 0.5.0")
   s.add_runtime_dependency('commander', "~> 4.1.3")
   s.add_runtime_dependency('safe_yaml', "~> 0.7.0")
@@ -41,6 +40,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency('rr', "~> 1.0.0")
   s.add_development_dependency('cucumber', "~> 1.2.1", '!= 1.2.4')
   s.add_development_dependency('RedCloth', "~> 4.2")
+  s.add_development_dependency('kramdown', "~> 1.0.2")
   s.add_development_dependency('rdiscount', "~> 1.6")
   s.add_development_dependency('launchy', "~> 2.1.2")
   s.add_development_dependency('simplecov', "~> 0.7")
@@ -72,6 +72,7 @@ Gem::Specification.new do |s|
     features/support/env.rb
     jekyll.gemspec
     lib/jekyll.rb
+    lib/jekyll/cleaner.rb
     lib/jekyll/command.rb
     lib/jekyll/commands/build.rb
     lib/jekyll/commands/doctor.rb
@@ -108,6 +109,7 @@ Gem::Specification.new do |s|
     lib/jekyll/tags/highlight.rb
     lib/jekyll/tags/include.rb
     lib/jekyll/tags/post_url.rb
+    lib/jekyll/url.rb
     lib/site_template/.gitignore
     lib/site_template/_config.yml
     lib/site_template/_layouts/default.html
@@ -144,6 +146,7 @@ Gem::Specification.new do |s|
     site/_posts/2013-07-24-jekyll-1-1-1-released.markdown
     site/_posts/2013-07-25-jekyll-1-0-4-released.markdown
     site/_posts/2013-07-25-jekyll-1-1-2-released.markdown
+    site/_posts/2013-09-06-jekyll-1-2-0-released.markdown
     site/css/gridism.css
     site/css/normalize.css
     site/css/pygments.css
@@ -233,6 +236,7 @@ Gem::Specification.new do |s|
     test/source/_posts/2013-04-11-custom-excerpt.markdown
     test/source/_posts/2013-05-10-number-category.textile
     test/source/_posts/2013-07-22-post-excerpt-with-layout.markdown
+    test/source/_posts/2013-08-01-mkdn-extension.mkdn
     test/source/_posts/es/2008-11-21-nested.textile
     test/source/about.html
     test/source/category/_posts/2008-9-23-categories.textile
@@ -267,6 +271,7 @@ Gem::Specification.new do |s|
     test/test_related_posts.rb
     test/test_site.rb
     test/test_tags.rb
+    test/test_url.rb
   ]
   # = MANIFEST =
 

data/lib/jekyll.rb

@@ -33,6 +33,7 @@ require 'jekyll/deprecator'
 require 'jekyll/configuration'
 require 'jekyll/site'
 require 'jekyll/convertible'
+require 'jekyll/url'
 require 'jekyll/layout'
 require 'jekyll/page'
 require 'jekyll/post'
@@ -42,6 +43,7 @@ require 'jekyll/filters'
 require 'jekyll/static_file'
 require 'jekyll/errors'
 require 'jekyll/related_posts'
+require 'jekyll/cleaner'
 
 # extensions
 require 'jekyll/plugin'
@@ -58,7 +60,7 @@ require_all 'jekyll/tags'
 SafeYAML::OPTIONS[:suppress_warnings] = true
 
 module Jekyll
-  VERSION = '1.1.2'
+  VERSION = '1.2.0'
 
   # Public: Generate a Jekyll configuration Hash by merging the default
   # options with anything in _config.yml, and adding the given options on top.

data/lib/jekyll/cleaner.rb

@@ -0,0 +1,73 @@
+require 'set'
+
+module Jekyll
+  class Site
+    # Handles the cleanup of a site's destination before the site is built.
+    class Cleaner
+      def initialize(site)
+        @site = site
+      end
+
+      # Cleans up the site's destination directory
+      def cleanup!
+        FileUtils.rm_rf(obsolete_files)
+      end
+
+      private
+
+      # Private: The list of files and directories to be deleted during the cleanup process
+      #
+      # Returns an Array with the file and directory paths
+      def obsolete_files
+        (existing_files - new_files - new_dirs + replaced_files).to_a
+      end
+
+      # Private: The list of existing files, except those included in keep_files and hidden files.
+      #
+      # Returns a Set with the file paths
+      def existing_files
+        files = Set.new
+        Dir.glob(File.join(@site.dest, "**", "*"), File::FNM_DOTMATCH) do |file|
+          files << file unless file =~ /\/\.{1,2}$/ || file =~ keep_file_regex
+        end
+        files
+      end
+
+      # Private: The list of files to be created when the site is built.
+      #
+      # Returns a Set with the file paths
+      def new_files
+        files = Set.new
+        @site.each_site_file { |item| files << item.destination(@site.dest) }
+        files
+      end
+
+      # Private: The list of directories to be created when the site is built.
+      # These are the parent directories of the files in #new_files.
+      #
+      # Returns a Set with the directory paths
+      def new_dirs
+        new_files.map { |file| File.dirname(file) }.to_set
+      end
+
+      # Private: The list of existing files that will be replaced by a directory during build
+      #
+      # Returns a Set with the file paths
+      def replaced_files
+        new_dirs.select { |dir| File.file?(dir) }.to_set
+      end
+
+      # Private: creates a regular expression from the config's keep_files array
+      #
+      # Examples
+      #   ['.git','.svn'] creates the following regex: /\/(\.git|\/.svn)/
+      #
+      # Returns the regular expression
+      def keep_file_regex
+        or_list = @site.keep_files.join("|")
+        pattern = "\/(#{or_list.gsub(".", "\.")})"
+        Regexp.new pattern
+      end
+    end
+  end
+end

data/lib/jekyll/commands/doctor.rb

@@ -6,23 +6,61 @@ module Jekyll
           site = Jekyll::Site.new(options)
           site.read
 
-          unless deprecated_relative_permalinks(site)
+          if healthy?(site)
             Jekyll.logger.info "Your test results", "are in. Everything looks fine."
+          else
+            abort
           end
         end
 
+        def healthy?(site)
+          [
+            !deprecated_relative_permalinks(site),
+            !conflicting_urls(site)
+          ].all?
+        end
+
         def deprecated_relative_permalinks(site)
           contains_deprecated_pages = false
           site.pages.each do |page|
             if page.uses_relative_permalinks
               Jekyll.logger.warn "Deprecation:", "'#{page.path}' uses relative" +
                                   " permalinks which will be deprecated in" +
-                                  " Jekyll v1.1 and beyond."
+                                  " Jekyll v1.2 and beyond."
               contains_deprecated_pages = true
             end
           end
           contains_deprecated_pages
         end
+
+        def conflicting_urls(site)
+          conflicting_urls = false
+          urls = {}
+          urls = collect_urls(urls, site.pages, site.dest)
+          urls = collect_urls(urls, site.posts, site.dest)
+          urls.each do |url, paths|
+            if paths.size > 1
+              conflicting_urls = true
+              Jekyll.logger.warn "Conflict:", "The URL '#{url}' is the destination" +
+                " for the following pages: #{paths.join(", ")}"
+            end
+          end
+          conflicting_urls
+        end
+
+        private
+
+        def collect_urls(urls, things, destination)
+          things.each do |thing|
+            dest = thing.destination(destination)
+            if urls[dest]
+              urls[dest] << thing.path
+            else
+              urls[dest] = [thing.path]
+            end
+          end
+          urls
+        end
       end
     end
   end