epub-parser-io 0.1.6a

data/test/test_inspect.rb

@@ -0,0 +1,121 @@
+require_relative 'helper'
+require 'epub'
+
+class TestInspect < Test::Unit::TestCase
+  class TestPackage < TestInspect
+    include EPUB::Publication
+
+    def setup
+      @package = Package.new
+    end
+
+    def test_package_inspects_object_id
+      assert_match (@package.__id__ << 1).to_s(16), @package.inspect
+    end
+
+    def test_package_inspects_attributes
+      @package.xml_lang = "zh"
+      @package.prefix = {'foaf' => 'http://xmlns.com/foaf/spec/'}
+
+      assert_match %Q|@xml_lang="zh"|, @package.inspect
+      assert_match %Q|@prefix={"foaf"=>"http://xmlns.com/foaf/spec/"}|, @package.inspect
+    end
+
+    def test_package_inspects_content_models
+      @package.metadata = Package::Metadata.new
+
+      assert_match '@metadata=#<EPUB::Publication::Package::Metadata:', @package.inspect
+    end
+
+    class TestMetadata < TestPackage
+      Metadata = Package::Metadata
+
+      def setup
+        super
+        @metadata = Metadata.new
+        @package.metadata = @metadata
+      end
+
+      def test_inspects_package_simply
+        assert_match /@package=\#<EPUB::Publication::Package:[^ ]+>/, @metadata.inspect
+      end
+
+      def test_inspects_attributes
+        title = Metadata::Title.new
+        title.content = 'Book Title'
+        @metadata.titles << title
+
+        title_pattern = RUBY_VERSION >= '2.0' ? '@dc_titles=[#<EPUB::Publication::Package::Metadata::Title' : 'Book Title'
+
+        assert_match title_pattern, @metadata.inspect
+      end
+
+      def test_dcmes_inspect_includes_class_name
+        meta = Package::Metadata::Title.new
+        meta.content = 'Book Title'
+
+        title_pattern = RUBY_VERSION >= '2.0' ? '#<EPUB::Publication::Package::Metadata::Title' : 'Book Title'
+
+        assert_match title_pattern, meta.inspect
+      end
+
+      def test_dcmes_inspect_includes_instance_variables
+        meta = Package::Metadata::DCMES.new
+        meta.lang = 'en-US'
+        meta.dir = 'rtl'
+
+        if RUBY_VERSION >= '2.0'
+          assert_match /@lang/, meta.inspect
+          assert_match /en\-US/, meta.inspect
+          assert_match /@dir/, meta.inspect
+          assert_match /rtl/, meta.inspect
+        else
+          assert_equal '', meta.inspect
+        end
+      end
+
+      def test_meta_inspect_includes_class_name
+        meta = Package::Metadata::Meta.new
+
+        assert_match /Package::Metadata::Meta/, meta.inspect
+      end
+
+      def test_meta_inspect_includes_instance_variables
+        meta = Package::Metadata::Meta.new
+        meta.id = 'meta-id'
+        meta.content = 'meta content'
+
+        assert_match /@id/, meta.inspect
+        assert_match /meta\-id/, meta.inspect
+        assert_match /@content/, meta.inspect
+        assert_match /meta content/, meta.inspect
+      end
+    end
+
+    class TestManifest < TestPackage
+      Manifest = Package::Manifest
+
+      def setup
+        super
+        @manifest = Manifest.new
+        @package.manifest = @manifest
+      end
+
+      def test_inspects_package_simply
+        assert_match /@package=\#<EPUB::Publication::Package:[^ ]+>/, @manifest.inspect
+      end
+
+      class TestItem < TestManifest
+        def setup
+          super
+          @item = Manifest::Item.new
+          @manifest << @item
+        end
+
+        def test_inspects_manifest_simply
+          assert_match /\#<EPUB::Publication::Package::Manifest:[^ ]+>/, @item.inspect
+        end
+      end
+    end
+  end
+end

data/test/test_parser.rb

@@ -0,0 +1,60 @@
+require File.expand_path 'helper', File.dirname(__FILE__)
+
+class MyBook
+  include EPUB::Book::Features
+end
+
+class TestParser < Test::Unit::TestCase
+  def setup
+    @parser = EPUB::Parser.new 'test/fixtures/book.epub'
+  end
+
+  def test_parse
+    assert_instance_of EPUB::Book, @parser.parse
+
+    book = Object.new
+    book.extend EPUB::Book::Features
+    assert_nothing_raised do
+      EPUB::Parser.parse('test/fixtures/book.epub', book: book)
+    end
+    assert_kind_of EPUB::Book::Features, EPUB::Parser.parse('test/fixtures/book.epub', book: book)
+
+    assert_nothing_raised do
+      EPUB::Parser.parse('test/fixtures/book.epub', class: MyBook)
+    end
+    assert_kind_of EPUB::Book::Features, EPUB::Parser.parse('test/fixtures/book.epub', class: MyBook)
+  end
+
+  class TestBook < TestParser
+    def setup
+      super
+      @book = @parser.parse
+    end
+
+    def test_each_page_on_spine_iterates_items_in_spines_order
+      @book.each_page_on_spine do |page|
+        assert_instance_of EPUB::Publication::Package::Manifest::Item, page
+      end
+    end
+
+    def test_each_content_iterates_items_in_manifest
+      @book.each_content do |page|
+        assert_instance_of EPUB::Publication::Package::Manifest::Item, page
+      end
+    end
+
+    def test_each_content_returns_enumerator_when_no_block_passed
+      contents = @book.each_content
+
+      assert_respond_to contents, :each
+    end
+
+    def test_enumerator_returned_by_each_content_iterates_items_in_spines_order
+      contents = @book.each_content
+
+      contents.each do |page|
+        assert_instance_of EPUB::Publication::Package::Manifest::Item, page
+      end
+    end
+  end
+end

data/test/test_parser_content_document.rb

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+require_relative 'helper'
+
+class TestParserContentDocument < Test::Unit::TestCase
+  def setup
+    @manifest = EPUB::Publication::Package::Manifest.new
+    %w[item-1.xhtml item-2.xhtml nav.xhtml].each.with_index do |href, index|
+      item = EPUB::Publication::Package::Manifest::Item.new
+      item.id = index
+      item.href = Addressable::URI.parse(href)
+      @manifest << item
+    end
+
+    @dir = 'test/fixtures/book'
+    @parser = EPUB::Parser::ContentDocument.new(@manifest.items.last)
+  end
+
+  def test_parse_navigations
+    doc = Nokogiri.XML open("#{@dir}/OPS/nav.xhtml")
+    navs = @parser.parse_navigations doc
+    nav = navs.first
+
+    assert_equal 1, navs.length
+    assert_equal 'Table of Contents', nav.heading
+    assert_equal 'toc', nav.type
+
+    assert_equal 2, nav.items.length
+    assert_equal @manifest.items.first, nav.items.first.item
+    assert_equal @manifest.items[1], nav.items[1].items[0].item
+    assert_equal @manifest.items[1], nav.items[1].items[1].item
+
+    assert_equal '第四節', nav.items.last.items.last.text
+
+    assert_true nav.hidden?
+  end
+end

data/test/test_parser_fixed_layout.rb

@@ -0,0 +1,16 @@
+require_relative 'helper'
+require 'epub/parser'
+
+class TestParserFixedLayout < Test::Unit::TestCase
+  def test_using_fixed_layout_is_true_when_rendition_property_in_package_prefix
+    parser = EPUB::Parser::Publication.new(<<OPF, 'dummy/rootfile.opf')
+    <package version="3.0"
+             unique-identifier="pub-id"
+             xmlns="http://www.idpf.org/2007/opf"
+             prefix="rendition: http://www.idpf.org/vocab/rendition/#">
+    </package>
+OPF
+    package = parser.parse_package
+    assert_true package.using_fixed_layout?
+  end
+end

data/test/test_parser_ocf.rb

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+require File.expand_path 'helper', File.dirname(__FILE__)
+
+class TestParserOCF < Test::Unit::TestCase
+  def setup
+    file = 'test/fixtures/book.epub'
+    @zip = Zip::Archive.open(file)
+    @parser = EPUB::Parser::OCF.new(@zip)
+    @container_xml = @zip.fopen('META-INF/container.xml').read
+  end
+
+  def teardown
+    @zip.close
+  end
+
+  def test_parsed_container_has_one_rootfile
+    assert_equal 1, @parser.parse_container(@container_xml).rootfiles.length
+  end
+
+  def test_parse_container_can_find_primary_rootfile
+    container = @parser.parse_container(@container_xml)
+
+    assert_equal 'OPS/ルートファイル.opf', container.rootfile.full_path.to_s
+  end
+
+  def test_parse_encryption_do_nothing_excluding_to_have_content
+    encryption = @parser.parse_encryption('content')
+
+    assert_equal 'content', encryption.content
+  end
+
+  def test_parse
+    assert_nothing_raised do
+      @parser.parse
+    end
+  end
+end
+

data/test/test_parser_publication.rb

@@ -0,0 +1,247 @@
+# -*- coding: utf-8 -*-
+require File.expand_path 'helper', File.dirname(__FILE__)
+
+class TestParserPublication < Test::Unit::TestCase
+  def setup
+    file = 'test/fixtures/book.epub'
+    rootfile = 'OPS/ルートファイル.opf'
+    @zip = Zip::Archive.open(file)
+    opf = @zip.fopen(rootfile).read
+    @parser = EPUB::Parser::Publication.new(opf, rootfile)
+    @package = @parser.parse_package
+  end
+
+  def teardown
+    @zip.close
+  end
+
+  def test_parse_package
+    assert_equal '3.0', @package.version
+  end
+
+  def test_has_unique_identifier
+    @package.metadata = @parser.parse_metadata
+    assert_equal 'pub-id', @package.unique_identifier.id
+    assert_equal 'da265185-8da8-462d-a146-17dd388f61fc', @package.unique_identifier.to_s
+  end
+
+  def test_has_prefixes_for_vocabulary
+    expected = {'foaf' => 'http://xmlns.com/foaf/spec/',
+                'dbp'  => 'http://dbpedia.org/ontology/'}
+    assert_equal expected, @package.prefix
+  end
+
+  def test_has_empty_hash_as_prefix_when_no_prefix_attribute
+    parser = EPUB::Parser::Publication.new('<package></package>', '')
+    package = parser.parse_package
+    assert_empty package.prefix
+  end
+
+  class TestParseMetadata < TestParserPublication
+    def setup
+      super
+      @metadata = @parser.parse_metadata
+    end
+
+    def test_has_identifier
+      assert_equal 'da265185-8da8-462d-a146-17dd388f61fc', @metadata.identifiers.first.content
+    end
+
+    def test_identifier_has_scheme_when_qualified_by_attribute
+      assert_equal 'ISBN', @metadata.identifiers[1].scheme
+    end
+
+    def test_has_unique_identifier
+      assert_equal 'da265185-8da8-462d-a146-17dd388f61fc', @metadata.unique_identifier.to_s
+    end
+
+    def test_has_five_titles
+      assert_equal 5, @metadata.titles.length
+    end
+
+    def test_returns_extended_title_as_title_attribute_if_exists
+      assert_equal 'The Great Cookbooks of the World: 
+        Mon premier guide de cuisson, un Mémoire. 
+        The New French Cuisine Masters, Volume Two. 
+        Special Anniversary Edition', @metadata.title
+    end
+
+    def test_titles_has_order
+      titles = @metadata.titles
+      assert titles[0] > titles[1]
+      assert titles[1] < titles[2]
+      assert titles[2] < titles[3]
+      assert titles[3] > titles[4]
+    end
+  end
+
+  class TestParseManifest < TestParserPublication
+    def setup
+      super
+      @manifest = @parser.parse_manifest
+    end
+
+    def test_manifest_has_16_items
+      assert_equal 16, @manifest.items.length
+    end
+
+    def test_item_has_relative_path_as_href_attribute
+      assert_equal 'nav.xhtml', @manifest['nav'].href.to_s
+    end
+
+    def test_fallback_attribute_of_item_should_be_item_object
+      fallback = @manifest['manifest-item-2'].fallback
+
+      assert_instance_of EPUB::Publication::Package::Manifest::Item, fallback
+      assert_equal 'manifest-item-fallback', fallback.id
+    end
+
+    def test_item_is_readable
+      item = EPUB::Parser.parse('test/fixtures/book.epub').package.manifest.items.first
+      doc = Nokogiri.XML item.read
+
+      assert_equal 'html', doc.root.name
+    end
+
+    def test_item_unescape_href_when_reading_file
+      item = EPUB::Parser.parse('test/fixtures/book.epub').package.manifest['containing-encoded-space']
+      doc = Nokogiri.HTML(item.read)
+      assert_equal 'Containing Space', (doc/'title').first.content
+    end
+
+    def test_iri_of_item_is_case_sensitive
+      manifest = EPUB::Parser.parse('test/fixtures/book.epub').package.manifest
+
+      assert_not_equal manifest['large-file-name'].read, manifest['small-file-name'].read
+    end
+
+    def test_item_can_traverse_fallback_chain
+      assert_equal [@manifest['manifest-item-2'], @manifest['manifest-item-fallback'], @manifest['manifest-item-fallback2']],
+                   @manifest['manifest-item-2'].fallback_chain
+    end
+
+    def test_item_always_has_fallback_chain_including_itself
+      item = @manifest['manifest-item-1']
+
+      assert_equal [item], item.fallback_chain
+    end
+
+    def test_item_can_use_fallback_chain_when_not_core_media_type_by_default
+      item = @manifest['manifest-item-2']
+      fallback = item.fallback
+      result = item.use_fallback_chain do |current|
+        current
+      end
+
+      assert_equal fallback, result
+    end
+
+    def test_item_can_custome_supported_media_type_in_use_fallback_chain
+      item = @manifest['manifest-item-2']
+      result = item.use_fallback_chain supported: 'application/pdf' do |current|
+        current
+      end
+
+      assert_equal item, result
+    end
+
+    def test_item_can_custome_not_supported_media_type_in_use_fallback_chain
+      item = @manifest['manifest-item-2']
+      fallback = item.fallback.fallback
+      result = item.use_fallback_chain unsupported: 'image/svg+xml' do |current|
+        current
+      end
+
+      assert_equal fallback, result
+    end
+
+    def test_item_with_absolute_iri_as_href_must_keep_it
+      item = @manifest['external-css']
+      assert_equal 'http://example.net/stylesheets/common.css', item.href.to_s
+    end
+  end
+
+  class TestParseSpine < TestParserPublication
+    def setup
+      super
+      @spine = @parser.parse_spine
+    end
+
+    def atest_each_itemref_yields_itemref_in_order_on_spine_element
+      expected = %w[nav manifest-item-1 manifest-item-2 containing-space japanese-filename].map {|idref|
+        itemref = EPUB::Publication::Package::Spine::Itemref.new
+        itemref.id = nil
+        itemref.spine = @spine
+        itemref.idref = idref
+        itemref.linear = true
+        itemref.properties = []
+        itemref
+      }
+      assert_equal expected, @spine.each_itemref.to_a
+    end
+  end
+
+  class TestParseGuide < TestParserPublication
+    def setup
+      super
+      @guide = @parser.parse_guide
+    end
+
+    def test_guide_has_one_reference
+      assert_equal 1, @guide.references.length
+    end
+
+    def test_guide_has_cover_reference
+      assert @guide.cover
+      assert_equal 'cover', @guide.cover.type
+    end
+
+    def test_reference_refers_item
+      @parser.parse_manifest
+
+      assert_instance_of EPUB::Publication::Package::Manifest::Item, @guide.cover.item
+    end
+  end
+
+  class TestParseBindings < TestParserPublication
+    def setup
+      super
+      @package.manifest = @parser.parse_manifest
+      @bindings = @parser.parse_bindings
+      @bindings.package = @package
+    end
+
+    def test_has_one_bindings
+      assert @bindings
+    end
+
+    def test_bindings_has_one_media_type
+      assert_equal 1, @bindings.media_types.length
+    end
+
+    def test_bindings_is_accessible_like_hash
+      media_type = @bindings.media_types.first
+      assert_equal media_type, @bindings['application/x-demo-slideshow']
+      assert_nil @bindings['non-existing-media-type']
+    end
+
+    def test_media_type_has_media_type_attribute
+      assert_equal 'application/x-demo-slideshow', @bindings.media_types.first.media_type
+    end
+
+    def test_media_type_has_handler_attribute
+      assert_not_nil @bindings.media_types.first.handler
+    end
+
+    def test_media_type_refers_item_as_handler
+      assert_kind_of EPUB::Publication::Package::Manifest::Item, @bindings.media_types.first.handler
+    end
+
+    def test_use_fallback_chain_use_bindings
+      item = @package.manifest['slideshow']
+      item.use_fallback_chain do |slideshow|
+        assert_equal 'impl', slideshow.id
+      end
+    end
+  end
+end