gepub 1.0.0beta1 → 1.0.0rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b309e48823e6ba81b9ec3d9082cb3be3e0f0198352ad439ba422234a0ab905f2
-  data.tar.gz: 2558196c081bd7cd71d70c912213820879b1f5d6df3ad96b6b39899d23213a14
+  metadata.gz: 6ea54f631081444844a163f58cb499a6dd92e32a310f80fa957a2fd8344126e0
+  data.tar.gz: 677cf3da9d50aea36764d24f55e3ba3d30ff4caef08b7f722807b181d839dbcd
 SHA512:
-  metadata.gz: 3ac54805a6b2582cbefa12655fd0c7d27801f16608c70b9355b81b6d6e623ffe0b94ed3f95a4bc4acc58b69d09476551a43d9f3926c42f0d59c1fc80cdea3ec9
-  data.tar.gz: d05593c50c03ae43a6a644b7a7ac2c2a9239025f35cfc09adb2dbb61729633ec5456d426cf1bd4e83624dd14d04e9b5a3cfb2d93d7eac43ce16a7acddd7d5e45
+  metadata.gz: 2c9858b1ce776c22fabe0dec16f44bd5c5c228cec894c876439c4a66abd617ef718731f5ff960820c634f8e48d8185cf2fa26b309a8f7d637fe18be3190992ac
+  data.tar.gz: ee051d198cfe11f1a824b3a8aefb03cf7046fae837429d6820fe633eb178aa54a43172532840c3c87a14ede39b2e0315191976c12bed3d358d4ca25422c82fb0

data/lib/gepub/book.rb

@@ -124,6 +124,7 @@ module GEPUB
       end
       @package = Package.new(path, attributes)
       @toc = []
+      @landmarks = []
       if block
         block.arity < 1 ? instance_eval(&block) : block[self]        
       end
@@ -148,22 +149,17 @@ module GEPUB
     def set_singleton_methods_to_item(item)
       toc = @toc
       metaclass = (class << item;self;end)
-      metaclass.send(:define_method, :toc_text,
-                                    Proc.new { |text|
-                                      toc.push(:item => item, :text => text, :id => nil)
-                                      item
-                     })
-      metaclass.send(:define_method, :toc_text_with_id,
-                                    Proc.new { |text, id|
-                                      toc.push(:item => item, :text => text, :id => id)
-                                      item
-                     })
+      metaclass.send(:define_method, :toc, Proc.new {
+        toc
+      })
+      landmarks = @landmarks
+      metaclass.send(:define_method, :landmarks, Proc.new {
+        landmarks
+      })
       bindings = @package.bindings
-      metaclass.send(:define_method, :is_handler_of,
-                     Proc.new { |media_type|
-                       bindings.add(item.id, media_type)
-                       item
-                     })
+      metaclass.send(:define_method, :bindings, Proc.new {
+        bindings
+      })
                                
     end
     
@@ -301,6 +297,19 @@ EOF
           }
         }
       end
+      def write_landmarks xml_doc, landmarks
+        xml_doc.ol {
+          landmarks.each {
+            |landmark|
+            id = landmark[:id].nil? ? "" : "##{x[:id]}"
+            landmark_title = landmark[:title]
+            type = landmark[:type]
+            xml_doc.li {
+              xml_doc.a({'href' => landmark[:item].href + id, 'epub:type' => landmark[:type]}, landmark_title)
+            }
+          }
+        }
+      end
       # build nav
       builder = Nokogiri::XML::Builder.new {
         |doc|
@@ -311,6 +320,9 @@ EOF
               doc.h1 "#{title}"
               write_toc(doc, stacked_toc[:tocs])
             }
+            doc.nav('epub:type' => 'landmarks', 'id' => 'landmarks') {
+              write_landmarks(doc, @landmarks)
+            }
           }
         }
       }

data/lib/gepub/item.rb

@@ -71,6 +71,29 @@ module GEPUB
       add_property('nav')
     end
 
+    # set toc text to the item
+    def toc_text text
+      toc.push(:item => self, :text => text, :id => nil)
+      self
+    end
+
+    # set toc text with id to the item
+    def toc_text_with_id text, toc_id
+      toc.push(:item => self, :text => text, :id => toc_id)
+      self
+    end
+
+    # set bindings: item is a handler for media_type
+    def is_handler_of media_type
+      bindings.add(self.id, media_type)
+      self
+    end
+
+    def landmark(type:, title:, id: nil)
+      landmarks.push(:type => type, :title => title, :item => self, :id => id)
+      self
+    end
+
     # guess and set content property from contents.
     def guess_content_property
       if File.extname(self.href) =~ /.x?html/ && @attributes['media-type'] === 'application/xhtml+xml'

data/lib/gepub/version.rb

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

data/spec/example_spec.rb

@@ -128,5 +128,65 @@ describe 'GEPUB usage' do
       book.generate_epub(epubname)
       epubcheck(epubname)
     end
+		
+    it 'should generate simple EPUB3 with landmarks' do
+      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(2).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, alternates: {'en' => 'Denshobu'})
+      book.add_contributor('アサガヤデンショ', display_seq: 2, 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__),  'fixtures', 'testdata', 'image1.jpg')
+      book.add_item('img/image1.jpg',content: imgfile).cover_image
+      
+      # within ordered block, add_item will be added to spine.
+      book.ordered {
+				book.add_item('text/cover.xhtml').add_content(StringIO.new('<html xmlns="http://www.w3.org/1999/xhtml"><head><title>cover</title></head><body><h1>the book title</h1><img src="../img/image1.jpg" /></body></html>')).landmark(type: 'cover', title: '表紙')
+				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').landmark(type: 'bodymatter', title: '本文')
+        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')
+      }
+      epubname = File.join(File.dirname(__FILE__), 'example_test.epub')
+
+      # check nav doc
+      xml = Nokogiri::XML::Document.parse book.nav_doc
+
+      # check toc
+			tocs =  xml.xpath("//xmlns:nav[@epub:type='toc']/xmlns:ol/xmlns:li") 
+      expect(tocs.size).to eq 2
+      expect(tocs[0].content.strip).to eq 'Chapter 1'
+      expect(tocs[1].content.strip).to eq 'Chapter 2'
+
+      # check landmarks 
+      landmarks = xml.xpath("//xmlns:nav[@epub:type='landmarks']/xmlns:ol/xmlns:li/xmlns:a")
+      expect(landmarks.size).to eq 2
+      expect(landmarks[0]['epub:type']).to eq 'cover'
+      expect(landmarks[0]['href']).to eq 'text/cover.xhtml'
+      expect(landmarks[1]['epub:type']).to eq 'bodymatter'
+      expect(landmarks[1]['href']).to eq 'text/chap1.xhtml'
+      book.generate_epub(epubname)
+      epubcheck(epubname)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gepub
 version: !ruby/object:Gem::Version
-  version: 1.0.0beta1
+  version: 1.0.0rc1
 platform: ruby
 authors:
 - KOJIMA Satoshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-24 00:00:00.000000000 Z
+date: 2018-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri