Merge remote-tracking branch 'upstream/master'

This commit is contained in:
Shinn Kondo 2016-03-23 19:33:22 -05:00
commit 01d48320fd
250 changed files with 8812 additions and 4604 deletions

29
.codeclimate.yml Normal file
View File

@ -0,0 +1,29 @@
engines:
rubocop: { enabled: true }
fixme: { enabled: false }
exclude_paths:
- .rubocop.yml
- .codeclimate.yml
- .travis.yml
- .gitignore
- .rspec
- Gemfile.lock
- CHANGELOG.{md,markdown,txt,textile}
- CONTRIBUTING.{md,markdown,txt,textile}
- readme.{md,markdown,txt,textile}
- README.{md,markdown,txt,textile}
- Readme.{md,markdown,txt,textile}
- ReadMe.{md,markdown,txt,textile}
- COPYING
- LICENSE
- site/**/*
- test/**/*
- vendor/**/*
- features/**/*
- script/**/*
- spec/**/*
ratings:
paths:
- lib/**/*.rb

122
.github/CONTRIBUTING.markdown vendored Normal file
View File

@ -0,0 +1,122 @@
# Contributing to Jekyll
Hi there! Interested in contributing to Jekyll? We'd love your help. Jekyll is an open source project, built one contribution at a time by users like you.
## Where to get help or report a problem
* If you have a question about using Jekyll, start a discussion on [Jekyll Talk](https://talk.jekyllrb.com).
* If you think you've found a bug within a Jekyll plugin, open an issue in that plugin's repository.
* If you think you've found a bug within Jekyll itself, [open an issue](https://github.com/jekyll/jekyll/issues/new)
* More resources are listed on our [Help page](https://jekyllrb.com/help/)
## Ways to contribute
Whether you're a developer, a designer, or just a Jekyll devotee, there are lots of ways to contribute. Here's a few ideas:
* [Install Jekyll on your computer](https://jekyllrb.com/docs/installation/) and kick the tires. Does it work? Does it do what you'd expect? If not, [open an issue](https://github.com/jekyll/jekyll/issues/new) and let us know.
* Comment on some of the project's [open issues](https://github.com/jekyll/jekyll/issues). Have you experienced the same problem? Know a work around? Do you have a suggestion for how the feature could be better?
* Read through [the documentation](https://jekyllrb.com/docs/home/), and click the "improve this page" button, any time you see something confusing, or have a suggestion for something that could be improved.
* Browse through [the Jekyll discussion forum](https://talk.jekyllrb.com/), and lend a hand answering questions. There's a good chance you've already experienced what another user is experiencing.
* Find [an open issue](https://github.com/jekyll/jekyll/issues) (especially [those labeled `help-wanted`](https://github.com/jekyll/jekyll/issues?q=is%3Aopen+is%3Aissue+label%3Ahelp-wanted)), and submit a proposed fix. If it's your first pull request, we promise we won't bite, and are glad to answer any questions.
* Help evaluate [open pull requests](https://github.com/jekyll/jekyll/pulls), by testing the changes locally and reviewing what's proposed.
## Submitting a pull request
### Pull requests generally
* The smaller the proposed change, the better. If you'd like to propose two unrelated changes, submit two pull requests.
* The more information, the better. Make judicious use of the pull request body. Describe what changes were made, why you made them, and what impact they will have for users.
* Pull request are easy and fun. If this is your first pull request, it may help to [understand GitHub Flow](https://guides.github.com/introduction/flow/)
* If you're submitting a code contribution, be sure to read the [code contributions](#code-contributions) section below.
### Submitting a pull request via github.com
Many small changes can be made entirely through the github.com web interface.
1. Navigate to the file within [`jekyll/jekyll`](https://github.com/jekyll/jekyll) that you'd like to edit
2. Click the pencil icon in the top right corner to edit the file
3. Make your proposed changes
4. Click "Propose file change"
5. Click "Create pull request"
6. Add a descriptive title and detailed description for your proposed change. The more information the better.
7. Click "Create pull request"
That's it! You'll be automatically subscribed to receive updates as others review your proposed change and provide feedback.
### Submitting a pull request via Git command line
1. Fork the project by clicking "Fork" in the top right corner of [`jekyll/jekyll`](https://github.com/jekyll/jekyll)
2. Clone the repository lcoally `git clone https://github.com/<you-username>/jekyll`
3. Create a new, descriptively named branch to contain your change ( `git checkout -b my-awesome-feature` ).
4. Hack away, add tests. Not necessarily in that order.
5. Make sure everything still passes by running `script/cibuild` (see [the tests section](#running-tests-locally) below)
6. Push the branch up ( `git push origin my-awesome-feature` ).
7. Create a pull request by visiting https://github.com/<your-username>/jekyll/ and following the instructions at the top of the screen.
## Proposing updates to the documentation
We want the Jekyll documentation to be the best it can be. We've open-sourced our docs and we welcome any pull requests if you find it lacking.
### How to submit changes
You can find the documentation for jekyllrb.com in the [site](https://github.com/jekyll/jekyll/tree/master/site) directory. See the section above, [submitting a pull request](#submitting-a-pull-request) for information on how to propose a change.
One gotcha, all pull requests should be directed at the `master` branch (the default branch).
### Adding plugins
If you want to add your plugin to the [list of plugins](https://jekyllrb.com/docs/plugins/#available-plugins), please submit a pull request modifying the [plugins page source file](site/_docs/plugins.md) by adding a link to your plugin under the proper subheading depending upon its type.
## Code Contributions
Interesting in submitting a pull request? Awesome. Read on. There's a few common gotchas that we'd love to help you avoid.
### Tests and documentation
Any time you propose a code change, you should also include updates to the documentation and tests within the same pull request.
#### Documentation
If your contribution changes any Jekyll behavior, make sure to update the documentation. Documentation lives in the `site/_docs` folder (spoiler alert: it's a Jekyll site!). If the docs are missing information, please feel free to add it in. Great docs make a great project. Include changes to the documentation within your pull request, and once merged, `jekyllrb.com` will be updated.
#### Tests
* If you're creating a small fix or patch to an existing feature, a simple test if more than enough. You can usually copy/paste from an existing example in the `tests` folder, but if you need to can find out about our tests suites [Shoulda](https://github.com/thoughtbot/shoulda/tree/master) and [RSpec-Mocks](https://github.com/rspec/rspec-mocks).
* If it's a brand new feature, create a new [Cucumber](https://github.com/cucumber/cucumber/) feature, reusing existing steps where appropriate.
### Code contributions generally
* Jekyll follows the [GitHub Ruby Styleguide](https://github.com/styleguide/ruby).
* Don't bump the Gem version in your pull request (if you don't know what that means, you probably didn't).
## Running tests locally
### Test Dependencies
To run the test suite and build the gem you'll need to install Jekyll's dependencies by running the following command:
$ script/bootstrap
Before you make any changes, run the tests and make sure that they pass (to confirm your environment is configured properly):
$ script/cibuild
If you are only updating a file in `test/`, you can use the command:
$ script/test test/blah_test.rb
If you are only updating a `.feature` file, you can use the command:
$ script/cucumber features/blah.feature
Both `script/test` and `script/cucumber` can be run without arguments to
run its entire respective suite.
## A thank you
Thanks! Hacking on Jekyll should be fun. If you find any of this hard to figure out, let us know so we can improve our process or documentation!

20
.github/ISSUE_TEMPLATE.md vendored Normal file
View File

@ -0,0 +1,20 @@
###### What version of Jekyll are you using (`jekyll -v`)?
###### What operating system are you using?
###### What did you do?
(Please include the content causing the issue, any relevant configuration settings, and the command you ran)
###### What did you expect to see?
###### What did you see instead?

30
.gitignore vendored
View File

@ -1,20 +1,22 @@
Gemfile.lock
test/dest
*.gem *.gem
pkg/
*.swp *.swp
*~ *~
_site/
.bundle/
.DS_Store .DS_Store
bbin/ .analysis
gh-pages/ .bundle/
site/_site/ .byebug_history
coverage
.ruby-version
.ruby-gemset
.sass-cache
tmp/*
.jekyll-metadata .jekyll-metadata
/vendor .ruby-gemset
.ruby-version
.sass-cache
/test/source/file_name.txt /test/source/file_name.txt
/vendor
Gemfile.lock
_site/
bbin/
coverage
gh-pages/
pkg/
site/_site/
test/dest
tmp/*

View File

@ -1,6 +1,3 @@
backtrace.mask=true backtrace.mask=true
compile.invokedynamic=true
objectspace.enabled=true
backtrace.color=true backtrace.color=true
compat.version=2.2
backtrace.style=mri backtrace.style=mri

80
.rubocop.yml Normal file
View File

@ -0,0 +1,80 @@
Metrics/MethodLength: { Max: 24 }
Metrics/ClassLength: { Max: 240 }
Metrics/ModuleLength: { Max: 240 }
Metrics/LineLength: { Max: 112 }
Metrics/CyclomaticComplexity: { Max: 8 }
Metrics/PerceivedComplexity: { Max: 8 }
Metrics/ParameterLists: { Max: 4 }
Metrics/MethodLength: { Max: 24 }
Metrics/AbcSize: { Max: 20 }
Style/IndentHash: { EnforcedStyle: consistent }
Style/HashSyntax: { EnforcedStyle: hash_rockets }
Style/SignalException: { EnforcedStyle: only_raise }
Style/AlignParameters: { EnforcedStyle: with_fixed_indentation }
Style/StringLiteralsInInterpolation: { EnforcedStyle: double_quotes }
Style/MultilineMethodCallIndentation: { EnforcedStyle: indented }
Style/MultilineOperationIndentation: { EnforcedStyle: indented }
Style/FirstParameterIndentation: { EnforcedStyle: consistent }
Style/StringLiterals: { EnforcedStyle: double_quotes }
Style/RegexpLiteral: { EnforcedStyle: slashes }
Style/IndentArray: { EnforcedStyle: consistent }
Style/ExtraSpacing: { AllowForAlignment: true }
Style/PercentLiteralDelimiters:
PreferredDelimiters:
'%q': '{}'
'%Q': '{}'
'%r': '!!'
'%s': '()'
'%w': '()'
'%W': '()'
'%x': '()'
Style/AlignArray: { Enabled: false }
Style/StringLiterals: { Enabled: false }
Style/Documentation: { Enabled: false }
Style/DoubleNegation: { Enabled: false }
Style/UnneededCapitalW: { Enabled: false }
Style/EmptyLinesAroundModuleBody: { Enabled: false }
Style/EmptyLinesAroundAccessModifier: { Enabled: false }
Style/BracesAroundHashParameters: { Enabled: false }
Style/SpaceInsideBrackets: { Enabled: false }
Style/IfUnlessModifier: { Enabled: false }
Style/ModuleFunction: { Enabled: false }
Style/RescueModifier: { Enabled: false }
Style/GuardClause: { Enabled: false }
Style/FileName: { Enabled: false }
Lint/UselessAccessModifier: { Enabled: false }
Style/SpaceAroundOperators: { Enabled: false }
Style/RedundantReturn: { Enabled: false }
Style/SingleLineMethods: { Enabled: false }
AllCops:
TargetRubyVersion: 2.0
Include:
- lib/**/*.rb
Exclude:
- .rubocop.yml
- .codeclimate.yml
- .travis.yml
- .gitignore
- .rspec
- Gemfile.lock
- CHANGELOG.{md,markdown,txt,textile}
- CONTRIBUTING.{md,markdown,txt,textile}
- readme.{md,markdown,txt,textile}
- README.{md,markdown,txt,textile}
- Readme.{md,markdown,txt,textile}
- ReadMe.{md,markdown,txt,textile}
- COPYING
- LICENSE
- site/**/*
- test/**/*
- vendor/**/*
- features/**/*
- script/**/*
- spec/**/*

View File

@ -1,30 +1,52 @@
language: ruby before_script: bundle update
bundler_args: --without benchmark:site:development
script: script/cibuild
cache: bundler cache: bundler
language: ruby
sudo: false sudo: false
rvm: rvm:
- 2.2 - &ruby1 2.3.0
- 2.1 - &ruby2 2.2.4
- 2.0 - &ruby3 2.1.8
- jruby-head - &jruby jruby-9.0.4.0
- &rhead ruby-head
matrix: matrix:
fast_finish: true
allow_failures: allow_failures:
- rvm: jruby-head - rvm: *jruby
- rvm: *rhead
env: env:
matrix: matrix:
- TEST_SUITE=test - TEST_SUITE=test
- TEST_SUITE=cucumber - TEST_SUITE=cucumber
before_script: bundle update
script: script/cibuild branches:
only:
- master
notifications: notifications:
irc: irc:
on_success: change template: "%{repository}#%{build_number} (%{branch}) %{message} %{build_url}"
on_failure: change channels: irc.freenode.org#jekyll
channels:
- irc.freenode.org#jekyll
template:
- "%{repository}#%{build_number} (%{branch}) %{message} %{build_url}"
email: email:
on_success: never recipients:
on_failure: never - jordon@envygeeks.io
slack: slack:
secure: dNdKk6nahNURIUbO3ULhA09/vTEQjK0fNbgjVjeYPEvROHgQBP1cIP3AJy8aWs8rl5Yyow4YGEilNRzKPz18AsFptVXofpwyqcBxaCfmHP809NX5PHBaadydveLm+TNVao2XeLXSWu+HUNAYO1AanCUbJSEyJTju347xCBGzESU= secure: "\
dNdKk6nahNURIUbO3ULhA09/vTEQjK0fNbgjVjeYPEvROHgQBP1cIP3AJy8aWs8rl5Yyow4Y\
GEilNRzKPz18AsFptVXofpwyqcBxaCfmHP809NX5PHBaadydveLm+TNVao2XeLXSWu+HUNAY\
O1AanCUbJSEyJTju347xCBGzESU=\
"
addons:
code_climate:
repo_token:
secure: "\
mAuvDu+nrzB8dOaLqsublDGt423mGRyZYM3vsrXh4Tf1sT+L1PxsRzU4gLmcV27HtX2Oq9\
DA4vsRURfABU0fIhwYkQuZqEcA3d8TL36BZcGEshG6MQ2AmnYsmFiTcxqV5bmlElHEqQuT\
5SUFXLafgZPBnL0qDwujQcHukID41sE=\
"

49
CONDUCT.markdown Normal file
View File

@ -0,0 +1,49 @@
# Code of Conduct
As contributors and maintainers of this project, and in the interest of
fostering an open and welcoming community, we pledge to respect all people who
contribute through reporting issues, posting feature requests, updating
documentation, submitting pull requests or patches, and other activities.
We are committed to making participation in this project a harassment-free
experience for everyone, regardless of level of experience, gender, gender
identity and expression, sexual orientation, disability, personal appearance,
body size, race, ethnicity, age, religion, or nationality.
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery
* Personal attacks
* Trolling or insulting/derogatory comments
* Public or private harassment
* Publishing other's private information, such as physical or electronic
addresses, without explicit permission
* Other unethical or unprofessional conduct
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
By adopting this Code of Conduct, project maintainers commit themselves to
fairly and consistently applying these principles to every aspect of managing
this project. Project maintainers who do not follow or enforce the Code of
Conduct may be permanently removed from the project team.
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community.
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by opening an issue or contacting a project maintainer. All complaints
will be reviewed and investigated and will result in a response that is deemed
necessary and appropriate to the circumstances. Maintainers are obligated to
maintain confidentiality with regard to the reporter of an incident.
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.3.0, available at
[http://contributor-covenant.org/version/1/3/0/][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/3/0/

View File

@ -1,92 +0,0 @@
Contribute
==========
So you've got an awesome idea to throw into Jekyll. Great! Please keep the
following in mind:
* **Use https://talk.jekyllrb.com for non-technical or indirect Jekyll questions that are not bugs.**
* **Contributions will not be accepted without tests or necessary documentation updates.**
* If you're creating a small fix or patch to an existing feature, just a simple
test will do. Please stay in the confines of the current test suite and use
[Shoulda](https://github.com/thoughtbot/shoulda/tree/master) and
[RSpec-Mocks](https://github.com/rspec/rspec-mocks).
* If it's a brand new feature, make sure to create a new
[Cucumber](https://github.com/cucumber/cucumber/) feature and reuse steps
where appropriate. Also, whipping up some documentation in your fork's `site`
would be appreciated, and once merged it will be transferred over to the main
`site`, jekyllrb.com.
* If your contribution changes any Jekyll behavior, make sure to update the
documentation. It lives in `site/_docs`. If the docs are missing information,
please feel free to add it in. Great docs make a great project!
* Please follow the [GitHub Ruby Styleguide](https://github.com/styleguide/ruby)
when modifying Ruby code.
* Please do your best to submit **small pull requests**. The easier the proposed
change is to review, the more likely it will be merged.
* When submitting a pull request, please make judicious use of the pull request
body. A description of what changes were made, the motivations behind the
changes and [any tasks completed or left to complete](http://git.io/gfm-tasks)
will also speed up review time.
Test Dependencies
-----------------
To run the test suite and build the gem you'll need to install Jekyll's
dependencies. Jekyll uses Bundler, so a quick run of the bundle command and
you're all set!
$ bundle
Before you start, run the tests and make sure that they pass (to confirm your
environment is configured properly):
$ bundle exec rake test
$ bundle exec rake features
Workflow
--------
Here's the most direct way to get your work merged into the project:
* Fork the project.
* Clone down your fork ( `git clone git@github.com:<username>/jekyll.git` ).
* Create a topic branch to contain your change ( `git checkout -b my_awesome_feature` ).
* Hack away, add tests. Not necessarily in that order.
* Make sure everything still passes by running `rake`.
* If necessary, rebase your commits into logical chunks, without errors.
* Push the branch up ( `git push origin my_awesome_feature` ).
* Create a pull request against jekyll/jekyll and describe what your change
does and the why you think it should be merged.
Updating Documentation
----------------------
We want the Jekyll documentation to be the best it can be. We've
open-sourced our docs and we welcome any pull requests if you find it
lacking.
You can find the documentation for jekyllrb.com in the
[site](https://github.com/jekyll/jekyll/tree/master/site) directory of
Jekyll's repo on GitHub.com.
All documentation pull requests should be directed at `master`. Pull
requests directed at another branch will not be accepted.
The [Jekyll wiki](https://github.com/jekyll/jekyll/wiki) on GitHub
can be freely updated without a pull request as all GitHub users have access.
Gotchas
-------
* If you want to bump the gem version, please put that in a separate commit.
This way, the maintainers can control when the gem gets released.
* Try to keep your patch(es) based from the latest commit on jekyll/jekyll.
The easier it is to apply your work, the less work the maintainers have to do,
which is always a good thing.
* Please don't tag your GitHub issue with [fix], [feature], etc. The maintainers
actively read the issues and will label it once they come across it.
Finally...
----------
Thanks! Hacking on Jekyll should be fun. If you find any of this hard to figure
out, let us know so we can improve our process or documentation!

115
Gemfile
View File

@ -1,47 +1,88 @@
source 'https://rubygems.org' source "https://rubygems.org"
gemspec gemspec :name => "jekyll"
gem 'pry' gem "rake", "~> 10.1"
gem 'toml', '~> 0.1.0' group :development do
gem 'jekyll-paginate', '~> 1.0' gem "launchy", "~> 2.3"
gem 'jekyll-gist', '~> 1.0' gem "rubocop", :branch => :master, :github => "bbatsov/rubocop"
gem 'jekyll-coffeescript', '~> 1.0' gem "pry"
platform :ruby, :mswin, :mingw do unless RUBY_ENGINE == "jruby"
gem 'pygments.rb', '~> 0.6.0' gem "pry-byebug"
gem 'rdiscount', '~> 2.0' end
gem 'classifier-reborn', '~> 2.0'
gem 'redcarpet', '~> 3.2', '>= 3.2.3'
gem 'liquid-c', '~> 3.0'
end end
if RUBY_PLATFORM =~ /cygwin/ || RUBY_VERSION.start_with?("2.2") #
gem 'test-unit'
group :test do
gem "cucumber", "~> 2.1"
gem "jekyll_test_plugin"
gem "jekyll_test_plugin_malicious"
gem "codeclimate-test-reporter"
gem "rspec-mocks"
gem "nokogiri"
gem "rspec"
end end
gem 'rake', '~> 10.1' #
gem 'rdoc', '~> 4.2'
gem 'redgreen', '~> 1.2'
gem 'shoulda', '~> 3.5'
gem 'cucumber', '~> 2.0'
gem 'launchy', '~> 2.3'
gem 'simplecov', '~> 0.9'
gem 'mime-types', '~> 2.6'
gem 'kramdown', '~> 1.7.0'
gem 'jekyll_test_plugin'
gem 'jekyll_test_plugin_malicious'
gem 'minitest-reporters'
gem 'minitest-profile'
gem 'minitest'
gem 'rspec-mocks'
if ENV['BENCHMARK'] group :test_legacy do
gem 'ruby-prof' if RUBY_PLATFORM =~ /cygwin/ || RUBY_VERSION.start_with?("2.2")
gem 'rbtrace' gem 'test-unit'
gem 'stackprof' end
gem 'benchmark-ips'
gem "redgreen"
gem "simplecov"
gem "minitest-reporters"
gem "minitest-profile"
gem "minitest"
gem "shoulda"
end end
if ENV['PROOF'] #
gem 'html-proofer', '~> 2.0'
group :benchmark do
if ENV["BENCHMARK"]
gem "ruby-prof"
gem "benchmark-ips"
gem "stackprof"
gem "rbtrace"
end
end
#
group :jekyll_optional_dependencies do
gem "toml", "~> 0.1.0"
gem "coderay", "~> 1.1.0"
gem "jekyll-docs", :path => '../docs' if Dir.exist?('../docs') && ENV['JEKYLL_VERSION']
gem "jekyll-gist", "~> 1.0"
gem "jekyll-feed", "~> 0.1.3"
gem "jekyll-coffeescript", "~> 1.0"
gem "jekyll-redirect-from", "~> 0.9.1"
gem "jekyll-paginate", "~> 1.0"
gem "mime-types", "~> 3.0"
gem "kramdown", "~> 1.9"
gem "rdoc", "~> 4.2"
platform :ruby, :mswin, :mingw do
gem "rdiscount", "~> 2.0"
gem "pygments.rb", "~> 0.6.0"
gem "redcarpet", "~> 3.2", ">= 3.2.3"
gem "classifier-reborn", "~> 2.0"
gem "liquid-c", "~> 3.0"
end
end
#
group :site do
if ENV["PROOF"]
gem "html-proofer", "~> 2.0"
end
gem "jemoji", "0.5.1"
gem "jekyll-sitemap"
gem "jekyll-seo-tag", "~> 1.1"
gem "jekyll-avatar"
end end

File diff suppressed because it is too large Load Diff

View File

@ -1,6 +1,6 @@
The MIT License (MIT) The MIT License (MIT)
Copyright (c) 2008-2015 Tom Preston-Werner Copyright (c) 2008-2016 Tom Preston-Werner
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

View File

@ -1,36 +1,58 @@
# [Jekyll](http://jekyllrb.com/) # [Jekyll](https://jekyllrb.com/)
[![Gem Version](https://img.shields.io/gem/v/jekyll.svg)](https://rubygems.org/gems/jekyll) [![Gem Version](https://img.shields.io/gem/v/jekyll.svg)][ruby-gems]
[![Build Status](https://img.shields.io/travis/jekyll/jekyll/master.svg)](https://travis-ci.org/jekyll/jekyll) [![Build Status](https://travis-ci.org/jekyll/jekyll.svg?branch=master)][travis]
[![Code Climate](https://img.shields.io/codeclimate/github/jekyll/jekyll.svg)](https://codeclimate.com/github/jekyll/jekyll) [![Test Coverage](https://codeclimate.com/github/jekyll/jekyll/badges/coverage.svg)][coverage]
[![Dependency Status](https://img.shields.io/gemnasium/jekyll/jekyll.svg)](https://gemnasium.com/jekyll/jekyll) [![Code Climate](https://codeclimate.com/github/jekyll/jekyll/badges/gpa.svg)][codeclimate]
[![Security](https://hakiri.io/github/jekyll/jekyll/master.svg)](https://hakiri.io/github/jekyll/jekyll/master) [![Dependency Status](https://gemnasium.com/jekyll/jekyll.svg)][gemnasium]
[![Security](https://hakiri.io/github/jekyll/jekyll/master.svg)][hakiri]
By Tom Preston-Werner, Nick Quaranto, Parker Moore, and many [awesome contributors](https://github.com/jekyll/jekyll/graphs/contributors)! [ruby-gems]: https://rubygems.org/gems/jekyll
[gemnasium]: https://gemnasium.com/jekyll/jekyll
[codeclimate]: https://codeclimate.com/github/jekyll/jekyll
[coverage]: https://codeclimate.com/github/jekyll/jekyll/coverage
[hakiri]: https://hakiri.io/github/jekyll/jekyll/master
[travis]: https://travis-ci.org/jekyll/jekyll
Jekyll is a simple, blog-aware, static site generator perfect for personal, project, or organization sites. Think of it like a file-based CMS, without all the complexity. Jekyll takes your content, renders Markdown and Liquid templates, and spits out a complete, static website ready to be served by Apache, Nginx or another web server. Jekyll is the engine behind [GitHub Pages](http://pages.github.com), which you can use to host sites right from your GitHub repositories. Jekyll is a simple, blog-aware, static site generator perfect for personal, project, or organization sites. Think of it like a file-based CMS, without all the complexity. Jekyll takes your content, renders Markdown and Liquid templates, and spits out a complete, static website ready to be served by Apache, Nginx or another web server. Jekyll is the engine behind [GitHub Pages](https://pages.github.com), which you can use to host sites right from your GitHub repositories.
## Philosophy ## Philosophy
Jekyll does what you tell it to do — no more, no less. It doesn't try to outsmart users by making bold assumptions, nor does it burden them with needless complexity and configuration. Put simply, Jekyll gets out of your way and allows you to concentrate on what truly matters: your content. Jekyll does what you tell it to do — no more, no less. It doesn't try to outsmart users by making bold assumptions, nor does it burden them with needless complexity and configuration. Put simply, Jekyll gets out of your way and allows you to concentrate on what truly matters: your content.
## Having trouble with OS X El Capitan?
See: https://jekyllrb.com/docs/troubleshooting/#jekyll-amp-mac-os-x-1011
## Getting Started ## Getting Started
* [Install](http://jekyllrb.com/docs/installation/) the gem * [Install](https://jekyllrb.com/docs/installation/) the gem
* Read up about its [Usage](http://jekyllrb.com/docs/usage/) and [Configuration](http://jekyllrb.com/docs/configuration/) * Read up about its [Usage](https://jekyllrb.com/docs/usage/) and [Configuration](https://jekyllrb.com/docs/configuration/)
* Take a gander at some existing [Sites](https://wiki.github.com/jekyll/jekyll/sites) * Take a gander at some existing [Sites](https://wiki.github.com/jekyll/jekyll/sites)
* Fork and [Contribute](http://jekyllrb.com/docs/contributing/) your own modifications * [Fork](https://github.com/jekyll/jekyll/fork) and [Contribute](https://jekyllrb.com/docs/contributing/) your own modifications
* Have questions? Check out our official forum community [Jekyll Talk](https://talk.jekyllrb.com/) or [`#jekyll` on irc.freenode.net](https://botbot.me/freenode/jekyll/) * Have questions? Check out our official forum community [Jekyll Talk](https://talk.jekyllrb.com/) or [`#jekyll` on irc.freenode.net](https://botbot.me/freenode/jekyll/)
## Code of Conduct
In order to have a more open and welcoming community, Jekyll adheres to a
[code of conduct](CONDUCT.markdown) adapted from the Ruby on Rails code of
conduct.
Please adhere to this code of conduct in any interactions you have in the
Jekyll community. It is strictly enforced on all official Jekyll
repositories, websites, and resources. If you encounter someone violating
these terms, please let a maintainer ([@parkr](https://github.com/parkr), [@envygeeks](https://github.com/envygeeks), or [@mattr-](https://github.com/mattr-)) know
and we will address it as soon as possible.
## Diving In ## Diving In
* [Migrate](http://import.jekyllrb.com/docs/home/) from your previous system * [Migrate](http://import.jekyllrb.com/docs/home/) from your previous system
* Learn how the [YAML Front Matter](http://jekyllrb.com/docs/frontmatter/) works * Learn how the [YAML Front Matter](https://jekyllrb.com/docs/frontmatter/) works
* Put information on your site with [Variables](http://jekyllrb.com/docs/variables/) * Put information on your site with [Variables](https://jekyllrb.com/docs/variables/)
* Customize the [Permalinks](http://jekyllrb.com/docs/permalinks/) your posts are generated with * Customize the [Permalinks](https://jekyllrb.com/docs/permalinks/) your posts are generated with
* Use the built-in [Liquid Extensions](http://jekyllrb.com/docs/templates/) to make your life easier * Use the built-in [Liquid Extensions](https://jekyllrb.com/docs/templates/) to make your life easier
* Use custom [Plugins](http://jekyllrb.com/docs/plugins/) to generate content specific to your site * Use custom [Plugins](https://jekyllrb.com/docs/plugins/) to generate content specific to your site
## License ## License
See [LICENSE](https://github.com/jekyll/jekyll/blob/master/LICENSE). See the [LICENSE](https://github.com/jekyll/jekyll/blob/master/LICENSE) file.

214
Rakefile
View File

@ -7,6 +7,8 @@ require 'yaml'
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w[lib])) $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w[lib]))
require 'jekyll/version' require 'jekyll/version'
Dir.glob('rake/**.rake').each { |f| import f }
############################################################################# #############################################################################
# #
# Helper functions # Helper functions
@ -14,13 +16,17 @@ require 'jekyll/version'
############################################################################# #############################################################################
def name def name
@name ||= File.basename(Dir['*.gemspec'].first, ".*") "jekyll"
end end
def version def version
Jekyll::VERSION Jekyll::VERSION
end end
def docs_name
"#{name}-docs"
end
def gemspec_file def gemspec_file
"#{name}.gemspec" "#{name}.gemspec"
end end
@ -81,6 +87,34 @@ def converted_history(markdown)
normalize_bullets(markdown))))) normalize_bullets(markdown)))))
end end
def siteify_file(file, overrides_front_matter = {})
abort "You seem to have misplaced your #{file} file. I can haz?" unless File.exists?(file)
title = begin
File.read(file).match(/\A# (.*)$/)[1]
rescue
File.basename(file, ".*").downcase.capitalize
end
slug = File.basename(file, ".markdown").downcase
front_matter = {
"title" => title,
"layout" => "docs",
"permalink" => "/docs/#{slug}/",
"note" => "This file is autogenerated. Edit /#{file} instead."
}.merge(overrides_front_matter)
contents = "#{front_matter.to_yaml}---\n\n#{content_for(file)}"
File.write("site/_docs/#{slug}.md", contents)
end
def content_for(file)
contents = File.read(file)
case file
when "History.markdown"
converted_history(contents)
else
contents.gsub(/\A# .*\n\n?/, "")
end
end
############################################################################# #############################################################################
# #
# Standard tasks # Standard tasks
@ -124,181 +158,3 @@ desc "Open an irb session preloaded with this library"
task :console do task :console do
sh "irb -rubygems -r ./lib/#{name}.rb" sh "irb -rubygems -r ./lib/#{name}.rb"
end end
#############################################################################
#
# Site tasks - http://jekyllrb.com
#
#############################################################################
namespace :site do
desc "Generate and view the site locally"
task :preview do
require "launchy"
require "jekyll"
# Yep, it's a hack! Wait a few seconds for the Jekyll site to generate and
# then open it in a browser. Someday we can do better than this, I hope.
Thread.new do
sleep 4
puts "Opening in browser..."
Launchy.open("http://localhost:4000")
end
# Generate the site in server mode.
puts "Running Jekyll..."
options = {
"source" => File.expand_path("site"),
"destination" => File.expand_path("site/_site"),
"watch" => true,
"serving" => true
}
Jekyll::Commands::Build.process(options)
Jekyll::Commands::Serve.process(options)
end
desc "Generate the site"
task :generate => [:history, :version_file] do
require "jekyll"
Jekyll::Commands::Build.process({
"source" => File.expand_path("site"),
"destination" => File.expand_path("site/_site")
})
end
desc "Update normalize.css library to the latest version and minify"
task :update_normalize_css do
Dir.chdir("site/_sass") do
sh 'curl "http://necolas.github.io/normalize.css/latest/normalize.css" -o "normalize.scss"'
sh 'sass "normalize.scss":"_normalize.scss" --style compressed'
rm ['normalize.scss', Dir.glob('*.map')].flatten
end
end
desc "Commit the local site to the gh-pages branch and publish to GitHub Pages"
task :publish => [:history, :version_file] do
# Ensure the gh-pages dir exists so we can generate into it.
puts "Checking for gh-pages dir..."
unless File.exist?("./gh-pages")
puts "Creating gh-pages dir..."
sh "git clone git@github.com:jekyll/jekyll gh-pages"
end
# Ensure latest gh-pages branch history.
Dir.chdir('gh-pages') do
sh "git checkout gh-pages"
sh "git pull origin gh-pages"
end
# Proceed to purge all files in case we removed a file in this release.
puts "Cleaning gh-pages directory..."
purge_exclude = %w[
gh-pages/.
gh-pages/..
gh-pages/.git
gh-pages/.gitignore
]
FileList["gh-pages/{*,.*}"].exclude(*purge_exclude).each do |path|
sh "rm -rf #{path}"
end
# Copy site to gh-pages dir.
puts "Building site into gh-pages branch..."
ENV['JEKYLL_ENV'] = 'production'
require "jekyll"
Jekyll::Commands::Build.process({
"source" => File.expand_path("site"),
"destination" => File.expand_path("gh-pages"),
"sass" => { "style" => "compressed" },
"full_rebuild" => true
})
File.open('gh-pages/.nojekyll', 'wb') { |f| f.puts(":dog: food.") }
# Commit and push.
puts "Committing and pushing to GitHub Pages..."
sha = `git rev-parse HEAD`.strip
Dir.chdir('gh-pages') do
sh "git add ."
sh "git commit --allow-empty -m 'Updating to #{sha}.'"
sh "git push origin gh-pages"
end
puts 'Done.'
end
desc "Create a nicely formatted history page for the jekyll site based on the repo history."
task :history do
if File.exist?("History.markdown")
history_file = File.read("History.markdown")
front_matter = {
"layout" => "docs",
"title" => "History",
"permalink" => "/docs/history/"
}
Dir.chdir('site/_docs/') do
File.open("history.md", "w") do |file|
file.write("#{front_matter.to_yaml}---\n\n")
file.write(converted_history(history_file))
end
end
else
abort "You seem to have misplaced your History.markdown file. I can haz?"
end
end
desc "Write the site latest_version.txt file"
task :version_file do
File.open('site/latest_version.txt', 'wb') { |f| f.puts(version) } unless version =~ /(beta|rc|alpha)/i
end
namespace :releases do
desc "Create new release post"
task :new, :version do |t, args|
raise "Specify a version: rake site:releases:new['1.2.3']" unless args.version
today = Time.new.strftime('%Y-%m-%d')
release = args.version.to_s
filename = "site/_posts/#{today}-jekyll-#{release.split('.').join('-')}-released.markdown"
File.open(filename, "wb") do |post|
post.puts("---")
post.puts("layout: news_item")
post.puts("title: 'Jekyll #{release} Released'")
post.puts("date: #{Time.new.strftime('%Y-%m-%d %H:%M:%S %z')}")
post.puts("author: ")
post.puts("version: #{release}")
post.puts("categories: [release]")
post.puts("---")
post.puts
post.puts
end
puts "Created #{filename}"
end
end
end
#############################################################################
#
# Packaging tasks
#
#############################################################################
desc "Release #{name} v#{version}"
task :release => :build do
unless `git branch` =~ /^\* master$/
puts "You must be on the master 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 v#{version}"
sh "gem push pkg/#{name}-#{version}.gem"
end
desc "Build #{name} v#{version} into pkg/"
task :build do
mkdir_p "pkg"
sh "gem build #{gemspec_file}"
sh "mv #{gem_file} pkg"
end

View File

@ -4,10 +4,12 @@ Benchmark.ips do |x|
path_without_ending_slash = '/some/very/very/long/path/to/a/file/i/like' path_without_ending_slash = '/some/very/very/long/path/to/a/file/i/like'
x.report('no slash regexp') { path_without_ending_slash =~ /\/$/ } x.report('no slash regexp') { path_without_ending_slash =~ /\/$/ }
x.report('no slash end_with?') { path_without_ending_slash.end_with?("/") } x.report('no slash end_with?') { path_without_ending_slash.end_with?("/") }
x.report('no slash [-1, 1]') { path_without_ending_slash[-1, 1] == "/" }
end end
Benchmark.ips do |x| Benchmark.ips do |x|
path_with_ending_slash = '/some/very/very/long/path/to/a/file/i/like/' path_with_ending_slash = '/some/very/very/long/path/to/a/file/i/like/'
x.report('slash regexp') { path_with_ending_slash =~ /\/$/ } x.report('slash regexp') { path_with_ending_slash =~ /\/$/ }
x.report('slash end_with?') { path_with_ending_slash.end_with?("/") } x.report('slash end_with?') { path_with_ending_slash.end_with?("/") }
x.report('slash [-1, 1]') { path_with_ending_slash[-1, 1] == "/" }
end end

View File

@ -0,0 +1,54 @@
#!/usr/bin/env ruby
require 'benchmark/ips'
# For this pull request, which changes Page#dir
# https://github.com/jekyll/jekyll/pull/4403
FORWARD_SLASH = '/'.freeze
def pre_pr(url)
url[-1, 1] == FORWARD_SLASH ? url : File.dirname(url)
end
def pr(url)
if url.end_with?(FORWARD_SLASH)
url
else
url_dir = File.dirname(url)
url_dir.end_with?(FORWARD_SLASH) ? url_dir : "#{url_dir}/"
end
end
def envygeeks(url)
return url if url.end_with?(FORWARD_SLASH) || url == FORWARD_SLASH
url = File.dirname(url)
url == FORWARD_SLASH ? url : "#{url}/"
end
# Just a slash
Benchmark.ips do |x|
path = '/'
x.report("pre_pr:#{path}") { pre_pr(path) }
x.report("pr:#{path}") { pr(path) }
x.report("envygeeks:#{path}") { pr(path) }
x.compare!
end
# No trailing slash
Benchmark.ips do |x|
path = '/some/very/very/long/path/to/a/file/i/like'
x.report("pre_pr:#{path}") { pre_pr(path) }
x.report("pr:#{path}") { pr(path) }
x.report("envygeeks:#{path}") { pr(path) }
x.compare!
end
# No trailing slash
Benchmark.ips do |x|
path = '/some/very/very/long/path/to/a/file/i/like/'
x.report("pre_pr:#{path}") { pre_pr(path) }
x.report("pr:#{path}") { pr(path) }
x.report("envygeeks:#{path}") { pr(path) }
x.compare!
end

View File

@ -0,0 +1,51 @@
#!/usr/bin/env ruby
require 'benchmark/ips'
# For this pull request, which changes Page#dir
# https://github.com/jekyll/jekyll/pull/4403
CONTENT_CONTAINING = <<-HTML.freeze
<!DOCTYPE HTML>
<html lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="UTF-8">
<title>Jemoji</title>
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="stylesheet" href="/css/screen.css">
</head>
<body class="wrap">
<p><img class="emoji" title=":+1:" alt=":+1:" src="https://assets.github.com/images/icons/emoji/unicode/1f44d.png" height="20" width="20" align="absmiddle"></p>
</body>
</html>
HTML
CONTENT_NOT_CONTAINING = <<-HTML.freeze
<!DOCTYPE HTML>
<html lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="UTF-8">
<title>Jemoji</title>
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="stylesheet" href="/css/screen.css">
</head>
<body class="wrap">
<p><img class="emoji" title=":+1:" alt=":+1:" src="https://assets.github.com/images/icons/emoji/unicode/1f44d.png" height="20" width="20" align="absmiddle"></p>
</body>
</html>
HTML
Benchmark.ips do |x|
x.report("no body include?") { CONTENT_NOT_CONTAINING.include?('<body') }
x.report("no body regexp") { CONTENT_NOT_CONTAINING =~ /<\s*body/ }
x.compare!
end
# No trailing slash
Benchmark.ips do |x|
x.report("with body include?") { CONTENT_CONTAINING.include?('<body') }
x.report("with body regexp") { CONTENT_CONTAINING =~ /<\s*body/ }
x.compare!
end

View File

@ -1,15 +1,11 @@
#!/usr/bin/env ruby #!/usr/bin/env ruby
STDOUT.sync = true STDOUT.sync = true
$:.unshift File.join(File.dirname(__FILE__), *%w{ .. lib }) $LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w( .. lib ))
require 'jekyll' require 'jekyll'
require 'mercenary' require 'mercenary'
Jekyll::External.require_if_present(
Jekyll::External.blessed_gems
)
Jekyll::PluginManager.require_from_bundler Jekyll::PluginManager.require_from_bundler
Jekyll::Deprecator.process(ARGV) Jekyll::Deprecator.process(ARGV)
@ -22,20 +18,33 @@ Mercenary.program(:jekyll) do |p|
p.option 'source', '-s', '--source [DIR]', 'Source directory (defaults to ./)' p.option 'source', '-s', '--source [DIR]', 'Source directory (defaults to ./)'
p.option 'destination', '-d', '--destination [DIR]', 'Destination directory (defaults to ./_site)' p.option 'destination', '-d', '--destination [DIR]', 'Destination directory (defaults to ./_site)'
p.option 'safe', '--safe', 'Safe mode (defaults to false)' p.option 'safe', '--safe', 'Safe mode (defaults to false)'
p.option 'plugins', '-p', '--plugins PLUGINS_DIR1[,PLUGINS_DIR2[,...]]', Array, 'Plugins directory (defaults to ./_plugins)' p.option 'plugins_dir', '-p', '--plugins PLUGINS_DIR1[,PLUGINS_DIR2[,...]]', Array, 'Plugins directory (defaults to ./_plugins)'
p.option 'layouts', '--layouts DIR', String, 'Layouts directory (defaults to ./_layouts)' p.option 'layouts_dir', '--layouts DIR', String, 'Layouts directory (defaults to ./_layouts)'
p.option 'profile', '--profile', 'Generate a Liquid rendering profile' p.option 'profile', '--profile', 'Generate a Liquid rendering profile'
Jekyll::External.require_if_present(Jekyll::External.blessed_gems) do |g|
cmd = g.split('-').last
p.command(cmd.to_sym) do |c|
c.syntax cmd
c.action do
Jekyll.logger.abort_with "You must install the '#{g}' gem to use the 'jekyll #{cmd}' command."
end
end
end
Jekyll::Command.subclasses.each { |c| c.init_with_program(p) } Jekyll::Command.subclasses.each { |c| c.init_with_program(p) }
p.action do |args, options| p.action do |args, _|
if args.empty? if args.empty?
Jekyll.logger.error "A subcommand is required." Jekyll.logger.error "A subcommand is required."
puts p puts p
abort abort
else else
unless p.has_command?(args.first) subcommand = args.first
Jekyll.logger.abort_with "Invalid command. Use --help for more information" unless p.has_command? subcommand
Jekyll.logger.abort_with "fatal: 'jekyll #{args.first}' could not" \
" be found. You may need to install the jekyll-#{args.first} gem" \
" or a related gem to be able to use this subcommand."
end end
end end
end end

View File

@ -8,12 +8,12 @@ Feature: Collections
And I have fixture collections And I have fixture collections
And I have a configuration file with "collections" set to "['methods']" And I have a configuration file with "collections" set to "['methods']"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And I should see "Collections: <p>Use <code>Jekyll.configuration</code> to build a full configuration for use w/Jekyll.</p>\n\n<p>Whatever: foo.bar</p>\n<p>Signs are nice</p>\n<p><code>Jekyll.sanitized_path</code> is used to make sure your path is in your source.</p>\n<p>Run your generators! default</p>\n<p>Page without title.</p>\n<p>Run your generators! default</p>" in "_site/index.html" And the _site directory should exist
And the "_site/methods/configuration.html" file should not exist And the "_site/methods/configuration.html" file should not exist
Scenario: Rendered collection Scenario: Rendered collection
Given I have an "index.html" page that contains "Collections: {{ site.collections }}" Given I have an "index.html" page that contains "Collections: output => {{ site.collections[0].output }} label => {{ site.collections[0].label }}"
And I have an "collection_metadata.html" page that contains "Methods metadata: {{ site.collections[0].foo }} {{ site.collections[0] }}" And I have an "collection_metadata.html" page that contains "Methods metadata: {{ site.collections[0].foo }} {{ site.collections[0] }}"
And I have fixture collections And I have fixture collections
And I have a "_config.yml" file with content: And I have a "_config.yml" file with content:
@ -24,9 +24,10 @@ Feature: Collections
foo: bar foo: bar
""" """
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And I should see "Collections: {\"output\"=>true" in "_site/index.html" And the _site directory should exist
And I should see "\"label\"=>\"methods\"," in "_site/index.html" And I should see "Collections: output => true" in "_site/index.html"
And I should see "label => methods" in "_site/index.html"
And I should see "Methods metadata: bar" in "_site/collection_metadata.html" And I should see "Methods metadata: bar" in "_site/collection_metadata.html"
And I should see "<p>Whatever: foo.bar</p>" in "_site/methods/configuration.html" And I should see "<p>Whatever: foo.bar</p>" in "_site/methods/configuration.html"
@ -41,11 +42,12 @@ Feature: Collections
permalink: /:collection/:path/ permalink: /:collection/:path/
""" """
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "<p>Whatever: foo.bar</p>" in "_site/methods/configuration/index.html" And I should see "<p>Whatever: foo.bar</p>" in "_site/methods/configuration/index.html"
Scenario: Rendered document in a layout Scenario: Rendered document in a layout
Given I have an "index.html" page that contains "Collections: {{ site.collections }}" Given I have an "index.html" page that contains "Collections: output => {{ site.collections[0].output }} label => {{ site.collections[0].label }} foo => {{ site.collections[0].foo }}"
And I have a default layout that contains "<div class='title'>Tom Preston-Werner</div> {{content}}" And I have a default layout that contains "<div class='title'>Tom Preston-Werner</div> {{content}}"
And I have fixture collections And I have fixture collections
And I have a "_config.yml" file with content: And I have a "_config.yml" file with content:
@ -56,9 +58,11 @@ Feature: Collections
foo: bar foo: bar
""" """
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And I should see "Collections: {\"output\"=>true" in "_site/index.html" And the _site directory should exist
And I should see "\"label\"=>\"methods\"," in "_site/index.html" And I should see "Collections: output => true" in "_site/index.html"
And I should see "label => methods" in "_site/index.html"
And I should see "foo => bar" in "_site/index.html"
And I should see "<p>Run your generators! default</p>" in "_site/methods/site/generate.html" And I should see "<p>Run your generators! default</p>" in "_site/methods/site/generate.html"
And I should see "<div class='title'>Tom Preston-Werner</div>" in "_site/methods/site/generate.html" And I should see "<div class='title'>Tom Preston-Werner</div>" in "_site/methods/site/generate.html"
@ -71,8 +75,9 @@ Feature: Collections
- methods - methods
""" """
When I run jekyll build When I run jekyll build
Then I should get a zero exit status
Then the _site directory should exist Then the _site directory should exist
And I should see "Collections: _methods/configuration.md _methods/escape-\+ #%20\[\].md _methods/sanitized_path.md _methods/site/generate.md _methods/site/initialize.md _methods/um_hi.md" in "_site/index.html" And I should see "Collections: _methods/collection/entries _methods/configuration.md _methods/escape-\+ #%20\[\].md _methods/sanitized_path.md _methods/site/generate.md _methods/site/initialize.md _methods/um_hi.md" in "_site/index.html"
Scenario: Collections specified as an hash Scenario: Collections specified as an hash
Given I have an "index.html" page that contains "Collections: {% for method in site.methods %}{{ method.relative_path }} {% endfor %}" Given I have an "index.html" page that contains "Collections: {% for method in site.methods %}{{ method.relative_path }} {% endfor %}"
@ -83,8 +88,9 @@ Feature: Collections
- methods - methods
""" """
When I run jekyll build When I run jekyll build
Then I should get a zero exit status
Then the _site directory should exist Then the _site directory should exist
And I should see "Collections: _methods/configuration.md _methods/escape-\+ #%20\[\].md _methods/sanitized_path.md _methods/site/generate.md _methods/site/initialize.md _methods/um_hi.md" in "_site/index.html" And I should see "Collections: _methods/collection/entries _methods/configuration.md _methods/escape-\+ #%20\[\].md _methods/sanitized_path.md _methods/site/generate.md _methods/site/initialize.md _methods/um_hi.md" in "_site/index.html"
Scenario: All the documents Scenario: All the documents
Given I have an "index.html" page that contains "All documents: {% for doc in site.documents %}{{ doc.relative_path }} {% endfor %}" Given I have an "index.html" page that contains "All documents: {% for doc in site.documents %}{{ doc.relative_path }} {% endfor %}"
@ -95,11 +101,12 @@ Feature: Collections
- methods - methods
""" """
When I run jekyll build When I run jekyll build
Then I should get a zero exit status
Then the _site directory should exist Then the _site directory should exist
And I should see "All documents: _methods/configuration.md _methods/escape-\+ #%20\[\].md _methods/sanitized_path.md _methods/site/generate.md _methods/site/initialize.md _methods/um_hi.md" in "_site/index.html" And I should see "All documents: _methods/collection/entries _methods/configuration.md _methods/escape-\+ #%20\[\].md _methods/sanitized_path.md _methods/site/generate.md _methods/site/initialize.md _methods/um_hi.md" in "_site/index.html"
Scenario: Documents have an output attribute, which is the converted HTML Scenario: Documents have an output attribute, which is the converted HTML
Given I have an "index.html" page that contains "First document's output: {{ site.documents.first.output }}" Given I have an "index.html" page that contains "Second document's output: {{ site.documents[1].output }}"
And I have fixture collections And I have fixture collections
And I have a "_config.yml" file with content: And I have a "_config.yml" file with content:
""" """
@ -107,8 +114,9 @@ Feature: Collections
- methods - methods
""" """
When I run jekyll build When I run jekyll build
Then I should get a zero exit status
Then the _site directory should exist Then the _site directory should exist
And I should see "First document's output: <p>Use <code>Jekyll.configuration</code> to build a full configuration for use w/Jekyll.</p>\n\n<p>Whatever: foo.bar</p>" in "_site/index.html" And I should see "Second document's output: <p>Use <code class=\"highlighter-rouge\">Jekyll.configuration</code> to build a full configuration for use w/Jekyll.</p>\n\n<p>Whatever: foo.bar</p>" in "_site/index.html"
Scenario: Filter documents by where Scenario: Filter documents by where
Given I have an "index.html" page that contains "{% assign items = site.methods | where: 'whatever','foo.bar' %}Item count: {{ items.size }}" Given I have an "index.html" page that contains "{% assign items = site.methods | where: 'whatever','foo.bar' %}Item count: {{ items.size }}"
@ -119,11 +127,12 @@ Feature: Collections
- methods - methods
""" """
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Item count: 2" in "_site/index.html" And I should see "Item count: 2" in "_site/index.html"
Scenario: Sort by title Scenario: Sort by title
Given I have an "index.html" page that contains "{% assign items = site.methods | sort: 'title' %}1. of {{ items.size }}: {{ items.first.output }}" Given I have an "index.html" page that contains "{% assign items = site.methods | sort: 'title' %}2. of {{ items.size }}: {{ items[1].output }}"
And I have fixture collections And I have fixture collections
And I have a "_config.yml" file with content: And I have a "_config.yml" file with content:
""" """
@ -131,11 +140,12 @@ Feature: Collections
- methods - methods
""" """
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And I should see "1. of 7: <p>Page without title.</p>" in "_site/index.html" And the _site directory should exist
And I should see "2. of 8: <p>Page without title.</p>" in "_site/index.html"
Scenario: Sort by relative_path Scenario: Sort by relative_path
Given I have an "index.html" page that contains "Collections: {% assign methods = site.methods | sort: 'relative_path' %}{% for method in methods %}{{ method.title }}, {% endfor %}" Given I have an "index.html" page that contains "Collections: {% assign methods = site.methods | sort: 'relative_path' %}{{ methods | map:"title" | join: ", " }}"
And I have fixture collections And I have fixture collections
And I have a "_config.yml" file with content: And I have a "_config.yml" file with content:
""" """
@ -143,5 +153,22 @@ Feature: Collections
- methods - methods
""" """
When I run jekyll build When I run jekyll build
Then I should get a zero exit status
Then the _site directory should exist Then the _site directory should exist
And I should see "Collections: Jekyll.configuration, Jekyll.escape, Jekyll.sanitized_path, Site#generate, , Site#generate," in "_site/index.html" And I should see "Collections: Collection#entries, Jekyll.configuration, Jekyll.escape, Jekyll.sanitized_path, Site#generate, Initialize, Site#generate," in "_site/index.html"
Scenario: Rendered collection with date/dateless filename
Given I have an "index.html" page that contains "Collections: {% for method in site.thanksgiving %}{{ method.title }} {% endfor %}"
And I have fixture collections
And I have a "_config.yml" file with content:
"""
collections:
thanksgiving:
output: true
"""
When I run jekyll build
Then I should get a zero exit status
And the _site directory should exist
And I should see "Thanksgiving Black Friday" in "_site/index.html"
And I should see "Happy Thanksgiving" in "_site/thanksgiving/2015-11-26-thanksgiving.html"
And I should see "Black Friday" in "_site/thanksgiving/black-friday.html"

View File

@ -13,7 +13,8 @@ Feature: Create sites
Scenario: Basic site Scenario: Basic site
Given I have an "index.html" file that contains "Basic Site" Given I have an "index.html" file that contains "Basic Site"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Basic Site" in "_site/index.html" And I should see "Basic Site" in "_site/index.html"
Scenario: Basic site with a post Scenario: Basic site with a post
@ -22,7 +23,8 @@ Feature: Create sites
| title | date | content | | title | date | content |
| Hackers | 2009-03-27 | My First Exploit | | Hackers | 2009-03-27 | My First Exploit |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "My First Exploit" in "_site/2009/03/27/hackers.html" And I should see "My First Exploit" in "_site/2009/03/27/hackers.html"
Scenario: Basic site with layout and a page Scenario: Basic site with layout and a page
@ -30,7 +32,8 @@ Feature: Create sites
And I have an "index.html" page with layout "default" that contains "Basic Site with Layout" And I have an "index.html" page with layout "default" that contains "Basic Site with Layout"
And I have a default layout that contains "Page Layout: {{ content }}" And I have a default layout that contains "Page Layout: {{ content }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Page Layout: Basic Site with Layout" in "_site/index.html" And I should see "Page Layout: Basic Site with Layout" in "_site/index.html"
Scenario: Basic site with layout and a post Scenario: Basic site with layout and a post
@ -41,7 +44,8 @@ Feature: Create sites
| Wargames | 2009-03-27 | default | The only winning move is not to play. | | Wargames | 2009-03-27 | default | The only winning move is not to play. |
And I have a default layout that contains "Post Layout: {{ content }}" And I have a default layout that contains "Post Layout: {{ content }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Post Layout: <p>The only winning move is not to play.</p>" in "_site/2009/03/27/wargames.html" And I should see "Post Layout: <p>The only winning move is not to play.</p>" in "_site/2009/03/27/wargames.html"
Scenario: Basic site with layout inside a subfolder and a post Scenario: Basic site with layout inside a subfolder and a post
@ -52,7 +56,8 @@ Feature: Create sites
| Wargames | 2009-03-27 | post/simple | The only winning move is not to play. | | Wargames | 2009-03-27 | post/simple | The only winning move is not to play. |
And I have a post/simple layout that contains "Post Layout: {{ content }}" And I have a post/simple layout that contains "Post Layout: {{ content }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Post Layout: <p>The only winning move is not to play.</p>" in "_site/2009/03/27/wargames.html" And I should see "Post Layout: <p>The only winning move is not to play.</p>" in "_site/2009/03/27/wargames.html"
Scenario: Basic site with layouts, pages, posts and files Scenario: Basic site with layouts, pages, posts and files
@ -75,7 +80,8 @@ Feature: Create sites
| entry3 | 2009-05-27 | post | content for entry3. | | entry3 | 2009-05-27 | post | content for entry3. |
| entry4 | 2009-06-27 | post | content for entry4. | | entry4 | 2009-06-27 | post | content for entry4. |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Page : Site contains 2 pages and 4 posts" in "_site/index.html" And I should see "Page : Site contains 2 pages and 4 posts" in "_site/index.html"
And I should see "No replacement \{\{ site.posts.size \}\}" in "_site/about.html" And I should see "No replacement \{\{ site.posts.size \}\}" in "_site/about.html"
And I should see "" in "_site/another_file" And I should see "" in "_site/another_file"
@ -90,7 +96,8 @@ Feature: Create sites
And I have an "index.html" page that contains "Basic Site with include tag: {% include about.textile %}" And I have an "index.html" page that contains "Basic Site with include tag: {% include about.textile %}"
And I have an "_includes/about.textile" file that contains "Generated by Jekyll" And I have an "_includes/about.textile" file that contains "Generated by Jekyll"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Basic Site with include tag: Generated by Jekyll" in "_site/index.html" And I should see "Basic Site with include tag: Generated by Jekyll" in "_site/index.html"
Scenario: Basic site with subdir include tag Scenario: Basic site with subdir include tag
@ -99,7 +106,8 @@ Feature: Create sites
And I have an info directory And I have an info directory
And I have an "info/index.html" page that contains "Basic Site with subdir include tag: {% include about.textile %}" And I have an "info/index.html" page that contains "Basic Site with subdir include tag: {% include about.textile %}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Basic Site with subdir include tag: Generated by Jekyll" in "_site/info/index.html" And I should see "Basic Site with subdir include tag: Generated by Jekyll" in "_site/info/index.html"
Scenario: Basic site with nested include tag Scenario: Basic site with nested include tag
@ -108,31 +116,35 @@ Feature: Create sites
And I have an "_includes/jekyll.textile" file that contains "Jekyll" And I have an "_includes/jekyll.textile" file that contains "Jekyll"
And I have an "index.html" page that contains "Basic Site with include tag: {% include about.textile %}" And I have an "index.html" page that contains "Basic Site with include tag: {% include about.textile %}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Basic Site with include tag: Generated by Jekyll" in "_site/index.html" And I should see "Basic Site with include tag: Generated by Jekyll" in "_site/index.html"
Scenario: Basic site with internal post linking Scenario: Basic site with internal post linking
Given I have an "index.html" page that contains "URL: {% post_url 2020-01-31-entry2 %}" Given I have an "index.html" page that contains "URL: {% post_url 2008-01-01-entry2 %}"
And I have a configuration file with "permalink" set to "pretty" And I have a configuration file with "permalink" set to "pretty"
And I have a _posts directory And I have a _posts directory
And I have the following posts: And I have the following posts:
| title | date | layout | content | | title | date | layout | content |
| entry1 | 2007-12-31 | post | content for entry1. | | entry1 | 2007-12-31 | post | content for entry1. |
| entry2 | 2020-01-31 | post | content for entry2. | | entry2 | 2008-01-01 | post | content for entry2. |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And I should see "URL: /2020/01/31/entry2/" in "_site/index.html" And the _site directory should exist
And I should see "URL: /2008/01/01/entry2/" in "_site/index.html"
Scenario: Basic site with whitelisted dotfile Scenario: Basic site with whitelisted dotfile
Given I have an ".htaccess" file that contains "SomeDirective" Given I have an ".htaccess" file that contains "SomeDirective"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "SomeDirective" in "_site/.htaccess" And I should see "SomeDirective" in "_site/.htaccess"
Scenario: File was replaced by a directory Scenario: File was replaced by a directory
Given I have a "test" file that contains "some stuff" Given I have a "test" file that contains "some stuff"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
When I delete the file "test" When I delete the file "test"
Given I have a test directory Given I have a test directory
And I have a "test/index.html" file that contains "some other stuff" And I have a "test/index.html" file that contains "some other stuff"
@ -146,13 +158,48 @@ Feature: Create sites
And I have a "secret.html" page with published "false" that contains "Unpublished page" And I have a "secret.html" page with published "false" that contains "Unpublished page"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And the "_site/index.html" file should exist And the "_site/index.html" file should exist
And the "_site/public.html" file should exist And the "_site/public.html" file should exist
But the "_site/secret.html" file should not exist But the "_site/secret.html" file should not exist
When I run jekyll build --unpublished When I run jekyll build --unpublished
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And the "_site/index.html" file should exist And the "_site/index.html" file should exist
And the "_site/public.html" file should exist And the "_site/public.html" file should exist
And the "_site/secret.html" file should exist And the "_site/secret.html" file should exist
Scenario: Basic site with page with future date
Given I have a _posts directory
And I have the following post:
| title | date | layout | content |
| entry1 | 2020-12-31 | post | content for entry1. |
| entry2 | 2007-12-31 | post | content for entry2. |
When I run jekyll build
Then I should get a zero exit status
And the _site directory should exist
And I should see "content for entry2" in "_site/2007/12/31/entry2.html"
And the "_site/2020/12/31/entry1.html" file should not exist
When I run jekyll build --future
Then I should get a zero exit status
And the _site directory should exist
And the "_site/2020/12/31/entry1.html" file should exist
Scenario: Basic site with layouts, posts and related posts
Given I have a _layouts directory
And I have a page layout that contains "Page {{ page.title }}: {{ content }}"
And I have a post layout that contains "Post {{ page.title }}: {{ content }}Related posts: {{ site.related_posts | size }}"
And I have an "index.html" page with layout "page" that contains "Site contains {{ site.pages.size }} pages and {{ site.posts.size }} posts; Related posts: {{ site.related_posts | size }}"
And I have a _posts directory
And I have the following posts:
| title | date | layout | content |
| entry1 | 2009-03-27 | post | content for entry1. |
| entry2 | 2009-04-27 | post | content for entry2. |
When I run jekyll build
Then I should get a zero exit status
And the _site directory should exist
And I should see "Page : Site contains 1 pages and 2 posts; Related posts: 0" in "_site/index.html"
And I should see "Post entry1: <p>content for entry1.</p>\nRelated posts: 1" in "_site/2009/03/27/entry1.html"
And I should see "Post entry2: <p>content for entry2.</p>\nRelated posts: 1" in "_site/2009/04/27/entry2.html"

View File

@ -10,7 +10,8 @@ Feature: Draft Posts
| title | date | layout | content | | title | date | layout | content |
| Recipe | 2009-03-27 | default | Not baked yet. | | Recipe | 2009-03-27 | default | Not baked yet. |
When I run jekyll build --drafts When I run jekyll build --drafts
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Not baked yet." in "_site/recipe.html" And I should see "Not baked yet." in "_site/recipe.html"
Scenario: Don't preview a draft Scenario: Don't preview a draft
@ -21,7 +22,8 @@ Feature: Draft Posts
| title | date | layout | content | | title | date | layout | content |
| Recipe | 2009-03-27 | default | Not baked yet. | | Recipe | 2009-03-27 | default | Not baked yet. |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And the "_site/recipe.html" file should not exist And the "_site/recipe.html" file should not exist
Scenario: Don't preview a draft that is not published Scenario: Don't preview a draft that is not published
@ -32,7 +34,8 @@ Feature: Draft Posts
| title | date | layout | published | content | | title | date | layout | published | content |
| Recipe | 2009-03-27 | default | false | Not baked yet. | | Recipe | 2009-03-27 | default | false | Not baked yet. |
When I run jekyll build --drafts When I run jekyll build --drafts
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And the "_site/recipe.html" file should not exist And the "_site/recipe.html" file should not exist
Scenario: Use page.path variable Scenario: Use page.path variable
@ -42,5 +45,6 @@ Feature: Draft Posts
| title | date | layout | content | | title | date | layout | content |
| Recipe | 2009-03-27 | simple | Post path: {{ page.path }} | | Recipe | 2009-03-27 | simple | Post path: {{ page.path }} |
When I run jekyll build --drafts When I run jekyll build --drafts
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Post path: _drafts/recipe.markdown" in "_site/recipe.html" And I should see "Post path: _drafts/recipe.markdown" in "_site/recipe.html"

View File

@ -11,7 +11,8 @@ Feature: Embed filters
| Star Wars | 2009-03-27 | default | These aren't the droids you're looking for. | | Star Wars | 2009-03-27 | default | These aren't the droids you're looking for. |
And I have a default layout that contains "{{ site.time | date_to_xmlschema }}" And I have a default layout that contains "{{ site.time | date_to_xmlschema }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see today's date in "_site/2009/03/27/star-wars.html" And I should see today's date in "_site/2009/03/27/star-wars.html"
Scenario: Escape text for XML Scenario: Escape text for XML
@ -22,7 +23,8 @@ Feature: Embed filters
| Star & Wars | 2009-03-27 | default | These aren't the droids you're looking for. | | Star & Wars | 2009-03-27 | default | These aren't the droids you're looking for. |
And I have a default layout that contains "{{ page.title | xml_escape }}" And I have a default layout that contains "{{ page.title | xml_escape }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Star &amp; Wars" in "_site/2009/03/27/star-wars.html" And I should see "Star &amp; Wars" in "_site/2009/03/27/star-wars.html"
Scenario: Calculate number of words Scenario: Calculate number of words
@ -33,7 +35,8 @@ Feature: Embed filters
| Star Wars | 2009-03-27 | default | These aren't the droids you're looking for. | | Star Wars | 2009-03-27 | default | These aren't the droids you're looking for. |
And I have a default layout that contains "{{ content | number_of_words }}" And I have a default layout that contains "{{ content | number_of_words }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "7" in "_site/2009/03/27/star-wars.html" And I should see "7" in "_site/2009/03/27/star-wars.html"
Scenario: Convert an array into a sentence Scenario: Convert an array into a sentence
@ -44,7 +47,8 @@ Feature: Embed filters
| Star Wars | 2009-03-27 | default | [scifi, movies, force] | These aren't the droids you're looking for. | | Star Wars | 2009-03-27 | default | [scifi, movies, force] | These aren't the droids you're looking for. |
And I have a default layout that contains "{{ page.tags | array_to_sentence_string }}" And I have a default layout that contains "{{ page.tags | array_to_sentence_string }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "scifi, movies, and force" in "_site/2009/03/27/star-wars.html" And I should see "scifi, movies, and force" in "_site/2009/03/27/star-wars.html"
Scenario: Markdownify a given string Scenario: Markdownify a given string
@ -55,7 +59,8 @@ Feature: Embed filters
| Star Wars | 2009-03-27 | default | These aren't the droids you're looking for. | | Star Wars | 2009-03-27 | default | These aren't the droids you're looking for. |
And I have a default layout that contains "By {{ '_Obi-wan_' | markdownify }}" And I have a default layout that contains "By {{ '_Obi-wan_' | markdownify }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "By <p><em>Obi-wan</em></p>" in "_site/2009/03/27/star-wars.html" And I should see "By <p><em>Obi-wan</em></p>" in "_site/2009/03/27/star-wars.html"
Scenario: Sort by an arbitrary variable Scenario: Sort by an arbitrary variable
@ -68,38 +73,37 @@ Feature: Embed filters
| Page-2 | default | 6 | Something | | Page-2 | default | 6 | Something |
And I have a default layout that contains "{{ site.pages | sort:'value' | map:'title' | join:', ' }}" And I have a default layout that contains "{{ site.pages | sort:'value' | map:'title' | join:', ' }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see exactly "Page-2, Page-1" in "_site/page-1.html" And I should see exactly "Page-2, Page-1" in "_site/page-1.html"
And I should see exactly "Page-2, Page-1" in "_site/page-2.html" And I should see exactly "Page-2, Page-1" in "_site/page-2.html"
Scenario: Sort pages by the title Scenario: Sort pages by the title
Given I have a _layouts directory Given I have a _layouts directory
And I have the following pages:
| title | layout | content |
| Dog | default | Run |
| Bird | default | Fly |
And I have the following page: And I have the following page:
| title | layout | content | | layout | content |
| Dog | default | Run | | default | Jump |
And I have the following page:
| title | layout | content |
| Bird | default | Fly |
And I have the following page:
| layout | content |
| default | Jump |
And I have a default layout that contains "{% assign sorted_pages = site.pages | sort: 'title' %}The rule of {{ sorted_pages.size }}: {% for p in sorted_pages %}{{ p.content | strip_html | strip_newlines }}, {% endfor %}" And I have a default layout that contains "{% assign sorted_pages = site.pages | sort: 'title' %}The rule of {{ sorted_pages.size }}: {% for p in sorted_pages %}{{ p.content | strip_html | strip_newlines }}, {% endfor %}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see exactly "The rule of 3: Jump, Fly, Run," in "_site/bird.html" And I should see exactly "The rule of 3: Jump, Fly, Run," in "_site/bird.html"
Scenario: Sort pages by the title ordering pages without title last Scenario: Sort pages by the title ordering pages without title last
Given I have a _layouts directory Given I have a _layouts directory
And I have the following pages:
| title | layout | content |
| Dog | default | Run |
| Bird | default | Fly |
And I have the following page: And I have the following page:
| title | layout | content | | layout | content |
| Dog | default | Run | | default | Jump |
And I have the following page:
| title | layout | content |
| Bird | default | Fly |
And I have the following page:
| layout | content |
| default | Jump |
And I have a default layout that contains "{% assign sorted_pages = site.pages | sort: 'title', 'last' %}The rule of {{ sorted_pages.size }}: {% for p in sorted_pages %}{{ p.content | strip_html | strip_newlines }}, {% endfor %}" And I have a default layout that contains "{% assign sorted_pages = site.pages | sort: 'title', 'last' %}The rule of {{ sorted_pages.size }}: {% for p in sorted_pages %}{{ p.content | strip_html | strip_newlines }}, {% endfor %}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see exactly "The rule of 3: Fly, Run, Jump," in "_site/bird.html" And I should see exactly "The rule of 3: Fly, Run, Jump," in "_site/bird.html"

View File

@ -12,7 +12,8 @@ Feature: frontmatter defaults
And I have a configuration file with "defaults" set to "[{scope: {path: ""}, values: {layout: "pretty"}}]" And I have a configuration file with "defaults" set to "[{scope: {path: ""}, values: {layout: "pretty"}}]"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "THIS IS THE LAYOUT: <p>just some post</p>" in "_site/2013/09/11/default-layout.html" And I should see "THIS IS THE LAYOUT: <p>just some post</p>" in "_site/2013/09/11/default-layout.html"
And I should see "THIS IS THE LAYOUT: just some page" in "_site/index.html" And I should see "THIS IS THE LAYOUT: just some page" in "_site/index.html"
@ -24,7 +25,8 @@ Feature: frontmatter defaults
And I have an "index.html" page that contains "just {{page.custom}} by {{page.author}}" And I have an "index.html" page that contains "just {{page.custom}} by {{page.author}}"
And I have a configuration file with "defaults" set to "[{scope: {path: ""}, values: {custom: "some special data", author: "Ben"}}]" And I have a configuration file with "defaults" set to "[{scope: {path: ""}, values: {custom: "some special data", author: "Ben"}}]"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "<p>some special data</p>\n<div>Ben</div>" in "_site/2013/09/11/default-data.html" And I should see "<p>some special data</p>\n<div>Ben</div>" in "_site/2013/09/11/default-data.html"
And I should see "just some special data by Ben" in "_site/index.html" And I should see "just some special data by Ben" in "_site/index.html"
@ -48,7 +50,8 @@ Feature: frontmatter defaults
And I have a configuration file with "defaults" set to "[{scope: {path: "special"}, values: {layout: "subfolder", description: "the special section"}}, {scope: {path: ""}, values: {layout: "root", description: "the webpage"}}]" And I have a configuration file with "defaults" set to "[{scope: {path: "special"}, values: {layout: "subfolder", description: "the special section"}}, {scope: {path: ""}, values: {layout: "root", description: "the webpage"}}]"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "root: <p>info on the webpage</p>" in "_site/2013/10/14/about.html" And I should see "root: <p>info on the webpage</p>" in "_site/2013/10/14/about.html"
And I should see "subfolder: <p>info on the special section</p>" in "_site/special/2013/10/14/about.html" And I should see "subfolder: <p>info on the special section</p>" in "_site/special/2013/10/14/about.html"
And I should see "root: Overview for the webpage" in "_site/index.html" And I should see "root: Overview for the webpage" in "_site/index.html"
@ -71,7 +74,8 @@ Feature: frontmatter defaults
And I have a configuration file with "defaults" set to "[{scope: {path: "special"}, values: {layout: "main"}}, {scope: {path: "special/_posts"}, values: {layout: "main"}}, {scope: {path: "_posts"}, values: {layout: "main"}}]" And I have a configuration file with "defaults" set to "[{scope: {path: "special"}, values: {layout: "main"}}, {scope: {path: "special/_posts"}, values: {layout: "main"}}, {scope: {path: "_posts"}, values: {layout: "main"}}]"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "main: <p>content of site/2013/10/14/about.html</p>" in "_site/2013/10/14/about.html" And I should see "main: <p>content of site/2013/10/14/about.html</p>" in "_site/2013/10/14/about.html"
And I should see "main: <p>content of site/special/2013/10/14/about1.html</p>" in "_site/special/2013/10/14/about1.html" And I should see "main: <p>content of site/special/2013/10/14/about1.html</p>" in "_site/special/2013/10/14/about1.html"
And I should see "main: <p>content of site/special/2013/10/14/about2.html</p>" in "_site/special/2013/10/14/about2.html" And I should see "main: <p>content of site/special/2013/10/14/about2.html</p>" in "_site/special/2013/10/14/about2.html"
@ -132,7 +136,8 @@ Feature: frontmatter defaults
myval: "Test" myval: "Test"
""" """
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Value: Test" in "_site/slides/slide1.html" And I should see "Value: Test" in "_site/slides/slide1.html"
Scenario: Override frontmatter defaults inside a collection Scenario: Override frontmatter defaults inside a collection
@ -159,7 +164,8 @@ Feature: frontmatter defaults
myval: "Test" myval: "Test"
""" """
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Value: Override" in "_site/slides/slide2.html" And I should see "Value: Override" in "_site/slides/slide2.html"
Scenario: Deep merge frontmatter defaults Scenario: Deep merge frontmatter defaults

View File

@ -24,7 +24,8 @@ Feature: Hooks
end end
""" """
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "mytinypage" in "_site/foo.html" And I should see "mytinypage" in "_site/foo.html"
Scenario: Modify the payload before rendering the site Scenario: Modify the payload before rendering the site
@ -37,7 +38,8 @@ Feature: Hooks
end end
""" """
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "myparam!" in "_site/index.html" And I should see "myparam!" in "_site/index.html"
Scenario: Modify the site contents after reading Scenario: Modify the site contents after reading
@ -51,7 +53,8 @@ Feature: Hooks
end end
""" """
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And the "_site/page1.html" file should not exist And the "_site/page1.html" file should not exist
And I should see "page2" in "_site/page2.html" And I should see "page2" in "_site/page2.html"
@ -67,33 +70,35 @@ Feature: Hooks
""" """
And I have a "page1.html" page that contains "page1" And I have a "page1.html" page that contains "page1"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "page1" in "_site/firstpage.html" And I should see "page1" in "_site/firstpage.html"
Scenario: Alter a page right after it is initialized Scenario: Alter a page right after it is initialized
Given I have a _plugins directory Given I have a _plugins directory
And I have a "_plugins/ext.rb" file with content: And I have a "_plugins/ext.rb" file with content:
""" """
Jekyll::Hooks.register :page, :post_init do |page| Jekyll::Hooks.register :pages, :post_init do |page|
page.name = 'renamed.html' page.name = 'renamed.html'
page.process(page.name) page.process(page.name)
end end
""" """
And I have a "page1.html" page that contains "page1" And I have a "page1.html" page that contains "page1"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "page1" in "_site/renamed.html" And I should see "page1" in "_site/renamed.html"
Scenario: Alter the payload for one page but not another Scenario: Alter the payload for one page but not another
Given I have a _plugins directory Given I have a _plugins directory
And I have a "_plugins/ext.rb" file with content: And I have a "_plugins/ext.rb" file with content:
""" """
Jekyll::Hooks.register :page, :pre_render do |page, payload| Jekyll::Hooks.register :pages, :pre_render do |page, payload|
payload['myparam'] = 'special' if page.name == 'page1.html' payload['page']['myparam'] = 'special' if page.name == 'page1.html'
end end
""" """
And I have a "page1.html" page that contains "{{ myparam }}" And I have a "page1.html" page that contains "{{ page.myparam }}"
And I have a "page2.html" page that contains "{{ myparam }}" And I have a "page2.html" page that contains "{{ page.myparam }}"
When I run jekyll build When I run jekyll build
Then I should see "special" in "_site/page1.html" Then I should see "special" in "_site/page1.html"
And I should not see "special" in "_site/page2.html" And I should not see "special" in "_site/page2.html"
@ -103,7 +108,7 @@ Feature: Hooks
And I have a "index.html" page that contains "WRAP ME" And I have a "index.html" page that contains "WRAP ME"
And I have a "_plugins/ext.rb" file with content: And I have a "_plugins/ext.rb" file with content:
""" """
Jekyll::Hooks.register :page, :post_render do |page| Jekyll::Hooks.register :pages, :post_render do |page|
page.output = "{{{{{ #{page.output.chomp} }}}}}" page.output = "{{{{{ #{page.output.chomp} }}}}}"
end end
""" """
@ -115,7 +120,7 @@ Feature: Hooks
And I have a "index.html" page that contains "HELLO FROM A PAGE" And I have a "index.html" page that contains "HELLO FROM A PAGE"
And I have a "_plugins/ext.rb" file with content: And I have a "_plugins/ext.rb" file with content:
""" """
Jekyll::Hooks.register :page, :post_write do |page| Jekyll::Hooks.register :pages, :post_write do |page|
require 'fileutils' require 'fileutils'
filename = page.destination(page.site.dest) filename = page.destination(page.site.dest)
FileUtils.mv(filename, "#{filename}.moved") FileUtils.mv(filename, "#{filename}.moved")
@ -128,18 +133,18 @@ Feature: Hooks
Given I have a _plugins directory Given I have a _plugins directory
And I have a "_plugins/ext.rb" file with content: And I have a "_plugins/ext.rb" file with content:
""" """
# rot13 translate Jekyll::Hooks.register :posts, :post_init do |post|
Jekyll::Hooks.register :post, :post_init do |post| post.data['harold'] = "content for entry1.".tr!('abcdefghijklmnopqrstuvwxyz',
post.content.tr!('abcdefghijklmnopqrstuvwxyz', 'nopqrstuvwxyzabcdefghijklm')
'nopqrstuvwxyzabcdefghijklm')
end end
""" """
And I have a _posts directory And I have a _posts directory
And I have the following posts: And I have the following posts:
| title | date | layout | content | | title | date | layout | content |
| entry1 | 2015-03-14 | nil | content for entry1. | | entry1 | 2015-03-14 | nil | {{ page.harold }} |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "pbagrag sbe ragel1." in "_site/2015/03/14/entry1.html" And I should see "pbagrag sbe ragel1." in "_site/2015/03/14/entry1.html"
Scenario: Alter the payload for certain posts Scenario: Alter the payload for certain posts
@ -148,7 +153,7 @@ Feature: Hooks
""" """
# Add myvar = 'old' to posts before 2015-03-15, and myvar = 'new' for # Add myvar = 'old' to posts before 2015-03-15, and myvar = 'new' for
# others # others
Jekyll::Hooks.register :post, :pre_render do |post, payload| Jekyll::Hooks.register :posts, :pre_render do |post, payload|
if post.date < Time.new(2015, 3, 15) if post.date < Time.new(2015, 3, 15)
payload['myvar'] = 'old' payload['myvar'] = 'old'
else else
@ -170,7 +175,7 @@ Feature: Hooks
And I have a "_plugins/ext.rb" file with content: And I have a "_plugins/ext.rb" file with content:
""" """
# Replace content after rendering # Replace content after rendering
Jekyll::Hooks.register :post, :post_render do |post| Jekyll::Hooks.register :posts, :post_render do |post|
post.output.gsub! /42/, 'the answer to life, the universe and everything' post.output.gsub! /42/, 'the answer to life, the universe and everything'
end end
""" """
@ -188,7 +193,7 @@ Feature: Hooks
And I have a "_plugins/ext.rb" file with content: And I have a "_plugins/ext.rb" file with content:
""" """
# Log all post filesystem writes # Log all post filesystem writes
Jekyll::Hooks.register :post, :post_write do |post| Jekyll::Hooks.register :posts, :post_write do |post|
filename = post.destination(post.site.dest) filename = post.destination(post.site.dest)
open('_site/post-build.log', 'a') do |f| open('_site/post-build.log', 'a') do |f|
f.puts "Wrote #{filename} at #{Time.now}" f.puts "Wrote #{filename} at #{Time.now}"
@ -208,7 +213,7 @@ Feature: Hooks
Given I have a _plugins directory Given I have a _plugins directory
And I have a "_plugins/ext.rb" file with content: And I have a "_plugins/ext.rb" file with content:
""" """
Jekyll::Hooks.register [:page, :post], :post_render do |owner| Jekyll::Hooks.register [:pages, :posts], :post_render do |owner|
owner.output = "{{{{{ #{owner.output.chomp} }}}}}" owner.output = "{{{{{ #{owner.output.chomp} }}}}}"
end end
""" """
@ -225,19 +230,19 @@ Feature: Hooks
Given I have a _plugins directory Given I have a _plugins directory
And I have a "_plugins/ext.rb" file with content: And I have a "_plugins/ext.rb" file with content:
""" """
Jekyll::Hooks.register :page, :post_render, priority: :normal do |owner| Jekyll::Hooks.register :pages, :post_render, priority: :normal do |owner|
# first normal runs second # first normal runs second
owner.output = "1 #{owner.output.chomp}" owner.output = "1 #{owner.output.chomp}"
end end
Jekyll::Hooks.register :page, :post_render, priority: :high do |owner| Jekyll::Hooks.register :pages, :post_render, priority: :high do |owner|
# high runs last # high runs last
owner.output = "2 #{owner.output.chomp}" owner.output = "2 #{owner.output.chomp}"
end end
Jekyll::Hooks.register :page, :post_render do |owner| Jekyll::Hooks.register :pages, :post_render do |owner|
# second normal runs third (normal is default) # second normal runs third (normal is default)
owner.output = "3 #{owner.output.chomp}" owner.output = "3 #{owner.output.chomp}"
end end
Jekyll::Hooks.register :page, :post_render, priority: :low do |owner| Jekyll::Hooks.register :pages, :post_render, priority: :low do |owner|
# low runs first # low runs first
owner.output = "4 #{owner.output.chomp}" owner.output = "4 #{owner.output.chomp}"
end end
@ -250,7 +255,7 @@ Feature: Hooks
Given I have a _plugins directory Given I have a _plugins directory
And I have a "_plugins/ext.rb" file with content: And I have a "_plugins/ext.rb" file with content:
""" """
Jekyll::Hooks.register :document, :pre_render do |doc, payload| Jekyll::Hooks.register :documents, :pre_render do |doc, payload|
doc.data['text'] = doc.data['text'] << ' are belong to us' doc.data['text'] = doc.data['text'] << ' are belong to us'
end end
""" """
@ -269,14 +274,15 @@ Feature: Hooks
{{ site.memes.first.text }} {{ site.memes.first.text }}
""" """
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "all your base are belong to us" in "_site/index.html" And I should see "all your base are belong to us" in "_site/index.html"
Scenario: Update a document after rendering it, but before writing it to disk Scenario: Update a document after rendering it, but before writing it to disk
Given I have a _plugins directory Given I have a _plugins directory
And I have a "_plugins/ext.rb" file with content: And I have a "_plugins/ext.rb" file with content:
""" """
Jekyll::Hooks.register :document, :post_render do |doc| Jekyll::Hooks.register :documents, :post_render do |doc|
doc.output.gsub! /<p>/, '<p class="meme">' doc.output.gsub! /<p>/, '<p class="meme">'
end end
""" """
@ -295,14 +301,15 @@ Feature: Hooks
{{ page.text }} {{ page.text }}
""" """
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "<p class=\"meme\">all your base are belong to us" in "_site/memes/doc1.html" And I should see "<p class=\"meme\">all your base are belong to us" in "_site/memes/doc1.html"
Scenario: Perform an action after every document is written Scenario: Perform an action after every document is written
Given I have a _plugins directory Given I have a _plugins directory
And I have a "_plugins/ext.rb" file with content: And I have a "_plugins/ext.rb" file with content:
""" """
Jekyll::Hooks.register :document, :post_write do |doc| Jekyll::Hooks.register :documents, :post_write do |doc|
open('_site/document-build.log', 'a') do |f| open('_site/document-build.log', 'a') do |f|
f.puts "Wrote document #{doc.collection.docs.index doc} at #{Time.now}" f.puts "Wrote document #{doc.collection.docs.index doc} at #{Time.now}"
end end
@ -323,5 +330,6 @@ Feature: Hooks
{{ page.text }} {{ page.text }}
""" """
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Wrote document 0" in "_site/document-build.log" And I should see "Wrote document 0" in "_site/document-build.log"

View File

@ -15,11 +15,12 @@ Feature: Include tags
| Ignore params if unused | 2013-03-21 | html | {% include ignore.html date="today" %} | | Ignore params if unused | 2013-03-21 | html | {% include ignore.html date="today" %} |
| List multiple parameters | 2013-03-21 | html | {% include params.html date="today" start="tomorrow" %} | | List multiple parameters | 2013-03-21 | html | {% include params.html date="today" start="tomorrow" %} |
| Dont keep parameters | 2013-03-21 | html | {% include ignore.html param="test" %}\n{% include header.html %} | | Dont keep parameters | 2013-03-21 | html | {% include ignore.html param="test" %}\n{% include header.html %} |
| Allow params with spaces and quotes | 2013-04-07 | html | {% include params.html cool="param with spaces" super="\"quoted\"" single='has "quotes"' escaped='\'single\' quotes' %} | | Allow params with spaces and quotes | 2013-04-07 | html | {% include params.html cool="param with spaces" super="\\"quoted\\"" single='has "quotes"' escaped='\\'single\\' quotes' %} |
| Parameter syntax | 2013-04-12 | html | {% include params.html param1_or_2="value" %} | | Parameter syntax | 2013-04-12 | html | {% include params.html param1_or_2="value" %} |
| Pass a variable | 2013-06-22 | html | {% assign var = 'some text' %}{% include params.html local=var title=page.title %} | | Pass a variable | 2013-06-22 | html | {% assign var = 'some text' %}{% include params.html local=var title=page.title %} |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "<header>My awesome blog header: myparam</header>" in "_site/2013/03/21/include-files.html" And I should see "<header>My awesome blog header: myparam</header>" in "_site/2013/03/21/include-files.html"
And I should not see "myparam" in "_site/2013/03/21/ignore-params-if-unused.html" And I should not see "myparam" in "_site/2013/03/21/ignore-params-if-unused.html"
And I should see "<li>date = today</li>" in "_site/2013/03/21/list-multiple-parameters.html" And I should see "<li>date = today</li>" in "_site/2013/03/21/list-multiple-parameters.html"
@ -44,7 +45,8 @@ Feature: Include tags
| include_file2 | parametrized.html | | include_file2 | parametrized.html |
And I have an "index.html" page that contains "{% include {{site.include_file1}} %} that {% include {{site.include_file2}} what='parameters' %}" And I have an "index.html" page that contains "{% include {{site.include_file1}} %} that {% include {{site.include_file2}} what='parameters' %}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "a snippet that works with parameters" in "_site/index.html" And I should see "a snippet that works with parameters" in "_site/index.html"
Scenario: Include a variable file in a loop Scenario: Include a variable file in a loop
@ -53,7 +55,8 @@ Feature: Include tags
And I have an "_includes/two.html" file that contains "two" And I have an "_includes/two.html" file that contains "two"
And I have an "index.html" page with files "[one.html, two.html]" that contains "{% for file in page.files %}{% include {{file}} %} {% endfor %}" And I have an "index.html" page with files "[one.html, two.html]" that contains "{% for file in page.files %}{% include {{file}} %} {% endfor %}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "one two" in "_site/index.html" And I should see "one two" in "_site/index.html"
Scenario: Include a file with variables and filters Scenario: Include a file with variables and filters
@ -64,7 +67,8 @@ Feature: Include tags
| include_file | one | | include_file | one |
And I have an "index.html" page that contains "{% include {{ site.include_file | append: '.html' }} %}" And I have an "index.html" page that contains "{% include {{ site.include_file | append: '.html' }} %}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "one included" in "_site/index.html" And I should see "one included" in "_site/index.html"
Scenario: Include a file with partial variables Scenario: Include a file with partial variables
@ -75,5 +79,28 @@ Feature: Include tags
| include_file | one | | include_file | one |
And I have an "index.html" page that contains "{% include {{ site.include_file }}.html %}" And I have an "index.html" page that contains "{% include {{ site.include_file }}.html %}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "one included" in "_site/index.html" And I should see "one included" in "_site/index.html"
Scenario: Include a file and rebuild when include content is changed
Given I have an _includes directory
And I have an "_includes/one.html" file that contains "include"
And I have an "index.html" page that contains "{% include one.html %}"
When I run jekyll build
Then I should get a zero exit status
And the _site directory should exist
And I should see "include" in "_site/index.html"
When I wait 1 second
Then I have an "_includes/one.html" file that contains "include content changed"
When I run jekyll build
Then I should see "include content changed" in "_site/index.html"
Scenario: Include a file with multiple variables
Given I have an _includes directory
And I have an "_includes/header-en.html" file that contains "include"
And I have an "index.html" page that contains "{% assign name = 'header' %}{% assign locale = 'en' %}{% include {{name}}-{{locale}}.html %}"
When I run jekyll build
Then I should get a zero exit status
And the _site directory should exist
And I should see "include" in "_site/index.html"

View File

@ -10,51 +10,59 @@ Feature: Incremental rebuild
| title | date | layout | content | | title | date | layout | content |
| Wargames | 2009-03-27 | default | The only winning move is not to play. | | Wargames | 2009-03-27 | default | The only winning move is not to play. |
And I have a default layout that contains "Post Layout: {{ content }}" And I have a default layout that contains "Post Layout: {{ content }}"
When I run jekyll build When I run jekyll build -I
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Post Layout: <p>The only winning move is not to play.</p>" in "_site/2009/03/27/wargames.html" And I should see "Post Layout: <p>The only winning move is not to play.</p>" in "_site/2009/03/27/wargames.html"
When I run jekyll build When I run jekyll build -I
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Post Layout: <p>The only winning move is not to play.</p>" in "_site/2009/03/27/wargames.html" And I should see "Post Layout: <p>The only winning move is not to play.</p>" in "_site/2009/03/27/wargames.html"
Scenario: Generate a metadata file Scenario: Generate a metadata file
Given I have an "index.html" file that contains "Basic Site" Given I have an "index.html" file that contains "Basic Site"
When I run jekyll build When I run jekyll build -I
Then the ".jekyll-metadata" file should exist Then the ".jekyll-metadata" file should exist
Scenario: Rebuild when content is changed Scenario: Rebuild when content is changed
Given I have an "index.html" file that contains "Basic Site" Given I have an "index.html" file that contains "Basic Site"
When I run jekyll build When I run jekyll build -I
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Basic Site" in "_site/index.html" And I should see "Basic Site" in "_site/index.html"
When I wait 1 second When I wait 1 second
Then I have an "index.html" file that contains "Bacon Site" Then I have an "index.html" file that contains "Bacon Site"
When I run jekyll build When I run jekyll build -I
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Bacon Site" in "_site/index.html" And I should see "Bacon Site" in "_site/index.html"
Scenario: Rebuild when layout is changed Scenario: Rebuild when layout is changed
Given I have a _layouts directory Given I have a _layouts directory
And I have an "index.html" page with layout "default" that contains "Basic Site with Layout" And I have an "index.html" page with layout "default" that contains "Basic Site with Layout"
And I have a default layout that contains "Page Layout: {{ content }}" And I have a default layout that contains "Page Layout: {{ content }}"
When I run jekyll build When I run jekyll build -I
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Page Layout: Basic Site with Layout" in "_site/index.html" And I should see "Page Layout: Basic Site with Layout" in "_site/index.html"
When I wait 1 second When I wait 1 second
Then I have a default layout that contains "Page Layout Changed: {{ content }}" Then I have a default layout that contains "Page Layout Changed: {{ content }}"
When I run jekyll build --full-rebuild When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Page Layout Changed: Basic Site with Layout" in "_site/index.html" And I should see "Page Layout Changed: Basic Site with Layout" in "_site/index.html"
Scenario: Rebuild when an include is changed Scenario: Rebuild when an include is changed
Given I have a _includes directory Given I have a _includes directory
And I have an "index.html" page that contains "Basic Site with include tag: {% include about.textile %}" And I have an "index.html" page that contains "Basic Site with include tag: {% include about.textile %}"
And I have an "_includes/about.textile" file that contains "Generated by Jekyll" And I have an "_includes/about.textile" file that contains "Generated by Jekyll"
When I run jekyll build When I run jekyll build -I
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Basic Site with include tag: Generated by Jekyll" in "_site/index.html" And I should see "Basic Site with include tag: Generated by Jekyll" in "_site/index.html"
When I wait 1 second When I wait 1 second
Then I have an "_includes/about.textile" file that contains "Regenerated by Jekyll" Then I have an "_includes/about.textile" file that contains "Regenerated by Jekyll"
When I run jekyll build When I run jekyll build -I
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Basic Site with include tag: Regenerated by Jekyll" in "_site/index.html" And I should see "Basic Site with include tag: Regenerated by Jekyll" in "_site/index.html"

View File

@ -0,0 +1,37 @@
Feature: Layout data
As a hacker who likes to avoid repetition
I want to be able to embed data into my layouts
In order to make the layouts slightly dynamic
Scenario: Use custom layout data
Given I have a _layouts directory
And I have a "_layouts/custom.html" file with content:
"""
---
foo: my custom data
---
{{ content }} foo: {{ layout.foo }}
"""
And I have an "index.html" page with layout "custom" that contains "page content"
When I run jekyll build
Then the "_site/index.html" file should exist
And I should see "page content\n foo: my custom data" in "_site/index.html"
Scenario: Inherit custom layout data
Given I have a _layouts directory
And I have a "_layouts/custom.html" file with content:
"""
---
layout: base
foo: my custom data
---
{{ content }}
"""
And I have a "_layouts/base.html" file with content:
"""
{{ content }} foo: {{ layout.foo }}
"""
And I have an "index.html" page with layout "custom" that contains "page content"
When I run jekyll build
Then the "_site/index.html" file should exist
And I should see "page content\n foo: my custom data" in "_site/index.html"

View File

@ -11,7 +11,8 @@ Feature: Markdown
| title | date | content | type | | title | date | content | type |
| Hackers | 2009-03-27 | # My Title | markdown | | Hackers | 2009-03-27 | # My Title | markdown |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Index" in "_site/index.html" And I should see "Index" in "_site/index.html"
And I should see "<h1 id=\"my-title\">My Title</h1>" in "_site/2009/03/27/hackers.html" And I should see "<h1 id=\"my-title\">My Title</h1>" in "_site/2009/03/27/hackers.html"
And I should see "<h1 id=\"my-title\">My Title</h1>" in "_site/index.html" And I should see "<h1 id=\"my-title\">My Title</h1>" in "_site/index.html"
@ -27,6 +28,7 @@ Feature: Markdown
| title | date | content | type | | title | date | content | type |
| Hackers | 2009-03-27 | # My Title | markdown | | Hackers | 2009-03-27 | # My Title | markdown |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Index" in "_site/index.html" And I should see "Index" in "_site/index.html"
And I should see "<h1 id=\"my-title\">My Title</h1>" in "_site/index.html" And I should see "<h1 id=\"my-title\">My Title</h1>" in "_site/index.html"

View File

@ -10,7 +10,8 @@ Feature: Fancy permalinks
| None Permalink Schema | 2009-03-27 | Totally nothing. | | None Permalink Schema | 2009-03-27 | Totally nothing. |
And I have a configuration file with "permalink" set to "none" And I have a configuration file with "permalink" set to "none"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Totally nothing." in "_site/none-permalink-schema.html" And I should see "Totally nothing." in "_site/none-permalink-schema.html"
Scenario: Use pretty permalink schema Scenario: Use pretty permalink schema
@ -20,7 +21,8 @@ Feature: Fancy permalinks
| Pretty Permalink Schema | 2009-03-27 | Totally wordpress. | | Pretty Permalink Schema | 2009-03-27 | Totally wordpress. |
And I have a configuration file with "permalink" set to "pretty" And I have a configuration file with "permalink" set to "pretty"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Totally wordpress." in "_site/2009/03/27/pretty-permalink-schema/index.html" And I should see "Totally wordpress." in "_site/2009/03/27/pretty-permalink-schema/index.html"
Scenario: Use pretty permalink schema for pages Scenario: Use pretty permalink schema for pages
@ -29,7 +31,8 @@ Feature: Fancy permalinks
And I have an "sitemap.xml" page that contains "Totally uhm, sitemap" And I have an "sitemap.xml" page that contains "Totally uhm, sitemap"
And I have a configuration file with "permalink" set to "pretty" And I have a configuration file with "permalink" set to "pretty"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Totally index" in "_site/index.html" And I should see "Totally index" in "_site/index.html"
And I should see "Totally awesome" in "_site/awesome/index.html" And I should see "Totally awesome" in "_site/awesome/index.html"
And I should see "Totally uhm, sitemap" in "_site/sitemap.xml" And I should see "Totally uhm, sitemap" in "_site/sitemap.xml"
@ -41,7 +44,8 @@ Feature: Fancy permalinks
| Custom Permalink Schema | stuff | 2009-03-27 | Totally custom. | | Custom Permalink Schema | stuff | 2009-03-27 | Totally custom. |
And I have a configuration file with "permalink" set to "/blog/:year/:month/:day/:title/" And I have a configuration file with "permalink" set to "/blog/:year/:month/:day/:title/"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Totally custom." in "_site/blog/2009/03/27/custom-permalink-schema/index.html" And I should see "Totally custom." in "_site/blog/2009/03/27/custom-permalink-schema/index.html"
Scenario: Use custom permalink schema with category Scenario: Use custom permalink schema with category
@ -51,7 +55,8 @@ Feature: Fancy permalinks
| Custom Permalink Schema | stuff | 2009-03-27 | Totally custom. | | Custom Permalink Schema | stuff | 2009-03-27 | Totally custom. |
And I have a configuration file with "permalink" set to "/:categories/:title.html" And I have a configuration file with "permalink" set to "/:categories/:title.html"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Totally custom." in "_site/stuff/custom-permalink-schema.html" And I should see "Totally custom." in "_site/stuff/custom-permalink-schema.html"
Scenario: Use custom permalink schema with squished date Scenario: Use custom permalink schema with squished date
@ -61,16 +66,32 @@ Feature: Fancy permalinks
| Custom Permalink Schema | stuff | 2009-03-27 | Totally custom. | | Custom Permalink Schema | stuff | 2009-03-27 | Totally custom. |
And I have a configuration file with "permalink" set to "/:month-:day-:year/:title.html" And I have a configuration file with "permalink" set to "/:month-:day-:year/:title.html"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Totally custom." in "_site/03-27-2009/custom-permalink-schema.html" And I should see "Totally custom." in "_site/03-27-2009/custom-permalink-schema.html"
Scenario: Use custom permalink schema with date and time
Given I have a _posts directory
And I have the following post:
| title | category | date | content |
| Custom Permalink Schema | stuff | 2009-03-27 22:31:07 | Totally custom. |
And I have a configuration file with:
| key | value |
| permalink | "/:year:month:day:hour:minute:second.html" |
| timezone | UTC |
When I run jekyll build
Then I should get a zero exit status
And the _site directory should exist
And I should see "Totally custom." in "_site/20090327223107.html"
Scenario: Use per-post permalink Scenario: Use per-post permalink
Given I have a _posts directory Given I have a _posts directory
And I have the following post: And I have the following post:
| title | date | permalink | content | | title | date | permalink | content |
| Some post | 2013-04-14 | /custom/posts/1/ | bla bla | | Some post | 2013-04-14 | /custom/posts/1/ | bla bla |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And the _site/custom/posts/1 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" And I should see "bla bla" in "_site/custom/posts/1/index.html"
@ -80,6 +101,44 @@ Feature: Fancy permalinks
| title | date | permalink | content | | title | date | permalink | content |
| Some post | 2013-04-14 | /custom/posts/some.html | bla bla | | Some post | 2013-04-14 | /custom/posts/some.html | bla bla |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And the _site/custom/posts directory should exist And the _site/custom/posts directory should exist
And I should see "bla bla" in "_site/custom/posts/some.html" And I should see "bla bla" in "_site/custom/posts/some.html"
Scenario: Use pretty permalink schema with cased file name
Given I have a _posts directory
And I have an "_posts/2009-03-27-Pretty-Permalink-Schema.md" page that contains "Totally wordpress"
And I have a configuration file with "permalink" set to "pretty"
When I run jekyll build
Then I should get a zero exit status
And the _site directory should exist
And I should see "Totally wordpress." in "_site/2009/03/27/Pretty-Permalink-Schema/index.html"
Scenario: Use custom permalink schema with cased file name
Given I have a _posts directory
And I have an "_posts/2009-03-27-Custom-Schema.md" page with title "Custom Schema" that contains "Totally awesome"
And I have a configuration file with "permalink" set to "/:year/:month/:day/:slug/"
When I run jekyll build
Then I should get a zero exit status
And the _site directory should exist
And I should see "Totally awesome" in "_site/2009/03/27/custom-schema/index.html"
Scenario: Use pretty permalink schema with title containing underscore
Given I have a _posts directory
And I have an "_posts/2009-03-27-Custom_Schema.md" page with title "Custom Schema" that contains "Totally awesome"
And I have a configuration file with "permalink" set to "pretty"
When I run jekyll build
Then I should get a zero exit status
And the _site directory should exist
And I should see "Totally awesome" in "_site/2009/03/27/Custom_Schema/index.html"
Scenario: Use a non-HTML file extension in the permalink
Given I have a _posts directory
And I have an "_posts/2016-01-18-i-am-php.md" page with permalink "/2016/i-am-php.php" that contains "I am PHP"
And I have a "i-am-also-php.md" page with permalink "/i-am-also-php.php" that contains "I am also PHP"
When I run jekyll build
Then I should get a zero exit status
And the _site directory should exist
And I should see "I am PHP" in "_site/2016/i-am-php.php"
And I should see "I am also PHP" in "_site/i-am-also-php.php"

View File

@ -6,7 +6,8 @@ Feature: Configuring and using plugins
Given I have an "index.html" file that contains "Whatever" Given I have an "index.html" file that contains "Whatever"
And I have a configuration file with "gems" set to "[jekyll_test_plugin]" And I have a configuration file with "gems" set to "[jekyll_test_plugin]"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Whatever" in "_site/index.html" And I should see "Whatever" in "_site/index.html"
And I should see "this is a test" in "_site/test.txt" And I should see "this is a test" in "_site/test.txt"
@ -17,7 +18,8 @@ Feature: Configuring and using plugins
| gems | [jekyll_test_plugin] | | gems | [jekyll_test_plugin] |
| whitelist | [] | | whitelist | [] |
When I run jekyll build --safe When I run jekyll build --safe
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Whatever" in "_site/index.html" And I should see "Whatever" in "_site/index.html"
And the "_site/test.txt" file should not exist And the "_site/test.txt" file should not exist
@ -28,7 +30,8 @@ Feature: Configuring and using plugins
| gems | [jekyll_test_plugin, jekyll_test_plugin_malicious] | | gems | [jekyll_test_plugin, jekyll_test_plugin_malicious] |
| whitelist | [jekyll_test_plugin] | | whitelist | [jekyll_test_plugin] |
When I run jekyll build --safe When I run jekyll build --safe
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Whatever" in "_site/index.html" And I should see "Whatever" in "_site/index.html"
And the "_site/test.txt" file should exist And the "_site/test.txt" file should exist
And I should see "this is a test" in "_site/test.txt" And I should see "this is a test" in "_site/test.txt"

View File

@ -11,7 +11,8 @@ Feature: Post data
| Star Wars | 2009-03-27 | simple | Luke, I am your father. | | Star Wars | 2009-03-27 | simple | Luke, I am your father. |
And I have a simple layout that contains "Post title: {{ page.title }}" And I have a simple layout that contains "Post title: {{ page.title }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Post title: Star Wars" in "_site/2009/03/27/star-wars.html" And I should see "Post title: Star Wars" in "_site/2009/03/27/star-wars.html"
Scenario: Use post.url variable Scenario: Use post.url variable
@ -22,7 +23,8 @@ Feature: Post data
| Star Wars | 2009-03-27 | simple | Luke, I am your father. | | Star Wars | 2009-03-27 | simple | Luke, I am your father. |
And I have a simple layout that contains "Post url: {{ page.url }}" And I have a simple layout that contains "Post url: {{ page.url }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Post url: /2009/03/27/star-wars.html" in "_site/2009/03/27/star-wars.html" And I should see "Post url: /2009/03/27/star-wars.html" in "_site/2009/03/27/star-wars.html"
Scenario: Use post.date variable Scenario: Use post.date variable
@ -33,9 +35,24 @@ Feature: Post data
| Star Wars | 2009-03-27 | simple | Luke, I am your father. | | Star Wars | 2009-03-27 | simple | Luke, I am your father. |
And I have a simple layout that contains "Post date: {{ page.date | date_to_string }}" And I have a simple layout that contains "Post date: {{ page.date | date_to_string }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Post date: 27 Mar 2009" in "_site/2009/03/27/star-wars.html" 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 Scenario: Use post.id variable
Given I have a _posts directory Given I have a _posts directory
And I have a _layouts directory And I have a _layouts directory
@ -44,7 +61,8 @@ Feature: Post data
| Star Wars | 2009-03-27 | simple | Luke, I am your father. | | Star Wars | 2009-03-27 | simple | Luke, I am your father. |
And I have a simple layout that contains "Post id: {{ page.id }}" And I have a simple layout that contains "Post id: {{ page.id }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Post id: /2009/03/27/star-wars" in "_site/2009/03/27/star-wars.html" And I should see "Post id: /2009/03/27/star-wars" in "_site/2009/03/27/star-wars.html"
Scenario: Use post.content variable Scenario: Use post.content variable
@ -55,7 +73,8 @@ Feature: Post data
| Star Wars | 2009-03-27 | simple | Luke, I am your father. | | Star Wars | 2009-03-27 | simple | Luke, I am your father. |
And I have a simple layout that contains "Post content: {{ content }}" And I have a simple layout that contains "Post content: {{ content }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Post content: <p>Luke, I am your father.</p>" in "_site/2009/03/27/star-wars.html" And I should see "Post content: <p>Luke, I am your father.</p>" in "_site/2009/03/27/star-wars.html"
Scenario: Use post.categories variable when category is in a folder Scenario: Use post.categories variable when category is in a folder
@ -67,7 +86,8 @@ Feature: Post data
| Star Wars | 2009-03-27 | simple | Luke, I am your father. | | Star Wars | 2009-03-27 | simple | Luke, I am your father. |
And I have a simple layout that contains "Post category: {{ page.categories }}" And I have a simple layout that contains "Post category: {{ page.categories }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Post category: movies" in "_site/movies/2009/03/27/star-wars.html" 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 category in YAML Scenario: Use post.categories variable when category is in a folder and has category in YAML
@ -79,7 +99,8 @@ Feature: Post data
| Star Wars | 2009-03-27 | simple | film | Luke, I am your father. | | Star Wars | 2009-03-27 | simple | film | Luke, I am your father. |
And I have a simple layout that contains "Post category: {{ page.categories }}" And I have a simple layout that contains "Post category: {{ page.categories }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Post category: movies" in "_site/movies/film/2009/03/27/star-wars.html" 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 Scenario: Use post.categories variable when category is in a folder and has categories in YAML
@ -91,7 +112,8 @@ Feature: Post data
| Star Wars | 2009-03-27 | simple | [film, scifi] | Luke, I am your father. | | 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 }}" And I have a simple layout that contains "Post category: {{ page.categories }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Post category: movies" in "_site/movies/film/scifi/2009/03/27/star-wars.html" 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 Scenario: Use post.categories variable when category is in a folder and duplicated category is in YAML
@ -103,7 +125,8 @@ Feature: Post data
| Star Wars | 2009-03-27 | simple | movies | Luke, I am your father. | | Star Wars | 2009-03-27 | simple | movies | Luke, I am your father. |
And I have a simple layout that contains "Post category: {{ page.categories }}" And I have a simple layout that contains "Post category: {{ page.categories }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Post category: movies" in "_site/movies/2009/03/27/star-wars.html" And I should see "Post category: movies" in "_site/movies/2009/03/27/star-wars.html"
Scenario: Use post.tags variable Scenario: Use post.tags variable
@ -114,7 +137,8 @@ Feature: Post data
| Star Wars | 2009-05-18 | simple | twist | Luke, I am your father. | | Star Wars | 2009-05-18 | simple | twist | Luke, I am your father. |
And I have a simple layout that contains "Post tags: {{ page.tags }}" And I have a simple layout that contains "Post tags: {{ page.tags }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Post tags: twist" in "_site/2009/05/18/star-wars.html" And I should see "Post tags: twist" in "_site/2009/05/18/star-wars.html"
Scenario: Use post.categories variable when categories are in folders Scenario: Use post.categories variable when categories are in folders
@ -127,7 +151,8 @@ Feature: Post data
| Star Wars | 2009-03-27 | simple | Luke, I am your father. | | Star Wars | 2009-03-27 | simple | Luke, I am your father. |
And I have a simple layout that contains "Post categories: {{ page.categories | array_to_sentence_string }}" And I have a simple layout that contains "Post categories: {{ page.categories | array_to_sentence_string }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
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/2009/03/27/star-wars.html"
Scenario: Use post.categories variable when categories are in folders with mixed case Scenario: Use post.categories variable when categories are in folders with mixed case
@ -140,7 +165,8 @@ Feature: Post data
| Star Wars | 2009-03-27 | simple | Luke, I am your father. | | Star Wars | 2009-03-27 | simple | Luke, I am your father. |
And I have a simple layout that contains "Post categories: {{ page.categories | array_to_sentence_string }}" And I have a simple layout that contains "Post categories: {{ page.categories | array_to_sentence_string }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
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/2009/03/27/star-wars.html"
Scenario: Use post.categories variable when category is in YAML Scenario: Use post.categories variable when category is in YAML
@ -151,7 +177,8 @@ Feature: Post data
| Star Wars | 2009-03-27 | simple | movies | Luke, I am your father. | | Star Wars | 2009-03-27 | simple | movies | Luke, I am your father. |
And I have a simple layout that contains "Post category: {{ page.categories }}" And I have a simple layout that contains "Post category: {{ page.categories }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Post category: movies" in "_site/movies/2009/03/27/star-wars.html" 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 and is mixed-case Scenario: Use post.categories variable when category is in YAML and is mixed-case
@ -162,7 +189,8 @@ Feature: Post data
| Star Wars | 2009-03-27 | simple | Movies | Luke, I am your father. | | Star Wars | 2009-03-27 | simple | Movies | Luke, I am your father. |
And I have a simple layout that contains "Post category: {{ page.categories }}" And I have a simple layout that contains "Post category: {{ page.categories }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Post category: Movies" in "_site/movies/2009/03/27/star-wars.html" And I should see "Post category: Movies" in "_site/movies/2009/03/27/star-wars.html"
Scenario: Use post.categories variable when categories are in YAML Scenario: Use post.categories variable when categories are in YAML
@ -173,7 +201,8 @@ Feature: Post data
| Star Wars | 2009-03-27 | simple | ['scifi', 'movies'] | Luke, I am your father. | | 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 }}" And I have a simple layout that contains "Post categories: {{ page.categories | array_to_sentence_string }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
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/2009/03/27/star-wars.html"
Scenario: Use post.categories variable when categories are in YAML and are duplicated Scenario: Use post.categories variable when categories are in YAML and are duplicated
@ -184,7 +213,28 @@ Feature: Post data
| Star Wars | 2009-03-27 | simple | ['movies', 'movies'] | Luke, I am your father. | | 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 }}" And I have a simple layout that contains "Post category: {{ page.categories }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Post category: movies" in "_site/movies/2009/03/27/star-wars.html"
Scenario: Superdirectories of _posts applied to post.categories
Given I have a movies/_posts directory
And I have a "movies/_posts/2009-03-27-star-wars.html" page with layout "simple" that contains "hi"
And I have a _layouts directory
And I have a simple layout that contains "Post category: {{ page.categories }}"
When I run jekyll build
Then I should get a zero exit status
And the _site directory should exist
And I should see "Post category: movies" in "_site/movies/2009/03/27/star-wars.html"
Scenario: Subdirectories of _posts not applied to post.categories
Given I have a movies/_posts/scifi directory
And I have a "movies/_posts/scifi/2009-03-27-star-wars.html" page with layout "simple" that contains "hi"
And I have a _layouts directory
And I have a simple layout that contains "Post category: {{ page.categories }}"
When I run jekyll build
Then I should get a zero exit status
And the _site directory should exist
And I should see "Post category: movies" in "_site/movies/2009/03/27/star-wars.html" And I should see "Post category: movies" in "_site/movies/2009/03/27/star-wars.html"
Scenario: Use post.categories variable when categories are in YAML with mixed case Scenario: Use post.categories variable when categories are in YAML with mixed case
@ -196,7 +246,8 @@ Feature: Post data
| Star Trek | 2013-03-17 | simple | ['SciFi', 'movies'] | Jean Luc, I am your father. | | Star Trek | 2013-03-17 | simple | ['SciFi', 'movies'] | Jean Luc, I am your father. |
And I have a simple layout that contains "Post categories: {{ page.categories | array_to_sentence_string }}" And I have a simple layout that contains "Post categories: {{ page.categories | array_to_sentence_string }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
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/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" And I should see "Post categories: SciFi and movies" in "_site/scifi/movies/2013/03/17/star-trek.html"
@ -206,7 +257,8 @@ Feature: Post data
| title | type | date | content | | title | type | date | content |
| my-post | html | 2013-04-12 | Source path: {{ page.path }} | | my-post | html | 2013-04-12 | Source path: {{ page.path }} |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And 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" 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: Examples:
@ -215,14 +267,15 @@ Feature: Post data
| dir | dir/ | | dir | dir/ |
| dir/nested | dir/nested/ | | dir/nested | dir/nested/ |
Scenario: Override page.path variable Scenario: Cannot override page.path variable
Given I have a _posts directory Given I have a _posts directory
And I have the following post: And I have the following post:
| title | date | path | content | | title | date | path | content |
| override | 2013-04-12 | override-path.html | Custom path: {{ page.path }} | | override | 2013-04-12 | override-path.html | Non-custom path: {{ page.path }} |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And I should see "Custom path: override-path.html" in "_site/2013/04/12/override.html" And the _site directory should exist
And I should see "Non-custom path: _posts/2013-04-12-override.markdown" in "_site/2013/04/12/override.html"
Scenario: Disable a post from being published Scenario: Disable a post from being published
Given I have a _posts directory Given I have a _posts directory
@ -231,7 +284,8 @@ Feature: Post data
| title | date | layout | published | content | | title | date | layout | published | content |
| Star Wars | 2009-03-27 | simple | false | Luke, I am your father. | | Star Wars | 2009-03-27 | simple | false | Luke, I am your father. |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And the "_site/2009/03/27/star-wars.html" file should not exist And the "_site/2009/03/27/star-wars.html" file should not exist
And I should see "Published!" in "_site/index.html" And I should see "Published!" in "_site/index.html"
@ -243,9 +297,22 @@ Feature: Post data
| Star Wars | 2009-03-27 | simple | Darth Vader | Luke, I am your father. | | Star Wars | 2009-03-27 | simple | Darth Vader | Luke, I am your father. |
And I have a simple layout that contains "Post author: {{ page.author }}" And I have a simple layout that contains "Post author: {{ page.author }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Post author: Darth Vader" in "_site/2009/03/27/star-wars.html" And I should see "Post author: Darth Vader" in "_site/2009/03/27/star-wars.html"
Scenario: Use a variable which is a reserved keyword in Ruby
Given I have a _posts directory
And I have a _layouts directory
And I have the following post:
| title | date | layout | class | content |
| My post | 2016-01-21 | simple | kewl-post | Luke, I am your father. |
And I have a simple layout that contains "{{page.title}} has class {{page.class}}"
When I run jekyll build
Then I should get a zero exit status
And the _site directory should exist
And I should see "My post has class kewl-post" in "_site/2016/01/21/my-post.html"
Scenario: Previous and next posts title Scenario: Previous and next posts title
Given I have a _posts directory Given I have a _posts directory
And I have a _layouts directory And I have a _layouts directory
@ -256,6 +323,7 @@ Feature: Post data
| Terminator | 2009-05-27 | ordered | Arnold | Sayonara, baby | | Terminator | 2009-05-27 | ordered | Arnold | Sayonara, baby |
And I have a ordered layout that contains "Previous post: {{ page.previous.title }} and next post: {{ page.next.title }}" And I have a ordered layout that contains "Previous post: {{ page.previous.title }} and next post: {{ page.next.title }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "next post: Some like it hot" in "_site/2009/03/27/star-wars.html" And I should see "next post: Some like it hot" in "_site/2009/03/27/star-wars.html"
And I should see "Previous post: Some like it hot" in "_site/2009/05/27/terminator.html" And I should see "Previous post: Some like it hot" in "_site/2009/05/27/terminator.html"

View File

@ -12,7 +12,8 @@ Feature: Post excerpts
| title | date | layout | content | | title | date | layout | content |
| entry1 | 2007-12-31 | post | content for entry1. | | entry1 | 2007-12-31 | post | content for entry1. |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see exactly "<p>content for entry1.</p>" in "_site/index.html" And I should see exactly "<p>content for entry1.</p>" in "_site/index.html"
Scenario: An excerpt from a post with a layout Scenario: An excerpt from a post with a layout
@ -24,7 +25,8 @@ Feature: Post excerpts
| title | date | layout | content | | title | date | layout | content |
| entry1 | 2007-12-31 | post | content for entry1. | | entry1 | 2007-12-31 | post | content for entry1. |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And the _site/2007 directory should exist And the _site/2007 directory should exist
And the _site/2007/12 directory should exist And the _site/2007/12 directory should exist
And the _site/2007/12/31 directory should exist And the _site/2007/12/31 directory should exist
@ -41,10 +43,11 @@ Feature: Post excerpts
| title | date | layout | content | | title | date | layout | content |
| entry1 | 2007-12-31 | post | content for entry1. | | entry1 | 2007-12-31 | post | content for entry1. |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And the _site/2007 directory should exist And the _site/2007 directory should exist
And the _site/2007/12 directory should exist And the _site/2007/12 directory should exist
And the _site/2007/12/31 directory should exist And the _site/2007/12/31 directory should exist
And the "_site/2007/12/31/entry1.html" file should exist And the "_site/2007/12/31/entry1.html" file should exist
And I should see "<p>content for entry1.</p>" in "_site/index.html" And I should see "<p>content for entry1.</p>" in "_site/index.html"
And I should see "<html><head></head><body><p>content for entry1.</p>\n\n</body></html>" in "_site/2007/12/31/entry1.html" And I should see "<html><head></head><body><p>content for entry1.</p>\n</body></html>" in "_site/2007/12/31/entry1.html"

View File

@ -5,11 +5,19 @@ Feature: Rendering
But I want to make it as simply as possible But I want to make it as simply as possible
So render with Liquid and place in Layouts So render with Liquid and place in Layouts
Scenario: When receiving bad Liquid
Given I have a "index.html" page with layout "simple" that contains "{% include invalid.html %}"
And I have a simple layout that contains "{{ content }}"
When I run jekyll build
Then I should get a non-zero exit-status
And I should see "Liquid Exception" in the build output
Scenario: Render Liquid and place in layout Scenario: Render Liquid and place in layout
Given I have a "index.html" page with layout "simple" that contains "Hi there, Jekyll {{ jekyll.environment }}!" Given I have a "index.html" page with layout "simple" that contains "Hi there, Jekyll {{ jekyll.environment }}!"
And I have a simple layout that contains "{{ content }}Ahoy, indeed!" And I have a simple layout that contains "{{ content }}Ahoy, indeed!"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Hi there, Jekyll development!\nAhoy, indeed" in "_site/index.html" And I should see "Hi there, Jekyll development!\nAhoy, indeed" in "_site/index.html"
Scenario: Don't place asset files in layout Scenario: Don't place asset files in layout
@ -18,7 +26,8 @@ Feature: Rendering
And I have a configuration file with "gems" set to "[jekyll-coffeescript]" And I have a configuration file with "gems" set to "[jekyll-coffeescript]"
And I have a simple layout that contains "{{ content }}Ahoy, indeed!" And I have a simple layout that contains "{{ content }}Ahoy, indeed!"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should not see "Ahoy, indeed!" in "_site/index.css" And I should not see "Ahoy, indeed!" in "_site/index.css"
And I should not see "Ahoy, indeed!" in "_site/index.js" And I should not see "Ahoy, indeed!" in "_site/index.js"
@ -26,18 +35,21 @@ Feature: Rendering
Given I have an "index.scss" page that contains ".foo-bar { color:{{site.color}}; }" Given I have an "index.scss" page that contains ".foo-bar { color:{{site.color}}; }"
And I have a configuration file with "color" set to "red" And I have a configuration file with "color" set to "red"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see ".foo-bar {\n color: red; }" in "_site/index.css" And I should see ".foo-bar {\n color: red; }" in "_site/index.css"
Scenario: Not render liquid in CoffeeScript without explicitly including jekyll-coffeescript Scenario: Not render liquid in CoffeeScript without explicitly including jekyll-coffeescript
Given I have an "index.coffee" page with animal "cicada" that contains "hey='for {{page.animal}}'" Given I have an "index.coffee" page with animal "cicada" that contains "hey='for {{page.animal}}'"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And the "_site/index.js" file should not exist And the "_site/index.js" file should not exist
Scenario: Render liquid in CoffeeScript with jekyll-coffeescript enabled Scenario: Render liquid in CoffeeScript with jekyll-coffeescript enabled
Given I have an "index.coffee" page with animal "cicada" that contains "hey='for {{page.animal}}'" Given I have an "index.coffee" page with animal "cicada" that contains "hey='for {{page.animal}}'"
And I have a configuration file with "gems" set to "[jekyll-coffeescript]" And I have a configuration file with "gems" set to "[jekyll-coffeescript]"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "hey = 'for cicada';" in "_site/index.js" And I should see "hey = 'for cicada';" in "_site/index.js"

View File

@ -8,7 +8,8 @@ Feature: Site configuration
And I have an "_sourcedir/index.html" file that contains "Changing source directory" And I have an "_sourcedir/index.html" file that contains "Changing source directory"
And I have a configuration file with "source" set to "_sourcedir" And I have a configuration file with "source" set to "_sourcedir"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Changing source directory" in "_site/index.html" And I should see "Changing source directory" in "_site/index.html"
Scenario: Change destination directory Scenario: Change destination directory
@ -66,27 +67,31 @@ Feature: Site configuration
Given I have an "index.markdown" page that contains "[Google](http://google.com)" Given I have an "index.markdown" page that contains "[Google](http://google.com)"
And I have a configuration file with "markdown" set to "rdiscount" And I have a configuration file with "markdown" set to "rdiscount"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "<a href=\"http://google.com\">Google</a>" in "_site/index.html" And I should see "<a href=\"http://google.com\">Google</a>" in "_site/index.html"
Scenario: Use Kramdown for markup Scenario: Use Kramdown for markup
Given I have an "index.markdown" page that contains "[Google](http://google.com)" Given I have an "index.markdown" page that contains "[Google](http://google.com)"
And I have a configuration file with "markdown" set to "kramdown" And I have a configuration file with "markdown" set to "kramdown"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "<a href=\"http://google.com\">Google</a>" in "_site/index.html" And I should see "<a href=\"http://google.com\">Google</a>" in "_site/index.html"
Scenario: Use Redcarpet for markup Scenario: Use Redcarpet for markup
Given I have an "index.markdown" page that contains "[Google](http://google.com)" Given I have an "index.markdown" page that contains "[Google](http://google.com)"
And I have a configuration file with "markdown" set to "redcarpet" And I have a configuration file with "markdown" set to "redcarpet"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "<a href=\"http://google.com\">Google</a>" in "_site/index.html" And I should see "<a href=\"http://google.com\">Google</a>" in "_site/index.html"
Scenario: Highlight code with pygments Scenario: Highlight code with pygments
Given I have an "index.html" page that contains "{% highlight ruby %} puts 'Hello world!' {% endhighlight %}" Given I have an "index.html" page that contains "{% highlight ruby %} puts 'Hello world!' {% endhighlight %}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Hello world!" in "_site/index.html" And I should see "Hello world!" in "_site/index.html"
And I should see "class=\"highlight\"" in "_site/index.html" And I should see "class=\"highlight\"" in "_site/index.html"
@ -94,7 +99,8 @@ Feature: Site configuration
Given I have an "index.html" page that contains "{% highlight ruby %} puts 'Hello world!' {% endhighlight %}" Given I have an "index.html" page that contains "{% highlight ruby %} puts 'Hello world!' {% endhighlight %}"
And I have a configuration file with "highlighter" set to "rouge" And I have a configuration file with "highlighter" set to "rouge"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Hello world!" in "_site/index.html" And I should see "Hello world!" in "_site/index.html"
And I should see "class=\"highlight\"" in "_site/index.html" And I should see "class=\"highlight\"" in "_site/index.html"
@ -122,7 +128,8 @@ Feature: Site configuration
| entry1 | 2007-12-31 | post | content for entry1. | | entry1 | 2007-12-31 | post | content for entry1. |
| entry2 | 2020-01-31 | post | content for entry2. | | entry2 | 2020-01-31 | post | content for entry2. |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Page Layout: 1 on 2010-01-01" in "_site/index.html" And I should see "Page Layout: 1 on 2010-01-01" in "_site/index.html"
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 entry1.</p>" in "_site/2007/12/31/entry1.html"
And the "_site/2020/01/31/entry2.html" file should not exist And the "_site/2020/01/31/entry2.html" file should not exist
@ -142,7 +149,8 @@ Feature: Site configuration
| entry1 | 2007-12-31 | post | content for entry1. | | entry1 | 2007-12-31 | post | content for entry1. |
| entry2 | 2020-01-31 | post | content for entry2. | | entry2 | 2020-01-31 | post | content for entry2. |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Page Layout: 2 on 2010-01-01" in "_site/index.html" And I should see "Page Layout: 2 on 2010-01-01" in "_site/index.html"
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 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" And I should see "Post Layout: <p>content for entry2.</p>" in "_site/2020/01/31/entry2.html"
@ -161,7 +169,8 @@ Feature: Site configuration
| entry1 | 2013-04-09 23:22 -0400 | post | content for entry1. | | entry1 | 2013-04-09 23:22 -0400 | post | content for entry1. |
| entry2 | 2013-04-10 03:14 -0400 | post | content for entry2. | | entry2 | 2013-04-10 03:14 -0400 | post | content for entry2. |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Page Layout: 2" in "_site/index.html" And I should see "Page Layout: 2" in "_site/index.html"
And I should see "Post Layout: <p>content for entry1.</p>\n 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 entry1.</p>\n 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>\n built at 2013-04-10T03:14:00-04:00" in "_site/2013/04/10/entry2.html" And I should see "Post Layout: <p>content for entry2.</p>\n built at 2013-04-10T03:14:00-04:00" in "_site/2013/04/10/entry2.html"
@ -180,7 +189,8 @@ Feature: Site configuration
| entry1 | 2013-04-09 23:22 +0400 | post | content for entry1. | | entry1 | 2013-04-09 23:22 +0400 | post | content for entry1. |
| entry2 | 2013-04-10 03:14 +0400 | post | content for entry2. | | entry2 | 2013-04-10 03:14 +0400 | post | content for entry2. |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Page Layout: 2" in "_site/index.html" And I should see "Page Layout: 2" in "_site/index.html"
And the "_site/2013/04/09/entry1.html" file should exist And the "_site/2013/04/09/entry1.html" file should exist
And the "_site/2013/04/09/entry2.html" file should exist And the "_site/2013/04/09/entry2.html" file should exist
@ -198,7 +208,8 @@ Feature: Site configuration
| Oranges | 2009-04-01 | An article about oranges | | Oranges | 2009-04-01 | An article about oranges |
| Bananas | 2009-04-05 | An article about bananas | | Bananas | 2009-04-05 | An article about bananas |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And the "_site/2009/04/05/bananas.html" file should exist And the "_site/2009/04/05/bananas.html" file should exist
And the "_site/2009/04/01/oranges.html" file should exist And the "_site/2009/04/01/oranges.html" file should exist
And the "_site/2009/03/27/apples.html" file should not exist And the "_site/2009/03/27/apples.html" file should not exist
@ -211,7 +222,8 @@ Feature: Site configuration
| .gitignore | | .gitignore |
| .foo | | .foo |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see ".DS_Store" in "_site/.gitignore" And I should see ".DS_Store" in "_site/.gitignore"
And the "_site/.htaccess" file should not exist And the "_site/.htaccess" file should not exist
@ -224,14 +236,15 @@ Feature: Site configuration
| key | value | | key | value |
| time | 2010-01-01 | | time | 2010-01-01 |
| future | true | | future | true |
| layouts | _theme | | layouts_dir | _theme |
And I have a _posts directory And I have a _posts directory
And I have the following posts: And I have the following posts:
| title | date | layout | content | | title | date | layout | content |
| entry1 | 2007-12-31 | post | content for entry1. | | entry1 | 2007-12-31 | post | content for entry1. |
| entry2 | 2020-01-31 | post | content for entry2. | | entry2 | 2020-01-31 | post | content for entry2. |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Page Layout: 2 on 2010-01-01" in "_site/index.html" And I should see "Page Layout: 2 on 2010-01-01" in "_site/index.html"
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 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" And I should see "Post Layout: <p>content for entry2.</p>" in "_site/2020/01/31/entry2.html"
@ -240,6 +253,7 @@ Feature: Site configuration
Given I have an "index.html" page with layout "page" that contains "FOO" Given I have an "index.html" page with layout "page" that contains "FOO"
And I have a "_config.yml" file that contains "layouts: '../../../../../../../../../../../../../../usr/include'" And I have a "_config.yml" file that contains "layouts: '../../../../../../../../../../../../../../usr/include'"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "FOO" in "_site/index.html" And I should see "FOO" in "_site/index.html"
And I should not see " " in "_site/index.html" And I should not see " " in "_site/index.html"

View File

@ -6,14 +6,16 @@ Feature: Site data
Scenario: Use page variable in a page Scenario: Use page variable in a page
Given I have an "contact.html" page with title "Contact" that contains "{{ page.title }}: email@example.com" Given I have an "contact.html" page with title "Contact" that contains "{{ page.title }}: email@example.com"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Contact: email@example.com" in "_site/contact.html" And I should see "Contact: email@example.com" in "_site/contact.html"
Scenario Outline: Use page.path variable in a page Scenario Outline: Use page.path variable in a page
Given I have a <dir> directory Given I have a <dir> directory
And I have a "<path>" page that contains "Source path: {{ page.path }}" And I have a "<path>" page that contains "Source path: {{ page.path }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Source path: <path>" in "_site/<path>" And I should see "Source path: <path>" in "_site/<path>"
Examples: Examples:
@ -25,13 +27,15 @@ Feature: Site data
Scenario: Override page.path Scenario: Override page.path
Given I have an "override.html" page with path "custom-override.html" that contains "Custom path: {{ page.path }}" Given I have an "override.html" page with path "custom-override.html" that contains "Custom path: {{ page.path }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Custom path: custom-override.html" in "_site/override.html" And I should see "Custom path: custom-override.html" in "_site/override.html"
Scenario: Use site.time variable Scenario: Use site.time variable
Given I have an "index.html" page that contains "{{ site.time }}" Given I have an "index.html" page that contains "{{ site.time }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see today's time in "_site/index.html" And I should see today's time in "_site/index.html"
Scenario: Use site.posts variable for latest post Scenario: Use site.posts variable for latest post
@ -43,7 +47,8 @@ Feature: Site data
| Second Post | 2009-03-26 | My Second Post | | Second Post | 2009-03-26 | My Second Post |
| Third Post | 2009-03-27 | My Third Post | | Third Post | 2009-03-27 | My Third Post |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Third Post: /2009/03/27/third-post.html" in "_site/index.html" And I should see "Third Post: /2009/03/27/third-post.html" in "_site/index.html"
Scenario: Use site.posts variable in a loop Scenario: Use site.posts variable in a loop
@ -55,7 +60,8 @@ Feature: Site data
| Second Post | 2009-03-26 | My Second Post | | Second Post | 2009-03-26 | My Second Post |
| Third Post | 2009-03-27 | My Third Post | | Third Post | 2009-03-27 | My Third Post |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Third Post Second Post First Post" in "_site/index.html" And I should see "Third Post Second Post First Post" in "_site/index.html"
Scenario: Use site.categories.code variable Scenario: Use site.categories.code variable
@ -66,7 +72,8 @@ Feature: Site data
| Awesome Hack | 2009-03-26 | code | puts 'Hello World' | | Awesome Hack | 2009-03-26 | code | puts 'Hello World' |
| Delicious Beer | 2009-03-26 | food | 1) Yuengling | | Delicious Beer | 2009-03-26 | food | 1) Yuengling |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Awesome Hack" in "_site/index.html" And I should see "Awesome Hack" in "_site/index.html"
Scenario: Use site.tags variable Scenario: Use site.tags variable
@ -76,7 +83,8 @@ Feature: Site data
| title | date | tag | content | | title | date | tag | content |
| Delicious Beer | 2009-03-26 | beer | 1) Yuengling | | Delicious Beer | 2009-03-26 | beer | 1) Yuengling |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "Yuengling" in "_site/index.html" And I should see "Yuengling" in "_site/index.html"
Scenario: Order Posts by name when on the same date Scenario: Order Posts by name when on the same date
@ -90,18 +98,21 @@ Feature: Site data
| C | 2009-03-26 | C | | C | 2009-03-26 | C |
| last | 2009-04-26 | last | | last | 2009-04-26 | last |
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "last:C, C:B,last B:A,C A:first,B first:,A" in "_site/index.html" And I should see "last:C, C:B,last B:A,C A:first,B first:,A" in "_site/index.html"
Scenario: Use configuration date in site payload Scenario: Use configuration date in site payload
Given I have an "index.html" page that contains "{{ site.url }}" Given I have an "index.html" page that contains "{{ site.url }}"
And I have a configuration file with "url" set to "http://example.com" And I have a configuration file with "url" set to "http://example.com"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "http://example.com" in "_site/index.html" And I should see "http://example.com" in "_site/index.html"
Scenario: Access Jekyll version via jekyll.version Scenario: Access Jekyll version via jekyll.version
Given I have an "index.html" page that contains "{{ jekyll.version }}" Given I have an "index.html" page that contains "{{ jekyll.version }}"
When I run jekyll build When I run jekyll build
Then the _site directory should exist Then I should get a zero exit status
And the _site directory should exist
And I should see "\d+\.\d+\.\d+" in "_site/index.html" And I should see "\d+\.\d+\.\d+" in "_site/index.html"

View File

@ -0,0 +1,245 @@
Before do
FileUtils.mkdir_p(Paths.test_dir) unless Paths.test_dir.directory?
Dir.chdir(Paths.test_dir)
end
#
After do
Paths.test_dir.rmtree if Paths.test_dir.exist?
Paths.output_file.delete if Paths.output_file.exist?
Paths.status_file.delete if Paths.status_file.exist?
Dir.chdir(Paths.test_dir.parent)
end
#
Given %r{^I have a blank site in "(.*)"$} do |path|
if !File.exist?(path)
then FileUtils.mkdir_p(path)
end
end
#
Given %r{^I do not have a "(.*)" directory$} do |path|
Paths.test_dir.join(path).directory?
end
#
Given %r{^I have an? "(.*)" page(?: with (.*) "(.*)")? that contains "(.*)"$} do |file, key, value, text|
File.write(file, Jekyll::Utils.strip_heredoc(<<-DATA))
---
#{key || 'layout'}: #{value || 'nil'}
---
#{text}
DATA
end
#
Given %r{^I have an? "(.*)" file that contains "(.*)"$} do |file, text|
File.write(file, text)
end
#
Given %r{^I have an? (.*) (layout|theme) that contains "(.*)"$} do |name, type, text|
folder = type == "layout" ? "_layouts" : "_theme"
destination_file = Pathname.new(File.join(folder, "#{name}.html"))
FileUtils.mkdir_p(destination_file.parent) unless destination_file.parent.directory?
File.write(destination_file, text)
end
#
Given %r{^I have an? "(.*)" file with content:$} do |file, text|
File.write(file, text)
end
#
Given %r{^I have an? (.*) directory$} do |dir|
if !File.directory?(dir)
then FileUtils.mkdir_p(dir)
end
end
#
Given %r{^I have the following (draft|page|post)s?(?: (in|under) "([^"]+)")?:$} do |status, direction, folder, table|
table.hashes.each do |input_hash|
title = slug(input_hash["title"])
ext = input_hash["type"] || "markdown"
filename = filename = "#{title}.#{ext}" if %w(draft page).include?(status)
before, after = location(folder, direction)
dest_folder = "_drafts" if status == "draft"
dest_folder = "_posts" if status == "post"
dest_folder = "" if status == "page"
if status == "post"
parsed_date = Time.xmlschema(input_hash['date']) rescue Time.parse(input_hash['date'])
filename = "#{parsed_date.strftime('%Y-%m-%d')}-#{title}.#{ext}"
end
path = File.join(before, dest_folder, after, filename)
File.write(path, file_content_from_hash(input_hash))
end
end
#
Given %r{^I have a configuration file with "(.*)" set to "(.*)"$} do |key, value|
config = if source_dir.join("_config.yml").exist?
SafeYAML.load_file(source_dir.join("_config.yml"))
else
{}
end
config[key] = YAML.load(value)
File.write("_config.yml", YAML.dump(config))
end
#
Given %r{^I have a configuration file with:$} do |table|
table.hashes.each do |row|
step %(I have a configuration file with "#{row["key"]}" set to "#{row["value"]}")
end
end
#
Given %r{^I have a configuration file with "([^\"]*)" set to:$} do |key, table|
File.open("_config.yml", "w") do |f|
f.write("#{key}:\n")
table.hashes.each do |row|
f.write("- #{row["value"]}\n")
end
end
end
#
Given %r{^I have fixture collections$} do
FileUtils.cp_r Paths.source_dir.join("test", "source", "_methods"), source_dir
FileUtils.cp_r Paths.source_dir.join("test", "source", "_thanksgiving"), source_dir
end
#
Given %r{^I wait (\d+) second(s?)$} do |time, plural|
sleep(time.to_f)
end
#
When %r{^I run jekyll(.*)$} do |args|
run_jekyll(args)
if args.include?("--verbose") || ENV["DEBUG"]
$stderr.puts "\n#{jekyll_run_output}\n"
end
end
#
When %r{^I run bundle(.*)$} do |args|
run_bundle(args)
if args.include?("--verbose") || ENV['DEBUG']
$stderr.puts "\n#{jekyll_run_output}\n"
end
end
#
When %r{^I change "(.*)" to contain "(.*)"$} do |file, text|
File.open(file, "a") do |f|
f.write(text)
end
end
#
When %r{^I delete the file "(.*)"$} do |file|
File.delete(file)
end
#
Then %r{^the (.*) directory should +(not )?exist$} do |dir, negative|
if negative.nil?
expect(Pathname.new(dir)).to exist
else
expect(Pathname.new(dir)).to_not exist
end
end
#
Then %r{^I should (not )?see "(.*)" in "(.*)"$} do |negative, text, file|
step %(the "#{file}" file should exist)
regexp = Regexp.new(text, Regexp::MULTILINE)
if negative.nil? || negative.empty?
expect(file_contents(file)).to match regexp
else
expect(file_contents(file)).not_to match regexp
end
end
#
Then %r{^I should see exactly "(.*)" in "(.*)"$} do |text, file|
step %(the "#{file}" file should exist)
expect(file_contents(file).strip).to eq text
end
#
Then %r{^I should see escaped "(.*)" in "(.*)"$} do |text, file|
step %(I should see "#{Regexp.escape(text)}" in "#{file}")
end
#
Then %r{^the "(.*)" file should +(not )?exist$} do |file, negative|
if negative.nil?
expect(Pathname.new(file)).to exist
else
expect(Pathname.new(file)).to_not exist
end
end
#
Then %r{^I should see today's time in "(.*)"$} do |file|
step %(I should see "#{seconds_agnostic_time(Time.now)}" in "#{file}")
end
#
Then %r{^I should see today's date in "(.*)"$} do |file|
step %(I should see "#{Date.today.to_s}" in "#{file}")
end
#
Then %r{^I should (not )?see "(.*)" in the build output$} do |negative, text|
if negative.nil? || negative.empty?
expect(jekyll_run_output).to match Regexp.new(text)
else
expect(jekyll_run_output).not_to match Regexp.new(text)
end
end
#
Then %r{^I should get a zero exit(?:\-| )status$} do
step %(I should see "EXIT STATUS: 0" in the build output)
end
#
Then %r{^I should get a non-zero exit(?:\-| )status$} do
step %(I should not see "EXIT STATUS: 0" in the build output)
end

View File

@ -1,229 +0,0 @@
def file_content_from_hash(input_hash)
matter_hash = input_hash.reject { |k, v| k == "content" }
matter = matter_hash.map { |k, v| "#{k}: #{v}\n" }.join.chomp
content = if input_hash['input'] && input_hash['filter']
"{{ #{input_hash['input']} | #{input_hash['filter']} }}"
else
input_hash['content']
end
<<-EOF
---
#{matter}
---
#{content}
EOF
end
Before do
FileUtils.mkdir_p(TEST_DIR) unless File.exist?(TEST_DIR)
Dir.chdir(TEST_DIR)
end
After do
FileUtils.rm_rf(TEST_DIR) if File.exist?(TEST_DIR)
FileUtils.rm(JEKYLL_COMMAND_OUTPUT_FILE) if File.exist?(JEKYLL_COMMAND_OUTPUT_FILE)
Dir.chdir(File.dirname(TEST_DIR))
end
World do
MinitestWorld.new
end
Given /^I have a blank site in "(.*)"$/ do |path|
FileUtils.mkdir_p(path) unless File.exist?(path)
end
Given /^I do not have a "(.*)" directory$/ do |path|
File.directory?("#{TEST_DIR}/#{path}")
end
# Like "I have a foo file" but gives a yaml front matter so jekyll actually processes it
Given /^I have an? "(.*)" page(?: with (.*) "(.*)")? that contains "(.*)"$/ do |file, key, value, text|
File.open(file, 'w') do |f|
f.write <<-EOF
---
#{key || 'layout'}: #{value || 'nil'}
---
#{text}
EOF
end
end
Given /^I have an? "(.*)" file that contains "(.*)"$/ do |file, text|
File.open(file, 'w') do |f|
f.write(text)
end
end
Given /^I have an? (.*) (layout|theme) that contains "(.*)"$/ do |name, type, text|
folder = if type == 'layout'
'_layouts'
else
'_theme'
end
destination_file = File.join(folder, name + '.html')
destination_path = File.dirname(destination_file)
unless File.exist?(destination_path)
FileUtils.mkdir_p(destination_path)
end
File.open(destination_file, 'w') do |f|
f.write(text)
end
end
Given /^I have an? "(.*)" file with content:$/ do |file, text|
File.open(file, 'w') do |f|
f.write(text)
end
end
Given /^I have an? (.*) directory$/ do |dir|
FileUtils.mkdir_p(dir)
end
Given /^I have the following (draft|page|post)s?(?: (in|under) "([^"]+)")?:$/ do |status, direction, folder, table|
table.hashes.each do |input_hash|
title = slug(input_hash['title'])
ext = input_hash['type'] || 'markdown'
before, after = location(folder, direction)
case status
when "draft"
dest_folder = '_drafts'
filename = "#{title}.#{ext}"
when "page"
dest_folder = ''
filename = "#{title}.#{ext}"
when "post"
parsed_date = Time.xmlschema(input_hash['date']) rescue Time.parse(input_hash['date'])
dest_folder = '_posts'
filename = "#{parsed_date.strftime('%Y-%m-%d')}-#{title}.#{ext}"
end
path = File.join(before, dest_folder, after, filename)
File.open(path, 'w') do |f|
f.write file_content_from_hash(input_hash)
end
end
end
Given /^I have a configuration file with "(.*)" set to "(.*)"$/ do |key, value|
File.open('_config.yml', 'w') do |f|
f.write("#{key}: #{value}\n")
end
end
Given /^I have a configuration file with:$/ do |table|
File.open('_config.yml', 'w') do |f|
table.hashes.each do |row|
f.write("#{row["key"]}: #{row["value"]}\n")
end
end
end
Given /^I have a configuration file with "([^\"]*)" set to:$/ do |key, table|
File.open('_config.yml', 'w') do |f|
f.write("#{key}:\n")
table.hashes.each do |row|
f.write("- #{row["value"]}\n")
end
end
end
Given /^I have fixture collections$/ do
FileUtils.cp_r File.join(JEKYLL_SOURCE_DIR, "test", "source", "_methods"), source_dir
end
Given /^I wait (\d+) second(s?)$/ do |time, plural|
sleep(time.to_f)
end
##################
#
# Changing stuff
#
##################
When /^I run jekyll(.*)$/ do |args|
status = run_jekyll(args)
if args.include?("--verbose") || ENV['DEBUG']
puts jekyll_run_output
end
end
When /^I run bundle(.*)$/ do |args|
status = run_bundle(args)
if args.include?("--verbose") || ENV['DEBUG']
puts jekyll_run_output
end
end
When /^I change "(.*)" to contain "(.*)"$/ do |file, text|
File.open(file, 'a') do |f|
f.write(text)
end
end
When /^I delete the file "(.*)"$/ do |file|
File.delete(file)
end
##################
#
# Checking stuff
#
##################
Then /^the (.*) directory should +exist$/ do |dir|
assert File.directory?(dir), "The directory \"#{dir}\" does not exist"
end
Then /^the (.*) directory should not exist$/ do |dir|
assert !File.directory?(dir), "The directory \"#{dir}\" exists"
end
Then /^I should see "(.*)" in "(.*)"$/ do |text, file|
assert_match Regexp.new(text, Regexp::MULTILINE), file_contents(file)
end
Then /^I should see exactly "(.*)" in "(.*)"$/ do |text, file|
assert_equal text, file_contents(file).strip
end
Then /^I should not see "(.*)" in "(.*)"$/ do |text, file|
refute_match Regexp.new(text, Regexp::MULTILINE), file_contents(file)
end
Then /^I should see escaped "(.*)" in "(.*)"$/ do |text, file|
assert_match Regexp.new(Regexp.escape(text)), file_contents(file)
end
Then /^the "(.*)" file should +exist$/ do |file|
file_does_exist = File.file?(file)
unless file_does_exist
all_steps_to_path(file).each do |dir|
STDERR.puts ""
STDERR.puts "Dir #{dir}:"
STDERR.puts Dir["#{dir}/**/*"]
end
end
assert file_does_exist, "The file \"#{file}\" does not exist.\n"
end
Then /^the "(.*)" file should not exist$/ do |file|
assert !File.exist?(file), "The file \"#{file}\" exists"
end
Then /^I should see today's time in "(.*)"$/ do |file|
assert_match Regexp.new(seconds_agnostic_time(Time.now)), file_contents(file)
end
Then /^I should see today's date in "(.*)"$/ do |file|
assert_match Regexp.new(Date.today.to_s), file_contents(file)
end
Then /^I should see "(.*)" in the build output$/ do |text|
assert_match Regexp.new(text), jekyll_run_output
end

View File

@ -1,94 +0,0 @@
require 'fileutils'
require 'posix-spawn'
require 'minitest/spec'
require 'time'
class MinitestWorld
extend Minitest::Assertions
attr_accessor :assertions
def initialize
self.assertions = 0
end
end
JEKYLL_SOURCE_DIR = File.dirname(File.dirname(File.dirname(__FILE__)))
TEST_DIR = File.expand_path(File.join('..', '..', 'tmp', 'jekyll'), File.dirname(__FILE__))
JEKYLL_PATH = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'bin', 'jekyll'))
JEKYLL_COMMAND_OUTPUT_FILE = File.join(File.dirname(TEST_DIR), 'jekyll_output.txt')
def source_dir(*files)
File.join(TEST_DIR, *files)
end
def all_steps_to_path(path)
source = Pathname.new(source_dir('_site')).expand_path
dest = Pathname.new(path).expand_path
paths = []
dest.ascend do |f|
break if f.eql? source
paths.unshift f.to_s
end
paths
end
def jekyll_output_file
JEKYLL_COMMAND_OUTPUT_FILE
end
def jekyll_run_output
File.read(jekyll_output_file) if File.file?(jekyll_output_file)
end
def run_bundle(args)
child = run_in_shell('bundle', *args.strip.split(' '))
end
def run_jekyll(args)
child = run_in_shell(JEKYLL_PATH, *args.strip.split(' '), "--trace")
child.status.exitstatus == 0
end
def run_in_shell(*args)
POSIX::Spawn::Child.new *args, :out => [JEKYLL_COMMAND_OUTPUT_FILE, "w"]
end
def slug(title)
if title
title.downcase.gsub(/[^\w]/, " ").strip.gsub(/\s+/, '-')
else
Time.now.strftime("%s%9N") # nanoseconds since the Epoch
end
end
def location(folder, direction)
if folder
before = folder if direction == "in"
after = folder if direction == "under"
end
[before || '.', after || '.']
end
def file_contents(path)
File.open(path) do |file|
file.readlines.join # avoid differences with \n and \r\n line endings
end
end
def seconds_agnostic_datetime(datetime = Time.now)
date, time, zone = datetime.to_s.split(" ")
time = seconds_agnostic_time(time)
[
Regexp.escape(date),
"#{time}:\\d{2}",
Regexp.escape(zone)
].join("\\ ")
end
def seconds_agnostic_time(time)
if time.is_a? Time
time = time.strftime("%H:%M:%S")
end
hour, minutes, _ = time.split(":")
"#{hour}:#{minutes}"
end

View File

@ -2,140 +2,177 @@ require 'fileutils'
require 'colorator' require 'colorator'
require 'cucumber/formatter/console' require 'cucumber/formatter/console'
require 'cucumber/formatter/io' require 'cucumber/formatter/io'
require 'gherkin/formatter/escaping'
module Features module Jekyll
module Support module Cucumber
# The formatter used for <tt>--format pretty</tt> (the default formatter). class Formatter
# attr_accessor :indent, :runtime
# This formatter prints features to plain text - exactly how they were parsed, include ::Cucumber::Formatter::Console
# just prettier. That means with proper indentation and alignment of table columns. include ::Cucumber::Formatter::Io
#
# If the output is STDOUT (and not a file), there are bright colours to watch too.
#
class Overview
include FileUtils include FileUtils
include Cucumber::Formatter::Console
include Cucumber::Formatter::Io CHARS = {
include Gherkin::Formatter::Escaping :failed => "\u2718".red,
attr_writer :indent :pending => "\u203D".yellow,
attr_reader :runtime :undefined => "\u2718".red,
:passed => "\u2714".green,
:skipped => "\u203D".blue
}
#
def initialize(runtime, path_or_io, options) def initialize(runtime, path_or_io, options)
@runtime, @io, @options = runtime, ensure_io(path_or_io, "pretty"), options @runtime = runtime
@exceptions = [] @snippets_input = []
@indent = 0 @io = ensure_io(path_or_io)
@prefixes = options[:prefixes] || {} @prefixes = options[:prefixes] || {}
@delayed_messages = [] @delayed_messages = []
@options = options
@exceptions = []
@indent = 0
end end
#
def before_features(features) def before_features(features)
print_profile_information print_profile_information
end end
#
def after_features(features) def after_features(features)
@io.puts @io.puts
print_summary(features) print_summary(features)
end end
#
def before_feature(feature) def before_feature(feature)
@exceptions = [] @exceptions = []
@indent = 0 @indent = 0
end end
def comment_line(comment_line) #
end
def after_tags(tags) def tag_name(tag_name); end
end def comment_line(comment_line); end
def after_feature_element(feature_element); end
def after_tags(tags); end
def tag_name(tag_name) #
end
def before_feature_element(feature_element) def before_feature_element(feature_element)
@indent = 2 @indent = 2
@scenario_indent = 2 @scenario_indent = 2
end end
def after_feature_element(feature_element) #
end
def before_background(background) def before_background(background)
@indent = 2
@scenario_indent = 2 @scenario_indent = 2
@in_background = true @in_background = true
@indent = 2
end end
#
def after_background(background) def after_background(background)
@in_background = nil @in_background = nil
end end
def background_name(keyword, name, file_colon_line, source_indent) #
print_feature_element_name(keyword, name, file_colon_line, source_indent)
def background_name(keyword, name, source_line, indend)
print_feature_element_name(
keyword, name, source_line, indend
)
end end
def scenario_name(keyword, name, file_colon_line, source_indent) #
print_feature_element_name(keyword, name, file_colon_line, source_indent)
def scenario_name(keyword, name, source_line, indent)
print_feature_element_name(
keyword, name, source_line, indent
)
end end
#
def before_step(step) def before_step(step)
@current_step = step @current_step = step
end end
def before_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background, file_colon_line) #
def before_step_result(keyword, step_match, multiline_arg, status, exception, \
source_indent, background, file_colon_line)
@hide_this_step = false @hide_this_step = false
if exception if exception
if @exceptions.include?(exception) if @exceptions.include?(exception)
@hide_this_step = true @hide_this_step = true
return return
end end
@exceptions << exception @exceptions << exception
end end
if status != :failed && @in_background ^ background if status != :failed && @in_background ^ background
@hide_this_step = true @hide_this_step = true
return return
end end
@status = status @status = status
end end
CHARS = { #
:failed => "x".red,
:pending => "?".yellow,
:undefined => "x".red,
:passed => ".".green,
:skipped => "-".blue
}
def step_name(keyword, step_match, status, source_indent, background, file_colon_line) def step_name(keyword, step_match, status, source_indent, background, file_colon_line)
@io.print CHARS[status] @io.print CHARS[status]
@io.print " "
end end
#
def exception(exception, status) def exception(exception, status)
return if @hide_this_step return if @hide_this_step
@io.puts @io.puts
print_exception(exception, status, @indent) print_exception(exception, status, @indent)
@io.flush @io.flush
end end
private #
def print_feature_element_name(keyword, name, file_colon_line, source_indent) def after_test_step(test_step, result)
collect_snippet_data(
test_step, result
)
end
#
private
def print_feature_element_name(keyword, name, source_line, indent)
@io.puts @io.puts
names = name.empty? ? [name] : name.split("\n")
line = " #{keyword}: #{names[0]}" names = name.empty? ? [name] : name.each_line.to_a
if @options[:source] line = " #{keyword}: #{names[0]}"
line_comment = "#{file_colon_line}"
@io.print(line_comment) @io.print(source_line) if @options[:source]
end
@io.print(line) @io.print(line)
@io.print " " @io.print " "
@io.flush @io.flush
end end
#
def cell_prefix(status) def cell_prefix(status)
@prefixes[status] @prefixes[status]
end end
#
def print_summary(features) def print_summary(features)
@io.puts @io.puts
print_stats(features, @options) print_stats(features, @options)

161
features/support/helpers.rb Normal file
View File

@ -0,0 +1,161 @@
require "fileutils"
require "jekyll/utils"
require "open3"
require "time"
require "safe_yaml/load"
class Paths
SOURCE_DIR = Pathname.new(File.expand_path("../..", __dir__))
def self.test_dir; source_dir.join("tmp", "jekyll"); end
def self.output_file; test_dir.join("jekyll_output.txt"); end
def self.status_file; test_dir.join("jekyll_status.txt"); end
def self.jekyll_bin; source_dir.join("bin", "jekyll"); end
def self.source_dir; SOURCE_DIR; end
end
#
def file_content_from_hash(input_hash)
matter_hash = input_hash.reject { |k, v| k == "content" }
matter = matter_hash.map do |k, v| "#{k}: #{v}\n"
end
matter = matter.join.chomp
content = \
if !input_hash['input'] || !input_hash['filter']
then input_hash['content']
else "{{ #{input_hash['input']} | " \
"#{input_hash['filter']} }}"
end
Jekyll::Utils.strip_heredoc(<<-EOF)
---
#{matter.gsub(
/\n/, "\n "
)}
---
#{content}
EOF
end
#
def source_dir(*files)
return Paths.test_dir(*files)
end
#
def all_steps_to_path(path)
source = source_dir
dest = Pathname.new(path).expand_path
paths = []
dest.ascend do |f|
break if f == source
paths.unshift f.to_s
end
paths
end
#
def jekyll_run_output
if Paths.output_file.file?
then return Paths.output_file.read
end
end
#
def jekyll_run_status
if Paths.status_file.file?
then return Paths.status_file.read
end
end
#
def run_bundle(args)
run_in_shell("bundle", *args.strip.split(' '))
end
#
def run_jekyll(args)
args = args.strip.split(" ") # Shellwords?
process = run_in_shell(Paths.jekyll_bin.to_s, *args, "--trace")
process.exitstatus == 0
end
#
def run_in_shell(*args)
i, o, e, p = Open3.popen3(*args)
out = o.read.strip
err = e.read.strip
[i, o, e].each do |m|
m.close
end
File.write(Paths.status_file, p.value.exitstatus)
File.open(Paths.output_file, "wb") do |f|
f.puts "$ " << args.join(" ")
f.puts out
f.puts err
f.puts "EXIT STATUS: #{p.value.exitstatus}"
end
p.value
end
#
def slug(title = nil)
if !title
then Time.now.strftime("%s%9N") # nanoseconds since the Epoch
else title.downcase.gsub(/[^\w]/, " ").strip.gsub(/\s+/, '-')
end
end
#
def location(folder, direction)
if folder
before = folder if direction == "in"
after = folder if direction == "under"
end
[before || '.',
after || '.']
end
#
def file_contents(path)
return Pathname.new(path).read
end
#
def seconds_agnostic_datetime(datetime = Time.now)
date, time, zone = datetime.to_s.split(" ")
time = seconds_agnostic_time(time)
[
Regexp.escape(date),
"#{time}:\\d{2}",
Regexp.escape(zone)
] \
.join("\\ ")
end
#
def seconds_agnostic_time(time)
time = time.strftime("%H:%M:%S") if time.is_a?(Time)
hour, minutes, _ = time.split(":")
"#{hour}:#{minutes}"
end

View File

@ -21,7 +21,7 @@ Gem::Specification.new do |s|
s.homepage = 'https://github.com/jekyll/jekyll' s.homepage = 'https://github.com/jekyll/jekyll'
all_files = `git ls-files -z`.split("\x0") all_files = `git ls-files -z`.split("\x0")
s.files = all_files.grep(%r{^(bin|lib)/}) s.files = all_files.grep(%r{^(bin|lib)/|^.rubocop.yml$})
s.executables = all_files.grep(%r{^bin/}) { |f| File.basename(f) } s.executables = all_files.grep(%r{^bin/}) { |f| File.basename(f) }
s.require_paths = ['lib'] s.require_paths = ['lib']

View File

@ -1,4 +1,4 @@
$:.unshift File.dirname(__FILE__) # For use/testing when no gem is installed $LOAD_PATH.unshift File.dirname(__FILE__) # For use/testing when no gem is installed
# Require all of the Ruby files in the given directory. # Require all of the Ruby files in the given directory.
# #
@ -16,6 +16,7 @@ end
require 'rubygems' require 'rubygems'
# stdlib # stdlib
require 'forwardable'
require 'fileutils' require 'fileutils'
require 'time' require 'time'
require 'English' require 'English'
@ -30,10 +31,8 @@ require 'kramdown'
require 'colorator' require 'colorator'
SafeYAML::OPTIONS[:suppress_warnings] = true SafeYAML::OPTIONS[:suppress_warnings] = true
Liquid::Template.error_mode = :strict
module Jekyll module Jekyll
# internal requires # internal requires
autoload :Cleaner, 'jekyll/cleaner' autoload :Cleaner, 'jekyll/cleaner'
autoload :Collection, 'jekyll/collection' autoload :Collection, 'jekyll/collection'
@ -53,14 +52,12 @@ module Jekyll
autoload :CollectionReader, 'jekyll/readers/collection_reader' autoload :CollectionReader, 'jekyll/readers/collection_reader'
autoload :DataReader, 'jekyll/readers/data_reader' autoload :DataReader, 'jekyll/readers/data_reader'
autoload :LayoutReader, 'jekyll/readers/layout_reader' autoload :LayoutReader, 'jekyll/readers/layout_reader'
autoload :DraftReader, 'jekyll/readers/draft_reader'
autoload :PostReader, 'jekyll/readers/post_reader' autoload :PostReader, 'jekyll/readers/post_reader'
autoload :PageReader, 'jekyll/readers/page_reader' autoload :PageReader, 'jekyll/readers/page_reader'
autoload :StaticFileReader, 'jekyll/readers/static_file_reader' autoload :StaticFileReader, 'jekyll/readers/static_file_reader'
autoload :LogAdapter, 'jekyll/log_adapter' autoload :LogAdapter, 'jekyll/log_adapter'
autoload :Page, 'jekyll/page' autoload :Page, 'jekyll/page'
autoload :PluginManager, 'jekyll/plugin_manager' autoload :PluginManager, 'jekyll/plugin_manager'
autoload :Post, 'jekyll/post'
autoload :Publisher, 'jekyll/publisher' autoload :Publisher, 'jekyll/publisher'
autoload :Reader, 'jekyll/reader' autoload :Reader, 'jekyll/reader'
autoload :Regenerator, 'jekyll/regenerator' autoload :Regenerator, 'jekyll/regenerator'
@ -98,7 +95,7 @@ module Jekyll
# list of option names and their defaults. # list of option names and their defaults.
# #
# Returns the final configuration Hash. # Returns the final configuration Hash.
def configuration(override = Hash.new) def configuration(override = {})
config = Configuration[Configuration::DEFAULTS] config = Configuration[Configuration::DEFAULTS]
override = Configuration[override].stringify_keys override = Configuration[override].stringify_keys
unless override.delete('skip_config_files') unless override.delete('skip_config_files')
@ -136,7 +133,7 @@ module Jekyll
# #
# Returns the new logger. # Returns the new logger.
def logger=(writer) def logger=(writer)
@logger = LogAdapter.new(writer) @logger = LogAdapter.new(writer, (ENV["JEKYLL_LOG_LEVEL"] || :info).to_sym)
end end
# Public: An array of sites # Public: An array of sites
@ -156,25 +153,27 @@ module Jekyll
def sanitized_path(base_directory, questionable_path) def sanitized_path(base_directory, questionable_path)
return base_directory if base_directory.eql?(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 = 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\:\//, '/')) if clean_path.start_with?(base_directory.sub(/\A\w\:\//, '/'))
File.join(base_directory, clean_path)
else
clean_path clean_path
else
File.join(base_directory, clean_path)
end end
end end
# Conditional optimizations # Conditional optimizations
Jekyll::External.require_if_present('liquid-c') Jekyll::External.require_if_present('liquid-c')
end end
end end
require "jekyll/drops/drop"
require_all 'jekyll/commands' require_all 'jekyll/commands'
require_all 'jekyll/converters' require_all 'jekyll/converters'
require_all 'jekyll/converters/markdown' require_all 'jekyll/converters/markdown'
require_all 'jekyll/drops'
require_all 'jekyll/generators' require_all 'jekyll/generators'
require_all 'jekyll/tags' require_all 'jekyll/tags'

View File

@ -3,6 +3,7 @@ require 'set'
module Jekyll module Jekyll
# Handles the cleanup of a site's destination before it is built. # Handles the cleanup of a site's destination before it is built.
class Cleaner class Cleaner
HIDDEN_FILE_REGEX = /\/\.{1,2}$/
attr_reader :site attr_reader :site
def initialize(site) def initialize(site)
@ -12,7 +13,7 @@ module Jekyll
# Cleans up the site's destination directory # Cleans up the site's destination directory
def cleanup! def cleanup!
FileUtils.rm_rf(obsolete_files) FileUtils.rm_rf(obsolete_files)
FileUtils.rm_rf(metadata_file) if @site.full_rebuild? FileUtils.rm_rf(metadata_file) unless @site.incremental?
end end
private private
@ -39,8 +40,8 @@ module Jekyll
regex = keep_file_regex regex = keep_file_regex
dirs = keep_dirs dirs = keep_dirs
Dir.glob(site.in_dest_dir("**", "*"), File::FNM_DOTMATCH) do |file| Utils.safe_glob(site.in_dest_dir, ["**", "*"], File::FNM_DOTMATCH).each do |file|
next if file =~ /\/\.{1,2}$/ || file =~ regex || dirs.include?(file) next if file =~ HIDDEN_FILE_REGEX || file =~ regex || dirs.include?(file)
files << file files << file
end end

View File

@ -1,6 +1,7 @@
module Jekyll module Jekyll
class Collection class Collection
attr_reader :site, :label, :metadata attr_reader :site, :label, :metadata
attr_writer :docs
# Create a new Collection. # Create a new Collection.
# #
@ -22,6 +23,23 @@ module Jekyll
@docs ||= [] @docs ||= []
end end
# Override of normal respond_to? to match method_missing's logic for
# looking in @data.
def respond_to?(method, include_private = false)
docs.respond_to?(method.to_sym, include_private) || super
end
# Override of method_missing to check in @data for the key.
def method_missing(method, *args, &blck)
if docs.respond_to?(method.to_sym)
Jekyll.logger.warn "Deprecation:", "#{label}.#{method} should be changed to #{label}.docs.#{method}."
Jekyll.logger.warn "", "Called by #{caller.first}."
docs.public_send(method.to_sym, *args, &blck)
else
super
end
end
# Fetch the static files in this collection. # Fetch the static files in this collection.
# Defaults to an empty array if no static files have been read in. # Defaults to an empty array if no static files have been read in.
# #
@ -38,9 +56,13 @@ module Jekyll
full_path = collection_dir(file_path) full_path = collection_dir(file_path)
next if File.directory?(full_path) next if File.directory?(full_path)
if Utils.has_yaml_header? full_path if Utils.has_yaml_header? full_path
doc = Jekyll::Document.new(full_path, { site: site, collection: self }) doc = Jekyll::Document.new(full_path, { :site => site, :collection => self })
doc.read doc.read
docs << doc if site.publisher.publish?(doc) if site.publisher.publish?(doc) || !write?
docs << doc
else
Jekyll.logger.debug "Skipped From Publishing:", doc.relative_path
end
else else
relative_dir = Jekyll.sanitized_path(relative_directory, File.dirname(file_path)).chomp("/.") relative_dir = Jekyll.sanitized_path(relative_directory, File.dirname(file_path)).chomp("/.")
files << StaticFile.new(site, site.source, relative_dir, File.basename(full_path), self) files << StaticFile.new(site, site.source, relative_dir, File.basename(full_path), self)
@ -54,10 +76,11 @@ module Jekyll
# Returns an Array of file paths to the documents in this collection # Returns an Array of file paths to the documents in this collection
# relative to the collection's directory # relative to the collection's directory
def entries def entries
return Array.new unless exists? return [] unless exists?
@entries ||= @entries ||=
Dir.glob(collection_dir("**", "*.*")).map do |entry| Utils.safe_glob(collection_dir, ["**", "*"]).map do |entry|
entry["#{collection_dir}/"] = ''; entry entry["#{collection_dir}/"] = ''
entry
end end
end end
@ -66,7 +89,7 @@ module Jekyll
# #
# Returns a list of filtered entry paths. # Returns a list of filtered entry paths.
def filtered_entries def filtered_entries
return Array.new unless exists? return [] unless exists?
@filtered_entries ||= @filtered_entries ||=
Dir.chdir(directory) do Dir.chdir(directory) do
entry_filter.filter(entries).reject do |f| entry_filter.filter(entries).reject do |f|
@ -148,14 +171,7 @@ module Jekyll
# #
# Returns a representation of this collection for use in Liquid. # Returns a representation of this collection for use in Liquid.
def to_liquid def to_liquid
metadata.merge({ Drops::CollectionDrop.new self
"label" => label,
"docs" => docs,
"files" => files,
"directory" => directory,
"output" => write?,
"relative_directory" => relative_directory
})
end end
# Whether the collection's documents ought to be written as individual # Whether the collection's documents ought to be written as individual
@ -163,15 +179,15 @@ module Jekyll
# #
# Returns true if the 'write' metadata is true, false otherwise. # Returns true if the 'write' metadata is true, false otherwise.
def write? def write?
!!metadata['output'] !!metadata.fetch('output', false)
end end
# The URL template to render collection's documents at. # The URL template to render collection's documents at.
# #
# Returns the URL template to render collection's documents at. # Returns the URL template to render collection's documents at.
def url_template def url_template
metadata.fetch('permalink') do @url_template ||= metadata.fetch('permalink') do
Utils.add_permalink_suffix("/:collection/:path", site.permalink_style) Utils.add_permalink_suffix("/:collection/:path", site.permalink_style)
end end
end end
@ -180,7 +196,7 @@ module Jekyll
# Returns the metadata for this collection # Returns the metadata for this collection
def extract_metadata def extract_metadata
if site.config['collections'].is_a?(Hash) if site.config['collections'].is_a?(Hash)
site.config['collections'][label] || Hash.new site.config['collections'][label] || {}
else else
{} {}
end end

View File

@ -1,8 +1,6 @@
module Jekyll module Jekyll
class Command class Command
class << self class << self
# A list of subclasses of Jekyll::Command # A list of subclasses of Jekyll::Command
def subclasses def subclasses
@subclasses ||= [] @subclasses ||= []
@ -60,10 +58,8 @@ module Jekyll
c.option 'unpublished', '--unpublished', 'Render posts that were marked as unpublished' c.option 'unpublished', '--unpublished', 'Render posts that were marked as unpublished'
c.option 'quiet', '-q', '--quiet', 'Silence output.' c.option 'quiet', '-q', '--quiet', 'Silence output.'
c.option 'verbose', '-V', '--verbose', 'Print verbose output.' c.option 'verbose', '-V', '--verbose', 'Print verbose output.'
c.option 'full_rebuild', '-f', '--full-rebuild', 'Disable incremental rebuild.' c.option 'incremental', '-I', '--incremental', 'Enable incremental rebuild.'
end end
end end
end end
end end

View File

@ -1,9 +1,7 @@
module Jekyll module Jekyll
module Commands module Commands
class Build < Command class Build < Command
class << self class << self
# Create the Mercenary command for the Jekyll CLI for this Command # Create the Mercenary command for the Jekyll CLI for this Command
def init_with_program(prog) def init_with_program(prog)
prog.command(:build) do |c| prog.command(:build) do |c|
@ -13,7 +11,7 @@ module Jekyll
add_build_options(c) add_build_options(c)
c.action do |args, options| c.action do |_, options|
options["serving"] = false options["serving"] = false
Jekyll::Commands::Build.process(options) Jekyll::Commands::Build.process(options)
end end
@ -35,7 +33,9 @@ module Jekyll
build(site, options) build(site, options)
end end
if options.fetch('watch', false) if options.fetch('detach', false)
Jekyll.logger.info "Auto-regeneration:", "disabled when running server detached."
elsif options.fetch('watch', false)
watch(site, options) watch(site, options)
else else
Jekyll.logger.info "Auto-regeneration:", "disabled. Use --watch to enable." Jekyll.logger.info "Auto-regeneration:", "disabled. Use --watch to enable."
@ -52,10 +52,10 @@ module Jekyll
t = Time.now t = Time.now
source = options['source'] source = options['source']
destination = options['destination'] destination = options['destination']
full_build = options['full_rebuild'] incremental = options['incremental']
Jekyll.logger.info "Source:", source Jekyll.logger.info "Source:", source
Jekyll.logger.info "Destination:", destination Jekyll.logger.info "Destination:", destination
Jekyll.logger.info "Incremental build:", (full_build ? "disabled" : "enabled") Jekyll.logger.info "Incremental build:", (incremental ? "enabled" : "disabled. Enable with --incremental")
Jekyll.logger.info "Generating..." Jekyll.logger.info "Generating..."
process_site(site) process_site(site)
Jekyll.logger.info "", "done in #{(Time.now - t).round(3)} seconds." Jekyll.logger.info "", "done in #{(Time.now - t).round(3)} seconds."
@ -67,13 +67,11 @@ module Jekyll
# options - A Hash of options passed to the command # options - A Hash of options passed to the command
# #
# Returns nothing. # Returns nothing.
def watch(site, options) def watch(_site, options)
External.require_with_graceful_fail 'jekyll-watch' External.require_with_graceful_fail 'jekyll-watch'
Jekyll::Watcher.watch(options) Jekyll::Watcher.watch(options)
end end
end # end of class << self end # end of class << self
end end
end end
end end

View File

@ -2,14 +2,15 @@ module Jekyll
module Commands module Commands
class Clean < Command class Clean < Command
class << self class << self
def init_with_program(prog) def init_with_program(prog)
prog.command(:clean) do |c| prog.command(:clean) do |c|
c.syntax 'clean [subcommand]' c.syntax 'clean [subcommand]'
c.description 'Clean the site (removes site output and metadata file) without building.' c.description 'Clean the site (removes site output and metadata file) without building.'
c.action do |args, _| add_build_options(c)
Jekyll::Commands::Clean.process({})
c.action do |_, options|
Jekyll::Commands::Clean.process(options)
end end
end end
end end
@ -18,24 +19,21 @@ module Jekyll
options = configuration_from_options(options) options = configuration_from_options(options)
destination = options['destination'] destination = options['destination']
metadata_file = File.join(options['source'], '.jekyll-metadata') metadata_file = File.join(options['source'], '.jekyll-metadata')
sass_cache = File.join(options['source'], '.sass-cache')
if File.directory? destination remove(destination, checker_func: :directory?)
Jekyll.logger.info "Cleaning #{destination}..." remove(metadata_file, checker_func: :file?)
FileUtils.rm_rf(destination) remove(sass_cache, checker_func: :directory?)
Jekyll.logger.info "", "done."
else
Jekyll.logger.info "Nothing to do for #{destination}."
end
if File.file? metadata_file
Jekyll.logger.info "Removing #{metadata_file}..."
FileUtils.rm_rf(metadata_file)
Jekyll.logger.info "", "done."
else
Jekyll.logger.info "Nothing to do for #{metadata_file}."
end
end end
def remove(filename, checker_func: :file?)
if File.public_send(checker_func, filename)
Jekyll.logger.info "Cleaner:", "Removing #{filename}..."
FileUtils.rm_rf(filename)
else
Jekyll.logger.info "Cleaner:", "Nothing to do for #{filename}."
end
end
end end
end end
end end

View File

@ -2,16 +2,15 @@ module Jekyll
module Commands module Commands
class Doctor < Command class Doctor < Command
class << self class << self
def init_with_program(prog) def init_with_program(prog)
prog.command(:doctor) do |c| prog.command(:doctor) do |c|
c.syntax 'doctor' c.syntax 'doctor'
c.description 'Search site and print specific deprecation warnings' c.description 'Search site and print specific deprecation warnings'
c.alias(:hyde) c.alias(:hyde)
c.option '--config CONFIG_FILE[,CONFIG_FILE2,...]', Array, 'Custom configuration file' c.option 'config', '--config CONFIG_FILE[,CONFIG_FILE2,...]', Array, 'Custom configuration file'
c.action do |args, options| c.action do |_, options|
Jekyll::Commands::Doctor.process(options) Jekyll::Commands::Doctor.process(options)
end end
end end
@ -32,14 +31,15 @@ module Jekyll
[ [
fsnotify_buggy?(site), fsnotify_buggy?(site),
!deprecated_relative_permalinks(site), !deprecated_relative_permalinks(site),
!conflicting_urls(site) !conflicting_urls(site),
!urls_only_differ_by_case(site)
].all? ].all?
end end
def deprecated_relative_permalinks(site) def deprecated_relative_permalinks(site)
if site.config['relative_permalinks'] if site.config['relative_permalinks']
Jekyll::Deprecator.deprecation_message "Your site still uses relative" + Jekyll::Deprecator.deprecation_message "Your site still uses relative" \
" permalinks, which was removed in" + " permalinks, which was removed in" \
" Jekyll v3.0.0." " Jekyll v3.0.0."
return true return true
end end
@ -49,19 +49,18 @@ module Jekyll
conflicting_urls = false conflicting_urls = false
urls = {} urls = {}
urls = collect_urls(urls, site.pages, site.dest) urls = collect_urls(urls, site.pages, site.dest)
urls = collect_urls(urls, site.posts, site.dest) urls = collect_urls(urls, site.posts.docs, site.dest)
urls.each do |url, paths| urls.each do |url, paths|
if paths.size > 1 next unless paths.size > 1
conflicting_urls = true conflicting_urls = true
Jekyll.logger.warn "Conflict:", "The URL '#{url}' is the destination" + Jekyll.logger.warn "Conflict:", "The URL '#{url}' is the destination" \
" for the following pages: #{paths.join(", ")}" " for the following pages: #{paths.join(", ")}"
end
end end
conflicting_urls conflicting_urls
end end
def fsnotify_buggy?(site) def fsnotify_buggy?(_site)
return true if !Utils::Platforms.osx? return true unless Utils::Platforms.osx?
if Dir.pwd != `pwd`.strip if Dir.pwd != `pwd`.strip
Jekyll.logger.error " " + <<-STR.strip.gsub(/\n\s+/, "\n ") Jekyll.logger.error " " + <<-STR.strip.gsub(/\n\s+/, "\n ")
We have detected that there might be trouble using fsevent on your We have detected that there might be trouble using fsevent on your
@ -76,6 +75,19 @@ module Jekyll
true true
end end
def urls_only_differ_by_case(site)
urls_only_differ_by_case = false
urls = case_insensitive_urls(site.pages + site.docs_to_write, site.dest)
urls.each do |case_insensitive_url, real_urls|
next unless real_urls.uniq.size > 1
urls_only_differ_by_case = true
Jekyll.logger.warn "Warning:", "The following URLs only differ" \
" by case. On a case-insensitive file system one of the URLs" \
" will be overwritten by the other: #{real_urls.join(", ")}"
end
urls_only_differ_by_case
end
private private
def collect_urls(urls, things, destination) def collect_urls(urls, things, destination)
things.each do |thing| things.each do |thing|
@ -89,8 +101,14 @@ module Jekyll
urls urls
end end
def case_insensitive_urls(things, destination)
things.inject({}) do |memo, thing|
dest = thing.destination(destination)
(memo[dest.downcase] ||= []) << dest
memo
end
end
end end
end end
end end
end end

View File

@ -2,7 +2,6 @@ module Jekyll
module Commands module Commands
class Help < Command class Help < Command
class << self class << self
def init_with_program(prog) def init_with_program(prog)
prog.command(:help) do |c| prog.command(:help) do |c|
c.syntax 'help [subcommand]' c.syntax 'help [subcommand]'
@ -26,7 +25,6 @@ module Jekyll
Jekyll.logger.error "Error:", "Hmm... we don't know what the '#{cmd}' command is." Jekyll.logger.error "Error:", "Hmm... we don't know what the '#{cmd}' command is."
Jekyll.logger.info "Valid commands:", prog.commands.keys.join(", ") Jekyll.logger.info "Valid commands:", prog.commands.keys.join(", ")
end end
end end
end end
end end

View File

@ -1,151 +1,208 @@
# -*- encoding: utf-8 -*-
module Jekyll module Jekyll
module Commands module Commands
class Serve < Command class Serve < Command
class << self class << self
COMMAND_OPTIONS = {
"ssl_cert" => ["--ssl-cert [CERT]", "X.509 (SSL) certificate."],
"host" => ["host", "-H", "--host [HOST]", "Host to bind to"],
"open_url" => ["-o", "--open-url", "Launch your browser with your site."],
"detach" => ["-B", "--detach", "Run the server in the background (detach)"],
"ssl_key" => ["--ssl-key [KEY]", "X.509 (SSL) Private Key."],
"port" => ["-P", "--port [PORT]", "Port to listen on"],
"baseurl" => ["-b", "--baseurl [URL]", "Base URL"],
"show_dir_listing" => ["--show-dir-listing",
"Show a directory listing instead of loading your index file."],
"skip_initial_build" => ["skip_initial_build", "--skip-initial-build",
"Skips the initial site build which occurs before the server is started."]
}
#
def init_with_program(prog) def init_with_program(prog)
prog.command(:serve) do |c| prog.command(:serve) do |cmd|
c.syntax 'serve [options]' cmd.description "Serve your site locally"
c.description 'Serve your site locally' cmd.syntax "serve [options]"
c.alias :server cmd.alias :server
c.alias :s cmd.alias :s
add_build_options(c) add_build_options(cmd)
COMMAND_OPTIONS.each do |key, val|
cmd.option key, *val
end
c.option 'detach', '-B', '--detach', 'Run the server in the background (detach)' cmd.action do |_, opts|
c.option 'port', '-P', '--port [PORT]', 'Port to listen on' opts["serving"] = true
c.option 'host', '-H', '--host [HOST]', 'Host to bind to' opts["watch" ] = true unless opts.key?("watch")
c.option 'baseurl', '-b', '--baseurl [URL]', 'Base URL' Build.process(opts)
c.option 'skip_initial_build', '--skip-initial-build', 'Skips the initial site build which occurs before the server is started.' Serve.process(opts)
c.action do |args, options|
options["serving"] = true
options["watch"] = true unless options.key?("watch")
Jekyll::Commands::Build.process(options)
Jekyll::Commands::Serve.process(options)
end end
end end
end end
# Boot up a WEBrick server which points to the compiled site's root. #
def process(options)
options = configuration_from_options(options) def process(opts)
destination = options['destination'] opts = configuration_from_options(opts)
destination = opts["destination"]
setup(destination) setup(destination)
s = WEBrick::HTTPServer.new(webrick_options(options)) server = WEBrick::HTTPServer.new(webrick_opts(opts)).tap { |o| o.unmount("") }
s.unmount("") server.mount(opts["baseurl"], Servlet, destination, file_handler_opts)
Jekyll.logger.info "Server address:", server_address(server, opts)
launch_browser server, opts if opts["open_url"]
boot_or_detach server, opts
end
s.mount( # Do a base pre-setup of WEBRick so that everything is in place
options['baseurl'], # when we get ready to party, checking for an setting up an error page
custom_file_handler, # and making sure our destination exists.
destination,
file_handler_options
)
Jekyll.logger.info "Server address:", server_address(s, options) private
def setup(destination)
require_relative "serve/servlet"
FileUtils.mkdir_p(destination)
if File.exist?(File.join(destination, "404.html"))
WEBrick::HTTPResponse.class_eval do
def create_error_page
@header["Content-Type"] = "text/html; charset=UTF-8"
@body = IO.read(File.join(@config[:DocumentRoot], "404.html"))
end
end
end
end
#
private
def webrick_opts(opts)
opts = {
:JekyllOptions => opts,
:DoNotReverseLookup => true,
:MimeTypes => mime_types,
:DocumentRoot => opts["destination"],
:StartCallback => start_callback(opts["detach"]),
:BindAddress => opts["host"],
:Port => opts["port"],
:DirectoryIndex => %W(
index.htm
index.html
index.rhtml
index.cgi
index.xml
)
}
opts[:DirectoryIndex] = [] if opts[:JekyllOptions]['show_dir_listing']
enable_ssl(opts)
enable_logging(opts)
opts
end
# Recreate NondisclosureName under utf-8 circumstance
private
def file_handler_opts
WEBrick::Config::FileHandler.merge({
:FancyIndexing => true,
:NondisclosureName => [
'.ht*', '~*'
]
})
end
#
private
def server_address(server, opts)
address = server.config[:BindAddress]
baseurl = "#{opts["baseurl"]}/" if opts["baseurl"]
port = server.config[:Port]
"http://#{address}:#{port}#{baseurl}"
end
#
private
def launch_browser(server, opts)
command =
if Utils::Platforms.windows?
"start"
elsif Utils::Platforms.osx?
"open"
else
"xdg-open"
end
system command, server_address(server, opts)
end
# Keep in our area with a thread or detach the server as requested
# by the user. This method determines what we do based on what you
# ask us to do.
private
def boot_or_detach(server, opts)
if opts["detach"]
pid = Process.fork do
server.start
end
if options['detach'] # detach the server
pid = Process.fork { s.start }
Process.detach(pid) Process.detach(pid)
Jekyll.logger.info "Server detached with pid '#{pid}'.", "Run `pkill -f jekyll' or `kill -9 #{pid}' to stop the server." Jekyll.logger.info "Server detached with pid '#{pid}'.", \
else # create a new server thread, then join it with current terminal "Run `pkill -f jekyll' or `kill -9 #{pid}' to stop the server."
t = Thread.new { s.start } else
trap("INT") { s.shutdown } t = Thread.new { server.start }
trap("INT") { server.shutdown }
t.join t.join
end end
end end
def setup(destination) # Make the stack verbose if the user requests it.
require 'webrick'
FileUtils.mkdir_p(destination) private
def enable_logging(opts)
# monkey patch WEBrick using custom 404 page (/404.html) opts[:AccessLog] = []
if File.exist?(File.join(destination, '404.html')) level = WEBrick::Log.const_get(opts[:JekyllOptions]["verbose"] ? :DEBUG : :WARN)
WEBrick::HTTPResponse.class_eval do opts[:Logger] = WEBrick::Log.new($stdout, level)
def create_error_page
@header['content-type'] = "text/html; charset=UTF-8"
@body = IO.read(File.join(@config[:DocumentRoot], '404.html'))
end
end
end
end end
def webrick_options(config) # Add SSL to the stack if the user triggers --enable-ssl and they
opts = { # provide both types of certificates commonly needed. Raise if they
:BindAddress => config['host'], # forget to add one of the certificates.
:DirectoryIndex => %w(index.html index.htm index.cgi index.rhtml index.xml),
:DocumentRoot => config['destination'],
:DoNotReverseLookup => true,
:MimeTypes => mime_types,
:Port => config['port'],
:StartCallback => start_callback(config['detach'])
}
if config['verbose'] private
opts.merge!({ def enable_ssl(opts)
:Logger => WEBrick::Log.new($stdout, WEBrick::Log::DEBUG) return if !opts[:JekyllOptions]["ssl_cert"] && !opts[:JekyllOptions]["ssl_key"]
}) if !opts[:JekyllOptions]["ssl_cert"] || !opts[:JekyllOptions]["ssl_key"]
else raise RuntimeError, "--ssl-cert or --ssl-key missing."
opts.merge!({
:AccessLog => [],
:Logger => WEBrick::Log.new([], WEBrick::Log::WARN)
})
end end
opts require "openssl"
end require "webrick/https"
source_key = Jekyll.sanitized_path(opts[:JekyllOptions]["source"], opts[:JekyllOptions]["ssl_key" ])
# Custom WEBrick FileHandler servlet for serving "/file.html" at "/file" source_certificate = Jekyll.sanitized_path(opts[:JekyllOptions]["source"], opts[:JekyllOptions]["ssl_cert"])
# when no exact match is found. This mirrors the behavior of GitHub opts[:SSLCertificate] = OpenSSL::X509::Certificate.new(File.read(source_certificate))
# Pages and many static web server configs. opts[:SSLPrivateKey ] = OpenSSL::PKey::RSA.new(File.read(source_key))
def custom_file_handler opts[:EnableSSL] = true
Class.new WEBrick::HTTPServlet::FileHandler do
def search_file(req, res, basename)
if file = super
file
else
super(req, res, "#{basename}.html")
end
end
end
end end
private
def start_callback(detached) def start_callback(detached)
unless detached unless detached
Proc.new { Jekyll.logger.info "Server running...", "press ctrl-c to stop." } proc do
Jekyll.logger.info("Server running...", "press ctrl-c to stop.")
end
end end
end end
private
def mime_types def mime_types
mime_types_file = File.expand_path('../mime.types', File.dirname(__FILE__)) file = File.expand_path('../mime.types', File.dirname(__FILE__))
WEBrick::HTTPUtils::load_mime_types(mime_types_file) WEBrick::HTTPUtils.load_mime_types(file)
end end
def server_address(server, options)
baseurl = "#{options['baseurl']}/" if options['baseurl']
[
"http://",
server.config[:BindAddress],
":",
server.config[:Port],
baseurl || ""
].map(&:to_s).join("")
end
# recreate NondisclosureName under utf-8 circumstance
def file_handler_options
WEBrick::Config::FileHandler.merge({
:FancyIndexing => true,
:NondisclosureName => ['.ht*','~*']
})
end
end end
end end
end end
end end

View File

@ -0,0 +1,61 @@
require "webrick"
module Jekyll
module Commands
class Serve
class Servlet < WEBrick::HTTPServlet::FileHandler
DEFAULTS = {
"Cache-Control" => "private, max-age=0, proxy-revalidate, " \
"no-store, no-cache, must-revalidate"
}
def initialize(server, root, callbacks)
# So we can access them easily.
@jekyll_opts = server.config[:JekyllOptions]
set_defaults
super
end
# Add the ability to tap file.html the same way that Nginx does on our
# Docker images (or on GitHub Pages.) The difference is that we might end
# up with a different preference on which comes first.
def search_file(req, res, basename)
# /file.* > /file/index.html > /file.html
super || super(req, res, "#{basename}.html")
end
#
def do_GET(req, res)
rtn = super
validate_and_ensure_charset(req, res)
res.header.merge!(@headers)
rtn
end
#
private
def validate_and_ensure_charset(_req, res)
key = res.header.keys.grep(/content-type/i).first
typ = res.header[key]
unless typ =~ /;\s*charset=/
res.header[key] = "#{typ}; charset=#{@jekyll_opts["encoding"]}"
end
end
#
private
def set_defaults
hash_ = @jekyll_opts.fetch("webrick", {}).fetch("headers", {})
DEFAULTS.each_with_object(@headers = hash_) do |(key, val), hash|
hash[key] = val unless hash.key?(key)
end
end
end
end
end
end

View File

@ -2,31 +2,30 @@
module Jekyll module Jekyll
class Configuration < Hash class Configuration < Hash
# Default options. Overridden by values in _config.yml. # Default options. Overridden by values in _config.yml.
# Strings rather than symbols are used for compatibility with YAML. # Strings rather than symbols are used for compatibility with YAML.
DEFAULTS = { DEFAULTS = Configuration[{
# Where things are # Where things are
'source' => Dir.pwd, 'source' => Dir.pwd,
'destination' => File.join(Dir.pwd, '_site'), 'destination' => File.join(Dir.pwd, '_site'),
'plugins' => '_plugins', 'plugins_dir' => '_plugins',
'layouts' => '_layouts', 'layouts_dir' => '_layouts',
'data_source' => '_data', 'data_dir' => '_data',
'collections' => nil, 'includes_dir' => '_includes',
'collections' => {},
# Handling Reading # Handling Reading
'safe' => false, 'safe' => false,
'include' => ['.htaccess'], 'include' => ['.htaccess'],
'exclude' => [], 'exclude' => [],
'keep_files' => ['.git','.svn'], 'keep_files' => ['.git', '.svn'],
'encoding' => 'utf-8', 'encoding' => 'utf-8',
'markdown_ext' => 'markdown,mkdown,mkdn,mkd,md', 'markdown_ext' => 'markdown,mkdown,mkdn,mkd,md',
'full_rebuild' => false,
# Filtering Content # Filtering Content
'show_drafts' => nil, 'show_drafts' => nil,
'limit_posts' => 0, 'limit_posts' => 0,
'future' => true, # remove and make true just default 'future' => false,
'unpublished' => false, 'unpublished' => false,
# Plugins # Plugins
@ -38,12 +37,14 @@ module Jekyll
'highlighter' => 'rouge', 'highlighter' => 'rouge',
'lsi' => false, 'lsi' => false,
'excerpt_separator' => "\n\n", 'excerpt_separator' => "\n\n",
'incremental' => false,
# Serving # Serving
'detach' => false, # default to not detaching the server 'detach' => false, # default to not detaching the server
'port' => '4000', 'port' => '4000',
'host' => '127.0.0.1', 'host' => '127.0.0.1',
'baseurl' => '', 'baseurl' => '',
'show_dir_listing' => false,
# Output Configuration # Output Configuration
'permalink' => 'date', 'permalink' => 'date',
@ -64,28 +65,20 @@ module Jekyll
'kramdown' => { 'kramdown' => {
'auto_ids' => true, 'auto_ids' => true,
'footnote_nr' => 1,
'entity_output' => 'as_char',
'toc_levels' => '1..6', 'toc_levels' => '1..6',
'entity_output' => 'as_char',
'smart_quotes' => 'lsquo,rsquo,ldquo,rdquo', 'smart_quotes' => 'lsquo,rsquo,ldquo,rdquo',
'enable_coderay' => false, 'input' => "GFM",
'hard_wrap' => false,
'coderay' => { 'footnote_nr' => 1
'coderay_wrap' => 'div',
'coderay_line_numbers' => 'inline',
'coderay_line_number_start' => 1,
'coderay_tab_width' => 4,
'coderay_bold_every' => 10,
'coderay_css' => 'style'
}
} }
} }]
# Public: Turn all keys into string # Public: Turn all keys into string
# #
# Return a copy of the hash where all its keys are strings # Return a copy of the hash where all its keys are strings
def stringify_keys def stringify_keys
reduce({}) { |hsh,(k,v)| hsh.merge(k.to_s => v) } reduce({}) { |hsh, (k, v)| hsh.merge(k.to_s => v) }
end end
def get_config_value_with_override(config_key, override) def get_config_value_with_override(config_key, override)
@ -117,7 +110,7 @@ module Jekyll
Jekyll::External.require_with_graceful_fail('toml') unless defined?(TOML) Jekyll::External.require_with_graceful_fail('toml') unless defined?(TOML)
TOML.load_file(filename) TOML.load_file(filename)
when /\.ya?ml/i when /\.ya?ml/i
SafeYAML.load_file(filename) SafeYAML.load_file(filename) || {}
else else
raise ArgumentError, "No parser for '#{filename}' is available. Use a .toml or .y(a)ml file instead." raise ArgumentError, "No parser for '#{filename}' is available. Use a .toml or .y(a)ml file instead."
end end
@ -135,7 +128,7 @@ module Jekyll
# Get configuration from <source>/_config.yml or <source>/<config_file> # Get configuration from <source>/_config.yml or <source>/<config_file>
config_files = override.delete('config') config_files = override.delete('config')
if config_files.to_s.empty? if config_files.to_s.empty?
default = %w[yml yaml].find(Proc.new { 'yml' }) do |ext| default = %w(yml yaml).find(-> { 'yml' }) do |ext|
File.exist?(Jekyll.sanitized_path(source(override), "_config.#{ext}")) File.exist?(Jekyll.sanitized_path(source(override), "_config.#{ext}"))
end end
config_files = Jekyll.sanitized_path(source(override), "_config.#{default}") config_files = Jekyll.sanitized_path(source(override), "_config.#{default}")
@ -152,7 +145,7 @@ module Jekyll
# Returns this configuration, overridden by the values in the file # Returns this configuration, overridden by the values in the file
def read_config_file(file) def read_config_file(file)
next_config = safe_load_file(file) next_config = safe_load_file(file)
raise ArgumentError.new("Configuration file: (INVALID) #{file}".yellow) unless next_config.is_a?(Hash) check_config_is_hash!(next_config, file)
Jekyll.logger.info "Configuration file:", file Jekyll.logger.info "Configuration file:", file
next_config next_config
rescue SystemCallError rescue SystemCallError
@ -180,12 +173,12 @@ module Jekyll
configuration = Utils.deep_merge_hashes(configuration, new_config) configuration = Utils.deep_merge_hashes(configuration, new_config)
end end
rescue ArgumentError => err rescue ArgumentError => err
Jekyll.logger.warn "WARNING:", "Error reading configuration. " + Jekyll.logger.warn "WARNING:", "Error reading configuration. " \
"Using defaults (and options)." "Using defaults (and options)."
$stderr.puts "#{err}" $stderr.puts "#{err}"
end end
configuration.fix_common_issues.backwards_compatibilize configuration.fix_common_issues.backwards_compatibilize.add_default_collections
end end
# Public: Split a CSV string into an array containing its values # Public: Split a CSV string into an array containing its values
@ -205,44 +198,41 @@ module Jekyll
config = clone config = clone
# Provide backwards-compatibility # Provide backwards-compatibility
if config.key?('auto') || config.key?('watch') if config.key?('auto') || config.key?('watch')
Jekyll::Deprecator.deprecation_message "Auto-regeneration can no longer" + Jekyll::Deprecator.deprecation_message "Auto-regeneration can no longer" \
" be set from your configuration file(s). Use the"+ " be set from your configuration file(s). Use the"\
" --[no-]watch/-w command-line option instead." " --[no-]watch/-w command-line option instead."
config.delete('auto') config.delete('auto')
config.delete('watch') config.delete('watch')
end end
if config.key? 'server' if config.key? 'server'
Jekyll::Deprecator.deprecation_message "The 'server' configuration option" + Jekyll::Deprecator.deprecation_message "The 'server' configuration option" \
" is no longer accepted. Use the 'jekyll serve'" + " is no longer accepted. Use the 'jekyll serve'" \
" subcommand to serve your site with WEBrick." " subcommand to serve your site with WEBrick."
config.delete('server') config.delete('server')
end end
if config.key? 'server_port' renamed_key 'server_port', 'port', config
Jekyll::Deprecator.deprecation_message "The 'server_port' configuration option" + renamed_key 'plugins', 'plugins_dir', config
" has been renamed to 'port'. Please update your config" + renamed_key 'layouts', 'layouts_dir', config
" file accordingly." renamed_key 'data_source', 'data_dir', config
# copy but don't overwrite:
config['port'] = config['server_port'] unless config.key?('port')
config.delete('server_port')
end
if config.key? 'pygments' if config.key? 'pygments'
Jekyll::Deprecator.deprecation_message "The 'pygments' configuration option" + Jekyll::Deprecator.deprecation_message "The 'pygments' configuration option" \
" has been renamed to 'highlighter'. Please update your" + " has been renamed to 'highlighter'. Please update your" \
" config file accordingly. The allowed values are 'rouge', " + " config file accordingly. The allowed values are 'rouge', " \
"'pygments' or null." "'pygments' or null."
config['highlighter'] = 'pygments' if config['pygments'] config['highlighter'] = 'pygments' if config['pygments']
config.delete('pygments') config.delete('pygments')
end end
%w[include exclude].each do |option| %w(include exclude).each do |option|
if config.fetch(option, []).is_a?(String) config[option] ||= []
Jekyll::Deprecator.deprecation_message "The '#{option}' configuration option" + if config[option].is_a?(String)
" must now be specified as an array, but you specified" + Jekyll::Deprecator.deprecation_message "The '#{option}' configuration option" \
" a string. For now, we've treated the string you provided" + " must now be specified as an array, but you specified" \
" a string. For now, we've treated the string you provided" \
" as a list of comma-separated values." " as a list of comma-separated values."
config[option] = csv_to_array(config[option]) config[option] = csv_to_array(config[option])
end end
@ -250,16 +240,16 @@ module Jekyll
end end
if (config['kramdown'] || {}).key?('use_coderay') if (config['kramdown'] || {}).key?('use_coderay')
Jekyll::Deprecator.deprecation_message "Please change 'use_coderay'" + Jekyll::Deprecator.deprecation_message "Please change 'use_coderay'" \
" to 'enable_coderay' in your configuration file." " to 'enable_coderay' in your configuration file."
config['kramdown']['use_coderay'] = config['kramdown'].delete('enable_coderay') config['kramdown']['use_coderay'] = config['kramdown'].delete('enable_coderay')
end end
if config.fetch('markdown', 'kramdown').to_s.downcase.eql?("maruku") if config.fetch('markdown', 'kramdown').to_s.downcase.eql?("maruku")
Jekyll.logger.abort_with "Error:", "You're using the 'maruku' " + Jekyll.logger.abort_with "Error:", "You're using the 'maruku' " \
"Markdown processor, which has been removed as of 3.0.0. " + "Markdown processor, which has been removed as of 3.0.0. " \
"We recommend you switch to Kramdown. To do this, replace " + "We recommend you switch to Kramdown. To do this, replace " \
"`markdown: maruku` with `markdown: kramdown` in your " + "`markdown: maruku` with `markdown: kramdown` in your " \
"`_config.yml` file." "`_config.yml` file."
end end
@ -270,12 +260,65 @@ module Jekyll
config = clone config = clone
if config.key?('paginate') && (!config['paginate'].is_a?(Integer) || config['paginate'] < 1) if config.key?('paginate') && (!config['paginate'].is_a?(Integer) || config['paginate'] < 1)
Jekyll.logger.warn "Config Warning:", "The `paginate` key must be a" + Jekyll.logger.warn "Config Warning:", "The `paginate` key must be a" \
" positive integer or nil. It's currently set to '#{config['paginate'].inspect}'." " positive integer or nil. It's currently set to '#{config['paginate'].inspect}'."
config['paginate'] = nil config['paginate'] = nil
end end
config config
end end
def add_default_collections
config = clone
return config if config['collections'].nil?
if config['collections'].is_a?(Array)
config['collections'] = Hash[config['collections'].map { |c| [c, {}] }]
end
config['collections']['posts'] ||= {}
config['collections']['posts']['output'] = true
config['collections']['posts']['permalink'] = style_to_permalink(config['permalink'])
config
end
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."
config[new] = config.delete(old)
end
end
private
def style_to_permalink(permalink_style)
case permalink_style.to_sym
when :pretty
"/:categories/:year/:month/:day/:title/"
when :none
"/:categories/:title:output_ext"
when :date
"/:categories/:year/:month/:day/:title:output_ext"
when :ordinal
"/:categories/:year/:y_day/:title:output_ext"
else
permalink_style.to_s
end
end
# Private: Checks if a given config is a hash
#
# extracted_config - the value to check
# file - the file from which the config was extracted
#
# Raises an ArgumentError if given config is not a hash
def check_config_is_hash!(extracted_config, file)
unless extracted_config.is_a?(Hash)
raise ArgumentError.new("Configuration file: (INVALID) #{file}".yellow)
end
end
end end
end end

View File

@ -5,7 +5,7 @@ module Jekyll
priority :lowest priority :lowest
def matches(ext) def matches(_ext)
true true
end end

View File

@ -1,57 +1,62 @@
module Jekyll module Jekyll
module Converters module Converters
class Markdown < Converter class Markdown < Converter
safe true
highlighter_prefix "\n" highlighter_prefix "\n"
highlighter_suffix "\n" highlighter_suffix "\n"
safe true
def setup def setup
return if @setup return if @setup
@parser = unless (@parser = get_processor)
case @config['markdown'].downcase Jekyll.logger.error "Invalid Markdown processor given:", @config["markdown"]
when 'redcarpet' then RedcarpetParser.new(@config) Jekyll.logger.info "", "Custom processors are not loaded in safe mode" if @config["safe"]
when 'kramdown' then KramdownParser.new(@config) Jekyll.logger.error "", "Available processors are: #{valid_processors.join(", ")}"
when 'rdiscount' then RDiscountParser.new(@config) raise Errors::FatalException, "Bailing out; invalid Markdown processor."
else end
# 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 [ #{valid_processors.join(" | ")} ]"
raise Errors::FatalException, "Invalid Markdown Processor: #{@config['markdown']}"
end
end
@setup = true @setup = true
end end
def valid_processors def get_processor
%w[ case @config["markdown"].downcase
rdiscount when "redcarpet" then return RedcarpetParser.new(@config)
kramdown when "kramdown" then return KramdownParser.new(@config)
redcarpet when "rdiscount" then return RDiscountParser.new(@config)
] + third_party_processors else
get_custom_processor
end
end end
# Public: Provides you with a list of processors, the ones we
# support internally and the ones that you have provided to us (if you
# are not in safe mode.)
def valid_processors
%W(rdiscount kramdown redcarpet) + third_party_processors
end
# Public: A list of processors that you provide via plugins.
# This is really only available if you are not in safe mode, if you are
# in safe mode (re: GitHub) then there will be none.
def third_party_processors def third_party_processors
self.class.constants - %w[ self.class.constants - \
KramdownParser %w(KramdownParser RDiscountParser RedcarpetParser PRIORITIES).map(
RDiscountParser &:to_sym
RedcarpetParser )
PRIORITIES
].map(&:to_sym)
end end
def extname_list def extname_list
@extname_list ||= @config['markdown_ext'].split(',').map { |e| ".#{e.downcase}" } @extname_list ||= @config['markdown_ext'].split(',').map do |e|
".#{e.downcase}"
end
end end
def matches(ext) def matches(ext)
extname_list.include? ext.downcase extname_list.include?(ext.downcase)
end end
def output_ext(ext) def output_ext(_ext)
".html" ".html"
end end
@ -61,16 +66,26 @@ module Jekyll
end end
private private
def get_custom_processor
converter_name = @config["markdown"]
if custom_class_allowed?(converter_name)
self.class.const_get(converter_name).new(@config)
end
end
# Private: Determine whether a class name is an allowed custom markdown # Private: Determine whether a class name is an allowed custom
# class name # markdown class name.
# #
# parser_name - the name of the parser class # parser_name - the name of the parser class
# #
# Returns true if the parser name contains only alphanumeric characters # Returns true if the parser name contains only alphanumeric
# and is defined within Jekyll::Converters::Markdown # characters and is defined within Jekyll::Converters::Markdown
def allowed_custom_class?(parser_name)
parser_name !~ /[^A-Za-z0-9]/ && self.class.constants.include?(parser_name.to_sym) private
def custom_class_allowed?(parser_name)
parser_name !~ /[^A-Za-z0-9_]/ && self.class.constants.include?(
parser_name.to_sym
)
end end
end end
end end

View File

@ -1,28 +1,116 @@
# Frozen-string-literal: true
# Encoding: utf-8
module Jekyll module Jekyll
module Converters module Converters
class Markdown class Markdown
class KramdownParser class KramdownParser
CODERAY_DEFAULTS = {
"css" => "style",
"bold_every" => 10,
"line_numbers" => "inline",
"line_number_start" => 1,
"tab_width" => 4,
"wrap" => "div"
}.freeze
def initialize(config) def initialize(config)
require 'kramdown' Jekyll::External.require_with_graceful_fail "kramdown"
@config = config @main_fallback_highlighter = config["highlighter"] || "rouge"
rescue LoadError @config = config["kramdown"] || {}
STDERR.puts 'You are missing a library required for Markdown. Please run:' setup
STDERR.puts ' $ [sudo] gem install kramdown' end
raise Errors::FatalException.new("Missing dependency: kramdown")
# Setup and normalize the configuration:
# * Create Kramdown if it doesn't exist.
# * Set syntax_highlighter, detecting enable_coderay and merging highlighter if none.
# * Merge kramdown[coderay] into syntax_highlighter_opts stripping coderay_.
# * Make sure `syntax_highlighter_opts` exists.
def setup
@config["syntax_highlighter"] ||= highlighter
@config["syntax_highlighter_opts"] ||= {}
@config["coderay"] ||= {} # XXX: Legacy.
modernize_coderay_config
make_accessible
end end
def convert(content) def convert(content)
# Check for use of coderay Kramdown::Document.new(content, @config).to_html
if @config['kramdown']['enable_coderay']
%w[wrap line_numbers line_numbers_start tab_width bold_every css default_lang].each do |opt|
key = "coderay_#{opt}"
@config['kramdown'][key] = @config['kramdown']['coderay'][key] unless @config['kramdown'].key?(key)
end
end
Kramdown::Document.new(content, Utils.symbolize_hash_keys(@config['kramdown'])).to_html
end end
private
def make_accessible(hash = @config)
proc_ = proc { |hash_, key| hash_[key.to_s] if key.is_a?(Symbol) }
hash.default_proc = proc_
hash.each do |_, val|
make_accessible val if val.is_a?(
Hash
)
end
end
# config[kramdown][syntax_higlighter] > config[kramdown][enable_coderay] > config[highlighter]
# Where `enable_coderay` is now deprecated because Kramdown
# supports Rouge now too.
private
def highlighter
return @highlighter if @highlighter
if @config["syntax_highlighter"]
return @highlighter = @config[
"syntax_highlighter"
]
end
@highlighter = begin
if @config.key?("enable_coderay") && @config["enable_coderay"]
Jekyll::Deprecator.deprecation_message "You are using 'enable_coderay', " \
"use syntax_highlighter: coderay in your configuration file."
"coderay"
else
@main_fallback_highlighter
end
end
end
private
def strip_coderay_prefix(hash)
hash.each_with_object({}) do |(key, val), hsh|
cleaned_key = key.gsub(/\Acoderay_/, "")
if key != cleaned_key
Jekyll::Deprecator.deprecation_message(
"You are using '#{key}'. Normalizing to #{cleaned_key}."
)
end
hsh[cleaned_key] = val
end
end
# If our highlighter is CodeRay we go in to merge the CodeRay defaults
# with your "coderay" key if it's there, deprecating it in the
# process of you using it.
private
def modernize_coderay_config
if highlighter == "coderay"
Jekyll::Deprecator.deprecation_message "You are using 'kramdown.coderay' in your configuration, " \
"please use 'syntax_highlighter_opts' instead."
@config["syntax_highlighter_opts"] = begin
strip_coderay_prefix(
@config["syntax_highlighter_opts"] \
.merge(CODERAY_DEFAULTS) \
.merge(@config["coderay"])
)
end
end
end
end end
end end
end end

View File

@ -5,7 +5,7 @@ module Jekyll
def initialize(config) def initialize(config)
Jekyll::External.require_with_graceful_fail "rdiscount" Jekyll::External.require_with_graceful_fail "rdiscount"
@config = config @config = config
@rdiscount_extensions = @config['rdiscount']['extensions'].map { |e| e.to_sym } @rdiscount_extensions = @config['rdiscount']['extensions'].map(&:to_sym)
end end
def convert(content) def convert(content)

View File

@ -2,12 +2,12 @@ module Jekyll
module Converters module Converters
class Markdown class Markdown
class RedcarpetParser class RedcarpetParser
module CommonMethods module CommonMethods
def add_code_tags(code, lang) def add_code_tags(code, lang)
code = code.to_s code = code.to_s
code = code.sub(/<pre>/, "<pre><code class=\"language-#{lang}\" data-lang=\"#{lang}\">") code = code.sub(/<pre>/, "<pre><code class=\"language-#{lang}\" data-lang=\"#{lang}\">")
code = code.sub(/<\/pre>/,"</code></pre>") code = code.sub(/<\/pre>/, "</code></pre>")
code
end end
end end
@ -48,12 +48,11 @@ module Jekyll
end end
protected protected
def rouge_formatter(lexer) def rouge_formatter(_lexer)
Rouge::Formatters::HTML.new(:wrap => false) Rouge::Formatters::HTML.new(:wrap => false)
end end
end end
def initialize(config) def initialize(config)
External.require_with_graceful_fail("redcarpet") External.require_with_graceful_fail("redcarpet")
@config = config @config = config
@ -71,12 +70,12 @@ module Jekyll
end end
when "rouge" when "rouge"
Class.new(Redcarpet::Render::HTML) do Class.new(Redcarpet::Render::HTML) do
Jekyll::External.require_with_graceful_fail(%w[ Jekyll::External.require_with_graceful_fail(%w(
rouge rouge
rouge/plugins/redcarpet rouge/plugins/redcarpet
]) ))
if Rouge.version < '1.3.0' unless Gem::Version.new(Rouge.version) > Gem::Version.new("1.3.0")
abort "Please install Rouge 1.3.0 or greater and try running Jekyll again." abort "Please install Rouge 1.3.0 or greater and try running Jekyll again."
end end

View File

@ -0,0 +1,34 @@
class Kramdown::Parser::SmartyPants < Kramdown::Parser::Kramdown
def initialize(source, options)
super
@block_parsers = [:block_html]
@span_parsers = [:smart_quotes, :html_entity, :typographic_syms, :span_html]
end
end
module Jekyll
module Converters
class SmartyPants < Converter
safe true
priority :low
def initialize(config)
Jekyll::External.require_with_graceful_fail "kramdown"
@config = config["kramdown"].dup || {}
@config[:input] = :SmartyPants
end
def matches(_)
false
end
def output_ext(_)
nil
end
def convert(content)
Kramdown::Document.new(content, @config).to_html.chomp
end
end
end
end

View File

@ -28,12 +28,6 @@ module Jekyll
!(data.key?('published') && data['published'] == false) !(data.key?('published') && data['published'] == false)
end end
# Returns merged option hash for File.read of self.site (if exists)
# and a given param
def merged_file_read_opts(opts)
(site ? site.file_read_opts : {}).merge(opts)
end
# Read the YAML frontmatter. # Read the YAML frontmatter.
# #
# base - The String path to the dir containing the file. # base - The String path to the dir containing the file.
@ -42,28 +36,41 @@ module Jekyll
# #
# Returns nothing. # Returns nothing.
def read_yaml(base, name, opts = {}) def read_yaml(base, name, opts = {})
filename = File.join(base, name)
begin begin
self.content = File.read(site.in_source_dir(base, name), self.content = File.read(site.in_source_dir(base, name),
merged_file_read_opts(opts)) Utils.merged_file_read_opts(site, opts))
if content =~ /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m if content =~ /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m
self.content = $POSTMATCH self.content = $POSTMATCH
self.data = SafeYAML.load($1) self.data = SafeYAML.load(Regexp.last_match(1))
end end
rescue SyntaxError => e rescue SyntaxError => e
Jekyll.logger.warn "YAML Exception reading #{File.join(base, name)}: #{e.message}" Jekyll.logger.warn "YAML Exception reading #{filename}: #{e.message}"
rescue Exception => e rescue Exception => e
Jekyll.logger.warn "Error reading file #{File.join(base, name)}: #{e.message}" Jekyll.logger.warn "Error reading file #{filename}: #{e.message}"
end end
self.data ||= {} self.data ||= {}
unless self.data.is_a?(Hash) validate_data! filename
Jekyll.logger.abort_with "Fatal:", "Invalid YAML front matter in #{File.join(base, name)}" validate_permalink! filename
end
self.data self.data
end end
def validate_data!(filename)
unless self.data.is_a?(Hash)
raise Errors::InvalidYAMLFrontMatterError, "Invalid YAML front matter in #{filename}"
end
end
def validate_permalink!(filename)
if self.data['permalink'] && self.data['permalink'].size == 0
raise Errors::InvalidPermalinkError, "Invalid permalink in #{filename}"
end
end
# Transform the contents based on the content type. # Transform the contents based on the content type.
# #
# Returns the transformed contents. # Returns the transformed contents.
@ -84,13 +91,7 @@ module Jekyll
# Returns the String extension for the output file. # Returns the String extension for the output file.
# e.g. ".html" for an HTML output file. # e.g. ".html" for an HTML output file.
def output_ext def output_ext
if converters.all? { |c| c.is_a?(Jekyll::Converters::Identity) } Jekyll::Renderer.new(site, self).output_ext
ext
else
converters.map { |c|
c.output_ext(ext) unless c.is_a?(Jekyll::Converters::Identity)
}.compact.last
end
end end
# Determine which converter to use based on this convertible's # Determine which converter to use based on this convertible's
@ -109,7 +110,7 @@ module Jekyll
# #
# Returns the converted content # Returns the converted content
def render_liquid(content, payload, info, path) def render_liquid(content, payload, info, path)
site.liquid_renderer.file(path).parse(content).render(payload, info) site.liquid_renderer.file(path).parse(content).render!(payload, info)
rescue Tags::IncludeTagError => e rescue Tags::IncludeTagError => e
Jekyll.logger.error "Liquid Exception:", "#{e.message} in #{e.path}, included in #{path || self.path}" Jekyll.logger.error "Liquid Exception:", "#{e.message} in #{e.path}, included in #{path || self.path}"
raise e raise e
@ -122,9 +123,9 @@ module Jekyll
# #
# Returns the Hash representation of this Convertible. # Returns the Hash representation of this Convertible.
def to_liquid(attrs = nil) def to_liquid(attrs = nil)
further_data = Hash[(attrs || self.class::ATTRIBUTES_FOR_LIQUID).map { |attribute| further_data = Hash[(attrs || self.class::ATTRIBUTES_FOR_LIQUID).map do |attribute|
[attribute, send(attribute)] [attribute, send(attribute)]
}] end]
defaults = site.frontmatter_defaults.all(relative_path, type) defaults = site.frontmatter_defaults.all(relative_path, type)
Utils.deep_merge_hashes defaults, Utils.deep_merge_hashes(data, further_data) Utils.deep_merge_hashes defaults, Utils.deep_merge_hashes(data, further_data)
@ -135,11 +136,14 @@ module Jekyll
# #
# Returns the type of self. # Returns the type of self.
def type def type
if is_a?(Draft) if is_a?(Page)
:drafts :pages
elsif is_a?(Post) end
:posts end
elsif is_a?(Page)
# returns the owner symbol for hook triggering
def hook_owner
if is_a?(Page)
:pages :pages
end end
end end
@ -157,7 +161,7 @@ module Jekyll
# #
# Returns true if extname == .sass or .scss, false otherwise. # Returns true if extname == .sass or .scss, false otherwise.
def sass_file? def sass_file?
%w[.sass .scss].include?(ext) %w(.sass .scss).include?(ext)
end end
# Determine whether the document is a CoffeeScript file. # Determine whether the document is a CoffeeScript file.
@ -206,12 +210,14 @@ module Jekyll
used = Set.new([layout]) used = Set.new([layout])
while layout while layout
payload = Utils.deep_merge_hashes(payload, {"content" => output, "page" => layout.data}) Jekyll.logger.debug "Rendering Layout:", path
payload["content"] = output
payload["layout"] = Utils.deep_merge_hashes(payload["layout"] || {}, layout.data)
self.output = render_liquid(layout.content, self.output = render_liquid(layout.content,
payload, payload,
info, info,
File.join(site.config['layouts'], layout.name)) File.join(site.config['layouts_dir'], layout.name))
# Add layout to dependency tree # Add layout to dependency tree
site.regenerator.add_dependency( site.regenerator.add_dependency(
@ -231,26 +237,34 @@ module Jekyll
# Add any necessary layouts to this convertible document. # Add any necessary layouts to this convertible document.
# #
# payload - The site payload Hash. # payload - The site payload Drop or Hash.
# layouts - A Hash of {"name" => "layout"}. # layouts - A Hash of {"name" => "layout"}.
# #
# Returns nothing. # Returns nothing.
def do_layout(payload, layouts) def do_layout(payload, layouts)
Jekyll::Hooks.trigger self, :pre_render, payload Jekyll.logger.debug "Rendering:", self.relative_path
info = { :filters => [Jekyll::Filters], :registers => { :site => site, :page => payload['page'] } }
Jekyll.logger.debug "Pre-Render Hooks:", self.relative_path
Jekyll::Hooks.trigger hook_owner, :pre_render, self, payload
info = { :filters => [Jekyll::Filters], :registers => { :site => site, :page => payload["page"] } }
# render and transform content (this becomes the final content of the object) # render and transform content (this becomes the final content of the object)
payload["highlighter_prefix"] = converters.first.highlighter_prefix payload["highlighter_prefix"] = converters.first.highlighter_prefix
payload["highlighter_suffix"] = converters.first.highlighter_suffix payload["highlighter_suffix"] = converters.first.highlighter_suffix
self.content = render_liquid(content, payload, info, path) if render_with_liquid? if render_with_liquid?
Jekyll.logger.debug "Rendering Liquid:", self.relative_path
self.content = render_liquid(content, payload, info, path)
end
Jekyll.logger.debug "Rendering Markup:", self.relative_path
self.content = transform self.content = transform
# output keeps track of what will finally be written # output keeps track of what will finally be written
self.output = content self.output = content
render_all_layouts(layouts, payload, info) if place_in_layout? render_all_layouts(layouts, payload, info) if place_in_layout?
Jekyll::Hooks.trigger self, :post_render Jekyll.logger.debug "Post-Render Hooks:", self.relative_path
Jekyll::Hooks.trigger hook_owner, :post_render, self
end end
# Write the generated page file to the destination directory. # Write the generated page file to the destination directory.
@ -264,7 +278,7 @@ module Jekyll
File.open(path, 'wb') do |f| File.open(path, 'wb') do |f|
f.write(output) f.write(output)
end end
Jekyll::Hooks.trigger self, :post_write Jekyll::Hooks.trigger hook_owner, :post_write, self
end end
# Accessor for data properties by Liquid. # Accessor for data properties by Liquid.

View File

@ -3,9 +3,10 @@ module Jekyll
extend self extend self
def process(args) def process(args)
no_subcommand(args)
arg_is_present? args, "--server", "The --server command has been replaced by the \ arg_is_present? args, "--server", "The --server command has been replaced by the \
'serve' subcommand." 'serve' subcommand."
arg_is_present? args, "--serve", "The --server command has been replaced by the \
'serve' subcommand."
arg_is_present? args, "--no-server", "To build Jekyll without launching a server, \ arg_is_present? args, "--no-server", "To build Jekyll without launching a server, \
use the 'build' subcommand." use the 'build' subcommand."
arg_is_present? args, "--auto", "The switch '--auto' has been replaced with '--watch'." arg_is_present? args, "--auto", "The switch '--auto' has been replaced with '--watch'."
@ -16,12 +17,13 @@ module Jekyll
arg_is_present? args, "--paginate", "The 'paginate' setting can only be set in your \ arg_is_present? args, "--paginate", "The 'paginate' setting can only be set in your \
config files." config files."
arg_is_present? args, "--url", "The 'url' setting can only be set in your config files." arg_is_present? args, "--url", "The 'url' setting can only be set in your config files."
no_subcommand(args)
end end
def no_subcommand(args) def no_subcommand(args)
if args.size > 0 && args.first =~ /^--/ && !%w[--help --version].include?(args.first) if args.size > 0 && args.first =~ /^--/ && !%w(--help --version).include?(args.first)
deprecation_message "Jekyll now uses subcommands instead of just \ deprecation_message "Jekyll now uses subcommands instead of just switches. Run `jekyll help` to find out more."
switches. Run `jekyll --help` to find out more." abort
end end
end end

View File

@ -4,33 +4,39 @@ module Jekyll
class Document class Document
include Comparable include Comparable
attr_reader :path, :site, :extname, :output_ext, :content, :output, :collection attr_reader :path, :site, :extname, :collection
attr_accessor :content, :output
YAML_FRONT_MATTER_REGEXP = /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m YAML_FRONT_MATTER_REGEXP = /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m
DATELESS_FILENAME_MATCHER = /^(.+\/)*(.*)(\.[^.]+)$/
DATE_FILENAME_MATCHER = /^(.+\/)*(\d+-\d+-\d+)-(.*)(\.[^.]+)$/
# Create a new Document. # Create a new Document.
# #
# site - the Jekyll::Site instance to which this Document belongs
# path - the path to the file # path - the path to the file
# relations - a hash with keys :site and :collection, the values of which
# are the Jekyll::Site and Jekyll::Collection to which this
# Document belong.
# #
# Returns nothing. # Returns nothing.
def initialize(path, relations) def initialize(path, relations = {})
@site = relations[:site] @site = relations[:site]
@path = path @path = path
@extname = File.extname(path) @extname = File.extname(path)
@output_ext = Jekyll::Renderer.new(site, self).output_ext
@collection = relations[:collection] @collection = relations[:collection]
@has_yaml_header = nil @has_yaml_header = nil
end
def output=(output) if draft?
@to_liquid = nil categories_from_path("_drafts")
@output = output else
end categories_from_path(collection.relative_directory)
end
def content=(content) data.default_proc = proc do |_, key|
@to_liquid = nil site.frontmatter_defaults.find(relative_path, collection.label, key)
@content = content end
trigger_hooks(:post_init)
end end
# Fetch the Document's data. # Fetch the Document's data.
@ -38,7 +44,44 @@ module Jekyll
# Returns a Hash containing the data. An empty hash is returned if # Returns a Hash containing the data. An empty hash is returned if
# no data was read. # no data was read.
def data def data
@data ||= Hash.new @data ||= {}
end
# Merge some data in with this document's data.
#
# Returns the merged data.
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)
end
other['categories'] = (data['categories'] || []) | other['categories']
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 #{source}."
)
end
data
end
def date
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
# the document is in the 'posts' collection but in a different
# directory than '_posts'.
#
# Returns whether the document is a draft.
def draft?
data['draft'] ||= relative_path.index(collection.relative_directory).nil? && collection.label == "posts"
end end
# The path to the document, relative to the site source. # The path to the document, relative to the site source.
@ -49,6 +92,13 @@ module Jekyll
@relative_path ||= Pathname.new(path).relative_path_from(Pathname.new(site.source)).to_s @relative_path ||= Pathname.new(path).relative_path_from(Pathname.new(site.source)).to_s
end end
# The output extension of the document.
#
# Returns the output extension
def output_ext
Jekyll::Renderer.new(site, self).output_ext
end
# The base filename of the document, without the file extname. # The base filename of the document, without the file extname.
# #
# Returns the basename without the file extname. # Returns the basename without the file extname.
@ -76,14 +126,14 @@ module Jekyll
# Returns the cleaned relative path of the document. # Returns the cleaned relative path of the document.
def cleaned_relative_path def cleaned_relative_path
@cleaned_relative_path ||= @cleaned_relative_path ||=
relative_path[0 .. -extname.length - 1].sub(collection.relative_directory, "") relative_path[0..-extname.length - 1].sub(collection.relative_directory, "")
end end
# Determine whether the document is a YAML file. # Determine whether the document is a YAML file.
# #
# Returns true if the extname is either .yml or .yaml, false otherwise. # Returns true if the extname is either .yml or .yaml, false otherwise.
def yaml_file? def yaml_file?
%w[.yaml .yml].include?(extname) %w(.yaml .yml).include?(extname)
end end
# Determine whether the document is an asset file. # Determine whether the document is an asset file.
@ -99,7 +149,7 @@ module Jekyll
# #
# Returns true if extname == .sass or .scss, false otherwise. # Returns true if extname == .sass or .scss, false otherwise.
def sass_file? def sass_file?
%w[.sass .scss].include?(extname) %w(.sass .scss).include?(extname)
end end
# Determine whether the document is a CoffeeScript file. # Determine whether the document is a CoffeeScript file.
@ -137,13 +187,7 @@ module Jekyll
# #
# Returns the Hash of key-value pairs for replacement in the URL. # Returns the Hash of key-value pairs for replacement in the URL.
def url_placeholders def url_placeholders
{ @url_placeholders ||= Drops::UrlDrop.new(self)
collection: collection.label,
path: cleaned_relative_path,
output_ext: output_ext,
name: Utils.slugify(basename_without_ext),
title: Utils.slugify(data['slug']) || Utils.slugify(basename_without_ext)
}
end end
# The permalink for this Document. # The permalink for this Document.
@ -159,12 +203,16 @@ module Jekyll
# Returns the computed URL for the document. # Returns the computed URL for the document.
def url def url
@url = URL.new({ @url = URL.new({
template: url_template, :template => url_template,
placeholders: url_placeholders, :placeholders => url_placeholders,
permalink: permalink :permalink => permalink
}).to_s }).to_s
end end
def [](key)
data[key]
end
# The full path to the output file. # The full path to the output file.
# #
# base_directory - the base path of the output directory # base_directory - the base path of the output directory
@ -173,8 +221,11 @@ module Jekyll
def destination(base_directory) def destination(base_directory)
dest = site.in_dest_dir(base_directory) dest = site.in_dest_dir(base_directory)
path = site.in_dest_dir(dest, URL.unescape_path(url)) path = site.in_dest_dir(dest, URL.unescape_path(url))
path = File.join(path, "index.html") if url.end_with?("/") if url.end_with? "/"
path << output_ext unless path.end_with?(output_ext) path = File.join(path, "index.html")
else
path << output_ext unless path.end_with? output_ext
end
path path
end end
@ -190,17 +241,7 @@ module Jekyll
f.write(output) f.write(output)
end end
Jekyll::Hooks.trigger self, :post_write trigger_hooks(:post_write)
end
# Returns merged option hash for File.read of self.site (if exists)
# and a given param
#
# opts - override options
#
# Return the file read options hash.
def merged_file_read_opts(opts)
site ? site.file_read_opts.merge(opts) : opts
end end
# Whether the file is published or not, as indicated in YAML front-matter # Whether the file is published or not, as indicated in YAML front-matter
@ -216,48 +257,86 @@ module Jekyll
# #
# Returns nothing. # Returns nothing.
def read(opts = {}) def read(opts = {})
@to_liquid = nil Jekyll.logger.debug "Reading:", relative_path
if yaml_file? if yaml_file?
@data = SafeYAML.load_file(path) @data = SafeYAML.load_file(path)
else else
begin begin
defaults = @site.frontmatter_defaults.all(url, collection.label.to_sym) defaults = @site.frontmatter_defaults.all(url, collection.label.to_sym)
unless defaults.empty? merge_data!(defaults, source: "front matter defaults") unless defaults.empty?
@data = defaults
end self.content = File.read(path, Utils.merged_file_read_opts(site, opts))
self.content = File.read(path, merged_file_read_opts(opts))
if content =~ YAML_FRONT_MATTER_REGEXP if content =~ YAML_FRONT_MATTER_REGEXP
self.content = $POSTMATCH self.content = $POSTMATCH
data_file = SafeYAML.load($1) data_file = SafeYAML.load(Regexp.last_match(1))
unless data_file.nil? merge_data!(data_file, source: "YAML front matter") if data_file
@data = Utils.deep_merge_hashes(defaults, data_file)
end
end end
post_read
rescue SyntaxError => e rescue SyntaxError => e
puts "YAML Exception reading #{path}: #{e.message}" Jekyll.logger.error "Error:", "YAML Exception reading #{path}: #{e.message}"
rescue Exception => e 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 end
end end
def post_read
if relative_path =~ DATE_FILENAME_MATCHER
date, slug, ext = $2, $3, $4
if !data['date'] || data['date'].to_i == site.time.to_i
merge_data!({"date" => date}, source: "filename")
end
elsif relative_path =~ DATELESS_FILENAME_MATCHER
slug, ext = $2, $3
end
# Try to ensure the user gets a title.
data["title"] ||= Utils.titleize_slug(slug)
# Only overwrite slug & ext if they aren't specified.
data['slug'] ||= slug
data['ext'] ||= ext
populate_categories
populate_tags
generate_excerpt
end
# Add superdirectories of the special_dir to categories.
# In the case of es/_posts, 'es' is added as a category.
# In the case of _posts/es, 'es' is NOT added as a category.
#
# Returns nothing.
def categories_from_path(special_dir)
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 }, source: "file path")
end
def populate_categories
merge_data!({
'categories' => (
Array(data['categories']) + Utils.pluralized_array_from_hash(data, 'category', 'categories')
).map(&:to_s).flatten.uniq
})
end
def populate_tags
merge_data!({
"tags" => Utils.pluralized_array_from_hash(data, "tag", "tags").flatten
})
end
# Create a Liquid-understandable version of this Document. # Create a Liquid-understandable version of this Document.
# #
# Returns a Hash representing this Document's data. # Returns a Hash representing this Document's data.
def to_liquid def to_liquid
@to_liquid ||= if data.is_a?(Hash) @to_liquid ||= Drops::DocumentDrop.new(self)
Utils.deep_merge_hashes data, {
"output" => output,
"content" => content,
"relative_path" => relative_path,
"path" => relative_path,
"url" => url,
"collection" => collection.label
}
else
data
end
end end
# The inspect string for this document. # The inspect string for this document.
@ -272,7 +351,7 @@ module Jekyll
# #
# Returns the content of the document # Returns the content of the document
def to_s def to_s
content || '' output || content || 'NO CONTENT'
end end
# Compare this document against another document. # Compare this document against another document.
@ -280,8 +359,11 @@ module Jekyll
# #
# Returns -1, 0, +1 or nil depending on whether this doc's path is less than, # Returns -1, 0, +1 or nil depending on whether this doc's path is less than,
# equal or greater than the other doc's path. See String#<=> for more details. # equal or greater than the other doc's path. See String#<=> for more details.
def <=>(anotherDocument) def <=>(other)
path <=> anotherDocument.path return nil unless other.respond_to?(:data)
cmp = data['date'] <=> other.data['date']
cmp = path <=> other.path if cmp.nil? || cmp == 0
cmp
end end
# Determine whether this document should be written. # Determine whether this document should be written.
@ -292,5 +374,78 @@ module Jekyll
def write? def write?
collection && collection.write? collection && collection.write?
end end
# The Document excerpt_separator, from the YAML Front-Matter or site
# default excerpt_separator value
#
# Returns the document excerpt_separator
def excerpt_separator
(data['excerpt_separator'] || site.config['excerpt_separator']).to_s
end
# Whether to generate an excerpt
#
# Returns true if the excerpt separator is configured.
def generate_excerpt?
!excerpt_separator.empty?
end
def next_doc
pos = collection.docs.index { |post| post.equal?(self) }
if pos && pos < collection.docs.length - 1
collection.docs[pos + 1]
else
nil
end
end
def previous_doc
pos = collection.docs.index { |post| post.equal?(self) }
if pos && pos > 0
collection.docs[pos - 1]
else
nil
end
end
def trigger_hooks(hook_name, *args)
Jekyll::Hooks.trigger collection.label.to_sym, hook_name, self, *args if collection
Jekyll::Hooks.trigger :documents, hook_name, self, *args
end
def id
@id ||= File.join(File.dirname(url), (data['slug'] || basename_without_ext).to_s)
end
# Calculate related posts.
#
# Returns an Array of related Posts.
def related_posts
Jekyll::RelatedPosts.new(self).build
end
# Override of normal respond_to? to match method_missing's logic for
# looking in @data.
def respond_to?(method, include_private = false)
data.key?(method.to_s) || super
end
# Override of method_missing to check in @data for the key.
def method_missing(method, *args, &blck)
if data.key?(method.to_s)
Jekyll.logger.warn "Deprecation:", "Document##{method} is now a key in the #data hash."
Jekyll.logger.warn "", "Called by #{caller.first}."
data[method.to_s]
else
super
end
end
private # :nodoc:
def generate_excerpt
if generate_excerpt?
data["excerpt"] ||= Jekyll::Excerpt.new(self)
end
end
end end
end end

View File

@ -1,40 +0,0 @@
module Jekyll
class Draft < Post
# Valid post name regex (no date)
MATCHER = /^(.*)(\.[^.]+)$/
# Draft name validator. Draft filenames must be like:
# my-awesome-post.textile
#
# Returns true if valid, false if not.
def self.valid?(name)
name =~ MATCHER
end
# Get the full path to the directory containing the draft files
def containing_dir(dir)
site.in_source_dir(dir, '_drafts')
end
# The path to the draft source file, relative to the site source
def relative_path
File.join(@dir, '_drafts', @name)
end
# Extract information from the post filename.
#
# name - The String filename of the post file.
#
# Returns nothing.
def process(name)
m, slug, ext = *name.match(MATCHER)
self.date = File.mtime(File.join(@base, name))
self.slug = slug
self.ext = ext
end
end
end

View File

@ -0,0 +1,22 @@
# encoding: UTF-8
module Jekyll
module Drops
class CollectionDrop < Drop
extend Forwardable
mutable false
def_delegator :@obj, :write?, :output
def_delegators :@obj, :label, :docs, :files, :directory,
:relative_directory
def to_s
docs.to_s
end
private
def_delegator :@obj, :metadata, :fallback_data
end
end
end

View File

@ -0,0 +1,27 @@
# encoding: UTF-8
module Jekyll
module Drops
class DocumentDrop < Drop
extend Forwardable
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
def collection
@obj.collection.label
end
def excerpt
fallback_data['excerpt'].to_s
end
private
def_delegator :@obj, :data, :fallback_data
end
end
end

176
lib/jekyll/drops/drop.rb Normal file
View File

@ -0,0 +1,176 @@
# encoding: UTF-8
module Jekyll
module Drops
class Drop < Liquid::Drop
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
# overwritten.
#
# is_mutable - Boolean set mutability of the class (default: nil)
#
# Returns the mutability of the class
def self.mutable(is_mutable = nil)
if is_mutable
@is_mutable = is_mutable
else
@is_mutable = false
end
end
def self.mutable?
@is_mutable
end
# Create a new Drop
#
# obj - the Jekyll Site, Collection, or Document required by the
# drop.
#
# Returns nothing
def initialize(obj)
@obj = obj
@mutations = {} # only if mutable: true
end
# Access a method in the Drop or a field in the underlying hash data.
# If mutable, checks the mutations first. Then checks the methods,
# and finally check the underlying hash (e.g. document front matter)
# if all the previous places didn't match.
#
# key - the string key whose value to fetch
#
# Returns the value for the given key, or nil if none exists
def [](key)
if self.class.mutable? && @mutations.key?(key)
@mutations[key]
elsif self.class.invokable? key
public_send key
else
fallback_data[key]
end
end
# Set a field in the Drop. If mutable, sets in the mutations and
# returns. If not mutable, checks first if it's trying to override a
# Drop method and raises a DropMutationException if so. If not
# mutable and the key is not a method on the Drop, then it sets the
# key to the value in the underlying hash (e.g. document front
# matter)
#
# key - the String key whose value to set
# val - the Object to set the key's value to
#
# Returns the value the key was set to unless the Drop is not mutable
# and the key matches a method in which case it raises a
# DropMutationException.
def []=(key, val)
if respond_to?("#{key}=")
public_send("#{key}=", val)
elsif respond_to? key
if self.class.mutable?
@mutations[key] = val
else
raise Errors::DropMutationException, "Key #{key} cannot be set in the drop."
end
else
fallback_data[key] = val
end
end
# Generates a list of strings which correspond to content getter
# methods.
#
# Returns an Array of strings which represent method-specific keys.
def content_methods
@content_methods ||= (
self.class.instance_methods(false) - NON_CONTENT_METHODS
).map(&:to_s).reject do |method|
method.end_with?("=")
end
end
# Check if key exists in Drop
#
# key - the string key whose value to fetch
#
# Returns true if the given key is present
def key?(key)
if self.class.mutable && @mutations.key?(key)
true
else
respond_to?(key) || fallback_data.key?(key)
end
end
# Generates a list of keys with user content as their values.
# This gathers up the Drop methods and keys of the mutations and
# underlying data hashes and performs a set union to ensure a list
# of unique keys for the Drop.
#
# Returns an Array of unique keys for content for the Drop.
def keys
(content_methods |
@mutations.keys |
fallback_data.keys).flatten
end
# Generate a Hash representation of the Drop by resolving each key's
# value. It includes Drop methods, mutations, and the underlying object's
# data. See the documentation for Drop#keys for more.
#
# Returns a Hash with all the keys and values resolved.
def to_h
keys.each_with_object({}) do |(key, _), result|
result[key] = self[key]
end
end
alias_method :to_hash, :to_h
# Inspect the drop's keys and values through a JSON representation
# of its keys and values.
#
# Returns a pretty generation of the hash representation of the Drop.
def inspect
require 'json'
JSON.pretty_generate to_h
end
# Collects all the keys and passes each to the block in turn.
#
# block - a block which accepts one argument, the key
#
# Returns nothing.
def each_key(&block)
keys.each(&block)
end
def merge(other, &block)
self.dup.tap do |me|
if block.nil?
me.merge!(other)
else
me.merge!(other, block)
end
end
end
def merge!(other)
other.each_key do |key|
if block_given?
self[key] = yield key, self[key], other[key]
else
if Utils.mergable?(self[key]) && Utils.mergable?(other[key])
self[key] = Utils.deep_merge_hashes(self[key], other[key])
next
end
self[key] = other[key] unless other[key].nil?
end
end
end
end
end
end

View File

@ -0,0 +1,21 @@
# encoding: UTF-8
module Jekyll
module Drops
class JekyllDrop < Liquid::Drop
class << self
def global
@global ||= JekyllDrop.new
end
end
def version
Jekyll::VERSION
end
def environment
Jekyll.env
end
end
end
end

View File

@ -0,0 +1,38 @@
# encoding: UTF-8
module Jekyll
module Drops
class SiteDrop < Drop
extend Forwardable
mutable false
def_delegator :@obj, :site_data, :data
def_delegators :@obj, :time, :pages, :static_files, :documents,
:tags, :categories
def [](key)
if @obj.collections.key?(key) && key != "posts"
@obj.collections[key].docs
else
super(key)
end
end
def posts
@site_posts ||= @obj.posts.docs.sort { |a, b| b <=> a }
end
def html_pages
@site_html_pages ||= @obj.pages.select { |page| page.html? || page.url.end_with?("/") }
end
def collections
@site_collections ||= @obj.collections.values.map(&:to_liquid)
end
private
def_delegator :@obj, :config, :fallback_data
end
end
end

View File

@ -0,0 +1,25 @@
# encoding: UTF-8
module Jekyll
module Drops
class UnifiedPayloadDrop < Drop
mutable true
attr_accessor :page, :layout, :content, :paginator
attr_accessor :highlighter_prefix, :highlighter_suffix
def jekyll
JekyllDrop.global
end
def site
@site_drop ||= SiteDrop.new(@obj)
end
private
def fallback_data
@fallback_data ||= {}
end
end
end
end

View File

@ -0,0 +1,83 @@
# encoding: UTF-8
module Jekyll
module Drops
class UrlDrop < Drop
extend Forwardable
mutable false
def_delegator :@obj, :cleaned_relative_path, :path
def_delegator :@obj, :output_ext, :output_ext
def collection
@obj.collection.label
end
def name
Utils.slugify(@obj.basename_without_ext)
end
def title
Utils.slugify(@obj.data['slug'], :mode => "pretty", :cased => true) ||
Utils.slugify(@obj.basename_without_ext, :mode => "pretty", :cased => true)
end
def slug
Utils.slugify(@obj.data['slug']) || Utils.slugify(@obj.basename_without_ext)
end
def categories
category_set = Set.new
Array(@obj.data['categories']).each do |category|
category_set << category.to_s.downcase
end
category_set.to_a.join('/')
end
def year
@obj.date.strftime("%Y")
end
def month
@obj.date.strftime("%m")
end
def day
@obj.date.strftime("%d")
end
def hour
@obj.date.strftime("%H")
end
def minute
@obj.date.strftime("%M")
end
def second
@obj.date.strftime("%S")
end
def i_day
@obj.date.strftime("%-d")
end
def i_month
@obj.date.strftime("%-m")
end
def short_month
@obj.date.strftime("%b")
end
def short_year
@obj.date.strftime("%y")
end
def y_day
@obj.date.strftime("%j")
end
end
end
end

View File

@ -1,6 +1,6 @@
module Jekyll module Jekyll
class EntryFilter class EntryFilter
SPECIAL_LEADING_CHARACTERS = ['.', '_', '#'].freeze SPECIAL_LEADING_CHARACTERS = ['.', '_', '#', '~'].freeze
attr_reader :site attr_reader :site
@ -47,7 +47,7 @@ module Jekyll
def excluded?(entry) def excluded?(entry)
excluded = glob_include?(site.exclude, relative_to_source(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 excluded
end end

View File

@ -1,9 +1,14 @@
module Jekyll module Jekyll
module Errors module Errors
class FatalException < RuntimeError FatalException = Class.new(::RuntimeError)
end
class MissingDependencyException < FatalException DropMutationException = Class.new(FatalException)
end InvalidPermalinkError = Class.new(FatalException)
InvalidYAMLFrontMatterError = Class.new(FatalException)
MissingDependencyException = Class.new(FatalException)
InvalidDateError = Class.new(FatalException)
InvalidPostNameError = Class.new(FatalException)
PostURLError = Class.new(FatalException)
end end
end end

View File

@ -1,47 +1,42 @@
require 'forwardable'
module Jekyll module Jekyll
class Excerpt class Excerpt
include Convertible
extend Forwardable extend Forwardable
attr_accessor :post attr_accessor :doc
attr_accessor :content, :output, :ext attr_accessor :content, :ext
attr_writer :output
def_delegator :@post, :site, :site def_delegators :@doc, :site, :name, :ext, :relative_path, :extname,
def_delegator :@post, :name, :name :render_with_liquid?, :collection, :related_posts
def_delegator :@post, :ext, :ext
# Initialize this Post instance. # Initialize this Excerpt instance.
# #
# site - The Site. # doc - The Document.
# base - The String path to the dir containing the post file.
# name - The String filename of the post file.
# #
# Returns the new Post. # Returns the new Excerpt.
def initialize(post) def initialize(doc)
self.post = post self.doc = doc
self.content = extract_excerpt(post.content) self.content = extract_excerpt(doc.content)
end end
def to_liquid # Fetch YAML front-matter data from related doc, without layout key
post.to_liquid(post.class::EXCERPT_ATTRIBUTES_FOR_LIQUID)
end
# Fetch YAML front-matter data from related post, without layout key
# #
# Returns Hash of post data # Returns Hash of doc data
def data def data
@data ||= post.data.dup @data ||= doc.data.dup
@data.delete("layout") @data.delete("layout")
@data.delete("excerpt")
@data @data
end end
def trigger_hooks(*)
end
# 'Path' of the excerpt. # 'Path' of the excerpt.
# #
# Returns the path for the post this excerpt belongs to with #excerpt appended # Returns the path for the doc this excerpt belongs to with #excerpt appended
def path def path
File.join(post.path, "#excerpt") File.join(doc.path, "#excerpt")
end end
# Check if excerpt includes a string # Check if excerpt includes a string
@ -51,28 +46,43 @@ module Jekyll
(output && output.include?(something)) || content.include?(something) (output && output.include?(something)) || content.include?(something)
end end
# The UID for this post (useful in feeds). # The UID for this doc (useful in feeds).
# e.g. /2008/11/05/my-awesome-post # e.g. /2008/11/05/my-awesome-doc
# #
# Returns the String UID. # Returns the String UID.
def id def id
File.join(post.dir, post.slug, "#excerpt") "#{doc.id}#excerpt"
end end
def to_s def to_s
output || content output || content
end end
# Returns the shorthand String identifier of this Post. def to_liquid
doc.data['excerpt'] = nil
@to_liquid ||= doc.to_liquid
doc.data['excerpt'] = self
@to_liquid
end
# Returns the shorthand String identifier of this doc.
def inspect def inspect
"<Excerpt: #{self.id}>" "<Excerpt: #{self.id}>"
end end
def output
@output ||= Renderer.new(doc.site, self, site.site_payload).run
end
def place_in_layout?
false
end
protected protected
# Internal: Extract excerpt from the content # Internal: Extract excerpt from the content
# #
# By default excerpt is your first paragraph of a post: everything before # By default excerpt is your first paragraph of a doc: everything before
# the first two new lines: # the first two new lines:
# #
# --- # ---
@ -86,16 +96,16 @@ module Jekyll
# [1]: http://example.com/ # [1]: http://example.com/
# #
# This is fairly good option for Markdown and Textile files. But might cause # This is fairly good option for Markdown and Textile files. But might cause
# problems for HTML posts (which is quite unusual for Jekyll). If default # problems for HTML docs (which is quite unusual for Jekyll). If default
# excerpt delimiter is not good for you, you might want to set your own via # excerpt delimiter is not good for you, you might want to set your own via
# configuration option `excerpt_separator`. For example, following is a good # configuration option `excerpt_separator`. For example, following is a good
# alternative for HTML posts: # alternative for HTML docs:
# #
# # file: _config.yml # # file: _config.yml
# excerpt_separator: "<!-- more -->" # excerpt_separator: "<!-- more -->"
# #
# Notice that all markdown-style link references will be appended to the # Notice that all markdown-style link references will be appended to the
# excerpt. So the example post above will have this excerpt source: # excerpt. So the example doc above will have this excerpt source:
# #
# First paragraph with [link][1]. # First paragraph with [link][1].
# #
@ -104,10 +114,14 @@ module Jekyll
# Excerpts are rendered same time as content is rendered. # Excerpts are rendered same time as content is rendered.
# #
# Returns excerpt String # Returns excerpt String
def extract_excerpt(post_content) def extract_excerpt(doc_content)
head, _, tail = post_content.to_s.partition(post.excerpt_separator) head, _, tail = doc_content.to_s.partition(doc.excerpt_separator)
"" << head << "\n\n" << tail.scan(/^\[[^\]]+\]:.+$/).join("\n") if tail.empty?
head
else
"" << head << "\n\n" << tail.scan(/^\[[^\]]+\]:.+$/).join("\n")
end
end end
end end
end end

View File

@ -1,16 +1,15 @@
module Jekyll module Jekyll
module External module External
class << self class << self
# #
# Gems that, if installed, should be loaded. # Gems that, if installed, should be loaded.
# Usually contain subcommands. # Usually contain subcommands.
# #
def blessed_gems def blessed_gems
%w{ %w(
jekyll-docs jekyll-docs
jekyll-import jekyll-import
} )
end end
# #
@ -18,12 +17,13 @@ module Jekyll
# #
# names - a string gem name or array of gem names # names - a string gem name or array of gem names
# #
def require_if_present(names) def require_if_present(names, &block)
Array(names).each do |name| Array(names).each do |name|
begin begin
require name require name
rescue LoadError rescue LoadError
Jekyll.logger.debug "Couldn't load #{name}. Skipping." Jekyll.logger.debug "Couldn't load #{name}. Skipping."
block.call(name) if block
false false
end end
end end
@ -39,6 +39,7 @@ module Jekyll
def require_with_graceful_fail(names) def require_with_graceful_fail(names)
Array(names).each do |name| Array(names).each do |name|
begin begin
Jekyll.logger.debug "Requiring:", "#{name}"
require name require name
rescue LoadError => e rescue LoadError => e
Jekyll.logger.error "Dependency Error:", <<-MSG Jekyll.logger.error "Dependency Error:", <<-MSG
@ -53,7 +54,6 @@ If you run into trouble, you can find helpful resources at http://jekyllrb.com/h
end end
end end
end end
end end
end end
end end

View File

@ -15,6 +15,17 @@ module Jekyll
converter.convert(input) converter.convert(input)
end end
# Convert quotes into smart quotes.
#
# input - The String to convert.
#
# Returns the smart-quotified String.
def smartify(input)
site = @context.registers[:site]
converter = site.find_converter_instance(Jekyll::Converters::SmartyPants)
converter.convert(input)
end
# Convert a Sass string into CSS output. # Convert a Sass string into CSS output.
# #
# input - The Sass String to convert. # input - The Sass String to convert.
@ -45,7 +56,7 @@ module Jekyll
# Returns the given filename or title as a lowercase URL String. # Returns the given filename or title as a lowercase URL String.
# See Utils.slugify for more detail. # See Utils.slugify for more detail.
def slugify(input, mode=nil) def slugify(input, mode=nil)
Utils.slugify(input, mode) Utils.slugify(input, :mode => mode)
end end
# Format a date in short format e.g. "27 Jan 2011". # Format a date in short format e.g. "27 Jan 2011".
@ -106,7 +117,7 @@ module Jekyll
# #
# Returns the escaped String. # Returns the escaped String.
def xml_escape(input) def xml_escape(input)
CGI.escapeHTML(input.to_s) input.to_s.encode(:xml => :attr).gsub(/\A"|"\Z/, "")
end end
# CGI escape a string for use in a URL. Replaces any special characters # CGI escape a string for use in a URL. Replaces any special characters
@ -194,7 +205,7 @@ module Jekyll
input.group_by do |item| input.group_by do |item|
item_property(item, property).to_s item_property(item, property).to_s
end.inject([]) do |memo, i| end.inject([]) do |memo, i|
memo << {"name" => i.first, "items" => i.last} memo << { "name" => i.first, "items" => i.last, "size" => i.last.size }
end end
else else
input input
@ -211,7 +222,7 @@ module Jekyll
def where(input, property, value) def where(input, property, value)
return input unless input.is_a?(Enumerable) return input unless input.is_a?(Enumerable)
input = input.values if input.is_a?(Hash) input = input.values if input.is_a?(Hash)
input.select { |object| item_property(object, property) == value } input.select { |object| Array(item_property(object, property)).map(&:to_s).include?(value.to_s) }
end end
# Sort an array of objects # Sort an array of objects
@ -223,7 +234,7 @@ module Jekyll
# Returns the filtered array of objects # Returns the filtered array of objects
def sort(input, property = nil, nils = "first") def sort(input, property = nil, nils = "first")
if input.nil? if input.nil?
raise ArgumentError.new("Cannot sort a null object.") raise ArgumentError.new("Cannot sort a null object.")
end end
if property.nil? if property.nil?
input.sort input.sort
@ -234,11 +245,11 @@ module Jekyll
when nils == "last" when nils == "last"
order = + 1 order = + 1
else else
raise ArgumentError.new("Invalid nils order: " + raise ArgumentError.new("Invalid nils order: " \
"'#{nils}' is not a valid nils order. It must be 'first' or 'last'.") "'#{nils}' is not a valid nils order. It must be 'first' or 'last'.")
end end
input.sort { |apple, orange| input.sort do |apple, orange|
apple_property = item_property(apple, property) apple_property = item_property(apple, property)
orange_property = item_property(orange, property) orange_property = item_property(orange, property)
@ -249,7 +260,7 @@ module Jekyll
else else
apple_property <=> orange_property apple_property <=> orange_property
end end
} end
end end
end end
@ -281,20 +292,30 @@ module Jekyll
new_ary new_ary
end end
def sample(input, num = 1)
return input unless input.respond_to?(:sample)
n = num.to_i rescue 1
if n == 1
input.sample
else
input.sample(n)
end
end
# Convert an object into its String representation for debugging # Convert an object into its String representation for debugging
# #
# input - The Object to be converted # input - The Object to be converted
# #
# Returns a String representation of the object. # Returns a String representation of the object.
def inspect(input) def inspect(input)
CGI.escapeHTML(input.inspect) xml_escape(input.inspect)
end end
private private
def time(input) def time(input)
case input case input
when Time when Time
input input.clone
when Date when Date
input.to_time input.to_time
when String when String
@ -327,7 +348,7 @@ module Jekyll
pairs = item.map { |k, v| as_liquid([k, v]) } pairs = item.map { |k, v| as_liquid([k, v]) }
Hash[pairs] Hash[pairs]
when Array when Array
item.map{ |i| as_liquid(i) } item.map { |i| as_liquid(i) }
else else
if item.respond_to?(:to_liquid) if item.respond_to?(:to_liquid)
liquidated = item.to_liquid liquidated = item.to_liquid

View File

@ -13,23 +13,31 @@ module Jekyll
def update_deprecated_types(set) def update_deprecated_types(set)
return set unless set.key?('scope') && set['scope'].key?('type') return set unless set.key?('scope') && set['scope'].key?('type')
set['scope']['type'] = case set['scope']['type'] set['scope']['type'] =
when 'page' case set['scope']['type']
Deprecator.defaults_deprecate_type('page', 'pages') when 'page'
'pages' Deprecator.defaults_deprecate_type('page', 'pages')
when 'post' 'pages'
Deprecator.defaults_deprecate_type('post', 'posts') when 'post'
'posts' Deprecator.defaults_deprecate_type('post', 'posts')
when 'draft' 'posts'
Deprecator.defaults_deprecate_type('draft', 'drafts') when 'draft'
'drafts' Deprecator.defaults_deprecate_type('draft', 'drafts')
else 'drafts'
set['scope']['type'] else
end set['scope']['type']
end
set set
end end
def ensure_time!(set)
return set unless set.key?('values') && set['values'].key?('date')
return set if set['values']['date'].is_a?(Time)
set['values']['date'] = Utils.parse_date(set['values']['date'], "An invalid date format was found in a front-matter default set: #{set}")
set
end
# Finds a default value for a given setting, filtered by path and type # Finds a default value for a given setting, filtered by path and type
# #
# path - the path (relative to the source) of the page, post or :draft the default is used in # path - the path (relative to the source) of the page, post or :draft the default is used in
@ -83,11 +91,11 @@ module Jekyll
end end
def applies_path?(scope, path) def applies_path?(scope, path)
return true if !scope.has_key?('path') || scope['path'].empty? return true if !scope.key?('path') || scope['path'].empty?
scope_path = Pathname.new(scope['path']) scope_path = Pathname.new(scope['path'])
Pathname.new(sanitize_path(path)).ascend do |path| Pathname.new(sanitize_path(path)).ascend do |path|
if path == scope_path if path.to_s == scope_path.to_s
return true return true
end end
end end
@ -143,7 +151,7 @@ module Jekyll
# Returns an array of hashes # Returns an array of hashes
def matching_sets(path, type) def matching_sets(path, type)
valid_sets.select do |set| valid_sets.select do |set|
!set.has_key?('scope') || applies?(set['scope'], path, type) !set.key?('scope') || applies?(set['scope'], path, type)
end end
end end
@ -159,7 +167,7 @@ module Jekyll
sets.map do |set| sets.map do |set|
if valid?(set) if valid?(set)
update_deprecated_types(set) ensure_time!(update_deprecated_types(set))
else else
Jekyll.logger.warn "Defaults:", "An invalid front-matter default set was found:" Jekyll.logger.warn "Defaults:", "An invalid front-matter default set was found:"
Jekyll.logger.warn "#{set}" Jekyll.logger.warn "#{set}"

View File

@ -1,4 +1,3 @@
module Jekyll module Jekyll
class Generator < Plugin Generator = Class.new(Plugin)
end
end end

View File

@ -1,47 +1,41 @@
module Jekyll module Jekyll
module Hooks module Hooks
# Helps look up hooks from the registry by owner's class
OWNER_MAP = {
Jekyll::Site => :site,
Jekyll::Page => :page,
Jekyll::Post => :post,
Jekyll::Document => :document,
}.freeze
DEFAULT_PRIORITY = 20 DEFAULT_PRIORITY = 20
# compatibility layer for octopress-hooks users # compatibility layer for octopress-hooks users
PRIORITY_MAP = { PRIORITY_MAP = {
low: 10, :low => 10,
normal: 20, :normal => 20,
high: 30, :high => 30
}.freeze }.freeze
# initial empty hooks # initial empty hooks
@registry = { @registry = {
:site => { :site => {
after_reset: [], :after_reset => [],
post_read: [], :post_read => [],
pre_render: [], :pre_render => [],
post_write: [], :post_render => [],
:post_write => []
}, },
:page => { :pages => {
post_init: [], :post_init => [],
pre_render: [], :pre_render => [],
post_render: [], :post_render => [],
post_write: [], :post_write => []
}, },
:post => { :posts => {
post_init: [], :post_init => [],
pre_render: [], :pre_render => [],
post_render: [], :post_render => [],
post_write: [], :post_write => []
},
:document => {
pre_render: [],
post_render: [],
post_write: [],
}, },
:documents => {
:post_init => [],
:pre_render => [],
:post_render => [],
:post_write => []
}
} }
# map of all hooks and their priorities # map of all hooks and their priorities
@ -65,13 +59,15 @@ module Jekyll
# register a single hook to be called later, internal API # register a single hook to be called later, internal API
def self.register_one(owner, event, priority, &block) def self.register_one(owner, event, priority, &block)
unless @registry[owner] @registry[owner] ||={
raise NotAvailable, "Hooks are only available for the following " << :post_init => [],
"classes: #{@registry.keys.inspect}" :pre_render => [],
end :post_render => [],
:post_write => []
}
unless @registry[owner][event] unless @registry[owner][event]
raise NotAvailable, "Invalid hook. #{owner} supports only the " << raise NotAvailable, "Invalid hook. #{owner} supports only the " \
"following hooks #{@registry[owner].keys.inspect}" "following hooks #{@registry[owner].keys.inspect}"
end end
@ -88,19 +84,17 @@ module Jekyll
end end
# interface for Jekyll core components to trigger hooks # interface for Jekyll core components to trigger hooks
def self.trigger(instance, event, *args) def self.trigger(owner, event, *args)
owner_symbol = OWNER_MAP[instance.class]
# proceed only if there are hooks to call # proceed only if there are hooks to call
return unless @registry[owner_symbol] return unless @registry[owner]
return unless @registry[owner_symbol][event] return unless @registry[owner][event]
# hooks to call for this owner and event # hooks to call for this owner and event
hooks = @registry[owner_symbol][event] hooks = @registry[owner][event]
# sort and call hooks according to priority and load order # sort and call hooks according to priority and load order
hooks.sort_by { |h| @hook_priority[h] }.each do |hook| hooks.sort_by { |h| @hook_priority[h] }.each do |hook|
hook.call(instance, *args) hook.call(*args)
end end
end end
end end

View File

@ -15,7 +15,7 @@ module Jekyll
def file(filename) def file(filename)
filename = @site.in_source_dir(filename).sub(/\A#{Regexp.escape(@site.source)}\//, '') filename = @site.in_source_dir(filename).sub(/\A#{Regexp.escape(@site.source)}\//, '')
LiquidRenderer::File.new(self, filename).tap do |file| LiquidRenderer::File.new(self, filename).tap do
@stats[filename] ||= {} @stats[filename] ||= {}
@stats[filename][:count] ||= 0 @stats[filename][:count] ||= 0
@stats[filename][:count] += 1 @stats[filename][:count] += 1

View File

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

View File

@ -69,10 +69,10 @@ module Jekyll
end end
def data_for_table(n) def data_for_table(n)
sorted = @stats.sort_by{ |filename, file_stats| -file_stats[:time] } sorted = @stats.sort_by { |_, file_stats| -file_stats[:time] }
sorted = sorted.slice(0, n) sorted = sorted.slice(0, n)
table = [[ 'Filename', 'Count', 'Bytes', 'Time' ]] table = [%w(Filename Count Bytes Time)]
sorted.each do |filename, file_stats| sorted.each do |filename, file_stats|
row = [] row = []

View File

@ -1,96 +1,800 @@
# These are the same MIME types that GitHub Pages uses as of 26 January 2014 # Woah there. Do not edit this file directly.
# This file is generated automatically by script/vendor-mimes.
text/html;charset=utf-8 html htm shtml application/andrew-inset ez
text/css css application/applixware aw
text/xml;charset=utf-8 xml rss xsl xsd application/atom+xml atom
image/gif gif application/atomcat+xml atomcat
image/jpeg jpeg jpg application/atomsvc+xml atomsvc
application/x-javascript js application/bdoc bdoc
application/atom+xml atom application/ccxml+xml ccxml
application/json json geojson topojson application/cdmi-capability cdmia
application/cdmi-container cdmic
text/mathml mml application/cdmi-domain cdmid
text/plain txt application/cdmi-object cdmio
text/vnd.sun.j2me.app-descriptor jad application/cdmi-queue cdmiq
text/vnd.wap.wml wml application/cu-seeme cu
text/x-component htc application/dash+xml mdp
text/cache-manifest manifest appcache application/davmount+xml davmount
text/coffeescript coffee application/docbook+xml dbk
text/plain pde application/dssc+der dssc
text/plain md markdown application/dssc+xml xdssc
text/vcard vcf vcard application/ecmascript ecma
application/emma+xml emma
image/png png application/epub+zip epub
image/svg+xml svg application/exi exi
image/svg+xml svgz application/font-tdpfr pfr
image/tiff tif tiff application/font-woff woff
image/vnd.wap.wbmp wbmp application/font-woff2 woff2
image/x-icon ico application/gml+xml gml
image/x-jng jng application/gpx+xml gpx
image/x-ms-bmp bmp application/gxf gxf
application/hyperstudio stk
application/vnd.ms-fontobject eot application/inkml+xml ink inkml
application/x-font-ttf ttf application/ipfix ipfix
application/x-font-woff woff application/java-archive jar war ear
application/font-woff2 woff2 application/java-serialized-object ser
font/opentype otf application/java-vm class
application/javascript js
application/java-archive jar ear application/json json map
application/mac-binhex40 hqx application/json5 json5
application/msword doc application/jsonml+json jsonml
application/pdf pdf application/ld+json jsonld
application/postscript ps eps ai application/lost+xml lostxml
application/rdf+xml rdf application/mac-binhex40 hqx
application/rtf rtf application/mac-compactpro cpt
application/vnd.apple.pkpass pkpass application/mads+xml mads
application/vnd.ms-excel xls application/manifest+json webmanifest
application/vnd.ms-powerpoint ppt application/marc mrc
application/vnd.wap.wmlc wmlc application/marcxml+xml mrcx
application/xhtml+xml xhtml application/mathematica ma nb mb
application/x-cocoa cco application/mathml+xml mathml
application/x-chrome-extension crx application/mbox mbox
application/x-java-archive-diff jardiff application/mediaservercontrol+xml mscml
application/x-java-jnlp-file jnlp application/metalink+xml metalink
application/x-makeself run application/metalink4+xml meta4
application/x-ms-application application application/mets+xml mets
application/x-ms-manifest manifest application/mods+xml mods
application/x-ms-vsto vsto application/mp21 m21 mp21
application/x-ns-proxy-autoconfig pac application/mp4 mp4s m4p
application/x-perl pl pm application/msword doc dot
application/x-pilot prc pdb application/mxf mxf
application/x-rar-compressed rar application/octet-stream bin dms lrf mar so dist distz pkg bpk dump elc deploy exe dll deb dmg iso img msi msp msm buffer
application/x-redhat-package-manager rpm application/oda oda
application/x-sea sea application/oebps-package+xml opf
application/x-shockwave-flash swf application/ogg ogx
application/x-stuffit sit application/omdoc+xml omdoc
application/x-tcl tcl tk application/onenote onetoc onetoc2 onetmp onepkg
application/x-web-app-manifest+json webapp application/oxps oxps
application/x-x509-ca-cert der pem crt application/patch-ops-error+xml xer
application/x-xpinstall xpi application/pdf pdf
application/x-zip war application/pgp-encrypted pgp
application/zip zip application/pgp-signature asc sig
application/pics-rules prf
application/octet-stream bin exe dll application/pkcs10 p10
application/octet-stream deb application/pkcs7-mime p7m p7c
application/octet-stream deploy application/pkcs7-signature p7s
application/octet-stream dmg application/pkcs8 p8
application/octet-stream iso img application/pkix-attr-cert ac
application/octet-stream msi msp msm application/pkix-cert cer
application/pkix-crl crl
audio/midi mid midi kar application/pkix-pkipath pkipath
audio/mpeg mp3 application/pkixcmp pki
audio/x-realaudio ra application/pls+xml pls
audio/ogg ogg application/postscript ai eps ps
application/prs.cww cww
video/3gpp 3gpp 3gp application/pskc+xml pskcxml
video/m4v m4v application/rdf+xml rdf
video/mp4 mp4 application/reginfo+xml rif
video/mpeg mpeg mpg application/relax-ng-compact-syntax rnc
video/ogg ogg ogv application/resource-lists+xml rl
video/quicktime mov application/resource-lists-diff+xml rld
video/webm webm application/rls-services+xml rs
video/x-flv flv application/rpki-ghostbusters gbr
video/x-mng mng application/rpki-manifest mft
video/x-ms-asf asx asf application/rpki-roa roa
video/x-ms-wmv wmv application/rsd+xml rsd
video/x-msvideo avi application/rss+xml rss
application/rtf rtf
application/sbml+xml sbml
application/scvp-cv-request scq
application/scvp-cv-response scs
application/scvp-vp-request spq
application/scvp-vp-response spp
application/sdp sdp
application/set-payment-initiation setpay
application/set-registration-initiation setreg
application/shf+xml shf
application/smil+xml smi smil
application/sparql-query rq
application/sparql-results+xml srx
application/srgs gram
application/srgs+xml grxml
application/sru+xml sru
application/ssdl+xml ssdl
application/ssml+xml ssml
application/tei+xml tei teicorpus
application/thraud+xml tfi
application/timestamped-data tsd
application/vnd.3gpp.pic-bw-large plb
application/vnd.3gpp.pic-bw-small psb
application/vnd.3gpp.pic-bw-var pvb
application/vnd.3gpp2.tcap tcap
application/vnd.3m.post-it-notes pwn
application/vnd.accpac.simply.aso aso
application/vnd.accpac.simply.imp imp
application/vnd.acucobol acu
application/vnd.acucorp atc acutc
application/vnd.adobe.air-application-installer-package+zip air
application/vnd.adobe.formscentral.fcdt fcdt
application/vnd.adobe.fxp fxp fxpl
application/vnd.adobe.xdp+xml xdp
application/vnd.adobe.xfdf xfdf
application/vnd.ahead.space ahead
application/vnd.airzip.filesecure.azf azf
application/vnd.airzip.filesecure.azs azs
application/vnd.amazon.ebook azw
application/vnd.americandynamics.acc acc
application/vnd.amiga.ami ami
application/vnd.android.package-archive apk
application/vnd.anser-web-certificate-issue-initiation cii
application/vnd.anser-web-funds-transfer-initiation fti
application/vnd.antix.game-component atx
application/vnd.apple.installer+xml mpkg
application/vnd.apple.mpegurl m3u8
application/vnd.aristanetworks.swi swi
application/vnd.astraea-software.iota iota
application/vnd.audiograph aep
application/vnd.blueice.multipass mpm
application/vnd.bmi bmi
application/vnd.businessobjects rep
application/vnd.chemdraw+xml cdxml
application/vnd.chipnuts.karaoke-mmd mmd
application/vnd.cinderella cdy
application/vnd.claymore cla
application/vnd.cloanto.rp9 rp9
application/vnd.clonk.c4group c4g c4d c4f c4p c4u
application/vnd.cluetrust.cartomobile-config c11amc
application/vnd.cluetrust.cartomobile-config-pkg c11amz
application/vnd.commonspace csp
application/vnd.contact.cmsg cdbcmsg
application/vnd.cosmocaller cmc
application/vnd.crick.clicker clkx
application/vnd.crick.clicker.keyboard clkk
application/vnd.crick.clicker.palette clkp
application/vnd.crick.clicker.template clkt
application/vnd.crick.clicker.wordbank clkw
application/vnd.criticaltools.wbs+xml wbs
application/vnd.ctc-posml pml
application/vnd.cups-ppd ppd
application/vnd.curl.car car
application/vnd.curl.pcurl pcurl
application/vnd.dart dart
application/vnd.data-vision.rdz rdz
application/vnd.dece.data uvf uvvf uvd uvvd
application/vnd.dece.ttml+xml uvt uvvt
application/vnd.dece.unspecified uvx uvvx
application/vnd.dece.zip uvz uvvz
application/vnd.denovo.fcselayout-link fe_launch
application/vnd.dna dna
application/vnd.dolby.mlp mlp
application/vnd.dpgraph dpg
application/vnd.dreamfactory dfac
application/vnd.ds-keypoint kpxx
application/vnd.dvb.ait ait
application/vnd.dvb.service svc
application/vnd.dynageo geo
application/vnd.ecowin.chart mag
application/vnd.enliven nml
application/vnd.epson.esf esf
application/vnd.epson.msf msf
application/vnd.epson.quickanime qam
application/vnd.epson.salt slt
application/vnd.epson.ssf ssf
application/vnd.eszigno3+xml es3 et3
application/vnd.ezpix-album ez2
application/vnd.ezpix-package ez3
application/vnd.fdf fdf
application/vnd.fdsn.mseed mseed
application/vnd.fdsn.seed seed dataless
application/vnd.flographit gph
application/vnd.fluxtime.clip ftc
application/vnd.framemaker fm frame maker book
application/vnd.frogans.fnc fnc
application/vnd.frogans.ltf ltf
application/vnd.fsc.weblaunch fsc
application/vnd.fujitsu.oasys oas
application/vnd.fujitsu.oasys2 oa2
application/vnd.fujitsu.oasys3 oa3
application/vnd.fujitsu.oasysgp fg5
application/vnd.fujitsu.oasysprs bh2
application/vnd.fujixerox.ddd ddd
application/vnd.fujixerox.docuworks xdw
application/vnd.fujixerox.docuworks.binder xbd
application/vnd.fuzzysheet fzs
application/vnd.genomatix.tuxedo txd
application/vnd.geogebra.file ggb
application/vnd.geogebra.tool ggt
application/vnd.geometry-explorer gex gre
application/vnd.geonext gxt
application/vnd.geoplan g2w
application/vnd.geospace g3w
application/vnd.gmx gmx
application/vnd.google-earth.kml+xml kml
application/vnd.google-earth.kmz kmz
application/vnd.grafeq gqf gqs
application/vnd.groove-account gac
application/vnd.groove-help ghf
application/vnd.groove-identity-message gim
application/vnd.groove-injector grv
application/vnd.groove-tool-message gtm
application/vnd.groove-tool-template tpl
application/vnd.groove-vcard vcg
application/vnd.hal+xml hal
application/vnd.handheld-entertainment+xml zmm
application/vnd.hbci hbci
application/vnd.hhe.lesson-player les
application/vnd.hp-hpgl hpgl
application/vnd.hp-hpid hpid
application/vnd.hp-hps hps
application/vnd.hp-jlyt jlt
application/vnd.hp-pcl pcl
application/vnd.hp-pclxl pclxl
application/vnd.hydrostatix.sof-data sfd-hdstx
application/vnd.ibm.minipay mpy
application/vnd.ibm.modcap afp listafp list3820
application/vnd.ibm.rights-management irm
application/vnd.ibm.secure-container sc
application/vnd.iccprofile icc icm
application/vnd.igloader igl
application/vnd.immervision-ivp ivp
application/vnd.immervision-ivu ivu
application/vnd.insors.igm igm
application/vnd.intercon.formnet xpw xpx
application/vnd.intergeo i2g
application/vnd.intu.qbo qbo
application/vnd.intu.qfx qfx
application/vnd.ipunplugged.rcprofile rcprofile
application/vnd.irepository.package+xml irp
application/vnd.is-xpr xpr
application/vnd.isac.fcs fcs
application/vnd.jam jam
application/vnd.jcp.javame.midlet-rms rms
application/vnd.jisp jisp
application/vnd.joost.joda-archive joda
application/vnd.kahootz ktz ktr
application/vnd.kde.karbon karbon
application/vnd.kde.kchart chrt
application/vnd.kde.kformula kfo
application/vnd.kde.kivio flw
application/vnd.kde.kontour kon
application/vnd.kde.kpresenter kpr kpt
application/vnd.kde.kspread ksp
application/vnd.kde.kword kwd kwt
application/vnd.kenameaapp htke
application/vnd.kidspiration kia
application/vnd.kinar kne knp
application/vnd.koan skp skd skt skm
application/vnd.kodak-descriptor sse
application/vnd.las.las+xml lasxml
application/vnd.llamagraphics.life-balance.desktop lbd
application/vnd.llamagraphics.life-balance.exchange+xml lbe
application/vnd.lotus-1-2-3 123
application/vnd.lotus-approach apr
application/vnd.lotus-freelance pre
application/vnd.lotus-notes nsf
application/vnd.lotus-organizer org
application/vnd.lotus-screencam scm
application/vnd.lotus-wordpro lwp
application/vnd.macports.portpkg portpkg
application/vnd.mcd mcd
application/vnd.medcalcdata mc1
application/vnd.mediastation.cdkey cdkey
application/vnd.mfer mwf
application/vnd.mfmp mfm
application/vnd.micrografx.flo flo
application/vnd.micrografx.igx igx
application/vnd.mif mif
application/vnd.mobius.daf daf
application/vnd.mobius.dis dis
application/vnd.mobius.mbk mbk
application/vnd.mobius.mqy mqy
application/vnd.mobius.msl msl
application/vnd.mobius.plc plc
application/vnd.mobius.txf txf
application/vnd.mophun.application mpn
application/vnd.mophun.certificate mpc
application/vnd.mozilla.xul+xml xul
application/vnd.ms-artgalry cil
application/vnd.ms-cab-compressed cab
application/vnd.ms-excel xls xlm xla xlc xlt xlw
application/vnd.ms-excel.addin.macroenabled.12 xlam
application/vnd.ms-excel.sheet.binary.macroenabled.12 xlsb
application/vnd.ms-excel.sheet.macroenabled.12 xlsm
application/vnd.ms-excel.template.macroenabled.12 xltm
application/vnd.ms-fontobject eot
application/vnd.ms-htmlhelp chm
application/vnd.ms-ims ims
application/vnd.ms-lrm lrm
application/vnd.ms-officetheme thmx
application/vnd.ms-pki.seccat cat
application/vnd.ms-pki.stl stl
application/vnd.ms-powerpoint ppt pps pot
application/vnd.ms-powerpoint.addin.macroenabled.12 ppam
application/vnd.ms-powerpoint.presentation.macroenabled.12 pptm
application/vnd.ms-powerpoint.slide.macroenabled.12 sldm
application/vnd.ms-powerpoint.slideshow.macroenabled.12 ppsm
application/vnd.ms-powerpoint.template.macroenabled.12 potm
application/vnd.ms-project mpp mpt
application/vnd.ms-word.document.macroenabled.12 docm
application/vnd.ms-word.template.macroenabled.12 dotm
application/vnd.ms-works wps wks wcm wdb
application/vnd.ms-wpl wpl
application/vnd.ms-xpsdocument xps
application/vnd.mseq mseq
application/vnd.musician mus
application/vnd.muvee.style msty
application/vnd.mynfc taglet
application/vnd.neurolanguage.nlu nlu
application/vnd.nitf ntf nitf
application/vnd.noblenet-directory nnd
application/vnd.noblenet-sealer nns
application/vnd.noblenet-web nnw
application/vnd.nokia.n-gage.data ngdat
application/vnd.nokia.n-gage.symbian.install n-gage
application/vnd.nokia.radio-preset rpst
application/vnd.nokia.radio-presets rpss
application/vnd.novadigm.edm edm
application/vnd.novadigm.edx edx
application/vnd.novadigm.ext ext
application/vnd.oasis.opendocument.chart odc
application/vnd.oasis.opendocument.chart-template otc
application/vnd.oasis.opendocument.database odb
application/vnd.oasis.opendocument.formula odf
application/vnd.oasis.opendocument.formula-template odft
application/vnd.oasis.opendocument.graphics odg
application/vnd.oasis.opendocument.graphics-template otg
application/vnd.oasis.opendocument.image odi
application/vnd.oasis.opendocument.image-template oti
application/vnd.oasis.opendocument.presentation odp
application/vnd.oasis.opendocument.presentation-template otp
application/vnd.oasis.opendocument.spreadsheet ods
application/vnd.oasis.opendocument.spreadsheet-template ots
application/vnd.oasis.opendocument.text odt
application/vnd.oasis.opendocument.text-master odm
application/vnd.oasis.opendocument.text-template ott
application/vnd.oasis.opendocument.text-web oth
application/vnd.olpc-sugar xo
application/vnd.oma.dd2+xml dd2
application/vnd.openofficeorg.extension oxt
application/vnd.openxmlformats-officedocument.presentationml.presentation pptx
application/vnd.openxmlformats-officedocument.presentationml.slide sldx
application/vnd.openxmlformats-officedocument.presentationml.slideshow ppsx
application/vnd.openxmlformats-officedocument.presentationml.template potx
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet xlsx
application/vnd.openxmlformats-officedocument.spreadsheetml.template xltx
application/vnd.openxmlformats-officedocument.wordprocessingml.document docx
application/vnd.openxmlformats-officedocument.wordprocessingml.template dotx
application/vnd.osgeo.mapguide.package mgp
application/vnd.osgi.dp dp
application/vnd.osgi.subsystem esa
application/vnd.palm pdb pqa oprc
application/vnd.pawaafile paw
application/vnd.pg.format str
application/vnd.pg.osasli ei6
application/vnd.picsel efif
application/vnd.pmi.widget wg
application/vnd.pocketlearn plf
application/vnd.powerbuilder6 pbd
application/vnd.previewsystems.box box
application/vnd.proteus.magazine mgz
application/vnd.publishare-delta-tree qps
application/vnd.pvi.ptid1 ptid
application/vnd.quark.quarkxpress qxd qxt qwd qwt qxl qxb
application/vnd.realvnc.bed bed
application/vnd.recordare.musicxml mxl
application/vnd.recordare.musicxml+xml musicxml
application/vnd.rig.cryptonote cryptonote
application/vnd.rim.cod cod
application/vnd.rn-realmedia rm
application/vnd.rn-realmedia-vbr rmvb
application/vnd.route66.link66+xml link66
application/vnd.sailingtracker.track st
application/vnd.seemail see
application/vnd.sema sema
application/vnd.semd semd
application/vnd.semf semf
application/vnd.shana.informed.formdata ifm
application/vnd.shana.informed.formtemplate itp
application/vnd.shana.informed.interchange iif
application/vnd.shana.informed.package ipk
application/vnd.simtech-mindmapper twd twds
application/vnd.smaf mmf
application/vnd.smart.teacher teacher
application/vnd.solent.sdkm+xml sdkm sdkd
application/vnd.spotfire.dxp dxp
application/vnd.spotfire.sfs sfs
application/vnd.stardivision.calc sdc
application/vnd.stardivision.draw sda
application/vnd.stardivision.impress sdd
application/vnd.stardivision.math smf
application/vnd.stardivision.writer sdw vor
application/vnd.stardivision.writer-global sgl
application/vnd.stepmania.package smzip
application/vnd.stepmania.stepchart sm
application/vnd.sun.xml.calc sxc
application/vnd.sun.xml.calc.template stc
application/vnd.sun.xml.draw sxd
application/vnd.sun.xml.draw.template std
application/vnd.sun.xml.impress sxi
application/vnd.sun.xml.impress.template sti
application/vnd.sun.xml.math sxm
application/vnd.sun.xml.writer sxw
application/vnd.sun.xml.writer.global sxg
application/vnd.sun.xml.writer.template stw
application/vnd.sus-calendar sus susp
application/vnd.svd svd
application/vnd.symbian.install sis sisx
application/vnd.syncml+xml xsm
application/vnd.syncml.dm+wbxml bdm
application/vnd.syncml.dm+xml xdm
application/vnd.tao.intent-module-archive tao
application/vnd.tcpdump.pcap pcap cap dmp
application/vnd.tmobile-livetv tmo
application/vnd.trid.tpt tpt
application/vnd.triscape.mxs mxs
application/vnd.trueapp tra
application/vnd.ufdl ufd ufdl
application/vnd.uiq.theme utz
application/vnd.umajin umj
application/vnd.unity unityweb
application/vnd.uoml+xml uoml
application/vnd.vcx vcx
application/vnd.visio vsd vst vss vsw
application/vnd.visionary vis
application/vnd.vsf vsf
application/vnd.wap.wbxml wbxml
application/vnd.wap.wmlc wmlc
application/vnd.wap.wmlscriptc wmlsc
application/vnd.webturbo wtb
application/vnd.wolfram.player nbp
application/vnd.wordperfect wpd
application/vnd.wqd wqd
application/vnd.wt.stf stf
application/vnd.xara xar
application/vnd.xfdl xfdl
application/vnd.yamaha.hv-dic hvd
application/vnd.yamaha.hv-script hvs
application/vnd.yamaha.hv-voice hvp
application/vnd.yamaha.openscoreformat osf
application/vnd.yamaha.openscoreformat.osfpvg+xml osfpvg
application/vnd.yamaha.smaf-audio saf
application/vnd.yamaha.smaf-phrase spf
application/vnd.yellowriver-custom-menu cmp
application/vnd.zul zir zirz
application/vnd.zzazz.deck+xml zaz
application/voicexml+xml vxml
application/widget wgt
application/winhlp hlp
application/wsdl+xml wsdl
application/wspolicy+xml wspolicy
application/x-7z-compressed 7z
application/x-abiword abw
application/x-ace-compressed ace
application/x-authorware-bin aab x32 u32 vox
application/x-authorware-map aam
application/x-authorware-seg aas
application/x-bcpio bcpio
application/x-bittorrent torrent
application/x-blorb blb blorb
application/x-bzip bz
application/x-bzip2 bz2 boz
application/x-cbr cbr cba cbt cbz cb7
application/x-cdlink vcd
application/x-cfs-compressed cfs
application/x-chat chat
application/x-chess-pgn pgn
application/x-chrome-extension crx
application/x-cocoa cco
application/x-conference nsc
application/x-cpio cpio
application/x-csh csh
application/x-debian-package udeb
application/x-dgc-compressed dgc
application/x-director dir dcr dxr cst cct cxt w3d fgd swa
application/x-doom wad
application/x-dtbncx+xml ncx
application/x-dtbook+xml dtb
application/x-dtbresource+xml res
application/x-dvi dvi
application/x-envoy evy
application/x-eva eva
application/x-font-bdf bdf
application/x-font-ghostscript gsf
application/x-font-linux-psf psf
application/x-font-otf otf
application/x-font-pcf pcf
application/x-font-snf snf
application/x-font-ttf ttf ttc
application/x-font-type1 pfa pfb pfm afm
application/x-freearc arc
application/x-futuresplash spl
application/x-gca-compressed gca
application/x-glulx ulx
application/x-gnumeric gnumeric
application/x-gramps-xml gramps
application/x-gtar gtar
application/x-hdf hdf
application/x-httpd-php php
application/x-install-instructions install
application/x-java-archive-diff jardiff
application/x-java-jnlp-file jnlp
application/x-latex latex
application/x-lua-bytecode luac
application/x-lzh-compressed lzh lha
application/x-makeself run
application/x-mie mie
application/x-mobipocket-ebook prc mobi
application/x-ms-application application
application/x-ms-shortcut lnk
application/x-ms-wmd wmd
application/x-ms-wmz wmz
application/x-ms-xbap xbap
application/x-msaccess mdb
application/x-msbinder obd
application/x-mscardfile crd
application/x-msclip clp
application/x-msdownload com bat
application/x-msmediaview mvb m13 m14
application/x-msmetafile wmf emf emz
application/x-msmoney mny
application/x-mspublisher pub
application/x-msschedule scd
application/x-msterminal trm
application/x-mswrite wri
application/x-netcdf nc cdf
application/x-ns-proxy-autoconfig pac
application/x-nzb nzb
application/x-perl pl pm
application/x-pkcs12 p12 pfx
application/x-pkcs7-certificates p7b spc
application/x-pkcs7-certreqresp p7r
application/x-rar-compressed rar
application/x-redhat-package-manager rpm
application/x-research-info-systems ris
application/x-sea sea
application/x-sh sh
application/x-shar shar
application/x-shockwave-flash swf
application/x-silverlight-app xap
application/x-sql sql
application/x-stuffit sit
application/x-stuffitx sitx
application/x-subrip srt
application/x-sv4cpio sv4cpio
application/x-sv4crc sv4crc
application/x-t3vm-image t3
application/x-tads gam
application/x-tar tar
application/x-tcl tcl tk
application/x-tex tex
application/x-tex-tfm tfm
application/x-texinfo texinfo texi
application/x-tgif obj
application/x-ustar ustar
application/x-wais-source src
application/x-web-app-manifest+json webapp
application/x-x509-ca-cert der crt pem
application/x-xfig fig
application/x-xliff+xml xlf
application/x-xpinstall xpi
application/x-xz xz
application/x-zmachine z1 z2 z3 z4 z5 z6 z7 z8
application/xaml+xml xaml
application/xcap-diff+xml xdf
application/xenc+xml xenc
application/xhtml+xml xhtml xht
application/xml xml xsl xsd
application/xml-dtd dtd
application/xop+xml xop
application/xproc+xml xpl
application/xslt+xml xslt
application/xspf+xml xspf
application/xv+xml mxml xhvml xvml xvm
application/yang yang
application/yin+xml yin
application/zip zip
audio/adpcm adp
audio/basic au snd
audio/midi mid midi kar rmi
audio/mp4 mp4a m4a
audio/mpeg mpga mp2 mp2a mp3 m2a m3a
audio/ogg oga ogg spx
audio/s3m s3m
audio/silk sil
audio/vnd.dece.audio uva uvva
audio/vnd.digital-winds eol
audio/vnd.dra dra
audio/vnd.dts dts
audio/vnd.dts.hd dtshd
audio/vnd.lucent.voice lvp
audio/vnd.ms-playready.media.pya pya
audio/vnd.nuera.ecelp4800 ecelp4800
audio/vnd.nuera.ecelp7470 ecelp7470
audio/vnd.nuera.ecelp9600 ecelp9600
audio/vnd.rip rip
audio/wav wav
audio/webm weba
audio/x-aac aac
audio/x-aiff aif aiff aifc
audio/x-caf caf
audio/x-flac flac
audio/x-matroska mka
audio/x-mpegurl m3u
audio/x-ms-wax wax
audio/x-ms-wma wma
audio/x-pn-realaudio ram ra
audio/x-pn-realaudio-plugin rmp
audio/xm xm
chemical/x-cdx cdx
chemical/x-cif cif
chemical/x-cmdf cmdf
chemical/x-cml cml
chemical/x-csml csml
chemical/x-xyz xyz
image/bmp bmp
image/cgm cgm
image/g3fax g3
image/gif gif
image/ief ief
image/jpeg jpeg jpg jpe
image/ktx ktx
image/png png
image/prs.btif btif
image/sgi sgi
image/svg+xml svg svgz
image/tiff tiff tif
image/vnd.adobe.photoshop psd
image/vnd.dece.graphic uvi uvvi uvg uvvg
image/vnd.djvu djvu djv
image/vnd.dvb.subtitle sub
image/vnd.dwg dwg
image/vnd.dxf dxf
image/vnd.fastbidsheet fbs
image/vnd.fpx fpx
image/vnd.fst fst
image/vnd.fujixerox.edmics-mmr mmr
image/vnd.fujixerox.edmics-rlc rlc
image/vnd.ms-modi mdi
image/vnd.ms-photo wdp
image/vnd.net-fpx npx
image/vnd.wap.wbmp wbmp
image/vnd.xiff xif
image/webp webp
image/x-3ds 3ds
image/x-cmu-raster ras
image/x-cmx cmx
image/x-freehand fh fhc fh4 fh5 fh7
image/x-icon ico
image/x-jng jng
image/x-mrsid-image sid
image/x-pcx pcx
image/x-pict pic pct
image/x-portable-anymap pnm
image/x-portable-bitmap pbm
image/x-portable-graymap pgm
image/x-portable-pixmap ppm
image/x-rgb rgb
image/x-tga tga
image/x-xbitmap xbm
image/x-xpixmap xpm
image/x-xwindowdump xwd
message/rfc822 eml mime
model/iges igs iges
model/mesh msh mesh silo
model/vnd.collada+xml dae
model/vnd.dwf dwf
model/vnd.gdl gdl
model/vnd.gtw gtw
model/vnd.mts mts
model/vnd.vtu vtu
model/vrml wrl vrml
model/x3d+binary x3db x3dbz
model/x3d+vrml x3dv x3dvz
model/x3d+xml x3d x3dz
text/cache-manifest appcache manifest
text/calendar ics ifb
text/coffeescript coffee litcoffee
text/css css
text/csv csv
text/hjson hjson
text/html html htm shtml
text/jade jade
text/jsx jsx
text/less less
text/mathml mml
text/n3 n3
text/plain txt text conf def list log in ini
text/prs.lines.tag dsc
text/richtext rtx
text/sgml sgml sgm
text/stylus stylus styl
text/tab-separated-values tsv
text/troff t tr roff man me ms
text/turtle ttl
text/uri-list uri uris urls
text/vcard vcard
text/vnd.curl curl
text/vnd.curl.dcurl dcurl
text/vnd.curl.mcurl mcurl
text/vnd.curl.scurl scurl
text/vnd.fly fly
text/vnd.fmi.flexstor flx
text/vnd.graphviz gv
text/vnd.in3d.3dml 3dml
text/vnd.in3d.spot spot
text/vnd.sun.j2me.app-descriptor jad
text/vnd.wap.wml wml
text/vnd.wap.wmlscript wmls
text/vtt vtt
text/x-asm s asm
text/x-c c cc cxx cpp h hh dic
text/x-component htc
text/x-fortran f for f77 f90
text/x-handlebars-template hbs
text/x-java-source java
text/x-lua lua
text/x-markdown markdown md mkd
text/x-nfo nfo
text/x-opml opml
text/x-pascal p pas
text/x-processing pde
text/x-sass sass
text/x-scss scss
text/x-setext etx
text/x-sfv sfv
text/x-uuencode uu
text/x-vcalendar vcs
text/x-vcard vcf
text/yaml yaml yml
video/3gpp 3gp 3gpp
video/3gpp2 3g2
video/h261 h261
video/h263 h263
video/h264 h264
video/jpeg jpgv
video/jpm jpm jpgm
video/mj2 mj2 mjp2
video/mp2t ts
video/mp4 mp4 mp4v mpg4
video/mpeg mpeg mpg mpe m1v m2v
video/ogg ogv
video/quicktime qt mov
video/vnd.dece.hd uvh uvvh
video/vnd.dece.mobile uvm uvvm
video/vnd.dece.pd uvp uvvp
video/vnd.dece.sd uvs uvvs
video/vnd.dece.video uvv uvvv
video/vnd.dvb.file dvb
video/vnd.fvt fvt
video/vnd.mpegurl mxu m4u
video/vnd.ms-playready.media.pyv pyv
video/vnd.uvvu.mp4 uvu uvvu
video/vnd.vivo viv
video/webm webm
video/x-f4v f4v
video/x-fli fli
video/x-flv flv
video/x-m4v m4v
video/x-matroska mkv mk3d mks
video/x-mng mng
video/x-ms-asf asf asx
video/x-ms-vob vob
video/x-ms-wm wm
video/x-ms-wmv wmv
video/x-ms-wmx wmx
video/x-ms-wvx wvx
video/x-msvideo avi
video/x-sgi-movie movie
video/x-smv smv
x-conference/x-cooltalk ice

View File

@ -7,14 +7,27 @@ module Jekyll
attr_accessor :name, :ext, :basename attr_accessor :name, :ext, :basename
attr_accessor :data, :content, :output attr_accessor :data, :content, :output
alias_method :extname, :ext
FORWARD_SLASH = '/'.freeze
# Attributes for Liquid templates # Attributes for Liquid templates
ATTRIBUTES_FOR_LIQUID = %w[ ATTRIBUTES_FOR_LIQUID = %w(
content content
dir dir
name name
path path
url url
] )
# A set of extensions that are considered HTML or HTML-like so we
# should not alter them, this includes .xhtml through XHTM5.
HTML_EXTENSIONS = %W(
.html
.xhtml
.htm
)
# Initialize a new Page. # Initialize a new Page.
# #
@ -28,15 +41,14 @@ module Jekyll
@dir = dir @dir = dir
@name = name @name = name
process(name) process(name)
read_yaml(File.join(base, dir), name) read_yaml(File.join(base, dir), name)
data.default_proc = proc do |hash, key| data.default_proc = proc do |_, key|
site.frontmatter_defaults.find(File.join(dir, name), type, key) site.frontmatter_defaults.find(File.join(dir, name), type, key)
end end
Jekyll::Hooks.trigger self, :post_init Jekyll::Hooks.trigger :pages, :post_init, self
end end
# The generated directory into which the page will be placed # The generated directory into which the page will be placed
@ -45,7 +57,12 @@ module Jekyll
# #
# Returns the String destination directory. # Returns the String destination directory.
def dir def dir
url[-1, 1] == '/' ? url : File.dirname(url) if url.end_with?(FORWARD_SLASH)
url
else
url_dir = File.dirname(url)
url_dir.end_with?(FORWARD_SLASH) ? url_dir : "#{url_dir}/"
end
end end
# The full path and filename of the post. Defined in the YAML of the post # The full path and filename of the post. Defined in the YAML of the post
@ -53,8 +70,7 @@ module Jekyll
# #
# Returns the String permalink or nil if none has been set. # Returns the String permalink or nil if none has been set.
def permalink def permalink
return nil if data.nil? || data['permalink'].nil? data.nil? ? nil : data['permalink']
data['permalink']
end end
# The template of the permalink. # The template of the permalink.
@ -98,7 +114,7 @@ module Jekyll
# Returns nothing. # Returns nothing.
def process(name) def process(name)
self.ext = File.extname(name) self.ext = File.extname(name)
self.basename = name[0 .. -ext.length - 1] self.basename = name[0..-ext.length - 1]
end end
# Add any necessary layouts to this post # Add any necessary layouts to this post
@ -108,12 +124,10 @@ module Jekyll
# #
# Returns nothing. # Returns nothing.
def render(layouts, site_payload) def render(layouts, site_payload)
payload = Utils.deep_merge_hashes({ site_payload["page"] = to_liquid
"page" => to_liquid, site_payload["paginator"] = pager.to_liquid
'paginator' => pager.to_liquid
}, site_payload)
do_layout(payload, layouts) do_layout(site_payload, layouts)
end end
# The path to the source file # The path to the source file
@ -135,8 +149,8 @@ module Jekyll
# Returns the destination file path String. # Returns the destination file path String.
def destination(dest) def destination(dest)
path = site.in_dest_dir(dest, URL.unescape_path(url)) path = site.in_dest_dir(dest, URL.unescape_path(url))
path = File.join(path, "index.html") if url.end_with?("/") path = File.join(path, "index") if url.end_with?("/")
path << output_ext unless path.end_with?(output_ext) path << output_ext unless path.end_with? output_ext
path path
end end
@ -147,12 +161,20 @@ module Jekyll
# Returns the Boolean of whether this Page is HTML or not. # Returns the Boolean of whether this Page is HTML or not.
def html? def html?
output_ext == '.html' HTML_EXTENSIONS.include?(output_ext)
end end
# Returns the Boolean of whether this Page is an index file or not. # Returns the Boolean of whether this Page is an index file or not.
def index? def index?
basename == 'index' basename == 'index'
end end
def trigger_hooks(hook_name, *args)
Jekyll::Hooks.trigger :pages, hook_name, self, *args
end
def write?
true
end
end end
end end

View File

@ -1,20 +1,39 @@
module Jekyll module Jekyll
class Plugin class Plugin
PRIORITIES = { :lowest => -100, PRIORITIES = {
:low => -10, :low => -10,
:normal => 0, :highest => 100,
:high => 10, :lowest => -100,
:highest => 100 } :normal => 0,
:high => 10
}
# Fetch all the subclasses of this class and its subclasses' subclasses.
# #
# Returns an array of descendant classes.
def self.descendants def self.inherited(const)
descendants = [] return catch_inheritance(const) do |const_|
ObjectSpace.each_object(singleton_class) do |k| catch_inheritance(const_)
descendants.unshift k unless k == self
end end
descendants end
#
def self.catch_inheritance(const)
const.define_singleton_method :inherited do |const_|
(@children ||= Set.new).add const_
if block_given?
yield const_
end
end
end
#
def self.descendants
@children ||= Set.new
out = @children.map(&:descendants)
out << self unless superclass == Plugin
Set.new(out).flatten
end end
# Get or set the priority of this plugin. When called without an # Get or set the priority of this plugin. When called without an

View File

@ -24,12 +24,7 @@ module Jekyll
# #
# Returns nothing. # Returns nothing.
def require_gems def require_gems
site.gems.each do |gem| Jekyll::External.require_with_graceful_fail(site.gems.select { |gem| plugin_allowed?(gem) })
if plugin_allowed?(gem)
Jekyll.logger.debug("PluginManager:", "Requiring #{gem}")
require gem
end
end
end end
def self.require_from_bundler def self.require_from_bundler
@ -70,10 +65,9 @@ module Jekyll
# Returns nothing. # Returns nothing.
def require_plugin_files def require_plugin_files
unless site.safe unless site.safe
plugins_path.each do |plugins| plugins_path.each do |plugin_search_path|
Dir[File.join(plugins, "**", "*.rb")].sort.each do |f| plugin_files = Utils.safe_glob(plugin_search_path, File.join("**", "*.rb"))
require f Jekyll::External.require_with_graceful_fail(plugin_files)
end
end end
end end
end end
@ -82,21 +76,20 @@ module Jekyll
# #
# Returns an Array of plugin search paths # Returns an Array of plugin search paths
def plugins_path def plugins_path
if (site.config['plugins'] == Jekyll::Configuration::DEFAULTS['plugins']) if site.config['plugins_dir'] == Jekyll::Configuration::DEFAULTS['plugins_dir']
[site.in_source_dir(site.config['plugins'])] [site.in_source_dir(site.config['plugins_dir'])]
else else
Array(site.config['plugins']).map { |d| File.expand_path(d) } Array(site.config['plugins_dir']).map { |d| File.expand_path(d) }
end end
end end
def deprecation_checks def deprecation_checks
pagination_included = (site.config['gems'] || []).include?('jekyll-paginate') || defined?(Jekyll::Paginate) pagination_included = (site.config['gems'] || []).include?('jekyll-paginate') || defined?(Jekyll::Paginate)
if site.config['paginate'] && !pagination_included if site.config['paginate'] && !pagination_included
Jekyll::Deprecator.deprecation_message "You appear to have pagination " + Jekyll::Deprecator.deprecation_message "You appear to have pagination " \
"turned on, but you haven't included the `jekyll-paginate` gem. " + "turned on, but you haven't included the `jekyll-paginate` gem. " \
"Ensure you have `gems: [jekyll-paginate]` in your configuration file." "Ensure you have `gems: [jekyll-paginate]` in your configuration file."
end end
end end
end end
end end

View File

@ -1,331 +0,0 @@
module Jekyll
class Post
include Comparable
include Convertible
# Valid post name regex.
MATCHER = /^(.+\/)*(\d+-\d+-\d+)-(.*)(\.[^.]+)$/
EXCERPT_ATTRIBUTES_FOR_LIQUID = %w[
title
url
dir
date
id
categories
next
previous
tags
path
]
# Attributes for Liquid templates
ATTRIBUTES_FOR_LIQUID = EXCERPT_ATTRIBUTES_FOR_LIQUID + %w[
content
excerpt
excerpt_separator
draft?
]
# Post name validator. Post filenames must be like:
# 2008-11-05-my-awesome-post.textile
#
# Returns true if valid, false if not.
def self.valid?(name)
name =~ MATCHER
end
attr_accessor :site
attr_accessor :data, :extracted_excerpt, :content, :output, :ext
attr_accessor :date, :slug, :tags, :categories
attr_reader :name
# Initialize this Post instance.
#
# site - The Site.
# base - The String path to the dir containing the post file.
# name - The String filename of the post file.
#
# Returns the new Post.
def initialize(site, source, dir, name)
@site = site
@dir = dir
@base = containing_dir(dir)
@name = name
self.categories = dir.split('/').reject { |x| x.empty? }
process(name)
read_yaml(@base, name)
data.default_proc = proc do |hash, key|
site.frontmatter_defaults.find(relative_path, type, key)
end
if data.key?('date')
self.date = Utils.parse_date(data["date"].to_s, "Post '#{relative_path}' does not have a valid date in the YAML front matter.")
end
populate_categories
populate_tags
Jekyll::Hooks.trigger self, :post_init
end
def published?
if data.key?('published') && data['published'] == false
false
else
true
end
end
def populate_categories
categories_from_data = Utils.pluralized_array_from_hash(data, 'category', 'categories')
self.categories = (
Array(categories) + categories_from_data
).map { |c| c.to_s }.flatten.uniq
end
def populate_tags
self.tags = Utils.pluralized_array_from_hash(data, "tag", "tags").flatten
end
# Get the full path to the directory containing the post files
def containing_dir(dir)
site.in_source_dir(dir, '_posts')
end
# Read the YAML frontmatter.
#
# base - The String path to the dir containing the file.
# name - The String filename of the file.
#
# Returns nothing.
def read_yaml(base, name)
super(base, name)
self.extracted_excerpt = extract_excerpt
end
# The post excerpt. This is either a custom excerpt
# set in YAML front matter or the result of extract_excerpt.
#
# Returns excerpt string.
def excerpt
data.fetch('excerpt') { extracted_excerpt.to_s }
end
# Public: the Post title, from the YAML Front-Matter or from the slug
#
# Returns the post title
def title
data.fetch('title') { titleized_slug }
end
# Public: the Post excerpt_separator, from the YAML Front-Matter or site default
# excerpt_separator value
#
# Returns the post excerpt_separator
def excerpt_separator
(data['excerpt_separator'] || site.config['excerpt_separator']).to_s
end
# Turns the post slug into a suitable title
def titleized_slug
slug.split('-').select {|w| w.capitalize! || w }.join(' ')
end
# Public: the path to the post relative to the site source,
# from the YAML Front-Matter or from a combination of
# the directory it's in, "_posts", and the name of the
# post file
#
# Returns the path to the file relative to the site source
def path
data.fetch('path') { relative_path.sub(/\A\//, '') }
end
# The path to the post source file, relative to the site source
def relative_path
File.join(*[@dir, "_posts", @name].map(&:to_s).reject(&:empty?))
end
# Compares Post objects. First compares the Post date. If the dates are
# equal, it compares the Post slugs.
#
# other - The other Post we are comparing to.
#
# Returns -1, 0, 1
def <=>(other)
cmp = self.date <=> other.date
if 0 == cmp
cmp = self.slug <=> other.slug
end
return cmp
end
# Extract information from the post filename.
#
# name - The String filename of the post file.
#
# Returns nothing.
def process(name)
m, cats, date, slug, ext = *name.match(MATCHER)
self.date = Utils.parse_date(date, "Post '#{relative_path}' does not have a valid date in the filename.")
self.slug = slug
self.ext = ext
end
# The generated directory into which the post will be placed
# upon generation. This is derived from the permalink or, if
# permalink is absent, set to the default date
# e.g. "/2008/11/05/" if the permalink style is :date, otherwise nothing.
#
# Returns the String directory.
def dir
File.dirname(url)
end
# The full path and filename of the post. Defined in the YAML of the post
# body (optional).
#
# Returns the String permalink.
def permalink
data && data['permalink']
end
def template
case site.permalink_style
when :pretty
"/:categories/:year/:month/:day/:title/"
when :none
"/:categories/:title.html"
when :date
"/:categories/:year/:month/:day/:title.html"
when :ordinal
"/:categories/:year/:y_day/:title.html"
else
site.permalink_style.to_s
end
end
# The generated relative url of this post.
#
# Returns the String url.
def url
@url ||= URL.new({
:template => template,
:placeholders => url_placeholders,
:permalink => permalink
}).to_s
end
# Returns a hash of URL placeholder names (as symbols) mapping to the
# desired placeholder replacements. For details see "url.rb"
def url_placeholders
{
:year => date.strftime("%Y"),
:month => date.strftime("%m"),
:day => date.strftime("%d"),
:title => slug,
:i_day => date.strftime("%-d"),
:i_month => date.strftime("%-m"),
:categories => (categories || []).map { |c| c.to_s.downcase }.uniq.join('/'),
:short_month => date.strftime("%b"),
:short_year => date.strftime("%y"),
:y_day => date.strftime("%j"),
:output_ext => output_ext
}
end
# The UID for this post (useful in feeds).
# e.g. /2008/11/05/my-awesome-post
#
# Returns the String UID.
def id
File.join(dir, slug)
end
# Calculate related posts.
#
# Returns an Array of related Posts.
def related_posts(posts)
Jekyll::RelatedPosts.new(self).build
end
# Add any necessary layouts to this post.
#
# layouts - A Hash of {"name" => "layout"}.
# site_payload - The site payload hash.
#
# Returns nothing.
def render(layouts, site_payload)
# construct payload
payload = Utils.deep_merge_hashes({
"site" => { "related_posts" => related_posts(site_payload["site"]["posts"]) },
"page" => to_liquid(self.class::EXCERPT_ATTRIBUTES_FOR_LIQUID)
}, site_payload)
if generate_excerpt?
extracted_excerpt.do_layout(payload, {})
end
do_layout(payload.merge({"page" => to_liquid}), layouts)
end
# Obtain destination path.
#
# dest - The String path to the destination dir.
#
# Returns destination file path String.
def destination(dest)
# The url needs to be unescaped in order to preserve the correct filename
path = site.in_dest_dir(dest, URL.unescape_path(url))
path = File.join(path, "index.html") if self.url.end_with?("/")
path << output_ext unless path.end_with?(output_ext)
path
end
# Returns the shorthand String identifier of this Post.
def inspect
"<Post: #{id}>"
end
def next
pos = site.posts.index {|post| post.equal?(self) }
if pos && pos < site.posts.length - 1
site.posts[pos + 1]
else
nil
end
end
def previous
pos = site.posts.index {|post| post.equal?(self) }
if pos && pos > 0
site.posts[pos - 1]
else
nil
end
end
# Returns if this Post is a Draft
def draft?
is_a?(Jekyll::Draft)
end
protected
def extract_excerpt
if generate_excerpt?
Jekyll::Excerpt.new(self)
else
""
end
end
def generate_excerpt?
!excerpt_separator.empty?
end
end
end

View File

@ -8,14 +8,14 @@ module Jekyll
can_be_published?(thing) && !hidden_in_the_future?(thing) can_be_published?(thing) && !hidden_in_the_future?(thing)
end end
def hidden_in_the_future?(thing)
thing.respond_to?(:date) && !@site.future && thing.date.to_i > @site.time.to_i
end
private private
def can_be_published?(thing) def can_be_published?(thing)
thing.data.fetch('published', true) || @site.unpublished thing.data.fetch('published', true) || @site.unpublished
end end
def hidden_in_the_future?(thing)
thing.is_a?(Post) && !@site.future && thing.date > @site.time
end
end end
end end

View File

@ -16,18 +16,18 @@ module Jekyll
@site.layouts = LayoutReader.new(site).read @site.layouts = LayoutReader.new(site).read
read_directories read_directories
sort_files! sort_files!
@site.data = DataReader.new(site).read(site.config['data_source']) @site.data = DataReader.new(site).read(site.config['data_dir'])
CollectionReader.new(site).read CollectionReader.new(site).read
end end
# Sorts posts, pages, and static files. # Sorts posts, pages, and static files.
def sort_files! def sort_files!
site.posts.sort! site.collections.values.each { |c| c.docs.sort! }
site.pages.sort_by!(&:name) site.pages.sort_by!(&:name)
site.static_files.sort_by!(&:relative_path) site.static_files.sort_by!(&:relative_path)
end end
# Recursively traverse directories to find posts, pages and static files # Recursively traverse directories to find pages and static files
# that will become part of the site according to the rules in # that will become part of the site according to the rules in
# filter_entries. # filter_entries.
# #
@ -38,9 +38,9 @@ module Jekyll
base = site.in_source_dir(dir) base = site.in_source_dir(dir)
dot = Dir.chdir(base) { filter_entries(Dir.entries('.'), base) } dot = Dir.chdir(base) { filter_entries(Dir.entries('.'), base) }
dot_dirs = dot.select{ |file| File.directory?(@site.in_source_dir(base,file)) } dot_dirs = dot.select { |file| File.directory?(@site.in_source_dir(base, file)) }
dot_files = (dot - dot_dirs) dot_files = (dot - dot_dirs)
dot_pages = dot_files.select{ |file| Utils.has_yaml_header?(@site.in_source_dir(base,file)) } dot_pages = dot_files.select { |file| Utils.has_yaml_header?(@site.in_source_dir(base, file)) }
dot_static_files = dot_files - dot_pages dot_static_files = dot_files - dot_pages
retrieve_posts(dir) retrieve_posts(dir)
@ -56,8 +56,8 @@ module Jekyll
# #
# Returns nothing. # Returns nothing.
def retrieve_posts(dir) def retrieve_posts(dir)
site.posts.concat(PostReader.new(site).read(dir)) site.posts.docs.concat(PostReader.new(site).read_posts(dir))
site.posts.concat(DraftReader.new(site).read(dir)) if site.show_drafts site.posts.docs.concat(PostReader.new(site).read_drafts(dir)) if site.show_drafts
end end
# Recursively traverse directories with the read_directories function. # Recursively traverse directories with the read_directories function.
@ -67,12 +67,12 @@ module Jekyll
# dot_dirs - The Array of subdirectories in the dir. # dot_dirs - The Array of subdirectories in the dir.
# #
# Returns nothing. # Returns nothing.
def retrieve_dirs(base, dir, dot_dirs) def retrieve_dirs(_base, dir, dot_dirs)
dot_dirs.map { |file| dot_dirs.map do |file|
dir_path = site.in_source_dir(dir,file) dir_path = site.in_source_dir(dir, file)
rel_path = File.join(dir, file) rel_path = File.join(dir, file)
@site.reader.read_directories(rel_path) unless @site.dest.sub(/\/$/, '') == dir_path @site.reader.read_directories(rel_path) unless @site.dest.sub(/\/$/, '') == dir_path
} end
end end
# Retrieve all the pages from the current directory, # Retrieve all the pages from the current directory,

View File

@ -1,5 +1,7 @@
module Jekyll module Jekyll
class CollectionReader class CollectionReader
SPECIAL_COLLECTIONS = %w(posts data).freeze
attr_reader :site, :content attr_reader :site, :content
def initialize(site) def initialize(site)
@site = site @site = site
@ -11,9 +13,8 @@ module Jekyll
# Returns nothing. # Returns nothing.
def read def read
site.collections.each do |_, collection| site.collections.each do |_, collection|
collection.read unless collection.label.eql?('data') collection.read unless SPECIAL_COLLECTIONS.include?(collection.label)
end end
end end
end end
end end

View File

@ -50,13 +50,13 @@ module Jekyll
# Returns the contents of the data file. # Returns the contents of the data file.
def read_data_file(path) def read_data_file(path)
case File.extname(path).downcase case File.extname(path).downcase
when '.csv' when '.csv'
CSV.read(path, { CSV.read(path, {
:headers => true, :headers => true,
:encoding => site.config['encoding'] :encoding => site.config['encoding']
}).map(&:to_hash) }).map(&:to_hash)
else else
SafeYAML.load_file(path) SafeYAML.load_file(path)
end end
end end

View File

@ -1,37 +0,0 @@
module Jekyll
class DraftReader
attr_reader :site, :unfiltered_content
def initialize(site)
@site = site
@unfiltered_content = Array.new
end
# Read all the files in <source>/<dir>/_drafts and create a new Draft
# object with each one.
#
# dir - The String relative path of the directory to read.
#
# Returns nothing.
def read(dir)
@unfiltered_content = read_content(dir, '_drafts')
@unfiltered_content.select{ |draft| site.publisher.publish?(draft) }
end
# Read all the content files from <source>/<dir>/magic_dir
# and return them with the type klass.
#
# dir - The String relative path of the directory to read.
# magic_dir - The String relative directory to <dir>,
# looks for content here.
# klass - The return type of the content.
#
# Returns klass type of content files
def read_content(dir, magic_dir)
@site.reader.get_entries(dir, magic_dir).map do |entry|
Draft.new(site, site.source, dir, entry) if Draft.valid?(entry)
end.reject do |entry|
entry.nil?
end
end
end
end

View File

@ -38,11 +38,11 @@ module Jekyll
end end
def layout_directory_inside_source def layout_directory_inside_source
site.in_source_dir(site.config['layouts']) site.in_source_dir(site.config['layouts_dir'])
end end
def layout_directory_in_cwd def layout_directory_in_cwd
dir = Jekyll.sanitized_path(Dir.pwd, site.config['layouts']) dir = Jekyll.sanitized_path(Dir.pwd, site.config['layouts_dir'])
if File.directory?(dir) && !site.safe if File.directory?(dir) && !site.safe
dir dir
else else

View File

@ -4,7 +4,7 @@ module Jekyll
def initialize(site, dir) def initialize(site, dir)
@site = site @site = site
@dir = dir @dir = dir
@unfiltered_content = Array.new @unfiltered_content = []
end end
# Read all the files in <source>/<dir>/ for Yaml header and create a new Page # Read all the files in <source>/<dir>/ for Yaml header and create a new Page
@ -14,8 +14,8 @@ module Jekyll
# #
# Returns an array of static pages. # Returns an array of static pages.
def read(files) def read(files)
files.map{ |page| @unfiltered_content << Page.new(@site, @site.source, @dir, page) } files.map { |page| @unfiltered_content << Page.new(@site, @site.source, @dir, page) }
@unfiltered_content.select{ |page| site.publisher.publish?(page) } @unfiltered_content.select { |page| site.publisher.publish?(page) }
end end
end end
end end

View File

@ -3,18 +3,44 @@ module Jekyll
attr_reader :site, :unfiltered_content attr_reader :site, :unfiltered_content
def initialize(site) def initialize(site)
@site = site @site = site
@unfiltered_content = Array.new
end end
# Read all the files in <source>/<dir>/_posts and create a new Post # Read all the files in <source>/<dir>/_drafts and create a new
# Document object with each one.
#
# dir - The String relative path of the directory to read.
#
# Returns nothing.
def read_drafts(dir)
read_publishable(dir, '_drafts', Document::DATELESS_FILENAME_MATCHER)
end
# Read all the files in <source>/<dir>/_posts and create a new Document
# object with each one. # object with each one.
# #
# dir - The String relative path of the directory to read. # dir - The String relative path of the directory to read.
# #
# Returns nothing. # Returns nothing.
def read(dir) def read_posts(dir)
@unfiltered_content = read_content(dir, '_posts') read_publishable(dir, '_posts', Document::DATE_FILENAME_MATCHER)
@unfiltered_content.select{ |post| site.publisher.publish?(post) } end
# Read all the files in <source>/<dir>/<magic_dir> and create a new
# Document object with each one insofar as it matches the regexp matcher.
#
# dir - The String relative path of the directory to read.
#
# Returns nothing.
def read_publishable(dir, magic_dir, matcher)
read_content(dir, magic_dir, matcher).tap do |docs|
docs.each(&:read)
end.select do |doc|
site.publisher.publish?(doc).tap do |will_publish|
if !will_publish && site.publisher.hidden_in_the_future?(doc)
Jekyll.logger.debug "Skipping:", "#{doc.relative_path} has a future date"
end
end
end
end end
# Read all the content files from <source>/<dir>/magic_dir # Read all the content files from <source>/<dir>/magic_dir
@ -26,12 +52,15 @@ module Jekyll
# klass - The return type of the content. # klass - The return type of the content.
# #
# Returns klass type of content files # Returns klass type of content files
def read_content(dir, magic_dir) def read_content(dir, magic_dir, matcher)
@site.reader.get_entries(dir, magic_dir).map do |entry| @site.reader.get_entries(dir, magic_dir).map do |entry|
Post.new(site, site.source, dir, entry) if Post.valid?(entry) next unless entry =~ matcher
end.reject do |entry| path = @site.in_source_dir(File.join(dir, magic_dir, entry))
entry.nil? Document.new(path, {
end :site => @site,
:collection => @site.posts
})
end.reject(&:nil?)
end end
end end
end end

View File

@ -4,7 +4,7 @@ module Jekyll
def initialize(site, dir) def initialize(site, dir)
@site = site @site = site
@dir = dir @dir = dir
@unfiltered_content = Array.new @unfiltered_content = []
end end
# Read all the files in <source>/<dir>/ for Yaml header and create a new Page # Read all the files in <source>/<dir>/ for Yaml header and create a new Page
@ -14,7 +14,7 @@ module Jekyll
# #
# Returns an array of static files. # Returns an array of static files.
def read(files) def read(files)
files.map{ |file| @unfiltered_content << StaticFile.new(@site, @site.source, @dir, file)} files.map { |file| @unfiltered_content << StaticFile.new(@site, @site.source, @dir, file) }
@unfiltered_content @unfiltered_content
end end
end end

View File

@ -17,8 +17,8 @@ module Jekyll
# Returns a boolean. # Returns a boolean.
def regenerate?(document) def regenerate?(document)
case document case document
when Post, Page when Page
document.asset_file? || document.data['regenerate'] || document.asset_file? || document.data['regenerate'] ||
source_modified_or_dest_missing?( source_modified_or_dest_missing?(
site.in_source_dir(document.relative_path), document.destination(@site.dest) site.in_source_dir(document.relative_path), document.destination(@site.dest)
) )
@ -62,7 +62,6 @@ module Jekyll
clear_cache clear_cache
end end
# Clear just the cache # Clear just the cache
# #
# Returns nothing # Returns nothing
@ -70,13 +69,12 @@ module Jekyll
@cache = {} @cache = {}
end end
# Checks if the source has been modified or the # Checks if the source has been modified or the
# destination is missing # destination is missing
# #
# returns a boolean # returns a boolean
def source_modified_or_dest_missing?(source_path, dest_path) def source_modified_or_dest_missing?(source_path, dest_path)
modified?(source_path) || (dest_path and !File.exist?(dest_path)) modified?(source_path) || (dest_path && !File.exist?(dest_path))
end end
# Checks if a path's (or one of its dependencies) # Checks if a path's (or one of its dependencies)
@ -87,10 +85,10 @@ module Jekyll
return true if disabled? return true if disabled?
# objects that don't have a path are always regenerated # objects that don't have a path are always regenerated
return true if path.nil? return true if path.nil?
# Check for path in cache # Check for path in cache
if cache.has_key? path if cache.key? path
return cache[path] return cache[path]
end end
@ -117,9 +115,9 @@ module Jekyll
# #
# Returns nothing. # Returns nothing.
def add_dependency(path, dependency) def add_dependency(path, dependency)
return if (metadata[path].nil? || @disabled) return if metadata[path].nil? || @disabled
if !metadata[path]["deps"].include? dependency unless metadata[path]["deps"].include? dependency
metadata[path]["deps"] << dependency metadata[path]["deps"] << dependency
add(dependency) unless metadata.include?(dependency) add(dependency) unless metadata.include?(dependency)
end end
@ -130,8 +128,8 @@ module Jekyll
# #
# Returns nothing. # Returns nothing.
def write_metadata def write_metadata
File.open(metadata_file, 'wb') do |f| unless disabled?
f.write(Marshal.dump(metadata)) File.binwrite(metadata_file, Marshal.dump(metadata))
end end
end end
@ -146,7 +144,7 @@ module Jekyll
# #
# Returns a Boolean (true for disabled, false for enabled). # Returns a Boolean (true for disabled, false for enabled).
def disabled? def disabled?
@disabled = site.full_rebuild? if @disabled.nil? @disabled = !site.incremental? if @disabled.nil?
@disabled @disabled
end end
@ -157,20 +155,21 @@ module Jekyll
# #
# Returns the read metadata. # Returns the read metadata.
def read_metadata def read_metadata
@metadata = if !disabled? && File.file?(metadata_file) @metadata =
content = File.read(metadata_file) if !disabled? && File.file?(metadata_file)
content = File.binread(metadata_file)
begin begin
Marshal.load(content) Marshal.load(content)
rescue TypeError rescue TypeError
SafeYAML.load(content) SafeYAML.load(content)
rescue ArgumentError => e rescue ArgumentError => e
Jekyll.logger.warn("Failed to load #{metadata_file}: #{e}") Jekyll.logger.warn("Failed to load #{metadata_file}: #{e}")
{}
end
else
{} {}
end end
else
{}
end
end end
end end
end end

View File

@ -1,6 +1,5 @@
module Jekyll module Jekyll
class RelatedPosts class RelatedPosts
class << self class << self
attr_accessor :lsi attr_accessor :lsi
end end
@ -14,7 +13,7 @@ module Jekyll
end end
def build def build
return [] unless site.posts.size > 1 return [] unless site.posts.docs.size > 1
if site.lsi if site.lsi
build_index build_index
@ -24,13 +23,12 @@ module Jekyll
end end
end end
def build_index def build_index
self.class.lsi ||= begin self.class.lsi ||= begin
lsi = ClassifierReborn::LSI.new(:auto_rebuild => false) lsi = ClassifierReborn::LSI.new(:auto_rebuild => false)
display("Populating LSI...") display("Populating LSI...")
site.posts.each do |x| site.posts.docs.each do |x|
lsi.add_item(x) lsi.add_item(x)
end end
@ -46,7 +44,7 @@ module Jekyll
end end
def most_recent_posts def most_recent_posts
@most_recent_posts ||= (site.posts.reverse - [post]).first(10) @most_recent_posts ||= (site.posts.docs.reverse - [post]).first(10)
end end
def display(output) def display(output)

View File

@ -2,13 +2,12 @@
module Jekyll module Jekyll
class Renderer class Renderer
attr_reader :document, :site, :payload
attr_reader :document, :site, :site_payload
def initialize(site, document, site_payload = nil) def initialize(site, document, site_payload = nil)
@site = site @site = site
@document = document @document = document
@site_payload = site_payload @payload = site_payload || site.site_payload
end end
# Determine which converters to use based on this document's # Determine which converters to use based on this document's
@ -23,7 +22,7 @@ module Jekyll
# #
# Returns the output extname including the leading period. # Returns the output extname including the leading period.
def output_ext def output_ext
converters.first.output_ext(document.extname) @output_ext ||= (permalink_ext || converter_output_ext)
end end
###################### ######################
@ -31,31 +30,45 @@ module Jekyll
###################### ######################
def run def run
payload = Utils.deep_merge_hashes({ Jekyll.logger.debug "Rendering:", document.relative_path
"page" => document.to_liquid
}, site_payload || site.site_payload)
Jekyll::Hooks.trigger document, :pre_render, payload payload["page"] = document.to_liquid
info = { if document.respond_to? :pager
filters: [Jekyll::Filters], payload["paginator"] = document.pager.to_liquid
registers: { :site => site, :page => payload['page'] } end
}
if document.is_a?(Document) && document.collection.label == 'posts'
payload['site']['related_posts'] = document.related_posts
else
payload['site']['related_posts'] = nil
end
# render and transform content (this becomes the final content of the object) # render and transform content (this becomes the final content of the object)
payload["highlighter_prefix"] = converters.first.highlighter_prefix payload['highlighter_prefix'] = converters.first.highlighter_prefix
payload["highlighter_suffix"] = converters.first.highlighter_suffix payload['highlighter_suffix'] = converters.first.highlighter_suffix
Jekyll.logger.debug "Pre-Render Hooks:", document.relative_path
document.trigger_hooks(:pre_render, payload)
info = {
:filters => [Jekyll::Filters],
:registers => { :site => site, :page => payload['page'] }
}
output = document.content output = document.content
if document.render_with_liquid? if document.render_with_liquid?
Jekyll.logger.debug "Rendering Liquid:", document.relative_path
output = render_liquid(output, payload, info, document.path) output = render_liquid(output, payload, info, document.path)
end end
Jekyll.logger.debug "Rendering Markup:", document.relative_path
output = convert(output) output = convert(output)
document.content = output document.content = output
if document.place_in_layout? if document.place_in_layout?
Jekyll.logger.debug "Rendering Layout:", document.relative_path
place_in_layouts( place_in_layouts(
output, output,
payload, payload,
@ -125,20 +138,15 @@ module Jekyll
used = Set.new([layout]) used = Set.new([layout])
while layout while layout
payload = Utils.deep_merge_hashes( payload['content'] = output
payload, payload['page'] = document.to_liquid
{ payload['layout'] = Utils.deep_merge_hashes(payload['layout'] || {}, layout.data)
"content" => output,
"page" => document.to_liquid,
"layout" => layout.data
}
)
output = render_liquid( output = render_liquid(
layout.content, layout.content,
payload, payload,
info, info,
File.join(site.config['layouts'], layout.name) File.join(site.config['layouts_dir'], layout.name)
) )
# Add layout to dependency tree # Add layout to dependency tree
@ -159,5 +167,27 @@ module Jekyll
output output
end end
private
def permalink_ext
if document.permalink && !document.permalink.end_with?("/")
permalink_ext = File.extname(document.permalink)
permalink_ext unless permalink_ext.empty?
end
end
def converter_output_ext
if output_exts.size == 1
output_exts.last
else
output_exts[-2]
end
end
def output_exts
@output_exts ||= converters.map do |c|
c.output_ext(document.extname)
end.compact
end
end end
end end

View File

@ -4,7 +4,7 @@ require 'csv'
module Jekyll module Jekyll
class Site class Site
attr_reader :source, :dest, :config attr_reader :source, :dest, :config
attr_accessor :layouts, :posts, :pages, :static_files, :drafts, attr_accessor :layouts, :pages, :static_files, :drafts,
:exclude, :include, :lsi, :highlighter, :permalink_style, :exclude, :include, :lsi, :highlighter, :permalink_style,
:time, :future, :unpublished, :safe, :plugins, :limit_posts, :time, :future, :unpublished, :safe, :plugins, :limit_posts,
:show_drafts, :keep_files, :baseurl, :data, :file_read_opts, :show_drafts, :keep_files, :baseurl, :data, :file_read_opts,
@ -19,8 +19,8 @@ module Jekyll
def initialize(config) def initialize(config)
@config = config.clone @config = config.clone
%w[safe lsi highlighter baseurl exclude include future unpublished %w(safe lsi highlighter baseurl exclude include future unpublished
show_drafts limit_posts keep_files gems].each do |opt| show_drafts limit_posts keep_files gems).each do |opt|
self.send("#{opt}=", config[opt]) self.send("#{opt}=", config[opt])
end end
@ -74,7 +74,6 @@ module Jekyll
def reset def reset
self.time = (config['time'] ? Utils.parse_date(config['time'].to_s, "Invalid time in _config.yml.") : Time.now) self.time = (config['time'] ? Utils.parse_date(config['time'].to_s, "Invalid time in _config.yml.") : Time.now)
self.layouts = {} self.layouts = {}
self.posts = []
self.pages = [] self.pages = []
self.static_files = [] self.static_files = []
self.data = {} self.data = {}
@ -86,7 +85,7 @@ module Jekyll
raise ArgumentError, "limit_posts must be a non-negative number" raise ArgumentError, "limit_posts must be a non-negative number"
end end
Jekyll::Hooks.trigger self, :after_reset Jekyll::Hooks.trigger :site, :after_reset, self
end end
# Load necessary libraries, plugins, converters, and generators. # Load necessary libraries, plugins, converters, and generators.
@ -144,7 +143,7 @@ module Jekyll
def read def read
reader.read reader.read
limit_posts! limit_posts!
Jekyll::Hooks.trigger self, :post_read Jekyll::Hooks.trigger :site, :post_read, self
end end
# Run each of the Generators. # Run each of the Generators.
@ -164,22 +163,25 @@ module Jekyll
payload = site_payload payload = site_payload
Jekyll::Hooks.trigger self, :pre_render, payload Jekyll::Hooks.trigger :site, :pre_render, self, payload
collections.each do |label, collection| collections.each do |_, collection|
collection.docs.each do |document| collection.docs.each do |document|
if regenerator.regenerate?(document) if regenerator.regenerate?(document)
document.output = Jekyll::Renderer.new(self, document, payload).run document.output = Jekyll::Renderer.new(self, document, payload).run
Jekyll::Hooks.trigger document, :post_render document.trigger_hooks(:post_render)
end end
end end
end end
[posts, pages].flatten.each do |page_or_post| pages.flatten.each do |page|
if regenerator.regenerate?(page_or_post) if regenerator.regenerate?(page)
page_or_post.render(layouts, payload) page.output = Jekyll::Renderer.new(self, page, payload).run
page.trigger_hooks(:post_render)
end end
end end
Jekyll::Hooks.trigger :site, :post_render, self, payload
rescue Errno::ENOENT rescue Errno::ENOENT
# ignore missing layout dir # ignore missing layout dir
end end
@ -195,11 +197,15 @@ module Jekyll
# #
# Returns nothing. # Returns nothing.
def write def write
each_site_file { |item| each_site_file do |item|
item.write(dest) if regenerator.regenerate?(item) item.write(dest) if regenerator.regenerate?(item)
} end
regenerator.write_metadata regenerator.write_metadata
Jekyll::Hooks.trigger self, :post_write Jekyll::Hooks.trigger :site, :post_write, self
end
def posts
collections['posts'] ||= Collection.new(self, 'posts')
end end
# Construct a Hash of Posts indexed by the specified Post attribute. # Construct a Hash of Posts indexed by the specified Post attribute.
@ -219,7 +225,7 @@ module Jekyll
# Build a hash map based on the specified post attribute ( post attr => # Build a hash map based on the specified post attribute ( post attr =>
# array of posts ) then sort each array in reverse order. # array of posts ) then sort each array in reverse order.
hash = Hash.new { |h, key| h[key] = [] } hash = Hash.new { |h, key| h[key] = [] }
posts.each { |p| p.send(post_attr.to_sym).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.values.each { |posts| posts.sort!.reverse! }
hash hash
end end
@ -254,47 +260,25 @@ module Jekyll
# "tags" - The Hash of tag values and Posts. # "tags" - The Hash of tag values and Posts.
# See Site#post_attr_hash for type info. # See Site#post_attr_hash for type info.
def site_payload def site_payload
{ Drops::UnifiedPayloadDrop.new self
"jekyll" => {
"version" => Jekyll::VERSION,
"environment" => Jekyll.env
},
"site" => Utils.deep_merge_hashes(config,
Utils.deep_merge_hashes(Hash[collections.map{|label, coll| [label, coll.docs]}], {
"time" => time,
"posts" => posts.sort { |a, b| b <=> a },
"pages" => pages,
"static_files" => static_files,
"html_pages" => pages.select { |page| page.html? || page.url.end_with?("/") },
"categories" => post_attr_hash('categories'),
"tags" => post_attr_hash('tags'),
"collections" => collections.values.map(&:to_liquid),
"documents" => documents,
"data" => site_data
}))
}
end end
# Get the implementation class for the given Converter. # Get the implementation class for the given Converter.
#
# klass - The Class of the Converter to fetch.
#
# Returns the Converter instance implementing the given Converter. # Returns the Converter instance implementing the given Converter.
# klass - The Class of the Converter to fetch.
def find_converter_instance(klass) def find_converter_instance(klass)
converters.find { |c| c.class == klass } || proc { raise "No converter for #{klass}" }.call converters.find { |klass_| klass_.instance_of?(klass) } || \
raise("No Converters found for #{klass}")
end end
# klass - class or module containing the subclasses.
# Returns array of instances of subclasses of parameter.
# Create array of instances of the subclasses of the class or module # Create array of instances of the subclasses of the class or module
# passed in as argument. # passed in as argument.
#
# klass - class or module containing the subclasses which should be
# instantiated
#
# Returns array of instances of subclasses of parameter
def instantiate_subclasses(klass) def instantiate_subclasses(klass)
klass.descendants.select do |c| klass.descendants.select { |c| !safe || c.safe }.sort.map do |c|
!safe || c.safe
end.sort.map do |c|
c.new(config) c.new(config)
end end
end end
@ -305,10 +289,10 @@ module Jekyll
# Returns # Returns
def relative_permalinks_are_deprecated def relative_permalinks_are_deprecated
if config['relative_permalinks'] if config['relative_permalinks']
Jekyll.logger.abort_with "Since v3.0, permalinks for pages" + Jekyll.logger.abort_with "Since v3.0, permalinks for pages" \
" in subfolders must be relative to the" + " in subfolders must be relative to the" \
" site source directory, not the parent" + " site source directory, not the parent" \
" directory. Check http://jekyllrb.com/docs/upgrading/"+ " directory. Check http://jekyllrb.com/docs/upgrading/"\
" for more info." " for more info."
end end
end end
@ -330,7 +314,7 @@ module Jekyll
end end
def each_site_file def each_site_file
%w(posts pages static_files docs_to_write).each do |type| %w(pages static_files docs_to_write).each do |type|
send(type).each do |item| send(type).each do |item|
yield item yield item
end end
@ -348,8 +332,8 @@ module Jekyll
# Whether to perform a full rebuild without incremental regeneration # Whether to perform a full rebuild without incremental regeneration
# #
# Returns a Boolean: true for a full rebuild, false for normal build # Returns a Boolean: true for a full rebuild, false for normal build
def full_rebuild?(override = {}) def incremental?(override = {})
override['full_rebuild'] || config['full_rebuild'] override['incremental'] || config['incremental']
end end
# Returns the publisher or creates a new publisher if it doesn't # Returns the publisher or creates a new publisher if it doesn't
@ -391,8 +375,8 @@ module Jekyll
# Returns nothing # Returns nothing
def limit_posts! def limit_posts!
if limit_posts > 0 if limit_posts > 0
limit = posts.length < limit_posts ? posts.length : limit_posts limit = posts.docs.length < limit_posts ? posts.docs.length : limit_posts
self.posts = posts[-limit, limit] self.posts.docs = posts.docs[-limit, limit]
end end
end end

View File

@ -1,7 +1,7 @@
module Jekyll module Jekyll
class StaticFile class StaticFile
# The cache of last modification times [path] -> mtime. # The cache of last modification times [path] -> mtime.
@@mtimes = Hash.new @@mtimes = {}
attr_reader :relative_path, :extname attr_reader :relative_path, :extname
@ -75,7 +75,7 @@ module Jekyll
def write(dest) def write(dest)
dest_path = destination(dest) dest_path = destination(dest)
return false if File.exist?(dest_path) and !modified? return false if File.exist?(dest_path) && !modified?
@@mtimes[path] = mtime @@mtimes[path] = mtime
FileUtils.mkdir_p(File.dirname(dest_path)) FileUtils.mkdir_p(File.dirname(dest_path))
@ -90,7 +90,7 @@ module Jekyll
# #
# Returns nothing. # Returns nothing.
def self.reset_cache def self.reset_cache
@@mtimes = Hash.new @@mtimes = {}
nil nil
end end
@ -104,12 +104,12 @@ module Jekyll
def placeholders def placeholders
{ {
collection: @collection.label, :collection => @collection.label,
path: relative_path[ :path => relative_path[
@collection.relative_directory.size..relative_path.size], @collection.relative_directory.size..relative_path.size],
output_ext: '', :output_ext => '',
name: '', :name => '',
title: '', :title => ''
} }
end end
@ -118,13 +118,13 @@ module Jekyll
# be overriden in the collection's configuration in _config.yml. # be overriden in the collection's configuration in _config.yml.
def url def url
@url ||= if @collection.nil? @url ||= if @collection.nil?
relative_path relative_path
else else
::Jekyll::URL.new({ ::Jekyll::URL.new({
template: @collection.url_template, :template => @collection.url_template,
placeholders: placeholders, :placeholders => placeholders
}) })
end.to_s.gsub /\/$/, '' end.to_s.gsub(/\/$/, '')
end end
# Returns the type of the collection if present, nil otherwise. # Returns the type of the collection if present, nil otherwise.

View File

@ -5,7 +5,7 @@ module Jekyll
@level = DEBUG @level = DEBUG
@default_formatter = Formatter.new @default_formatter = Formatter.new
@logdev = $stdout @logdev = $stdout
@formatter = proc do |severity, datetime, progname, msg| @formatter = proc do |_, _, _, msg|
"#{msg}" "#{msg}"
end end
end end
@ -14,7 +14,7 @@ module Jekyll
severity ||= UNKNOWN severity ||= UNKNOWN
@logdev = set_logdevice(severity) @logdev = set_logdevice(severity)
if @logdev.nil? or severity < @level if @logdev.nil? || severity < @level
return true return true
end end
progname ||= @progname progname ||= @progname

Some files were not shown because too many files have changed in this diff Show More