rpub 0.1.0

data/lib/rpub/compressor.rb

@@ -0,0 +1,46 @@
+module Rpub
+  # Wrapper around a `ZipOutputStream` object provided by the `rubyzip` gem.
+  # This writes string contents straight into a zip file, without first saving
+  # them to disk.
+  class Compressor
+
+    # @return [ZipOutputStream]
+    attr_reader :zip
+
+    # Convenience method for opening a stream, allowing content to be written
+    # and finally closing the stream again.
+    def self.open(filename)
+      compressor = new(filename)
+      yield compressor
+      compressor.close
+    end
+
+    # @param [String] filename of the archive to write to disk
+    def initialize(filename)
+      @zip = Zip::ZipOutputStream.new(filename)
+    end
+
+    # Close the zip stream and write the file to disk.
+    def close
+      zip.close
+    end
+
+    # Store a file in the archive without any compression.
+    #
+    # @param [String] filename under the which the data should be stored
+    # @param [#to_s] content to be compressed
+    def store_file(filename, content)
+      zip.put_next_entry filename, nil, nil, Zip::ZipEntry::STORED, Zlib::NO_COMPRESSION
+      zip.write content.to_s
+    end
+
+    # Store a file with maximum compression in the archive.
+    #
+    # @param [String] filename under the which the data should be stored
+    # @param [#to_s] content to be compressed
+    def compress_file(filename, content)
+      zip.put_next_entry filename, nil, nil, Zip::ZipEntry::DEFLATED, Zlib::BEST_COMPRESSION
+      zip.write content.to_s
+    end
+  end
+end

data/lib/rpub/epub.rb

@@ -0,0 +1,37 @@
+module Rpub
+  class Epub
+    attr_reader :book, :styles
+
+    def initialize(book, styles)
+      @book, @styles = book, styles
+    end
+
+    def manifest_in(target)
+      target.store_file 'mimetype', 'application/epub+zip'
+      target.compress_file 'META-INF/container.xml', Container.new
+      target.compress_file 'OEBPS/content.opf', Content.new(book)
+      target.compress_file 'OEBPS/toc.ncx', Toc.new(book)
+      target.compress_file 'OEBPS/styles.css', styles
+      if book.cover?
+        target.compress_file 'OEBPS/cover.html', Cover.new(book)
+        target.compress_file File.join('OEBPS', book.cover_image), File.read(book.cover_image)
+      end
+      if book.toc?
+        target.compress_file 'OEBPS/toc.html', toc { HtmlToc.new(book).render }
+      end
+      book.each do |chapter|
+        target.compress_file File.join('OEBPS', chapter.filename), chapter.to_html
+      end
+      book.images.each do |image|
+        target.compress_file File.join('OEBPS', image), File.read(image)
+      end
+    end
+
+  private
+
+    def toc
+      @body = yield
+      ERB.new(File.read(book.layout)).result(binding)
+    end
+  end
+end

data/lib/rpub/epub/container.rb

@@ -0,0 +1,14 @@
+module Rpub
+  class Epub
+    class Container < XmlFile
+      def render
+        xml.instruct!
+        xml.container :version => '1.0', :xmlns => 'urn:oasis:names:tc:opendocument:xmlns:container' do
+          xml.rootfiles do
+            xml.rootfile 'full-path' => 'OEBPS/content.opf', 'media-type' => 'application/oebps-package+xml'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpub/epub/content.rb

@@ -0,0 +1,80 @@
+module Rpub
+  class Epub
+    class Content < XmlFile
+      attr_reader :book
+
+      MEDIA_TYPES = {
+        'png' => 'image/png',
+        'gif' => 'image/gif',
+        'jpg' => 'image/jpeg',
+        'svg' => 'image/svg+xml'
+      }
+
+      def initialize(book)
+        @book = book
+        super()
+      end
+
+      def render
+        xml.instruct!
+        xml.declare! :DOCTYPE, :package, :PUBLIC,  '-//W3C//DTD XHTML 1.1//EN', 'http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd'
+        xml.package 'xmlns' => 'http://www.idpf.org/2007/opf', 'unique-identifier' => 'BookId', 'version' => '2.0' do
+          xml.metadata 'xmlns:dc' => 'http://purl.org/dc/elements/1.1/', 'xmlns:opf' => 'http://www.idpf.org/2007/opf' do
+            xml.dc :language,    book.language
+            xml.dc :title,       book.title
+            xml.dc :creator,     book.creator, 'opf:role' => 'aut'
+            xml.dc :publisher,   book.publisher
+            xml.dc :subject,     book.subject
+            xml.dc :identifier,  book.uid, :id => 'BookId'
+            xml.dc :rights,      book.rights
+            xml.dc :description, book.description
+
+            if book.cover?
+              xml.meta :name => 'cover', :content => 'cover-image'
+            end
+          end
+
+          xml.manifest do
+            xml.item 'id' => 'ncx', 'href' => 'toc.ncx', 'media-type' => 'application/x-dtbncx+xml'
+            xml.item 'id' => 'css', 'href' => 'styles.css', 'media-type' => 'text/css'
+
+            if book.cover?
+              xml.item 'id' => 'cover', 'href' => 'cover.html', 'media-type' => 'application/xhtml+xml'
+              xml.item 'id' => 'cover-image', 'href' => book.cover_image, 'media-type' => guess_media_type(book.cover_image)
+            end
+
+            book.images.each do |image|
+              xml.item 'id' => File.basename(image), 'href' => image, 'media-type' => guess_media_type(image)
+            end
+            xml.item 'id' => 'toc', 'href' => 'toc.html', 'media-type' => 'application/xhtml+xml'
+            book.chapters.each do |chapter|
+              xml.item 'id' => chapter.id, 'href' => chapter.filename, 'media-type' => 'application/xhtml+xml'
+            end
+          end
+
+          xml.spine 'toc' => 'ncx' do
+            if book.cover?
+              xml.itemref 'idref' => 'cover', 'linear' => 'no'
+            end
+            book.chapters.each do |chapter|
+              xml.itemref 'idref' => chapter.id
+            end
+          end
+
+          if book.cover?
+            xml.guide do
+              xml.reference :type => 'cover', :title => 'Cover', :href => 'cover.html'
+            end
+          end
+        end
+      end
+
+      private
+
+      def guess_media_type(filename)
+        MEDIA_TYPES.fetch(filename[/\.(gif|png|jpe?g|svg)$/, 1]) { 'image/png' }
+      end
+    end
+  end
+end
+

data/lib/rpub/epub/cover.rb

@@ -0,0 +1,27 @@
+module Rpub
+  class Epub
+    class Cover < XmlFile
+      attr_reader :book
+
+      def initialize(book)
+        @book = book
+        super()
+      end
+
+      def render
+        xml.declare! :DOCTYPE, :html, :PUBLIC, '-//W3C//DTD XHTML 1.0 Strict//EN', 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'
+        xml.html :xmlns => 'http://www.w3.org/1999/xhtml' do
+          xml.head do
+            xml.title 'Cover'
+            xml.style 'img { max-width: 100%; }', :type => 'text/css'
+          end
+          xml.body do
+            xml.div :id => 'cover-image' do
+              xml.img :src => book.cover_image, :alt => book.title
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpub/epub/html_toc.rb

@@ -0,0 +1,25 @@
+module Rpub
+  class Epub
+    class HtmlToc < XmlFile
+      attr_reader :book
+
+      def initialize(book)
+        @book = book
+        super()
+      end
+
+      def render
+        xml.h1 'Table of Contents'
+        xml.div :class => 'toc' do
+          book.outline.each do |(filename, headings)|
+            headings.each do |heading|
+              xml.div :class => "level-#{heading.level}" do
+                xml.a heading.text, :href => [filename, heading.id].join('#')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rpub/epub/toc.rb

@@ -0,0 +1,35 @@
+module Rpub
+  class Epub
+    class Toc < XmlFile
+      attr_reader :book
+
+      def initialize(book)
+        @book = book
+        super()
+      end
+
+      def render
+        xml.instruct!
+        xml.declare! :DOCTYPE, :ncx, :PUBLIC, "-//W3C//DTD XHTML 1.1//EN", 'http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd'
+        xml.ncx :xmlns => 'http://www.daisy.org/z3986/2005/ncx/', :version => '2005-1' do
+          xml.head do
+            xml.meta :name => 'dtb:uid', :content => @book.uid
+            xml.meta :name => 'dtb:depth', :content => '1'
+            xml.meta :name => 'dtb:totalPageCount', :content => '0'
+            xml.meta :name => 'dtb:maxPageNumber', :content => '0'
+          end
+          xml.docTitle { xml.text @book.title }
+          xml.navMap do
+            @book.chapters.each_with_index do |chapter, n|
+              xml.navPoint :id => chapter.id, :playOrder => n do
+                xml.navLabel { xml.text chapter.title }
+                xml.content :src => chapter.filename
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/rpub/hash_delegation.rb

@@ -0,0 +1,23 @@
+module Rpub
+  # Delegate missing methods to keys in a Hash atribute on the current object.
+  module HashDelegation
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def delegate_to_hash(attr)
+        define_method(:delegated_hash) { send attr }
+      end
+    end
+
+    def respond_to?(m)
+      super || delegated_hash.has_key?(m.to_s)
+    end
+
+    def method_missing(m, *args, &block)
+      return super unless respond_to? m
+      delegated_hash.fetch m.to_s
+    end
+  end
+end

data/lib/rpub/subclass_tracker.rb

@@ -0,0 +1,53 @@
+module Rpub
+  # Add tracking of subclasses to an existing class by extending it with
+  # SubclassTracker.
+  #
+  # This allows you to set an identifier in a subclass using the `identifier`
+  # macro, and find subclasses based on that value.
+  #
+  # Example:
+  #
+  #     class ParentClass
+  #       extend SubclassTracker
+  #     end
+  #
+  #     class ChildClass < ParentClass
+  #       identifier 'foo'
+  #     end
+  #
+  #     ParentClass.matching('foo') # => ChildClass
+  #     ParentClass.matching('bar') # => raises SubclassTracker::NoSuchSubclass
+  #
+  # Note that you don't HAVE to set an identifier. If you don't, your child
+  # class will never be found by `#matching`.
+  module SubclassTracker
+    class NoSuchSubclass < StandardError
+      def initialize(subcommand)
+        super "Unrecognized identifier: #{subcommand}"
+      end
+    end
+
+    # Set or return the identifier for this class.
+    def identifier(id = nil)
+      return @identifier if id.nil?
+      @identifier = id
+    end
+
+    def inherited(child)
+      @subclasses ||= []
+      @subclasses << child
+      super
+    end
+
+    def each
+      @subclasses ||= []
+      @subclasses.each { |subclass| yield subclass }
+    end
+
+    def matching(identifier)
+      find { |subclass| subclass.identifier === identifier } or raise NoSuchSubclass, identifier
+    end
+
+    include Enumerable
+  end
+end

data/lib/rpub/version.rb

@@ -0,0 +1,3 @@
+module Rpub
+  VERSION = '0.1.0'
+end

data/lib/rpub/xml_file.rb

@@ -0,0 +1,14 @@
+module Rpub
+  class XmlFile
+    attr_reader :xml
+
+    def initialize
+      @xml = Builder::XmlMarkup.new :indent => 2
+    end
+
+    def to_s
+      render
+      xml.target!
+    end
+  end
+end

data/rpub.gemspec

@@ -0,0 +1,52 @@
+# -*- encoding: utf-8 -*-
+require './lib/rpub/version'
+
+Gem::Specification.new do |s|
+  # Metadata
+  s.name        = 'rpub'
+  s.version     = Rpub::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Arjan van der Gaag']
+  s.email       = %q{arjan@arjanvandergaag.nl}
+  s.description = %q{an ePub generation library in Ruby}
+  s.homepage    = %q{http://avdgaag.github.com/rpub}
+  s.summary     = <<-EOS
+rPub is a command-line tool that generates a collection of plain text input
+files into an eBook in ePub format. It provides several related functions to
+make working with ePub files a little easier:
+
+* Generation of table of contents
+* Tracking of references to tables or figures
+* Validation of output file
+* Packaging your eBook in an archive with additional README file
+* Very simple version control
+EOS
+
+  # Files
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # Rdoc
+  s.rdoc_options = ['--charset=UTF-8']
+  s.extra_rdoc_files = [
+     'LICENSE',
+     'README.md',
+     'HISTORY.md'
+  ]
+
+  # Dependencies
+  s.add_runtime_dependency 'typogruby'
+  s.add_runtime_dependency 'kramdown'
+  s.add_runtime_dependency 'rubyzip'
+  s.add_runtime_dependency 'builder'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'guard'
+  s.add_development_dependency 'guard-rspec'
+  s.add_development_dependency 'rb-fsevent'
+  s.add_development_dependency 'growl'
+end
+

data/spec/fixtures/clean/config.yml

@@ -0,0 +1,2 @@
+---
+title: example

data/spec/fixtures/preview/a.md

@@ -0,0 +1 @@
+foo

data/spec/fixtures/preview/b.md

@@ -0,0 +1 @@
+bar