docubot 0.0.1

data/bin/docubot

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'docubot'
+
+USAGE = <<ENDUSAGE
+Usage:
+   docubot [-t template_name] directory
+ENDUSAGE
+
+ARGS = { :template=>'default' }
+UNFLAGGED_ARGS = [ :directory ]
+next_arg = UNFLAGGED_ARGS.first
+ARGV.each{ |arg|
+	case arg
+		when '-h','--help'
+		  ARGS[:help] = true
+		when '-t','--template'
+			next_arg = :template
+		else
+		  if next_arg
+		    ARGS[next_arg] = arg
+		    UNFLAGGED_ARGS.delete( next_arg )
+		  end
+		  next_arg = UNFLAGGED_ARGS.first
+	end
+}
+
+if ARGS[:help] or !ARGS[:directory]
+   puts USAGE
+   #puts EXAMPLES if ARGS[:help]
+   exit
+end
+
+DocuBot.generate( ARGS[:directory], ARGS )
+

data/lib/docubot.rb

@@ -0,0 +1,14 @@
+module DocuBot
+	VERSION = '0.0.1'
+	DIR     = File.dirname( __FILE__ )
+	def self.name( file_path )
+		no_extension = File.basename( file_path ).sub( /\.[^.]+$/, '' )
+		no_ordering  = no_extension.sub( /^\d*\s/, '' )
+	end
+end
+require 'docubot/converter'
+require 'docubot/section'
+require 'docubot/page'
+require 'docubot/template'
+require 'docubot/snippet'
+require 'docubot/generator'

data/lib/docubot/converter.rb

@@ -0,0 +1,21 @@
+module DocuBot
+	module Converter
+		@@by_type = {}
+		def converts_for( *types )
+			types.each{ |type| @@by_type[type.to_s] = self }
+		end
+		def self.by_type
+			@@by_type
+		end
+	end
+
+	def self.convert_to_html( source, type )
+		converter = DocuBot::Converter.by_type[ type.to_s ]
+		raise "No converter found for type #{type}" unless converter
+		converter.new( source ).to_html
+	end
+end
+
+Dir[ File.join( DocuBot::DIR, 'docubot/converters/*.rb' ) ].each do |converter|
+	require converter
+end

data/lib/docubot/converters/markdown.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bluecloth'
+class BlueCloth
+	extend DocuBot::Converter
+	converts_for :md, :markdown
+end

data/lib/docubot/generator.rb

@@ -0,0 +1,35 @@
+module DocuBot
+	GENERATOR_DEFAULTS = {
+		:template => 'default'
+	}
+	def self.generate( directory, options={} )
+		options = GENERATOR_DEFAULTS.merge( options )
+		
+		if !File.exists?( directory )
+			raise "DocuBot cannot find directory #{File.expand_path(directory)}. Exiting."
+		end
+		
+		use_template( options[:template] )
+		
+		@toc = DocuBot::Section.new( 'Table of Contents' )
+		sections_by_path = {}
+		
+		Dir[ File.join( directory, '**/*' ) ].each do |item|
+			parent = sections_by_path[ File.dirname( item ) ] || @toc
+			if File.directory?( item )
+				section = DocuBot::Section.new( DocuBot.name( item ) )
+				sections_by_path[ item ] = section
+				parent << section
+			else
+				parent << DocuBot::Page.from_file( item )
+			end
+		end
+		
+		puts @toc
+
+		output = "#{directory}_html"
+		Dir.mkdir(output) unless File.exists?(output)
+		
+		# TODO: CHM the results
+	end
+end

data/lib/docubot/page.rb

@@ -0,0 +1,33 @@
+require 'yaml'
+class DocuBot::Page
+	META_SEPARATOR = /^\+\+\+$/ # Sort of like +++ATH0
+
+	attr_reader :html
+
+	def self.from_file( filename, title=nil, type=:md )
+		title ||= DocuBot.name( filename )
+		type  ||= File.extname( filename )[ 1..-1 ]
+		new( File.read(filename), title, type )
+	end
+
+	def initialize( source, title=nil, type=:md )
+		parts = source.split( META_SEPARATOR, 2 )
+		@meta = { 'title'=>title }
+		@meta.merge!( YAML.load( parts.first ) ) if parts.length > 1
+		@html = DocuBot::convert_to_html( parts.last, type )
+		@html = DocuBot::process_snippets( @html )
+	end
+
+	def method_missing( method, *args )
+		key=method.to_s
+		case key[-1..-1]
+			when '?' then @meta.has_key?( key[0..-2] )
+			when '!', '=' then super
+			else @meta[ key ]
+		end
+	end
+	
+	def to_s( depth=0 )
+		"#{'  '*depth}#{@meta['title']}"
+	end
+end

data/lib/docubot/section.rb

@@ -0,0 +1,16 @@
+class DocuBot::Section
+	attr_reader :entries, :title
+	def initialize( title )
+		@entries = []
+		@title   = title
+	end
+	def sub_sections
+		@entries.select{ |e| e.is_a?( DocuBot::Section ) }
+	end
+	def <<( entry )
+		@entries << entry
+	end
+	def to_s( depth=0 )
+		(["#{'  '*depth}#@title"] + @entries.map{ |e| e.to_s(depth+1) }).join("\n")
+	end
+end

data/lib/docubot/snippet.rb

@@ -0,0 +1,17 @@
+module DocuBot
+	@snippets = {}
+	
+	def self.handle_snippet( regexp, &handler )
+		@snippets[ regexp ] = handler
+	end
+	
+	def self.process_snippets( html )
+		@snippets.inject(html){ |html,regexp,handler| html.gsub( regexp, &handler ) }
+	end
+	
+	Dir[ File.join( DocuBot::DIR, 'docubot/snippets/*.rb' ) ].each do |snippet|
+		require snippet
+	end
+	
+end
+

data/lib/docubot/snippets/glossary.rb

@@ -0,0 +1,4 @@
+DocuBot.handle_snippet /\$\$(\w[\w ]*\w)\$\$/ do
+	# TODO: look up glossary terms
+	"<span class='glossary'>#{$1}</span>"
+end

data/lib/docubot/template.rb

@@ -0,0 +1,13 @@
+module DocuBot
+	TEMPLATE_DIR = File.expand_path( File.join( DocuBot::DIR, 'docubot/templates' ) )
+	Dir.chdir TEMPLATE_DIR do
+		@available_templates = Dir[ '*' ]
+	end
+	def self.use_template( template_name )
+		@template = template_name
+		unless @available_templates.include?( template_name )
+			warn "No template named '#{template_name}' exists in #{TEMPLATE_DIR}; using 'default' instead."
+			use 'default' unless template_name=='default'
+		end
+	end
+end

data/test/all.rb

@@ -0,0 +1,6 @@
+require 'docubot'
+# I'm too lazy to enter the syntax for directory with spaces
+# So just find the 3_more_crap.md file that has metadata.
+file = Dir['**/**'].grep( /3/ ).first
+x = DocuBot::Page.from_file( file )
+p x.title?, x.title, x.foo?, x.foo

data/test/site1/A Slight Change of Heart/1 Ze First Page in Ze Section.md

@@ -0,0 +1 @@
+The title of this should be "Ze First Page in Ze Section"

data/test/site1/A Slight Change of Heart/2 Another Page in the Section.md

@@ -0,0 +1 @@
+The title of this page should be "Another Page in the Section".

data/test/site1/A Slight Change of Heart/3_more_crap.md

@@ -0,0 +1,5 @@
+title  : Additional Helpful Information
+author : Gavin Kistner
+date   : 2010-1-4
++++
+The title of this page should be "Additional Helpful Information", not "More Crap".

data/test/site1/headers.md

@@ -0,0 +1,10 @@
+# I like Chicken, I like Liver
+MeowMix MeowMix, please deliver.
+
+## Delivery Options
+You could just put it in my bowl. Or you could:
+
+* Put it on a fancy plate.
+* Let me eat it out of your hand.
+* Just dump it all over the floor and let me lick up dust
+  at the same time as I scarf the food.

data/test/site1/raw.md

@@ -0,0 +1,3 @@
+This is a simple two paragraph page.
+
+This is the second paragraph.

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: docubot
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Gavin Kistner
+- Harold Hausman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-05 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bluecloth
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: haml
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Create CHM documentation from a simple hierarchy of text files.
+email: gavin@phrogz.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/docubot
+- lib/docubot/converter.rb
+- lib/docubot/converters/markdown.rb
+- lib/docubot/generator.rb
+- lib/docubot/page.rb
+- lib/docubot/section.rb
+- lib/docubot/snippet.rb
+- lib/docubot/snippets/glossary.rb
+- lib/docubot/template.rb
+- lib/docubot/templates/default/page.haml
+- lib/docubot/templates/default/section.haml
+- lib/docubot.rb
+- test/all.rb
+- test/site1/A Slight Change of Heart/1 Ze First Page in Ze Section.md
+- test/site1/A Slight Change of Heart/2 Another Page in the Section.md
+- test/site1/A Slight Change of Heart/3_more_crap.md
+- test/site1/headers.md
+- test/site1/raw.md
+has_rdoc: true
+homepage: http://github.com/Phrogz/docubot
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 
+- Windows with HTML Help Workshop installed.
+- BlueCloth gem for Markdown conversion.
+- Haml gem for template interpretation.
+rubyforge_project: docubot
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Create CHM documentation from a simple hierarchy of text files.
+test_files: 
+- test/all.rb