epub-parser 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee9d5ae3802a16461fd85224ecf47f4b2eafc6181e0c84761a9108a61b5890f1
-  data.tar.gz: 24d6b8164c849969121e9b4975e366a1683e7367096214d5c78ec6f3676e12f0
+  metadata.gz: 0f7e1c88df88ae747c9119ab1a7a5978da200d977ffa0a97b33f2c5c2d398cb8
+  data.tar.gz: b554ff75c8641a4f8edc3cf0a4801671440b605aa493a50d95498d278c9e49b7
 SHA512:
-  metadata.gz: 45c6d1b877698ab09620ecd079c805fd873fde3e77210e76a251bf416390fd1d17fcb5ea4246f55d4616640952e7db00dca5f3635f6829d429851c24cf6ecec2
-  data.tar.gz: 97e70f781221ef0036761d84fd1ae718f543588a04ce78b5209e068604c9d2b6c33ce68c57f51499420e65710cf260c86cb8016c5ee8674c21db56c348af8ad6
+  metadata.gz: 8a102404b9a0a7257e7899f43c08002e4ce55b29ed56df6bead42d2eef0d316b9b63ee4494627777fba1aa3849389fd2754caccc5409a9d7c7a5761243ca3367
+  data.tar.gz: f12125b9970efaa46bd24d71f6e32b6fe9d95d7ceb07c20f0b65124be6c3832044941c28fd46ed79722408ab0a449e6431442cfd519981a786606550fd34bfde

data/.yardopts

@@ -1,3 +1,4 @@
+--load docs/yard-forwardable_def_delegators_handler.rb
 -
 CHANGELOG.markdown
 MIT-LICENSE

data/CHANGELOG.markdown

@@ -1,6 +1,13 @@
 CHANGELOG
 =========
 
+0.3.6
+-----
+* [BUG FIX]Ignore fragment when find item by relative IRI
+* Enable [PrettyBacktrace][] only when specified by env var for testing performance
+
+[PrettyBacktrace]: https://github.com/ko1/pretty_backtrace
+
 0.3.5
 -----
 * [BUG FIX]Fix a bug that {EPUB::ContentDocument::Navigation::Item#item} is `nil` when `href` includes double dots(`..`)(Thanks [aelkiss][]!)

data/README.markdown

@@ -64,7 +64,7 @@ See document's {file:docs/Home.markdown} or [API Documentation][rubydoc] for mor
     Unique identifier:  978-1-934356-91-3
     Epub version:       2.0
 
-See {file:docs/Epubinfo} for more info.
+See {file:docs/Epubinfo.markdown} for more info.
 
 ### `epub-open` command-line tool
 
@@ -96,7 +96,7 @@ IRB starts. `self` becomes the EPUB book and can access to methods of `EPUB`.
     => nil
     exit # Enter "exit" when exit the session
 
-See {file:docs/EpubOpen} for more info.
+See {file:docs/EpubOpen.markdown} for more info.
 
 DOCUMENTATION
 -------------
@@ -159,6 +159,14 @@ If you find other gems, please tell me or request a pull request.
 RECENT CHANGES
 --------------
 
+### 0.3.6
+
+* [BUG FIX]Ignore fragment when find item by relative IRI
+* Disable [PrettyBacktrace][] by default
+
+[PrettyBacktrace]: https://github.com/ko1/pretty_backtrace
+
+
 ### 0.3.5
 
 * [BUG FIX]Fix a bug that {EPUB::ContentDocument::Navigation::Item#item} is `nil` when `href` includes double dots(`..`)(Thanks [aelkiss][]!)
@@ -176,14 +184,11 @@ RECENT CHANGES
 * [BREAKING CHANGE]Remove deprecated second argument from `EPUB::Parser::Publication#initialize`
 * Add `detect_encoding` keyword argument to `Publication::Package::Manifest::Item#read` and `ContentDocument::XHTML#read`
 
-### 0.3.2
-
-* Use epub-cfi gem for EPUB CFI
-
 See {file:CHANGELOG.markdown} for older changelogs and details.
 
 TODOS
 -----
+* Consider to implement IRI feature instead of to use Addressable
 * EPUB 3.0.1
 * EPUB 3.1
 * Help features for `epub-open` tool

data/Rakefile

@@ -51,38 +51,3 @@ Gem::Tasks.new do |tasks|
   tasks.console.command = 'pry'
 end
 task :build => :clean
-
-class ForwardableDefDelegatorsHandler < YARD::Handlers::Ruby::Base
-  handles method_call(:def_delegators)
-  namespace_only
-
-  def process
-    params = validated_attribute_names(statement.parameters(false))
-    accessor = params.shift
-    params.each do |param|
-      object = YARD::CodeObjects::MethodObject.new(namespace, param)
-      object.docstring = "Forwarded to +#{accessor}+"
-    end
-  end
-
-  protected
-
-  # Strips out any non-essential arguments from the attr statement.
-  #
-  # @param [Array<Parser::Ruby::AstNode>] params a list of the parameters
-  #   in the attr call.
-  # @return [Array<String>] the validated attribute names
-  # @raise [Parser::UndocumentableError] if the arguments are not valid.
-  def validated_attribute_names(params)
-    params.map do |obj|
-      case obj.type
-      when :symbol_literal
-        obj.jump(:ident, :op, :kw, :const).source
-      when :string_literal
-        obj.jump(:string_content).source
-      else
-        raise YARD::Parser::UndocumentableError, obj.source
-      end
-    end
-  end
-end

data/bin/epubinfo

@@ -39,11 +39,16 @@ unless File.readable? file
   end
 end
 book = EPUB::Parser.parse(file)
-data = {'Title' => [book.title]}
+data = {'title' => book.title}
 data.merge!(book.metadata.to_h)
-data['modified'] = [book.modified]
-data['Unique identifier'] = [book.metadata.unique_identifier]
-data['EPUB Version'] = [book.package.version]
+data['modified'] = book.modified
+data['unique identifier'] = book.metadata.unique_identifier
+data['epub version'] = book.package.version
+
+data.each_pair do |(key, value)|
+  data[key] = value.respond_to?(:join) ? value.join(", ") : value.to_s
+end
+
 counts = {:chars => 0, :words => 0}
 if options[:words] or options[:chars]
   book.resources.select(&:xhtml?).each do |xhtml|
@@ -60,12 +65,12 @@ if options[:words] or options[:chars]
     end
   end
 end
-data['Words'] = [counts[:words]] if options[:words]
-data['Characters'] = [counts[:chars]] if options[:chars]
+data['words'] = counts[:words] if options[:words]
+data['characters'] = 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|
-    puts (k.to_s.capitalize + ':').ljust(key_width) + v.join(', ')
+    puts (k.to_s.capitalize + ':').ljust(key_width) + v.to_s
   end
 else
   require options[:format].to_s

data/docs/EpubOpen.markdown

@@ -1,4 +1,4 @@
-{file:docs/Home} > **{file:docs/EpubOpen}**
+{file:docs/Home} > **{file:docs/EpubOpen.markdown}**
 
 `epub-open` command-line tool
 =============================

data/docs/Epubinfo.markdown

@@ -1,4 +1,4 @@
-{file:docs/Home} > **{file:docs/Epubinfo}**
+{file:docs/Home} > **{file:docs/Epubinfo.markdown}**
 
 `epubinfo` command-line tool
 ============================
@@ -12,7 +12,7 @@ Usage
 
 Example:
 
-    $ epubinfo ~/Documebts/Books/build_awesome_command_line_applications_in_ruby_fo.epub 
+    $ 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)
@@ -34,4 +34,95 @@ Example:
 
 To see help:
 
-    epubinfo -h
+    $ epubinfo -h
+    Show metadata of an EPUB file
+    
+    Usage: epubinfo [options] EPUBFILE
+    
+        -f, --format=FORMAT              format of output(line, json or yaml), defaults to line(for console)
+            --words                      count words of content documents
+            --chars                      count charactors of content documents
+
+Output formats
+--------------
+
+`epubinfo` can output in three formats: line, JSON and YAML. You can specify format by `--format`(`-f`) command-line option
+
+### JSON ###
+
+    $ epubinfo --format=json ~/Documebts/Books/build_awesome_command_line_applications_in_ruby_fo.epub | jq .
+    {
+      "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": "",
+      "modified": "",
+      "unique identifier": "978-1-934356-91-3",
+      "epub version": "2.0"
+    }
+
+### YAML ###
+
+    $ epubinfo --format=yaml ~/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: ''
+    modified: ''
+    unique identifier: 978-1-934356-91-3
+    epub Version: '2.0'
+
+Character and word count
+------------------------
+
+`epubinfo` can count characters and words(space perarated) in EPUB document. Pass `--chars` and `--words` options to the command.
+
+Note that this makes process slower because it will read all the document.
+
+    $ epubinfo --chars --words ~/Documebts/Books/build_awesome_command_line_applications_in_ruby_fo.epub
+    Title:              Build Awesome Command-Line Applications in Ruby (for IKEDA TATSUNOBU)
+    Identifiers:        978-1-934356-91-3
+    Titles:             Build Awesome Command-Line Applications in Ruby (for IKEDA TATSUNOBU)
+    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:              
+    Modified:           
+    Unique identifier:  978-1-934356-91-3
+    Epub version:       2.0
+    Words:              65006
+    Characters:         445924

data/docs/Home.markdown

@@ -17,13 +17,13 @@ Usage
 
 `epubinfo` tool extracts and shows the metadata of specified EPUB book.
 
-See {file:docs/Epubinfo}.
+See {file:docs/Epubinfo.markdown}.
 
 #### epub-open
 
 `epub-open` tool provides interactive shell(IRB) which helps you research about EPUB book.
 
-See {file:docs/EpubOpen}.
+See {file:docs/EpubOpen.markdown}.
 
 ### As a library
 

data/docs/yard-forwardable_def_delegators_handler.rb

@@ -0,0 +1,34 @@
+class ForwardableDefDelegatorsHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:def_delegators)
+  namespace_only
+
+  def process
+    params = validated_attribute_names(statement.parameters(false))
+    accessor = params.shift
+    params.each do |param|
+      object = YARD::CodeObjects::MethodObject.new(namespace, param)
+      object.docstring = "Forwarded to +#{accessor}+"
+    end
+  end
+
+  protected
+
+  # Strips out any non-essential arguments from the attr statement.
+  #
+  # @param [Array<Parser::Ruby::AstNode>] params a list of the parameters
+  #   in the attr call.
+  # @return [Array<String>] the validated attribute names
+  # @raise [Parser::UndocumentableError] if the arguments are not valid.
+  def validated_attribute_names(params)
+    params.map do |obj|
+      case obj.type
+      when :symbol_literal
+        obj.jump(:ident, :op, :kw, :const).source
+      when :string_literal
+        obj.jump(:string_content).source
+      else
+        raise YARD::Parser::UndocumentableError, obj.source
+      end
+    end
+  end
+end

data/lib/epub/parser/content_document.rb

@@ -82,13 +82,7 @@ module EPUB
             item.text = extract_attribute(a_or_span, 'title').to_s if item.text.nil? || item.text.empty?
           end
           item.href = extract_attribute(a_or_span, 'href')
-          # TODO: too dirty and with potential performance issue
-          full_path = EPUB::Publication::Package::Manifest::Item::DUMMY_ROOT_IRI + @item.manifest.package.full_path + @item.href + item.href
-          full_path.scheme = nil
-          full_path.host = nil
-          full_path.path = full_path.path[1..-1]
-          full_path.fragment = nil
-          item.item = @item.manifest.items.find {|it| it.full_path == full_path}
+          item.item = @item.find_item_by_relative_iri(item.href)
         end
         item.items = element.xpath('./xhtml:ol[1]/xhtml:li', EPUB::NAMESPACES).map {|li| parse_navigation_item(li)}
 

data/lib/epub/parser/version.rb

@@ -1,5 +1,5 @@
 module EPUB
   class Parser
-    VERSION = "0.3.5"
+    VERSION = "0.3.6"
   end
 end

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

@@ -227,6 +227,7 @@ module EPUB
               segment == '..' ? clean_segments.pop : clean_segments << segment
             end
             target_iri = Addressable::URI.parse(clean_segments.join(Addressable::URI::SLASH))
+            target_iri.fragment = nil
             manifest.items.find { |item| item.href == target_iri}
           end
 

data/test/helper.rb

@@ -9,7 +9,9 @@ require 'test/unit'
 require 'test/unit/rr'
 require 'test/unit/notify'
 require 'pry'
-require 'pretty_backtrace'
-PrettyBacktrace.enable
+if ENV["PRETTY_BACKTRACE"]
+  require 'pretty_backtrace'
+  PrettyBacktrace.enable
+end
 
 require 'epub/parser'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epub-parser
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - KITAITI Makoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-04 00:00:00.000000000 Z
+date: 2018-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -313,6 +313,7 @@ files:
 - docs/Publication.markdown
 - docs/Searcher.markdown
 - docs/UnpackedArchive.markdown
+- docs/yard-forwardable_def_delegators_handler.rb
 - epub-parser.gemspec
 - examples/aggregate-contents-from-web.rb
 - examples/exctract-content-using-cfi.rb