erbook 8.0.0 → 9.0.0

data/fmt/xhtml/jquery/jquery-ui-1.7.2.custom.css

@@ -397,9 +397,9 @@
 ----------------------------------*/
 .ui-tabs { padding: .2em; zoom: 1; }
 .ui-tabs .ui-tabs-nav { list-style: none; position: relative; padding: .2em .2em 0; }
-.ui-tabs .ui-tabs-nav li { position: relative; float: left; border-bottom-width: 0 !important; margin: 0 .2em -1px 0; padding: 0; }
+.ui-tabs .ui-tabs-nav li { position: relative; float: left; margin: 0 .2em -1px 0; padding: 0 0 1px 0; }
 .ui-tabs .ui-tabs-nav li a { float: left; text-decoration: none; padding: .5em 1em; }
-.ui-tabs .ui-tabs-nav li.ui-tabs-selected { padding-bottom: 1px; border-bottom-width: 0; }
+.ui-tabs .ui-tabs-nav li.ui-tabs-selected { padding-bottom: 2px; border-bottom-width: 0 !important; }
 .ui-tabs .ui-tabs-nav li.ui-tabs-selected a, .ui-tabs .ui-tabs-nav li.ui-state-disabled a, .ui-tabs .ui-tabs-nav li.ui-state-processing a { cursor: text; }
 .ui-tabs .ui-tabs-nav li a, .ui-tabs.ui-tabs-collapsible .ui-tabs-nav li.ui-tabs-selected a { cursor: pointer; } /* first selector in group seems obsolete, but required to overcome bug in Opera applying cursor: text overall if defined elsewhere... */
 .ui-tabs .ui-tabs-panel { padding: 1em 1.4em; display: block; border-width: 0; background: none; }

data/lib/erbook.rb

@@ -9,8 +9,8 @@ require 'inochi'
 
 Inochi.init :ERBook,
   :program => 'erbook',
-  :version => '8.0.0',
-  :release => '2009-10-10',
+  :version => '9.0.0',
+  :release => '2009-10-18',
   :website => 'http://snk.tuxfamily.org/lib/erbook/',
   :tagline => 'Write books, manuals, and documents in eRuby',
   :require => {
@@ -19,6 +19,7 @@ Inochi.init :ERBook,
     'coderay'    => '>= 0.8',   # for syntax coloring of source code
     'haml'       => '>= 2.2.2', # for generating HTML and CSS
     'mime-types' => '>= 1.16',  # for detecting MIME types
+    'json'       => nil,        # for emitting JSON
   }
 
 module ERBook

data/lib/erbook/document.rb

@@ -81,7 +81,7 @@ module ERBook
           # Handles the method call from a node
           # placeholder in the input document.
           #
-          def sandbox.__node_impl__ node_type, *node_args, &node_content
+          def sandbox.__node_handler__ node_type, *node_args, &node_content
             node = Node.new(
               :type       => node_type,
               :definition => @format['nodes'][node_type],
@@ -153,7 +153,7 @@ module ERBook
             #      does not accept a block until Ruby 1.9
             file, line = __FILE__, __LINE__; eval %{
               def sandbox.#{type} *node_args, &node_content
-                __node_impl__ #{type.inspect}, *node_args, &node_content
+                __node_handler__ #{type.inspect}, *node_args, &node_content
               end
             }, binding, file, line
           end
@@ -163,7 +163,7 @@ module ERBook
           @processed_document = template.buffer
 
         # chain block-level nodes together for local navigation
-          block_nodes = @nodes.select {|n| n.anchor? }
+          block_nodes = @nodes.select {|n| n.chain? }
 
           require 'enumerator'
           block_nodes.each_cons(2) do |a, b|
@@ -200,9 +200,16 @@ module ERBook
                 actual_output[c.output] = actual_output_by_node[c]
 
               else
-                # pull block-level child out of paragraph tag added by Maruku
-                actual_output.sub! %r/(<p>\s*)?#{Regexp.quote c.output}/ do
-                  actual_output_by_node[c] + $1.to_s
+                # remove <p> around block-level child (added by Markdown)
+                actual_output.sub! %r{(<p>\s*)?#{
+                  Regexp.quote c.output
+                }(\s*</p>)?} do
+                  actual_output_by_node[c] +
+                    if $1 and $2
+                      ''
+                    else
+                      [$1, $2].join
+                    end
                 end
               end
             end
@@ -266,8 +273,11 @@ module ERBook
         Array(definition['number']).include? 'ordinal'
       end
 
-      def anchor?
-        not inline? and not silent?
+      ##
+      # Include this node in the previous/next navigation chain?
+      #
+      def chain?
+        definition['chain']
       end
 
       def inline?

data/lib/erbook/to_xhtml.rb

@@ -1,5 +1,5 @@
-# This file defines the String#to_xhtml and String#to_inline_xhtml
-# methods, which are invoked to transform plain text into XHTML.
+# This file defines the String#to_xhtml method which
+# is invoked to transform plain text into XHTML.
 #
 # This particular implementation features the Markdown
 # formatting system via Maruku, syntax coloring via CodeRay,
@@ -44,25 +44,12 @@ class String
   }
 
   ##
-  # Transforms this string into an *inline* XHTML string (one that
-  # does not contain any block-level XHTML elements at the root).
+  # Transforms this string into XHTML.
   #
-  def to_inline_xhtml
-    to_xhtml true
-  end
-
-  ##
-  # Transforms this string into XHTML while ensuring that the
-  # result contains one or more block-level elements at the root.
-  #
-  # [inline]
-  #   If true, the resulting XHTML will *not*
-  #   contain a block-level element at the root.
-  #
-  def to_xhtml inline = false
+  def to_xhtml
     with_protected_tags(self, VERBATIM_TAGS, true) do |text|
       html = with_protected_tags(text, PROTECTED_TAGS, false) do
-        |s| s.thru_maruku inline
+        |s| s.thru_maruku
       end
 
       # Markdown's "code spans" should really be "pre spans"
@@ -90,11 +77,7 @@ class String
   ##
   # Returns the result of running this string through Maruku.
   #
-  # [inline]
-  #   If true, the resulting XHTML will *not*
-  #   be wrapped in a XHTML paragraph element.
-  #
-  def thru_maruku inline = false #:nodoc:
+  def thru_maruku #:nodoc:
     #
     # XXX: add a newline at the beginning of the text to
     #      prevent Maruku from interpreting the first line
@@ -104,9 +87,10 @@ class String
     #      see this bug report for details:
     #      http://rubyforge.org/tracker/?func=detail&atid=10735&aid=25697&group_id=2795
     #
-    html = Maruku.new("\n#{self}").to_html
-    html.sub! %r{\A<p>(.*)</p>\Z}, '\1' if inline
-    html
+    Maruku.new("\n#{self}").to_html.
+
+    # omit the <p> added by Maruku
+    sub(%r{\A<p>(.*)</p>\Z}, '\1')
   end
 
   ##
@@ -116,8 +100,9 @@ class String
   # or a class="para" attribute, according to whether it
   # spans a single line or multiple lines of code.
   #
-  # In the latter case, the <code> element is replaced with a <pre> element
-  # so that its multi-line body appears correctly in text-mode web browsers.
+  # In the latter case, the <code> element is replaced
+  # with a <pre> element so that its multi-line body
+  # appears correctly in text-mode web browsers.
   #
   # If a <code> element has a lang="..." attribute,
   # then that attribute's value is considered to be
@@ -128,7 +113,9 @@ class String
   def thru_coderay #:nodoc:
     gsub %r{<(code)(.*?)>(.*?)</\1>}m do
       elem, atts, code = $1, $2, CGI.unescapeHTML($3).sub(/\A\r?\n/, '')
-      lang = atts[/\blang=('|")(.*?)\1/i, 2] || :ruby
+
+      lang = atts[/\blang=('|")(.*?)\1/i, 2]
+      lang = :ruby if lang !~ /\S/
 
       body = CodeRay.scan(code, lang).html(:css => :style)
 
@@ -143,7 +130,11 @@ class String
         tail = "</#{elem}>"
       end
 
-      %{#{head} class="#{span}"#{atts}>#{body}#{tail}}
+      unless atts.sub!(/\b(class=('|"))(.*?\2)/){ $1 + span + ' ' + $3 }
+        atts << %{ class="#{span}"}
+      end
+
+      %{#{head}#{atts}>#{body}#{tail}}
     end
   end
 

data/test/erbook.rb

@@ -0,0 +1,17 @@
+unless ERBook.const_defined? :INOCHI
+  fail "ERBook must be established by Inochi"
+end
+
+ERBook::INOCHI.each do |param, value|
+  const = param.to_s.upcase
+
+  unless ERBook.const_defined? const
+    fail "ERBook::#{const} must be established by Inochi"
+  end
+
+  unless ERBook.const_get(const) == value
+    fail "ERBook::#{const} is not what Inochi established"
+  end
+end
+
+puts "Inochi establishment tests passed!"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: erbook
 version: !ruby/object:Gem::Version 
-  version: 8.0.0
+  version: 9.0.0
 platform: ruby
 authors: 
 - Suraj N. Kurapati
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-10 00:00:00 -07:00
+date: 2009-10-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,6 +62,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "1.16"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: inochi
   type: :development
@@ -82,9 +92,8 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "1"
     version: 
-description: "                           ERBook 8.0.0\n\n           Write books, manuals, and documents in eRuby\n\n               http://snk.tuxfamily.org/lib/erbook/\n\n   ERBook is an extensible document processor that emits [1]any\n   document you can imagine from [2]eRuby templates, which allow\n   scripting and dynamic content generation.\n\n\
-  Version 8.0.0 (2009-10-10)\n\n   This release simplifies [3]node definitions, adds [4]Table\n   nodes for building tables the HTML way, and introduces\n   [5]Arbitrary floats to combat the [6]explosion of\n   special-purpose document nodes.\n\n     * [7]Incompatible changes\n\n     * [8]New features\n\n     * [9]Housekeeping\n\n   Incompatible changes\n\n     * Reduce and rename [10]node definitions attributes:\n          + toc: true -> index: tree\n          + lof: true -> index: list\n          + index: true -> number: section\n          + number: true -> number: ordinal\n          + depth: true -> (removed)\n          + bypass: true -> (removed)\n\n     * Rename [11]The ERBook::Document::Node class properties to\n       be more self-documenting:\n          + args -> arguments\n          + defn -> definition\n          + trace -> backtrace\n          + index -> section_number\n          + number -> ordinal_number\n\n     * Replace formal blocks (figure, table, example, equation,\n       procedure) with [12]Arbitrary floats.\n\n     * Append an exclamation mark (!) to the names of\n       [13]Admonition nodes, thereby making them a special case\n       of [14]Arbitrary floats.\n\n   New features\n\n     * Add \"params\" attribute to [15]node definitions.\n\n     * Add [16]Table nodes for building tables the HTML way.\n\n   Housekeeping\n\n     * Use YAML hash merging to DRY node definitions in XHTML\n       format.\n\n     * Use [17]Table nodes instead of PHP Markdown Extra table\n       syntax in the user manual.\n\n     * Remove the \"digest\" [18]Node definition attribute from\n       the user manual. Its use was discontinued a few major\n       versions ago.\n\n\
-  References\n\n   1. http://snk.tuxfamily.org/lib/erbook/#HelloWorld\n   2. http://en.wikipedia.org/wiki/ERuby\n   3. http://snk.tuxfamily.org/lib/erbook/#SpecFile-nodes\n   4. http://snk.tuxfamily.org/lib/erbook/#Table-nodes\n   5. http://snk.tuxfamily.org/lib/erbook/#Arbitrary-floats\n   6. http://www.docbook.org/tdg/en/html/part2.html\n   7. http://snk.tuxfamily.org/lib/erbook/#Incompatible-changes\n   8. http://snk.tuxfamily.org/lib/erbook/#New-features\n   9. http://snk.tuxfamily.org/lib/erbook/#Housekeeping\n  10. http://snk.tuxfamily.org/lib/erbook/#SpecFile-nodes\n  11. http://snk.tuxfamily.org/lib/erbook/#Node-class\n  12. http://snk.tuxfamily.org/lib/erbook/#Arbitrary-floats\n  13. http://snk.tuxfamily.org/lib/erbook/#Admonition-nodes\n  14. http://snk.tuxfamily.org/lib/erbook/#Arbitrary-floats\n  15. http://snk.tuxfamily.org/lib/erbook/#SpecFile-nodes\n  16. http://snk.tuxfamily.org/lib/erbook/#Table-nodes\n  17. http://snk.tuxfamily.org/lib/erbook/#Table-nodes\n  18. http://snk.tuxfamily.org/lib/erbook/#SpecFile-nodes\n"
+description: "                    Version 9.0.0 (2009-10-18)\n\n   This release adds new nodes to the XHTML format, reduces the\n   size of generated XHTML documents and also improves their\n   usability and validity.\n\n     * [1]Incompatible changes\n\n     * [2]New features\n\n     * [3]Bug fixes\n\n     * [4]Housekeeping\n\n   Incompatible changes\n\n     * The String#to_inline_xhtml method has been removed. Use\n       the String#to_xhtml method, which now returns inline\n       XHTML, instead.\n\n   New features\n\n     * Add \"text\" and \"code\" nodes for <pre> and <code>.\n\n     * Add \"chain\" parameter to [5]XHTML node definitions.\n\n     * Add [6]command! floats for listing shell commands and\n       their output.\n\n     * Reduce XHTML output size by activating image data URIs at\n       runtime using JavaScript. Previously, data URIs were\n       emitted into XHTML at compile time.\n\n     * Upgrade from XHTML 1.0 Transitional to Strict.\n\n   Bug fixes\n\n     * Add support for [7]multiple tab rows in jQuery UI tab\n       bars.\n\n     * Auto-detected mime types were inserted incorrectly in\n       base64 embeds.\n\n     * Prevent block-level children of <ins> from appearing\n       underlined on screen (Opera browsers) and in print\n       (Microsoft browsers).\n\n     * <blockquote/> icon did not appear in print style.\n\n     * Prevent mini navigation menus from colliding.\n\n   Housekeeping\n\n     * Remove the need for highlighting scroll target by setting\n       body height so that any element can be brought to the top\n       of the screen via scrolling.\n\n     * Place mini navigation menus on jQuery UI tab bars when\n       possible.\n\n     * Show logo image in full and centered above document\n       header.\n\n     * Completely remove <p> around block-level child (added by\n       Markdown).\n\n     * Fix XHTML validation errors on <table>, <tfoot>, <img> in\n       RDoc strings, and output of syntax coloring library.\n\n     * DRY up XHTML node definitions using YAML hash merging\n       operator.\n\n\
+  References\n\n   1. http://snk.tuxfamily.org/lib/erbook/#Incompatible-changes\n   2. http://snk.tuxfamily.org/lib/erbook/#New-features\n   3. http://snk.tuxfamily.org/lib/erbook/#Bug-fixes\n   4. http://snk.tuxfamily.org/lib/erbook/#Housekeeping\n   5. http://snk.tuxfamily.org/lib/erbook/#xhtml-nodes\n   6. http://snk.tuxfamily.org/lib/erbook/#xhtml-nodes-command\n   7. http://dev.jqueryui.com/ticket/4882\n"
 email: sunaku@gmail.com
 executables: 
 - erbook
@@ -161,6 +170,7 @@ files:
 - lang/de.yaml
 - lang/nl.yaml
 - lang/phrases.yaml
+- test/erbook.rb
 - lib/erbook/template.rb
 - lib/erbook/to_xhtml.rb
 - lib/erbook/document.rb