erbook 4.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/erbook.rb

@@ -0,0 +1,13 @@
+# Project and release information.
+module ERBook
+  PROJECT = 'erbook'
+  VERSION = '4.0.0'
+  RELEASE = '2008-11-15'
+  WEBSITE = 'http://snk.tuxfamily.org/lib/erbook'
+  SUMMARY = 'Extensible document processor based on eRuby.'
+  DISPLAY = PROJECT + ' ' + VERSION
+
+  INSTALL_DIR = File.expand_path File.join(File.dirname(__FILE__), '..')
+  FORMATS_DIR = File.join INSTALL_DIR, 'fmt'
+  FORMAT_FILES = Dir[File.join(FORMATS_DIR, '*.yaml')]
+end

data/lib/erbook/html.rb

@@ -0,0 +1,145 @@
+# This file defines the String#to_html and String#to_inline_html
+# methods, which are invoked to transform plain text into HTML.
+#
+# This particular implementation features the Markdown
+# formatting system via Maruku, syntax coloring via CodeRay,
+# and smart source code sizing (block versus inline display).
+
+require 'cgi'
+
+begin
+  require 'rubygems'
+  gem 'maruku', '~> 0.5'
+  gem 'coderay', '>= 0.7'
+rescue LoadError
+end
+
+require 'coderay'
+require 'maruku'
+
+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 an *inline* HTML string (one that
+  # does not contain any block-level HTML elements at the root).
+  def to_inline_html
+    to_html true
+  end
+
+  # XXX: Maruku also defines String#to_html so we have to hack around it :-(
+  alias to_html_maruku to_html
+
+  # Transforms this string into HTML while ensuring that the
+  # result contains one or more block-level elements at the root.
+  #
+  # If aInline is true, then the resulting HTML will be an *inline* string.
+  #
+  def to_html aInline = false
+    # XXX: Maruku also defines String#to_html so we have to hack around it :-(
+    return to_html_maruku if caller.detect {|c| c =~ %r'/lib/maruku/output/' }
+
+    protect(self, VERBATIM_TAGS, true) do |text|
+      html = protect(text, PROTECTED_TAGS, false) {|s| s.thru_maruku aInline }
+
+      # Markdown's "code spans" should really be "pre spans"
+      while html.gsub! %r{(<pre>)<code>(.*?)</code>(</pre>)}m, '\1\2\3'
+      end
+
+      # ensure tables have a border: this *greatly* improves
+      # readability in text-based web browsers like w3m and lynx
+      html.gsub! %r/<table\b/, '\& border="1"'
+
+      # add syntax coloring
+      html.thru_coderay
+    end
+  end
+
+  # Returns the result of running this string through Maruku.
+  #
+  # If aInline is true, then the resulting HTML will
+  # *not* be wrapped in a HTML paragraph element.
+  #
+  def thru_maruku aInline = false
+    html = Maruku.new(self).to_html
+    html.sub! %r{\A<p>(.*)</p>\Z}, '\1' if aInline
+    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 = atts[/\blang=('|")(.*?)\1/i, 2] || :ruby
+
+      html = CodeRay.scan(code, lang).html(:css => :style)
+      tag = if code =~ /\n/ then :pre else :code end
+
+      %{<#{tag} class="code"#{atts}>#{html}</#{tag}>}
+    end
+  end
+
+  private
+
+  # Protects the given tags in the given input, passes
+  # that protected input to the given block, restores the
+  # given tags in the result of the block and returns it.
+  #
+  # If aVerbatim is true, the content of the elments having the given tags will
+  # not be temporarily altered so that process nested elements can be processed.
+  #
+  def protect aInput, aTags, aVerbatim #:yields: aInput
+    raise ArgumentError unless block_given?
+
+    input = aInput.dup
+    escapes = {}
+
+    # protect the given tags by escaping them
+    aTags.each do |tag|
+      input.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
+
+        escaped = original.digest_id
+        escapes[escaped] = original
+
+        escaped
+      end
+    end
+
+    # invoke the given block with the protected input
+    output = yield(input)
+
+    # restore the protected tags by unescaping them
+    until escapes.empty?
+      escapes.each_pair do |esc, orig|
+        if output.gsub! esc, orig
+          escapes.delete esc
+        end
+      end
+    end
+
+    output
+  end
+end

data/lib/erbook/rdoc.rb

@@ -0,0 +1,126 @@
+# Workaround for: `rdoc --fmt xml` does not dump information about methods.
+
+require 'rdoc/rdoc'
+
+module RDoc
+  class TopLevel
+    # Returns an array of all classes recorded thus far.
+    def self.all_classes
+      @@all_classes.values
+    end
+
+    # Returns an array of all modules recorded thus far.
+    def self.all_modules
+      @@all_modules.values
+    end
+
+    # Returns an array of RDoc::AnyMethod objects
+    # representing all methods recorded thus far.
+    def self.all_methods
+      all_classes_and_modules.map {|c| c.method_list }.flatten
+    end
+
+    # Update the return value of the all_classes_and_modules() method
+    # to *really* include every class and every module seen thus far.
+    def self.refresh_all_classes_and_modules
+      visit = lambda do |node|
+        if node.is_a? NormalClass or node.is_a? SingleClass
+          @@all_classes[node.full_name] = node
+
+        elsif node.is_a? NormalModule
+          @@all_modules[node.full_name] = node
+        end
+
+        (node.classes + node.modules).each {|n| visit[n] }
+      end
+
+      all_classes_and_modules.each {|n| visit[n] }
+    end
+
+    # Returns a RDoc::TopLevel object containing information
+    # parsed from the given code string.  This information is
+    # also added to the global TopLevel class state, so you can
+    # access it via the class methods of the TopLevel class.
+    #
+    # If the file name (which signifies the origin
+    # of the given code) is given, it MUST have a
+    # ".c" or ".rb" file extension.  Otherwise,
+    # RDoc will ignore the given code string!  :-(
+    #
+    def self.parse aCodeString, aFileName = __FILE__
+      top = ParserFactory.parser_for(
+        TopLevel.new(aFileName), aFileName,
+        aCodeString, DummyOptions.new, Stats.new
+      ).scan
+
+      refresh_all_classes_and_modules
+
+      top
+    end
+
+    # Returns a RDoc::TopLevel object containing information
+    # parsed from the code in the given file.  This information
+    # is also added to the global TopLevel class state, so you
+    # can access it via the class methods of the TopLevel class.
+    #
+    # The given file name MUST have a ".c" or ".rb" file
+    # extension.  Otherwise, RDoc will ignore the file!  :-(
+    #
+    def self.parse_file aFileName
+      parse File.read(aFileName), aFileName
+    end
+  end
+
+  class AnyMethod
+    # Returns the fully qualified name of this method.
+    def full_name
+      [parent.full_name, name].join(singleton ? '::' : '#')
+    end
+
+    # Returns a complete method declaration with block parameters and all.
+    def decl
+      a = params.dup
+      if b = block_params
+        a.sub! %r/\s*\#.*(?=.$)/, '' # remove "# :yields: ..." string
+        a << " {|#{b}| ... }"
+      end
+      full_name << a
+    end
+
+    # Returns a HTML version of this method's comment.
+    def comment_html
+      DummyMarkup.new.markup comment
+    end
+
+    # Returns the RDoc::TopLevel object which contains this method.
+    def top_level
+      n = parent
+      while n && n.parent
+        n = n.parent
+      end
+      n
+    end
+  end
+
+  private
+
+  module DummyMixin #:nodoc:
+    def method_missing *args
+      # ignore all messages
+    end
+  end
+
+  class DummyOptions #:nodoc:
+    include DummyMixin
+
+    def quiet # supress '...c..m...' output on STDERR
+      true
+    end
+  end
+
+  class DummyMarkup #:nodoc:
+    require 'rdoc/generators/html_generator'
+    include Generators::MarkUp
+    include DummyMixin
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification 
+name: erbook
+version: !ruby/object:Gem::Version 
+  version: 4.0.0
+platform: ruby
+authors: 
+- Suraj N. Kurapati
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-15 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: maruku
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.5"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: coderay
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.7"
+    version: 
+description: Extensible document processor based on eRuby.
+email: sunaku@gmail.com
+executables: 
+- erbook
+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/quote.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/erbook
+- lib/erbook/html.rb
+- lib/erbook/rdoc.rb
+- lib/erbook.rb
+- Rakefile
+- bin
+- bin/erbook
+- LICENSE
+- README
+- doc
+- doc/manual.erb
+- doc/erbook.svg
+- doc/erbook.png
+- doc/HelloWorld.input
+- doc/feed-icon-28x28.png
+- doc/HelloWorld.spec
+- doc/index.html
+- doc/api
+- doc/api/classes
+- doc/api/classes/RDoc.html
+- doc/api/classes/String.src
+- doc/api/classes/String.src/M000001.html
+- doc/api/classes/String.src/M000004.html
+- doc/api/classes/String.src/M000003.html
+- doc/api/classes/String.src/M000002.html
+- doc/api/classes/String.html
+- doc/api/classes/ERBook.html
+- doc/api/classes/RDoc
+- doc/api/classes/RDoc/TopLevel.src
+- doc/api/classes/RDoc/TopLevel.src/M000013.html
+- doc/api/classes/RDoc/TopLevel.src/M000010.html
+- doc/api/classes/RDoc/TopLevel.src/M000011.html
+- doc/api/classes/RDoc/TopLevel.src/M000014.html
+- doc/api/classes/RDoc/TopLevel.src/M000012.html
+- doc/api/classes/RDoc/TopLevel.src/M000009.html
+- doc/api/classes/RDoc/TopLevel.html
+- doc/api/classes/RDoc/AnyMethod.src
+- doc/api/classes/RDoc/AnyMethod.src/M000005.html
+- doc/api/classes/RDoc/AnyMethod.src/M000008.html
+- doc/api/classes/RDoc/AnyMethod.src/M000006.html
+- doc/api/classes/RDoc/AnyMethod.src/M000007.html
+- doc/api/classes/RDoc/AnyMethod.html
+- doc/api/fr_method_index.html
+- doc/api/rdoc-style.css
+- doc/api/files
+- doc/api/files/lib
+- doc/api/files/lib/erbook_rb.html
+- doc/api/files/lib/erbook
+- doc/api/files/lib/erbook/rdoc_rb.html
+- doc/api/files/lib/erbook/html_rb.html
+- doc/api/created.rid
+- doc/api/index.html
+- doc/api/fr_file_index.html
+- doc/api/fr_class_index.html
+- doc/README
+has_rdoc: true
+homepage: http://snk.tuxfamily.org/lib/erbook
+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: sunaku
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Extensible document processor based on eRuby.
+test_files: []
+