sdoc 0.2.14.1 → 0.2.15

data/README.rdoc

@@ -6,8 +6,7 @@
 - <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
+    sudo gem install sdoc
     sdoc -N projectdir
 
 == Command line sdoc

data/Rakefile

@@ -21,17 +21,24 @@ end
 
 begin
   require 'jeweler'
-  jewler = Jeweler::Tasks.new do |gem|
+  
+  spec = Gem::Specification.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
+    
+    if defined?(JRUBY_VERSION)
+      gem.platform = Gem::Platform.new(['universal', 'java', nil])
+      gem.add_dependency("json_pure", ">= 1.1.3")
+    else
+      gem.add_dependency("json", ">= 1.1.3")
+    end    
   end
+  
+  jewler = Jeweler::Tasks.new(spec)
 
   desc "Replace system gem with symlink to this folder"
   task 'ghost' do

data/VERSION.yml

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

data/lib/sdoc/c_parser_fix.rb

@@ -1,7 +1,7 @@
 require "rdoc/parser/c"
 
-# New RDoc somehow misses class comemnts.
-# copyied this function from "2.2.2" 
+# New RDoc somehow misses class comments.
+# copied this function from "2.2.2" 
 if ['2.4.2', '2.4.3'].include? RDoc::VERSION
 
   class RDoc::Parser::C

data/lib/sdoc/generator/shtml.rb

@@ -24,7 +24,7 @@ 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
@@ -36,84 +36,84 @@ class RDoc::Generator::SHtml
   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
+    $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
+    @options = options
+    @options.diagram = false
     @github_url_cache = {}
-    
-		template = @options.template || 'direct'
 
-		templ_dir = self.class.template_dir template
+    template = @options.template || 'direct'
 
-		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
+    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
+    @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
+    # Now actually write the output
     copy_resources
     generate_class_tree
     generate_search_index
-		generate_file_files
-		generate_class_files
-		generate_index_file
+    generate_file_files
+    generate_class_files
+    generate_index_file
+  end
+
+  def class_dir
+    CLASS_DIR
+  end
+
+  def file_dir
+    FILE_DIR
   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  
-  
+  ### 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"
@@ -124,7 +124,7 @@ class RDoc::Generator::SHtml
       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 = []
@@ -139,22 +139,22 @@ class RDoc::Generator::SHtml
     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
@@ -163,11 +163,11 @@ class RDoc::Generator::SHtml
       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|
@@ -183,20 +183,21 @@ class RDoc::Generator::SHtml
       ])
     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|
       modulename = klass.module? ? '' : (klass.superclass ? (String === klass.superclass ? klass.superclass : klass.superclass.full_name) : '')
       index[:searchIndex].push( search_string(klass.name) )
       index[:longSearchIndex].push( search_string(klass.parent.full_name) )
+      files = klass.in_files.map{ |file| file.absolute_name }
       index[:info].push([
         klass.name, 
-        klass.parent.full_name, 
+        files.include?(klass.parent.full_name) ? files.first : klass.parent.full_name, 
         klass.path, 
         modulename ? " < #{modulename}" : '', 
         snippet(klass.comment),
@@ -204,20 +205,20 @@ class RDoc::Generator::SHtml
       ])
     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 }
+      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.full_name) )
@@ -231,37 +232,37 @@ class RDoc::Generator::SHtml
       ])
     end
   end
-  
-	### Generate a documentation file for each class
-	def generate_class_files
-		debug_msg "Generating class documentation in #@outputdir"
+
+  ### 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"
+    @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
-	
+
+    @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
+
   def index_file
     if @options.main_page && file = @files.find { |f| f.full_name == @options.main_page }
       file
@@ -270,17 +271,17 @@ class RDoc::Generator::SHtml
     end
   end
 
-	### Create index.html with frameset
-	def generate_index_file
-		debug_msg "Generating index file in #@outputdir"
+  ### 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'
     index_path = index_file.path
-	  
-	  self.render_template( templatefile, binding(), outfile )
-	end
-	
-	### Strip comments on a space after 100 chars
+
+    self.render_template( templatefile, binding(), outfile )
+  end
+
+  ### Strip comments on a space after 100 chars
   def snippet(str)
     str ||= ''
     if str =~ /^(?>\s*)[^\#]/
@@ -288,9 +289,9 @@ class RDoc::Generator::SHtml
     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
@@ -309,11 +310,11 @@ class RDoc::Generator::SHtml
     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}/**"
+    debug_msg "Copying #{resoureces_path}/** to #{@outputdir}/**"
     FileUtils.cp_r resoureces_path.to_s, @outputdir.to_s, :preserve => true unless $dryrun
   end
 

data/lib/sdoc/generator/template/direct/resources/css/main.css

@@ -47,6 +47,21 @@ h4 {
     font-size: 1em;
 }
 
+table
+{
+    margin-bottom: 1em;
+}
+
+td, th
+{
+    padding: 0 0.7em 0.3em 0;
+}
+
+th
+{
+    font-weight: bold;
+}
+
 .clear
 {
     clear: both;

data/lib/sdoc/merge.rb

@@ -1,6 +1,8 @@
 require 'optparse'
 require 'pathname'
 require 'fileutils'
+
+gem 'json_pure', '>= 1.1.3' if defined?(::JRUBY_VERSION)
 require 'json'
 
 require 'sdoc/templatable'

data/sdoc.gemspec

@@ -1,12 +1,11 @@
-# -*- encoding: utf-8 -*-
-
 Gem::Specification.new do |s|
   s.name = %q{sdoc}
-  s.version = "0.2.14.1"
+  s.version = "0.2.15"
+  s.platform = Gem::Platform.new(["universal", "java", nil]) if defined?(::JRUBY_VERSION)
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Volodya Kolesnikov"]
-  s.date = %q{2009-08-14}
+  s.date = %q{2009-12-12}
   s.email = %q{voloko@gmail.com}
   s.executables = ["sdoc", "sdoc-merge"]
   s.extra_rdoc_files = [
@@ -68,7 +67,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/voloko/sdoc}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.4}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{rdoc html with javascript search index.}
 
   if s.respond_to? :specification_version then
@@ -76,14 +75,15 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<json>, [">= 1.1.3"])
       s.add_runtime_dependency(%q<rdoc>, [">= 2.4.2"])
+      s.add_runtime_dependency(defined?(::JRUBY_VERSION) ? %q<json_pure> : %q<json>, [">= 1.1.3"])
     else
-      s.add_dependency(%q<json>, [">= 1.1.3"])
       s.add_dependency(%q<rdoc>, [">= 2.4.2"])
+      s.add_runtime_dependency(defined?(::JRUBY_VERSION) ? %q<json_pure> : %q<json>, [">= 1.1.3"])
     end
   else
-    s.add_dependency(%q<json>, [">= 1.1.3"])
     s.add_dependency(%q<rdoc>, [">= 2.4.2"])
+    s.add_runtime_dependency(defined?(::JRUBY_VERSION) ? %q<json_pure> : %q<json>, [">= 1.1.3"])
   end
 end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sdoc
 version: !ruby/object:Gem::Version 
-  version: 0.2.14.1
+  version: 0.2.15
 platform: ruby
 authors: 
 - Volodya Kolesnikov
@@ -9,28 +9,28 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-14 00:00:00 +04:00
+date: 2009-12-12 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: rdoc
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.1.3
+        version: 2.4.2
     version: 
 - !ruby/object:Gem::Dependency 
-  name: rdoc
+  name: json
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.4.2
+        version: 1.1.3
     version: 
 description: 
 email: voloko@gmail.com
@@ -117,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: rdoc html with javascript search index.