sdoc 0.2.12.1

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2009 Vladimir Kolesnikov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.rdoc

@@ -0,0 +1,38 @@
+= SDoc
+== What's in?
+- shtml - RDoc's generator to build searchable documentation
+- <tt>sdoc-merge</tt> - comand line tool to build merge multiple sdoc documentations
+  packages into a single one
+- <tt>sdoc</tt> - command line tool to run rdoc with generator=shtml
+
+== Getting Started
+    gem sources -a http://gems.github.com
+    sudo gem install voloko-sdoc
+    sdoc -N projectdir
+
+== Command line sdoc
+sdoc is simply a wrapper to rdoc command line tool. see <tt>sdoc --help </tt>
+for more details. <tt>--fmt</tt> is set to shtml by default. 
+Default template <tt>-T</tt> is shtml. You can also use 'direct' template.
+Example:
+<tt>sdoc -o doc/rails -T direct rails</tt>
+
+== Rake
+    # Rakefile
+    require 'sdoc' # and use your RDoc task the same way you used it before
+
+    Rake::RDocTask.new do |rdoc|
+      rdoc.rdoc_dir = 'doc/rdoc'
+      rdoc.options << '--fmt' << 'shtml' # explictly set shtml generator
+      rdoc.template = 'direct' # lighter template used on railsapi.com
+      ...
+    end
+
+== sdoc-merge
+    Usage: sdoc-merge [options] directories
+        -n, --names [NAMES]              Names of merged repositories. Comma separated
+        -o, --op [DIRECTORY]             Set the output directory
+        -t, --title [TITLE]              Set the title of merged file
+
+Example:
+<tt>sdoc-merge --title "Ruby v1.9, Rails v2.3.2.1" --op merged --names "Ruby,Rails" ruby-v1.9 rails-v2.3.2.1</tt>

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rake/testtask'
+require 'rake/gempackagetask'
+
+task :default => :test
+
+Rake::TestTask.new("test") do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.warning = true
+  t.verbose = true
+end
+
+desc "Generate file list for .gemspec"
+task :gem_file_list do
+  f = FileList.new
+  f.include('lib/**/**')
+  f.include('rdoc/**/**')
+  f.exclude('rdoc/test/**/**')
+  print "%w(" + f.to_a.select{|file| !File.directory? file }.join(' ') + ")\n"
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sdoc"
+    gem.summary = "rdoc html with javascript search index."
+    gem.email = "voloko@gmail.com"
+    gem.homepage = "http://github.com/voloko/sdoc"
+    gem.authors = ["Volodya Kolesnikov"]
+    gem.add_dependency("json", ">= 1.1.3")
+    gem.add_dependency("rdoc", ">= 2.4.2")
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 2
+:patch: 12
+:major: 0

data/bin/sdoc

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby -KU
+
+require File.dirname(__FILE__) + '/../lib/sdoc' # add extensions
+
+begin
+  r = RDoc::RDoc.new
+  r.document(ARGV)
+rescue RDoc::RDocError => e
+  $stderr.puts e.message
+  exit(1)
+end

data/bin/sdoc-merge

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby -KU
+
+require File.dirname(__FILE__) + '/../lib/sdoc' # add extensions
+require 'sdoc/merge'
+
+begin
+  m = SDoc::Merge.new
+  m.merge(ARGV)
+rescue RDoc::RDocError => e
+  $stderr.puts e.message
+  exit(1)
+end

data/lib/rdoc/discover.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), '/../sdoc')

data/lib/sdoc.rb

@@ -0,0 +1,23 @@
+$:.unshift File.dirname(__FILE__)
+require "rubygems"
+gem "rdoc", ">= 2.4.2"
+
+require "rdoc/rdoc"
+
+module SDoc
+end
+
+require "sdoc/generator/shtml"
+require "sdoc/c_parser_fix"
+
+unless defined? SDOC_FIXED_RDOC_OPTIONS
+  SDOC_FIXED_RDOC_OPTIONS = 1
+  class RDoc::Options
+    alias_method :rdoc_initialize, :initialize
+  
+    def initialize
+      rdoc_initialize
+      @generator = RDoc::Generator::SHtml
+    end
+  end
+end

data/lib/sdoc/c_parser_fix.rb

@@ -0,0 +1,31 @@
+require "rdoc/parser/c"
+
+# New RDoc somehow misses class comemnts.
+# copyied this function from "2.2.2" 
+if ['2.4.2', '2.4.3'].include? RDoc::VERSION
+
+  class RDoc::Parser::C
+    def find_class_comment(class_name, class_meth)
+      comment = nil
+      if @content =~ %r{((?>/\*.*?\*/\s+))
+                     (static\s+)?void\s+Init_#{class_name}\s*(?:_\(\s*)?\(\s*(?:void\s*)\)}xmi then
+        comment = $1
+      elsif @content =~ %r{Document-(?:class|module):\s#{class_name}\s*?(?:<\s+[:,\w]+)?\n((?>.*?\*/))}m
+        comment = $1
+      else
+        if @content =~ /rb_define_(class|module)/m then
+          class_name = class_name.split("::").last
+          comments = []
+          @content.split(/(\/\*.*?\*\/)\s*?\n/m).each_with_index do |chunk, index|
+            comments[index] = chunk
+            if chunk =~ /rb_define_(class|module).*?"(#{class_name})"/m then
+              comment = comments[index-1]
+              break
+            end
+          end
+        end
+      end
+      class_meth.comment = mangle_comment(comment) if comment
+    end
+  end
+end

data/lib/sdoc/generator/shtml.rb

@@ -0,0 +1,314 @@
+require 'rubygems'
+gem "rdoc", ">= 2.4.2"
+if Gem.available? "json" 
+  gem "json", ">= 1.1.3"
+else
+  gem "json_pure", ">= 1.1.3"
+end
+
+require 'iconv'
+require 'json'
+require 'pathname'
+require 'fileutils'
+require 'erb'
+
+require 'rdoc/rdoc'
+require 'rdoc/generator'
+require 'rdoc/generator/markup'
+
+require 'sdoc/github'
+require 'sdoc/templatable'
+require 'sdoc/helpers'
+
+class RDoc::ClassModule
+  def document_self_or_methods
+    document_self || method_list.any?{ |m| m.document_self }
+  end
+  
+  def with_documentation?
+    document_self_or_methods || classes_and_modules.any?{ |c| c.with_documentation? }
+  end
+end
+
+class RDoc::Generator::SHtml
+  RDoc::RDoc.add_generator( self )
+  include ERB::Util
+  include SDoc::GitHub
+  include SDoc::Templatable
+  include SDoc::Helpers
+  
+  GENERATOR_DIRS = [File.join('sdoc', 'generator'), File.join('rdoc', 'generator')]
+  
+  # Used in js to reduce index sizes
+  TYPE_CLASS  = 1
+  TYPE_METHOD = 2
+  TYPE_FILE   = 3
+  
+  TREE_FILE = File.join 'panel', 'tree.js'
+  SEARCH_INDEX_FILE = File.join 'panel', 'search_index.js'
+  
+  FILE_DIR = 'files'
+  CLASS_DIR = 'classes'
+  
+  RESOURCES_DIR = File.join('resources', '.')
+  
+  attr_reader :basedir
+  
+  def self.for(options)
+    self.new(options)
+  end
+  
+  def self.template_dir template
+		$LOAD_PATH.map do |path|
+		  GENERATOR_DIRS.map do |dir|
+  			File.join path, dir, 'template', template
+	    end
+		end.flatten.find do |dir|
+			File.directory? dir
+		end
+  end
+  
+  def initialize(options)
+		@options = options
+		@options.diagram = false
+    @github_url_cache = {}
+    
+		template = @options.template || 'direct'
+
+		templ_dir = self.class.template_dir template
+
+		raise RDoc::Error, "could not find template #{template.inspect}" unless
+			templ_dir
+		
+		@template_dir = Pathname.new File.expand_path(templ_dir)
+		@basedir = Pathname.pwd.expand_path
+  end
+  
+  def generate( top_levels )
+		@outputdir = Pathname.new( @options.op_dir ).expand_path( @basedir )
+		@files = top_levels.sort
+		@classes = RDoc::TopLevel.all_classes_and_modules.sort
+
+		# Now actually write the output
+    copy_resources
+    generate_class_tree
+    generate_search_index
+		generate_file_files
+		generate_class_files
+		generate_index_file
+  end
+  
+	def class_dir
+		CLASS_DIR
+	end
+
+	def file_dir
+		FILE_DIR
+	end
+
+  
+  protected
+	### Output progress information if debugging is enabled
+	def debug_msg( *msg )
+		return unless $DEBUG_RDOC
+		$stderr.puts( *msg )
+	end  
+  
+  ### Create class tree structure and write it as json
+  def generate_class_tree
+    debug_msg "Generating class tree"
+    topclasses = @classes.select {|klass| !(RDoc::ClassModule === klass.parent) } 
+    tree = generate_class_tree_level topclasses
+    debug_msg "  writing class tree to %s" % TREE_FILE
+    File.open(TREE_FILE, "w", 0644) do |f|
+      f.write('var tree = '); f.write(tree.to_json)
+    end unless $dryrun
+  end
+  
+  ### Recursivly build class tree structure
+  def generate_class_tree_level(classes)
+    tree = []
+    classes.select{|c| c.with_documentation? }.sort.each do |klass|
+      item = [
+        klass.name, 
+        klass.document_self_or_methods ? klass.path : '',
+        klass.module? ? '' : (klass.superclass ? " < #{String === klass.superclass ? klass.superclass : klass.superclass.full_name}" : ''), 
+        generate_class_tree_level(klass.classes_and_modules)
+      ]
+      tree << item
+    end
+    tree
+  end
+  
+  ### Create search index for all classes, methods and files
+  ### Wite it as json
+  def generate_search_index
+    debug_msg "Generating search index"
+    
+    index = {
+      :searchIndex => [],
+      :longSearchIndex => [],
+      :info => []
+    }
+    
+    add_class_search_index(index)
+    add_method_search_index(index)
+    add_file_search_index(index)
+    
+    debug_msg "  writing search index to %s" % SEARCH_INDEX_FILE
+    data = {
+      :index => index
+    }
+    File.open(SEARCH_INDEX_FILE, "w", 0644) do |f|
+      f.write('var search_data = '); f.write(data.to_json)
+    end unless $dryrun
+  end
+  
+  ### Add files to search +index+ array
+  def add_file_search_index(index)
+    debug_msg "  generating file search index"
+    
+    @files.select { |file| 
+      file.document_self 
+    }.sort.each do |file|
+      index[:searchIndex].push( search_string(file.name) )
+      index[:longSearchIndex].push( search_string(file.path) )
+      index[:info].push([
+        file.name, 
+        file.path, 
+        file.path, 
+        '', 
+        snippet(file.comment),
+        TYPE_FILE
+      ])
+    end
+  end
+  
+  ### Add classes to search +index+ array
+  def add_class_search_index(index)
+    debug_msg "  generating class search index"
+    
+    @classes.select { |klass| 
+      klass.document_self_or_methods
+    }.sort.each do |klass|
+      index[:searchIndex].push( search_string(klass.name) )
+      index[:longSearchIndex].push( search_string(klass.parent.name) )
+      index[:info].push([
+        klass.name, 
+        klass.parent.full_name, 
+        klass.path, 
+        klass.module? ? '' : (klass.superclass ? " < #{String === klass.superclass ? klass.superclass : klass.superclass.full_name}" : ''), 
+        snippet(klass.comment),
+        TYPE_CLASS
+      ])
+    end
+  end
+  
+  ### Add methods to search +index+ array
+  def add_method_search_index(index)
+    debug_msg "  generating method search index"
+    
+    list = @classes.map { |klass| 
+      klass.method_list
+    }.flatten.sort{ |a, b| a.name == b.name ? a.parent.full_name <=> b.parent.full_name : a.name <=> b.name }.select { |method| 
+      method.document_self 
+    }
+    unless @options.show_all
+        list = list.find_all {|m| m.visibility == :public || m.visibility == :protected || m.force_documentation }
+    end
+    
+    list.each do |method|
+      index[:searchIndex].push( search_string(method.name) + '()' )
+      index[:longSearchIndex].push( search_string(method.parent.name) )
+      index[:info].push([
+        method.name, 
+        method.parent.full_name, 
+        method.path, 
+        method.params, 
+        snippet(method.comment),
+        TYPE_METHOD
+      ])
+    end
+  end
+  
+	### Generate a documentation file for each class
+	def generate_class_files
+		debug_msg "Generating class documentation in #@outputdir"
+    templatefile = @template_dir + 'class.rhtml'
+
+		@classes.each do |klass|
+			debug_msg "  working on %s (%s)" % [ klass.full_name, klass.path ]
+			outfile     = @outputdir + klass.path
+			rel_prefix  = @outputdir.relative_path_from( outfile.dirname )
+      
+			debug_msg "  rendering #{outfile}"
+			self.render_template( templatefile, binding(), outfile )
+		end
+	end
+
+	### Generate a documentation file for each file
+	def generate_file_files
+		debug_msg "Generating file documentation in #@outputdir"
+    templatefile = @template_dir + 'file.rhtml'
+    
+		@files.each do |file|
+			outfile     = @outputdir + file.path
+			debug_msg "  working on %s (%s)" % [ file.full_name, outfile ]
+			rel_prefix  = @outputdir.relative_path_from( outfile.dirname )
+
+			debug_msg "  rendering #{outfile}"
+			self.render_template( templatefile, binding(), outfile )
+		end
+	end
+	
+	### Create index.html with frameset
+	def generate_index_file
+		debug_msg "Generating index file in #@outputdir"
+    templatefile = @template_dir + 'index.rhtml'
+    outfile      = @outputdir + 'index.html'
+    if @options.main_page && index_path = @files.find { |f| f.full_name == @options.main_page }
+      index_path = index_path.path
+    else
+	    index_path = @files.first.path
+    end
+	  
+	  self.render_template( templatefile, binding(), outfile )
+	end
+	
+	### Strip comments on a space after 100 chars
+  def snippet(str)
+    str ||= ''
+    if str =~ /^(?>\s*)[^\#]/
+      content = str
+    else
+      content = str.gsub(/^\s*(#+)\s*/, '')
+    end
+    
+    content = content.sub(/^(.{100,}?)\s.*/m, "\\1").gsub(/\r?\n/m, ' ')
+    
+    begin
+      content.to_json
+    rescue # might fail on non-unicode string
+      begin
+        content = Iconv.conv('latin1//ignore', "UTF8", content) # remove all non-unicode chars
+        content.to_json
+      rescue
+        content = '' # something hugely wrong happend
+      end
+    end
+    content
+  end
+
+  ### Build search index key
+  def search_string(string)
+    string ||= ''
+    string.downcase.gsub(/\s/,'')
+  end
+  
+  ### Copy all the resource files to output dir
+  def copy_resources
+    resoureces_path = @template_dir + RESOURCES_DIR
+		debug_msg "Copying #{resoureces_path}/** to #{@outputdir}/**"
+    FileUtils.cp_r resoureces_path.to_s, @outputdir.to_s, :preserve => true unless $dryrun
+  end
+end