epub-parser 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b9ee0e48ab95b16264f66048d2f0d040f63ab2d
-  data.tar.gz: b16bd608fc1c7c54de24a30c13ad880cd9f096de
+  metadata.gz: e92165c76652996a441e9996bb9bdee8bb0e7b04
+  data.tar.gz: c7a62b70d282f9b8343c0b850db21d7f078961d9
 SHA512:
-  metadata.gz: 6df7c1519d379afe93635e085ae7c3d9548ac9005a7e6cb79066db2310deca63ac8d0089100516a3657e6a16f092c3472897e5b10c227dd60b0c5db5e028f570
-  data.tar.gz: 80f34c61d4043beba1ca680db124744a1c619c126e19b097d2b1ba4ac0cb0439efdb99ebd9c183119f8d5a210bfde7408f234b4bf25678a36b4401cf842f37a6
+  metadata.gz: f56160b8148faf112e6ff8941a380223f1ce4d0ad114b2375f8e9793fe4eb0d7d9e18dda540f36c1ce702c90c7791006f5fa65c270498d5d6e5b341862e6aa37
+  data.tar.gz: f139ae34069e6bcfe85d23ae5b4db32cecd99ae90cfc1fbe12ba1b2541f31d93329a6215cf099074b0fc0a3b03996ea6fca2508ad9b3165f27522be5fb8c759e

data/.yardopts

@@ -11,6 +11,7 @@ docs/Navigation.markdown
 docs/Searcher.markdown
 docs/UnpackedArchive.markdown
 docs/AggregateContentsFromWeb.markdown
+docs/MultipleRenditions.markdown
 examples/aggregate-contents-from-web.rb
 examples/exctract-content-using-cfi.rb
 examples/find-elements-and-cfis.rb

data/CHANGELOG.markdown

@@ -1,6 +1,14 @@
 CHANGELOG
 =========
 
+0.2.7
+-----
+
+* Add `EPUB::Metadata#children` to keep all child emements to count them on CFI search
+* Allow class including `EPUB` to intialize with extra arguments(Thanks, [skukx][]!)
+
+[skukx]: https://github.com/skukx
+
 0.2.6
 -----
 

data/README.markdown

@@ -151,6 +151,13 @@ If you find other gems, please tell me or request a pull request.
 RECENT CHANGES
 --------------
 
+### 0.2.7
+
+* Add `EPUB::Metadata#children`
+* Allow class including `EPUB` to intialize with extra arguments(Thanks, [skukx][]!)
+
+[skukx]: https://github.com/skukx
+
 ### 0.2.6
 
 * Add `EPUB::Publication::Package::Metadata#package_identifier` as alias of `#release_identifier`
@@ -167,14 +174,6 @@ RECENT CHANGES
 * [BUG FIX]Don't load Zip/Ruby if unneccessary
 * Add `EPUB::CFI::PhysicalContainer.find_adapter`
 
-### 0.2.4
-
-* Bug fix for `EPUB::CFI::Location#<=>`
-* Change default physical container adapter from `EPUB::OCF::PhysicalContainer::ZipRuby` to `EPUB::OCF::PhysicalContainer::ArchiveZip`
-* Add `EPUB::CFI::Step#element?` and `#character_data?`
-* Change attribute name: `EPUB::CFI::Step#step` -> `EPUB::CFI::Step#value`, `EPUB::CFI::CharacterOffset#offset` -> `EPUB::CFI::CharacterOffset#value`
-* Show modified on `epubinfo` command
-
 See {file:CHANGELOG.markdown} for older changelogs and details.
 
 TODOS

data/docs/Home.markdown

@@ -102,6 +102,7 @@ More documentations are avaiable in:
 * {file:docs/Searcher.markdown}
 * {file:docs/UnpackedArchive.markdown}
 * {file:docs/AggregateContentsFromWeb.markdown}
+* {file:docs/MultipleRenditions.markdown}
 
 If you installed EPUB Parser via gem command, you can also generate documentaiton by your own([rubygems-yardoc][] gem is needed):
 
@@ -157,11 +158,13 @@ Currently implemented:
 * [EPUB Publications 3.0][]
 * EPUB Navigation Documents of [EPUB Content Documents 3.0][]
 * [EPUB 3 Fixed-Layout Documents][]
+* metadata.xml of [EPUB Multiple-Rendition Publications][]
 
 [EPUB Open Container Format (OCF) 3.0]:http://idpf.org/epub/30/spec/epub30-ocf.html#sec-container-metainf-container.xml
 [EPUB Publications 3.0]:http://idpf.org/epub/30/spec/epub30-publications.html
 [EPUB Content Documents 3.0]:http://www.idpf.org/epub/30/spec/epub30-contentdocs.html
 [EPUB 3 Fixed-Layout Documents]:http://www.idpf.org/epub/fxl/
+[EPUB Multiple-Rendition Publications]: http://www.idpf.org/epub/renditions/multiple/
 
 License
 -------

data/docs/MultipleRenditions.markdown

@@ -0,0 +1,61 @@
+{file:docs/Home.markdown} > **{file:docs/MultipleRenditions.markdown}**
+
+Multiple Renditions
+===================
+
+An EPUB publication(file) may have multiple renditions, how reading system renders contents. It is expressed as multiple {EPUB::Publication::Package} object.
+
+Usually, you don't need to care about it.
+
+    epub = EPUB::Parser.parse('path/to/book')
+    epub.package # => #<EPUB::Publication::Package...>
+
+This is enough in most cases.
+
+Getting multiple renditions
+---------------------------
+
+If your book has multiple renditions, you can get them by {EPUB::Book::Features#packages}, aliased as {EPUB::Book::Features#packages #renditoins}.
+
+    epub.packages # => [#<EPUB::Publication::Package...>, #<EPUB::Publication::Package...>, ...]
+
+`epub.package` is shortcut to `epub.packages.first`(called default rendition).
+
+    epub.package == epub.packages.first # => true
+    epub.default_rendition == epub.packages.first # => true
+
+Metadata of renditions
+----------------------
+
+Sometimes, the situation about metadata is more complicated.
+
+A publication may have multiple rendition(package)s. A rendition has a metadata. So, A publication has as many metadata objects as renditions...
+
+    epub.packages.all? {|package| package.respond_to? :metadata} # => true
+
+... at least.
+
+In addition, a publication may have a metadata that is not related to any rendition but to EPUB file itself. You can access to it by:
+
+    epub.ocf.metadata # => #<EPUB::Metadata...>
+
+This kind of metadata is introduced by [EPUB Multiple-Rendition Publications][] spec and most EPUB files don't have that for now. So, you need to note that `epub.ocf.metadata` might be `nil`.
+
+Identifiers
+-----------
+
+You can identify any metadata by identifers called release identifier. If your book has metadata for publication and packages, they might not have the same identifier to any identifiers of renditions. By this difference, publishers or authors can represent the situation "all renditions are changed but the book itself is not." To do so, publishers or authors will change all identifiers of renditions(`epub.packages.collect(&:metadata).collect(&:release_identifier)`) but keep `epub.ocf.metadata.release_identifier`.
+
+Known issues
+------------
+
+Currently, at least on v0.2.6, EPUB Parser provides limited support for [Multiple-Rendition][EPUB Multiple-Rendition Publications] spec.
+
+See also
+--------
+
+* [EPUB Publications 3.0.1][]
+* [EPUB Multiple-Rendition Publications][]
+
+[EPUB Publications 3.0.1]: http://www.idpf.org/epub/301/spec/epub-publications.html
+[EPUB Multiple-Rendition Publications]: http://www.idpf.org/epub/renditions/multiple/

data/lib/epub/book/features.rb

@@ -5,7 +5,6 @@ module EPUB
     module Features
       extend Forwardable
       attr_reader :ocf
-      attr_writer :package
       attr_accessor :epub_file
 
       # When writing, sets +ocf.book+ to self.
@@ -27,19 +26,12 @@ module EPUB
       end
       alias renditions packages
 
-      # Syntax sugar.
-      # Returns package set by +package=+.
-      # Returns default rendition if any package has not been set ever.
-      # @return [Publication::Package]
-      def package
-        @package || default_rendition
-      end
-
       # First +package+ in +packages+
       # @return [Package|nil]
       def default_rendition
         packages.first
       end
+      alias package default_rendition
 
       # @!parse def_delegators :package, :metadata, :manifest, :spine, :guide, :bindings
       def_delegators :package, *Publication::Package::CONTENT_MODELS

data/lib/epub/metadata.rb

@@ -7,6 +7,8 @@ module EPUB
     DC_ELEMS = [:identifiers, :titles, :languages] +
                [:contributors, :coverages, :creators, :dates, :descriptions, :formats, :publishers,
                 :relations, :rights, :sources, :subjects, :types]
+    # Used for CFI
+    attr_reader :children
     attr_accessor :package, :unique_identifier, :metas, :links,
                   *(DC_ELEMS.collect {|elem| "dc_#{elem}"})
     DC_ELEMS.each do |elem|
@@ -18,6 +20,7 @@ module EPUB
       (DC_ELEMS + [:metas, :links]).each do |elem|
         __send__ "#{elem}=", []
       end
+      @children = []
     end
 
     def release_identifier
@@ -174,5 +177,13 @@ module EPUB
         @refines = refinee
       end
     end
+
+    class UnsupportedModel
+      attr_accessor :raw_element
+
+      def initialize(raw_element)
+        @raw_element = raw_element
+      end
+    end
   end
 end

data/lib/epub/parser.rb

@@ -81,7 +81,11 @@ module EPUB
       when params[:book]
         params[:book]
       when params[:class]
-        params[:class].new
+        if params[:initialize_with]
+          params[:class].new params[:initialize_with]
+        else
+          params[:class].new
+        end
       else
         Book.new
       end

data/lib/epub/parser/metadata.rb

@@ -5,62 +5,95 @@ module EPUB
         metadata = EPUB::Publication::Package::Metadata.new
         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, "./#{default_namespace}:meta", :Meta, %w[property id scheme])
-        metadata.links = extract_refinee(elem, id_map, "./#{default_namespace}:link", :Link, %w[id media-type]) {|link, e|
-          link.href = extract_attribute(e, 'href')
-          link.rel = Set.new(extract_attribute(e, 'rel').split(nil))
-        }
+        default_namespace_uri = EPUB::NAMESPACES[default_namespace]
+        elem.element_children.each do |child|
+          namespace_uri = child.namespace && child.namespace.href
+          elem_name = child.name
 
-        id_map.values.each do |hsh|
-          next unless hsh[:refiners]
-          next unless hsh[:metadata]
-          hsh[:refiners].each {|meta| meta.refines = hsh[:metadata]}
-        end
+          model =
+            case namespace_uri
+            when EPUB::NAMESPACES['dc']
+              case elem_name
+              when 'identifier'
+                identifier = build_model(child, :Identifier, ['id'])
+                metadata.identifiers << identifier
+                identifier.scheme = extract_attribute(child, 'scheme', 'opf')
+                identifier
+              when 'title'
+                title = build_model(child, :Title)
+                metadata.titles << title
+                title
+              when 'language'
+                language = build_model(child, :DCMES, ['id'])
+                metadata.languages << language
+                language
+              when 'title', 'contributor', 'coverage', 'creator', 'date', 'description', 'format', 'publisher', 'relation', 'source', 'subject', 'rights', 'type'
+                attr = elem_name == 'rights' ? elem_name : elem_name + 's'
+                dcmes = build_model(child)
+                metadata.__send__(attr) << dcmes
+                dcmes
+              else
+                build_unsupported_model(child)
+              end
+            when default_namespace_uri
+              case elem_name
+              when 'meta'
+                meta = build_model(child, :Meta, %w[property id scheme])
+                metadata.metas << meta
+                meta
+              when 'link'
+                link = build_model(child, :Link, %w[id media-type])
+                metadata.links << link
+                link.href = extract_attribute(child, 'href')
+                link.rel = Set.new(extract_attribute(child, 'rel').split(/\s+/))
+                link
+              else
+                build_unsupported_model(child)
+              end
+            else
+              build_unsupported_model(child)
+            end
 
-        metadata
-      end
+          metadata.children << model
 
-      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)
+          if model.kind_of?(EPUB::Metadata::Identifier) &&
+             model.id == unique_identifier_id
+            metadata.unique_identifier = model
           end
-          model.content = e.content unless klass == :Link
 
-          yield model, e if block_given?
+          if model.respond_to?(:id) && model.id
+            id_map[model.id] = {refinee: model}
+          end
 
-          model
+          refines = extract_attribute(child, 'refines')
+          if refines && refines.start_with?('#')
+            id = refines[1..-1]
+            id_map[id] ||= {}
+            id_map[id][:refiners] ||= []
+            id_map[id][:refiners] << model
+          end
         end
 
-        models.each do |model|
-          id_map[model.id] = {metadata: model} if model.respond_to?(:id) && model.id
+        id_map.values.each do |hsh|
+          next unless hsh[:refiners]
+          next unless hsh[:refinee]
+          hsh[:refiners].each {|meta| meta.refines = hsh[:refinee]}
         end
 
-        models
+        metadata
       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
-        }
+      def build_model(elem, klass=:DCMES, attributes=%w[id lang dir])
+        model = EPUB::Metadata.const_get(klass).new
+        attributes.each do |attr|
+          model.__send__ "#{attr.gsub('-', '_')}=", extract_attribute(elem, attr)
+        end
+        model.content = elem.content unless klass == :Link
+        model
+      end
+
+      def build_unsupported_model(elem)
+        EPUB::Metadata::UnsupportedModel.new(elem)
       end
     end
   end

data/lib/epub/parser/version.rb

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

data/test/test_parser_publication.rb

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 require File.expand_path 'helper', File.dirname(__FILE__)
+require 'zipruby'
 
 class TestParserPublication < Test::Unit::TestCase
   def setup
@@ -75,6 +76,14 @@ class TestParserPublication < Test::Unit::TestCase
       assert titles[2] < titles[3]
       assert titles[3] > titles[4]
     end
+
+    def test_children_keeps_order_in_xml
+      expected = @metadata.links.find {|link|
+        link.rel.include?('foaf:homepage') &&
+          link.href.to_s == 'http://example.org/book-info/12389347'
+      }
+      assert_equal expected, @metadata.children[27]
+    end
   end
 
   class TestParseManifest < TestParserPublication

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epub-parser
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - KITAITI Makoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-05 00:00:00.000000000 Z
+date: 2016-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -317,6 +317,7 @@ files:
 - docs/FixedLayout.markdown
 - docs/Home.markdown
 - docs/Item.markdown
+- docs/MultipleRenditions.markdown
 - docs/Navigation.markdown
 - docs/Publication.markdown
 - docs/Searcher.markdown