brianjlandau-sdoc-helpers 0.1.2

data/README.md

@@ -0,0 +1,51 @@
+sdoc-helpers
+============
+
+Some Rake tasks and hacks to let me easily generate documentation like
+that found at <http://defunkt.github.com/mustache/>.
+
+After installing it, put this in your Rakefile:
+
+    begin
+      require 'sdoc_helpers'
+      Rake::SDocTask.new do |rdoc|
+        rdoc.title = "My Library Documentation"
+      end
+    rescue LoadError
+      puts "sdoc support not enabled. Please gem install sdoc-helpers."
+    end
+
+Now (with a clean index) run `rake pages:init` to create and publish
+your `gh-pages` branch.
+
+It'll drop you back on master when it's done. Now in the future just
+run `rake pages` to publish sdoc documentation to your `gh-pages`
+branch.
+
+Make sure you don't already have a `docs/` directory. If you do, this
+won't work.
+
+If you README (or any files) end in `md` or `markdown` they'll get
+parsed by `RDiscount` and displayed as Markdown. This gives you a
+nicely formatted README on GitHub as well as in your sdoc.
+
+Enjoy.
+
+
+Dependencies
+------------
+
+* rdiscount
+* sdoc
+
+
+Installation
+------------
+
+    gem install sdoc-helpers
+
+
+Author
+------
+
+Chris Wanstrath // chris@ozmm.org

data/Rakefile

@@ -0,0 +1,20 @@
+begin
+  require 'jeweler'
+
+  $LOAD_PATH.unshift File.dirname(__FILE__) + '/lib'
+  require 'sdoc_helpers/version'
+
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "brianjlandau-sdoc-helpers"
+    gemspec.summary = "Simple helpers to make using sdoc easier."
+    gemspec.description = "Simple helpers to make using sdoc easier."
+    gemspec.email = "chris@ozmm.org"
+    gemspec.homepage = "http://github.com/brianjlandau/sdoc-helpers"
+    gemspec.authors = ["Chris Wanstrath", "Brian Landau"]
+    gemspec.version = SDocHelpers::Version.to_s
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available."
+  puts "Install it with: gem install jeweler"
+end

data/lib/rake/sdoctask.rb

@@ -0,0 +1,23 @@
+require 'rake/rdoctask'
+
+module Rake
+  # Just a customized version of the normal RDoc task for generating SDocs.
+  class SDocTask < RDocTask
+    def initialize
+      @name = :rdoc
+      @rdoc_files = Rake::FileList.new
+      @rdoc_files.include('README*')
+      @rdoc_files.include('LICENSE*')
+      @rdoc_files.include('lib/**/*.rb')
+      @rdoc_dir = 'docs'
+      @main = Dir['README*'].first
+      @title = nil
+      @template = 'direct'
+      @external = false
+      @inline_source = true
+      @options = ['--fmt', 'shtml']
+      yield self if block_given?
+      define
+    end
+  end
+end

data/lib/sdoc_helpers.rb

@@ -0,0 +1,4 @@
+require 'sdoc'
+
+require 'sdoc_helpers/markdown'
+require 'sdoc_helpers/pages'

data/lib/sdoc_helpers/markdown.rb

@@ -0,0 +1,56 @@
+require 'digest/md5'
+
+module SDocHelpers
+  module MarkdownFiles
+    def description
+      return super unless full_name =~ /\.(md|markdown)$/
+      # assuming your path is ROOT/html or ROOT/doc
+      path = Dir.pwd + '/../' + full_name
+      Markdown.new(gfm(File.read(path))).to_html + open_links_in_new_window
+    end
+
+    def open_links_in_new_window
+      <<-html
+<script type="text/javascript">$(function() {
+  $('a').each(function() { $(this).attr('target', '_blank') })
+})</script>
+html
+    end
+    
+    private
+    
+    def gfm(text)
+      # Extract pre blocks
+      extractions = {}
+      text.gsub!(%r{<pre>.*?</pre>}m) do |match|
+        md5 = Digest::MD5.hexdigest(match)
+        extractions[md5] = match
+        "{gfm-extraction-#{md5}}"
+      end
+
+      # prevent foo_bar_baz from ending up with an italic word in the middle
+      text.gsub!(/(^(?! {4}|\t)\w+_\w+_\w[\w_]*)/) do |x|
+        x.gsub('_', '\_') if x.split('').sort.to_s[0..1] == '__'
+      end
+
+      # in very clear cases, let newlines become <br /> tags
+      text.gsub!(/(\A|^$\n)(^\w[^\n]*\n)(^\w[^\n]*$)+/m) do |x|
+        x.gsub(/^(.+)$/, "\\1  ")
+      end
+
+      # Insert pre block extractions
+      text.gsub!(/\{gfm-extraction-([0-9a-f]{32})\}/) do
+        extractions[$1]
+      end
+
+      text
+    end
+  end
+end
+
+begin
+  require 'rdiscount'
+  RDoc::TopLevel.send :include, SDocHelpers::MarkdownFiles
+rescue LoadError
+  puts "Markdown support not enabled. Please install RDiscount."
+end

data/lib/sdoc_helpers/pages.rb

@@ -0,0 +1,30 @@
+require 'rake/sdoctask'
+
+namespace :pages do
+  task :publish => [ :check_dirty, :rerdoc ] do
+    `git checkout gh-pages`
+    `ls -1 | grep -v docs | xargs rm -rf; mv docs/* .; rm -rf docs`
+    `git add .; git commit -m "update docs"; git push origin gh-pages`
+    `git checkout master`
+    puts :done
+  end
+
+  desc "Initialize GitHub Pages with documentation"
+  task :init => [ :check_dirty, :rerdoc ] do
+    `git symbolic-ref HEAD refs/heads/gh-pages`
+    `rm .git/index`
+    `ls -1 | grep -v docs | xargs rm -rf; mv docs/* .; rm -rf docs`
+    `git add .;git commit -m "create docs"; git push origin gh-pages`
+    `git checkout master`
+    puts :done
+  end
+
+  task :check_dirty do
+    if !`git status`.include?('nothing to commit')
+      abort "dirty index - not publishing!"
+    end
+  end
+end
+
+desc "Build and publish documentation using GitHub Pages."
+task :pages => "pages:publish"

data/lib/sdoc_helpers/version.rb

@@ -0,0 +1,3 @@
+module SDocHelpers
+  Version = '0.1.2'
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: brianjlandau-sdoc-helpers
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Chris Wanstrath
+- Brian Landau
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-24 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Simple helpers to make using sdoc easier.
+email: chris@ozmm.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- Rakefile
+- lib/rake/sdoctask.rb
+- lib/sdoc_helpers.rb
+- lib/sdoc_helpers/markdown.rb
+- lib/sdoc_helpers/pages.rb
+- lib/sdoc_helpers/version.rb
+has_rdoc: true
+homepage: http://github.com/brianjlandau/sdoc-helpers
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simple helpers to make using sdoc easier.
+test_files: []
+