RubyGems - sdoc - Versions diffs - 0.2.12.1 - Mend

sdoc 0.2.12.1

Files changed (45) hide show

data/LICENSE +21 -0
data/README.rdoc +38 -0
data/Rakefile +37 -0
data/VERSION.yml +4 -0
data/bin/sdoc +11 -0
data/bin/sdoc-merge +12 -0
data/lib/rdoc/discover.rb +1 -0
data/lib/sdoc.rb +23 -0
data/lib/sdoc/c_parser_fix.rb +31 -0
data/lib/sdoc/generator/shtml.rb +314 -0
data/lib/sdoc/generator/template/direct/_context.rhtml +172 -0
data/lib/sdoc/generator/template/direct/class.rhtml +40 -0
data/lib/sdoc/generator/template/direct/file.rhtml +30 -0
data/lib/sdoc/generator/template/direct/index.rhtml +14 -0
data/lib/sdoc/generator/template/direct/resources/css/main.css +263 -0
data/lib/sdoc/generator/template/direct/resources/css/panel.css +383 -0
data/lib/sdoc/generator/template/direct/resources/css/reset.css +53 -0
data/lib/sdoc/generator/template/direct/resources/i/arrows.png +0 -0
data/lib/sdoc/generator/template/direct/resources/i/results_bg.png +0 -0
data/lib/sdoc/generator/template/direct/resources/i/tree_bg.png +0 -0
data/lib/sdoc/generator/template/direct/resources/js/jquery-1.3.2.min.js +19 -0
data/lib/sdoc/generator/template/direct/resources/js/jquery-effect.js +593 -0
data/lib/sdoc/generator/template/direct/resources/js/main.js +22 -0
data/lib/sdoc/generator/template/direct/resources/js/searchdoc.js +620 -0
data/lib/sdoc/generator/template/direct/resources/panel/index.html +71 -0
data/lib/sdoc/generator/template/merge/index.rhtml +14 -0
data/lib/sdoc/generator/template/shtml/_context.rhtml +164 -0
data/lib/sdoc/generator/template/shtml/class.rhtml +46 -0
data/lib/sdoc/generator/template/shtml/file.rhtml +37 -0
data/lib/sdoc/generator/template/shtml/index.rhtml +14 -0
data/lib/sdoc/generator/template/shtml/resources/css/main.css +191 -0
data/lib/sdoc/generator/template/shtml/resources/css/panel.css +383 -0
data/lib/sdoc/generator/template/shtml/resources/css/reset.css +53 -0
data/lib/sdoc/generator/template/shtml/resources/i/arrows.png +0 -0
data/lib/sdoc/generator/template/shtml/resources/i/results_bg.png +0 -0
data/lib/sdoc/generator/template/shtml/resources/i/tree_bg.png +0 -0
data/lib/sdoc/generator/template/shtml/resources/js/jquery-1.3.2.min.js +19 -0
data/lib/sdoc/generator/template/shtml/resources/js/main.js +34 -0
data/lib/sdoc/generator/template/shtml/resources/js/searchdoc.js +620 -0
data/lib/sdoc/generator/template/shtml/resources/panel/index.html +71 -0
data/lib/sdoc/github.rb +64 -0
data/lib/sdoc/helpers.rb +26 -0
data/lib/sdoc/merge.rb +217 -0
data/lib/sdoc/templatable.rb +58 -0
metadata +117 -0

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

@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+	"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+<head>
+	<title>layout</title>
+	<link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" charset="utf-8" />
+	<link rel="stylesheet" href="../css/panel.css" type="text/css" media="screen" charset="utf-8" />
+	<script src="search_index.js" type="text/javascript" charset="utf-8"></script>
+	<script src="tree.js" type="text/javascript" charset="utf-8"></script>
+	<script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
+	<script src="../js/searchdoc.js" type="text/javascript" charset="utf-8"></script>
+	<script type="text/javascript" charset="utf-8">
+		//<![CDATA[
+	    function placeholder() {
+ 	       if (jQuery.browser.safari) return;
+ 	       $('#search-label').click(function() {
+ 	           $('#search').focus();
+ 	           $('#search-label').hide();
+ 	       });
+ 	       $('#search').focus(function() {
+ 	           $('#search-label').hide();
+            });
+ 	       $('#search').blur(function() {
+ 	           this.value == '' && $('#search-label').show()
+ 	       });
+ 	       $('#search')[0].value == '' && $('#search-label').show();
+	    }
+	   $(function() {
+           placeholder();
+           var panel = new Searchdoc.Panel($('#panel'), search_data, tree, top.frames[1]);
+           $('#search').focus();
+           var s = window.parent.location.search.match(/\?q=(.*)$/);
+           if (s) {
+               s = decodeURIComponent(s[1]).replace(/\+/g, ' ');
+               if (s.length > 0)
+               {
+                   $('#search').val(s);
+                   panel.search(s, true);
+               }
+           }
+	   })
+		//]]>
+	</script>
+</head>
+<body>
+    <div class="panel panel_tree" id="panel">
+        <div class="header">
+            <div>
+                <label for="search" id="search-label" style="display: none">Search</label>
+                <table>
+                <tr><td>
+                    <input type="Search" placeholder="Search" autosave="searchdoc" results="10" id="search" autocomplete="off"/>
+                </td></tr>
+            </table></div>
+        </div>
+        <div class="tree">
+            <ul>
+            </ul>
+        </div>
+        <div class="result">
+            <ul>
+            </ul>
+        </div>
+    </div>
+</body>
+</html>

data/lib/sdoc/github.rb ADDED

@@ -0,0 +1,64 @@
+module SDoc::GitHub
+  def github_url(path)
+    unless @github_url_cache.has_key? path
+      @github_url_cache[path] = false
+      file = RDoc::TopLevel.find_file_named(path)
+      if file
+        base_url = repository_url(path)
+        if base_url
+          sha1 = commit_sha1(path)
+          if sha1
+            relative_url = path_relative_to_repository(path)
+            @github_url_cache[path] = "#{base_url}#{sha1}#{relative_url}"
+          end
+        end
+      end
+    end
+    @github_url_cache[path]
+  end
+  protected
+  def commit_sha1(path)
+    name = File.basename(path)
+    s = in_dir(File.join(basedir, File.dirname(path))) do
+      `git log -1 --pretty=format:"commit %H" #{name}`
+    end
+    m = s.match(/commit\s+(\S+)/)
+    m ? m[1] : false
+  end
+  def repository_url(path)
+    s = in_dir(File.join(basedir, File.dirname(path))) do
+      `git config --get remote.origin.url`
+    end
+    m = s.match(%r{github.com[/:](.*)\.git$})
+    m ? "http://github.com/#{m[1]}/blob/" : false
+  end
+  def path_relative_to_repository(path)
+    absolute_path = File.join(basedir, path)
+    root = path_to_git_dir(File.dirname(absolute_path))
+    absolute_path[root.size..absolute_path.size]
+  end
+  def path_to_git_dir(path)
+    while !path.empty? && path != '.'
+      if (File.exists? File.join(path, '.git'))
+        return path
+      end
+      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/sdoc/helpers.rb ADDED

@@ -0,0 +1,26 @@
+module SDoc::Helpers
+  def each_letter_group(methods, &block)
+    group = {:name => '', :methods => []}
+    methods.sort{ |a, b| a.name <=> b.name }.each do |method|
+      gname = group_name method.name
+      if gname != group[:name]
+        yield group unless group[:methods].size == 0
+        group = {
+          :name => gname,
+          :methods => []
+        }
+      end
+      group[:methods].push(method)
+    end
+    yield group unless group[:methods].size == 0
+  end
+protected
+  def group_name name
+    if match = name.match(/^([a-z])/i)
+      match[1].upcase
+    else
+      '#'
+    end
+  end
+end

data/lib/sdoc/merge.rb ADDED

@@ -0,0 +1,217 @@
+require 'optparse'
+require 'pathname'
+require 'fileutils'
+require 'json'
+require 'sdoc/templatable'
+class SDoc::Merge
+  include SDoc::Templatable
+  FLAG_FILE = "created.rid"
+  def initialize()
+    @names = []
+    @urls = []
+    @op_dir = 'doc'
+    @title = ''
+    @directories = []
+    template_dir = RDoc::Generator::SHtml.template_dir('merge')
+		@template_dir = Pathname.new File.expand_path(template_dir)
+  end
+  def merge(options)
+    parse_options options
+		@outputdir = Pathname.new( @op_dir )
+    check_directories
+    setup_output_dir
+    setup_names
+    copy_files
+    copy_docs if @urls.empty?
+    merge_search_index
+    merge_tree
+    generate_index_file
+  end
+  def parse_options(options)
+    opts = OptionParser.new do |opt|
+      opt.banner = "Usage: sdoc-merge [options] directories"
+      opt.on("-n", "--names [NAMES]", "Names of merged repositories. Comma separated") do |v|
+        @names = v.split(',').map{|name| name.strip }
+      end
+      opt.on("-o", "--op [DIRECTORY]", "Set the output directory") do |v|
+        @op_dir = v
+      end
+      opt.on("-t", "--title [TITLE]", "Set the title of merged file") do |v|
+        @title = v
+      end
+      opt.on("-u", "--urls [URLS]", "Paths to merged docs. If you \n" +
+                   "set this files and classes won't be actualy copied to merged build") do |v|
+        @urls = v.split(' ').map{|name| name.strip }
+      end
+    end
+    opts.parse! options
+    @directories = options.dup
+  end
+  def merge_tree
+    tree = []
+    @directories.each_with_index do |dir, i|
+      name = @names[i]
+      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
+      item = [
+        name,
+        url + '/' + extract_index_path(dir),
+        '',
+        append_path(subtree, url)
+      ]
+      tree << item
+    end
+    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)
+    end
+  end
+  def append_path subtree, path
+    subtree.map do |item|
+      item[1] = path + '/' + item[1] unless item[1].empty?
+      item[3] = append_path item[3], path
+      item
+    end
+  end
+  def merge_search_index
+    items = []
+    @indexes = {}
+    @directories.each_with_index do |dir, i|
+      name = @names[i]
+      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
+      @indexes[name] = subindex
+      searchIndex = subindex["index"]["searchIndex"]
+      longSearchIndex = subindex["index"]["longSearchIndex"]
+      subindex["index"]["info"].each_with_index do |info, j|
+        info[2] = url + '/' + info[2]
+        info[6] = i
+        items << {
+          :info => info,
+          :searchIndex => searchIndex[j],
+          :longSearchIndex => name + ' ' + longSearchIndex[j]
+        }
+      end
+    end
+    items.sort! do |a, b|
+      # type (class/method/file) or name or doc part or namespace
+      [a[:info][5], a[:info][0], a[:info][6], a[:info][1]] <=> [b[:info][5], b[:info][0], b[:info][6], b[:info][1]]
+    end
+    index = {
+      :searchIndex => items.map{|item| item[:searchIndex]},
+      :longSearchIndex => items.map{|item| item[:longSearchIndex]},
+      :info => items.map{|item| item[:info]}
+    }
+    search_data = {
+      :index => index,
+      :badges => @names
+    }
+    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)
+    end
+  end
+  def extract_index_path dir
+    filename = File.join dir, 'index.html'
+    content = File.open(filename) { |f| f.read }
+    match = content.match(/<frame\s+src="([^"]+)"\s+name="docwin"/mi)
+    if match
+      match[1]
+    else
+      ''
+    end
+  end
+  def generate_index_file
+    templatefile = @template_dir + 'index.rhtml'
+    outfile      = @outputdir + 'index.html'
+    url          = @urls.empty? ? @names[0] : @urls[0]
+    index_path   = url + '/' + extract_index_path(@directories[0])
+    render_template templatefile, binding(), outfile
+  end
+  def setup_names
+    unless @names.size > 0
+      @directories.each do |dir|
+        name = File.basename dir
+        name = File.basename File.dirname(dir) if name == 'doc'
+        @names << name
+      end
+    end
+  end
+  def copy_docs
+    @directories.each_with_index do |dir, i|
+      name = @names[i]
+      index_dir = File.dirname(RDoc::Generator::SHtml::TREE_FILE)
+      FileUtils.mkdir_p(File.join(@op_dir, name))
+      Dir.new(dir).each do |item|
+        if File.directory?(File.join(dir, item)) && item != '.' && item != '..' && item != index_dir
+          FileUtils.cp_r File.join(dir, item), File.join(@op_dir, name, item), :preserve => true
+        end
+      end
+    end
+  end
+  def copy_files
+    dir = @directories.first
+    Dir.new(dir).each do |item|
+      if item != '.' && item != '..' && item != RDoc::Generator::SHtml::FILE_DIR && item != RDoc::Generator::SHtml::CLASS_DIR
+        FileUtils.cp_r File.join(dir, item), @op_dir, :preserve => true
+      end
+    end
+  end
+  def setup_output_dir
+    if File.exists? @op_dir
+      error "#{@op_dir} allready exists"
+    end
+    FileUtils.mkdir_p @op_dir
+  end
+  def check_directories
+    @directories.each do |dir|
+      unless File.exists?(File.join(dir, FLAG_FILE)) &&
+      File.exists?(File.join(dir, RDoc::Generator::SHtml::TREE_FILE)) &&
+      File.exists?(File.join(dir, RDoc::Generator::SHtml::SEARCH_INDEX_FILE))
+        error "#{dir} does not seem to be an sdoc directory"
+      end
+    end
+  end
+  ##
+  # Report an error message and exit
+  def error(msg)
+    raise RDoc::Error, msg
+  end
+end

data/lib/sdoc/templatable.rb ADDED

@@ -0,0 +1,58 @@
+require "sdoc"
+module SDoc::Templatable
+	### Load and render the erb template in the given +templatefile+ within the
+	### specified +context+ (a Binding object) and return output
+	### Both +templatefile+ and +outfile+ should be Pathname-like objects.
+  def eval_template(templatefile, context)
+		template_src = templatefile.read
+		template = ERB.new( template_src, nil, '<>' )
+		template.filename = templatefile.to_s
+    begin
+      template.result( context )
+    rescue NoMethodError => err
+      raise RDoc::Error, "Error while evaluating %s: %s (at %p)" % [
+        templatefile.to_s,
+        err.message,
+        eval( "_erbout[-50,50]", context )
+        ], err.backtrace
+      end
+  end
+  ### Load and render the erb template with the given +template_name+ within
+  ### current context. Adds all +local_assigns+ to context
+  def include_template(template_name, local_assigns = {})
+    source = local_assigns.keys.map { |key| "#{key} = local_assigns[:#{key}];" }.join
+    eval("#{source};templatefile = @template_dir + template_name;eval_template(templatefile, binding)")
+  end
+	### Load and render the erb template in the given +templatefile+ within the
+	### specified +context+ (a Binding object) and write it out to +outfile+.
+	### Both +templatefile+ and +outfile+ should be Pathname-like objects.
+	def render_template( templatefile, context, outfile )
+    output = eval_template(templatefile, context)
+    # TODO delete this dirty hack when documentation for example for GeneratorMethods will not be cutted off by <script> tag
+    begin
+      if output.respond_to? :force_encoding
+        encoding = output.encoding
+        output = output.force_encoding('ASCII-8BIT').gsub('<script>', '&lt;script;&gt;').force_encoding(encoding)
+      else
+        output = output.gsub('<script>', '&lt;script&gt;')
+      end
+    rescue Exception => e
+    end
+		unless $dryrun
+			outfile.dirname.mkpath
+			outfile.open( 'w', 0644 ) do |file|
+				file.print( output )
+			end
+		else
+			debug_msg "  would have written %d bytes to %s" %
+			[ output.length, outfile ]
+		end
+	end
+end

metadata ADDED

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: sdoc
+version: !ruby/object:Gem::Version
+  version: 0.2.12.1
+platform: ruby
+authors:
+- Volodya Kolesnikov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-04-24 00:00:00 +04:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+    version:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.2
+    version:
+description:
+email: voloko@gmail.com
+executables:
+- sdoc
+- sdoc-merge
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- 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/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/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/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/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
+has_rdoc: true
+homepage: http://github.com/voloko/sdoc
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.1
+signing_key:
+specification_version: 2
+summary: rdoc html with javascript search index.
+test_files: []