codex 1.0.2 → 1.1.0

data/lib/codex/filters/graphviz_filter.rb

@@ -0,0 +1,112 @@
+# Graphviz filter
+
+require 'digest/md5'
+require 'facets/fileutils/which.rb'
+
+module Codex::GraphvizFilter
+  OUTPUT_DIR="html/images/"
+  LINK_DIR="images/"
+  
+  class Descriptor
+    attr_reader :engine, :width, :height, :file_name, :file_type
+    
+    include FileUtils
+    
+    raise "Graphviz ('dot') is not installed." unless which('dot')
+
+    def initialize(string)
+      @engine = "dot"
+      @file_type = "svg"
+      @width = nil
+      @height = nil
+      @file_name = nil
+
+      if string && string =~ /^\[(.*)\]/
+        @file_name = nil
+        parse_params($1.dup)
+      elsif string && string =~ /(.*?)\[(.*)\]/
+        @file_name = $1
+        parse_params($2.dup)
+      else
+        @file_name = string
+      end
+    end
+
+    def parse_params(params)
+      params.split.each do |param|
+        if param =~ /(.*?)=(.*)/
+          case $1
+          when "engine"
+            @engine = $2
+            fail "Unknown engine value. Choices are: dot,neato,twopi and circo." unless @engine =~ /dot|neato|twopi|circo/
+          when "width"
+            @width = $2
+          when "height"
+            @height = $2
+          when "type"
+            @file_type = $2
+            fail "Unknown output format. Choices are: png,jpeg and svg" unless @file_type =~ /png|jpeg|svg/
+          when "options" # Additional options for graphviz
+            @extra_options = $2
+          else
+            fail "Unknown parameter #{$1} in '#{params}'"
+          end
+        end
+      end
+    end
+    
+    def graphviz_cmd(outputfile)
+      exec = which(@engine)
+      file = (@file_name.nil? or @file_name.empty?)?"":File.expand_path(@file_name)
+      "#{exec} #{file} -T#{@file_type} -o#{outputfile} #{@extra_options}"
+    end
+  end
+
+  class GraphViz < Codex::Filter
+    tag :graphviz
+    
+    def filter_inline(text,args)
+      d = Descriptor.new(args)
+      output_file = "graphviz-" + Digest::MD5.hexdigest(text) + "." + d.file_type
+      IO.popen(d.graphviz_cmd(OUTPUT_DIR + output_file),"w") do |pipe|
+        pipe.write text
+        pipe.close_write
+      end
+      to_html(d,output_file)
+    end
+
+    def filter_single(args)
+      d = Descriptor.new(args)
+      output_file = File.basename(d.file_name) + "." + d.file_type
+      system d.graphviz_cmd(OUTPUT_DIR + output_file)
+      to_html(d,output_file)
+    end
+    
+    def to_html(d,output_file)
+      if d.file_type == "svg"
+        %{<object type="image/svg+xml" name="graphviz" data="#{LINK_DIR + output_file}" #{width_html(d)} #{height_html(d)}">\n} +
+        %{If you a seeing this text, your browser probably doesn't support SVG. Try setting the filetype=png option instead.} +
+        %{</object>}
+      else
+        %{<img type="image/#{d.file_type}" name="#{d.file_name}" src="#{output_file}" #{width_html(d)} #{height_html(d)}">\n} +
+        %{</img>}
+      end
+    end
+    
+    def width_html(desc)
+      if desc.width.nil?
+        ""
+      else
+        %{width="#{desc.width}"}
+      end
+    end
+    
+    def height_html(desc)
+      if desc.height.nil?
+        ""
+      else
+        %{width="#{desc.height}"}
+      end
+    end
+  end
+end

data/lib/codex/filters/ritex_filter.rb

@@ -0,0 +1,16 @@
+require 'ritex'
+
+class RitexFilter < Codex::Filter
+  tag :webtex
+  
+  # Expect something like
+  # :webtex \alpha\beta\gamma
+  def filter_single(text,args)
+    Ritex::Parser.new.parse(args)
+  end
+
+  # parse everythingenclosed in :inlinewebtex .. :end
+  def filter_inline(text,args)
+    Ritex::Parser.new.parse(text)
+  end
+end

data/lib/codex/post_processor.rb

@@ -0,0 +1,55 @@
+module Codex
+  class PostProcessor
+    # Call this in your subclass to register the PostProcessor
+    def self.register
+      PostProcessors.instance << self
+    end 
+    attr_reader :html
+    def initialize(html)
+      @html = html
+    end
+    def process
+      raise "Overwrite me!"
+    end
+  end
+  class PostProcessors
+    include Singleton
+    def << (post_processor_class)
+      @post_processors << post_processor_class
+    end
+    def delete(post_processor_class)
+      @post_processors.delete(post_processor_class)
+    end
+    def process_all(html)
+      @new_html = html
+      @post_processors.each do |pp_class|
+        processor = pp_class.new(@new_html)
+        processor.process
+        @new_html = processor.html
+      end
+      @new_html
+    end
+    
+    private
+    
+    def initialize
+      @post_processors = []
+    end
+    
+  end
+  
+end
+
+# Requires all Post Processores files inside the lib and the slides directory.
+# Ignores errors so that processors that depend on external libs and gems
+# that are not present won't break the app.
+Dir.glob([
+    File.join(File.dirname(__FILE__), 'post_processors/*.rb'), 
+    File.join(APP_ROOT, 'post_processors/*.rb')
+    ]) do |post_processor|
+  begin
+    require(post_processor)
+  rescue Exception => e
+    ;
+  end
+end

data/lib/codex/post_processors/01_slides_processor.rb

@@ -0,0 +1,8 @@
+# This will divide the html in slides, surrounding <hN> tags
+# plus the following text in @<div class="slide">(...)</div>@.
+class Codex::SlidesProcessor < Codex::PostProcessor
+  register
+  def process
+    @html = @html.gsub(/(<h{1,6}.*?)(?=<h{1,6}|\z)/m, "\n<div class=\"slide\">\\1</div>")
+  end
+end

data/lib/codex/post_processors/02_add_title_slides.rb

@@ -0,0 +1,11 @@
+# This allows you to create title slides in the middle of presentations,
+# using:
+#   h1(slide0). Slide that only has a title
+# This is used by the @rake all@ task,
+# that will build the @html/all.html@ file.
+class Codex::AddTitleSlides < Codex::PostProcessor
+  register
+  def process
+    @html = @html.gsub(/<div class="slide">\s*<h1 class="slide0"/m, %{<div class="title slide">\n<h1})
+  end
+end

data/lib/codex/pressie.rb

@@ -1,108 +1,21 @@
 require 'yaml'
-
-S5_HEAD = %{<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
-
-<head>
-<title>&title;</title>
-<!-- metadata -->
-<meta name="generator" content="S5" />
-<meta name="version" content="S5 1.1" />
-<meta name="presdate" content="&date" />
-<meta name="author" content="&author;" />
-<meta name="organization" content="&organization;" />
-<meta name="company" content="&company;" />
-<!-- configuration parameters -->
-<meta name="defaultView" content="slideshow" />
-<meta name="controlVis" content="hidden" />
-<!-- style sheet links -->
-<link rel="stylesheet" href="../ui/default/slides.css" type="text/css" media="projection" id="slideProj" />
-<link rel="stylesheet" href="../ui/default/outline.css" type="text/css" media="screen" id="outlineStyle" />
-<link rel="stylesheet" href="../lib/stylesheets/print.css" type="text/css" media="print" id="slidePrint" />
-<link rel="stylesheet" href="../ui/default/opera.css" type="text/css" media="projection" id="operaFix" />
-
-<link rel="stylesheet" href="../lib/stylesheets/pressie.css" type="text/css" />
-
-<!-- S5 JS -->
-<script src="../ui/default/slides.js" type="text/javascript"></script>
-
-<!-- Syntax Highlighter -->
-<link rel="stylesheet"  href="../dp.SyntaxHighlighter/Styles/SyntaxHighlighter.css"></link>
-
-</head>
-<body>
-
-<div class="layout">
-<div id="controls"><!-- DO NOT EDIT --></div>
-<div id="currentSlide"><!-- DO NOT EDIT --></div>
-<div id="header"></div>
-<div id="footer">
-<h2>Copyright &copy; &copyright;</h2>
-</div>
-
-</div>
-
-
-<div class="presentation">
-}
-
-S5_TAIL = %{
-  <!-- Syntax Highlighter -->
-  <script language="javascript" src="../dp.SyntaxHighlighter/Scripts/shCore.js"></script>
-  <script language="javascript" src="../dp.SyntaxHighlighter/Scripts/shBrushCpp.js"></script>
-  <script language="javascript" src="../dp.SyntaxHighlighter/Scripts/shBrushRuby.js"></script>
-  <script language="javascript" src="../dp.SyntaxHighlighter/Scripts/shBrushXml.js"></script>
-  <script language="javascript">
-  dp.SyntaxHighlighter.ClipboardSwf = '/flash/clipboard.swf';
-  dp.SyntaxHighlighter.HighlightAll('code');
-  </script>
-</div>
-</body>
-</html>
-}
-
+require 'erb'
 
 module Codex
   class Pressie
-
-    def self.process
-      new.process
-    end
-
-    def process
-      metadata_name = ARGV.shift || usage("Missing metadata file name")
-      load_metadata(metadata_name)
-      input_name = ARGV.shift || usage("Missing input file name")
-      content = Content.new(File.read(input_name)) rescue usage($!.message)
-      header = substitute_metadata_into(S5_HEAD)
-      puts header, content.to_html, S5_TAIL
-    end
-
-
-    private
-
-    def usage(msg = nil)
-      STDERR.puts "pressie.rb  <metadatafile> <inputfile>"
-      if msg
-        STDERR.puts
-        STDERR.puts msg
+    
+    def initialize(metadata)
+      YAML.load_file(metadata).each do |key, value|
+        instance_variable_set("@#{key}", value)
       end
-      exit 1
     end
 
-    def load_metadata(file_name)
-      @metadata = YAML.load_file(file_name)
-    end
-
-    def substitute_metadata_into(text)
-      text = text.dup
-      %w{author company organization date copyright title}.each do |key|
-        text.gsub!(/&#{key};/, @metadata[key]) if @metadata.has_key?(key)
+    def process(input, output)
+      content = Content.new(input).to_html
+      File.open(output, 'w') do |f|
+        f << ERB.new(File.read(File.join(Codex.root, 'templates', 'layout.erb'))).result(binding)
       end
-      text
     end
-
+  
   end
 end

data/lib/codex/rake/codextask.rb

@@ -0,0 +1,93 @@
+require 'codex'
+require 'rake'
+require 'rake/tasklib'
+
+module Codex
+  module Rake
+    class CodexTask < ::Rake::TaskLib
+      attr_accessor :name
+      
+      # Directory of the source content. Defaults to 'content'
+      attr_accessor :content_dir
+
+      # Directory to output the built files into. Defaults to 'html'
+      attr_accessor :output_dir
+
+      # Metadata filename. Defaults to config/metadata.yml
+      attr_accessor :metadata
+
+      def initialize(name = :codex)
+        @name = name
+        @content_dir = 'content'
+        @output_dir = 'html'
+        @metadata = "config/metadata.yml"
+        yield self if block_given?
+        define
+      end
+      
+      def content_path
+        File.join(*[Codex.root, content_dir].compact)
+      end
+      
+      def output_path
+        File.join(*[Codex.root, output_dir].compact)
+      end
+      
+      def contents
+        Dir.chdir(content_path) do
+          filelist = FileList["*"]
+          filelist.resolve
+          filelist
+        end
+      end
+
+      def define
+        @output = []
+        pressie = Codex::Pressie.new(metadata)
+        
+        contents.each do |file|
+          input_file = File.join(content_dir, file)
+          output_file = File.join(output_dir, file.ext('.html'))
+          @output << output_file
+          desc "Build #{output_file} from #{input_file}"
+          file output_file => [output_dir, input_file] do
+            pressie.process(input_file, output_file)
+          end
+        end
+
+        task :default => name
+        
+        desc "Build all the content"
+        task name => @output
+        
+        # FIXME: clean up all this
+        all_html   = File.join(output_dir, "all.html")
+
+        task :remove_tmp do
+          FileUtils.rm_rf("tmp")
+        end
+        
+        desc "Build all based on the contents of content/table_of_contents.textile"
+        task :all => [ 'tmp', output_dir, all_html, :remove_tmp ]
+
+        desc "Remove all generated output and temporary files"
+        task :clean => "#{name}:remove_tmp" do
+          FileUtils.rm_rf output_path
+        end
+        
+        task all_html => 'tmp/all.textile' do
+          pressie.process('tmp/all.textile', all_html)
+        end
+
+        task 'tmp/all.textile' => @output do
+          sh "ruby bin/build_all.rb #{metadata} #{content_dir}/table_of_contents.textile tmp/all.textile"
+        end
+
+        directory "tmp"
+
+        directory output_dir
+      end
+    
+    end
+  end
+end

data/lib/codex/template_handler.rb

@@ -0,0 +1,29 @@
+module Codex
+  class TemplateHandler
+    include Singleton
+    
+    attr_reader :handlers
+    
+    def initialize
+      # just return the content for unknown formats
+      @handlers = Hash.new(lambda {|c| c })
+    end
+    
+    def self.register(extension, &klass)
+      instance.handlers[extension.to_s] = klass
+    end
+    
+    def self.choose(file)
+      instance.handlers[File.extname(file.to_s).sub(/^\./, '')]
+    end
+  end
+end
+
+Codex::TemplateHandler.register :textile do |content|
+  require 'redcloth'
+  RedCloth.new(content).to_html
+end
+Codex::TemplateHandler.register :markdown do |content|
+  require 'bluecloth'
+  BlueCloth.new(content).to_html
+end