RubyGems - gepub - Versions diffs - 0.0.1 - Mend

gepub 0.0.1

Files changed (14) hide show

data/History.txt ADDED Viewed

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-05-05
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt ADDED Viewed

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/gepub.rb
+lib/gepub/generator.rb
+script/console
+script/destroy
+script/generate
+spec/gepub_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/README.rdoc ADDED Viewed

@@ -0,0 +1,110 @@
+= gepub
+* http://github.com/skoji/gepub
+== DESCRIPTION:
+a good-enough EPUB generator library.
+== FEATURES/PROBLEMS:
+* GEPUB::Generator provides functionality to create ncx/opf, and epub file.
+* opf: can't specify creators with role
+* opf: can't specify date with event
+* opf: unique-identifier's scheme is fixed to 'URL'
+* ncx: can't nest navPoint elements
+* ...and many other restrictions
+== SYNOPSIS:
+  require 'rubygems'
+  require 'gepub'
+  require 'fileutils'
+  epubdir = "testepub"
+  title = "samplepub"
+  FileUtils.rm_rf(epubdir)
+  FileUtils.mkdir(epubdir)
+  epub = GEPUB::Generator.new(title)
+  epub.author="the author"
+  epub.publisher="the publisher"
+  epub.date = "2010-05-03"
+  epub.identifier = "http://www.skoji.jp/testepub/2010-05-03"
+  # create test contents files
+  [ 'coverpage', 'chapter1', 'chapter2' ].each {
+  |name|
+  File.open(epubdir + "/#{name}.html", 'w') {
+  |file|
+  file << <<EOF
+  <?xml version="1.0" encoding="UTF-8"?>
+  <html xmlns="http://www.w3.org/1999/xhtml" lang="ja" xml:lang="ja">
+  <head>
+  <title>sample #{name} </title>
+  </head>
+  <body>
+  <h1>#{name}</h1>
+  <p>here comes the contents for #{name}</p>
+  </body>
+  </html>
+  EOF
+  }
+  }
+  # coverpage won't appear on toc, so do not call addNav
+  epub.addManifest('cover', "coverpage.html", 'application/xhtml+xml')
+  epub.spine.push('cover')
+  epub.addManifest('chap1', "chapter1.html", 'application/xhtml+xml')
+  epub.spine.push('chap1')
+  epub.addNav('chap1', 'Chapter 1', "chapter1.html")
+  epub.addManifest('chap2', "chapter2.html", 'application/xhtml+xml')
+  epub.spine.push('chap2')
+  epub.addNav('chap1', 'Chapter 2', "chapter2.html")
+  epub.create(epubdir)
+  epub.create_epub(epubdir, ".")
+== REQUIREMENTS:
+* LibXML
+== INSTALL:
+* rake install_gem
+== LICENSE:
+(The New BSD License)
+Copyright (c) 2010, KOJIMA Satoshi
+All rights reserved.
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the <organization> nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile ADDED Viewed

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/gepub'
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'gepub' do
+  self.developer 'KOJIMA Satoshi', 'skoji@skoji.jp'
+#  self.post_install_message = 'PostInstall.txt'
+#  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+end
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/gepub.rb ADDED Viewed

@@ -0,0 +1,8 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+require 'gepub/generator'
+module GEPUB
+  VERSION = '0.0.1'
+end

data/lib/gepub/generator.rb ADDED Viewed

@@ -0,0 +1,225 @@
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'xml/libxml'
+require 'fileutils'
+module GEPUB
+  class Generator
+    attr_accessor :spine
+    def initialize(title)
+      @metadata = Hash.new
+      @manifest = Hash.new
+      @spine = Array.new
+      @toc = Array.new
+      @metadata[:title] = title
+      @manifest['ncx'] = { :href => 'toc.ncx', :mediatype => 'application/x-dtbncx+xml' }
+    end
+    def title
+      @metadata[:title]
+    end
+    def title=(title)
+      @metadata[:title] = title
+    end
+    def author
+      @metadata[:creator]
+    end
+    def author=(author)
+      @metadata[:creator] = author
+    end
+    def publisher
+      @metadata[:publisher]
+    end
+    def publisher=(publisher)
+      @metadata[:publisher] = publisher
+    end
+    def date
+      @metadata[:date]
+    end
+    def date=(date)
+      @metadata[:date] = date
+    end
+    def identifier
+      @metadata[:itentifier]
+    end
+    def identifier=(id)
+      @metadata[:identifier] = id
+    end
+    def addManifest(id, href, mediatype)
+      @manifest[id] = { :href => href, :mediatype => mediatype }
+    end
+    def addNav(id, text, ref)
+      @toc.push({ :id => id, :text => text, :ref => ref})
+    end
+    def create(destdir)
+      create_mimetype(destdir)
+      create_container(destdir)
+      create_toc(destdir)
+      create_opf(destdir)
+    end
+    def create_epub(destdir, targetdir, epubname = @metadata[:title])
+      realtarget = File::expand_path(targetdir)
+      FileUtils.cd("#{destdir}") {
+        |dir|
+        epubname = "#{realtarget}/#{epubname}.epub"
+        %x(zip -0X \"#{epubname}\" \"mimetype\")
+        %x(zip -r9XD \"#{epubname}\" * -x mimetype)
+      }
+    end
+    def mimetype_contents
+      <<EOF
+application/epub+zip
+EOF
+    end
+    def create_mimetype(destdir)
+      File.open(destdir + '/mimetype', 'w') {
+        | file |
+        file << mimetype_contents
+      }
+    end
+    def container_xml
+      <<EOF
+<?xml version="1.0" encoding="UTF-8"?>
+<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
+  <rootfiles>
+    <rootfile full-path="content.opf" media-type="application/oebps-package+xml"/>
+  </rootfiles>
+</container>
+EOF
+    end
+    def create_container(destdir)
+      infdir = destdir + "/META-INF"
+      Dir.mkdir(infdir) if !File.exist?(infdir)
+      File.open(infdir + "/container.xml", 'w') {
+        |file|
+        file << container_xml
+      }
+    end
+    def opf_xml
+      result = XML::Document.new
+      result.root = XML::Node.new('package')
+      package = result.root
+      XML::Namespace.new(package, nil, 'http://www.idpf.org/2007/opf')
+      package['version'] = '2.0'
+      package['unique-identifier'] = 'BookID'
+      package << metadataelem = XML::Node.new('metadata')
+      XML::Namespace.new(metadataelem, 'opf', 'http://www.idpf.org/2007/opf')
+      XML::Namespace.new(metadataelem, 'dc', "http://purl.org/dc/elements/1.1/")
+      metadataelem << XML::Node.new('dc:language', 'ja')
+      @metadata.each { | k, v |
+        metadataelem << node = XML::Node.new("dc:#{k}",v)
+        if (k == :identifier)
+          node['id'] = 'BookID'
+          node['opf:scheme'] = 'URL'
+        end
+      }
+      package << manifestelem = XML::Node.new('manifest')
+      @manifest.each {|k,v|
+        manifestelem << node = XML::Node.new("item")
+        node['id'] = "#{k}"
+        node['href'] = "#{v[:href]}"
+        node['media-type'] = "#{v[:mediatype]}"
+      }
+      package << spineelem = XML::Node.new('spine')
+      spineelem['toc'] = 'ncx'
+      @spine.each {
+        |v|
+        spineelem << node = XML::Node.new('itemref')
+        node['idref'] = "#{v}"
+      }
+      result.to_s
+    end
+    def create_opf(destdir)
+      File.open(destdir + "/content.opf", 'w') { | file | file << opf_xml }
+    end
+    def ncx_xml
+      result = XML::Document.new
+      result.root = XML::Node.new('ncx')
+      root = result.root
+      XML::Namespace.new(root, nil, "http://www.daisy.org/z3986/2005/ncx/")
+      root['version'] = "2005-1"
+      root << head = XML::Node.new('head')
+      head << uid = XML::Node.new('meta')
+      uid['name'] = 'dtb:uid'
+      uid['content'] = "#{@metadata[:identifier]}"
+      head << depth = XML::Node.new('meta')
+      depth['name'] = 'dtb:depth'
+      depth['content'] = '1'
+      head << totalPageCount = XML::Node.new('meta')
+      totalPageCount['name'] = 'dtb:totalPageCount'
+      totalPageCount['content'] = '0'
+      head << maxPageNumber = XML::Node.new('meta')
+      maxPageNumber['name'] = 'dtb:maxPageNumber'
+      maxPageNumber['content'] = '0'
+      root << docTitle = XML::Node.new('docTitle')
+      docTitle << XML::Node.new('text', "#{@metadata[:title]}")
+      root << nav_map = XML::Node.new('navMap')
+      count = 1
+      @toc.each {
+        |x|
+        nav_point = XML::Node.new('navPoint')
+        nav_point['id'] = "#{x[:id]}"
+        nav_point['playOrder'] = "#{count}"
+        nav_label = XML::Node.new('navLabel')
+        nav_label << XML::Node.new('text', "#{x[:text]}")
+        nav_content = XML::Node.new('content')
+        nav_content['src'] = "#{x[:ref]}"
+        count = count + 1
+        nav_map << nav_point
+        nav_point << nav_label
+        nav_point << nav_content
+      }
+      result.to_s
+    end
+    def create_toc(destdir)
+      File.open(destdir + "/toc.ncx", 'w') {
+        |file|
+        file << ncx_xml
+      }
+    end
+  end
+end

data/script/console ADDED Viewed

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/gepub.rb'}"
+puts "Loading gepub gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy ADDED Viewed

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate ADDED Viewed

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/gepub_spec.rb ADDED Viewed

@@ -0,0 +1,115 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'rubygems'
+require 'xml/libxml'
+# for parsing only elements. DO I REALLY NEED THIS !?
+class LibXML::XML::Node
+  def next_element
+    r = self.next
+    r = r.next while !r.element?
+    r
+  end
+  def first_child_element
+    r = self.first
+    r = r.next_element if !r.element?
+    r
+  end
+end
+describe GEPUB::Generator do
+  before do
+    @generator = GEPUB::Generator.new('thetitle')
+    @generator.author = "theauthor"
+    @generator.publisher = "thepublisher"
+    @generator.date = "2010-05-05"
+    @generator.identifier = "http://example.jp/foobar/"
+    @generator.addManifest('c1', 'foobar.html', 'foo/bar')
+    @generator.addNav('c2', 'test chapter', 'foobar2.html')
+    @generator.spine.push('c1')
+  end
+  it "should have titile"  do
+    @generator.title.should == 'thetitle'
+  end
+  it "should generate correct ncx"  do
+    ncx = LibXML::XML::Parser.string(@generator.ncx_xml).parse
+    ncx.root.name.should == 'ncx'
+    ncx.root.attributes['version'].should == '2005-1'
+    ncx.root.namespaces.namespace.href.should == 'http://www.daisy.org/z3986/2005/ncx/'
+  end
+  it "should have correct head in ncx" do
+    ncx = LibXML::XML::Parser.string(@generator.ncx_xml).parse
+    ncx.root.namespaces.default_prefix='a'
+    ncx.find_first('a:head').should_not be_nil
+    ncx.find_first("a:head/a:meta[@name='dtb:uid']")['content'].should == "http://example.jp/foobar/"
+    ncx.find_first("a:head/a:meta[@name='dtb:depth']").should_not be_nil
+    ncx.find_first("a:head/a:meta[@name='dtb:totalPageCount']").should_not be_nil
+    ncx.find_first("a:head/a:meta[@name='dtb:maxPageNumber']").should_not be_nil
+  end
+  it "should have correct ncx doctitle" do
+    ncx = LibXML::XML::Parser.string(@generator.ncx_xml).parse
+    ncx.root.namespaces.default_prefix='a'
+    ncx.root.find_first('a:docTitle').should_not be_nil
+    ncx.root.find_first('a:docTitle/a:text').content.should == 'thetitle'
+  end
+  it "should correct ncx navmap" do
+    ncx = LibXML::XML::Parser.string(@generator.ncx_xml).parse
+    ncx.root.namespaces.default_prefix='a'
+    ncx.root.find_first('a:navMap').should_not be_nil
+    nav_point = ncx.root.find_first('a:navMap/a:navPoint')
+    nav_point['id'].should == 'c2'
+    nav_point['playOrder'].should == '1'
+    nav_point.find_first('a:navLabel/a:text').content.should == 'test chapter'
+    nav_point.find_first('a:content')['src'] == 'foobar2.html'
+  end
+  it "should create correct opf" do
+    opf = LibXML::XML::Parser.string(@generator.opf_xml).parse
+    opf.root.namespaces.default_prefix='a'
+    opf.root.name.should == 'package'
+    opf.root.namespaces.namespace.href.should == 'http://www.idpf.org/2007/opf'
+    opf.root['version'] == '2.0'
+    opf.root['unique-identifier'] == 'http://example.jp/foobar/'
+  end
+  it "should have correct metadata in opf" do
+    opf = LibXML::XML::Parser.string(@generator.opf_xml).parse
+    opf.root.namespaces.default_prefix='a'
+    metadata = opf.find_first('a:metadata')
+    metadata.find_first('dc:language').content.should == 'ja'
+    # TODO checking metadatas...
+  end
+  it "should have correct manifest and spine in opf" do
+    opf = LibXML::XML::Parser.string(@generator.opf_xml).parse
+    opf.root.namespaces.default_prefix='a'
+    manifest = opf.find_first('a:manifest')
+    manifest.find_first('a:item')['id'].should == 'c1'
+    manifest.find_first('a:item')['href'].should == 'foobar.html'
+    manifest.find_first('a:item')['media-type'].should == 'foo/bar'
+    spine = opf.find_first('a:spine')
+    spine['toc'].should == 'ncx'
+    spine.find_first('a:itemref')['idref'].should == 'c1'
+  end
+end

data/spec/spec.opts ADDED Viewed

	@@ -0,0 +1 @@
1	+ --colour

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'gepub'

data/tasks/rspec.rake ADDED Viewed

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata ADDED Viewed

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: gepub
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- KOJIMA Satoshi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-05-05 00:00:00 +09:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyforge
+  type: :development
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+    version:
+- !ruby/object:Gem::Dependency
+  name: hoe
+  type: :development
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+    version:
+description: a good-enough EPUB generator library.
+email:
+- skoji@skoji.jp
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+files:
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/gepub.rb
+- lib/gepub/generator.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/gepub_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/skoji/gepub
+licenses: []
+post_install_message:
+rdoc_options:
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project: gepub
+rubygems_version: 1.3.5
+signing_key:
+specification_version: 3
+summary: a good-enough EPUB generator library.
+test_files: []