epubber 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42daf1a5cfc9933d3bbccdffd13be03d45b585e4
+  data.tar.gz: b349d1f7b7ea333a6ceb4d470dbce023daba2534
+SHA512:
+  metadata.gz: 424d892bfbc55f533d5c921b8884441a3f342388d99be0241694d9912ef6def42c7cf8b33456a0d305506bbbccf409ed55be0a80e26e65d56f1164d6273fd2e9
+  data.tar.gz: 53fd7dd832c3baea3aba7008a8f7b3f167e1002f4a7ad0f32d57b34f79f6a2893305d6d1df7d490e710944d355256c878eb764de65c89a7fc3305b5f5fba91a5

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,9 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in epubber.gemspec
+gemspec
+
+# Use liquid template engine
+gem 'liquid'
+# For packaging
+gem 'rubyzip'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Federico Ramirez
+
+MIT License
+
+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,58 @@
+# Epubber
+This gem allows you to easily build EPUB files programatically.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'epubber'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install epubber
+
+## Usage
+Epubber's DSL is rather simple:
+
+```ruby
+path = Epubber.generate do
+  title 'My First EPUB book'
+  author 'Ramirez, Federico'
+  description 'This is an example EPUB'
+  url 'http://my-url.com'
+
+  chapter do
+    title 'Chapter 1'
+    content '<p>This is some content!</p>'
+  end
+
+  chapter do
+    title 'Chapter 2'
+    content '<p>Some more content this is.</p>'
+  end
+end
+
+# Now the `path` variable contains the full path of the generated EPUB file.
+# Defaults to `#{title}.epub`
+``` 
+
+You can configure the generator 
+
+```ruby
+path = Epubber.generate filename: 'some-file.epub', workspace: '/tmp' do
+  # Ebook code here...
+end
+``` 
+
+## Contributing
+
+1. Fork it ( https://github.com/gosukiwi/epubber/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task :default => :test

data/epubber.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'epubber/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "epubber"
+  spec.version       = Epubber::VERSION
+  spec.authors       = ["Federico Ramirez"]
+  spec.email         = ["fedra.arg@gmail.com"]
+  spec.summary       = %q{Generate EPUB files programatically}
+  #spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = "https://github.com/gosukiwi/epubber"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/epubber/generator.rb

@@ -0,0 +1,63 @@
+require 'epubber/generators/chapters'
+require 'epubber/generators/content'
+require 'epubber/generators/toc'
+require 'epubber/generators/introduction'
+require 'epubber/generators/static'
+require 'epubber/generators/endnotes'
+require 'epubber/services/persistance'
+require 'epubber/services/compressor'
+
+# Given a book and a place to work in, generates all required EPUB files
+class Epubber::Generator
+  attr_reader :working_dir, :book, :filename
+  def initialize(book: book, filename: filename, working_dir: working_dir)
+    @book        = book
+    @filename    = filename || "#{book.title}.epub"
+    @working_dir = working_dir || '/tmp/epubber'
+    @persistance = Epubber::Services::Persistance.new File.join(@working_dir, 'workspace')
+    @generators  = []
+
+    register_generators book: book, persistance: @persistance
+  end
+
+  def register_generators(params)
+    add_generator Epubber::Generators::Content.new(params)
+    add_generator Epubber::Generators::Introduction.new(params)
+    add_generator Epubber::Generators::Toc.new(params)
+    add_generator Epubber::Generators::Chapters.new(params)
+    add_generator Epubber::Generators::Static.new(params)
+    add_generator Epubber::Generators::Endnotes.new(params)
+  end
+
+  def generate
+    @generators.each { |generator| generator.generate }
+    pack
+  end
+
+protected
+
+  def clean_tmp
+    @persistance.clean
+  end
+
+  def compressor
+    Epubber::Services::Compressor.new
+  end
+
+  def compress
+    file = File.join working_dir, "#{filename}"
+    dir  = File.join working_dir, 'workspace'
+    compressor.compress dir, file
+    return file
+  end
+
+  def pack
+    path = compress
+    clean_tmp
+    return path
+  end
+
+  def add_generator(generator)
+    @generators << generator
+  end
+end

data/lib/epubber/generators/chapters.rb

@@ -0,0 +1,20 @@
+require 'epubber/generators/generator'
+
+module Epubber::Generators
+  class Chapters < Generator
+    def generate
+      compiled_template = template.compile 'OEBPS/Text/chapter.xhtml'
+      book.chapters.each do |chapter|
+        generate_chapter compiled_template, chapter
+      end
+    end
+
+  protected
+    
+    def generate_chapter(compiled_template, chapter)
+      context = chapter.contextify
+      content = compiled_template.render context
+      persist file: "OEBPS/Text/chapter#{context['id']}.xhtml", content: content
+    end
+  end
+end

data/lib/epubber/generators/content.rb

@@ -0,0 +1,10 @@
+require 'epubber/generators/generator'
+
+module Epubber::Generators
+  class Content < Generator
+    def generate
+      content = template.parse file: 'OEBPS/content.opf', context: book_context
+      persist file: 'OEBPS/content.opf', content: content
+    end
+  end
+end

data/lib/epubber/generators/endnotes.rb

@@ -0,0 +1,14 @@
+require 'epubber/generators/generator'
+
+module Epubber::Generators
+  class Endnotes < Generator
+    def generate
+      # Because this is an optional generator, don't do anything if there's no
+      # introduction in the book
+      return if book.endnotes.nil?
+
+      content = template.parse file: 'OEBPS/Text/endnotes.xhtml', context: book_context
+      persist file: 'OEBPS/Text/endnotes.xhtml', content: content
+    end
+  end
+end

data/lib/epubber/generators/generator.rb

@@ -0,0 +1,29 @@
+require 'epubber/services/template'
+
+module Epubber::Generators
+  class Generator
+    attr_reader :book, :persistance
+    def initialize(book: book, persistance: persistance)
+      @book = book
+      @persistance = persistance
+    end
+
+  protected
+
+    def book_context
+      { 'book' => book.contextify }
+    end
+
+    def template
+      Epubber::Services::Template.new
+    end
+
+    def template_path(file)
+      template.path file
+    end
+
+    def persist(file: file, content: content)
+      persistance.persist file: file, content: content
+    end
+  end
+end

data/lib/epubber/generators/introduction.rb

@@ -0,0 +1,14 @@
+require 'epubber/generators/generator'
+
+module Epubber::Generators
+  class Introduction < Generator
+    def generate
+      # Because this is an optional generator, don't do anything if there's no
+      # introduction in the book
+      return if book.introduction.nil?
+
+      content = template.parse file: 'OEBPS/Text/introduction.xhtml', context: book_context
+      persist file: 'OEBPS/Text/introduction.xhtml', content: content
+    end
+  end
+end

data/lib/epubber/generators/static.rb

@@ -0,0 +1,21 @@
+require 'epubber/generators/generator'
+
+module Epubber::Generators
+  class Static < Generator
+    def generate
+      files = ['mimetype', 'META-INF/container.xml', 'META-INF/com.apple.ibooks.display-options.xml',
+               'OEBPS/Text/cover.xhtml', 'OEBPS/Styles/style.css']
+      files.each do |file|
+        copy file
+      end
+    end
+
+  protected
+
+    # Get the file from the template and copy it unchanged
+    def copy(file)
+      content = File.open(template_path(file)).read
+      persist file: file, content: content
+    end
+  end
+end

data/lib/epubber/generators/toc.rb

@@ -0,0 +1,13 @@
+require 'epubber/generators/generator'
+
+module Epubber::Generators
+  class Toc < Generator
+    def generate
+      content = template.parse file: 'OEBPS/toc.ncx', context: book_context
+      persist file: 'OEBPS/toc.ncx', content: content
+
+      content = template.parse file: 'OEBPS/Text/toc.xhtml', context: book_context
+      persist file: 'OEBPS/Text/toc.xhtml', content: content
+    end
+  end
+end

data/lib/epubber/models/book.rb

@@ -0,0 +1,87 @@
+require 'securerandom'
+require 'epubber/models/concerns/has_chapters'
+require 'epubber/models/concerns/has_introduction'
+require 'epubber/models/concerns/has_endnotes'
+
+# Represents a book with it's chapters.
+module Epubber::Models
+  class Book
+    # Related models and their DSL goodies
+    include Epubber::Models::Concerns::HasChapters
+    include Epubber::Models::Concerns::HasIntroduction
+    include Epubber::Models::Concerns::HasEndnotes
+
+    def initialize
+      @title        = not_specified
+      @author       = not_specified
+      @description  = not_specified
+      @publisher    = not_specified
+      @language     = 'en'
+      @url          = not_specified
+      # LIST / OF / SUBJECTS => https://www.bisg.org/complete-bisac-subject-headings-2014-edition
+      @subjects     = 'NON000000 NON-CLASSIFIABLE'
+      @isbn         = nil
+    end
+
+    def title(text = nil)
+      return @title if text.nil?
+      @title = text
+    end
+
+    def author(text)
+      @author = text
+    end
+
+    def publisher(text)
+      @publisher = text
+    end
+
+    def description(text)
+      @description = text
+    end
+
+    def language(lang)
+      @language = lang
+    end
+
+    def url(url)
+      @url = url
+    end
+
+    def subjects(subjects)
+      @subjects = subjects
+    end
+
+    def isbn(isbn)
+      @isbn = isbn
+    end
+
+    # Return a hash which can be used as a template's context
+    def contextify
+      context = { 
+        # Attributes
+        "title" => @title, 
+        "author" => @author,
+        "description" => @description, 
+        "publisher" => @publisher,
+        "language" => @language,
+        "url" => @url,
+        "subjects" => @subjects,
+        "uuid" => ::SecureRandom.uuid,
+        "isbn" => @isbn
+      }
+      
+      # Related models
+      context["chapters"]     = contextified_chapters
+      context["introduction"] = contextified_introduction
+      context["endnotes"]     = contextified_endnotes
+      return context
+    end
+
+  protected
+
+    def not_specified
+      'Not specified'
+    end
+  end
+end

data/lib/epubber/models/chapter.rb

@@ -0,0 +1,26 @@
+# Represents a book's chapter
+module Epubber::Models
+  class Chapter
+    def initialize
+      @id = 0
+      @title = 'Not specified'
+      @content = '<p>Not specified</p>'
+    end
+
+    def id(idx)
+      @id = idx
+    end
+
+    def title(text)
+      @title = text
+    end
+
+    def content(text)
+      @content = text
+    end
+
+    def contextify
+      { 'id' => @id, 'title' => @title, 'content' => @content }
+    end
+  end
+end

data/lib/epubber/models/concerns/has_chapters.rb

@@ -0,0 +1,23 @@
+require 'epubber/models/chapter'
+
+module Epubber::Models::Concerns
+  module HasChapters
+    def chapters
+      @chapters ||= []
+    end
+
+    # Add chapter
+    def chapter(&block)
+      chapter = Epubber::Models::Chapter.new
+      chapter.instance_eval &block
+      chapter.id(chapters.count + 1)
+      chapters << chapter
+    end
+
+    def contextified_chapters
+      chapters.map do |chapter|
+        chapter.contextify
+      end
+    end
+  end
+end

data/lib/epubber/models/concerns/has_endnotes.rb

@@ -0,0 +1,17 @@
+require 'epubber/models/endnotes'
+
+module Epubber::Models::Concerns
+  module HasEndnotes
+    def endnotes(&block)
+      @endnotes ||= nil
+      return @endnotes unless block_given?
+      @endnotes = Epubber::Models::Endnotes.new
+      @endnotes.instance_eval &block
+    end
+
+    def contextified_endnotes
+      return nil if endnotes.nil?
+      return endnotes.contextify
+    end
+  end
+end

data/lib/epubber/models/concerns/has_introduction.rb

@@ -0,0 +1,17 @@
+require 'epubber/models/introduction'
+
+module Epubber::Models::Concerns
+  module HasIntroduction
+    def introduction(&block)
+      @introduction ||= nil
+      return @introduction unless block_given?
+      @introduction = Epubber::Models::Introduction.new
+      @introduction.instance_eval &block
+    end
+
+    def contextified_introduction
+      return nil if introduction.nil?
+      return introduction.contextify
+    end
+  end
+end

data/lib/epubber/models/endnotes.rb

@@ -0,0 +1,16 @@
+# Represents a book's introduction
+module Epubber::Models
+  class Endnotes
+    def initialize
+      @content = '<p>Not specified</p>'
+    end
+
+    def content(content)
+      @content = content
+    end
+
+    def contextify
+      { 'content' => @content }
+    end
+  end
+end

data/lib/epubber/models/introduction.rb

@@ -0,0 +1,16 @@
+# Represents a book's introduction
+module Epubber::Models
+  class Introduction
+    def initialize
+      @content = '<p>Not specified</p>'
+    end
+
+    def content(content)
+      @content = content
+    end
+
+    def contextify
+      { 'content' => @content }
+    end
+  end
+end

data/lib/epubber/services/compressor.rb

@@ -0,0 +1,45 @@
+require 'zip'
+
+module Epubber::Services
+  class Compressor
+    def compress(dir, file)
+      FileUtils.rm file if File.exists?(file)
+      generator = ZipFileGenerator.new dir, file
+      generator.write
+    end
+  end
+
+  # Helper class to create the actual zip file
+  class ZipFileGenerator
+    # Initialize with the directory to zip and the location of the output archive.
+    def initialize(inputDir, outputFile)
+      @inputDir   = inputDir
+      @outputFile = outputFile
+    end
+
+    # Zip the input directory.
+    def write()
+      entries = Dir.entries(@inputDir); entries.delete("."); entries.delete("..")
+      io = Zip::File.open(@outputFile, Zip::File::CREATE);
+
+      writeEntries(entries, "", io)
+      io.close();
+    end
+
+  private
+
+    def writeEntries(entries, path, io)
+      entries.each { |e|
+        zipFilePath = path == "" ? e : File.join(path, e)
+        diskFilePath = File.join(@inputDir, zipFilePath)
+        if  File.directory?(diskFilePath)
+          io.mkdir(zipFilePath)
+          subdir =Dir.entries(diskFilePath); subdir.delete("."); subdir.delete("..")
+          writeEntries(subdir, zipFilePath, io)
+        else
+          io.get_output_stream(zipFilePath) { |f| f.puts(File.open(diskFilePath, "rb").read())}
+        end
+      }
+    end
+  end
+end

data/lib/epubber/services/persistance.rb

@@ -0,0 +1,35 @@
+module Epubber::Services
+  class Persistance
+    attr_reader :workspace
+    def initialize(workspace)
+      @workspace = workspace
+    end
+
+    # Persist a file into the working directory with the spcified contents.
+    # The file argument is the relative path to the new file, eg: test/chapters/file.xhtml
+    def persist(file: file, content: content)
+      create_path_for file
+      write file, content
+    end
+
+    # Remove the working directory, thus cleaning the file system
+    def clean
+      FileUtils.remove_dir workspace, true
+    end
+
+  protected
+
+    def write(file, content)
+      File.write path(file), content
+    end
+
+    def create_path_for(file)
+      dir = File.dirname path(file)
+      FileUtils.mkdir_p dir unless File.directory?(dir)
+    end
+
+    def path(file)
+      File.join workspace, file
+    end
+  end
+end

data/lib/epubber/services/template.rb

@@ -0,0 +1,27 @@
+require 'liquid'
+
+module Epubber::Services
+  class Template
+    # Compiles and renderes a template file in the given context
+    def parse(file: file, context: context)
+      compile(file).render context
+    end
+
+    # Compiles a file and returns a template instance ready to be rendered
+    def compile(file)
+      Liquid::Template.parse load(file)
+    end
+
+    # Returns the full path for a given template file
+    def path(file)
+      File.join File.dirname(__FILE__), '../../templates/', file
+    end
+
+  protected
+
+    # Opens a file from disk located inside ./templates
+    def load(file)
+      File.open(path(file)).read
+    end
+  end
+end

data/lib/epubber/version.rb

@@ -0,0 +1,3 @@
+module Epubber
+  VERSION = "0.0.1"
+end

data/lib/epubber.rb

@@ -0,0 +1,12 @@
+require "epubber/version"
+require "epubber/models/book"
+require "epubber/generator"
+
+module Epubber
+  def self.generate(filename: filename = nil, working_dir: working_dir = nil, &block)
+    book = Epubber::Models::Book.new
+    book.instance_eval &block
+    generator = Epubber::Generator.new book: book, working_dir: working_dir, filename: filename
+    generator.generate
+  end
+end