softcover 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 810f0a9d1295ebe59b85307d284783b81d9221e5
-  data.tar.gz: 575e05eac1784232405f765fac5b01a532d87286
+  metadata.gz: df5fc92cddff6bd934a2ac83265b7577f09d6fcd
+  data.tar.gz: e894e67dd71e366249e23083a92f0c81d76e1680
 SHA512:
-  metadata.gz: d39595bdaa8c8fc5b71d1681fe2d63a8dcc0e6cd88a049593e4f26c57cbbfa4b2e8dd615262973ea3e7aa9cadd977cb58e58185d512bbfeb5d81d1a5711e13cb
-  data.tar.gz: eaf552cae27c6439fa18ca13ed8cde16f47d6a26fb810d1c41e0669d4e45045cb8ee300312c955f1fb38076786fbf7f82c0c663f81057e621b21f8ea13b5b3dd
+  metadata.gz: 6d4766cf6a4cb4dc2381a276a6736294297a39b4aaff78df690e6ee726e1e36c9a29b2b4de6aa6072caffe06a6c29ecbce888229624b6497af31a1730044cd5c
+  data.tar.gz: b15fcf53ea90b1813065b0b80885d3095e855dc27f4d1f4ed6ba02796ce9745c04dbeedec9fdd811ce5f2b8e4ab2f18cfbdd5dcdeb4d59b02d62321b09b4145b

data/lib/softcover/book_manifest.rb

@@ -1,6 +1,8 @@
 require 'ostruct'
 
 class Softcover::BookManifest < OpenStruct
+  include Softcover::Utils
+
   class NotFound < StandardError
     def message
       "Invalid book directory, no manifest file found!"
@@ -44,6 +46,7 @@ class Softcover::BookManifest < OpenStruct
 
   def initialize(options = {})
     @source = options[:source] || :polytex
+    @origin = options[:origin]
     yaml_attrs = read_from_yml
     attrs = case
             when polytex?  then yaml_attrs
@@ -76,7 +79,7 @@ class Softcover::BookManifest < OpenStruct
       chapter_includes(base_contents).each_with_index do |name, i|
         slug = File.basename(name, '.*')
         title_regex = /^\s*\\chapter{(.*)}/
-        content = File.read(File.join('chapters', slug + '.tex'))
+        content = File.read(File.join(polytex_dir, slug + '.tex'))
         title = content[title_regex, 1]
         j = 0
         sections = content.scan(/^\s*\\section{(.*)}/).flatten.map do |name|
@@ -91,9 +94,19 @@ class Softcover::BookManifest < OpenStruct
     verify_paths! if options[:verify_paths]
   end
 
+  # Returns the directory where the LaTeX files are located.
+  # We put them in the a separate directory when using them as an intermediate
+  # format when working with Markdown books. Otherwise, we use the chapters
+  # directory, which is the default location when writing LaTeX/PolyTeX books.
+  def polytex_dir
+    dir = (markdown? || @origin == :markdown) ? 'generated_polytex' : 'chapters'
+    mkdir dir
+    dir
+  end
+
   # Returns an array of the chapters to include.
   def chapter_includes(string)
-    chapter_regex = /^\s*\\include\{chapters\/(.*?)\}/
+    chapter_regex = /^\s*\\include\{#{polytex_dir}\/(.*?)\}/
     string.scan(chapter_regex).flatten
   end
 
@@ -136,12 +149,14 @@ class Softcover::BookManifest < OpenStruct
     @source == :polytex
   end
 
-  # Returns an iterator the chapter file paths.
+  # Returns an iterator for the chapter file paths.
   def chapter_file_paths
     pdf_chapter_names.map do |name|
       file_path = case
-      when markdown? then File.join("chapters", "#{name}.md")
-      when polytex?  then File.join("chapters", "#{name}.tex")
+      when markdown? || @origin == :markdown
+        File.join("chapters", "#{name}.md")
+      when polytex?
+        File.join("chapters", "#{name}.tex")
       end
 
       yield file_path if block_given?
@@ -150,7 +165,7 @@ class Softcover::BookManifest < OpenStruct
     end
   end
 
-  # Return chapters for the PDF.
+  # Returns chapters for the PDF.
   # The frontmatter pseudo-chapter exists for the sake of HTML/EPUB/MOBI, so
   # it's not returned as part of the chapters.
   def pdf_chapter_names
@@ -159,6 +174,11 @@ class Softcover::BookManifest < OpenStruct
     frontmatter? ? frontmatter + chaps : chaps
   end
 
+  # Returns the full chapter filenames for the PDF.
+  def pdf_chapter_filenames
+    pdf_chapter_names.map { |name| File.join(polytex_dir, "#{name}.tex") }
+  end
+
   def find_chapter_by_slug(slug)
     chapters.find { |chapter| chapter.slug == slug }
   end

data/lib/softcover/builder.rb

@@ -6,7 +6,7 @@ module Softcover
 
     def initialize
       @manifest = Softcover::BookManifest.new(verify_paths: true,
-                                               source: source)
+                                              source: source)
       @built_files = []
       write_polytexnic_commands_file
     end
@@ -18,21 +18,6 @@ module Softcover
       self
     end
 
-    # Returns true if we should remove the generated PolyTeX.
-    # This is true of Markdown books, but we can't just use `markdown?` because
-    # we're re-using the PolyTeX production pipeline.
-    def remove_polytex?
-      @remove_tex
-    end
-
-    # Removes the generated PolyTeX.
-    # The 'removal' actually just involves moving it to an ignored storage
-    # directory. This gives users the ability to inspect it if desired.
-    def remove_polytex!
-      mkdir 'generated_polytex'
-      FileUtils.mv(Dir.glob(path('chapters/*.tex')), 'generated_polytex')
-    end
-
     def clean!; end
 
     private

data/lib/softcover/builders/epub.rb

@@ -7,8 +7,8 @@ module Softcover
         @preview = options[:preview]
         Softcover::Builders::Html.new.build!(preserve_tex: true)
         if manifest.markdown?
-          self.manifest = Softcover::BookManifest.new(source: :polytex)
-          @remove_tex = true
+          self.manifest = Softcover::BookManifest.new(source: :polytex,
+                                                      origin: :markdown)
         end
         remove_html
         create_directories
@@ -22,7 +22,6 @@ module Softcover
         create_style_files
         make_epub(options)
         move_epub
-        remove_polytex! if remove_polytex?
       end
 
       # Returns true if generating a book preview.

data/lib/softcover/builders/html.rb

@@ -20,7 +20,7 @@ module Softcover
 
         if manifest.markdown?
           unless options[:'find-overfull']
-            FileUtils.rm(Dir.glob(path('chapters/*.tex')))
+            FileUtils.rm(Dir.glob(path("#{manifest.polytex_dir}/*.tex")))
           end
           manifest.chapters.each do |chapter|
             write_latex_files(chapter, options)
@@ -28,8 +28,8 @@ module Softcover
           rewrite_master_latex_file
           # Reset the manifest to use PolyTeX.
           self.manifest = Softcover::BookManifest.new(source: :polytex,
-                                                      verify_paths: true)
-          @remove_tex = true unless options[:preserve_tex]
+                                                      verify_paths: true,
+                                                      origin: :markdown)
         end
 
         if manifest.polytex?
@@ -49,8 +49,6 @@ module Softcover
           printer.print(STDOUT, {})
         end
 
-        remove_polytex! if remove_polytex?
-
         true
       end
 
@@ -60,7 +58,7 @@ module Softcover
         cc = Softcover.custom_styles
         md = Polytexnic::Pipeline.new(File.read(path), source: :md,
                                                        custom_commands: cc)
-        filename = path("chapters/#{chapter.slug}.tex")
+        filename = path("#{manifest.polytex_dir}/#{chapter.slug}.tex")
         File.write(filename, md.polytex)
       end
 
@@ -71,7 +69,7 @@ module Softcover
         tex_file = []
         lines.each do |line|
           if line =~ /(.*)\.md\s*$/
-            tex_file << "\\include{chapters/#{$1}}"
+            tex_file << "\\include{#{manifest.polytex_dir}/#{$1}}"
           elsif line =~ /(.*):\s*$/  # frontmatter or mainmatter
             tex_file << "\\#{$1}"
           elsif line.strip == 'cover'

data/lib/softcover/builders/pdf.rb

@@ -8,13 +8,12 @@ module Softcover
           # Build the HTML to produce PolyTeX as a side-effect,
           # then update the manifest to reduce PDF generation
           # to a previously solved problem.
-          Softcover::Builders::Html.new.build!(options.merge(preserve_tex:
-                                                              true))
-          self.manifest = Softcover::BookManifest.new(source: :polytex)
-          @remove_tex = true unless options[:preserve_tex]
+          Softcover::Builders::Html.new.build!
+          self.manifest = Softcover::BookManifest.new(source: :polytex,
+                                                      origin: :markdown)
         end
         # Build the PolyTeX filename so it accepts both 'foo' and 'foo.tex'.
-        basename = File.basename(@manifest.filename, '.tex')
+        basename = File.basename(manifest.filename, '.tex')
         book_filename = basename + '.tex'
 
         # In debug mode, execute `xelatex` and exit.
@@ -36,27 +35,25 @@ module Softcover
           return
         end
 
-        polytex_filenames = @manifest.chapter_file_paths << book_filename
-        polytex_filenames.delete(path('chapters/frontmatter.tex'))
+        polytex_filenames = manifest.pdf_chapter_filenames << book_filename
         polytex_filenames.each do |filename|
           puts filename unless options[:quiet] || options[:silent]
           polytex = File.open(filename) { |f| f.read }
           latex   = Polytexnic::Pipeline.new(polytex).to_latex
           if filename == book_filename
             latex.gsub!(/\\include{(.*?)}/) do
-              "\\include{#{Softcover::Utils.tmpify($1)}.tmp}"
+              "\\include{#{Softcover::Utils.tmpify(manifest, $1)}.tmp}"
             end
           end
-          File.open(Softcover::Utils.tmpify(filename), 'w') do |f|
+          File.open(Softcover::Utils.tmpify(manifest, filename), 'w') do |f|
             f.write(latex)
           end
         end
         write_pygments_file(:latex)
         copy_polytexnic_sty
 
-        remove_polytex! if remove_polytex?
-
-        build_pdf = "#{xelatex} #{Softcover::Utils.tmpify(book_filename)}"
+        tmp_filename = Softcover::Utils.tmpify(manifest, book_filename)
+        build_pdf = "#{xelatex} #{tmp_filename}"
         # Run the command twice (to guarantee up-to-date cross-references)
         # unless explicitly overriden.
         # Renaming the PDF in the command is necessary because `execute`

data/lib/softcover/commands/server.rb

@@ -12,7 +12,7 @@ module Softcover::Commands::Server
     server_pid = Process.pid
     directories = ['.', 'chapters']
     @listener = Listen.to(*directories)
-    file_pattern = markdown? ? '\.md' : '\.tex'
+    file_pattern = markdown? ? '\.md|\.txt' : '\.tex'
     @listener.filter(/(#{file_pattern}|custom\.sty)$/)
 
     @listener.change do |modified|

data/lib/softcover/server/app.rb

@@ -13,7 +13,8 @@ class Softcover::App < Sinatra::Base
   end
 
   before do
-    @manifest = Softcover::BookManifest.new
+    origin = Dir.glob('chapters/*.md').empty? ? :polytex : :markdown
+    @manifest = Softcover::BookManifest.new(foo: "bar", origin: origin)
   end
 
   get '/' do

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

@@ -14,7 +14,7 @@ This is a section. You can refer to it using the \LaTeX\ cross-reference syntax,
 
 This is a subsection.
 
-You can typeset code samples and other verbatim text using four space of indentation:
+You can typeset code samples and other verbatim text using four spaces of indentation:
 
     def hello
       puts "hello, world"

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

@@ -20,7 +20,6 @@ Softcover comes with full support for syntax-highlighted source code:
 \begin{code}
 def hello
   puts "hello, world!"
-  "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod t"
 end
 \end{code}
 \noindent Softcover can highlight any language supported by \href{http://pygments.org/languages/}{Pygments} (which means most of them).

data/lib/softcover/utils.rb

@@ -51,9 +51,10 @@ module Softcover::Utils
 
   # Returns the tmp version of a filename.
   # E.g., tmpify('foo.tex') => 'foo.tmp.tex'
-  def tmpify(filename)
+  def tmpify(manifest, filename)
     sep = File::SEPARATOR
-    filename.sub('chapters' + sep, 'tmp' + sep).sub('.tex', '.tmp.tex')
+    filename.sub(manifest.polytex_dir + sep, 'tmp' + sep).
+             sub('.tex', '.tmp.tex')
   end
 
   # Writes a Pygments style file.

data/lib/softcover/version.rb

@@ -1,3 +1,3 @@
 module Softcover
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

data/spec/builders/html_spec.rb

@@ -98,15 +98,17 @@ describe Softcover::Builders::Html do
   describe "when generating from Markdown source" do
     before(:all) do
       generate_book(markdown: true)
-      @file_to_be_removed = path('chapters/should_be_removed.tex')
-      File.write(@file_to_be_removed, '')
     end
     after(:all)  { remove_book }
 
     describe "#build!" do
       subject(:builder) { Softcover::Builders::Html.new }
 
-      before { builder.build! }
+      before do
+        @file_to_be_removed = path("#{builder.manifest.polytex_dir}/remove.tex")
+        File.write(@file_to_be_removed, '')
+        builder.build!
+      end
 
       its(:built_files) { should include "html/a_chapter.html" }
       its(:built_files) { should include "html/a_chapter_fragment.html" }
@@ -117,18 +119,17 @@ describe Softcover::Builders::Html do
         expect(@file_to_be_removed).not_to exist
       end
 
-      it "should remove the generated LaTeX files" do
-        expect(Dir.glob(path('chapters/*.tex'))).to be_empty
+      it "should include generated LaTeX files" do
         expect(Dir.glob(path('generated_polytex/*.tex'))).not_to be_empty
       end
 
       describe "master LaTeX file" do
         let(:master_file) { Dir['*.tex'].reject { |f| f =~ /\.tmp/}.first }
         subject { File.read(master_file) }
-        it { should include '\include{chapters/preface}' }
-        it { should include '\include{chapters/a_chapter}' }
-        it { should include '\include{chapters/another_chapter}' }
-        it { should include '\include{chapters/yet_another_chapter}' }
+        it { should include '\include{generated_polytex/preface}' }
+        it { should include '\include{generated_polytex/a_chapter}' }
+        it { should include '\include{generated_polytex/another_chapter}' }
+        it { should include '\include{generated_polytex/yet_another_chapter}' }
         it { should include '\end{document}' }
       end
     end

data/spec/builders/pdf_spec.rb

@@ -15,17 +15,18 @@ describe Softcover::Builders::Pdf do
     describe "#build!" do
 
       it "should create a tmp LaTeX file" do
-        expect(Softcover::Utils.tmpify('book.tex')).to exist
+        expect(Softcover::Utils.tmpify(builder.manifest, 'book.tex')).to exist
       end
 
       it "should create tmp files for all chapters" do
         builder.manifest.chapter_file_paths.each do |filename|
-          expect(Softcover::Utils.tmpify(filename)).to exist
+          expect(Softcover::Utils.tmpify(builder.manifest, filename)).to exist
         end
       end
 
       it "should replace the main file's \\includes with tmp files" do
-        contents = File.read(Softcover::Utils.tmpify('book.tex'))
+        contents = File.read(Softcover::Utils.tmpify(builder.manifest,
+                                                     'book.tex'))
         builder.manifest.pdf_chapter_names.each do |name|
           expect(contents).to match("\\include{tmp/#{name}.tmp}")
         end
@@ -58,22 +59,19 @@ describe Softcover::Builders::Pdf do
     describe "#build!" do
 
       it "should create a tmp LaTeX file" do
-        expect(Softcover::Utils.tmpify('book.tex')).to exist
+        expect(Softcover::Utils.tmpify(builder.manifest, 'book.tex')).to exist
       end
 
       describe "LaTeX file" do
-        subject(:content) { File.read(Softcover::Utils.tmpify('book.tex')) }
+        subject(:content) do
+          File.read(Softcover::Utils.tmpify(builder.manifest, 'book.tex'))
+        end
         it { should_not be_empty }
         it { should include '\includepdf{images/cover.pdf}' }
         it { should include '\maketitle' }
         it { should include '\tableofcontents' }
         it { should include '\include{tmp/a_chapter.tmp}' }
       end
-
-
-      it "should remove the generated LaTeX files" do
-        expect(Dir.glob(path('chapters/*.tex'))).to be_empty
-      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: softcover
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Michael Hartl
@@ -362,6 +362,7 @@ files:
 - .pull_requests/1384207054
 - .pull_requests/1384304643
 - .pull_requests/1384447036
+- .pull_requests/1384468478
 - .rspec
 - .ruby-gemset
 - .ruby-version
@@ -423,7 +424,6 @@ files:
 - lib/softcover/template/epub/OEBPS/styles/epub.css
 - lib/softcover/template/epub/OEBPS/styles/page-template.xpgt
 - lib/softcover/template/framed.sty
-- lib/softcover/template/generated_polytex/.gitkeep
 - lib/softcover/template/gitignore
 - lib/softcover/template/html/.gitkeep
 - lib/softcover/template/html/MathJax/MathJax.js