gepub 0.5.0 → 0.6.0

data/lib/gepub/package.rb

@@ -0,0 +1,232 @@
+require 'rubygems'
+require 'nokogiri'
+
+module GEPUB
+  # Holds data in opf file.
+  class Package
+    include XMLUtil
+    attr_accessor :path, :metadata, :manifest, :spine, :epub_backward_compat, :contents_prefix
+
+    class IDPool
+      def initialize
+        @pool = {}
+        @counter = {}
+      end
+
+      def counter(prefix,suffix)
+        @counter[prefix + '////' + suffix]
+      end
+
+      def set_counter(prefix,suffix,val)
+        @counter[prefix + '////' + suffix] = val
+      end
+      
+      def generate_key(param = {})
+        while (true)
+          prefix = param[:prefix] || ''
+          suffix = param[:suffix] || ''
+          count = [ param[:start] || 1, counter(prefix,suffix) || 1].max
+          if param[:without_count]
+            k = prefix + suffix
+            count -= 1
+            param[:without_count] = nil
+          else
+            k = prefix + count.to_s + suffix
+          end
+          if @pool[k].nil?
+            set_counter(prefix,suffix, count + 1)
+            return k
+          end
+          count += 1
+        end
+
+      end
+      
+      def [](k)
+        @pool[k]
+      end
+      def []=(k,v)
+        @pool[k] = v
+      end
+    end
+    
+    # parse OPF data. opf should be io or string object.
+    def self.parse_opf(opf, path)
+      Package.new(path) {
+        |package|
+        package.instance_eval {
+          @path = path
+          @xml = Nokogiri::XML::Document.parse(opf)
+          @namespaces = @xml.root.namespaces
+          @attributes = attr_to_hash(@xml.root.attributes)
+          @metadata = Metadata.parse(@xml.at_xpath("//#{ns_prefix(OPF_NS)}:metadata"), @attributes['version'], @id_pool)
+          @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)
+        }
+      }
+    end
+
+    def initialize(path='OEBPS/package.opf', attributes={})
+      @path = path
+      if File.extname(@path) != '.opf'
+        if @path.size > 0
+          @path = [path,'package.opf'].join('/')
+        end
+      end
+      @contents_prefix = File.dirname(@path).sub(/^\.$/,'')
+      @contents_prefix = @contents_prefix + '/' if @contents_prefix.size > 0
+      @namespaces = {'xmlns' => OPF_NS }
+      @attributes = attributes
+      @attributes['version'] ||= '3.0'
+      @id_pool = IDPool.new
+      @metadata = Metadata.new(version)
+      @manifest = Manifest.new(version)
+      @spine = Spine.new(version)
+      @epub_backward_compat = true
+      yield self if block_given?
+    end
+
+    ['version', 'unique-identifier', 'xml:lang', 'dir', 'prefix', 'id'].each {
+      |name|
+      methodbase = name.gsub('-','_').sub('xml:lang', 'lang')
+      define_method(methodbase + '=') { |val| @attributes[name] =  val }
+      define_method('set_' + methodbase) { |val| @attributes[name] = val }        
+      define_method(methodbase) { @attributes[name] }
+    }
+
+    def [](x)
+      @attributes[x]
+    end
+
+    def []=(k,v)
+      @attributes[k] = v
+    end
+
+
+    def identifier
+      @metadata.identifier_by_id(unique_identifier)
+    end
+    
+    def identifier=(identifier)
+      set_main_id(identifier, nil, 'URL')
+    end
+    
+    def set_main_id(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
+    
+    def specify_cover(item)
+      # ... not smart. should create old-meta on generating xml
+      @metadata.add_oldstyle_meta(nil, { 'name' => 'cover', 'content' => item.id })
+      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)
+      item = @manifest.add_item(id, href, nil, attributes)
+      item.add_content(io) unless io.nil?
+      @spine.push(item) if @ordered
+      yield item if block_given?
+      item
+    end
+
+    def ordered
+      raise 'need block.' if !block_given?
+      @ordered = true
+      yield
+      @ordered = nil
+    end
+
+    def add_ordered_item(href, io = nil, id = nil, attributes = {})
+      raise 'do not call add_ordered_item within ordered block.' if @ordered
+      item = add_item(href, io, id, attributes)
+      @spine.push(item)
+      
+      item
+    end
+
+
+    def method_missing(name, *args) 
+      Metadata::CONTENT_NODE_LIST.each {
+        |x|
+        case name.to_s
+        when x, "#{x}_list", "set_#{x}", "#{x}=", "add_#{x}"
+          return @metadata.send(name, *args)
+        end
+      }
+      super
+    end
+
+    def author=(val)
+      warn 'author= is deprecated. please use #creator'
+      @metadata.creator= val
+    end
+
+    def author
+      warn '#author is deprecated. please use #creator'
+      @metadata.creator
+    end      
+
+    def specify_cover_image(item)
+      warn 'specify_cover_image is deprecated. please use Item#cover_image'
+      item.cover_image
+    end
+
+    def locale=(val)
+      warn 'locale= is deprecated. please use #language='
+      @metadata.language = val
+    end
+
+    def locale 
+      warn '#locale is deprecated. please use #language'
+      @metadata.language
+    end
+
+    def version=(val)
+      @attributes['version'] = val
+      @metadata.opf_version = val
+      @manifest.opf_version = val
+      @spine.opf_version = val
+    end
+    
+    def epub_version=(val)
+      warn 'epub_version= is deprecated. please use #version='
+      @attributes['version'] = val
+    end
+
+    def epub_version
+      warn 'epub_version is deprecated. please use #version'
+      version
+    end
+
+    def opf_xml
+      if version.to_f < 3.0 || @epub_backward_compat
+        spine.toc  ||= 'ncx'
+        if @metadata.oldstyle_meta.select {
+          |meta|
+          meta['name'] == 'cover'
+          }.length == 0
+          
+          @manifest.item_list.each {
+            |k, item|
+            if item.properties && item.properties.member?('cover-image')
+              @metadata.add_oldstyle_meta(nil, 'name' => 'cover', 'content' => item.id)
+            end
+          }
+        end
+      end
+      builder = Nokogiri::XML::Builder.new {
+        |xml|
+        xml.package(@namespaces.merge(@attributes)) {
+          @metadata.to_xml(xml)
+          @manifest.to_xml(xml)
+          @spine.to_xml(xml)
+        }
+      }
+      builder.to_xml
+    end
+
+
+  end
+end

data/lib/gepub/spine.rb

@@ -0,0 +1,112 @@
+require 'rubygems'
+require 'nokogiri'
+module GEPUB
+  class Spine
+    include XMLUtil
+    attr_accessor :opf_version
+    class Itemref
+      def self.create(parent, attributes = {})
+        Itemref.new(attributes['idref'], parent, attributes.reject{|k,v| k == 'idref'})
+      end
+      
+      def initialize(idref, parent = nil, attributes = {})
+        if attributes['properties'].class == String
+          attributes['properties'] = attributes['properties'].split(' ')
+        end
+        @attributes = {'idref' => idref}.merge(attributes)
+        @parent = parent
+        @parent.register_itemref(self) unless @parent.nil?
+        self
+      end
+
+      ['idref', 'linear', 'id', 'properties'].each { |name|
+        methodbase = name.gsub('-','_')
+        define_method(methodbase + '=') { |val| @attributes[name] = val }
+        define_method('set_' + methodbase) { |val| @attributes[name] = val }
+        define_method(methodbase) { @attributes[name] }
+      }
+
+      def [](x)
+        @attributes[x]
+      end
+
+      def []=(x,y)
+        @attributes[x] = y
+      end
+      
+      def add_property(property)
+        (@attributes['properties'] ||=[]) << property
+      end
+
+      def to_xml(builder)
+        builder.itemref(@attributes)
+      end
+    end    
+
+    def self.parse(spine_xml, opf_version = '3.0', id_pool  = Package::IDPool.new)
+      Spine.new(opf_version, id_pool) {
+        |spine|
+        spine.instance_eval {
+          @xml = spine_xml
+          @namespaces = @xml.namespaces
+          @attributes = attr_to_hash(@xml.attributes)
+          @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))
+            @item_refs << i
+          }
+        }
+      }
+    end
+
+    def initialize(opf_version = '3.0', id_pool  = Package::IDPool.new)
+      @id_pool = id_pool
+      @attributes = {}
+      @item_refs = []
+      @opf_version = opf_version
+      yield self if block_given?
+    end
+
+    ['id', 'toc', 'page-progression-direction'].each { |name|
+      methodbase = name.gsub('-','_')
+      define_method(methodbase + '=') { |val| @attributes[name] = val }
+      define_method('set_' + methodbase) { |val| @attributes[name] = val }
+      define_method(methodbase) { @attributes[name] }
+    }
+    
+    def itemref_list
+      @item_refs.dup
+    end
+
+    def push(item)
+      @item_refs << i = Itemref.new(item.id, self)
+      i
+    end
+
+    def <<(item)
+      push item
+    end
+    
+    def to_xml(builder)
+      builder.spine(@attributes) {
+        @item_refs.each {
+          |ref|
+          ref.to_xml(builder)
+        }
+      }
+    end
+
+    def register_itemref(itemref)
+      raise "id '#{itemref.id}' is already in use." if @id_pool[itemref.id]
+      @id_pool[itemref.id] = true unless itemref.id.nil?
+    end
+
+    def unregister_itemref(itemref)
+      @item_refs.delete itemref
+      @id_pool[itemref.id] = nil
+    end
+    
+    
+  end
+end

data/lib/gepub/version.rb

@@ -1,3 +1,3 @@
 module GEPUB
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/gepub/xml_util.rb

@@ -0,0 +1,25 @@
+module GEPUB
+  module XMLUtil
+    OPF_NS = 'http://www.idpf.org/2007/opf'
+    DC_NS = 'http://purl.org/dc/elements/1.1/'
+    def ns_prefix(ns)
+      prefix = raw_prefix(ns)
+      prefix.nil? ? nil : prefix.sub(/^xmlns:/,'')
+    end
+
+    def raw_prefix(ns)
+      @namespaces.key(ns)      
+    end
+
+    def attr_to_hash(nokogiri_attrs)
+      attributes = {}
+      nokogiri_attrs.each {
+        |k,v|
+        attributes[k] = v.to_s
+      }
+      attributes['xml:lang'] = attributes['lang'];
+      attributes.delete('lang')
+      attributes
+    end
+  end
+end

data/lib/gepub.rb

@@ -1,6 +1,22 @@
+if !({}.respond_to? 'key')
+  class Hash
+    def key(x)
+      index(x)
+    end
+  end
+end
+
 require 'gepub/version'
+require 'gepub/xml_util'
+require 'gepub/meta'
+require 'gepub/metadata'
+require 'gepub/manifest'
+require 'gepub/spine'
+require 'gepub/package'
 require 'gepub/item'
 require 'gepub/book'
 require 'gepub/gepuber'
 
 
+
+

data/spec/example_spec.rb

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'rubygems'
+
+describe 'GEPUB usage' do
+  context 'On generating EPUB' do
+    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')
+      book.language = 'ja'
+
+      # you can add metadata and its property using block
+      book.add_title('GEPUBサンプル文書', nil, GEPUB::TITLE_TYPE::MAIN) {
+        |title|
+        title.lang = 'ja'
+        title.file_as = 'GEPUB Sample Book'
+        title.display_seq = 1
+        title.add_alternates(
+                             'en' => 'GEPUB Sample Book (Japanese)',
+                             'el' => 'GEPUB δείγμα (Ιαπωνικά)',
+                             'th' => 'GEPUB ตัวอย่าง (ญี่ปุ่น)')
+      }
+      # you can do the same thing using method chain
+      book.add_title('これはあくまでサンプルです',nil, GEPUB::TITLE_TYPE::SUBTITLE).set_display_seq(1).add_alternates('en' => 'this book is just a sample.')
+      book.add_creator('小嶋智') {
+        |creator|
+        creator.display_seq = 1
+        creator.add_alternates('en' => 'KOJIMA Satoshi')
+      }
+      book.add_contributor('電書部').set_display_seq(1).add_alternates('en' => 'Denshobu')
+      book.add_contributor('アサガヤデンショ').set_display_seq(2).add_alternates('en' => 'Asagaya Densho')
+      book.add_contributor('湘南電書鼎談').set_display_seq(3).add_alternates('en' => 'Shonan Densho Teidan')
+      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
+      
+      # within ordered block, add_item will be added to spine.
+      book.ordered {
+        book.add_item('text/chap1.xhtml').add_content(StringIO.new('<html xmlns="http://www.w3.org/1999/xhtml"><head><title>c1</title></head><body><p>the first page</p></body></html>')).toc_text('Chapter 1')
+        book.add_item('text/chap1-1.xhtml').add_content(StringIO.new('<html xmlns="http://www.w3.org/1999/xhtml"><head><title>c2</title></head><body><p>the second page</p></body></html>')) # do not appear on table of contents
+        book.add_item('text/chap2.xhtml').add_content(StringIO.new('<html xmlns="http://www.w3.org/1999/xhtml"><head><title>c3</title></head><body><p>the third page</p></body></html>')).toc_text('Chapter 2')
+      }
+      epubname = File.join(File.dirname(__FILE__), 'example_test.epub')
+      book.generate_epub(epubname)
+      jar = File.join(File.dirname(__FILE__), 'fixtures/epubcheck-3.0b4/epubcheck-3.0b4.jar')    
+      system 'java' '-jar', jar, epubname
+    end
+  end
+end

data/spec/fixtures/epubcheck-3.0b4/COPYING.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2007 Adobe Systems Incorporated
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/spec/fixtures/epubcheck-3.0b4/README.txt

@@ -0,0 +1,61 @@
+This folder contains the distribution of epubcheck project.
+
+EpubCheck is a tool to validate IDPF Epub files. It can detect many
+types of errors in Epub. OCF container structure, OPF and OPS mark-up,
+and internal reference consistency are checked. EpubCheck can be run
+as a standalone command-line tool, installed as a web application or
+used as a library.
+
+Epubcheck project home: http://code.google.com/p/epubcheck/
+
+BUILDING
+
+To build epubcheck from the sources you need Java Development Kit (JDK) 1.5 or above
+and Apache ant (http://ant.apache.org/) 1.6 or above installed
+
+Run
+
+ant -f build.xml
+
+RUNNING
+
+To run the tool you need Java Runtime (1.5 or above). Any OS should do. Run
+it from the command line: 
+
+java -jar epubcheck-x.x.x.jar file.epub
+
+All detected errors are simply printed to stderr. 
+
+USING AS A LIBRARY
+
+You can also use EpubCheck as a library in your Java application. EpubCheck
+public interfaces can be found in com.adobe.epubcheck.api package. EpubCheck
+class can be used to instantiate a validation engine. Use one of its
+constructors and then call validate() method. Report is an interface that
+you can implement to get a list of the errors and warnings reported by the
+validation engine (instead of the error list being printed out).
+
+LICENSING
+
+See COPYING.txt
+
+AUTHORS
+
+Peter Sorotokin 
+Garth Conboy 
+Markus Gylling 
+Piotr Kula
+
+Most of the EpubCheck functionality comes from the schema validation tool Jing
+and schemas that were developed by IDPF and DAISY. EpubCheck development was
+largely done at Adobe Systems. 
+
+
+
+
+
+
+
+
+
+

data/spec/fixtures/epubcheck-3.0b4/jing_license.txt

@@ -0,0 +1,12 @@
+Jing Copying Conditions
+
+Copyright (c) 2001-2003 Thai Open Source Software Center Ltd
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+    * Neither the name of the Thai Open Source Software Center Ltd nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/spec/fixtures/testdata/test.opf

@@ -0,0 +1,60 @@
+<?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">
+<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>
+<dc:identifier id="pub-id2">http://example.jp/epub/test/url</dc:identifier>
+<meta refines="#pub-id2" property="identifier-type" scheme="xsd:string">uri</meta>
+
+<dc:title id="series">Series Title</dc:title>
+<meta refines="#series" property="title-type">collection</meta>
+<meta refines="#series" property="display-seq">2</meta>
+<dc:title id="title">TheTitle</dc:title>
+<meta refines="#title" property="title-type">main</meta>
+<meta refines="#title" property="display-seq">1</meta>
+
+<dc:language id="pub-lang">ja</dc:language>
+
+<dc:creator id="author1">最初の著者</dc:creator>
+<meta refines="#author1" property="role" scheme="marc:relators">aut</meta>
+<meta refines="#author1" property="display-seq">1</meta>
+<meta refines="#author1" property="file-as">さいしょのちょしゃ</meta>
+<dc:creator id="author3">三人目</dc:creator>
+<meta refines="#author3" property="role" scheme="marc:relators">prg</meta>
+<meta refines="#author3" property="display-seq">3</meta>
+<meta refines="#author3" property="file-as">さんにんめ</meta>
+<dc:creator id="author2">ふたりめ</dc:creator>
+<meta refines="#author2" property="role" scheme="marc:relators">aut</meta>
+<meta refines="#author2" property="display-seq">2</meta>
+<meta refines="#author2" property="file-as">ふたりめ</meta>
+
+
+<dc:publisher id="publisher">小嶋智</dc:publisher>
+
+<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 name="cover" content="cover-image" />
+</metadata>
+
+
+<manifest>
+<item id="ncx" href="toc.ncx" media-type="application/x-dtbncx+xml" />
+<item id="cover" href="cover/cover.xhtml" media-type="application/xhtml+xml" />
+<item id="cover-image" href="img/cover.jpg" properties="cover-image" media-type="image/jpeg" />
+<item id="toc" href="toc.xhtml" media-type="application/xhtml+xml" />
+<item id="nav" href="nav.xhtml" properties="nav" media-type="application/xhtml+xml" />
+<item id="chap1" href="chap1.xhtml" media-type="application/xhtml+xml" />
+<item id="css" href="style/default.css" media-type="text/css" />
+<item id="object" href="img/test.png" media-type="image/png" />
+<item id="object2" href="resource/image.jpg" media-type="image/jpg" />
+</manifest>
+
+<spine toc="ncx" page-progression-direction="ltr">
+<itemref idref="cover" linear="no" />
+<itemref idref="toc" linear="yes" />
+<itemref idref="chap1" linear="yes" />
+<itemref idref="nav" linear="no" />
+</spine>
+
+</package>