jeffreyhunter77-R2Doc 0.1

data/lib/r2doc/template/r2doc/rdoc.js.erb

@@ -0,0 +1,164 @@
+rdoc.searchList = [<%= (@classes + complete_method_list).sort{|a,b| a.name <=> b.name}.collect{|c| (c.is_method_context?) ? "{display_name:\"#{c.name}\",description:\"(#{c.context.parent.full_name})\",href:\"#{c.path}\"}" : "{display_name:\"#{c.name}\",description:\"\",href:\"#{c.path}\"}"}.join(",") %>];
+
+/**
+ * Auto completion for search box
+ */
+rdoc.SearchAutoCompleter = Class.create();
+Object.extend(rdoc.SearchAutoCompleter.prototype, rdoc.CustomAutoCompleter.prototype);
+Object.extend(rdoc.SearchAutoCompleter.prototype, {
+  /**
+   * Constructor
+   *
+   * @param elem   The element or id to preform autocompletion for
+   * @param chooser The element or id of the window that diplays the choices
+   */
+  initialize: function(elem, chooser) {
+    this.baseInitialize(elem, chooser);
+  },  
+  
+  /**
+   * Retrieve the list of options for autocompletion
+   */
+  delayedUpdate: function() {
+    this.selectedIndex = (this.selectedIndex || this.selectedIndex == 0) ? 0 : null
+    this.newSelections(rdoc.searchList, true);
+  },
+  
+  /**
+   * Called when a pure text entry is selected
+   */
+  determineIds: function() {
+    // no special action needed
+  },
+  
+  /**
+   * Called when a particular item in the list is selected
+   */
+  setIds: function(result) {
+    location = rdoc.genUrl(rdoc.currentPath, result.href);
+  },
+  
+  /**
+   * Do a contains search for a given value
+   */
+  searchForContains: function() {
+    var txt = this.element.value.toUpperCase();
+    var tokens = txt.split(/\s+/);
+    var matches = [];
+    var i, j, matched;
+    
+    for (i = 0; i < rdoc.searchList.length; i++) {
+      matched = 1;
+      for (j = 0; j < tokens.length; j++) {
+        if (rdoc.searchList[i].display_name.toUpperCase().indexOf(tokens[j]) == -1) {
+          matched = 0;
+          break;
+        }
+      }
+      if (matched != 0) matches.push(rdoc.searchList[i]);
+    }
+    
+    this.displaySearchResults(matches);
+  },
+  
+  /**
+   * Displays the search results
+   */
+  displaySearchResults: function(matches) {
+    if (matches.length == 0) {
+      window.location = rdoc.genUrl(rdoc.currentPath, matches[i].href);
+    } else {
+      if (this.updateTimer != null) clearTimeout(this.updateTimer);
+      this.updateTimer = null;
+      this.hide();
+      rdoc.searchDialog.displayResults(matches);
+    }
+  },
+  
+  /**
+   * Set the position for the chooser window
+   * (sadly, Position.close just doesn't work everywhere correctly)
+   */
+  positionChooser: function() {
+    var p = this.element;
+    var left = 0;
+    var top = 0;
+    while (p) {
+      left += p.offsetLeft;
+      top += p.offsetTop;
+      p = p.offsetParent
+    }
+    this.chooser.style.left = left + 'px';
+    this.chooser.style.top  = (top + this.element.offsetHeight) + 'px';
+  },
+  
+  /**
+   * Effect for displaying the chooser.
+   */
+  displayChooser: function() {
+    this.chooser.style.height = '1px';
+    this.chooser.style.width = '120px';
+    jQuery(this.chooser).animate({height: '120px', width: '300px', opacity: 1}, 'fast');
+  }
+
+});
+
+/**
+ * Search results dialog
+ */
+rdoc.SearchResultsDialog = Class.create();
+Object.extend(rdoc.SearchResultsDialog.prototype, rdoc.CustomDialog.prototype);
+Object.extend(rdoc.SearchResultsDialog.prototype, {
+  /**
+   * Constructor
+   */
+  initialize: function() {
+    this.baseInitialize({});
+    this.dialog.className = 'search_results';
+  },
+  
+  /**
+   * Display search results
+   */
+  displayResults: function(results) {
+    var html = '<h1><a onclick="rdoc.searchDialog.close(); return false;"></a>Search Results</h1><ul>';
+    
+    var i;
+    for (i = 0; i < results.length; i++) {
+      html += '<li class="'+(i % 2 == 0 ? 'odd' : 'even')+'" ' +
+        "onclick=\"window.location='" + rdoc.genUrl(rdoc.currentPath, results[i].href) + "'\">" +
+        results[i].display_name.escapeHTML() + '  ' +
+        '<span class="description">' + results[i].description.escapeHTML() + '</span>' +
+        '</li>';
+    }
+    
+    if (results.length == 0) {
+      html += '<li class="odd">No results found</li>';
+    }
+    
+    html += '</ul>';
+    this.dialog.innerHTML = html;
+    this.open();
+  },
+  
+  /**
+   * Return the width of the dialog in pixels
+   */
+  dialogWidth: function() {
+    return 550;
+  }
+
+});
+
+/**
+ * Runs when the document is loaded
+ */
+Event.observe(window, 'load', function(event) {
+  rdoc.searchField = new rdoc.SearchAutoCompleter('search_criteria', 'search_choices');
+  rdoc.searchDialog = new rdoc.SearchResultsDialog();
+  Event.observe($('searchform'), 'submit', function(event) {
+    Event.stop(event);
+    $('search_criteria').blur();
+    rdoc.searchField.searchForContains();
+  });
+});

data/lib/r2doc/template_util.rb

@@ -0,0 +1,82 @@
+module R2Doc
+
+  # Utility functions available for use in templates
+  module TemplateUtil
+    # Convert a target url to one that is relative to a given
+    # path.  This method is updated to account for paths to files
+    # in the root directory.
+    def TemplateUtil.gen_url(path, target)
+      from          = File.dirname(path)
+      to, to_file   = File.split(target)
+      
+      from = from.split("/")
+      to   = to.split("/")
+      
+      from.shift if from.first == '.'
+      to.shift if to.first == '.'
+      
+      while from.size > 0 and to.size > 0 and from[0] == to[0]
+        from.shift
+        to.shift
+      end
+      
+      from.fill("..")
+      from.concat(to)
+      from << to_file
+      File.join(*from)
+    end
+
+    # Runs a partial template and return the contents.  This is similar
+    # to, but much lighter weight than the notion of partials in Rails.
+    # Example usage:
+    #   render_partial :foo             # renders the partial in '_foo.html.erb'
+    #   render_partial :foo, {:bar=>1}  # renders the partial and sets local variable bar to 1
+    def render_partial(partial, locals = nil)
+      local_assign_code = locals.nil? ? '' : locals.keys.collect{|k| "#{k} = locals[:#{k}];"}.join
+      template = "#{template_name}/_#{partial.to_s}"
+      proc_code = <<-end_src
+        Proc.new {
+          #{local_assign_code}
+          R2Doc::TemplateManager.load_template('#{template}').result(binding)
+        }
+      end_src
+      p = eval proc_code
+      p.call
+    end
+    
+    # A much simplified and altered version of the link_to method in
+    # ActionView::Helpers::UrlHelper, creates a link of the given
+    # +content+ to the given +url+.  If +url+ is a string it is assumed
+    # to be relative to the top of the documentation directory.  If +url+
+    # is a ContextUser object, its path is used.  The final URL is
+    # adjusted to match the path of the current file being output.  If
+    # +html_options+ are provided, they become attributes of the returned
+    # tag.
+    def link_to(content, url, html_options = nil)
+      url = url.path if url.respond_to?(:path)
+      attrs = html_options.nil? ? {} : html_options
+      attrs[:href] = R2Doc::TemplateUtil.gen_url(@current_path, url)
+      content_tag 'a', content, attrs
+    end
+    
+    # Return the relative path to +url+ for the current file.  Assumes
+    # that +url+  is a ContextUser or path relative to the top of the
+    # documentation directory.
+    def path_to(url)
+      url = url.path if url.respond_to?(:path)
+      R2Doc::TemplateUtil.gen_url(@current_path, url)
+    end
+    
+    # Return an html tag with content an attributed defined by the provided hash
+    def content_tag(tagname, content, html_options = {})
+      attr_string = html_options.collect{|k,v| " #{h(k.to_s)}=\"#{h(v)}\""}.join('')
+      "<#{tagname}#{attr_string}>#{content}</#{tagname}>"
+    end
+    
+    # Returns an even or odd class name for striping rows using a zero-based index
+    def stripe_class(index, class_prefix = '')
+      "#{class_prefix}#{index % 2 == 0 ? 'odd' : 'even'}"
+    end
+  end
+  
+end

data/lib/rdoc/discover.rb

@@ -0,0 +1,4 @@
+# This file is invoked by RDoc version 2 when it searches for gems
+# associated with RDoc.  It is responsible for loading any generators or
+# other items this gem provides for RDoc
+require 'r2doc/rdoc_v2_generator'

data/lib/rdoc/generators/r2doc_generator.rb

@@ -0,0 +1,105 @@
+
+require 'ftools'
+
+require 'rdoc/options'
+require 'rdoc/markup/simple_markup'
+require 'rdoc/markup/simple_markup/to_html'
+require 'rdoc/generators/html_generator'
+
+require 'erb'
+
+require 'r2doc/context_extensions'
+require 'r2doc/template'
+require 'r2doc/template_util'
+require 'r2doc/generator'
+require 'r2doc/erb_template_engine'
+
+Generators::ContextUser.class_eval do
+  include R2Doc::ContextExtensions
+end
+
+Generators::HtmlClass.class_eval do
+  include R2Doc::ClassExtensions
+end
+
+Generators::HtmlMethod.class_eval do
+  include R2Doc::MethodExtensions
+end
+
+module R2Doc
+  # Accessor for the AllReferences class
+  def self.all_references
+    Generators::AllReferences
+  end    
+end
+
+module Generators
+  
+  class ContextUser #:nodoc:
+    protected
+    def format_path=(new_path)
+      @html_formatter = HyperlinkHtml.new(new_path, self)
+    end
+  end
+    
+  class HtmlMethod #:nodoc:
+    def create_source_code_file(code_body)
+    end
+  end
+  
+  class HTMLGenerator #:nodoc:
+    def HTMLGenerator.gen_url(path, target)
+      R2Doc::TemplateUtil.gen_url(path, target)
+    end
+  end
+  
+  # R2Doc generator for RDoc v1.0.1
+  class R2DOCGenerator < HTMLGenerator
+    
+    include ERB::Util
+    include R2Doc::TemplateUtil
+    include R2Doc::Generator
+    
+    # Factory method
+    def R2DOCGenerator.for(options)
+      R2DOCGenerator.new(options)
+    end
+  
+    # Constructor
+    def initialize(*args)
+      super
+      build_static_file_list
+    end
+    
+    # Perform version-specific initialization
+    def generate_prep
+    end
+    
+    # Return the name of the template
+    def template_name
+      @options.template || 'r2doc'
+    end
+    
+    # Return the list of top level objects for this RDoc version
+    def get_toplevels
+      RDoc::TopLevel
+    end
+    
+    # Create a new file object for this RDoc version
+    def create_file_context(context, options)
+      HtmlFile.new(context, options, FILE_DIR)
+    end
+    
+    # Create a new class object for this RDoc version
+    def create_class_context(context, file, options)
+      HtmlClass.new(context, file, CLASS_DIR, options)
+    end
+    
+    # Return a list of all defined methods
+    def complete_method_list
+      HtmlMethod.all_methods
+    end
+    
+  end
+
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification 
+name: jeffreyhunter77-R2Doc
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Jeffrey Hunter and Mission Critical Labs, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-17 00:00:00 -07:00
+default_executable: r2doc
+dependencies: []
+
+description: R2Doc is an improved generator for RDoc. It provides an improved output template for documentation (including search and frameless navigation), but also aims to be more extensible so that template authoring is an easier task with a wider set of options.
+email: r2doc@missioncriticallabs.com
+executables: 
+- r2doc
+extensions: []
+
+extra_rdoc_files: 
+- bin/r2doc
+- CHANGELOG
+- lib/r2doc/context_extensions.rb
+- lib/r2doc/erb_template_engine.rb
+- lib/r2doc/generator.rb
+- lib/r2doc/rdoc_v2_generator.rb
+- lib/r2doc/template/r2doc/_aliases.html.erb
+- lib/r2doc/template/r2doc/_attributes.html.erb
+- lib/r2doc/template/r2doc/_classes_and_modules.html.erb
+- lib/r2doc/template/r2doc/_constants.html.erb
+- lib/r2doc/template/r2doc/_method_detail.html.erb
+- lib/r2doc/template/r2doc/_method_details.html.erb
+- lib/r2doc/template/r2doc/_method_listing.html.erb
+- lib/r2doc/template/r2doc/_method_listing_row.html.erb
+- lib/r2doc/template/r2doc/_nav.html.erb
+- lib/r2doc/template/r2doc/_nav_item.html.erb
+- lib/r2doc/template/r2doc/class.html.erb
+- lib/r2doc/template/r2doc/file.html.erb
+- lib/r2doc/template/r2doc/images/blue-arrow-right.png
+- lib/r2doc/template/r2doc/images/blue-arrow-up.png
+- lib/r2doc/template/r2doc/images/blue-box.png
+- lib/r2doc/template/r2doc/images/blue-plus.png
+- lib/r2doc/template/r2doc/images/close-button.png
+- lib/r2doc/template/r2doc/images/green-arrow-right.png
+- lib/r2doc/template/r2doc/images/green-arrow-up.png
+- lib/r2doc/template/r2doc/images/nav-back.png
+- lib/r2doc/template/r2doc/images/nav-bottom.png
+- lib/r2doc/template/r2doc/images/nav-top.png
+- lib/r2doc/template/r2doc/images/orange-hash.png
+- lib/r2doc/template/r2doc/images/red-dash.png
+- lib/r2doc/template/r2doc/images/search-back.png
+- lib/r2doc/template/r2doc/images/top-back.png
+- lib/r2doc/template/r2doc/images/top-left.png
+- lib/r2doc/template/r2doc/images/top-right.png
+- lib/r2doc/template/r2doc/index.html.erb
+- lib/r2doc/template/r2doc/jquery.js
+- lib/r2doc/template/r2doc/prototype.js
+- lib/r2doc/template/r2doc/r2doc.css
+- lib/r2doc/template/r2doc/rdoc-utils.js
+- lib/r2doc/template/r2doc/rdoc.js.erb
+- lib/r2doc/template.rb
+- lib/r2doc/template_util.rb
+- lib/r2doc.rb
+- lib/rdoc/discover.rb
+- lib/rdoc/generators/r2doc_generator.rb
+- LICENSE
+- README
+- README.rdoc
+files: 
+- bin/r2doc
+- CHANGELOG
+- lib/r2doc/context_extensions.rb
+- lib/r2doc/erb_template_engine.rb
+- lib/r2doc/generator.rb
+- lib/r2doc/rdoc_v2_generator.rb
+- lib/r2doc/template/r2doc/_aliases.html.erb
+- lib/r2doc/template/r2doc/_attributes.html.erb
+- lib/r2doc/template/r2doc/_classes_and_modules.html.erb
+- lib/r2doc/template/r2doc/_constants.html.erb
+- lib/r2doc/template/r2doc/_method_detail.html.erb
+- lib/r2doc/template/r2doc/_method_details.html.erb
+- lib/r2doc/template/r2doc/_method_listing.html.erb
+- lib/r2doc/template/r2doc/_method_listing_row.html.erb
+- lib/r2doc/template/r2doc/_nav.html.erb
+- lib/r2doc/template/r2doc/_nav_item.html.erb
+- lib/r2doc/template/r2doc/class.html.erb
+- lib/r2doc/template/r2doc/file.html.erb
+- lib/r2doc/template/r2doc/images/blue-arrow-right.png
+- lib/r2doc/template/r2doc/images/blue-arrow-up.png
+- lib/r2doc/template/r2doc/images/blue-box.png
+- lib/r2doc/template/r2doc/images/blue-plus.png
+- lib/r2doc/template/r2doc/images/close-button.png
+- lib/r2doc/template/r2doc/images/green-arrow-right.png
+- lib/r2doc/template/r2doc/images/green-arrow-up.png
+- lib/r2doc/template/r2doc/images/nav-back.png
+- lib/r2doc/template/r2doc/images/nav-bottom.png
+- lib/r2doc/template/r2doc/images/nav-top.png
+- lib/r2doc/template/r2doc/images/orange-hash.png
+- lib/r2doc/template/r2doc/images/red-dash.png
+- lib/r2doc/template/r2doc/images/search-back.png
+- lib/r2doc/template/r2doc/images/top-back.png
+- lib/r2doc/template/r2doc/images/top-left.png
+- lib/r2doc/template/r2doc/images/top-right.png
+- lib/r2doc/template/r2doc/index.html.erb
+- lib/r2doc/template/r2doc/jquery.js
+- lib/r2doc/template/r2doc/prototype.js
+- lib/r2doc/template/r2doc/r2doc.css
+- lib/r2doc/template/r2doc/rdoc-utils.js
+- lib/r2doc/template/r2doc/rdoc.js.erb
+- lib/r2doc/template.rb
+- lib/r2doc/template_util.rb
+- lib/r2doc.rb
+- lib/rdoc/discover.rb
+- lib/rdoc/generators/r2doc_generator.rb
+- LICENSE
+- Manifest
+- Rakefile
+- README
+- README.rdoc
+- R2Doc.gemspec
+has_rdoc: true
+homepage: http://r2doc.org
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- R2Doc
+- --main
+- README
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: r2doc
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: An extensible RDoc generator using ERB
+test_files: []
+