bookchef 0.1.6

data/lib/bookchef/stylesheets/scss/default.scss

@@ -0,0 +1,88 @@
+body { font-family: "Liberation Serif", "Times New Roman"; line-height: 150%; }
+
+code, .code.inline { font-family: "Monaco"; font-size: 80%; background-color: #eee; }
+code { display: block; clear: both; margin: 1em 0; padding: 0.5em; white-space: pre; line-height: 120%; }
+
+@mixin end_of_section_block_container {
+  font-size: 80%; margin: 1em; border: dotted 1px #aaa; padding: 1em 1em 0 1em;
+}
+@mixin end_of_section_block {
+  margin-bottom: 1em;
+}
+
+p { margin: 0 0 0 0; text-indent: 1em; text-align: justify; }
+span.name, span.filename, span.keyboard { font-family: "Monaco"; font-size: 80%; }
+img { clear: both; display: block; margin: 2em 1em; width: 80%; page-break-inside: avoid; }
+
+.footnotes  {
+  @include end_of_section_block_container; page-break-inside: avoid;
+  .footnote { @include end_of_section_block; }
+}
+.references {
+  font-style: italic; @include end_of_section_block_container; page-break-inside: avoid;
+  img {margin: 0 0.5em 0 0; margin-bottom: -0.3em;display: inline; width: 16px; }
+  .reference { @include end_of_section_block; }
+}
+
+.footnotes, .references { font-size: 70%; line-height: 120%; }
+
+h1 { page-break-inside: avoid; }
+.chapter {
+  page-break-before: always;
+  h1 { font-size: 270%; line-height: 100%; }
+  .section {
+    margin-top: 2em;
+    h1 { font-size: 220%; }
+    .section {
+      margin-top: 1.7em;
+      h1 { font-size: 190%; }
+      .section {
+        margin-top: 1.5em;
+        h1 { font-size: 170%; }
+        .section {
+          margin-top: 1.3em;
+          h1 { font-size: 140%; }
+          .section {
+            margin-top: 1.1em;
+            h1 { font-size: 125%; }
+          }
+        }
+      }
+    }
+  }
+}
+
+p.frameDescription { font-style: italic; font-size: 80%; margin: 1.5em 0 -0.5em 0; text-indent: 0px; }
+
+.cover {
+  page-break-after: always;
+  img { width: 100%; }
+}
+
+.tableOfContents {
+  page-break-after: always; font-size: 120%;
+  ul { list-style-type: none; margin: 0 0 0 0; padding: 0 0 0 0; }
+}
+
+table {
+  margin: 1.5em 1em; page-break-inside: avoid;
+  border-collapse: collapse;
+  td { vertical-align: top; }
+  td, th { border: solid 1px #aaa; padding: 0.5em; margin-top: 1.5em; font-size: 80%; }
+}
+
+ul, ol {
+  margin-left: 2em;
+  li { margin: 0.5em 0; }
+}
+
+sup {	height: 0; line-height: 1; vertical-align: baseline; _vertical-align: bottom; position: relative; bottom: 1ex; }
+
+.footer {
+  border-top: solid 1px #ccc;
+  paddign-top: 1em; font-size: 80%; line-height: 100%;
+  .text { float: left; width: 80%; color: #aaa; }
+  .info { float: right; width: 20%; text-align: right; font-weight: bold; }
+}
+
+.insertPageBreak { page-break-after: always; height: 1px; }

data/lib/bookchef/stylesheets/xslt/bookchef_to_html.xsl

@@ -0,0 +1,238 @@
+<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:exslt="http://exslt.org/common">
+  <xsl:output indent="yes" omit-xml-declaration="yes"/>
+
+  <xsl:param name="gem_path">#{gem_path}</xsl:param>
+
+  <!-- Identity template -->
+  <xsl:template match="@* | node()">
+    <xsl:copy>
+      <xsl:apply-templates select="@* | node()"/>
+    </xsl:copy>
+  </xsl:template>
+
+ <xsl:template name="string-replace-all">
+    <xsl:param name="text" />
+    <xsl:param name="replace" />
+    <xsl:param name="by" />
+    <xsl:choose>
+      <xsl:when test="contains($text, $replace)">
+        <xsl:value-of select="substring-before($text,$replace)" />
+        <xsl:value-of select="$by" />
+        <xsl:call-template name="string-replace-all">
+          <xsl:with-param name="text" select="substring-after($text,$replace)" />
+          <xsl:with-param name="replace" select="$replace" />
+          <xsl:with-param name="by" select="$by" />
+        </xsl:call-template>
+      </xsl:when>
+      <xsl:otherwise>
+        <xsl:value-of select="$text" />
+      </xsl:otherwise>
+    </xsl:choose>
+  </xsl:template>
+
+  <xsl:template match="text()">
+    <xsl:variable name="mdash"><xsl:text disable-output-escaping="yes"><![CDATA[#mdash;]]></xsl:text></xsl:variable>
+    <xsl:call-template name="string-replace-all">
+      <xsl:with-param name="text" select="." />
+      <xsl:with-param name="replace" select='" - "'/>
+      <xsl:with-param name="by" select='$mdash' />
+    </xsl:call-template>
+  </xsl:template>
+
+  <xsl:template match="/book">
+    <html>
+      <head>
+        <meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>
+        <link href="{$gem_path}/stylesheets/css/default.css" rel="stylesheet" type="text/css"/>
+        <xsl:copy-of select="/book/settings/*"/>
+      </head>
+      <body>
+        <xsl:apply-templates select="cover" mode="cover" />
+        <div class="tableOfContents">
+          <h2>Table of contents</h2>
+          <ul><xsl:apply-templates select="chapter" mode="table_of_contents" /></ul>
+        </div>
+        <xsl:apply-templates select="node()" />
+      </body>
+    </html>
+  </xsl:template>
+
+  <xsl:template match="cover" mode="cover">
+    <div class="cover"><xsl:apply-templates select="@* | node()" /></div>
+  </xsl:template>
+  <xsl:template match="cover">
+  </xsl:template>
+
+  <xsl:template match="InsertBookVersion">
+    <xsl:value-of select="/book/@version" />
+  </xsl:template>
+
+  <xsl:template match="/book/settings">
+  </xsl:template>
+
+  <xsl:template match="section/title">
+    <h1 id="{../@id}"><xsl:value-of select="." /></h1>
+  </xsl:template>
+  <xsl:template match="chapter/title">
+    <h1 id="{../@id}">Chapter <xsl:number count="chapter"/>. <xsl:value-of select="." /></h1>
+  </xsl:template>
+
+  <xsl:template match="li/title">
+    <b><xsl:value-of select="." /></b>
+  </xsl:template>
+
+  <xsl:template match="chapter">
+    <div class="chapter">
+      <xsl:apply-templates select="@* |node()" />
+    </div>
+  </xsl:template>
+  <xsl:template match="chapter/@id">
+  </xsl:template>
+
+  <xsl:template match="chapter" mode="table_of_contents">
+    <li>Chapter <xsl:number count="chapter"/>. <a href="#{@id}"><xsl:value-of select="./title"/></a></li> 
+  </xsl:template>
+
+  <xsl:template match="section">
+    <div class="section">
+      <xsl:apply-templates select="@* |node()" />
+    </div>
+  </xsl:template>
+  <xsl:template match="section/@id">
+  </xsl:template>
+
+  <xsl:template match="pagebreak">
+    <div class="insertPageBreak"></div>
+  </xsl:template>
+
+  <xsl:template match="footnotes">
+    <div class="footnotes">
+      <xsl:apply-templates select="@* |node()" />
+    </div>
+  </xsl:template>
+
+  <xsl:template match="footnote">
+    <xsl:param name="id" select="./@id"/>
+    <div class="footnote" id="{$id}">
+      <sup><xsl:number count="footnote" level="single"/></sup><xsl:text> </xsl:text>
+      <xsl:apply-templates select="node()"/>
+    </div>
+  </xsl:template>
+
+
+  <xsl:template match="references">
+    <div class="references">
+      <xsl:apply-templates select="@* |node()" />
+    </div>
+  </xsl:template>
+
+  <xsl:template match="reference">
+    <xsl:param name="id"   select="./@id"/>
+    <xsl:param name="type" select="./@type"/>
+    <xsl:param name="url"  select="./@url"/>
+    <div class="reference" id="{$id}">
+      <img src="{$gem_path}/images/{$type}_link.png" />
+      [<xsl:number count="reference" level="single"/>]<xsl:text> </xsl:text>
+      <a href="{$url}"><xsl:value-of select="."/></a>
+    </div>
+  </xsl:template>
+
+  <xsl:template match="code">
+    <p class="frameDescription"><xsl:value-of select="./@description"/><xsl:text> </xsl:text></p>
+    <xsl:element name="{name()}">
+      <xsl:copy-of select="./node()"/>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="table">
+    <p class="frameDescription"><xsl:value-of select="./@description"/><xsl:text> </xsl:text></p>
+    <table><xsl:apply-templates select="./node()" /></table>
+  </xsl:template>
+
+  <xsl:template match="code-inline" >
+    <span class="code inline"><xsl:apply-templates select="@* |node()" /></span>
+  </xsl:template>
+
+  <xsl:template match="name" >
+    <span class="name"><xsl:apply-templates select="@* |node()" /></span>
+  </xsl:template>
+
+  <xsl:template match="filename" >
+    <span class="filename"><xsl:apply-templates select="@* |node()" /></span>
+  </xsl:template>
+
+  <xsl:template match="keyboard" >
+    <span class="keyboard"><xsl:apply-templates select="@* |node()" /></span>
+  </xsl:template>
+
+  <xsl:template match="a[not(node())]">
+    <xsl:param name="href"      select="./@href"/>
+    <xsl:param name="reference" select="./@reference"/>
+
+    <xsl:choose>
+      <xsl:when test="$href != ''">
+        <xsl:variable name="name"><xsl:value-of select='translate($href, "#", "")'/></xsl:variable>
+        <a href="{$href}"><xsl:value-of select="//*[@id=$name]/title"/></a>
+      </xsl:when>
+      <xsl:when test="$reference != ''">
+        <xsl:variable name="title"><xsl:value-of select='//reference[@id=$reference]'/></xsl:variable>
+        <xsl:variable name="url"><xsl:value-of select='//reference[@id=$reference]/@url'/></xsl:variable>
+        <a href="{$url}"><xsl:value-of select="$title"/></a>
+      </xsl:when>
+    </xsl:choose>
+
+  </xsl:template>
+
+  <xsl:template match="term" name="term">
+    <i><xsl:apply-templates select="@* |node()"/></i>
+  </xsl:template>
+
+  <xsl:template match="*[@reference]" >
+    <xsl:param name="href" select="./@reference"/>
+    <xsl:choose>
+
+      <xsl:when test="name() = 'span'">
+        <span class="referenceSelection">
+          <xsl:value-of select="."/>
+        </span>
+      </xsl:when>
+
+      <xsl:otherwise>
+        <xsl:variable name="reference_content">
+          <xsl:element name="{name()}">
+            <xsl:value-of select="."/>
+          </xsl:element>
+        </xsl:variable>
+        <xsl:apply-templates select="exslt:node-set($reference_content)"/>
+      </xsl:otherwise>
+
+    </xsl:choose>
+
+    <xsl:text> </xsl:text><a href="#{$href}">[<xsl:value-of select="./@number"/>]</a>
+
+  </xsl:template>
+
+  <xsl:template match="*[@footnote]" >
+    <xsl:param name="href" select="./@footnote"/>
+
+    <xsl:choose>
+      <xsl:when test="name() = 'span'">
+        <span class="footnoteSelection">
+          <xsl:value-of select="."/>
+        </span>
+      </xsl:when>
+      <xsl:otherwise>
+        <xsl:variable name="footnote_content">
+          <xsl:element name="{name()}">
+            <xsl:value-of select="."/>
+          </xsl:element>
+        </xsl:variable>
+        <xsl:apply-templates select="exslt:node-set($footnote_content)"/>
+      </xsl:otherwise>
+    </xsl:choose>
+
+    <a href="#{$href}"><sup><xsl:value-of select="./@number"/></sup></a>
+
+  </xsl:template>
+
+</xsl:stylesheet>

data/lib/bookchef/templates/footer.html

@@ -0,0 +1,26 @@
+<html>
+
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+    <script type="text/javascript">
+      function subst() {
+        var vars={};
+        var x=document.location.search.substring(1).split('&');
+        for(var i in x) {var z=x[i].split('=',2);vars[z[0]] = unescape(z[1]);}
+        var x=['frompage','topage','page','webpage','section','subsection','subsubsection'];
+        for(var i in x) {
+          var y = document.getElementsByClassName(x[i]);
+          for(var j=0; j<y.length; ++j) y[j].textContent = vars[x[i]];
+        }
+      }
+    </script>
+  </head>
+
+  <body onload="subst();">
+    <div class="footer">
+      <div class="text">#{footer_text}</div>
+      <div class="info"><span class="page"></span></div>
+    </div>
+  </body>
+
+</html>

data/lib/bookchef/tree_merger.rb

@@ -0,0 +1,192 @@
+class BookChef
+
+  class TreeMerger
+
+    attr_reader :document, :version
+
+    class LinkLevelOutOfReach < Exception; end
+
+    def initialize(path, fn)
+      @path     = File.expand_path(path)
+      @filename = fn
+      @document = File.read("#@path/#@filename").gsub(/<%(.*?)%>/, '&lt;%\1%&gt;')
+      @document = Nokogiri::XML.parse @document
+      insert_version_from_git_tag!
+      if File.exists?("#@path/settings.xml")
+        @settings = File.read("#@path/settings.xml") 
+        @document.root << @settings
+      end
+    end
+
+    def run
+      @documents = []
+      @document  = process_level(@document)
+    end
+
+    def save_to(fn)
+      f = File.open(fn, "w")
+      f.write @document.to_s
+      f.close
+    end
+
+    private
+
+      def process_level(level_document, current_path="")
+        @documents << level_document
+        sourced_sections = level_document.xpath('//section[@src]|//chapter[@src]')
+
+        normalize_code!            level_document
+        convert_links!             level_document, current_path
+        make_image_paths_absolute! level_document, current_path
+        
+        sourced_sections.each do |s|
+          current_fn        = filename_or_index(s[:src])
+          current_dir       = s[:src].sub(/\/?[^\/]*\.xml\Z/, '')
+          path              = current_path
+          path              += "/#{current_dir}" unless current_dir.empty?
+          full_current_path = "#{path}/#{current_fn}"
+          
+          puts "processing #{full_current_path}" 
+          assign_id_to_section! s, full_current_path
+          
+          # Parse the sourced file
+          level_file = File.read("#@path#{full_current_path}")
+          level_file = BookChef.protect_special_chars(level_file)
+          sourced_document = Nokogiri::XML.parse(level_file)
+          convert_references_and_footnotes! sourced_document, full_current_path
+
+          # Now process it too, replacing all src-s with xml from sourced files
+          sourced_document = process_level(sourced_document, path)
+
+          # replace the contents of the tag with the actual sourced file
+          s.children = sourced_document.root.children
+        end unless sourced_sections.empty?
+
+        @documents.delete(level_document) and return level_document
+      end
+
+      # Converts links 'href' attr from relative to absolute path
+      # according to the sections 'name' attrs.
+      def convert_links!(document, current_path)
+        document.search("a").each do |link|
+
+          next if link[:href].nil? || link[:href] =~ /\Ahttps?:\/\//
+          link_path_arr    = link[:href].split("/")
+          current_path_arr = current_path.split("/").reject { |i| i.empty? }
+          uplevels_count   = (link_path_arr.map { |i| i if i == ".." }).compact.size
+          link_path_arr.delete_if { |i| i == ".." }
+
+          if uplevels_count > current_path_arr.size
+            raise LinkLevelOutOfReach, "for link #{link.to_s} in \"#{current_path}\""
+          end
+
+          current_path_arr = current_path_arr.reverse.drop(uplevels_count).reverse
+          link[:href] = "#/#{current_path_arr.join("/")}/#{path_with_filename(link_path_arr.join("/"))}".gsub(/\/+/, '/')
+        end
+      end
+
+      def convert_references_and_footnotes!(document, current_path)
+        
+        # Search the document tree and find the closest file
+        # that contains <footnotes> and <references>
+        container_paths = { footnote: current_path.split("/"), reference: current_path.split("/") }
+        [:footnote, :reference].each do |container|
+          catch :break_inner_loop do
+            (@documents + [document]).reverse.each_with_index do |d,i|
+              throw :break_inner_loop if d.search("//#{container}s").size > 0
+              container_paths[container].pop if container_paths[container].pop == "index.xml"
+              container_paths["#{container}_file"] = "/index.xml"
+            end
+          end
+        end
+        
+        document.search("//footnote|//reference").each do |node|
+          node[:id] = current_path + "/#{node.name}_#{node[:id]}"
+        end
+        
+        document.search("//@footnote|//@reference").each do |node|
+          node.parent["number"]  = node.value
+          node.parent[node.name] = container_paths[node.name.to_sym].join("/")  +
+                                   (container_paths["#{node.name}_file"] || '') +
+                                   "/#{node.name}_#{node.value}"
+        end
+      end
+
+      def make_image_paths_absolute!(document, current_path)
+        document.search("img").each do |img|
+          img[:src] = "file://" + @path + current_path + "/#{img[:src]}"
+        end
+      end
+
+      # Sets section id like this: <section id="/section1/subsection_a/intro.xml">
+      def assign_id_to_section!(node, full_current_path)
+        node[:id] = full_current_path
+        node.remove_attribute("src")
+      end
+
+      # returns just the filename out of the full path
+      # For example, if the path is "/section1/subsection"
+      # it returns "index.xml"
+      def filename_or_index(path)
+        (path.match(/[^\/]*\.xml\Z/) || ["index.xml"])[0]
+      end
+
+      # returns full path attaching "index.xml" to the end of no file specified
+      # For example, if the path is "/section/subsection"
+      # it returns "/section/subsection/index.xml"
+      def path_with_filename(path)
+        if path.match(/[^\/]*\.xml\Z/)
+          path
+        else
+          path + "/index.xml"
+        end
+      end
+
+      def normalize_code!(document)
+        document.search("code").each do |c|
+          minimum_whitespace = nil
+          lines_arr = c.children.to_s.split("\n")
+          new_lines_arr = []
+          lines_arr.each_with_index do |l,i|
+            next if l =~ /\A\s*\Z/
+            match_size = l.match(/\A( )*/).to_s.size
+            minimum_whitespace = match_size if !minimum_whitespace || match_size < minimum_whitespace
+          end
+          lines_arr.each_with_index do |l,i|
+            next if l =~ /\A\s*\Z/ && (i == 0 || i == lines_arr.size-1)
+            l.sub!("\n", '')
+            l.sub!(/\A( ){#{minimum_whitespace}}/, '')
+            new_lines_arr << split_long_line(l, l.match(/\A( )*/).to_s.size)
+          end
+          c.content = new_lines_arr.compact.join("\n")
+        end
+      end
+
+      def split_long_line(line, leading_spaces_number=0)
+        if line.length > 70
+          lines = line[61..line.length-1].split(/[ .]/, 2)
+          line1 = line[0..60] + lines[0]
+          leading_spaces = (0..leading_spaces_number-1).map { ' ' }.join
+          line2 = leading_spaces.to_s + lines[1].to_s
+          line2 = split_long_line(line2, leading_spaces_number)
+          return "#{line1}\n#{line2}"
+        else
+          line
+        end
+      end
+
+      def insert_version_from_git_tag!
+
+        `cd #{@path} && git tag`.split("\n").sort.reverse.each do |t|
+          if t =~ /\Av[0-9]/
+            @version = t.sub(/\Av/,'').rstrip
+            @document.root["version"] = t.sub(/\Av/,'').rstrip
+            return
+          end
+        end
+
+      end
+
+  end
+
+end