epub-parser 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b83027d3e13f05cfbfae7040371f72608502d9b
-  data.tar.gz: 4aced6978cc17c4301c7f478e1197b6701d909b1
+  metadata.gz: 0863e952eebf7e5a0c502a70ef0d4eb53dc6f53a
+  data.tar.gz: 3f30d0aa575bc3b2ac740ec50ef54cee1452546c
 SHA512:
-  metadata.gz: fcba9ccf2de4b1ab26f3443836e10ead323fcf9139164abd28385cc08e0838339fd3a6287b358b968b83f44a3fa5277c785c13000494581bc874975a84f82e27
-  data.tar.gz: f1109a47200e5e0c94d67fecda3dbd464e170883fff35812bea44fb44cd780b66229f94a3dd9bdde162d8a82473596a1b76b595bfc2c11de3196db9c3ba3b977
+  metadata.gz: 55884a448641a94a3f100e09d3aed2ab554b299903af5008c6aa708932310c7164891667e426fd5093a152fa74e16cc44e9c92360db0c129ecd0c3e6933f9505
+  data.tar.gz: a09a814b990ccced895fe9e462fe44dad2ad244cbeda02a82afe69d4e5988b3bd98b5698a76e6c69cf87b3d64ebf66c63f21b24cd8485137c49da6cb0ad50707

data/.yardopts

@@ -1,3 +1,6 @@
 -
-wiki/Home.md
-wiki/Item.md
+CHANGELOG.markdown
+MIT-LICENSE
+docs/Home.markdown
+docs/Item.markdown
+docs/FixedLayout.markdown

data/CHANGELOG.markdown

@@ -0,0 +1,33 @@
+CHANGELOG
+=========
+0.1.4
+-----
+* [Fixed-Layout Documents][fixed-layout] support
+* Define `ContentDocument::XHTML#top_level?`
+* Define `Spine::Itemref#page_spread` and `#page_spread=`
+* Define some utility methods around `Manifest::Item` and `Spine::Itemref`
+  * `Manifest::Item#itemref`
+  * `Spine::Itemref#item=`
+
+[fixed-layout]: http://www.idpf.org/epub/fxl/
+
+0.1.3
+-----
+* Add `EPUB::Parser::Utils` module
+* Add a command-line tool `epub-open`
+* Add support for XHTML Navigation Document
+* Make `EPUB::Publication::Package::Metadata#to_hash` obsolete. Use `#to_h` instead
+* Add utility methods `EPUB#description`, `EPUB#date` and `EPUB#unique_identifier`
+
+0.1.2
+-----
+* Fix a bug that `Item#read` couldn't read file when `href` is percent-encoded(Thanks, [gambhiro][]!)
+
+[gambhiro]: https://github.com/gambhiro
+
+0.1.1
+-----
+* Parse package@prefix and attach it as `Package#prefix`
+* `Manifest::Item#iri` was removed. It have existed for files in unzipped epub books but now EPUB Parser retrieves files from zip archive directly. `#href` now returns `Addressable::URI` object.
+* `Metadata::Link#iri`: ditto.
+* `Guide::Reference#iri`: ditto.

data/Gemfile

@@ -1,4 +1,2 @@
 source "https://rubygems.org"
-
-# Specify your gem's dependencies in epub-parser.gemspec
 gemspec

data/README.markdown

@@ -4,6 +4,7 @@ EPUB Parser
 
 INSTALLATION
 -------
+
     gem install epub-parser  
 
 USAGE
@@ -18,9 +19,8 @@ USAGE
       # do somethong...
     end
 
-See the [wiki][] or [API Documentation][rubydoc] for more info.
+See files in docs directory or [API Documentation][rubydoc] for more info.
 
-[wiki]: https://github.com/KitaitiMakoto/epub-parser/wiki
 [rubydoc]: http://rubydoc.info/gems/epub-parser/frames
 
 ### `epubinfo` command-line tool
@@ -75,10 +75,17 @@ REQUIREMENTS
 * libxml2 and libxslt for Nokogiri gem
 * C compiler to compile Zip/Ruby and Nokogiri
 
-CHANGELOG
----------
+RECENT CHANGES
+--------------
+### 0.1.4
+* [Fixed-Layout Documents][fixed-layout] support
+* Define `ContentDocument::XHTML#top_level?`
+* Define `Spine::Itemref#page_spread` and `#page_spread=`
+* Define some utility methods around `Manifest::Item` and `Spine::Itemref`
+
+[fixed-layout]: http://www.idpf.org/epub/fxl/
+
 ### 0.1.3
-* Add `EPUB::Parser::Utils` module
 * Add a command-line tool `epub-open`
 * Add support for XHTML Navigation Document
 * Make `EPUB::Publication::Package::Metadata#to_hash` obsolete. Use `#to_h` instead
@@ -91,10 +98,12 @@ CHANGELOG
 
 ### 0.1.1
 * Parse package@prefix and attach it as `Package#prefix`
-* `Manifest::Item#iri` was removed. It have existed for files in unzipped epub books but now EPUB Parser retrieves files from zip archive directly. `#href` now returns `Addressable::URI` object.
+* `Manifest::Item#iri` was removed. `#href` now returns `Addressable::URI` object.
 * `Metadata::Link#iri`: ditto.
 * `Guide::Reference#iri`: ditto.
 
+See CHANGELOG.markdown for details.
+
 TODOS
 -----
 * Simple inspect for `epub-open` tool

data/Rakefile

@@ -6,6 +6,7 @@ require 'rdoc/task'
 require 'cucumber'
 require 'cucumber/rake/task'
 require 'epub/parser/version'
+require 'zipruby'
 
 task :default => :test
 task :test => 'test:default'
@@ -20,6 +21,10 @@ namespace :test do
   task :build => :clean do
     input_dir  = 'test/fixtures/book'
     sh "epzip #{input_dir}"
+    small_file = File.read("#{input_dir}/OPS/case-sensitive.xhtml")
+    Zip::Archive.open "#{input_dir}.epub" do |archive|
+      archive.add_buffer 'OPS/CASE-SENSITIVE.xhtml', small_file.sub('small file name', 'LARGE FILE NAME')
+    end
   end
 
   Rake::TestTask.new do |task|
@@ -41,7 +46,7 @@ namespace :doc do
     rdoc.rdoc_files = FileList['lib/**/*.rb']
     rdoc.rdoc_files.include 'README.markdown'
     rdoc.rdoc_files.include 'MIT-LICENSE'
-    rdoc.rdoc_files.include 'wiki/**/*.md'
+    rdoc.rdoc_files.include 'docs/**/*.md'
   end
 end
 
@@ -57,7 +62,7 @@ namespace :gem do
   end
 
   desc "Create tag v#{EPUB::Parser::VERSION} and build and push epub-parser-#{EPUB::Parser::VERSION}.gem to Rubygems"
-  task :release do
+  task :release => :test do
     Bundler::GemHelper.new.release_gem
   end
 end

data/docs/FixedLayout.markdown

@@ -0,0 +1,98 @@
+{file:docs/Home.markdown} > **{file:docs/FixedLayout.markdow}**
+
+Fixed-Layout Documents
+======================
+
+Since v0.1.4, EPUB Parser supports Fixed-Layout Documents by {EPUB::Publication::FixedLayout} module.
+It is set "on" when `rendition` property exists in `prefix` attribute of `package` element in rootfile.
+
+EPUB Fixed-Layout defines some additional properties to see how to render Content Documents. This EPUB Parser library supports it by providing convenience methods to know how to render.
+
+Methods for {EPUB::Publication::Package}
+----------------------------------------
+
+### {EPUB::Publication::FixedLayout::PackageMixin#using_fixed_layout #using_fixed_layout}
+
+It is `true` when `package@prefix` attribute has `rendition` property.
+
+    parser = EPUB::Parser::Publication.new(<<OPF, 'dummy/rootfile.opf')
+    <package version="3.0"
+             unique-identifier="pub-id"
+             xmlns="http://www.idpf.org/2007/opf"
+             prefix="rendition: http://www.idpf.org/vocab/rendition/#">
+    </package>
+    OPF
+    package = parser.parse_package
+    package.using_fixed_layout # => true
+
+And you can set by your self:
+
+    package.using_fixed_layout = true
+    package.prefix # => {"rendition"=>"http://www.idpf.org/vocab/rendition/#"}
+
+Common Methods
+--------------
+
+Methods below are provided for
+
+* {EPUB::Publication::Package::Metadata},
+* {EPUB::Publication::Package::Spine::Itemref},
+* {EPUB::Publication::Package::Manifest::Item} and
+* {EPUB::ContentDocument::XHTML}(and its subclasses).
+
+### #rendition_layout, #rendition_orientation and #rendition_spread
+
+`rendition:xxx` property is specified `meta` element in `package/metadata` and `properties` attribute of `package/spine/itemref` elements in EPUB Publications. You can recommended to use `rendition_xxx` attribute to set them although you can do it by manipulating {EPUB::Publication::Package::Metadata} and {EPUB::Publication::Package::Spine::Itemref}s directly. It is the reason why it be recommended that you must manipulate some objects not only one object to set a document's `rendition:layout` to, for instance, `reflowable`; {EPUB::Publication::Package::Metadata::Meta Metadata::Meta} and {EPUB::Publication::Package::Spine::Itemref#properties Spine::Itemref#properties}. It is bothered and tends to be mistaken, so you're recommended to use not them but `rendition_layout`.
+
+Usage is simple. Just read and write attribute values.
+
+    metadata.rendition_layout # => "reflowable"
+    metadata.rendition_layout = 'pre-paginated'
+    metadata.rendition_layout # => "pre-paginated"
+    
+    itemref.rendition_layout # => "pre-paginated"
+    itemref.rendition_layout = "reflowable"
+    itemref.rendition_layout # => "reflowable"
+
+These methods are defined for {EPUB::Publication::Package::Metadata}, {EPUB::Publication::Package::Spine::Itemref}, {EPUB::Publication::Package::Manifest::Item} and {EPUB::ContentDocument::XHTML}. Methods for {EPUB::Publication::Package::Metadata Metadata} and {EPUB::Publication::Package::Spine::Itemref Itemref} are primary and ones for {EPUB::Publication::Package::Manifest::Item Item} and {EPUB::ContentDocument::XHTML ContentDocument} are simply delegated to {EPUB::Publication::Package::Spine::Itemref Itemref}.
+
+### aliases
+
+Each attribute `rendition_xxx` has alias attribute as just `xxx`.
+
+    metadata.orientation = 'portrait'
+    metadata.orientation # => "portrait"
+    metadata.rendition_orientation # => "portrait"
+
+### #reflowable? and #pre_paginated?
+
+Predicate methods `#reflowable?` and `#pre_paginated?` which are shortcuts for comparison `rendition_layout` to arbitrary property value.
+
+    itemref.rendition_layout = 'pre-paginated'
+    itemref.reflowable? # => false
+    itemref.pre_paginated? # => true
+
+### #make_reflowable and make_pre_paginated
+
+`#make_reflowable` and `#make_pre_paginated` can be used instead of calling `rendition_layout` and comparing with `String` `"reflowable"` or `"pre-paginated"`, they help you from mistyping such like `"pre_paginated"`(using underscore rather than hyphen).
+
+They are aliased to `#reflowable!` and `#pre_paginated!`.
+
+Methods for {EPUB::Publication::Package::Spine::Itemref}
+--------------------------------------------------------
+
+### #page_spread
+
+{EPUB::Publication::FixedLayout FixedLayout} module adds property `center` to {EPUB::Publication::Package::Spine::Itemref#page_spread}'s available properties, which are ever `left` and `right`.
+
+    itemref.page_spread # => nil
+    itemref.page_spread = 'center'
+    itemref.page_spread # => "center"
+    itemref.properties # => ["rendition:page-spread-center"]
+
+References
+----------
+
+* [Fixed-Layout Documents][fixed-layout] on IDPF site
+
+[fixed-layout]: http://www.idpf.org/epub/fxl/

data/{wiki/Home.md → docs/Home.markdown}

@@ -32,9 +32,7 @@ This book object can yield page by spine's order(spine defines the order to read
       # do something...
     end
 
-`page` above is a [`EPUB::Publication::Package::Manifest::Item`][1] object and you can call `#href` to see where is the page file:
-
-[1]:http://rubydoc.info/gems/epub-parser/EPUB/Publication/Package/Manifest/Item
+`page` above is an {EPUB::Publication::Package::Manifest::Item} object and you can call {EPUB::Publication::Package::Manifest::Item#href #href} to see where is the page file:
 
     book.each_page_on_spine do |page|
       file = page.href # => path/to/page/in/zip/archive
@@ -43,15 +41,15 @@ This book object can yield page by spine's order(spine defines the order to read
       }
     end
 
-And `Item` provides syntax suger `#read` for above:
+And {EPUB::Publication::Package::Manifest::Item Item} provides syntax suger {EPUB::Publication::Package::Manifest::Item#read #read} for above:
 
     html = page.read
     doc = Nokogiri.HTML html
     # do something with Nokogiri as always
 
-For several utilities of Item, see [[Item]] page.
+For several utilities of Item, see {file:docs/Item.markdown} page.
 
-By the way, although `book` above is a `EPUB::Book` object, all features are provided by `EPUB` module. Therefore YourBook class can include the features of EPUB:
+By the way, although `book` above is a {EPUB::Book} object, all features are provided by {EPUB} module. Therefore YourBook class can include the features of {EPUB}:
 
     require 'epub'
     
@@ -111,4 +109,4 @@ License
 =======
 
 This library is distributed under the term of the MIT Licence.
-See [MIT-LICENSE](/epub/parser/blobs/master/MIT-LICENSE) file for more info.
+See {file:MIT-LICENSE} file for more info.

data/{wiki/Item.md → docs/Item.markdown}

@@ -1,17 +1,17 @@
-[[Home]] > **[[Item]]**
+{file:docs/Home.markdown} > **{file:docs/Item}**
 
 Overview
 ========
 
-When manipulating resources (XHTML, images, audio...) in EPUB, [`EPUB::Publication::Manifest::Item`](http://rubydoc.info/gems/epub-parser/EPUB/Publication/Package/Manifest/Item) object will be used.
-And objects which `EPUB#each_page_on_spine` yields are also instances of this class.
+When manipulating resources (XHTML, images, audio...) in EPUB, {EPUB::Publication::Package::Manifest::Item} object will be used.
+And objects which {EPUB#each_page_on_spine} yields are also instances of this class.
 
 Here's the tutorial of this class.
 
 Getting Items
 =============
 
-Getting the `Item` object you want is due to other classes, mainly `EPUB` module:
+Getting the {EPUB::Publication::Package::Manifest::Item Item} object you want is due to other classes, mainly {EPUB} module:
 
     book = EPUB::Parser.parse 'book.epub'
     book.resouces # => all items including XHTMLs, CSSs, images, audios and so on
@@ -27,7 +27,7 @@ For the last two examples, knowledge for EPUB structure is required.
 Using Items
 ===========
 
-Once you've got an `Item`, it provides informations about the item(file).
+Once you've got an {EPUB::Publication::Package::Manifest::Item Item}, it provides informations about the item(file).
 
     item.id # => the ID of the item
     item.media_type # => media type like application/xhtml+xml
@@ -37,7 +37,7 @@ Once you've got an `Item`, it provides informations about the item(file).
     item.fallback_chain # => ditto.
     item.using_fallback_chain # => ditto.
 
-And `Item` also provides some methods which helps you handle the item.
+And {EPUB::Publication::Package::Manifest::Item Item} also provides some methods which helps you handle the item.
 
 For example, for XHTML:
 
@@ -52,13 +52,13 @@ For image:
 Fallback Chain
 ==============
 
-Some items have `fallback` attribute, which provides the item to be used when reading system(your app) cannot handle with given item for some reason(for example, media type not supported).
+Some items have {EPUB::Publication::Package::Manifest::Item#fallback `fallback`} attribute, which provides the item to be used when reading system(your app) cannot handle with given item for some reason(for example, media type not supported).
 
-Of course, you can get it by calling `fallback` method:
+Of course, you can get it by calling {EPUB::Publication::Package::Manifest::Item#fallback `fallback`} method:
 
     item.fallback # => fallback `Item` or nil
 
-Also you can use `use_fallback_chain` not to check if you can accept item or not for every item:
+Also you can use {EPUB::Publication::Package::Manifest::Item#use_fallback_chain `use_fallback_chain`} not to check if you can accept item or not for every item:
 
     item.use_fallback_chain :supported => 'image/png' do |png|
       # do something with PNG image
@@ -66,7 +66,7 @@ Also you can use `use_fallback_chain` not to check if you can accept item or not
 
 If item's media type is, for instance, 'image/x-eps', the fallback is used.
 If the fallback item's media type is 'image/png', `png` variable means the item, if not, "fallback of fallback" will be checked.
-Finally you can use the item you want, or `EPUB::MediaType::UnsupportedError` exception will be raised(if no item you can accept found).
+Finally you can use the item you want, or {EPUB::Constants::MediaType::UnsupportedError EPUB::MediaType::UnsupportedError} exception will be raised(if no item you can accept found).
 Therefore, you should `rescue` clause:
 
     # :unsupported option can also be used

data/epub-parser.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
                     .push('test/fixtures/book/OPS/ルートファイル.opf')
                     .push('test/fixtures/book/OPS/日本語.xhtml')
-                    .push(Dir['wiki/*.md'])
+                    .push(Dir['docs/*.md'])
   s.files.reject! do |fn|
     ['"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"', '"test/fixtures/book/OPS/\346\227\245\346\234\254\350\252\236.xhtml"'].include? fn
   end
@@ -26,7 +26,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.has_rdoc = 'yard'
 
-  s.add_development_dependency 'rubygems-test'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'pry'
   s.add_development_dependency 'pry-doc'
@@ -43,6 +42,6 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'enumerabler'
   s.add_runtime_dependency 'zipruby'
-  s.add_runtime_dependency 'nokogiri', '1.5.8'
+  s.add_runtime_dependency 'nokogiri', '1.5.9'
   s.add_runtime_dependency 'addressable'
 end

data/lib/epub.rb

@@ -31,6 +31,12 @@ module EPUB
     end
   end
 
+  %w[nav].each do |met|
+    define_method met do
+      manifest.__send__ met
+    end
+  end
+
   def each_page_on_spine(&blk)
     enum = package.spine.items
     if block_given?

data/lib/epub/content_document/navigation.rb

@@ -44,6 +44,10 @@ module EPUB
       def each_landmark
       end
 
+      def navigation
+        navigations.first
+      end
+
       class Item
         attr_accessor :items, :text, :hidden,
                       :content_document, :href, :item

data/lib/epub/content_document/xhtml.rb

@@ -7,6 +7,11 @@ module EPUB
         item.read
       end
       alias raw_document read
+
+      # referenced directly from spine?
+      def top_level?
+        !! item.itemref
+      end
     end
   end
 end

data/lib/epub/parser/content_document.rb

@@ -8,13 +8,6 @@ module EPUB
     class ContentDocument
       include Utils
 
-      class << self
-        # @param [EPUB::Publication::Package::Manifest::Item] item
-        def parse(item)
-          new(item).parse
-        end
-      end
-
       # @param [EPUB::Publication::Package::Manifest::Item] item
       def initialize(item)
         @item = item

data/lib/epub/parser/ocf.rb

@@ -55,19 +55,19 @@ module EPUB
         encryption
       end
 
-      def parse_manifest
+      def parse_manifest(content)
         warn "Not implemented: #{self.class}##{__method__}" if $VERBOSE
       end
 
-      def parse_metadata
+      def parse_metadata(content)
         warn "Not implemented: #{self.class}##{__method__}" if $VERBOSE
       end
 
-      def parse_rights
+      def parse_rights(content)
         warn "Not implemented: #{self.class}##{__method__}" if $VERBOSE
       end
 
-      def parse_signatures
+      def parse_signatures(content)
         warn "Not implemented: #{self.class}##{__method__}" if $VERBOSE
       end
     end