epub-parser 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0863e952eebf7e5a0c502a70ef0d4eb53dc6f53a
-  data.tar.gz: 3f30d0aa575bc3b2ac740ec50ef54cee1452546c
+  metadata.gz: 4451be8049a35f2aa4ca54da4d89445f6269c967
+  data.tar.gz: d254d043d0e356d062f7a422d8f0dbe28bd3be0b
 SHA512:
-  metadata.gz: 55884a448641a94a3f100e09d3aed2ab554b299903af5008c6aa708932310c7164891667e426fd5093a152fa74e16cc44e9c92360db0c129ecd0c3e6933f9505
-  data.tar.gz: a09a814b990ccced895fe9e462fe44dad2ad244cbeda02a82afe69d4e5988b3bd98b5698a76e6c69cf87b3d64ebf66c63f21b24cd8485137c49da6cb0ad50707
+  metadata.gz: 4b36dd1a28d7a4249a6be8487e41210e1d9b29c00eddb7ada281035540199fcb263cec36b2b74ce55c4771225d24e1b04a3611227e06870a1b33d5544a30246f
+  data.tar.gz: 0619e36858b236585f330d5272aa90469481771445bb383086d1686026216fe066dc3bcaf2624fe6b55877072875a4a8ed5c8cc335f0015a5447e3b9329ccfe4

data/.yardopts

@@ -4,3 +4,5 @@ MIT-LICENSE
 docs/Home.markdown
 docs/Item.markdown
 docs/FixedLayout.markdown
+docs/Epubinfo.markdown
+docs/EpubOpen.markdown

data/CHANGELOG.markdown

@@ -1,5 +1,15 @@
 CHANGELOG
 =========
+0.1.5
+-----
+* Add `ContentDocument::XHTML#title`
+* Add `Manifest::Item#xhtml?`
+* Add `--words` and `--chars` options to `epubinfo` command which count words and charactors of XHTMLs in EPUB file
+* API change: `OCF::Container::Rootfile#full_path` became Addressable::URI object rather than `String`. `EPUB#rootfile_path` still returns `String`
+* Add `ContentDocument::XHTML#rexml` which returns document as `REXML::Document` object
+* Add `ContentDocument::XHTML#nokogiri` which returns document as `Nokogiri::XML::Document` object
+* Inspect more readbly
+
 0.1.4
 -----
 * [Fixed-Layout Documents][fixed-layout] support

data/README.markdown

@@ -16,10 +16,15 @@ USAGE
     
     book = EPUB::Parser.parse('book.epub')
     book.each_page_on_spine do |page|
-      # do somethong...
+      page.media_type # => "application/xhtml+xml"
+      page.entry_name #=> "OPS/nav.xhtml" entry name in EPUB package(zip archive)
+      page.read # => raw content document
+      page.content_document.nokogiri # => Nokogiri::XML::Document. The same to Nokogiri.XML(page.read)
+      # do something more
+      #    :
     end
 
-See files in docs directory or [API Documentation][rubydoc] for more info.
+See document's {file:docs/Home.markdown} or [API Documentation][rubydoc] for more info.
 
 [rubydoc]: http://rubydoc.info/gems/epub-parser/frames
 
@@ -27,11 +32,27 @@ See files in docs directory or [API Documentation][rubydoc] for more info.
 
 `epubinfo` tool extracts and shows the metadata of specified EPUB book.
 
-    epubinfo path/to/book.epub
-
-For more info:
-
-    epubinfo -h
+    $ epubinfo ~/Documebts/Books/build_awesome_command_line_applications_in_ruby.epub
+    Title:              Build Awesome Command-Line Applications in Ruby (for KITAITI MAKOTO)
+    Identifiers:        978-1-934356-91-3
+    Titles:             Build Awesome Command-Line Applications in Ruby (for KITAITI MAKOTO)
+    Languages:          en
+    Contributors:       
+    Coverages:          
+    Creators:           David Bryant Copeland
+    Dates:              
+    Descriptions:       
+    Formats:            
+    Publishers:         The Pragmatic Bookshelf, LLC (338304)
+    Relations:          
+    Rights:             Copyright © 2012 Pragmatic Programmers, LLC
+    Sources:            
+    Subjects:           Pragmatic Bookshelf
+    Types:              
+    Unique identifier:  978-1-934356-91-3
+    Epub version:       2.0
+
+See {file:docs/Epubinfo} for more info.
 
 ### `epub-open` command-line tool
 
@@ -63,20 +84,23 @@ IRB starts. `self` becomes the EPUB book and can access to methods of `EPUB`.
     => nil
     exit # Enter "exit" when exit the session
 
-For command-line options:
-
-    epub-open -h
-
-Development of this tool is still in progress.
-Welcome comments and suggestions for this!
+See {file:docs/EpubOpen} for more info.
 
 REQUIREMENTS
 ------------
-* libxml2 and libxslt for Nokogiri gem
+* Ruby 1.9.2 or later
 * C compiler to compile Zip/Ruby and Nokogiri
 
 RECENT CHANGES
 --------------
+### 0.1.5
+* Add `ContentDocument::XHTML#title`
+* Add `Manifest::Item#xhtml?`
+* Add `--words` and `--char` options to `epubinfo` command
+* API change: `OCF::Container::Rootfile#full_path` became Addressable::URI object rather than `String`
+* Add `ContentDocument::XHTML#rexml` and `#nokogiri`
+* Inspect more readbly
+
 ### 0.1.4
 * [Fixed-Layout Documents][fixed-layout] support
 * Define `ContentDocument::XHTML#top_level?`
@@ -91,18 +115,7 @@ RECENT CHANGES
 * 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. `#href` now returns `Addressable::URI` object.
-* `Metadata::Link#iri`: ditto.
-* `Guide::Reference#iri`: ditto.
-
-See CHANGELOG.markdown for details.
+See {file:CHANGELOG.markdown} for older changelogs and details.
 
 TODOS
 -----
@@ -112,16 +125,19 @@ TODOS
 * Implementing navigation document and so on
 * Media Overlays
 * Content Document
-* Fixed Layout
 * Digital Signature
 * Using SAX on parsing
 * Extracting and organizing common behavior from some classes to modules
 * Abstraction of XML parser(making it possible to use REXML, standard bundled XML library of Ruby)
+* Handle with encodings other than UTF-8
 
 DONE
 ----
 * Using zip library instead of `unzip` command, which has security issue
 * Modify methods around fallback to see `bindings` element in the package
+* Content Document(only for Navigation Documents)
+* Fixed Layout
+* Vocabulary Association Mechanisms(only for itemref)
 
 LICENSE
 -------

data/bin/epubinfo

@@ -16,6 +16,12 @@ EOB
   opt.on '-f', '--format=FORMAT', formats, "format of output(#{nl_formats.join(', ')} or #{nl_last}), defaults to line(for console)" do |format|
     options[:format] = format
   end
+  opt.on '--words', 'count words of content documents' do
+    options[:words] = true
+  end
+  opt.on '--chars', 'count charactors of content documents' do
+    options[:chars] = true
+  end
 end
 opt.parse!(ARGV)
 
@@ -31,6 +37,22 @@ data = {'Title' => [book.title]}
 data.merge!(book.metadata.to_h)
 data['Unique identifier'] = [book.metadata.unique_identifier]
 data['EPUB Version'] = [book.package.version]
+counts = {:chars => 0, :words => 0}
+book.resources.select(&:xhtml?).each do |xhtml|
+  begin
+    doc = Nokogiri.XML(xhtml.read)
+    body = doc.search('body').first
+    content = body.content
+    if body
+      counts[:words] += content.scan(/\S+/).length
+      counts[:chars] += content.gsub(/\r|\n/, '').length
+    end
+  rescue => error
+    warn "#{xhtml.href}: #{error}"
+  end
+end
+data['Words'] = [counts[:words]] if options[:words]
+data['Charactors'] = [counts[:chars]] if options[:chars]
 if options[:format] == :line
   key_width = data.keys.map {|k| k.length}.max + 3
   data.each_pair do |k, v|

data/docs/EpubOpen.markdown

@@ -0,0 +1,43 @@
+{file:docs/Home} > **{file:docs/EpubOpen}**
+
+`epub-open` command-line tool
+=============================
+
+`epub-open` tool provides interactive shell(IRB) which helps you research about EPUB book.
+
+Usage
+-----
+
+    epub-open path/to/book.epub
+
+IRB starts. `self` becomes the EPUB book and can access to methods of `EPUB`.
+
+    title
+    => "Title of the book"
+    metadata.creators
+    => [Author 1, Author2, ...]
+    resources.first.properties
+    => ["nav"] # You know that first resource of this book is nav document
+    nav = resources.first
+    => ...
+    nav.href
+    => #<Addressable::URI:0x15ce350 URI:nav.xhtml>
+    nav.media_type
+    => "application/xhtml+xml"
+    puts nav.read
+    <?xml version="1.0"?>
+    <html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops">
+        :
+        :
+        :
+    </html>
+    => nil
+    exit # Enter "exit" when exit the session
+
+For command-line options:
+
+    epub-open -h
+
+Development of this tool is still in progress.
+Welcome comments and suggestions for this!
+

data/docs/Epubinfo.markdown

@@ -0,0 +1,37 @@
+{file:docs/Home} > **{file:docs/Epubinfo}**
+
+`epubinfo` command-line tool
+============================
+
+`epubinfo` command-line tool shows metadata of specified epub file.
+
+Usage
+-----
+
+    epubinfo path/to/book.epub
+
+Example:
+
+    $ epubinfo ~/Documebts/Books/build_awesome_command_line_applications_in_ruby_fo.epub 
+    Title:              Build Awesome Command-Line Applications in Ruby (for KITAITI MAKOTO)
+    Identifiers:        978-1-934356-91-3
+    Titles:             Build Awesome Command-Line Applications in Ruby (for KITAITI MAKOTO)
+    Languages:          en
+    Contributors:       
+    Coverages:          
+    Creators:           David Bryant Copeland
+    Dates:              
+    Descriptions:       
+    Formats:            
+    Publishers:         The Pragmatic Bookshelf, LLC (338304)
+    Relations:          
+    Rights:             Copyright © 2012 Pragmatic Programmers, LLC
+    Sources:            
+    Subjects:           Pragmatic Bookshelf
+    Types:              
+    Unique identifier:  978-1-934356-91-3
+    Epub version:       2.0
+
+To see help:
+
+    epubinfo -h

data/docs/FixedLayout.markdown

@@ -25,7 +25,7 @@ It is `true` when `package@prefix` attribute has `rendition` property.
     package = parser.parse_package
     package.using_fixed_layout # => true
 
-And you can set by your self:
+And you can set by yourself:
 
     package.using_fixed_layout = true
     package.prefix # => {"rendition"=>"http://www.idpf.org/vocab/rendition/#"}
@@ -42,7 +42,7 @@ Methods below are provided for
 
 ### #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`.
+`rendition:xxx` property is specified by `meta` elements in `/package/metadata` and `properties` attribute of `/package/spine/itemref` elements in EPUB Publications. You are 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 is 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 strongly recommended to use not them but `rendition_layout`.
 
 Usage is simple. Just read and write attribute values.
 
@@ -74,9 +74,7 @@ Predicate methods `#reflowable?` and `#pre_paginated?` which are shortcuts for c
 
 ### #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!`.
+`#make_reflowable`(alias: `#reflowable!`) and `#make_pre_paginated`(alias: `#pre_paginated!`) can be used instead of calling `rendition_layout` and comparing it with `String` `"reflowable"` or `"pre-paginated"`, they help you from mistyping such like `"pre_paginated"`(using underscore rather than hyphen).
 
 Methods for {EPUB::Publication::Package::Spine::Itemref}
 --------------------------------------------------------

data/docs/Home.markdown

@@ -1,30 +1,37 @@
+EPUB Parser
+===========
+
 EPUB Parser gem parses EPUB 3 book loosely.
 
 Installation
-============
+------------
 
     gem install epub-parser
 
 Usage
-=====
+-----
 
-As a command-line tool
-----------------------
+### As command-line tools
 
-    epubinfo path/to/book.epub
+#### epubinfo
 
-To see help:
+`epubinfo` tool extracts and shows the metadata of specified EPUB book.
 
-    epubinfo -h
+See {file:docs/Epubinfo}.
 
-As a library
-------------
+#### epub-open
+
+`epub-open` tool provides interactive shell(IRB) which helps you research about EPUB book.
+
+See {file:docs/EpubOpen}.
+
+### As a library
 
 Use `EPUB::Parser.parse` at first:
 
     require 'epub/parser'
     
-    book = EPUB::Parser.parse '/path/to/book.epub'
+    book = EPUB::Parser.parse('/path/to/book.epub')
 
 This book object can yield page by spine's order(spine defines the order to read that the author determines):
 
@@ -44,7 +51,7 @@ This book object can yield page by spine's order(spine defines the order to read
 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
+    doc = Nokogiri.HTML(html)
     # do something with Nokogiri as always
 
 For several utilities of Item, see {file:docs/Item.markdown} page.
@@ -83,15 +90,19 @@ You are also able to find YourBook object for the first:
     ret == book # => true; this API is not good I feel... Welcome suggestion!
     # do something with your book
 
-More documents comming soon..., hopefully :)
+More documentations are avaiable in:
+
+* {file:docs/Item.markdown}
+* {file:docs/FixedLayout.markdown}
 
 Requirements
-============
+------------
 
 * libxml2 and libxslt for Nokogiri gem
+* C compiler to compile Zip/Ruby and Nokogiri
 
 Note
-====
+----
 
 This library is still in work.
 Only a few features are implemented and APIs might be changed in the future.
@@ -101,12 +112,16 @@ Currently implemented:
 
 * container.xml of [EPUB Open Container Format (OCF) 3.0][]
 * [EPUB Publications 3.0][]
+* EPUB Navigation Documents of [EPUB Content Documents 3.0][]
+* [EPUB 3 Fixed-Layout Documents][]
 
 [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/
 
 License
-=======
+-------
 
 This library is distributed under the term of the MIT Licence.
 See {file:MIT-LICENSE} file for more info.

data/docs/Item.markdown

@@ -13,13 +13,13 @@ Getting Items
 
 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
-    book.cover_image # => item representing cover image file
-    book.each_page_by_spine do |page|
-      page # => item in spine(order of "page" the author determined, often XHTML file)
+    book = EPUB::Parser.parse('book.epub')
+    book.resouces                    # => all items including XHTMLs, CSSs, images, audios and so on
+    book.cover_image                 # => item representing cover image file
+    book.each_page_on_spine do |page|
+      page                           # => item in spine(order of "page" the author determined, often XHTML file)
     end
-    book.package.manifest.navs # => navigation items(XHTML files including <nav> element)
+    book.package.manifest.navs       # => navigation items(XHTML files including <nav> element)
     book.package.manifest['item-id'] # => item referenced by the ID "item-id"
 
 For the last two examples, knowledge for EPUB structure is required.
@@ -29,19 +29,19 @@ Using Items
 
 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
-    item.href # => Addressable::URI object which represents the IRI of the item
-    item.properties # => array of properties
-    item.fallback # => see the next section for details
-    item.fallback_chain # => ditto.
+    item.id                   # => the ID of the item
+    item.media_type           # => media type like application/xhtml+xml
+    item.href                 # => Addressable::URI object which represents the IRI of the item
+    item.properties           # => array of properties
+    item.fallback             # => see the next section for details
+    item.fallback_chain       # => ditto.
     item.using_fallback_chain # => ditto.
 
-And {EPUB::Publication::Package::Manifest::Item Item} also provides some methods which helps you handle the item.
+And {EPUB::Publication::Package::Manifest::Item Item} also provides some methods which help you handle the item.
 
 For example, for XHTML:
 
-    item.read # => content of the item
+    item.read                # => content of the item
     Nokogiri.HTML(item.read) #=> Nokogiri::HTML::Document object
 
 For image: