epub-directory 0.1.0

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2018-10-21
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'kramdown'
+end
+
+group :test do
+  if RUBY_PLATFORM.match /darwin/
+    gem 'terminal-notifier'
+  end
+end

data/README.md

@@ -0,0 +1,57 @@
+# EPUB Directory
+
+* [Homepage](https://rubygems.org/gems/epub-directory)
+* [Documentation](http://rubydoc.info/gems/epub-directory/frames)
+* [Email](mailto:KitaitiMakoto at gmail.com)
+
+## Description
+
+Builds EPUB directory static site from EPUB files, package documents or Web Publication manifests.
+
+## Features
+
+* Registers EPUB information into `src` directory.
+* Builds static EPUB directory site to `build` directory.
+
+## Examples
+
+    require 'epub/directory'
+
+## Requirements
+
+## Install
+
+    $ gem install epub-directory
+
+## Synopsis
+
+### Registering EPUB info
+
+    $ epub-directory path/to/document.epub
+
+This command makes `src` directory, registers under it, and then build EPUB directory site.
+
+### Build EPUB directory site
+
+    $ epub-directory
+
+This command builds EPUB directory site to `build` directory.
+
+## Copyright
+
+#
+# Copyright (c) 2018 Kitaiti Makoto
+#
+# EPUB Directory is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# EPUB Directory is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with EPUB Directory.  If not, see <http://www.gnu.org/licenses/>.
+#

data/Rakefile

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler/setup'
+rescue LoadError => e
+  abort e.message
+end
+
+require 'rake'
+
+task :default => :test
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+task :test => ["test/fixtures/wasteland.epub"]
+
+directory "test/fixtures"
+
+require "open-uri"
+file "test/fixtures/wasteland.epub" => "test/fixtures" do |t|
+  open "https://github.com/IDPF/epub3-samples/releases/download/20170606/wasteland.epub" do |f|
+    File.write t.name, f.read
+  end
+end
+
+require 'yard'
+YARD::Rake::YardocTask.new  
+task :doc => :yard

data/bin/epub-directory

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+root = File.expand_path(File.join(File.dirname(__FILE__),'..'))
+if File.directory?(File.join(root,'.git'))
+  Dir.chdir(root) do
+    begin
+      require 'bundler/setup'
+    rescue LoadError => e
+      warn e.message
+      warn "Run `gem install bundler` to install Bundler"
+      exit -1
+    end
+  end
+end
+
+require "epub/directory"
+
+def main(argv)
+  EPUB::Directory.run argv
+end
+
+main(ARGV)

data/epub-directory.gemspec

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'epub/directory/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "epub-directory"
+  gem.version       = EPUB::Directory::VERSION
+  gem.summary       = %q{EPUB directory builder}
+  gem.description   = %q{Builds EPUB directory static site from EPUB files, package documents or Web Publication manifests.}
+  gem.license       = "AGPL"
+  gem.authors       = ["KITAITI Makoto"]
+  gem.email         = "KitaitiMakoto@gmail.com"
+  gem.homepage      = "https://rubygems.org/gems/epub-directory"
+
+  gem.files         = `git ls-files`.split($/)
+
+  `git submodule --quiet foreach --recursive pwd`.split($/).each do |submodule|
+    submodule.sub!("#{Dir.pwd}/",'')
+
+    Dir.chdir(submodule) do
+      `git ls-files`.split($/).map do |subpath|
+        gem.files << File.join(submodule,subpath)
+      end
+    end
+  end
+  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.add_development_dependency "epub-parser"
+  gem.add_development_dependency "tomlrb"
+  gem.add_development_dependency "haml"
+  gem.add_development_dependency "rss-opds"
+
+  gem.add_development_dependency 'bundler', '~> 1.10'
+  gem.add_development_dependency 'rake', '~> 10.0'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+  gem.add_development_dependency 'yard', '~> 0.8'
+  gem.add_development_dependency "test-unit"
+  gem.add_development_dependency "test-unit-notify"
+end

data/lib/epub/directory.rb

@@ -0,0 +1,139 @@
+require 'epub/directory/version'
+require "epub/parser"
+require "pathname"
+require "rss/opds"
+require "haml"
+
+module EPUB
+  class Directory
+    SRC_DIR = Pathname.new("src")
+    DEST_DIR = Pathname.new("build")
+
+    class << self
+      def run(paths)
+        paths.each do |path|
+          add path
+        end
+        build
+      end
+
+      def add(path)
+        EPUB::Parser.parse(path).renditions.each do |rendition|
+          add_rendition rendition
+        end
+      end
+
+      def build
+        new.build
+      end
+
+      def add_rendition(rendition)
+        Rendition.add rendition
+      end
+    end
+
+    def build
+      DEST_DIR.mkpath
+      Pathname.glob("#{SRC_DIR}/**/*.opf").each do |opf_path|
+        make_destination_directory opf_path
+        build_opf opf_path
+        build_html opf_path
+        build_opds opf_path
+      end
+    end
+
+    def make_destination_directory(opf_path)
+      dest_path = opf_path.to_path.sub(SRC_DIR.to_path, DEST_DIR.to_path)
+      dest_path = Pathname.new(dest_path)
+      dest_path.dirname.mkpath
+    end
+
+    def build_opf(opf_path)
+      dest_path = opf_path.to_path.sub(SRC_DIR.to_path, DEST_DIR.to_path)
+      dest_path = Pathname.new(dest_path)
+      dest_path.write opf_path.read
+    end
+
+    def build_html(opf_path)
+      dest_path = opf_path.sub_ext(".html").to_path.sub(SRC_DIR.to_path, DEST_DIR.to_path)
+      dest_path = Pathname.new(dest_path)
+      rendition = EPUB::Parser::Publication.new(opf_path.read).parse
+      metadata = rendition.metadata
+      page_title = "Information on EPUB Rendition with Release Identifier #{metadata.release_identifier}"
+      template_path = File.join(__dir__, "../../templates/release-identifier.haml")
+      engine = Haml::Engine.new(File.read(template_path))
+      engine.options[:format] = :html5
+      dest_path.write engine.render(binding)
+    end
+
+    def build_opds(opf_path)
+      dest_path = opf_path.sub_ext(".opds").to_path.sub(SRC_DIR.to_path, DEST_DIR.to_path)
+      dest_path = Pathname.new(dest_path)
+      rendition = EPUB::Parser::Publication.new(opf_path.read).parse
+      opds = RSS::Maker.make("atom:entry") {|maker|
+        maker.items.new_item do |entry|
+          entry.id = rendition.metadata.release_identifier
+          entry.updated = rendition.metadata.modified.to_s
+          entry.title = rendition.metadata.title
+          # TODO: Filter authors by refines
+          rendition.metadata.creators.each do |creator|
+            entry.authors.new_author do |author|
+              author.name = creator.to_s
+            end
+          end
+          entry.summary = rendition.metadata.description
+          entry.links.new_link do |link|
+            link.rel = RSS::OPDS::RELATIONS["acquisition"] # TODO: Arrange by info.toml
+            link.href = dest_path.basename.sub_ext(".epub").to_path # TODO: Arrange by info.toml
+            link.type = "application/epub+zip"
+          end
+        end
+      }
+      dest_path.write opds
+    end
+
+    def build_json(opf_path)
+      raise NotImplementedError
+    end
+
+    class Rendition
+      class << self
+        def add(rendition)
+          new(rendition).add
+        end
+      end
+
+      def initialize(rendition)
+        @rendition = rendition
+      end
+
+      def add
+        make_source_directory
+        add_package_document
+      end
+
+      private
+
+      def book
+        @rendition.book
+      end
+
+      def source_directory
+        SRC_DIR/@rendition.unique_identifier.to_s
+      end
+
+      def source_path
+        source_directory/"#{@rendition.metadata.modified}.opf"
+      end
+
+      def make_source_directory
+        source_directory.mkpath
+      end
+
+      def add_package_document
+        package_xml = book.container_adapter.read(book.epub_file, @rendition.full_path.to_s)
+        source_path.write package_xml
+      end
+    end
+  end
+end

data/lib/epub/directory/version.rb

@@ -0,0 +1,23 @@
+#
+# Copyright (c) 2018 KITAITI Makoto (KitaitiMakoto at gmail.com)
+#
+# epub-directory is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# epub-directory is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with epub-directory.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+module EPUB
+  class Directory
+    # epub-directory version
+    VERSION = "0.1.0"
+  end
+end

data/templates/release-identifier.haml

@@ -0,0 +1,37 @@
+!!! 5
+%meta{charset: "UTF-8"}
+%title= page_title
+%link{rel: "alternate", href: "#{metadata.modified}.opds", type: RSS::OPDS::TYPES["acquisition"]}
+%h1= page_title
+%dl
+  - metadata.to_h.each_pair do |prop, elems|
+    - case prop
+    - when :titles
+      %dt Title
+      %dd= elems.join(" ")
+    - else
+      %dt= prop.capitalize
+      - if elems.empty?
+        %dd N/A
+      - else
+        - elems.each do |elem|
+          - if elem == metadata.unique_identifier
+            %dd= elem.to_s + "(Unique Identifier)"
+          - else
+            %dd= elem
+  - metadata.primary_metas.each do |meta|
+    - if meta == metadata.modified
+      %dt Modified
+      %dd
+        %time= meta
+    - else
+      %dt= meta.property
+      %dd= meta
+  %dt EPUB Version
+  %dd= rendition.version
+  %dt OPF
+  %dd
+    %a{href: "#{metadata.modified}.opf"} #{metadata.modified}.opf
+  %dt OPDS Catalog Entry
+  %dd
+    %a{href: "#{metadata.modified}.opds"} #{metadata.modified}.opds

data/test/fixtures/wasteland.html

@@ -0,0 +1,54 @@
+<!DOCTYPE html>
+<title>Information on EPUB Rendition with Release Identifier code.google.com.epub-samples.wasteland-basic@2012-01-18T12:47:00Z</title>
+<h1>Information on EPUB Rendition with Release Identifier code.google.com.epub-samples.wasteland-basic@2012-01-18T12:47:00Z</h1>
+<link href='2012-01-18T12:47:00Z.opds' rel='alternative' type='application/atom+xml;profile=opds-catalog;kind=acquisition'>
+<dl>
+<dt>Identifiers</dt>
+<dd>code.google.com.epub-samples.wasteland-basic(Unique Identifier)</dd>
+<dt>Title</dt>
+<dd>The Waste Land</dd>
+<dt>Languages</dt>
+<dd>en-US</dd>
+<dt>Contributors</dt>
+<dd>N/A</dd>
+<dt>Coverages</dt>
+<dd>N/A</dd>
+<dt>Creators</dt>
+<dd>T.S. Eliot</dd>
+<dt>Dates</dt>
+<dd>2011-09-01</dd>
+<dt>Descriptions</dt>
+<dd>N/A</dd>
+<dt>Formats</dt>
+<dd>N/A</dd>
+<dt>Publishers</dt>
+<dd>N/A</dd>
+<dt>Relations</dt>
+<dd>N/A</dd>
+<dt>Rights</dt>
+<dd>This work is shared with the public using the Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0) license.</dd>
+<dt>Sources</dt>
+<dd>N/A</dd>
+<dt>Subjects</dt>
+<dd>N/A</dd>
+<dt>Types</dt>
+<dd>N/A</dd>
+<dt>Modified</dt>
+<dd>
+<time>2012-01-18T12:47:00Z</time>
+</dd>
+<dt>cc:attributionURL</dt>
+<dd>http://code.google.com/p/epub-samples/</dd>
+<dt></dt>
+<dd></dd>
+<dt>EPUB Version</dt>
+<dd>3.0</dd>
+<dt>OPF</dt>
+<dd>
+<a href='2012-01-18T12:47:00Z.opf'>2012-01-18T12:47:00Z.opf</a>
+</dd>
+<dt>OPDS Catalog Entry</dt>
+<dd>
+<a href='2012-01-18T12:47:00Z.opds'>2012-01-18T12:47:00Z.opds</a>
+</dd>
+</dl>

data/test/fixtures/wasteland.opds

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<entry xmlns="http://www.w3.org/2005/Atom"
+  xmlns:dc="http://purl.org/dc/elements/1.1/"
+  xmlns:dcterms="http://purl.org/dc/terms/"
+  xmlns:fh="http://purl.org/syndication/history/1.0"
+  xmlns:opds="http://opds-spec.org/2010/catalog">
+  <author>
+    <name>T.S. Eliot</name>
+  </author>
+  <id>code.google.com.epub-samples.wasteland-basic@2012-01-18T12:47:00Z</id>
+  <link href="2012-01-18T12:47:00Z.epub"
+    rel="http://opds-spec.org/acquisition"
+    type="application/epub+zip"/>
+  <summary></summary>
+  <title>The Waste Land</title>
+  <updated>2012-01-18T12:47:00Z</updated>
+  <dc:date>2012-01-18T12:47:00Z</dc:date>
+  <dcterms:date>2012-01-18T12:47:00Z</dcterms:date>
+</entry>