epub-maker 0.0.1

data/test/schemas/ocf-container-30.rnc

@@ -0,0 +1,16 @@
+
+   default namespace = "urn:oasis:names:tc:opendocument:xmlns:container"
+   include "./mod/datatypes.rnc"
+
+   start = ocf.container
+      
+   ocf.container = element container {
+      attribute version { '1.0' } & 
+      element rootfiles {
+         element rootfile {
+            attribute full-path { datatype.URI } &
+            attribute media-type { 'application/oebps-package+xml' }
+         }+
+      }
+   }
+   

data/test/test_inplace_editing.rb

@@ -0,0 +1,62 @@
+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
+    @book = EPUB::Parser.parse(@file)
+  end
+
+  def teardown
+    (@assets_dir/'mimetype').rmtree
+    @dir.remove_entry_secure if @dir.exist?
+  end
+
+  def test_save_parsed_book
+    nav = @book.nav
+    doc = nav.content_document.nokogiri
+    title = doc.search('title').first
+    title.content = 'Edited Title'
+    nav.content = doc.to_xml
+    nav.save
+
+    assert_match '<title>Edited Title</title>', nav.read
+  end
+
+  def test_edit
+    item = @book.resources.find(&:xhtml?)
+    item.edit do
+      doc = Nokogiri.XML(item.read)
+      title = doc.search('title').first
+      title.content = 'Edited Title'
+      item.content = doc.to_xml
+    end
+
+    assert_match '<title>Edited Title</title>', item.read
+  end
+
+  def test_edit_with_rexml
+    require 'rexml/quickpath'
+    item = @book.resources.find(&:xhtml?)
+    item.edit_with_rexml do |doc|
+      title = REXML::QuickPath.first(doc, '//title')
+      title.text = 'Edited Title'
+    end
+
+    assert_match '<title>Edited Title</title>', item.read
+  end
+
+  def test_edit_with_nokogiri
+    item = @book.resources.find(&:xhtml?)
+    item.edit_with_nokogiri do |doc|
+      title = doc.search('title').first
+      title.content = 'Edited Title'
+    end
+
+    assert_match '<title>Edited Title</title>', item.read
+  end
+end

data/test/test_maker.rb

@@ -0,0 +1,66 @@
+# -*- coding: utf-8 -*-
+require_relative 'helper'
+require 'tmpdir'
+require 'fileutils'
+require 'epub/maker'
+
+class TestMaker < Test::Unit::TestCase
+  def setup
+    @fixture_dir = Pathname(__dir__) + 'fixtures' + 'book'
+    @dir = Pathname.mktmpdir('epub-maker-test')
+    @file = @dir + 'book.epub'
+  end
+
+  def teardown
+    @dir.remove_entry_secure if @dir.exist?
+  end
+
+  def test_make
+    EPUB::Maker.make @file do |book|
+      book.make_ocf do |ocf|
+        ocf.make_container do |container|
+          container.make_rootfile full_path: Addressable::URI.parse('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 '.xml' then 'application/xml'
+                                end
+              item.content_file = (@fixture_dir + item.entry_name).to_path
+              item.properties << 'nav' if content_path.basename.to_path == 'nav.xhtml'
+              item.properties << 'scripted' if content_path.basename.to_path == 'impl.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
+
+    assert_valid_epub @file.to_path
+  end
+end

data/test/test_maker_ocf.rb

@@ -0,0 +1,61 @@
+require_relative 'helper'
+require 'nokogiri'
+require 'epub/constants'
+require 'epub/maker/ocf'
+
+class TestMakerOCF < Test::Unit::TestCase
+  def setup
+    @container = EPUB::OCF::Container.new
+  end
+
+  def test_make_container_returns_container_object
+    ocf = EPUB::OCF.new
+    assert_kind_of EPUB::OCF::Container, ocf.make_container
+  end
+
+  def test_make_container_yields_container_object
+    ocf = EPUB::OCF.new
+    ocf.make_container do |container|
+      assert_kind_of EPUB::OCF::Container, container
+    end
+  end
+
+  def test_container_make_container_yeilds_is_a_container_of_the_ocf
+    ocf = EPUB::OCF.new
+    container = ocf.make_container
+    assert_same ocf.container, container
+  end
+
+  class TestMakerContainer < TestMakerOCF
+    def test_to_xml
+      rootfile = EPUB::OCF::Container::Rootfile.new
+      rootfile.full_path = 'OPS/contents.opf'
+      rootfile.media_type = 'application/oebps-package+xml'
+      @container.rootfiles << rootfile
+      expected = Nokogiri.XML(<<EOC)
+<?xml version="1.0" encoding="UTF-8"?>
+<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
+  <rootfiles>
+    <rootfile full-path="OPS/contents.opf" media-type="application/oebps-package+xml" />
+  </rootfiles>
+</container>
+EOC
+      assert_equal expected.to_s, Nokogiri.XML(@container.to_xml).to_s
+    end
+
+    def test_make_rootfile_returnes_rootfile_object
+      assert_kind_of EPUB::OCF::Container::Rootfile, @container.make_rootfile
+    end
+
+    def test_make_rootfile_yields_rootfile_object
+      @container.make_rootfile do |rootfile|
+        assert_kind_of EPUB::OCF::Container::Rootfile, rootfile
+      end
+    end
+
+    def test_rootfile_make_rootfile_yields_is_a_rootfile_of_the_container
+      rootfile = @container.make_rootfile
+      assert_include @container.rootfiles, rootfile
+    end
+  end
+end

data/test/test_maker_publication.rb

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+require_relative 'helper'
+require 'epub/parser'
+require 'epub/maker/publication'
+
+class TestMakerPublication < Test::Unit::TestCase
+  def setup
+    rootfile = 'OPS/ルートファイル.opf'
+    @opf = File.read(File.expand_path("../fixtures/book/#{rootfile}", __FILE__))
+    @package = EPUB::Parser::Publication.new(@opf, rootfile).parse
+  end
+
+  def test_to_xml_attribute
+    doc = Nokogiri.XML(@package.to_xml)
+
+    identifier = doc.xpath('/opf:package/opf:metadata/dc:identifier', EPUB::NAMESPACES).first
+    assert_equal 'pub-id', identifier['id']
+
+    meta = doc.xpath('/opf:package/opf:metadata/opf:meta[@scheme]', EPUB::NAMESPACES).first
+    assert_equal 'marc:relators', meta['scheme']
+
+    link = doc.xpath('/opf:package/opf:metadata/opf:link[@refines]', EPUB::NAMESPACES).first
+    assert_equal 'http://example.org/onix/12389347', link['href']
+
+    manifest = doc.xpath('/opf:package/opf:manifest', EPUB::NAMESPACES).first
+    assert_equal 'manifest-id', manifest['id']
+
+    item = doc.xpath('/opf:package/opf:manifest/opf:item[@id="nav"]', EPUB::NAMESPACES).first
+    assert_equal 'application/xhtml+xml', item['media-type']
+
+    spine = doc.xpath('/opf:package/opf:spine', EPUB::NAMESPACES).first
+    assert_equal 'spine-id', spine['id']
+
+    itemref = doc.xpath('/opf:package/opf:spine/opf:itemref', EPUB::NAMESPACES).first
+    assert_equal 'cover', itemref['idref']
+
+    media_type = doc.xpath('/opf:package/opf:bindings/opf:mediaType', EPUB::NAMESPACES).first
+    assert_equal 'application/x-demo-slideshow', media_type['media-type']
+  end
+end

data/test/test_task.rb

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+require_relative 'helper'
+require 'epub/maker/task'
+
+class TestTask < Test::Unit::TestCase
+  def setup
+    @base_dir = File.join(__dir__, 'fixtures', 'book')
+    @epub_name = File.join(__dir__, 'fixtures', 'book.epub')
+    FileUtils::Verbose.rm @epub_name if File.exist? @epub_name
+
+    @task = EPUB::Maker::Task.new @epub_name do |task|
+      task.titles = ['EPUB Maker Rake Example'] # temporary
+
+      task.base_dir = @base_dir
+
+      task.files.include "#{@base_dir}/**/*"
+      task.files.exclude {|entry| ! File.file? entry}
+
+      task.rootfile = "#{@base_dir}/OPS/ルートファイル.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 = {"#{@base_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' => "#{@base_dir}/OPS/impl.xhtml"}
+    end
+  end
+
+  def test_execute
+    Rake::Task[:epub].execute
+    assert_path_exist @epub_name
+    assert_valid_epub @epub_name
+  end
+
+  def test_file_map
+    expected = {
+      File.join(@base_dir, 'META-INF/container.xml')  => 'META-INF/container.xml',
+      File.join(@base_dir, 'OPS/ルートファイル.opf')  => 'OPS/ルートファイル.opf',
+      File.join(@base_dir, 'OPS/item-1.xhtml')        => 'OPS/item-1.xhtml',
+      File.join(@base_dir, 'OPS/item-2.xhtml')        => 'OPS/item-2.xhtml',
+      File.join(@base_dir, 'OPS/nav.xhtml')           => 'OPS/nav.xhtml',
+      File.join(@base_dir, 'OPS/impl.xhtml')          => 'OPS/impl.xhtml',
+      File.join(@base_dir, 'OPS/slideshow.xml')       => 'OPS/slideshow.xml'
+    }
+
+    assert_equal expected, @task.file_map
+  end
+end

metadata

@@ -0,0 +1,333 @@
+--- !ruby/object:Gem::Specification
+name: epub-maker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- KITAITI Makoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-19 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
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+- !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: mime-types
+  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: ruby-uuid
+  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: archive-zip
+  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: rake
+  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: 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
+  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
+  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: simplecov
+  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: pry
+  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: pry-doc
+  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: yard
+  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: redcarpet
+  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: gem-man
+  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: ronn
+  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'
+description: This library supports making and editing EPUB books
+email:
+- KitaitiMakoto@gmail.com
+executables:
+- epub-maker
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.markdown
+- Gemfile
+- 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/publication.rb
+- lib/epub/maker/task.rb
+- lib/epub/maker/version.rb
+- test/fixtures/book/META-INF/container.xml
+- test/fixtures/book/OPS/impl.xhtml
+- test/fixtures/book/OPS/item-1.xhtml
+- test/fixtures/book/OPS/item-2.xhtml
+- test/fixtures/book/OPS/nav.xhtml
+- test/fixtures/book/OPS/slideshow.xml
+- test/helper.rb
+- test/make_task.rake
+- test/schemas/epub-nav-30.rnc
+- test/schemas/epub-nav-30.sch
+- test/schemas/epub-xhtml-30.sch
+- test/schemas/ocf-container-30.rnc
+- test/test_inplace_editing.rb
+- test/test_maker.rb
+- test/test_maker_ocf.rb
+- test/test_maker_publication.rb
+- test/test_task.rb
+- test/fixtures/book/OPS/ルートファイル.opf
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: EPUB Maker
+test_files:
+- test/fixtures/book/META-INF/container.xml
+- test/fixtures/book/OPS/impl.xhtml
+- test/fixtures/book/OPS/item-1.xhtml
+- test/fixtures/book/OPS/item-2.xhtml
+- test/fixtures/book/OPS/nav.xhtml
+- test/fixtures/book/OPS/slideshow.xml
+- test/helper.rb
+- test/make_task.rake
+- test/schemas/epub-nav-30.rnc
+- test/schemas/epub-nav-30.sch
+- test/schemas/epub-xhtml-30.sch
+- test/schemas/ocf-container-30.rnc
+- test/test_inplace_editing.rb
+- test/test_maker.rb
+- test/test_maker_ocf.rb
+- test/test_maker_publication.rb
+- test/test_task.rb
+- test/fixtures/book/OPS/ルートファイル.opf
+has_rdoc: