mint 0.2.9 → 0.5.0

data/lib/mint/plugins/epub.rb

@@ -0,0 +1,292 @@
+require 'nokogiri'
+require 'hashie'
+require 'zip/zip'
+require 'zip/zipfilesystem'
+require 'active_support/core_ext/hash/deep_merge'
+require 'active_support/core_ext/hash/keys'
+
+# Note: This code is not as clean as I want it to be. It is an example
+# plugin with which I'm developing the Mint plugin system. Code cleanup
+# to follow.
+
+module Mint
+  META_DIR = 'META-INF'
+  CONTENT_DIR = 'OPS'
+
+  # Add chapters to document -- this is probably not a sustainable pattern
+  # for all plugins, but it's useful here.
+  class Document
+    def chapters
+      html_document = Nokogiri::HTML::Document.parse render
+      EPub.split_on(html_document, 'h2').map &:to_s
+    end
+  end
+
+  class InvalidDocumentError < StandardError; end
+
+  class EPub < Plugin
+    def self.after_publish(document)
+      # This check doesn't currently follow simlinks
+      if document.destination_directory == Dir.getwd
+        raise InvalidDocumentError 
+      end
+
+      Dir.chdir document.destination_directory do
+        metadata = standardize document.metadata
+        chapters = document.chapters
+        locals = { chapters: chapters }.merge metadata
+
+        prepare_directory!
+        create_chapters! chapters, :locals => metadata
+
+        create! do |container|
+          container.type = 'container'
+          container.locals = locals
+        end
+
+        create! do |content|
+          content.type = 'content'
+          content.locals = locals
+        end
+
+        create! do |toc|
+          toc.type = 'toc'
+          toc.locals = locals
+        end
+
+        create! do |title|
+          title.type = 'title'
+          title.locals = locals
+        end
+      end
+
+      FileUtils.rm document.destination_file
+
+      self.zip! document.destination_directory, 
+                :mimetype => 'application/epub+zip',
+                :extension => 'epub'
+
+      FileUtils.rm_r document.destination_directory
+    end
+    
+    protected
+    
+    def self.split_on(document, tag_name, opts={})
+      container_node = opts[:container] || '#container'
+
+      new_document = document.dup.tap do |node|
+        container = node.at container_node
+
+        unless container
+          raise InvalidDocumentError, 
+                "Document doesn't contain expected container: #{container}",
+                caller
+        end
+        
+        div = nil
+        container.element_children.each do |elem|
+          if elem.name == tag_name
+            div = node.create_element 'div'
+            # div.add_class 'chapter'
+            elem.replace div
+          end
+          div << elem if div
+        end
+      end
+
+      new_document.search('div div')
+    end
+
+    # This is an opinionated version of ZIP, specifically
+    # tailored to ePub creation
+    def self.zip!(directory, opts={})
+      default_opts = {
+        extension: 'zip',
+        mimetype: nil
+      }
+
+      opts = default_opts.merge opts
+      extension = opts[:extension]
+      parent_directory = File.expand_path "#{directory}/.."
+      child_directory = File.basename directory
+
+      Zip::ZipOutputStream.open "#{directory}.#{extension}" do |zos|
+        if opts[:mimetype]
+          zos.put_next_entry('mimetype', nil, nil, Zip::ZipEntry::STORED)
+          zos << opts[:mimetype]
+        end
+
+        Dir.chdir parent_directory do
+          Dir["#{child_directory}/**/*"].each do |file|
+            if File.file? file
+              relative_path = Helpers.normalize_path(file, child_directory)
+              zos.put_next_entry(relative_path, 
+                                 nil, 
+                                 nil, 
+                                 Zip::ZipEntry::DEFLATED)
+              zos << File.read(file)
+            end
+          end
+        end
+      end
+    end
+
+    def self.create!
+      options = Hashie::Mash.new
+      yield options if block_given?
+      options = options.to_hash.symbolize_keys
+
+      type = options[:type] || 'container'
+      default_options = 
+        case type.to_sym
+        when :container
+          container_defaults
+        when :content
+          content_defaults
+        when :toc
+          toc_defaults
+        when :title
+          title_defaults
+        else
+          {}
+        end
+
+      create_from_template! default_options.deep_merge(options)
+    end
+
+    def self.create_chapters!(chapters, opts={})
+      opts = chapter_defaults.deep_merge(opts)
+      template_file = EPub.template_directory + '/layout.haml'
+      renderer = Tilt.new template_file, :ugly => false
+      chapters.map do |chapter|
+        renderer.render Object.new, opts[:locals].merge(:content => chapter)
+      end.each_with_index do |text, id| 
+        create_chapter!(id + 1, text)
+      end
+    end
+    
+    private
+
+    def self.create_from_template!(opts={})
+      template_file = EPub.template_directory + "/#{opts[:from]}"
+      renderer = Tilt.new template_file, :ugly => false
+      content = renderer.render Object.new, opts[:locals]
+
+      File.open(opts[:to], 'w') do |f|
+        f << content
+      end
+    end
+
+    def self.prepare_directory!
+      [META_DIR, CONTENT_DIR].each do |dir|
+        FileUtils.mkdir dir unless File.exist?(dir)
+      end
+    end
+
+    def self.locals_lookup_table
+      {
+        author:     [:creators, :array],
+        authors:    [:creators, :array],
+        editor:     [:contributors, :array],
+        editors:    [:contributors, :array],
+        barcode:    [:uuid, :string],
+        upc:        [:uuid, :string],
+        copyright:  [:rights, :string]
+      }
+    end
+
+    def self.standardize(metadata)
+      sanitized_metadata = 
+        Helpers.symbolize_keys(metadata, :downcase => true)
+      standardized_metadata = 
+        Helpers.standardize(sanitized_metadata, 
+                            :table => locals_lookup_table)
+    end
+
+    def self.chapter_filename(id)
+      "OPS/chapter-#{id}.html"
+    end
+
+    # def self.metadata_from(document)
+      # document.metadata
+    # end
+
+    # def self.chapters_from(document)
+      # html_text = File.read document.destination_file
+      # html_document = Nokogiri::HTML::Document.parse html_text
+      # chapter_contents = self.split_on(html_document, 'h2')
+      # chapter_ids = (1..chapters.length).map {|x| "chapter-#{x}" }
+      # chapters = Hash[chapter_ids.zip chapter_contents]
+    # end
+
+    def self.create_chapter!(id, text)
+      File.open chapter_filename(id), 'w' do |file|
+        file << text
+      end
+    end
+
+    def self.chapter_defaults
+      {
+        locals: {
+          title: 'Untitled'
+        }
+      }
+    end
+
+    def self.container_defaults
+      defaults = {
+        from: 'container.haml',
+        to: "#{META_DIR}/container.xml",
+        locals: {
+          opf_file: 'OPS/content.opf'
+        }
+      }
+    end
+
+    def self.content_defaults
+      defaults = {
+        from: 'content.haml',
+        to: "#{CONTENT_DIR}/content.opf",
+        locals: {
+          title: 'Untitled',
+          language: 'English',
+          short_title: '',
+          uuid: 'Unspecified',
+          description: 'No description',
+          date: Date.today,
+          creators: ['Anonymous'],
+          contributors: [],
+          publisher: 'Self published',
+          genre: 'Non-fiction',
+          rights: 'All Rights Reserved',
+          ncx_file: 'toc.ncx',
+          style_file: 'style.css',
+          title_file: 'title.html',
+        }
+      }
+    end
+
+    def self.toc_defaults
+      defaults = {
+        from: 'toc.haml',
+        to: "#{CONTENT_DIR}/toc.ncx",
+        locals: {
+          uuid: 'Unspecified',
+          title: 'Untitled',
+          title_file: 'title.html',
+        }
+      }
+    end
+
+    def self.title_defaults
+      defaults = {
+        from: 'title.haml',
+        to: "#{CONTENT_DIR}/title.html",
+        locals: {
+          title: 'Untitled',
+          creators: ['Anonymous']
+        }
+      }
+    end
+  end
+end

data/lib/mint/version.rb

@@ -1,3 +1,3 @@
 module Mint
-  VERSION = '0.2.9'
+  VERSION = '0.5.0'
 end

data/plugins/templates/epub/container.haml

@@ -0,0 +1,5 @@
+!!! XML
+%container(version='1.0' xmlns='urn:oasis:names:tc:opendocument:xmlns:container')
+  %rootfiles
+    %rootfile(full-path=opf_file 
+              media-type='application/oebps-package+xml')

data/plugins/templates/epub/content.haml

@@ -0,0 +1,36 @@
+!!! XML
+%package(version='2.0' xmlns='http://www.idpf.org/2007/opf' unique-identifier=uuid)
+  %metadata{ 'xmlns:dc' => 'http://purl.org/dc/elements/1.1/',
+             'xmlns:dcterms' => 'http://purl.org/dc/terms/',
+             'xmlns:opf' => 'http://www.idpf.org/2007/opf',
+             'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance' }
+  
+    %dc:title= title
+    %dc:language{ 'xsi:type' => 'dcterms:RFC3066' }= language
+    %dc:identifier{ :id => uuid }= short_title
+    %dc:description= description
+    %dc:date{ 'xsi:type' => 'dcterms:W3CDTF' }= date
+    
+    - creators.each do |creator|
+      %dc:creator{ 'opf:file-as' => creator, 'opf:role' => 'aut' }
+    - contributors.each do |contributor|
+      %dc:contributor{ 'opf:file-as' => contributor,
+        'opf:role' => 'edt' }
+    
+    %dc:publisher= publisher
+    %dc:type= genre
+    %dc:rights= rights
+  
+  %manifest
+    %item(id='ncx' href=ncx_file media-type='application/x-dtbncx+xml')/
+    %item(id='style' href=style_file media-type='text/css')/
+    %item(id='title' href=title_file media-type='application/xhtml+xml')/
+    - chapters.each_with_index do |content, id|
+      - idx = id + 1
+      %item(id="chapter-#{idx}" href="chapter-#{idx}.html" media-type='application/xhtml+xml')/
+  
+  %spine(toc='ncx')
+    %itemref(idref='title')/
+    - chapters.each_with_index do |content, id|
+      - idx = id + 1
+      %itemref(idref="chapter-#{idx}")/

data/plugins/templates/epub/layout.haml

@@ -0,0 +1,6 @@
+!!! 1.1
+%html(xmlns='http://www.w3.org/1999/xhtml')
+  %head
+    %title= title
+  %body
+    #container= content

data/plugins/templates/epub/title.haml

@@ -0,0 +1,11 @@
+!!! 1.1
+%html(xmlns='http://www.w3.org/1999/xhtml')
+  %head
+    %meta(http-equiv='Content-Type' 
+          content='text/html; charset=utf-8')
+    %title= title
+    %link(href='style.css' type='text/css' rel='stylesheet')
+  
+  %body
+    %h1= title
+    %h2= Mint::Helpers.listify creators

data/plugins/templates/epub/toc.haml

@@ -0,0 +1,26 @@
+!!! XML
+<!DOCTYPE ncx PUBLIC '-//NISO//DTD ncx 2005-1//EN' 'http://www.daisy.org/z3986/2005/ncx-2005-1.dtd'>
+
+%ncx(xmlns='http://www.daisy.org/z3986/2005/ncx/' version='2005-1')
+  %head
+    %meta(name='dtb:uid' content=uuid)
+    %meta(name='dtb:depth' content='1')
+    %meta(name='dtb:totalPageCount' content='0')
+    %meta(name='dtb:maxPageNumber' content='0')
+  
+  %docTitle
+    %text= title
+
+  %navMap
+    %navPoint(id='navpoint-1' playOrder=1)
+      %navLabel
+        %text= title
+      %content(src=title_file)
+    
+    - chapters.each_with_index do |content, id|
+      - idx = Integer(id) + 1
+      - order = idx + 1
+      %navPoint(id="navpoint-#{order}" playOrder=order)
+        %navLabel
+          %text= "Chapter #{idx}"
+        %content(src="chapter-#{idx}.html")

data/spec/commandline_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+module Mint
+  describe CommandLine do
+    describe "#options" do
+      it "provides default options" do
+        CommandLine.options['template']['long'].should == 'template'
+        CommandLine.options['layout']['long'].should == 'layout'
+        CommandLine.options['style']['long'].should == 'style'
+      end
+    end
+
+    describe "#parser" do
+      it "provides a default option parser" do
+        fake_argv = ['--layout', 'pro']
+
+        options = {}
+        CommandLine.parser {|k, p| options[k] = p }.parse!(fake_argv)
+        options[:layout].should == 'pro'
+      end
+
+      it "provides an option parser based on a formatted hash" do
+        fake_argv = ['--novel', 'novel']
+        formatted_options = {
+          # Option keys must be formatted as strings, so we
+          # use hash-bang syntax
+          novel: {
+            'short' => 'n',
+            'long' => 'novel',
+            'parameter' => true,
+            'description' => ''
+          }
+        }
+
+        options = {}
+
+        CommandLine.parser(formatted_options) do |k, p| 
+          options[k] = p
+        end.parse!(fake_argv)
+
+        options[:novel].should == 'novel'
+      end
+    end
+
+    describe "#configuration" do
+      context "when no config syntax file is loaded" do
+        it "returns nil" do
+          CommandLine.configuration(nil).should be_nil
+        end
+      end
+
+      context "when a config syntax file is loaded but there is no .config file" do
+        it "returns a default set of options" do
+          expected_map = {
+            layout: 'default',
+            style: 'default',
+            destination: nil,
+            style_destination: nil
+          }
+
+          CommandLine.configuration.should == expected_map 
+        end
+      end
+
+      context "when a config syntax file is loaded and there is a .config file" do
+        before do
+          FileUtils.mkdir_p '.mint/config'
+          File.open('.mint/config/config.yaml', 'w') do |file|
+            file << 'layout: pro'
+          end
+        end
+
+        after do
+          File.delete '.mint/config/config.yaml'
+        end
+
+        it "merges all specified options with precedence according to scope" do
+          CommandLine.configuration[:layout].should == 'pro'
+        end
+      end
+    end
+
+    it "displays the sum of all configuration files with other options added"
+    it "prints a help message"
+    it "installs a template file to the correct scope"
+    it "pulls up a named template file in the user's editor"
+    it "writes options to the correct file for the scope specified"
+    it "sets and stores a scoped configuration variable"
+    it "publishes a set of files"
+  end
+end