ebook_generator 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf15d724642369b00ca8059e0e543843b9d90994
-  data.tar.gz: 88b3f1ea8d9cf688592d9fe3c3da998002699c9c
+  metadata.gz: 4430a1086ca77ff50348df43afafb4890e520053
+  data.tar.gz: 87a99f1c44cb867ad21eb46301343b92e5d12188
 SHA512:
-  metadata.gz: 2e7d7a9fc89599202c886abe6537de107caca1b886e304b46a333144c324f0bcfd2c803bd645c2d09e5e2da8e4dd03fe0a68a350b8f2892b0fd9cb84118ac99e
-  data.tar.gz: 716ca817854459a200355b5e53ede17c12dae748560d7f9dcf19730710fe8e6b71bbf80766596b6bc0c14b2212b66152f814dc1a276aac2c7c31f298960fe255
+  metadata.gz: c6bbf83277abbf49711c4db131f1a4391e4dc4e11a6f185bceac23e439f367bfb726dde392ea109d884fb55608865fe35aa90dc02cb8fd50feda8cc75666a9ef
+  data.tar.gz: 0c279a1b23d92c7b83c8c381a69da4ace0b6556f517f5cee84859a437b257a8ece13cb1507a8b76aea164eacc1d81cf167112455ff3926a95be6c3aee9c3e0a6

data/Changelog.md

@@ -1,5 +1,10 @@
 # EbookGenerator Changelog
 
+## 0.0.4 (2014-04-40)
+
+- Added missing file "zip_file_processor"
+- Refactored code to use builder instead of strings
+
 ## 0.0.3 (2014-04-18)
 
 - Added gem dependencies

data/README.md

@@ -27,22 +27,15 @@ Or install it yourself as:
 ## Usage
 
 Generate the tables needed to process the ebooks:
-
 `rails generate ebook_generator`
 
-Migrate the db:
-
+Migrate the database:
 `rake db:migrate`
 
-Require the ebook_generator module in your class:
-
-`include 'EbookGenerator'`
-
 Pass the id for the ebook you want to generate:
-
 `EbookGenerator.generate_ebook(ebook.id)`
 
-This will then generate an ebook based on the values in the db in the /tmp folder.
+This will then generate an ePub based on the values in the db and output to the /tmp folder.
 
 ## Feature roadmap
 

data/ebook_generator.gemspec

@@ -10,8 +10,10 @@ Gem::Specification.new do |s|
   s.description = "A simple eBook (ePub) generator gem"
   s.authors     = ["Kris Quigley"]
   s.email       = 'kris@krisquigley.co.uk'
-  s.homepage    = 'https://github.com/krisquigley/ebook_generator'
+  s.homepage    =
+    'https://github.com/krisquigley/ebook_generator'
 
+  s.add_runtime_dependency 'rails', '>= 4.0.0'
   s.add_runtime_dependency 'friendly_id', '>= 5.0.3'
   s.add_runtime_dependency 'pg',  '>= 0.17.1'
   s.add_runtime_dependency 'redcarpet',  '>= 3.0.0'

data/lib/ebook_generator/version.rb

@@ -1,3 +1,3 @@
 module EbookGenerator
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/ebook_generator/zip_file_processor.rb

@@ -0,0 +1,48 @@
+require 'zip'
+
+# This is a simple example which uses rubyzip to
+# recursively generate a zip file from the contents of
+# a specified directory. The directory itself is not
+# included in the archive, rather just its contents.
+#
+# Usage:
+#   directoryToZip = "/tmp/input"
+#   outputFile = "/tmp/out.zip"
+#   zf = ZipFileGenerator.new(directoryToZip, outputFile)
+#   zf.write()
+class ZipFileProcessor
+
+  # 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
+
+  # A helper method to make the recursion work.
+  private
+  def writeEntries(entries, path, io)
+
+    entries.each { |e|
+      zipFilePath = path == "" ? e : File.join(path, e)
+      diskFilePath = File.join(@inputDir, zipFilePath)
+      puts "Deflating " + diskFilePath
+      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

data/lib/ebook_generator.rb

@@ -1,4 +1,6 @@
 require "ebook_generator/version"
+require "ebook_generator/zip_file_processor"
+require "builder"
 
 module EbookGenerator
 
@@ -7,170 +9,136 @@ module EbookGenerator
   end
 
   # Move writing of files into its own class that accepts an array
-  def self.make_dir(path)
-    Dir.mkdir(path, 0777) unless File.exists?(path)
+  def self.make_dirs(paths)
+    paths.each do |path|
+      Dir.mkdir(path, 0777) unless File.exists?(path)
+    end
   end
 
-  def self.initialise_files(path)
-    metainf_path = path + "/META-INF"
+  def self.generate_container(path)
 
-    Dir.mkdir(metainf_path) unless File.exists?(metainf_path)
+    file = File.new(path + "/container.xml", "wb")
+    xm = Builder::XmlMarkup.new(:target => file, :indent => 2)
+    xm.instruct!
+    xm.container("version" => "1.0", "xmlns" => "urn:oasis:names:tc:opendocument:xmlns:container") {
+      xm.rootfiles {
+        xm.rootfile("full-path" => "OEBPS/content.opf", "media-type" => "application/oebps-package+xml")
+      }
+    }
 
-    metainf = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
-      <container version=\"1.0\" xmlns=\"urn:oasis:names:tc:opendocument:xmlns:container\">
-        <rootfiles>
-          <rootfile full-path=\"OEBPS/content.opf\" media-type=\"application/oebps-package+xml\"/>
-        </rootfiles>
-      </container>"
+    file.close
 
-    File.open(metainf_path + "/container.xml", "w+") do |f|
-      f.write(metainf)
-    end
+  end
 
-    mimetype = "application/epub+zip"
-    mimetype_path = path + "/mimetype"
+  def self.generate_mimetype(path)
 
-    File.open(mimetype_path, "w+") do |f|
-      f.write(mimetype)
+    File.open(path, "w+") do |f|
+      f.write("application/epub+zip")
     end
 
-    FileUtils.chmod 0755, mimetype_path
-
-    content_path = path + "/OEBPS"
-
-    Dir.mkdir(content_path) unless File.exists?(content_path)
-
-    Dir.mkdir(content_path + "/Text") unless File.exists?(content_path + "/Text")
-
-    Dir.mkdir(content_path + "/Styles") unless File.exists?(content_path + "/Styles")
-
-    root = Rails.root.to_s
-
-    FileUtils.cp "#{root}/app/ebook/style.css", content_path+"/Styles"
-
-    return content_path
-
   end
 
-  def self.generate_headers(attrs)
-    xml = "<title>#{attrs.title}</title>
-      <meta content=\"#{attrs.title}\" name=\"Title\" />
-      <meta content=\"#{attrs.title}\" name=\"Author\" />
-      <link href=\"../Styles/style.css\" rel=\"stylesheet\" type=\"text/css\" />"
-    return xml
+  def self.copy_style(path)
+    FileUtils.cp Rails.root.to_s + "/app/ebook/style.css", path
   end
 
   def self.generate_sections(path, attrs)
     markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML, autolink: true, tables: true)
-    headers = generate_headers(attrs)
 
     attrs.sections.each do |section|
-      xml = "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"no\"?>
-        <!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\">
-        <head>
-          #{headers}
-        </head>
-        <body>
-          <div id=\"#{section.title}\">
-          "
-      xml += markdown.render(section.content)
-      xml += "
-          </div>
-        </body>
-        </html>"
-
-      File.open(path + "/Section#{section.position}.html", "w+") do |f|
-        f.write(xml)
-      end
+      file = File.new(path + "/Section#{section.position}.html", "wb")
+
+      xm = Builder::XmlMarkup.new(:target => file, :indent => 2)
+      xm.instruct!
+      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.link("href" => "../Styles/style.css", "rel" => "stylesheet", "type" => "text/css")
+        }
+        xm.body { |b| b << "<div id=\"#{section.title}\">" + markdown.render(section.content) + "</div>" }
+      }
+
+      file.close
     end
   end
 
   def self.generate_content_opf(path, attrs)
-    xml = "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>
-    <package xmlns=\"http://www.idpf.org/2007/opf\" unique-identifier=\"BookId\" version=\"2.0\">
-      <metadata xmlns:dc=\"http://purl.org/dc/elements/1.1/\" xmlns:opf=\"http://www.idpf.org/2007/opf\">
-        <dc:identifier id=\"BookId\" opf:scheme=\"UUID\">#{attrs.id}</dc:identifier>
-        <dc:title>#{attrs.title}</dc:title>
-        <dc:creator opf:role=\"aut\">#{attrs.creator}</dc:creator>
-        <dc:language>#{attrs.language}</dc:language>
-        <dc:date opf:event=\"modification\">#{attrs.updated_at}</dc:date>
-        <dc:description>#{attrs.description}</dc:description>
-        <dc:publisher>#{attrs.publisher}</dc:publisher>
-        <dc:rights>#{attrs.rights}</dc:rights>
-        <dc:subject>#{attrs.subject}</dc:subject>
-        <dc:contributor opf:role=\"cov\">#{attrs.contributor}</dc:contributor>
-        <meta content=\"0.7.2\" name=\"Sigil version\" />
-      </metadata>
-      <manifest>
-        <item href=\"toc.ncx\" id=\"ncx\" media-type=\"application/x-dtbncx+xml\" />
-        <item href=\"Styles/style.css\" id=\"style.css\" media-type=\"text/css\" />"
-
-    attrs.sections.each do |section|
-      xml += "<item href=\"Text/Section#{section.position}.html\" id=\"Section#{section.position}.html\" media-type=\"application/xhtml+xml\" />"
-    end
-
-    xml += "<item href=\"Fonts/junicode-italic-webfont.ttf\" id=\"junicode-italic-webfont.ttf\" media-type=\"application/x-font-ttf\" />
-        <item href=\"Fonts/junicode-webfont.ttf\" id=\"junicode-webfont.ttf\" media-type=\"application/x-font-ttf\" />
-        <item href=\"Fonts/junicode-bold-webfont.ttf\" id=\"junicode-bold-webfont.ttf\" media-type=\"application/x-font-ttf\" />
-      </manifest>
-      <spine toc=\"ncx\">"
-
-    attrs.sections.each do |section|
-      xml += "<itemref idref=\"Section#{section.position}.html\" />"
-
-    end
-    xml += "</spine>
-      <guide />
-    </package>"
-
-    content_path = path + "/content.opf"
-
-    File.open(content_path, "w+") do |f|
-      f.write(xml)
-    end
-
-    FileUtils.chmod 0755, content_path
+    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.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|
+          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|
+          xm.itemref("idref" => "Section#{section.position}.html")
+        end
+      }
+      xm.guide()
+    }
+
+    file.close
 
   end
 
   def self.generate_toc_ncx(path, attrs)
-    xml = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\" ?>
-    <!DOCTYPE ncx PUBLIC \"-//NISO//DTD ncx 2005-1//EN\"
-     \"http://www.daisy.org/z3986/2005/ncx-2005-1.dtd\">
-    <ncx xmlns=\"http://www.daisy.org/z3986/2005/ncx/\" version=\"2005-1\">
-      <head>
-        <meta content=\"urn:uuid:${attrs.id}\" name=\"dtb:uid\"/>
-        <meta content=\"2\" name=\"dtb:depth\"/>
-        <meta content=\"0\" name=\"dtb:totalPageCount\"/>
-        <meta content=\"0\" name=\"dtb:maxPageNumber\"/>
-      </head>
-      <docTitle>
-        <text>#{attrs.title}</text>
-      </docTitle>
-      <navMap>"
-
 
-    attrs.sections.each do |section|
-      xml += "<navPoint id=\"navPoint-#{section.position}\" playOrder=\"#{section.position}\">
-        <navLabel>
-          <text>#{section.title}</text>
-        </navLabel>
-        <content src=\"Text/Section#{section.position}.html\"/>
-      </navPoint>"
-    end
+    file = File.new(path + "/toc.ncx", "wb")
+
+    xm = Builder::XmlMarkup.new(:target => file, :indent => 2)
+    xm.instruct!
+    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" => "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.navMap {
+        attrs.sections.each do |section|
+          xm.navPoint("id" => "navPoint-#{section.position}", "playOrder" => "#{section.position}") {
+            xm.navLabel {
+              xm.text(section.title)
+            }
+            xm.content("src" => "Text/Section#{section.position}.html")
+          }
+        end
+      }
+    }
+
+    file.close
 
-    xml += "</navMap>
-    </ncx>"
-
-    toc_path = path + "/toc.ncx"
+  end
 
-    File.open(toc_path, "w+") do |f|
-      f.write(xml)
+  def self.change_perms(files)
+    files.each do |file|
+      FileUtils.chmod 0755, file
     end
-
-    FileUtils.chmod 0755, toc_path
   end
 
   def self.remove_tmp_dir(directory)
@@ -179,29 +147,41 @@ module EbookGenerator
 
   def self.generate_ebook(ebook_id)
 
-    # create tmp directory based on UUID
-    path = Rails.root.join "tmp/#{ebook_id}"
-    make_dir(path.to_s)
+    # 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)
 
-    # set up required files and dirs
-    content_path = initialise_files(path.to_s)
+    # 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(content_path + "/Text", attrs)
+    generate_sections(path + "/OEBPS/Text", attrs)
 
     # generate toc based on the number of sections generated
-    generate_content_opf(content_path, attrs)
-    generate_toc_ncx(content_path, attrs)
+    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.to_s, zipfile_name)
+    zf = ZipFileProcessor.new(path, zipfile_name)
     zf.write
 
     # Clean up the tmp dir
-    remove_tmp_dir(path.to_s + "/")
+    remove_tmp_dir(path + "/")
 
   end
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ebook_generator
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Kris Quigley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-18 00:00:00.000000000 Z
+date: 2014-04-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: friendly_id
   requirement: !ruby/object:Gem::Requirement
@@ -83,6 +97,7 @@ files:
 - lib/ebook_generator/initializer.rb
 - lib/ebook_generator/migration.rb
 - lib/ebook_generator/version.rb
+- lib/ebook_generator/zip_file_processor.rb
 - lib/generators/ebook_generator_generator.rb
 homepage: https://github.com/krisquigley/ebook_generator
 licenses: