wpdoc 0.2.17 → 0.2.20

data/Rakefile

@@ -28,7 +28,7 @@ begin
     gem.email = "voloko@gmail.com"
     gem.homepage = "http://github.com/dxw/wpdoc"
     gem.authors = ["Volodya Kolesnikov"]
-    gem.add_dependency("rdoc", ">= 2.4.2")
+    gem.add_dependency("rdoc", "= 2.4.3")
     
     if defined?(JRUBY_VERSION)
       gem.platform = Gem::Platform.new(['universal', 'java', nil])
@@ -47,5 +47,5 @@ begin
     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"
+  puts "Jeweler not available. Install it with: (sudo) gem install jeweler"
 end

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:patch: 17
+:patch: 20
 :major: 0
 :build: 
 :minor: 2

data/lib/sdoc/json_backend.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+
+## undefined method `to_json' for Array :(
+# if Gem.available? "yajl-ruby"
+#   gem "yajl-ruby", ">= 0.7.6"
+#   require "yajl"
+#   warn "yajl"
+# else
+  if Gem.available? "json"
+    gem "json", ">= 1.1.3"
+  else
+    gem "json_pure", ">= 1.1.3"
+  end
+  require "json"
+# end

data/lib/wpdoc.rb

@@ -1,6 +1,5 @@
 $:.unshift File.dirname(__FILE__)
 require "rubygems"
-gem "rdoc", ">= 2.4.2"
 
 require "rdoc/rdoc"
 

data/lib/wpdoc/generator/shtml.rb

@@ -1,13 +1,5 @@
-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 'sdoc/json_backend'
 require 'iconv'
-require 'json'
 require 'pathname'
 require 'fileutils'
 require 'erb'
@@ -123,7 +115,7 @@ class RDoc::Generator::SHtml
     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)
+      f.write('var tree = '); f.write(tree.to_json(:max_nesting => 0))
     end unless $dryrun
   end
 
@@ -162,7 +154,7 @@ class RDoc::Generator::SHtml
       :index => index
     }
     File.open(SEARCH_INDEX_FILE, "w", 0644) do |f|
-      f.write('var search_data = '); f.write(data.to_json)
+      f.write('var search_data = '); f.write(data.to_json(:max_nesting => 0))
     end unless $dryrun
   end
 
@@ -295,11 +287,11 @@ class RDoc::Generator::SHtml
     content = content.sub(/^(.{100,}?)\s.*/m, "\\1").gsub(/\r?\n/m, ' ')
 
     begin
-      content.to_json
+      content.to_json(:max_nesting => 0)
     rescue # might fail on non-unicode string
       begin
         content = Iconv.conv('latin1//ignore', "UTF8", content) # remove all non-unicode chars
-        content.to_json
+        content.to_json(:max_nesting => 0)
       rescue
         content = '' # something hugely wrong happend
       end

data/lib/wpdoc/generator/template/direct/_context.rhtml

@@ -31,7 +31,7 @@
         end
     %>
     <% unless list.empty? %>
-    <div class="sectiontitle">Methods</div>
+    <div class="sectiontitle">Functions</div>
     <dl class="methods">
     <% each_letter_group(list) do |group| %>
         <dt><%= group[:name] %></dt>
@@ -72,10 +72,10 @@
     <% end %>
 
     <% unless context.classes_and_modules.empty? %>
-    <div class="sectiontitle">Classes and Modules</div>
+    <div class="sectiontitle"><%= context.full_name == 'Global' ? 'Index' : 'Classes and Modules' %></div>
     <ul>
         <% (context.modules.sort + context.classes.sort).each do |mod| %>
-        <li><span class="type"><%= mod.type.upcase %></span> <a href="<%= context.aref_to mod.path %>"><%= mod.full_name %></a></li>
+        <li><span class="type"><%= context.full_name == 'Global' ? '' : mod.type.upcase %></span> <a href="<%= context.aref_to mod.path %>"><%= context.full_name == 'Global' ? mod.name : mod.full_name %></a></li>
         <% end %>
     </ul>
     <% end %>
@@ -120,7 +120,7 @@
             next if methods.empty? 
             next unless @options.show_all || visibility == :public || visibility == :protected || methods.any? {|m| m.force_documentation }
             %>
-            <div class="sectiontitle"><%= type.capitalize %> <%= visibility.to_s.capitalize %> methods</div>
+            <div class="sectiontitle"><%= type.capitalize %> <%= visibility.to_s.capitalize %> functions</div>
             <% methods.each do |method| %>
             <div class="method">
                 <div class="title" id="<%= method.aref %>">
@@ -137,7 +137,7 @@
                 <% end %>
                 <% unless method.aliases.empty? %>
                 <div class="aka">
-                    This method is also aliased as
+                    This function is also aliased as
                     <% method.aliases.each do |aka| %>
                     <a href="<%= context.aref_to aka.path %>"><%= h aka.name %></a>
                     <% end %>

data/lib/wpdoc/generator/template/direct/class.rhtml

@@ -14,26 +14,31 @@
 
 <body>     
     <div class="banner">
-        <h1>
-            <% if klass.full_name != 'Global' %>
-            <span class="type"><%= klass.module? ? 'Module' : 'Class' %></span> 
-            <% end %>
-            <%= h klass.full_name %> 
-            <% if klass.type == 'class' && !klass.superclass.nil? %>
-                <span class="parent">&lt; 
-                    <% if String === klass.superclass %>
-                    <%= klass.superclass %>
-                    <% elsif !klass.superclass.nil? %>
-                    <a href="<%= klass.aref_to klass.superclass.path %>"><%= h klass.superclass.full_name %></a>
-                    <% end %>
-                </span>
-            <% end %>
-        </h1>
-        <ul class="files">
-            <% klass.in_files.each do |file| %>
-            <li><a href="<%= "#{rel_prefix}/#{h file.path}" %>"><%= h file.absolute_name %></a></li>
-            <% end  %>
-        </ul>
+        <div class="grr_container">
+          <h1>
+              <% if klass.parent && klass.parent.full_name != 'Global' && klass.full_name != 'Global' %>
+              <span class="type"><%= klass.module? ? 'Module' : 'Class' %></span> 
+              <% end %>
+              <%= h klass.full_name %> 
+              <% if klass.type == 'class' && !klass.superclass.nil? %>
+                  <span class="parent">&lt; 
+                      <% if String === klass.superclass %>
+                      <%= klass.superclass %>
+                      <% elsif !klass.superclass.nil? %>
+                      <a href="<%= klass.aref_to klass.superclass.path %>"><%= h klass.superclass.full_name %></a>
+                      <% end %>
+                  </span>
+              <% end %>
+          </h1>
+          <ul class="files">
+              <% klass.in_files.each do |file| %>
+              <li><a href="<%= "#{rel_prefix}/#{h file.path}" %>"><%= h file.absolute_name %></a></li>
+              <% end  %>
+          </ul>
+        </div>
+        <div class="logo">
+          <a target="_blank" href="http://thedextrousweb.com">The Dextrous Web</a>
+        </div>
     </div>
     <div id="bodyContent">
         <%= include_template '_context.rhtml', {:context => klass, :rel_prefix => rel_prefix} %>

data/lib/wpdoc/generator/template/direct/file.rhtml

@@ -14,17 +14,22 @@
 
 <body>     
     <div class="banner">
-        <h1>
-            <%= h file.name %>
-        </h1>
-        <ul class="files">
-            <li><%= h file.relative_name %></li>
-            <li>Last modified: <%= file.file_stat.mtime %></li>
-        </ul>
+        <div class="grr_container">
+          <h1>
+              <%= h file.name %>
+          </h1>
+          <ul class="files">
+              <li><%= h file.relative_name %></li>
+              <li>Last modified: <%= file.file_stat.mtime %></li>
+          </ul>
+        </div>
+        <div class="logo">
+          <a target="_blank" href="http://thedextrousweb.com">The Dextrous Web</a>
+        </div>
     </div>
 
     <div id="bodyContent">
         <%= include_template '_context.rhtml', {:context => file, :rel_prefix => rel_prefix} %>
     </div>
   </body>
-</html>
+</html>

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

@@ -105,7 +105,13 @@ ol li
     background: #EDF3FE;
     border-bottom: 1px solid #ccc;
     padding: 1em 2em 0.5em 2em;
+    overflow: auto;
 }
+.banner .grr_container
+{
+  float: left
+}
+
 .banner h1
 {
     font-size: 1.2em;
@@ -138,6 +144,16 @@ ol li
     margin-bottom: 0;
 }
 
+.banner div.logo a
+{
+    background: url(../dextrous_web.png);
+    text-indent: -9999px;
+    width: 292px;
+    height: 62px;
+    float: right;
+    margin-bottom: 0.5em
+}
+
 pre 
 {
     margin-bottom: 1em;

data/lib/wpdoc/github.rb

@@ -18,10 +18,16 @@ module SDoc::GitHub
   end
   
   protected
-  
+
+  def have_git?
+    @have_git = system('git --version > /dev/null 2>&1') if @have_git.nil?
+    @have_git
+  end
+
   def commit_sha1(path)
+    return false unless have_git?
     name = File.basename(path)
-    s = in_dir(File.join(basedir, File.dirname(path))) do
+    s = Dir.chdir(File.join(basedir, File.dirname(path))) do
       `git log -1 --pretty=format:"commit %H" #{name}`
     end
     m = s.match(/commit\s+(\S+)/)
@@ -29,7 +35,8 @@ module SDoc::GitHub
   end
   
   def repository_url(path)
-    s = in_dir(File.join(basedir, File.dirname(path))) do
+    return false unless have_git?
+    s = Dir.chdir(File.join(basedir, File.dirname(path))) do
       `git config --get remote.origin.url`
     end
     m = s.match(%r{github.com[/:](.*)\.git$})
@@ -50,15 +57,5 @@ module SDoc::GitHub
       path = File.dirname(path)
     end
     ''
-  end  
-  
-  def in_dir(dir)
-    pwd = Dir.pwd
-    Dir.chdir dir
-    return yield
-  rescue Exception => e
-    return ''
-  ensure
-    Dir.chdir pwd
   end
 end

data/lib/wpdoc/merge.rb

@@ -2,9 +2,7 @@ require 'optparse'
 require 'pathname'
 require 'fileutils'
 
-gem 'json_pure', '>= 1.1.3' if defined?(::JRUBY_VERSION)
-require 'json'
-
+require 'wpdoc/json_backend'
 require 'wpdoc/templatable'
 
 class SDoc::Merge
@@ -69,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, :max_nesting => 35
+      subtree = JSON.parse(data, :max_nesting => 0)
       item = [
         name,
         url + '/' + extract_index_path(dir),
@@ -82,7 +80,7 @@ class SDoc::Merge
     dst = File.join @op_dir, RDoc::Generator::SHtml::TREE_FILE
     FileUtils.mkdir_p File.dirname(dst)
     File.open(dst, "w", 0644) do |f|
-      f.write('var tree = '); f.write(tree.to_json)
+      f.write('var tree = '); f.write(tree.to_json(:max_nesting => 0))
     end
   end
   
@@ -102,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, :max_nesting => 35
+      subindex = JSON.parse(data, :max_nesting => 0)
       @indexes[name] = subindex
       
       searchIndex = subindex["index"]["searchIndex"]
@@ -135,7 +133,7 @@ class SDoc::Merge
     dst = File.join @op_dir, RDoc::Generator::SHtml::SEARCH_INDEX_FILE
     FileUtils.mkdir_p File.dirname(dst)
     File.open(dst, "w", 0644) do |f|
-      f.write('var search_data = '); f.write(search_data.to_json)
+      f.write('var search_data = '); f.write(search_data.to_json(:max_nesting => 0))
     end
   end
   
@@ -216,4 +214,4 @@ class SDoc::Merge
     raise RDoc::Error, msg
   end
   
-end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 17
-  version: 0.2.17
+  - 20
+  version: 0.2.20
 platform: ruby
 authors: 
 - Volodya Kolesnikov
@@ -14,27 +14,29 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-29 00:00:00 +01:00
+date: 2011-03-25 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rdoc
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         segments: 
         - 2
         - 4
-        - 2
-        version: 2.4.2
+        - 3
+        version: 2.4.3
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: json
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -56,7 +58,6 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
-- .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -64,6 +65,7 @@ files:
 - bin/wpdoc
 - bin/wpdoc-merge
 - lib/rdoc/discover.rb
+- lib/sdoc/json_backend.rb
 - lib/wpdoc.rb
 - lib/wpdoc/c_parser_fix.rb
 - lib/wpdoc/generator/shtml.rb
@@ -75,6 +77,7 @@ files:
 - lib/wpdoc/generator/template/direct/resources/css/main.css
 - lib/wpdoc/generator/template/direct/resources/css/panel.css
 - lib/wpdoc/generator/template/direct/resources/css/reset.css
+- lib/wpdoc/generator/template/direct/resources/dextrous_web.png
 - lib/wpdoc/generator/template/direct/resources/favicon.ico
 - lib/wpdoc/generator/template/direct/resources/i/arrows.png
 - lib/wpdoc/generator/template/direct/resources/i/results_bg.png
@@ -94,11 +97,12 @@ homepage: http://github.com/dxw/wpdoc
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -106,6 +110,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -115,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: rdoc html with javascript search index.

data/.gitignore

@@ -1,4 +0,0 @@
-pkg
-doc
-/test.rb
-wpdoc.gemspec