sdoc 0.3.16 → 0.3.17

data/README.md

@@ -0,0 +1,66 @@
+# SDoc
+
+**Powering http://api.rubyonrails.org/ and http://railsapi.com/**
+
+### What is sdoc?
+
+RDoc generator to build searchable HTML documentation for Ruby code.
+
+* `sdoc` - command line tool to run rdoc with `generator=shtml` (searchable HTML)
+* `sdoc-merge` - comand line tool to merge multiple sdoc folders into a single documentation site
+
+
+### Getting Started
+
+```bash
+  # Install the gem
+  gem install sdoc
+
+  # Generate documentation for 'projectdir'
+  sdoc projectdir
+```
+
+### sdoc
+
+`sdoc` is simply a wrapper for the `rdoc` command line tool. See `sdoc --help`
+for more details. `--fmt` is set to `shtml` by default. The default template `-T` is `shtml`, but you can also use the `direct` template.
+
+Example:
+
+```bash
+sdoc -o doc/rails -T direct rails
+```
+
+### sdoc-merge
+
+<pre>
+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
+</pre>
+
+Example:
+
+```bash
+sdoc-merge --title "Ruby v1.9, Rails v2.3.2.1" --op merged --names "Ruby,Rails" ruby-v1.9 rails-v2.3.2.1
+```
+
+### Rake Task
+
+```ruby
+# 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
+```
+
+# Who?
+
+* Vladimir Kolesnikov ([voloko](https://github.com/voloko))
+* Nathan Broadbent ([ndbroadbent](https://github.com/ndbroadbent))

data/lib/rdoc/generator/template/rails/_context.rhtml

@@ -150,10 +150,11 @@
         <div class="method">
           <div class="title method-title" id="<%= method.aref %>">
             <% if method.call_seq %>
-              <a name="<%= method.aref %>"></a><b><%= method.call_seq.gsub(/->/, '&rarr;') %></b>
+              <b><%= method.call_seq.gsub(/->/, '&rarr;') %></b>
             <% else %>
-              <a name="<%= method.aref %>"></a><b><%= h method.name %></b><%= h method.params %>
+              <b><%= h method.name %></b><%= h method.params %>
             <% end %>
+            <a href="<%= "#{rel_prefix}/#{context.path}##{method.aref}"%>" name="<%= method.aref %>" class="permalink">Link</a>
           </div>
           
           <% if method.comment %>
@@ -206,4 +207,4 @@
       <% end #visibilities.each %>
     <% end #context.methods_by_type %>
   <% end #context.each_section %>
-</div>
+</div>

data/lib/rdoc/generator/template/rails/resources/css/main.css

@@ -280,6 +280,13 @@ tt {
     margin: 0 0 0.5em 0;
     font-size: 1.2em;
     line-height: 1.25em;
+    position: relative;
+}
+
+.method .method-title a.permalink {
+  position: absolute;
+  font-size: 0.75em;
+  right: 0;
 }
 
 .method .sourcecode p.source-link {

data/lib/rdoc/generator/template/sdoc/_context.rhtml

@@ -150,10 +150,11 @@
         <div class="method">
           <div class="title method-title" id="<%= method.aref %>">
             <% if method.call_seq %>
-              <a name="<%= method.aref %>"></a><b><%= method.call_seq.gsub(/->/, '&rarr;') %></b>
+              <b><%= method.call_seq.gsub(/->/, '&rarr;') %></b>
             <% else %>
-              <a name="<%= method.aref %>"></a><b><%= h method.name %></b><%= h method.params %>
+              <b><%= h method.name %></b><%= h method.params %>
             <% end %>
+            <a href="<%= "#{rel_prefix}/#{context.path}##{method.aref}"%>" name="<%= method.aref %>" class="permalink">Link</a>
           </div>
           
           <% if method.comment %>
@@ -206,4 +207,4 @@
       <% end #visibilities.each %>
     <% end #context.methods_by_type %>
   <% end #context.each_section %>
-</div>
+</div>

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

@@ -267,6 +267,13 @@ tt {
     margin: 0 0 0.5em 0;
     font-size: 1.2em;
     line-height: 1.25em;
+    position: relative;
+}
+
+.method .method-title a.permalink {
+  position: absolute;
+  font-size: 0.75em;
+  right: 0;
 }
 
 .method .sourcecode p.source-link {

data/lib/sdoc/generator.rb

@@ -199,7 +199,7 @@ class RDoc::Generator::SDoc
     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(:max_nesting => 0))
-    end unless $dryrun
+    end unless @options.dry_run
   end
 
   ### Recursivly build class tree structure
@@ -306,7 +306,7 @@ class RDoc::Generator::SDoc
       rel_prefix  = @outputdir.relative_path_from( outfile.dirname )
 
       debug_msg "  rendering #{outfile}"
-      self.render_template( templatefile, binding(), outfile )
+      self.render_template( templatefile, binding(), outfile ) unless @options.dry_run
     end
   end
 
@@ -321,7 +321,7 @@ class RDoc::Generator::SDoc
       rel_prefix  = @outputdir.relative_path_from( outfile.dirname )
 
       debug_msg "  rendering #{outfile}"
-      self.render_template( templatefile, binding(), outfile )
+      self.render_template( templatefile, binding(), outfile ) unless @options.dry_run
     end
   end
 
@@ -348,7 +348,7 @@ class RDoc::Generator::SDoc
     templatefile = @template_dir + 'index.rhtml'
     outfile      = @outputdir + 'index.html'
 
-    self.render_template( templatefile, binding(), outfile )
+    self.render_template( templatefile, binding(), outfile ) unless @options.dry_run
   end
 
   ### Generate file with links for the search engine
@@ -357,14 +357,14 @@ class RDoc::Generator::SDoc
     templatefile = @template_dir + 'se_index.rhtml'
     outfile      = @outputdir + 'panel/links.html'
 
-    self.render_template( templatefile, binding(), outfile )
+    self.render_template( templatefile, binding(), outfile ) unless @options.dry_run
   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
+    FileUtils.cp_r resoureces_path.to_s, @outputdir.to_s, :preserve => true unless @options.dry_run
   end
 
   class FilesTree

data/lib/sdoc/github.rb

@@ -27,7 +27,7 @@ module SDoc::GitHub
   def commit_sha1(path)
     return false unless have_git?
     name = File.basename(path)
-    s = Dir.chdir(File.join(basedir, File.dirname(path))) do
+    s = Dir.chdir(File.join(base_dir, File.dirname(path))) do
       `git log -1 --pretty=format:"commit %H" #{name}`
     end
     m = s.match(/commit\s+(\S+)/)
@@ -36,7 +36,7 @@ module SDoc::GitHub
   
   def repository_url(path)
     return false unless have_git?
-    s = Dir.chdir(File.join(basedir, File.dirname(path))) do
+    s = Dir.chdir(File.join(base_dir, File.dirname(path))) do
       `git config --get remote.origin.url`
     end
     m = s.match(%r{github.com[/:](.*)\.git$})
@@ -44,7 +44,7 @@ module SDoc::GitHub
   end
 
   def path_relative_to_repository(path)
-    absolute_path = File.join(basedir, path)
+    absolute_path = File.join(base_dir, path)
     root = path_to_git_dir(File.dirname(absolute_path))
     absolute_path[root.size..absolute_path.size]
   end

data/lib/sdoc/merge.rb

@@ -2,7 +2,7 @@ require 'optparse'
 require 'pathname'
 require 'fileutils'
 
-if Gem.available? "json"
+if Gem::Specification.respond_to?(:find_by_name) ? Gem::Specification::find_by_name("json") : Gem.available?("json")
   gem "json", ">= 1.1.3"
 else
   gem "json_pure", ">= 1.1.3"

data/sdoc.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "sdoc"
-  s.version = "0.3.16"
+  s.version = "0.3.17"
 
   s.authors = ["Vladimir Kolesnikov"]
   s.description = %q{rdoc generator html with javascript search index.}
@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
     s.respond_to? :required_rubygems_version=
 
   s.rdoc_options = ["--charset=UTF-8"]
-  s.extra_rdoc_files = ["README.rdoc"]
+  s.extra_rdoc_files = ["README.md"]
 
   s.add_runtime_dependency('rdoc', "~> 3.10")
   if defined?(JRUBY_VERSION)

metadata

@@ -1,68 +1,61 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sdoc
-version: !ruby/object:Gem::Version 
-  hash: 51
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 16
-  version: 0.3.16
+version: !ruby/object:Gem::Version
+  version: 0.3.17
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Vladimir Kolesnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-08 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rdoc
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 3
-        - 10
-        version: "3.10"
+      - !ruby/object:Gem::Version
+        version: '3.10'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 1
-        - 1
-        - 3
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.1.3
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
 description: rdoc generator html with javascript search index.
 email: voloko@gmail.com
-executables: 
+executables:
 - sdoc
 - sdoc-merge
 extensions: []
-
-extra_rdoc_files: 
-- README.rdoc
-files: 
+extra_rdoc_files:
+- README.md
+files:
 - .gitignore
 - .rake_tasks~
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - bin/sdoc
 - bin/sdoc-merge
@@ -117,41 +110,30 @@ files:
 - 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: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: rdoc html with javascript search index.
 test_files: []
-
+has_rdoc: 

data/README.rdoc

@@ -1,37 +0,0 @@
-= 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
-    sudo gem install 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>