walterdavis-eeepub 0.6.2

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,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "walterdavis-eeepub"
+    gem.summary = %Q{ePub generator}
+    gem.description = %Q{EeePub is a Ruby ePub generator. This version is forked from the original https://github.com/jugyo/eeepub}
+    gem.email = "waltd@wdstudio.com"
+    gem.homepage = "http://github.com/walterdavis/eeepub"
+    gem.authors = ["jugyo", "walterdavis"]
+    gem.add_dependency "builder"
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "rr"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+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/VERSION

@@ -0,0 +1 @@
+0.6.2

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/simple_epub.rb

@@ -0,0 +1,26 @@
+$:.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'
+  author      'foo bar'
+  date        '2010-05-06'
+  identifier  'http://example.com/book/foo', :scheme => 'URL'
+  uid         'http://example.com/book/foo'
+
+  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'}
+  ]
+end
+epub.save('sample.epub')
+
+puts "complete! => 'sample.epub'"

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 /.*\.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,101 @@
+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,
+          :author => @authors,
+          :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,127 @@
+require 'tmpdir'
+require 'fileutils'
+
+module EeePub
+  # The class to make ePub easily
+  #
+  # @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'
+  #
+  #     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,
+      :author,
+      :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,
+      :ncx_file,
+      :opf_file
+    ].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]}
+    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)
+      Dir.mktmpdir do |dir|
+        @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 => @uid,
+          :title => @titles[0],
+          :nav => @nav
+        ).save(File.join(dir, @ncx_file))
+
+        OPF.new(
+          :title => @titles,
+          :identifier => @identifiers,
+          :creator => @creators,
+          :author => @authors,
+          :publisher => @publishers,
+          :date => @dates,
+          :language => @languages,
+          :subject => @subjects,
+          :description => @descriptions,
+          :rights => @rightss,
+          :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
+        ).save(File.join(dir, @opf_file))
+
+        OCF.new(
+          :dir => dir,
+          :container => @opf_file
+        ).save(filename)
+      end
+    end
+  end
+end

data/lib/eeepub/ncx.rb

@@ -0,0 +1,68 @@
+module EeePub
+  class NCX < ContainerItem
+    attr_accessor :uid,
+                  :depth,
+                  :total_page_count,
+                  :max_page_number,
+                  :doc_title,
+                  :nav_map
+
+    attr_alias :title, :doc_title
+    attr_alias :nav, :nav_map
+
+    default_value :depth, 1
+    default_value :total_page_count, 0
+    default_value :max_page_number, 0
+    default_value :doc_title, 'Untitled'
+
+    def build_xml(builder)
+      builder.declare! :DOCTYPE, :ncx, :PUBLIC, "-//NISO//DTD ncx 2005-1//EN", "http://www.daisy.org/z3986/2005/ncx-2005-1.dtd"
+      builder.ncx :xmlns => "http://www.daisy.org/z3986/2005/ncx/", :version => "2005-1" do
+        build_head(builder)
+        builder.docTitle { builder.text doc_title }
+        build_nav_map(builder)
+      end
+    end
+
+    def build_head(builder)
+      builder.head do
+        {
+          :uid => uid,
+          :depth => depth,
+          :totalPageCount => total_page_count,
+          :maxPageNumber => max_page_number
+        }.each do |k, v|
+          builder.meta :name => "dtb:#{k}", :content => v
+        end
+      end
+    end
+
+    def build_nav_map(builder)
+      builder.navMap do
+        builder_nav_point(builder, nav_map)
+      end
+    end
+
+    def builder_nav_point(builder, nav_point, play_order = 1)
+      case nav_point
+      when Array
+        nav_point.each do |point|
+          play_order = builder_nav_point(builder, point, play_order)
+        end
+      when Hash
+        id = nav_point[:id] || "navPoint-#{play_order}"
+        builder.navPoint :id => id, :playOrder => play_order do
+          builder.navLabel { builder.text nav_point[:label] }
+          builder.content :src => nav_point[:content]
+          play_order += 1
+          if nav_point[:nav]
+            play_order = builder_nav_point(builder, nav_point[:nav], play_order)
+          end
+        end
+      else
+        raise "nav_point must be Array or Hash"
+      end
+      play_order
+    end
+  end
+end