epub-parser 0.2.5 → 0.2.6

data/lib/epub/parser/ocf.rb

@@ -1,12 +1,14 @@
 require 'epub/constants'
 require 'epub/ocf'
 require 'epub/ocf/physical_container'
+require 'epub/parser/metadata'
 require 'nokogiri'
 
 module EPUB
   class Parser
     class OCF
       include Utils
+      include Metadata
 
       DIRECTORY = 'META-INF'
 
@@ -26,9 +28,7 @@ module EPUB
           begin
             data = @container.read(File.join(DIRECTORY, "#{m}.xml"))
             @ocf.__send__ "#{m}=", __send__("parse_#{m}", data)
-          rescue EPUB::OCF::PhysicalContainer::NoEntry, ::Errno::ENOENT, OpenURI::HTTPError
-          rescue => error
-            raise error unless (Object.const_defined? :Zip and ::Zip.const_defined? :Error and error.kind_of? ::Zip::Error)
+          rescue EPUB::OCF::PhysicalContainer::NoEntry
           end
         end
 
@@ -59,7 +59,14 @@ module EPUB
       end
 
       def parse_metadata(content)
-        warn "Not implemented: #{self.class}##{__method__}" if $VERBOSE
+        doc = Nokogiri.XML(content)
+        unless multiple_rendition_metadata?(doc)
+          warn "Not implemented: #{self.class}##{__method__}" if $VERBOSE
+          metadata = EPUB::OCF::UnknownFormatMetadata.new
+          metadata.content = content
+          return metadata
+        end
+        super(doc.root, doc.root['unique-identifier'], 'metadata')
       end
 
       def parse_rights(content)
@@ -69,6 +76,14 @@ module EPUB
       def parse_signatures(content)
         warn "Not implemented: #{self.class}##{__method__}" if $VERBOSE
       end
+
+      private
+
+      def multiple_rendition_metadata?(doc)
+        doc.root &&
+          doc.root.name == 'metadata' &&
+          doc.namespaces['xmlns'] == EPUB::NAMESPACES['metadata']
+      end
     end
   end
 end

data/lib/epub/parser/publication.rb

@@ -2,79 +2,56 @@ require 'strscan'
 require 'nokogiri'
 require 'epub/publication'
 require 'epub/constants'
+require 'epub/parser/metadata'
 
 module EPUB
   class Parser
     class Publication
       include Utils
+      include Metadata
 
       class << self
         def parse(container, file)
           opf = container.read(Addressable::URI.unencode(file))
 
-          new(opf, file).parse
+          new(opf).parse
         end
       end
 
-      def initialize(opf, rootfile)
-        @package = EPUB::Publication::Package.new
-        @rootfile = Addressable::URI.parse(rootfile)
+      def initialize(opf, rootfile=nil)
+        warn "Second argument for #{self.class}.new is deprecated" if rootfile
         @doc = Nokogiri.XML(opf)
       end
 
       def parse
-        ([:package] + EPUB::Publication::Package::CONTENT_MODELS).each do |model|
-          __send__ "parse_#{model}"
+        package = parse_package(@doc)
+        (EPUB::Publication::Package::CONTENT_MODELS - [:bindings]).each do |model|
+          package.__send__ "#{model}=",  __send__("parse_#{model}", @doc)
         end
+        package.bindings = parse_bindings(@doc, package.manifest)
 
-        @package
+        package
       end
 
-      def parse_package
-        elem = @doc.root
+      def parse_package(doc)
+        package = EPUB::Publication::Package.new
+        elem = doc.root
         %w[version xml:lang dir id].each do |attr|
-          @package.__send__ "#{attr.gsub(/\:/, '_')}=", extract_attribute(elem, attr)
+          package.__send__ "#{attr.gsub(/\:/, '_')}=", extract_attribute(elem, attr)
         end
-        @unique_identifier_id = elem['unique-identifier']
-        @package.prefix = parse_prefix(extract_attribute(elem, 'prefix'))
-        EPUB::Publication.__send__ :include, EPUB::Publication::FixedLayout if @package.prefix.key? EPUB::Publication::FixedLayout::PREFIX_KEY
+        package.prefix = parse_prefix(extract_attribute(elem, 'prefix'))
+        EPUB::Publication.__send__ :include, EPUB::Publication::FixedLayout if package.prefix.key? EPUB::Publication::FixedLayout::PREFIX_KEY
 
-        @package
+        package
       end
 
-      def parse_metadata
-        metadata = @package.metadata = EPUB::Publication::Package::Metadata.new
-        elem = @doc.xpath('/opf:package/opf:metadata', EPUB::NAMESPACES).first
-        id_map = {}
-
-        metadata.identifiers = extract_model(elem, id_map, './dc:identifier', :Identifier, ['id']) {|identifier, e|
-          identifier.scheme = extract_attribute(e, 'scheme', 'opf')
-          metadata.unique_identifier = identifier if identifier.id == @unique_identifier_id
-        }
-        metadata.titles = extract_model(elem, id_map, './dc:title', :Title)
-        metadata.languages = extract_model(elem, id_map, './dc:language', :DCMES, %w[id])
-        %w[contributor coverage creator date description format publisher relation source subject type].each do |dcmes|
-          metadata.__send__ "#{dcmes}s=", extract_model(elem, id_map, "./dc:#{dcmes}")
-        end
-        metadata.rights = extract_model(elem, id_map, './dc:rights')
-        metadata.metas = extract_refinee(elem, id_map, './opf:meta', :Meta, %w[property id scheme])
-        metadata.links = extract_refinee(elem, id_map, './opf:link', :Link, %w[id media-type]) {|link, e|
-          link.href = extract_attribute(e, 'href')
-          link.rel = Set.new(extract_attribute(e, 'rel').split(nil))
-        }
-
-        id_map.values.each do |hsh|
-          next unless hsh[:refiners]
-          next unless hsh[:metadata]
-          hsh[:refiners].each {|meta| meta.refines = hsh[:metadata]}
-        end
-
-        metadata
+      def parse_metadata(doc)
+        super(doc.xpath('/opf:package/opf:metadata', EPUB::NAMESPACES).first, doc.root['unique-identifier'], 'opf')
       end
 
-      def parse_manifest
-        manifest = @package.manifest = EPUB::Publication::Package::Manifest.new
-        elem = @doc.xpath('/opf:package/opf:manifest', EPUB::NAMESPACES).first
+      def parse_manifest(doc)
+        manifest = EPUB::Publication::Package::Manifest.new
+        elem = doc.xpath('/opf:package/opf:manifest', EPUB::NAMESPACES).first
         manifest.id = extract_attribute(elem, 'id')
 
         fallback_map = {}
@@ -97,9 +74,9 @@ module EPUB
         manifest
       end
 
-      def parse_spine
-        spine = @package.spine = EPUB::Publication::Package::Spine.new
-        elem = @doc.xpath('/opf:package/opf:spine', EPUB::NAMESPACES).first
+      def parse_spine(doc)
+        spine = EPUB::Publication::Package::Spine.new
+        elem = doc.xpath('/opf:package/opf:spine', EPUB::NAMESPACES).first
         %w[id toc page-progression-direction].each do |attr|
           spine.__send__ "#{attr.gsub(/-/, '_')}=", extract_attribute(elem, attr)
         end
@@ -118,9 +95,9 @@ module EPUB
         spine
       end
 
-      def parse_guide
-        guide = @package.guide = EPUB::Publication::Package::Guide.new
-        @doc.xpath('/opf:package/opf:guide/opf:reference', EPUB::NAMESPACES).each do |ref|
+      def parse_guide(doc)
+        guide = EPUB::Publication::Package::Guide.new
+        doc.xpath('/opf:package/opf:guide/opf:reference', EPUB::NAMESPACES).each do |ref|
           reference = EPUB::Publication::Package::Guide::Reference.new
           %w[type title].each do |attr|
             reference.__send__ "#{attr}=", extract_attribute(ref, attr)
@@ -132,12 +109,12 @@ module EPUB
         guide
       end
 
-      def parse_bindings
-        bindings = @package.bindings = EPUB::Publication::Package::Bindings.new
-        @doc.xpath('/opf:package/opf:bindings/opf:mediaType', EPUB::NAMESPACES).each do |elem|
+      def parse_bindings(doc, handler_map)
+        bindings = EPUB::Publication::Package::Bindings.new
+        doc.xpath('/opf:package/opf:bindings/opf:mediaType', EPUB::NAMESPACES).each do |elem|
           media_type = EPUB::Publication::Package::Bindings::MediaType.new
           media_type.media_type = extract_attribute(elem, 'media-type')
-          media_type.handler = @package.manifest[extract_attribute(elem, 'handler')]
+          media_type.handler = handler_map[extract_attribute(elem, 'handler')]
           bindings << media_type
         end
 
@@ -161,39 +138,6 @@ module EPUB
         end
         prefixes
       end
-
-      def extract_model(elem, id_map, xpath, klass=:DCMES, attributes=%w[id lang dir])
-        models = elem.xpath(xpath, EPUB::NAMESPACES).collect do |e|
-          model = EPUB::Publication::Package::Metadata.const_get(klass).new
-          attributes.each do |attr|
-            model.__send__ "#{attr.gsub(/-/, '_')}=", extract_attribute(e, attr)
-          end
-          model.content = e.content unless klass == :Link
-
-          yield model, e if block_given?
-
-          model
-        end
-
-        models.each do |model|
-          id_map[model.id] = {metadata: model} if model.respond_to?(:id) && model.id
-        end
-
-        models
-      end
-
-      def extract_refinee(elem, id_map, xpath, klass, attributes)
-        extract_model(elem, id_map, xpath, klass, attributes) {|model, e|
-          yield model, e if block_given?
-          refines = extract_attribute(e, 'refines')
-          if refines && refines[0] == '#'
-            id = refines[1..-1]
-            id_map[id] ||= {}
-            id_map[id][:refiners] ||= []
-            id_map[id][:refiners] << model
-          end
-        }
-      end
     end
   end
 end

data/lib/epub/parser/version.rb

@@ -1,5 +1,5 @@
 module EPUB
   class Parser
-    VERSION = "0.2.5"
+    VERSION = "0.2.6"
   end
 end

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

@@ -1,174 +1,9 @@
-require 'set'
+require 'epub/metadata'
 
 module EPUB
   module Publication
     class Package
-      class Metadata
-        include Inspector::PublicationModel
-
-        DC_ELEMS = [:identifiers, :titles, :languages] +
-                   [:contributors, :coverages, :creators, :dates, :descriptions, :formats, :publishers,
-                    :relations, :rights, :sources, :subjects, :types]
-        attr_accessor :package, :unique_identifier, :metas, :links,
-                      *(DC_ELEMS.collect {|elem| "dc_#{elem}"})
-        DC_ELEMS.each do |elem|
-          alias_method elem, "dc_#{elem}"
-          alias_method "#{elem}=", "dc_#{elem}="
-        end
-
-        def initialize
-          (DC_ELEMS + [:metas, :links]).each do |elem|
-            __send__ "#{elem}=", []
-          end
-        end
-
-        def title
-          return extended_title unless extended_title.empty?
-          compositted = titles.select {|title| title.display_seq}.sort.join("\n")
-          return compositted unless compositted.empty?
-          return main_title unless main_title.empty?
-          titles.sort.join("\n")
-        end
-
-        %w[main short collection edition extended].each do |type|
-          define_method "#{type}_title" do
-            titles.select {|title| title.title_type.to_s == type}.sort.join(' ')
-          end
-        end
-
-        def subtitle
-          titles.select {|title| title.title_type.to_s == 'subtitle'}.sort.join(' ')
-        end
-
-        def description
-          descriptions.join(' ')
-        end
-
-        def date
-          dates.first
-        end
-
-        def language
-          languages.first
-        end
-
-        def modified
-          metas.find {|meta| meta.property == 'dcterms:modified'}
-        end
-
-        def to_h
-          DC_ELEMS.inject({}) do |hsh, elem|
-            hsh[elem] = __send__(elem)
-            hsh
-          end
-        end
-
-        def primary_metas
-          metas.select {|meta| meta.primary_expression?}
-        end
-
-        module Refinee
-          PROPERTIES = %w[alternate-script display-seq file-as group-position identifier-type meta-auth role title-type]
-
-          attr_writer :refiners
-
-          def refiners
-            @refiners ||= Set.new
-          end
-
-          PROPERTIES.each do |voc|
-            met = voc.gsub(/-/, '_')
-            attr_writer met
-            define_method met do
-              refiners.find {|refiner| refiner.property == voc}
-            end
-          end
-        end
-
-        class DCMES
-          include Refinee
-
-          attr_accessor :content, :id, :lang, :dir
-
-          def to_s
-            content.to_s
-          end
-        end
-
-        class Identifier < DCMES
-          # @note This is ad-hoc
-          # @todo Define and include OPF module for opf:scheme attribute
-          # @todo Define general 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 general way to handle with identifier-type refiners
-          def isbn?
-            scheme == 'ISBN' or
-            content.to_s.downcase.start_with? 'urn:isbn' or
-            refiners.any? {|refiner|
-              refiner.property == 'identifier-type' and
-              refiner.scheme == 'onix:codelist5' and
-              %w[02 15].include? refiner.content
-            }
-          end
-        end
-
-        class Title < DCMES
-          include Comparable
-
-          def <=>(other)
-            return 1 if other.display_seq.nil?
-            return -1 if display_seq.nil?
-            display_seq.to_s.to_i <=> other.display_seq.to_s.to_i
-          end
-        end
-
-        class Meta
-          include Refinee
-
-          attr_accessor :property, :id, :scheme, :content
-          attr_reader :refines
-
-          def refines=(refinee)
-            refinee.refiners << self
-            @refines = refinee
-          end
-
-          def refines?
-            ! refines.nil?
-          end
-          alias subexpression? refines?
-
-          def primary_expression?
-            ! subexpression?
-          end
-
-          def inspect
-            ivs = instance_variables.map {|iv|
-              [iv, instance_variable_get(iv).inspect].join('=')
-            }.join(' ')
-            '<#%s:%#0x %s>' % [self.class, __id__, ivs]
-          end
-
-          def to_s
-            content.to_s
-          end
-        end
-
-        class Link
-          include Refinee
-
-          attr_accessor :href, :rel, :id, :media_type
-          attr_reader :refines
-
-          def refines=(refinee)
-            refinee.refiners << self
-            @refines = refinee
-          end
-        end
-      end
+      Metadata = EPUB::Metadata
     end
   end
 end

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

@@ -0,0 +1,6 @@
+<metadata xmlns="http://www.idpf.org/2013/metadata"
+          xmlns:dc="http://purl.org/dc/elements/1.1/"
+          unique-identifier="pub-id">
+  <dc:identifier id="pub-id">urn:uuid:A1B0D67E-2E81-4DF5-9E67-A64CBE366809</dc:identifier>
+  <meta property="dcterms:modified">2011-01-01T12:00:00Z</meta>
+</metadata>

data/test/helper.rb

@@ -8,4 +8,7 @@ require 'test/unit'
 require 'test/unit/rr'
 require 'test/unit/notify'
 require 'pry'
+require 'pretty_backtrace'
+PrettyBacktrace.enable
+
 require 'epub/parser'

data/test/test_epub.rb

@@ -17,5 +17,9 @@ class TestEUPB < Test::Unit::TestCase
       assert_kind_of EPUB::Publication::Package::Manifest::Item, entry
     end
   end
-end
 
+  def test_book_has_multiple_packages
+    book = EPUB::Parser.parse(@file)
+    assert_instance_of Array, book.packages
+  end
+end