epub-maker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 151508171923e54e7fff1950f2faceedab975568
+  data.tar.gz: 1343fe1b022341d99765ebc1a46a9261fb0339c7
+SHA512:
+  metadata.gz: 6261ffcbc75632d75188ee109c544d46955a9917f3b817a8dd2df8d0edceca530ee4b436bf4347e14a7d6d3f9610333eed8420da22d608da78b4f8357f9ce6b8
+  data.tar.gz: de1a958a0ec211d11e82eac5f3e59bcde89b84da93bb5cb0faadc9f1a4b48ec8ef94551ff44c18edc715dff7a89fa060b7430108ba3b48c5f994aa01c4d6fd41

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+deps
+*~

data/CHANGELOG.markdown

@@ -0,0 +1,4 @@
+0.0.1
+------
+
+* Initial release!

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'epub-parser', path: '../epub-parser'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012, 2013 KITAITI Makoto
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,154 @@
+EPUB Maker
+==========
+
+This library supports making and editing EPUB books
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'epub-maker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install epub-maker
+
+Usage
+-----
+
+### Library ###
+
+    require 'epub/maker'
+    
+    EPUB::Maker.make path/to/generated/book.epub do |book|
+      book.make_ocf do |ocf|
+        ocf.make_container do |container|
+          container.make_rootfile full_path: 'OPS/content.opf'
+        end
+      end
+
+      book.make_package do |package|
+        package.dir = 'rtl'
+
+        package.make_metadata do |metadata|
+          metadata.title = 'Sample eBook'
+          metadata.language = 'ja'
+        end
+
+        package.make_manifest do |manifest|
+          Pathname.glob("#{@fixture_dir}/OPS/*.{xhtml,xml}").each_with_index do |content_path, index|
+            manifest.make_item do |item|
+              item.id = "item-#{index + 1}"
+              href = content_path.relative_path_from(@fixture_dir + File.dirname(book.rootfile_path))
+              item.href = Addressable::URI.parse(href.to_s)
+              item.media_type = case content_path.extname
+                                when '.xhtml' then 'application/xhtml+xml'
+                                when '.png' then 'image/png'
+                                end
+              item.content_file = (@fixture_dir + item.entry_name).to_path
+              item.properties << 'nav' if content_path.basename.to_path == 'nav.xhtml'
+            end
+          end
+
+          package.make_spine do |spine|
+            spine.page_progression_direction = 'rtl'
+
+            package.manifest.items.select(&:xhtml?).each do |item|
+              spine.make_itemref do |itemref|
+                itemref.item = item
+                itemref.linear = true
+              end
+            end
+          end
+        end
+      end
+    end
+
+For structure of EPUB book, see [EPUB Parser's documentation][epub-parser-doc].
+
+### Rake task ###
+
+**CAUTION**: Still work in progress. File path to require and API will be modified in the future.
+
+    require 'epub/maker/task'
+
+    DIR = 'path/to/dir/holding/contents'
+    EPUB::Maker::Task.new @epub_name do |task|
+      task.titles = ['EPUB Maker Rake Example']
+
+      task.base_dir = DIR
+
+      task.files.include "#{task.base_dir}/**/*"
+      task.files.exclude {|entry| ! File.file? entry}
+
+      task.rootfile = "#{DIR}/OPS/contents.opf"
+      task.make_rootfiles = true
+
+      task.resources = task.files.dup
+      task.resources.exclude /\.opf/
+      task.resources.exclude /META\-INF/
+
+      task.navs.include 'OPS/nav.xhtml'
+      task.media_types = {"#{DIR}/OPS/slideshow.xml" => 'application/x-demo-slideshow'}
+
+      task.spine = task.resources.dup
+      task.spine.exclude /OPS\/impl\.xhtml\z/
+      task.spine.exclude /\.xml\z/
+
+      task.bindings = {'application/x-demo-slideshow' => "#{DIR}/OPS/impl.xhtml"}
+    end
+
+### In-place editing
+
+    require 'epub/maker'
+    
+    book = EPUB::Parser.parse('path/to/book.epub')
+    book.resources.select(&:xhtml?).each do |item|
+      doc = item.content_document.nokogiri
+      title = doc/'title'
+      title.content += ' - Additional Title such like book title'
+      item.content = doc.to_xml
+      item.save
+    end
+
+Shortcut:
+
+    book.resources.select(&:xhtml?).each do |item|
+      item.edit_with_nokogiri do |doc| # Nokogiri::XML::Document is passed to block
+        doc.search('img').each do |img|
+          img['alt'] = '' if img['alt'].nil?
+        end
+      end # item.content = doc.to_xml is called automatically
+    end # item.save is called automatically
+
+For APIs of parsed EPUB book, see [EPUB Parser's documentation][epub-parser-doc].
+
+[epub-parser-doc]: http://rubydoc.info/gems/epub-parser/frames
+
+Requirements
+------------
+* Ruby 2.0 or later
+* C compiler to build zipruby and Nokogiri gems
+
+Todo
+----
+* Refine Rake task
+
+Recent Changes
+--------------
+### 0.0.1
+* Initial release!
+
+Contributing
+------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake/testtask'
+require 'rake/clean'
+require 'yard'
+require "bundler/gem_tasks"
+
+task :default => :test
+
+CLEAN.include 'README.html'
+
+Rake::TestTask.new
+YARD::Rake::YardocTask.new

data/bin/epub-maker

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

data/epub-maker.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'epub/maker/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "epub-maker"
+  gem.version       = EPUB::Maker::VERSION
+  gem.authors       = ["KITAITI Makoto"]
+  gem.email         = ["KitaitiMakoto@gmail.com"]
+  gem.description   = %q{This library supports making and editing EPUB books}
+  gem.summary       = %q{EPUB Maker}
+  gem.homepage      = ""
+
+  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"'
+  gem.files.push('test/fixtures/book/OPS/ルートファイル.opf')
+  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.add_runtime_dependency 'zipruby'
+  gem.add_runtime_dependency 'epub-parser', '>= 0.1.5'
+  gem.add_runtime_dependency 'pathname-common_prefix'
+  gem.add_runtime_dependency 'mime-types'
+  gem.add_runtime_dependency 'ruby-uuid'
+  gem.add_runtime_dependency 'archive-zip'
+  gem.add_runtime_dependency 'rake'
+
+  gem.add_development_dependency 'test-unit-full'
+  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

@@ -0,0 +1,113 @@
+require 'pathname'
+require 'pathname/common_prefix'
+require 'fileutils'
+require 'tmpdir'
+require 'time'
+require 'uuid'
+require 'archive/zip'
+require 'epub'
+require 'epub/constants'
+require 'epub/book'
+require 'epub/parser'
+require "epub/maker/version"
+require 'epub/maker/ocf'
+require 'epub/maker/publication'
+require 'epub/maker/content_document'
+
+module EPUB
+  module Maker
+    class << self
+      # @param path [Pathname|#to_path|String]
+      # @todo Add option whether mv blocks or not when file locked already
+      # @todo Timeout when file shared-locked long time
+      def make(path)
+        path = Pathname(path) unless path.kind_of? Pathname
+        book = EPUB::Book.new
+        Pathname.mktmpdir 'epub-maker' do |dir|
+          temp_path = dir/path.basename
+          mimetype = dir/'mimetype'
+          mimetype.write EPUB::MediaType::EPUB
+          Archive::Zip.open temp_path.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
+
+          Zip::Archive.open temp_path.to_path do |archive|
+            yield book if block_given?
+            book.save archive
+          end
+
+          path.open 'wb' do |file|
+            raise "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
+        end
+        book
+
+        # validate
+        # build_xml
+        # archive
+      end
+    end
+  end
+
+  def make_ocf
+    self.ocf = OCF.new
+    ocf.make do |ocf|
+      yield ocf if block_given?
+    end
+    ocf
+  end
+
+  def make_package
+    self.package = Publication::Package.new
+    package.make do |package|
+      yield package if block_given?
+    end
+    package
+  end
+
+  # @param archive [Zip::Archive]
+  def save(archive)
+    ocf.save archive
+    package.save archive
+    resources.each do |item|
+      item.save archive
+    end
+  end
+end
+
+class Pathname
+  class << self
+    # @overload mktmpdir(prefix_suffix=nil, tmpdir=nil)
+    #   @param prefix_suffix [String|nil] see Dir.mktmpdir
+    #   @param tmpdir [String|nil] see Dir.mktmpdir
+    #   @return [Pathname] path to temporary directory
+    # @overload mktmpdir(prefix_suffix=nil, tmpdir=nil)
+    #   @param prefix_suffix [String|nil] see Dir.mktmpdir
+    #   @param tmpdir [String|nil] see Dir.mktmpdir
+    #   @yieldparam dir [Pathname] path to temporary directory
+    #   @return value of given block
+    def mktmpdir(prefix_suffix=nil, tmpdir=nil)
+      if block_given?
+        Dir.mktmpdir prefix_suffix, tmpdir do |dir|
+          yield new(dir)
+        end
+      else
+        new(Dir.mktmpdir(prefix_suffix, tmpdir))
+      end
+    end
+  end
+
+  def write(string, mode='w', perm=0666)
+    open mode, perm do |file|
+      file << string
+    end
+  end
+
+  def remove_entry_secure
+    FileUtils.remove_entry_secure to_path
+  end
+
+  alias / +
+end

data/lib/epub/maker/content_document.rb

@@ -0,0 +1,36 @@
+require 'epub/content_document'
+
+module EPUB
+  module ContentDocument
+    class Navigation
+      def to_xml(options={:encoding => 'UTF-8'})
+        Nokogiri::XML::Builder.new(options) {|xml|
+          xml.html('xmlns' => EPUB::NAMESPACES['xhtml'], 'xmlns:epub' => EPUB::NAMESPACES['epub']) {
+            xml.head {
+              xml.title_ 'Table of Contents'
+            }
+            xml.body {
+              navigations.each do |navigation|
+                xml.nav_('epub:type' => navigation.type) {
+                  unless navigation.items.empty?
+                    xml.ol {
+                      navigation.items.each do |item|
+                        xml.li {
+                          if item.href
+                            xml.a item.text, 'href' => item.href
+                          else
+                            xml.span_ item.text
+                          end
+                        }
+                      end
+                    }
+                  end
+                }
+              end
+            }
+          }
+        }.to_xml
+      end
+    end
+  end
+end

data/lib/epub/maker/ocf.rb

@@ -0,0 +1,60 @@
+require 'epub/ocf'
+
+# @todo Use refinement
+module EPUB
+  class OCF
+    DIRECTORY = 'META-INF'
+
+    def make
+      yield self if block_given?
+      self
+    end
+
+    # @param archive [Zip::Archive] path to archive file
+    def save(archive)
+      self.container.save archive if self.container
+    end
+
+    # @overload make_container
+    #   @return [Container]
+    # @overload make_container
+    #   @return [Container]
+    #   @yield [container] if block given
+    #   @yieldparam [Container]
+    def make_container
+      self.container = Container.new
+      yield container if block_given?
+      container
+    end
+
+    class Container
+      def to_xml(options={:encoding => 'UTF-8'})
+        Nokogiri::XML::Builder.new(options) {|xml|
+          xml.container('xmlns' => EPUB::NAMESPACES['ocf'], 'version' => '1.0') {
+            xml.rootfiles {
+              rootfiles.each do |rootfile|
+                xml.rootfile('full-path' => rootfile.full_path,
+                             'media-type' => rootfile.media_type)
+              end
+            }
+          }
+        }.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
+      def make_rootfile(full_path: nil, media_type: EPUB::MediaType::ROOTFILE)
+        rootfile = Rootfile.new(full_path, media_type)
+        @rootfiles << rootfile
+        yield rootfile if block_given?
+        rootfile
+      end
+    end
+  end
+end