eeepub-with-cover-support 0.8.6

data/.gitignore

@@ -0,0 +1,8 @@
+*.sw?
+.DS_Store
+coverage
+doc
+pkg
+*.epub
+.rvmrc
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in eeepub.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 jugyo
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+EeePub
+======
+
+EeePub is a Ruby ePub generator.
+
+Usage
+-------
+
+    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'
+
+      files ['/path/to/foo.html', '/path/to/bar.html'] # or files [{'/path/to/foo.html' => 'dest/dir'}, {'/path/to/bar.html' => 'dest/dir'}]
+      nav [
+        {:label => '1. foo', :content => 'foo.html', :nav => [
+          {:label => '1.1 foo-1', :content => 'foo.html#foo-1'}
+        ]},
+        {:label => '1. bar', :content => 'bar.html'}
+      ]
+    end
+    epub.save('sample.epub')
+
+### Low Level API
+
+Create NCX:
+
+    EeePub::NCX.new(
+      :uid => 'xxxx',
+      :title => 'sample',
+      :nav => [
+        {:label => '1. foo', :content => 'foo.html'},
+        {:label => '2. bar', :content => 'bar.html'}
+      ]
+    ).save(File.join('sample', 'toc.ncx'))
+
+Create OPF:
+
+    EeePub::OPF.new(
+      :title => 'sample',
+      :identifier => {:value => '0-0000000-0-0', :scheme => 'ISBN'},
+      :manifest => ['foo.html', 'bar.html'],
+      :ncx => 'toc.ncx'
+    ).save(File.join('sample', 'content.opf'))
+
+Create OCF and ePub file:
+
+    EeePub::OCF.new(
+      :dir => 'sample',
+      :container => 'content.opf'
+    ).save('sample.epub')
+
+Install
+-------
+
+    gem install eeepub
+
+Requirements
+-------
+
+* builder
+* eBook Reader :)
+
+Links
+-------
+
+* Documentation: [http://yardoc.org/docs/jugyo-eeepub](http://yardoc.org/docs/jugyo-eeepub)
+* Source code: [http://github.com/jugyo/eeepub](http://github.com/jugyo/eeepub)
+
+Copyright
+-------
+
+Copyright (c) 2010 jugyo. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new do |t|
+    t.rspec_opts = ['--color']
+  end
+rescue LoadError => e
+  puts "RSpec not installed"
+end
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/eeepub.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = "eeepub-with-cover-support"
+  s.version     = "0.8.6"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["jugyo"]
+  s.email       = ["jugyo.org@gmail.com"]
+  s.homepage    = "http://github.com/jugyo/eeepub"
+  s.summary     = %q{ePub generator}
+  s.description = %q{EeePub is a Ruby ePub generator.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "builder"
+  s.add_dependency "rubyzip"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "nokogiri"
+  s.add_development_dependency "rr"
+  s.add_development_dependency "simplecov"  
+end

data/examples/files/bar.html

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja">
+  <head>
+    <title></title>
+  </head>
+  <body>
+    <h1>bar</h1>
+
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+
+    <h2 id="bar-1">bar-1</h2>
+
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+  </body>
+</html>

data/examples/files/foo.html

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja">
+  <head>
+    <title></title>
+  </head>
+  <body>
+    <h1>foo</h1>
+
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+
+    <h2 id="foo-1">foo-1</h2>
+
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+    <p>foo foo foo foo</p>
+    <p>bar bar bar bar</p>
+  </body>
+</html>

data/examples/files/toc.html

@@ -0,0 +1,22 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xml:lang='en' xmlns='http://www.w3.org/1999/xhtml'>
+  <head>
+    <meta content='application/xhtml+xml; charset=utf-8' http-equiv='Content-Type' />
+    <title>Table of Contents</title>
+  </head>
+  <body>
+    <div id='toc'>
+        <ul>
+          <li>
+          <a href='foo.html'>Chapter 1</a>
+          </li>
+        </ul>
+        <ul>
+          <li>
+          <a href='bar.html'>Chapter 2</a>
+          </li>
+        </ul>
+    </div>
+  </body>
+</html>

data/examples/simple_epub.rb

@@ -0,0 +1,27 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'rubygems'
+require 'eeepub'
+
+dir = File.join(File.dirname(__FILE__), 'files')
+
+epub = EeePub.make do
+  title       'sample'
+  creator     'jugyo'
+  publisher   'jugyo.org'
+  date        '2010-05-06'
+  uid         'BookId'
+  identifier  'http://example.com/book/foo', :scheme => 'URL', :id => 'BookId'
+
+  files [File.join(dir, 'foo.html'), File.join(dir, 'bar.html')]
+  nav [
+    {:label => '1. foo', :content => 'foo.html', :nav => [
+      {:label => '1.1 foo-1', :content => 'foo.html#foo-1'}
+    ]},
+    {:label => '1. bar', :content => 'bar.html'}
+  ]
+  cover_page File.join(dir, 'cover.jpg')
+  toc_page File.join(dir, 'toc.html')
+end
+epub.save('sample.epub')
+
+puts "complete! => 'sample.epub'"

data/lib/eeepub.rb

@@ -0,0 +1,15 @@
+require 'eeepub/container_item'
+require 'eeepub/opf'
+require 'eeepub/ocf'
+require 'eeepub/ncx'
+require 'eeepub/maker'
+require 'eeepub/easy'
+
+module EeePub
+  # Make ePub
+  #
+  # @param [Proc] block the block for initialize EeePub::Maker
+  def self.make(&block)
+    EeePub::Maker.new(&block)
+  end
+end

data/lib/eeepub/container_item.rb

@@ -0,0 +1,108 @@
+require 'builder'
+
+module EeePub
+  # Abstract base class for container item of ePub. Provides some helper methods.
+  #
+  # @abstract
+  class ContainerItem
+    class << self
+
+      private
+
+      # Set default value to attribute
+      #
+      # @param [Symbol] name the attribute name
+      # @param [Object] default the default value
+      def default_value(name, default)
+        instance_variable_name = "@#{name}"
+        define_method(name) do
+          self.instance_variable_get(instance_variable_name) ||
+            self.instance_variable_set(instance_variable_name, default)
+        end
+      end
+
+      # Define alias of attribute accessor
+      #
+      # @param [Symbol] name the attribute name as alias
+      # @param [Symbol] name the attribute name as source
+      def attr_alias(name, src)
+        alias_method name, src
+        alias_method :"#{name}=", :"#{src}="
+      end
+    end
+
+    # @param [Hash<Symbol, Object>] values the hash of symbols and objects for attributes
+    def initialize(values)
+      set_values(values)
+    end
+
+    # Set values for attributes
+    #
+    # @param [Hash<Symbol, Object>] values the hash of symbols and objects for attributes
+    def set_values(values)
+      values.each do |k, v|
+        self.send(:"#{k}=", v)
+      end
+    end
+
+    # Convert to xml of container item
+    #
+    # @return [String] the xml of container item
+    def to_xml
+      out = ""
+      builder = Builder::XmlMarkup.new(:target => out, :indent => 2)
+      builder.instruct!
+      build_xml(builder)
+      out
+    end
+
+    # Save as container item
+    #
+    # @param [String] filepath the file path for container item
+    def save(filepath)
+      File.open(filepath, 'w') do |file|
+        file << self.to_xml
+      end
+    end
+
+    private
+
+    # Guess media type from file name
+    #
+    # @param [String] filename the file name
+    # @return [String] the media-type
+    def guess_media_type(filename)
+      case filename
+      when /.*\.x?html?$/i
+        'application/xhtml+xml'
+      when /.*\.css$/i
+        'text/css'
+      when /.*\.(jpeg|jpg)$/
+        'image/jpeg'
+      when /.*\.png$/i
+        'image/png'
+      when /.*\.gif$/i
+        'image/gif'
+      when /.*\.svg$/i
+        'image/svg+xml'
+      when /.*\.ncx$/i
+        'application/x-dtbncx+xml'
+      when /.*\.opf$/i
+        'application/oebps-package+xml'
+      end
+    end
+
+    # Convert options for xml attributes
+    #
+    # @param [Hash<Symbol, Object>] hash the hash of symbols and objects for xml attributes
+    # @return [Hash<String, Object>] the options for xml attributes
+    def convert_to_xml_attributes(hash)
+      result = {}
+      hash.each do |k, v|
+        key = k.to_s.gsub('_', '-').to_sym
+        result[key] = v
+      end
+      result
+    end
+  end
+end

data/lib/eeepub/easy.rb

@@ -0,0 +1,100 @@
+require 'tmpdir'
+require 'fileutils'
+
+module EeePub
+  # The class to make ePub more easily
+  #
+  # @example
+  #   epub = EeePub::Easy.new do
+  #     title 'sample'
+  #     creator 'jugyo'
+  #     identifier 'http://example.com/book/foo', :scheme => 'URL'
+  #     uid 'http://example.com/book/foo'
+  #   end
+  #   
+  #   epub.sections << ['1. foo', <<HTML]
+  #   <?xml version="1.0" encoding="UTF-8"?>
+  #   <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+  #   <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja">
+  #     <head>
+  #       <title>foo</title>
+  #     </head>
+  #     <body>
+  #       <p>
+  #       foo foo foo foo foo foo
+  #       </p>
+  #     </body>
+  #   </html>
+  #   HTML
+  #   
+  #   epub.assets << 'image.png'
+  #   
+  #   epub.save('sample.epub')
+  class Easy < EeePub::Maker
+    attr_reader :sections, :assets
+
+    # @param [Proc] block the block for initialize
+    def initialize(&block)
+      @sections = []
+      @assets = []
+      super
+    end
+
+    # Save as ePub file
+    #
+    # @param [String] filename the ePub file name to save
+    def save(filename)
+      Dir.mktmpdir do |dir|
+        prepare(dir)
+
+        NCX.new(
+          :uid => @uid,
+          :title => @titles[0],
+          :nav => @nav
+        ).save(File.join(dir, @ncx_file))
+
+        OPF.new(
+          :title => @titles,
+          :identifier => @identifiers,
+          :creator => @creators,
+          :publisher => @publishers,
+          :date => @dates,
+          :language => @languages,
+          :subject => @subjects,
+          :description => @descriptions,
+          :rights => @rightss,
+          :relation => @relations,
+          :manifest => @files.map{|i| File.basename(i)},
+          :ncx => @ncx_file
+        ).save(File.join(dir, @opf_file))
+
+        OCF.new(
+          :dir => dir,
+          :container => @opf_file
+        ).save(filename)
+      end
+    end
+
+    private
+
+    def prepare(dir)
+      filenames = []
+      sections.each_with_index do |section, index|
+        filename = File.join(dir, "section_#{index}.html")
+        File.open(filename, 'w') { |file| file.write section[1] }
+        filenames << filename
+      end
+
+      assets.each do |file|
+        FileUtils.cp(file, dir)
+      end
+
+      files(filenames + assets)
+      nav(
+        [sections, filenames].transpose.map do |section, filename|
+          {:label => section[0], :content => File.basename(filename)}
+        end
+      )
+    end
+  end
+end