booky 0.0.4 → 0.0.6

data/README.textile

@@ -1,22 +1,49 @@
-With this converter you can write documents or a whole book with textile and convert it to a PDF.
+h1. Booky
 
-It's main focus is to be some kind of LaTeX replacement being simpler to use and more beautiful.
+Booky is a real alternative to latex when it comes to document creation. It uses an enhanced version of textile to create the content
+and converts it to a PDF using pure-ruby with the help of the rubygem @prawn@.
 
-h2. Install
+It features:
 
-Simply do @gem install booky@
+* Chapters and Sections
+* Inclusion of Images
+* Footnotes
+* Import of Spreadsheets
+* Requiring of other Files
+* Automatic Table of Content
+* Lists
+* Customized Layouting
+* Inclusion of Highlighted Source Code
+
+Demos:
+
+* "Chapters and Sections":https://github.com/southdesign/booky/tree/master/pdfs/title_subtitle.pdf
+* "Tables":https://github.com/southdesign/booky/tree/master/pdfs/tables.pdf
+* "Lists":https://github.com/southdesign/booky/tree/master/pdfs/lists.pdf
+* "Links and Images":https://github.com/southdesign/booky/tree/master/pdfs/link_image.pdf
+* "Footnotes":https://github.com/southdesign/booky/tree/master/pdfs/footnotes.pdf
+* "Blockquote and Source":https://github.com/southdesign/booky/tree/master/pdfs/blockquote_source.pdf
+
+h2. Install 
+
+bc.. gem install booky
 
 h2. Usage
 
-Create a plain textfile with some textile content in in and name it e.g. @sample.textile@. Then simply
-run it through booky like this:
+Create a plain textile file, e.g. @sample.textile@ and run:
 
 bc.. booky create sample
 
+p. To see all features and the markup in action simply check out the "Examples":https://github.com/southdesign/booky/tree/master/lib/examples directory.
+
 h2. Help
 
-Simply run @booky help@ to get further information.
+bc.. booky help
+
+p. to get further information.
 
 h2. Examples
 
-Simply run @booky examples@ to see formatting examples of images, tables, lists, bibliography, etc.
+bc.. booky examples
+
+p. to see formatting examples of images, tables, lists, bibliography, etc.

data/booky.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email       = ["tommylefunk@googlemail.com"]
   s.homepage    = "http://www.southdesign.de"
   s.summary     = %q{Create a pdf book from a textile}
-  s.description = %q{Create a full blown book pdf from a textile file using docbook and xsl fo in the background}
+  s.description = %q{Create a full blown book pdf from a textile file using prawn}
 
   s.rubyforge_project = "booky"
 
@@ -20,5 +20,10 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   
   s.add_dependency "RedCloth", "~> 4.2.8"
-  s.add_dependency "redcloth-formatters-docbook", "~> 0.0.3"
+  s.add_dependency "redcloth-formatters-ast", "~> 0.0.3"
+  s.add_dependency "colorize", "~> 0.5.8"
+  s.add_dependency "prawn", "~> 1.0.0.rc1"
+  s.add_dependency "coderay", "~> 1.0.6"
+  s.add_dependency "spreadsheet", "~> 0.7.2"
+  s.add_dependency "json", "~> 1.7.3"
 end

data/lib/booky.rb

@@ -1,18 +1,23 @@
 require 'rubygems'
 require 'RedCloth'
-require 'redcloth-formatters-docbook'
+require 'redcloth-formatters-ast'
+require 'prawn'
+require "prawn/measurement_extensions"
+require 'colorize'
+require 'coderay'
+require 'spreadsheet'
+require 'ostruct'
+require 'json'
 
 module Booky
   require 'booky/version'
   require 'booky/exceptions'
-  require 'booky/fonts'
+  require 'booky/ast'
+  require 'booky/layout'
   require 'booky/textile'
-  require 'booky/docbook'
-  require 'booky/fo'
   require 'booky/pdf'
   
-  @@source = nil
-  @@name = nil
+  @@source, @@name, @@layout = nil, nil, nil
   
   # initial dispatch
   def self.dispatch argv
@@ -22,7 +27,7 @@ module Booky
     return    if argv.empty?
         
     # dispatch
-    self.setup(argv[1])
+    self.setup(argv)
     self.send(argv[0].to_sym)
     
   end
@@ -32,18 +37,16 @@ module Booky
     
     # setup
     puts "\nStarting Booky...\n"
-    Booky::Fonts.configure
     
     # create
-    Booky::Docbook.create
-    Booky::Fo.create
-    Booky::Pdf.create
+    ast = Booky::AST.create
+    Booky::PDF.create(ast)
     
     # open
-    Booky::Pdf.open
+    Booky::PDF.open
     
     # clear
-    Booky.clear
+    #Booky.clear
   end
   
   # help
@@ -56,11 +59,10 @@ module Booky
           booky create BOOK_TEXTILE       Creates a pdf out of a textile file and opens it
           booky version                   Shows the current Booky version
           booky help                      Shows this help
-          booky clear BOOK_TEXTILE        Removes the docbook xml and the fo byproducts
           
       Paths:
           Custom Fonts                    Add them to the #{Booky.root}/lib/fonts folder
-          Layout Tweaking                 Modify #{Booky.root}/lib/stylesheets/fo/param.xsl
+          Layout Tweaking                 Add them to the #{Booky.root}/lib/booky/layouts folder
           
       Examples:
           booky examples                  Shows a list of all commands that can be used inside textile documents
@@ -99,22 +101,15 @@ module Booky
     puts "\n\n"
   end  
   
-  # clear byproducts
-  def self.clear
-    if @@name.nil?
-      puts "-> Please privde a name to clear!"
-      return
-    end
-    
-    File.delete "#{@@name}.xml" rescue (puts "-> XML already cleared.")
-    File.delete "#{@@name}.fo"  rescue (puts "-> FO already cleared.")
-  end
-  
   # book name
   def self.name
     @@name
   end
   
+  def self.name=(value)
+    @@name = value
+  end
+  
   # book source
   def self.source
     @@source
@@ -123,22 +118,31 @@ module Booky
   def self.source=(value)
     @@source = value
   end
+
+  # book layout
+  def self.layout
+    @@layout
+  end
+  
+  def self.layout=(value)
+    @@layout = value
+  end
   
   def self.root
     "#{__FILE__}".gsub("/lib/booky.rb", "")
   end
   
   private
-  def self.setup name
-    return if name.nil?
-    @@source = name
-    @@name = name
-    @@name = @@name.gsub(".textile", "")
-    @@name = @@name.gsub(".txt", "")
-    @@name = @@name.gsub(".text", "")
-    @@name = @@name.gsub(".xml", "")
-    @@name = @@name.gsub(".fo", "")
-    @@name = @@name.gsub(".pdf", "")
+  def self.setup argv
+    return if argv[1].nil?
+
+    @@source  = argv[1]
+    @@name    = argv[1]
+    @@layout  = argv[2]
+    @@name    = @@name.gsub(".textile", "")
+    @@name    = @@name.gsub(".txt", "")
+    @@name    = @@name.gsub(".text", "")
+    @@name    = @@name.gsub(".pdf", "")
   end
   
 end

data/lib/booky/ast.rb

@@ -0,0 +1,10 @@
+module Booky::AST
+  
+  def self.create
+    raise "File #{Booky.source} not found. Sorry".red if !File.exists?("#{Booky.source}")
+    
+    textile = Booky::Textile.precompile
+    RedCloth.new(textile).to_ast
+  end
+  
+end

data/lib/booky/exceptions.rb

@@ -2,7 +2,7 @@ module Booky
   class LoadError < StandardError # :nodoc:
     def to_s
       %Q(
-      Sorry, couldn't load #{message}.
+      Sorry, couldn't load #{@message}.
       You always need to specify the file with respect to your main textile file, did you?
       )
     end

data/lib/booky/layout.rb

@@ -0,0 +1,103 @@
+module Booky::Layout
+  require 'booky/layout/helpers'
+  require 'booky/layout/element'
+  require 'booky/layout/base'
+  
+  @@config = nil
+  
+  # Performs a double rendering and creates the final pdf. The first rendering is for the
+  # actual definition of the content and page references. The second then actually renders the pdf
+  def self.compile(ast, layout = Booky::Layout::Base)
+    
+    # 1. Render: Creates TOC Contents
+    config.runs = 1
+    layout.document { |document| create_elements(ast, layout, document) }
+    reset_config_after_first_render
+    
+    # 2. Render Creates Document
+    config.runs = 2
+    pdf = layout.document do |document|
+      create_elements(ast, layout, document)
+      create_page_links(document)
+      create_outline(layout, document)
+      create_page_numbering(layout, document)
+    end
+    pdf.render_file "#{Booky.name}.pdf"
+    
+  end
+  
+  # Traverses the AST tree and tries to create a class of every entry type:
+  #
+  #     {:type => :h1, ... }
+  #     -> H1.new({:type => :h1, ... }, ...)
+  #
+  # The object then executes its normal prawn methods in the to_prawn method
+  def self.create_elements(ast, layout, document)
+    ast.each_with_index do |option, index|
+       log_element(option)
+       klass = layout.const_get to_constant(option)
+       klass.new(option, document, layout, ast, index).to_prawn
+     end
+  end
+  
+  LOG_ELEMENTS = :h0, :h1, :h2
+  def self.log_element(option)
+    return unless config.runs == 2
+    return unless LOG_ELEMENTS.include?(option[:type])
+    puts "    Creating #{option[:text]}".green
+  end
+  
+  # Traverses through every page and adds an link anchor named 'page0', 'page1', ...
+  def self.create_page_links(document)
+    (1..document.page_count).each { |page| document.add_dest("page#{page}", document.dest_fit(document.state.pages[page-1])) }
+  end
+  
+  # Creates the PDF outline
+  def self.create_outline(layout, document)
+    klass = layout.const_get "Outline"
+    begin
+      klass.new(nil, document, layout).to_prawn
+    rescue Exception => e
+      puts "Couldn't create outline due to the following error:".red
+      puts e
+    end
+  end
+  
+  def self.create_page_numbering(layout, document)
+    layout.numbering_options(document)
+  end
+  
+  # Creates a global layout config that holds the state during processing
+  def self.config
+    @@config ||= OpenStruct.new(
+      :runs             => 0,
+      :last_level       => 0,
+      :current_chapter  => 0,
+      :levels           => { 0 => 0, 1 => 0, 2 => 0, 3 => 0, 4 => 0 },
+      :toc              => [],
+      :toc_offset       => 1,
+      :tof              => [],
+      :no_content_pages => [],
+      :chapter_info     => []
+    )
+  end
+  
+  # Resets the config
+  def self.reset_config!
+    @@config = nil
+  end
+  
+  # Resets the config state after the 1. Rendering
+  def self.reset_config_after_first_render
+    config.current_chapter    = 0
+    config.tof                = []
+    config.no_content_pages   = []
+    config.chapter_info       = []
+  end
+  
+  def self.to_constant(option)
+    "#{option[:type].to_s.split('_').map{|t| t.capitalize }.join}"
+  end
+  
+end
+

data/lib/booky/layout/base.rb

@@ -0,0 +1,70 @@
+module Booky
+  module Layout
+    module Base
+      COLORS = ['000000', '646464', 'B6B6B6', 'ECECEC']
+      
+      require 'booky/layout/base/title'
+      require 'booky/layout/base/subtitle'
+      require 'booky/layout/base/author'
+      require 'booky/layout/base/copyright'
+      require 'booky/layout/base/h0'
+      require 'booky/layout/base/h1'
+      require 'booky/layout/base/h2'
+      require 'booky/layout/base/h3'
+      require 'booky/layout/base/h4'
+      require 'booky/layout/base/p'
+      require 'booky/layout/base/toc'
+      require 'booky/layout/base/tof'
+      require 'booky/layout/base/outline'
+      require 'booky/layout/base/table'
+      require 'booky/layout/base/unnumbered_list'
+      require 'booky/layout/base/numbered_list'
+      require 'booky/layout/base/image'
+      require 'booky/layout/base/footnote'
+      require 'booky/layout/base/blockquote'
+      require 'booky/layout/base/code'
+      require 'booky/layout/base/chart'
+      require 'booky/layout/base/import'
+
+      def self.document options = {}
+        options.merge!({
+          :page_size => "A4",
+          :margin => [3.cm, 3.cm, 3.cm, 3.cm,]
+        })
+        
+        
+        Prawn::Document.new options do |document|
+          document.font_families.update(
+          "Ubuntu" => {
+            :normal       => "#{Booky.root}/lib/fonts/Ubuntu-R.ttf",
+            :bold         => "#{Booky.root}/lib/fonts/Ubuntu-B.ttf",
+            :italic       => "#{Booky.root}/lib/fonts/Ubuntu-L.ttf",
+            :italic_light => "#{Booky.root}/lib/fonts/Ubuntu-LI.ttf"
+          },
+          "Monaco" => {
+            :normal => "#{Booky.root}/lib/fonts/Monaco.ttf"
+          })
+          
+          document.font "Ubuntu"
+          document.font_size 12
+          document.default_leading 3
+          
+          yield(document)
+        end
+      end
+      
+      def self.numbering_options document
+        document.number_pages "<page> of <total>", {
+          :start_count_at   => Booky::Layout.config.has_cover ? 2 : 1,
+          :page_filter      => lambda{ |pg| Booky::Layout.config.has_cover ? (pg != 1) : true },
+          :at               => [document.bounds.left, -3.cm],
+          :align            => :center,
+          :size             => 10,
+          :style            => :italic,
+          :color            => COLORS[2]
+        }
+      end
+      
+    end
+  end
+end

data/lib/booky/layout/base/author.rb

@@ -0,0 +1,15 @@
+module Booky::Layout::Base
+  class Author < Booky::Layout::Element
+    
+    OPTIONS = {
+      :align => :center,
+      :size => 12
+    }
+    
+    def to_prawn
+      text @options[:text], OPTIONS
+      move_down 0.2.cm
+    end
+    
+  end
+end

data/lib/booky/layout/base/blockquote.rb

@@ -0,0 +1,58 @@
+module Booky::Layout::Base
+  class Blockquote < Booky::Layout::Element
+    include Booky::Layout::Helpers
+    
+    OPTIONS = {
+      :align => :justify,
+      :size => 14,
+      :style => :italic_light,
+      :inline_format => true
+    }
+    
+    def start_new_page_if_needed
+      start_new_page if cursor < (bounds.bottom + 4.cm)
+    end
+    
+    def to_prawn
+      start_new_page_if_needed
+      
+      citation = "(#{@options[:author]}"
+      citation << " #{@options[:year]}"   if @options[:year]
+      citation << ", #{@options[:pages]}" if @options[:pages]
+      citation << ")"
+      citation = "" unless @options[:author]
+      
+      data = []
+      data << [make_cell(
+        :content        => citation,
+        :size           => 10, 
+        :font_style     => :normal,
+        :align          => :right,
+        :border_width   => 1, 
+        :borders        => [:bottom]
+      )]
+      data << [make_cell(
+        :content        => @options[:text].chop,
+        :size           => 12, 
+        :font_style     => :italic, 
+        :border_width   => 1, 
+        :borders        => [:bottom]
+      )]
+      
+      
+      table(data,
+        :header => false,
+        :width => bounds.width - 2.cm,
+        :position => :center,
+        :row_colors => ['FFFFFF', Booky::Layout::Base::COLORS[3]],
+        :cell_style => { 
+          :inline_format => true, 
+          :border_color => Booky::Layout::Base::COLORS[2], 
+          :border_width => 0.5
+        }
+      )
+      move_down 1.cm
+    end
+    
+  end
+end