epub-parser 0.1.5 → 0.1.6

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

@@ -5,10 +5,14 @@ module EPUB
     class Package
       class Guide
         include Inspector::PublicationModel
-        attr_accessor :package
+        attr_accessor :package, :references
 
-        def references
-          @references ||= []
+        def initialize
+          Reference::TYPES.each do |type|
+            variable_name = '@' + type.gsub('-', '_')
+            instance_variable_set variable_name, nil
+          end
+          @references = []
         end
 
         def <<(reference)
@@ -16,18 +20,8 @@ module EPUB
           references << reference
         end
 
-        %w[cover title-page toc index glossary acknowledgements bibliography colophon copyright-page dedication epigraph foreword loi lot notes preface text].each do |type|
-          method_name = type.gsub('-', '_')
-          define_method method_name do
-            var = instance_variable_get "@#{method_name}"
-            return var if var
-
-            var = references.selector {|ref| ref.type == type}.first
-            instance_variable_set "@#{method_name}", var
-          end
-        end
-
         class Reference
+          TYPES = %w[cover title-page toc index glossary acknowledgements bibliography colophon copyright-page dedication epigraph foreword loi lot notes preface text]
           attr_accessor :guide,
                         :type, :title, :href
 
@@ -40,6 +34,17 @@ module EPUB
             end.first
           end
         end
+
+        Reference::TYPES.each do |type|
+          method_name = type.gsub('-', '_')
+          define_method method_name do
+            var = instance_variable_get "@#{method_name}"
+            return var if var
+
+            var = references.selector {|ref| ref.type == type}.first
+            instance_variable_set "@#{method_name}", var
+          end
+        end
       end
     end
   end

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

@@ -1,3 +1,4 @@
+require 'set'
 require 'enumerabler'
 require 'epub/constants'
 require 'epub/parser/content_document'
@@ -31,7 +32,7 @@ module EPUB
         end
 
         def cover_image
-          items.selector {|i| i.properties.include? 'cover-image'}.first
+          items.selector(&:cover_image?).first
         end
 
         def each_item
@@ -57,20 +58,25 @@ module EPUB
           #   @return [String] Returns the value of id
           # @!attribute [rw] href
           #   @return [Addressable::URI] Returns the value of href,
-          #                              which is relative path from rootfile(OPF file)
+          #                              which is relative IRI from rootfile(OPF file)
           # @!attribute [rw] media_type
           #   @return [String] Returns the value of media_type
           # @!attribute [rw] properties
-          #   @return [Array<String>] Returns the value of properties
+          #   @return [Set<String>] Returns the value of properties
           # @!attribute [rw] media_overlay
           #   @return [String] Returns the value of media_overlay
           # @!attribute [rw] fallback
           #   @return [Item] Returns the value of attribute fallback
           attr_accessor :manifest,
-                        :id, :href, :media_type, :fallback, :properties, :media_overlay
+                        :id, :href, :media_type, :fallback, :media_overlay
+          attr_reader :properties
 
           def initialize
-            @properties = []
+            @properties = Set.new
+          end
+
+          def properties=(props)
+            @properties = props.kind_of?(Set) ? props : Set.new(props)
           end
 
           # @todo Handle circular fallback chain
@@ -98,6 +104,10 @@ module EPUB
             properties.include? 'nav'
           end
 
+          def cover_image?
+            properties.include? 'cover-image'
+          end
+
           # @todo Handle circular fallback chain
           def use_fallback_chain(options = {})
             supported = EPUB::MediaType::CORE
@@ -113,7 +123,7 @@ module EPUB
               return yield binding_media_type.handler
             end
             return fallback.use_fallback_chain(options) {|fb| yield fb} if fallback
-            raise EPUB::MediaType::UnsupportedError
+            raise EPUB::MediaType::UnsupportedMediaType
           end
 
           def content_document
@@ -127,6 +137,26 @@ module EPUB
             manifest.package.spine.itemrefs.find {|itemref| itemref.idref == id}
           end
 
+          # @param iri [Addressable::URI] relative iri
+          # @return [Item]
+          # @return [nil] when item not found
+          # @raise ArgumentError when +iri+ is not relative
+          # @raise ArgumentError when +iri+ starts with "/"(slash)
+          # @note Algorithm stolen form Rack::Utils#clean_path_info
+          def find_item_by_relative_iri(iri)
+            raise ArgumentError, "Not relative: #{iri.inspect}" unless iri.relative?
+            raise ArgumentError, "Start with slash: #{iri.inspect}" if iri.to_s.start_with? Addressable::URI::SLASH
+            target_href = href + iri
+            segments = target_href.to_s.split(Addressable::URI::SLASH)
+            clean_segments = []
+            segments.each do |segment|
+              next if segment.empty? || segment == '.'
+              segment == '..' ? clean_segments.pop : clean_segments << segment
+            end
+            target_iri = Addressable::URI.parse(clean_segments.join(Addressable::URI::SLASH))
+            manifest.items.find { |item| item.href == target_iri}
+          end
+
           def inspect
             "#<%{class}:%{object_id} %{manifest} %{attributes}>" % {
               :class      => self.class,

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

@@ -1,10 +1,10 @@
+require 'set'
+
 module EPUB
   module Publication
     class Package
       class Metadata
         include Inspector::PublicationModel
-        include MethodDecorators
-        extend MethodDecorators
 
         DC_ELEMS = [:identifiers, :titles, :languages] +
                    [:contributors, :coverages, :creators, :dates, :descriptions, :formats, :publishers,
@@ -48,6 +48,10 @@ module EPUB
           dates.first
         end
 
+        def language
+          languages.first
+        end
+
         def to_h
           DC_ELEMS.inject({}) do |hsh, elem|
             hsh[elem] = __send__(elem)
@@ -55,11 +59,6 @@ module EPUB
           end
         end
 
-        +Deprecated.new {|klass, method| "#{klass}##{method} is deprecated. Use #to_h instead."}
-        def to_hash
-          to_h
-        end
-
         def primary_metas
           metas.select {|meta| meta.primary_expression?}
         end
@@ -70,7 +69,7 @@ module EPUB
           attr_writer :refiners
 
           def refiners
-            @refiners ||= []
+            @refiners ||= Set.new
           end
 
           PROPERTIES.each do |voc|
@@ -92,6 +91,26 @@ module EPUB
           end
         end
 
+        class Identifier < DCMES
+          # @note This is ad-hoc
+          # @todo Define and include OPF module for opf:scheme attribute
+          # @todo Define generale way to handle with identifier-type refiners
+          attr_accessor :scheme
+
+          # @note This is ad-hoc
+          # @todo Define and include OPF module for opf:scheme attribute
+          # @todo Define generale way to handle with identifier-type refiners
+          def isbn?
+            refiners.any? {|refiner|
+              refiner.property == 'identifier-type' and
+              refiner.scheme == 'onix:codelist5' and
+              %w[02 15].include? refiner.content
+            } or
+            scheme == 'ISBN' or
+            content.to_s.downcase.start_with? 'urn:isbn'
+          end
+        end
+
         class Title < DCMES
           include Comparable
 

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

@@ -1,3 +1,5 @@
+require 'set'
+
 module EPUB
   module Publication
     class Package
@@ -42,10 +44,15 @@ module EPUB
           PAGE_SPREAD_PREFIX = 'page-spread-'.freeze
 
           attr_accessor :spine,
-                        :idref, :linear, :id, :properties
+                        :idref, :linear, :id
+          attr_reader :properties
 
           def initialize
-            @properties = []
+            @properties = Set.new
+          end
+
+          def properties=(props)
+            @properties = props.kind_of?(Set) ? props : Set.new(props)
           end
 
           # @return [true|false]
@@ -68,7 +75,7 @@ module EPUB
               self.__send__(meth) == other.__send__(meth)
             } and
               (linear? == other.linear?) and
-              (other.properties - properties).empty?
+              (properties == other.properties)
           end
 
           # @return ["left", "right", nil]

data/test/fixtures/book/OPS/nav.xhtml

@@ -5,7 +5,7 @@
   </head>
   <body>
     <div>
-      <nav epub:type="toc" id="idid">
+      <nav epub:type="toc" id="idid" hidden="">
         <hgroup>
           <h2>Sub Navigation</h2>
           <h1>Table of Contents</h1>

data/test/fixtures/book/OPS//343/203/253/343/203/274/343/203/210/343/203/225/343/202/241/343/202/244/343/203/253.opf

@@ -4,8 +4,9 @@
          xmlns="http://www.idpf.org/2007/opf"
          prefix=" foaf:  http://xmlns.com/foaf/spec/
                   dbp: http://dbpedia.org/ontology/  ">
-  <metadata xmlns:dc="http://purl.org/dc/elements/1.1/">
+  <metadata xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:opf="http://www.idpf.org/2007/opf">
     <dc:identifier id="pub-id">da265185-8da8-462d-a146-17dd388f61fc</dc:identifier>
+    <dc:identifier opf:scheme="ISBN">0000000000000</dc:identifier>
 
     <dc:title id="t1" xml:lang="fr">Mon premier guide de cuisson, un Mémoire</dc:title>
     <meta refines="#t1" property="title-type">main</meta>

data/test/helper.rb

@@ -1,6 +1,6 @@
 require 'simplecov'
 SimpleCov.start do
-  add_filter '/test|deps|method_decorators/'
+  add_filter '/test|deps/'
 end
 
 require 'test/unit'

data/test/test_content_document.rb

@@ -41,13 +41,52 @@ class TestContentDocument < Test::Unit::TestCase
 
   def test_title_returns_value_of_title_element
     content_doc = XHTML.new
-    stub(content_doc).read {File.read(File.join(File.dirname(__FILE__), 'fixtures', 'book', 'OPS', '日本語.xhtml'))}
+    stub(content_doc).raw_document {File.read(File.join(File.dirname(__FILE__), 'fixtures', 'book', 'OPS', '日本語.xhtml'))}
     assert_equal '日本語', content_doc.title
   end
 
   def test_title_returns_empty_string_when_title_element_not_exist
     content_doc = XHTML.new
-    stub(content_doc).read {'content'}
+    stub(content_doc).raw_document {'content'}
     assert_equal '', content_doc.title
   end
+
+  class TestNavigationDocument < self
+    def test_item_hidden_returns_true_when_it_has_some_value
+      item = Navigation::Item.new.tap {|item| item.hidden = ''}
+      assert_true item.hidden?
+    end
+
+    def test_item_hidden_returns_false_when_no_parent_and_no_value
+      item = Navigation::Item.new
+      assert_false item.hidden?
+    end
+
+    def test_item_hidden_cascade_parent_item
+      parent = Navigation::Item.new.tap {|item| item.hidden = true}
+      child = Navigation::Item.new.tap {|item| item.hidden = nil}
+      parent.items << child
+      assert_true parent.items.hidden?
+      assert_true child.hidden?
+    end
+
+    def test_item_is_traversable
+      parent = Navigation::Item.new
+      child = Navigation::Navigation.new
+      grandchild = Navigation::Item.new
+      parent.items << child
+      child.items << grandchild
+
+      parent.traverse do |item, deps|
+        case deps
+        when 0
+          assert_equal item, parent
+        when 1
+          assert_equal item, child
+        when 2
+          assert_equal item, grandchild
+        end
+      end
+    end
+  end
 end

data/test/test_epub.rb

@@ -6,13 +6,6 @@ class TestEUPB < Test::Unit::TestCase
     @file = 'test/fixtures/book.epub'
   end
 
-  def test_parse
-    book = EPUB::Book.new
-    assert_nothing_raised do
-      book.parse @file
-    end
-  end
-
   def test_each_page_on_spine_returns_enumerator_when_block_not_given
     book = EPUB::Parser.parse(@file)
     assert_kind_of Enumerator, book.each_page_on_spine

data/test/test_parser.rb

@@ -1,7 +1,7 @@
 require File.expand_path 'helper', File.dirname(__FILE__)
 
 class MyBook
-  include EPUB
+  include EPUB::Book::Features
 end
 
 class TestParser < Test::Unit::TestCase
@@ -13,16 +13,16 @@ class TestParser < Test::Unit::TestCase
     assert_instance_of EPUB::Book, @parser.parse
 
     book = Object.new
-    book.extend EPUB
+    book.extend EPUB::Book::Features
     assert_nothing_raised do
       EPUB::Parser.parse('test/fixtures/book.epub', book: book)
     end
-    assert_kind_of EPUB, EPUB::Parser.parse('test/fixtures/book.epub', book: book)
+    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, EPUB::Parser.parse('test/fixtures/book.epub', class: MyBook)
+    assert_kind_of EPUB::Book::Features, EPUB::Parser.parse('test/fixtures/book.epub', class: MyBook)
   end
 
   class TestBook < TestParser

data/test/test_parser_content_document.rb

@@ -30,5 +30,7 @@ class TestParserContentDocument < Test::Unit::TestCase
     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_publication.rb

@@ -47,6 +47,10 @@ class TestParserPublication < Test::Unit::TestCase
       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

data/test/test_publication.rb

@@ -134,6 +134,51 @@ class TestPublication < Test::Unit::TestCase
 
       assert_true meta.subexpression?
     end
+
+    class TestIdentifier < self
+      def setup
+        @identifier = Package::Metadata::Identifier.new
+      end
+
+      def test_is_isbn_when_refined_by_onix_scheme
+        meta = Package::Metadata::Meta.new
+        meta.property = 'identifier-type'
+        meta.scheme = 'onix:codelist5'
+        meta.content = '02'
+        meta.refines = @identifier
+
+        assert_true @identifier.isbn?
+      end
+
+      def test_is_isbn_when_qualified_by_attribute
+        @identifier.content = '0000000000'
+        @identifier.scheme = 'ISBN'
+
+        assert_true @identifier.isbn?
+      end
+
+      def test_is_isbn_when_content_is_isbn_urn
+        @identifier.content = 'urn:isbn:0000000000'
+
+        assert_true @identifier.isbn?
+      end
+
+      def test_is_not_isbn_when_no_refiner_nor_scheme
+        assert_false @identifier.isbn?
+      end
+
+      def test_refiner_take_precedence_over_scheme_for_isbn
+        @identifier.content = '0000000000000'
+        @identifier.scheme = 'something'
+        meta = Package::Metadata::Meta.new
+        meta.property = 'identifier-type'
+        meta.scheme = 'onix:codelist5'
+        meta.content = '15'
+        meta.refines = @identifier
+
+        assert_true @identifier.isbn?
+      end
+    end
   end
 
   class TestManifest < TestPublication
@@ -179,6 +224,21 @@ class TestPublication < Test::Unit::TestCase
 
         assert_false item.xhtml?
       end
+
+      def test_find_item_by_relative_iri_returns_item_which_has_resolved_iri_as_href
+        manifest = Package::Manifest.new
+        manifest << xhtml_item = Package::Manifest::Item.new.tap {|item| item.href = Addressable::URI.parse('text/01.xhtml')}
+        manifest << image_item = Package::Manifest::Item.new.tap {|item| item.href = Addressable::URI.parse('image/01.png')}
+
+        assert_equal image_item, xhtml_item.find_item_by_relative_iri(Addressable::URI.parse('../image/01.png'))
+      end
+
+      def test_find_item_by_relative_iri_returns_nil_when_no_item_found
+        manifest = Package::Manifest.new
+        manifest << xhtml_item = Package::Manifest::Item.new.tap {|item| item.href = Addressable::URI.parse('text/01.xhtml')}
+
+        assert_nil xhtml_item.find_item_by_relative_iri(Addressable::URI.parse('../image/01.png'))
+      end
     end
   end