bindery 0.0.3 → 2.0.0

data/.gitignore

@@ -1,3 +1,4 @@
+.ruby-version
 *.gem
 .bundle
 Gemfile.lock

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm: 1.9.2
+notifications:
+  recipients:
+    - glv@vanderburg.org

data/ChangeLog

@@ -0,0 +1,18 @@
+2013-08-10  Glenn Vanderburg
+
+	* content_methods.rb: Completely changed the behavior of the
+	chapter method when a block is passed.  The previous design was
+	embarrassingly bad.  There was no need to use the passed block
+	to dynamically calculate the parameters that could be passed
+	directly to the method; Ruby has other ways of doing that.  Now,
+	the block is used to define hierarchical book structure: nested
+	chapters, parts, sections, etc.
+
+	If you were using the block to dynamically build content and
+	return the chapter title and file name, simply move the content of
+	the block to a method, and then you can splice the returned title
+	and filename into the arguments of chapter using the splat
+	operator (*) or (if the block used the strategy of returning a
+	hash) include the activesupport gem, require
+	'active_support/core_ext/hash/slice', and use Hash#slice(:title,
+	:filename).

data/README.md

@@ -1,11 +1,11 @@
-# Bindery
+# Bindery [![Build Status](https://secure.travis-ci.org/glv/bindery.png)](http://travis-ci.org/glv/bindery)
 
 [Bindery][] is a [Ruby][] library for packaging ebooks.
 
 Electronic book formats are typically rather simple.
 An EPUB book, for example, is just HTML, CSS, and some image files packed into a single zip file along with various bits of metadata.
 But there are numerous tricky details, and a lot of redundancy in the metadata.
-Bindery aims to simplify the process.
+Bindery aims to simplify the process, while stopping short of being a full ebook authoring system.
 
 To use Bindery, you write a simple Ruby program that describes the book's structure and important metadata.
 This program is also responsible for identifying the HTML files that correspond to the book's chapters; those files might already exist, but the program can generate them on the fly as well.
@@ -49,13 +49,11 @@ Bindery.book do |b|
   # is a Ruby Markdown library that supports numerous common extensions
   # to the basic Markdown syntax.)
   Dir['*.maruku'].sort.each do |file_name|
-    b.chapter do
-      output_file_name = file_name.sub(/\.maruku$/, '.xhtml_gen')
-      doc = Maruku.new(IO.read(file_name))
-      open(output_file_name, "w") {|os| os.write(doc.to_html)}
-      # return a hash with title and file info:
-      { :title => doc.attributes[:title], :file => output_file_name }
-    end
+    output_file_name = file_name.sub(/\.maruku$/, '.xhtml_gen')
+    doc = Maruku.new(IO.read(file_name))
+    open(output_file_name, "w") {|os| os.write(doc.to_html)}
+   
+    b.chapter doc.attributes[:title], output_file_name
   end
   
   b.backmatter 'Colophon' # filename assumed to be colophon.xhtml
@@ -64,18 +62,22 @@ end
     
 ## Status
 
-Bindery is currently limited to generating EPUB books that do not contain images or other non-textual content.
+Bindery is currently limited to generating EPUB books.
 
 It is also in a very early stage.
 It's capable of generating very simple books, but many features (including the frontmatter and backmatter methods in the example above) do not work yet.
-Additionally, validation is sketchy, so it's quite likely that the books you build using Bindery will not be valid EPUB files.
 But the basics are there, and contributions are welcome.
 
+Generated EPUB books will be valid according to [epubcheck][] *except* perhaps for chapter content.
+EPUB places some additional restrictions on XHTML and CSS, and if the supplied chapter content violates those restrictions then the EPUB file will be invalid.
+Most EPUB readers are fairly permissive about such things, but some are more particular.
+I plan to build support for tidying up the XHTML and CSS and eliminating invalid constructs, but at the moment that's a low priority.
+
 Planned features include:
 
 * options for sections (with and without section title pages) rather than just a flat chapter structure.
 * additional metadata including all of [Dublin Core][].
-* support for images
+* title and cover pages
 * support for multiple stylesheets
 * support for generating Mobipocket books
 
@@ -102,6 +104,13 @@ Bindery is designed to support those use cases, not just brand new books written
 If you want to publish in both electronic and paper formats, Bindery is probably not for you.
 Bindery is targeted at electronic books only.
 
+## Acknowledgments
+
+In February 2013, about a year and a half after initially writing Bindery,
+I discovered the [Python Epub Builder][pyepub], written by (apparently)
+Bin Tan. It was more complete than Bindery was at the time, and it inspired
+me to work on Bindery again, and gave me some valuable ideas.
+
 [adobe indesign]: http://www.adobe.com/products/indesign.html
 [asciidoc]: http://www.methods.co.nz/asciidoc/
 [best software writing]: http://www.apress.com/9781590595008
@@ -109,6 +118,7 @@ Bindery is targeted at electronic books only.
 [devonthink]: http://www.devon-technologies.com/products/devonthink/index.html
 [dublin core]: http://dublincore.org/sm
 [epub]: http://idpf.org/epub
+[epubcheck]: http://code.google.com/p/epubcheck/
 [git]: http://git-scm.com/
 [github]: http://github.com/
 [git-scribe]: http://github.com/schacon/git-scribe
@@ -118,6 +128,7 @@ Bindery is targeted at electronic books only.
 [johnson dt2]: http://boingboing.net/2009/01/27/diy-how-to-write-a-b.html
 [markdown]: http://daringfireball.net/projects/markdown/
 [microsoft word]: http://office.microsoft.com/word/
+[pyepub]: http://code.google.com/p/python-epub-builder/
 [rake]: http://rake.rubyforge.org/
 [ruby]: http://ruby-lang.org/
 [sproutcore]: http://www.sproutcore.com/

data/TODO.taskpaper

@@ -1,13 +1,14 @@
 - Flesh out validation
 	Consider moving details to format modules.
 	Investigate Mobi validity constraints to see whether that makes sense.
+- Cache fetched image (and other) files so we don't have to fetch them twice while building multiple formats.
 - Add more metadata support
 	- subtitle
 	- different kinds of authors
 - Title page
 - Title image
-- Image support
-- A basic CSS file
+- Image support @done
+- A basic CSS file @done
 - Support for alternative CSS files
 - Frontmatter
 - Nested chapter structures

data/examples/ashtray/book.rb

@@ -40,7 +40,7 @@ def process_part(url, i)
     content.children[0..1].each{|c| c.remove}
     os.write content.serialize
   end
-  { :title => title, :file => file_name }
+  [title, file_name]
 end
 
 Bindery.book do |b|
@@ -53,6 +53,6 @@ Bindery.book do |b|
   b.language 'en'
   
   PARTS.each_with_index do |url, i|
-    b.chapter { process_part(url, i) }
+    b.chapter *process_part(url, i)
   end
 end

data/examples/trivial/appendices.xhtml

@@ -0,0 +1 @@
+<h2>Appendices</h2>

data/examples/trivial/book.rb

@@ -11,17 +11,23 @@ Bindery.book do |b|
   
   b.chapter "Chapter 1", 'chapter_1.xhtml'
   b.chapter "Chapter 2", 'chapter_2.xhtml', :body_only => false
-  b.chapter "Chapter 3" do
-    # It's good practice to have a way to distinguish source files from
-    # those generated as part of the build, so you can have a Rake task
-    # or something to clean up the intermediate files.
-    "chapter_3.xhtml_gen".tap do |filename|
-      File.open(filename, "w") do |os|
-        os.write %{
-          <p>Let's just write this chapter in line, shall we?</p>
-          <p>It seems easier that way, when the chapters are so short.</p>
-        }
-      end
-    end
+
+  # It's good practice to have a way to distinguish source files from
+  # those generated as part of the build, so you can have a Rake task
+  # or something to clean up the intermediate files.
+  fn = 'chapter_3.xhtml_gen'
+  File.open(fn, 'w') do |os|
+    os.write %{
+      <p>Let's just write this chapter in line, shall we?</p>
+      <p>It seems easier that way, when the chapters are so short.</p>
+    }
+  end
+  b.chapter "Chapter 3", fn
+
+  b.part("Appendices", 'appendices.xhtml') do |div|
+    div.appendix "Appendix 1: Errata", 'errata.xhtml'
+    div.appendix "Appendix 2: Index", 'index.xhtml'
   end
+
+  b.part "Colophon", 'colophon.xhtml'
 end

data/examples/trivial/chapter_2.xhtml

@@ -9,6 +9,8 @@
 <body>
 <h2>Chapter 2</h2>
 
-<p>Unlike Chapter 1, this chapter's source file is a full, valid XHTML file, not just the body.</p>
+<p>Unlike Chapter 1, this chapter's source file is a full, valid XHTML
+  file, not just the body. It will cause some errors for an epub
+  reader that really validates the spec.</p>
 </body>
 </html>

data/examples/trivial/colophon.xhtml

@@ -0,0 +1,3 @@
+<h2>Colophon</h2>
+
+<p>Made with bindery!</p>

data/examples/trivial/errata.xhtml

@@ -0,0 +1,5 @@
+<h2>Appendix 1: Errata</h2>
+
+<ol>
+<li><cite>Appendix 1: Errata</cite>: title should be "Erratum"</li>
+</ol>

data/examples/trivial/index.xhtml

@@ -0,0 +1,3 @@
+<h2>Appendix 2: Index</h2>
+
+<p>(Expand this section when there's something worth looking up.)</p>

data/examples/vanier_monads/book.rb

@@ -0,0 +1,52 @@
+require 'bindery'
+require 'open-uri'
+require 'nokogiri'
+#require 'tidy_ffi'
+
+PARTS = [
+  'http://webcache.googleusercontent.com/search?q=cache:http://mvanier.livejournal.com/3917.html',
+  'http://webcache.googleusercontent.com/search?q=cache:http://mvanier.livejournal.com/4305.html',
+  'http://webcache.googleusercontent.com/search?q=cache:http://mvanier.livejournal.com/4586.html',
+  'http://webcache.googleusercontent.com/search?q=cache:http://mvanier.livejournal.com/4647.html',
+  'http://webcache.googleusercontent.com/search?q=cache:http://mvanier.livejournal.com/5103.html',
+  'http://webcache.googleusercontent.com/search?q=cache:http://mvanier.livejournal.com/5343.html',
+  'http://webcache.googleusercontent.com/search?q=cache:http://mvanier.livejournal.com/5406.html',
+  'http://webcache.googleusercontent.com/search?q=cache:http://mvanier.livejournal.com/5846.html'
+]
+
+TITLES = [
+  "Part 1: Basics",
+  nil,
+  nil,
+  nil,
+  "Part 5: Error-Handling Monads",
+  "Part 6: More on Error-Handling Monads",
+  "Part 7: State Monads",
+  "Part 8: More on State Monads"
+]
+
+def process_part(url, i)
+  file_name = "chapter_#{i+1}.xhtml_gen"
+  doc = Nokogiri::HTML(open(url), nil, 'UTF-8')
+  title = TITLES[i] || doc.at_css('h1.b-singlepost-title').text.sub(/^.*?Tutorial \(p(art .*?)\).*$/, 'P\\1')
+  open(file_name, 'w') do |os|
+    content = doc.at_css('div.b-singlepost-body')
+    os.puts "<h1>#{title}</h1>"
+    os.write content.serialize
+  end
+  [title, file_name]
+end
+
+Bindery.book do |b|
+  b.output 'mvanier_monad_tutorial'
+  b.format :epub
+  
+  b.title "Yet Another Monad Tutorial"
+  b.author 'Mike Vanier'
+  b.url 'http://glenn.mp/book/mvanier_monad_tutorial'
+  b.language 'en'
+  
+  PARTS.each_with_index do |url, i|
+    b.chapter *process_part(url, i)
+  end
+end

data/lib/bindery.rb

@@ -4,7 +4,8 @@ require 'bindery/extensions/file'
 require 'bindery/version'
 require 'bindery/bindery'
 require 'bindery/book'
+require 'bindery/content_methods'
 require 'bindery/book_builder'
-require 'bindery/chapter'
+require 'bindery/division'
 
 require 'bindery/formats/epub'

data/lib/bindery/book.rb

@@ -1,13 +1,23 @@
 module Bindery
   class Book
+    class Metadata < Struct.new(:name, :value, :options)
+    end
+    
+    class DublinMetadata < Metadata
+    end
+    
     attr_accessor :output, :url, :isbn, :title, :language, :author, :subtitle
     
+    def metadata
+      @metadata ||= []
+    end
+    
     def formats
       @formats ||= []
     end
     
-    def chapters
-      @chapters ||= []
+    def divisions
+      @divisions ||= []
     end
     
     def full_title
@@ -15,14 +25,14 @@ module Bindery
     end
     
     def valid?
-      configuration_valid? && metadata_valid? && chapters_valid?
+      configuration_valid? && metadata_valid? && divisions_valid?
     end
     
     def configuration_valid?
       true
       # formats specified or correctly defaulted
       # ouput specified
-      # at least one chapter
+      # at least one division
     end
     
     def metadata_valid?
@@ -31,8 +41,8 @@ module Bindery
       # what is there is correct
     end
     
-    def chapters_valid?
-      chapters.all?{|chapter| chapter.valid?} # && chapter file names are unique
+    def divisions_valid?
+      divisions.all?{|div| div.valid?} # && division file names are unique
     end
     
     def generate

data/lib/bindery/book_builder.rb

@@ -3,6 +3,27 @@ module Bindery
   class BookBuilder
     attr_accessor :book
     
+    Metadata = {
+      :contributor => nil,
+      :cover       => :special,
+      :coverage    => nil,
+      :creator     => nil,
+      :date        => nil,
+      :description => nil,
+      :format      => nil,
+      :identifier  => :required,
+      :language    => :required,
+      :publisher   => nil,
+      :relation    => nil,
+      :rights      => nil,
+      :source      => nil,
+      :subject     => nil,
+      :title       => :required,
+      :type        => nil
+    }
+
+    include ContentMethods
+    
     def initialize
       self.book = ::Bindery::Book.new
     end
@@ -16,7 +37,42 @@ module Bindery
       raise "output already set to #{book.output}" unless book.output.nil?
       book.output = basename.to_s
     end
+
+    def divisions
+      book.divisions
+    end
+    
+    # ---------------------------------------------------- 
+    # Metadata elements  
+    
+    # Allows grouping metadata elements together in a named block
+    # within the book specification. Use of this method is not necessary;
+    # all of the metadata methods can be called directly on the BookBuilder
+    # instance. It is usually best, though, to have them clearly grouped
+    # within a metadata block.
+    def metadata
+      yield self
+    end
     
+    def metadata_element(name, value, options={})
+      name_sym = name.to_sym
+      if Metadata[name_sym] == :special
+        book.metadata << Bindery::Book::Metadata.new(name_sym, value, options)
+      else
+        book.metadata << Bindery::Book::DublinMetadata.new(name_sym, value, options)
+      end
+    end
+
+    def method_missing(name, *args, &block)
+      if Metadata.include?(name.to_sym)
+        metadata_element(name, *args, &block)
+      else
+        super
+      end
+    end
+
+    # TODO: Most of these could be switched to be general metadata
+    # objects. Should they be?
     def url(url)
       book.url = url
     end
@@ -41,61 +97,6 @@ module Bindery
       book.author = author
     end
     
-    # :call-seq:
-    #   chapter(title, filename, options={})
-    #   chapter(title, options={}) { ... }
-    #   chapter(options={}) { ... }
-    #
-    # Add a chapter to the book.
-    #
-    # If called with a title and a filename, the chapter's content should
-    # be found in the named file.
-    #
-    # If called with a title and a block, the block should generate or
-    # retrieve the chapter's content, write it to a file, and return the
-    # file name.
-    #
-    # If called with no parameters and a block, the block should generate
-    # or retrieve the chapter's content, write it to a file, and return a
-    # hash with the following keys:
-    # [:title] the chapter title (required)
-    # [:file]  the name of the file containing the chapter content (required)
-    #
-    # An options hash parameter is always allowed, and the following 
-    # options are supported:
-    # [:body_only] the file contains only the body of the XHTML document,
-    #              and Bindery should wrap it to create a valid document.
-    #              Defaults to true.
-    def chapter(*args)
-      default_options = {:body_only => true}
-      options = default_options.merge(args.last.kind_of?(Hash) ? args.pop : {})
-      if block_given?
-        chapter_dynamic(options, *args){yield}
-      else
-        chapter_static(options, *args)
-      end
-    end
-    
-    protected
-    
-    def chapter_static(options, *args)
-      title, file = args
-      raise ArgumentError, "title not specified" if title.nil?
-      raise ArgumentError, "file not specified" if file.nil?
-      book.chapters << Chapter.new(title, file, options)
-    end
-    
-    def chapter_dynamic(options, title=nil)
-      if title
-        file = yield
-        raise "expected the block to return a filename string" unless file.kind_of?(String)
-        chapter_static(options, title, yield)
-      else
-        info = yield
-        raise "expected the block to return a hash containing :title, :file, etc." unless info.kind_of?(Hash)
-        chapter_static(options, info[:title], info[:file])
-      end
-    end
   end
   
 end

data/lib/bindery/content_methods.rb

@@ -0,0 +1,36 @@
+module Bindery
+  module ContentMethods
+
+    # Add a division to the book.
+    #
+    # The following options are supported:
+    # [:body_only] the file contains only the body of the XHTML document,
+    #              and Bindery should wrap it to create a valid document.
+    #              Defaults to true.
+    def div(div_type, title, filename, options={})
+      options = {:body_only => true}.merge(options)
+      raise ArgumentError, "title not specified" if title.nil?
+      raise ArgumentError, "file not specified" if filename.nil?
+      div = Division.new(div_type, title, filename, options)
+      divisions << div
+      yield div if block_given?
+    end
+
+    def chapter(title, filename, options={}, &block)
+      div('chapter', title, filename, options, &block)
+    end
+    
+    def section(title, filename, options={}, &block)
+      div('section', title, filename, options, &block)
+    end
+    
+    def part(title, filename, options={}, &block)
+      div('part', title, filename, options, &block)
+    end
+    
+    def appendix(title, filename, options={}, &block)
+      div('appendix', title, filename, options, &block)
+    end
+    
+  end
+end

data/lib/bindery/division.rb

@@ -0,0 +1,43 @@
+module Bindery
+  class Division
+    attr_accessor :div_type
+    attr_accessor :file
+    attr_accessor :title
+    attr_accessor :options
+
+    include ContentMethods
+    
+    def initialize(div_type, title, file, options)
+      self.div_type = div_type
+      self.title = title
+      self.file = file
+      self.options = options
+    end
+    
+    def valid?
+      true
+      # ??? title specified? Is this required by the spec? Think about
+      #   in what sense a chapter needs a title. Wouldn't it be nice
+      #   if (say) Pratchett's books could be broken up a bit even
+      #   though he doesn't have titled chapters? Aren't there books
+      #   with actual chapters but no titles? Does epub provide
+      #   another way to provide subdivisions without separate
+      #   chapters that would break up the text flow?
+      # file exists, readable
+      # file content properly formed?  Does that matter?  Can we
+      #   verify it? 
+    end
+
+    def divisions
+      @divisions ||= []
+    end
+    
+    def body_only?
+      options.fetch(:body_only, true)
+    end
+    
+    def include_images?
+      options.fetch(:include_images, true)
+    end
+  end
+end

data/lib/bindery/formats/epub.rb

@@ -35,7 +35,7 @@ module Bindery
       def initialize(book)
         self.book = book
         book.extend BookMethods
-        book.chapters.each{|chapter| chapter.extend ChapterMethods}
+        book.divisions.each{|division| division.extend DivisionMethods}
         self.manifest_entries = []
       end
       
@@ -48,8 +48,8 @@ module Bindery
           zipfile.write_file 'META-INF/container.xml', container
           
           # also frontmatter, backmatter
-          book.chapters.each do |chapter|
-            write_chapter(chapter, zipfile)
+          book.divisions.each do |division|
+            write_division(division, zipfile)
           end
           
           zipfile.mkdir 'css'
@@ -93,7 +93,7 @@ module Bindery
           }
           
           xm.manifest {
-            book.chapters.each{|chapter| xm.item 'id'=>chapter.epub_id, 'href'=>chapter.epub_output_file, 'media-type'=>'application/xhtml+xml'}
+            book.divisions.each{|division| division.write_item(xm)}
             # also frontmatter, backmatter
             xm.item 'id'=>'stylesheet', 'href'=>'css/book.css', 'media-type'=>'text/css'
             manifest_entries.each do |entry|
@@ -104,7 +104,7 @@ module Bindery
           }
           
           xm.spine('toc'=>'ncx') {
-            book.chapters.each{|chapter| xm.itemref 'idref'=>chapter.epub_id}
+            book.divisions.each{|division| division.write_itemref(xm)}
           }
           
           # xm.guide {
@@ -134,36 +134,31 @@ module Bindery
           }
           
           xm.navMap {
-            play_order = 1
+            play_order = 0
             
             # also frontmatter, backmatter
-            book.chapters.each do |chapter|
-              xm.navPoint('class'=>'chapter', 'id'=>chapter.epub_id, 'playOrder'=>play_order) {
-                xm.navLabel {
-                  xm.text chapter.title
-                }
-                xm.content 'src'=>chapter.epub_output_file
-              }
+            book.divisions.each do |division|
               play_order += 1
+              play_order = division.write_navpoint(xm, play_order)
             end
           }
         }
       end
       
-      def write_chapter(chapter, zipfile)
+      def write_division(division, zipfile)
         save_options = Nokogiri::XML::Node::SaveOptions
-        File.open(chapter.file, 'r:UTF-8') do |ch_in|
+        File.open(division.file, 'r:UTF-8') do |ch_in|
           doc = Nokogiri.HTML(ch_in.read)
-          include_images(doc, zipfile) if chapter.include_images?
-          zipfile.get_output_stream(chapter.epub_output_file) do |ch_out|
-            if chapter.body_only?
-              # FIXME: must HTML-escape the chapter title
+          include_images(doc, zipfile) if division.include_images?
+          zipfile.get_output_stream(division.epub_output_file) do |ch_out|
+            if division.body_only?
+              # FIXME: must HTML-escape the division title
               ch_out.write %{|<?xml version="1.0" encoding="UTF-8" ?>
                              |<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
                              |<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
                              |<head>
                              |  <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8" />
-                             |  <title>#{chapter.title}</title>
+                             |  <title>#{division.title}</title>
                              |  <link rel="stylesheet" href="css/book.css" type="text/css" />
                              |</head>
                              |}.strip_margin
@@ -175,6 +170,9 @@ module Bindery
             end
           end
         end
+        division.divisions.each do |div|
+          write_division(div, zipfile)
+        end
       end
       
       def include_images(doc, zipfile)
@@ -184,13 +182,17 @@ module Bindery
           url = img['src']
           img_fn = make_image_file_name(zipfile, url)
           # TODO: These images should be cached somewhere for multi-format runs
-          open(url, 'r') do |is|
-            zipfile.get_output_stream(img_fn) do |os|
-              os.write is.read
+          begin
+            open(url, 'r') do |is|
+              zipfile.get_output_stream(img_fn) do |os|
+                os.write is.read
+              end
             end
+            add_manifest_entry(img_fn)
+            img['src'] = img_fn
+          rescue OpenURI::HTTPError => ex
+            puts "Image fetch failed: #{ex.message} (#{url})"
           end
-          add_manifest_entry(img_fn)
-          img['src'] = img_fn
         end
       end
       
@@ -291,7 +293,7 @@ module Bindery
         end
         
         def depth
-          1
+          (divisions.map(&:depth) + [0]).max
         end
         
         def ident
@@ -299,7 +301,12 @@ module Bindery
         end
       end
       
-      module ChapterMethods
+      module DivisionMethods
+
+        def self.extended(obj)
+          obj.divisions.each{|division| division.extend DivisionMethods}
+        end
+          
         def epub_id
           @epub_id ||= File.stemname(file)
         end
@@ -307,6 +314,50 @@ module Bindery
         def epub_output_file
           @epub_output_file ||= "#{epub_id}.xhtml"
         end
+
+        def depth
+          (divisions.map(&:depth) + [0]).max + 1
+        end
+
+        def write_item(xm)
+          xm.item('id' => epub_id,
+                  'href' => epub_output_file,
+                  'media-type' => 'application/xhtml+xml')
+          divisions.each{|div| div.write_item(xm)}
+        end
+
+        def write_itemref(xm)
+          xm.itemref('idref' => epub_id)
+          divisions.each{|div| div.write_itemref(xm)}
+        end
+
+        def write_navpoint(xm, play_order)
+          xm.navPoint('class'=>'chapter', 'id'=>epub_id, 'playOrder'=>play_order) {
+            xm.navLabel {
+              xm.text title
+            }
+            xm.content 'src'=>epub_output_file
+            divisions.each do |division|
+              play_order += 1
+              play_order = division.write_navpoint(xm, play_order)
+            end
+          }
+          play_order
+        end
+
+      end
+      
+      module MetadataMethods
+        def to_xml(builder)
+          builder.meta(options.merge(:name => name, :content => value))
+          %{<dc:#{name}>#{value}</dc:#{name}>}
+        end
+      end
+      
+      module DublinMetadataMethods
+        def to_xml(builder)
+          builder.dc name, value, options
+        end
       end
     end
   end

data/lib/bindery/version.rb

@@ -1,3 +1,3 @@
 module Bindery
-  VERSION = "0.0.3"
+  VERSION = "2.0.0"
 end

data/spec/bindery/book_builder_spec.rb

@@ -38,53 +38,32 @@ describe Bindery::BookBuilder do
     end
   end
   
-  describe "#chapter" do
+  describe "#div" do
     
-    context "when called without a block" do
-      it "raises an exception if title or filename are not supplied" do
-        expect { subject.chapter }.to raise_error(ArgumentError, "title not specified")
-        expect { subject.chapter "A" }.to raise_error(ArgumentError, "file not specified")
-      end
-      
-      it "stores a new chapter with the supplied options" do
-        subject.chapter "Foo", "bar.xhtml"
-        book.chapters.should have(1).elements
-        book.chapters.first.title.should == "Foo"
-        book.chapters.first.file.should == "bar.xhtml"
-      end
+    it "raises an exception if title or filename are not supplied" do
+      expect { subject.div("chapter", nil, "fn") }.to raise_error(ArgumentError, "title not specified")
+      expect { subject.div("chapter", "A", nil) }.to raise_error(ArgumentError, "file not specified")
+    end
+
+    it "stores a new division with the supplied options" do
+      subject.div 'excerpt', "Foo", "bar.xhtml", :a => :b
+      book.divisions.should have(1).elements
+      div = book.divisions.first
+      div.div_type.should == 'excerpt'
+      div.title.should == "Foo"
+      div.file.should == "bar.xhtml"
+      div.options.should include(:a => :b)
     end
     
-    context "when called with a block" do
-      
-      context "and title is supplied as an argument" do
-        it "expects the block to result in a filename string" do
-          expect { subject.chapter("Foo"){ 3 } }.to raise_error
-        end
-        
-        it "stores the title and the filename as a new chapter" do
-          subject.chapter("Foo"){ 'bar.xhtml' }
-          book.chapters.should have(1).elements
-          book.chapters.first.title.should == "Foo"
-          book.chapters.first.file.should == "bar.xhtml"
-        end
-      end
-      
-      context "and title is not supplied as an argument" do
-        it "expects the block to result in a hash with :title and :file options" do
-          expect { subject.chapter{ "Invalid" } }.to raise_error
-          expect { subject.chapter{ {:title => 'Foo'} } }.to raise_error
-          expect { subject.chapter{ {:file => 'bar.xhtml'} } }.to raise_error
-        end
-        
-        it "stores the title and the filename as a new chapter" do
-          subject.chapter { {:title => 'Foo', :file => 'bar.xhtml'} }
-          book.chapters.should have(1).elements
-          book.chapters.first.title.should == "Foo"
-          book.chapters.first.file.should == "bar.xhtml"
-        end
+  end
+
+  %w[chapter section part appendix].each do |div_type|
+    describe "##{div_type}" do
+      it "calls #div with the appropriate type" do
+        subject.expects(div_type.to_sym).once
+        subject.send(div_type, :title, :filename, {:a => :b})
       end
-      
     end
-    
   end
-end
+
+end

metadata

@@ -1,113 +1,150 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: bindery
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 2.0.0
   prerelease: 
-  version: 0.0.3
 platform: ruby
-authors: 
+authors:
 - Glenn Vanderburg
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-18 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: builder
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: zip
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rake
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2.0"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *id006
-description: |-
-  Bindery is a Ruby library for easy packaging of ebooks.
-  You supply the chapter content (in HTML format) and explain the book's structure to bindery,
-  and bindery generates the various other files required by ebook formats and assembles them
-  into a completed book suitable for installation on an ebook reader.
-email: 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: ! 'Bindery is a Ruby library for easy packaging of ebooks.
+
+  You supply the chapter content (in HTML format) and explain the book''s structure
+  to bindery,
+
+  and bindery generates the various other files required by ebook formats and assembles
+  them
+
+  into a completed book suitable for installation on an ebook reader.'
+email:
 - glv@vanderburg.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .travis.yml
+- ChangeLog
 - Gemfile
 - README.md
 - Rakefile
 - TODO.taskpaper
 - bindery.gemspec
 - examples/ashtray/book.rb
+- examples/trivial/appendices.xhtml
 - examples/trivial/book.rb
 - examples/trivial/chapter_1.xhtml
 - examples/trivial/chapter_2.xhtml
+- examples/trivial/colophon.xhtml
+- examples/trivial/errata.xhtml
+- examples/trivial/index.xhtml
+- examples/vanier_monads/book.rb
 - lib/bindery.rb
 - lib/bindery/bindery.rb
 - lib/bindery/book.rb
 - lib/bindery/book_builder.rb
-- lib/bindery/chapter.rb
+- lib/bindery/content_methods.rb
+- lib/bindery/division.rb
 - lib/bindery/extensions/file.rb
 - lib/bindery/extensions/string.rb
 - lib/bindery/extensions/zip_file.rb
@@ -116,38 +153,34 @@ files:
 - spec/bindery/bindery_spec.rb
 - spec/bindery/book_builder_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/glv/bindery
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.9.2
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: -2203226033245718984
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -394401607600380017
 requirements: []
-
 rubyforge_project: bindery
-rubygems_version: 1.5.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Easy ebook packaging with Ruby
-test_files: 
+test_files:
 - spec/bindery/bindery_spec.rb
 - spec/bindery/book_builder_spec.rb
 - spec/spec_helper.rb

data/lib/bindery/chapter.rb

@@ -1,28 +0,0 @@
-module Bindery
-  class Chapter
-    attr_accessor :file
-    attr_accessor :title
-    attr_accessor :options
-    
-    def initialize(title, file, options)
-      self.title = title
-      self.file = file
-      self.options = options
-    end
-    
-    def valid?
-      true
-      # title specified
-      # file exists, readable
-      # file content properly formed?  Does that matter?  Can we verify it?
-    end
-    
-    def body_only?
-      options.fetch(:body_only, true)
-    end
-    
-    def include_images?
-      options.fetch(:include_images, true)
-    end
-  end
-end