epub-maker 0.1.2 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4119c4878b2777ccee127c12fbd897dc771308b306172ca887ff962e07d9bfd1
-  data.tar.gz: 8393a6d8d9aa4fa369f4ebf8f3247e1e9a5dbdbf96022f90a9b137f88173d4c1
+  metadata.gz: cb15b719ce1526ed7cc33d12ca8da5fbd58664a3baedfd72b8f8363795584825
+  data.tar.gz: 3c493a4f38d30554736e8d752bdbd43414d261081bfe99717004664b50b94d1e
 SHA512:
-  metadata.gz: 5c728e1af722eb6e102b56e2df6b91b0003c7513a5036ff8a68ab26a7adbd6a9a4391205f58a0328718531fb714ae3dac6c570626afceea66d9951874b8b3234
-  data.tar.gz: 5589187d2a35be80c16a4127ff1f442deb2defd756f7f2feae85aa44da26144fe2c5a03d7ee13f7205eda4b7df5ea6177ab98419a0f56c0239263fd96f640c7a
+  metadata.gz: d9386a7a043b34f1dcd91e1bffeef3463b7c0bbb106b133619b18a51fbf053c65285817fb5deb3c0f07e25c5074fbff401fbcb51458b9531c8a6f0b6e65b43cd
+  data.tar.gz: bc385ddb0e1a3115c1a5e3039d6638fee5924345a0a3d13e34ae8935ba62c39d4f5b77528816f9c9be7690e47fd2582194019f6f4b9f1e8f43b434375b834a11

data/.gitlab-ci.yml

@@ -46,3 +46,23 @@ test:2.6:
     key: ruby:2.6
     paths:
       - deps
+
+test:2.7:
+  image: ruby:2.7
+  script: bundle exec rake test
+  except:
+    - tags
+  cache:
+    key: ruby:2.7
+    paths:
+      - deps
+
+test:3.0:
+  image: ruby:3.0-rc
+  script: bundle exec rake test
+  except:
+    - tags
+  cache:
+    key: ruby:3.0
+    paths:
+      - deps

data/.yardopts

@@ -0,0 +1,2 @@
+-
+CHANGELOG.markdown

data/CHANGELOG.markdown

@@ -1,3 +1,25 @@
+0.1.6
+-----
+
+* [BUG FIX]Add `mtime` keyword argument to `OCF::PhysicalContainer::Zipruby#write`
+
+0.1.5
+-----
+
+* [BUG FIX]Compare path name in the same encoding when finding file in ZIP archive
+* Add `PhysicalContaienr.mtime` API to set mtime of files in EPUB archive
+
+0.1.4
+-----
+
+* Add `Publication::Package::Metadata#modified=` method
+* Rescue Errno::EXDEV on renaming temporary EPUB file
+
+0.1.3
+-----
+
+* Add workaround Window file renaming problem
+
 0.1.2
 ------
 

data/README.markdown

@@ -178,48 +178,19 @@ Todo
 Recent Changes
 --------------
 
-### 0.1.2
+### 0.1.6
 
-* Close temp file when archiving EPUB file
+* [BUG FIX]Add `mtime` keyword argument to `OCF::PhysicalContainer::Zipruby#write`
 
-### 0.1.1
+### 0.1.5
 
-* Update Nokogiri version to < 1.11
+* [BUG FIX]Compare path name in the same encoding when finding file in ZIP archive
+* Add `PhysicalContaienr.mtime` API to set mtime of files in EPUB archive
 
-### 0.1.0
+### 0.1.4
 
-* [BUG FIX]Fix the case file extension should be wrong
-* Add Nokogiri to runtime dependencies explicitly
-
-### 0.0.9
-
-* Remove [ruby-uuid][] gem from dependencies
-* [BUG FIX]Convert Set to Array before writing into XML
-* Follow change of EPUB Parser v0.3.6
-
-[ruby-uuid]: https://github.com/shyouhei/ruby-uuid
-
-### 0.0.8
-
-* Use default temporary directory for `EPUB::Maker.archive`
-
-### 0.0.7
-
-* Change temporary directory used by `EPUB::Maker.archive`
-
-### 0.0.6
-
-* Add `epub-archive` command
-* Add `EPUB::Maker.archive` method
-
-### 0.0.5
-
-* Fix bug to modify `dc:rights` to `dc:right`
-
-### 0.0.4
-* API change: #save -> #write for PhysicalContainer classes
-* Bump required EPUB Parser version: 0.2.0 -> 0.2.6
-* Deprecate `EPUB::OCF::PhysicalContainer.save`
+* Add `Publication::Package::Metadata#modified=` method
+* Rescue Errno::EXDEV on renaming temporary EPUB file
 
 Contributing
 ------------

data/Rakefile

@@ -2,11 +2,17 @@ require 'rake/testtask'
 require 'rake/clean'
 require 'yard'
 require "rubygems/tasks"
+  require "open-uri"
 
 task :default => :test
 
 CLEAN.include 'README.html'
 
+VALID_EPUB = "test/fixtures/accessible_epub_3.epub"
+file VALID_EPUB do |t|
+  File.write t.name, URI("https://github.com/IDPF/epub3-samples/releases/download/20170606/accessible_epub_3.epub").read
+end
 Rake::TestTask.new
+task test: VALID_EPUB
 YARD::Rake::YardocTask.new
 Gem::Tasks.new

data/epub-maker.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'archive-zip'
   gem.add_runtime_dependency 'rake'
   gem.add_runtime_dependency 'addressable', '>= 2.3.5'
+  gem.add_runtime_dependency 'rexml'
   gem.add_runtime_dependency "nokogiri", ">= 1.6.0", "< 1.11"
 
   gem.add_development_dependency 'zipruby'

data/lib/epub/maker/ocf/physical_container/archive_zip.rb

@@ -5,7 +5,7 @@ module EPUB
     class PhysicalContainer
       class ArchiveZip < self
         # @todo Write multiple files at once
-        def write(path_name, content)
+        def write(path_name, content, mtime: nil)
           ::Dir.mktmpdir do |dir|
             tmp_archive_path = ::File.join(dir, ::File.basename(@container_path) + '.tmp')
             ::File.open @container_path do |archive_in|
@@ -15,23 +15,36 @@ module EPUB
                   Archive::Zip.open archive_out, :w do |z_out|
                     updated = false
                     z_in.each do |entry|
-                      if entry.zip_path == path_name
+                      if entry.zip_path == path_name.force_encoding('ASCII-8BIT')
                         entry.file_data = StringIO.new(content)
                         updated = true
                       end
+                      if mtime
+                        entry.mtime = mtime
+                      end
                       z_out << entry
                     end
                     unless updated
                       entry = Archive::Zip::Entry::File.new(path_name)
                       entry.file_data = StringIO.new(content)
+                      if mtime
+                        entry.mtime = mtime
+                      end
                       z_out << entry
                     end
                   end
                 end
               end
             end
-            ::File.chmod 0666 & ~::File.umask, tmp_archive_path
-            ::File.rename tmp_archive_path, @container_path
+            begin
+              ::File.chmod 0666 & ~::File.umask, tmp_archive_path
+              ::File.rename tmp_archive_path, @container_path
+            rescue Errno::EACCES, Errno::EXDEV
+              # In some cases on Windows, we fail to rename the file
+              # but succeed to copy although I don't know why.
+              # Race condition? I don't know. But no time to dig deeper.
+              ::FileUtils.copy tmp_archive_path, @container_path
+            end
           end
         end
       end

data/lib/epub/maker/ocf/physical_container/zipruby.rb

@@ -4,7 +4,7 @@ module EPUB
   class OCF
     class PhysicalContainer
       class Zipruby < self
-        def write(path_name, content)
+        def write(path_name, content, mtime: nil)
           if @archive
             @archive.add_or_replace_buffer path_name, content
           else

data/lib/epub/maker/ocf/physical_container.rb

@@ -13,15 +13,34 @@ module EPUB
   class OCF
     class PhysicalContainer
       class << self
+        @@mtime = nil
+
+        def mtime
+          @@mtime
+        end
+
+        # Sets +mtime+, which is used when setting mtime of file in EPUB(ZIP) archive.
+        # Currently supported for only {ArchiveZip} adapter
+        #
+        # @example
+        #   EPUB::OCF::PhysicalCotainer.adapter = :ArchiveZip
+        #   EPUB::OCF::PhysicalCotainer.mtime = Time.new(2020, 1, 1)
+        #
+        # @param time [Time] mtime to set
+        # @return [Time]
+        def mtime=(time)
+          @@mtime = time
+        end
+
         def write(container_path, path_name, content)
           open(container_path) {|container|
-            container.write(path_name, content)
+            container.write(path_name, content, mtime: mtime)
           }
         end
 
         def save(container_path, path_name, content)
           warn "EPUB::OCF::PhysicalContainer.#{__method__} is deprecated. Use .write instead"
-          write(container_path, path_name, content)
+          write(container_path, path_name, content, mtime: mtime)
         end
       end
     end

data/lib/epub/maker/publication.rb

@@ -1,6 +1,7 @@
 require 'securerandom'
 require 'epub/publication/package'
 require "nokogiri"
+require "mimemagic"
 
 module EPUB
   module Publication
@@ -183,6 +184,21 @@ module EPUB
           name
         end
 
+        # Shortcut to set modified date time
+        # @param datetime [String, #to_time]
+        def modified=(datetime)
+          modified = self.modified
+          unless modified
+            modified = Meta.new
+            modified.property = "dcterms:modified"
+            self.metas << modified
+          end
+          modified.content = datetime.respond_to?(:to_time) ?
+                               datetime.to_time.utc.xmlschema :
+                               datetime
+          modified
+        end
+
         class Meta
           def valid?
             property
@@ -235,6 +251,15 @@ module EPUB
           end
           item.manifest = self
           yield item if block_given?
+          unless item.media_type
+            path = item.href.to_s
+            item.media_type =
+              if path.end_with? ".html"
+                "application/xhtml+xml"
+              else
+                MimeMagic.by_path(item.href.to_s).type
+              end
+          end
           self << item
           item
         end
@@ -263,7 +288,11 @@ module EPUB
               elsif content_file
                 File.read(content_file)
               else
-                raise 'no content nor content_file'
+                begin
+                  read
+                rescue OCF::PhysicalContainer::NoEntry
+                  raise 'no content nor content_file'
+                end
               end
             book = manifest.package.book
             book.container_adapter.write book.epub_file, entry_name, content_to_save

data/lib/epub/maker/version.rb

@@ -1,5 +1,5 @@
 module EPUB
   module Maker
-    VERSION = "0.1.2"
+    VERSION = "0.1.6"
   end
 end

data/test/helper.rb

@@ -11,6 +11,12 @@ class Test::Unit::TestCase
   def assert_valid_epub(file)
     assert_true Epubcheck::Ruby::CLI.new.execute(file)
   end
+
+  private
+
+  def valid_epub
+    Pathname.new("test/fixtures/accessible_epub_3.epub")
+  end
 end
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'epub'

data/test/test_inplace_editing.rb

@@ -1,13 +1,15 @@
 require_relative 'helper'
 require 'epub/maker'
 
-class TestImplaceEditing < Test::Unit::TestCase
+class TestInplaceEditing < Test::Unit::TestCase
   def setup
     @assets_dir = Pathname(__dir__)/'fixtures'/'book'
     @dir = Pathname.mktmpdir('epub-maker-test')
     @file = @dir/'book.epub'
     EPUB::Maker.archive @assets_dir, @file
     @book = EPUB::Parser.parse(@file)
+    @valid_epub = @dir/valid_epub.basename
+    FileUtils.cp valid_epub, @valid_epub
   end
 
   def teardown
@@ -57,4 +59,25 @@ class TestImplaceEditing < Test::Unit::TestCase
 
     assert_match '<title>Edited Title</title>', item.read
   end
+
+  def test_edit_without_change
+    epub = EPUB::Parser.parse(@valid_epub)
+    epub.save
+    assert_equal epub.release_identifier, EPUB::Parser.parse(@valid_epub).release_identifier
+  end
+
+  def test_specify_mtime
+    # Currently, only ArchiveZip supports this API
+    EPUB::OCF::PhysicalContainer.adapter = :ArchiveZip
+    mtime = EPUB::OCF::PhysicalContainer.mtime = Time.new(2020, 1, 1)
+    epub = EPUB::Parser.parse(@valid_epub)
+    epub.metadata.unique_identifier.content = "new-unique-identifier"
+    epub.package.save
+
+    Archive::Zip.open @valid_epub.to_path do |z|
+      z.each do |entry|
+        assert_equal mtime, entry.mtime
+      end
+    end
+  end
 end

data/test/test_maker.rb

@@ -73,7 +73,6 @@ class TestMaker < Test::Unit::TestCase
       error_message = error.message
     end
     dirname = error_message.match(/\[EPUB::Maker\].*:\s*(.+)\Z/m).captures.last
-
     assert_path_exist dirname
   end
 

data/test/test_maker_publication.rb

@@ -2,6 +2,7 @@
 require_relative 'helper'
 require 'epub/parser'
 require 'epub/maker/publication'
+require "date"
 
 class TestMakerPublication < Test::Unit::TestCase
   def setup
@@ -37,4 +38,25 @@ class TestMakerPublication < Test::Unit::TestCase
     media_type = doc.xpath('/opf:package/opf:bindings/opf:mediaType', EPUB::NAMESPACES).first
     assert_equal 'application/x-demo-slideshow', media_type['media-type']
   end
+
+  def test_modified=
+    metadata = EPUB::Publication::Package::Metadata.new
+    metadata.modified = "2011-01-01T12:00:00Z"
+
+    assert_equal 1, metadata.metas.length
+    assert_equal "2011-01-01T12:00:00Z", metadata.modified.content
+
+    metadata.modified = Time.new(2020, 2, 1, 0, 0, 0, "+09:00")
+    assert_equal 1, metadata.metas.length
+    assert_equal "2020-01-31T15:00:00Z", metadata.modified.content
+
+    metadata.modified = Date.new(1993, 2, 24)
+    assert_equal 1, metadata.metas.length
+    expected = Time.new(1993, 2, 24, 0, 0, 0, Time.now.utc_offset)
+    assert_equal expected.utc.xmlschema, metadata.modified.content
+
+    metadata.modified = DateTime.new(1993, 2, 24, 0, 0, 0, "+00:00")
+    assert_equal 1, metadata.metas.length
+    assert_equal "1993-02-24T00:00:00Z", metadata.modified.content
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epub-maker
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.6
 platform: ruby
 authors:
 - KITAITI Makoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-31 00:00:00.000000000 Z
+date: 2021-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: epub-parser
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.5
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -236,6 +250,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".gitlab-ci.yml"
+- ".yardopts"
 - CHANGELOG.markdown
 - Gemfile
 - LICENSE.txt
@@ -288,7 +303,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: EPUB Maker