eeepub3 0.0.1

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,50 @@
+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
+
+  it 'should stream epub' do
+    pending
+    output = @ocf.render
+    output.size.should == 134
+    output.is_binary_data?.should be_true
+  end
+end

data/spec/eeepub/opf_spec.rb

@@ -0,0 +1,267 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'date'
+
+describe "EeePub::OPF" do
+  before do
+    @opf = EeePub::OPF.new(
+      :identifier => {:value => '978-4-00-310101-8', :scheme => 'ISBN'},
+      :files => ['foo.html', 'bar.html', 'picture.png'],
+      :ncx => 'toc.ncx'
+    )
+  end
+
+  it 'should set default value' do
+    @opf.toc.should == 'ncx'
+    @opf.unique_identifier.should == 'BookId'
+    @opf.title.should == 'Untitled'
+    @opf.language.should == 'en'
+  end
+
+  it 'should export as xml' do
+    doc  = Nokogiri::XML(@opf.to_xml)
+    doc.at('package').attribute('unique-identifier').value.should == @opf.unique_identifier
+    metadata = doc.at('metadata')
+    metadata.should_not be_nil
+    [
+      ['dc:title', @opf.title],
+      ['dc:language', @opf.language],
+      ['dc:date', ''],
+      ['dc:subject', ''],
+      ['dc:description', ''],
+      ['dc:relation', ''],
+      ['dc:creator', ''],
+      ['dc:publisher', ''],
+      ['dc:rights', ''],
+    ].each do |xpath, expect|
+      metadata.xpath(xpath,
+        'xmlns:dc' => "http://purl.org/dc/elements/1.1/").inner_text.should == expect
+    end
+    identifier = metadata.xpath('dc:identifier', 'xmlns:dc' => "http://purl.org/dc/elements/1.1/")[0]
+    identifier.attribute('id').value.should == @opf.unique_identifier
+    identifier.attribute('scheme').value.should == @opf.identifier[0][:scheme]
+    identifier.inner_text.should == @opf.identifier[0][:value]
+
+    manifest = doc.at('manifest')
+    manifest.should_not be_nil
+    manifest = manifest.search('item')
+    manifest.size.should == 4
+    manifest[0..2].each_with_index do |item, index|
+      expect = @opf.manifest[index]
+      item.attribute('id').value.should == expect
+      item.attribute('href').value.should == expect
+      item.attribute('media-type').value.should == @opf.send(:guess_media_type, expect)
+    end
+    manifest[3].attribute('id').value.should == 'ncx'
+    manifest[3].attribute('href').value.should == @opf.ncx
+    manifest[3].attribute('media-type').value.should == @opf.send(:guess_media_type, @opf.ncx)
+
+    spine = doc.at('spine')
+    spine.should_not be_nil
+    spine = spine.search('itemref')
+    spine.size.should == 2
+    spine[0].attribute('idref').value.should == 'foo.html'
+    spine[1].attribute('idref').value.should == 'bar.html'
+
+    doc.at('guide').should be_nil
+  end
+
+  describe 'spec of identifier' do
+    context 'specify as Array' do
+      before { @opf.identifier = [{:scheme => 'ISBN', :value => '978-4-00-310101-8'}] }
+      it 'should return value' do
+        @opf.identifier.should == [{:scheme => 'ISBN', :value => '978-4-00-310101-8'}]
+      end
+    end
+
+    context 'specify as Hash' do
+      before { @opf.identifier = {:scheme => 'ISBN', :value => '978-4-00-310101-8'} }
+      it 'should return value' do
+        @opf.identifier.should == [{:scheme => 'ISBN', :value => '978-4-00-310101-8', :id => @opf.unique_identifier}]
+      end
+    end
+
+    context 'specify as String' do
+      before { @opf.identifier = '978-4-00-310101-8' }
+      it 'should return value' do
+        @opf.identifier.should == [{:value => '978-4-00-310101-8', :id => @opf.unique_identifier}]
+      end
+    end
+  end
+
+  describe 'spec of create_unique_item_id' do
+    it 'should return unique item id' do
+      id_cache = {}
+      @opf.create_unique_item_id('foo/bar/test.html', id_cache).should == 'test.html'
+      @opf.create_unique_item_id('foo/bar/test.html', id_cache).should == 'test.html-1'
+      @opf.create_unique_item_id('foo/bar/TEST.html', id_cache).should == 'TEST.html'
+      @opf.create_unique_item_id('foo/bar/test.html.1', id_cache).should == 'test.html.1'
+    end
+  end
+
+  context 'ncx is nil' do
+    before do
+      @opf.ncx = nil
+    end
+
+    it 'should not set ncx to manifest' do
+      doc  = Nokogiri::XML(@opf.to_xml)
+      doc.search('manifest/item[id=ncx]').should be_empty
+    end
+  end
+
+  context 'set all metadata' do
+    before do
+      @opf.set_values(
+        :date => Date.today,
+        :subject => 'subject',
+        :description => 'description',
+        :relation => 'relation',
+        :creator => 'creator',
+        :publisher => 'publisher',
+        :rights => 'rights',
+        :cover => 'cover.jpg'
+      )
+    end
+
+    it 'should export as xml' do
+      doc  = Nokogiri::XML(@opf.to_xml)
+      metadata = doc.at('metadata')
+      metadata.should_not be_nil
+      [
+        ['dc:title', @opf.title],
+        ['dc:language', @opf.language],
+        ['dc:date', @opf.date.to_s],
+        ['dc:subject', 'subject'],
+        ['dc:description', 'description'],
+        ['dc:relation', 'relation'],
+        ['dc:creator', 'creator'],
+        ['dc:publisher', 'publisher'],
+        ['dc:rights', 'rights'],
+      ].each do |xpath, expect|
+        metadata.xpath(xpath,
+          'xmlns:dc' => "http://purl.org/dc/elements/1.1/").inner_text.should == expect
+      end
+      identifier = metadata.xpath('dc:identifier', 'xmlns:dc' => "http://purl.org/dc/elements/1.1/")[0]
+      identifier.attribute('id').value.should == @opf.unique_identifier
+      identifier.attribute('scheme').value.should == @opf.identifier[0][:scheme]
+      identifier.inner_text.should == @opf.identifier[0][:value]
+      
+      identifier = metadata.at('meta')
+      identifier.attribute('name').value.should == 'cover'
+      identifier.attribute('content').value.should == 'cover.jpg'      
+    end
+  end
+
+  context 'plural identifiers' do
+    before do
+      @opf.identifier = [
+        {:id => 'BookId', :scheme => 'ISBN', :value => '978-4-00-310101-8'},
+        {:id => 'BookURL', :scheme => 'URL', :value => 'http://example.com/books/foo'}
+      ]
+    end
+
+    it 'should export as xml' do
+      doc  = Nokogiri::XML(@opf.to_xml)
+      elements = doc.xpath('//dc:identifier', 'xmlns:dc' => "http://purl.org/dc/elements/1.1/")
+      elements.size.should == 2
+      elements.each_with_index do |element, index|
+        expect = @opf.identifier[index]
+        element.attribute('id').value.should == expect[:id]
+        element.attribute('scheme').value.should == expect[:scheme]
+        element.inner_text.should == expect[:value]
+      end
+    end
+  end
+
+  context 'plural languages' do
+    before do
+      @opf.language = ['ja', 'en']
+    end
+
+    it 'should export as xml' do
+      doc  = Nokogiri::XML(@opf.to_xml)
+      elements = doc.xpath('//dc:language', 'xmlns:dc' => "http://purl.org/dc/elements/1.1/")
+      elements.size.should == 2
+      elements.each_with_index do |element, index|
+        element.inner_text.should == @opf.language[index]
+      end
+    end
+  end
+
+  context 'specify spine' do
+    before do
+      @opf.spine = ['a', 'b']
+    end
+
+    it 'should export as xml' do
+      doc  = Nokogiri::XML(@opf.to_xml)
+      spine = doc.at('spine')
+      spine.should_not be_nil
+      spine = spine.search('itemref')
+      spine.size.should == 2
+      spine[0].attribute('idref').value.should == 'a'
+      spine[1].attribute('idref').value.should == 'b'
+    end
+  end
+
+  context 'specify manifest as Hash' do
+    before do
+      @opf.manifest = [
+        {:id => 'foo', :href => 'foo.html', :media_type => 'application/xhtml+xml'},
+        {:id => 'bar', :href => 'bar.html', :media_type => 'application/xhtml+xml'},
+        {:id => 'picture', :href => 'picture.png', :media_type => 'image/png'}
+      ]
+    end
+
+    it 'should export as xml' do
+      doc  = Nokogiri::XML(@opf.to_xml)
+      manifest = doc.at('manifest')
+      manifest.should_not be_nil
+      manifest = manifest.search('item')
+      manifest.size.should == 4
+      manifest[0..2].each_with_index do |item, index|
+        expect = @opf.manifest[index]
+        item.attribute('id').value.should == expect[:id]
+        item.attribute('href').value.should == expect[:href]
+        item.attribute('media-type').value.should == expect[:media_type]
+      end
+      manifest[3].attribute('id').value.should == 'ncx'
+      manifest[3].attribute('href').value.should == @opf.ncx
+      manifest[3].attribute('media-type').value.should == @opf.send(:guess_media_type, @opf.ncx)
+    end
+  end
+
+  context 'specify dc:date[event]' do
+    before do
+      @opf.date = {:value => Date.today, :event => 'publication'}
+    end
+
+    it 'should export as xml' do
+      doc  = Nokogiri::XML(@opf.to_xml)
+      metadata = doc.at('metadata')
+      date = metadata.xpath('dc:date', 'xmlns:dc' => "http://purl.org/dc/elements/1.1/")
+      date.inner_text.should == @opf.date[:value].to_s
+      date.attribute('event').value.should == @opf.date[:event]
+    end
+  end
+
+  context 'set guide' do
+    before do
+      @opf.guide = [
+        {:type => 'toc', :title => 'Table of Contents', :href => 'toc.html'},
+        {:type => 'loi', :title => 'List Of Illustrations', :href => 'toc.html#figures'},
+      ]
+    end
+
+    it 'should export as xml' do
+      doc  = Nokogiri::XML(@opf.to_xml)
+      guide = doc.at('guide')
+      guide.should_not be_nil
+      references = guide.search('reference')
+      references.size.should == 2
+      [references, @opf.guide].transpose do |element, expect|
+        element.attributes.should == expect
+      end
+    end
+  end
+end

data/spec/eeepub_spec.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Epubr" do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'eeepub'
+require 'rspec'
+require 'nokogiri'
+require 'rr'
+require 'simplecov'
+
+RSpec.configure do |config|
+  config.mock_with :rr
+end
+
+SimpleCov.start
+

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: eeepub3
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- bubaz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: EeePub is a Ruby ePub generator.
+email:
+- s.bubovich@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- eeepub3.gemspec
+- lib/eeepub.rb
+- lib/eeepub/container_item.rb
+- lib/eeepub/easy.rb
+- lib/eeepub/maker.rb
+- lib/eeepub/ncx.rb
+- lib/eeepub/ocf.rb
+- lib/eeepub/opf.rb
+- spec/eeepub/container_item_spec.rb
+- spec/eeepub/easy_spec.rb
+- spec/eeepub/maker_spec.rb
+- spec/eeepub/ncx_spec.rb
+- spec/eeepub/ocf_spec.rb
+- spec/eeepub/opf_spec.rb
+- spec/eeepub_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/bubaz/eeepub3
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0.rc.2
+signing_key: 
+specification_version: 4
+summary: ePub generator
+test_files: []