kitabu 0.4.7 → 1.0.0.rc1

data/lib/kitabu.rb

@@ -1,54 +1,62 @@
-# encoding: utf-8
-require "yaml"
+require "active_support/all"
+require "digest/md5"
+require "eeepub"
 require "erb"
+require "logger"
+require "nokogiri"
+require "notifier"
+require "open3"
+require "optparse"
 require "ostruct"
-require "rexml/streamlistener"
-require "rexml/document"
-
-begin
-  require "active_support/all"
-rescue LoadError
-  require "active_support"
-end
-
-$:.unshift File.dirname(__FILE__)
-
-require "kitabu/base"
-require "kitabu/toc"
-require "kitabu/syntax"
-require "kitabu/templates"
-
-vendor = File.dirname(__FILE__) + "/kitabu/vendor/"
-
-dir = RUBY_VERSION =~ /^1.9/ ? "ruby1.9" : "ruby1.8"
-
-$:.unshift File.join(vendor, dir, "plist")
-$:.unshift File.join(vendor, dir, "textpow")
-$:.unshift File.join(vendor, dir, "uv")
-$:.unshift File.join(vendor, "colorize")
-
-begin
-  require "nokogiri"
-rescue LoadError
-  nil
+require "RedCloth"
+require "tempfile"
+require "thor"
+require "thor/group"
+require "watchr"
+require "yaml"
+require "cgi"
+
+%w[maruku peg_markdown bluecloth redcarpet rdiscount].each do |lib|
+  begin
+    require lib
+    break
+  rescue LoadError => e
+    next
+  end
 end
 
-begin
-  require "hpricot"
-rescue LoadError
-  nil
-end unless defined?(Nokogiri)
-
-require "colorize"
+Encoding.default_internal = "utf-8"
+Encoding.default_external = "utf-8"
 
-begin
-  require "plist"
-  require "textpow"
-  require "uv"
-rescue LoadError => e
-  NO_SYNTAX_HIGHLIGHT = true
-end
+require 'pygments.rb'
 
 module Kitabu
-  VERSION = "0.4.7"
+  require "kitabu/extensions/string"
+  require "kitabu/extensions/redcloth"
+  require "kitabu/errors"
+
+  ROOT = Pathname.new(File.dirname(__FILE__) + "/..")
+
+  autoload :Version,    "kitabu/version"
+  autoload :Generator,  "kitabu/generator"
+  autoload :Toc,        "kitabu/toc"
+  autoload :Cli,        "kitabu/cli"
+  autoload :Parser,     "kitabu/parser"
+  autoload :Exporter,   "kitabu/exporter"
+  autoload :Syntax,     "kitabu/syntax"
+  autoload :Stream,     "kitabu/stream"
+
+  def self.config(root_dir = nil)
+    root_dir ||= Pathname.new(Dir.pwd)
+    path = root_dir.join("config/kitabu.yml")
+
+    raise "Invalid Kitabu directory; couldn't found config/kitabu.yml file." unless File.file?(path)
+    content = File.read(path)
+    erb = ERB.new(content).result
+    YAML.load(erb).with_indifferent_access
+  end
+
+  def self.logger
+    @logger ||= Logger.new(File.open("/tmp/kitabu.log", "a+"))
+  end
 end

data/lib/kitabu/cli.rb

@@ -0,0 +1,88 @@
+# -*- encoding: utf-8 -*-
+module Kitabu
+  class Cli < Thor
+    FORMATS = %w[pdf html epub mobi txt]
+    check_unknown_options!
+
+    def self.exit_on_failure?
+      true
+    end
+
+    def initialize(args = [], options = {}, config = {})
+      if config[:current_task].name == "new" && args.empty?
+        raise Error, "The e-Book path is required. For details run: kitabu help new"
+      end
+
+      super
+    end
+
+    desc "new EBOOK_PATH", "Generate a new e-book structure"
+
+    def new(path)
+      generator = Generator.new
+      generator.destination_root = path
+      generator.invoke_all
+    end
+
+    desc "export [OPTIONS]", "Export e-book"
+    method_option :only, :type => :string, :desc => "Can be one of: #{FORMATS.join(", ")}"
+    method_option :auto, :type => :boolean, :desc => "Watch changes and automatically export files"
+    method_option :open, :type => :boolean, :desc => "Automatically open PDF (Mac OS X only)"
+
+    def export
+      if options[:only] && !FORMATS.include?(options[:only])
+        raise Error, "The --only option need to be one of: #{FORMATS.join(", ")}"
+      end
+
+      inside_ebook!
+
+      Kitabu::Exporter.run(root_dir, options)
+    end
+
+    desc "version", "Prints the Kitabu's version information"
+    map %w(-v --version) => :version
+
+    def version
+      say "Kitabu version #{Version::STRING}"
+    end
+
+    desc "permalinks", "List title permalinks"
+
+    def permalinks
+      html = Kitabu::Parser::Html.new(root_dir).content
+      toc = Kitabu::Toc.generate(html)
+
+      color_support = shell.instance_of?(Thor::Shell::Color)
+
+      toc.toc.each do |options|
+        level = options[:level] - 1
+        title = " #{options[:text]}: "
+        permalink = "##{options[:permalink]}"
+
+        text = "*" * level
+        text << (color_support ? shell.set_color(title, :blue) : title)
+        text <<  (color_support ? shell.set_color(permalink, :yellow) : permalink)
+        say(text)
+      end
+    end
+
+    private
+    def inside_ebook!
+      unless File.exist?(config_path)
+        raise Error, "You can't export files when you're outside an e-book directory"
+      end
+    end
+
+    def config
+      YAML.load_file(config_path).with_indifferent_access
+    end
+
+    def config_path
+      root_dir.join("config/kitabu.yml")
+    end
+
+    def root_dir
+      @root ||= Pathname.new(Dir.pwd)
+    end
+  end
+end

data/lib/kitabu/errors.rb

@@ -0,0 +1,3 @@
+module Kitabu
+  class DirectoryAlreadyCreatedError < StandardError; end
+end

data/lib/kitabu/exporter.rb

@@ -0,0 +1,81 @@
+module Kitabu
+  class Exporter
+    def self.run(root_dir, options)
+      exporter = new(root_dir, options)
+
+      if options[:auto]
+        exporter.export!
+        exporter.auto! if options[:auto]
+      else
+        exporter.export!
+      end
+    end
+
+    attr_accessor :root_dir
+    attr_accessor :options
+
+    def initialize(root_dir, options)
+      @root_dir = root_dir
+      @options = options
+    end
+
+    def ui
+      @ui ||= Thor::Base.shell.new
+    end
+
+    def export!
+      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::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
+
+      if exported.all?
+        color = :green
+        message = options[:auto] ? "exported!" : "** e-book has been exported"
+
+        if options[:open] && export_pdf && RUBY_PLATFORM =~ /darwin/
+          filepath = root_dir.join("output/#{File.basename(root_dir)}.pdf")
+          IO.popen("open -a Preview.app '#{filepath}'").close
+        end
+
+        Notifier.notify(
+          :image   => Kitabu::ROOT.join("templates/ebook.png"),
+          :title   => "Kitabu",
+          :message => "Your \"#{config[:title]}\" e-book has been exported!"
+        )
+      else
+        color = :red
+        message = options[:auto] ? "could not be exported!" : "** e-book couldn't be exported"
+      end
+
+      ui.say message, color
+    end
+
+    def config
+      Kitabu.config(root_dir)
+    end
+
+    def auto!
+      script = Watchr::Script.new
+
+      script.watch(%r[(code|config|images|templates|text)/.*]) do |match|
+        ui.say "* #{match[0]}... ", :yellow, false
+        export!
+      end
+
+      contrl = Watchr::Controller.new(script, Watchr.handler.new)
+      contrl.run
+    end
+  end
+end

data/lib/kitabu/extensions/redcloth.rb

@@ -0,0 +1,65 @@
+module RedCloth
+  INLINE_FORMATTERS = [:textile, :footnote, :link]
+
+  def self.convert(text)
+    new(text).to_html(*INLINE_FORMATTERS)
+  end
+
+  module Inline
+    FN_RE = /
+      (\s+)?    # getting spaces
+      %\{       # opening
+      (.*?)     # footnote
+      \}#       # closing
+    /xm
+
+    def footnote(text)
+      text.gsub!(FN_RE) do |m|
+        %(<span class="footnote">#{$2}</span>)
+      end
+    end
+
+    LINK_RE = /
+      <
+      ((?:https?|ftp):\/\/.*?)
+      >
+    /xm
+
+    def link(text)
+      text.gsub!(LINK_RE) do |m|
+        %(<a href="#{$1}">#{$1}</a>)
+      end
+    end
+  end
+
+  module Formatters
+    module HTML
+      def figure(options = {})
+        %[<p class="figure"><img src="../images/#{options[:text]}" alt="#{options[:class]}" /><br/><span class="caption">#{options[:class]}</span></p>]
+      end
+
+      def note(options = {})
+        %[<p class="note">#{options[:text]}</p>]
+      end
+
+      def attention(options = {})
+        %[<p class="attention">#{options[:text]}</p>]
+      end
+
+      def file(options = {})
+        base_url = Kitabu.config[:base_url]
+
+        if base_url
+          url = File.join(base_url, options[:text])
+        else
+          url = content
+          $stderr << "\nYou're using `file. #{content}` but didn't set base_url in your configuration file.\n"
+        end
+
+        %[<p class="file"><span><strong>Download</strong> <a href="#{url}">#{options[:text]}</a></span></p>]
+      end
+    end
+  end
+end
+
+RedCloth.send(:include, RedCloth::Inline)

data/lib/kitabu/extensions/string.rb

@@ -0,0 +1,11 @@
+class String
+  def to_permalink
+    str = ActiveSupport::Multibyte::Chars.new(self.dup)
+    str = str.normalize(:kd).gsub(/[^\x00-\x7F]/,'').to_s
+    str.gsub!(/[^-\w\d]+/xim, "-")
+    str.gsub!(/-+/xm, "-")
+    str.gsub!(/^-?(.*?)-?$/, '\1')
+    str.downcase!
+    str
+  end
+end

data/lib/kitabu/generator.rb

@@ -0,0 +1,74 @@
+module Kitabu
+  # The Kitabu::Generator class will create a new book structure.
+  #
+  #   ebook = Kitabu::Generator.new
+  #   ebook.destination_root = "/some/path/book-name"
+  #   ebook.invoke_all
+  #
+  class Generator < Thor::Group
+    include Thor::Actions
+
+    desc "Generate a new e-Book structure"
+
+    def self.source_root
+      File.dirname(__FILE__) + "/../../templates"
+    end
+
+    def copy_template_files
+      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 "cover.erb"   , "templates/epub/cover.erb"
+      copy_file "epub.css"    , "templates/epub/style.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
+    end
+
+    def copy_config_file
+      @name = full_name
+      @uid = Digest::MD5.hexdigest("#{Time.now}--#{rand}")
+      @year = Date.today.year
+      template "config.erb", "config/kitabu.yml"
+    end
+
+    def copy_helper_file
+      copy_file "helper.rb", "config/helper.rb"
+    end
+
+    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"
+      end
+
+      create_file "output/.gitkeep"
+      create_file "images/.gitkeep"
+      create_file "text/.gitkeep"
+      create_file "code/.gitkeep"
+    end
+
+    private
+    # Retrieve user's name using finger.
+    # Defaults to <tt>John Doe</tt>.
+    #
+    def full_name
+      name = `finger $USER 2> /dev/null | grep Login | colrm 1 46`.chomp
+      name.present? ? name.squish : "John Doe"
+    end
+  end
+end

data/lib/kitabu/parser.rb

@@ -0,0 +1,34 @@
+module Kitabu
+  module Parser
+    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"
+
+    class Base
+      # The e-book directory.
+      #
+      attr_accessor :root_dir
+
+      # Where the text files are stored.
+      #
+      attr_accessor :source
+
+      def self.parse(root_dir)
+        new(root_dir).parse
+      end
+
+      def initialize(root_dir)
+        @root_dir = Pathname.new(root_dir)
+        @source = root_dir.join("text")
+      end
+
+      # Return directory's basename.
+      #
+      def name
+        File.basename(root_dir)
+      end
+    end
+  end
+end