Class: Softcover::Builders::Html

Inherits:
Softcover::Builder show all
Defined in:
lib/softcover/builders/html.rb

Constant Summary

Constants included from Utils

Utils::UNITS

Instance Attribute Summary

Attributes inherited from Softcover::Builder

#built_files, #manifest

Instance Method Summary collapse

Methods inherited from Softcover::Builder

#build!, #initialize

Methods included from Utils

#add_highlight_class!, #as_size, #current_book, #digest, #executable, #execute, #in_book_directory?, #logged_in?, #mkdir, #path, #reset_current_book!, #rm, #silence, #source, #tmpify, #write_pygments_file

Constructor Details

This class inherits a constructor from Softcover::Builder

Instance Method Details

#build(options = {}) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/softcover/builders/html.rb', line 15

def build(options = {})
  if Softcover::profiling?
    require 'ruby-prof'
    RubyProf.start
  end

  if manifest.markdown?
    unless options[:'find-overfull']
      FileUtils.rm(Dir.glob(path("#{manifest.polytex_dir}/*.tex")))
    end
    manifest.chapters.each do |chapter|
      write_latex_files(chapter, options)
    end
    rewrite_master_latex_file
    # Reset the manifest to use PolyTeX.
    self.manifest = Softcover::BookManifest.new(source: :polytex,
                                                verify_paths: true,
                                                origin: :markdown)
  end

  if manifest.polytex?
    basename = File.basename(manifest.filename, '.tex')
    @html  = converted_html(basename)
    @title = basename
    erb_file = File.read(File.join(File.dirname(__FILE__),
                                   '../server/views/book.html.erb'))
    file_content = ERB.new(erb_file).result(binding)
    write_full_html_file(basename, file_content)
    write_chapter_html_files(Nokogiri::HTML(file_content), erb_file)
  end

  if Softcover::profiling?
    result = RubyProf.stop
    printer = RubyProf::GraphPrinter.new(result)
    printer.print(STDOUT, {})
  end

  true
end

#build_target_cache(xml) ⇒ Object

Builds a cache of targets for cross-references.



156
157
158
159
160
161
162
 
# File 'lib/softcover/builders/html.rb', line 156

def build_target_cache(xml)
  {}.tap do |target_cache|
    xml.xpath("//*[@id]").each do |target|
      target_cache[target['id']] = target
    end
  end
end

#clean! ⇒ Object 



203
204
205
206
207
208
209
 
# File 'lib/softcover/builders/html.rb', line 203

def clean!
  # It's safe to remove HTML files in the html/ directory,
  # as they are regenerated every time the book gets built.
  # This also arranges to clear out unused HTML files, as happens when,
  # e.g., the name of a LaTeX chapter file changes.
  FileUtils.rm(Dir.glob(path('html/*.html')))
end

#converted_html(basename) ⇒ Object

Returns the converted HTML.



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/softcover/builders/html.rb', line 90

def converted_html(basename)
  polytex_filename = basename + '.tex'
  polytex = File.read(polytex_filename)
  # Replace the includes with the file contents, padding with a trailing
  # newline for safety.
  polytex.gsub!(/(^\s*\\include{(.*?)})/) do
    File.read($2 + '.tex') + "\n"
  end
  cc = Softcover.custom_styles
  Polytexnic::Pipeline.new(polytex, custom_commands: cc).to_html
end

#rewrite_master_latex_file ⇒ Object

Rewrites the master LaTeX file <name>.tex to use chapters from Book.txt.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/softcover/builders/html.rb', line 66

def rewrite_master_latex_file
  master_filename = Dir['*.tex'].reject { |f| f =~ /\.tmp/}.first
  lines = File.readlines('Book.txt')
  tex_file = []
  lines.each do |line|
    if line =~ /(.*)\.md\s*$/
      tex_file << "\\include{#{manifest.polytex_dir}/#{$1}}"
    elsif line =~ /(.*):\s*$/  # frontmatter or mainmatter
      tex_file << "\\#{$1}"
    elsif line.strip == 'cover'
      tex_file << '\\includepdf{images/cover.pdf}'
    else # raw command, like 'maketitle' or 'tableofcontents'
      tex_file << "\\#{line.strip}"
    end
  end
  tex_file << '\end{document}'
  content = File.read(master_filename)
  content.gsub!(/(\\begin{document}\n)(.*)/m) do
    $1 + tex_file.join("\n") + "\n"
  end
  File.write(master_filename, content)
end

#setup ⇒ Object 



7
8
9
10
11
12
13
 
# File 'lib/softcover/builders/html.rb', line 7

def setup
  Dir.mkdir "html" unless File.directory?("html")
  unless File.directory?(path('html/stylesheets'))
    Dir.mkdir path('html/stylesheets')
  end
  clean!
end

#split_into_chapters(xml) ⇒ Object

Splits the full XML document into chapters.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/softcover/builders/html.rb', line 132

def split_into_chapters(xml)
  chapter_number = 0
  current_chapter = manifest.chapters.first
  reference_cache = {}
  xml.css('#book>div').each do |node|
    klass = node.attributes['class'].to_s
    id = node.attributes['id'].to_s
    if klass == 'chapter' || id == 'frontmatter'
      current_chapter = manifest.chapters[chapter_number]
      node['data-chapter'] = current_chapter.slug
      chapter_number += 1
    end

    reference_cache[node['data-tralics-id']] = current_chapter
    node.xpath('.//*[@data-tralics-id]').each do |labeled_node|
      reference_cache[labeled_node['data-tralics-id']] = current_chapter
    end

    current_chapter.nodes.push node
  end
  reference_cache
end

#update_cross_references(chapter, ref_map, target_cache) ⇒ Object

Updates the book’s cross-references.



165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/softcover/builders/html.rb', line 165

def update_cross_references(chapter, ref_map, target_cache)
  chapter.nodes.each do |node|
    node.css('a.hyperref').each do |ref_node|
      ref_id = ref_node['href'][1..-1]  # i.e., 'cha-foo_bar'
      target = target_cache[ref_id]
      unless target.nil?
        id = target['id']
        ref_chapter = ref_map[target['data-tralics-id']]
        ref_node['href'] = "#{ref_chapter.fragment_name}##{id}"
      end
    end
  end
end

#write_chapter_html_files(html, erb_file) ⇒ Object

Writes the full HTML file for each chapter. The resulting files are self-contained HTML documents suitable for viewing in isolation.



121
122
123
124
125
126
127
128
129
 
# File 'lib/softcover/builders/html.rb', line 121

def write_chapter_html_files(html, erb_file)
  reference_cache = split_into_chapters(html)
  target_cache = build_target_cache(html)
  manifest.chapters.each_with_index do |chapter, i|
    update_cross_references(chapter, reference_cache, target_cache)
    write_fragment_file(chapter)
    write_complete_file(chapter, erb_file, i)
  end
end

#write_complete_file(chapter, erb_file, n) ⇒ Object

Writes the chapter as a complete, self-contained HTML document.



191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/softcover/builders/html.rb', line 191

def write_complete_file(chapter, erb_file, n)
  html_filename = File.join('html', chapter.slug + '.html')
  File.open(html_filename, 'w') do |f|
    @html = chapter.nodes.map(&:to_xhtml).join("\n")
    @mathjax = Softcover::Mathjax::config(chapter_number: n)
    @src     = Softcover::Mathjax::AMS_SVG
    file_content = ERB.new(erb_file).result(binding)
    f.write(file_content)
  end
  built_files.push html_filename
end

#write_fragment_file(chapter) ⇒ Object

Writes the chapter fragment HTML (omitting, e.g., <html> tags, etc.)



180
181
182
183
184
185
186
187
188
 
# File 'lib/softcover/builders/html.rb', line 180

def write_fragment_file(chapter)
  html_filename = File.join('html', "#{chapter.slug}_fragment.html")
  File.open(html_filename, 'w') do |f|
    chapter.nodes.each do |node|
      f.write(node.to_xhtml)
    end
  end
  built_files.push html_filename
end

#write_full_html_file(basename, file_content) ⇒ Object

Writes the full HTML file for the book. The resulting file is a self-contained HTML document suitable for viewing in isolation.



105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/softcover/builders/html.rb', line 105

def write_full_html_file(basename, file_content)
  html_filename = File.join('html', basename + '.html')
  File.open(html_filename, 'w') do |f|
    f.write(file_content)
  end
  polytexnic_css = File.join('html', 'stylesheets', 'softcover.css')
  source_css     = File.join(File.dirname(__FILE__),
                             "../template/#{polytexnic_css}")
  FileUtils.cp source_css, polytexnic_css
  write_pygments_file(:html, File.join('html', 'stylesheets'))
  built_files.push html_filename
end

#write_latex_files(chapter, options = {}) ⇒ Object

Writes the LaTeX files for a given Markdown chapter.



56
57
58
59
60
61
62
63
 
# File 'lib/softcover/builders/html.rb', line 56

def write_latex_files(chapter, options = {})
  path = File.join('chapters', chapter.slug + '.md')
  cc = Softcover.custom_styles
  md = Polytexnic::Pipeline.new(File.read(path), source: :md,
                                                 custom_commands: cc)
  filename = path("#{manifest.polytex_dir}/#{chapter.slug}.tex")
  File.write(filename, md.polytex)
end