jekyll 1.0.0.beta4 → 1.0.0.rc1

data/History.txt

@@ -6,6 +6,15 @@
     * Added ability to render drafts in _drafts folder via command line (#833)
     * Add ordinal date permalink style (/:categories/:year/:y_day/:title.html) (#928)
   * Minor Enhancements
+    * Add `timezone` configuration option for compilation (#957)
+    * Add deprecation messages for pre-1.0 CLI options (#959)
+    * Refactor and colorize logging (#959)
+    * Refactor Markdown parsing (#955)
+    * Added application/vnd.apple.pkpass to mime.types served by WEBrick (#907)
+    * Move template site to default markdown renderer (#961)
+    * Expose new attribute to Liquid via `page`: `page.path` (#951)
+    * Accept multiple config files from command line (#945)
+    * Add page variable to liquid custom tags and blocks (#413)
     * Add paginator.previous_page_path and paginator.next_page_path (#942)
     * Backwards compatibility for 'auto' (#821, #934)
     * Added date_to_rfc822 used on RSS feeds (#892)
@@ -31,11 +40,13 @@
     * Truncate post slugs when importing from Tumblr (#496)
     * Add glob support to include, exclude option (#743)
     * Layout of Page or Post defaults to 'page' or 'post', respectively (#580)
+      REPEALED by (#977)
     * "Keep files" feature (#685)
     * Output full path & name for files that don't parse (#745)
     * Add source and destination directory protection (#535)
     * Better YAML error message (#718)
   * Bug Fixes
+    * Allow 'excerpt' in YAML Front-Matter to override the extracted excerpt (#946)
     * Fix cascade problem with site.baseurl, site.port and site.host. (#935)
     * Filter out directories with valid post names (#875)
     * Fix symlinked static files not being correctly built in unsafe mode (#909)
@@ -56,6 +67,9 @@
     * Add SVG support to Jekyll/WEBrick. (#407, #406)
     * Prevent custom destination from causing continuous regen on watch (#528, #820, #862)
   * Site Enhancements
+    * Update quickstart instructions with `new` command (#966)
+    * Add docs for page.excerpt (#956)
+    * Add docs for page.path (#951)
     * Clean up site docs to prepare for 1.0 release (#918)
     * Bring site into master branch with better preview/deploy (#709)
     * Redesigned site (#583)

data/bin/jekyll

@@ -6,6 +6,8 @@ $:.unshift File.join(File.dirname(__FILE__), *%w{ .. lib })
 require 'commander/import'
 require 'jekyll'
 
+Jekyll::Deprecator.process(ARGV)
+
 program :name, 'jekyll'
 program :version, Jekyll::VERSION
 program :description, 'Jekyll is a blog-aware, static site generator in Ruby'
@@ -44,7 +46,7 @@ command :build do |c|
   c.syntax = 'jekyll build [options]'
   c.description = 'Build your site'
 
-  c.option '--config [CONFIG_FILE]', 'Custom configuration file'
+  c.option '--config CONFIG_FILE[,CONFIG_FILE2,...]', Array, 'Custom configuration file'
   c.option '--future', 'Publishes posts with a future date'
   c.option '--limit_posts MAX_POSTS', 'Limits the number of posts to parse and publish'
   c.option '-w', '--watch', 'Watch for changes and rebuild'
@@ -52,7 +54,6 @@ command :build do |c|
   c.option '--drafts', 'Render posts in the _drafts folder'
 
   c.action do |args, options|
-    options.defaults :serving => false
     options = normalize_options(options.__hash__)
     options = Jekyll.configuration(options)
     Jekyll::Commands::Build.process(options)
@@ -63,7 +64,7 @@ command :serve do |c|
   c.syntax = 'jekyll serve [options]'
   c.description = 'Serve your site locally'
 
-  c.option '--config [CONFIG_FILE]', 'Custom configuration file'
+  c.option '--config CONFIG_FILE[,CONFIG_FILE2,...]', Array, 'Custom configuration file'
   c.option '--future', 'Publishes posts with a future date'
   c.option '--limit_posts MAX_POSTS', 'Limits the number of posts to parse and publish'
   c.option '-w', '--watch', 'Watch for changes and rebuild'

data/features/post_data.feature

@@ -153,6 +153,30 @@ Feature: Post data
     And I should see "Post categories: scifi and movies" in "_site/scifi/movies/2009/03/27/star-wars.html"
     And I should see "Post categories: scifi and movies" in "_site/scifi/movies/2013/03/17/star-trek.html"
 
+  Scenario Outline: Use page.path variable
+    Given I have a <dir>/_posts directory
+    And I have the following post in "<dir>":
+      | title | type | date | content |
+      | my-post | html | 4/12/2013 | Source path: {{ page.path }} |
+    When I run jekyll
+    Then the _site directory should exist
+    And I should see "Source path: <path_prefix>_posts/2013-04-12-my-post.html" in "_site/<dir>/2013/04/12/my-post.html"
+
+    Examples:
+      | dir | path_prefix |
+      | .   |             |
+      | dir | dir/        |
+      | dir/nested | dir/nested/ |
+
+  Scenario: Override page.path variable
+    Given I have a _posts directory
+    And I have the following post:
+      | title    | date      | path               | content                      |
+      | override | 4/12/2013 | override-path.html | Custom path: {{ page.path }} |
+    When I run jekyll
+    Then the _site directory should exist
+    And I should see "Custom path: override-path.html" in "_site/2013/04/12/override.html"
+
   Scenario: Disable a post from being published
     Given I have a _posts directory
     And I have an "index.html" file that contains "Published!"

data/features/site_configuration.feature

@@ -116,6 +116,46 @@ Feature: Site configuration
     And I should see "Post Layout: <p>content for entry1.</p>" in "_site/2007/12/31/entry1.html"
     And I should see "Post Layout: <p>content for entry2.</p>" in "_site/2020/01/31/entry2.html"
 
+    Scenario: Generate proper dates with explicitly set timezone (same as posts' time)
+      Given I have a _layouts directory
+      And I have a page layout that contains "Page Layout: {{ site.posts.size }}"
+      And I have a post layout that contains "Post Layout: {{ content }} built at {{ page.date | date_to_xmlschema }}"
+      And I have an "index.html" page with layout "page" that contains "site index page"
+      And I have a configuration file with:
+        | key         | value            |
+        | timezone    | America/New_York |
+      And I have a _posts directory
+      And I have the following posts:
+        | title     | date                   | layout  | content             |
+        | entry1    | 2013-04-09 23:22 -0400 | post    | content for entry1. |
+        | entry2    | 2013-04-10 03:14 -0400 | post    | content for entry2. |
+      When I run jekyll
+      Then the _site directory should exist
+      And I should see "Page Layout: 2" in "_site/index.html"
+      And I should see "Post Layout: <p>content for entry1.</p> built at 2013-04-09T23:22:00-04:00" in "_site/2013/04/09/entry1.html"
+      And I should see "Post Layout: <p>content for entry2.</p> built at 2013-04-10T03:14:00-04:00" in "_site/2013/04/10/entry2.html"
+
+    Scenario: Generate proper dates with explicitly set timezone (different than posts' time)
+      Given I have a _layouts directory
+      And I have a page layout that contains "Page Layout: {{ site.posts.size }}"
+      And I have a post layout that contains "Post Layout: {{ content }} built at {{ page.date | date_to_xmlschema }}"
+      And I have an "index.html" page with layout "page" that contains "site index page"
+      And I have a configuration file with:
+        | key         | value               |
+        | timezone    | Australia/Melbourne |
+      And I have a _posts directory
+      And I have the following posts:
+        | title     | date                   | layout  | content             |
+        | entry1    | 2013-04-09 23:22 -0400 | post    | content for entry1. |
+        | entry2    | 2013-04-10 03:14 -0400 | post    | content for entry2. |
+      When I run jekyll
+      Then the _site directory should exist
+      And I should see "Page Layout: 2" in "_site/index.html"
+      And the "_site/2013/04/10/entry1.html" file should exist
+      And the "_site/2013/04/10/entry2.html" file should exist
+      And I should see escaped "Post Layout: <p>content for entry1.</p> built at 2013-04-10T13:22:00+10:00" in "_site/2013/04/10/entry1.html"
+      And I should see escaped "Post Layout: <p>content for entry2.</p> built at 2013-04-10T17:14:00+10:00" in "_site/2013/04/10/entry2.html"
+
   Scenario: Limit the number of posts generated by most recent date
     Given I have a _posts directory
     And I have a configuration file with:

data/features/site_data.feature

@@ -9,6 +9,25 @@ Feature: Site data
     Then the _site directory should exist
     And I should see "Contact: email@me.com" in "_site/contact.html"
 
+  Scenario Outline: Use page.path variable in a page
+    Given I have a <dir> directory
+    And I have a "<path>" page that contains "Source path: {{ page.path }}"
+    When I run jekyll
+    Then the _site directory should exist
+    And I should see "Source path: <path>" in "_site/<path>"
+
+    Examples:
+      | dir | path |
+      | .   | index.html |
+      | dir | dir/about.html |
+      | dir/nested | dir/nested/page.html |
+
+  Scenario: Override page.path
+    Given I have an "override.html" page with path "custom-override.html" that contains "Custom path: {{ page.path }}"
+    When I run jekyll
+    Then the _site directory should exist
+    And I should see "Custom path: custom-override.html" in "_site/override.html"
+
   Scenario: Use site.time variable
     Given I have an "index.html" page that contains "{{ site.time }}"
     When I run jekyll

data/features/step_definitions/jekyll_steps.rb

@@ -1,4 +1,5 @@
 Before do
+  FileUtils.rm_rf(TEST_DIR)
   FileUtils.mkdir(TEST_DIR)
   Dir.chdir(TEST_DIR)
 end
@@ -61,14 +62,24 @@ Given /^I have the following (draft|post)s?(?: (.*) "(.*)")?:$/ do |status, dire
     if "draft" == status
       path = File.join(before || '.', '_drafts', after || '.', "#{title}.#{ext}")
     else
-      date = Date.strptime(post['date'], '%m/%d/%Y').strftime('%Y-%m-%d')
+      format = if has_time_component?(post['date'])
+        '%Y-%m-%d %H:%M %z'
+      else
+        '%m/%d/%Y' # why even
+      end
+      parsed_date = DateTime.strptime(post['date'], format)
+      post['date'] = parsed_date.to_s
+      date = parsed_date.strftime('%Y-%m-%d')
       path = File.join(before || '.', '_posts', after || '.', "#{date}-#{title}.#{ext}")
     end
 
     matter_hash = {}
-    %w(title layout tag tags category categories published author).each do |key|
+    %w(title layout tag tags category categories published author path).each do |key|
       matter_hash[key] = post[key] if post[key]
     end
+    if "post" == status
+      matter_hash["date"] = post["date"] if post["date"]
+    end
     matter = matter_hash.map { |k, v| "#{k}: #{v}\n" }.join.chomp
 
     content = post['content']
@@ -134,7 +145,11 @@ Then /^the (.*) directory should exist$/ do |dir|
 end
 
 Then /^I should see "(.*)" in "(.*)"$/ do |text, file|
-  assert_match Regexp.new(text), File.open(file).readlines.join
+  assert Regexp.new(text).match(File.open(file).readlines.join)
+end
+
+Then /^I should see escaped "(.*)" in "(.*)"$/ do |text, file|
+  assert Regexp.new(Regexp.escape(text)).match(File.open(file).readlines.join)
 end
 
 Then /^the "(.*)" file should exist$/ do |file|

data/features/support/env.rb

@@ -7,7 +7,7 @@ World do
 end
 
 TEST_DIR    = File.join('/', 'tmp', 'jekyll')
-JEKYLL_PATH = File.join(ENV['PWD'], 'bin', 'jekyll')
+JEKYLL_PATH = File.join(File.dirname(__FILE__), '..', '..', 'bin', 'jekyll')
 
 def run_jekyll(opts = {})
   command = JEKYLL_PATH.clone
@@ -17,5 +17,9 @@ def run_jekyll(opts = {})
   system command
 end
 
+def has_time_component?(date_string)
+  date_string.split(" ").size > 1
+end
+
 # work around "invalid option: --format" cucumber bug (see #296)
 Test::Unit.run = true if RUBY_VERSION < '1.9'

data/jekyll.gemspec

@@ -4,9 +4,9 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
 
   s.name              = 'jekyll'
-  s.version           = '1.0.0.beta4'
+  s.version           = '1.0.0.rc1'
   s.license           = 'MIT'
-  s.date              = '2013-04-09'
+  s.date              = '2013-04-16'
   s.rubyforge_project = 'jekyll'
 
   s.summary     = "A simple, blog aware, static site generator."
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('pygments.rb', "~> 0.4.2")
   s.add_runtime_dependency('commander', "~> 4.1.3")
   s.add_runtime_dependency('safe_yaml', "~> 0.7.0")
+  s.add_runtime_dependency('colorator', "~> 0.1")
 
   s.add_development_dependency('rake', "~> 10.0.3")
   s.add_development_dependency('rdoc', "~> 3.11")
@@ -72,18 +73,25 @@ Gem::Specification.new do |s|
     lib/jekyll/commands/build.rb
     lib/jekyll/commands/new.rb
     lib/jekyll/commands/serve.rb
+    lib/jekyll/configuration.rb
     lib/jekyll/converter.rb
     lib/jekyll/converters/identity.rb
     lib/jekyll/converters/markdown.rb
+    lib/jekyll/converters/markdown/kramdown_parser.rb
+    lib/jekyll/converters/markdown/maruku_parser.rb
+    lib/jekyll/converters/markdown/rdiscount_parser.rb
+    lib/jekyll/converters/markdown/redcarpet_parser.rb
     lib/jekyll/converters/textile.rb
     lib/jekyll/convertible.rb
     lib/jekyll/core_ext.rb
+    lib/jekyll/deprecator.rb
     lib/jekyll/draft.rb
     lib/jekyll/errors.rb
     lib/jekyll/filters.rb
     lib/jekyll/generator.rb
     lib/jekyll/generators/pagination.rb
     lib/jekyll/layout.rb
+    lib/jekyll/logger.rb
     lib/jekyll/mime.types
     lib/jekyll/page.rb
     lib/jekyll/plugin.rb
@@ -193,6 +201,7 @@ Gem::Specification.new do |s|
     test/source/_posts/2013-01-12-nil-layout.textile
     test/source/_posts/2013-01-12-no-layout.textile
     test/source/_posts/2013-03-19-not-a-post.markdown/.gitkeep
+    test/source/_posts/2013-04-11-custom-excerpt.markdown
     test/source/about.html
     test/source/category/_posts/2008-9-23-categories.textile
     test/source/contacts.html

data/lib/jekyll.rb

@@ -25,9 +25,13 @@ require 'English'
 require 'liquid'
 require 'maruku'
 require 'pygments'
+require 'colorator'
 
 # internal requires
 require 'jekyll/core_ext'
+require 'jekyll/logger'
+require 'jekyll/deprecator'
+require 'jekyll/configuration'
 require 'jekyll/site'
 require 'jekyll/convertible'
 require 'jekyll/layout'
@@ -46,123 +50,41 @@ require 'jekyll/command'
 
 require_all 'jekyll/commands'
 require_all 'jekyll/converters'
+require_all 'jekyll/converters/markdown'
 require_all 'jekyll/generators'
 require_all 'jekyll/tags'
 
 SafeYAML::OPTIONS[:suppress_warnings] = true
 
 module Jekyll
-  VERSION = '1.0.0.beta4'
-
-  # Default options. Overriden by values in _config.yml.
-  # Strings rather than symbols are used for compatability with YAML.
-  DEFAULTS = {
-    'source'        => Dir.pwd,
-    'destination'   => File.join(Dir.pwd, '_site'),
-    'plugins'       => '_plugins',
-    'layouts'       => '_layouts',
-    'keep_files'   => ['.git','.svn'],
-
-    'future'        => true,           # remove and make true just default
-    'pygments'      => true,           # remove and make true just default
-
-    'markdown'      => 'maruku',
-    'permalink'     => 'date',
-    'baseurl'       => '/',
-    'include'       => ['.htaccess'],
-    'paginate_path' => 'page:num',
-
-    'markdown_ext'  => 'markdown,mkd,mkdn,md',
-    'textile_ext'   => 'textile',
-
-    'port'          => '4000',
-    'host'          => '0.0.0.0',
-
-    'excerpt_separator' => "\n\n",
-
-    'maruku' => {
-      'use_tex'    => false,
-      'use_divs'   => false,
-      'png_engine' => 'blahtex',
-      'png_dir'    => 'images/latex',
-      'png_url'    => '/images/latex'
-    },
-
-    'rdiscount' => {
-      'extensions' => []
-    },
-
-    'redcarpet' => {
-      'extensions' => []
-    },
-
-    'kramdown' => {
-      'auto_ids'      => true,
-      'footnote_nr'   => 1,
-      'entity_output' => 'as_char',
-      'toc_levels'    => '1..6',
-      'smart_quotes'  => 'lsquo,rsquo,ldquo,rdquo',
-      'use_coderay'   => false,
-
-      'coderay' => {
-        'coderay_wrap'              => 'div',
-        'coderay_line_numbers'      => 'inline',
-        'coderay_line_number_start' => 1,
-        'coderay_tab_width'         => 4,
-        'coderay_bold_every'        => 10,
-        'coderay_css'               => 'style'
-      }
-    },
-
-    'redcloth' => {
-      'hard_breaks' => true
-    }
-  }
+  VERSION = '1.0.0.rc1'
 
   # Public: Generate a Jekyll configuration Hash by merging the default
   # options with anything in _config.yml, and adding the given options on top.
   #
   # override - A Hash of config directives that override any options in both
-  #            the defaults and the config file. See Jekyll::DEFAULTS for a
+  #            the defaults and the config file. See Jekyll::Configuration::DEFAULTS for a
   #            list of option names and their defaults.
   #
   # Returns the final configuration Hash.
   def self.configuration(override)
-    # Convert any symbol keys to strings and remove the old key/values
-    override = override.reduce({}) { |hsh,(k,v)| hsh.merge(k.to_s => v) }
-
-    # _config.yml may override default source location, but until
-    # then, we need to know where to look for _config.yml
-    source = override['source'] || Jekyll::DEFAULTS['source']
+    config = Configuration[Configuration::DEFAULTS]
+    override = Configuration[override].stringify_keys
+    config = config.read_config_files(config.config_files(override))
 
-    # Get configuration from <source>/_config.yml or <source>/<config_file>
-    config_file = override.delete('config')
-    config_file = File.join(source, "_config.yml") if config_file.to_s.empty?
-
-    begin
-      config = YAML.safe_load_file(config_file)
-      raise "Configuration file: (INVALID) #{config_file}" if !config.is_a?(Hash)
-      $stdout.puts "Configuration file: #{config_file}"
-    rescue SystemCallError
-      # Errno:ENOENT = file not found
-      $stderr.puts "Configuration file: none"
-      config = {}
-    rescue => err
-      $stderr.puts "           " +
-                   "WARNING: Error reading configuration. " +
-                   "Using defaults (and options)."
-      $stderr.puts "#{err}"
-      config = {}
-    end
+    # Merge DEFAULTS < _config.yml < override
+    config = config.deep_merge(override).stringify_keys
+    set_timezone(config['timezone']) if config['timezone']
 
-    # Provide backwards-compatibility
-    if config['auto']
-      $stderr.puts "Deprecation: ".rjust(20) + "'auto' has been changed to " +
-                   "'watch'. Please update your configuration to use 'watch'."
-      config['watch'] = config['auto']
-    end
+    config
+  end
 
-    # Merge DEFAULTS < _config.yml < override
-    Jekyll::DEFAULTS.deep_merge(config).deep_merge(override)
+  # Static: Set the TZ environment variable to use the timezone specified
+  #
+  # timezone - the IANA Time Zone
+  #
+  # Returns nothing
+  def self.set_timezone(timezone)
+    ENV['TZ'] = timezone
   end
 end