text_to_epub 0.1.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem 'RedCloth'
+gem 'liquid'
+gem 'uuid'
+gem 'linguistics'
+
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.2.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,38 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    RedCloth (4.2.3)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    linguistics (1.0.8)
+    liquid (2.2.2)
+    macaddr (1.0.0)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.2.0)
+      rspec-core (~> 2.2)
+      rspec-expectations (~> 2.2)
+      rspec-mocks (~> 2.2)
+    rspec-core (2.2.1)
+    rspec-expectations (2.2.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.2.0)
+    uuid (2.3.1)
+      macaddr (~> 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  RedCloth
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  linguistics
+  liquid
+  rcov
+  rspec (~> 2.2.0)
+  uuid

data/LICENSE.txt

@@ -0,0 +1,26 @@
+Copyright (c) 2010 Jason LaPier
+
+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.
+
+
+NOTE:
+Some open source fonts are included for embedding in epubs. Please 
+refer to the license file for usage, found here:
+templates/OEBPS/fonts/licenses.txt

data/README.rdoc

@@ -0,0 +1,41 @@
+= text_to_epub
+
+Generates a template directory that you can use to build a custom epub file. 
+
+Usage:
+new_book /path/to/new/book
+(if the directory does not exist, it will be created)
+
+Go to the new directory and modify the file config.yml
+
+Run gen_epub from within the new directory.
+
+Text files will be html-ized using textile (via the RedCloth gem). Check the templates directory for files you may want to customize (such as stylesheet.css or the .liquid html files).
+
+== Converting to PDF
+
+After you've created an epub file, you can easily convert it to PDF. Here are a couple of hints:
+
+using Calibre (http://calibre-ebook.com/):
+  ebook-convert epub_folder/file_name.epub .pdf --custom-size=5x8 --base-font-size=12 --margin-top=54 --margin-left=54 --margin-bottom=54 --margin-right=54
+
+using wkhtmltopdf (http://code.google.com/p/wkhtmltopdf/):
+  wkhtmltopdf --page-width 5in --page-height 8in -L 0.5in -R 0.5in -B 0.5in -T 0.25in --footer-center '[page]' --footer-spacing 2 --print-media-type --footer-font-name TexGyreTermes --footer-font-size 9 epub_folder/OEBPS/*.html mybook.pdf
+
+
+
+== Contributing to text_to_epub
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 Jason LaPier. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "text_to_epub"
+  gem.homepage = "http://github.com/jlapier/text_to_epub"
+  gem.license = "MIT"
+  gem.summary = %Q{Generate epub skeleton, convert plain text files into xhtml and create epub}
+  gem.description = %Q{Generates a template directory that you can use to build a custom epub. 
+    After customizing templates, use bin/gen_epub.rb to create and validate an epub archive.}
+  gem.email = "jason.lapier@gmail.com"
+  gem.authors = ["Jason LaPier"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+  gem.add_runtime_dependency 'RedCloth'
+  gem.add_runtime_dependency 'liquid'
+  gem.add_runtime_dependency 'uuid'
+  gem.add_runtime_dependency 'linguistics'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "text_to_epub #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/bin/gen_epub

@@ -0,0 +1,40 @@
+#!/usr/bin/ruby
+
+@base_dir = File.expand_path(File.dirname(__FILE__) + '/..')
+
+$: << File.join(@base_dir, 'lib')
+
+require File.join(@base_dir, 'lib', 'text_to_epub')
+
+include EpubSetup
+
+@config = YAML::load(File.read('config.yml'))
+
+@epub_folder = File.join(@base_dir, @config[:temp_epub_folder])
+
+make_skeleton @base_dir, @epub_folder
+
+@book = Book.new @config[:book_title], @config[:author]
+@book.chapters = EpubSetup::read_chapters(@config[:chapter_glob])
+
+write_templates(@book)
+
+# TODO: use rubyzip or zipruby or something - they all seem to be a PITA compared to unix zip
+
+FileUtils.cd @epub_folder
+FileUtils.rm @config[:file_name] if File.exists?(@config[:file_name])
+
+puts "\nGenerating #{@epub_folder}/#{@config[:file_name]}"
+
+system "zip -0Xq #{@config[:file_name]} mimetype"
+system "zip -Xr9Dq #{@config[:file_name]} *"
+
+puts "\nRunning epubcheck..."
+system "java -jar #{@config[:epubcheck]} #{@config[:file_name]}"
+
+
+puts "\nnext convert to pdf for POD:"
+puts "\nebook-convert #{@epub_folder}/#{@config[:file_name]} .pdf --custom-size=5x8 --base-font-size=12 --margin-top=54 --margin-left=54 --margin-bottom=54 --margin-right=54"
+
+puts "\n -- or use wkhtmltopdf:"
+puts "\nwkhtmltopdf --page-width 5in --page-height 8in -L 0.5in -R 0.5in -B 0.5in -T 0.25in --footer-center '[page]' --footer-spacing 2 --print-media-type --footer-font-name TexGyreTermes --footer-font-size 9 #{@epub_folder}/OEBPS/*.html mybook1.pdf"

data/bin/new_book

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby
+
+require 'fileutils'
+
+if ARGV[0]
+  @destination = ARGV[0]
+else
+  puts "Usage:\n"
+  puts "new_book.rb path/to/copy/templates/to"
+  exit
+end
+
+@base_dir = File.expand_path(File.dirname(__FILE__) + '/..')
+
+puts "Creating templates..."
+FileUtils.mkdir_p @destination
+puts "Copying necessary files..."
+FileUtils.cp_r File.join(@base_dir, 'templates'), @destination
+FileUtils.cp_r File.join(@base_dir, 'lib'), @destination
+FileUtils.cp_r File.join(@base_dir, 'bin'), @destination
+FileUtils.cp 'config_sample.yml', File.join(@destination, 'config.yml')
+
+puts "Done! Go to #{@destination} and edit config.yml and then run ./bin/gen_epub.rb from that directory."

data/config_sample.yml

@@ -0,0 +1,7 @@
+--- 
+:book_title: My Book Title
+:author: My Name
+:epubcheck: /opt/epubcheck/epubcheck-1.1.jar
+:file_name: mybook.epub
+:chapter_glob: ~/some/path/*.txt
+:temp_epub_folder: epub

data/lib/book.rb

@@ -0,0 +1,30 @@
+# Book: contains info like title and creator
+# also contains an array of chapters (Chapter class)
+class Book
+  attr_accessor :title, :creator, :chapters, :pub_date, :pub_year, :isbn
+  liquid_methods :title, :creator, :chapters, :pub_date, :pub_year, :book_id, :cc_url
+
+  def initialize(title, creator, pub_date = Date.today, isbn = nil)
+    self.title = title
+    self.creator = creator
+    self.pub_date = pub_date
+    self.isbn = isbn
+  end
+
+  def book_id
+    @book_id ||= (isbn || "urn:uuid:#{UUID.new.generate}")
+  end
+
+  def pub_year
+    pub_date.year
+  end
+
+  def cc_url
+    # attribution only, free to distribute, modify, or use commercially:
+    # "http://creativecommons.org/licenses/by/3.0/"
+
+    # free to share with attribution, non-commercial, no derivatives
+    "http://creativecommons.org/licenses/by-nc-nd/3.0/"
+  end
+end
+

data/lib/chapter.rb

@@ -0,0 +1,68 @@
+# Chapter 
+# contains name, content (text-only)
+# generates html
+# file_name should reference html file after it is written
+class Chapter
+  attr_accessor :number, :name, :subhead, :file_name, :content
+  liquid_methods :number, :name, :subhead, :file_name, :word_count, :html, :chapter_id,
+    :number_as_word, :number_or_name, :name_or_number
+
+  def initialize(lines)
+    meta = true
+    while meta and line = lines.shift do
+      line.strip!
+      if line =~ /^Chapter:/
+        meta_num = line.scan(/^Chapter:\s*(\d+)/).flatten.first
+        self.number = meta_num.strip.to_i if meta_num
+      elsif line =~ /^Name:/
+        meta_name = line.scan(/^Name:\s*(.+)/).flatten.first
+        self.name = meta_name.strip if meta_name
+      elsif line =~ /^Subhead:/
+        meta_sub = line.scan(/^Subhead:\s*(.+)/).flatten.first
+        self.subhead = meta_sub.strip if meta_sub
+      else
+        lines = [line] + lines if line
+        meta = false 
+      end
+    end
+
+    self.content = lines.join
+  end
+
+  def word_count
+    @word_count ||= (name || "" + content).gsub(/(_|\*|,|:)/, '').scan(/(\w|-|')+/).size
+  end
+  
+  def html
+    content.strip!
+    @html ||= RedCloth.new(content).to_html
+  end
+
+  def chapter_id
+    @book_id ||= file_name.gsub(/\W/,'_').gsub('.html', '')
+  end
+
+  def number_as_word
+    number ? Linguistics::EN.numwords(number).capitalize : nil
+  end
+
+  # if there is a number, give us that written out as words; otherwise give the chapter name
+  def number_or_name
+    if number
+      "Chapter #{number_as_word}"
+    else
+      name || ""
+    end
+  end
+  
+  # if there is a name, give us that; otherwise give the number written out as words
+  def name_or_number
+    if name and !name.empty?
+      name
+    elsif number
+      "Chapter #{number_as_word}"
+    else
+      ""
+    end
+  end
+end

data/lib/epub_setup.rb

@@ -0,0 +1,70 @@
+# EpubSetup
+# making directories and moving files and whatnot
+module EpubSetup
+  def make_skeleton(base_dir, epub_folder)
+    @epub_folder = epub_folder
+    @source_templates_dir = File.join(base_dir, 'templates')
+    @target_meta_dir = File.join(@epub_folder, 'META-INF')
+    @target_oebps_dir = File.join(@epub_folder, 'OEBPS')
+
+    FileUtils.rm_rf @epub_folder if File.exists?(@epub_folder)
+    FileUtils.mkdir_p @epub_folder
+    FileUtils.mkdir_p @target_meta_dir
+    FileUtils.mkdir_p @target_oebps_dir
+
+    FileUtils.cp File.join(@source_templates_dir, 'mimetype'), @epub_folder
+    FileUtils.cp File.join(@source_templates_dir, 'META-INF', 'container.xml'), @target_meta_dir
+
+    # TODO - somehow detect these "asset" folders and files - 
+    # for now they are these defaults: css, images, fonts
+    FileUtils.cp Dir[File.join(@source_templates_dir, 'OEBPS', '*.css')], @target_oebps_dir
+    FileUtils.cp_r File.join(@source_templates_dir, 'OEBPS', 'images'), @target_oebps_dir
+    FileUtils.cp_r File.join(@source_templates_dir, 'OEBPS', 'fonts'), @target_oebps_dir
+
+    # liquid templates for rest of files
+    @chapter_liq_template = Liquid::Template.parse(File.read(File.join(@source_templates_dir, 'OEBPS', 'chapter.html.liquid'    )))
+    @content_liq_template = Liquid::Template.parse(File.read(File.join(@source_templates_dir, 'OEBPS', 'content.opf.liquid'     )))
+    @title_liq_template   = Liquid::Template.parse(File.read(File.join(@source_templates_dir, 'OEBPS', 'title.html.liquid'      )))
+    @toc_liq_template     = Liquid::Template.parse(File.read(File.join(@source_templates_dir, 'OEBPS', 'toc.ncx.liquid'         )))
+    @eob_liq_template     = Liquid::Template.parse(File.read(File.join(@source_templates_dir, 'OEBPS', 'end_of_book.html.liquid')))
+  end
+
+  def read_chapters(file_glob)
+    file_glob = File.expand_path(file_glob)
+    puts "Reading files: #{file_glob} (#{Dir[file_glob].size} files found)"
+    chapters = []
+
+    Dir[file_glob].each do |txtfile|
+      chapter = nil
+      File.open(txtfile) do |f|
+        chapter = Chapter.new(f.readlines)
+        chapter.file_name = "#{File.basename(txtfile, '.txt')}.html"
+      end
+      chapters << chapter if chapter
+    end
+
+    # returns chapters as an array sorted by name
+    chapters.sort_by { |c| [c.number, c.name, c.file_name] }
+  end
+
+  def write_templates(book)
+    book.chapters.each do |chapter|
+      html_output = @chapter_liq_template.render 'chapter' => chapter
+      puts "Writing: #{@epub_folder}/OEBPS/#{chapter.file_name}"
+      File.open(File.join(@target_oebps_dir, chapter.file_name), "w") { |f| f.puts html_output }
+    end
+
+    puts "Writing: #{@epub_folder}/OEBPS/content.opf"
+    File.open(File.join(@target_oebps_dir, 'content.opf'), "w") { |f| f.puts @content_liq_template.render('book' => book,
+        'css_files'   => Dir[File.join(@source_templates_dir, 'OEBPS', '*.css')].map    { |f| File.basename(f) },
+        'image_files' => Dir[File.join(@source_templates_dir, 'OEBPS', 'images', '*')].map { |f| File.basename(f) },
+        'font_files'  => Dir[File.join(@source_templates_dir, 'OEBPS', 'fonts', '*')].map  { |f| File.basename(f) } ) }
+    puts "Writing: #{@epub_folder}/OEBPS/title.html"
+    File.open(File.join(@target_oebps_dir, 'title.html'), "w") { |f| f.puts @title_liq_template.render('book' => book) }
+    puts "Writing: #{@epub_folder}/OEBPS/end_of_book.html"
+    File.open(File.join(@target_oebps_dir, 'end_of_book.html'), "w") { |f| f.puts @eob_liq_template.render('book' => book) }
+    puts "Writing: #{@epub_folder}/OEBPS/toc.ncx"
+    File.open(File.join(@target_oebps_dir, 'toc.ncx'), "w") { |f| f.puts @toc_liq_template.render('book' => book) }
+  end
+end
+

data/lib/text_to_epub.rb

@@ -0,0 +1,15 @@
+# gems
+require 'liquid'
+require 'RedCloth'
+require 'linguistics'
+require 'uuid'
+
+# ruby libs
+require 'fileutils'
+require 'date'
+
+# text_to_epub libs
+require 'book'
+require 'chapter'
+require 'epub_setup'
+