epub-parser 0.3.9 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5961049ade105ba54596ed40e0c6ff1f492b48fbb37957b90ce0a35bff61fda1
-  data.tar.gz: 1c6d046515c6dd279a113b69040eae5d713813a35561b960882571cd02356792
+  metadata.gz: b8eeea7d5a67b4f9aaa7c71088837f4bb7156090c48e5411628e960de7b24233
+  data.tar.gz: b4d0b181946da274c66927caea49cf59c62d5507cd9543dde59bf1d3deae43d8
 SHA512:
-  metadata.gz: 8d295d2df9ea39e38a52140e1c812901edc21189c98ad32c2ed25e1078372099483b4d671ca2a1a320d0c5c05f179762bf6ad9b27f960c40b3eb9548b1053239
-  data.tar.gz: e45a6b0d495458fa4de9b9aaff379f0d20d11723bf8d7bac30686045811387d6ee641fb759c6b5bc218c1de8f309d1d8a981db03e1e9a6b16da2bc3f62eb5d92
+  metadata.gz: 3f9441b1dd0b6c4ac0d8acf04ff35fcdd0df4d3e880bb8a496e4a2e5127d99dc2ffc98927dd9d9907327cef08b7e8b76280f324cc1543ca38b7c80fe824fd8f1
+  data.tar.gz: 158ac997006c5ee7967132c294d6f4183dbb4dc29927653dca49e05399c63793929910beb9cd2673d8a9ea5b5175adff5f45bc712097e8b5055cb1e69df9565e

data/.gitlab-ci.yml

@@ -39,7 +39,7 @@ test:2.5:
       - deps
 
 test:2.6:
-  image: ruby:2.6-rc
+  image: ruby:2.6
   script: bundle exec rake test
   except:
     - tags
@@ -51,9 +51,9 @@ test:2.6:
 pages:
   stage: deploy
   dependencies:
-    - test:2.5
+    - test:2.6
   script:
-    - bundle exec rake doc:yard
+    - bundle exec rake test doc:yard
     - mv doc public
     - mv coverage public/
   artifacts:
@@ -62,6 +62,6 @@ pages:
   only:
     - master
   cache:
-    key: ruby:2.5
+    key: ruby:2.6
     paths:
       - deps

data/CHANGELOG.adoc

@@ -1,5 +1,10 @@
 = CHANGELOG
 
+== 0.4.0
+
+* [REFACTORING]Make submodules for `XMLDocument::Refinements`
+* [BUG FIX]Make epub:type a Set
+
 == 0.3.9
 
 * [BUG FIX]Set {EPUB::Metadata::DCMES#lang} properly from xml:lang attribute

data/README.adoc

@@ -174,6 +174,10 @@ If you find other gems, please tell me or request a pull request.
 
 == RECENT CHANGES
 
+=== 0.4.0
+
+* [BUG FIX]Make epub:type a Set
+
 === 0.3.9
 
 * [BUG FIX]Set {EPUB::Metadata::DCMES#lang} properly from xml:lang attribute
@@ -186,18 +190,6 @@ If you find other gems, please tell me or request a pull request.
 * Make XML library switchable between REXML and Nokogiri
 * Make REXML a default XML backend
 
-=== 0.3.7
-
-* Strip leading and trailing white spaces from identifiers
-* Change home page and documentation from rubydoc.info to GitLab Pages
-* Make {EPUB::Book::Features#cover_image Book::Features#cover_image} return EPUB 2 cover image if EPUB 3's not available
-* Add `epub-cover` command-line tool. See {file:docs/EpubCover.adoc} for details.
-
-=== 0.3.6
-
-* [BUG FIX]Ignore fragment when find item by relative IRI
-* Disable https://github.com/ko1/pretty_backtrace[PrettyBacktrace] by default
-
 See {file:CHANGELOG.adoc} for older changelogs and details.
 
 == TODOS

data/docs/Home.adoc

@@ -5,7 +5,6 @@
 EPUB Parser gem parses EPUB 3 book loosely.
 
 image:https://gitlab.com/KitaitiMakoto/epub-parser/badges/master/build.svg[link="https://gitlab.com/KitaitiMakoto/epub-parser/commits/master", title="pipeline status"]
-image:https://gemnasium.com/KitaitiMakoto/epub-parser.png[link="https://gitlab.com/KitaitiMakoto/epub-parser/commits/master",title="Dependency Status"]
 image:https://badge.fury.io/rb/epub-parser.svg[link="https://gemnasium.com/KitaitiMakoto/epub-parser",title="Gem Version"]
 image:https://gitlab.com/KitaitiMakoto/epub-parser/badges/master/coverage.svg[link="https://kitaitimakoto.gitlab.io/epub-parser/coverage/",title="coverage report"]
 

data/epub-parser.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
   s.test_files    = s.files & Dir['{test,spec,features}/**/*.{rb,feature}']
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+  s.metadata["yard.run"] = "yard"
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rubygems-tasks'

data/lib/epub/content_document/navigation.rb

@@ -1,3 +1,5 @@
+require "set"
+
 module EPUB
   module ContentDocument
     class Navigation < XHTML
@@ -99,12 +101,33 @@ module EPUB
           LANDMARKS = 'landmarks'
         end
 
-        attr_accessor :type
+        attr_reader :types
         alias navigations items
         alias navigations= items=
         alias heading text
         alias heading= text=
 
+        def initialize
+          super
+          @types = Set.new
+        end
+
+        def types=(ts)
+          @types = ts.kind_of?(Set) ? ts : Set.new(ts)
+        end
+
+        # For backward compatibility
+        def type
+          @types.find {|t|
+            %w[toc page_list landmarks].include? t
+          }
+        end
+
+        # For backward compatibility
+        def type=(t)
+          @types << t
+        end
+
         %w[toc page_list landmarks].each do |type|
           define_method "#{type}?" do
             type == Type.const_get(type.upcase)

data/lib/epub/parser/content_document.rb

@@ -48,7 +48,7 @@ module EPUB
         nav.text = find_heading(element)
         hidden = element.attribute_with_prefix('hidden')
         nav.hidden = hidden.nil? ? nil : true
-        nav.type = element.attribute_with_prefix('type', 'epub')
+        nav.types = element.attribute_with_prefix('type', 'epub')&.split(/\s+/)
         element.each_element_by_xpath('./xhtml:ol/xhtml:li', EPUB::NAMESPACES).map do |elem|
           nav.items << parse_navigation_item(elem)
         end

data/lib/epub/parser/version.rb

@@ -1,5 +1,5 @@
 module EPUB
   class Parser
-    VERSION = "0.3.9"
+    VERSION = "0.4.0"
   end
 end

data/lib/epub/parser/xml_document.rb

@@ -1,5 +1,3 @@
-require "rexml/document"
-
 module EPUB
   class Parser
     class XMLDocument
@@ -14,67 +12,14 @@ module EPUB
           end
         end
       end
-
-      begin
-        require "nokogiri"
-        @backend = :Nokogiri
-      rescue LoadError
-        @backend = :REXML
-      end
-
-      module Refinements
-        [REXML::Element, REXML::Text].each do |klass|
-          refine klass do
-            %i[document element text].each do |type|
-              define_method "#{type}?" do
-                node_type == type
-              end
-            end
-          end
-        end
-
-        refine REXML::Element do
-          def each_element_by_xpath(xpath, namespaces = nil, &block)
-            REXML::XPath.each self, xpath, namespaces, &block
-          end
-
-          def attribute_with_prefix(name, prefix = nil)
-            attribute(name, EPUB::NAMESPACES[prefix])&.value
-          end
-
-          alias namespace_uri namespace
-
-          def content
-            texts.join
-          end
-        end
-
-        refine REXML::Text do
-          alias content value
-        end
-
-        if const_defined? :Nokogiri
-          refine Nokogiri::XML::Node do
-            def each_element_by_xpath(xpath, namespaces = nil, &block)
-              xpath(xpath, namespaces).each &block
-            end
-
-            def attribute_with_prefix(name, prefix = nil)
-              attribute_with_ns(name, EPUB::NAMESPACES[prefix])&.value
-            end
-
-            def each_element(xpath = nil, &block)
-              element_children.each(&block)
-            end
-
-            alias elements element_children
-
-            def namespace_uri
-              namespace.href
-            end
-          end
-        end
-      end
     end
   end
 end
+
+require "epub/parser/xml_document/refinements/rexml"
+begin
+  require "epub/parser/xml_document/refinements/nokogiri"
+  EPUB::Parser::XMLDocument.backend = :Nokogiri
+rescue LoadError
+  EPUB::Parser::XMLDocument.backend = :REXML
+end

data/lib/epub/parser/xml_document/refinements/nokogiri.rb

@@ -0,0 +1,33 @@
+require "nokogiri"
+
+module EPUB
+  class Parser
+    class XMLDocument
+      module Refinements
+        module Nokogiri
+          refine ::Nokogiri::XML::Node do
+            def each_element_by_xpath(xpath, namespaces = nil, &block)
+              xpath(xpath, namespaces).each &block
+            end
+
+            def attribute_with_prefix(name, prefix = nil)
+              attribute_with_ns(name, EPUB::NAMESPACES[prefix])&.value
+            end
+
+            def each_element(xpath = nil, &block)
+              element_children.each(&block)
+            end
+
+            alias elements element_children
+
+            def namespace_uri
+              namespace.href
+            end
+          end
+        end
+
+        include Nokogiri
+      end
+    end
+  end
+end

data/lib/epub/parser/xml_document/refinements/rexml.rb

@@ -0,0 +1,43 @@
+require "rexml/document"
+
+module EPUB
+  class Parser
+    class XMLDocument
+      module Refinements
+        module REXML
+          [::REXML::Element, ::REXML::Text].each do |klass|
+            refine klass do
+              %i[document element text].each do |type|
+                define_method "#{type}?" do
+                  node_type == type
+                end
+              end
+            end
+          end
+
+          refine ::REXML::Element do
+            def each_element_by_xpath(xpath, namespaces = nil, &block)
+              ::REXML::XPath.each self, xpath, namespaces, &block
+            end
+
+            def attribute_with_prefix(name, prefix = nil)
+              attribute(name, EPUB::NAMESPACES[prefix])&.value
+            end
+
+            alias namespace_uri namespace
+
+            def content
+              texts.join
+            end
+          end
+
+          refine ::REXML::Text do
+            alias content value
+          end
+        end
+
+        include REXML
+      end
+    end
+  end
+end

data/lib/epub/searcher/publication.rb

@@ -24,6 +24,7 @@ module EPUB
         @package = package
       end
 
+      # @return [Array<Result>]
       def search_text(word, algorithm: :seamless)
         results = []
 
@@ -41,10 +42,10 @@ module EPUB
 
       # @todo: Refactoring
       # @return [Array<Hash>] An array of rearch results. Each result is composed of:
-      #   :element: [REXML::Element, Nokogiri::XML::ELement] Found element
-      #   :itemref: [EPUB::Publication::Package::Spine::Itemref] Itemref that element's document belongs to
-      #   :location: [EPUB::CFI::Location] CFI that indicates the element
-      #   :package: [EPUB::Publication::Package] Package that the element belongs to
+      #   * +:element+: [REXML::Element, Nokogiri::XML::ELement] Found element
+      #   * +:itemref+: [EPUB::Publication::Package::Spine::Itemref] Itemref that element's document belongs to
+      #   * +:location+: [EPUB::CFI::Location] CFI that indicates the element
+      #   * +:package+: [EPUB::Publication::Package] Package that the element belongs to
       def search_element(css: nil, xpath: nil, namespaces: {})
         raise ArgumentError, 'Both css and xpath are nil' if css.nil? && xpath.nil?
 

data/test/fixtures/book/OPS/nav.xhtml

@@ -5,7 +5,7 @@
   </head>
   <body>
     <div>
-      <nav epub:type="toc" id="idid" hidden="">
+      <nav epub:type="frontmatter toc" id="idid" hidden="">
         <hgroup>
           <h2>Sub Navigation</h2>
           <h1>Table of Contents</h1>

data/test/test_parser_content_document.rb

@@ -25,6 +25,7 @@ class TestParserContentDocument < Test::Unit::TestCase
     assert_equal 1, navs.length
     assert_equal 'Table of Contents', nav.heading
     assert_equal 'toc', nav.type
+    assert_equal Set.new(["toc", "frontmatter"]), nav.types
 
     assert_equal 2, nav.items.length
     assert_equal @manifest.items.first, nav.items.first.item

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epub-parser
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.4.0
 platform: ruby
 authors:
 - KITAITI Makoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-05 00:00:00.000000000 Z
+date: 2019-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -364,6 +364,8 @@ files:
 - lib/epub/parser/publication.rb
 - lib/epub/parser/version.rb
 - lib/epub/parser/xml_document.rb
+- lib/epub/parser/xml_document/refinements/nokogiri.rb
+- lib/epub/parser/xml_document/refinements/rexml.rb
 - lib/epub/publication.rb
 - lib/epub/publication/fixed_layout.rb
 - lib/epub/publication/package.rb
@@ -413,7 +415,8 @@ files:
 homepage: https://kitaitimakoto.gitlab.io/epub-parser/file.Home.html
 licenses:
 - MIT
-metadata: {}
+metadata:
+  yard.run: yard
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -429,8 +432,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: EPUB 3 Parser