2010-05-26 03:23:47 -04:00
require " rubygems "
2011-05-30 00:30:16 -04:00
require " bundler/setup "
2011-08-25 10:52:43 -04:00
require " stringex "
2010-05-26 03:23:47 -04:00
2011-06-22 12:29:23 -04:00
## -- Rsync Deploy config -- ##
# Be sure your public key is listed in your server's ~/.ssh/authorized_keys file
2011-08-25 16:58:02 -04:00
ssh_user = " user@domain.com "
document_root = " ~/website.com/ "
2011-06-29 14:01:06 -04:00
deploy_default = " rsync "
# This will be configured for you when you run config_deploy
deploy_branch = " gh-pages "
2011-06-22 12:29:23 -04:00
2011-08-16 01:49:49 -04:00
## -- Misc Configs -- ##
2011-06-22 12:29:23 -04:00
2011-08-16 01:49:49 -04:00
public_dir = " public " # compiled site directory
source_dir = " source " # source file directory
blog_index_dir = 'source' # directory for your blog's index page (if you put your index in source/blog/index.html, set this to 'source/blog')
deploy_dir = " _deploy " # deploy directory (for Github pages deployment)
stash_dir = " _stash " # directory to stash posts for speedy generation
posts_dir = " _posts " # directory for blog files
themes_dir = " .themes " # directory for blog files
new_post_ext = " markdown " # default new post file extension when using the new_post task
new_page_ext = " markdown " # default new page file extension when using the new_page task
server_port = " 4000 " # port for preview server eg. localhost:4000
2009-11-24 17:53:24 -05:00
2009-11-01 00:17:29 -04:00
2011-07-19 09:06:54 -04:00
desc " Initial setup for Octopress: copies the default theme into the path of Jekyll's generator. Rake install defaults to rake install[classic] to install a different theme run rake install[some_theme_name] "
2011-06-07 10:45:01 -04:00
task :install , :theme do | t , args |
2011-09-04 08:25:04 -04:00
if File . directory? ( source_dir ) || File . directory? ( " sass " )
abort ( " rake aborted! " ) if ask ( " A theme is already installed, proceeding will overwrite existing files. Are you sure? " , [ 'y' , 'n' ] ) == 'n'
end
2011-06-07 10:45:01 -04:00
# copy theme into working Jekyll directories
theme = args . theme || 'classic'
2011-07-19 09:06:54 -04:00
puts " # # Copying " + theme + " theme into ./ #{ source_dir } and ./sass "
2011-07-11 11:55:56 -04:00
mkdir_p source_dir
cp_r " #{ themes_dir } / #{ theme } /source/. " , source_dir
mkdir_p " sass "
cp_r " #{ themes_dir } / #{ theme } /sass/. " , " sass "
mkdir_p " #{ source_dir } / #{ posts_dir } "
mkdir_p public_dir
2011-06-07 10:45:01 -04:00
end
2011-06-11 07:56:04 -04:00
#######################
# Working with Jekyll #
#######################
2010-03-10 13:23:30 -05:00
2011-06-22 23:44:02 -04:00
desc " Generate jekyll site "
task :generate do
2011-08-25 10:36:57 -04:00
raise " # # # You haven't set anything up yet. First run `rake install` to set up an Octopress theme. " unless File . directory? ( source_dir )
2011-06-22 23:44:02 -04:00
puts " # # Generating Site with Jekyll "
system " jekyll "
end
2011-06-11 07:56:04 -04:00
desc " Watch the site and regenerate when it changes "
task :watch do
2011-08-25 10:36:57 -04:00
raise " # # # You haven't set anything up yet. First run `rake install` to set up an Octopress theme. " unless File . directory? ( source_dir )
2011-08-25 10:52:43 -04:00
puts " Starting to watch source with Jekyll and Compass. "
jekyllPid = spawn ( " jekyll --auto " )
compassPid = spawn ( " compass watch " )
trap ( " INT " ) {
Process . kill ( 9 , jekyllPid )
Process . kill ( 9 , compassPid )
exit 0
}
Process . wait
2009-11-25 09:34:32 -05:00
end
2011-06-11 07:56:04 -04:00
desc " preview the site in a web browser "
task :preview do
2011-08-25 10:36:57 -04:00
raise " # # # You haven't set anything up yet. First run `rake install` to set up an Octopress theme. " unless File . directory? ( source_dir )
2011-08-25 10:52:43 -04:00
puts " Starting to watch source with Jekyll and Compass. Starting Rack on port #{ server_port } "
jekyllPid = spawn ( " jekyll --auto " )
compassPid = spawn ( " compass watch " )
rackupPid = spawn ( " rackup --port #{ server_port } " )
trap ( " INT " ) {
Process . kill ( 9 , jekyllPid )
Process . kill ( 9 , compassPid )
Process . kill ( 9 , rackupPid )
exit 0
}
Process . wait
2009-11-05 22:30:03 -05:00
end
2011-07-19 16:09:42 -04:00
# usage rake new_post[my-new-post] or rake new_post['my new post'] or rake new_post (defaults to "new-post")
2011-06-27 22:47:40 -04:00
desc " Begin a new post in #{ source_dir } / #{ posts_dir } "
2011-07-19 16:09:42 -04:00
task :new_post , :title do | t , args |
2011-08-25 10:36:57 -04:00
raise " # # # You haven't set anything up yet. First run `rake install` to set up an Octopress theme. " unless File . directory? ( source_dir )
2011-07-16 14:27:16 -04:00
require './plugins/titlecase.rb'
2011-08-25 10:05:22 -04:00
mkdir_p " #{ source_dir } / #{ posts_dir } "
2011-07-19 16:09:42 -04:00
args . with_defaults ( :title = > 'new-post' )
title = args . title
2011-08-25 10:52:43 -04:00
filename = " #{ source_dir } / #{ posts_dir } / #{ Time . now . strftime ( '%Y-%m-%d' ) } - #{ title . to_url } . #{ new_post_ext } "
2011-09-03 09:06:36 -04:00
if File . exist? ( filename )
puts " # # # #{ filename } Already exists. Overwrite? y/n: "
response = $stdin . gets . chomp . downcase
next unless response == 'y'
end
2011-07-19 16:09:42 -04:00
puts " Creating new post: #{ filename } "
open ( filename , 'w' ) do | post |
2011-08-25 10:05:22 -04:00
system " mkdir -p #{ source_dir } / #{ posts_dir } / " ;
2009-12-07 11:55:13 -05:00
post . puts " --- "
2011-04-17 23:49:30 -04:00
post . puts " layout: post "
2011-07-19 16:18:40 -04:00
post . puts " title: \" #{ title . gsub ( / & / , '&' ) . titlecase } \" "
2011-07-19 16:09:42 -04:00
post . puts " date: #{ Time . now . strftime ( '%Y-%m-%d %H:%M' ) } "
post . puts " comments: true "
2011-07-19 09:06:54 -04:00
post . puts " categories: "
2009-12-07 11:55:13 -05:00
post . puts " --- "
end
end
2011-07-19 16:09:42 -04:00
# usage rake new_page[my-new-page] or rake new_page[my-new-page.html] or rake new_page (defaults to "new-page.markdown")
2011-07-26 19:10:16 -04:00
desc " Create a new page in #{ source_dir } /(filename)/index. #{ new_page_ext } "
2011-07-19 16:09:42 -04:00
task :new_page , :filename do | t , args |
2011-08-25 10:36:57 -04:00
raise " # # # You haven't set anything up yet. First run `rake install` to set up an Octopress theme. " unless File . directory? ( source_dir )
2011-07-19 16:09:42 -04:00
require './plugins/titlecase.rb'
args . with_defaults ( :filename = > 'new-page' )
page_dir = source_dir
2011-07-19 17:29:23 -04:00
if args . filename =~ / (^.+ \/ )?([ \ w_-]+)( \ .)?(.+)? /
2011-07-19 17:01:14 -04:00
page_dir += $4 ? " / #{ $1 } " : " / #{ $1 } #{ $2 } / "
name = $4 ? $2 : " index "
extension = $4 || " #{ new_page_ext } "
2011-07-19 16:09:42 -04:00
filename = " #{ name } . #{ extension } "
mkdir_p page_dir
file = page_dir + filename
2011-09-03 09:06:36 -04:00
if File . exist? ( file )
puts " # # # #{ file } Already exists. Overwrite? y/n: "
response = $stdin . gets . chomp . downcase
next unless response == 'y'
end
2011-07-19 16:09:42 -04:00
puts " Creating new page: #{ file } "
open ( file , 'w' ) do | page |
page . puts " --- "
page . puts " layout: page "
2011-07-19 17:01:14 -04:00
page . puts " title: \" #{ $2 . gsub ( / [-_] / , ' ' ) . titlecase } \" "
2011-07-19 16:09:42 -04:00
page . puts " date: #{ Time . now . strftime ( '%Y-%m-%d %H:%M' ) } "
page . puts " comments: true "
page . puts " sharing: true "
page . puts " footer: true "
page . puts " --- "
end
else
puts " Syntax error: #{ args . filename } contains unsupported characters "
end
end
2010-01-23 15:47:43 -05:00
# usage rake isolate[my-post]
desc " Move all other posts than the one currently being worked on to a temporary stash location (stash) so regenerating the site happens much quicker. "
task :isolate , :filename do | t , args |
2011-06-21 16:11:07 -04:00
stash_dir = " #{ source_dir } / #{ stash_dir } "
2010-01-23 15:47:43 -05:00
FileUtils . mkdir ( stash_dir ) unless File . exist? ( stash_dir )
2011-06-21 16:11:07 -04:00
Dir . glob ( " #{ source_dir } / #{ posts_dir } /*.* " ) do | post |
2010-01-23 15:47:43 -05:00
FileUtils . mv post , stash_dir unless post . include? ( args . filename )
end
end
desc " Move all stashed posts back into the posts directory, ready for site generation. "
task :integrate do
2011-06-21 16:11:07 -04:00
FileUtils . mv Dir . glob ( " #{ source_dir } / #{ stash_dir } /*.* " ) , " #{ source_dir } / #{ posts_dir } / "
2010-01-23 15:47:43 -05:00
end
2011-06-17 22:24:48 -04:00
desc " Clean out caches: _code_cache, _gist_cache, .sass-cache "
task :clean do
2011-08-25 10:52:43 -04:00
rm_rf [ " _code_cache/** " , " _gist_cache/** " , " .sass-cache/** " , " source/stylesheets/screen.css " ]
2011-06-17 22:24:48 -04:00
end
2011-07-19 22:18:34 -04:00
desc " Move sass to sass.old, install sass theme updates, replace sass/custom with sass.old/custom "
task :update_style , :theme do | t , args |
theme = args . theme || 'classic'
2011-07-27 18:22:57 -04:00
if File . directory? ( " sass.old " )
puts " removed existing sass.old directory "
2011-08-25 10:52:43 -04:00
rm_r " sass.old " , :secure = > true
2011-07-27 18:22:57 -04:00
end
2011-08-25 10:52:43 -04:00
mv " sass " , " sass.old "
2011-07-19 22:18:34 -04:00
puts " # # Moved styles into sass.old/ "
2011-08-25 10:52:43 -04:00
cp_r " #{ themes_dir } / " + theme + " /sass/ " , " sass "
2011-07-19 22:18:34 -04:00
cp_r " sass.old/custom/. " , " sass/custom "
puts " # # Updated Sass # # "
end
desc " Move source to source.old, install source theme updates, replace source/_includes/navigation.html with source.old's navigation "
task :update_source , :theme do | t , args |
theme = args . theme || 'classic'
2011-07-27 18:22:57 -04:00
if File . directory? ( " #{ source_dir } .old " )
2011-09-02 18:24:42 -04:00
puts " # # Removed existing #{ source_dir } .old directory "
2011-08-25 10:52:43 -04:00
rm_r " #{ source_dir } .old " , :secure = > true
2011-07-27 18:22:57 -04:00
end
2011-09-02 18:24:42 -04:00
cp_r " #{ source_dir } /. " , " #{ source_dir } .old "
puts " # # Copied #{ source_dir } into #{ source_dir } .old/ "
cp_r " #{ themes_dir } / " + theme + " /source/. " , source_dir , :remove_destination = > true
cp_r " #{ source_dir } .old/_includes/custom/. " , " #{ source_dir } /_includes/custom/ " , :remove_destination = > true
2011-08-25 10:52:43 -04:00
mv " #{ source_dir } /index.html " , " #{ blog_index_dir } " , :force = > true if blog_index_dir != source_dir
cp " #{ source_dir } .old/index.html " , source_dir if blog_index_dir != source_dir
2011-07-19 22:18:34 -04:00
puts " # # Updated #{ source_dir } # # "
end
2011-06-11 07:56:04 -04:00
##############
# Deploying #
##############
2011-06-29 14:01:06 -04:00
desc " Default deploy task "
2011-08-25 10:52:43 -04:00
multitask :deploy = > [ :copydot , " #{ deploy_default } " ] do
end
desc " copy dot files for deployment "
task :copydot do
2011-08-28 23:29:30 -04:00
exclusions = [ " . " , " .. " , " .DS_Store " ]
Dir [ " #{ source_dir } /.* " ] . each do | file |
if ! File . directory? ( file ) && ! exclusions . include? ( file )
cp ( file , " #{ public_dir } " ) ;
2011-08-25 10:52:43 -04:00
end
end
2011-06-29 14:01:06 -04:00
end
2011-06-11 07:56:04 -04:00
desc " Deploy website via rsync "
2011-06-29 14:01:06 -04:00
task :rsync do
2011-06-07 10:45:01 -04:00
puts " # # Deploying website via Rsync "
2011-06-21 16:11:07 -04:00
ok_failed system ( " rsync -avz --delete #{ public_dir } / #{ ssh_user } : #{ document_root } " )
2009-10-18 20:07:36 -04:00
end
2011-06-21 16:11:07 -04:00
desc " deploy public directory to github pages "
2011-08-25 10:52:43 -04:00
multitask :push do
2011-06-21 16:11:07 -04:00
puts " # # Deploying branch to Github Pages "
( Dir [ " #{ deploy_dir } /* " ] ) . each { | f | rm_rf ( f ) }
2011-07-26 14:32:15 -04:00
system " cp -R #{ public_dir } /* #{ deploy_dir } "
2011-06-21 16:11:07 -04:00
puts " \n # # copying #{ public_dir } to #{ deploy_dir } "
cd " #{ deploy_dir } " do
system " git add . "
system " git add -u "
puts " \n # # Commiting: Site updated at #{ Time . now . utc } "
message = " Site updated at #{ Time . now . utc } "
system " git commit -m ' #{ message } ' "
puts " \n # # Pushing generated #{ deploy_dir } website "
2011-06-29 14:01:06 -04:00
system " git push origin #{ deploy_branch } "
2011-06-21 16:11:07 -04:00
puts " \n # # Github Pages deploy complete "
end
2009-11-24 17:40:47 -05:00
end
2011-07-16 14:52:50 -04:00
desc " Update configurations to support publishing to root or sub directory "
task :set_root_dir , :dir do | t , args |
puts " >>> !! Please provide a directory, eg. rake config_dir[publishing/subdirectory] " unless args . dir
if args . dir
if args . dir == " / "
dir = " "
else
dir = " / " + args . dir . sub ( / ( \/ *)(.+) / , " \\ 2 " ) . sub ( / \/ $ / , '' ) ;
end
rakefile = IO . read ( __FILE__ )
rakefile . sub! ( / public_dir( \ s*)=( \ s*)(["'])[ \ w \ - \/ ]*["'] / , " public_dir \\ 1= \\ 2 \\ 3public #{ dir } \\ 3 " )
File . open ( __FILE__ , 'w' ) do | f |
f . write rakefile
end
compass_config = IO . read ( 'config.rb' )
compass_config . sub! ( / http_path( \ s*)=( \ s*)(["'])[ \ w \ - \/ ]*["'] / , " http_path \\ 1= \\ 2 \\ 3 #{ dir } / \\ 3 " )
compass_config . sub! ( / http_images_path( \ s*)=( \ s*)(["'])[ \ w \ - \/ ]*["'] / , " http_images_path \\ 1= \\ 2 \\ 3 #{ dir } /images \\ 3 " )
compass_config . sub! ( / http_fonts_path( \ s*)=( \ s*)(["'])[ \ w \ - \/ ]*["'] / , " http_fonts_path \\ 1= \\ 2 \\ 3 #{ dir } /fonts \\ 3 " )
compass_config . sub! ( / css_dir( \ s*)=( \ s*)(["'])[ \ w \ - \/ ]*["'] / , " css_dir \\ 1= \\ 2 \\ 3public #{ dir } /stylesheets \\ 3 " )
File . open ( 'config.rb' , 'w' ) do | f |
f . write compass_config
end
jekyll_config = IO . read ( '_config.yml' )
jekyll_config . sub! ( / ^destination:.+$ / , " destination: public #{ dir } " )
2011-07-22 00:03:11 -04:00
jekyll_config . sub! ( / ^subscribe_rss: \ s* \/ .+$ / , " subscribe_rss: #{ dir } /atom.xml " )
jekyll_config . sub! ( / ^root:.*$ / , " root: / #{ dir . sub ( / ^ \/ / , '' ) } " )
2011-07-16 14:52:50 -04:00
File . open ( '_config.yml' , 'w' ) do | f |
f . write jekyll_config
end
2011-07-22 00:03:11 -04:00
rm_rf public_dir
mkdir_p " #{ public_dir } #{ dir } "
puts " # # Site's root directory is now '/ #{ dir . sub ( / ^ \/ / , '' ) } ' # # "
2011-07-16 14:52:50 -04:00
end
end
desc " Setup _deploy folder and deploy branch "
2011-06-29 14:01:06 -04:00
task :config_deploy , :branch do | t , args |
2011-06-27 22:47:40 -04:00
puts " !! Please provide a deploy branch, eg. rake init_deploy[gh-pages] !! " unless args . branch
puts " # # Creating a clean #{ args . branch } branch in ./ #{ deploy_dir } for Github pages deployment "
2011-06-27 18:17:15 -04:00
cd " #{ deploy_dir } " do
2011-06-22 23:44:02 -04:00
system " git symbolic-ref HEAD refs/heads/ #{ args . branch } "
system " rm .git/index "
system " git clean -fdx "
2011-06-27 22:47:40 -04:00
system " echo 'My Octopress Page is coming soon …' > index.html "
2011-06-22 23:44:02 -04:00
system " git add . "
2011-06-29 14:01:06 -04:00
system " git commit -m 'Octopress init' "
rakefile = IO . read ( __FILE__ )
rakefile . sub! ( / deploy_branch( \ s*)=( \ s*)(["'])[ \ w-]*["'] / , " deploy_branch \\ 1= \\ 2 \\ 3 #{ args . branch } \\ 3 " )
rakefile . sub! ( / deploy_default( \ s*)=( \ s*)(["'])[ \ w-]*["'] / , " deploy_default \\ 1= \\ 2 \\ 3push \\ 3 " )
File . open ( __FILE__ , 'w' ) do | f |
f . write rakefile
end
2011-06-22 23:44:02 -04:00
end
2011-07-11 11:17:15 -04:00
puts " # # Deployment configured. Now you can deploy to the #{ args . branch } branch with `rake deploy` # # "
2011-06-22 23:44:02 -04:00
end
2009-10-18 20:07:36 -04:00
2011-06-22 23:44:02 -04:00
def ok_failed ( condition )
if ( condition )
puts " OK "
else
puts " FAILED "
end
end
2009-10-18 20:07:36 -04:00
2011-09-04 08:25:04 -04:00
def get_stdin ( message )
print message
STDIN . gets . chomp
end
def ask ( message , valid_options )
if valid_options
answer = get_stdin ( " #{ message } #{ valid_options . to_s . gsub ( / " / , '' ) . gsub ( / , / , '/' ) } " ) while ! valid_options . include? ( answer )
else
answer = get_stdin ( message )
end
answer
end
2011-06-11 07:56:04 -04:00
desc " list tasks "
task :list do
2011-08-11 08:13:30 -04:00
puts " Tasks: #{ ( Rake :: Task . tasks - [ Rake :: Task [ :list ] ] ) . join ( ', ' ) } "
2011-06-11 07:56:04 -04:00
puts " (type rake -T for more detail) \n \n "
2010-08-03 01:10:59 -04:00
end