epub-maker 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c40def444773cc73f4a412792312c708d34fc45
-  data.tar.gz: 2a731fbf57f36c9c978707b49d8c060d4086f80b
+  metadata.gz: dd80bab3836300bb946438407d0cd8c931557277
+  data.tar.gz: 7430a5c2e9680f0f93a9c7e2f7f1fb7339bef339
 SHA512:
-  metadata.gz: 715949ee62b509a9eade435df0d6823d85892ee1ad7f99ff949089abb02386d62cbfcd4a549a4c4e0b615ed1f59681cdcdc6e8794bdf0c8eacb52f3076940948
-  data.tar.gz: e7825b5df371b8bf4da010fa72e8099491fe25f2cfe50f291b36acd8a8087fd80e1d56c33531d8a4b9709faec721fadc3d514508274c831e8a61e17b1b08fb26
+  metadata.gz: b6a2af0f44dcfa9ee4f934ddb4b7a32b99c06aafe9a812e72409e447292325811d2d5e123a13b92006bc588454e886d33575fa047a25763f08e338ce9a6a2f02
+  data.tar.gz: 8ab6ec574eec7d760130e67285bd0264656b36e979dd00ecffac80cbd1d6105c48bb42d1221357c49caee524d14dcead69babba27f0ce42d1413852758cf72bf

data/.gitlab-ci.yml

@@ -0,0 +1,22 @@
+before_script:
+  - ruby -v
+  - which ruby
+  - gem install bundler --no-document
+  - bundle install --jobs=$(nproc) --path=deps
+
+cache:
+  paths:
+    - deps/
+
+test:2.2:
+  image: ruby:2.2
+  script:
+    - bundle exec rake test
+
+test:2.3:
+  image: ruby:2.3
+  script: bundle exec rake test
+
+test:2.4:
+  image: ruby:2.4
+  script: bundle exec rake test

data/CHANGELOG.markdown

@@ -1,3 +1,9 @@
+0.0.6
+-----
+
+* Add `epub-archive` command
+* Add `EPUB::Maker.archive` method
+
 0.0.5
 -----
 

data/Gemfile

@@ -7,3 +7,7 @@ if ENV['EDGE_PARSER'] == '1'
 end
 
 gemspec
+
+if RUBY_PLATFORM.match /darwin/
+  gem 'terminal-notifier'
+end

data/README.markdown

@@ -131,9 +131,30 @@ For APIs of parsed EPUB book, see [EPUB Parser's documentation][epub-parser-doc]
       task.bindings = {'application/x-demo-slideshow' => "#{DIR}/OPS/impl.xhtml"}
     end
 
+### epub-archive command
+
+`epub-archive` command archives given directory as an EPUB file like [epzip][] gem but doesn't require zip command.
+
+    % ls path/to
+    book
+    % epub-archie path/to/book
+    % ls path/to
+    book
+    book.epub
+
+You can specify target file path.
+
+    % epub-archive source/dir/book target/dir/book.epub
+    % ls source/dir
+    book
+    % ls target/dir
+    book.epub
+
+[epzip]: https://github.com/takahashim/epzip
+
 Requirements
 ------------
-* Ruby 2.1 or later
+* Ruby 2.2 or later
 * C compiler to build Nokogiri gems
 
 Todo
@@ -145,6 +166,11 @@ Todo
 
 Recent Changes
 --------------
+### 0.0.6
+
+* Add `epub-archive` command
+* Add `EPUB::Maker.archive` method
+
 ### 0.0.5
 
 * Fix bug to modify `dc:rights` to `dc:right`

data/bin/epub-archive

@@ -0,0 +1,14 @@
+require "English"
+require "epub/maker"
+
+def main(argv)
+  source_dir = argv.shift
+  raise "source directory not specified" unless source_dir
+
+  EPUB::Maker.archive(source_dir, argv.shift)
+rescue => error
+  $stderr.puts error
+  abort "Usage: #{$PROGRAM_NAME} SOURCE_DIR [EPUB_FILE]"
+end
+
+main(ARGV)

data/epub-maker.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["KitaitiMakoto@gmail.com"]
   gem.description   = %q{This library supports making and editing EPUB books}
   gem.summary       = %q{EPUB Maker}
-  gem.homepage      = ""
+  gem.homepage      = "http://www.rubydoc.info/gems/epub-maker"
 
   gem.files         = `git ls-files`.split($/)
   gem.files.delete '"test/fixtures/book/OPS/\343\203\253\343\203\274\343\203\210\343\203\225\343\202\241\343\202\244\343\203\253.opf"'
@@ -21,7 +21,6 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 2.1.0'
 
   gem.add_runtime_dependency 'epub-parser', '>= 0.2.6'
-  gem.add_runtime_dependency 'pathname-common_prefix'
   gem.add_runtime_dependency 'mimemagic'
   gem.add_runtime_dependency 'ruby-uuid'
   gem.add_runtime_dependency 'archive-zip'
@@ -31,8 +30,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'zipruby'
   gem.add_development_dependency 'test-unit'
   gem.add_development_dependency 'test-unit-notify'
-  gem.add_development_dependency 'epubcheck'
-  gem.add_development_dependency 'epzip'
+  gem.add_development_dependency 'epubcheck-ruby'
   gem.add_development_dependency 'simplecov'
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'pry-doc'

data/lib/epub/maker.rb

@@ -1,6 +1,5 @@
 require 'English'
 require 'pathname'
-require 'pathname/common_prefix'
 require 'fileutils'
 require 'tmpdir'
 require 'time'
@@ -60,6 +59,46 @@ module EPUB
         error.set_backtrace backtrace
         raise error
       end
+
+      # Substance of +epub-archive+ command
+      # @param source_file [Pathname, String]
+      # @param epub_file [Pathname, String, nil]
+      # @return [Pathname] Path to generated EPUB file
+      # @raise [RuntimeError] if directory +source_dir+ doesn't exist
+      # @raise [Archive::Zip::Error] if something goes wrong around ZIP archive manipulation
+      # @todo Accept usage that +epub-archive path/to/boo .+ generates ./book.epub
+      # @todo Abstract ZIP library
+      # @todo Accept compression method option
+      # @todo Accept compression level option
+      def archive(source_dir, epub_file = nil)
+        source_dir = Pathname(source_dir)
+        raise "source directory #{source_dir} not exist" unless source_dir.exist?
+
+        epub_file ||= source_dir.sub_ext(".epub")
+        epub_file = Pathname(epub_file)
+
+        Pathname.mktmpdir do |dir|
+          temp_dest = dir/epub_file.basename
+          temp_container = dir/source_dir.basename
+
+          temp_container.mkdir
+          mimetype = temp_container/"mimetype"
+          mimetype.write EPUB::MediaType::EPUB
+          Archive::Zip.open temp_dest.to_path, :w do |archive|
+            file = Archive::Zip::Entry.from_file(mimetype.to_path,  compression_codec: Archive::Zip::Codec::Store)
+            archive.add_entry file
+          end
+          mimetype.delete
+          temp_container.delete
+
+          FileUtils.cp_r source_dir, temp_container
+          mimetype.delete if mimetype.exist?
+          Archive::Zip.archive temp_dest.to_path, temp_container.to_path + "/.", directories: false
+          temp_dest.rename epub_file
+        end
+
+        epub_file
+      end
     end
   end
 

data/lib/epub/maker/version.rb

@@ -1,5 +1,5 @@
 module EPUB
   module Maker
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/test/helper.rb

@@ -8,11 +8,17 @@ require 'test/unit/notify'
 require 'open3'
 require 'shellwords'
 require 'pry'
+require 'epubcheck/ruby/cli'
 class Test::Unit::TestCase
   def assert_valid_epub(file)
-    jar = File.join(ENV['GEM_HOME'], 'gems', 'epubcheck-3.0.0', 'lib', 'epubcheck-3.0', 'epubcheck-3.0.jar')
-    stderr, status = Open3.capture2e "java -jar #{jar.shellescape} #{file.shellescape}"
-    assert_true (status.exitstatus == 0 or stderr !~ /^ERROR: /), stderr
+    if ENV["GITLAB_CI"]
+      warn "Validating EPUB file loosly by EPUB::Parser.parse instead of EpubCheck"
+      assert_nothing_raised do
+        EPUB::Parser.parse file
+      end
+    else
+      assert_true Epubcheck::Ruby::CLI.new.execute(file)
+    end
   end
 end
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)

data/test/test_inplace_editing.rb

@@ -1,18 +1,16 @@
 require_relative 'helper'
 require 'epub/maker'
-require 'epzip'
 
 class TestImplaceEditing < Test::Unit::TestCase
   def setup
     @assets_dir = Pathname(__dir__)/'fixtures'/'book'
     @dir = Pathname.mktmpdir('epub-maker-test')
     @file = @dir/'book.epub'
-    Epzip.zip @assets_dir.to_s, @file.to_path
+    EPUB::Maker.archive @assets_dir, @file
     @book = EPUB::Parser.parse(@file)
   end
 
   def teardown
-    (@assets_dir/'mimetype').rmtree
     @dir.remove_entry_secure if @dir.exist?
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epub-maker
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - KITAITI Makoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-06 00:00:00.000000000 Z
+date: 2017-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: epub-parser
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.6
-- !ruby/object:Gem::Dependency
-  name: pathname-common_prefix
-  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: mimemagic
   requirement: !ruby/object:Gem::Requirement
@@ -151,21 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: epubcheck
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: epzip
+  name: epubcheck-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -251,16 +223,19 @@ dependencies:
 description: This library supports making and editing EPUB books
 email:
 - KitaitiMakoto@gmail.com
-executables: []
+executables:
+- epub-archive
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
 - CHANGELOG.markdown
 - Gemfile
 - LICENSE.txt
 - README.markdown
 - Rakefile
+- bin/epub-archive
 - epub-maker.gemspec
 - lib/epub/maker.rb
 - lib/epub/maker/content_document.rb
@@ -289,7 +264,7 @@ files:
 - test/test_maker_ocf.rb
 - test/test_maker_publication.rb
 - test/test_task.rb
-homepage: ''
+homepage: http://www.rubydoc.info/gems/epub-maker
 licenses: []
 metadata: {}
 post_install_message: 
@@ -308,7 +283,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: EPUB Maker