softcover 1.1.22 → 1.1.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72e252aa13bbad0e3f8324319dbc95735e44b543
-  data.tar.gz: e0103feb26670764f118d26adec63daf3ad72f95
+  metadata.gz: 0525db14fac2a0c8d3e36fe1730e11aadea0f260
+  data.tar.gz: 6ac3cade0c04ae7cb4c970a4fe13012d4fb70b29
 SHA512:
-  metadata.gz: dc00bf1862a43dbb8a3ba1abfd91c447e1075992103b01412eb9e9141412f244d35059655ec6062d2d11265001c44a8026277953b443281de138d1e9bac1fa37
-  data.tar.gz: 53df4405acc260fed02cfd3d2d075316afbe1b961422fc7c9f70baba1df9e1f58e23526ef2e656f79746e5ed599933e14cd5c78228a807961cc9367f34464ca4
+  metadata.gz: c575083b8d00e0262bec7b18d37d9d7d079618409a20bd745081c922bf2fdaef6a402cfc4b0bac1085869be71e665e60fad265c34fb5e56f7680fd4d2d01d247
+  data.tar.gz: c0aa8dc1442c3f738fba7aa99534a7701f146dfd0c538c38a9363fc8aa7bbe305072414620bd4c5cb1b2619367082645845bb342bb2890f18df9403f1c116732

data/lib/softcover/article_template/latex_gitignore

@@ -12,9 +12,11 @@ generated_polytex/
 
 # Generated HTML files
 html/*.html
+html/*.xhtml
 
 # Generated EPUB files
 epub/OEBPS/*.html
+epub/OEBPS/*.xhtml
 epub/OEBPS/*.opf
 epub/OEBPS/*.ncx
 epub/OEBPS/images

data/lib/softcover/article_template/markdown_gitignore

@@ -13,9 +13,11 @@ generated_polytex/
 
 # Generated HTML files
 html/*.html
+html/*.xhtml
 
 # Generated EPUB files
 epub/OEBPS/*.html
+epub/OEBPS/*.xhtml
 epub/OEBPS/*.opf
 epub/OEBPS/*.ncx
 epub/OEBPS/images

data/lib/softcover/book_manifest.rb

@@ -31,7 +31,7 @@ class Softcover::BookManifest < OpenStruct
     include Softcover::Utils
 
     def fragment_name
-      "#{slug}_fragment.html"
+      "#{slug}_fragment.#{html_extension}"
     end
 
     def fragment_path
@@ -281,7 +281,7 @@ class Softcover::BookManifest < OpenStruct
 
   # Returns the name of the HTML file containing the full book.
   def full_html_file
-    path("html/#{slug}.html")
+    path("html/#{slug}.#{html_extension}")
   end
 
   # Returns chapters for the PDF.

data/lib/softcover/book_template/latex_gitignore

@@ -12,9 +12,11 @@ generated_polytex/
 
 # Generated HTML files
 html/*.html
+html/*.xhtml
 
 # Generated EPUB files
 epub/OEBPS/*.html
+epub/OEBPS/*.xhtml
 epub/OEBPS/*.opf
 epub/OEBPS/*.ncx
 epub/OEBPS/images

data/lib/softcover/book_template/markdown_gitignore

@@ -13,6 +13,7 @@ generated_polytex/
 
 # Generated HTML files
 html/*.html
+html/*.xhtml
 
 # Generated EPUB files
 epub/OEBPS/*.html

data/lib/softcover/builders/epub.rb

@@ -25,6 +25,15 @@ module Softcover
       !options[:amazon] && cover_img
     end
 
+    def cover_filename
+      xhtml("cover.#{html_extension}")
+    end
+
+    # Transforms foo.html to foo.xhtml
+    def xhtml(filename)
+      filename.sub('.html', '.xhtml')
+    end
+
     def cover_img_path
       path("#{images_dir}/#{cover_img}")
     end
@@ -33,6 +42,11 @@ module Softcover
       path('epub/OEBPS/images')
     end
 
+    def nav_filename
+      xhtml("nav.#{html_extension}")
+    end
+
+
     def escape(string)
       CGI.escape_html(string)
     end
@@ -42,7 +56,7 @@ module Softcover
                              toc_chapters, manifest_chapters, images)
       if cover_id
         cover_meta = %(<meta name="cover" content="#{cover_id}"/>)
-        cover_html = '<item id="cover" href="cover.html" media-type="application/xhtml+xml"/>'
+        cover_html = %(<item id="cover" href="#{cover_filename}" media-type="application/xhtml+xml"/>)
         cover_ref  = '<itemref idref="cover" linear="no" />'
       else
         cover_meta = cover_html = cover_ref = ''
@@ -61,7 +75,7 @@ module Softcover
       #{cover_meta}
   </metadata>
   <manifest>
-      <item href="nav.html" id="nav" media-type="application/xhtml+xml" properties="nav"/>
+      <item href="#{nav_filename}" id="nav" media-type="application/xhtml+xml" properties="nav"/>
       <item id="ncx" href="toc.ncx" media-type="application/x-dtbncx+xml"/>
       <item id="page-template.xpgt" href="styles/page-template.xpgt" media-type="application/vnd.adobe-page-template+xml"/>
       <item id="pygments.css" href="styles/pygments.css" media-type="text/css"/>
@@ -160,6 +174,7 @@ module Softcover
       # All the HTML is generated, so this clears out any unused files.
       def remove_html
         FileUtils.rm(Dir.glob(path('epub/OEBPS/*.html')))
+        FileUtils.rm(Dir.glob(path('epub/OEBPS/*.xhtml')))
       end
 
       # Removes images in case they are stale.
@@ -215,14 +230,18 @@ module Softcover
         mkdir images_dir
         mkdir texmath_dir
 
-        File.write(path('epub/OEBPS/cover.html'), cover_page) if cover?(options)
+        File.write(path("epub/OEBPS/#{cover_filename}"), cover_page) if cover?(options)
 
         pngs = []
         chapters.each_with_index do |chapter, i|
-          target_filename = path("epub/OEBPS/#{chapter.fragment_name}")
+          target_filename = path("epub/OEBPS/#{xhtml(chapter.fragment_name)}")
           File.open(target_filename, 'w') do |f|
             content = File.read(path("html/#{chapter.fragment_name}"))
             doc = strip_attributes(Nokogiri::HTML(content))
+            # Use xhtml in references.
+            doc.css('a.hyperref').each do |ref_node|
+              ref_node['href'] = ref_node['href'].sub('.html', xhtml('.html'))
+            end
             body = doc.at_css('body')
             if body.nil?
               $stderr.puts "\nError: Document not built due to empty chapter"
@@ -262,9 +281,10 @@ module Softcover
       # SHAs of their contents, which arranges both for unique filenames
       # and for automatic disk caching.
       def html_with_math(chapter, images_dir, texmath_dir, pngs, options={})
-        content = File.read(File.join("html", "#{chapter.slug}.html"))
+        content = File.read(File.join("html",
+                                      "#{chapter.slug}.#{html_extension}"))
         pagejs = "#{File.dirname(__FILE__)}/utils/page.js"
-        url = "file://#{Dir.pwd}/html/#{chapter.slug}.html"
+        url = "file://#{Dir.pwd}/html/#{chapter.slug}.#{html_extension}"
         cmd = "#{phantomjs} #{pagejs} #{url}"
         silence { silence_stream(STDERR) { system cmd } }
         # Sometimes in tests the phantomjs_source.html file is missing.
@@ -323,7 +343,8 @@ module Softcover
         end
         # Make references relative.
         source.css('a.hyperref').each do |ref_node|
-          ref_node['href'] = ref_node['href'].sub('.html', '_fragment.html')
+          ref_node['href'] = ref_node['href'].sub('.html',
+                                                  xhtml('_fragment.html'))
         end
         source.at_css('div#book').children.to_xhtml
       end
@@ -446,7 +467,7 @@ module Softcover
       # Writes the navigation file.
       # This is required by the EPUB standard.
       def write_nav
-        File.write('epub/OEBPS/nav.html', nav_html)
+        File.write("epub/OEBPS/#{nav_filename}", nav_html)
       end
 
       def container_xml
@@ -470,7 +491,7 @@ module Softcover
       # Returns the content configuration file.
       def content_opf(options={})
         man_ch = chapters.map do |chapter|
-                   %(<item id="#{chapter.slug}" href="#{chapter.fragment_name}" media-type="application/xhtml+xml"/>)
+                   %(<item id="#{chapter.slug}" href="#{xhtml(chapter.fragment_name)}" media-type="application/xhtml+xml"/>)
                  end
           toc_ch = chapters.map do |chapter|
                      %(<itemref idref="#{chapter.slug}"/>)
@@ -523,14 +544,14 @@ module Softcover
           section_names_and_ids(article).each_with_index do |(name, id), n|
             chapter_nav << %(<navPoint id="#{id}" playOrder="#{n+1}">)
             chapter_nav << %(    <navLabel><text>#{escape(name)}</text></navLabel>)
-            chapter_nav << %(    <content src="#{article.fragment_name}##{id}"/>)
+            chapter_nav << %(    <content src="#{xhtml(article.fragment_name)}##{id}"/>)
             chapter_nav << %(</navPoint>)
           end
         else
           chapters.each_with_index do |chapter, n|
             chapter_nav << %(<navPoint id="#{chapter.slug}" playOrder="#{n+1}">)
             chapter_nav << %(    <navLabel><text>#{chapter_name(n)}</text></navLabel>)
-            chapter_nav << %(    <content src="#{chapter.fragment_name}"/>)
+            chapter_nav << %(    <content src="#{xhtml(chapter.fragment_name)}"/>)
             chapter_nav << %(</navPoint>)
           end
         end
@@ -547,7 +568,7 @@ module Softcover
         if article?
           article = chapters.first
           nav_list = section_names_and_ids(article).map do |name, id|
-                       %(<li> <a href="#{article.fragment_name}##{id}">#{name}</a></li>)
+                       %(<li> <a href="#{xhtml(article.fragment_name)}##{id}">#{name}</a></li>)
                      end
         else
           nav_list = manifest.chapters.map do |chapter|
@@ -560,14 +581,14 @@ module Softcover
 
       # Returns a navigation link for the chapter.
       def nav_link(chapter)
-        %(<a href="#{chapter.fragment_name}">#{chapter.html_title}</a>)
+        %(<a href="#{xhtml(chapter.fragment_name)}">#{chapter.html_title}</a>)
       end
 
       # Returns a list of the section names and CSS ids.
       # Form is [['Beginning', 'sec-beginning'], ['Next', 'sec-next']]
       def section_names_and_ids(article)
         # Grab section names and ids from the article.
-        filename = File.join('epub', 'OEBPS', article.fragment_name)
+        filename = File.join('epub', 'OEBPS', xhtml(article.fragment_name))
         doc = Nokogiri::HTML(File.read(filename))
         names = doc.css('div.section>h2').map do |s|
                   s.children.children.last.content

data/lib/softcover/builders/html.rb

@@ -127,7 +127,7 @@ module Softcover
       # The resulting file is a self-contained HTML document suitable
       # for viewing in isolation.
       def write_full_html_file(basename, file_content, options)
-        html_filename = File.join('html', basename + '.html')
+        html_filename = File.join('html', "#{basename}.#{html_extension}")
         File.open(html_filename, 'w') do |f|
           f.write(file_content)
         end
@@ -221,7 +221,8 @@ module Softcover
 
       # Writes the chapter fragment HTML (omitting, e.g., <html> tags, etc.)
       def write_fragment_file(chapter)
-        html_filename = File.join('html', "#{chapter.slug}_fragment.html")
+        html_filename = File.join('html',
+                                  "#{chapter.slug}_fragment.#{html_extension}")
         File.open(html_filename, 'w') do |f|
           chapter.nodes.each do |node|
             f.write(node.to_xhtml)
@@ -232,7 +233,7 @@ module Softcover
 
       # Writes the chapter as a complete, self-contained HTML document.
       def write_complete_file(chapter, erb_file, n)
-        html_filename = File.join('html', chapter.slug + '.html')
+        html_filename = File.join('html', "#{chapter.slug}.#{html_extension}")
         # Make references absolute.
         chapter.nodes.each do |node|
           node.css('a.hyperref').each do |ref_node|
@@ -255,6 +256,7 @@ module Softcover
         # 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')))
+        FileUtils.rm(Dir.glob(path('html/*.xhtml')))
       end
     end
   end

data/lib/softcover/commands/check.rb

@@ -87,9 +87,9 @@ module Softcover
           "Install zip (e.g., apt-get install zip)"
         when :epubcheck
           url  = 'https://github.com/IDPF/epubcheck/releases/'
-          url += 'download/v3.0/epubcheck-3.0.zip'
-          message  = "EpubCheck 3.0 (#{url})\n"
-          message += "      ∟ Unzip and place epubcheck-3.0/ in a directory on your path"
+          url += 'download/v4.0.1/epubcheck-4.0.1.zip'
+          message  = "EpubCheck 4.0.1 (#{url})\n"
+          message += "      ∟ Unzip and place epubcheck-4.0.1/ in a directory on your path"
         when :inkscape
           message  = "Inkscape (http://inkscape.org/)"
         else

data/lib/softcover/utils.rb

@@ -41,6 +41,10 @@ module Softcover::Utils
     Softcover::Config['api_key'].present?
   end
 
+  def html_extension
+    'html'
+  end
+
   UNITS = %W(B KB MB GB TB).freeze
 
   def as_size(number)
@@ -238,6 +242,13 @@ module Softcover::Utils
     lines.reject { |line| line =~ skip }.join("\n")
   end
 
+  # Returns first location on the path for a given file.
+  def first_path(file)
+    possible_paths = ENV['PATH'].split(File::PATH_SEPARATOR).
+                                       collect { |x| File.join(x, file) }
+    possible_paths.find { |f| File.file?(f) }
+  end
+
   # Returns the filename of a dependency given a label.
   def dependency_filename(label)
     case label
@@ -249,10 +260,9 @@ module Softcover::Utils
       get_filename(:'ebook-convert')
     when :epubcheck
       # Finds EpubCheck anywhere on the path.
-      cmd_path = ['epubcheck-3.0', 'epubcheck-3.0.jar']
-      possible_paths = ENV['PATH'].split(File::PATH_SEPARATOR).
-                                   collect { |x| File.join(x, cmd_path) }
-      possible_paths.select { |f| File.file?(f) }.first || ""
+      version_3 = path('epubcheck-3.0/epubcheck-3.0.jar')
+      version_4 = path('epubcheck-4.0.1/epubcheck.jar')
+      first_path(version_4) || first_path(version_3) || ""
     when :inkscape
       default = '/Applications/Inkscape.app/Contents/Resources/bin/inkscape'
       filename_or_default(:inkscape, default)

data/lib/softcover/version.rb

@@ -1,3 +1,3 @@
 module Softcover
-  VERSION = "1.1.22"
+  VERSION = "1.1.23"
 end

data/spec/builders/epub_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Softcover::Builders::Epub do
   before(:all) do
     generate_book
-    @file_to_be_removed = path('html/should_be_removed.html')
+    @file_to_be_removed = path('html/should_be_removed.xhtml')
     File.write(@file_to_be_removed, '')
     silence { `softcover build:epub` }
     @builder = Softcover::Builders::Epub.new
@@ -118,9 +118,9 @@ describe Softcover::Builders::Epub do
       it { should exist }
 
       it "should contain the right filenames in the right order" do
-        filenames = %w[frontmatter_fragment.html a_chapter_fragment.html
-                       another_chapter_fragment.html
-                       yet_another_chapter_fragment.html]
+        filenames = %w[frontmatter_fragment.xhtml a_chapter_fragment.xhtml
+                       another_chapter_fragment.xhtml
+                       yet_another_chapter_fragment.xhtml]
         source_files = doc.css('content').map { |node| node['src'] }
         expect(source_files).to eql(filenames)
       end
@@ -150,11 +150,11 @@ describe Softcover::Builders::Epub do
 
       it "should create the HTML files" do
         has_math = false
-        expect(path('epub/OEBPS/cover.html')).to exist
+        expect(path('epub/OEBPS/cover.xhtml')).to exist
         builder.manifest.chapters.each_with_index do |chapter, i|
           content = File.read(path("html/#{chapter.slug}_fragment.html"))
           has_math ||= builder.math?(content)
-          fragment = path("epub/OEBPS/#{chapter.slug}_fragment.html")
+          fragment = path("epub/OEBPS/#{chapter.slug}_fragment.xhtml")
           expect(fragment).to exist
         end
         # Make sure at least one template file has math.
@@ -162,7 +162,7 @@ describe Softcover::Builders::Epub do
       end
 
       describe "cover file" do
-        subject(:cover_file) { File.read(path('epub/OEBPS/cover.html')) }
+        subject(:cover_file) { File.read(path('epub/OEBPS/cover.xhtml')) }
         it "should have the right cover image" do
           expect(cover_file).to include 'cover.jpg'
         end
@@ -263,7 +263,7 @@ describe Softcover::EpubUtils do
     end
   end
 
-  context "nav.html template" do
+  context "nav.xhtml template" do
     let(:nav_list) { [] }
     let(:template) do
       dummy_class.new.nav_html_template(title, nav_list)
@@ -278,7 +278,7 @@ end
 describe "article validation" do
   before(:all) do
     generate_book(markdown: true, article: true)
-    @file_to_be_removed = path('html/should_be_removed.html')
+    @file_to_be_removed = path('html/should_be_removed.xhtml')
     File.write(@file_to_be_removed, '')
     silence { `softcover build:epub` }
     @builder = Softcover::Builders::Epub.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: softcover
 version: !ruby/object:Gem::Version
-  version: 1.1.22
+  version: 1.1.23
 platform: ruby
 authors:
 - Michael Hartl
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-01 00:00:00.000000000 Z
+date: 2016-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: polytexnic