gepub 0.6.2 → 0.6.3

data/.gitignore

@@ -21,7 +21,7 @@ pkg
 ## PROJECT::SPECIFIC
 testepub.epub
 testepub2.epub
-example_test.epub
+example_test*.epub
 
 ## BUNDLER
 Gemfile.lock

data/README.md

@@ -9,15 +9,48 @@ a generic EPUB parser/generator library.
 ## FEATURES/PROBLEMS:
 
 * GEPUB::Book provides functionality to create EPUB file, and parsing EPUB file
-* from version 0.6, GEPUB::Book will be able handle almost every metadata in EPUB2/EPUB3.
-  .. but is still beta version. Please inform me when you find bugs.
-* Will provide easy to generate EPUB class, like Nokogiri::XML::Generator.
+* Handle every metadata in EPUB2/EPUB3.
+* Soon, I will provide easy to generate EPUB class, like Nokogiri::XML::Generator.
 
 * See [issues](https://github.com/skoji/gepub/issues/) for known problems.
 
 ## SYNOPSIS:
 
-see examples directory.
+### Builder Example
+
+    require 'rubygem'
+    require 'gepub'
+    workdir = 'epub/example/'
+    builder = GEPUB::Builder.new {
+      unique_identifier 'http:/example.jp/bookid_in_url', 'BookID', 'URL'
+      language 'en'
+
+      title 'GEPUB Sample Book'
+      subtitle 'This book is just a sample'
+      alt 'ja' => 'これはあくまでサンプルです'
+
+      creator 'KOJIMA Satoshi'
+      alt 'ja' => '小嶋智'
+
+      contributors 'Denshobu', 'Asagaya Densho', 'Shonan Densho Teidan', 'eMagazine Torutaru'
+
+      date '2012-02-29T00:00:00Z'
+
+      resources(:workdir => workdir) {
+        cover_image 'img/image1.jpg' => 'image1.jpg'
+        ordered {
+          file 'text/chap1.xhtml'
+          heading 'Chapter 1'
+          file 'text/chap1-1.xhtml'
+          file 'text/chap2.html'
+          heading 'Chapter 2'
+        }
+      }
+    }
+    epubname = File.join(File.dirname(__FILE__), 'example_test_with_builder.epub')
+    builder.generate_epub(epubname)
+
+ [examples](https://github.com/skoji/gepub/tree/master/examples/) 
 
 ## INSTALL:
 

data/examples/builder_example.rb

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+    require 'rubygem'
+    require 'gepub'
+    workdir = 'epub/example/'
+    builder = GEPUB::Builder.new {
+      unique_identifier 'http:/example.jp/bookid_in_url', 'BookID', 'URL'
+      language 'en'
+
+      title 'GEPUB Sample Book'
+      subtitle 'This book is just a sample'
+      alt 'ja' => 'これはあくまでサンプルです'
+
+      creator 'KOJIMA Satoshi'
+      alt 'ja' => '小嶋智'
+
+      contributors 'Denshobu', 'Asagaya Densho', 'Shonan Densho Teidan', 'eMagazine Torutaru'
+
+      date '2012-02-29T00:00:00Z'
+
+      resources(:workdir => workdir) {
+        cover_image 'img/image1.jpg' => 'image1.jpg'
+        ordered {
+          file 'text/chap1.xhtml'
+          heading 'Chapter 1'
+          file 'text/chap1-1.xhtml'
+          file 'text/chap2.html'
+          heading 'Chapter 2'
+        }
+      }
+    }
+    epubname = File.join(File.dirname(__FILE__), 'example_test_with_builder.epub')
+    builder.generate_epub(epubname)

data/gepub.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ["KOJIMA Satoshi"]
   s.email       = ["skoji@mac.com"]
   s.homepage    = %q{http://github.com/skoji/gepub}
-  s.summary     = %q{a generic EPUB parser/generator.}
-  s.description = %q{gepub is a EPUB parser/generator. Generates EPUB2 opf. will support EPUB3 parse/generation}
+  s.summary     = %q{a generic EPUB library for Ruby.}
+  s.description = %q{gepub is a generic EPUB parser/generator. Generates and parse EPUB2 and EPUB3}
 
   s.rubyforge_project = "gepub"
 

data/lib/gepub/book.rb

@@ -4,7 +4,6 @@ require 'nokogiri'
 require 'zip/zip'
 require 'fileutils'
 
-
 module GEPUB
   class Book
     MIMETYPE='mimetype'
@@ -81,20 +80,25 @@ module GEPUB
       @toc.push({ :item => item, :text => text, :id => id})      
     end
 
-    def add_item(href, io = nil, id = nil, attributes = {})
-      item = @package.add_item(href,io,id,attributes)
+    def add_item(href, io_or_filename = nil, id = nil, attributes = {})
+      item = @package.add_item(href,io_or_filename,id,attributes)
       toc = @toc
       (class << item;self;end).send(:define_method, :toc_text,
                                     Proc.new { |text|
                                       toc.push(:item => item, :text => text, :id => nil)
                                       item
                                     })
+      (class << item;self;end).send(:define_method, :toc_text_with_id,
+                                    Proc.new { |text, id|
+                                      toc.push(:item => item, :text => text, :id => id)
+                                      item
+                                    })
       yield item if block_given?
       item
     end
 
-    def add_ordered_item(href, io = nil, id = nil, attributes = {})
-      item = @package.add_ordered_item(href,io,id,attributes)
+    def add_ordered_item(href, io_or_filename = nil, id = nil, attributes = {})
+      item = @package.add_ordered_item(href,io_or_filename,id,attributes)
       toc = @toc
       (class << item;self;end).send(:define_method, :toc_text,
                                     Proc.new { |text|
@@ -182,8 +186,9 @@ EOF
               doc.ol {
                 @toc.each {
                   |x|
+                  id = x[:id].nil? ? "" : "##{x[:id]}"
                   doc.li {
-                    doc.a({'href' => x[:item].href} ,x[:text])
+                    doc.a({'href' => x[:item].href + id} ,x[:text])
                   }
                 }
               }

data/lib/gepub/builder.rb

@@ -0,0 +1,127 @@
+module GEPUB
+  class Builder
+    include BuilderMixin
+    class MetaItem
+      def initialize(item)
+        @item = item
+      end
+
+      def apply_one_to_multi
+        false
+      end
+
+      def alt(alternates = {})
+        @item.add_alternates(alternates)
+      end
+
+      def file_as(name)
+        @item.set_file_as(name)
+      end
+
+      def seq(num)
+        @item.set_display_seq(num)
+      end
+
+      def group_position(num)
+        @item.set_group_position(num)
+      end
+
+      def id(val)
+        @item['id'] = val
+      end
+    end
+
+    def initialize(attributes = {},  &block)
+      @last_defined_item = nil
+      @book = Book.new
+      instance_eval &block
+      # TODO check @book's consistency
+      true
+    end
+
+    # define base methods.
+    GEPUB::Metadata::CONTENT_NODE_LIST.each {
+      |name|
+      define_method(name) { |val| @last_defined_item = MetaItem.new(@book.send("add_#{name}".to_sym, val, nil)) }
+    }
+
+    GEPUB::TITLE_TYPE::TYPES.each {
+      |type|
+      case type
+      when 'main'
+        methodname = 'title'
+      when 'short'
+        methodname = 'short_title'
+      when 'expanded'
+        methodname = 'expandend_title'
+      else
+        methodname = type
+      end
+      define_method(methodname) { |val| @last_defined_item = MetaItem.new(@book.add_title(val, nil, type)) }
+    }
+
+    def collection(val, count = 1)
+      @last_defined_item =
+        MetaItem.new(@book.add_title(val, nil, GEPUB::TITLE_TYPE::COLLECTION).set_group_position(count.to_s))
+    end
+
+    def creator(val, role = 'aut')
+      MetaItem.new(@book.add_creator(val, nil, role))
+    end
+
+    def creators(*vals)
+      @last_defined_item = vals.map {
+        |v|
+        name = v
+        role = ''
+        name,role = v[0], v[1] if Array === name
+        MetaItem.new(@book.add_creator(name, nil, role))
+      }
+    end
+
+    def contributors(*vals)
+      @last_defined_item = vals.map {
+        |v|
+        name = v
+        role = nil
+        name,role = v[0], v[1] if Array === name
+        MetaItem.new(@book.add_contributor(name, nil, role))
+      }
+    end
+
+    def publishers(*vals)
+      @last_defined_item = vals.map {
+        |v|
+        MetaItem.new(@book.add_publisher(v, nil))
+      }
+    end
+
+    def unique_identifier(val, id = 'BookID', scheme = 'nil')
+      @last_defined_item = MetaItem.new(@book.set_main_id(val, id, scheme))
+    end
+    
+    def alts(alt_vals = {})
+      raise "can't specify alts on single item" if ! Array === @last_defined_item
+      @last_defined_item.each_with_index {
+        |item, index| 
+        item.alt Hash[*(alt_vals.map{|k,v| [k,v[index]]}.flatten)]
+      }
+    end
+    
+    def contributor(val, role = nil)
+      MetaItem.new(@book.add_contributor(val, nil, role))
+    end
+
+    def generate_epub(path_to_epub)
+      @book.generate_epub(path_to_epub)
+    end
+
+    def resources(attributes = {}, &block)
+      ResourceBuilder.new(@book, attributes, &block)
+    end
+    
+    def generate_epub_stream
+      # TODO should implement
+    end
+  end
+end

data/lib/gepub/builder_mixin.rb

@@ -0,0 +1,29 @@
+module GEPUB
+  module BuilderMixin
+    def method_missing(name, *args)
+      if Array === @last_defined_item &&
+          @last_defined_item.size > 0 &&
+          @last_defined_item[0].respond_to?(name.to_sym)
+
+        if !(@last_defined_item[0].apply_one_to_multi ||
+             @last_defined_item.size != 1) &&
+            @last_defined_item.size != args.size
+          warn "appling #{args} to #{@last_defined_item}: length differs."
+        end
+
+        @last_defined_item.each_with_index {
+          |item, i|
+          if item.apply_one_to_multi && args.size == 1
+            item.send(name, args[0])
+          elsif !args[i].nil?
+            item.send(name, args[i])
+          end
+        }
+      elsif @last_defined_item.respond_to?(name.to_sym)
+        @last_defined_item.send(name, *args)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/gepub/item.rb

@@ -49,10 +49,19 @@ module GEPUB
       add_property('cover-image')
     end
 
+    def nav
+      add_property('nav')
+    end
+
     def add_raw_content(data)
       @content = data
     end
-    def add_content(io)
+    
+    def add_content(io_or_filename)
+      io = io_or_filename
+      if io_or_filename.class == String
+        io = File.new(io_or_filename)
+      end
       io.binmode
       @content = io.read
       self

data/lib/gepub/manifest.rb

@@ -44,11 +44,16 @@ module GEPUB
       @items.dup
     end
 
+    def items
+      @items.dup      
+    end
+    
     def item_by_href(href)
       @items_by_href[href]
     end
     
     def add_item(id,href,media_type, attributes = {})
+      id ||= @id_pool.generate_key(:prefix=>'item_'+ File.basename(href,'.*'), :without_count => true)
       @items[id] = item = Item.new(id,href,media_type,self, attributes)
       @items_by_href[href] = item
       item

data/lib/gepub/meta.rb

@@ -61,7 +61,7 @@ module GEPUB
       self
     end
 
-    ['title-type', 'identifier-type', 'display-seq', 'file-as', 'group-position'].each {
+    ['title-type', 'identifier-type', 'display-seq', 'file-as', 'group-position', 'role'].each {
       |name|
       methodbase = name.sub('-','_')
       define_method(methodbase + '=') { |val| refine(name, val); }
@@ -78,6 +78,14 @@ module GEPUB
       self
     end
 
+    def list_alternates
+      list = refiner_list('alternate-script').map {
+        |refiner|
+        [ refiner['xml:lang'], refiner.content ]
+      }
+      Hash[*list.flatten]
+    end
+
     def to_xml(builder, id_pool, ns = nil, additional_attr = {}, opf_version = '3.0')
       additional_attr ||= {}
       if @refiners.size > 0 && opf_version.to_f >= 3.0

data/lib/gepub/metadata.rb

@@ -5,7 +5,7 @@ require 'time'
 module GEPUB
   # metadata constants
   module TITLE_TYPE
-    ['main','subtitle', 'short', 'collection', 'edition','expanded'].each {
+    TYPES = ['main','subtitle', 'short', 'collection', 'edition','expanded'].each {
       |type|
       const_set(type.upcase, type)
     }
@@ -145,6 +145,13 @@ module GEPUB
       yield meta if block_given?
       meta
     end
+
+    def set_title(content, id = nil, title_type = nil)
+      title_clear
+      add_title(content, id, title_type)
+      yield meta if block_given?
+      meta
+    end
     
     def add_person(name, content, id = nil, role = 'aut')
       meta = add_metadata(name, content, id).refine('role', role)

data/lib/gepub/package.rb

@@ -29,7 +29,7 @@ module GEPUB
           if param[:without_count]
             k = prefix + suffix
             count -= 1
-            param[:without_count] = nil
+            param.delete(:without_count)
           else
             k = prefix + count.to_s + suffix
           end
@@ -122,10 +122,9 @@ module GEPUB
       item.add_properties 'cover-image'
     end
 
-    def add_item(href, io = nil, id = nil, attributes = {})
-      id ||= @id_pool.generate_key(:prefix=>'item', :suffix=>'_'+ File.basename(href,'.*'), :without_count => true)
+    def add_item(href, io_or_filename = nil, id = nil, attributes = {})
       item = @manifest.add_item(id, href, nil, attributes)
-      item.add_content(io) unless io.nil?
+      item.add_content(io_or_filename) unless io_or_filename.nil?
       @spine.push(item) if @ordered
       yield item if block_given?
       item
@@ -138,16 +137,27 @@ module GEPUB
       @ordered = nil
     end
 
-    def add_ordered_item(href, io = nil, id = nil, attributes = {})
+    def add_ordered_item(href, io_or_filename = nil, id = nil, attributes = {})
       raise 'do not call add_ordered_item within ordered block.' if @ordered
-      item = add_item(href, io, id, attributes)
+      item = add_item(href, io_or_filename, id, attributes)
       @spine.push(item)
       
       item
     end
 
+    def spine_items
+      spine.itemref_list.map {
+        |itemref|
+        @manifest.item_list[itemref.idref]
+      }
+    end
 
-    def method_missing(name, *args) 
+    def items
+      @manifest.item_list
+    end
+    
+    def method_missing(name, *args)
+      return @manifest.send(name.to_sym, *args) if [:item_by_href].member? name
       Metadata::CONTENT_NODE_LIST.each {
         |x|
         case name.to_s

data/lib/gepub/resource_builder.rb

@@ -0,0 +1,147 @@
+module GEPUB
+  class ResourceBuilder
+    include BuilderMixin
+    class ResourceItem
+      attr_reader :item
+      def initialize(item)
+        @item = item
+      end
+
+      def apply_one_to_multi
+        true
+      end
+
+      def media_type(val)
+        @item.set_media_type(val)
+      end
+      
+      def method_missing(name, *args)
+        @item.send(name.to_sym, *args)
+      end
+    end
+    
+    def initialize(book, attributes = {},  &block)
+      @last_defined_item = nil
+      @book = book
+      @file_postprocess = {}
+      @file_preprocess = {}
+      @files_postprocess = {}
+      @files_preprocess = {}
+      current_wd = Dir.getwd
+      Dir.chdir(attributes[:workdir]) unless attributes[:workdir].nil?
+      instance_eval &block
+      Dir.chdir current_wd
+      true
+    end
+
+    def ordered(&block)
+      @book.ordered {
+        instance_eval &block
+      }
+    end
+
+    def file(val)
+      raise "can't specify multiple files on file keyword" if Hash === val && val.length > 1
+
+      @file_preprocess.each {
+        |k,p|
+        p.call
+      }
+      @last_defined_item = ResourceItem.new(create_one_file(val))
+      @file_postprocess.each {
+        |k,p|
+        p.call
+      }
+    end
+
+    def files(*arg)
+      arg = arg[0] if arg.size == 1 && Hash === arg[0]
+      @files_preprocess.each {
+        |k,p|
+        p.call
+      }
+      @last_defined_item = arg.map {
+        |val|
+        ResourceItem.new(create_one_file(val))
+      }
+      @files_postprocess.each {
+        |k,p|
+        p.call
+      }
+    end
+
+    def cover_image(val)
+      file(val)
+      @last_defined_item.cover_image
+    end
+
+    def nav(val)
+      file(val)
+      @last_defined_item.nav
+    end
+
+    def heading(text, id = nil)
+      @last_defined_item.toc_text_with_id(text, id)
+    end
+
+    def with_media_type(*type)
+      raise 'with_media_type needs block.' unless block_given?
+      @file_postprocess['with_media_type'] = Proc.new { media_type(*type) }
+      @files_postprocess['with_media_type'] = Proc.new { media_type(*type) }
+      yield 
+      @file_postprocess.delete('with_media_type')
+      @files_postprocess.delete('with_media_type')
+    end
+
+    def fallback_group
+      raise 'fallback_group needs block.' unless block_given?
+      count = 0
+      before = nil
+
+      @files_preprocess['fallback_group'] = Proc.new { raise "can't use files within fallback_group" }
+
+      @file_preprocess['fallback_group'] = Proc.new {
+        before = @last_defined_item
+      }
+
+      @file_postprocess['fallback_group'] = Proc.new {
+        if count > 0
+          before.item.set_fallback(@last_defined_item.item.id)
+        end
+        count += 1
+      }
+      yield
+      @files_preprocess.delete('fallback_group')
+      @file_postprocess.delete('fallback_group')
+      @file_preprocess.delete('fallback_group')
+    end
+
+    def fallback_chain_files(*arg)
+      files(*arg)
+      @last_defined_item.inject(nil) {
+        |item1, item2|
+        if !item1.nil?
+          item1.item.set_fallback(item2.item.id)
+        end
+        item2
+      }
+    end
+    
+    private
+
+    def create_one_file(val)
+      name = val
+      io = val
+      if Hash === val 
+        name = val.first[0]
+        io = val.first[1]
+      end
+      if Array === val
+        name = val[0]
+        io = val[1]
+      end
+      @book.add_item(name, io)
+    end
+  end    
+
+end

data/lib/gepub/version.rb

@@ -1,3 +1,3 @@
 module GEPUB
-  VERSION = "0.6.2"
+  VERSION = "0.6.3"
 end

data/lib/gepub.rb

@@ -16,6 +16,10 @@ require 'gepub/package'
 require 'gepub/item'
 require 'gepub/book'
 require 'gepub/gepuber'
+require 'gepub/builder_mixin'
+require 'gepub/resource_builder'
+require 'gepub/builder'
+
 
 
 

data/spec/builder_spec.rb

@@ -0,0 +1,356 @@
+# -*- coding: utf-8 -*-
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'rubygems'
+describe GEPUB::Builder do
+  context 'metadata generating' do
+    it 'should generate language' do
+      builder = GEPUB::Builder.new {
+        language 'ja'
+      }
+      builder.instance_eval { @book.language }.to_s.should == 'ja'
+    end
+
+    it 'should generate uid' do
+      builder = GEPUB::Builder.new {
+        unique_identifier 'http://example.jp/as_url', 'BookID', 'url'
+      }
+      builder.instance_eval { @book.identifier }.to_s.should == 'http://example.jp/as_url'
+      builder.instance_eval { @book.identifier_list[0]['id']}.should == 'BookID'
+      builder.instance_eval { @book.identifier_list[0].identifier_type}.to_s.should == 'url'
+    end
+    
+    it 'should generate title' do
+      builder = GEPUB::Builder.new {
+        title 'The Book Title'
+      }
+      builder.instance_eval { @book.title }.to_s.should == 'The Book Title'
+      builder.instance_eval { @book.title.title_type }.to_s.should == 'main'
+    end
+
+    it 'should generate title with type ' do
+      builder = GEPUB::Builder.new {
+        subtitle 'the sub-title'
+      }
+      builder.instance_eval { @book.title }.to_s.should == 'the sub-title'
+      builder.instance_eval { @book.title.title_type }.to_s.should == 'subtitle'
+    end
+
+    it 'should generate collection title ' do
+      builder = GEPUB::Builder.new {
+        collection 'the collection', 3
+      }
+      builder.instance_eval { @book.title }.to_s.should == 'the collection'
+      builder.instance_eval { @book.title.title_type }.to_s.should == 'collection'
+      builder.instance_eval { @book.title.group_position }.to_s.should == '3'
+    end
+
+    it 'should refine title: alternates ' do
+      builder = GEPUB::Builder.new {
+        collection 'the collection', 3
+        alt 'ja' => 'シリーズ'
+      }
+      builder.instance_eval { @book.title }.to_s.should == 'the collection'
+      builder.instance_eval { @book.title.title_type }.to_s.should == 'collection'
+      builder.instance_eval { @book.title.list_alternates['ja'] }.to_s.should == 'シリーズ'
+    end
+
+    it 'should refine title: file_as ' do
+      builder = GEPUB::Builder.new {
+        title 'メインタイトル'
+        file_as 'main title'
+      }
+      builder.instance_eval { @book.title }.to_s.should == 'メインタイトル'
+      builder.instance_eval { @book.title.title_type }.to_s.should == 'main'
+      builder.instance_eval { @book.title.file_as }.to_s.should == 'main title'
+    end
+
+    it 'should refine title: alt and file_as ' do
+      builder = GEPUB::Builder.new {
+        title 'メインタイトル'
+        file_as 'main title'
+        alt 'en' => 'The Main Title'
+      }
+      builder.instance_eval { @book.title }.to_s.should == 'メインタイトル'
+      builder.instance_eval { @book.title.title_type }.to_s.should == 'main'
+      builder.instance_eval { @book.title.file_as }.to_s.should == 'main title'
+      builder.instance_eval { @book.title.list_alternates['en'] }.to_s.should == 'The Main Title'
+    end
+
+    it 'should generate creator ' do
+      builder = GEPUB::Builder.new {
+        creator 'The Main Author'
+      }
+      builder.instance_eval { @book.creator }.to_s.should == 'The Main Author'
+    end
+
+    it 'should generate creator with role' do
+      builder = GEPUB::Builder.new {
+        creator 'The Illustrator', 'ill'
+      }
+      builder.instance_eval { @book.creator }.to_s.should == 'The Illustrator'
+      builder.instance_eval { @book.creator.role}.to_s.should == 'ill'
+    end
+
+    it 'should generate contributor ' do
+      builder = GEPUB::Builder.new {
+        contributor 'contributor', 'edt'
+      }
+      builder.instance_eval { @book.contributor }.to_s.should == 'contributor'
+      builder.instance_eval { @book.contributor.role}.to_s.should == 'edt'
+    end
+
+    it 'should generate multiple creators ' do
+      builder = GEPUB::Builder.new {
+        creators 'First Author', 'Second Author', ['Third Person', 'edt']
+      }
+      builder.instance_eval { @book.creator_list }.size.should == 3
+      builder.instance_eval { @book.creator_list[0] }.to_s.should == 'First Author'
+      builder.instance_eval { @book.creator_list[1] }.to_s.should == 'Second Author'
+      builder.instance_eval { @book.creator_list[2] }.to_s.should == 'Third Person'
+      builder.instance_eval { @book.creator_list[2].role }.to_s.should == 'edt'
+    end
+
+    it 'should generate multiple creators, and then add file_as at once ' do
+      builder = GEPUB::Builder.new {
+        creators 'First Author', 'Second Author', ['Third Person', 'edt']
+        file_as '1st', '2nd', '3rd'
+      }
+      builder.instance_eval { @book.creator_list }.size.should == 3
+      builder.instance_eval { @book.creator_list[0] }.to_s.should == 'First Author'
+      builder.instance_eval { @book.creator_list[0].file_as }.to_s.should == '1st'
+      builder.instance_eval { @book.creator_list[1] }.to_s.should == 'Second Author'
+      builder.instance_eval { @book.creator_list[1].file_as }.to_s.should == '2nd'
+      builder.instance_eval { @book.creator_list[2] }.to_s.should == 'Third Person'
+      builder.instance_eval { @book.creator_list[2].file_as }.to_s.should == '3rd'
+      builder.instance_eval { @book.creator_list[2].role }.to_s.should == 'edt'
+    end
+
+
+    it 'should generate multiple creators, and multiple alternates ' do
+      builder = GEPUB::Builder.new {
+        creators 'First Author', 'Second Author', ['Third Person', 'edt']
+        alts(
+             'ja' => ['最初','二番目', '三番目'],
+             'en' => ['first','second','third']
+             )
+      }
+      builder.instance_eval { @book.creator_list }.size.should == 3
+      builder.instance_eval { @book.creator_list[0] }.to_s.should == 'First Author'
+      builder.instance_eval { @book.creator_list[0].list_alternates['ja'] }.to_s.should == '最初'
+      builder.instance_eval { @book.creator_list[0].list_alternates['en'] }.to_s.should == 'first'
+      builder.instance_eval { @book.creator_list[1] }.to_s.should == 'Second Author'
+      builder.instance_eval { @book.creator_list[1].list_alternates['ja'] }.to_s.should == '二番目'
+      builder.instance_eval { @book.creator_list[1].list_alternates['en'] }.to_s.should == 'second'
+      builder.instance_eval { @book.creator_list[2] }.to_s.should == 'Third Person'
+      builder.instance_eval { @book.creator_list[2].list_alternates['ja'] }.to_s.should == '三番目'
+      builder.instance_eval { @book.creator_list[2].list_alternates['en'] }.to_s.should == 'third'
+      builder.instance_eval { @book.creator_list[2].role }.to_s.should == 'edt'
+    end
+  end
+  context 'resources' do
+    it 'should add a file to book' do
+      workdir = File.join(File.dirname(__FILE__),'fixtures', 'builder')
+      builder = GEPUB::Builder.new {
+        resources(:workdir => workdir)  {
+          file('text/memo.txt')
+        }
+      }
+      builder.instance_eval{ @book.item_by_href('text/memo.txt') }.should_not be_nil
+      builder.instance_eval{ @book.item_by_href('text/memo.txt').content.chomp }.should == 'just a plain text.'
+    end
+
+    it 'should add files to book' do
+      workdir = File.join(File.dirname(__FILE__),'fixtures', 'builder')
+      builder = GEPUB::Builder.new {
+        resources(:workdir => workdir)  {
+          files('text/memo.txt','text/cover.xhtml')
+        }
+      }
+      builder.instance_eval{ @book.item_by_href('text/memo.txt') }.should_not be_nil
+      builder.instance_eval{ @book.item_by_href('text/memo.txt').content.chomp }.should == 'just a plain text.'
+      builder.instance_eval{ @book.item_by_href('text/cover.xhtml') }.should_not be_nil
+    end
+
+    it 'should add files to book from IO object' do
+      io = File.new(File.join(File.dirname(__FILE__),'fixtures', 'builder', 'text', 'memo.txt'))
+      builder = GEPUB::Builder.new {
+        resources()  {
+          file('text/memo.txt' => io)
+        }
+      }
+      builder.instance_eval{ @book.item_by_href('text/memo.txt') }.should_not be_nil
+      builder.instance_eval{ @book.item_by_href('text/memo.txt').content.chomp }.should == 'just a plain text.'
+    end
+
+    it 'should add image file as cover' do
+      workdir = File.join(File.dirname(__FILE__),'fixtures', 'builder')
+      builder = GEPUB::Builder.new {
+        resources(:workdir => workdir)  {
+          cover_image 'img/cover.jpg'
+        }
+      }
+      builder.instance_eval{ @book.item_by_href('img/cover.jpg') }.should_not be_nil
+      builder.instance_eval{ @book.item_by_href('img/cover.jpg').properties.member? 'cover-image' }.should ==  true
+    end
+
+    it 'should add file as nav' do
+      workdir = File.join(File.dirname(__FILE__),'fixtures', 'builder')
+      builder = GEPUB::Builder.new {
+        resources(:workdir => workdir)  {
+          nav 'text/nav.xhtml'
+        }
+      }
+      builder.instance_eval{ @book.item_by_href('text/nav.xhtml') }.should_not be_nil
+      builder.instance_eval{ @book.item_by_href('text/nav.xhtml').properties.member? 'nav' }.should ==  true
+    end
+
+    it 'should specify mediatype' do
+      workdir = File.join(File.dirname(__FILE__),'fixtures', 'builder')
+      builder = GEPUB::Builder.new {
+        resources(:workdir => workdir)  {
+          file('resources/noise.m4')
+          media_type('audio/mp4')
+        }
+      }
+      builder.instance_eval{ @book.item_by_href('resources/noise.m4') }.should_not be_nil        
+      builder.instance_eval{ @book.item_by_href('resources/noise.m4').media_type }.should == 'audio/mp4'
+    end
+
+    it 'should specify mediatype to files' do
+      workdir = File.join(File.dirname(__FILE__),'fixtures', 'builder')
+      builder = GEPUB::Builder.new {
+        resources(:workdir => workdir)  {
+          files('resources/noise.m4', 'resources/noise_2.m4a')
+          media_type('audio/mp4')
+        }
+      }
+      builder.instance_eval{ @book.item_by_href('resources/noise.m4') }.should_not be_nil        
+      builder.instance_eval{ @book.item_by_href('resources/noise.m4').media_type }.should == 'audio/mp4'
+
+      builder.instance_eval{ @book.item_by_href('resources/noise_2.m4a') }.should_not be_nil        
+      builder.instance_eval{ @book.item_by_href('resources/noise_2.m4a').media_type }.should == 'audio/mp4'
+    end
+
+    it 'should specify mediatype to files using with_media_type' do
+      workdir = File.join(File.dirname(__FILE__),'fixtures', 'builder')
+      builder = GEPUB::Builder.new {
+        resources(:workdir => workdir)  {
+          with_media_type('audio/mp4') {
+            file('resources/noise.m4')
+            file('resources/noise_2.m4a')
+          }
+          file('text/cover.xhtml')
+        }
+      }
+      builder.instance_eval{ @book.item_by_href('resources/noise.m4') }.should_not be_nil        
+      builder.instance_eval{ @book.item_by_href('resources/noise.m4').media_type }.should == 'audio/mp4'
+
+      builder.instance_eval{ @book.item_by_href('resources/noise_2.m4a') }.should_not be_nil        
+      builder.instance_eval{ @book.item_by_href('resources/noise_2.m4a').media_type }.should == 'audio/mp4'
+
+      builder.instance_eval{ @book.item_by_href('text/cover.xhtml') }.should_not be_nil        
+      builder.instance_eval{ @book.item_by_href('text/cover.xhtml').media_type }.should == 'application/xhtml+xml'
+    end
+    
+    it 'should add files to book in spine' do
+      workdir = File.join(File.dirname(__FILE__),'fixtures', 'builder')
+      builder = GEPUB::Builder.new {
+        resources(:workdir => workdir)  {
+          ordered {
+            file('text/cover.xhtml')
+            file('text/memo.txt')
+          }
+        }
+      }
+      builder.instance_eval{ @book.item_by_href('text/cover.xhtml') }.should_not be_nil
+      builder.instance_eval{ @book.spine_items[0].href }.should ==  'text/cover.xhtml'
+      builder.instance_eval{ @book.item_by_href('text/memo.txt') }.should_not be_nil
+      builder.instance_eval{ @book.spine_items[1].href }.should ==  'text/memo.txt'
+    end
+
+    it 'should add files and heading' do
+      workdir = File.join(File.dirname(__FILE__),'fixtures', 'builder')
+      builder = GEPUB::Builder.new {
+        resources(:workdir => workdir)  {
+          ordered {
+            file('text/cover.xhtml')
+            heading 'cover page'
+            file('text/memo.txt')
+            heading 'memo text'
+          }
+        }
+      }
+      builder.instance_eval{ @book.item_by_href('text/cover.xhtml') }.should_not be_nil
+      builder.instance_eval{ @book.spine_items[0].href }.should ==  'text/cover.xhtml'
+      builder.instance_eval{ @book.item_by_href('text/memo.txt') }.should_not be_nil
+      builder.instance_eval{ @book.spine_items[1].href }.should ==  'text/memo.txt'
+      builder.instance_eval{ @book.instance_eval { @toc[0][:item].href }}.should == 'text/cover.xhtml'
+      builder.instance_eval{ @book.instance_eval { @toc[0][:text] }}.should == 'cover page'
+      builder.instance_eval{ @book.instance_eval { @toc[1][:item].href }}.should == 'text/memo.txt'
+      builder.instance_eval{ @book.instance_eval { @toc[1][:text] }}.should == 'memo text'
+    end
+
+    it 'should handle fallback chain' do
+      # in this test, do not supply 
+      workdir = File.join(File.dirname(__FILE__),'fixtures', 'builder')
+      builder = GEPUB::Builder.new {
+        resources(:workdir => workdir)  {
+          fallback_group {
+            file 'chap3_docbook.xhtml' => nil
+            media_type('application/docbook+xml')
+            file 'chap3.xml' => nil
+            media_type("application/z3986-auth+xml")
+            file 'chap3.xhtml' => nil
+          }
+        }
+      }
+      builder.instance_eval {
+        fallbackid = @book.item_by_href('chap3_docbook.xhtml').fallback
+        @book.items[fallbackid].href.should == 'chap3.xml'
+
+        fallbackid = @book.items[fallbackid].fallback
+        @book.items[fallbackid].href.should == 'chap3.xhtml'        
+      }
+    end
+
+    it 'should handle fallback chain with fallback_chain_files' do
+      # in this test, do not supply 
+      workdir = File.join(File.dirname(__FILE__),'fixtures', 'builder')
+      builder = GEPUB::Builder.new {
+        resources(:workdir => workdir)  {
+          fallback_chain_files 'chap3_docbook.xhtml' => nil, 'chap3.xml' => nil, 'chap3.xhtml' => nil
+        }
+      }
+      builder.instance_eval {
+        fallbackid = @book.item_by_href('chap3_docbook.xhtml').fallback
+        @book.items[fallbackid].href.should == 'chap3.xml'
+
+        fallbackid = @book.items[fallbackid].fallback
+        @book.items[fallbackid].href.should == 'chap3.xhtml'        
+      }
+    end
+
+    it 'should handle fallback chain with fallback_chain_files in with_media_type' do
+      # in this test, do not supply 
+      workdir = File.join(File.dirname(__FILE__),'fixtures', 'builder')
+      builder = GEPUB::Builder.new {
+        resources(:workdir => workdir)  {
+          with_media_type('application/docbook+xml', 'application/z3986-auth+xml', 'application/xhtml+xml') {
+            fallback_chain_files 'chap3_docbook.xhtml' => nil, 'chap3.xml' => nil, 'chap3.xhtml' => nil
+          }
+        }
+      }
+      builder.instance_eval {
+        @book.item_by_href('chap3_docbook.xhtml').media_type.should == 'application/docbook+xml'
+        fallbackid = @book.item_by_href('chap3_docbook.xhtml').fallback
+        @book.items[fallbackid].href.should == 'chap3.xml'
+        @book.items[fallbackid].media_type.should == 'application/z3986-auth+xml'
+
+        fallbackid = @book.items[fallbackid].fallback
+        @book.items[fallbackid].href.should == 'chap3.xhtml'        
+        @book.items[fallbackid].media_type.should == 'application/xhtml+xml'
+      }
+    end
+
+  end
+end

data/spec/example_spec.rb

@@ -3,7 +3,42 @@ require File.dirname(__FILE__) + '/spec_helper.rb'
 require 'rubygems'
 
 describe 'GEPUB usage' do
+  context 'On using Builder' do
+  end
+  
   context 'On generating EPUB' do
+    it 'should generate simple EPUB3 with Builder' do
+      workdir = File.join(File.dirname(__FILE__),  'fixtures', 'testdata')
+      builder = GEPUB::Builder.new {
+        unique_identifier 'http:/example.jp/bookid_in_url', 'BookID', 'URL'
+        language 'ja'
+        title 'GEPUBサンプル文書'
+        file_as 'GEPUB Sample Book'
+        alt 'en' => 'GEPUB Sample Book (Japanese)',
+        'el' => 'GEPUB δείγμα (Ιαπωνικά)',
+        'th' => 'GEPUB ตัวอย่าง (ญี่ปุ่น)'
+
+        subtitle 'これはあくまでサンプルです'
+        alt 'en' => 'This book is just a sample'
+        creator '小嶋智'
+        contributors 'Denshobu', 'Asagaya Densho', 'Shonan Densho Teidan', 'eMagazine Torutaru'
+        resources(:workdir => workdir) {
+          cover_image 'img/image1.jpg' => 'image1.jpg'
+          ordered {
+            file 'text/chap1.xhtml' => StringIO.new('<html xmlns="http://www.w3.org/1999/xhtml"><head><title>c1</title></head><body><p>the first page</p></body></html>')
+            heading 'Chapter 1'
+            file 'text/chap1-1.xhtml' => StringIO.new('<html xmlns="http://www.w3.org/1999/xhtml"><head><title>c2</title></head><body><p>the second page</p></body></html>')
+            file 'text/chap2.html' => StringIO.new('<html xmlns="http://www.w3.org/1999/xhtml"><head><title>c3</title></head><body><p>the third page</p></body></html>')
+            heading 'Chapter 2'
+          }
+        }
+      }
+      epubname = File.join(File.dirname(__FILE__), 'example_test_with_builder.epub')
+      builder.generate_epub(epubname)
+      jar = File.join(File.dirname(__FILE__), 'fixtures/epubcheck-3.0b4/epubcheck-3.0b4.jar')    
+      system 'java' '-jar', jar, epubname
+    end
+
     it 'should generate simple EPUB3 with rather complicated matadata' do
       book = GEPUB::Book.new
       book.set_main_id('http:/example.jp/bookid_in_url', 'BookID', 'URL')
@@ -33,10 +68,7 @@ describe 'GEPUB usage' do
       book.add_contributor('電子雑誌トルタル').set_display_seq(4).add_alternates('en' => 'eMagazine Torutaru')
 
       imgfile = File.join(File.dirname(__FILE__),  'fixtures', 'testdata', 'image1.jpg')
-      File.open(imgfile) do
-        |io|
-        book.add_item('img/image1.jpg',io).cover_image
-      end
+      book.add_item('img/image1.jpg',imgfile).cover_image
       
       # within ordered block, add_item will be added to spine.
       book.ordered {

data/spec/fixtures/builder/text/cover.xhtml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+	<title>title</title>
+  </head>
+  <body>
+	<div class="cover_wrap">
+	<img class="cover" src="img/cover.jpg" alt="cover" />
+	</div>
+  </body>
+</html>

data/spec/fixtures/builder/text/memo.txt

@@ -0,0 +1 @@
+just a plain text.

data/spec/fixtures/builder/text/nav.xhtml

@@ -0,0 +1,12 @@
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops">
+<head></head>
+<body>
+<nav epub:type="toc" id="toc">
+  <h1>Table of contents</h1>
+  <ol>
+    <li><a href="foobar.xhtml">Chapter 1</a> </li>
+    <li> <a href="barbar.xhtml">Chapter 2</a></li>
+  </ol>
+</nav>
+</body>
+</html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gepub
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-20 00:00:00.000000000 Z
+date: 2012-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70172284071640 !ruby/object:Gem::Requirement
+  requirement: &70335408467760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '2'
   type: :development
   prerelease: false
-  version_requirements: *70172284071640
+  version_requirements: *70335408467760
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70172284071140 !ruby/object:Gem::Requirement
+  requirement: &70335408467260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70172284071140
+  version_requirements: *70335408467260
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: &70172284070680 !ruby/object:Gem::Requirement
+  requirement: &70335408466800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,9 +43,9 @@ dependencies:
         version: 0.9.6
   type: :runtime
   prerelease: false
-  version_requirements: *70172284070680
-description: gepub is a EPUB parser/generator. Generates EPUB2 opf. will support EPUB3
-  parse/generation
+  version_requirements: *70335408466800
+description: gepub is a generic EPUB parser/generator. Generates and parse EPUB2 and
+  EPUB3
 email:
 - skoji@mac.com
 executables:
@@ -60,21 +60,32 @@ files:
 - README.md
 - Rakefile
 - bin/gepuber
+- examples/builder_example.rb
 - examples/generate_example.rb
 - examples/image1.jpg
 - gepub.gemspec
 - lib/gepub.rb
 - lib/gepub/book.rb
+- lib/gepub/builder.rb
+- lib/gepub/builder_mixin.rb
 - lib/gepub/gepuber.rb
 - lib/gepub/item.rb
 - lib/gepub/manifest.rb
 - lib/gepub/meta.rb
 - lib/gepub/metadata.rb
 - lib/gepub/package.rb
+- lib/gepub/resource_builder.rb
 - lib/gepub/spine.rb
 - lib/gepub/version.rb
 - lib/gepub/xml_util.rb
+- spec/builder_spec.rb
 - spec/example_spec.rb
+- spec/fixtures/builder/img/cover.jpg
+- spec/fixtures/builder/resources/noise.m4
+- spec/fixtures/builder/resources/noise_2.m4a
+- spec/fixtures/builder/text/cover.xhtml
+- spec/fixtures/builder/text/memo.txt
+- spec/fixtures/builder/text/nav.xhtml
 - spec/fixtures/epubcheck-3.0b4/COPYING.txt
 - spec/fixtures/epubcheck-3.0b4/README.txt
 - spec/fixtures/epubcheck-3.0b4/epubcheck-3.0b4.jar
@@ -118,9 +129,16 @@ rubyforge_project: gepub
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: a generic EPUB parser/generator.
+summary: a generic EPUB library for Ruby.
 test_files:
+- spec/builder_spec.rb
 - spec/example_spec.rb
+- spec/fixtures/builder/img/cover.jpg
+- spec/fixtures/builder/resources/noise.m4
+- spec/fixtures/builder/resources/noise_2.m4a
+- spec/fixtures/builder/text/cover.xhtml
+- spec/fixtures/builder/text/memo.txt
+- spec/fixtures/builder/text/nav.xhtml
 - spec/fixtures/epubcheck-3.0b4/COPYING.txt
 - spec/fixtures/epubcheck-3.0b4/README.txt
 - spec/fixtures/epubcheck-3.0b4/epubcheck-3.0b4.jar