gepub 0.6.3 → 0.6.3.1

data/.gitignore

@@ -19,8 +19,7 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
-testepub.epub
-testepub2.epub
+testepub*.epub
 example_test*.epub
 
 ## BUNDLER

data/README.md

@@ -10,7 +10,7 @@ a generic EPUB parser/generator library.
 
 * GEPUB::Book provides functionality to create EPUB file, and parsing EPUB file
 * Handle every metadata in EPUB2/EPUB3.
-* Soon, I will provide easy to generate EPUB class, like Nokogiri::XML::Generator.
+* GEPUB::Builder privides easy and powerful way to create EPUB3 files
 
 * See [issues](https://github.com/skoji/gepub/issues/) for known problems.
 
@@ -20,7 +20,6 @@ a generic EPUB parser/generator library.
 
     require 'rubygem'
     require 'gepub'
-    workdir = 'epub/example/'
     builder = GEPUB::Builder.new {
       unique_identifier 'http:/example.jp/bookid_in_url', 'BookID', 'URL'
       language 'en'
@@ -36,7 +35,7 @@ a generic EPUB parser/generator library.
 
       date '2012-02-29T00:00:00Z'
 
-      resources(:workdir => workdir) {
+      resources(:workdir => '~/epub/sample_book_source/') {
         cover_image 'img/image1.jpg' => 'image1.jpg'
         ordered {
           file 'text/chap1.xhtml'
@@ -50,7 +49,9 @@ a generic EPUB parser/generator library.
     epubname = File.join(File.dirname(__FILE__), 'example_test_with_builder.epub')
     builder.generate_epub(epubname)
 
- [examples](https://github.com/skoji/gepub/tree/master/examples/) 
+[more builder examples](https://gist.github.com/1878995)
+ 
+[examples in this repository](https://github.com/skoji/gepub/tree/master/examples/) 
 
 ## INSTALL:
 

data/lib/gepub/book.rb

@@ -83,16 +83,18 @@ module GEPUB
     def add_item(href, io_or_filename = nil, id = nil, attributes = {})
       item = @package.add_item(href,io_or_filename,id,attributes)
       toc = @toc
-      (class << item;self;end).send(:define_method, :toc_text,
+      metaclass = (class << item;self;end)
+      metaclass.send(:define_method, :toc_text,
                                     Proc.new { |text|
                                       toc.push(:item => item, :text => text, :id => nil)
                                       item
-                                    })
-      (class << item;self;end).send(:define_method, :toc_text_with_id,
+                     })
+      metaclass.send(:define_method, :toc_text_with_id,
                                     Proc.new { |text, id|
                                       toc.push(:item => item, :text => text, :id => id)
                                       item
-                                    })
+                     })
+      
       yield item if block_given?
       item
     end
@@ -117,8 +119,7 @@ module GEPUB
       @package.ordered(&block)
     end
 
-    def generate_epub(path_to_epub)
-
+    def cleanup
       if version.to_f < 3.0 || @package.epub_backward_compat
         if @package.manifest.item_list.select {
           |x,item|
@@ -133,30 +134,52 @@ module GEPUB
 
       if version.to_f >=3.0
         @package.metadata.set_lastmodified
+        
         if @package.manifest.item_list.select {
           |href, item|
           (item.properties||[]).member? 'nav'
           }.size == 0
           generate_nav_doc
         end
+        
+        @package.spine.remove_with_idlist @package.manifest.item_list.map {
+          |href, item|
+          item.fallback
+        }.reject(&:nil?)
+
       end
+    end
+
+    def write_to_epub_container(epub) 
+      epub.put_next_entry('mimetype', '', '', Zip::ZipEntry::STORED)
+      epub << "application/epub+zip"
+      epub.put_next_entry('META-INF/container.xml')
+      epub << container_xml
 
+      epub.put_next_entry(@package.path)
+      epub << opf_xml
+
+      @package.manifest.item_list.each {
+        |k, item|
+        epub.put_next_entry(@package.contents_prefix + item.href)
+        epub << item.content
+      }
+    end
+
+    def generate_epub_stream
+      cleanup
+      Zip::ZipOutputStream::write_buffer {
+        |epub|
+        write_to_epub_container(epub)
+      }
+    end
+    
+    def generate_epub(path_to_epub)
+      cleanup
       File.delete(path_to_epub) if File.exist?(path_to_epub)
       Zip::ZipOutputStream::open(path_to_epub) {
         |epub|
-        epub.put_next_entry('mimetype', '', '', Zip::ZipEntry::STORED)
-        epub << "application/epub+zip"
-        epub.put_next_entry('META-INF/container.xml')
-        epub << container_xml
-
-        epub.put_next_entry(@package.path)
-        epub << opf_xml
-
-        @package.manifest.item_list.each {
-          |k, item|
-          epub.put_next_entry(@package.contents_prefix + item.href)
-          epub << item.content
-        }
+        write_to_epub_container(epub)
       }
     end
     

data/lib/gepub/builder.rb

@@ -73,7 +73,7 @@ module GEPUB
       @last_defined_item = vals.map {
         |v|
         name = v
-        role = ''
+        role = 'aut'
         name,role = v[0], v[1] if Array === name
         MetaItem.new(@book.add_creator(name, nil, role))
       }
@@ -121,7 +121,7 @@ module GEPUB
     end
     
     def generate_epub_stream
-      # TODO should implement
+      @book.generate_epub_stream
     end
   end
 end

data/lib/gepub/metadata.rb

@@ -153,7 +153,7 @@ module GEPUB
       meta
     end
     
-    def add_person(name, content, id = nil, role = 'aut')
+    def add_person(name, content, id = nil, role = nil)
       meta = add_metadata(name, content, id).refine('role', role)
       yield meta if block_given?
       meta

data/lib/gepub/spine.rb

@@ -106,7 +106,13 @@ module GEPUB
       @item_refs.delete itemref
       @id_pool[itemref.id] = nil
     end
-    
+
+    def remove_with_idlist(ids)
+      @item_refs = @item_refs.select {
+        |ref|
+        !ids.member? ref.idref
+      }
+    end
     
   end
 end

data/lib/gepub/version.rb

@@ -1,3 +1,3 @@
 module GEPUB
-  VERSION = "0.6.3"
+  VERSION = "0.6.3.1"
 end

data/spec/builder_spec.rb

@@ -291,12 +291,11 @@ describe GEPUB::Builder do
     end
 
     it 'should handle fallback chain' do
-      # in this test, do not supply 
       workdir = File.join(File.dirname(__FILE__),'fixtures', 'builder')
       builder = GEPUB::Builder.new {
         resources(:workdir => workdir)  {
           fallback_group {
-            file 'chap3_docbook.xhtml' => nil
+            file 'chap3_docbook.xml' => nil
             media_type('application/docbook+xml')
             file 'chap3.xml' => nil
             media_type("application/z3986-auth+xml")
@@ -305,7 +304,7 @@ describe GEPUB::Builder do
         }
       }
       builder.instance_eval {
-        fallbackid = @book.item_by_href('chap3_docbook.xhtml').fallback
+        fallbackid = @book.item_by_href('chap3_docbook.xml').fallback
         @book.items[fallbackid].href.should == 'chap3.xml'
 
         fallbackid = @book.items[fallbackid].fallback
@@ -318,11 +317,11 @@ describe GEPUB::Builder do
       workdir = File.join(File.dirname(__FILE__),'fixtures', 'builder')
       builder = GEPUB::Builder.new {
         resources(:workdir => workdir)  {
-          fallback_chain_files 'chap3_docbook.xhtml' => nil, 'chap3.xml' => nil, 'chap3.xhtml' => nil
+          fallback_chain_files({'chap3_docbook.xml' => nil}, {'chap3.xml' => nil}, {'chap3.xhtml' => nil})
         }
       }
       builder.instance_eval {
-        fallbackid = @book.item_by_href('chap3_docbook.xhtml').fallback
+        fallbackid = @book.item_by_href('chap3_docbook.xml').fallback
         @book.items[fallbackid].href.should == 'chap3.xml'
 
         fallbackid = @book.items[fallbackid].fallback
@@ -331,18 +330,17 @@ describe GEPUB::Builder do
     end
 
     it 'should handle fallback chain with fallback_chain_files in with_media_type' do
-      # in this test, do not supply 
       workdir = File.join(File.dirname(__FILE__),'fixtures', 'builder')
       builder = GEPUB::Builder.new {
         resources(:workdir => workdir)  {
           with_media_type('application/docbook+xml', 'application/z3986-auth+xml', 'application/xhtml+xml') {
-            fallback_chain_files 'chap3_docbook.xhtml' => nil, 'chap3.xml' => nil, 'chap3.xhtml' => nil
+            fallback_chain_files({'chap3_docbook.xml' => nil}, {'chap3.xml' => nil}, {'chap3.xhtml' => nil})
           }
         }
       }
       builder.instance_eval {
-        @book.item_by_href('chap3_docbook.xhtml').media_type.should == 'application/docbook+xml'
-        fallbackid = @book.item_by_href('chap3_docbook.xhtml').fallback
+        @book.item_by_href('chap3_docbook.xml').media_type.should == 'application/docbook+xml'
+        fallbackid = @book.item_by_href('chap3_docbook.xml').fallback
         @book.items[fallbackid].href.should == 'chap3.xml'
         @book.items[fallbackid].media_type.should == 'application/z3986-auth+xml'
 
@@ -352,5 +350,35 @@ describe GEPUB::Builder do
       }
     end
 
+    it 'should handle fallback chain in spine' do
+      workdir = File.join(File.dirname(__FILE__),'fixtures', 'builder')
+      builder = GEPUB::Builder.new {
+        unique_identifier 'uid'
+
+        resources(:workdir => workdir)  {
+          ordered {
+            fallback_group {
+              file 'chap3_docbook.xml' => nil
+              media_type('application/docbook+xml')
+              file 'chap3.xml' => nil
+              media_type("application/z3986-auth+xml")
+              file 'chap3.xhtml' => nil
+            }
+          }
+        }
+      }
+      builder.instance_eval {
+        @book.cleanup
+        fallbackid = @book.item_by_href('chap3_docbook.xml').fallback
+        @book.items[fallbackid].href.should == 'chap3.xml'
+        fallbackid = @book.items[fallbackid].fallback
+        @book.items[fallbackid].href.should == 'chap3.xhtml'
+
+        @book.spine_items.size.should == 1
+        @book.spine_items[0].href == 'chap3_docbook.xhtml'
+
+      }
+    end
+
   end
 end

data/spec/example_spec.rb

@@ -7,6 +7,38 @@ describe 'GEPUB usage' do
   end
   
   context 'On generating EPUB' do
+    it 'should generate simple EPUB3 with Builder and buffer' do
+      workdir = File.join(File.dirname(__FILE__),  'fixtures', 'testdata')
+      builder = GEPUB::Builder.new {
+        unique_identifier 'http:/example.jp/bookid_in_url', 'BookID', 'URL'
+        language 'ja'
+        title 'GEPUBサンプル文書'
+        file_as 'GEPUB Sample Book'
+        alt 'en' => 'GEPUB Sample Book (Japanese)',
+        'el' => 'GEPUB δείγμα (Ιαπωνικά)',
+        'th' => 'GEPUB ตัวอย่าง (ญี่ปุ่น)'
+
+        subtitle 'これはあくまでサンプルです'
+        alt 'en' => 'This book is just a sample'
+        creator '小嶋智'
+        contributors 'Denshobu', 'Asagaya Densho', 'Shonan Densho Teidan', 'eMagazine Torutaru'
+        resources(:workdir => workdir) {
+          cover_image 'img/image1.jpg' => 'image1.jpg'
+          ordered {
+            file 'text/chap1.xhtml' => StringIO.new('<html xmlns="http://www.w3.org/1999/xhtml"><head><title>c1</title></head><body><p>the first page</p></body></html>')
+            heading 'Chapter 1'
+            file 'text/chap1-1.xhtml' => StringIO.new('<html xmlns="http://www.w3.org/1999/xhtml"><head><title>c2</title></head><body><p>the second page</p></body></html>')
+            file 'text/chap2.html' => StringIO.new('<html xmlns="http://www.w3.org/1999/xhtml"><head><title>c3</title></head><body><p>the third page</p></body></html>')
+            heading 'Chapter 2'
+          }
+        }
+      }
+      epubname = File.join(File.dirname(__FILE__), 'example_test_with_builder_buffer.epub')
+      File.open(epubname, 'wb') { |io| io.write builder.generate_epub_stream.string }
+      jar = File.join(File.dirname(__FILE__), 'fixtures/epubcheck-3.0b4/epubcheck-3.0b4.jar')    
+      system 'java' '-jar', jar, epubname
+    end
+
     it 'should generate simple EPUB3 with Builder' do
       workdir = File.join(File.dirname(__FILE__),  'fixtures', 'testdata')
       builder = GEPUB::Builder.new {

data/spec/gepub_spec.rb

@@ -158,6 +158,16 @@ EOF
     system 'java', '-jar', jar, epubname
   end
 
+  it "should generate correct epub with buffer" do
+    epubname = File.join(File.dirname(__FILE__), 'testepub_buf.epub')
+    File.open(epubname, 'wb') {
+      |io|
+      io.write @book.generate_epub_stream.string
+    }
+    jar = File.join(File.dirname(__FILE__), 'fixtures/epubcheck-3.0b4/epubcheck-3.0b4.jar')
+    system 'java', '-jar', jar, epubname
+  end
+
   it "should generate correct epub2.0" do
     epubname = File.join(File.dirname(__FILE__), 'testepub2.epub')
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gepub
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-24 00:00:00.000000000 Z
+date: 2012-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70335408467760 !ruby/object:Gem::Requirement
+  requirement: &70317965172840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '2'
   type: :development
   prerelease: false
-  version_requirements: *70335408467760
+  version_requirements: *70317965172840
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70335408467260 !ruby/object:Gem::Requirement
+  requirement: &70317964165820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70335408467260
+  version_requirements: *70317964165820
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: &70335408466800 !ruby/object:Gem::Requirement
+  requirement: &70317964163220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: 0.9.6
   type: :runtime
   prerelease: false
-  version_requirements: *70335408466800
+  version_requirements: *70317964163220
 description: gepub is a generic EPUB parser/generator. Generates and parse EPUB2 and
   EPUB3
 email:
@@ -53,7 +53,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
 - .gitignore
 - .travis.yml
 - Gemfile

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-