ebookbinder 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e84bb03efbd7cc1485383c90b47e60fbe9e61f711b5dcd19f016372433c08b00
-  data.tar.gz: 43a1abc9fde8c47f9d8cd50f8829f490f249381240bbf7e772a7d7377c7d92c3
+  metadata.gz: bf3679fa9fe0db4a7f242b7defb30fd07f3217ffd3e4ffcbec1a842e30ced7fa
+  data.tar.gz: 28b58dec10fae2974d4a6bee7068a02d4154bedcc2924a2a9594f11d6740fa05
 SHA512:
-  metadata.gz: be92f5553c6ff6417c4d2bafe8e8b487cbc9084f7721f647e8de787d354c9816a3dd81a44bf322231de57c84881a42a084b0d7460764dd622436842edc4cac30
-  data.tar.gz: 388f22704f7770c26881542c3fe53d97ef58a5cd9e851e74382441ce26dca73c599048532b06ec704f60caee3e1202bd6ee2479fcbd05793cb20f6c3685667f3
+  metadata.gz: a2c97daecd67e300a6c1f2b8082d0c12b66d6c135c234eb498b126970a2b40701fdbc09b411f780cb43cfd5b0805a681b71383d9c7e4cbae0b95afed88330b0c
+  data.tar.gz: 2859f0a4ad5488ca9c7c7637ea3443059e685993ff1a4768a57cad714385720c8218789cf235c29f9256afeec0c72f619bb4d27a8e7eae909cd1efb728346309

data/.aspell.pws

@@ -0,0 +1,10 @@
+personal_ws-1.1 en 9 
+Ebookbinder
+Friedrich
+SemVer
+SemVerTag
+XHTML
+ebook
+ebooks
+epubcheck
+regtest

data/Changelog

@@ -1,2 +1,5 @@
+1.0.1
+Improve repository structure and add regtest.
+
 1.0.0
 First public release.

data/README.md

@@ -4,14 +4,20 @@
 ## Description
 
 This library should help to make ebooks as easy as possible.  It interprets an
-XHTML structure and generate a corresponding ebook on base of easy asumptions.
+XHTML structure and generate a corresponding ebook on base of easy assumptions.
+
+
+## Usage
+
+To understand how Ebookbinder works have a look at the examples directory.
+There are examples of the actual implemented functionality.
 
 
 ## Requirements
 
 To use rake check it needs an actual version of
 [epubcheck](https://www.w3.org/publishing/epubcheck/) accessible on the
-commandline via `epubcheck`.
+command line via `epubcheck`.
 
 
 ## Versioning

data/Rakefile

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require 'rim/tire'
+require 'rim/regtest'
 require 'rim/version'
 require_relative 'lib/ebookbinder/version'
 
@@ -8,7 +9,20 @@ Rim.setup do |r|
   r.name = 'ebookbinder'
   r.authors = 'Jan Friedrich'
   r.email = 'janfri26@gmail.com'
+  r.homepage = 'https://github.com/janfri/ebookbinder'
+  r.license = 'MIT'
+  r.summary = 'This library should help to make ebooks as easy as possible. It interprets an XHTML structure and generate a corresponding ebook on base of easy asumptions.'
   r.version = Ebookbinder::VERSION
-  r.gem_files.exclude(/build/).exclude {|e| File.directory?(e)}
-  r.test_files = FileList.new()
+  r.install_message = %q{
++-----------------------------------------------------------------------+
+| To run rake check you need epubcheck installed and accessible via     |
+| `epubcheck` on the command line.                                      |
+|                                                                       |
+| https://www.w3.org/publishing/epubcheck/                              |
++-----------------------------------------------------------------------+
+  }
+  r.gem_files += FileList.new('examples/*/Rakefile', 'examples/*/src/**/*.*')
 end
+
+task :test => :regtest
+task :default => :regtest

data/ebookbinder.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-# stub: ebookbinder 1.0.0 ruby lib
+# stub: ebookbinder 1.0.1 ruby lib
 #
 # This file is automatically generated by rim.
 # PLEASE DO NOT EDIT IT DIRECTLY!
@@ -7,20 +7,24 @@
 
 Gem::Specification.new do |s|
   s.name = "ebookbinder"
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Jan Friedrich"]
-  s.date = "2024-03-02"
+  s.date = "2024-03-05"
   s.description = ""
   s.email = "janfri26@gmail.com"
-  s.files = ["Changelog", "Gemfile", "LICENSE", "README.md", "Rakefile", "ebookbinder.gemspec", "lib/ebookbinder.rb", "lib/ebookbinder/ebook_base.rb", "lib/ebookbinder/epub2.rb", "lib/ebookbinder/epub3.rb", "lib/ebookbinder/epub_base.rb", "lib/ebookbinder/version.rb", "test/epub2/Rakefile", "test/epub2/src/01.xhtml", "test/epub2/src/02.xhtml", "test/epub3/Rakefile", "test/epub3/src/01.xhtml", "test/epub3/src/02.xhtml"]
+  s.files = ["./.aspell.pws", "Changelog", "Gemfile", "LICENSE", "README.md", "Rakefile", "ebookbinder.gemspec", "examples/epub2/Rakefile", "examples/epub2/src/01.xhtml", "examples/epub2/src/02.xhtml", "examples/epub3/Rakefile", "examples/epub3/src/01.xhtml", "examples/epub3/src/02.xhtml", "lib/ebookbinder", "lib/ebookbinder.rb", "lib/ebookbinder/ebook_base.rb", "lib/ebookbinder/epub2.rb", "lib/ebookbinder/epub3.rb", "lib/ebookbinder/epub_base.rb", "lib/ebookbinder/version.rb", "regtest/epub2.rb", "regtest/epub2.yml", "regtest/epub3.rb", "regtest/epub3.yml"]
+  s.homepage = "https://github.com/janfri/ebookbinder"
+  s.licenses = ["MIT"]
+  s.post_install_message = "\n+-----------------------------------------------------------------------+\n| To run rake check you need epubcheck installed and accessible via     |\n| `epubcheck` on the command line.                                      |\n|                                                                       |\n| https://www.w3.org/publishing/epubcheck/                              |\n+-----------------------------------------------------------------------+\n  "
   s.rubygems_version = "3.6.0.dev"
-  s.summary = ""
+  s.summary = "This library should help to make ebooks as easy as possible. It interprets an XHTML structure and generate a corresponding ebook on base of easy asumptions."
 
   s.specification_version = 4
 
   s.add_development_dependency(%q<rake>, [">= 0"])
   s.add_development_dependency(%q<rim>, ["~> 2.17"])
+  s.add_development_dependency(%q<regtest>, ["~> 2"])
 end

data/lib/ebookbinder/ebook_base.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 require_relative '../ebookbinder'
-
-require 'rake/clean'
 require 'singleton'
 
 module Ebookbinder

data/lib/ebookbinder/epub2.rb

@@ -52,6 +52,7 @@ module Ebookbinder
     end
 
     def generate_ncx_file
+      puts "generate #{ncx_filename}" if verbose
       builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
         xml.ncx(xmlns: 'http://www.daisy.org/z3986/2005/ncx/', version: '2005-1') do
           xml.head do
@@ -128,7 +129,7 @@ module Ebookbinder
         root = Dir.pwd
         epub_filename_fullpath = File.join(root, epub_filename)
         cd epub_dir do
-          sh "zip -Xr9D \"#{epub_filename_fullpath}\" mimetype *"
+          sh "zip -Xqr9D \"#{epub_filename_fullpath}\" mimetype *"
         end
       end
 

data/lib/ebookbinder/epub3.rb

@@ -53,7 +53,7 @@ module Ebookbinder
     end
 
     def generate_nav_file
-      puts "generate #{nav_filename}"
+      puts "generate #{nav_filename}" if verbose
       builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
         xml.html(xmlns: 'http://www.w3.org/1999/xhtml') do
           xml.head do
@@ -123,7 +123,7 @@ module Ebookbinder
         root = Dir.pwd
         epub_filename_fullpath = File.join(root, epub_filename)
         cd epub_dir do
-          sh "zip -Xr9D \"#{epub_filename_fullpath}\" mimetype *"
+          sh "zip -Xqr9D \"#{epub_filename_fullpath}\" mimetype *"
         end
       end
 

data/lib/ebookbinder/version.rb

@@ -2,6 +2,6 @@
 
 module Ebookbinder
 
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 
 end

data/lib/ebookbinder.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 require 'rake'
+require 'rake/clean'
 require 'yaml'
 
 module Ebookbinder

data/regtest/epub2.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require 'regtest'
+
+EPUB2_DIR = File.join(__dir__,  '../examples/epub2/build/epub2')
+
+Dir.chdir(EPUB2_DIR) do
+  system('rake -s clobber build')
+end
+
+%w(toc.ncx).each do |fn|
+
+  Regtest.sample fn do
+    File.read File.join(EPUB2_DIR, fn)
+  end
+
+end

data/regtest/epub2.yml

@@ -0,0 +1,77 @@
+---
+sample: toc.ncx
+result: |
+  <?xml version="1.0" encoding="UTF-8"?>
+  <ncx xmlns="http://www.daisy.org/z3986/2005/ncx/" version="2005-1">
+    <head>
+      <meta name="dtb:uid" content="79590ed992de79754671e01316da8f2a"/>
+      <meta name="dtb:depth" content="2"/>
+      <meta name="dtb:totalPageCount" content="0"/>
+      <meta name="dtb:maxPageNumber" content="0"/>
+    </head>
+    <docTitle>
+      <text>Test Book in EPUB 2</text>
+    </docTitle>
+    <navMap>
+      <navPoint id="id_0001" playOrder="1">
+        <navLabel>
+          <text>H1 number 1</text>
+        </navLabel>
+        <content src="01.xhtml#id1"/>
+      </navPoint>
+      <navPoint id="id_0002" playOrder="2">
+        <navLabel>
+          <text>H1 number 2</text>
+        </navLabel>
+        <content src="01.xhtml#id2"/>
+      </navPoint>
+      <navPoint id="id_0003" playOrder="3">
+        <navLabel>
+          <text>H1 number 3</text>
+        </navLabel>
+        <content src="01.xhtml#id3"/>
+      </navPoint>
+      <navPoint id="id_0004" playOrder="4">
+        <navLabel>
+          <text>H1 number 4</text>
+        </navLabel>
+        <content src="01.xhtml#id4"/>
+      </navPoint>
+      <navPoint id="id_0005" playOrder="5">
+        <navLabel>
+          <text>H1 number 5</text>
+        </navLabel>
+        <content src="01.xhtml#id5"/>
+      </navPoint>
+      <navPoint id="id_0006" playOrder="6">
+        <navLabel>
+          <text>H1 number 1</text>
+        </navLabel>
+        <content src="02.xhtml#id1"/>
+      </navPoint>
+      <navPoint id="id_0007" playOrder="7">
+        <navLabel>
+          <text>H1 number 2</text>
+        </navLabel>
+        <content src="02.xhtml#id2"/>
+      </navPoint>
+      <navPoint id="id_0008" playOrder="8">
+        <navLabel>
+          <text>H1 number 3</text>
+        </navLabel>
+        <content src="02.xhtml#id3"/>
+      </navPoint>
+      <navPoint id="id_0009" playOrder="9">
+        <navLabel>
+          <text>H1 number 4</text>
+        </navLabel>
+        <content src="02.xhtml#id4"/>
+      </navPoint>
+      <navPoint id="id_0010" playOrder="10">
+        <navLabel>
+          <text>H1 number 5</text>
+        </navLabel>
+        <content src="02.xhtml#id5"/>
+      </navPoint>
+    </navMap>
+  </ncx>

data/regtest/epub3.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require 'regtest'
+
+EPUB3_DIR = File.join(__dir__,  '../examples/epub3/build/epub3')
+
+Dir.chdir(EPUB3_DIR) do
+  system('rake -s clobber build')
+end
+
+%w(nav.xhtml).each do |fn|
+
+  Regtest.sample fn do
+    File.read File.join(EPUB3_DIR, fn)
+  end
+
+end

data/regtest/epub3.yml

@@ -0,0 +1,45 @@
+---
+sample: nav.xhtml
+result: |
+  <?xml version="1.0" encoding="UTF-8"?>
+  <html xmlns="http://www.w3.org/1999/xhtml">
+    <head>
+      <title>Test Book in EPUB 3</title>
+    </head>
+    <body>
+      <nav xmlns:epub="http://www.idpf.org/2007/ops" epub:type="toc" id="toc">
+        <ol>
+          <li>
+            <a href="01.xhtml#id1">H1 number 1</a>
+          </li>
+          <li>
+            <a href="01.xhtml#id2">H1 number 2</a>
+          </li>
+          <li>
+            <a href="01.xhtml#id3">H1 number 3</a>
+          </li>
+          <li>
+            <a href="01.xhtml#id4">H1 number 4</a>
+          </li>
+          <li>
+            <a href="01.xhtml#id5">H1 number 5</a>
+          </li>
+          <li>
+            <a href="02.xhtml#id1">H1 number 1</a>
+          </li>
+          <li>
+            <a href="02.xhtml#id2">H1 number 2</a>
+          </li>
+          <li>
+            <a href="02.xhtml#id3">H1 number 3</a>
+          </li>
+          <li>
+            <a href="02.xhtml#id4">H1 number 4</a>
+          </li>
+          <li>
+            <a href="02.xhtml#id5">H1 number 5</a>
+          </li>
+        </ol>
+      </nav>
+    </body>
+  </html>

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ebookbinder
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jan Friedrich
 bindir: bin
 cert_chain: []
-date: 2024-03-02 00:00:00.000000000 Z
+date: 2024-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -37,32 +37,58 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.17'
+- !ruby/object:Gem::Dependency
+  name: regtest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
 description: ''
 email: janfri26@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- "./.aspell.pws"
 - Changelog
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - ebookbinder.gemspec
+- examples/epub2/Rakefile
+- examples/epub2/src/01.xhtml
+- examples/epub2/src/02.xhtml
+- examples/epub3/Rakefile
+- examples/epub3/src/01.xhtml
+- examples/epub3/src/02.xhtml
 - lib/ebookbinder.rb
 - lib/ebookbinder/ebook_base.rb
 - lib/ebookbinder/epub2.rb
 - lib/ebookbinder/epub3.rb
 - lib/ebookbinder/epub_base.rb
 - lib/ebookbinder/version.rb
-- test/epub2/Rakefile
-- test/epub2/src/01.xhtml
-- test/epub2/src/02.xhtml
-- test/epub3/Rakefile
-- test/epub3/src/01.xhtml
-- test/epub3/src/02.xhtml
-licenses: []
+- regtest/epub2.rb
+- regtest/epub2.yml
+- regtest/epub3.rb
+- regtest/epub3.yml
+homepage: https://github.com/janfri/ebookbinder
+licenses:
+- MIT
 metadata: {}
+post_install_message: "\n+-----------------------------------------------------------------------+\n|
+  To run rake check you need epubcheck installed and accessible via     |\n| `epubcheck`
+  on the command line.                                      |\n|                                                                       |\n|
+  https://www.w3.org/publishing/epubcheck/                              |\n+-----------------------------------------------------------------------+\n
+  \ "
 rdoc_options: []
 require_paths:
 - lib
@@ -79,5 +105,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.0.dev
 specification_version: 4
-summary: ''
+summary: This library should help to make ebooks as easy as possible. It interprets
+  an XHTML structure and generate a corresponding ebook on base of easy asumptions.
 test_files: []