softcover 0.8.9 → 0.9.0

data/lib/softcover/template/chapters/a_chapter.tex

@@ -1,7 +1,7 @@
 \chapter{A chapter}
 \label{cha:a_chapter}
 
-This is the first paragraph of the Softcover template. It shows how to write a document in \PolyTeX, a subset of the \LaTeX\ typesetting language optimized for ebooks. For more information, see \href{http://manual.softcover.org/book}{\emph{The Softcover Book}} and the \href{http://example.com}{\PolyTeX\ source of the book}. To learn how to easily publish (and optionally sell) documents produced with Softcover, visit \href{http://softcover.io/}{Softcover.io}. Softcover is currently in private beta; go to \href{http://softcover.io/}{Softcover.io} to get an invitation.
+This is the first paragraph of the Softcover template. It shows how to write a document in \PolyTeX, a subset of the \LaTeX\ typesetting language optimized for ebooks. For more information, see \href{http://manual.softcover.org/book}{\emph{The Softcover Book}}. To learn how to easily publish (and optionally sell) documents produced with Softcover, visit \href{http://softcover.io/}{Softcover.io}. Softcover is currently in private beta; go to \href{http://softcover.io/}{Softcover.io} to get an invitation.
 
 This is the \emph{second} paragraph, showing how to emphasize text.\footnote{This is a footnote. It is numbered automatically.} You can also make text \textbf{bold} or \textit{italicized} (which looks the same as emphasized text).
 
@@ -22,7 +22,7 @@ def hello
   puts "hello, world!"
 end
 \end{code}
-\noindent Softcover can highlight any language supported by \href{http://pygments.org/languages/}{Pygments} (which means most of them).
+\noindent Softcover can highlight any language supported by \href{http://pygments.org/languages/}{Pygments} (which is most of them).
 
 You can also define \emph{code listings}, as seen in Listing~\ref{code:hello_world}. Such code listings are automatically numbered and linked.
 
@@ -39,7 +39,7 @@ end
 
 You can indicate inline code with the \verb+\kode+ command, as in \kode{current\_\-user}. If you prefer a plainer version of the same thing, you can use ``typewriter text'', as in \texttt{current\_\-user}.
 
-For words whose hypenation isn't built in, you can indicate an optional hyphen using \verb+\-+ (Listing~\ref{code:hyphenation}), which will only be used if necessary to make a clean line break (and even then only when producing PDFs). You can also define global hyphenation rules in \texttt{custom.sty}, which includes a rule for hyphenating ``JavaScript'' (Listing~\ref{code:custom}).
+For words whose hypenation isn't built in, you can indicate an optional hyphen using \verb+\-+ (Listing~\ref{code:hyphenation}), which will only be used if necessary to make a clean line break (and even then only when producing PDFs). You can also define global hyphenation rules in \texttt{custom\_pdf.sty}, which includes a rule for hyphenating ``JavaScript'' (Listing~\ref{code:custom}).
 
 \begin{codelisting}
 \label{code:hyphenation}
@@ -52,8 +52,8 @@ current\_\-user
 
 \begin{codelisting}
 \label{code:custom}
-\codecaption{Defining custom commands. \\ \filepath{latex\_styles/custom.sty}}
-%= <<(latex_styles/custom.sty, lang: tex)
+\codecaption{Defining custom commands. \\ \filepath{latex\_styles/custom\_pdf.sty}}
+%= <<(latex_styles/custom_pdf.sty, lang: tex)
 \end{codelisting}
 
 Listing~\ref{code:hyphenation} also shows how to escape the underscore character using a backslash. This is necessary because plain underscores are reserved for math environments (Section~\ref{sec:mathematics}).
@@ -140,11 +140,11 @@ Softcover supports raw tables via the \kode{tabular} environment. To make a tabu
 
 \section{Command-line interface}
 
-Softcover comes with a command-line interface called \kode{poly}. To get more information, just run \kode{softcoverhelp}:
+Softcover comes with a command-line interface called \kode{poly}. To get more information, just run \kode{softcover help}:
 
 %= lang:console
 \begin{code}
-$ softcoverhelp
+$ softcover help
 Commands:
   softcover build, build:all           # Build all formats
   softcover build:epub                 # Build EPUB
@@ -152,26 +152,18 @@ Commands:
   softcover build:mobi                 # Build MOBI
   softcover build:pdf                  # Build PDF
   softcover build:preview              # Build book preview in all formats
-  softcover config                     # View local config
-  softcover config:add key=value       # Add to your local config vars
-  softcover epub:validate, epub:check  # Validate EPUB with epubcheck
-  softcover help [COMMAND]             # Describe available commands...
-  softcover login                      # Log into Softcover account
-  softcover logout                     # Log out of Softcover account
-  softcover new <name>                 # Generate new book directory structure.
-  softcover open                       # Open book on Softcover website (OS X)
-  softcover publish                    # Publish your book on Softcover
-  softcover publish:screencasts        # Publish screencasts
-  softcover server                     # Run local server
+  .
+  .
+  .
 \end{code}
 
 \noindent You can run \kode{softcover help <command>} to get additional help on a given command:
 
 %= lang:console
 \begin{code}
-$ softcoverhelp build
+$ softcover help build
 Usage:
-  softcoverbuild, build:all
+  softcover build, build:all
 
 Options:
   -q, [--quiet]   # Quiet output
@@ -187,4 +179,4 @@ This is the end of the template---apart from two mostly empty chapters (Chapter~
 
 %= <<(chapters/yet_another_chapter.tex)
 
-See \href{http://manual.softcover.org/book}{\emph{The Softcover Book}} to learn more about what Softcover can do.
+See \href{http://manual.softcover.org/book}{\emph{The Softcover Book}} to learn more about what Softcover can do.

data/lib/softcover/template/chapters/another_chapter.md

@@ -1,9 +1,11 @@
 # Another chapter
 
-This is another chapter.[^numbering] It also has a little code fencing, mainly to test an edge case where math syntax appears in a non-math context:
+This is another chapter.[^numbering] It also includes a little code fencing, mainly to test an edge case for the sake of the Softcover test suite:[^why_code_fencing]
 
 ```console
 $ find . \( -name \*.gemspec -or -name \*.jpg \) -type f
 ```
 
 [^numbering]: Footnotes are numbered on a per-chapter basis.
+
+[^why_code_fencing]: The test suite uses the template files to stress-test the build system. In this case, there used to be a bug when math syntax appeared in a non-math context. Including the code fencing as above ensures that any regressions will cause the test suite to fail.

data/lib/softcover/template/config/lang.yml

@@ -0,0 +1,14 @@
+---
+chapter:
+  word: Chapter
+  order: standard     # Use 'reverse' to change 'Chapter 1' to '1 Chapter'
+section: Section
+table: Table
+figure: Figure
+fig: Fig
+aside: Box
+listing: Listing
+equation: Equation
+eq: Eq
+frontmatter: Frontmatter
+contents: Contents

data/lib/softcover/template/config/preamble.tex

@@ -0,0 +1,8 @@
+\documentclass[14pt]{extbook} % Edit this line to change the documentclass.
+% Add custom preamble content below.
+% Example commands for using the Polyglossia package with French are
+% included for reference.
+% You may also have to edit config/lang.yml to sync up the HTML/EPUB/MOBI.
+% \usepackage{polyglossia}
+% \setdefaultlanguage{french}
+% \DeclareTextCommandDefault{\nobreakspace}{\leavevmode\nobreak\ }

data/lib/softcover/template/epub/OEBPS/styles/custom_epub.css

@@ -0,0 +1,7 @@
+/* Custom styles specific to EPUB (and hence MOBI) books */
+
+/*.highlight pre {
+  font-size: 80%;
+  font-weight: normal;
+}
+*/

data/lib/softcover/template/latex_styles/custom_pdf.sty

@@ -1,7 +1,9 @@
-% You can also use this file to define commands that *only* pertain to the PDF.
+% You should use this file to define commands that *only* pertain to the PDF.
+% Otherwise, use `custom.sty`.
 % For example, you can define the proper hypenation of any words that LaTeX
 % can't hyphenate natively.
-\hyphenation{Ja-va-Script}
+% \hyphenation{Ja-va-Script}
 % You can also include and use packages.
-\usepackage{newunicodechar}
-\newunicodechar{★}{\ensuremath{\star}}
+% \usepackage{newunicodechar}
+% \newunicodechar{★}{\ensuremath{\star}}
+% \newunicodechar{ž}{\v{z}}

data/lib/softcover/template/latex_styles/language_customization.sty

@@ -0,0 +1,11 @@
+% This file is automatically overwritten; do not edit.
+
+% Aside box label
+\renewcommand{\boxlabel}{Box}
+
+% Codelisting captions
+\usepackage[hypcap=false]{caption}
+\DeclareCaptionFormat{listing}{\hspace{-0.2em}\colorbox[gray]{.85}{\hspace{0.1em}\parbox{0.997\textwidth}{#1#2#3}}\vspace{-1.3\baselineskip}}
+\captionsetup[listing]{format=listing,labelfont=bf,skip=16pt,font={rm,normalsize}}
+\DeclareCaptionType{listing}
+\newcommand{\codecaption}[1]{\captionof{listing}{#1}}

data/lib/softcover/template/latex_styles/softcover.sty

@@ -114,17 +114,13 @@
 \numberwithin{codelisting}{chapter}
 \newenvironment{codelisting}{\refstepcounter{codelisting}\begin{framed_shaded}\vspace{-0.5em}}%
 {\end{framed_shaded}}
-% Codelisting captions
-\usepackage[hypcap=false]{caption}
-\DeclareCaptionFormat{listing}{\hspace{-0.2em}\colorbox[gray]{.85}{\hspace{0.1em}\parbox{0.997\textwidth}{#1#2#3}}\vspace{-1.3\baselineskip}}
-\captionsetup[listing]{format=listing,labelfont=bf,skip=16pt,font={rm,normalsize}}
-\DeclareCaptionType{listing}
-\newcommand{\codecaption}[1]{\captionof{listing}{#1}}
+% See latex_styles/language_customization.sty for codelisting captions.
 
 % Aside boxes
 \usepackage{amsthm}
 \theoremstyle{definition}
-\newtheorem{aside}{Box}[chapter]
+\newcommand{\boxlabel}{Box}
+\newtheorem{aside}{\boxlabel}[chapter]
 \usepackage{latex_styles/framed}
 \definecolor{shadecolor}{gray}{0.97}
 \definecolor{boxcolor}{gray}{0.10}
@@ -144,6 +140,13 @@
     \vskip0.5em}%
 }
 
+% Define some commonly used Unicode characters.
+\usepackage{newunicodechar}
+\newunicodechar{—}{---}
+\newunicodechar{–}{--}
+
+\usepackage{latex_styles/language_customization}
+
 % Add custom commands.
 \usepackage{latex_styles/custom}
 \usepackage{latex_styles/custom_pdf}

data/lib/softcover/utils.rb

@@ -103,13 +103,14 @@ module Softcover::Utils
       end
     end
     tex_file << '\end{document}'
-    tex_file.join("\n")
+    tex_file.join("\n") + "\n"
   end
 
   def master_latex_header(manifest)
+    preamble = File.read(path('config/preamble.tex'))
     subtitle = manifest.subtitle.nil? ? "" : "\\subtitle{#{manifest.subtitle}}"
     <<-EOS
-\\documentclass[14pt]{extbook}
+#{preamble}
 \\usepackage{#{Softcover::Directories::STYLES}/softcover}
 \\VerbatimFootnotes % Allows verbatim text in footnotes
 \\title{#{manifest.title}}
@@ -165,11 +166,11 @@ module Softcover::Utils
   end
 
   # Returns the executable if it exists, raising an error otherwise.
-  def executable(filename, message)
+  def executable(filename)
     filename.tap do |f|
       unless File.exist?(f)
         $stderr.puts "Document not built due to missing dependency"
-        $stderr.puts message
+        $stderr.puts "Run `softcover check` to check dependencies"
         exit 1
       end
     end
@@ -179,8 +180,13 @@ module Softcover::Utils
     Dir.mkdir(dir) unless File.directory?(dir)
   end
 
+  # Removes a file (or list of files).
   def rm(file)
-    FileUtils.rm(file) if File.exist?(file)
+    if file.is_a?(Array)
+      file.each { |f| rm(f) }
+    else
+      FileUtils.rm(file) if File.exist?(file)
+    end
   end
 
   # Returns the system-independent file path.
@@ -214,5 +220,58 @@ module Softcover::Utils
   def linux?
     RUBY_PLATFORM.match(/linux/)
   end
-end
 
+  # Returns the commands from the given lines.
+  # We skip comments and blank lines.
+  def commands(lines)
+    skip = /(^\s*#|^\s*$)/
+    lines.reject { |line| line =~ skip }.join("\n")
+  end
+
+  # Returns the filename of a dependency given a label.
+  def dependency_filename(label)
+    case label
+    when :latex
+      `which xelatex`.chomp
+    when :convert
+      `which convert`.chomp
+    when :node
+      `which node`.chomp
+    when :phantomjs
+      `which phantomjs`.chomp
+    when :kindlegen
+      `which kindlegen`.chomp
+    when :java
+      `which java`.chomp
+    when :calibre
+      `which ebook-convert`.chomp
+    when :ghostscript
+      `which gs`.chomp
+    when :epubcheck
+      File.join(Dir.home, 'epubcheck-3.0', 'epubcheck-3.0.jar')
+    when :inkscape
+      filename = `which inkscape`.chomp
+      if filename.empty?
+        filename = '/Applications/Inkscape.app/Contents/Resources/bin/' +
+                   'inkscape'
+      end
+      filename
+    else
+      raise "Unknown label #{label}"
+    end
+  end
+
+  # Returns the language labels from the config file.
+  def language_labels
+    YAML.load_file(File.join(Softcover::Directories::CONFIG, 'lang.yml'))
+  end
+
+  def chapter_label(chapter_number)
+    if language_labels["chapter"]["order"] == "reverse"
+      "#{chapter_number} #{language_labels['chapter']['word']}"
+    else
+      "#{language_labels['chapter']['word']} #{chapter_number}"
+    end
+  end
+
+end

data/lib/softcover/version.rb

@@ -1,3 +1,3 @@
 module Softcover
-  VERSION = "0.8.9"
+  VERSION = "0.9.0"
 end

data/lib/softcover.rb

@@ -30,6 +30,7 @@ require_relative 'softcover/builders/preview'
 require_relative 'softcover/cli'
 require_relative 'softcover/commands/auth'
 require_relative 'softcover/commands/build'
+require_relative 'softcover/commands/check'
 require_relative 'softcover/commands/deployment'
 require_relative 'softcover/commands/epub_validator'
 require_relative 'softcover/commands/generator'

data/softcover.gemspec

@@ -18,23 +18,23 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'polytexnic', '~> 0.8.3'
+  gem.add_dependency 'polytexnic', '~> 0.9.1'
   gem.add_dependency 'msgpack', '~> 0.4.2'
   gem.add_dependency 'nokogiri', '~> 1.6.0'
-  gem.add_dependency 'thor'
-  gem.add_dependency 'activesupport'
-  gem.add_dependency 'rest-client'
-  gem.add_dependency 'curb'
-  gem.add_dependency 'ruby-progressbar'
-  gem.add_dependency 'maruku'
-  gem.add_dependency 'pygments.rb'
-  gem.add_dependency 'kramdown'
+  gem.add_dependency 'thor', '~> 0.18.1'
+  gem.add_dependency 'activesupport', '~> 4.0.3'
+  gem.add_dependency 'rest-client', '~> 1.6.7'
+  gem.add_dependency 'curb', '~> 0.8.5'
+  gem.add_dependency 'ruby-progressbar', '~> 1.4.1'
+  gem.add_dependency 'maruku', '~> 0.7.1'
+  gem.add_dependency 'pygments.rb', '~> 0.4.2'
+  gem.add_dependency 'kramdown', '~> 1.3.2'
 
   gem.add_dependency 'sinatra', '~> 1.4.4'
   gem.add_dependency 'thin', '~> 1.6.1'
   gem.add_dependency 'async_sinatra', '~> 1.1.0'
   gem.add_dependency 'sinatra-respond_to', '~> 0.9.0'
-  gem.add_dependency 'coffee-script'
+  gem.add_dependency 'coffee-script', '~> 2.2.0'
   gem.add_dependency 'listen', '~> 1.3.1'
   gem.add_dependency 'rb-fsevent', '~> 0.9.3'
   gem.add_dependency 'sanitize', '~> 2.0.6'

data/spec/builders/mobi_spec.rb

@@ -16,7 +16,9 @@ describe Softcover::Builders::Mobi do
 
     describe "MOBI command" do
       context "default" do
-        let(:command) { @builder.mobi_command(@builder.mobi_filename) }
+        let(:command) do
+          @builder.mobi_command(@builder.mobi_filename, calibre: true)
+        end
         it "should use Calibre's ebook-convert" do
           expect(command).to include 'ebook-convert'
         end
@@ -24,7 +26,7 @@ describe Softcover::Builders::Mobi do
 
       context "kindlegen" do
         let(:command) do
-          @builder.mobi_command(@builder.mobi_filename, kindlegen: true)
+          @builder.mobi_command(@builder.mobi_filename)
         end
         it "should use Amazon.com's kindlegen" do
           expect(command).to include 'kindlegen'
@@ -35,7 +37,7 @@ describe Softcover::Builders::Mobi do
         let(:filename) do
           @builder.mobi_filename(preview: true)
         end
-        it "should use Calibre's ebook-convert" do
+        it "should create a preview file" do
           expect(filename).to include 'book-preview'
         end
       end

data/spec/builders/pdf_spec.rb

@@ -24,6 +24,19 @@ describe Softcover::Builders::Pdf do
         end
       end
 
+      context "preamble" do
+        subject(:preamble_file) { File.join('config', 'preamble.tex') }
+        it { should exist }
+        context "content" do
+          subject { Softcover::Utils::master_latex_header(builder.manifest) }
+          it { should include File.read(preamble_file) }
+          it { should include '\usepackage{latex_styles/softcover}' }
+          it { should include "\\title{#{builder.manifest.title}}" }
+          it { should include "\\author{#{builder.manifest.author}}" }
+          it { should include "\\date{#{builder.manifest.date}}" }
+        end
+      end
+
       it "should prepend the fontsize verbatim declaration for source code" do
         fontsize = '\begin{Verbatim}[fontsize=\relsize'
         expect(File.read(Dir.glob('tmp/*.tmp.tex').first)).to include fontsize
@@ -52,6 +65,12 @@ describe Softcover::Builders::Pdf do
         expect(File.read(styles)).to match /newcommand/
       end
 
+      context "language customization file" do
+        subject { File.join(Softcover::Directories::STYLES,
+                            'language_customization.sty') }
+        it { should exist }
+      end
+
       context "after removing Book.txt" do
         before { FileUtils.rm Softcover::BookManifest::TXT_PATH }
         it "should still build the book" do

data/spec/cli_spec.rb

@@ -47,6 +47,28 @@ describe Softcover::CLI do
     end
   end
 
+  context "softcover clean" do
+    before do
+      chdir_to_fixtures
+
+      FileUtils.touch('foo.aux')
+      FileUtils.touch('foo.toc')
+      FileUtils.touch('foo.out')
+      FileUtils.touch('foo.tmp.pdf')
+      FileUtils.touch('.highlight_cache')
+    end
+
+    it "should remove unnecessary files" do
+      `softcover clean`
+      expect('foo.aux').not_to exist
+      expect('foo.aux').not_to exist
+      expect('foo.toc').not_to exist
+      expect('foo.out').not_to exist
+      expect('foo.tmp.pdf').not_to exist
+      expect('.highlight_cache').not_to exist
+    end
+  end
+
   shared_examples "book" do
     context "pdf" do
 
@@ -147,4 +169,9 @@ describe Softcover::CLI do
       end
     end
   end
+
+  describe "check" do
+    subject { `softcover check` }
+    it { should match /all dependencies satisfied/i }
+  end
 end

data/spec/commands/build_spec.rb

@@ -47,4 +47,13 @@ describe Softcover::Commands::Build do
       build.preview
     end
   end
+
+  describe "commands helper" do
+    let(:lines) { ['foo', ' #  bar', 'baz'] }
+    subject { Softcover::Commands::Build.commands(lines) }
+
+    it { should match /foo/ }
+    it { should_not match /bar/ }
+    it { should match /baz/ }
+  end
 end

data/spec/commands/check_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'stringio'
+
+module Kernel
+
+  def capture_stdout
+    out = StringIO.new
+    $stdout = out
+    yield
+    return out.string
+  ensure
+    $stdout = STDOUT
+  end
+
+end
+
+describe Softcover::Commands::Check do
+
+  subject(:check) do
+    capture_stdout do
+      Softcover::Commands::Check.check_dependencies!
+    end
+  end
+
+  it { should match /all dependencies satisfied/i }
+
+  describe "missing dependencies" do
+    before do
+      Softcover::Commands::Check.dependency_labels.each do |label|
+        Softcover::Commands::Check.stub(:present?).with(label).and_return(false)
+      end
+    end
+
+    it { should match /Checking for LaTeX.*Missing/ }
+    it { should match /Checking for PhantomJS.*Missing/ }
+    it { should match /Checking for Inkscape.*Missing/ }
+    it { should match /Checking for Calibre.*Missing/ }
+    it { should match /Checking for KindleGen.*Missing/ }
+    it { should match /Checking for Java.*Missing/ }
+    it { should match /Checking for EpubCheck.*Missing/ }
+    it { should match /Checking for GhostScript.*Missing/ }
+    it { should match /Checking for ImageMagick.*Missing/ }
+    it { should match /Checking for Node\.js.*Missing/ }
+
+    it { should match /Missing dependencies:/ }
+    it { should match /LaTeX/ }
+    it { should match /PhantomJS/ }
+    it { should match /Inkscape/ }
+    it { should match /Calibre/ }
+    it { should match /KindleGen/ }
+    it { should match /Java/ }
+    it { should match /EpubCheck/ }
+    it { should match /GhostScript/ }
+    it { should match /ImageMagick/ }
+    it { should match /Node\.js/ }
+  end
+end