eeepub3 0.0.1

data/lib/eeepub/ncx.rb

@@ -0,0 +1,67 @@
+module EeePub
+  class NCX < ContainerItem
+    attr_accessor :uid,
+                  :depth,
+                  :total_page_count,
+                  :max_page_number,
+                  :doc_title,
+                  :nav_map
+
+    attr_alias :title, :doc_title
+    attr_alias :nav, :nav_map
+
+    default_value :depth, 1
+    default_value :total_page_count, 0
+    default_value :max_page_number, 0
+    default_value :doc_title, 'Untitled'
+
+    def build_xml(builder)
+      builder.ncx 'xmlns:ncx' => 'http://www.daisy.org/z3986/2005/ncx/', :version => '2005-1', :xmlns => 'http://www.daisy.org/z3986/2005/ncx/', 'xml:lang' => 'en' do
+        build_head(builder)
+        builder.docTitle { builder.text doc_title }
+        build_nav_map(builder)
+      end
+    end
+
+    def build_head(builder)
+      builder.head do
+        {
+          :uid => uid,
+          :depth => depth,
+          :totalPageCount => total_page_count,
+          :maxPageNumber => max_page_number
+        }.each do |k, v|
+          builder.meta :name => "dtb:#{k}", :content => v
+        end
+      end
+    end
+
+    def build_nav_map(builder)
+      builder.navMap do
+        builder_nav_point(builder, nav_map)
+      end
+    end
+
+    def builder_nav_point(builder, nav_point, play_order = 1)
+      case nav_point
+      when Array
+        nav_point.each do |point|
+          play_order = builder_nav_point(builder, point, play_order)
+        end
+      when Hash
+        id = nav_point[:id] || "navPoint-#{play_order}"
+        builder.navPoint :id => id, :playOrder => play_order do
+          builder.navLabel { builder.text nav_point[:label] }
+          builder.content :src => nav_point[:content]
+          play_order += 1
+          if nav_point[:nav]
+            play_order = builder_nav_point(builder, nav_point[:nav], play_order)
+          end
+        end
+      else
+        raise "nav_point must be Array or Hash"
+      end
+      play_order
+    end
+  end
+end

data/lib/eeepub/ocf.rb

@@ -0,0 +1,131 @@
+require 'zip'
+
+module EeePub
+  # Class to create OCF
+  class OCF
+    # Class for 'container.xml' of OCF
+    class Container < ContainerItem
+      attr_accessor :rootfiles
+
+      # @param [String or Array or Hash]
+      #
+      # @example
+      #   # with String
+      #   EeePub::OCF::Container.new('container.opf')
+      #
+      # @example
+      #   # with Array
+      #   EeePub::OCF::Container.new(['container.opf', 'other.opf'])
+      #
+      # @example
+      #   # with Hash
+      #   EeePub::OCF::Container.new(
+      #     :rootfiles => [
+      #       {:full_path => 'container.opf', :media_type => 'application/oebps-package+xml'}
+      #     ]
+      #   )
+      def initialize(arg)
+        case arg
+        when String
+          set_values(
+            :rootfiles => [
+              {:full_path => arg, :media_type => guess_media_type(arg)}
+            ]
+          )
+        when Array
+          # TODO: spec
+          set_values(
+            :rootfiles => arg.keys.map { |k|
+              filename = arg[k]
+              {:full_path => filename, :media_type => guess_media_type(filename)}
+            }
+          )
+        when Hash
+          set_values(arg)
+        end
+      end
+
+      private
+
+      def build_xml(builder)
+        builder.container :xmlns => "urn:oasis:names:tc:opendocument:xmlns:container", :version => "1.0" do
+          builder.rootfiles do
+            rootfiles.each do |i|
+              builder.rootfile convert_to_xml_attributes(i)
+            end
+          end
+        end
+      end
+    end
+
+    attr_accessor :dir, :container
+
+    # @param [Hash<Symbol, Object>] values the values of symbols and objects for OCF
+    #
+    # @example
+    #   EeePub::OCF.new(
+    #     :dir => '/path/to/dir',
+    #     :container => 'container.opf'
+    #   )
+    def initialize(values)
+      values.each do |k, v|
+        self.send(:"#{k}=", v)
+      end
+    end
+
+    # Set container
+    #
+    # @param [EeePub::OCF::Container or args for EeePub::OCF::Container]
+    def container=(arg)
+      if arg.is_a?(EeePub::OCF::Container)
+        @container = arg
+      else
+        # TODO: spec
+        @container = EeePub::OCF::Container.new(arg)
+      end
+    end
+
+    # Save as OCF
+    #
+    # @param [String] output_path the output file path of ePub
+    def save(output_path)
+      output_path = File.expand_path(output_path)
+
+      create_epub do
+        mimetype = Zip::ZipOutputStream::open(output_path) do |os|
+          os.put_next_entry("mimetype", nil, nil, Zip::ZipEntry::STORED, Zlib::NO_COMPRESSION)
+          os << "application/epub+zip"
+        end
+        zipfile = Zip::ZipFile.open(output_path)
+        Dir.glob('**/*').each do |path|
+          zipfile.add(path, path)
+        end
+        zipfile.commit
+      end
+      FileUtils.remove_entry_secure dir
+    end
+    
+    # Stream OCF
+    #
+    # @return [String] streaming output of the zip/epub file.
+    def render
+      create_epub do
+        temp_file = Tempfile.new("ocf")
+        self.save(temp_file.path)
+        return temp_file.read
+      end
+    end
+
+    private
+    def create_epub
+      FileUtils.chdir(dir) do
+        meta_inf = 'META-INF'
+        FileUtils.mkdir_p(meta_inf)
+
+        container.save(File.join(meta_inf, 'container.xml'))
+        yield
+      end
+
+    end
+  end
+end

data/lib/eeepub/opf.rb

@@ -0,0 +1,154 @@
+module EeePub
+  class OPF < ContainerItem
+    attr_accessor :unique_identifier,
+                  :title,
+                  :language,
+                  :identifier,
+                  :date,
+                  :subject,
+                  :description,
+                  :relation,
+                  :creator,
+                  :publisher,
+                  :rights,
+                  :manifest,
+                  :spine,
+                  :guide,
+                  :cover,
+                  :ncx,
+                  :toc
+
+    default_value :toc, 'ncx'
+    default_value :unique_identifier, 'BookId'
+    default_value :title, 'Untitled'
+    default_value :language, 'en'
+
+    attr_alias :files, :manifest
+
+    def identifier
+      case @identifier
+      when Array
+        @identifier
+      when String
+        [{:value => @identifier, :id => unique_identifier}]
+      when Hash
+        @identifier[:id] = unique_identifier
+        [@identifier]
+      else
+        @identifier
+      end
+    end
+
+    def spine
+      @spine ||
+        complete_manifest.
+          select { |i| i[:media_type] == 'application/xhtml+xml' }.
+          map { |i| i[:id]}
+    end
+
+    def build_xml(builder)
+      builder.package :xmlns => 'http://www.idpf.org/2007/opf',
+          'unique-identifier' => 'uid',
+          'xml:lang' => 'en-US',
+          'prefix'=> 'cc: http://creativecommons.org/ns#',
+          'version' => '3.0' do
+
+        build_metadata(builder)
+        build_manifest(builder)
+        build_spine(builder)
+        build_guide(builder)
+      end
+    end
+
+    def build_metadata(builder)
+      builder.metadata 'xmlns:dc' => "http://purl.org/dc/elements/1.1/" do
+        identifier.each do |i|
+          attrs = {}
+          attrs['opf:scheme'] = i[:scheme] if i[:scheme]
+          attrs[:id] = i[:id] if i[:id]
+          builder.dc :identifier, i[:value], attrs
+        end
+
+        [:title, :language, :subject, :description, :relation, :creator, :publisher, :date, :rights].each do |i|
+          value = self.send(i)
+          next unless value
+
+          [value].flatten.each do |v|
+            case v
+            when Hash
+              builder.dc i, v[:value], convert_to_xml_attributes(v.reject {|k, v| k == :value})
+            else
+              builder.dc i, v
+            end
+          end
+        end
+        builder.meta({:property => 'dcterms:modified'}, Time.now.strftime('%FT%TZ'))
+        builder.meta(:name => 'cover', :content => self.cover) if self.cover
+      end
+    end
+
+    def build_manifest(builder)
+      builder.manifest do
+        complete_manifest.each do |i|
+          if i[:media_type] == 'application/xhtml+xml'
+            builder.item :id => i[:id], :href => i[:href], 'media-type' => i[:media_type], 'properties' => i[:properties] || 'scripted'
+          else
+            builder.item :id => i[:id], :href => i[:href], 'media-type' => i[:media_type]
+          end
+        end
+      end
+    end
+
+    def build_spine(builder)
+      builder.spine :toc => toc do
+        spine.each do |i|
+          builder.itemref :idref => i
+        end
+      end
+    end
+
+    def build_guide(builder)
+      return if guide.nil? || guide.empty?
+
+      builder.guide do
+        guide.each do |i|
+          builder.reference convert_to_xml_attributes(i)
+        end
+      end
+    end
+
+    def complete_manifest
+      item_id_cache = {}
+
+      result = manifest.map do |i|
+        case i
+        when String
+          id = create_unique_item_id(i, item_id_cache)
+          href = i
+          media_type = guess_media_type(i)
+        when Hash
+          id = i[:id] || create_unique_item_id(i[:href], item_id_cache)
+          href = i[:href]
+          media_type = i[:media_type] || guess_media_type(i[:href])
+        end
+        {:id => id, :href => href, :media_type => media_type}
+      end
+
+      result += [{:id => 'nav', :href => 'nav.html', :media_type => 'application/xhtml+xml', :properties => 'nav'}]
+      result += [{:id => 'ncx', :href => ncx, :media_type => 'application/x-dtbncx+xml'}] if ncx
+      result
+    end
+
+    def create_unique_item_id(filename, id_cache)
+      basename = File.basename(filename)
+      unless id_cache[basename]
+        id_cache[basename] = 0
+        name = basename
+      else
+        name = "#{basename}-#{id_cache[basename]}"
+      end
+      id_cache[basename] += 1
+      name
+    end
+  end
+end

data/spec/eeepub/container_item_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "EeePub::ContainerItem" do
+  
+  context 'guess media type' do
+
+    before :each do
+      @container_item = EeePub::ContainerItem.new []
+    end
+
+    it 'should be application/xhtml+xml' do
+      media_type = 'application/xhtml+xml'
+      ['test.htm', 'test.html', 'test.xhtm', 'test.xhtml'].each do |file_name|
+        @container_item.send(:guess_media_type, file_name).should == media_type
+      end
+      @container_item.send(:guess_media_type, "test.xml").should_not == media_type
+    end
+  end
+
+end

data/spec/eeepub/easy_spec.rb

@@ -0,0 +1,66 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "EeePub::Easy" do
+  before do
+    @easy = EeePub::Easy.new do
+      title 'sample'
+      creator 'jugyo'
+      identifier 'http://example.com/book/foo', :scheme => 'URL'
+      uid 'http://example.com/book/foo'
+    end
+
+    @easy.sections << ['1. foo', <<HTML]
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja">
+  <head>
+    <title>foo</title>
+  </head>
+  <body>
+    <p>
+    foo foo foo foo foo foo
+    </p>
+  </body>
+</html>
+HTML
+
+    @easy.sections << ['2. bar', <<HTML]
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja">
+  <head>
+    <title>bar</title>
+  </head>
+  <body>
+    <p>
+    bar bar bar bar bar bar
+    </p>
+  </body>
+</html>
+HTML
+
+    @easy.assets << 'image.png'
+  end
+
+  it 'spec for prepare' do
+    Dir.mktmpdir do |dir|
+      mock(FileUtils).cp('image.png', dir)
+
+      @easy.send(:prepare, dir)
+
+      file1 = File.join(dir, 'section_0.html')
+      file2 = File.join(dir, 'section_1.html')
+      File.exists?(file1).should be_true
+      File.exists?(file2).should be_true
+      File.read(file1).should == @easy.sections[0][1]
+      File.read(file2).should == @easy.sections[1][1]
+
+      @easy.instance_variable_get(:@nav).should == [
+        {:label => '1. foo', :content => 'section_0.html'},
+        {:label => '2. bar', :content => 'section_1.html'}
+      ]
+
+      @easy.instance_variable_get(:@files).should == [file1, file2, 'image.png']
+    end
+  end
+end

data/spec/eeepub/maker_spec.rb

@@ -0,0 +1,131 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "EeePub::Maker" do
+  before do
+    @maker = EeePub::Maker.new do
+      title 'sample'
+      creator 'jugyo'
+      publisher 'jugyo.org'
+      date "2010-05-06"
+      language 'en'
+      subject 'epub sample'
+      description 'this is epub sample'
+      rights 'xxx'
+      relation 'xxx'
+      identifier 'http://example.com/book/foo', :scheme => 'URL'
+      uid 'http://example.com/book/foo'
+      ncx_file 'toc.ncx'
+      opf_file 'content.opf'
+      cover 'cover.jpg'
+      files ['foo.html', 'bar.html']
+      nav [
+        {:label => '1. foo', :content => 'foo.html'},
+        {:label => '1. bar', :content => 'bar.html'}
+      ]
+    end
+  end
+
+  it { @maker.instance_variable_get(:@titles).should == ['sample'] }
+  it { @maker.instance_variable_get(:@creators).should == ['jugyo'] }
+  it { @maker.instance_variable_get(:@publishers).should == ['jugyo.org'] }
+  it { @maker.instance_variable_get(:@dates).should == ["2010-05-06"] }
+  it { @maker.instance_variable_get(:@identifiers).should == [{:value => 'http://example.com/book/foo', :scheme => 'URL', :id => nil}] }
+  it { @maker.instance_variable_get(:@uid).should == 'http://example.com/book/foo' }
+  it { @maker.instance_variable_get(:@ncx_file).should == 'toc.ncx' }
+  it { @maker.instance_variable_get(:@opf_file).should == 'content.opf' }
+  it { @maker.instance_variable_get(:@cover).should == 'cover.jpg' }
+  it { @maker.instance_variable_get(:@files).should == ['foo.html', 'bar.html'] }
+  it { 
+    @maker.instance_variable_get(:@nav).should == [
+        {:label => '1. foo', :content => 'foo.html'},
+        {:label => '1. bar', :content => 'bar.html'}
+      ]
+  }
+
+  it 'should save' do
+    stub(FileUtils).cp.with_any_args
+    mock(Dir).mktmpdir { '/tmp' }
+    mock(EeePub::NCX).new(
+      :title => "sample",
+      :nav => [
+        {:label => '1. foo', :content => 'foo.html'},
+        {:label => '1. bar', :content => 'bar.html'}
+      ],
+      :uid=>{:value=>"http://example.com/book/foo", :scheme=>"URL", :id=>"http://example.com/book/foo"}
+    ) { stub!.save }
+    mock(EeePub::OPF).new(
+      :title => ["sample"],
+      :creator => ["jugyo"],
+      :date => ["2010-05-06"],
+      :language => ['en'],
+      :subject => ['epub sample'],
+      :description => ['this is epub sample'],
+      :rights => ['xxx'],
+      :relation => ['xxx'],
+      :ncx => "toc.ncx",
+      :cover => 'cover.jpg',
+      :publisher => ["jugyo.org"],
+      :unique_identifier=>"http://example.com/book/foo",
+      :identifier => [{:value => "http://example.com/book/foo", :scheme => "URL", :id => "http://example.com/book/foo"}],
+      :manifest => ['foo.html', 'bar.html']
+    ) { stub!.save }
+    mock(EeePub::OCF).new(
+      :container => "content.opf",
+      :dir => '/tmp'
+    ) { stub!.save }
+
+    @maker.save('test.epub')
+  end
+
+  describe "files as hash" do
+    before do
+      @maker = EeePub::Maker.new do
+        title 'sample'
+        creator 'jugyo'
+        publisher 'jugyo.org'
+        date "2010-05-06"
+        language 'en'
+        subject 'epub sample'
+        description 'this is epub sample'
+        rights 'xxx'
+        relation 'xxx'
+        identifier 'http://example.com/book/foo', :scheme => 'URL'
+        uid 'http://example.com/book/foo'
+        ncx_file 'toc.ncx'
+        opf_file 'content.opf'
+        cover 'cover.jpg'
+        files [{'foo.html' => 'foo/bar'}, {'bar.html' => 'foo/bar/baz'}]
+        nav [
+          {:label => '1. foo', :content => 'foo.html'},
+          {:label => '1. bar', :content => 'bar.html'}
+        ]
+      end
+    end
+
+    it 'should save' do
+      stub(FileUtils).cp.with_any_args
+      stub(FileUtils).mkdir_p.with_any_args
+      mock(Dir).mktmpdir { '/tmp' }
+      mock(EeePub::NCX).new.with_any_args { stub!.save }
+      mock(EeePub::OPF).new(
+        :title => ["sample"],
+        :creator => ["jugyo"],
+        :date => ["2010-05-06"],
+        :language => ['en'],
+        :subject => ['epub sample'],
+        :description => ['this is epub sample'],
+        :rights => ['xxx'],
+        :relation => ['xxx'],
+        :ncx => "toc.ncx",
+        :cover => 'cover.jpg',
+        :publisher => ["jugyo.org"],
+        :unique_identifier=>"http://example.com/book/foo",
+        :identifier => [{:value => "http://example.com/book/foo", :scheme => "URL", :id=>"http://example.com/book/foo"}],
+        :manifest => ["foo/bar/foo.html", "foo/bar/baz/bar.html"]
+      ) { stub!.save }
+      mock(EeePub::OCF).new.with_any_args { stub!.save }
+
+      @maker.save('test.epub')
+    end
+  end
+end