RubyGems - softcover-nonstop - Versions diffs - 1.0.beta2 - Mend

softcover-nonstop 1.0.beta2

Files changed (753) hide show

data/spec/app_spec.rb ADDED Viewed

@@ -0,0 +1,91 @@
+require 'spec_helper'
+require 'rack/test'
+describe Softcover::App do
+  include Rack::Test::Methods
+  def app
+    Softcover::App
+  end
+  context "ordinary book" do
+    before(:all) do
+      generate_book
+      Softcover::Builders::Html.new.build!
+    end
+    # after(:all)  { remove_book }
+    before { chdir_to_book }
+    let(:manifest) { Softcover::BookManifest.new }
+    let(:chapter) { manifest.chapters[1] }
+    it 'redirects / to first chapter' do
+      get '/'
+      expect(last_response).to be_redirect
+      expect(last_response.location).to match chapter.slug
+    end
+    it 'GET chapter' do
+      get "/#{chapter.slug}"
+      expect(last_response).to be_ok
+      expect(last_response.body).to match Regexp.new(chapter.title)
+    end
+    it 'GET chapter.js' do
+      get "/#{chapter.slug}.js"
+      expect(last_response).to be_ok
+      expect(last_response.body).to match Regexp.new(chapter.title)
+      expect(last_response.body).not_to match Regexp.new('<html>')
+    end
+    it 'GET nonexistent chapter' do
+      get '/boom'
+      expect(last_response.status).to eq 404
+    end
+    describe 'serving files' do
+      it 'GET pygments.css' do
+        get '/stylesheets/pygments.css'
+        expect_server_response_of_type 'text/css'
+      end
+      it 'GET softcover.css' do
+        get '/stylesheets/softcover.css'
+        expect_server_response_of_type 'text/css'
+      end
+      it 'GET custom.css' do
+        get '/stylesheets/custom.css'
+        expect_server_response_of_type 'text/css'
+      end
+      it 'GET main.js' do
+        get '/main.js'
+        expect_server_response_of_type 'application/javascript'
+      end
+      it 'GET css asset' do
+        get '/assets/main.css'
+        expect_server_response_of_type 'text/css'
+      end
+      it 'GET image asset' do
+        get '/assets/icons.png'
+        expect_server_response_of_type 'image/png'
+      end
+      it 'GET image within book' do
+        get '/images/2011_michael_hartl.png'
+        expect_server_response_of_type 'image/png'
+      end
+      def expect_server_response_of_type(type)
+        expect(last_response).to be_ok
+        expect(last_response.content_type).to match type
+        expect(last_response.content_length > 0).to be_true
+      end
+    end
+  end
+end

data/spec/auth_spec.rb ADDED Viewed

@@ -0,0 +1,44 @@
+require 'spec_helper'
+describe Softcover::Commands::Auth do
+  context 'valid login' do
+    before do
+      email = 'valid@lemurheavy.com'
+      pass = 'asdf'
+      stub_valid_login email, pass, TEST_API_KEY
+      Softcover::Commands::Auth.login email, pass
+    end
+    it 'should set the api key' do
+      expect(Softcover::Config['api_key']).to eq TEST_API_KEY
+    end
+  end
+  context 'invalid login' do
+    before do
+      email = 'invalid@lemurheavy.com'
+      pass = 'asdf'
+      stub_invalid_login email, pass
+      Softcover::Commands::Auth.login email, pass
+    end
+    it 'should not set the api key' do
+      expect(Softcover::Config['api_key']).to be_nil
+    end
+  end
+  context "logging out" do
+    before do
+      Softcover::Config['api_key'] = 'asdfasdf'
+      Softcover::Commands::Auth.logout
+    end
+    it "should unset the api_key" do
+      expect(Softcover::Config['api_key']).to be_nil
+    end
+  end
+end

data/spec/book_manifest_spec.rb ADDED Viewed

@@ -0,0 +1,78 @@
+require 'spec_helper'
+describe Softcover::BookManifest do
+  context "with book generation" do
+    before(:all) { generate_book }
+    after(:all)  { remove_book }
+    subject(:manifest) { Softcover::BookManifest.new }
+    context "in valid book directory" do
+      describe "basic information" do
+        its(:title) { should eq "Title of the Book" }
+        its(:subtitle) { should eq "Change me" }
+        its(:description) { should eq "Change me." }
+        its(:author) { should eq "Author Name" }
+      end
+      describe "chapter information" do
+        subject(:chapter) { manifest.chapters[1] }
+        it { should be_a Softcover::BookManifest::Chapter }
+        its(:title) { should eq "A chapter" }
+        its(:slug) { should eq "a_chapter" }
+        its(:chapter_number) { should eq 1 }
+        its("sections.first.name") do
+          should eq 'A section'
+        end
+        describe "for second chapter" do
+          subject(:chapter) { manifest.chapters[2] }
+          its(:title) { should eq 'Another chapter' }
+          its(:slug) { should eq "another_chapter" }
+          its(:chapter_number) { should eq 2 }
+        end
+        describe "for third chapter" do
+          subject(:chapter) { manifest.chapters[3] }
+          its(:title) { should eq 'Yet \emph{another} chapter' }
+          its(:slug) { should eq "yet_another_chapter" }
+          its(:chapter_number) { should eq 3 }
+        end
+      end
+    end
+    context "in a valid book subdirectory" do
+      before { Dir.chdir 'chapters' }
+      describe "finding the manifest in a higher directory" do
+        its(:slug) { should eq "book" }
+      end
+    end
+    context "with mixed Markdown & PolyTeX files" do
+      before do
+        manifest.stub(:source_files).and_return(['foo.md', 'bar.tex'])
+      end
+      it "should have the right basenames" do
+        expect(manifest.basenames).to eq ['foo', 'bar']
+      end
+      it "should have the right extensions" do
+        expect(manifest.extensions).to eq ['.md', '.tex']
+      end
+      it "should have the right chapter objects" do
+        expect(manifest.chapter_objects[0].slug).     to eq 'foo'
+        expect(manifest.chapter_objects[0].extension).to eq '.md'
+        expect(manifest.chapter_objects[1].slug).     to eq 'bar'
+        expect(manifest.chapter_objects[1].extension).to eq '.tex'
+      end
+    end
+  end
+  context "in an invalid book directory" do
+    it "raises an error when manifest missing" do
+      expect{ subject }.to raise_error(Softcover::BookManifest::NotFound)
+    end
+  end
+end

data/spec/book_spec.rb ADDED Viewed

@@ -0,0 +1,40 @@
+require 'spec_helper'
+describe Softcover::Book do
+  context "#initialize" do
+    context "valid book directory" do
+      before(:all) { generate_book(id: 1) }
+      after(:all)  { remove_book }
+      describe "reading from book.yml" do
+        its(:filenames) { should_not include "html/test-book.html"}
+        its(:filenames) { should include "html/chapter-1_fragment.html"}
+        its(:filenames) { should_not include "html/chapter-1.html"}
+        its(:filenames) { should include "html/#{subject.slug}.html"}
+        its(:filenames) { should include "config/marketing.yml"}
+        its(:slug) { should eq "book" }
+        its(:url) { should match /\/books\/(.*?)\/redirect/ }
+        it "sets chapter attributes" do
+          expect(subject.chapter_attributes.first[:menu_heading]).
+            to match /Frontmatter/
+        end
+        it "has rendered latex in menu_heading" do
+          expect(subject.chapter_attributes.last[:menu_heading]).
+            to match /<em>/
+        end
+      end
+      describe "reading from marketing.yml" do
+        its(:prices) { should_not be_empty }
+        its(:faq) { should_not be_empty }
+        its(:testimonials) { should_not be_empty }
+        its(:marketing_content) { should be_empty }
+      end
+    end
+  end
+end

data/spec/builder_spec.rb ADDED Viewed

@@ -0,0 +1,10 @@
+require 'spec_helper'
+describe Softcover::Builder do
+  before(:all) { generate_book }
+  after(:all)  { remove_book }
+  it "should not raise an error" do
+    expect(subject).not_to be_nil
+  end
+end

data/spec/builders/epub_spec.rb ADDED Viewed

@@ -0,0 +1,219 @@
+require 'spec_helper'
+describe Softcover::Builders::Epub do
+  before(:all) do
+    generate_book
+    @file_to_be_removed = path('html/should_be_removed.html')
+    File.write(@file_to_be_removed, '')
+    silence { `softcover build:epub` }
+    @builder = Softcover::Builders::Epub.new
+    @builder.build!
+  end
+  after(:all) { remove_book }
+  subject(:builder) { @builder }
+  it "should be valid" do
+    output = `softcover epub:validate`
+    expect(output).to match(/No errors or warnings/)
+  end
+  describe "mimetype file" do
+    it "should exist in the right directory" do
+      expect(path('epub/mimetype')).to exist
+    end
+    it "should have the right contents" do
+      File.open('epub/mimetype') do |f|
+        expect(f.read).to match(/application\/epub\+zip/)
+      end
+    end
+  end
+  describe "META-INF" do
+    it "should have the right container file" do
+      expect('epub/META-INF/container.xml').to exist
+    end
+    it "should have an iBooks XML file" do
+      expect('epub/META-INF/com.apple.ibooks.display-options.xml').to exist
+    end
+    it "should have the right contents" do
+      File.open('epub/META-INF/container.xml') do |f|
+        expect(f.read).to match(/rootfile full-path="OEBPS\/content.opf"/)
+      end
+    end
+  end
+  describe "OEBPS" do
+    describe "contents" do
+      describe "opf file" do
+        let(:content_opf) { 'epub/OEBPS/content.opf' }
+        let(:doc) { Nokogiri.XML(File.read(content_opf)) }
+        subject { content_opf }
+        it { should exist }
+        it "should have the chapter right items" do
+          expect(doc.css('item#a_chapter')).not_to be_empty
+          expect(doc.css('item#another_chapter')).not_to be_empty
+        end
+        it "should have the right TOC chapter refs" do
+          toc_refs = doc.css('itemref').map { |node| node['idref'] }
+          expect(toc_refs).to eq %w[cover frontmatter a_chapter another_chapter
+                                    yet_another_chapter]
+        end
+        it "should have the right title" do
+          expect(doc.to_xml).to match(/>#{builder.manifest.title}</)
+        end
+        it "should have the right author" do
+          author = Regexp.escape(builder.manifest.author)
+          expect(doc.to_xml).to match(/>#{author}</)
+        end
+        it "should have the right copyright line" do
+          copyright = Regexp.escape("Copyright (c) #{Time.new.year}")
+          author = Regexp.escape(builder.manifest.author)
+          expect(doc.to_xml).to match(/>#{copyright} #{author}</)
+        end
+        it "should have a unique UUID" do
+          uuid = Regexp.escape(builder.manifest.uuid)
+          expect(doc.to_xml).to match(/#{uuid}</)
+        end
+        it "should have the right conver meta tag" do
+          meta = '<meta name="cover" content="img-cover-jpg"/>'
+          expect(doc.to_xml).to include meta
+        end
+      end
+      context "stylesheets directory" do
+        it "should have a Pygments CSS file" do
+          expect('epub/OEBPS/styles/pygments.css').to exist
+        end
+        it "should have a page template file" do
+          expect('epub/OEBPS/styles/page-template.xpgt').to exist
+        end
+        it "should have a PolyTeXnic CSS file" do
+          expect('epub/OEBPS/styles/softcover.css').to exist
+        end
+        it "should have an EPUB CSS file" do
+          expect('epub/OEBPS/styles/epub.css').to exist
+        end
+      end
+    end
+    describe "spine toc" do
+      subject(:toc) { 'epub/OEBPS/toc.ncx' }
+      let(:doc) { Nokogiri::XML(File.read(toc)) }
+      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]
+        source_files = doc.css('content').map { |node| node['src'] }
+        expect(source_files).to eql(filenames)
+      end
+      it "should have the right title" do
+        expect(doc.to_xml).to match(/>#{builder.manifest.title}</)
+      end
+    end
+    context "HTML generation" do
+      context "math? method" do
+        it "should return true when there's math" do
+          expect(builder.math?('\(')).to be_true
+          expect(builder.math?('\[')).to be_true
+          expect(builder.math?('\begin{equation}')).to be_true
+        end
+        it "should return false when there's no math" do
+          expect(builder.math?('foo')).to be_false
+        end
+      end
+      it "should remove the HTML files" do
+        expect(@file_to_be_removed).not_to exist
+      end
+      it "should create the HTML files" do
+        has_math = false
+        expect(path('epub/OEBPS/cover.html')).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")
+          expect(fragment).to exist
+        end
+        # Make sure at least one template file has math.
+        expect(has_math).to be_true
+      end
+      describe "cover file" do
+        subject(:cover_file) { File.read(path('epub/OEBPS/cover.html')) }
+        it "should have the right cover image" do
+          expect(cover_file).to include 'cover.jpg'
+        end
+      end
+      it "should create math PNGs" do
+        expect(path("epub/OEBPS/images/texmath")).to exist
+        expect(Dir[path("epub/OEBPS/images/texmath/*.png")]).not_to be_empty
+      end
+    end
+    it "should create the style files" do
+      expect(path('epub/OEBPS/styles/page-template.xpgt')).to exist
+      expect(path('epub/OEBPS/styles/pygments.css')).to exist
+      expect(path('epub/OEBPS/styles/softcover.css')).to exist
+    end
+    it "should scrub the CSS file of the book id" do
+      css = File.read(path('epub/OEBPS/styles/softcover.css'))
+      expect(css).not_to match /\#book/
+    end
+  end
+  it "should generate the EPUB" do
+    expect(path('ebooks/book.epub')).to exist
+    expect(path('epub/book.epub')).not_to exist
+    expect(path('epub/book.zip')).not_to exist
+  end
+end
+describe Softcover::Builders::Epub do
+  context "for a Markdown book" do
+    before(:all) do
+      generate_book(markdown: true)
+      @builder = Softcover::Builders::Epub.new
+      @builder.build!
+      chdir_to_book
+    end
+    after(:all) { remove_book }
+    subject(:builder) { @builder }
+    it "should be valid" do
+      expect(`softcover epub:validate`).to match(/No errors or warnings/)
+    end
+    it "should not raise an error" do
+      expect { subject }.not_to raise_error
+    end
+    it "should remove the generated LaTeX files" do
+      expect(Dir.glob(path('chapters/*.tex'))).to be_empty
+    end
+  end
+end

data/spec/builders/html_spec.rb ADDED Viewed

@@ -0,0 +1,170 @@
+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 include '<!DOCTYPE html>' }
+        it { should include 'pygments.css' }
+        it { should include 'MathJax' }
+        it { should_not include 'functionNumber'}
+        context "HTML document" do
+          subject(:doc) { Nokogiri::HTML(output) }
+          context "frontmatter" do
+            subject(:frontmatter) { doc.at_css('#frontmatter') }
+            it { should_not be_nil }
+            it "should link the preface to the frontmatter page" do
+              link = '<a href="#preface"'
+              expect(frontmatter.to_xhtml).to match /#{link}/
+            end
+          end
+          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(:doc) { Nokogiri::HTML(File.open(filename)) }
+          it "should include the title page" do
+            expect(doc.at_css('div#title_page')).not_to be_nil
+          end
+          it "should include the table of contents" do
+            expect(doc.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 include 'MathJax.Hub.Config' }
+        it { should include 'TeX-AMS-MML_SVG' }
+        it { should include 'formatNumber: function (n)' }
+        it { should include 'A chapter' }
+      end
+    end
+  end
+  describe "when generating from Markdown source" do
+    before(:all) do
+      generate_book(markdown: true)
+    end
+    after(:all)  { remove_book }
+    describe "#build!" do
+      subject(:builder) { Softcover::Builders::Html.new }
+      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" }
+      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 include generated LaTeX files" do
+        expect(Dir.glob(path('generated_polytex/*.tex'))).not_to be_empty
+      end
+      it "should write cache files" do
+        expect(Dir.glob(path('tmp/*.cache'))).not_to be_empty
+      end
+      describe "master LaTeX file" do
+        let(:master_file) { builder.master_filename(builder.manifest) }
+        subject { File.read(master_file) }
+        it { should include "\\title{#{builder.manifest.title}}" }
+        it { should include "\\subtitle{#{builder.manifest.subtitle}}" }
+        it { should include "\\author{#{builder.manifest.author}}" }
+        it { should include '\date{}' }
+        it { should include '\begin{document}' }
+        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
+      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_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'
+        end
+      end
+    end
+  end
+end