ebook_generator 0.0.5 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bd956ba768bbc1c3c607b1b4f3dd7aca5108190
-  data.tar.gz: 84b1f546c5ffc29dc60d82b76d731897058ba052
+  metadata.gz: 48d8c90867c3202845223f9a32ddfa97355c91c2
+  data.tar.gz: 6bc9b510a69a4408fd05edcb4222a9e4e0b0cd0d
 SHA512:
-  metadata.gz: e2a11d62c96e321cd61e51bd951a9cc34a604b8c6bdeeedd4bafc954a03bde6f83f6c2d07124565ba03120dc02efd2495f29c9b1fa2bb3ded6bce29d87807752
-  data.tar.gz: ba678ffba0836f3e65daede396bf2edcde3d6e485e4055e0e3c1c148b2d17e24a78e41071f3e18916160247827d0f999ffb929a1ae9f5a8c5567065eaa73ed37
+  metadata.gz: 3f5ce5e4a77897bd07833cb2f3a3267cd69a7e51810153e81f4ee04011a620b4e1d85957c6cb3d427ed1e22353526df6adc8dd6d63550985ed8c5260f809d0ee
+  data.tar.gz: b3b7e0fb42a30ca9346fae2b4725c90e34281a5114195c0f9fa846db273349ce945b45d545238bbdff0b2e7c7becb0041de28e8d45a48a06d4e120524bb3df8c

data/{LICENSE.txt → MIT-LICENSE}

@@ -1,6 +1,4 @@
-Copyright (c) 2014 Kris Quigley
-
-MIT License
+Copyright 2014 YOURNAME
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -5,10 +5,9 @@ Rails gem to generate eBooks using the Markdown syntax to format content for sec
 An example of this gem being used can be found at: [ebook-generator.affinity-tech.com](http://ebook-generator.affinity-tech.com)
 
 Requires:
-- Postgres with UUID support (uses the id to generate the ebook UUID)
+- Rails 4
 - Rubyzip (to generate the .epub)
 - Redcarpet (to render Markdown into HTML)
-- Friendly_id (for nice slugs and for naming of generated ebook file)
 
 ## Installation
 
@@ -32,35 +31,29 @@ Generate the tables needed to process the ebooks:
 Migrate the database:
 `rake db:migrate`
 
-Pass the id for the ebook you want to generate:
-`EbookGenerator.generate_ebook(ebook.id)`
+Pass the ebook object you want to generate:
+`EbookGenerator.generate_ebook(ebook_object)`
 
 This will then generate an ePub based on the values in the db and output to the /tmp folder.
 
-## Feature roadmap
+For a Kindle mobi file then pass in `true` as the second argument:
+`EbookGenerator.generate_ebook(ebook_object, true)`
 
-### 0.1.0
-- Kindle support
-- Tests
+## Feature roadmap
 
-### 0.2.0
+### 1.1.0
 - Style editing
 
-### 0.3.0
+### 1.2.0
 - PDF out
 
-### 0.4.0
+### 1.3.0
 - HTML out
 - Image support for the front cover
 
-### 0.5.0
+### 1.4.0
 - HTML to eBook conversion
 
-### 0.6.0
-- User membership to manage books
-
-Publishing support?
-
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/ebook_generator/fork )

data/Rakefile

@@ -1,2 +1,18 @@
-require 'bundler'
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+
 Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/lib/ebook_generator.rb

@@ -1,14 +1,57 @@
 require "ebook_generator/version"
 require "ebook_generator/zip_file_processor"
 require "builder"
+require "redcarpet"
 
 module EbookGenerator
 
-  def self.included(model_class)
-    model_class.extend self
+  # def self.included(model_class)
+  #   model_class.extend self
+  # end
+
+  def self.generate_ebook(ebook_object, generate_kindle_file = false)
+    # Set the root path of the ebook
+    path = Rails.root.to_s + "/tmp/#{ebook_object.id}"
+
+    # Make all required dirs
+    dirs = [path, path + "/META-INF", path + "/OEBPS", path + "/OEBPS/Text", path + "/OEBPS/Styles"]
+    make_dirs(dirs)
+
+    # Create container.xml
+    generate_container(path + "/META-INF")
+
+    # Create mimetype
+    generate_mimetype(path + "/mimetype")
+
+    # Move default stylesheet into styles folder
+    copy_style(path + "/OEBPS/Styles")
+
+    # loop through each section loading the reference header and saving as it's own section
+    generate_sections(path + "/OEBPS/Text", ebook_object)
+
+    # generate toc based on the number of sections generated
+    generate_content_opf(path + "/OEBPS", ebook_object)
+    generate_toc_ncx(path + "/OEBPS", ebook_object)
+
+    # change permissions for files that need to be executable
+    files = [path + "/OEBPS/toc.ncx", path + "/OEBPS/content.opf", path + "/mimetype"]
+    change_perms(files)
+
+    # zip all files
+    zipfile_name = Rails.root.to_s + "/tmp/" + ebook_object.slug + ".epub"
+    zf = ZipFileProcessor.new(path, zipfile_name)
+    zf.write
+
+    # Clean up the tmp dir
+    remove_tmp_dir(path + "/")
+
+    # return the file path
+    zipfile_name = generate_mobi(zipfile_name, ebook_object.slug) if generate_kindle_file
+    zipfile_name
   end
 
-  # Move writing of files into its own class that accepts an array
+  private
+
   def self.make_dirs(paths)
     paths.each do |path|
       Dir.mkdir(path, 0777) unless File.exists?(path)
@@ -16,7 +59,6 @@ module EbookGenerator
   end
 
   def self.generate_container(path)
-
     file = File.new(path + "/container.xml", "wb")
     xm = Builder::XmlMarkup.new(:target => file, :indent => 2)
     xm.instruct!
@@ -27,15 +69,12 @@ module EbookGenerator
     }
 
     file.close
-
   end
 
   def self.generate_mimetype(path)
-
     File.open(path, "w+") do |f|
       f.write("application/epub+zip")
     end
-
   end
 
   def self.copy_style(path)
@@ -43,10 +82,13 @@ module EbookGenerator
     #FileUtils.cp Rails.root.to_s + "/app/ebook/style.css", path
   end
 
-  def self.generate_sections(path, attrs)
+  def self.convert_to_html(content)
     markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML, autolink: true, tables: true)
+    markdown.render(content)
+  end
 
-    attrs.sections.each do |section|
+  def self.generate_sections(path, ebook_object)
+    ebook_object.sections.each do |section|
       file = File.new(path + "/Section#{section.position}.html", "wb")
 
       xm = Builder::XmlMarkup.new(:target => file, :indent => 2)
@@ -54,45 +96,45 @@ module EbookGenerator
       xm.declare! :DOCTYPE, :html, :PUBLIC, "-//W3C//DTD XHTML 1.1//EN", "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"
       xm.html("xmlns" => "http://www.w3.org/1999/xhtml"){
         xm.head {
-          xm.title { attrs.title }
-          xm.meta("content" => attrs.title, "name" => "Title")
-          xm.meta("content" => attrs.creator, "name" => "Author")
+          xm.title { ebook_object.title }
+          xm.meta("content" => ebook_object.title, "name" => "Title")
+          xm.meta("content" => ebook_object.creator, "name" => "Author")
           xm.link("href" => "../Styles/style.css", "rel" => "stylesheet", "type" => "text/css")
         }
-        xm.body { |b| b << "<div id=\"#{section.title}\">" + markdown.render(section.content) + "</div>" }
+        xm.body { |b| b << "<div id=\"#{section.title}\">" + convert_to_html(section.content) + "</div>" }
       }
 
       file.close
     end
   end
 
-  def self.generate_content_opf(path, attrs)
+  def self.generate_content_opf(path, ebook_object)
     file = File.new(path + "/content.opf", "wb")
 
     xm = Builder::XmlMarkup.new(:target => file, :indent => 2)
     xm.instruct!
     xm.package("xmlns" => "http://www.idpf.org/2007/opf", "unique-identifier" => "BookId", "version" => "2.0") {
       xm.metadata("xmlns:dc" => "http://purl.org/dc/elements/1.1/", "xmlns:opf" => "http://www.idpf.org/2007/opf") {
-        xm.tag!("dc:identifier", attrs.id, "id" => "BookId", "opf:scheme" => "UUID")
-        xm.tag!("dc:title", attrs.title)
-        xm.tag!("dc:creator", attrs.creator, "opf:role" => "aut")
-        xm.tag!("dc:language", attrs.language)
-        xm.tag!("dc:date", attrs.updated_at, "opf:event" => "modification")
-        xm.tag!("dc:description", attrs.description)
-        xm.tag!("dc:publisher", attrs.publisher)
-        xm.tag!("dc:rights", attrs.rights)
-        xm.tag!("dc:subject", attrs.subject)
-        xm.tag!("dc:contributor", attrs.contributor, "opf:role" => "cov")
+        xm.tag!("dc:identifier", ebook_object.id, "id" => "BookId", "opf:scheme" => "UUID")
+        xm.tag!("dc:title", ebook_object.title)
+        xm.tag!("dc:creator", ebook_object.creator, "opf:role" => "aut")
+        xm.tag!("dc:language", ebook_object.language)
+        xm.tag!("dc:date", ebook_object.updated_at, "opf:event" => "modification")
+        xm.tag!("dc:description", ebook_object.description)
+        xm.tag!("dc:publisher", ebook_object.publisher)
+        xm.tag!("dc:rights", ebook_object.rights)
+        xm.tag!("dc:subject", ebook_object.subject)
+        xm.tag!("dc:contributor", ebook_object.contributor, "opf:role" => "cov")
       }
       xm.manifest {
         xm.item("href" => "toc.ncx", "id" => "ncx", "media-type" => "application/x-dtbncx+xml")
         xm.item("href" => "Styles/style.css", "media-type" => "text/css")
-        attrs.sections.each do |section|
+        ebook_object.sections.each do |section|
           xm.item("href" => "Text/Section#{section.position}.html", "id" => "Section#{section.position}.html", "media-type" => "application/xhtml+xml")
         end
       }
       xm.spine("toc" => "ncx") {
-        attrs.sections.each do |section|
+        ebook_object.sections.each do |section|
           xm.itemref("idref" => "Section#{section.position}.html")
         end
       }
@@ -100,11 +142,9 @@ module EbookGenerator
     }
 
     file.close
-
   end
 
-  def self.generate_toc_ncx(path, attrs)
-
+  def self.generate_toc_ncx(path, ebook_object)
     file = File.new(path + "/toc.ncx", "wb")
 
     xm = Builder::XmlMarkup.new(:target => file, :indent => 2)
@@ -112,16 +152,16 @@ module EbookGenerator
     xm.declare! :DOCTYPE, :ncx, :PUBLIC, "-//NISO//DTD ncx 2005-1//EN", "http://www.daisy.org/z3986/2005/ncx-2005-1.dtd"
     xm.ncx("xmlns" => "http://www.daisy.org/z3986/2005/ncx/", "version" => "2005-1") {
       xm.head {
-        xm.meta("content" => "urn:uuid:${attrs.id}", "name" => "dtb:uid")
+        xm.meta("content" => "urn:uuid:${ebook_object.id}", "name" => "dtb:uid")
         xm.meta("content" => "2", "name" => "dtb:depth")
         xm.meta("content" => "0", "name" => "dtb:totalPageCount")
         xm.meta("content" => "0", "name" => "dtb:maxPageNumber")
       }
       xm.docTitle {
-        xm.text(attrs.title)
+        xm.text(ebook_object.title)
       }
       xm.navMap {
-        attrs.sections.each do |section|
+        ebook_object.sections.each do |section|
           xm.navPoint("id" => "navPoint-#{section.position}", "playOrder" => "#{section.position}") {
             xm.navLabel {
               xm.text(section.title)
@@ -133,7 +173,6 @@ module EbookGenerator
     }
 
     file.close
-
   end
 
   def self.change_perms(files)
@@ -146,44 +185,8 @@ module EbookGenerator
     FileUtils.remove_dir(directory, true)
   end
 
-  def self.generate_ebook(ebook_id)
-
-    # Set the root path of the ebook
-    path = Rails.root.to_s + "/tmp/#{ebook_id}"
-
-    # Make all required dirs
-    dirs = [path, path + "/META-INF", path + "/OEBPS", path + "/OEBPS/Text", path + "/OEBPS/Styles"]
-    make_dirs(dirs)
-
-    # Create container.xml
-    generate_container(path + "/META-INF")
-
-    # Create mimetype
-    generate_mimetype(path + "/mimetype")
-
-    # Move default stylesheet into styles folder
-    copy_style(path + "/OEBPS/Styles")
-
-    # loop through each section loading the reference header and saving as it's own section
-    attrs = Ebook.find(ebook_id)
-    generate_sections(path + "/OEBPS/Text", attrs)
-
-    # generate toc based on the number of sections generated
-    generate_content_opf(path + "/OEBPS", attrs)
-    generate_toc_ncx(path + "/OEBPS", attrs)
-
-    # change permissions for files that need to be executable
-    files = [path + "/OEBPS/toc.ncx", path + "/OEBPS/content.opf", path + "/mimetype"]
-    change_perms(files)
-
-    # zip all files
-    zipfile_name = Rails.root.to_s + "/tmp/" + attrs.slug + ".epub"
-    zf = ZipFileProcessor.new(path, zipfile_name)
-    zf.write
-
-    # Clean up the tmp dir
-    remove_tmp_dir(path + "/")
-
+  def self.generate_mobi(path, slug)
+    `#{Rails.root.to_s}/bin/kindlegen #{path} -o #{slug}.mobi`
+    "#{Rails.root.to_s}/tmp/#{slug}.mobi"
   end
-
 end

data/lib/ebook_generator/version.rb

@@ -1,3 +1,3 @@
 module EbookGenerator
-  VERSION = "0.0.5"
+  VERSION = "1.0.2"
 end

data/lib/generators/ebook_generator/ebook_generator_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+class EbookGeneratorGenerator < ActiveRecord::Generators::Base
+  argument :name, type: :string, default: 'random_name'
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_model_files
+    template "ebook.rb", "app/models/ebook.rb"
+    template "section.rb", "app/models/section.rb"
+    migration_template "create_ebooks.rb", "db/migrate/create_ebooks.rb"
+    migration_template "create_sections.rb", "db/migrate/create_sections.rb"
+  end
+end

data/lib/generators/ebook_generator/templates/create_ebooks.rb

@@ -0,0 +1,18 @@
+class CreateEbooks < ActiveRecord::Migration
+  def change
+    create_table :ebooks, force: true  do |t|
+      t.string    :title,      null: false
+      t.string    :creator
+      t.string    :language,   limit: 2, null: false
+      t.string    :contributor
+      t.text      :description
+      t.string    :publisher
+      t.text      :rights
+      t.string    :subject
+      t.string    :slug,       null: false
+      t.timestamps
+    end
+
+    add_index :ebooks, :slug, unique: true
+  end
+end

data/lib/generators/ebook_generator/templates/create_sections.rb

@@ -0,0 +1,13 @@
+class CreateSections < ActiveRecord::Migration
+  def change
+    create_table :sections, force: true do |t|
+      t.belongs_to  :ebook
+      t.string      :title,      null: false
+      t.text        :content,    null: false
+      t.integer     :position,   null: false
+      t.timestamps
+    end
+
+    add_index :sections, ["position"], name: "index_sections_on_position", using: :btree
+  end
+end

data/lib/generators/ebook_generator/templates/ebook.rb

@@ -0,0 +1,8 @@
+class Ebook < ActiveRecord::Base
+  extend FriendlyId
+  has_many :sections, ->{ order(:position) }
+
+  friendly_id :title, use: :slugged
+
+  validates :title, presence: true
+end

data/lib/generators/ebook_generator/templates/section.rb

@@ -0,0 +1,6 @@
+class Section < ActiveRecord::Base
+  belongs_to :ebook
+
+  validates :title, :presence => true
+  validates :content, :presence => true
+end

data/lib/tasks/ebook_generator_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :ebook_generator do
+#   # Task goes here
+# end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.