sdoc_local_editor 0.3.17

data/.gitignore

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

data/.rake_tasks~

@@ -0,0 +1,20 @@
+build
+check_dependencies
+check_dependencies:development
+check_dependencies:runtime
+gem_file_list
+gemspec
+gemspec:debug
+gemspec:generate
+gemspec:validate
+ghost
+git:release
+github:release
+install
+release
+test
+version
+version:bump:major
+version:bump:minor
+version:bump:patch
+version:write

data/LICENSE

@@ -0,0 +1,110 @@
+Copyright (c) 2011 Vladimir Kolesnikov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+
+Darkfish RDoc HTML Generator
+
+Copyright (c) 2007, 2008, Michael Granger. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the author/s, nor the names of the project's
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+RDoc is copyrighted free software.
+
+You can redistribute it and/or modify it under either the terms of the GPL
+version 2 (see the file GPL), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+          modifications to Usenet or an equivalent medium, or by allowing
+          the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
+
+       a) distribute the binaries and library files of the software,
+          together with instructions (in the manual page or equivalent)
+          on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+          the software.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under these terms.
+
+     For the list of those files and their copying conditions, see the
+     file LEGAL.
+
+  5. The scripts and library files supplied as input to or produced as
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them,
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/README.rdoc

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

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+gem 'rspec', '>= 2.5.0'
+require 'rspec/core/rake_task'
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+task :test => :spec

data/bin/sdoc_local_editor

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby -KU
+require 'sdoc_local_editor'
+
+begin
+  ARGV.push('--format=sdoc') if ARGV.grep(/\A(-f|--fmt|--format|-r|-R|--ri|--ri-site)\b/).empty?
+  r = RDoc::RDoc.new
+  r.document ARGV
+rescue SystemExit
+  raise
+rescue Exception => e
+  if $DEBUG_RDOC then
+    $stderr.puts e.message
+    $stderr.puts "#{e.backtrace.join "\n\t"}"
+    $stderr.puts
+  elsif Interrupt === e then
+    $stderr.puts
+    $stderr.puts 'Interrupted'
+  else
+    $stderr.puts "uh-oh! RDoc had a problem:"
+    $stderr.puts e.message
+    $stderr.puts
+    $stderr.puts "run with --debug for full backtrace"
+  end
+
+  exit 1
+end
+

data/bin/sdoc_local_editor_merge

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby -KU
+require File.dirname(__FILE__) + '/../lib/sdoc_local_editor' # add extensions
+require 'sdoc_local_editor/merge'
+
+begin
+  m = SDoc::Merge.new
+  m.merge(ARGV)
+rescue SystemExit
+  raise
+rescue Exception => e
+  if $DEBUG_RDOC then
+    $stderr.puts e.message
+    $stderr.puts "#{e.backtrace.join "\n\t"}"
+    $stderr.puts
+  elsif Interrupt === e then
+    $stderr.puts
+    $stderr.puts 'Interrupted'
+  else
+    $stderr.puts "uh-oh! SDoc merge had a problem:"
+    $stderr.puts e.message
+  end
+  exit 1
+end
+

data/lib/rdoc/discover.rb

@@ -0,0 +1,5 @@
+begin
+  gem 'rdoc', '~> 3'
+  require File.join(File.dirname(__FILE__), '/../sdoc_local_editor')
+rescue Gem::LoadError
+end

data/lib/rdoc/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=utf-8"/>
+
+	<title><%= @title %></title>
+</head>
+<frameset cols="300,*" frameborder="1" border="1" bordercolor="#999999" framespacing="1">
+    <frame src="panel/index.html" title="Search" name="panel" />
+    <frame src="<%= index_path %>" name="docwin" />
+</frameset>
+</html>

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

@@ -0,0 +1,210 @@
+<div id="content">
+  <% unless (description = context.description).empty? %>
+    <div class="description">
+      <%= description %>
+    </div>
+  <% end %>
+
+
+  <% unless context.requires.empty? %>
+    <!-- File only: requires -->
+    <div class="sectiontitle">Required Files</div>
+    <ul>
+      <% context.requires.each do |req| %>
+        <li><%= h req.name %></li>
+      <% end %>
+    </ul>
+  <% end %>
+
+
+  <% sections = context.sections.select { |s| s.title }.sort_by{ |s| s.title.to_s } %>
+  <% unless sections.empty? then %>
+    <!-- Sections -->
+    <div class="sectiontitle">Sections</div>
+    <ul>
+      <% sections.each do |section| %>
+        <li><a href="#<%= section.aref %>"><%= h section.title %></a></li>
+      <% end %>
+    </ul>
+  <% end %>
+
+
+  <% unless context.classes_and_modules.empty? %>
+    <!-- Namespace -->
+    <div class="sectiontitle">Namespace</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>
+      <% end %>
+    </ul>
+  <% end %>
+
+
+  <% unless context.method_list.empty? %>
+    <!-- Method ref -->
+    <div class="sectiontitle">Methods</div>
+    <dl class="methods">
+      <% each_letter_group(context.method_list) do |group| %>
+        <dt><%= group[:name] %></dt>
+        <dd>
+          <ul>
+            <% group[:methods].each_with_index do |method, i|  %>
+              <%
+                comma = group[:methods].size == i+1 ? '' : ','
+              %>
+              <li>
+                <a href="#<%= method.aref %>"><%= h method.name %></a><%= comma %>
+              </li>
+            <% end %>
+          </ul>
+        </dd>
+      <% end %>
+    </dl>
+  <% end %>
+
+  <% unless context.includes.empty? %>
+    <!-- Includes -->
+    <div class="sectiontitle">Included Modules</div>
+    <ul>
+      <% context.includes.each do |inc| %>
+        <li>
+          <% unless String === inc.module %>
+            <a href="<%= context.aref_to inc.module.path %>">
+              <%= h inc.module.full_name %>
+            </a>
+          <% else %>
+            <%= h inc.name %>
+          <% end %>
+        </li>
+      <% end %>
+    </ul>
+  <% end %>
+
+
+
+  <% context.each_section do |section, constants, attributes| %>
+
+    <% if section.title then %>
+      <div class="contenttitle" id="<%= h section.aref %>">
+        <%= h section.title %>
+      </div>
+    <% end %>
+
+    <% if section.comment then %>
+      <div class="description">
+        <%= section.description %>
+      </div>
+    <% end %>
+
+    <% unless constants.empty? %>
+      <!-- Section constants -->
+      <div class="sectiontitle">Constants</div>
+      <table border='0' cellpadding='5'>
+        <% context.each_constant do |const| %>
+          <tr valign='top'>
+            <td class="attr-name"><%= h const.name %></td>
+            <td>=</td>
+            <td class="attr-value"><%= h const.value %></td>
+          </tr>
+          <% if const.comment %>
+            <tr valign='top'>
+              <td>&nbsp;</td>
+              <td colspan="2" class="attr-desc"><%= const.description.strip %></td>
+            </tr>
+          <% end %>
+        <% end %>
+      </table>
+    <% end %>
+
+
+    <% unless attributes.empty? %>
+      <!-- Section attributes -->
+      <div class="sectiontitle">Attributes</div>
+      <table border='0' cellpadding='5'>
+        <% attributes.each do |attrib| %>
+          <tr valign='top'>
+            <td class='attr-rw'>
+              [<%= attrib.rw %>]
+            </td>
+            <td class='attr-name'><%= h attrib.name %></td>
+            <td class='attr-desc'><%= attrib.description.strip %></td>
+          </tr>
+        <% end %>
+      </table>
+    <% end %>
+
+
+    <!-- Methods -->
+    <%
+      context.methods_by_type(section).each do |type, visibilities|
+        next if visibilities.empty?
+
+        visibilities.each do |visibility, methods|
+          next if methods.empty?
+    %>
+      <div class="sectiontitle"><%= type.capitalize %> <%= visibility.to_s.capitalize %> methods</div>
+      <% methods.each do |method| %>
+        <div class="method">
+          <div class="title method-title" id="<%= method.aref %>">
+            <% if method.call_seq %>
+              <b><%= method.call_seq.gsub(/->/, '&rarr;') %></b>
+            <% else %>
+              <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 %>
+            <div class="description">
+              <%= method.description.strip %>
+            </div>
+          <% end %>
+          
+          <% unless method.aliases.empty? %>
+            <div class="aka">
+              Also aliased as: <%= method.aliases.map do |aka|
+                if aka.parent then # HACK lib/rexml/encodings
+                  %{<a href="#{context.aref_to aka.path}">#{h aka.name}</a>}
+                else
+                  h aka.name
+                end
+              end.join ", " %>
+            </div>
+          <% end %>
+          
+          <% if method.token_stream %>
+            <% markup = method.sdoc_markup_code %>
+            <div class="sourcecode">
+              <%
+                # generate github link
+                github = if options.github
+                  if markup =~ /File\s(\S+), line (\d+)/
+                    path = $1
+                    line = $2.to_i
+                  end
+                  path && github_url(path)
+                else
+                  false
+                end
+              %>
+              <p class="source-link">
+                Source: 
+                <a href="javascript:toggleSource('<%= method.aref %>_source')" id="l_<%= method.aref %>_source">show</a>
+                <% if github %>
+                  | <a href="<%= "#{github}#L#{line}" %>" target="_blank" class="github_url">on GitHub</a>
+                <% end %>
+              </p>
+              <div id="<%= method.aref %>_source" class="dyn-source">
+                <pre><%= markup %></pre>
+              </div>
+            </div>
+            <% end %>
+          </div>
+        <% end #methods.each %>
+      <% end #visibilities.each %>
+    <% end #context.methods_by_type %>
+  <% end #context.each_section %>
+</div>