epub-maker 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f7686e5d9b95fd78315282adc67a221417f66c6
-  data.tar.gz: d8c453ee610a382d3bd313c8faee92c5c3e2d86a
+  metadata.gz: b0bd5ce3c4ef3e3461c4148891ec762164f635b7
+  data.tar.gz: a102f5e8bfb4743d2e585127d7174dae326abb7b
 SHA512:
-  metadata.gz: 73ff726291b887c4de99e76e169e02a3e0f1cc9dc15491f527ff1604b563bae295982e3805c3e70801377462b48c62e56a30c61f351fb0fa6e259dc0a1172469
-  data.tar.gz: 840a22921fdfa05a16e85a5a08d778812e341d4d36d2dd5d05b4c4a687681148da473aea105129d1b50193fe22c382938fe1f6b54879b30ac0c4f386055a19ba
+  metadata.gz: 33e8be24da60d5eafb31c24784d0cf51440c3660e9ce6e86047d2c4a89b83e5dbed14efff60ff4148ed1224b2a3eb7c1008d17d99eba5a98466a70b302962987
+  data.tar.gz: 1a2272a5ad1f6a09e2e353fc7dc0c65bad265e2921c63cac2a9c8ddf14e2e3344e0a30661de2570be8823f8988350d0d1a8048a0a58ffba86a3476068d60a04b

data/CHANGELOG.markdown

@@ -1,3 +1,9 @@
+0.0.3
+-----
+
+* Bump up required Ruby version: >= 2.0.0 -> >= 2.1.0
+* Use PhysicalContainer to save contents into EPUB file
+
 0.0.2
 -----
 

data/README.markdown

@@ -133,8 +133,8 @@ For APIs of parsed EPUB book, see [EPUB Parser's documentation][epub-parser-doc]
 
 Requirements
 ------------
-* Ruby 2.0 or later
-* C compiler to build zipruby and Nokogiri gems
+* Ruby 2.1 or later
+* C compiler to build Nokogiri gems
 
 Todo
 ----
@@ -145,6 +145,9 @@ Todo
 
 Recent Changes
 --------------
+### 0.0.3
+* Bump up required Ruby version: >= 2.0.0 -> >= 2.1.0
+
 ### 0.0.2
 * Detect media type of files more strictly
 * Keep temporary directory remained on error in `EPUB::Maker.make`

data/epub-maker.gemspec

@@ -18,9 +18,8 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-  gem.required_ruby_version = '>= 2.0.0'
+  gem.required_ruby_version = '>= 2.1.0'
 
-  gem.add_runtime_dependency 'zipruby'
   gem.add_runtime_dependency 'epub-parser', '>= 0.2.0'
   gem.add_runtime_dependency 'pathname-common_prefix'
   gem.add_runtime_dependency 'mimemagic'
@@ -29,14 +28,13 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'rake'
   gem.add_runtime_dependency 'addressable', '>= 2.3.5'
 
-  gem.add_development_dependency 'test-unit-full'
+  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 'simplecov'
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'pry-doc'
   gem.add_development_dependency 'yard'
-  gem.add_development_dependency 'redcarpet'
-  gem.add_development_dependency 'gem-man'
-  gem.add_development_dependency 'ronn'
 end

data/lib/epub/maker.rb

@@ -35,16 +35,16 @@ module EPUB
           archive.add_entry file
         end
 
-        Zip::Archive.open temp_path.to_path do |archive|
-          yield book if block_given?
-          book.save archive
-        end
+        book.epub_file = temp_path.to_path
+        yield book if block_given?
+        book.save
 
         path.open 'wb' do |file|
           raise Error, "File locked by other process: #{path}" unless file.flock File::LOCK_SH|File::LOCK_NB
           ($VERBOSE ? ::FileUtils::Verbose : ::FileUtils).move temp_path.to_path, path.to_path
         end
         dir.remove_entry_secure
+        book.epub_file = path.to_path
         book
 
         # validate
@@ -78,12 +78,12 @@ module EPUB
       package
     end
 
-    # @param archive [Zip::Archive]
-    def save(archive)
-      ocf.save archive
-      package.save archive
+    # @param archive [OCF::PhysicalContainer]
+    def save
+      ocf.save
+      package.save
       resources.each do |item|
-        item.save archive
+        item.save
       end
     end
   end
@@ -115,14 +115,6 @@ class Pathname
     FileUtils.remove_entry_secure to_path
   end
 
-  unless method_defined? :write
-    def write(string, mode='w', perm=0666)
-      open mode, perm do |file|
-        file << string
-      end
-    end
-  end
-
   unless method_defined? :/
     alias / +
   end

data/lib/epub/maker/ocf.rb

@@ -1,4 +1,5 @@
 require 'epub/ocf'
+require 'epub/maker/ocf/physical_container'
 
 # @todo Use refinement
 module EPUB
@@ -10,9 +11,8 @@ module EPUB
       self
     end
 
-    # @param archive [Zip::Archive] path to archive file
-    def save(archive)
-      self.container.save archive if self.container
+    def save
+      book.container_adapter.save book.epub_file, File.join(DIRECTORY, Container::FILE), self.container.to_xml if self.container
     end
 
     # @overload make_container
@@ -41,11 +41,6 @@ module EPUB
         }.to_xml
       end
 
-      # @param archive [Zip::Archive]
-      def save(archive)
-        archive.add_buffer File.join(DIRECTORY, Container::FILE), to_xml
-      end
-
       # @option full_path [String|nil] full path to package document file in container such like "OPS/content.opf"
       # @option media_type [String] media type
       # @yield [Rootfile] rootfile

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

@@ -0,0 +1,24 @@
+require 'tmpdir'
+require 'epub/ocf/physical_container'
+[
+  [:ArchiveZip, 'archive_zip'],
+  [:Zipruby, 'zipruby']
+].each do |(class_name, feature_name)|
+  if EPUB::OCF::PhysicalContainer.const_defined? class_name
+    require "epub/maker/ocf/physical_container/#{feature_name}"
+  end
+end
+
+module EPUB
+  class OCF
+    class PhysicalContainer
+      class << self
+        def save(container_path, path_name, content)
+          open(container_path) {|container|
+            container.save(path_name, content)
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require 'epub/ocf/physical_container/archive_zip'
+
+module EPUB
+  class OCF
+    class PhysicalContainer
+      class ArchiveZip < self
+        def save(path_name, content)
+          ::Dir.mktmpdir do |dir|
+            path = ::File.join(dir, ::File.basename(path_name))
+            ::File.write path, content
+            Archive::Zip.archive @container_path, path, path_prefix: ::File.dirname(path_name)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require 'epub/ocf/physical_container/zipruby'
+
+module EPUB
+  class OCF
+    class PhysicalContainer
+      class Zipruby < self
+        def save(path_name, content)
+          if @archive
+            @archive.add_or_replace_buffer path_name, content
+          else
+            open {|container| container.save(path_name, content)}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/epub/maker/publication.rb

@@ -40,15 +40,9 @@ module EPUB
         self
       end
 
-      def edit(archive=nil)
+      def edit
         yield self if block_given?
-        if archive
-          save archive
-        else
-          Zip::Archive.open manifest.package.book.epub_file do |archive|
-            save archive
-          end
-        end
+        save
       end
 
       def make_metadata
@@ -83,8 +77,8 @@ module EPUB
         bindings
       end
 
-      def save(archive)
-        archive.add_or_replace_buffer book.rootfile_path, to_xml
+      def save
+        book.container_adapter.save book.epub_file, book.rootfile_path, to_xml
       end
 
       module ContentModel
@@ -255,22 +249,19 @@ module EPUB
         class Item
           attr_accessor :content, :content_file
 
-          # @param archive [Zip::Archive|nil] archive to save content. If nil, open archive in this method
           # @raise StandardError when no content nor content_file
-          def save(archive=nil)
-            if archive
+          # @todo Don't read content from file when +content_file+ exists. If container adapter is Archive::Zip, it writes content to file twice.
+          def save
+            content_to_save =
               if content
-                archive.add_or_replace_buffer entry_name, content
+                content
               elsif content_file
-                archive.add_or_replace_file entry_name, content_file
+                File.read(content_file)
               else
                 raise 'no content nor content_file'
               end
-            else
-              Zip::Archive.open manifest.package.book.epub_file do |archive|
-                save archive
-              end
-            end
+            book = manifest.package.book
+            book.container_adapter.save book.epub_file, entry_name, content_to_save
           end
 
           # Save document into EPUB archive when block ended

data/lib/epub/maker/version.rb

@@ -1,5 +1,5 @@
 module EPUB
   module Maker
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/test/helper.rb

@@ -3,7 +3,8 @@ SimpleCov.start do
   add_filter '/test|deps/'
 end
 
-require 'test/unit/full'
+require 'test/unit'
+require 'test/unit/notify'
 require 'open3'
 require 'shellwords'
 require 'pry'

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: epub-maker
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - KITAITI Makoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-04 00:00:00.000000000 Z
+date: 2016-01-16 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: zipruby
-  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: epub-parser
   requirement: !ruby/object:Gem::Requirement
@@ -123,21 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.3.5
 - !ruby/object:Gem::Dependency
-  name: test-unit-full
-  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: epubcheck
+  name: zipruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: epzip
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: test-unit-notify
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -179,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: epubcheck
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -193,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-doc
+  name: epzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -207,7 +179,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -221,7 +193,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -235,7 +207,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: gem-man
+  name: pry-doc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -249,7 +221,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ronn
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -265,8 +237,7 @@ dependencies:
 description: This library supports making and editing EPUB books
 email:
 - KitaitiMakoto@gmail.com
-executables:
-- epub-maker
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -276,11 +247,13 @@ files:
 - LICENSE.txt
 - README.markdown
 - Rakefile
-- bin/epub-maker
 - epub-maker.gemspec
 - lib/epub/maker.rb
 - lib/epub/maker/content_document.rb
 - lib/epub/maker/ocf.rb
+- lib/epub/maker/ocf/physical_container.rb
+- lib/epub/maker/ocf/physical_container/archive_zip.rb
+- lib/epub/maker/ocf/physical_container/zipruby.rb
 - lib/epub/maker/publication.rb
 - lib/epub/maker/task.rb
 - lib/epub/maker/version.rb
@@ -313,7 +286,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -321,7 +294,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: EPUB Maker

data/bin/epub-maker

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'epub-maker'