RubyGems - softcover - Versions diffs - 0.0.1 → 0.5.0 - Mend

softcover 0.0.1 → 0.5.0

Files changed (716) hide show

data/spec/builders/html_spec.rb ADDED Viewed

@@ -0,0 +1,136 @@
+require 'spec_helper'
+describe Softcover::Builders::Html do
+  describe "when generating from PolyTeX source" do
+    before(:all) { generate_book }
+    after(:all)  { remove_book }
+    describe "#build!" do
+      subject(:builder) { Softcover::Builders::Html.new }
+      let(:file_to_be_removed) { path('html/should_be_removed.html') }
+      before do
+        # Create an empty file that should be removed automatically.
+        File.write(file_to_be_removed, '')
+        builder.build!
+      end
+      its(:built_files) { should include File.join('html', 'book.html') }
+      it "should remove the HTML file without a corresponding LaTeX file" do
+        expect(file_to_be_removed).not_to exist
+      end
+      describe "HTML output" do
+        let(:output) { File.read("html/book.html") }
+        subject { output }
+        it { should match('<!DOCTYPE html>') }
+        it { should match('pygments.css') }
+        context "HTML document" do
+          subject(:doc) { Nokogiri::HTML(output) }
+          context "first chapter" do
+            subject(:chapter) { doc.at_css('#cha-a_chapter') }
+            it { should_not be_nil }
+            it "should have a chapter class" do
+              expect(chapter['class']).to eq 'chapter'
+            end
+          end
+          context "second chapter" do
+            subject(:chapter) { doc.at_css('#cha-another_chapter') }
+            it { should_not be_nil }
+            it "should have a chapter class" do
+              expect(chapter['class']).to eq 'chapter'
+            end
+          end
+        end
+      end
+      describe "Pygments stylesheet" do
+        let(:stylesheet) { 'html/stylesheets/pygments.css' }
+        subject { stylesheet }
+        it { should exist }
+        it "should have a .highlight class" do
+          expect(File.read(stylesheet)).to match('.highlight')
+        end
+      end
+      describe "HTML fragments output" do
+        let(:output) { File.read('html/a_chapter_fragment.html') }
+        subject { output }
+        it { should match('A chapter') }
+      end
+      describe "frontmatter output" do
+        let(:filename) { 'html/frontmatter_fragment.html' }
+        it "should create a frontmatter file" do
+          expect(filename).to exist
+        end
+        describe "contents" do
+          subject(:html) { Nokogiri::HTML(File.open(filename)) }
+          it "should include the title page" do
+            expect(html.at_css('div#title_page')).not_to be_nil
+          end
+          it "should include the table of contents" do
+            expect(html.at_css('div#table_of_contents')).not_to be_nil
+          end
+        end
+      end
+      describe "HTML MathJax output" do
+        let(:output) { File.read(path('html/a_chapter.html')) }
+        subject { output }
+        it { should match 'MathJax.Hub.Config' }
+        it { should match 'TeX-AMS-MML_SVG' }
+        it { should match 'A chapter' }
+      end
+    end
+  end
+  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! }
+      its(:built_files) { should include "html/a_chapter.html" }
+      its(:built_files) { should include "html/a_chapter_fragment.html" }
+      its(:built_files) { should include "html/another_chapter.html" }
+      its(:built_files) { should include "html/another_chapter_fragment.html" }
+      it "should remove an unneeded LaTeX file" 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
+        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 '\end{document}' }
+      end
+    end
+  end
+end

data/spec/builders/mobi_spec.rb ADDED Viewed

@@ -0,0 +1,47 @@
+require 'spec_helper'
+describe Softcover::Builders::Mobi do
+  context "for a PolyTeX book" do
+    before(:all) do
+      generate_book
+      @builder = Softcover::Builders::Mobi.new
+      @built = @builder.build!
+      chdir_to_book
+    end
+    after(:all) { remove_book }
+    describe "#build!" do
+      it "should generate the EPUB" do
+        expect('ebooks/book.epub').to exist
+      end
+      # Because of the way kindlegen uses tempfiles, testing for the
+      # actual generation of the MOBI causes an error, so we just
+      # check the command.
+      describe "MOBI generation" do
+        subject(:built) { @built }
+        it { should match /kindlegen/ }
+        it { should match /ebooks\/book\.epub/ }
+      end
+    end
+  end
+  context "for a Markdown book" do
+    before(:all) do
+      generate_book(markdown: true)
+      @builder = Softcover::Builders::Mobi.new
+      @built = @builder.build!
+      chdir_to_book
+    end
+    after(:all) { remove_book }
+    describe "#build!" do
+      describe "MOBI generation" do
+        subject(:built) { @built }
+        it { should match /kindlegen/ }
+        it { should match /ebooks\/book\.epub/ }
+        it { should_not match /Book.txt.epub/ }
+      end
+    end
+  end
+end

data/spec/builders/pdf_spec.rb ADDED Viewed

@@ -0,0 +1,80 @@
+require 'spec_helper'
+describe Softcover::Builders::Pdf do
+  context "for a PolyTeX book" do
+    before(:all) do
+      generate_book
+      @builder = Softcover::Builders::Pdf.new
+      @builder.build!
+      chdir_to_book
+    end
+    after(:all) { remove_book }
+    subject(:builder) { Softcover::Builders::Pdf.new }
+    describe "#build!" do
+      it "should create a tmp LaTeX file" do
+        expect(Softcover::Utils.tmpify('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
+        end
+      end
+      it "should replace the main file's \\includes with tmp files" do
+        contents = File.read(Softcover::Utils.tmpify('book.tex'))
+        builder.manifest.pdf_chapter_names.each do |name|
+          expect(contents).to match("\\include{tmp/#{name}.tmp}")
+        end
+      end
+      it "should build a PDF" do
+        expect('ebooks/book.pdf').to exist
+      end
+      it "should create a Pygments style file" do
+        expect('pygments.sty').to exist
+      end
+      it "should write the correct PolyTeXnic commands file" do
+        expect(File.read('polytexnic_commands.sty')).to match /newcommand/
+      end
+    end
+  end
+  context "for a Markdown book" do
+    before(:all) do
+      generate_book(markdown: true)
+      @builder = Softcover::Builders::Pdf.new
+      @builder.build!
+      chdir_to_book
+    end
+    after(:all) { remove_book }
+    subject(:builder) { Softcover::Builders::Pdf.new }
+    describe "#build!" do
+      it "should create a tmp LaTeX file" do
+        expect(Softcover::Utils.tmpify('book.tex')).to exist
+      end
+      describe "LaTeX file" do
+        subject(:content) { File.read(Softcover::Utils.tmpify('book.tex')) }
+        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

data/spec/builders/preview_spec.rb ADDED Viewed

@@ -0,0 +1,60 @@
+require 'spec_helper'
+describe Softcover::Builders::Preview do
+  context "for a PolyTeX book" do
+    before(:all) do
+      generate_book
+      @builder = Softcover::Builders::Preview.new
+      @builder.build!
+      chdir_to_book
+    end
+    after(:all) { remove_book }
+    describe "#build!" do
+      it "should build a PDF" do
+        expect('ebooks/book-preview.pdf').to exist
+      end
+      context "EPUB & MOBI books" do
+        it "should build an EPUB" do
+          expect('ebooks/book-preview.epub').to exist
+        end
+        #
+        # We don't test for MOBI because kindlegen doesn't work in tests.
+        #
+        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
+  context "for a Markdown book" do
+    before(:all) do
+      generate_book(markdown: true)
+      @builder = Softcover::Builders::Preview.new
+      @builder.build!
+      chdir_to_book
+    end
+    after(:all) { remove_book }
+    describe "#build!" do
+      it "should build a PDF" do
+        expect('ebooks/book-preview.pdf').to exist
+      end
+    end
+  end
+end

data/spec/cli_spec.rb ADDED Viewed

@@ -0,0 +1,130 @@
+require 'spec_helper'
+describe Softcover::CLI do
+  context 'help output' do
+    subject { capture(:stdout) { Softcover::CLI.start commands } }
+    let(:commands) { ['help'] }
+    %w{new login logout publish build server}.each do |cmd|
+      it { should match /#{cmd}/ }
+    end
+    Softcover::FORMATS.each do |format|
+      it { should match /build:#{format}/ }
+      it { should match /Build #{format.upcase}/ }
+    end
+    it { should match /build:all/ }
+    it { should match /build:preview/ }
+    it { should match /epub:validate/ }
+    it { should match /epub:check/ }
+  end
+  context "version number" do
+    subject { `softcover -v` }
+    it { should eq "Softcover #{Softcover::VERSION}\n" }
+  end
+  context "softcover build:pdf options" do
+    subject { `softcover help build:pdf` }
+    it { should include '-d, [--debug]' }
+    it { should include '-o, [--once]' }
+    it { should include 'f, [--find-overfull]' }
+  end
+  context "softcover new options" do
+    subject { `softcover help new` }
+    it { should include '-m, [--markdown]' }
+    it { should include '-s, [--simple]' }
+  end
+  context "softcover new" do
+    before(:all) { chdir_to_fixtures }
+    after(:all) { remove_book }
+    it "should not raise error" do
+      result = `softcover new book 2>&1`
+      expect($?.exitstatus).to eq 0
+    end
+  end
+  shared_examples "book" do
+    context "pdf" do
+      context "without options" do
+        before { silence { `softcover build:pdf` } }
+        it "should generate the PDF" do
+          expect(path('ebooks/book.pdf')).to exist
+        end
+      end
+      context "with the debug option" do
+        before { silence { `softcover build:pdf -d` } }
+        it "should generate the debug PDF" do
+          expect(path('book.pdf')).to exist
+        end
+      end
+      context "with the --once option" do
+        it "should build without error" do
+          expect { silence { `softcover build:pdf --once` } }.not_to raise_error
+        end
+      end
+      context "with the --find-overfull option" do
+        it "should not find any overfull lines" do
+          expect(`softcover build:pdf --find-overfull`.strip).to be_empty
+        end
+      end
+    end
+    context "html" do
+      context "without options" do
+        before { silence { `softcover build:html` } }
+        it "should generate the html" do
+          expect(path('html/book.html')).to exist
+        end
+      end
+    end
+    context "epub & mobi" do
+      context "without options" do
+        before { silence { `softcover build:mobi` } }
+        it "should generate the EPUB & MOBI" do
+          expect(path('ebooks/book.epub')).to exist
+          expect(path('ebooks/book.mobi')).to exist
+        end
+      end
+    end
+  end
+  describe "PolyTeX books" do
+    before(:all) do
+      remove_book
+      chdir_to_fixtures
+      silence { `softcover new book` }
+      chdir_to_book
+    end
+    after(:all) { remove_book }
+    it_should_behave_like "book"
+  end
+  describe "Markdown books" do
+    before(:all) do
+      remove_book
+      chdir_to_fixtures
+      silence { `softcover new book -m` }
+      chdir_to_book
+    end
+    after(:all) { remove_book }
+    it_should_behave_like "book"
+  end
+end