kitabu 1.0.0.rc1 → 1.0.0.rc2

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    kitabu (1.0.0.rc1)
+    kitabu (1.0.0.rc2)
       RedCloth (~> 4.2)
       activesupport (~> 3.0)
+      coderay
       eeepub-with-cover-support (~> 0.8)
       i18n (~> 0.5)
       nokogiri (~> 1.5)
       notifier (~> 0.1)
-      pygments.rb (~> 0.2)
       rdiscount (~> 1.6)
       thor (~> 0.14)
       watchr (~> 0.7)
@@ -20,36 +20,30 @@ GEM
     activesupport (3.2.3)
       i18n (~> 0.6)
       multi_json (~> 1.0)
-    blankslate (2.1.2.4)
     builder (3.0.0)
+    coderay (1.0.6)
     diff-lcs (1.1.3)
     eeepub-with-cover-support (0.8.7)
       builder
       rubyzip
-    ffi (1.0.11)
     i18n (0.6.0)
-    multi_json (1.3.2)
+    multi_json (1.3.5)
     nokogiri (1.5.2)
-    notifier (0.1.4)
-    pygments.rb (0.2.12)
-      rubypython (~> 0.5.3)
+    notifier (0.2.1)
     rake (0.9.2.2)
     rdiscount (1.6.8)
-    rspec (2.9.0)
-      rspec-core (~> 2.9.0)
-      rspec-expectations (~> 2.9.0)
-      rspec-mocks (~> 2.9.0)
-    rspec-core (2.9.0)
-    rspec-expectations (2.9.1)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.9.0)
-    rubypython (0.5.3)
-      blankslate (>= 2.1.2.3)
-      ffi (~> 1.0.7)
-    rubyzip (0.9.7)
+    rspec-mocks (2.10.1)
+    rubyzip (0.9.8)
     test_notifier (1.0.0)
       notifier
-    thor (0.14.6)
+    thor (0.15.2)
     watchr (0.7)
 
 PLATFORMS

data/README.rdoc

@@ -1,22 +1,42 @@
 = kitabu
 
-While Prince is too expensive (495USD for a single user license), the free version available at http://www.princexml.com/download/ generates a PDF with a small logo on the first page, which is removed when sent to a printer.
+While Prince is too expensive (495USD for a single user license), the free version available at http://www.princexml.com/download generates a PDF with a small logo on the first page, which is removed when sent to a printer.
 
 == Features
 
-* Write PDF using Markdown, Textile or plain HTML
+* Write using Markdown, Textile or plain HTML
 * Book layout support
 * Syntax highlight
-* Generate a HTML, PDF and e-Pub files
+* Generate HTML, PDF, e-Pub, Mobi and Text files
 * Table of Contents automatically generated from chapter titles
 
 == Installation
 
-To install Kitabu, you’ll need a working Ruby installation with Rubygems.
+To install Kitabu, you’ll need a working Ruby 1.9+ installation.
 If you’re cool with it, just run the following command to install it.
 
   gem install kitabu --pre
 
+After installing Kitabu, run the following command to check your external
+dependencies.
+
+  $ kitabu check
+
+  Prince XML: Converts HTML files into PDF files.
+  Installed.
+
+  KindleGen: Converts ePub e-books into .mobi files.
+  Installed.
+
+  html2text: Converts HTML documents into plain text.
+  Not installed.
+
+  pygments.rb: A generic syntax highlight. If installed, replaces CodeRay.
+  Not installed.
+
+There's no requirements here; just make sure you cleared the correct dependency based
+on the formats you want to export to.
+
 == Usage
 
 To create a new e-book, just run
@@ -25,20 +45,26 @@ To create a new e-book, just run
 
 This command creates a directory <tt>mybook</tt> with the following structure:
 
-  * mypdf
-    * code
-    * config
-      * kitabu.yml
-      * helper.rb
-    * images
-    * output
-    * Rakefile
-    * templates
-      * layout.css
-      * layout.html
-      * syntax.css
-      * user.css
-    * text
+  mybook
+  ├── code
+  ├── config
+  │   ├── helper.rb
+  │   └── kitabu.yml
+  ├── images
+  ├── output
+  ├── templates
+  │   ├── epub
+  │   │   ├── cover.erb
+  │   │   ├── cover.png
+  │   │   ├── page.erb
+  │   │   └── user.css
+  │   └── html
+  │       ├── layout.css
+  │       ├── layout.erb
+  │       ├── syntax.css
+  │       └── user.css
+  └── text
+      └── 01_Welcome.md
 
 The <tt>config/kitabu.yml</tt> file holds some information about your book; so you'll always change it.
 
@@ -76,7 +102,7 @@ To print the TOC, you need to print a variable called +toc+, using the eRb tag.
 
 === Syntax Highlighting
 
-We use Ultraviolet[http://rubygems.org/gems/ultraviolet] for syntax highlighting. To highlight a given code snippet, just do something like
+We use CodeRay[http://rubygems.org/gems/coderay] for syntax highlighting. To highlight a given code snippet, just do something like
 
   @@@ ruby
   class User < ActiveRecord::Base
@@ -85,7 +111,7 @@ We use Ultraviolet[http://rubygems.org/gems/ultraviolet] for syntax highlighting
   end
   @@@
 
-Run @kitabu syntaxes@ to list all available syntaxes.
+If can replace CodeRay by Pygments; just install the gem pygments.rb[http://rubygems.org/pygments.rb].
 
 <b>Don't indent</b> the source block or will end up with unexpected results.
 
@@ -121,18 +147,23 @@ By default, RDiscount[http://github.com/rtomayko/rdiscount/tree/master] is the M
 * Maruku: https://rubygems.org/gems/maruku
 * PEGMarkdown: https://rubygems.org/gems/rpeg-markdown
 * BlueCloth: https://rubygems.org/gems/bluecloth
+* Redcarpet: https://rubygems.org/gems/redcarpet
+
+Note: RDiscount will always be installed as Kitabu's dependency but only used when no
+alternative library is available.
 
 === References
 
-* Textile: http://hobix.com/textile/
+* Textile: http://hobix.com/textile
 * Markdown: http://daringfireball.net/projects/markdown/syntax
 
 == Samples
 
 I published two PDFs (portuguese only) exploring lots of features. Check it out:
 
-* http://howtocode.com.br/downloads/rdoc.pdf
-* http://howtocode.com.br/downloads/rails-application-templates.pdf
+* http://cl.ly/3j1s2g1O1b1c0S3M0n20
+* http://cl.ly/1L1o123L3Z0p3P0L1Q3t
+* http://cl.ly/0a2W3s3u2T2P1V0C0c3g
 
 There's also an (probably) outdated Rails Guide section in the <tt>examples</tt> directory.
 

data/kitabu.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   s.add_dependency "eeepub-with-cover-support", "~> 0.8"
   s.add_dependency "watchr",                    "~> 0.7"
   s.add_dependency "notifier",                  "~> 0.1"
-  s.add_dependency "pygments.rb",               "~> 0.2"
+  s.add_dependency "coderay"
 
   s.add_development_dependency "rspec"
   s.add_development_dependency "test_notifier"

data/lib/kitabu.rb

@@ -16,6 +16,14 @@ require "watchr"
 require "yaml"
 require "cgi"
 
+%w[pygments.rb coderay].each do |lib|
+  begin
+    require lib
+  rescue LoadError => e
+    next
+  end
+end
+
 %w[maruku peg_markdown bluecloth redcarpet rdiscount].each do |lib|
   begin
     require lib
@@ -28,8 +36,6 @@ end
 Encoding.default_internal = "utf-8"
 Encoding.default_external = "utf-8"
 
-require 'pygments.rb'
-
 module Kitabu
   require "kitabu/extensions/string"
   require "kitabu/extensions/redcloth"
@@ -39,12 +45,13 @@ module Kitabu
 
   autoload :Version,    "kitabu/version"
   autoload :Generator,  "kitabu/generator"
-  autoload :Toc,        "kitabu/toc"
+  autoload :TOC,        "kitabu/toc"
   autoload :Cli,        "kitabu/cli"
   autoload :Parser,     "kitabu/parser"
   autoload :Exporter,   "kitabu/exporter"
   autoload :Syntax,     "kitabu/syntax"
   autoload :Stream,     "kitabu/stream"
+  autoload :Dependency, "kitabu/dependency"
 
   def self.config(root_dir = nil)
     root_dir ||= Pathname.new(Dir.pwd)
@@ -57,6 +64,6 @@ module Kitabu
   end
 
   def self.logger
-    @logger ||= Logger.new(File.open("/tmp/kitabu.log", "a+"))
+    @logger ||= Logger.new(File.open("/tmp/kitabu.log", "a"))
   end
 end

data/lib/kitabu/cli.rb

@@ -46,13 +46,48 @@ module Kitabu
       say "Kitabu version #{Version::STRING}"
     end
 
+    desc "check", "Check if all external dependencies are installed"
+
+    def check
+      result = []
+
+      result << {
+        :description => "Prince XML: Converts HTML files into PDF files.",
+        :installed => Kitabu::Dependency.prince?
+      }
+
+      result << {
+        :description => "KindleGen: Converts ePub e-books into .mobi files.",
+        :installed => Kitabu::Dependency.kindlegen?
+      }
+
+      result << {
+        :description => "html2text: Converts HTML documents into plain text.",
+        :installed => Kitabu::Dependency.html2text?
+      }
+
+      result << {
+        :description => "pygments.rb: A generic syntax highlight. If installed, replaces CodeRay.",
+        :installed => Kitabu::Dependency.pygments_rb?
+      }
+
+      result.each do |result|
+        text = color(result[:name], :blue)
+        text << "\n" << result[:description]
+        text << "\n" << (result[:installed] ? color("Installed.", :green) : color("Not installed.", :red))
+        text << "\n"
+
+        say(text)
+      end
+    end
+
     desc "permalinks", "List title permalinks"
 
     def permalinks
-      html = Kitabu::Parser::Html.new(root_dir).content
-      toc = Kitabu::Toc.generate(html)
+      inside_ebook!
 
-      color_support = shell.instance_of?(Thor::Shell::Color)
+      html = Kitabu::Parser::HTML.new(root_dir).content
+      toc = Kitabu::TOC::HTML.generate(html)
 
       toc.toc.each do |options|
         level = options[:level] - 1
@@ -60,8 +95,8 @@ module Kitabu
         permalink = "##{options[:permalink]}"
 
         text = "*" * level
-        text << (color_support ? shell.set_color(title, :blue) : title)
-        text <<  (color_support ? shell.set_color(permalink, :yellow) : permalink)
+        text << color(title, :blue)
+        text << color(permalink, :yellow)
         say(text)
       end
     end
@@ -69,7 +104,7 @@ module Kitabu
     private
     def inside_ebook!
       unless File.exist?(config_path)
-        raise Error, "You can't export files when you're outside an e-book directory"
+        raise Error, "You have to run this command from inside an e-book directory."
       end
     end
 
@@ -84,5 +119,13 @@ module Kitabu
     def root_dir
       @root ||= Pathname.new(Dir.pwd)
     end
+
+    def color(text, color)
+      color? ? shell.set_color(text, color) : text
+    end
+
+    def color?
+      shell.instance_of?(Thor::Shell::Color)
+    end
   end
 end

data/lib/kitabu/dependency.rb

@@ -0,0 +1,19 @@
+module Kitabu
+  class Dependency
+    def self.kindlegen?
+      @kindlegen ||= `which kindlegen` && $?.success?
+    end
+
+    def self.prince?
+      @prince ||= `which prince` && $?.success?
+    end
+
+    def self.html2text?
+      @html2text ||= `which html2text` && $?.success?
+    end
+
+    def self.pygments_rb?
+      @pygments_rb ||= defined?(Pygments)
+    end
+  end
+end

data/lib/kitabu/exporter.rb

@@ -27,18 +27,17 @@ module Kitabu
       helper = root_dir.join("config/helper.rb")
       load(helper) if helper.exist?
 
-      export_html = [nil, "pdf", "txt", "html"].include?(options[:only])
       export_pdf = [nil, "pdf"].include?(options[:only])
       export_epub = [nil, "mobi", "epub"].include?(options[:only])
       export_mobi = [nil, "mobi"].include?(options[:only])
       export_txt = [nil, "txt"].include?(options[:only])
 
       exported = []
-      exported << Parser::Html.parse(root_dir) if export_html
-      exported << Parser::Pdf.parse(root_dir) if export_pdf
+      exported << Parser::HTML.parse(root_dir)
+      exported << Parser::PDF.parse(root_dir) if export_pdf && Dependency.prince?
       exported << Parser::Epub.parse(root_dir) if export_epub
-      exported << Parser::Mobi.parse(root_dir) if export_mobi
-      exported << Parser::Txt.parse(root_dir) if export_txt
+      exported << Parser::Mobi.parse(root_dir) if export_mobi && Dependency.kindlegen?
+      exported << Parser::Txt.parse(root_dir) if export_txt && Dependency.html2text?
 
       if exported.all?
         color = :green

data/lib/kitabu/generator.rb

@@ -14,23 +14,22 @@ module Kitabu
       File.dirname(__FILE__) + "/../../templates"
     end
 
-    def copy_template_files
+    def copy_html_templates
       copy_file "layout.erb"  , "templates/html/layout.erb"
       copy_file "layout.css"  , "templates/html/layout.css"
       copy_file "user.css"    , "templates/html/user.css"
+      copy_file "syntax.css"  , "templates/html/syntax.css"
+    end
+
+    def copy_epub_templates
       copy_file "cover.erb"   , "templates/epub/cover.erb"
-      copy_file "epub.css"    , "templates/epub/style.css"
+      copy_file "epub.css"    , "templates/epub/user.css"
       copy_file "epub.erb"    , "templates/epub/page.erb"
-      
-      create_file "templates/html/syntax.css" do
-        String.new.tap do |s|
-          Dir[File.dirname(__FILE__) + "/../../templates/styles/*.css"].each do |file|
-            s << "/*== #{File.basename(file)} ==*/\n"
-            s << File.read(file)
-            s << "\n\n"
-          end
-        end
-      end
+      copy_file "cover.png"   , "templates/epub/cover.png"
+    end
+
+    def copy_sample_page
+      copy_file "sample.md"   , "text/01_Welcome.md"
     end
 
     def copy_config_file
@@ -47,18 +46,16 @@ module Kitabu
     def create_directories
       empty_directory "output"
       empty_directory "images"
-      empty_directory "text"
       empty_directory "code"
     end
 
     def create_git_files
       create_file ".gitignore" do
-        "output/*.{html,epub,pdf}\n"
+        "output/*.{html,epub,pdf}\noutput/tmp"
       end
 
       create_file "output/.gitkeep"
       create_file "images/.gitkeep"
-      create_file "text/.gitkeep"
       create_file "code/.gitkeep"
     end
 

data/lib/kitabu/parser.rb

@@ -1,7 +1,9 @@
+require 'open3'
+
 module Kitabu
   module Parser
-    autoload :Html  , "kitabu/parser/html"
-    autoload :Pdf   , "kitabu/parser/pdf"
+    autoload :HTML  , "kitabu/parser/html"
+    autoload :PDF   , "kitabu/parser/pdf"
     autoload :Epub  , "kitabu/parser/epub"
     autoload :Mobi  , "kitabu/parser/mobi"
     autoload :Txt   , "kitabu/parser/txt"
@@ -29,6 +31,29 @@ module Kitabu
       def name
         File.basename(root_dir)
       end
+
+      # Return the configuration file.
+      #
+      def config
+        Kitabu.config(root_dir)
+      end
+
+      # Render a eRb template using +locals+ as data seed.
+      #
+      def render_template(file, locals = {})
+        ERB.new(File.read(file)).result OpenStruct.new(locals).instance_eval{ binding }
+      end
+
+      def spawn_command(cmd)
+        begin
+          stdout_and_stderr, status = Open3.capture2e(*cmd)
+        rescue Errno::ENOENT => e
+          puts e.message
+        else
+          puts stdout_and_stderr unless status.success?
+          status.success?
+        end
+      end
     end
   end
 end