walterdavis-eeepub 0.6.2

data/lib/eeepub/ocf.rb

@@ -0,0 +1,107 @@
+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)
+
+      FileUtils.chdir(dir) do
+        File.open('mimetype', 'w') do |f|
+          f << 'application/epub+zip'
+        end
+
+        meta_inf = 'META-INF'
+        FileUtils.mkdir_p(meta_inf)
+
+        container.save(File.join(meta_inf, 'container.xml'))
+
+        %x(zip -X9 \"#{output_path}\" mimetype)
+        %x(zip -Xr9D \"#{output_path}\" * -xi mimetype)
+      end
+    end
+  end
+end

data/lib/eeepub/opf.rb

@@ -0,0 +1,149 @@
+module EeePub
+  class OPF < ContainerItem
+    attr_accessor :unique_identifier,
+                  :title,
+                  :language,
+                  :identifier,
+                  :date,
+                  :subject,
+                  :description,
+                  :relation,
+                  :creator,
+                  :author,
+                  :publisher,
+                  :rights,
+                  :manifest,
+                  :spine,
+                  :guide,
+                  :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' => unique_identifier,
+          'version' => "2.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/",
+        'xmlns:dcterms' => "http://purl.org/dc/terms/",
+        'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+        'xmlns:opf' => "http://www.idpf.org/2007/opf" 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, :author, :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
+      end
+    end
+
+    def build_manifest(builder)
+      builder.manifest do
+        complete_manifest.each do |i|
+          builder.item :id => i[:id], :href => i[:href], 'media-type' => i[:media_type]
+        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 => '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/lib/eeepub.rb

@@ -0,0 +1,15 @@
+require 'eeepub/container_item'
+require 'eeepub/opf'
+require 'eeepub/ocf'
+require 'eeepub/ncx'
+require 'eeepub/maker'
+require 'eeepub/easy'
+
+module EeePub
+  # Make ePub
+  #
+  # @param [Proc] block the block for initialize EeePub::Maker
+  def self.make(&block)
+    EeePub::Maker.new(&block)
+  end
+end

data/spec/eeepub/easy_spec.rb

@@ -0,0 +1,67 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "EeePub::Easy" do
+  before do
+    @easy = EeePub::Easy.new do
+      title 'sample'
+      creator 'jugyo'
+      author 'foo bar'
+      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,129 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "EeePub::Maker" do
+  before do
+    @maker = EeePub::Maker.new do
+      title 'sample'
+      creator 'jugyo'
+      author 'foo bar'
+      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'
+      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(:@authors).should == ['foo bar'] }
+  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'}] }
+  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(:@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 {|i| i.call('/tmp')}
+    mock(EeePub::NCX).new(
+      :title => "sample",
+      :nav => [
+        {:label => '1. foo', :content => 'foo.html'},
+        {:label => '1. bar', :content => 'bar.html'}
+      ],
+      :uid => "http://example.com/book/foo"
+    ) { stub!.save }
+    mock(EeePub::OPF).new(
+      :title => ["sample"],
+      :creator => ["jugyo"],
+      :author => ["foo bar"],
+      :date => ["2010-05-06"],
+      :language => ['en'],
+      :subject => ['epub sample'],
+      :description => ['this is epub sample'],
+      :rights => ['xxx'],
+      :relation => ['xxx'],
+      :ncx => "toc.ncx",
+      :publisher => ["jugyo.org"],
+      :identifier => [{:value => "http://example.com/book/foo", :scheme => "URL"}],
+      :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'
+        author 'foo bar'
+        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'
+        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 {|i| i.call('/tmp')}
+      mock(EeePub::NCX).new.with_any_args { stub!.save }
+      mock(EeePub::OPF).new(
+        :title => ["sample"],
+        :creator => ["jugyo"],
+        :author => ["foo bar"],
+        :date => ["2010-05-06"],
+        :language => ['en'],
+        :subject => ['epub sample'],
+        :description => ['this is epub sample'],
+        :rights => ['xxx'],
+        :relation => ['xxx'],
+        :ncx => "toc.ncx",
+        :publisher => ["jugyo.org"],
+        :identifier => [{:value => "http://example.com/book/foo", :scheme => "URL"}],
+        :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

data/spec/eeepub/ncx_spec.rb

@@ -0,0 +1,80 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+require 'tmpdir'
+require 'fileutils'
+
+describe "EeePub::NCX" do
+  before do
+    @ncx = EeePub::NCX.new(
+      :uid => 'uid',
+      :nav_map => [
+        {:label => 'foo', :content => 'foo.html'},
+        {:label => 'bar', :content => 'bar.html'}
+      ]
+    )
+  end
+
+  it 'should set default values' do
+    @ncx.depth.should == 1
+    @ncx.total_page_count.should == 0
+    @ncx.max_page_number.should == 0
+    @ncx.doc_title.should == 'Untitled'
+  end
+
+  it 'should make xml' do
+    doc  = Nokogiri::XML(@ncx.to_xml)
+    head = doc.at('head')
+    head.should_not be_nil
+
+    head.at("//xmlns:meta[@name='dtb:uid']")['content'].should == @ncx.uid
+    head.at("//xmlns:meta[@name='dtb:depth']")['content'].should == @ncx.depth.to_s
+    head.at("//xmlns:meta[@name='dtb:totalPageCount']")['content'].should == @ncx.total_page_count.to_s
+    head.at("//xmlns:meta[@name='dtb:maxPageNumber']")['content'].should == @ncx.max_page_number.to_s
+    head.at("//xmlns:docTitle/xmlns:text").inner_text.should == @ncx.doc_title
+
+    nav_map = doc.at('navMap')
+    nav_map.should_not be_nil
+    nav_map.search('navPoint').each_with_index do |nav_point, index|
+      expect = @ncx.nav_map[index]
+      nav_point.attribute('id').value.should == "navPoint-#{index + 1}"
+      nav_point.attribute('playOrder').value.should == (index + 1).to_s
+      nav_point.at('navLabel').at('text').inner_text.should == expect[:label]
+      nav_point.at('content').attribute('src').value.should == expect[:content]
+    end
+  end
+
+  context 'nested nav_map' do
+    before do
+      @ncx.nav = [
+        {:label => 'foo', :content => 'foo.html',
+          :nav => [
+            {:label => 'foo-1', :content => 'foo-1.html'},
+            {:label => 'foo-2', :content => 'foo-2.html'}
+          ],
+        },
+        {:label => 'bar', :content => 'bar.html'}
+      ]
+    end
+
+    it 'should make xml' do
+      doc  = Nokogiri::XML(@ncx.to_xml)
+      nav_map = doc.at('navMap')
+
+      nav_map.search('navMap/navPoint').each_with_index do |nav_point, index|
+        expect = @ncx.nav_map[index]
+        nav_point.attribute('id').value.should == "navPoint-#{index + 1}"
+        nav_point.attribute('playOrder').value.should == (index + 1).to_s
+        nav_point.at('navLabel').at('text').inner_text.should == expect[:label]
+        nav_point.at('content').attribute('src').value.should == expect[:content]
+      end
+
+      nav_map.search('navPoint/navPoint').each_with_index do |nav_point, index|
+        expect = @ncx.nav[0][:nav][index]
+        nav_point.attribute('id').value.should == "navPoint-#{index + 2}"
+        nav_point.attribute('playOrder').value.should == (index + 2).to_s
+        nav_point.at('navLabel').at('text').inner_text.should == expect[:label]
+        nav_point.at('content').attribute('src').value.should == expect[:content]
+      end
+    end
+  end
+end

data/spec/eeepub/ocf_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+require 'tmpdir'
+require 'fileutils'
+
+describe "EeePub::OCF" do
+  before do
+    @tmpdir = File.join(Dir.tmpdir, 'eeepub_test')
+    FileUtils.mkdir_p(@tmpdir)
+    @container = EeePub::OCF::Container.new('foo.opf')
+    @ocf = EeePub::OCF.new(:dir => @tmpdir, :container => @container)
+  end
+
+  after do
+    FileUtils.rm_rf(@tmpdir)
+  end
+
+  it 'should return rootfiles' do
+    @container.rootfiles.should == [{:full_path => 'foo.opf', :media_type => 'application/oebps-package+xml'}]
+  end
+
+  it 'should specify container as String' do
+    ocf = EeePub::OCF.new(:dir => @tmpdir, :container => 'foo.opf')
+    ocf.container.rootfiles == [{:full_path => 'foo.opf', :media_type => 'application/oebps-package+xml'}]
+  end
+
+  it 'should make xml' do
+    doc  = Nokogiri::XML(@container.to_xml)
+    rootfiles = doc.at('rootfiles')
+    rootfiles.should_not be_nil
+    rootfiles.search('rootfile').each_with_index do |rootfile, index|
+      expect = @container.rootfiles[index]
+      rootfile.attribute('full-path').value.should == expect[:full_path]
+      rootfile.attribute('media-type').value.should == expect[:media_type]
+    end
+  end
+
+  it 'should make epub' do
+    output_path = File.join('eeepub_test.epub')
+    @ocf.save(output_path)
+    File.exists?(output_path)
+  end
+end