drnic-codex 1.0.0

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/codex/content.rb

@@ -0,0 +1,160 @@
+require 'redcloth'
+
+class Codex::Content
+
+  # Wrap the parameters to :code
+  #
+  #  :code file.rb[:part class=xxx]
+  class Descriptor
+    attr_reader :file_name, :part
+    attr_reader :css_class
+    attr_reader :lang
+
+    def initialize(string)
+      @css_class = "code-normal"
+      @lang = "ruby"
+
+      if 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 "class"
+            @css_class = $2
+          when "lang"
+            @lang = $2
+          else
+            fail "Unknown parameter #{$1} in '#{params}'"
+          end
+        else
+          @part = param
+        end
+      end
+    end
+
+  end
+
+  START_SLIDE = %{<div class="slide">\n}
+  END_SLIDE   = %{</div>\n}
+  BETWEEN_SLIDES = END_SLIDE + "\n" + START_SLIDE
+
+  CODE_PATTERN = /^:code\s+(.+)/
+
+  # Temporarily prepended to lines of incldued code to stop them being processed
+  # as Textfile
+
+  INCLUDED_CODE_PREFIX = "XXX\001"
+  INCLUDED_CODE_PREFIX_REGEXP = /#{INCLUDED_CODE_PREFIX}/mo
+
+
+  def initialize(original)
+    @original = original.sub(/__END__.*/m, '').gsub(/__SKIP__.*?__ENDSKIP__/m, '')
+  end
+
+  def to_html
+    textile = preprocess_inlinecode(@original)
+    textile = preprocess_code(textile)
+    content = split_into_slides(textile)
+    html = RedCloth.new(content).to_html
+    remove_code_escaping_from(html)
+  end
+
+  # look for :code filename[part] and substitute in the appropriate part
+  # of the given file. Do in two steps because the regexp engine isn;t reentrant
+  def preprocess_code(text)
+    chunks = {}
+    text.scan(CODE_PATTERN) do |file,|
+      desc = Descriptor.new(file)
+      chunks[file] = find_content_from(desc)
+    end
+    text.gsub(CODE_PATTERN) { file = $1.dup; format_code(Descriptor.new(file), chunks[file]) }
+  end
+
+  # Look for :inlinecode /.../:endinlinecode and substitute in as if it came from a file
+  def preprocess_inlinecode(text)
+    state = :copying
+    result = []
+    text.split(/\n/).each do |line|
+      case state
+      when :copying
+        if line =~ /^:inlinecode(.*)/
+          args = $1.strip
+          desc = Descriptor.new("--[#{args}]")
+          result << %{<div class="#{desc.css_class}">\n}
+          result << %{\n<pre name="code" class="#{desc.lang}:nogutter:nocontrols">\n}
+          state = :incode
+        else
+          result << line
+        end
+      when :incode
+        if line =~ /^:endinlinecode/
+          result << "</pre></div>\n\n"
+          state = :copying
+        else
+          result << INCLUDED_CODE_PREFIX + line
+        end
+      end
+    end
+
+    result.join("\n")
+  end
+
+  def split_into_slides(textile)
+    result = []
+    slides = textile.split(/^h1/).each do |slide|
+      unless slide.empty?
+        result << START_SLIDE << "\nh1" << slide << END_SLIDE
+      end
+    end
+    result.join
+  end
+
+  def find_content_from(desc)
+    begin
+      content = File.read(desc.file_name)
+    rescue   Exception => e
+      STDERR.puts e.message
+      exit 2
+    end
+
+   find_part_in(content, desc.part)
+  end
+
+  def find_part_in(content, part_name)
+    result = []
+    state = part_name ? :skipping : :normal
+    content.each_line do |line|
+      if line.sub!(/(START|END):(\w+)/, '')
+        if $2 == part_name
+          if $1 == "START"
+            state = :normal
+          else
+            state = :skipping
+          end
+        end
+        next
+      end
+      result << line unless state == :skipping
+    end
+    result.join
+  end
+
+  def format_code(desc, code)
+    code = code.gsub(/^/m, INCLUDED_CODE_PREFIX)
+    %{<div class="#{desc.css_class}">\n} +
+    %{\n<pre name="code" class="#{desc.lang}:nogutter:nocontrols">#{code}} +
+    %{</pre></div>} +
+    %{<div class="codeurl"><a href="txmt://open?url=file://#{File.expand_path(desc.file_name)}">#{desc.file_name}</a></div>\n\n}
+  end
+
+  def remove_code_escaping_from(html)
+    html.gsub(INCLUDED_CODE_PREFIX_REGEXP, '')
+  end
+end

data/lib/codex/pressie.rb

@@ -0,0 +1,107 @@
+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="20050728" />
+<meta name="author" content="&author;" />
+<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>
+}
+
+
+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
+      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 copyright title}.each do |key|
+        text.gsub!(/&#{key};/, @metadata[key]) if @metadata.has_key?(key)
+      end
+      text
+    end
+
+  end
+end

data/lib/codex/version.rb

@@ -0,0 +1,9 @@
+module Codex #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/codex.rb

@@ -0,0 +1,7 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Codex; end
+
+require 'codex/content'
+require 'codex/pressie'

data/lib/stylesheets/pressie.css

@@ -0,0 +1,196 @@
+code {
+    font-family: Monaco;
+}
+
+
+div.slide code {
+    font-weight: normal;
+    font-size: 85%;
+    color:  #228;
+}
+    
+div.dp-highlighter
+{
+	font-family: "Gill Sans", "Consolas", "Courier New", Courier, mono;
+	font-size: 100%;
+	background-color: white;
+	overflow: auto;
+/*	margin: 18px 0px 18px 0px; */
+	padding-top: 1px; /* adds a little border on top when controls are hidden */
+	margin-bottom: 0px;
+ 	border: 2px solid; 
+}
+
+div.dp-highlighter ol 
+{
+	margin-top: 1px;
+	margin-bottom: 10px;
+	padding: 0px;
+}
+
+div.dp-highlighter ol li
+{
+  background-color: white;	
+}
+
+div.dp-highlighter .keyword {
+  font-weight: normal;
+  color: #33b;	
+}
+
+div.dp-highlighter .variable {
+  font-weight: normal;	
+}
+
+div.dp-highlighter .string {
+  color:  #22c;
+  font-style: italic;
+}
+
+.dp-cpp span.datatypes {
+    font-weight: normal;
+}
+
+div.codeurl {
+	margin-top: 0.5em;
+	margin-bottom: 1.5em;
+	padding-right: 1em;
+	text-align: right;
+	font-size: 50%;
+}
+
+div.slide ul {
+    margin-left: 0pt;
+}
+
+div.slide td {
+    padding: 0.3em 1em;
+}
+
+div.slide th {
+  background: #337;
+  color:      white;
+  font-weight: bold;
+  padding:    0.2em 0em 0.2em 0em;    
+}
+
+
+body {
+	background: white;
+}
+
+
+
+
+div#header {
+	background: white;
+	display: none;
+}
+
+div#footer {
+	background: white;
+	font-size: 50%;
+	height: 1em;
+}
+
+div#footer h2 {
+  font-weight: normal;
+  font-size:  60%;	
+}
+
+div.slide h1 {
+  background: white;
+  color:   #993333;
+  left: 1em;
+  top: 0.5em;
+  width: 95%;
+  padding: 0em 0em 0em 0em;
+  border-bottom: 6px solid #ffaaaa;
+  text-transform: none;
+}
+
+
+div.slide h1.exercise {
+  background: white;
+  color:   #339933;
+  left: 1em;
+  top: 0.5em;
+  width: 95%;
+  padding: 0em 0em 0em 0em;
+  border-bottom: 6px solid #aaffaa;
+}
+
+
+div#slide0,  div.title {
+    height: 100%;
+    background-image: url(ruby.png);
+    background-repeat: no-repeat;
+    background-position: bottom right;
+}
+
+div#slide0 h1, div.title h1 {
+	color: #993333;
+    background:transparent none repeat scroll 0%;
+    font-family:Helvetica,sans-serif;
+    font-size:2em;
+    font-size-adjust:none;
+    font-stretch:normal;
+    font-style:normal;
+    font-variant:normal;
+    font-weight:bold;
+    line-height:normal;
+    margin:10% 0pt 0pt;
+    padding:0pt;
+    position:static;
+    white-space:normal;
+    }
+}
+
+/* code layout */
+div.code-large {
+	font-size: 150% !important;
+	line-height: 1.6em !important;
+}
+
+
+div.code-normal {
+	font-size: 90% !important;
+	line-height: 2em !important;
+}
+
+div.code-normal li {
+	margin-top: 0.6em;
+}
+
+div.code-small {
+	font-size: 75% !important;
+	line-height: 2em !important;
+}
+
+div.code-small li {
+	margin-top: 0.6em;
+}
+
+div.code-tiny {
+	font-size: 50% !important;
+	line-height: 2em !important;
+}
+
+div.code-tiny li {
+	margin-top: 0.6em;
+}
+
+div.code-supertiny {
+   font-size: 33% !important;	
+   line-height: 2em !important;
+}
+
+div.code-supertiny li {
+	margin-top: 0.6em;
+}
+
+.caption {
+    color: #448;
+    font-family: Gil Sans;
+    font-size:   70%;
+}

data/lib/stylesheets/print.css

@@ -0,0 +1,149 @@
+/* The following rule is necessary to have all slides appear in print! DO NOT REMOVE IT! */
+@page {
+    size: 8.5in 11in;
+    margin: .75in 0.5in .75in 0.5in
+}
+
+@page :left {
+    @top-left {
+        content: "Wibble";
+    }
+}
+
+
+body div.slide, ul {
+    page-break-inside: avoid !important; 
+    widows: 20;
+    orphans: 20;
+    visibility: visible !important;
+}
+body div.slide {
+    page-break-before: auto;
+    clear: both;
+    margin-bottom: 1in;
+}
+
+h1 {page-break-after: avoid;}
+
+body {margin-left: 75px; font-size: 12pt; background: blue;}
+* {color: black;}
+
+body div div#slide0 h1, body div div.title h1 {
+    page-break-before: always;
+    font-size: 200%; 
+    border: 2px solid black; 
+    margin: 0.5em 0 0.25em;
+    padding: 1em 1em 1em 1em;
+    color: black;
+    text-align: center;    
+}
+
+div#slide0 {margin-bottom: 3em;}
+
+body div.slide h1 {
+    border-top: 2pt solid gray; 
+    border-bottom: 1px dotted silver; 
+    color: black;
+    text-transform: none;
+    font-size: 150%;
+}
+
+.extra {background: transparent !important;}
+div.extra, pre.extra, .example {font-size: 10pt; color: #333;}
+ul.extra a {font-weight: bold;}
+p.example {display: none;}
+
+#header {display: none;}
+#footer h1 {margin: 0; border-bottom: 1px solid; color: gray; font-style: italic;}
+#footer h2, #controls {display: none;}
+
+/* The following rule keeps the layout stuff out of print.  Remove at your own risk! */
+.layout, .layout * {display: none !important;}
+
+
+
+/* code layout */
+div div.code-large, div div.code-small, div div.code-normal, div div.code-tiny, div div.code-supertiny {
+	font-size: 80% !important;
+	line-height: 1.6em !important;
+}
+
+
+
+
+
+/*** Original 
+
+x div.slide ul {
+    margin-left: 0pt;
+}
+
+x div.slide td {
+    padding: 0.3em 1em;
+}
+
+x div.slide th {
+  background: #337;
+  color:      white;
+  font-weight: bold;
+  padding:    0.2em 0em 0.2em 0em;    
+}
+
+
+xxs div.slide h1 {
+  background: white;
+  color:   #993333;
+  left: 1em;
+  top: 0.5em;
+  width: 95%;
+  padding: 0em 0em 0em 0em;
+  border-bottom: 6px solid #ffaaaa;
+
+}
+
+
+x div.slide h1.exercise {
+  background: white;
+  color:   #339933;
+  left: 1em;
+  top: 0.5em;
+  width: 95%;
+  padding: 0em 0em 0em 0em;
+  border-bottom: 6px solid #aaffaa;
+}
+
+
+x div#slide0,  div.title {
+    height: 100%;
+    background-image: url(ruby.png);
+    background-repeat: no-repeat;
+    background-position: bottom right;
+}
+
+x div#slide0 h1, div.title h1 {
+	color: #993333;
+    background:transparent none repeat scroll 0%;
+    font-family:Helvetica,sans-serif;
+    font-size:2em;
+    font-size-adjust:none;
+    font-stretch:normal;
+    font-style:normal;
+    font-variant:normal;
+    font-weight:bold;
+    line-height:normal;
+    margin:10% 0pt 0pt;
+    padding:0pt;
+    position:static;
+    white-space:normal;
+    }
+}
+
+
+
+x .caption {
+    color: #448;
+    font-family: Gil Sans;
+    font-size:   70%;
+}
+
+*/

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/codex.rb'}"
+puts "Loading codex gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)