epub-parser 0.3.8 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02fa97ea55de70030b58276b77bfbba26d43f5f99a77c7bffb86aec8b6afaf9e
-  data.tar.gz: c07fe68a8715101082628bb10fee8f3869d3874467aeba8598df89e79a72e442
+  metadata.gz: 5961049ade105ba54596ed40e0c6ff1f492b48fbb37957b90ce0a35bff61fda1
+  data.tar.gz: 1c6d046515c6dd279a113b69040eae5d713813a35561b960882571cd02356792
 SHA512:
-  metadata.gz: 7c03dcea199c65a84f1c184bbfa07c6d42583167ab26398e3159ec421e2c3205b57e39200d006f22f7f3fbf6dbb7567a7b9424d309123e724dc59ce584ee790e
-  data.tar.gz: a04003670af41618c26ecb7acd1ec0cda0063961b40c3b5fa0c9d6de21e2c7462eaac7205d6a577df69a05056f04f85ec8cf9044262e2d6bd9c24933d2ca4c04
+  metadata.gz: 8d295d2df9ea39e38a52140e1c812901edc21189c98ad32c2ed25e1078372099483b4d671ca2a1a320d0c5c05f179762bf6ad9b27f960c40b3eb9548b1053239
+  data.tar.gz: e45a6b0d495458fa4de9b9aaff379f0d20d11723bf8d7bac30686045811387d6ee641fb759c6b5bc218c1de8f309d1d8a981db03e1e9a6b16da2bc3f62eb5d92

data/CHANGELOG.adoc

@@ -1,5 +1,10 @@
 = CHANGELOG
 
+== 0.3.9
+
+* [BUG FIX]Set {EPUB::Metadata::DCMES#lang} properly from xml:lang attribute
+* Change default XML backend from REXML to Nokogiri
+
 == 0.3.8
 
 * [REFACTORING]Add {EPUB::Parser::NokogiriAttributeWithPrefix} and use `Nokogiri::XML::Node#attribute_with_prefix` instead of `EPUB::Parser::Utils#extract_attribute`

data/README.adoc

@@ -174,6 +174,11 @@ If you find other gems, please tell me or request a pull request.
 
 == RECENT CHANGES
 
+=== 0.3.9
+
+* [BUG FIX]Set {EPUB::Metadata::DCMES#lang} properly from xml:lang attribute
+* Change default XML backend from REXML to Nokogiri
+
 === 0.3.8
 
 * [REFACTORING]Add {EPUB::Parser::NokogiriAttributeWithPrefix} and use `Nokogiri::XML::Node#attribute_with_prefix` instead of `EPUB::Parser::Utils#extract_attribute`

data/Rakefile

@@ -39,21 +39,11 @@ namespace :test do
     File.rename "#{input_dir}.epub.tmp", "#{input_dir}.epub"
   end
 
-  # TODO: Test with both REXML and Nokogiri in testing framework
-  %w[REXML Nokogiri].each do |xml_backend|
-    task "set_xml_backend_#{xml_backend.downcase}" do
-      ENV["EPUB_PARSER_XML_BACKEND"] = xml_backend
-    end
-
-    Rake::TestTask.new "test_with_#{xml_backend.downcase}" do |task|
-      task.test_files = FileList['test/**/test_*.rb']
-      task.warning = true
-      task.options = '--no-show-detail-immediately --verbose'
-      EPUB::Parser::XMLDocument.backend = xml_backend
-    end
-    task "test_with_#{xml_backend.downcase}" => "set_xml_backend_#{xml_backend.downcase}"
+  Rake::TestTask.new do |task|
+    task.test_files = FileList['test/**/test_*.rb']
+    task.warning = true
+    task.options = '--no-show-detail-immediately --verbose'
   end
-  task :test => [:test_with_rexml, :test_with_nokogiri]
 end
 
 task :doc => 'doc:default'

data/docs/Home.adoc

@@ -119,10 +119,10 @@ ret == book # => true; this API is not good I feel... Welcome suggestion!
 
 ==== Switching XML Library
 
-EPUB Parser uses https://ruby-doc.org/stdlib-2.5.3/libdoc/rexml/rdoc/index.html[REXML], a standard-bundled library, by default. You can use https://www.nokogiri.org/[Nokogiri], a Ruby bindings for http://xmlsoft.org/[Libxml2] and http://xmlsoft.org/XSLT/[Libxslt] and more if you have already installed Nokogiri gem by RubyGems or Bundler.
+EPUB Parser uses https://www.nokogiri.org/[Nokogiri], a Ruby bindings for http://xmlsoft.org/[Libxml2] and http://xmlsoft.org/XSLT/[Libxslt] and more if you have already installed Nokogiri gem by RubyGems or Bundler. If Nokogiri is not available, it fallbacks to https://ruby-doc.org/stdlib-2.5.3/libdoc/rexml/rdoc/index.html[REXML], a standard-bundled library. You can also specify REXML explicitly:
 
 ----
-EPUB::Parser::XMLDocument.backend = :Nokogiri
+EPUB::Parser::XMLDocument.backend = :REXML
 ----
 
 ==== Switching ZIP library

data/lib/epub/constants.rb

@@ -1,5 +1,6 @@
 module EPUB
   NAMESPACES = {
+    'xml'   => 'http://www.w3.org/XML/1998/namespace',
     'dc'    => 'http://purl.org/dc/elements/1.1/',
     'ocf'   => 'urn:oasis:names:tc:opendocument:xmlns:container',
     'opf'   => 'http://www.idpf.org/2007/opf',

data/lib/epub/parser/metadata.rb

@@ -88,7 +88,8 @@ module EPUB
         model = EPUB::Metadata.const_get(klass).new
         attributes.each do |attr|
           writer_name = (attr == "content") ? "meta_content=" : "#{attr.gsub('-', '_')}="
-          model.__send__ writer_name, elem.attribute_with_prefix(attr)
+          namespace = (attr == "lang") ? "xml" : nil
+          model.__send__ writer_name, elem.attribute_with_prefix(attr, namespace)
         end
         model.content = elem.content unless klass == :Link
         model.content.strip! if klass == :Identifier

data/lib/epub/parser/version.rb

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

data/lib/epub/parser/xml_document.rb

@@ -1,8 +1,4 @@
 require "rexml/document"
-begin
-  require "nokogiri"
-rescue LoadError
-end
 
 module EPUB
   class Parser
@@ -19,6 +15,13 @@ module EPUB
         end
       end
 
+      begin
+        require "nokogiri"
+        @backend = :Nokogiri
+      rescue LoadError
+        @backend = :REXML
+      end
+
       module Refinements
         [REXML::Element, REXML::Text].each do |klass|
           refine klass do

data/test/helper.rb

@@ -15,4 +15,3 @@ if ENV["PRETTY_BACKTRACE"]
 end
 
 require 'epub/parser'
-EPUB::Parser::XMLDocument.backend = ENV["EPUB_PARSER_XML_BACKEND"].to_sym

data/test/test_parser_xmldocument.rb

@@ -0,0 +1,82 @@
+# coding: utf-8
+require_relative "helper"
+
+class TestParserXMLDocument < Test::Unit::TestCase
+  def setup
+    @container = File.read("test/fixtures/book/META-INF/container.xml")
+    @opf = File.read("test/fixtures/book/OPS/ルートファイル.opf")
+    @nav = File.read("test/fixtures/book/OPS/nav.xhtml")
+  end
+
+  def test_parse_container
+    EPUB::Parser::XMLDocument.backend = :REXML
+    rexml_container = EPUB::Parser::OCF.new(nil).parse_container(@container)
+    EPUB::Parser::XMLDocument.backend = :Nokogiri
+    nokogiri_container = EPUB::Parser::OCF.new(nil).parse_container(@container)
+
+    assert_equal rexml_container.rootfiles.length, nokogiri_container.rootfiles.length
+    rexml_container.rootfiles.each do |rootfile|
+      rf = nokogiri_container.rootfiles.find {|rf| rf.full_path == rootfile.full_path}
+      assert_equal rootfile.full_path, rf.full_path
+      assert_equal rootfile.media_type, rf.media_type
+    end
+  end
+
+  def test_parse_package_document
+    EPUB::Parser::XMLDocument.backend = :REXML
+    rexml_package = EPUB::Parser::Publication.new(@opf).parse
+    EPUB::Parser::XMLDocument.backend = :Nokogiri
+    nokogiri_package = EPUB::Parser::Publication.new(@opf).parse
+
+    %i[version prefix xml_lang dir id].each do |attr|
+      assert_equal rexml_package.send(attr), nokogiri_package.send(attr)
+    end
+
+    EPUB::Metadata::DC_ELEMS.each do |attr|
+      rexml_attr = rexml_package.metadata.send(attr)
+      nokogiri_attr = nokogiri_package.metadata.send(attr)
+
+      assert_equal rexml_attr.length, nokogiri_attr.length
+
+      rexml_attr.each_with_index do |model, index|
+        %i[content id lang dir].each do |a|
+          assert_equal model.send(a), nokogiri_attr[index].send(a)
+        end
+      end
+    end
+
+    rexml_package.metadata.metas.each_with_index do |meta, index|
+      %i[property id scheme content name meta_content].each do |attr|
+        assert_equal meta.send(attr), nokogiri_package.metadata.metas[index].send(attr)
+      end
+    end
+
+    rexml_package.metadata.links.each_with_index do |link, index|
+      %i[href rel id media_type].each do |attr|
+        assert_equal link.send(attr), nokogiri_package.metadata.links[index].send(attr)
+      end
+    end
+  end
+
+  def test_parse_navigation
+    EPUB::Parser::XMLDocument.backend = :REXML
+    rexml_nav = EPUB::Parser.parse("test/fixtures/book.epub").nav.content_document
+    EPUB::Parser::XMLDocument.backend = :Nokogiri
+    nokogiri_nav = EPUB::Parser.parse("test/fixtures/book.epub").nav.content_document
+
+    assert_equal rexml_nav.navigations.length, nokogiri_nav.navigations.length
+
+    rexml_nav.navigations.each_with_index do |item, index|
+      nokogiri_item = nokogiri_nav.navigations[index]
+      %i[text content_document type].each do |attr|
+        assert_equal item.send(attr), nokogiri_item.send(attr)
+      end
+
+      item.items.each_with_index do |i, index2|
+        %i[text content_document].each do |attr|
+          assert_equal i.send(attr), nokogiri_item.items[index2].send(attr)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epub-parser
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.9
 platform: ruby
 authors:
 - KITAITI Makoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-29 00:00:00.000000000 Z
+date: 2018-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -407,6 +407,7 @@ files:
 - test/test_parser_fixed_layout.rb
 - test/test_parser_ocf.rb
 - test/test_parser_publication.rb
+- test/test_parser_xmldocument.rb
 - test/test_publication.rb
 - test/test_searcher.rb
 homepage: https://kitaitimakoto.gitlab.io/epub-parser/file.Home.html
@@ -445,5 +446,6 @@ test_files:
 - test/test_parser_fixed_layout.rb
 - test/test_parser_ocf.rb
 - test/test_parser_publication.rb
+- test/test_parser_xmldocument.rb
 - test/test_publication.rb
 - test/test_searcher.rb