gepub 0.6.8.5 → 0.6.8.6

data/README.md

@@ -1,4 +1,4 @@
-# gepub  [<img src="https://secure.travis-ci.org/skoji/gepub.png" />](http://travis-ci.org/skoji/gepub) [<img src="https://gemnasium.com/skoji/gepub.png" />](https://gemnasium.com/skoji/gepub)
+# gepub  [<img src="https://secure.travis-ci.org/skoji/gepub.png" />](http://travis-ci.org/skoji/gepub) 
 
 * http://en.skoji.jp/category/gepub/
 

data/gepub.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "rspec", "~> 2"
+  s.add_development_dependency "rspec", "~> 2.11"
   s.add_runtime_dependency "nokogiri", "~> 1.5.0"
   s.add_runtime_dependency "rubyzip", "~> 0.9.7"
 end

data/lib/gepub/book.rb

@@ -104,41 +104,9 @@ module GEPUB
       package_path = nil
       Zip::ZipInputStream::open_buffer(io) {
         |zis|
-        while entry = zis.get_next_entry
-          if !entry.directory?
-            files[entry.name] = zis.read
-            case entry.name
-            when MIMETYPE then
-              if files[MIMETYPE] != MIMETYPE_CONTENTS
-                warn "#{MIMETYPE} is not valid: should be #{MIMETYPE_CONTENTS} but was #{files[MIMETYPE]}"
-              end
-              files.delete(MIMETYPE)
-            when CONTAINER then
-              package_path = rootfile_from_container(files[CONTAINER])
-              files.delete(CONTAINER)
-            when ROOTFILE_PATTERN then
-              package = Package.parse_opf(files[entry.name], entry.name)
-              files.delete(entry.name)
-            end
-          end
-        end
-
-        if package.nil?
-          raise 'this container do not cotains publication information file'
-        end
-        
-        if package_path != package.path
-          warn 'inconsistend EPUB file: container says opf is #{package_path}, but actually #{package.path}'
-        end
-        
-        files.each {
-          |k, content|
-          item = package.manifest.item_by_href(k.sub(/^#{package.contents_prefix}/,''))
-          if !item.nil?
-            files.delete(k)
-            item.add_raw_content(content)
-          end
-        }
+        package, package_path = parse_container(zis, files)
+        check_consistency_of_package(package, package_path)
+        parse_files_into_package(files, package)
         book = Book.new(package.path)
         book.instance_eval { @package = package; @optional_files = files }
         book
@@ -226,8 +194,8 @@ module GEPUB
       items[@package.bindings.handler_by_media_type[media_type]]
     end
 
-    def method_missing(name,*args)
-      @package.send(name, *args)
+    def method_missing(name,*args, &block)
+      @package.send(name, *args, &block)
     end
 
     # should call ordered() with block.
@@ -239,34 +207,8 @@ module GEPUB
     # clenup and maintain consistency of metadata and items included in the Book
     # object. 
     def cleanup
-      if version.to_f < 3.0 || @package.epub_backward_compat
-        if @package.manifest.item_list.select {
-          |x,item|
-          item.media_type == 'application/x-dtbncx+xml'
-        }.size == 0
-          if (@toc.size == 0)
-            @toc << { :item => @package.manifest.item_list[@package.spine.itemref_list[0].idref] }
-          end
-          add_item('toc.ncx', StringIO.new(ncx_xml), 'ncx')
-        end
-      end
-
-      if version.to_f >=3.0
-        @package.metadata.set_lastmodified
-        
-        if @package.manifest.item_list.select {
-          |href, item|
-          (item.properties||[]).member? 'nav'
-          }.size == 0
-          generate_nav_doc
-        end
-        
-        @package.spine.remove_with_idlist @package.manifest.item_list.map {
-          |href, item|
-          item.fallback
-        }.reject(&:nil?)
-
-      end
+      cleanup_for_epub2
+      cleanup_for_epub3
     end
 
     # write EPUB to stream specified by the argument.
@@ -388,5 +330,80 @@ EOF
       }
       builder.to_xml(:encoding => 'utf-8')
     end
+    
+    private
+    def self.parse_container(zis, files) 
+      package_path = nil
+      package = nil
+      while entry = zis.get_next_entry
+        if !entry.directory?
+          files[entry.name] = zis.read
+          case entry.name
+          when MIMETYPE then
+            if files[MIMETYPE] != MIMETYPE_CONTENTS
+              warn "#{MIMETYPE} is not valid: should be #{MIMETYPE_CONTENTS} but was #{files[MIMETYPE]}"
+            end
+            files.delete(MIMETYPE)
+          when CONTAINER then
+            package_path = rootfile_from_container(files[CONTAINER])
+            files.delete(CONTAINER)
+          when ROOTFILE_PATTERN then
+            package = Package.parse_opf(files[entry.name], entry.name)
+            files.delete(entry.name)
+          end
+        end
+      end
+      return package, package_path
+    end
+
+    def self.check_consistency_of_package(package, package_path)
+      if package.nil?
+        raise 'this container do not cotains publication information file'
+      end
+
+      if package_path != package.path
+        warn 'inconsistend EPUB file: container says opf is #{package_path}, but actually #{package.path}'
+      end
+    end
+    def self.parse_files_into_package(files, package)
+      files.each {
+        |k, content|
+        item = package.manifest.item_by_href(k.sub(/^#{package.contents_prefix}/,''))
+        if !item.nil?
+          files.delete(k)
+          item.add_raw_content(content)
+        end
+      }
+    end
+    def  cleanup_for_epub2
+      if version.to_f < 3.0 || @package.epub_backward_compat
+        if @package.manifest.item_list.select {
+          |x,item|
+          item.media_type == 'application/x-dtbncx+xml'
+        }.size == 0
+          if (@toc.size == 0)
+            @toc << { :item => @package.manifest.item_list[@package.spine.itemref_list[0].idref] }
+          end
+          add_item('toc.ncx', StringIO.new(ncx_xml), 'ncx')
+        end
+      end
+    end
+    def cleanup_for_epub3
+      if version.to_f >=3.0
+        @package.metadata.set_lastmodified
+        
+        if @package.manifest.item_list.select {
+          |href, item|
+          (item.properties||[]).member? 'nav'
+          }.size == 0
+          generate_nav_doc
+        end
+        
+        @package.spine.remove_with_idlist @package.manifest.item_list.map {
+          |href, item|
+          item.fallback
+        }.reject(&:nil?)
+      end
+    end
   end
 end

data/lib/gepub/builder_mixin.rb

@@ -1,6 +1,6 @@
 module GEPUB
   module BuilderMixin
-    def method_missing(name, *args)
+    def method_missing(name, *args, &block)
       if Array === @last_defined_item &&
           @last_defined_item.size > 0 &&
           @last_defined_item[0].respond_to?(name.to_sym)
@@ -20,7 +20,7 @@ module GEPUB
           end
         }
       elsif @last_defined_item.respond_to?(name.to_sym)
-        @last_defined_item.send(name, *args)
+        @last_defined_item.send(name, *args, &block)
       else
         super
       end

data/lib/gepub/meta.rb

@@ -48,7 +48,7 @@ module GEPUB
 
     # add a refiner.
     def add_refiner(property, content, attributes = {})
-      (@refiners[property] ||= []) << refiner = Meta.new('meta', content, @parent, { 'property' => property }.merge(attributes)) unless content.nil?
+      (@refiners[property] ||= []) <<  Meta.new('meta', content, @parent, { 'property' => property }.merge(attributes)) unless content.nil?
       self
     end
 
@@ -69,6 +69,14 @@ module GEPUB
       define_method(methodbase) { refiner(name) }
     }
 
+    def lang=(lang)
+      @attributes['xml:lang'] = lang
+    end
+
+    def lang
+      @attributes['xml:lang']
+    end
+    
     # add alternate script refiner.
     def add_alternates(alternates = {})
       alternates.each {

data/lib/gepub/meta_array.rb

@@ -0,0 +1,10 @@
+class Array
+  def sort_as_meta
+    i = 0
+    sort_by {
+        |v|
+        seq = v.display_seq
+        [ seq && seq.to_s.to_i || 2 ** (0.size * 8 - 2) - 1, i += 1]
+    }
+  end
+end

data/lib/gepub/metadata.rb

@@ -12,6 +12,11 @@ module GEPUB
   end
   # Holds data in /package/metadata 
   class Metadata
+    class NilContent
+      def self.content
+        nil
+      end
+    end
     include XMLUtil
     attr_accessor :opf_version
     # parse metadata element. metadata_xml should be Nokogiri::XML::Node object.
@@ -23,18 +28,26 @@ module GEPUB
           @namespaces = @xml.namespaces
           CONTENT_NODE_LIST.each {
             |node|
-            i = 0
-            @content_nodes[node] = parse_node(DC_NS, node).sort_by {
-              |v|
-              [v.refiner('display-seq').to_s.to_i || 2 ** (0.size * 8 - 2) - 1, i += 1]
-            }              
+            @content_nodes[node] = parse_node(DC_NS, node).sort_as_meta
           }
           @xml.xpath("#{ns_prefix(OPF_NS)}:meta[not(@refines) and @property]", @namespaces).each {
             |node|
-            @meta[node['property']] = create_meta(node)
+            (@content_nodes['meta'] ||= []) << create_meta(node)
           }
 
           @oldstyle_meta = parse_opf2_meta
+
+          meta_list.each {
+            |metanode|
+            case metanode['property']
+            when 'rendition:layout'
+              @layout = metanode
+            when 'rendition:orientation'          
+              @orientation = metanode
+            when 'rendition:spread'
+              @spread = metanode
+            end
+          }
         }
       }
     end
@@ -43,15 +56,20 @@ module GEPUB
       @id_pool = id_pool
       @metalist = {}
       @content_nodes = {}
-      @meta = {}
       @oldstyle_meta = []
       @opf_version = opf_version
       @namespaces = { 'xmlns:dc' =>  DC_NS }
       @namespaces['xmlns:opf'] = OPF_NS if @opf_version.to_f < 3.0
+      @default_layout = 'reflowable'
+      @default_orientation = 'auto'
+      @spread = 'auto'
+      @layout = NilContent
+      @orientation = NilContent
+      @spread = NilContent
       yield self if block_given?
     end
 
-    def to_xml(builder)
+    def to_xml(builder) 
       builder.metadata(@namespaces) {
         @content_nodes.each {
           |name, list|
@@ -86,7 +104,7 @@ module GEPUB
     
     CONTENT_NODE_LIST = ['identifier','title', 'language', 'contributor', 'creator', 'coverage', 'date','description','format','publisher','relation','rights','source','subject','type'].each {
       |node|
-      define_method(node + '_list') { @content_nodes[node].dup }
+      define_method(node + '_list') { @content_nodes[node].dup.sort_as_meta }
       define_method(node + '_clear') {
         if !@content_nodes[node].nil?
           @content_nodes[node].each { |x| unregister_meta(x) };
@@ -115,6 +133,17 @@ module GEPUB
       }
     }
 
+    def meta_list
+      (@content_nodes['meta'] || []).sort_as_meta.dup
+    end
+
+    def meta_clear
+      if !@content_nodes['meta'].nil?
+        @content_nodes['meta'].each { |x| unregister_meta(x) };
+        @content_nodes['meta'] = []
+      end
+    end
+
     def title
       if !@content_nodes['title'].nil?
         @content_nodes['title'].each do
@@ -127,12 +156,13 @@ module GEPUB
     
     def get_first_node(node)
       if !@content_nodes[node].nil? && @content_nodes[node].size > 0
-        @content_nodes[node][0]
+        @content_nodes[node].sort_as_meta[0]
       end
     end
 
-    def add_identifier(string, id, type=nil)
-      raise 'id #{id} is already in use' if @id_pool[id]
+    def add_identifier(string, id=nil, type=nil)
+      id = @id_pool.generate_key(:prefix => 'BookId') if id.nil?
+      raise "id #{id} is already in use" if @id_pool[id]
       identifier = add_metadata('identifier', string, id)
       identifier.refine('identifier-type', type) unless type.nil?
       identifier
@@ -147,12 +177,13 @@ module GEPUB
         |x|
         return x.content if x['id'] == id
       }
+      return nil
     end
     
     def add_metadata(name, content, id = nil, itemclass = Meta)
       meta = itemclass.new(name, content, self, { 'id' => id })
       (@content_nodes[name] ||= []) << meta
-      yield self if block_given?
+      yield meta if block_given?
       meta
     end
 
@@ -227,15 +258,42 @@ module GEPUB
         @id_pool[meta['id']] = nil
       end
     end
+
+    def rendition_layout
+      @layout.content || @default_layout
+    end
+
+    def rendition_layout=(val)
+      @layout = Meta.new('meta', val, self, { 'property' => 'rendition:layout' })
+      (@content_nodes['meta'] ||= []) << @layout
+    end
+
+    def rendition_orientation
+      @orientation.content || @default_orientation
+    end
+
+    def rendition_orientation=(val)
+      @orientation = Meta.new('meta', val, self, { 'property' => 'rendition:orientation' })
+      (@content_nodes['meta'] ||= []) << @orientation
+    end
+
+    def rendition_spread
+      @spread.content || @default_spread
+    end
+
+    def rendition_spread=(val)
+      @spread = Meta.new('meta', val, self, { 'property' => 'rendition:spread' })
+      (@content_nodes['meta'] ||= []) << @spread
+    end
     
     private
     def parse_node(ns, node)
       @xml.xpath("#{ns_prefix(ns)}:#{node}", @namespaces).map {
-        |node|
-        create_meta(node)
+        |n|
+        create_meta(n)
       }
     end
-
+    
     def create_meta(node)
       Meta.new(node.name, node.content, self, attr_to_hash(node.attributes), collect_refiners(node['id']))
     end

data/lib/gepub/package.rb

@@ -7,12 +7,21 @@ module GEPUB
   class Package
     include XMLUtil
     extend Forwardable
-    attr_accessor :path, :metadata, :manifest, :spine, :bindings, :epub_backward_compat, :contents_prefix
+    attr_accessor :path, :metadata, :manifest, :spine, :bindings, :epub_backward_compat, :contents_prefix, :prefixes 
     def_delegators :@manifest, :item_by_href
     def_delegators :@metadata, *Metadata::CONTENT_NODE_LIST.map {
       |x|
       ["#{x}", "#{x}_list", "set_#{x}", "#{x}=", "add_#{x}"]
     }.flatten
+    def_delegators :@metadata, :set_lastmodified
+    def_delegators :@metadata, :lastmodified
+    def_delegators :@metadata, :rendition_layout
+    def_delegators :@metadata, :rendition_layout=
+    def_delegators :@metadata, :rendition_orientation
+    def_delegators :@metadata, :rendition_orientation=
+    def_delegators :@metadata, :rendition_spread
+    def_delegators :@metadata, :rendition_spread=
+
     def_delegators :@spine, :page_progression_direction=
     def_delegators :@spine, :page_progression_direction
 
@@ -59,6 +68,12 @@ module GEPUB
         @pool[k] = v
       end
     end
+
+    def parse_prefixes(prefix)
+      return {} if prefix.nil?
+      m = prefix.scan(/([\S]+): +(\S+)[\s]*/)
+      Hash[*m.flatten]
+    end
     
     # parse OPF data. opf should be io or string object.
     def self.parse_opf(opf, path)
@@ -73,6 +88,7 @@ module GEPUB
           @manifest = Manifest.parse(@xml.at_xpath("//#{ns_prefix(OPF_NS)}:manifest"), @attributes['version'], @id_pool)
           @spine = Spine.parse(@xml.at_xpath("//#{ns_prefix(OPF_NS)}:spine"), @attributes['version'], @id_pool)
           @bindings = Bindings.parse(@xml.at_xpath("//#{ns_prefix(OPF_NS)}:bindings"))
+          @prefixes = parse_prefixes(@attributes['prefix'])
         }
       }
     end
@@ -86,6 +102,7 @@ module GEPUB
       end
       @contents_prefix = File.dirname(@path).sub(/^\.$/,'')
       @contents_prefix = @contents_prefix + '/' if @contents_prefix.size > 0
+      @prefixes = {}
       @namespaces = {'xmlns' => OPF_NS }
       @attributes = attributes
       @attributes['version'] ||= '3.0'
@@ -120,10 +137,15 @@ module GEPUB
     end
     
     def identifier=(identifier)
-      set_main_id(identifier, nil, 'URL')
+      set_primary_identifier(identifier, nil, nil)
     end
     
     def set_main_id(identifier, id = nil, type = nil)
+      warn 'set_main_id is deprecated. use set_primary_identifier instead.'
+      set_primary_identifier(identifier, id, type)
+    end
+
+    def set_primary_identifier(identifier, id = nil, type = nil)
       set_unique_identifier(id || @id_pool.generate_key(:prefix => 'BookId', :without_count => true))
       @metadata.add_identifier identifier, unique_identifier, type
     end
@@ -187,6 +209,7 @@ module GEPUB
       @metadata.language
     end
 
+    #TODO maybe it should be 'epub_version'
     def version
       @attributes['version']
     end
@@ -212,6 +235,14 @@ module GEPUB
       version
     end
 
+    def enable_rendition
+      @prefixes['rendition'] = 'http://www.idpf.org/vocab/rendition/#'
+    end
+
+    def rendition_enabled?
+      @prefixes['rendition'] == 'http://www.idpf.org/vocab/rendition/#'      
+    end
+    
     def opf_xml
       if version.to_f < 3.0 || @epub_backward_compat
         spine.toc  ||= 'ncx'
@@ -230,6 +261,12 @@ module GEPUB
       end
       builder = Nokogiri::XML::Builder.new {
         |xml|
+        if @prefixes.size == 0
+          @attributes.delete 'prefix'
+        else
+          @attributes['prefix'] = @prefixes.map { |k, v| "#{k}: #{v}" }.join(' ')
+        end
+        
         xml.package(@namespaces.merge(@attributes)) {
           @metadata.to_xml(xml)
           @manifest.to_xml(xml)

data/lib/gepub/rendition.rb

@@ -0,0 +1,49 @@
+module GEPUB
+  class Rendition
+    class NilContent
+      def self.content
+        nil
+      end
+    end
+    
+    def initialize()
+      @default_layout = 'reflowable'
+      @default_orientation = 'auto'
+      @default_spread = 'auto'
+      @layout = NilContent
+      @orientation = NilContent
+      @spread = NilContent
+    end
+
+    def set_metadata(metadata)
+      @metadata = metadata
+      @metadata.meta_list.each {
+        |metanode|
+        case metanode['property']
+        when 'rendition:layout'
+          @layout = metanode
+        when 'rendition:orientation'          
+          @orientation = metanode
+        when 'rendition:spread'
+          @spread = metanode
+        end
+      }
+    end
+
+    def layout
+      @layout.content || @default_layout
+    end
+
+    def orientation
+      @orientation.content || @default_orientation
+    end
+
+    def spread
+      @spread.content || @default_spread
+    end
+    
+    def value_map
+      { 'layout' => layout, 'orientation' => orientation, 'spread' => spread }
+    end
+  end
+end

data/lib/gepub/resource_builder.rb

@@ -15,8 +15,8 @@ module GEPUB
         @item.set_media_type(val)
       end
       
-      def method_missing(name, *args)
-        @item.send(name.to_sym, *args)
+      def method_missing(name, *args, &block)
+        @item.send(name.to_sym, *args, &block)
       end
     end
     
@@ -83,6 +83,22 @@ module GEPUB
       itemref.page_spread_right
     end
 
+    def rendition_layout val
+      itemref = @book.spine.itemref_by_id[@last_defined_item.item.id]
+      raise 'rendition should be called inside ordered' if (itemref.nil?)
+      itemref.rendition_layout = val
+    end
+    def rendition_orientation val
+      itemref = @book.spine.itemref_by_id[@last_defined_item.item.id]
+      raise 'rendition should be called inside ordered' if (itemref.nil?)
+      itemref.rendition_orientation = val
+    end
+    def rendition_spread val
+      itemref = @book.spine.itemref_by_id[@last_defined_item.item.id]
+      raise 'rendition should be called inside ordered' if (itemref.nil?)
+      itemref.rendition_spread = val
+    end
+
     def linear val
       itemref = @book.spine.itemref_by_id[@last_defined_item.item.id]
       raise 'linear should be called inside ordered' if (itemref.nil?)
@@ -105,6 +121,13 @@ module GEPUB
     def add_resource_dir(name)
       import "#{name}/resources.conf", :dir_prefix => name
     end
+
+    def add_resource_dirs(dirs)
+      dirs.each do
+        |dir|
+        add_resource_dir dir
+      end
+    end
     
     def cover_image(val)
       file(val)

data/lib/gepub/sorted_array.rb

@@ -0,0 +1,20 @@
+class SortedArray < Array
+  def initialize(*args, &sort_by)
+    @sort_by = sort_by || Proc.new { |x,y| x <=> y }
+    super(*args)
+    self.sort!() &sort_by
+  end
+
+  def insert(i, v)
+    insert_before = index(find { |x| @sort_by.call(x, v) == 1 })
+    super(insert_before ? insert_before : -1, v)
+  end
+
+  def <<(v)
+    insert(0, v)
+  end
+
+  alias push <<
+  alias unshift <<
+
+end

data/lib/gepub/spine.rb

@@ -46,6 +46,22 @@ module GEPUB
         add_property 'page-spread-left'
       end
 
+      def set_rendition_param(name, val)
+        add_property "rendition:#{name}-#{val}"
+      end
+
+      def rendition_layout=(val)
+        set_rendition_param('layout', val)
+      end
+
+      def rendition_orientation=(val)
+        set_rendition_param('orientation', val)
+      end
+
+      def rendition_spread=(val)
+        set_rendition_param('spread', val)
+      end
+
       def to_xml(builder, opf_version)
         attr = @attributes.dup
         if opf_version.to_f < 3.0
@@ -68,7 +84,7 @@ module GEPUB
           @xml = spine_xml
           @namespaces = @xml.namespaces
           @attributes = attr_to_hash(@xml.attributes)
-         @item_refs = []
+          @item_refs = []
           @xml.xpath("//#{ns_prefix(OPF_NS)}:spine/#{ns_prefix(OPF_NS)}:itemref", @namespaces).map {
             |itemref|
             i = Itemref.create(self, attr_to_hash(itemref.attributes))

data/lib/gepub/version.rb

@@ -1,4 +1,4 @@
 module GEPUB
   # GEPUB gem version 
-  VERSION = "0.6.8.5"
+  VERSION = "0.6.8.6"
 end

data/lib/gepub.rb

@@ -21,6 +21,7 @@ require 'gepub/version'
 require 'gepub/xml_util'
 require 'gepub/meta'
 require 'gepub/datemeta'
+require 'gepub/meta_array'
 require 'gepub/metadata'
 require 'gepub/manifest'
 require 'gepub/spine'

data/spec/book_spec.rb

@@ -0,0 +1,292 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'rubygems'
+require 'nokogiri'
+
+describe GEPUB::Book do
+  context 'on creating new book' do
+    describe 'initialize' do
+      context 'without parameter' do
+        it 'returns empty book' do
+          book = GEPUB::Book.new()
+          expect(book.path) .to eq('OEBPS/package.opf')
+          expect(book.version).to eq('3.0')
+        end
+      end
+      context 'with path' do
+        it 'returns empty book with path' do
+          book = GEPUB::Book.new('mypath/foo.opf')
+          expect(book.path) .to eq('mypath/foo.opf')
+        end
+      end
+      context 'with path and attributes' do
+        it 'returns empty book with path and attributes' do
+          book = GEPUB::Book.new('mypath/book.opf', {'version' => '2.1'});
+          expect(book.path) .to eq('mypath/book.opf')
+          expect(book.version).to eq('2.1')
+        end
+      end
+    end 
+    describe 'version=' do
+      context 'overwrite version' do
+        it 'will hold new version' do
+          book = GEPUB::Book.new()
+          book.version = '2.1'
+          expect(book.version).to eq('2.1')
+        end
+      end
+    end
+    describe 'identifer=' do
+      context 'set identifier' do
+        it 'will set unique-identifier and related attributes' do
+          book = GEPUB::Book.new()
+          book.identifier = 'the-book-identifier'
+
+          expect(book.identifier).to eq('the-book-identifier')
+          expect(book.identifier_list[0]['id']).to eq(book.unique_identifier)
+          expect(book.identifier_list[0].refiner('identifier-type')).to be_nil
+        end
+      end 
+    end
+    describe 'set_primary_identifier=' do 
+      context 'set identifier with id and type' do
+        it 'will set unique-identifier and related attributes' do
+          book = GEPUB::Book.new()
+          book.set_primary_identifier 'http//example.com/the-identifier', 'MyBookID', 'URL'
+
+          expect(book.identifier).to eq('http//example.com/the-identifier')
+          expect(book.unique_identifier).to eq('MyBookID')
+          expect(book.identifier_list[0]['id']).to eq('MyBookID')
+          expect(book.identifier_list[0].identifier_type.content).to eq('URL')
+        end
+      end 
+    end
+    describe 'add_identifier' do
+      context 'add new identifier to new book' do
+        it 'will set identifier, and not set unique-identifier' do
+          book = GEPUB::Book.new()
+          book.add_identifier 'newid'
+          expect(book.unique_identifier).to be_nil
+          expect(book.identifier).to be_nil
+          expect(book.identifier_list[0].content).to eq('newid')
+        end
+      end
+      context 'add new identifier to existing book' do
+        it 'will set new identifier' do
+          book = GEPUB::Book.new()
+          book.identifier = 'theIdentifier'
+          book.add_identifier 'http://example.jp/additional_identifier', nil, 'URL'
+          expect(book.identifier).to eq('theIdentifier')
+          expect(book.identifier_list[1].content).to eq('http://example.jp/additional_identifier')
+          expect(book.identifier_list[1].identifier_type.content).to eq('URL')
+        end
+      end
+    end
+    describe 'add_title' do
+      context 'add  title' do
+        it 'adds new title' do
+          book = GEPUB::Book.new()
+          book.title = 'the title'
+          book.add_title 'new title'
+          expect(book.title.to_s).to eq('the title')
+          expect(book.title_list[1].to_s).to eq('new title')
+        end
+      end 
+    end
+    describe 'title =' do 
+      context 'set first title' do
+        it 'will add new title' do
+          book = GEPUB::Book.new()
+          book.title = 'the title'
+          expect(book.title.to_s).to eq('the title')
+        end
+      end 
+      context 'clear and set title' do
+        it 'will clear title and add new title' do
+          book = GEPUB::Book.new()
+          book.add_title 'the title'
+          book.title = 'new title'
+          expect(book.title.to_s).to eq('new title')
+        end
+      end 
+    end
+    describe 'title' do
+      context 'main title is specified' do
+        it 'returns main title' do
+          book = GEPUB::Book.new()
+          book.add_title 'sub title' 
+          book.add_title('the main title', nil, GEPUB::TITLE_TYPE::MAIN) 
+          expect(book.title.to_s).to eq('the main title')
+        end
+      end
+      context 'display_seq is specified' do
+        it 'returns first title' do
+          book = GEPUB::Book.new()
+          book.add_title 'second title' 
+          book.add_title('first title') do
+            |title|
+            title.display_seq = 1
+          end 
+          expect(book.title.to_s).to eq('first title')
+        end
+      end
+    end
+    describe 'title_list' do 
+      context 'main title is specified' do
+        it 'returns titles in defined order' do
+          book = GEPUB::Book.new()
+          book.add_title 'sub title' 
+          book.add_title('the main title', nil, GEPUB::TITLE_TYPE::MAIN) 
+          expect(book.title_list[0].to_s).to eq('sub title')
+          expect(book.title_list[1].to_s).to eq('the main title')
+        end
+        context 'display seq is specified' do
+          it 'returns titles in display-seq order' do
+            book = GEPUB::Book.new()
+            book.add_title 'third title' 
+            book.add_title 'fourth title' 
+            book.add_title 'second title' do
+              |title|
+              title.display_seq = 2
+            end 
+            book.add_title('first title') do
+              |title|
+              title.display_seq = 1
+            end 
+            expect(book.title_list[0].to_s).to eq('first title')
+            expect(book.title_list[1].to_s).to eq('second title')
+            expect(book.title_list[2].to_s).to eq('third title')
+            expect(book.title_list[3].to_s).to eq('fourth title')
+          end
+        end
+      end
+    end
+    describe 'add_creator' do
+      it 'adds new creator' do
+        book = GEPUB::Book.new()
+        book.creator = 'the creator'
+        book.add_creator 'new creator'
+        expect(book.creator.to_s).to eq('the creator')
+        expect(book.creator_list[1].to_s).to eq('new creator')
+      end
+    end 
+    describe 'creator=' do 
+      it 'set first creator' do
+        book = GEPUB::Book.new()
+        book.creator = 'the creator'
+        expect(book.creator.to_s).to eq('the creator')
+      end
+      it 'clear and set creator' do
+        book = GEPUB::Book.new()
+        book.creator = 'the creator'
+        book.creator = 'new creator'
+        expect(book.creator.to_s).to eq('new creator')
+        expect(book.creator_list.size).to eq(1)
+      end
+    end
+    describe 'creator' do
+      context 'display seq is specified' do
+        it 'shows creator with smallest display-seq' do
+          book = GEPUB::Book.new()
+          book.add_creator 'a creator'
+          book.add_creator('second creator') do 
+            |creator|
+            creator.display_seq = 2
+          end
+          expect(book.creator.to_s).to eq('second creator')
+        end
+      end
+    end
+
+    describe 'creator_list' do
+      context 'display seq is specified' do
+        it 'returns creators in display-seq order' do
+          book = GEPUB::Book.new()
+          book.add_creator 'a creator'
+          book.add_creator('second creator') do 
+            |creator|
+            creator.display_seq = 2
+          end
+          book.add_creator 'another creator'
+          book.add_creator('first creator') do 
+            |creator|
+            creator.display_seq = 1
+          end
+          book.add_creator('third creator') do 
+            |creator|
+            creator.display_seq = 3
+          end
+          expect(book.creator_list[0].to_s).to eq('first creator')
+          expect(book.creator_list[1].to_s).to eq('second creator')
+          expect(book.creator_list[2].to_s).to eq('third creator')
+          expect(book.creator_list[3].to_s).to eq('a creator')
+          expect(book.creator_list[4].to_s).to eq('another creator')
+        end
+      end
+    end
+
+    # omit tests for setter/getter for contributor, publisher, date etc; these methods use same implementation as creator. 
+
+    describe 'set_lastmodified' do
+      it 'set current time' do
+        book = GEPUB::Book.new
+        now = Time.now
+        book.set_lastmodified
+        expect((book.lastmodified.content - now).abs).to be < 2
+      end
+      it 'set time in string' do
+        book = GEPUB::Book.new
+        book.set_lastmodified(Time.parse('2012-9-12 00:00:00Z'))
+        expect(book.lastmodified.content).to eq(Time.parse('2012-9-12 00:00:00 UTC'))
+      end
+    end
+    describe 'page_progression_direction=' do
+      it 'set page_progression_direction' do 
+        book = GEPUB::Book.new
+        book.page_progression_direction= 'rtl'
+        expect(book.page_progression_direction).to eq('rtl')
+      end
+    end
+    describe 'add_optional_file' do
+      context 'add apple specific option file' do
+        it 'is added to book' do
+          content = <<-EOF
+                <?xml version="1.0" encoding="UTF-8"?>
+                <display_options>
+                <platform name="*">
+                <option name="fixed-layout">true</option>
+                </platform>
+                </display_options>
+                EOF
+          book = GEPUB::Book.new
+          book.add_optional_file('META-INF/com.apple.ibooks.display-options.xm', StringIO.new(content))
+
+          expect(book.optional_files.size).to eq(1)
+          expect(book.optional_files['META-INF/com.apple.ibooks.display-options.xm']).to eq(content)
+        end
+      end
+    end
+    describe 'add_item' do
+    end
+    describe 'add_ordered_item' do
+    end
+    describe 'ordered' do
+    end
+    describe 'write_to_epub_container' do
+      context 'create typical book' do
+      end
+      context 'create very complex book' do
+      end
+    end
+  end
+  context 'on parsing existing book' do
+    describe '.parse' do
+     context 'IO Object' do
+      it 'loads book and returns GEPUB::Book object' do
+       filehandle = File.new(File.dirname(__FILE__) + '/fixtures/testdata/wasteland-20120118.epub')
+       book = GEPUB::Book.parse(filehandle)
+       expect(book).to be_instance_of GEPUB::Book
+      end
+     end
+    end
+  end
+end

data/spec/builder_spec.rb

@@ -356,6 +356,25 @@ describe GEPUB::Builder do
       builder.instance_eval{ @book.spine.itemref_list[1].properties[0] }.should == 'page-spread-right'
     end
 
+    it 'should add files and rendition property' 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')
+            rendition_layout 'pre-paginated'
+            rendition_orientation 'landscape'
+            rendition_spread 'both'
+          }
+        }
+      }
+      builder.instance_eval{ @book.item_by_href('text/memo.txt') }.should_not be_nil
+      builder.instance_eval{ @book.spine.itemref_list[1].properties[0] }.should == 'rendition:layout-pre-paginated'
+      builder.instance_eval{ @book.spine.itemref_list[1].properties[1] }.should == 'rendition:orientation-landscape'
+      builder.instance_eval{ @book.spine.itemref_list[1].properties[2] }.should == 'rendition:spread-both'
+    end
+
     it 'should handle fallback chain' do
       workdir = File.join(File.dirname(__FILE__),'fixtures', 'builder')
       builder = GEPUB::Builder.new {

data/spec/fixtures/testdata/test.opf

@@ -1,6 +1,11 @@
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 
-<package xmlns="http://www.idpf.org/2007/opf" version="3.0" unique-identifier="pub-id" xml:lang="ja">
+<package xmlns="http://www.idpf.org/2007/opf" version="3.0"
+         unique-identifier="pub-id"
+         xml:lang="ja"
+         prefix="foaf: http://xmlns.com/foaf/spec/ 
+                 rendition:  http://www.idpf.org/vocab/rendition/#"
+         >
 <metadata xmlns:dc="http://purl.org/dc/elements/1.1/" >
 <dc:identifier id="pub-id">urn:uuid:1234567890</dc:identifier>
 <meta refines="#pub-id" property="identifier-type" scheme="xsd:string">uuid</meta>
@@ -34,6 +39,10 @@
 
 <meta property="dcterms:issued" id="issued">2012-02-12T15:00:00Z</meta>
 <meta property="dcterms:modified" id="modified">2012-02-12T19:00:00Z</meta>
+
+<meta property="rendition:layout">pre-paginated</meta>
+<meta property="rendition:spread">both</meta> 
+
 <meta name="cover" content="cover-image" />
 </metadata>
 
@@ -57,4 +66,4 @@
 <itemref idref="nav" linear="no" />
 </spine>
 
-</package>
+</package>

data/spec/package_spec.rb

@@ -8,6 +8,7 @@ describe GEPUB::Package do
     opf = GEPUB::Package.new('/package.opf')
     opf.ns_prefix(GEPUB::XMLUtil::OPF_NS).should == 'xmlns'
   end
+
   context 'parse existing opf' do
     it 'should be initialized with opf' do
       opf = GEPUB::Package.parse_opf(File.open(File.dirname(__FILE__) + '/fixtures/testdata/test.opf'), '/package.opf')
@@ -15,8 +16,24 @@ describe GEPUB::Package do
       opf['version'].should == '3.0'
       opf['unique-identifier'].should == 'pub-id'
       opf['xml:lang'].should == 'ja'
+      opf['prefix'].should == 'foaf: http://xmlns.com/foaf/spec/                   rendition:  http://www.idpf.org/vocab/rendition/#'
+    end
+    it 'should parse prefix data' do
+      package = GEPUB::Package.parse_opf(File.open(File.dirname(__FILE__) + '/fixtures/testdata/test.opf'), '/package.opf')
+      package.prefixes.size.should == 2
+      package.prefixes['foaf'].should == 'http://xmlns.com/foaf/spec/'
+      package.prefixes['rendition'].should == 'http://www.idpf.org/vocab/rendition/#'
+      
     end
-    
+
+    it 'should parse rendition metadata' do
+      package = GEPUB::Package.parse_opf(File.open(File.dirname(__FILE__) + '/fixtures/testdata/test.opf'), '/package.opf')
+      package.rendition_layout.should == 'pre-paginated'
+      package.rendition_orientation.should == 'auto'
+      package.rendition_spread.should == 'both'
+      
+    end
+
   end
   context 'generate new opf' do
     it 'should generate opf' do
@@ -58,6 +75,30 @@ describe GEPUB::Package do
       # TODO: should check all elements
     end
 
+    it 'should generate package with prefix attribute' do
+      package = GEPUB::Package.new('OEBPS/package.opf') do
+        |package|
+        package.set_main_id('http://example.jp', 'BookID', 'url')
+        package['xml:lang'] = 'ja'
+        package.enable_rendition
+      end
+      xml = Nokogiri::XML::Document.parse package.opf_xml
+      xml.root['prefix'].should == 'rendition: http://www.idpf.org/vocab/rendition/#'
+    end
+
+    it 'should generate package with rendition attributes' do
+      package = GEPUB::Package.new('OEBPS/package.opf') do
+        |package|
+        package.rendition_layout = 'pre-paginated'
+        package.rendition_orientation = 'portlait'
+        package.rendition_spread = 'landscape'
+      end
+      xml = Nokogiri::XML::Document.parse package.opf_xml
+      xml.at_xpath("//xmlns:meta[@property='rendition:layout']").content.should == 'pre-paginated'
+      xml.at_xpath("//xmlns:meta[@property='rendition:orientation']").content.should == 'portlait'
+      xml.at_xpath("//xmlns:meta[@property='rendition:spread']").content.should == 'landscape'
+    end
+
     it 'should generate opf2.0' do
       opf = GEPUB::Package.new('OEBPS/package.opf', { 'version' => '2.0'}) {
         |opf|
@@ -94,6 +135,5 @@ describe GEPUB::Package do
       xml.root['version'].should == '2.0'
       xml.root['lang'].should == 'ja'
     end
-
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gepub
 version: !ruby/object:Gem::Version
-  version: 0.6.8.5
+  version: 0.6.8.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-18 00:00:00.000000000 Z
+date: 2012-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70309442002400 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.11'
   type: :development
   prerelease: false
-  version_requirements: *70309442002400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70309442001900 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70309442001900
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: &70309442001440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +53,12 @@ dependencies:
         version: 0.9.7
   type: :runtime
   prerelease: false
-  version_requirements: *70309442001440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.7
 description: gepub is a generic EPUB parser/generator. Generates and parse EPUB2 and
   EPUB3
 email:
@@ -76,13 +91,17 @@ files:
 - lib/gepub/item.rb
 - lib/gepub/manifest.rb
 - lib/gepub/meta.rb
+- lib/gepub/meta_array.rb
 - lib/gepub/metadata.rb
 - lib/gepub/package.rb
+- lib/gepub/rendition.rb
 - lib/gepub/resource_builder.rb
+- lib/gepub/sorted_array.rb
 - lib/gepub/spine.rb
 - lib/gepub/version.rb
 - lib/gepub/xml_util.rb
 - spec/bindings_spec.rb
+- spec/book_spec.rb
 - spec/builder_spec.rb
 - spec/example_spec.rb
 - spec/fixtures/builder/img/cover.jpg
@@ -108,6 +127,7 @@ files:
 - spec/fixtures/testdata/test.opf
 - spec/fixtures/testdata/test2.opf
 - spec/fixtures/testdata/test_with_bindings.opf
+- spec/fixtures/testdata/wasteland-20120118.epub
 - spec/gepub_spec.rb
 - spec/manifest_spec.rb
 - spec/metadata_spec.rb
@@ -134,12 +154,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: gepub
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: a generic EPUB library for Ruby.
 test_files:
 - spec/bindings_spec.rb
+- spec/book_spec.rb
 - spec/builder_spec.rb
 - spec/example_spec.rb
 - spec/fixtures/builder/img/cover.jpg
@@ -165,6 +186,7 @@ test_files:
 - spec/fixtures/testdata/test.opf
 - spec/fixtures/testdata/test2.opf
 - spec/fixtures/testdata/test_with_bindings.opf
+- spec/fixtures/testdata/wasteland-20120118.epub
 - spec/gepub_spec.rb
 - spec/manifest_spec.rb
 - spec/metadata_spec.rb