epub-parser 0.0.2 → 0.0.3

data/.gitignore

@@ -6,5 +6,6 @@ vendor/*
 .yardoc/
 coverage/*
 samples/*
+doc/*
 NOTE
 *~

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 KITAITIMAKOTO <KitaitiMakoto@gmail.com>
+Copyright (c) 2011, 2012 KITAITIMAKOTO <KitaitiMakoto@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/README

@@ -1,6 +1,13 @@
 EPUB Parer
 ==========
 
+USAGE
+-----
+    book = EPUB::Parser.parse 'book.epub'
+    book.each_page_in_spines_order do |page|
+      # do somethong...
+    end
+
 LICENSE
 -------
 This library is distribuetd under the term of the MIT License.

data/lib/epub/book.rb

@@ -14,6 +14,7 @@ module EPUB
         enum
       end
     end
+
     def each_page_by_toc(&blk)
     end
 
@@ -29,9 +30,14 @@ module EPUB
     def other_navigation
     end
 
-    # Syntax suger
+    # Syntax sugar
     def rootfile_path
       ocf.container.rootfile.full_path
     end
+
+    # Syntax sugar
+    def cover_image
+      package.manifest.cover_image
+    end
   end
 end

data/lib/epub/constants.rb

@@ -9,11 +9,40 @@ module EPUB
       'm'         => 'http://www.w3.org/1998/Math/MathML',
       'svg'       => 'http://www.w3.org/2000/svg'
     }
+
     module Type
       TOC       = 'toc'
       PAGE_LIST = 'page_list'
       LANDMARKS = 'landmarks'
     end
+
+    module MediaType
+      class NotSupportedError < StandardError; end
+
+      IMAGE = %w[
+        image/gif
+        image/jpeg
+        image/png
+        image/svg+xml
+      ]
+      APPLICATION = %w[
+        application/xhtml+xml
+        application/x-dtbncx+xml
+        application/vnd.ms-opentype
+        application/font-woff
+        application/smil+xml
+        application/pls+xml
+      ]
+      AUDIO = %w[
+        audio/mpeg
+        audio/mp4
+      ]
+      TEXT = %w[
+        text/css
+        text/javascript
+      ]
+      CORE = IMAGE + APPLICATION + AUDIO + TEXT
+    end
   end
 
   include Constants

data/lib/epub/parser.rb

@@ -4,13 +4,20 @@ require 'epub/parser/version'
 require 'epub/parser/ocf'
 require 'epub/parser/publication'
 require 'epub/parser/content_document'
+require 'shellwords'
 require 'nokogiri'
 
 module EPUB
   class Parser
+    class << self
+      def parse(file, dir, options = {})
+        new(file, dir, options).parse
+      end
+    end
+
     def initialize(filepath, root_directory, options = {})
-      raise 'File #{filepath} not readable' unless File.readable_real? filepath
-      raise 'File #{root_directory} already exists' if File.file? root_directory
+      raise "File #{filepath} not readable" unless File.readable_real? filepath
+      raise "File #{root_directory} already exists" if File.file? root_directory
         
       @filepath = File.realpath filepath
       Dir.mkdir(root_directory) unless File.directory? root_directory
@@ -19,8 +26,9 @@ module EPUB
       @book = Book.new
 
       unzip_cmd = options['unzip-command'] || 'unzip'
-      unzip_cmd << " #{@filepath} -d #{@dir}"
+      unzip_cmd << " #{@filepath.to_s.shellescape} -d #{@dir.to_s.shellescape}"
       system unzip_cmd
+puts unzip_cmd
     end
 
     def parse

data/lib/epub/parser/publication.rb

@@ -22,7 +22,7 @@ module EPUB
         # parse_metadata
         parse_manifest
         parse_spine
-        # parse_guide
+        parse_guide
         # parse_bindings
 
         @package
@@ -43,7 +43,8 @@ module EPUB
           %w[ id media-type media-overlay ].each do |attr|
             item.send "#{attr.gsub(/-/, '_')}=", elm[attr]
           end
-          item.href = @rootfile.join Addressable::URI.parse(elm['href'])
+          item.href = elm['href']
+          item.iri = @rootfile.join Addressable::URI.parse(elm['href'])
           fallback_map[elm['fallback']] = item if elm['fallback']
           item.properties = elm['properties'] ? elm['properties'].split(' ') : []
           manifest << item
@@ -76,7 +77,17 @@ module EPUB
       end
 
       def parse_guide
-        raise 'still not implemented'
+        guide = @package.guide = EPUB::Publication::Package::Guide.new
+        elem = @doc.xpath('/opf:package/opf:guide/opf:reference', EPUB::NAMESPACES).each do |ref|
+          reference = EPUB::Publication::Package::Guide::Reference.new
+          %w[ type title href ].each do |attr|
+            reference.send("#{attr}=", ref[attr])
+          end
+          reference.iri = @rootfile.join Addressable::URI.parse(reference.href)
+          guide << reference
+        end
+
+        guide
       end
 
       def parse_bindings

data/lib/epub/parser/version.rb

@@ -1,5 +1,5 @@
 module EPUB
   class Parser
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/epub/publication/package.rb

@@ -4,7 +4,7 @@ module EPUB
   module Publication
     class Package
       attr_accessor :version, :unique_identifier, :prefix, :xml_lang, :dir, :id
-      attr_reader :metadata, :manifest, :spine
+      attr_reader :metadata, :manifest, :spine, :guide
       alias lang  xml_lang
       alias lang= xml_lang=
 
@@ -20,6 +20,11 @@ module EPUB
         spine.package = self
         @spine = spine
       end
+
+      def guide=(guide)
+        guide.package = self
+        @guide = guide
+      end
     end
   end
 end

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

@@ -1,10 +1,45 @@
-# This class is deprecated
-# See OPF2 for specification
+require 'enumerabler'
 
 module EPUB
   module Publication
     class Package
       class Guide
+        attr_accessor :package
+
+        def references
+          @references ||= []
+        end
+
+        def <<(reference)
+          reference.guide = self
+          references << reference
+        end
+
+        # Should use epub:type list?
+        %w[cover title-page toc index glossary acknowledgements bibliography colophon copyright-page dedication epigraph foreword loi lot notes preface text].each do |type|
+          define_method type do
+            var = instance_variable_get "@#{type}"
+            return var if var
+
+            var = references.selector {|ref| ref.type == type.to_s}.first
+            instance_variable_set "@#{type}", var
+          end
+        end
+
+        class Reference
+          attr_accessor :guide,
+                        :type, :title, :href,
+                        :iri
+
+          def item
+            return @item if @item
+
+            len = iri.fragment.nil? ? 1 : iri.fragment.length + 2
+            @item = @guide.package.manifest.items.selector do |item|
+              item.href == href[0 .. -len]
+            end.first
+          end
+        end
       end
     end
   end

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

@@ -1,4 +1,5 @@
 require 'enumerabler'
+require 'epub/constants'
 
 module EPUB
   module Publication
@@ -24,18 +25,54 @@ module EPUB
           navs.first
         end
 
+        def cover_image
+          items.selector {|i| i.properties.include? 'cover-image'}.first
+        end
+
         def [](item_id)
           items.selector {|item| item.id == item_id}.first
         end
 
         class Item
           attr_accessor :manifest,
-                        :id, :href, :media_type, :fallback, :properties, :media_overlay
+                        :id, :href, :media_type, :fallback, :properties, :media_overlay,
+                        :iri
+
+          # To do: Handle circular fallback chain
+          def fallback_chain
+            return @fallback_chain if @fallback_chain
+            @fallback_chain = traverse_fallback_chain([])
+          end
+
+          def read
+            open(iri) {|file| file.read}
+          end
+
+          # To do: Handle circular fallback chain
+          def use_fallback_chain(options = {})
+            supported = EPUB::MediaType::CORE
+            if ad = options[:supported]
+              supported = supported | (ad.respond_to?(:to_ary) ? ad : [ad])
+            end
+            if del = options[:not_supported]
+              supported = supported - (del.respond_to?(:to_ary) ? del : [del])
+            end
+
+            if supported.include? media_type
+              yield self
+            elsif fallback
+              fallback.use_fallback_chain(options) {|fallbacked| yield fallbacked}
+            else
+              raise EPUB::MediaType::NotSupportedError
+            end
+          end
 
-          alias path href
+          protected
 
-          def to_s
-            href.to_s
+          def traverse_fallback_chain(chain)
+            chain << self
+            return chain unless fallback
+            fallback.traverse_fallback_chain(chain)
           end
         end
       end

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

@@ -10,14 +10,21 @@
 	  properties="nav"/>
     <item id="manifest-item-1"
 	  href="item-1.xhtml"
-	  media-type="application/xhtml+xml"
+	  media-type="application/pdf"
 	  properties="property1 property2  property3"/>
     <item id="manifest-item-2"
 	  href="item-2.xhtml"
-	  media-type="application/xhtml+xml"
+	  media-type="application/pdf"
 	  fallback="manifest-item-fallback"/>
     <item id="manifest-item-fallback"
 	  href="fallback.xhtml"
+	  media-type="image/svg+xml"
+	  fallback="manifest-item-fallback2"/>
+    <item id="manifest-item-fallback2"
+	  href="fallback2.xhtml"
+	  media-type="application/xhtml+xml"/>
+    <item id="cover"
+	  href="cover.xhtml"
 	  media-type="application/xhtml+xml"/>
   </manifest>
   <spine>
@@ -25,4 +32,7 @@
     <itemref idref="manifest-item-1"/>
     <itemref idref="manifest-item-2"/>
   </spine>
+  <guide>
+    <reference type="cover" href="cover.xhtml#start" title="カバー"/>
+  </guide>
 </package>

data/test/test_parser_publication.rb

@@ -13,14 +13,14 @@ class TestParserPublication < Test::Unit::TestCase
       @manifest = @parser.parse_manifest
     end
 
-    def test_manifest_has_4_items
-      assert_equal 4, @manifest.items.length
+    def test_manifest_has_6_items
+      assert_equal 6, @manifest.items.length
     end
 
-    def test_item_has_full_path_as_href_attribute
+    def test_item_has_full_path_as_iri_attribute
       actual = File.expand_path 'fixtures/book/OPS/nav.xhtml', File.dirname(__FILE__)
 
-      assert_equal actual, @manifest['nav'].href.to_s
+      assert_equal actual, @manifest['nav'].iri.to_s
     end
 
     def test_fallback_attribute_of_item_should_be_item_object
@@ -29,5 +29,74 @@ class TestParserPublication < Test::Unit::TestCase
       assert_instance_of Publication::Package::Manifest::Item, fallback
       assert_equal 'manifest-item-fallback', fallback.id
     end
+
+    def test_item_is_readable
+      item = @manifest.items.first
+      doc = Nokogiri.XML item.read
+
+      assert_equal 'html', doc.root.name
+    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 not_supported: 'image/svg+xml' do |current|
+        current
+      end
+
+      assert_equal fallback, result
+    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
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: epub-parser
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-29 00:00:00.000000000Z
+date: 2012-01-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubygems-test
-  requirement: &13163480 !ruby/object:Gem::Requirement
+  requirement: &9485980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13163480
+  version_requirements: *9485980
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &13162840 !ruby/object:Gem::Requirement
+  requirement: &9485300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13162840
+  version_requirements: *9485300
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &13162140 !ruby/object:Gem::Requirement
+  requirement: &9483760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13162140
+  version_requirements: *9483760
 - !ruby/object:Gem::Dependency
   name: test-unit
-  requirement: &13159480 !ruby/object:Gem::Requirement
+  requirement: &9481540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '2'
   type: :development
   prerelease: false
-  version_requirements: *13159480
+  version_requirements: *9481540
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &13224740 !ruby/object:Gem::Requirement
+  requirement: &9480560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13224740
+  version_requirements: *9480560
 - !ruby/object:Gem::Dependency
   name: thin
-  requirement: &13224120 !ruby/object:Gem::Requirement
+  requirement: &9479860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13224120
+  version_requirements: *9479860
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &13223480 !ruby/object:Gem::Requirement
+  requirement: &9479400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13223480
+  version_requirements: *9479400
 - !ruby/object:Gem::Dependency
   name: epzip
-  requirement: &13222740 !ruby/object:Gem::Requirement
+  requirement: &9065560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13222740
+  version_requirements: *9065560
 - !ruby/object:Gem::Dependency
   name: enumerabler
-  requirement: &13222200 !ruby/object:Gem::Requirement
+  requirement: &9064540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13222200
+  version_requirements: *9064540
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &13221620 !ruby/object:Gem::Requirement
+  requirement: &9063520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13221620
+  version_requirements: *9063520
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &13221000 !ruby/object:Gem::Requirement
+  requirement: &9062780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,7 +131,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13221000
+  version_requirements: *9062780
 description: Parse EPUB 3 book loosely
 email:
 - KitaitiMakoto@gmail.com
@@ -145,53 +145,6 @@ files:
 - MIT-LICENSE
 - README
 - Rakefile
-- doc/EPUB.html
-- doc/EPUB/Book.html
-- doc/EPUB/Constants.html
-- doc/EPUB/Constants/Type.html
-- doc/EPUB/ContentDocument.html
-- doc/EPUB/ContentDocument/Navigation.html
-- doc/EPUB/ContentDocument/Navigation/Nav.html
-- doc/EPUB/ContentDocument/Navigation/Nav/Ol.html
-- doc/EPUB/ContentDocument/Navigation/Nav/Ol/A.html
-- doc/EPUB/ContentDocument/Navigation/Nav/Ol/Span.html
-- doc/EPUB/OCF.html
-- doc/EPUB/OCF/Container.html
-- doc/EPUB/OCF/Container/Rootfile.html
-- doc/EPUB/OCF/Encryption.html
-- doc/EPUB/OCF/Manifest.html
-- doc/EPUB/OCF/Metadata.html
-- doc/EPUB/OCF/Rights.html
-- doc/EPUB/OCF/Signatures.html
-- doc/EPUB/Parser.html
-- doc/EPUB/Parser/ContentDocument.html
-- doc/EPUB/Parser/OCF.html
-- doc/EPUB/Parser/Publication.html
-- doc/EPUB/Publication.html
-- doc/EPUB/Publication/Package.html
-- doc/EPUB/Publication/Package/Bindings.html
-- doc/EPUB/Publication/Package/Bindings/MediaType.html
-- doc/EPUB/Publication/Package/Guide.html
-- doc/EPUB/Publication/Package/Manifest.html
-- doc/EPUB/Publication/Package/Manifest/Item.html
-- doc/EPUB/Publication/Package/Metadata.html
-- doc/EPUB/Publication/Package/Spine.html
-- doc/EPUB/Publication/Package/Spine/Itemref.html
-- doc/EPUB/Type.html
-- doc/_index.html
-- doc/class_list.html
-- doc/css/common.css
-- doc/css/full_list.css
-- doc/css/style.css
-- doc/file.README.html
-- doc/file_list.html
-- doc/frames.html
-- doc/index.html
-- doc/js/app.js
-- doc/js/full_list.js
-- doc/js/jquery.js
-- doc/method_list.html
-- doc/top-level-namespace.html
 - epub-parser.gemspec
 - lib/epub/book.rb
 - lib/epub/constants.rb
@@ -245,7 +198,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1604800020780391737
+      hash: 1208319521840117348
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -254,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1604800020780391737
+      hash: 1208319521840117348
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.8