You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@buildr.apache.org by as...@apache.org on 2009/03/11 23:44:56 UTC
svn commit: r752672 - in /buildr/trunk/rakelib: doc.rake jekylltask.rb
Author: assaf
Date: Wed Mar 11 22:44:56 2009
New Revision: 752672
URL: http://svn.apache.org/viewvc?rev=752672&view=rev
Log:
Created JekyllTask that uses Jekyll to generate documentation and also supports auto generation (rake jekyll[auto])
Added:
buildr/trunk/rakelib/jekylltask.rb
Modified:
buildr/trunk/rakelib/doc.rake
Modified: buildr/trunk/rakelib/doc.rake
URL: http://svn.apache.org/viewvc/buildr/trunk/rakelib/doc.rake?rev=752672&r1=752671&r2=752672&view=diff
==============================================================================
--- buildr/trunk/rakelib/doc.rake (original)
+++ buildr/trunk/rakelib/doc.rake Wed Mar 11 22:44:56 2009
@@ -14,6 +14,8 @@
# the License.
+require 'rakelib/jekylltask'
+
begin # For the Web site, we use the mislav-hanna RDoc theme (http://github.com/mislav/hanna/)
require 'hanna/rdoctask'
rescue LoadError
@@ -24,7 +26,7 @@
desc 'Generate RDoc documentation'
-rdoc = Rake::RDocTask.new('rdoc') do |rdoc|
+Rake::RDocTask.new('rdoc') do |rdoc|
rdoc.rdoc_dir = 'rdoc'
rdoc.title = spec.name
rdoc.options = spec.rdoc_options.clone
@@ -33,36 +35,12 @@
end
-begin
- require 'jekyll'
-
- class Albino
- def execute(command)
- output = ''
- Open4.popen4(command) do |pid, stdin, stdout, stderr|
- stdin.puts @target
- stdin.close
- output = stdout.read.strip
- [stdout, stderr].each { |io| io.close }
- end
- output
- end
- end
-
- task '_site'=>['doc'] do
- Jekyll.pygments = true
- Jekyll.process 'doc', '_site'
- end
-
-rescue LoadError
- puts "Buildr uses the mojombo-jekyll to generate the Web site. You can install it by running rake setup"
- task 'setup' do
- install_gem 'mojombo-jekyll', :source=>'http://gems.github.com', :version=>'0.4.1'
- sh "#{sudo_needed? ? 'sudo ' : nil}easy_install Pygments"
- end
+JekyllTask.new 'jekyll' do |task|
+ task.source = 'doc'
+ task.target = '_site'
+ task.pygments = true
end
-
desc "Build a copy of the Web site in the ./_site"
task 'site'=>['_site', 'rdoc', 'spec', 'coverage'] do
cp_r 'rdoc', '_site'
@@ -70,6 +48,7 @@
cp '_reports/specs.html', '_site'
cp_r '_reports/coverage', '_site'
fail 'No coverage report in site directory' unless File.exist?('_site/coverage/index.html')
+ cp 'CHANGELOG', '_site'
puts 'OK'
end
Added: buildr/trunk/rakelib/jekylltask.rb
URL: http://svn.apache.org/viewvc/buildr/trunk/rakelib/jekylltask.rb?rev=752672&view=auto
==============================================================================
--- buildr/trunk/rakelib/jekylltask.rb (added)
+++ buildr/trunk/rakelib/jekylltask.rb Wed Mar 11 22:44:56 2009
@@ -0,0 +1,106 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership. The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+class JekyllTask < Rake::TaskLib
+ def initialize(name=:jekyll) # :yield: self
+ @name = name
+ @source = name
+ @target = name
+ yield self if block_given?
+ task name, :auto, :needs=>[@source] do |task, args|
+ if args.auto
+ auto_generate
+ else
+ generate
+ end
+ end
+ if @source != @target
+ file @target=>name
+ task 'clobber' do
+ rm_rf @target
+ end
+ end
+ end
+
+ attr_accessor :source
+ attr_accessor :target
+ attr_accessor :pygments
+
+ def generate
+ puts "Generating documentation in #{target}"
+ Jekyll.pygments = @pygments
+ Jekyll.process source, target
+ end
+
+ def auto_generate
+ require 'directory_watcher'
+ puts "Auto generating: just edit a page and save, watch the console to see when its done"
+ dw = DirectoryWatcher.new(source)
+ dw.interval = 1
+ dw.glob = Dir.chdir(source) do
+ dirs = Dir['*'].select { |x| File.directory?(x) }
+ dirs -= [target]
+ dirs = dirs.map { |x| "#{x}/**/*" }
+ dirs += ['*']
+ end
+ dw.start
+ dw.add_observer do |*args|
+ t = Time.now.strftime("%Y-%m-%d %H:%M:%S")
+ puts "[#{t}] regeneration: #{args.size} files changed"
+ Jekyll.pygments = @pygments
+ Jekyll.process source, target
+ puts "Done"
+ end
+ loop { sleep 1 }
+ end
+end
+
+
+begin
+ require 'jekyll'
+
+ # TODO: Worked around bug in Jekyll 0.4.1. Removed when 0.4.2 is out.
+ # http://github.com/mojombo/jekyll/commit/c180bc47bf2f63db1bff9f6600cccbe5ad69077e#diff-0
+ class Albino
+ def execute(command)
+ output = ''
+ Open4.popen4(command) do |pid, stdin, stdout, stderr|
+ stdin.puts @target
+ stdin.close
+ output = stdout.read.strip
+ [stdout, stderr].each { |io| io.close }
+ end
+ output
+ end
+ end
+
+ module TocFilter
+ def toc(input)
+ input.scan(/<(h2)(?:>|\s+(.*?)>)(.*?)<\/\1\s*>/mi).inject(%{<ol class="toc">}) { |toc, entry|
+ id = entry[1][/^id=(['"])(.*)\1$/, 2]
+ title = entry[2].gsub(/<(\w*).*?>(.*?)<\/\1\s*>/m, '\2').strip
+ toc << %{<li><a href="##{id}">#{title}</a></li>}
+ } << "</ol>"
+ end
+ end
+ Liquid::Template.register_filter(TocFilter)
+
+rescue LoadError
+ puts "Buildr uses the mojombo-jekyll to generate the Web site. You can install it by running rake setup"
+ task 'setup' do
+ install_gem 'mojombo-jekyll', :source=>'http://gems.github.com', :version=>'0.4.1'
+ sh "#{sudo_needed? ? 'sudo ' : nil}easy_install Pygments"
+ end
+end