jekyll-ebook 0.0.1

data/bin/jekyll-ebook

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+# For use/testing when no gem is installed
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib]) 
+
+require 'jekyll-ebook'
+
+# Generate an EPUB from manifests passed as command line arguments
+ARGV.each { |m| Ebook.new(m).generate_epub }

data/lib/jekyll-ebook.rb

@@ -0,0 +1,18 @@
+
+# Name::          EPUB Generator for Jekyll
+# Author::        Lincoln Mullen | lincoln@lincolnmullen.com
+# Copyright::     Copyright (c) 2012 Lincoln Mullen 
+# License::       MIT License | http://lmullen.mit-license.org/
+
+# A Ruby script to create EPUB books from Jekyll posts and pages using 
+# Pandoc. 
+
+$:.unshift File.dirname(__FILE__) # For use/testing when no gem is installed
+
+# load the required files
+require 'yaml'
+require 'pandoc-ruby'
+require 'jekyll-ebook/article'
+require 'jekyll-ebook/ebook'
+
+

data/lib/jekyll-ebook/article.rb

@@ -0,0 +1,63 @@
+# The Article class loads a file that is formatted as a Jekyll post or 
+# page with metadata in a YAML block at the top and the content in 
+# Markdown or HTML. It has a method to export the metadata in a format 
+# suitable for conversion to EPUB using Pandoc.
+
+class Article
+
+  # +filename+ is the name of the Jekyll post or page
+  # +metadata+ is the metadata read in from the post or page
+  # +content+ is the body of the post or page
+  # +required_fields+ is the list of metadata items to include
+  attr_accessor :filename, :metadata, :content, :required_fields
+
+  # Retrieve the filename then call the method to read its data. Pass 
+  # required_fields along but delete 'title' since we're going to print 
+  # it regardless.
+  def initialize( filename, required_fields )
+    @required_fields = required_fields.delete_if { |f| f == "title" }
+    @filename = filename
+    self.read_file
+  end
+
+  # Read the metadata and content from the Jekyll post or page
+  def read_file
+
+    self.content = File.read(@filename)
+
+    # Define a regular expression to find the YAML header Use the back 
+    # reference to load the metadata and the postmatch to load the 
+    # content.
+    begin
+      if /^(---\s*\n.*?\n?)^(---\s*$\n?)/m.match(self.content)
+        self.metadata = YAML.load($1)
+        self.content = $'
+      end
+    rescue => e
+      puts "YAML exception reading #{filename}: #{e.message}"
+    end
+
+  end
+
+  # Print the relevant metadata in a block with CSS selectors for 
+  # formatting in the e-book, then print the content
+  def format_article
+
+    # an array to hold all our output
+    out = Array.new
+
+    out.push "# " + self.metadata['title'] + "\n\n"
+
+    # Loop through the required fields, printing them if they exist
+    self.required_fields.each do |f|
+      out.push "<p class='#{f}'>" + self.metadata[f] + "</p>\n\n" unless self.metadata[f].nil?
+    end
+
+    out.push self.content
+
+    # Return the contents of the array
+    return out.join("\n")
+
+  end
+
+end

data/lib/jekyll-ebook/ebook.rb

@@ -0,0 +1,67 @@
+# The Ebook class reads a YAML manifest file that contains a list of 
+# Jekyll posts and pages to be included in the EPUB book. It then 
+# creates an article object for each file, writing the metadata to both 
+# a table of contents and a body file.
+
+class Ebook
+
+  # +manifest+ is the filename of the YAML manifest 
+  attr_accessor :manifest
+
+  # Initialize the object with the filename of the manifest
+  def initialize( manifest )
+
+    begin
+      @manifest = YAML.load(File.read(manifest))
+    rescue => e
+      puts "YAML exception reading #{manifest}: #{e.message}"
+    end
+
+  end
+
+  # Loop through the contents in the manifest to generate the body 
+  # content and the table of contents
+  def generate_content
+
+    # an array to hold all our output
+    out = Array.new
+
+    # Generate front matter as Pandoc title block
+    out.push "% " + self.manifest['title']
+    out.push "% " + self.manifest['author']
+    out.push "% " + self.manifest['date'] + "\n" unless self.manifest['date'].nil?
+
+    # Loop through the sections in the manifest's list of contents
+    self.manifest['contents'].each do |section|
+
+      out.push "# " + section['section-title'] + "\n\n"
+
+      # Loop through the files in this section. Create an Article object 
+      # for each file, to which we pass the directory plus filename and 
+      # the list of required metadata items.
+      section['files'].each do |filename|
+        out.push Article.new( self.manifest['content-dir'] + filename , self.manifest['header-items'] ).format_article
+      end
+
+    end
+
+    # Return the contents of the array
+    return out.join("\n")
+
+  end
+
+  # Use PandocRuby to take the output of the `generate_content` method 
+  # and create an EPUB file from it, using the settings in the manifest.
+  def generate_epub
+
+    Dir.chdir(self.manifest['epub-dir'])
+    PandocRuby.new( self.generate_content ,
+                   {:f => :markdown, :to => :epub},
+                   'smart', 'o' => self.manifest['epub-filename'],
+                   'epub-cover-image' => self.manifest['epub-cover-image'],
+                   'epub-metadata' => self.manifest['epub-metadata'], 
+                   'epub-stylesheet' => self.manifest['epub-stylesheet'],).convert
+
+  end
+
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-ebook
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Lincoln A. Mullen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-01 00:00:00.000000000 Z
+dependencies: []
+description: A gem to generate an EPUB e-book from Jekyll posts and pages
+email: lincoln@lincolnmullen.com
+executables:
+- jekyll-ebook
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll-ebook.rb
+- lib/jekyll-ebook/article.rb
+- lib/jekyll-ebook/ebook.rb
+- bin/jekyll-ebook
+homepage: https://github.com/lmullen/jekyll-ebook
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: EPUB generator for Jekyll
+test_files: []
+has_rdoc: