mint 0.2.9 → 0.5.0

data/spec/plugins/epub_spec.rb

@@ -0,0 +1,242 @@
+require 'spec_helper'
+
+# Mimics the requirement to actually require plugins for
+# them to be registered/work.
+require 'mint/plugins/epub'
+
+module Mint
+  describe Document do
+    describe "#chapters" do
+      it "splits a document's final text into chapters and maps onto IDs" do
+        # TODO: Clean up these long lines
+        chapters = Document.new('content.md').chapters
+        chapters[0].should =~ /This is just a test.*Paragraph number two/m 
+        chapters[1].should =~ /Third sentence.*Fourth sentence/m
+      end
+    end
+  end
+
+  describe EPub do
+    describe "#after_publish" do
+      let(:document) do
+        Document.new 'content.md', :destination => 'directory'
+      end
+
+      before do
+        document.publish!
+        document_length = File.read('directory/content.html').length
+        EPub.after_publish(document)
+
+        # We're going to consider a document successfully split
+        # if its two chapters are less than half of it's length,
+        # not including the DOCTYPE/HTML chrome that we introduce 
+        # into each split document (~150 characters)
+        @target_length = document_length / 2 + 200
+      end
+
+      after do
+        FileUtils.rm_r 'directory.epub'
+      end
+
+      it "does nothing if no destination is specified" do
+        invalid_document = Document.new 'content.md'
+        lambda do
+          EPub.after_publish(invalid_document)
+        end.should raise_error(InvalidDocumentError)
+      end
+
+      it "replaces the monolithic published file with a packaged ePub file" do
+        File.exist?('directory/content.html').should be_false
+        File.exist?('directory.epub').should be_true
+      end
+
+      it "produces a valid ePub file" do
+        pending "need to integrate epubcheck script if found on system"
+      end
+
+      it "ensures all files were compressed using PKZIP" do
+        File.read('directory.epub')[0..1].should == 'PK'
+      end
+
+      context "when the ePub file is unzipped" do
+        before do
+          # Copy instead of moving to make test cleanup more
+          # predictable in nested contexts.
+          FileUtils.cp 'directory.epub', 'directory.zip'
+
+          # I will later replace this with my own EPub.unzip! function
+          # but don't want to get too distracted now.
+          `unzip -o directory.zip -d directory`
+
+          # EPub.unzip! 'directory.zip'
+        end
+
+        after do
+          FileUtils.rm_r 'directory.zip'
+          FileUtils.rm_r 'directory'
+        end
+
+        it "contains a META-INF directory" do
+          File.exist?('directory/META-INF/container.xml').should be_true
+        end
+
+        it "contains an OPS directory" do
+          File.exist?('directory/OPS').should be_true
+        end
+
+        it "contains a mimetype file" do
+          File.exist?('directory/mimetype').should be_true
+          File.read('directory/mimetype').chomp.should == 'application/epub+zip'
+        end
+
+        it "contains a container file that points to the OPF file" do
+          File.exist?('directory/META-INF/container.xml').should be_true
+        end
+
+        it "contains an OPF manifest with book metadata" do
+          File.exist?('directory/OPS/content.opf').should be_true
+        end
+
+        it "contains an NCX file with book spine and TOC" do
+          File.exist?('directory/OPS/toc.ncx').should be_true
+        end
+
+        it "splits the document into chapters" do
+          chapter1 = File.read 'directory/OPS/chapter-1.html'
+          chapter2 = File.read 'directory/OPS/chapter-2.html'
+
+          chapter1.length.should < @target_length
+          chapter2.length.should < @target_length
+        end
+
+        it "creates a stylesheet for all pages"
+      end
+    end
+    
+    describe "#split_on" do
+      it "returns a copy of the HTML text it is passed, grouping elements" do
+        Document.new('content.md').publish!
+
+        html_text = File.read 'content.html'
+        html_document = Nokogiri::HTML.parse(html_text)
+
+        chapters = EPub.split_on(html_document, 'h2')
+
+        expected_document = Nokogiri::HTML.parse <<-HTML
+          <div id='container'>
+            <div>
+              <h2>Header</h2>
+              <p>This is just a test.</p>
+              <p>Paragraph number two.</p>
+            </div>
+
+            <div>
+              <h2>Header 2</h2>
+              <p>Third sentence.</p>
+              <p>Fourth sentence.</p>
+            </div>
+          </div>
+        HTML
+
+        expected_chapters = expected_document.search 'div div'
+
+        cleanse(chapters).should == cleanse(expected_chapters)
+      end
+    end
+
+    describe "#zip!" do
+      before do
+        FileUtils.mkdir 'directory'
+
+        files = {
+          first: 'First content',
+          second: 'Second content',
+          third: 'Third content'
+        }
+
+        files.each do |name, content|
+          File.open "directory/#{name}", 'w' do |f|
+            f << content
+          end
+        end
+      end
+
+      after do
+        Dir['directory*'].each {|dir| FileUtils.rm_r dir }
+        # FileUtils.rm 'directory.zip'
+        # FileUtils.rm_r 'directory'
+      end
+
+      # This is not a great test of Zip functionality,
+      # but I don't really care to spend time on this right now.
+      # Most of the details of the Zip file creation will be tested
+      # above.
+      it "compresses the named file into a directory" do
+        EPub.zip! 'directory'
+        File.exist?('directory.zip').should be_true
+      end
+      
+      it "accepts an extension parameter" do
+        EPub.zip! 'directory', :extension => 'epub'
+        File.exist?('directory.epub').should be_true
+      end
+
+      it "creates a mimetype entry if specified" do
+        pending "a more robust Zip testing strategy"
+        EPub.zip! 'directory', :mimetype => 'text/epub'
+      end
+    end
+
+    describe "#create!" do
+      before do
+        EPub.should_receive(:create_from_template!).and_return
+      end
+
+      it "accepts a block for configuration options" do
+        lambda do
+          EPub.create! do |file|
+            file.type = 'container'
+          end
+        end.should_not raise_error
+      end
+
+      it "render a container file" do
+        EPub.should_receive(:container_defaults).once.and_return({})
+        EPub.create! do |file|
+          file.type = 'container'
+        end
+      end
+
+      it "render a content file" do
+        EPub.should_receive(:content_defaults).once.and_return({})
+        EPub.create! do |file|
+          file.type = 'content'
+        end
+      end
+
+      it "render a table of contents file" do
+        EPub.should_receive(:toc_defaults).once.and_return({})
+        EPub.create! do |file|
+          file.type = 'toc'
+        end
+      end
+
+      it "defaults to a type of 'container'" do
+        EPub.should_receive(:container_defaults).once.and_return({})
+        EPub.create!
+      end
+    end
+
+    describe "#create_chapters!" do
+      it "calls #create_chapter! for each chapter" do
+        EPub.should_receive(:create_chapter!).once.ordered
+        EPub.should_receive(:create_chapter!).once.ordered
+        EPub.create_chapters! ['text1', 'text2']
+      end
+    end
+
+    def cleanse(dom)
+      dom.to_s.squeeze.chomp.gsub(/^\s/, '')
+    end
+  end
+end

data/spec/resource_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+module Mint
+  describe Resource do
+    before do 
+      @tmp_dir = Dir.getwd 
+      @alternative_root = "#{@tmp_dir}/alternative-root"
+      @full_content_file = "#{@tmp_dir}/#{@content_file}"
+      @full_alt_content_file = "#{@alternative_root}/#{@content_file}"
+    end
+
+    shared_examples_for "all resources" do
+      subject { resource }
+
+      its(:root_directory_path) { should be_path(resource.root_directory) }
+      its(:source_file_path) { should be_path(resource.source_file) }
+      its(:source_directory_path) { should be_path(resource.source_directory) }
+      its(:destination_file_path) { should be_path(resource.destination_file) }
+      its(:destination_directory_path) do
+        should be_path(resource.destination_directory)
+      end
+    end
+
+    context "when created with a relative path and no root" do
+      let(:resource) { Resource.new @content_file }
+      subject { resource }
+
+      its(:name) { should == 'content.html' }
+      its(:root) { should == @tmp_dir }
+      its(:source) { should == @content_file }
+      its(:source_file) { should == @full_content_file }
+      its(:source_directory) { should == @tmp_dir }
+      its(:destination) { should be_nil }
+      its(:destination_file) { should == "#{@tmp_dir}/content.html" }
+      its(:destination_directory) { should == @tmp_dir }
+
+      it_should_behave_like "all resources"
+    end
+
+    # TODO: This is wrong, need to rework this -- probably build slightly
+    # more comprehensive system in spec_helper for these edge cases,
+    # then build up compound variables in before block for this particular 
+    # spec (which has more edge cases than most)
+    context "when created with a relative path and absolute root" do
+      let(:resource) { Resource.new @content_file, :root => @alternative_root }
+      subject { resource }
+
+      its(:name) { should == 'content.html' }
+      its(:root) { should == @alternative_root }
+      its(:source) { should == @content_file }
+      its(:source_file) { should == @full_alt_content_file }
+      its(:source_directory) { should == @alternative_root }
+      its(:destination) { should be_nil }
+      its(:destination_file) { should == "#{@alternative_root}/content.html" }
+      its(:destination_directory) { should == @alternative_root }
+
+      it_should_behave_like "all resources"
+    end
+
+    context "when created with an absolute path, no root" do
+      before do
+        # This is a use case we will only ever test here, so
+        # I'm not going to include it in the spec_helper
+        FileUtils.mkdir_p @alternative_root
+        File.open(@full_alt_content_file, 'w') do |f|
+          f << @content
+        end
+      end
+
+      let(:resource) { Resource.new @full_alt_content_file }
+      subject { resource }
+      
+      its(:name) { should == 'content.html' }
+      its(:root) { should == @alternative_root }
+      its(:source) { should == @full_alt_content_file }
+      its(:source_file) { should == @full_alt_content_file}
+      its(:source_directory) { should == @alternative_root }
+      its(:destination) { should be_nil }
+      its(:destination_file) { should == "#{@alternative_root}/content.html" }
+      its(:destination_directory) { should == @alternative_root }
+
+      it_should_behave_like "all resources"
+    end
+
+    # The root should *not* override a source file absolute path but
+    # *should* affect the destination file path.
+    # I should also test this when neither the source nor the root
+    # are in Dir.getwd, which is the default root.
+    context "when created with an absolute path and root" do
+      let(:resource) { Resource.new @full_content_file,
+                       :root => @alternative_root }
+
+      subject { resource }
+
+      its(:name) { should == 'content.html' }
+      its(:root) { should == @alternative_root }
+      its(:source) { should == @full_content_file }
+      its(:source_file) { should == @full_content_file }
+      its(:source_directory) { should == @tmp_dir }
+      its(:destination) { should be_nil }
+      its(:destination_file) { should == "#{@alternative_root}/content.html" }
+      its(:destination_directory) { should == @alternative_root }
+
+      it_should_behave_like "all resources"
+    end
+
+    context "when it's created with a block" do
+      let(:resource) do
+        Resource.new @content_file do |resource|
+          resource.root = @alternative_root
+          resource.destination = 'destination'
+        end
+      end
+
+      subject { resource }
+      
+      its(:name) { should == 'content.html' }
+      its(:root) { should == @alternative_root }
+      its(:source) { should == @content_file }
+      its(:source_file) { should == @full_alt_content_file }
+      its(:source_directory) { should == @alternative_root }
+      its(:destination) { should == 'destination' }
+
+      its(:destination_file) do
+        should == "#{@alternative_root}/destination/content.html"
+      end
+
+      its(:destination_directory) do
+        should == "#{@alternative_root}/destination"
+      end
+
+      it_should_behave_like "all resources"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,12 @@
 require 'pathname'
 require 'mint'
 
+def delete_class(klass)
+  klass = nil
+  GC.start
+  sleep 1
+end
+
 RSpec::Matchers.define :be_in_directory do |name|
   match {|resource| resource.source_directory =~ /#{name}/ }
 end
@@ -41,10 +47,22 @@ RSpec.configure do |config|
     @dynamic_style_file = 'dynamic.sass'
 
     @content = <<-HERE
+---
+metadata: true
+
 Header
 ------
 
 This is just a test.
+
+Paragraph number two.
+
+Header 2
+--------
+
+Third sentence.
+
+Fourth sentence.
     HERE
 
     @layout = <<-HERE

data/spec/style_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+module Mint
+  describe Style do
+    before { @tmp_dir = Dir.getwd }
+
+    context "when it's created from a static file" do
+      let(:style) { Style.new @static_style_file }
+      subject { style }
+
+      its(:destination) { should be_nil }
+      its(:destination_file) { should == "#{@tmp_dir}/static.css" }
+
+      it { should_not be_rendered }
+      it "'renders' itself verbatim" do
+        style.render.should == File.read(@static_style_file)
+      end
+    end
+
+    context "when it's created from a dynamic file" do
+      let(:style) { Style.new @dynamic_style_file }
+      subject { style }
+
+      its(:destination) { should be_nil }
+      its(:destination_file) { should == "#{@tmp_dir}/dynamic.css" }
+
+      it { should be_rendered }
+      it "renders itself from a templating language to Html" do
+        style.render.gsub("\n", " ").should == 
+          File.read(@static_style_file).gsub("\n", " ")
+      end
+    end
+
+    context "when it's created with a specified destination" do
+      let(:style) { Style.new @static_style_file,
+                    :destination => 'destination' }
+      subject { style }
+
+      its(:destination) { should == 'destination' }
+      its(:destination_file) do
+        should == "#{@tmp_dir}/destination/static.css"
+      end
+    end
+
+    # TODO: Create local-scope templates directory that I can test this with,
+    # and use it to beef up other specs (like document_spec and mint_spec)
+    # context "when it's created from a static template file" do
+    #  let(:style) { Style.new(Mint.lookup_template(:static_test, :style)) }
+    #  it "#destination" do
+    #    style.destination.should be_nil
+    #  end
+
+    #  it "#destination_file" do
+    #    style.destination_file.should == 
+    #      Mint.path_for_scope(:local) + '/templates/static_test/style.css'
+    #  end
+    # end
+
+    context "when it's created from a dynamic template file" do
+      let(:style) { Style.new(Mint.lookup_template(:default, :style)) }
+      subject { style }
+
+      its(:destination) { should == 'css' }
+      its(:destination_file) do
+        should == "#{Mint.root}/templates/default/css/style.css"
+      end
+    end
+  end
+end