epub-parser 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e95e303cf2c03479fdc655b8c4ea3c0b668b421f9d63082c40d984542312804b
-  data.tar.gz: 680b503b44bf23e82374da6afc18439762289eeaf87d58c6b0db5588d6ad59b5
+  metadata.gz: 0d7e6e2104c4c77f435607cc2b05936b405dad9e18d29d316c98633f9e7df35e
+  data.tar.gz: 03b8c36a39101d777fa0e6026436898f4136df2bd4acfa83f173da7baa750ca1
 SHA512:
-  metadata.gz: dc201c61dc61f7f56e4690c4b669bf0bee8e098f6025ceea17bc8604fb8b0b4a49a9937a4c34972d5b4584c83064fdf78d9b1831c75706c7f94ad01eebb23a8f
-  data.tar.gz: 7d08504f668f371dbef455f1498214b3f7bec305f3095638986441a2d6d8800932c329b65c7c62913f4ec126b02db892bbe10a3c22e0a316933f613d5cf7a8d7
+  metadata.gz: 2f3d5ce0f4d7847cb0e171dfc7741bb0b1899e9e4300746b8e447f0ba2cc5be2eb6700ace854aac6b39b7cddab069e4f83d14f1a930dcb0becbcb5b32c955105
+  data.tar.gz: 96a793271073777e2ae68666018d0e627b7b59edc108a8ed08c085bd0d09cfe4a808f5cc787bdbc8dba28d978e29af92d2e2bd222b2b049d6b4a28b1747f10dc

data/CHANGELOG.markdown

@@ -1,6 +1,14 @@
 CHANGELOG
 =========
 
+0.3.4
+-----
+
+* Add {EPUB::Publication::Package#full_path} and {EPUB::Publication::Package#rootfile}
+* [BUG FIX]Fix a bug that {EPUB::ContentDocument::Navigation::Item#item} doesn't return correct {EPUB::Publication::Package::Manifest::Item Item}(Thanks [aelkiss][]!)
+
+[aelkiss]: https://gitlab.com/aelkiss
+
 0.3.3
 -----
 

data/README.markdown

@@ -5,6 +5,12 @@ EPUB Parser
 [![Gem Version](https://badge.fury.io/rb/epub-parser.svg)](http://badge.fury.io/rb/epub-parser)
 [![coverage report](https://gitlab.com/KitaitiMakoto/epub-parser/badges/master/coverage.svg)](https://gitlab.com/KitaitiMakoto/epub-parser/commits/master)
 
+* [Homepage][homepage]
+* [Documentation][rubydoc]
+* [Source Code][]
+
+[Source Code]: https://gitlab.com/KitaitiMakoto/epub-parser
+
 INSTALLATION
 -------
 
@@ -153,6 +159,13 @@ If you find other gems, please tell me or request a pull request.
 RECENT CHANGES
 --------------
 
+### 0.3.4
+
+* Add {EPUB::Publication::Package#full_path} and {EPUB::Publication::Package#rootfile}
+* [BUG FIX]Fix a bug that {EPUB::ContentDocument::Navigation::Item#item} doesn't return correct {EPUB::Publication::Package::Manifest::Item Item}(Thanks [aelkiss][]!)
+
+[aelkiss]: https://gitlab.com/aelkiss
+
 ### 0.3.3
 
 * [BUG FIX]Use UnpackedURI adapter for URI
@@ -163,25 +176,12 @@ RECENT CHANGES
 
 * Use epub-cfi gem for EPUB CFI
 
-### 0.3.1
-
-* Make `CFI` comparable. Now can call `CFI#==`
-* Include `Publication::Package::Spine::Itemref` in `Searcher.search_element`'s result
-
-### 0.3.0
-
-* Wrong release. I'm sorry.
-
-### 0.2.9
-
-* Fix a bug that `Searcher.search_element` returns wrong CFI
-* Add `Searcher.search_by_cfi`
-
 See {file:CHANGELOG.markdown} for older changelogs and details.
 
 TODOS
 -----
 * EPUB 3.0.1
+* EPUB 3.1
 * Help features for `epub-open` tool
 * Vocabulary Association Mechanisms
 * Implementing navigation document and so on

data/lib/epub/parser/content_document.rb

@@ -82,7 +82,9 @@ module EPUB
             item.text = extract_attribute(a_or_span, 'title').to_s if item.text.nil? || item.text.empty?
           end
           item.href = extract_attribute(a_or_span, 'href')
-          item.item = @item.manifest.items.find {|it| it.href.request_uri == item.href.request_uri}
+          item.item = @item.manifest.items.find {|it|
+            it.full_path == @item.full_path + item.href.request_uri
+          }
         end
         item.items = element.xpath('./xhtml:ol[1]/xhtml:li', EPUB::NAMESPACES).map {|li| parse_navigation_item(li)}
 

data/lib/epub/parser/version.rb

@@ -1,5 +1,5 @@
 module EPUB
   class Parser
-    VERSION = "0.3.3"
+    VERSION = "0.3.4"
   end
 end

data/lib/epub/publication/package.rb

@@ -43,6 +43,18 @@ module EPUB
         @metadata.unique_identifier
       end
 
+      # Corresponding {Rootfile}
+      # @return [OCF::Container::Rootfile]
+      def rootfile
+        @book.ocf.container.rootfiles.find {|rf| rf.package == self}
+      end
+
+      # Full path in EPUB archive
+      # @return [Addressable::URI]
+      def full_path
+        rootfile.full_path if rootfile
+      end
+
       def inspect
         "#<%{class}:%{object_id} %{attributes} %{models}>" % {
           :class      => self.class,

data/lib/epub/publication/package/manifest.rb

@@ -121,8 +121,7 @@ module EPUB
           # @return [Addressable::URI]
           def full_path
             return @full_path if @full_path
-            rootfile = manifest.package.book.ocf.container.rootfile.full_path
-            path = DUMMY_ROOT_IRI + rootfile + href
+            path = DUMMY_ROOT_IRI + manifest.package.full_path + href
             path.scheme = nil
             path.host = nil
             path.path = path.path[1..-1]

data/test/fixtures/book/META-INF/container.xml

@@ -2,5 +2,6 @@
 <container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
   <rootfiles>
     <rootfile full-path="OPS/ルートファイル.opf" media-type="application/oebps-package+xml" />
+    <rootfile full-path="nested/dir/content.opf" media-type="application/oebps-package+xml" />
   </rootfiles>
 </container>

data/test/fixtures/book/nested/dir/content.opf

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<package xmlns="http://www.idpf.org/2007/opf" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:dcterms="http://purl.org/dc/terms/" xmlns:media="http://www.idpf.org/epub/vocab/overlays/#" version="3.0" unique-identifier="BookId" xml:lang="en" prefix="ibooks: http://vocabulary.itunes.apple.com/rdf/ibooks/vocabulary-extensions-1.0/">
+  <metadata xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:opf="http://www.idpf.org/2007/opf">
+    <dc:identifier id="BookId">af6e04ec-ca74-4951-a5cd-f0572885a7f9</dc:identifier>
+    <meta refines="#BookId" property="identifier-type" scheme="onix:codelist5">22</meta>
+    <meta property="dcterms:identifier" id="meta-identifier">BookId</meta>
+    <dc:title>Test</dc:title>
+    <meta property="dcterms:title" id="meta-title">Test</meta>
+    <dc:language>en</dc:language>
+    <meta property="dcterms:language" id="meta-language">en</meta>
+    <meta property="dcterms:modified">2017-12-05T20:55:41Z</meta>
+    <dc:creator id="creator">anonymous</dc:creator>
+    <meta refines="#creator" property="file-as">anonymous</meta>
+    <meta property="dcterms:publisher">anonymous</meta>
+    <dc:publisher>anonymous</dc:publisher>
+    <meta property="dcterms:date">2017-12-5</meta>
+    <dc:date>2017-12-5</dc:date>
+    <meta property="dcterms:rights">see MIT-LICENSE</meta>
+    <dc:rights>see MIT-LICENSE</dc:rights>
+    <meta name="cover" content="image_cover"/>
+  </metadata>
+  <manifest>
+    <item id="ncx" href="toc.ncx" media-type="application/x-dtbncx+xml"/>
+    <item id="toc" href="text/toc.xhtml" media-type="application/xhtml+xml" properties="nav"/>
+    <item id="content_2_chapter-1" href="text/2_chapter-1.xhtml" media-type="application/xhtml+xml"/>
+  </manifest>
+  <spine toc="ncx">
+    <itemref idref="toc"/>
+    <itemref idref="content_2_chapter-1"/>
+  </spine>
+</package>

data/test/fixtures/book/nested/dir/text/2_chapter-1.xhtml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+  <head>
+  <meta charset="UTF-8" />
+  <title>Chapter 1</title>
+  </head>
+<body><div class="chapter-heading"> <h1 class="chapter-number">1</h1> <h1 class="chapter-title">Chapter 1</h1> </div> <div class="chapter-content"><p class="no-indent">This is the first sentence. This is the next sentence. This is all for Chapter 1.</p> <p><br/></p> </div> </body></html>

data/test/fixtures/book/nested/dir/text/toc.xhtml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en" lang="en">
+  <head>
+    <title>Test</title>
+    <meta charset="UTF-8"/>
+  </head>
+  <body>
+    <h1 class="chapter-title">Contents</h1>
+    <nav id="toc" epub:type="toc">
+      <ol class="toc">
+        <li class="toc-chapter">
+          <a href="2_chapter-1.xhtml" epub:type="bodymatter">Chapter 1</a>
+          <ol class="toc">
+        
+        </ol>
+        </li>
+      </ol>
+    </nav>
+  </body>
+</html>

data/test/test_content_document.rb

@@ -62,6 +62,8 @@ class TestContentDocument < Test::Unit::TestCase
 
     def test_contents_returns_items_of_toc
       manifest = EPUB::Publication::Package::Manifest.new
+      manifest.package = Object.new
+      stub(manifest.package).full_path {Addressable::URI.parse("")}
       item = EPUB::Publication::Package::Manifest::Item.new
       item.media_type = 'application/xhtml+xml'
       item.properties = %w[nav]
@@ -109,5 +111,19 @@ class TestContentDocument < Test::Unit::TestCase
         end
       end
     end
+
+    def test_rexml_returns_rexml_document
+      content_doc = XHTML.new
+      stub(content_doc).raw_document {File.read(File.join(File.dirname(__FILE__), 'fixtures', 'book', 'OPS', '日本語.xhtml'))}
+      doc = content_doc.rexml
+      assert_instance_of REXML::Document, doc
+    end
+
+    def test_navigation_item
+      book = EPUB::Parser.parse("test/fixtures/book.epub")
+      package = book.packages[1]
+
+      assert_equal "nested/dir/text/2_chapter-1.xhtml", package.manifest.nav.content_document.navigation.items.first.item.full_path.path
+    end
   end
 end

data/test/test_parser_content_document.rb

@@ -10,6 +10,8 @@ class TestParserContentDocument < Test::Unit::TestCase
       item.href = href
       @manifest << item
     end
+    @manifest.package = Object.new
+    stub(@manifest.package).full_path {"OPS/ルートファイル.opf"}
 
     @dir = 'test/fixtures/book'
     @parser = EPUB::Parser::ContentDocument.new(@manifest.items.last)

data/test/test_parser_ocf.rb

@@ -16,8 +16,8 @@ class TestParserOCF < Test::Unit::TestCase
     }
   end
 
-  def test_parsed_container_has_one_rootfile
-    assert_equal 1, @parser.parse_container(@container_xml).rootfiles.length
+  def test_parsed_container_has_two_rootfiles
+    assert_equal 2, @parser.parse_container(@container_xml).rootfiles.length
   end
 
   def test_parse_container_can_find_primary_rootfile

data/test/test_publication.rb

@@ -18,6 +18,23 @@ class TestPublication < Test::Unit::TestCase
     assert_nil metadata.package
   end
 
+  def test_full_path_equals_to_corresponding_rootfiles_one
+    full_path = Addressable::URI.parse("OPS/content.opf")
+    ocf = EPUB::OCF.new
+    ocf.container = EPUB::OCF::Container.new
+    rootfile = EPUB::OCF::Container::Rootfile.new(full_path)
+    rootfile.package = @package
+    another_rootfile = Object.new
+    stub(another_rootfile).package
+    ocf.container.rootfiles << another_rootfile
+    ocf.container.rootfiles << rootfile
+    book = Object.new
+    stub(book).ocf {ocf}
+    @package.book = book
+
+    assert_equal full_path, @package.full_path
+  end
+
   class TestMetadata < TestPublication
     def setup
       @metadata = Package::Metadata.new

data/test/test_searcher.rb

@@ -15,6 +15,7 @@ class TestSearcher < Test::Unit::TestCase
           itemref.idref == 'nav' ? File.read(nav_path) : '<html></html>'
         }
       end
+      stub(@package).full_path {"OPS/ルートファイル.opf"}
     end
 
     def test_no_result

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epub-parser
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - KITAITI Makoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-02 00:00:00.000000000 Z
+date: 2018-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -371,6 +371,9 @@ files:
 - test/fixtures/book/OPS/ルートファイル.opf
 - test/fixtures/book/OPS/日本語.xhtml
 - test/fixtures/book/mimetype
+- test/fixtures/book/nested/dir/content.opf
+- test/fixtures/book/nested/dir/text/2_chapter-1.xhtml
+- test/fixtures/book/nested/dir/text/toc.xhtml
 - test/helper.rb
 - test/test_content_document.rb
 - test/test_epub.rb