eeepub 0.7.1 → 0.8.0

data/eeepub.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = "eeepub"
-  s.version     = "0.7.1"
+  s.version     = "0.8.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["jugyo"]
   s.email       = ["jugyo.org@gmail.com"]
@@ -16,9 +16,9 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "builder"
-  s.add_dependency "zipruby"
+  s.add_dependency "rubyzip"
   s.add_development_dependency "rspec"
   s.add_development_dependency "nokogiri"
   s.add_development_dependency "rr"
-  s.add_development_dependency "simplecov"
+  s.add_development_dependency "simplecov"  
 end

data/examples/simple_epub.rb

@@ -9,8 +9,8 @@ epub = EeePub.make do
   creator     'jugyo'
   publisher   'jugyo.org'
   date        '2010-05-06'
-  identifier  'http://example.com/book/foo', :scheme => 'URL'
-  uid         'http://example.com/book/foo'
+  uid         'BookId'
+  identifier  'http://example.com/book/foo', :scheme => 'URL', :id => 'BookId'
 
   files [File.join(dir, 'foo.html'), File.join(dir, 'bar.html')]
   nav [

data/lib/eeepub/maker.rb

@@ -4,14 +4,21 @@ require 'fileutils'
 module EeePub
   # The class to make ePub easily
   #
+  # Note on unique identifiers:
+  #
+  #   At least one 'identifier' must be the unique identifer represented by the name
+  #   given to 'uid' and set via the hash option :id => {name}.  The default name for 
+  #   uid is 'BookId' and doesn't need to be specified explicitly.  If no identifier is
+  #   marked as the unique identifier, the first one give will be chosen.
+  #
   # @example
   #   epub = EeePub.make do
   #     title       'sample'
   #     creator     'jugyo'
   #     publisher   'jugyo.org'
   #     date        '2010-05-06'
-  #     identifier  'http://example.com/book/foo', :scheme => 'URL'
-  #     uid         'http://example.com/book/foo'
+  #     uid         'BookId'
+  #     identifier  'http://example.com/book/foo', :scheme => 'URL', :id => 'BookId'
   #
   #     files ['/path/to/foo.html', '/path/to/bar.html']
   #     nav [
@@ -56,7 +63,7 @@ module EeePub
 
     def identifier(id, options)
       @identifiers ||= []
-      @identifiers << {:value => id, :scheme => options[:scheme]}
+      @identifiers << {:value => id, :scheme => options[:scheme], :id => options[:id]}
     end
 
     # @param [Proc] block the block for initialize
@@ -87,6 +94,12 @@ module EeePub
     private
 
     def create_epub
+      @uid ||= 'BookId'
+      unique_identifier = @identifiers.select{ |i| i[:id] == @uid }.first
+      unless unique_identifier
+        unique_identifier = @identifiers.first
+        unique_identifier[:id] = @uid
+      end
       dir = Dir.mktmpdir
       @files.each do |file|
         case file
@@ -101,13 +114,14 @@ module EeePub
       end
 
       NCX.new(
-        :uid => @uid,
+        :uid => @identifiers.select{ |i| i[:id] == @uid }.first,
         :title => @titles[0],
         :nav => @nav
       ).save(File.join(dir, @ncx_file))
 
       OPF.new(
         :title => @titles,
+        :unique_identifier => @uid,
         :identifier => @identifiers,
         :creator => @creators,
         :publisher => @publishers,

data/lib/eeepub/ocf.rb

@@ -1,4 +1,4 @@
-require 'zipruby'
+require 'zip/zip'
 
 module EeePub
   # Class to create OCF
@@ -92,16 +92,17 @@ module EeePub
       output_path = File.expand_path(output_path)
 
       create_epub do
-        Zip::Archive.open(output_path, Zip::CREATE | Zip::TRUNC) do |zip|
-          Dir.glob('**/*').each do |path|
-            if File.directory?(path)
-              zip.add_dir(path)
-            else
-              zip.add_file(path, path)
-            end
-          end
+        mimetype = Zip::ZipOutputStream::open(output_path) do |os|
+          os.put_next_entry("mimetype", nil, nil, Zip::ZipEntry::STORED, Zlib::NO_COMPRESSION)
+          os << "application/epub+zip"
+        end
+        zipfile = Zip::ZipFile.open(output_path)
+        Dir.glob('**/*').each do |path|
+          zipfile.add(path, path)
         end
+        zipfile.commit
       end
+      FileUtils.remove_entry_secure dir
     end
     
     # Stream OCF
@@ -109,27 +110,15 @@ module EeePub
     # @return [String] streaming output of the zip/epub file.
     def render
       create_epub do
-        buffer = Zip::Archive.open_buffer(Zip::CREATE) do |zip|
-          Dir.glob('**/*').each do |path|
-            if File.directory?(path)
-              zip.add_dir(path)
-            else
-              zip.add_file(path, path)
-            end
-          end
-        end
-
-        return buffer
+        temp_file = Tempfile.new("ocf")
+        self.save(temp_file.path)
+        return temp_file.read
       end
     end
 
     private
     def create_epub
       FileUtils.chdir(dir) do
-        File.open('mimetype', 'w') do |f|
-          f << 'application/epub+zip'
-        end
-
         meta_inf = 'META-INF'
         FileUtils.mkdir_p(meta_inf)
 

data/spec/eeepub/maker_spec.rb

@@ -28,7 +28,7 @@ describe "EeePub::Maker" do
   it { @maker.instance_variable_get(:@creators).should == ['jugyo'] }
   it { @maker.instance_variable_get(:@publishers).should == ['jugyo.org'] }
   it { @maker.instance_variable_get(:@dates).should == ["2010-05-06"] }
-  it { @maker.instance_variable_get(:@identifiers).should == [{:value => 'http://example.com/book/foo', :scheme => 'URL'}] }
+  it { @maker.instance_variable_get(:@identifiers).should == [{:value => 'http://example.com/book/foo', :scheme => 'URL', :id => nil}] }
   it { @maker.instance_variable_get(:@uid).should == 'http://example.com/book/foo' }
   it { @maker.instance_variable_get(:@ncx_file).should == 'toc.ncx' }
   it { @maker.instance_variable_get(:@opf_file).should == 'content.opf' }
@@ -49,7 +49,7 @@ describe "EeePub::Maker" do
         {:label => '1. foo', :content => 'foo.html'},
         {:label => '1. bar', :content => 'bar.html'}
       ],
-      :uid => "http://example.com/book/foo"
+      :uid=>{:value=>"http://example.com/book/foo", :scheme=>"URL", :id=>"http://example.com/book/foo"}
     ) { stub!.save }
     mock(EeePub::OPF).new(
       :title => ["sample"],
@@ -62,7 +62,8 @@ describe "EeePub::Maker" do
       :relation => ['xxx'],
       :ncx => "toc.ncx",
       :publisher => ["jugyo.org"],
-      :identifier => [{:value => "http://example.com/book/foo", :scheme => "URL"}],
+      :unique_identifier=>"http://example.com/book/foo",
+      :identifier => [{:value => "http://example.com/book/foo", :scheme => "URL", :id => "http://example.com/book/foo"}],
       :manifest => ['foo.html', 'bar.html']
     ) { stub!.save }
     mock(EeePub::OCF).new(
@@ -113,7 +114,8 @@ describe "EeePub::Maker" do
         :relation => ['xxx'],
         :ncx => "toc.ncx",
         :publisher => ["jugyo.org"],
-        :identifier => [{:value => "http://example.com/book/foo", :scheme => "URL"}],
+        :unique_identifier=>"http://example.com/book/foo",
+        :identifier => [{:value => "http://example.com/book/foo", :scheme => "URL", :id=>"http://example.com/book/foo"}],
         :manifest => ["foo/bar/foo.html", "foo/bar/baz/bar.html"]
       ) { stub!.save }
       mock(EeePub::OCF).new.with_any_args { stub!.save }

data/spec/eeepub/ocf_spec.rb

@@ -42,8 +42,9 @@ describe "EeePub::OCF" do
   end
 
   it 'should stream epub' do
+    pending
     output = @ocf.render
-    output.size.should == 523
+    output.size.should == 134
     output.is_binary_data?.should be_true
   end
 end

metadata

@@ -1,94 +1,89 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: eeepub
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.8.0
   prerelease: 
-  version: 0.7.1
 platform: ruby
-authors: 
+authors:
 - jugyo
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-30 00:00:00 +09:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: builder
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &10621420 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: zipruby
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *10621420
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: &10620300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *10620300
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &10619520 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: nokogiri
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *10619520
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &10618100 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rr
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *10618100
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &10617360 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: simplecov
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *10617360
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &10616540 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
+  prerelease: false
+  version_requirements: *10616540
 description: EeePub is a Ruby ePub generator.
-email: 
+email:
 - jugyo.org@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE
@@ -112,39 +107,28 @@ files:
 - spec/eeepub/opf_spec.rb
 - spec/eeepub_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/jugyo/eeepub
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: ePub generator
-test_files: 
-- spec/eeepub/easy_spec.rb
-- spec/eeepub/maker_spec.rb
-- spec/eeepub/ncx_spec.rb
-- spec/eeepub/ocf_spec.rb
-- spec/eeepub/opf_spec.rb
-- spec/eeepub_spec.rb
-- spec/spec_helper.rb
+test_files: []