voloko-sdoc 0.1.10 → 0.2.0

data/VERSION.yml

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

data/lib/sdoc.rb

@@ -10,12 +10,14 @@ end
 require "sdoc/generator/shtml"
 require "sdoc/c_parser_fix"
 
-class RDoc::Options
-  alias_method :rdoc_initialize, :initialize
+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
+    def initialize
+      rdoc_initialize
+      @generator = RDoc::Generator::SHtml
+    end
   end
 end
-

data/lib/sdoc/generator/shtml.rb

@@ -17,6 +17,7 @@ require 'rdoc/generator'
 require 'rdoc/generator/markup'
 
 require 'sdoc/github'
+require 'sdoc/templatable'
 
 class RDoc::ClassModule
   def with_documentation?
@@ -28,6 +29,7 @@ class RDoc::Generator::SHtml
   RDoc::RDoc.add_generator( self )
   include ERB::Util
   include SDoc::GitHub
+  include SDoc::Templatable
   
   GENERATOR_DIRS = [File.join('sdoc', 'generator'), File.join('rdoc', 'generator')]
   
@@ -50,6 +52,16 @@ class RDoc::Generator::SHtml
     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
@@ -57,18 +69,12 @@ class RDoc::Generator::SHtml
     
 		template = @options.template || 'shtml'
 
-		template_dir = $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
+		templ_dir = self.class.template_dir template
 
 		raise RDoc::Error, "could not find template #{template.inspect}" unless
-			template_dir
+			templ_dir
 		
-		@template_dir = Pathname.new File.expand_path(template_dir)
+		@template_dir = Pathname.new File.expand_path(templ_dir)
 		@basedir = Pathname.pwd.expand_path
   end
   
@@ -108,7 +114,7 @@ class RDoc::Generator::SHtml
     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") do |f|
+    File.open(TREE_FILE, "w", 0644) do |f|
       f.write('var tree = '); f.write(tree.to_json)
     end unless $dryrun
   end
@@ -147,7 +153,7 @@ class RDoc::Generator::SHtml
     data = {
       :index => index
     }
-    File.open(SEARCH_INDEX_FILE, "w") do |f|
+    File.open(SEARCH_INDEX_FILE, "w", 0644) do |f|
       f.write('var search_data = '); f.write(data.to_json)
     end unless $dryrun
   end
@@ -206,7 +212,7 @@ class RDoc::Generator::SHtml
     end
     
     list.each do |method|
-      index[:searchIndex].push( search_string(method.name) )
+      index[:searchIndex].push( search_string(method.name) + '()' )
       index[:longSearchIndex].push( search_string(method.parent.name) )
       index[:info].push([
         method.name, 
@@ -254,7 +260,11 @@ class RDoc::Generator::SHtml
 		debug_msg "Generating index file in #@outputdir"
     templatefile = @template_dir + 'index.rhtml'
     outfile      = @outputdir + 'index.html'
-	  index_path   = @files.first.path
+    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
@@ -293,48 +303,6 @@ class RDoc::Generator::SHtml
   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 unless $dryrun
+    FileUtils.cp_r resoureces_path.to_s, @outputdir.to_s, :preserve => true unless $dryrun
   end
-  
-	### Load and render the erb template in the given +templatefile+ within the
-	### specified +context+ (a Binding object) and return output
-	### Both +templatefile+ and +outfile+ should be Pathname-like objects.
-  def eval_template(templatefile, context)
-		template_src = templatefile.read
-		template = ERB.new( template_src, nil, '<>' )
-		template.filename = templatefile.to_s
-
-    begin
-      template.result( context )
-    rescue NoMethodError => err
-      raise RDoc::Error, "Error while evaluating %s: %s (at %p)" % [
-        templatefile.to_s,
-        err.message,
-        eval( "_erbout[-50,50]", context )
-        ], err.backtrace
-      end
-  end
-  
-  ### Load and render the erb template with the given +template_name+ within
-  ### current context. Adds all +local_assigns+ to context
-  def include_template(template_name, local_assigns = {})
-    source = local_assigns.keys.map { |key| "#{key} = local_assigns[:#{key}];" }.join
-    eval("#{source};templatefile = @template_dir + template_name;eval_template(templatefile, binding)")
-  end
-  
-	### Load and render the erb template in the given +templatefile+ within the
-	### specified +context+ (a Binding object) and write it out to +outfile+.
-	### Both +templatefile+ and +outfile+ should be Pathname-like objects.
-	def render_template( templatefile, context, outfile )
-    output = eval_template(templatefile, context)
-		unless $dryrun
-			outfile.dirname.mkpath
-			outfile.open( 'w', 0644 ) do |ofh|
-				ofh.print( output )
-			end
-		else
-			debug_msg "  would have written %d bytes to %s" %
-			[ output.length, outfile ]
-		end
-	end  
 end

data/lib/sdoc/generator/template/merge/index.rhtml

@@ -0,0 +1,14 @@
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">    
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+	<meta http-equiv="Content-Type" content="text/html; charset=%charset%"/>
+
+	<title><%= @title %></title>
+</head>
+<frameset cols="300,*" frameborder="1" border="1" bordercolor="#666666" framespacing="1">
+    <frame src="panel/index.html" title="Search" name="panel" />
+    <frame src="<%= index_path %>" name="docwin" />
+</frameset>
+</html>

data/lib/sdoc/generator/template/shtml/resources/js/searchdoc.js

@@ -166,7 +166,7 @@ Searchdoc.Searcher.prototype = new function() {
 
     /*  ----- Utilities ------  */
     function splitQuery(query) {
-        return jQuery.grep(query.split(/\s+/), function(string) { return !!string });
+        return jQuery.grep(query.split(/(\s+|\(\)?)/), function(string) { return string.match(/\S/) });
     }
 
     function buildRegexps(queries) {
@@ -506,7 +506,7 @@ Searchdoc.Tree.prototype = $.extend({}, Searchdoc.Navigation, new function() {
     this.move = function(isDown) {
         if (!this.$current) {
             this.select(this.$list.find('li:first'));
-            return;
+            return true;
         }        
         var next = this.$current[0];
         if (isDown) {
@@ -526,6 +526,7 @@ Searchdoc.Tree.prototype = $.extend({}, Searchdoc.Navigation, new function() {
             scrollIntoView(next, this.$element[0]);
             this.$current = $(next);
         }
+        return true;
     }
 
     function toggleVis($li, show) {

data/lib/sdoc/github.rb

@@ -54,8 +54,8 @@ module SDoc::GitHub
   
   def in_dir(dir)
     pwd = Dir.pwd
-    Dir.chdir dir
     begin
+      Dir.chdir dir
       return yield
     ensure
       Dir.chdir pwd

data/lib/sdoc/merge.rb

@@ -3,25 +3,34 @@ require 'pathname'
 require 'fileutils'
 require 'json'
 
+require 'sdoc/templatable'
+
 class SDoc::Merge
+  include SDoc::Templatable
   
   FLAG_FILE = "created.rid"
   
   def initialize()
     @names = []
     @op_dir = 'doc'
+    @title = ''
     @directories = []
+    template_dir = RDoc::Generator::SHtml.template_dir('merge')
+		@template_dir = Pathname.new File.expand_path(template_dir)
   end
   
   def merge(options)
     parse_options options
     
+		@outputdir = Pathname.new( @op_dir )
+		
     check_directories
     setup_output_dir
     setup_names
     copy_files
-    merge_tree
     merge_search_index
+    merge_tree
+    generate_index_file
   end
   
   def parse_options(options)
@@ -35,6 +44,10 @@ class SDoc::Merge
       opt.on("-o", "--op [DIRECTORY]", "Set the output directory") do |v|
         @op_dir = v
       end
+      
+      opt.on("-t", "--title [TITLE]", "Set the title of merged file") do |v|
+        @title = v
+      end
     end
     opts.parse! options
     @directories = options.dup
@@ -49,7 +62,7 @@ class SDoc::Merge
       subtree = JSON.parse data
       item = [
         name,
-        '',
+        @indexes[name]["index"]["info"][0][2],
         '',
         append_path(subtree, name)
       ]
@@ -58,7 +71,7 @@ class SDoc::Merge
     
     dst = File.join @op_dir, RDoc::Generator::SHtml::TREE_FILE
     FileUtils.mkdir_p File.dirname(dst)
-    File.open(dst, "w") do |f|
+    File.open(dst, "w", 0644) do |f|
       f.write('var tree = '); f.write(tree.to_json)
     end
   end
@@ -73,11 +86,13 @@ class SDoc::Merge
   
   def merge_search_index
     items = []
+    @indexes = {}
     @directories.each_with_index do |dir, i|
       name = @names[i]
       filename = File.join dir, RDoc::Generator::SHtml::SEARCH_INDEX_FILE
       data = open(filename).read.sub(/var search_data =\s*/, '')
       subindex = JSON.parse data
+      @indexes[name] = subindex
       
       searchIndex = subindex["index"]["searchIndex"]
       longSearchIndex = subindex["index"]["longSearchIndex"]
@@ -92,15 +107,8 @@ class SDoc::Merge
       end
     end
     items.sort! do |a, b|
-      a[:info][5] == b[:info][5] ?        # type (class/method/file)
-        (a[:info][0] == b[:info][0] ?     # or name
-          (a[:info][6] == b[:info][6] ?   # or doc part
-            a[:info][1] <=> b[:info][1] :  # or namespace
-            a[:info][6] <=> b[:info][6]
-          ) :
-          a[:info][0] <=> b[:info][0]
-        ) : 
-        a[:info][5] <=> b[:info][5]
+      # type (class/method/file) or name or doc part or namespace
+      [a[:info][5], a[:info][0], a[:info][6], a[:info][1]] <=> [b[:info][5], b[:info][0], b[:info][6], b[:info][1]]
     end
     
     index = {
@@ -115,13 +123,21 @@ class SDoc::Merge
     
     dst = File.join @op_dir, RDoc::Generator::SHtml::SEARCH_INDEX_FILE
     FileUtils.mkdir_p File.dirname(dst)
-    File.open(dst, "w") do |f|
+    File.open(dst, "w", 0644) do |f|
       f.write('var search_data = '); f.write(search_data.to_json)
     end
   end
   
+  def generate_index_file
+    templatefile = @template_dir + 'index.rhtml'
+    outfile      = @outputdir + 'index.html'
+	  index_path   = @indexes[@names.first]["index"]["info"][0][2]
+	  
+    render_template templatefile, binding(), outfile
+  end
+  
   def setup_names
-    unless @names.size
+    unless @names.size > 0
       @directories.each do |dir|
         name = File.basename dir
         name = File.basename File.dirname(dir) if name == 'doc'
@@ -138,7 +154,7 @@ class SDoc::Merge
       
       Dir.new(dir).each do |item|
         if File.directory?(File.join(dir, item)) && item != '.' && item != '..' && item != index_dir
-          FileUtils.cp_r File.join(dir, item), File.join(@op_dir, name, item)
+          FileUtils.cp_r File.join(dir, item), File.join(@op_dir, name, item), :preserve => true
         end
       end
     end
@@ -146,7 +162,7 @@ class SDoc::Merge
     dir = @directories.first
     Dir.new(dir).each do |item|
       if item != '.' && item != '..' && item != RDoc::Generator::SHtml::FILE_DIR && item != RDoc::Generator::SHtml::CLASS_DIR
-        FileUtils.cp_r File.join(dir, item), @op_dir
+        FileUtils.cp_r File.join(dir, item), @op_dir, :preserve => true
       end
     end
   end
@@ -168,10 +184,6 @@ class SDoc::Merge
     end
   end
   
-  def update_output_dir(op_dir, time)
-    File.open(File.join @op_dir, FLAG_FILE, "w") { |f| f.puts time.rfc2822 }
-  end
-  
   ##
   # Report an error message and exit
 

data/lib/sdoc/templatable.rb

@@ -0,0 +1,45 @@
+require "sdoc"
+
+module SDoc::Templatable
+	### Load and render the erb template in the given +templatefile+ within the
+	### specified +context+ (a Binding object) and return output
+	### Both +templatefile+ and +outfile+ should be Pathname-like objects.
+  def eval_template(templatefile, context)
+		template_src = templatefile.read
+		template = ERB.new( template_src, nil, '<>' )
+		template.filename = templatefile.to_s
+
+    begin
+      template.result( context )
+    rescue NoMethodError => err
+      raise RDoc::Error, "Error while evaluating %s: %s (at %p)" % [
+        templatefile.to_s,
+        err.message,
+        eval( "_erbout[-50,50]", context )
+        ], err.backtrace
+      end
+  end
+  
+  ### Load and render the erb template with the given +template_name+ within
+  ### current context. Adds all +local_assigns+ to context
+  def include_template(template_name, local_assigns = {})
+    source = local_assigns.keys.map { |key| "#{key} = local_assigns[:#{key}];" }.join
+    eval("#{source};templatefile = @template_dir + template_name;eval_template(templatefile, binding)")
+  end
+  
+	### Load and render the erb template in the given +templatefile+ within the
+	### specified +context+ (a Binding object) and write it out to +outfile+.
+	### Both +templatefile+ and +outfile+ should be Pathname-like objects.
+	def render_template( templatefile, context, outfile )
+    output = eval_template(templatefile, context)
+		unless $dryrun
+			outfile.dirname.mkpath
+			outfile.open( 'w', 0644 ) do |file|
+				file.print( output )
+			end
+		else
+			debug_msg "  would have written %d bytes to %s" %
+			[ output.length, outfile ]
+		end
+	end  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: voloko-sdoc
 version: !ruby/object:Gem::Version 
-  version: 0.1.10
+  version: 0.2.0
 platform: ruby
 authors: 
 - Volodya Kolesnikov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-02 00:00:00 -07:00
+date: 2009-04-03 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,6 +51,8 @@ files:
 - lib/sdoc/generator
 - lib/sdoc/generator/shtml.rb
 - lib/sdoc/generator/template
+- lib/sdoc/generator/template/merge
+- lib/sdoc/generator/template/merge/index.rhtml
 - lib/sdoc/generator/template/shtml
 - lib/sdoc/generator/template/shtml/_context.rhtml
 - lib/sdoc/generator/template/shtml/class.rhtml
@@ -73,6 +75,7 @@ files:
 - lib/sdoc/generator/template/shtml/resources/panel/index.html
 - lib/sdoc/github.rb
 - lib/sdoc/merge.rb
+- lib/sdoc/templatable.rb
 - lib/sdoc.rb
 - README
 - LICENSE