gepub 1.0.0rc1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ea54f631081444844a163f58cb499a6dd92e32a310f80fa957a2fd8344126e0
-  data.tar.gz: 677cf3da9d50aea36764d24f55e3ba3d30ff4caef08b7f722807b181d839dbcd
+  metadata.gz: 877e717beb44a21df9afc0a5427d5576a162e27dfad1cb562cb5b36bd2adcdc9
+  data.tar.gz: 2ea4a07ae25bf2a85af439a1b49b429ce70961e958a8deba1882f2f46075ec55
 SHA512:
-  metadata.gz: 2c9858b1ce776c22fabe0dec16f44bd5c5c228cec894c876439c4a66abd617ef718731f5ff960820c634f8e48d8185cf2fa26b309a8f7d637fe18be3190992ac
-  data.tar.gz: ee051d198cfe11f1a824b3a8aefb03cf7046fae837429d6820fe633eb178aa54a43172532840c3c87a14ede39b2e0315191976c12bed3d358d4ca25422c82fb0
+  metadata.gz: 7e58686f88c0d9e80dd4db6c3749a571ba53b2b4d92579fde57af40802438d64e344629d59d2d6667da83eca35bf2202616ac4097e2c5caca7bc833ad188874e
+  data.tar.gz: 59065a6eea1f705bda13722f677928730e7b23565dbd778a1c9174e3f0919880f9a504c90f0ba86c3d75bdeb914207473f13f6ad64596420d382090d5517f4c1

data/README.md

@@ -3,7 +3,6 @@
 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/skoji/gepub?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [<img src="https://secure.travis-ci.org/skoji/gepub.png" />](http://travis-ci.org/skoji/gepub) 
 [![Coverage Status](https://coveralls.io/repos/skoji/gepub/badge.png?branch=master)](https://coveralls.io/r/skoji/gepub?branch=master)
-[![Dependency Status](https://gemnasium.com/skoji/gepub.png)](https://gemnasium.com/skoji/gepub)
 [![Gem Version](https://badge.fury.io/rb/gepub.png)](http://badge.fury.io/rb/gepub)
 
 * http://rdoc.info/github/skoji/gepub/master/frames
@@ -16,57 +15,97 @@ a generic EPUB parser/generator library.
 
 * GEPUB::Book provides functionality to create EPUB file, and parsing EPUB files
 * Handle every metadata in EPUB2/EPUB3.
-* GEPUB::Builder provides an easy and powerful way to create EPUB3 files
 
 * See [issues](https://github.com/skoji/gepub/issues/) for known problems.
 
-If you are using GEPUB::Builder from your code and do not like its behaviour(e.g. the block inside is evaluated as inside the Builder instance), please consider using GEPUB::Book directly.
-
-**GEPUB::Builder will be obsolete in gepub 0.7. GEPUB::Book#new will be enhanced instead of Builder DSL.**
-
+If you are using GEPUB::Builder and do not like its behaviour(e.g. the block inside is evaluated as inside the Builder instance), please consider using GEPUB::Book directly.
 
 ## SYNOPSIS:
 
 ### Builder Example
 
 ```ruby
-require 'rubygem'
+require 'rubygems'
 require 'gepub'
-builder = GEPUB::Builder.new {
-  language 'en'
-  unique_identifier 'http:/example.jp/bookid_in_url', 'BookID', 'URL'
-  title 'GEPUB Sample Book'
-  subtitle 'This book is just a sample'
-
-  creator 'KOJIMA Satoshi'
-
-  contributors 'Denshobu', 'Asagaya Densho', 'Shonan Densho Teidan', 'eMagazine Torutaru'
-
-  date '2012-02-29T00:00:00Z'
 
-  resources(:workdir => '~/epub/sample_book_source/') {
-    cover_image 'img/image1.jpg' => 'image1.jpg'
-    ordered {
-      file 'text/chap1.xhtml'
-      heading 'Chapter 1'
-
-      file 'text/chap1-1.xhtml'
-
-      file 'text/chap2.html'
-      heading 'Chapter 2'
-    }
-  }
+book = GEPUB::Book.new
+book.primary_identifier('http://example.jp/bookid_in_url', 'BookID', 'URL')
+book.language = 'ja'
+
+book.add_title 'GEPUBサンプル文書', 
+               title_type: GEPUB::TITLE_TYPE::MAIN,
+               lang: 'ja',
+               file_as: 'GEPUB Sample Book',
+               display_seq: 1,
+               alternates: {
+                       'en' => 'GEPUB Sample Book (Japanese)',
+                       'el' => 'GEPUB δείγμα (Ιαπωνικά)',
+                       'th' => 'GEPUB ตัวอย่าง (ญี่ปุ่น)' }
+               
+# you can do the same thing using method chain
+book.add_title('これはあくまでサンプルです', title_type: GEPUB::TITLE_TYPE::SUBTITLE).display_seq(1).add_alternates('en' => 'this book is just a sample.')
+
+# use arguments
+book.add_creator '小嶋智', 
+                 display_seq:1, 
+                 alternates: { 'en' => 'KOJIMA Satoshi' } 
+book.add_contributor '電書部',
+                     display_seq: 1,
+                     alternates: {'en' => 'Denshobu'}
+book.add_contributor 'アサガヤデンショ',
+                     display_seq: 2, 
+                     alternates: {'en' => 'Asagaya Densho'}
+# you can also use method chain
+book.add_contributor('湘南電書鼎談').display_seq(3).add_alternates('en' => 'Shonan Densho Teidan')
+book.add_contributor('電子雑誌トルタル').display_seq(4).add_alternates('en' => 'eMagazine Torutaru')
+
+imgfile = File.join(File.dirname(__FILE__),  'image1.jpg')
+File.open(imgfile) do
+  |io|
+  book.add_item('img/image1.jpg',content: io).cover_image
+end
+
+# within ordered block, add_item will be added to spine.
+book.ordered {
+  book.add_item('text/cover.xhtml',
+                content: StringIO.new(<<-COVER)).landmark(type: 'cover', title: 'cover page')
+                <html xmlns="http://www.w3.org/1999/xhtml">
+                <head>
+                  <title>cover page</title>
+                </head>
+                <body>
+                <h1>The Book</h1>
+                <img src="../img/image1.jpg" />
+                </body></html>
+  COVER
+  book.add_item('text/chap1.xhtml').add_content(StringIO.new(<<-CHAP_ONE)).toc_text('Chapter 1').landmark(type: 'bodymatter', title: '本文')
+  <html xmlns="http://www.w3.org/1999/xhtml">
+  <head><title>c1</title></head>
+  <body><p>the first page</p></body></html>
+  CHAP_ONE
+  book.add_item('text/chap1-1.xhtml').add_content(StringIO.new(<<-SEC_ONE_ONE)) # do not appear on table of contents
+  <html xmlns="http://www.w3.org/1999/xhtml">
+  <head><title>c2</title></head>
+  <body><p>the second page</p></body></html>
+  SEC_ONE_ONE
+  book.add_item('text/chap2.xhtml').add_content(StringIO.new(<<-CHAP_TWO)).toc_text('Chapter 2')
+  <html xmlns="http://www.w3.org/1999/xhtml">
+  <head><title>c3</title></head>
+  <body><p>the third page</p></body></html>
+  CHAP_TWO
+  # to add nav file:
+  # book.add_item('path/to/nav').add_content(nav_html_content).add_property('nav')
 }
-epubname = File.join(File.dirname(__FILE__), 'example_test_with_builder.epub')
-builder.generate_epub(epubname)
+epubname = File.join(File.dirname(__FILE__), 'example_test.epub')
+
+# if you do not specify your own nav document with add_item, 
+# simple navigation text will be generated in generate_epub.
+# auto-generated nav file will not appear on spine.
+book.generate_epub(epubname)
 ```
-[more builder examples](https://gist.github.com/1878995)
- [examples in this repository](https://github.com/skoji/gepub/tree/master/examples/) 
+ * [examples in this repository](https://github.com/skoji/gepub/tree/master/examples/) 
 
 ## INSTALL:
 
 * gem install gepub
 
-
-
-[![endorse](http://api.coderwall.com/skoji/endorse.png)](http://coderwall.com/skoji)

data/examples/{builder_example.rb → deprecated_builder_example.rb}

@@ -1,4 +1,6 @@
 # -*- coding: utf-8 -*-
+# We will continue to support GEPUB::Builder works fine on version 1.x, but Builder will not be updated any more. For example, landmarks are not supported with Builder.
+
     require 'rubygems'
     require 'gepub'
     workdir = 'epub/example/'

data/examples/generate_example.rb

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 require 'rubygems'
 require 'gepub'
 
@@ -6,40 +5,67 @@ book = GEPUB::Book.new
 book.primary_identifier('http://example.jp/bookid_in_url', 'BookID', 'URL')
 book.language = 'ja'
 
-# you can add metadata and its property using block
-book.add_title('GEPUBサンプル文書', title_type: GEPUB::TITLE_TYPE::MAIN) {
-  |title|
-  title.lang = 'ja'
-  title.file_as = 'GEPUB Sample Book'
-  title.display_seq = 1
-  title.add_alternates(
+book.add_title 'GEPUBサンプル文書', 
+               title_type: GEPUB::TITLE_TYPE::MAIN,
+               lang: 'ja',
+               file_as: 'GEPUB Sample Book',
+               display_seq: 1,
+               alternates: {
                        'en' => 'GEPUB Sample Book (Japanese)',
                        'el' => 'GEPUB δείγμα (Ιαπωνικά)',
-                       'th' => 'GEPUB ตัวอย่าง (ญี่ปุ่น)')
-}
+                       'th' => 'GEPUB ตัวอย่าง (ญี่ปุ่น)' }
+               
 # you can do the same thing using method chain
 book.add_title('これはあくまでサンプルです', title_type: GEPUB::TITLE_TYPE::SUBTITLE).display_seq(1).add_alternates('en' => 'this book is just a sample.')
-book.add_creator('小嶋智') {
-  |creator|
-  creator.display_seq = 1
-  creator.add_alternates('en' => 'KOJIMA Satoshi')
-}
-book.add_contributor('電書部').display_seq(1).add_alternates('en' => 'Denshobu')
-book.add_contributor('アサガヤデンショ').display_seq(2).add_alternates('en' => 'Asagaya Densho')
+
+# use arguments
+book.add_creator '小嶋智', 
+                 display_seq:1, 
+                 alternates: { 'en' => 'KOJIMA Satoshi' } 
+book.add_contributor '電書部',
+                     display_seq: 1,
+                     alternates: {'en' => 'Denshobu'}
+book.add_contributor 'アサガヤデンショ',
+                     display_seq: 2, 
+                     alternates: {'en' => 'Asagaya Densho'}
+# you can also use method chain
 book.add_contributor('湘南電書鼎談').display_seq(3).add_alternates('en' => 'Shonan Densho Teidan')
 book.add_contributor('電子雑誌トルタル').display_seq(4).add_alternates('en' => 'eMagazine Torutaru')
 
 imgfile = File.join(File.dirname(__FILE__),  'image1.jpg')
 File.open(imgfile) do
   |io|
-  book.add_item('img/image1.jpg',io).cover_image
+  book.add_item('img/image1.jpg',content: io).cover_image
 end
 
 # within ordered block, add_item will be added to spine.
 book.ordered {
-  book.add_item('text/chap1.xhtml').add_content(StringIO.new('<html xmlns="http://www.w3.org/1999/xhtml"><head><title>c1</title></head><body><p>the first page</p></body></html>')).toc_text('Chapter 1') 
-  book.add_item('text/chap1-1.xhtml').add_content(StringIO.new('<html xmlns="http://www.w3.org/1999/xhtml"><head><title>c2</title></head><body><p>the second page</p></body></html>')) # do not appear on table of contents
-  book.add_item('text/chap2.xhtml').add_content(StringIO.new('<html xmlns="http://www.w3.org/1999/xhtml"><head><title>c3</title></head><body><p>the third page</p></body></html>')).toc_text('Chapter 2')
+  book.add_item('text/cover.xhtml',
+                content: StringIO.new(<<-COVER)).landmark(type: 'cover', title: 'cover page')
+                <html xmlns="http://www.w3.org/1999/xhtml">
+                <head>
+                  <title>cover page</title>
+                </head>
+                <body>
+                <h1>The Book</h1>
+                <img src="../img/image1.jpg" />
+                </body></html>
+  COVER
+  book.add_item('text/chap1.xhtml').add_content(StringIO.new(<<-CHAP_ONE)).toc_text('Chapter 1').landmark(type: 'bodymatter', title: '本文')
+  <html xmlns="http://www.w3.org/1999/xhtml">
+  <head><title>c1</title></head>
+  <body><p>the first page</p></body></html>
+  CHAP_ONE
+  book.add_item('text/chap1-1.xhtml').add_content(StringIO.new(<<-SEC_ONE_ONE)) # do not appear on table of contents
+  <html xmlns="http://www.w3.org/1999/xhtml">
+  <head><title>c2</title></head>
+  <body><p>the second page</p></body></html>
+  SEC_ONE_ONE
+  book.add_item('text/chap2.xhtml').add_content(StringIO.new(<<-CHAP_TWO)).toc_text('Chapter 2')
+  <html xmlns="http://www.w3.org/1999/xhtml">
+  <head><title>c3</title></head>
+  <body><p>the third page</p></body></html>
+  CHAP_TWO
   # to add nav file:
   # book.add_item('path/to/nav').add_content(nav_html_content).add_property('nav')
 }

data/examples/generate_example_legacy_apis.rb

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'gepub'
+
+book = GEPUB::Book.new
+book.primary_identifier('http://example.jp/bookid_in_url', 'BookID', 'URL')
+book.language = 'ja'
+
+# you can add metadata and its property using block
+book.add_title('GEPUBサンプル文書', title_type: GEPUB::TITLE_TYPE::MAIN) {
+  |title|
+  title.lang = 'ja'
+  title.file_as = 'GEPUB Sample Book'
+  title.display_seq = 1
+  title.add_alternates(
+                       'en' => 'GEPUB Sample Book (Japanese)',
+                       'el' => 'GEPUB δείγμα (Ιαπωνικά)',
+                       'th' => 'GEPUB ตัวอย่าง (ญี่ปุ่น)')
+}
+# you can do the same thing using method chain
+book.add_title('これはあくまでサンプルです', title_type: GEPUB::TITLE_TYPE::SUBTITLE).display_seq(1).add_alternates('en' => 'this book is just a sample.')
+book.add_creator('小嶋智') {
+  |creator|
+  creator.display_seq = 1
+  creator.add_alternates('en' => 'KOJIMA Satoshi')
+}
+book.add_contributor('電書部').display_seq(1).add_alternates('en' => 'Denshobu')
+book.add_contributor('アサガヤデンショ').display_seq(2).add_alternates('en' => 'Asagaya Densho')
+book.add_contributor('湘南電書鼎談').display_seq(3).add_alternates('en' => 'Shonan Densho Teidan')
+book.add_contributor('電子雑誌トルタル').display_seq(4).add_alternates('en' => 'eMagazine Torutaru')
+
+imgfile = File.join(File.dirname(__FILE__),  'image1.jpg')
+File.open(imgfile) do
+  |io|
+  book.add_item('img/image1.jpg',io).cover_image
+end
+
+# within ordered block, add_item will be added to spine.
+book.ordered {
+  book.add_item('text/chap1.xhtml').add_content(StringIO.new('<html xmlns="http://www.w3.org/1999/xhtml"><head><title>c1</title></head><body><p>the first page</p></body></html>')).toc_text('Chapter 1') 
+  book.add_item('text/chap1-1.xhtml').add_content(StringIO.new('<html xmlns="http://www.w3.org/1999/xhtml"><head><title>c2</title></head><body><p>the second page</p></body></html>')) # do not appear on table of contents
+  book.add_item('text/chap2.xhtml').add_content(StringIO.new('<html xmlns="http://www.w3.org/1999/xhtml"><head><title>c3</title></head><body><p>the third page</p></body></html>')).toc_text('Chapter 2')
+  # to add nav file:
+  # book.add_item('path/to/nav').add_content(nav_html_content).add_property('nav')
+}
+epubname = File.join(File.dirname(__FILE__), 'example_test.epub')
+
+# if you do not specify your own nav document with add_item, 
+# simple navigation text will be generated in generate_epub.
+# auto-generated nav file will not appear on spine.
+book.generate_epub(epubname)
+

data/lib/gepub/version.rb

@@ -1,4 +1,4 @@
 module GEPUB
   # GEPUB gem version 
-	VERSION = "1.0.0rc1"
+	VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gepub
 version: !ruby/object:Gem::Version
-  version: 1.0.0rc1
+  version: 1.0.0
 platform: ruby
 authors:
 - KOJIMA Satoshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-06 00:00:00.000000000 Z
+date: 2018-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -91,8 +91,9 @@ files:
 - Rakefile
 - bin/genepub
 - bin/gepuber
-- examples/builder_example.rb
+- examples/deprecated_builder_example.rb
 - examples/generate_example.rb
+- examples/generate_example_legacy_apis.rb
 - examples/image1.jpg
 - examples/new_book_example.rb
 - gepub.gemspec
@@ -180,9 +181,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: gepub
 rubygems_version: 2.7.6