sdoc 0.2.12.1 → 0.2.14

data/.gitignore

@@ -0,0 +1,3 @@
+pkg
+doc
+/test.rb

data/Rakefile

@@ -21,7 +21,7 @@ end
 
 begin
   require 'jeweler'
-  Jeweler::Tasks.new do |gem|
+  jewler = Jeweler::Tasks.new do |gem|
     gem.name = "sdoc"
     gem.summary = "rdoc html with javascript search index."
     gem.email = "voloko@gmail.com"
@@ -32,6 +32,13 @@ begin
 
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
+
+  desc "Replace system gem with symlink to this folder"
+  task 'ghost' do
+    path = Gem.searcher.find(jewler.gemspec.name).full_gem_path
+    system 'sudo', 'rm', '-r', path
+    symlink File.expand_path('.'), path
+  end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end

data/VERSION.yml

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

data/lib/sdoc/generator/shtml.rb

@@ -118,7 +118,7 @@ class RDoc::Generator::SHtml
   def generate_class_tree
     debug_msg "Generating class tree"
     topclasses = @classes.select {|klass| !(RDoc::ClassModule === klass.parent) } 
-    tree = generate_class_tree_level topclasses
+    tree = generate_file_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)
@@ -191,13 +191,14 @@ class RDoc::Generator::SHtml
     @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.name) )
+      index[:longSearchIndex].push( search_string(klass.parent.full_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}" : ''), 
+        modulename ? " < #{modulename}" : '', 
         snippet(klass.comment),
         TYPE_CLASS
       ])
@@ -261,16 +262,20 @@ class RDoc::Generator::SHtml
 		end
 	end
 	
+  def index_file
+    if @options.main_page && file = @files.find { |f| f.full_name == @options.main_page }
+      file
+    else
+      @files.first
+    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
+    index_path = index_file.path
 	  
 	  self.render_template( templatefile, binding(), outfile )
 	end
@@ -311,4 +316,41 @@ class RDoc::Generator::SHtml
 		debug_msg "Copying #{resoureces_path}/** to #{@outputdir}/**"
     FileUtils.cp_r resoureces_path.to_s, @outputdir.to_s, :preserve => true unless $dryrun
   end
-end
+
+  class FilesTree
+    attr_reader :children
+    def add(path, url)
+      path = path.split(File::SEPARATOR) unless Array === path
+      @children ||= {}
+      if path.length == 1
+        @children[path.first] = url
+      else
+        @children[path.first] ||= FilesTree.new
+        @children[path.first].add(path[1, path.length], url)
+      end
+    end
+  end
+
+  def generate_file_tree
+    if @files.length > 1
+      @files_tree = FilesTree.new
+      @files.each do |file|
+        @files_tree.add(file.relative_name, file.path)
+      end
+      [['', '', 'files', generate_file_tree_level(@files_tree)]]
+    else
+      []
+    end
+  end
+
+  def generate_file_tree_level(tree)
+    tree.children.keys.sort.map do |name|
+      child = tree.children[name]
+      if String === child
+        [name, child, '', []]
+      else
+        ['', '', name, generate_file_tree_level(child)]
+      end
+    end
+  end
+end

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

@@ -28,10 +28,14 @@ Searchdoc.Navigation = new function() {
             case 38: //Event.KEY_UP:
             case 39: //Event.KEY_RIGHT:
             case 40: //Event.KEY_DOWN:
-            case 73: // i
-            case 67: // c (dvorak)
+            case 73: // i - qwerty
+            case 74: // j
             case 75: // k
-            case 84: // t (dvorak)
+            case 76: // l
+            case 67: // c - dvorak
+            case 72: // h 
+            case 84: // t
+            case 78: // n
                 this.clearMoveTimeout();
                 break;
             }
@@ -41,10 +45,12 @@ Searchdoc.Navigation = new function() {
         if (!this.navigationActive) return;
         switch(e.keyCode) {
             case 37: //Event.KEY_LEFT:
+            case 74: // j (qwerty)
+            case 72: // h (dvorak)
                 if (this.moveLeft()) e.preventDefault();
                 break;
             case 38: //Event.KEY_UP:
-            case 73: // i
+            case 73: // i (qwerty)
             case 67: // c (dvorak)
                 if (e.keyCode == 38 || e.ctrlKey) {
                     if (this.moveUp()) e.preventDefault();
@@ -52,10 +58,12 @@ Searchdoc.Navigation = new function() {
                 }
                 break;
             case 39: //Event.KEY_RIGHT:
+            case 76: // l (qwerty)
+            case 78: // n (dvorak)
                 if (this.moveRight()) e.preventDefault();
                 break;
             case 40: //Event.KEY_DOWN:
-            case 75: // k
+            case 75: // k (qwerty)
             case 84: // t (dvorak)
                 if (e.keyCode == 40 || e.ctrlKey) {
                     if (this.moveDown()) e.preventDefault();

data/lib/sdoc/generator/template/direct/resources/panel/index.html

@@ -34,7 +34,7 @@
            var panel = new Searchdoc.Panel($('#panel'), search_data, tree, top.frames[1]);
            $('#search').focus();
 
-           var s = window.parent.location.search.match(/\?q=(.*)$/);
+           var s = window.parent.location.search.match(/\?q=([^&]+)/);
            if (s) {
                s = decodeURIComponent(s[1]).replace(/\+/g, ' ');
                if (s.length > 0)

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

@@ -28,10 +28,14 @@ Searchdoc.Navigation = new function() {
             case 38: //Event.KEY_UP:
             case 39: //Event.KEY_RIGHT:
             case 40: //Event.KEY_DOWN:
-            case 73: // i
-            case 67: // c (dvorak)
+            case 73: // i - qwerty
+            case 74: // j
             case 75: // k
-            case 84: // t (dvorak)
+            case 76: // l
+            case 67: // c - dvorak
+            case 72: // h 
+            case 84: // t
+            case 78: // n
                 this.clearMoveTimeout();
                 break;
             }
@@ -41,10 +45,12 @@ Searchdoc.Navigation = new function() {
         if (!this.navigationActive) return;
         switch(e.keyCode) {
             case 37: //Event.KEY_LEFT:
+            case 74: // j (qwerty)
+            case 72: // h (dvorak)
                 if (this.moveLeft()) e.preventDefault();
                 break;
             case 38: //Event.KEY_UP:
-            case 73: // i
+            case 73: // i (qwerty)
             case 67: // c (dvorak)
                 if (e.keyCode == 38 || e.ctrlKey) {
                     if (this.moveUp()) e.preventDefault();
@@ -52,10 +58,12 @@ Searchdoc.Navigation = new function() {
                 }
                 break;
             case 39: //Event.KEY_RIGHT:
+            case 76: // l (qwerty)
+            case 78: // n (dvorak)
                 if (this.moveRight()) e.preventDefault();
                 break;
             case 40: //Event.KEY_DOWN:
-            case 75: // k
+            case 75: // k (qwerty)
             case 84: // t (dvorak)
                 if (e.keyCode == 40 || e.ctrlKey) {
                     if (this.moveDown()) e.preventDefault();

data/lib/sdoc/generator/template/shtml/resources/panel/index.html

@@ -34,7 +34,7 @@
            var panel = new Searchdoc.Panel($('#panel'), search_data, tree, top.frames[1]);
            $('#search').focus();
 
-           var s = window.parent.location.search.match(/\?q=(.*)$/);
+           var s = window.parent.location.search.match(/\?q=([^&]+)/);
            if (s) {
                s = decodeURIComponent(s[1]).replace(/\+/g, ' ');
                if (s.length > 0)

data/lib/sdoc/merge.rb

@@ -67,7 +67,7 @@ class SDoc::Merge
       url = @urls.empty? ? name : @urls[i]
       filename = File.join dir, RDoc::Generator::SHtml::TREE_FILE
       data = open(filename).read.sub(/var tree =\s*/, '')
-      subtree = JSON.parse data
+      subtree = JSON.parse data, :max_nesting => 35
       item = [
         name,
         url + '/' + extract_index_path(dir),
@@ -100,7 +100,7 @@ class SDoc::Merge
       url = @urls.empty? ? name : @urls[i]
       filename = File.join dir, RDoc::Generator::SHtml::SEARCH_INDEX_FILE
       data = open(filename).read.sub(/var search_data =\s*/, '')
-      subindex = JSON.parse data
+      subindex = JSON.parse data, :max_nesting => 35
       @indexes[name] = subindex
       
       searchIndex = subindex["index"]["searchIndex"]

data/sdoc.gemspec

@@ -0,0 +1,89 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sdoc}
+  s.version = "0.2.14"
+
+  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.email = %q{voloko@gmail.com}
+  s.executables = ["sdoc", "sdoc-merge"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "bin/sdoc",
+     "bin/sdoc-merge",
+     "lib/rdoc/discover.rb",
+     "lib/sdoc.rb",
+     "lib/sdoc/c_parser_fix.rb",
+     "lib/sdoc/generator/shtml.rb",
+     "lib/sdoc/generator/template/direct/_context.rhtml",
+     "lib/sdoc/generator/template/direct/class.rhtml",
+     "lib/sdoc/generator/template/direct/file.rhtml",
+     "lib/sdoc/generator/template/direct/index.rhtml",
+     "lib/sdoc/generator/template/direct/resources/apple-touch-icon.png",
+     "lib/sdoc/generator/template/direct/resources/css/main.css",
+     "lib/sdoc/generator/template/direct/resources/css/panel.css",
+     "lib/sdoc/generator/template/direct/resources/css/reset.css",
+     "lib/sdoc/generator/template/direct/resources/favicon.ico",
+     "lib/sdoc/generator/template/direct/resources/i/arrows.png",
+     "lib/sdoc/generator/template/direct/resources/i/results_bg.png",
+     "lib/sdoc/generator/template/direct/resources/i/tree_bg.png",
+     "lib/sdoc/generator/template/direct/resources/js/jquery-1.3.2.min.js",
+     "lib/sdoc/generator/template/direct/resources/js/jquery-effect.js",
+     "lib/sdoc/generator/template/direct/resources/js/main.js",
+     "lib/sdoc/generator/template/direct/resources/js/searchdoc.js",
+     "lib/sdoc/generator/template/direct/resources/panel/index.html",
+     "lib/sdoc/generator/template/merge/index.rhtml",
+     "lib/sdoc/generator/template/shtml/_context.rhtml",
+     "lib/sdoc/generator/template/shtml/class.rhtml",
+     "lib/sdoc/generator/template/shtml/file.rhtml",
+     "lib/sdoc/generator/template/shtml/index.rhtml",
+     "lib/sdoc/generator/template/shtml/resources/apple-touch-icon.png",
+     "lib/sdoc/generator/template/shtml/resources/css/main.css",
+     "lib/sdoc/generator/template/shtml/resources/css/panel.css",
+     "lib/sdoc/generator/template/shtml/resources/css/reset.css",
+     "lib/sdoc/generator/template/shtml/resources/favicon.ico",
+     "lib/sdoc/generator/template/shtml/resources/i/arrows.png",
+     "lib/sdoc/generator/template/shtml/resources/i/results_bg.png",
+     "lib/sdoc/generator/template/shtml/resources/i/tree_bg.png",
+     "lib/sdoc/generator/template/shtml/resources/js/jquery-1.3.2.min.js",
+     "lib/sdoc/generator/template/shtml/resources/js/main.js",
+     "lib/sdoc/generator/template/shtml/resources/js/searchdoc.js",
+     "lib/sdoc/generator/template/shtml/resources/panel/index.html",
+     "lib/sdoc/github.rb",
+     "lib/sdoc/helpers.rb",
+     "lib/sdoc/merge.rb",
+     "lib/sdoc/templatable.rb",
+     "sdoc.gemspec"
+  ]
+  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.summary = %q{rdoc html with javascript search index.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    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"])
+    else
+      s.add_dependency(%q<json>, [">= 1.1.3"])
+      s.add_dependency(%q<rdoc>, [">= 2.4.2"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 1.1.3"])
+    s.add_dependency(%q<rdoc>, [">= 2.4.2"])
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sdoc
 version: !ruby/object:Gem::Version 
-  version: 0.2.12.1
+  version: 0.2.14
 platform: ruby
 authors: 
 - Volodya Kolesnikov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-24 00:00:00 +04:00
+date: 2009-08-14 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,6 +43,7 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
+- .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -57,9 +58,11 @@ files:
 - lib/sdoc/generator/template/direct/class.rhtml
 - lib/sdoc/generator/template/direct/file.rhtml
 - lib/sdoc/generator/template/direct/index.rhtml
+- lib/sdoc/generator/template/direct/resources/apple-touch-icon.png
 - lib/sdoc/generator/template/direct/resources/css/main.css
 - lib/sdoc/generator/template/direct/resources/css/panel.css
 - lib/sdoc/generator/template/direct/resources/css/reset.css
+- lib/sdoc/generator/template/direct/resources/favicon.ico
 - lib/sdoc/generator/template/direct/resources/i/arrows.png
 - lib/sdoc/generator/template/direct/resources/i/results_bg.png
 - lib/sdoc/generator/template/direct/resources/i/tree_bg.png
@@ -73,9 +76,11 @@ files:
 - lib/sdoc/generator/template/shtml/class.rhtml
 - lib/sdoc/generator/template/shtml/file.rhtml
 - lib/sdoc/generator/template/shtml/index.rhtml
+- lib/sdoc/generator/template/shtml/resources/apple-touch-icon.png
 - lib/sdoc/generator/template/shtml/resources/css/main.css
 - lib/sdoc/generator/template/shtml/resources/css/panel.css
 - lib/sdoc/generator/template/shtml/resources/css/reset.css
+- lib/sdoc/generator/template/shtml/resources/favicon.ico
 - lib/sdoc/generator/template/shtml/resources/i/arrows.png
 - lib/sdoc/generator/template/shtml/resources/i/results_bg.png
 - lib/sdoc/generator/template/shtml/resources/i/tree_bg.png
@@ -87,8 +92,11 @@ files:
 - lib/sdoc/helpers.rb
 - lib/sdoc/merge.rb
 - lib/sdoc/templatable.rb
+- sdoc.gemspec
 has_rdoc: true
 homepage: http://github.com/voloko/sdoc
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -109,9 +117,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.1
+rubygems_version: 1.3.4
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: rdoc html with javascript search index.
 test_files: []