prophecy 0.0.1

data/lib/prophecy/book.rb

@@ -0,0 +1,281 @@
+
+module Prophecy
+
+  class Book
+
+    attr_reader :config, :chapters, :manifest
+
+    attr_reader :title, :subtitle, :author, :publisher, :publisher_atag,
+      :publisher_logo, :book_atag, :isbn, :uuid, :version, :edition,
+      :lang, :lang_iso_639_2, :build_dir, :template_dir, :layouts_dir,
+      :assets_dir, :tex_dir, :markdown_dir, :xhtml_dir, :chapter_layout,
+      :include_assets, :exclude_assets, :toc, :output_format, :bookid,
+      :rights, :creator, :subject, :source, :contributors, :cover_image,
+      :date, :compile_name
+
+    def initialize(config)
+      @config = config.clone
+
+      c = config
+
+      @output_format  = c['output_format']  || nil
+      @title          = c['title']          || "The Title"
+      @subtitle       = c['subtitle']       || nil
+      @author         = c['author']         || "The Author"
+      @creator        = c['creator']        || @author
+      @publisher      = c['publisher']      || nil
+      @publisher_atag = c['publisher_atag'] || nil
+      @publisher_logo = c['publisher_logo'] || nil
+      @book_atag      = c['book_atag']      || nil
+      @isbn           = c['isbn']           || nil
+      @uuid           = c['uuid']           || nil
+      @version        = c['version']        || 'v0.1'
+      @edition        = c['edition']        || nil
+      @lang           = c['lang']           || 'en-GB'
+      @lang_iso_639_2 = c['lang_iso_639_2'] || @lang.downcase.sub(/-.*$/, '')
+      @tex_dir        = c['tex_dir']        || find_format_dir('tex')
+      @markdown_dir   = c['markdown_dir']   || find_format_dir('markdown')
+      @xhtml_dir      = c['xhtml_dir']      || find_format_dir('xhtml')
+      @build_dir      = c['build_dir']      || File.join('./build', @output_format)
+      @assets_dir     = c['assets_dir']     || find_assets_dir
+      @template_dir   = c['template_dir']   || find_template_dir
+      @layouts_dir    = c['layouts_dir']    || File.join(@assets_dir, 'layouts')
+      @chapter_layout = c['chapter_layout'] || 'page.xhtml.erb'
+      @include_assets = format_include_assets(c['include_assets'])
+      @exclude_assets = format_exclude_assets(c['exclude_assets'])
+      @toc            = c['toc']            || nil
+      @bookid         = c['bookid']         || nil
+      @rights         = c['rights']         || nil
+      @subject        = c['subject']        || nil
+      @source         = c['source']         || nil
+      @contributors   = c['contributors']   || nil
+      @cover_image    = c['cover_image']    || nil
+      @date           = c['date']           || Time.now.strftime("%Y-%m-%d")
+
+      @compile_name = "#{self.author}-#{self.title}-#{Time.now.strftime("%FT%T")}".gsub(/[^a-zA-Z0-9-]/, '-').gsub(/--*/, '-')
+
+      @manifest = nil
+      @chapters = []
+      Chapter.section_name = config['section_names'] if config['section_names']
+      if @toc
+        @toc.each do |ch|
+          if ch.is_a?(String)
+            ch = { 'src' => ch }
+          end
+
+          if ch.has_key?('target')
+            if ch['target'].include?(@output_format) || ch['target'] == @output_format
+              @chapters << Chapter.new(self, ch)
+            end
+          else
+            c = Chapter.new(self, ch)
+            @chapters << c unless c.render_path.nil?
+          end
+        end
+        @navpoints = @chapters.flat_map{|c| c.navpoints}
+      end
+    end
+
+    def generate_build
+      case self.output_format
+      when 'epub'
+        self.build_epub_mobi
+      when 'mobi'
+        self.build_epub_mobi
+      when 'latex'
+        self.build_latex
+      else
+        warn "Don't know how to build output format: " + self.output_format
+        raise "Unknown Output Format Error"
+      end
+    end
+
+    def build_latex
+      FileUtils.cp_r(File.join(@template_dir, '.'), @build_dir)
+      FileUtils.cp_r(@include_assets, @build_dir)
+
+      # For ERB binding.
+      book = self
+
+      Dir.glob(File.join(@build_dir, '**/*'), File::FNM_DOTMATCH).each do |f|
+        if File.extname(f) == '.erb'
+          template = ERB.new(IO.read(f))
+          text = template.result(binding)
+          File.open(f.sub(/\.erb$/, ''), "w"){|file| file << text }
+          FileUtils.rm(f)
+        end
+
+        @exclude_assets.each do |ex|
+          if File.fnmatch(ex, f) || File.fnmatch(ex, File.basename(f))
+            FileUtils.rm(f)
+          end
+        end
+      end
+
+      @chapters.each do |ch|
+        next if ch.src.nil?
+        unless File.extname(ch.src) == '.tex'
+          File.open(ch.render_path, "w"){|f| f << ch.to_tex }
+        end
+      end
+    end
+
+    def build_epub_mobi
+      FileUtils.cp_r(File.join(@template_dir, '.'), @build_dir)
+      FileUtils.cp_r(@include_assets, File.join(@build_dir, 'OEBPS'))
+
+      content_opf_path = nil
+
+      # For ERB binding.
+      book = self
+
+      Dir.glob(File.join(@build_dir, '**/*'), File::FNM_DOTMATCH).each do |f|
+        if File.extname(f) == '.erb'
+          if File.basename(f) == 'content.opf.erb'
+            content_opf_path = File.expand_path(f)
+            next
+          end
+          template = ERB.new(IO.read(f))
+          text = template.result(binding)
+          File.open(f.sub(/\.erb$/, ''), "w"){|file| file << text }
+          FileUtils.rm(f)
+        end
+
+        @exclude_assets.each do |ex|
+          if File.fnmatch(ex, f) || File.fnmatch(ex, File.basename(f))
+            FileUtils.rm(f)
+          end
+        end
+      end
+
+      @chapters.each do |ch|
+        File.open(ch.render_path, "w"){|f| f << ch.to_html }
+      end
+
+      @manifest = Manifest.new(self)
+
+      # Rendering content.opf.erb at the end.
+      unless content_opf_path.nil?
+        template = ERB.new(IO.read(content_opf_path))
+        text = template.result(binding)
+        File.open(content_opf_path.sub(/\.erb$/, ''), "w"){|file| file << text }
+        FileUtils.rm(content_opf_path)
+      end
+    end
+
+    def format_dir(src)
+      case File.extname(src)
+      when '.md', '.mkd', '.markdown'
+        self.markdown_dir
+      when '.tex'
+        self.tex_dir
+      when '.xhtml'
+        self.xhtml_dir
+      when '.html'
+        self.xhtml_dir
+      when '.erb'
+        self.format_dir(src.sub(/\.erb$/, ''))
+      end
+    end
+
+    def render_navpoints
+      ret = ""
+      @navpoints.each_with_index do |nav, idx|
+        ret += "<navPoint id='nav#{nav['playOrder']}' playOrder='#{nav['playOrder']}'>\n"
+        ret += "<navLabel><text>#{nav['text']}</text></navLabel>\n"
+        ret += "<content src='#{nav['src']}'/>"
+
+        next_nav = @navpoints[idx+1]
+        if !next_nav.nil? && next_nav['level'] < nav['level']
+          d = nav['level'] - next_nav['level'] + 1
+          d.times{ ret += "</navPoint>\n" }
+        elsif next_nav.nil? || next_nav['level'] == nav['level']
+          ret += "</navPoint>\n"
+        end
+      end
+      ret
+    end
+
+    def personal_name_first(lastname_comma_name)
+      n = lastname_comma_name.split(/, */)
+      "#{n[1]} #{n[0]}"
+    end
+
+    def epub?
+      self.output_format == 'epub'
+    end
+
+    def mobi?
+      self.output_format == 'mobi'
+    end
+
+    def latex?
+      self.output_format == 'latex'
+    end
+
+    private
+
+    def find_format_dir(format)
+      if Dir.exists?("./manuscript/#{format}/")
+        "./manuscript/#{format}/"
+      else
+        './manuscript/'
+      end
+    end
+
+    def find_assets_dir
+      if Dir.exists?('./assets/')
+        File.join('.', 'assets')
+      else
+        File.join(File.expand_path(File.dirname(__FILE__)), 'assets')
+      end
+    end
+
+    def format_include_assets(config_include)
+      case (self.output_format)
+      when 'epub', 'mobi'
+        inc = [
+          File.join(self.assets_dir, 'webfonts'),
+          File.join('.', 'images'),
+          File.join(self.assets_dir, 'stylesheets')
+        ]
+      when 'latex'
+        inc = []
+      end
+
+      if config_include.nil?
+        inc
+      else
+        inc.concat(config_include).uniq
+      end
+    end
+
+    def format_exclude_assets(config_exclude)
+      case (self.output_format)
+      when 'epub'
+        ex = [ 'ie.css', 'print.css', 'style-mobi.css', '*.swp', '.gitkeep' ]
+      when 'mobi'
+        ex = [ 'ie.css', 'print.css', 'style-epub.css', '*.swp', '.gitkeep' ]
+      when 'latex'
+        ex = []
+      end
+
+      if config_exclude.nil?
+        ex
+      else
+        ex.concat(config_exclude).uniq
+      end
+    end
+
+    def find_template_dir
+      case (self.output_format)
+      when 'epub', 'mobi'
+        File.join(self.assets_dir, 'epub_template')
+      when 'latex'
+        File.join(self.assets_dir, 'latex_template')
+      end
+    end
+
+  end
+
+end

data/lib/prophecy/chapter.rb

@@ -0,0 +1,359 @@
+
+module Prophecy
+
+  class Chapter
+
+    attr_accessor :title, :id, :idref, :lang, :class, :book, :level,
+      :layout, :src, :path, :render_name, :render_path, :href, :type,
+      :linear, :prefix, :postfix, :insert, :section_name,
+      :section_number, :navpoints
+
+    # Array index corresponds to level, levels index from 0 too. In the
+    # .yml you give the level: N attrib as if they were indexed from 1,
+    # makes more sense there, but we compensate for it in the class.
+
+    @@section_name = [ "Chapter", ]
+    @@section_number = [ 0, ]
+    @@toc_from_headers = false
+    @@playOrder = 1
+
+    @@the_matter = 'frontmatter'
+
+    def initialize(book, config)
+      @book = book
+
+      if @book.output_format == 'mobi'
+        unless config['level'].nil?
+          lvl = config['level'].to_i - 1
+          if lvl > 1
+            @level = 1
+          else
+            @level = lvl
+          end
+        else
+          @level = 0
+        end
+      else
+        if config['level'].nil?
+          @level = 0
+        else
+          @level = config['level'].to_i - 1
+        end
+      end
+
+      if config['the_matter']
+        @the_matter = config['the_matter']
+        @@the_matter = config['the_matter']
+      else
+        @the_matter = @@the_matter
+      end
+
+      @linear = config['linear'] || nil
+
+      @src = nil
+      if config.is_a?(String)
+        @src = config
+      elsif config.is_a?(Hash) && config.has_key?('src')
+        @src = config['src']
+      end
+
+      ext_for_output = {
+        'epub' => '.xhtml',
+        'mobi' => '.xhtml',
+        'latex' => '.tex',
+        'web' => '.html'
+      }
+
+      chapters_dir_for_output = {
+        'epub' => File.join('OEBPS', 'chapters'),
+        'mobi' => File.join('OEBPS', 'chapters'),
+        'latex' => 'chapters',
+        'web' => 'chapters',
+      }
+
+      @path = nil
+      @href = nil
+
+      unless @src.nil?
+        @render_ext = ext_for_output[book.output_format]
+
+        @path = File.expand_path(File.join(
+          book.format_dir(@src), @src))
+        @render_name = File.basename(@path).sub(/\.erb$/, '').sub(/\.[^\.]+$/, @render_ext)
+        @render_path = File.expand_path(
+          File.join(
+            self.book.build_dir,
+            chapters_dir_for_output[book.output_format],
+            @render_name
+          )
+        )
+
+        a = Pathname.new(self.render_path)
+        b = Pathname.new(File.expand_path(
+          File.join(
+            self.book.build_dir,
+            chapters_dir_for_output[book.output_format],
+            '..'
+          )
+        ))
+        @href = a.relative_path_from(b)
+      end
+
+      @type = config['type'] || nil
+      @title = config['title'] || self.first_header_text || ""
+      @class = config['class'] || ""
+      @class += " #{@type}" if @type
+      @id = config['id'] || 'chapter_' + @title.downcase.gsub(/[^a-z0-9-]/, '-').gsub(/--+/, '-')
+      @lang = config['lang'] || book.lang
+      @prefix = config['prefix'] || nil
+      @postfix = config['postfix'] || nil
+      @insert = config['insert'] || nil
+
+      if config['section_name']
+        @@section_name[@level] = config['section_name']
+      else
+      end
+      if config['section_number']
+        @@section_number[@level] = config['section_number'].to_i - 1
+      elsif @@section_number[@level].nil?
+        @@section_number[@level] = 1
+      elsif !@path.nil?
+        @@section_number[@level] += 1
+      end
+      @section_name = @@section_name[@level]
+      @section_number = @@section_number[@level]
+
+      @@toc_from_headers = config['toc_from_headers'] unless config['toc_from_headers'].nil?
+
+      @navpoints = []
+      if @path
+        if @@toc_from_headers
+          doc = Nokogiri::HTML(self.to_html)
+          headers = doc.xpath("//*[name()='h1' or name()='h2' or name()='h3' or name()='h4']")
+          headers.each do |h|
+            # skip links (<a href=""> tag) in header (possibly end- or footnote references)
+            t = ""
+            h.children.select{|i| i.name != 'a'}.each{|s| t += s}
+            @navpoints << {
+              'text' => CGI.escapeHTML(t),
+              'src' => "chapters/#{@render_name}##{h.attributes['id']}",
+              'playOrder' => @@playOrder,
+              'level' => @level,
+            }
+            @@playOrder += 1
+          end
+        else
+          @navpoints << {
+            'text' => @title,
+            'src' => "chapters/#{@render_name}",
+            'playOrder' => @@playOrder,
+            'level' => @level,
+          }
+          @@playOrder += 1
+        end
+      end
+
+      if config['layout'].nil?
+        @layout_path = File.join(book.layouts_dir, book.chapter_layout)
+      elsif config['layout'] == 'nil' || config['layout'] == 'none'
+        @layout_path = nil
+      else
+        @layout_path = File.join(book.layouts_dir, config['layout'])
+      end
+    end
+
+    def idref
+      self.book.manifest.items.select do |i|
+        File.expand_path(i.path) == self.render_path
+      end.first.id
+    end
+
+    def first_header_text
+      if @path
+        doc = Nokogiri::HTML(self.to_html)
+        h = doc.xpath("//*[name()='h1' or name()='h2' or name()='h3' or name()='h4']").first
+        h.text.strip if h
+      else
+        nil
+      end
+    end
+
+    def to_guide_reference
+      return "" if @type.nil?
+      ret = "<reference href='#{@href}' title=\"#{@title.gsub('"', "'")}\""
+      ret += " type='#{@type}'"
+      ret += " />"
+    end
+
+    def to_html(format = nil, text = nil, layout_path = @layout_path)
+      format ||= File.extname(@path)
+      text ||= IO.read(@path)
+      # for ERB binding
+      book = self.book
+      chapter = self
+
+      ret = nil
+
+      case format
+      when '.html', '.xhtml'
+        ret = text
+      when '.md', '.mkd', '.markdown'
+        ret = Kramdown::Document.new(text).to_html
+      when '.tex'
+        File.open('./temp-chapter.tex', 'w'){|f| f << text }
+        r = system 'pandoc --smart --normalize --from=latex --to=html -o ./temp-chapter.xhtml ./temp-chapter.tex'
+        warn "WARNING: pandoc returned non-zero for #{self.to_s}" unless r
+        ret = IO.read('./temp-chapter.xhtml')
+        FileUtils.rm(['./temp-chapter.tex', './temp-chapter.xhtml'])
+      when '.erb'
+        template = ERB.new(text)
+        fmt = File.extname(@path.sub(/#{format}$/, ''))
+        return self.to_html(format = fmt, text = template.result(binding))
+      else
+        warn "Don't know how to render: #{@src}"
+        raise "Error while rendering chapter"
+      end
+
+      unless layout_path.nil?
+        template = ERB.new(IO.read(layout_path))
+        content = ret
+        template.result(binding)
+      else
+        ret
+      end
+    end
+
+    def to_tex(format = nil, text = nil, layout_path = @layout_path)
+      format ||= File.extname(@path)
+      text ||= IO.read(@path)
+      # for ERB binding
+      book = self.book
+      chapter = self
+
+      ret = nil
+
+      case format
+      when '.html', '.xhtml'
+        File.open('./temp-chapter.html', 'w'){|f| f << text }
+        system 'pandoc --smart --normalize --chapters --from=html --to=latex -o ./temp-chapter.tex ./temp-chapter.html'
+        ret = IO.read('./temp-chapter.tex')
+        FileUtils.rm(['./temp-chapter.tex', './temp-chapter.html'])
+      when '.md'
+        ret = Kramdown::Document.new(text, options = {:latex_headers => %w{chapter section subsection subsubsection paragraph subparagraph}}).to_latex
+      when '.tex'
+        ret = text
+      when '.erb'
+        template = ERB.new(text)
+        fmt = File.extname(@path.sub(/#{format}$/, ''))
+        ret = self.to_tex(format = fmt, text = template.result(binding))
+      else
+        warn "Don't know how to render: #{@src}"
+        raise "Error while rendering chapter"
+      end
+
+      ret
+    end
+
+    def to_spineitem
+      ret = "<itemref idref='#{self.idref}' "
+      ret += "linear='#{self.linear}'" unless self.linear.nil?
+      ret += " />"
+    end
+
+    def to_chapterlist
+      return "#{@insert}" if @insert
+      ret = ""
+      ret += @prefix + "\n" if @prefix
+
+      if @src
+        ret += "% #{@title}\n" unless @title.empty?
+        if File.extname(@src) == '.tex'
+          ret += "\\input{" + File.join('..', '..', @book.tex_dir, @src) + "}"
+        else
+          ret += "\\input{#{@href}}"
+        end
+      end
+      ret += "\n" + @postfix if @postfix
+      ret
+    end
+
+    def to_toc_li
+      "<li><a href='../chapters/#{@render_name}'><span>#{@title}</span></a></li>"
+    end
+
+    def to_toc_tr
+      ret = ""
+      @navpoints.each do |nav|
+        ret += "<tr>\n"
+        # Section name and number
+        ret += "<td class='section'>\n"
+        if self.mainmatter? && !@section_name.nil? && !@section_name.empty?
+          ret += "#{@section_name} #{@section_number}"
+        end
+        ret += "</td>\n"
+        # Separator
+        ret += "<td class='separator'>"
+        if self.mainmatter? && !@section_name.nil? && !@section_name.empty?
+          ret += " &middot; "
+        end
+        ret += "</td>\n"
+        # Title
+        ret += "<td class='title #{@the_matter}'>\n"
+        ret += "<a href='#{File.join('..', 'chapters', File.basename(nav['src']))}'><span>#{nav['text']}</span></a>\n"
+        ret += "</td>\n"
+        ret += "</tr>"
+      end
+      ret
+    end
+
+    def frontmatter?
+      @the_matter == 'frontmatter'
+    end
+
+    def mainmatter?
+      @the_matter == 'mainmatter'
+    end
+
+    def backmatter?
+      @the_matter == 'backmatter'
+    end
+
+    def self.section_name
+      @@section_name
+    end
+
+    def self.section_name=(a)
+      @@section_name = a
+    end
+
+    def self.section_number
+      @@section_number
+    end
+
+    def self.section_number=(a)
+      @@section_number = a
+    end
+
+    def self.toc_from_headers
+      @@toc_from_headers
+    end
+
+    def self.toc_from_headers=(b)
+      @@toc_from_headers = b
+    end
+
+    def self.the_matter
+      @@the_matter
+    end
+
+    def self.the_matter=(s)
+      @@the_matter = s
+    end
+
+    def to_s
+      [@title, @path].join(", ")
+    end
+  end
+
+end
+