pubgen 0.1.2 → 0.1.3

data/README.md

@@ -1,7 +1,7 @@
 # Pubgen
 
-Pubgen is a simple command-line based epub generator. With the simple YAML 
-file, Pubgen generate the epub file for you. 
+Pubgen is a command-line based epub generator. With a simple YAML, Pubgen make 
+a epub for you. 
 
 ## Installation
 
@@ -14,7 +14,7 @@ $ gem install pubgen
 
 ```bash
 $ pubgen -h
-pubgen 0.1.0, a epub generator.
+pubgen, a epub generator. (http://github.com/9beach/pubgen)
 
 Usage:
   pubgen <yaml file> [-o <epub file>] [-v]
@@ -28,15 +28,13 @@ Usage:
 ## Quick Start
  
 Prepare files (documents, images, style sheets, etc.) that make up the 
-publication. iBooks requires strict xhtml format, 
-[`tidy -asxhtml`] (http://tidy.sourceforge.net/) will be helpful.
+publication. iBooks requires strict xhtml. [`tidy -asxhtml`] 
+(http://tidy.sourceforge.net/) will be helpful.
 
 ```bash
 $ find .
 .
 ./contents
-./contents/a-1.html
-./contents/a-2.html
 ./contents/a.html
 ./contents/b.html
 ./images
@@ -46,14 +44,14 @@ $ find .
 ./images/cover.jpg
 ./style.css
 ```
-Create the YAML file describing your publication. As a example, 
+
+Create the utf-8 encoded YAML file describing the publication. As a example, 
 `will_oldham.yml`.
 
 ```yaml
 # METADATA: Publication metadata (title, author, publisher, etc.).
 #
 # See http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2
-# -*- encoding: utf-8 -*-
 metadata:
   title: "Will Oldham: Wikipedia, the free encyclopedia"
   creator: Wikipedia
@@ -61,7 +59,7 @@ metadata:
   language: en
   subject: American alternative country singers
   publisher:
-  contrubuter:
+  contributor:
   description:
   source: "http://en.wikipedia.org/wiki/Will_Oldham"
   rights:
@@ -71,19 +69,22 @@ metadata:
 # publication, such as table of contents, foreword, bibliography, etc.
 #
 # See http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.6
+#
+# If you provide cover-image without cover-page, pubgen automatically 
+# generate cover-page xhtml, and add it to manifest and spine
 guide:
   toc-page:
   title-page: 
-# If you provide cover-image without cover-page, pubgen automatically 
-# generate cover-page xhtml, and add it to manifest and spine
-  cover-image: images/cover.jpg
   cover-page:
+  cover-image: images/cover.jpg
 
 # MANIFEST: A list of files (documents, images, style sheets, etc.) that make 
 # up the publication.
 #
-# All the files in manifest ought to be in the same or sub-directory of yaml.
-# Say yaml's path is /book/a.yaml.
+# See http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.3
+#
+# All the file paths in manifest ought to be relative to yaml's path and in the
+# same or sub-directory of yaml. Say yaml's path is /book/a.yaml.
 # - a/b/c.html                # good. in the sub-directory
 # - d.jpg                     # good. in the same directory
 # - ./e.jpg                   # good. in the same directory
@@ -93,8 +94,6 @@ guide:
 # - ../book/f.png             # bad. although in the same directory
 manifest:
   - contents/a.html
-  - contents/a-1.html
-  - contents/a-2.html
   - contents/b.html
   - images/cover.jpg
   - images/1.jpg
@@ -103,18 +102,26 @@ manifest:
   - style.css
 
 # SPINE: An arrangement of documents providing a linear reading order.
+#
+# See http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4
 spine:
   - contents/a.html
-  - contents/a-1.html
-  - contents/a-2.html
   - contents/b.html
 
 # TOC: Table of contents
+#
+# See http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4.1
 toc:
-  - Music -- contents/a.html:   # don't forget colon to indent
-    - Discography -- contents/a-1.html
-    - Response -- contents/a-2.html
-  - Film -- contents/b.html
+# Add a colon suffix to indent
+  - 1 Music -- contents/a.html:
+    - 1.1 Discography -- contents/a.html#discography: 
+      - 1.1.1 Studio albums -- contents/a.html#studio_albums
+    - 1.2 Response -- contents/a.html#response
+  - 2 Film -- contents/b.html:
+    - 2.1 Filmography -- contents/b.html#filmography
+  - 3 Photography -- contents/b.html#photography
+  - 4 References -- contents/b.html#references
+  - 5 External links -- contents/b.html#external_links
 ```
 
 Run pubgen.
@@ -123,8 +130,6 @@ Run pubgen.
 $ pubgen /path/to/will_oldham.yml -v
 mkdir .pubgen-4f4a210e
 cp ./contents/a.html .pubgen-4f4a210e/contents
-cp ./contents/a-1.html .pubgen-4f4a210e/contents
-cp ./contents/a-2.html .pubgen-4f4a210e/contents
 cp ./contents/b.html .pubgen-4f4a210e/contents
 cp ./images/cover.jpg .pubgen-4f4a210e/images
 cp ./images/1.jpg .pubgen-4f4a210e/images
@@ -138,8 +143,10 @@ cat > cover-pubgen.xhtml
 cat > content.opf
 cat > toc.ncx
 zip > pubgen.epub
-cd /path/to/pwd
-mv .pubgen-4f4a210e /pubgen.epub 'Will Oldham_ Wikipedia, the free encyclopedia.epub'
+cd /path/to/prev_dir
+mv .pubgen-4f4a210e/pubgen.epub 'Will Oldham_ Wikipedia, the free encyclopedia.epub'
 rm -rf .pubgen-4f4a210e
 # Successfully generated 'Will Oldham_ Wikipedia, the free encyclopedia.epub'
 ```
+
+Done!

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake'
+require 'rake/testtask'
+
+task :default => [:test_units]
+Rake::TestTask.new('test_units') do |t|
+  t.libs << %w[lib test]
+  t.pattern = 'test/test*.rb'
+  t.warning = true
+end
+

data/bin/pubgen

@@ -1,8 +1,5 @@
 #!/usr/bin/env ruby
 
-PACKAGE = 'pubgen'
-VERSION = '0.1.2'
-
 require 'yaml'
 require 'fileutils'
 require 'optparse'
@@ -13,11 +10,11 @@ $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 require 'pubgen'
 
 HELP = <<EOF
-#{PACKAGE} #{VERSION}, a epub generator. (http://github.com/9beach/pubgen)
+pubgen #{Pubgen::VERSION}, a epub generator. (http://github.com/9beach/pubgen)
 
 Usage:
-  #{PACKAGE} <yaml file> [-o <epub file>] [-v]
-  #{PACKAGE} <yaml file> -m
+  pubgen <yaml file> [-o <epub file>] [-v]
+  pubgen <yaml file> -m
 
 EOF
 
@@ -42,18 +39,18 @@ opts.parse!(ARGV)
 # check options validity
 if (options[:meta_file_only] == true && options[:epub_path] != nil)
   $stderr << <<EOF
-#{PACKAGE}: `--meta-file-only' with `--output EPUB_PATH', not allowed
+pubgen: `--meta-file-only' with `--output EPUB_PATH', not allowed
 
-Try `#{PACKAGE} -h' for more informations
+Try `pubgen -h' for more informations
 EOF
   exit 1
 end
 
 if ARGV.size != 1
   $stderr << <<EOF
-#{PACKAGE}: specify a yaml file
+pubgen: specify a yaml file
 
-Try `#{PACKAGE} -h' for more informations
+Try `pubgen -h' for more informations
 EOF
   exit 1
 else
@@ -68,7 +65,8 @@ rescue Exception=>e
 end
 
 if yaml['metadata']['title'] == nil
-  pubgen_err("Failed to find the value of 'title' attribute in: " + options[:yaml_path])
+  pubgen_err("Failed to find the value of 'title' attribute in: " + 
+             options[:yaml_path])
   exit 1
 end
 
@@ -77,20 +75,23 @@ if !options[:meta_file_only] && !options[:epub_path]
   options[:epub_path] = yaml['metadata']['title'] + ".epub"
   options[:epub_path].gsub!(/[\/:?]/, "_") # file-system friendly
 end
-# now, options done
+# options done
 
-# just for one line
+# just for one line log
 def pubgen_log(log, verbose = true)
   $stdout << log + "\n" if verbose
 end
 
-# just for one line
 def pubgen_err(err)
   $stderr << '# ' + err + "\n"
 end
 
-yaml['metadata']['creator'] = "#{PACKAGE}-#{VERSION}" if yaml['metadata']['creator'] == nil
-yaml['metadata']['contributor'] = "#{PACKAGE}-#{VERSION}" if yaml['metadata']['contributor'] == nil
+if yaml['metadata']['creator'] == nil
+  yaml['metadata']['creator'] = "pubgen-#{Pubgen::VERSION}" 
+end
+if yaml['metadata']['contributor'] == nil
+  yaml['metadata']['contributor'] = "pubgen-#{Pubgen::VERSION}"
+end
 
 $tmpdir = ""
 $pwd_old = Dir.pwd
@@ -98,19 +99,20 @@ $exit_code = 0
 
 begin
   if !options[:meta_file_only]
-    # we need temporal working directory
+    # temporal working directory
     $tmpdir = ".pubgen-%08x" % Time.now.to_i 
     Dir.mkdir($tmpdir)
     pubgen_log("mkdir " + $tmpdir, options[:verbose])
 
-    # copy all files of manifest to $tmpdir
+    # copy all the files of manifest to $tmpdir
     yaml['manifest'].each do |file|
       if Pubgen::OPF.valid_manifest_element?(file) == false
         raise "Invalid manifest (not in sub-directory of yaml file): " + file
       end
       target_dir = "#{$tmpdir}/#{File.dirname(file)}"
       FileUtils.mkdir_p(target_dir)
-      FileUtils.cp("#{File.dirname(options[:yaml_path])}/#{file}", target_dir, :verbose=>options[:verbose])
+      FileUtils.cp("#{File.dirname(options[:yaml_path])}/#{file}", 
+                   target_dir, :verbose=>options[:verbose])
     end
 
     # change pwd
@@ -119,15 +121,16 @@ begin
   end
 
   # generate container.xml 
-  # it's name and path are fixed (META-INF/container.xml)
+  # it's path is fixed (META-INF/container.xml)
   Dir.mkdir('META-INF') if !File::directory?('META-INF')
   container = File.new('META-INF/container.xml', 'w')
   container.write(Pubgen::Container.generate)
   container.close
-  pubgen_log('cat > META-INF/container.xml', options[:meta_file_only] || options[:verbose])
+  pubgen_log('cat > META-INF/container.xml', 
+             options[:meta_file_only] || options[:verbose])
 
   # generate mimetype
-  # it's name and path are also fixed (./mimetype)
+  # it's path is also fixed (./mimetype)
   mimetype = File.new('mimetype', 'w')
   mimetype.write('application/epub+zip')
   mimetype.close
@@ -135,12 +138,13 @@ begin
 
   # pubgen automatically generates cover page if cover-image is given without 
   # cover-page
-  if Pubgen::CoverPage.need_to_generate?(yaml['guide'])
+  if yaml['guide']['cover-image'] != nil && yaml['guide']['cover-page'] == nil
     COVER_PAGE_PATH = 'cover-pubgen.xhtml'
     cover_page = File.new(COVER_PAGE_PATH, 'w')
     cover_page.write(Pubgen::CoverPage.generate(yaml['guide']['cover-image']))
     cover_page.close
-    pubgen_log("cat > " + COVER_PAGE_PATH, options[:meta_file_only] || options[:verbose])
+    pubgen_log("cat > " + COVER_PAGE_PATH, 
+               options[:meta_file_only] || options[:verbose])
 
     # add/set it to manifest, spine, and cover-page
     yaml['manifest'] << COVER_PAGE_PATH
@@ -149,24 +153,26 @@ begin
   end
 
   # generate uuid
-  uuid = "%08x" % Time.now.to_i + "-" + [4,4,4,12].map {|l| "%0#{l}x" % rand(1 << l*4) }.join('-')
-  # require 'uuid'
+  uuid = "%08x-" % Time.now.to_i + 
+            [4,4,4,12].map {|l| "%0#{l}x" % rand(1 << l*4) }.join('-')
   # uuid = UUID.new.generate
 
-  # generate opf file
+  # generate .opf file
   opf = File.new(Pubgen::Container.opf_path, 'w')
   opf.write(Pubgen::OPF.generate(yaml, uuid))
   opf.close
-  pubgen_log("cat > " + Pubgen::Container.opf_path, options[:meta_file_only] || options[:verbose])
-  # pubgen automatically added ncx file to opf's manifest (but not to yaml[]'s)
+  pubgen_log("cat > " + Pubgen::Container.opf_path, 
+             options[:meta_file_only] || options[:verbose])
+  # pubgen automatically added .ncx file to opf's manifest
 
-  # generate ncx file
+  # generate .ncx file
   ncx = File.new(Pubgen::OPF.ncx_path, 'w')
   ncx.write(Pubgen::NCX.generate(yaml['metadata']['title'], yaml['toc'], uuid))
   ncx.close
-  pubgen_log("cat > " + Pubgen::OPF.ncx_path, options[:meta_file_only] || options[:verbose])
+  pubgen_log("cat > " + Pubgen::OPF.ncx_path, 
+             options[:meta_file_only] || options[:verbose])
 
-  # generate epub
+  # make an epub
   if !options[:meta_file_only]
     Zip::Archive.open("pubgen.epub", Zip::CREATE | Zip::TRUNC) do |ar|
       Dir.glob('**/*').each do |path|
@@ -183,7 +189,8 @@ begin
     Dir.chdir($pwd_old)
     pubgen_log("cd " + $pwd_old, options[:verbose])
     FileUtils.mv($tmpdir + "/pubgen.epub", options[:epub_path])
-    pubgen_log("mv #{$tmpdir} /pubgen.epub '#{options[:epub_path]}'", options[:verbose])
+    pubgen_log("mv #{$tmpdir}/pubgen.epub '#{options[:epub_path]}'", 
+               options[:verbose])
   end
 rescue Exception=>e
   $exit_code = 1

data/lib/pubgen.rb

@@ -2,3 +2,4 @@ require 'pubgen/cover_page'
 require 'pubgen/ncx'
 require 'pubgen/opf'
 require 'pubgen/container'
+require 'pubgen/version'

data/lib/pubgen/container.rb

@@ -7,11 +7,11 @@ module Pubgen
     def self.generate
       <<EOF
 <?xml version="1.0"?>
-<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container"
-> 
+<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:\
+container">
   <rootfiles>
-    <rootfile full-path="#{opf_path}" media-type="application/oebps-package+xml"
-/>  
+    <rootfile full-path="#{opf_path}" media-type="application/\
+oebps-package+xml"/>
   </rootfiles>
 </container>
 EOF

data/lib/pubgen/cover_page.rb

@@ -1,9 +1,5 @@
 module Pubgen
   module CoverPage
-    def self.need_to_generate?(guide)
-      guide['cover-image'] != nil && guide['cover-page'] == nil
-    end
-
     def self.generate(cover_image)
       <<EOF
 <?xml version='1.0' encoding='utf-8'?>
@@ -19,7 +15,9 @@ module Pubgen
   </head>
   <body>
     <div>
-      <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="100%" height="100%" viewBox="0 0 469 616" preserveAspectRatio="xMinYMin">
+      <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/\
+1999/xlink" version="1.1" width="100%" height="100%" viewBox="0 0 469 616" \
+preserveAspectRatio="xMinYMin">
         <image width="469" height="616" xlink:href="#{cover_image}"/>
       </svg>
     </div>

data/lib/pubgen/ncx.rb

@@ -2,72 +2,68 @@ module Pubgen
   module NCX
     def self.generate(title, toc, uuid)
       # header
-      toc_xml = TOC_XML_HEADER_FORMAT % [uuid, CGI.escapeHTML(title || '')]
-      # NavPoint traces indentation, so we need class and instantiation of it
-      nav_point = NavPointImpl.new
-      toc.each do |name_and_path|
-        toc_xml += nav_point.generate(name_and_path)
-      end
-      # footer
-      toc_xml += TOC_XML_FOOTER
-    end
-
-    # define NavPointImpl class and some constants
-    # they are all private, only Pubgen.NCX.generate use them
-    NAVPOINT_XML_HEADER_FORMAT = <<EOF
-    <navPoint id="d%03d" playOrder="%d">
-      <navLabel>
-        <text>%s</text>
-      </navLabel>
-      <content src="%s"/>
-EOF
-    NAVPOINT_XML_FOOTER = "    </navPoint>\n"
-    TOC_XML_HEADER_FORMAT = <<EOF
+      toc_xml = <<EOF
 <?xml version='1.0' encoding='utf-8'?>
-<ncx xmlns="http://www.daisy.org/z3986/2005/ncx/" version="2005-1" xml:lang="en">
+<ncx xmlns="http://www.daisy.org/z3986/2005/ncx/" version="2005-1" \
+xml:lang="en">
   <head>
-    <meta content="%s" name="dtb:uid"/>
+    <meta content="#{uuid}" name="dtb:uid"/>
     <meta content="2" name="dtb:depth"/>
     <meta content="pubgen" name="dtb:generator"/>
     <meta content="0" name="dtb:totalPageCount"/>
     <meta content="0" name="dtb:maxPageNumber"/>
   </head>
   <docTitle>
-    <text>%s</text>
+    <text>#{CGI.escapeHTML(title || '')}</text>
   </docTitle>
   <navMap>
 EOF
-    TOC_XML_FOOTER = "  </navMap>\n</ncx>"
+      # NavPoint traces indentation, so we need class and instantiation of it
+      nav_point = NavPointImpl.new
+      toc.each do |name_and_path|
+        toc_xml += nav_point.generate(name_and_path)
+      end
+      # footer
+      toc_xml += "  </navMap>\n</ncx>"
+    end
 
+    # define NavPointImpl class
+    # it's private. only Pubgen.NCX.generate use it
     class NavPointImpl
       private
       def generate_impl(name_and_path, depth)
-        header = NAVPOINT_XML_HEADER_FORMAT
-        footer = NAVPOINT_XML_FOOTER
-        @toc_indent_order += 1
+        header = <<EOF
+    <navPoint id="d%03d" playOrder="%d">
+      <navLabel>
+        <text>%s</text>
+      </navLabel>
+      <content src="%s"/>
+EOF
+        footer = "    </navPoint>\n"
         if depth
           depth.times do
-            header = header.gsub(/^/, '  ')
-            footer = footer.gsub(/^/, '  ')
+            header.gsub!(/^/, '  ')
+            footer.gsub!(/^/, '  ')
           end
         end
 
+        @play_order += 1
         navpoint_xml = ''
         if name_and_path.is_a?(String)
           if name_and_path.split(" -- ").size != 2
             raise "Bad toc contents format: " + name_and_path 
           end
-          navpoint_xml = header % [@toc_indent_order, @toc_indent_order, 
-                CGI.escapeHTML(name_and_path.split(" -- ")[0]), 
-                name_and_path.split(" -- ")[1]]
+          navpoint_xml = header % [@play_order, @play_order, 
+            CGI.escapeHTML(name_and_path.split(" -- ")[0]), 
+            name_and_path.split(" -- ")[1]]
         else
           # if not string, it's hash map with just one element
           name_and_path.each do |key, value|
             if key.split(" -- ").size != 2
               raise "Bad toc contents format: " + key 
             end
-            navpoint_xml = header % [@toc_indent_order, @toc_indent_order, 
-                CGI.escapeHTML(key.split(" -- ")[0]), key.split(" -- ")[1]]
+            navpoint_xml = header % [@play_order, @play_order, 
+              CGI.escapeHTML(key.split(" -- ")[0]), key.split(" -- ")[1]]
             value.each do |v|
               navpoint_xml += generate_impl(v, depth + 1)
             end
@@ -79,7 +75,7 @@ EOF
 
       public
       def initialize
-        @toc_indent_order = 0
+        @play_order = 0
       end
 
       def generate(name_and_path)

data/lib/pubgen/opf.rb

@@ -3,49 +3,32 @@ require 'cgi'
 module Pubgen
   module OPF
     def self.ncx_path
-      NCX_PATH
+      'toc.ncx'
     end
 
     def self.generate(yaml, uuid)
       cover_id, manifest_xml, file2id = 
-            OPFImpl.get_cover_id_and_manifest_xml(yaml['guide']['cover-image'], 
-                                                  yaml['manifest'])
+        OPFImpl.get_cover_id_and_manifest_xml(yaml['guide']['cover-image'], 
+                                              yaml['manifest'])
       metadata_xml = OPFImpl.get_metadata_xml(yaml['metadata'], uuid, cover_id)
       spine_xml = OPFImpl.get_spine_xml(yaml['spine'], file2id)
       guide_xml = OPFImpl.get_guide_xml(yaml['guide'], file2id)
-      return OPF_XML_HEADER + metadata_xml + manifest_xml + spine_xml + 
-            guide_xml + OPF_XML_FOOTER
+
+      <<EOF
+<?xml version='1.0' encoding='utf-8'?>
+<package xmlns="http://www.idpf.org/2007/opf" version="2.0" \
+unique-identifier="uuid_id">
+#{metadata_xml}#{manifest_xml}#{spine_xml}#{guide_xml}</package>
+EOF
     end
 
+    # sub directories and relative paths
     def self.valid_manifest_element?(e)
       e[0..2] != "../" && e[0] != "/"
     end
 
-    # define OPFImpl class and some constants
-    # they are all private, only Pubgen.OPF.generate use them
-    NCX_PATH = "toc.ncx"
-    METADATA_FORMAT = <<EOF
-  <metadata xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:opf="http://www.idpf.org/2007/opf">
-    <dc:title>%s</dc:title>
-    <dc:creator opf:role="aut">%s</dc:creator>
-    <dc:date>%s</dc:date>
-    <dc:language>%s</dc:language>
-    <dc:subject>%s</dc:subject>
-    <dc:publisher>%s</dc:publisher>
-    <dc:description>%s</dc:description>
-    <dc:contributor opf:role="bkp">%s</dc:contributor>
-    <dc:source>%s</dc:source>
-    <dc:rights>%s</dc:rights>
-    <dc:relation>%s</dc:relation>
-    <dc:identifier id="BookID" opf:scheme="UUID">%s</dc:identifier>%s
-  </metadata>
-EOF
-    OPF_XML_HEADER = <<EOF
-<?xml version='1.0' encoding='utf-8'?>
-<package xmlns="http://www.idpf.org/2007/opf" version="2.0" unique-identifier="uuid_id">
-EOF
-    OPF_XML_FOOTER = '</package>'
-
+    # define OPFImpl class
+    # it's private. only Pubgen.OPF.generate use it
     module OPFImpl
       def self.guess_media_type(filename)
         case filename.downcase
@@ -78,10 +61,12 @@ EOF
 
         manifest.each do |path|
           if OPF.valid_manifest_element?(path) == false
-            raise "One of manifest element (" + path + ") is not in sub-directory of yaml file"
+            raise "A manifest file, #{path} is not in sub-directory of " + 
+                  "yaml file"
           end
           id = "i%03d" % no
-          manifest_xml += "    <item id=\"#{id}\" href=\"#{path}\" media-type=\"#{guess_media_type(path)}\"/>\n"
+          manifest_xml += "    <item id=\"#{id}\" href=\"#{path}\" " + 
+                          "media-type=\"#{guess_media_type(path)}\"/>\n"
           if path == cover_path
             cover_id = id
           end
@@ -91,34 +76,45 @@ EOF
         end
 
         if cover_path && cover_id == nil
-          raise "Can't find cover-image from manifest" 
+          raise "Failed to find cover-image from manifest" 
         end
 
-        manifest_xml += "    <item id=\"ncx\" href=\"#{NCX_PATH}\" media-type=\"application/x-dtbncx+xml\"/>\n  </manifest>\n"
+        manifest_xml += "    <item id=\"ncx\" href=\"#{OPF.ncx_path}\" " + 
+                "media-type=\"application/x-dtbncx+xml\"/>\n  </manifest>\n"
 
         return cover_id, manifest_xml, file2id
       end
 
+      def self.cgi_escape(text)
+        CGI.escapeHTML(text || '')
+      end
+
       def self.get_metadata_xml(metadata, uuid, cover_id)
         cover_id_xml = ''
         if cover_id != nil
-          cover_id_xml = "\n    <meta name=\"cover\" content=\"%s\"/>" % cover_id
+          cover_id_xml = "\n    <meta name=\"cover\" content=\"#{cover_id}\"/>"
         end
-        METADATA_FORMAT % [
-          CGI.escapeHTML(metadata['title'] || ''),
-          CGI.escapeHTML(metadata['creator'] || ''), 
-          CGI.escapeHTML((metadata['date'].is_a?(Fixnum) ? 
-                          metadata['date'].to_s : metadata['date']) || ''), 
-          CGI.escapeHTML(metadata['language'] || ''), 
-          CGI.escapeHTML(metadata['subject'] || ''), 
-          CGI.escapeHTML(metadata['publisher'] || ''), 
-          CGI.escapeHTML(metadata['description'] || ''), 
-          CGI.escapeHTML(metadata['contributor'] || ''), 
-          CGI.escapeHTML(metadata['source'] || ''), 
-          CGI.escapeHTML(metadata['rights'] || ''), 
-          CGI.escapeHTML(metadata['relation'] || ''), 
-          uuid, cover_id_xml
-        ]
+        <<EOF
+  <metadata xmlns:dc="http://purl.org/dc/elements/1.1/" \
+xmlns:opf="http://www.idpf.org/2007/opf">
+    <dc:title>#{cgi_escape(metadata['title'])}</dc:title>
+    <dc:creator opf:role="aut">#{cgi_escape(metadata['creator'])}\
+</dc:creator>
+    <dc:date>#{cgi_escape((metadata['date'].is_a?(Fixnum) ? \
+metadata['date'].to_s : metadata['date']))}</dc:date>
+    <dc:language>#{cgi_escape(metadata['language'])}</dc:language>
+    <dc:subject>#{cgi_escape(metadata['subject'])}</dc:subject>
+    <dc:publisher>#{cgi_escape(metadata['publisher'])}</dc:publisher>
+    <dc:description>#{cgi_escape(metadata['description'])}</dc:description>
+    <dc:contributor opf:role="bkp">#{cgi_escape(metadata['contributor'])}\
+</dc:contributor>
+    <dc:source>#{cgi_escape(metadata['source'])}</dc:source>
+    <dc:rights>#{cgi_escape(metadata['rights'])}</dc:rights>
+    <dc:relation>#{cgi_escape(metadata['relation'])}</dc:relation>
+    <dc:identifier id="BookID" opf:scheme="UUID">#{uuid}</dc:identifier>\
+#{cover_id_xml}
+  </metadata>
+EOF
       end
 
       def self.get_guide_xml(guide, file2id)
@@ -126,25 +122,28 @@ EOF
         cover_page = guide['cover-page']
         if cover_page != nil
           if file2id[cover_page] == nil
-            raise "Can't find cover-page from manifest" 
+            raise "Failed to find cover-page from manifest" 
           else
-            guide_xml += "    <reference href=\"%s\" type=\"cover\" title=\"Cover\"/>\n" % cover_page
+            guide_xml += "    <reference href=\"#{cover_page}\" " + 
+              "type=\"cover\" title=\"Cover\"/>\n"
           end
         end
         toc_page =  guide['toc-page']
         if toc_page != nil
           if file2id[toc_page] == nil
-            raise "Can't find toc-page from manifest" 
+            raise "Failed to find toc-page from manifest" 
           else
-            guide_xml += "    <reference href=\"%s\" type=\"toc\" title=\"Table of Contents\"/>\n" % toc_page
+            guide_xml += "    <reference href=\"#{toc_page}\" type=\"toc\" " + 
+              "title=\"Table of Contents\"/>\n"
           end
         end
         title_page =  guide['title-page']
         if title_page != nil
           if file2id[title_page] == nil
-            raise "Can't find title-page from manifest" 
+            raise "Failed to find title-page from manifest" 
           else
-            guide_xml += "    <reference href=\"%s\" type=\"title-page\" title=\"Title Page\"/>\n" % toc_page
+            guide_xml += "    <reference href=\"#{title_page}\" " + 
+              "type=\"title-page\" title=\"Title Page\"/>\n"
           end
         end
         guide_xml += "  </guide>\n"
@@ -156,7 +155,7 @@ EOF
           if file2id[path] != nil
             spine_xml += "    <itemref idref=\"#{file2id[path]}\"/>\n"
           else
-            raise "Can't find spine element `#{path}' from manifest"
+            raise "Failed to find spine element `#{path}' from manifest"
           end
         end
         spine_xml += "  </spine>\n"

data/lib/pubgen/version.rb

@@ -0,0 +1,3 @@
+module Pubgen
+  VERSION = "0.1.3"
+end

data/pubgen.gemspec

@@ -1,8 +1,11 @@
 # -*- encoding: utf-8 -*-
 
+$:.push File.expand_path("../lib", __FILE__)
+require "pubgen/version"
+
 Gem::Specification.new do |s|
   s.name                  = "pubgen"
-  s.version               = "0.1.2"
+  s.version               = Pubgen::VERSION
   s.platform              = Gem::Platform::RUBY
   s.author                = "9beach"
   s.email                 = ["9beach@gmail.com"]
@@ -12,6 +15,6 @@ Gem::Specification.new do |s|
   s.bindir                = 'bin'
   s.require_paths         = ["lib"]
   s.summary               = "command-line based epub generator"
-  s.description           = "Pubgen is a simple command-line based epub generator. With the simple YAML file, Pubgen generate the epub file for you."
+  s.description           = "Pubgen is a simple command-line based epub generator. With a plain YAML, Pubgen generate the epub for you."
   s.add_dependency        "zipruby"
 end

data/test/helper.rb

@@ -0,0 +1 @@
+require 'pubgen'

data/test/test_cover_page.rb

@@ -0,0 +1,11 @@
+require 'test/unit'
+require 'yaml'
+
+require 'helper'
+
+class TestCoverPage < Test::Unit::TestCase
+  def test_generate
+    xml = Pubgen::CoverPage.generate("test.jpg")
+    assert_match(/<image.*"test.jpg"\/>/, xml)
+  end
+end

data/test/test_ncx.rb

@@ -0,0 +1,90 @@
+require 'test/unit'
+require 'yaml'
+
+require 'helper'
+
+$test_yaml = <<EOF
+metadata:
+  title: "Will Oldham"
+  creator: Wikipedia
+  date: 2012
+  language: en
+  subject: American alternative country singers
+  publisher: 9beach
+  contributor: 9valley
+  description: describe here
+  source: "http://en.wikipedia.org/wiki/Will_Oldham"
+  rights: I've got no right
+  relation: bad relation
+
+guide:
+  toc-page: contents/a.html
+  title-page: contents/b.html
+  cover-page: contents/c.html
+  cover-image: images/cover.jpg
+
+manifest:
+  - contents/a.html
+  - contents/b.html
+  - contents/c.html
+  - images/cover.jpg
+  - images/1.jpg
+  - images/2.jpg
+  - images/3.jpg
+  - style.css
+
+spine:
+  - contents/a.html
+  - contents/b.html
+  - contents/c.html
+
+toc:
+  - 1 Music -- contents/a.html:
+    - 1.1 Discography -- contents/a.html#discography: 
+      - 1.1.1 Studio albums -- contents/a.html#studio_albums
+    - 1.2 Response -- contents/a.html#response
+  - 2 Film -- contents/b.html:
+    - 2.1 Filmography -- contents/b.html#filmography
+  - 3 Photography -- contents/b.html#photography
+  - 4 References -- contents/b.html#references
+  - 5 External links -- contents/c.html
+EOF
+
+class TestNCX < Test::Unit::TestCase
+  def setup
+    $yaml = YAML::load $test_yaml
+  end
+
+  def test_generate
+    xml = Pubgen::NCX.generate('English Patient', $yaml['toc'], '1111')
+
+    assert_match(/<meta content="1111" name="dtb:uid"\/>/, xml)
+    assert_match(/^    <navPoint id="d001" playOrder="1">/, xml)
+    assert_match(/^      <content src="contents\/a.html"/, xml)
+    assert_match(/^        <text>1 Music</, xml)
+    assert_match(/^      <navPoint id="d002" playOrder="2">/, xml)
+    assert_match(/^        <content src="contents\/a.html#discography"/, xml)
+    assert_match(/^          <text>1.1 Discography</, xml)
+    assert_match(/^        <navPoint id="d003" playOrder="3">/, xml)
+    assert_match(/^          <content src="contents\/a.html#studio_albums"/, xml)
+    assert_match(/^            <text>1.1.1 Studio albums</, xml)
+    assert_match(/^      <navPoint id="d004" playOrder="4">/, xml)
+    assert_match(/^        <content src="contents\/a.html#response"/, xml)
+    assert_match(/^          <text>1.2 Response</, xml)
+    assert_match(/^    <navPoint id="d005" playOrder="5">/, xml)
+    assert_match(/^      <content src="contents\/b.html"/, xml)
+    assert_match(/^        <text>2 Film</, xml)
+    assert_match(/^      <navPoint id="d006" playOrder="6">/, xml)
+    assert_match(/^        <content src="contents\/b.html#filmography"/, xml)
+    assert_match(/^          <text>2.1 Filmography</, xml)
+    assert_match(/^    <navPoint id="d007" playOrder="7">/, xml)
+    assert_match(/^      <content src="contents\/b.html#photography"/, xml)
+    assert_match(/^        <text>3 Photography</, xml)
+    assert_match(/^    <navPoint id="d008" playOrder="8">/, xml)
+    assert_match(/^      <content src="contents\/b.html#references"/, xml)
+    assert_match(/^        <text>4 References</, xml)
+    assert_match(/^    <navPoint id="d009" playOrder="9">/, xml)
+    assert_match(/^      <content src="contents\/c.html"/, xml)
+    assert_match(/^        <text>5 External links</, xml)
+  end
+end

data/test/test_opf.rb

@@ -0,0 +1,112 @@
+require 'test/unit'
+require 'yaml'
+
+require 'helper'
+
+$test_yaml = <<EOF
+metadata:
+  title: "Will Oldham"
+  creator: Wikipedia
+  date: 2012
+  language: en
+  subject: American alternative country singers
+  publisher: 9beach
+  contributor: 9valley
+  description: describe here
+  source: "http://en.wikipedia.org/wiki/Will_Oldham"
+  rights: I've got no right
+  relation: bad relation
+
+guide:
+  toc-page: contents/a.html
+  title-page: contents/b.html
+  cover-page: contents/c.html
+  cover-image: images/cover.jpg
+
+manifest:
+  - contents/a.html
+  - contents/b.html
+  - contents/c.html
+  - images/cover.jpg
+  - images/1.jpg
+  - images/2.jpg
+  - images/3.jpg
+  - style.css
+
+spine:
+  - contents/a.html
+  - contents/b.html
+  - contents/c.html
+
+toc:
+  - 1 Music -- contents/a.html:
+    - 1.1 Discography -- contents/a.html#discography: 
+      - 1.1.1 Studio albums -- contents/a.html#studio_albums
+    - 1.2 Response -- contents/a.html#response
+  - 2 Film -- contents/b.html:
+    - 2.1 Filmography -- contents/b.html#filmography
+  - 3 Photography -- contents/b.html#photography
+  - 4 References -- contents/b.html#references
+  - 5 External links -- contents/c.html
+EOF
+
+class TestOPF < Test::Unit::TestCase
+  def setup
+    $yaml = YAML::load $test_yaml
+  end
+
+  def test_metadata
+    xml = Pubgen::OPF.generate($yaml, 'aaaaaaaa-1111')
+    assert_match(/<dc:title>Will Oldham<\/dc:[^>].*>/, xml)
+    assert_match(/<dc:creator opf:role="aut">Wikipedia<\/dc:[^>].*>/, xml)
+    assert_match(/<dc:date>2012<\/dc:[^>].*>/, xml)
+    assert_match(/<dc:language>en<\/dc:[^>].*>/, xml)
+    assert_match(/<dc:subject>American alternative country singers<\/dc:[^>].*>/, xml)
+    assert_match(/<dc:publisher>9beach<\/dc:[^>].*>/, xml)
+    assert_match(/<dc:description>describe here<\/dc:[^>].*>/, xml)
+    assert_match(/<dc:source>http:\/\/en.wikipedia.org\/wiki\/Will_Oldham<\/dc:[^>].*>/, xml)
+    assert_match(/<dc:rights>I've got no right<\/dc:[^>].*>/, xml)
+    assert_match(/<dc:relation>bad relation<\/dc:[^>].*>/, xml)
+    assert_match(/<dc:contributor opf:role="bkp">9valley<\/dc:[^>].*>/, xml)
+    assert_match(/<dc:identifier id="BookID" opf:scheme="UUID">aaaaaaaa-1111<\/dc:[^>].*>/, xml)
+  end
+
+  def test_guide
+    xml = Pubgen::OPF.generate($yaml, 'aaaaaaaa')
+
+    assert_match(/reference href="contents\/a.html" type="toc"/, xml)
+    assert_match(/reference href="contents\/b.html" type="title-page"/, xml)
+    assert_match(/reference href="contents\/c.html" type="cover"/, xml)
+    assert_match(/<meta name="cover" content/, xml)
+
+    $yaml['guide']['cover-image'] = nil
+    xml = Pubgen::OPF.generate($yaml, 'aaaaaaa')
+    assert_no_match(/<meta name="cover" content/, xml)
+  end
+
+  def test_manifest
+    xml = Pubgen::OPF.generate($yaml, 'a')
+    assert_match(/item id="i001" href="contents\/a.html" media-type="application\/xhtml\+xml"\/>/, xml)
+    assert_match(/item id="i002" href="contents\/b.html" media-type="application\/xhtml\+xml"\/>/, xml)
+    assert_match(/item id="i003" href="contents\/c.html" media-type="application\/xhtml\+xml"\/>/, xml)
+    assert_match(/item id="i004" href="images\/cover.jpg" media-type="image\/jpeg"\/>/, xml)
+    assert_match(/item id="i005" href="images\/1.jpg" media-type="image\/jpeg"\/>/, xml)
+    assert_match(/item id="i006" href="images\/2.jpg" media-type="image\/jpeg"\/>/, xml)
+    assert_match(/item id="i007" href="images\/3.jpg" media-type="image\/jpeg"\/>/, xml)
+    assert_match(/item id="i008" href="style.css" media-type="text\/css"\/>/, xml)
+    assert_match(/item id="ncx" href="#{Pubgen::OPF.ncx_path}" media-type="application\/x-dtbncx\+xml"\/>/, xml)
+  end
+
+  def test_spine
+    xml = Pubgen::OPF.generate($yaml, 'aaaaaaaa-1111')
+    assert_match(/<itemref idref="i001"\/>/, xml)
+    assert_match(/<itemref idref="i002"\/>/, xml)
+    assert_match(/<itemref idref="i003"\/>/, xml)
+    assert_no_match(/<itemref idref="i004"\/>/, xml)
+    assert_no_match(/<itemref idref="i005"\/>/, xml)
+    assert_no_match(/<itemref idref="i006"\/>/, xml)
+    assert_no_match(/<itemref idref="i007"\/>/, xml)
+    assert_no_match(/<itemref idref="i008"\/>/, xml)
+    assert_no_match(/<itemref idref="ncx"\/>/, xml)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pubgen
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-26 00:00:00.000000000Z
+date: 2012-02-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zipruby
-  requirement: &2157391000 !ruby/object:Gem::Requirement
+  requirement: &15276980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,9 +21,9 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157391000
-description: Pubgen is a simple command-line based epub generator. With the simple
-  YAML file, Pubgen generate the epub file for you.
+  version_requirements: *15276980
+description: Pubgen is a simple command-line based epub generator. With a plain YAML,
+  Pubgen generate the epub for you.
 email:
 - 9beach@gmail.com
 executables:
@@ -34,13 +34,19 @@ files:
 - .gitignore
 - LICENSE
 - README.md
+- Rakefile
 - bin/pubgen
 - lib/pubgen.rb
 - lib/pubgen/container.rb
 - lib/pubgen/cover_page.rb
 - lib/pubgen/ncx.rb
 - lib/pubgen/opf.rb
+- lib/pubgen/version.rb
 - pubgen.gemspec
+- test/helper.rb
+- test/test_cover_page.rb
+- test/test_ncx.rb
+- test/test_opf.rb
 homepage: https://github.com/9beach/pubgen
 licenses: []
 post_install_message: