eeepub3 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e37fdd0df050b43117eb43439f4f2dba67cc9f96
+  data.tar.gz: 7e5a05e05a17afbdcd72c3c3a6ed2269c16c51d9
+SHA512:
+  metadata.gz: e1587a96ace135f869eb4494d2c087e5dac8aedf7977140fa1bfe54469e12a3eb3bede7e099823ec7875d60a52d48c6f7af6527d1b859d421c9cb494135f0c97
+  data.tar.gz: 43d500fe967d569fbba17c71712eb6dfed33119cb6ca6dffd03c61808b939574659e7ab59d9e6ff07bd10eee880f318e5e179ee44087c8d8f39f12bb1438c5b9

data/Gemfile

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

data/README.md

@@ -0,0 +1,4 @@
+eeepub3
+=======
+
+EPUB3 tools

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/eeepub3.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = "eeepub3"
+  s.version     = "0.0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["bubaz"]
+  s.email       = ["s.bubovich@gmail.com"]
+  s.homepage    = "http://github.com/bubaz/eeepub3"
+  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/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,116 @@
+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)
+      ext = File.extname(filename)
+      mimes = {
+        '.png' => 'image/png',
+        '.js' => 'application/x-javascript',
+        '.html' => 'application/xhtml+xml',
+        '.jpeg' => 'image/jpeg',
+        '.jpg' => 'image/jpeg',
+        '.gif' => 'image/gif',
+        '.svg' => 'image/svg+xml',
+        '.ncx' => 'application/x-dtbncx+xml',
+        '.css' => 'text/css',
+        '.less' => 'text/plain', #explicit not text/css because of validation failure
+        '.mp4' => 'video/mp4',
+        '.mp3' => 'audio/mpeg',
+        '.webm' => 'video/webm',
+        '.woff' => 'application/font-woff',
+        '.otf' => 'application/vnd.ms-opentype',
+        '.ttf' => 'application/vnd.ms-opentype',
+        '.eot' => 'application/vnd.ms-opentype',
+        '.db' =>'application/octet-stream',  #explicit,
+        '.nes'=>'text/plain; charset=x-user-defined', #explicit
+        '.txt'=>'text/plain'
+      }
+
+      mimes[ext] || 'application/octet-stream'
+
+    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

data/lib/eeepub/maker.rb

@@ -0,0 +1,156 @@
+require 'tmpdir'
+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'
+  #     uid         'BookId'
+  #     identifier  'http://example.com/book/foo', :scheme => 'URL', :id => 'BookId'
+  #
+  #     files ['/path/to/foo.html', '/path/to/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'}
+  #     ]
+  #   end
+  #   epub.save('sample.epub')
+  class Maker
+    [
+      :title,
+      :creator,
+      :publisher,
+      :date,
+      :language,
+      :subject,
+      :description,
+      :rights,
+      :relation
+    ].each do |name|
+      class_eval <<-DELIM
+        def #{name}(value)
+          @#{name}s ||= []
+          @#{name}s << value
+        end
+      DELIM
+    end
+
+    [
+      :uid,
+      :files,
+      :nav,
+      :cover,
+      :ncx_file,
+      :opf_file,
+      :guide
+    ].each do |name|
+      define_method(name) do |arg|
+        instance_variable_set("@#{name}", arg)
+      end
+    end
+
+    def identifier(id, options)
+      @identifiers ||= []
+      @identifiers << {:value => id, :scheme => options[:scheme], :id => options[:id]}
+    end
+
+    # @param [Proc] block the block for initialize
+    def initialize(&block)
+      @files ||= []
+      @nav ||= []
+      @ncx_file ||= 'toc.ncx'
+      @opf_file ||= 'content.opf'
+
+      instance_eval(&block) if block_given?
+    end
+
+    # Save as ePub file
+    #
+    # @param [String] filename the ePub file name to save
+    def save(filename)
+      create_epub.save(filename)
+    end
+
+    # instead of saving to file, output the file contents.
+    # important for serving on-the-fly doc creation from
+    # web interface where we don't want to allow file system
+    # writes (Heroku, et al.)
+    def render
+      create_epub.render
+    end
+
+    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
+        when String
+          FileUtils.cp(file, dir)
+        when Hash
+          file_path, dir_path = *file.first
+          dest_dir = File.join(dir, dir_path)
+          FileUtils.mkdir_p(dest_dir)
+          FileUtils.cp(file_path, dest_dir)
+        end
+      end
+
+      NCX.new(
+        :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,
+        :date => @dates,
+        :language => @languages,
+        :subject => @subjects,
+        :description => @descriptions,
+        :rights => @rightss,
+        :cover => @cover,
+        :relation => @relations,
+        :manifest => @files.map{|file|
+          case file
+          when String
+            File.basename(file)
+          when Hash
+            file_path, dir_path = *file.first
+            File.join(dir_path, File.basename(file_path))
+          end
+        },
+        :ncx => @ncx_file,
+        :guide => @guide
+      ).save(File.join(dir, @opf_file))
+
+      OCF.new(
+        :dir => dir,
+        :container => @opf_file
+      )
+    end
+  end
+end