jekyll-epub 0.0.1

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Gregoire Lejeune
+
+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.

data/README.rdoc

@@ -0,0 +1,101 @@
+= jekyll-epub
+
+Create an eBook (epub) of your Jekyll blog
+
+== How To
+
+=== Create your blog ;)
+
+First, you need to create your own Jekyll Blog ;) Please, refer to the {Jekyll documentation}[http://wiki.github.com/mojombo/jekyll/].
+
+=== Configuration
+
+Then, you must add a configuration file : <tt>_epub.yml</tt>. This file is pretty similar to the Jekyll configuration file (<tt>_config.yml</tt>) except that's you must add in some specifics entries. This entries are in the mapping <tt>epub</tt>:
+
+<tt>_epub.yml</tt> :
+
+  epub:
+    name: "My Jekyll Blog"
+    lang: en
+    identifier: my_blog.example.com-123456
+
+Note that's in the file, you can also use all the {Jekyll configuration options}[http://wiki.github.com/mojombo/jekyll/configuration]. However, it is prudent not to change the <tt>permalink</tt> option, or you may spend a lot of time to set the proper access to resources (images, CSS, ...). You have been warned;)
+
+Here is the list of options :
+
+* <tt>name:</tt> <tt>String</tt> : The name of your book. This is a mandatory option.
+* <tt>title:</tt> <tt>String</tt> : The title of your book. This is a mandatory option.
+* <tt>identifier:</tt> <tt>String</tt> : A unique identifier for your book. If you have one, you can use an ISBN. If not given, Jekyll-epub will generate an UUID for you.
+* <tt>subject:</tt> <tt>String</tt> : The subject of the book.
+* <tt>description:</tt> <tt>String</tt> : An abstract of your book.
+* <tt>relation:</tt> <tt>String</tt> : 
+* <tt>creator:</tt> <tt>String</tt> : The identity of the creator of the book. 
+* <tt>contributor:</tt> <tt>String</tt> : The identity of the contributor of the book.
+* <tt>publisher:</tt> <tt>String</tt> : The identity of the publisher.
+* <tt>date:</tt> <tt>Date</tt> : You really want to know ;) 
+* <tt>rights:</tt> <tt>String</tt> : The copyright of your book.
+* <tt>type:</tt> <tt>String</tt> : The type of the book (I mean the kind)
+* <tt>format:</tt> <tt>String</tt> : Some informations about the book format (The physical format)
+* <tt>source:</tt> <tt>String</tt> : Information about the source of the book.
+* <tt>coverage:</tt> <tt>String</tt> : Provides information on the spatial and/or time relevance of the book.
+* <tt>cover-image:</tt> <tt>String</tt> : The image to use for the cover of the book (i use a 540 × 648 pixels image)
+* <tt>pages-order:</tt> <tt>[page | post]</tt> : A list of pages and/or posts you want to order at the begenning of the book. If you don't specify any order, Jekyll-epub will generate the book with the posts first (from the older to the newer), then the pages.
+
+=== Layout
+
+If you want to use a special layout for your book, you can use the <tt>epub:</tt> mapping in the header of your pages, posts, layouts. This mapping is similar to the <tt>layout:</tt> mapping except that's it is specific for the epub generation. In this example :
+
+  ---
+  epub: my_ebook
+  layout: post
+  ---
+  <p>This is the content of my post...</p>
+
+When we generate the epub, Jekyll-epub will use the layout <tt>my_ebook</tt>.
+
+=== Liquid extension
+
+You can also use two Liquid extensions :
+
+  {% epub %}
+  ... This will only be display in the epub ...
+  {% endepub %}
+
+  {% noepub %}
+  ... This will not be display in the epub ...
+  {% endnoepub %}
+
+Since I have add those two extensions, if you want to use them, you also need to use one of the two following solution
+
+==== Use <tt>jekyll_epub</tt>
+
+1. Run <tt>jekyll_epub</tt> instead of <tt>jekyll</tt> to generate you site and eBook. 
+
+Otherwise, you will not be able to generate your (web) site.
+
+==== Use Rack tasks
+
+1. Create a Rakefile in your root's Jekyll blog directory
+2. Add the following code in your Rakefile
+
+  require 'jekyll/epub/tasks'
+  Jekyll::Epub::Tasks do
+    web :serve_port, 4000
+    epub :destination, "_epub"
+  end
+
+3. Use <tt>rake epub</tt> to generate the epub, use <tt>rake site</tt> to generate the website, use <tt>rake serve</tt> to serve the website.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Gregoire Lejeune. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "jekyll-epub"
+    gem.summary = %Q{Create an eBook (epub) of your Jekyll blog}
+    gem.description = %Q{Create an eBook (epub) of your Jekyll blog}
+    gem.email = "gregoire.lejeune@free.fr"
+    gem.homepage = "http://github.com/glejeune/jekyll-epub"
+    gem.authors = ["Gregoire Lejeune"]
+
+    gem.add_dependency 'mime-types', ">= 0"
+    gem.add_dependency 'uuid', ">= 0"
+    gem.add_dependency 'jekyll', ">= 0"
+    
+    gem.add_development_dependency "shoulda", ">= 0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "jekyll-epub #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/jekyll_epub

@@ -0,0 +1,175 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+help = <<HELP
+Jekyll is a blog-aware, static site generator.
+
+Basic Command Line Usage:
+                                                                #       Site       #      ePub
+  --------------------------------------------------------------#------------------#-----------------
+  jekyll_epub                                                   # . -> ./_site     # . -> ./_epub
+  jekyll_epub <path to write generated site>                    # . -> <path>      # . -> <path>
+  jekyll_epub <path to source> <path to write generated site>   # <path> -> <path> # <path> -> <path>
+
+  ePub configuration is read from '<source>/_epub.yml'
+  
+  Site configuration is read from '<source>/_config.yml' but can be overriden
+  using the following options:
+
+HELP
+
+require 'optparse'
+require 'jekyll/epub'
+
+exec = {}
+options = { 
+  'gen_epub' => true, 
+  'gen_site' => true
+}
+opts = OptionParser.new do |opts|
+  opts.banner = help
+
+  opts.on("--auto", "Auto-regenerate") do
+    options['auto'] = true
+  end
+
+  opts.on("--no-auto", "No auto-regenerate") do
+    options['auto'] = false
+  end
+
+  opts.on("--no-epub", "Do not generate epub") do
+    options['gen_epub'] = false
+  end
+
+  opts.on("--no-site", "Do not generate site") do
+    options['gen_site'] = false
+  end
+
+  opts.on("--server [PORT]", "Start web server (default port 4000)") do |port|
+    options['server'] = true
+    options['server_port'] = port unless port.nil?
+  end
+
+  opts.on("--lsi", "Use LSI for better related posts") do
+    options['lsi'] = true
+  end
+
+  opts.on("--pygments", "Use pygments to highlight code") do
+    options['pygments'] = true
+  end
+
+  opts.on("--rdiscount", "Use rdiscount gem for Markdown") do
+    options['markdown'] = 'rdiscount'
+  end
+
+  opts.on("--permalink [TYPE]", "Use 'date' (default) for YYYY/MM/DD") do |style|
+    options['permalink'] = style unless style.nil?
+  end
+  
+  opts.on("--paginate [POSTS_PER_PAGE]", "Paginate a blog's posts") do |per_page|
+    begin
+      options['paginate'] = per_page.to_i
+      raise ArgumentError if options['paginate'] == 0
+    rescue
+      puts 'you must specify a number of posts by page bigger than 0'
+      exit 0
+    end
+  end
+
+  opts.on("--version", "Display current version") do
+    puts "Jekyll (epub) " + Jekyll.version
+    exit 0
+  end
+end
+
+# Read command line options into `options` hash
+opts.parse!
+
+# Get source and destintation from command line
+case ARGV.size
+  when 0
+  when 1
+    options['destination'] = ARGV[0]
+  when 2
+    options['source']      = ARGV[0]
+    options['destination'] = ARGV[1]
+  else
+    puts "Invalid options. Run `jekyll_epub --help` for assistance."
+    exit(1)
+end
+
+if options['gen_epub']
+  Jekyll::Epub.new().create( options )
+end
+
+if options['gen_site']
+  options = Jekyll.configuration(options)
+
+  # Get source and destination directories (possibly set by config file)
+  source      = options['source']
+  destination = options['destination']
+  
+  # Files to watch
+  def globs(source)
+    Dir.chdir(source) do
+      dirs = Dir['*'].select { |x| File.directory?(x) }
+      dirs -= ['_site']
+      dirs = dirs.map { |x| "#{x}/**/*" }
+      dirs += ['*']
+    end
+  end
+  
+  # Create the Site
+  site = Jekyll::Site.new(options)
+  
+  # Run the directory watcher for auto-generation, if required
+  if options['auto']
+    require 'directory_watcher'
+  
+    puts "Auto-regenerating enabled: #{source} -> #{destination}"
+  
+    dw = DirectoryWatcher.new(source)
+    dw.interval = 1
+    dw.glob = globs(source)
+  
+    dw.add_observer do |*args|
+      t = Time.now.strftime("%Y-%m-%d %H:%M:%S")
+      puts "[#{t}] regeneration: #{args.size} files changed"
+      site.process
+    end
+  
+    dw.start
+  
+    unless options['server']
+      loop { sleep 1000 }
+    end
+  else
+    puts "Building site: #{source} -> #{destination}"
+    site.process
+    puts "Successfully generated site: #{source} -> #{destination}"
+  end
+  
+  # Run the server on the specified port, if required
+  if options['server']
+    require 'webrick'
+    include WEBrick
+  
+    FileUtils.mkdir_p(destination)
+  
+    mime_types = WEBrick::HTTPUtils::DefaultMimeTypes
+    mime_types.store 'js', 'application/javascript'
+  
+    s = HTTPServer.new(
+      :Port            => options['server_port'],
+      :DocumentRoot    => destination,
+      :MimeTypes       => mime_types
+    )
+    t = Thread.new {
+      s.start
+    }
+  
+    trap("INT") { s.shutdown }
+    t.join()
+  end
+end

data/jekyll-epub.gemspec

@@ -0,0 +1,78 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{jekyll-epub}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gregoire Lejeune"]
+  s.date = %q{2010-04-27}
+  s.default_executable = %q{jekyll_epub}
+  s.description = %q{Create an eBook (epub) of your Jekyll blog}
+  s.email = %q{gregoire.lejeune@free.fr}
+  s.executables = ["jekyll_epub"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/jekyll_epub",
+     "jekyll-epub.gemspec",
+     "lib/jekyll/epub.rb",
+     "lib/jekyll/epub/dtd/xhtml-lat1.ent",
+     "lib/jekyll/epub/dtd/xhtml-special.ent",
+     "lib/jekyll/epub/dtd/xhtml-symbol.ent",
+     "lib/jekyll/epub/dtd/xhtml1-strict.dtd",
+     "lib/jekyll/epub/tasks.rb",
+     "lib/jekyll/epub/templates/META-INF/container.xml",
+     "lib/jekyll/epub/templates/content.opf",
+     "lib/jekyll/epub/templates/cover.xhtml",
+     "lib/jekyll/epub/templates/mimetype",
+     "lib/jekyll/epub/templates/page-template.xpgt",
+     "lib/jekyll/epub/templates/toc.ncx",
+     "lib/jekyll/tags/epub.rb",
+     "test/helper.rb",
+     "test/test_jekyll-epub.rb"
+  ]
+  s.homepage = %q{http://github.com/glejeune/jekyll-epub}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Create an eBook (epub) of your Jekyll blog}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_jekyll-epub.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mime-types>, [">= 0"])
+      s.add_runtime_dependency(%q<uuid>, [">= 0"])
+      s.add_runtime_dependency(%q<jekyll>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<mime-types>, [">= 0"])
+      s.add_dependency(%q<uuid>, [">= 0"])
+      s.add_dependency(%q<jekyll>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<mime-types>, [">= 0"])
+    s.add_dependency(%q<uuid>, [">= 0"])
+    s.add_dependency(%q<jekyll>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+