softcover 0.9.5 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1aa02aca75e2ee2079f25f083b1698393b24329f
-  data.tar.gz: 176640a59c9930125f6ea00849757b73e5a595a6
+  metadata.gz: d4dfd43d360ce2e5fb73f9ef560fddcb1e52fe0d
+  data.tar.gz: 9cc10d4ad3b1e58ec96037e9e23dd048cc76721a
 SHA512:
-  metadata.gz: e4c9ecc94a6f73cbbc6edd868685c5ca32eb4ca6c3c62c9d6c552301c9f390e833b1b508f6439aab209c6cb85d43cd6bf9e3298cf238f00fd5f227a0bfdfc2f7
-  data.tar.gz: 049bb3787159465ad794862f31a9a7cdbb57e9eb692cdcd8a1abe9ac6b3b398a52abca4cdadd52cb5f64c9c7754f82e4e2b08b5003c27e4ac56218b24052f978
+  metadata.gz: 53275a23f95789f065d67e84805bce54e0122663dfb1de8939261daffa638044a6aea2e06c1d586f4b782e432adfbac94c8fe1f96c9902cd171cce5fdb1c3fa0
+  data.tar.gz: 5d7cf763ed7fac74e4847c33b30dd0aeb68c22938f355fb4058907b47911d3fccb5fc49968eb1f685e7fabcdb2cd58bca131ea5b75f1ab888930f0d91be3d2c5

data/lib/softcover/book_manifest.rb

@@ -3,6 +3,8 @@ require 'ostruct'
 class Softcover::BookManifest < OpenStruct
   include Softcover::Utils
 
+  attr_accessor :book_file
+
   class Softcover::MarketingManifest < Softcover::BookManifest
 
     YAML_PATH = File.join(Softcover::Directories::CONFIG, 'marketing.yml')
@@ -74,12 +76,14 @@ class Softcover::BookManifest < OpenStruct
   class Section < OpenStruct
   end
 
-  TXT_PATH  = 'Book.txt'
+  TXT_PATH     = 'Book.txt'
+  PREVIEW_PATH = 'Preview.txt'
   YAML_PATH = File.join(Softcover::Directories::CONFIG, 'book.yml')
 
   def initialize(options = {})
     @source = options[:source] || :polytex
     @origin = options[:origin]
+    @book_file = options[:preview] ? PREVIEW_PATH : TXT_PATH
 
     ensure_template_files
 
@@ -148,7 +152,8 @@ class Softcover::BookManifest < OpenStruct
              path('latex_styles/custom_pdf.sty'),
              path('config/preamble.tex'),
              path('config/lang.yml'),
-             path('epub/OEBPS/styles/custom_epub.css')
+             path('epub/OEBPS/styles/custom_epub.css'),
+             path('Preview.txt')
            ]
     files.each do |file|
       unless File.exist?(file)
@@ -309,7 +314,7 @@ class Softcover::BookManifest < OpenStruct
   def source_files
     self.class.find_book_root!
     md_tex = /.*(?:\.md|\.tex)/
-    book_txt_lines.select { |path| path =~ md_tex }.map(&:strip)
+    book_file_lines(self).select { |path| path =~ md_tex }.map(&:strip)
   end
 
   def basenames
@@ -327,7 +332,7 @@ class Softcover::BookManifest < OpenStruct
   end
 
   def read_from_md
-    { chapters: chapter_objects, filename: TXT_PATH }
+    { chapters: chapter_objects, filename: book_file }
   end
 
 

data/lib/softcover/builders/epub.rb

@@ -7,8 +7,8 @@ module Softcover
         @preview = options[:preview]
         Softcover::Builders::Html.new.build!
         if manifest.markdown?
-          self.manifest = Softcover::BookManifest.new(source: :polytex,
-                                                      origin: :markdown)
+          opts = options.merge({ source: :polytex, origin: :markdown })
+          self.manifest = Softcover::BookManifest.new(opts)
         end
         remove_html
         create_directories
@@ -61,9 +61,9 @@ module Softcover
         File.write(path('epub/OEBPS/content.opf'), content_opf)
       end
 
-      # Returns the chapters to write (accounting for previews).
+      # Returns the chapters to write.
       def chapters
-        preview? ? manifest.preview_chapters : manifest.chapters
+        manifest.chapters
       end
 
       # Writes the HTML for the EPUB.
@@ -367,9 +367,7 @@ module Softcover
       def toc_ncx
         title = manifest.title
         chapter_nav = []
-        offset = preview? ? manifest.preview_chapter_range.first : 0
-        chapters.each_with_index do |chapter, i|
-          n = i + offset
+        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}"/>)

data/lib/softcover/builders/pdf.rb

@@ -11,8 +11,8 @@ module Softcover
           # then update the manifest to reduce PDF generation
           # to a previously solved problem.
           Softcover::Builders::Html.new.build!
-          self.manifest = Softcover::BookManifest.new(source: :polytex,
-                                                      origin: :markdown)
+          opts = options.merge({ source: :polytex, origin: :markdown})
+          self.manifest = Softcover::BookManifest.new(opts)
         end
 
         write_master_latex_file(manifest)
@@ -60,7 +60,7 @@ module Softcover
         elsif options[:'find-overfull']
           silence_stream(STDERR) { execute(cmd) }
         else
-          options[:preview] ? system(cmd) : execute(cmd)
+          execute(cmd)
         end
       end
 
@@ -126,7 +126,8 @@ module Softcover
         # While we're at it, we move it to the standard ebooks/ directory.
         def rename_pdf(basename, options={})
           tmp_pdf = basename + '.tmp.pdf'
-          pdf     = basename + '.pdf'
+          name    = options[:preview] ? basename + '-preview' : basename
+          pdf     = name + '.pdf'
           mkdir('ebooks')
           # Remove the intermediate tmp files unless only running once.
           rm_tmp = keep_tmp_files?(options) ? "" : "&& rm -f *.tmp.*"

data/lib/softcover/builders/preview.rb

@@ -6,27 +6,8 @@ module Softcover
         # Recall that MOBI generation makes an EPUB as a side-effect.
         Softcover::Builders::Mobi.new.build!(preview: true)
         Softcover::Builders::Pdf.new.build!(preview: true)
-        extract_pdf_pages
       end
 
-      private
-
-        # Extracts pages from the PDF using GhostScript.
-        # The page range is set by the `pdf_preview_page_range` parameter
-        # in book.yml so that authors can override the default range.
-        def extract_pdf_pages
-          input  = File.join('ebooks', manifest.filename + '.pdf')
-          output = input.sub('.pdf', '-preview.pdf')
-          range  = manifest.pdf_preview_page_range.split('..').map(&:to_i)
-          cmd  = %(yes | #{ghostscript} -dBATCH -sOutputFile="#{output}")
-          cmd += %( -dFirstPage=#{range.first} -dLastPage=#{range.last})
-          cmd += %( -sDEVICE=pdfwrite "#{input}" > /dev/null)
-          execute cmd
-        end
-
-        def ghostscript
-          @ghostscript ||= executable(dependency_filename(:ghostscript))
-        end
     end
   end
 end

data/lib/softcover/commands/check.rb

@@ -32,7 +32,6 @@ module Softcover
 
       def dependencies
         [[:latex,       'LaTeX'],
-         [:ghostscript, 'GhostScript'],
          [:convert,     'ImageMagick'],
          [:node,        'Node.js'],
          [:phantomjs,   'PhantomJS'],
@@ -74,8 +73,6 @@ module Softcover
         when :java
           url = 'http://www.java.com/en/download/help/index_installing.xml'
           "Java (#{url})"
-        when :ghostscript
-          "GhostScript (should come with LaTeX)"
         when :epubcheck
           url  = 'https://github.com/IDPF/epubcheck/releases/'
           url += 'download/v3.0/epubcheck-3.0.zip'

data/lib/softcover/template/Preview.txt

@@ -0,0 +1,7 @@
+cover
+frontmatter:
+maketitle
+tableofcontents
+preface.md
+mainmatter:
+a_chapter.md

data/lib/softcover/template/config/book.yml.erb

@@ -7,5 +7,3 @@ description: Change me.
 author: Author Name
 copyright: <%= Time.new.year %>
 uuid: <%= SecureRandom.uuid %>
-pdf_preview_page_range: 1..30
-epub_mobi_preview_chapter_range: 0..1

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

@@ -128,8 +128,7 @@
 
 % Additional commands
 \newcommand{\heading}[1]{\textbf{#1}}
-\newcommand{\kodesize}{\smaller[0.75]}
-\newcommand{\kode}[1]{\textcolor{darkgreen}{\textbf{\texttt{\kodesize #1}}}}
+\newcommand{\kode}[1]{\textcolor{darkgreen}{\textbf{\texttt{#1}}}}
 
 % Subtitle command
 \usepackage{titling}

data/lib/softcover/utils.rb

@@ -64,7 +64,7 @@ module Softcover::Utils
   # We skip this step if Book.txt doesn't exist, as that means the user
   # is writing raw LaTeX.
   def write_master_latex_file(manifest)
-    if File.exist?(Softcover::BookManifest::TXT_PATH)
+    if File.exist?(manifest.book_file)
       File.write(master_filename(manifest), master_content(manifest))
     end
   end
@@ -74,15 +74,20 @@ module Softcover::Utils
     "#{manifest.filename}.tex"
   end
 
-  # Returns the lines of Book.txt as an array, removing any commented-out lines.
-  def book_txt_lines
+  # Returns the lines of book file as an array, removing commented-out lines.
+  def book_file_lines(manifest)
+    non_comment_lines(raw_lines(manifest))
+  end
+
+  # Returns only non-comment lines.
+  def non_comment_lines(lines)
     comment = /^\s*#.*$/
-    raw_lines.reject { |line| line.match(comment) }
+    lines.reject { |line| line.match(comment) }
   end
 
   # Returns all the lines in Book.txt.
-  def raw_lines
-    File.readlines(Softcover::BookManifest::TXT_PATH)
+  def raw_lines(manifest)
+    File.readlines(manifest.book_file)
   end
 
   # Returns the content for the master LaTeX file.
@@ -91,7 +96,7 @@ module Softcover::Utils
     source_file = /(.*)(?:\.md|\.tex)\s*$/
 
     tex_file = [master_latex_header(manifest)]
-    book_txt_lines.each do |line|
+    book_file_lines(manifest).each do |line|
       if line.match(source_file)
         tex_file << "\\include{#{manifest.polytex_dir}/#{$1}}"
       elsif line.match(front_or_mainmatter)  # frontmatter or mainmatter
@@ -245,8 +250,6 @@ module Softcover::Utils
       `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

data/lib/softcover/version.rb

@@ -1,3 +1,3 @@
 module Softcover
-  VERSION = "0.9.5"
+  VERSION = "0.9.6"
 end

data/spec/builders/html_spec.rb

@@ -155,7 +155,7 @@ describe Softcover::Builders::Html do
       describe "commented-out lines of Book.txt" do
         let(:lines) { ['foo.md', '# bar.md'] }
         let(:content) { builder.master_content(builder.manifest) }
-        before { builder.stub(:book_txt_lines).and_return(lines) }
+        before { builder.stub(:book_file_lines).and_return(lines) }
         it "should be ignored" do
           expect(content).to     include 'generated_polytex/foo'
           expect(content).not_to include 'generated_polytex/bar'

data/spec/builders/preview_spec.rb

@@ -24,17 +24,6 @@ describe Softcover::Builders::Preview do
       it "should build an EPUB" do
         expect('ebooks/book-preview.mobi').to exist
       end
-
-      it "should include the right chapters" do
-        @builder.manifest.preview_chapters.each do |ch|
-          expect(File.join('epub', 'OEBPS', ch.fragment_name)).to exist
-        end
-        nonpreview_chapters = @builder.manifest.chapters -
-                              @builder.manifest.preview_chapters
-        nonpreview_chapters.each do |ch|
-          expect(File.join('epub', 'OEBPS', ch.fragment_name)).not_to exist
-        end
-      end
     end
   end
 end

data/spec/commands/check_spec.rb

@@ -38,7 +38,6 @@ describe Softcover::Commands::Check do
     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/ }
 
@@ -50,7 +49,6 @@ describe Softcover::Commands::Check do
     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

data/spec/utils_spec.rb

@@ -1,11 +1,9 @@
 require 'spec_helper'
 
 describe Softcover::Utils do
-  context "book_txt_lines" do
-    before do
-      Softcover::Utils.stub(:raw_lines).and_return(['foo.md', '# bar.tex'])
-    end
-    subject { Softcover::Utils.book_txt_lines }
+  context "book_file_lines" do
+    let(:raw_lines) { ['foo.md', '# bar.tex'] }
+    subject { Softcover::Utils.non_comment_lines(raw_lines) }
     it { should     include 'foo.md' }
     it { should_not include 'bar.tex' }
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: softcover
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.6
 platform: ruby
 authors:
 - Michael Hartl
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-25 00:00:00.000000000 Z
+date: 2014-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: polytexnic
@@ -430,6 +430,7 @@ files:
 - lib/softcover/template/.softcover-build
 - lib/softcover/template/.softcover-deploy
 - lib/softcover/template/Book.txt
+- lib/softcover/template/Preview.txt
 - lib/softcover/template/README.md
 - lib/softcover/template/chapters/a_chapter.md
 - lib/softcover/template/chapters/a_chapter.tex