epubbery 0.1.2 → 0.2.0

data/Gemfile

@@ -3,6 +3,7 @@ source "http://rubygems.org"
 # Example:
 #   gem "activesupport", ">= 2.3.5"
 
+gem 'rake'
 gem 'RedCloth'
 gem 'liquid'
 gem 'uuid'

data/Gemfile.lock

@@ -1,27 +1,27 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    RedCloth (4.2.3)
+    RedCloth (4.2.7)
     diff-lcs (1.1.2)
     git (1.2.5)
-    jeweler (1.5.1)
+    jeweler (1.5.2)
       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)
+    rake (0.9.2)
     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)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.2.0)
-    uuid (2.3.1)
+    rspec-mocks (2.6.0)
+    uuid (2.3.2)
       macaddr (~> 1.0)
 
 PLATFORMS
@@ -33,6 +33,7 @@ DEPENDENCIES
   jeweler (~> 1.5.1)
   linguistics
   liquid
+  rake
   rcov
   rspec (~> 2.2.0)
   uuid

data/README.rdoc

@@ -3,15 +3,46 @@
 Generates a template directory that you can use to build a custom epub file. 
 
 Usage:
-new_book /path/to/new/book
+epubbery /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.
+Run epubbery 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).
 
+== meta tags in text files
+Any line at the top of a text file that matches a single word followed by a colon, followed by any text, will become a meta tag-like variable for that "chapter". For example, if you have:
+  Date: 1999
+  Subhead: Party Time
+
+Then your chapter will have a "meta" hash with those attributes:
+  chapter.meta['date'] == '1999'
+  chapter.meta['subhead'] == 'Party Time'
+
+Additionally, there are a couple of special meta tags that will be used for functional purposes:
+  Name: _string_ - will always be availble as chapter.name
+  Position: _number_ - will be set to chapter.number and used in sorting
+  Number: _number_ - will be set to chapter.number and used in sorting
+  Chapter: _number_ - will be set to chapter.number and used in sorting
+  Template: see below
+
+== Templates
+You'll find a few liquid templates in the OEBPS directory of your project. Feel free to edit these as desired using liquid syntax:
+http://www.liquidmarkup.org/
+By default, all text files will use the chapter.html.liquid template. You can override this default in config.yml, as well as on a file-by-file basis (by using the special meta tag "Template: whatever").
+
+Any meta tags as described previously will be available in the liquid templates.
+
+Helper functions for chapters:
+  name
+  number_or_name
+  number_as_word
+  name_or_number
+  word_count
+  html
+
 == Converting to PDF
 
 After you've created an epub file, you can easily convert it to PDF. Here are a couple of hints:

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/bin/epubbery

@@ -7,7 +7,7 @@ $: << File.join(@gem_dir, 'lib')
 require 'fileutils'
 require File.join(@gem_dir, 'lib', 'epubbery')
 
-include EpubSetup
+@epub = Epub.new
 
 if ARGV[0]
   @destination = ARGV[0]
@@ -26,12 +26,12 @@ elsif File.exist?('config.yml')
   @config = YAML::load(File.read('config.yml'))
   @epub_folder = File.join(Dir.getwd, @config[:temp_epub_folder])
   
-  make_skeleton Dir.getwd, @epub_folder
+  @epub.make_skeleton Dir.getwd, @epub_folder, @config[:default_template]
   
   @book = Book.new @config[:book_title], @config[:author]
-  @book.chapters = EpubSetup::read_chapters(@config[:chapter_glob])
+  @book.chapters = Epub.read_chapters(@config[:chapter_glob])
   
-  write_templates(@book)
+  @epub.write_templates(@book)
   
   # TODO: use rubyzip or zipruby or something - they all seem to be a PITA compared to unix zip
   

data/config_sample.yml

@@ -5,3 +5,4 @@
 :file_name: mybook.epub
 :chapter_glob: ~/some/path/*.txt
 :temp_epub_folder: epub
+:default_template: chapter

data/epubbery.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{epubbery}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jason LaPier"]
-  s.date = %q{2011-06-10}
+  s.date = %q{2011-06-18}
   s.default_executable = %q{epubbery}
   s.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.}
@@ -33,11 +33,11 @@ Gem::Specification.new do |s|
     "epubbery.gemspec",
     "lib/book.rb",
     "lib/chapter.rb",
-    "lib/epub_setup.rb",
+    "lib/epub.rb",
     "lib/epubbery.rb",
     "spec/book_spec.rb",
     "spec/chapter_spec.rb",
-    "spec/epub_setup_spec.rb",
+    "spec/epub_spec.rb",
     "spec/spec_helper.rb",
     "templates/META-INF/container.xml",
     "templates/OEBPS/chapter.html.liquid",
@@ -74,7 +74,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/book_spec.rb",
     "spec/chapter_spec.rb",
-    "spec/epub_setup_spec.rb",
+    "spec/epub_spec.rb",
     "spec/spec_helper.rb"
   ]
 
@@ -82,6 +82,7 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
       s.add_runtime_dependency(%q<RedCloth>, [">= 0"])
       s.add_runtime_dependency(%q<liquid>, [">= 0"])
       s.add_runtime_dependency(%q<uuid>, [">= 0"])
@@ -95,6 +96,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<uuid>, [">= 0"])
       s.add_runtime_dependency(%q<linguistics>, [">= 0"])
     else
+      s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<RedCloth>, [">= 0"])
       s.add_dependency(%q<liquid>, [">= 0"])
       s.add_dependency(%q<uuid>, [">= 0"])
@@ -109,6 +111,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<linguistics>, [">= 0"])
     end
   else
+    s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<RedCloth>, [">= 0"])
     s.add_dependency(%q<liquid>, [">= 0"])
     s.add_dependency(%q<uuid>, [">= 0"])

data/lib/chapter.rb

@@ -48,6 +48,10 @@ class Chapter
     meta['name'] || ""
   end
 
+  def template
+    meta['template'] || nil
+  end
+
   # if there is a number, give us that written out as words; otherwise give the chapter name
   def number_or_name
     number ? "Chapter #{number_as_word}" : name

data/lib/{epub_setup.rb → epub.rb}

@@ -1,7 +1,28 @@
 # EpubSetup
 # making directories and moving files and whatnot
-module EpubSetup
-  def make_skeleton(base_dir, epub_folder)
+class Epub
+  class << self
+    # kind of an orphaned method that just reads in chapters from text files and returns chapter objects
+    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 || 0, c.name || '', c.file_name] }
+    end
+  end
+
+  def make_skeleton(base_dir, epub_folder, default_template = 'chapter')
     @epub_folder = epub_folder
     @source_templates_dir = File.join(base_dir, 'templates')
     @target_meta_dir = File.join(@epub_folder, 'META-INF')
@@ -22,34 +43,20 @@ module EpubSetup
     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'    )))
+    @default_liq_template = Liquid::Template.parse(File.read(File.join(@source_templates_dir, 'OEBPS', "#{default_template.gsub(' ', '_')}.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 || 0, c.name || '', c.file_name] }
-  end
-
   def write_templates(book)
     book.chapters.each do |chapter|
-      html_output = @chapter_liq_template.render 'chapter' => chapter
+      template = @default_liq_template
+      if chapter.template
+        template = Liquid::Template.parse(File.read(File.join(@source_templates_dir, 'OEBPS', "#{chapter.template.gsub(' ', '_')}.html.liquid"    )))
+      end
+      html_output = 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

data/lib/epubbery.rb

@@ -12,5 +12,5 @@ require 'date'
 # epubbery libs
 require 'book'
 require 'chapter'
-require 'epub_setup'
+require 'epub'
 

data/spec/{epub_setup_spec.rb → epub_spec.rb}

@@ -1,20 +1,22 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-include EpubSetup
-
-describe EpubSetup do
+describe Epub do
   before(:all) do
+    @epub = Epub.new
     @tmp_epub_folder = "test_epub_folder_safe_to_remove_will_be_deleted"
     @base_dir = File.expand_path(File.dirname(__FILE__) + "/..")
     @tmp_text_folder = "test_epub_folder_safe_to_remove_will_be_deleted2"
     FileUtils.rm_rf File.join(@base_dir, @tmp_text_folder) if File.exists?(File.join(@base_dir, @tmp_text_folder))
     FileUtils.mkdir File.join(@base_dir, @tmp_text_folder)
+    FileUtils.cp File.join(@base_dir, 'templates', 'OEBPS', "chapter.html.liquid"),
+        File.join(@base_dir, 'templates', 'OEBPS', 'delete_this_alternate.html.liquid')
     File.open(File.join(@base_dir, @tmp_text_folder, "1.txt"), "w") do |f|
         f.puts "Chapter: 1\n"
         f.puts "Blah blah blah.\n"
     end
     File.open(File.join(@base_dir, @tmp_text_folder, "2.txt"), "w") do |f|
         f.puts "Chapter: 2\n"
+        f.puts "Template: delete this alternate\n"
         f.puts "Bork bork bork.\n"
     end
   end
@@ -22,10 +24,11 @@ describe EpubSetup do
   after(:all) do
     FileUtils.rm_rf File.join(@base_dir, @tmp_epub_folder)
     FileUtils.rm_rf File.join(@base_dir, @tmp_text_folder)
+    FileUtils.rm File.join(@base_dir, 'templates', 'OEBPS', 'delete_this_alternate.html.liquid')
   end
 
   it "should make skeleton" do
-    make_skeleton @base_dir, @tmp_epub_folder
+    @epub.make_skeleton @base_dir, @tmp_epub_folder
     File.exists?(File.join(@tmp_epub_folder, 'META-INF')).should == true
     File.exists?(File.join(@tmp_epub_folder, 'META-INF', 'container.xml')).should == true
     File.exists?(File.join(@tmp_epub_folder, 'OEBPS')).should == true
@@ -33,17 +36,28 @@ describe EpubSetup do
   end
 
   it "should read chapters from a glob file description" do
-    chapters = read_chapters("#{File.join(@base_dir, @tmp_text_folder)}/*.txt")
+    chapters = Epub.read_chapters("#{File.join(@base_dir, @tmp_text_folder)}/*.txt")
     chapters.size.should == 2
     chapters.first.file_name.should == "1.html"
     chapters[1].file_name.should == "2.html"
   end
 
   it "should write tempates into the epub folder" do
-    make_skeleton @base_dir, @tmp_epub_folder
+    @epub.make_skeleton @base_dir, @tmp_epub_folder
+    book = Book.new "Testy", "Jason", Date.new(2001)
+    book.chapters = Epub.read_chapters("#{File.join(@base_dir, @tmp_text_folder)}/*.txt")
+    @epub.write_templates book
+    File.exists?(File.join(@tmp_epub_folder, 'OEBPS', 'title.html')).should == true
+    File.exists?(File.join(@tmp_epub_folder, 'OEBPS', '1.html')).should == true
+    File.exists?(File.join(@tmp_epub_folder, 'OEBPS', '2.html')).should == true
+    File.exists?(File.join(@tmp_epub_folder, 'OEBPS', 'end_of_book.html')).should == true
+  end
+
+  it "should write tempates into the epub folder" do
+    @epub.make_skeleton @base_dir, @tmp_epub_folder
     book = Book.new "Testy", "Jason", Date.new(2001)
-    book.chapters = read_chapters("#{File.join(@base_dir, @tmp_text_folder)}/*.txt")
-    write_templates book
+    book.chapters = Epub.read_chapters("#{File.join(@base_dir, @tmp_text_folder)}/*.txt")
+    @epub.write_templates book
     File.exists?(File.join(@tmp_epub_folder, 'OEBPS', 'title.html')).should == true
     File.exists?(File.join(@tmp_epub_folder, 'OEBPS', '1.html')).should == true
     File.exists?(File.join(@tmp_epub_folder, 'OEBPS', '2.html')).should == true

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: epubbery
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jason LaPier
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-10 00:00:00 -07:00
+date: 2011-06-18 00:00:00 -07:00
 default_executable: epubbery
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: RedCloth
+  name: rake
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -33,7 +33,7 @@ dependencies:
   type: :runtime
   requirement: *id001
 - !ruby/object:Gem::Dependency 
-  name: liquid
+  name: RedCloth
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -47,7 +47,7 @@ dependencies:
   type: :runtime
   requirement: *id002
 - !ruby/object:Gem::Dependency 
-  name: uuid
+  name: liquid
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -61,7 +61,7 @@ dependencies:
   type: :runtime
   requirement: *id003
 - !ruby/object:Gem::Dependency 
-  name: linguistics
+  name: uuid
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -75,8 +75,22 @@ dependencies:
   type: :runtime
   requirement: *id004
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: linguistics
   version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :runtime
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -89,10 +103,10 @@ dependencies:
         version: 2.2.0
   prerelease: false
   type: :development
-  requirement: *id005
+  requirement: *id006
 - !ruby/object:Gem::Dependency 
   name: bundler
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -105,10 +119,10 @@ dependencies:
         version: 1.0.0
   prerelease: false
   type: :development
-  requirement: *id006
+  requirement: *id007
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -121,10 +135,10 @@ dependencies:
         version: 1.5.1
   prerelease: false
   type: :development
-  requirement: *id007
+  requirement: *id008
 - !ruby/object:Gem::Dependency 
   name: rcov
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -135,10 +149,10 @@ dependencies:
         version: "0"
   prerelease: false
   type: :development
-  requirement: *id008
+  requirement: *id009
 - !ruby/object:Gem::Dependency 
   name: RedCloth
-  version_requirements: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -149,10 +163,10 @@ dependencies:
         version: "0"
   prerelease: false
   type: :runtime
-  requirement: *id009
+  requirement: *id010
 - !ruby/object:Gem::Dependency 
   name: liquid
-  version_requirements: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -163,10 +177,10 @@ dependencies:
         version: "0"
   prerelease: false
   type: :runtime
-  requirement: *id010
+  requirement: *id011
 - !ruby/object:Gem::Dependency 
   name: uuid
-  version_requirements: &id011 !ruby/object:Gem::Requirement 
+  version_requirements: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -177,10 +191,10 @@ dependencies:
         version: "0"
   prerelease: false
   type: :runtime
-  requirement: *id011
+  requirement: *id012
 - !ruby/object:Gem::Dependency 
   name: linguistics
-  version_requirements: &id012 !ruby/object:Gem::Requirement 
+  version_requirements: &id013 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -191,7 +205,7 @@ dependencies:
         version: "0"
   prerelease: false
   type: :runtime
-  requirement: *id012
+  requirement: *id013
 description: |-
   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.
@@ -217,11 +231,11 @@ files:
 - epubbery.gemspec
 - lib/book.rb
 - lib/chapter.rb
-- lib/epub_setup.rb
+- lib/epub.rb
 - lib/epubbery.rb
 - spec/book_spec.rb
 - spec/chapter_spec.rb
-- spec/epub_setup_spec.rb
+- spec/epub_spec.rb
 - spec/spec_helper.rb
 - templates/META-INF/container.xml
 - templates/OEBPS/chapter.html.liquid
@@ -286,5 +300,5 @@ summary: Generate epub skeleton, convert plain text files into xhtml and create
 test_files: 
 - spec/book_spec.rb
 - spec/chapter_spec.rb
-- spec/epub_setup_spec.rb
+- spec/epub_spec.rb
 - spec/spec_helper.rb