gerbil 1.0.0

data/fmt/latex.yaml

@@ -0,0 +1,2 @@
+desc: high-quality typesetting
+code: raise NotImplementedError, 'this format is not yet implemented'

data/fmt/man.yaml

@@ -0,0 +1,2 @@
+desc: manual page for UNIX
+code: raise NotImplementedError, 'this format is not yet implemented'

data/fmt/text.yaml

@@ -0,0 +1,2 @@
+desc: plain text, nothing fancy
+code: raise NotImplementedError, 'this format is not yet implemented'

data/lib/gerbil.rb

@@ -0,0 +1,11 @@
+# project information
+
+Gerbil = {
+  :name    => 'Gerbil',
+  :version => '1.0.0',
+  :release => '2008-01-12',
+  :website => 'http://gerbil.rubyforge.org',
+  :home    => File.expand_path(File.join(File.dirname(__FILE__), '..'))
+}
+Gerbil[:format_home]  = File.join(Gerbil[:home], 'fmt')
+Gerbil[:format_files] = Dir[File.join(Gerbil[:format_home], '*.yaml')]

data/lib/gerbil/html.rb

@@ -0,0 +1,149 @@
+# This file defines the String#to_html method, which is
+# invoked to transform the content of a blog entry into HTML.
+#
+# It features the Textile formatting system (RedCloth), syntax coloring
+# (CodeRay), and smart source code sizing (block versus inline display).
+#--
+# Copyright 2006 Suraj N. Kurapati
+# See the file named LICENSE for details.
+
+require 'cgi'
+require 'digest/sha1'
+
+begin
+  require 'rubygems'
+rescue LoadError
+end
+
+require 'coderay'
+require 'redcloth'
+
+class String
+  # The content of these HTML tags will be preserved while
+  # they are being processed by Textile. By doing this, we
+  # avoid unwanted Textile transformations, such as quotation
+  # marks becoming curly ( ), in source code.
+  PROTECTED_TAGS = %w[tt code pre]
+
+  # The content of these HTML tags will
+  # be preserved *verbatim* throughout
+  # the text-to-HTML conversion process.
+  VERBATIM_TAGS = %w[noformat]
+
+  # Transforms this string into HTML.
+  def to_html
+    text = dup
+    protect_tags! text, VERBATIM_TAGS, verbatimStore = {}, true
+    protect_tags! text, PROTECTED_TAGS, protectedStore = {}, false
+
+    html = text.thru_redcloth
+    restore_tags! html, protectedStore
+
+    # collapse redundant <pre> elements -- a side effect of RedCloth
+    html.gsub! %r{(<pre>)\s*<pre>(.*?)</pre>\s*(</pre>)}m, '\1\2\3'
+
+    html = html.thru_coderay
+    restore_tags! html, verbatimStore
+
+    # ensure tables have a border (this GREATLY improves
+    # readability in text-mode web browsers like Lynx and w3m)
+    html.gsub! %r/<table/, '\& border="1"'
+
+    html
+  end
+
+  # Returns the result of running this string through RedCloth.
+  def thru_redcloth
+    text = dup
+
+    # redcloth does not correctly convert -- into &mdash;
+    text.gsub! %r{\b--\b}, '&mdash;'
+
+    html = RedCloth.new(text).to_html
+
+    # redcloth adds <span> tags around acronyms
+    html.gsub! %r{<span class="caps">([[:upper:][:digit:]]+)</span>}, '\1'
+
+    # redcloth wraps indented text within <pre><code> tags
+    html.gsub! %r{(<pre>)\s*<code>(.*?)\s*</code>\s*(</pre>)}m, '\1\2\3'
+
+    # redcloth wraps a single item within paragraph tags, which
+    # prevents the item's HTML from being validly injected within
+    # other block-level elements, such as headings (h1, h2, etc.)
+    html.sub! %r{^<p>(.*)</p>$}m do |match|
+      payload = $1
+
+      if payload =~ /<p>/
+        match
+      else
+        payload
+      end
+    end
+
+    html
+  end
+
+  # Adds syntax coloring to <code> elements in the given text.  If the
+  # <code> tag has an attribute lang="...", then that is considered the
+  # programming language for which appropriate syntax coloring should be
+  # applied.  Otherwise, the programming language is assumed to be ruby.
+  def thru_coderay
+    gsub %r{<(code)(.*?)>(.*?)</\1>}m do
+      atts, code = $2, CGI.unescapeHTML($3)
+
+      lang =
+        if $2 =~ /lang=('|")(.*?)\1/i
+          $2
+        else
+          :ruby
+        end
+
+      tag =
+        if code =~ /\n/
+          :pre
+        else
+          :code
+        end
+
+      html = CodeRay.scan(code, lang).html(:css => :style)
+
+      %{<#{tag} class="code"#{atts}>#{html}</#{tag}>}
+    end
+  end
+
+  private
+
+  def protect_tags! aText, aTags, aStore, aVerbatim #:nodoc:
+    aTags.each do |tag|
+      aText.gsub! %r{(<#{tag}.*?>)(.*?)(</#{tag}>)}m do
+        head, body, tail = $1, $2, $3
+
+        # XXX: when we restore protected tags later on, String.gsub! is
+        #      removing all single backslashes for some reason... so we
+        #      protect against this by doubling all single backslashes first
+        body.gsub! %r/\\/, '\&\&'
+
+        original =
+          if aVerbatim
+            body
+          else
+            head << CGI.escapeHTML(CGI.unescapeHTML(body)) << tail
+          end
+        escape = Digest::SHA1.hexdigest(original)
+
+        aStore[escape] = original
+        escape
+      end
+    end
+  end
+
+  def restore_tags! aText, aStore #:nodoc:
+    until aStore.empty?
+      aStore.each_pair do |escape, original|
+        if aText.gsub! %r{<p>#{escape}</p>|#{escape}}, original
+          aStore.delete escape
+        end
+      end
+    end
+  end
+end

data/lib/gerbil/rdoc.rb

@@ -0,0 +1,91 @@
+# Workaround for: `rdoc --fmt xml` does not dump information about methods.
+#--
+# Copyright 2007 Suraj N. Kurapati
+# See the file named LICENSE for details.
+
+require 'rdoc/rdoc'
+
+module RDoc
+  module DummyMixin
+    def method_missing *args
+      # ignore all messages
+    end
+  end
+
+  class DummyOptions
+    include DummyMixin
+
+    def quiet # supress '...c..m...' output on STDERR
+      true
+    end
+  end
+
+  class DummyMarkup
+    require 'rdoc/generators/html_generator'
+    include Generators::MarkUp
+    include DummyMixin
+  end
+
+  # Returns an array of RDoc parse trees for the given code.
+  # If the file name (which signifies the origin of the given
+  # code) is given, it MUST have a ".rb" file extension.
+  # Otherwise, RDoc will give you an empty parse tree!  :-(
+  def self.gen_parse_trees aCode, aFileName = __FILE__
+    root = TopLevel.new(aFileName)
+    parser = ParserFactory.parser_for(root, aFileName, aCode, DummyOptions.new, Stats.new)
+    info = parser.scan
+
+    info.requires.map do |r|
+      f = r.name
+      f << '.rb' unless File.exist? f
+      gen_parse_tree f if File.exist? f
+    end.flatten.compact << info
+  end
+
+  # Returns an array of hashes describing all methods present in the
+  # given parse trees (which are produced by RDoc::gen_parse_trees).
+  def self.gen_method_infos *aParseTrees
+    meths = aParseTrees.map do |i|
+      i.method_list + i.classes.map { |c| c.method_list }
+    end.flatten.uniq
+
+    meths.map do |m|
+      # determine full path to method (Module::Class::...::method)
+      hier = []
+      root = m.parent
+      while root && root.parent
+        hier.unshift root
+        root = root.parent
+      end
+
+      if hier.empty?
+        path = m.name
+      else
+        path = hier.map {|n| n.name}.join('::')
+        path = [path, m.name].join(m.singleton ? '::' : '#')
+      end
+
+      # determine argument string for method
+      args = m.params
+      if m.block_params
+        args.sub! %r/\#.*(?=.$)/, ''
+        args << " { |#{m.block_params}| ... }"
+      end
+
+      {
+        :file => root.file_absolute_name,
+        :name => path,
+        :args => args,
+        :decl => path + args,
+        :docs => m.comment,
+        :docs_html => DummyMarkup.new.markup(m.comment),
+
+        # nodes in the parse tree
+        :node => m,
+        :root => root,
+        # for top level methods, info.parent == root
+        # for class methods, info.singleton == true
+      }
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: gerbil
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: []
+
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-01-12 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: RedCloth
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: coderay
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Extensible document generator based on eRuby.
+email: 
+executables: 
+- gerbil
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- fmt
+- fmt/html.icons
+- fmt/html.icons/warning.png
+- fmt/html.icons/tip.png
+- fmt/html.icons/caution.png
+- fmt/html.icons/important.png
+- fmt/html.icons/note.png
+- fmt/html.icons/LICENSE
+- fmt/html.icons/README
+- fmt/latex.yaml
+- fmt/html.yaml
+- fmt/man.yaml
+- fmt/text.yaml
+- lib
+- lib/gerbil
+- lib/gerbil/html.rb
+- lib/gerbil/rdoc.rb
+- lib/gerbil.rb
+- Rakefile
+- bin
+- bin/gerbil
+- LICENSE
+- README
+- doc
+- doc/gerbil.png
+- doc/gerbil.svg
+- doc/HelloWorld.input
+- doc/guide.html
+- doc/guide.erb
+- doc/HelloWorld.spec
+has_rdoc: false
+homepage: http://gerbil.rubyforge.org
+post_install_message: 
+rdoc_options: []
+
+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.0.1
+signing_key: 
+specification_version: 2
+summary: Extensible document generator based on eRuby.
+test_files: []
+