slideshow 0.9.1 → 0.9.2

data/History.rdoc

@@ -1,3 +1,12 @@
+=== 0.9.2 / 2010-07-11
+
+* Change default template pack from s6gradients to s6blank
+* Added syntax highlighting helper (sh) for SyntaxHighlighter JavaScript Library
+* Added gradient and background helper
+* Added simplified parameters for Django-style expressions and statements
+* Added support for %-directives (e.g. %helper, %css, %yourown, etc)
+* Minor fixes 
+
 === 0.9  / 2010-07-04
 
 * Added support for !SLIDE (and alternative syntax %slide)

data/Manifest.txt

@@ -7,32 +7,34 @@ config/slideshow.builtin.yml
 config/slideshow.yml
 lib/slideshow.rb
 lib/slideshow/config.rb
+lib/slideshow/filters/debug_filter.rb
 lib/slideshow/filters/headers_filter.rb
 lib/slideshow/filters/text_filter.rb
 lib/slideshow/gen.rb
 lib/slideshow/helpers/analytics_helper.rb
+lib/slideshow/helpers/background_helper.rb
 lib/slideshow/helpers/capture_helper.rb
-lib/slideshow/helpers/coderay_helper.rb
+lib/slideshow/helpers/directive_helper.rb
+lib/slideshow/helpers/markdown_helper.rb
+lib/slideshow/helpers/source_helper.rb
 lib/slideshow/helpers/step_helper.rb
+lib/slideshow/helpers/syntax/coderay_helper.rb
+lib/slideshow/helpers/syntax/sh_helper.rb
+lib/slideshow/helpers/syntax/uv_helper.rb
 lib/slideshow/helpers/table_helper.rb
 lib/slideshow/helpers/text_helper.rb
-lib/slideshow/helpers/uv_helper.rb
 lib/slideshow/markdown.rb
 lib/slideshow/opts.rb
 lib/slideshow/slide.rb
 lib/slideshow/textile.rb
-templates/gradient.svg.erb
 templates/s6.txt
 templates/s6.txt.gen
-templates/s6.txt.sample
-templates/s6/footer.html.erb
-templates/s6/footer.pdf.html.erb
-templates/s6/header.html.erb
-templates/s6/header.pdf.html.erb
 templates/s6/jquery.js
 templates/s6/outline.css
 templates/s6/print.css
 templates/s6/slides.core.js
 templates/s6/slides.css
 templates/s6/slides.js
-templates/s6/style.css.erb
+templates/slides.html.erb
+templates/slides.pdf.html.erb
+templates/style.css.erb

data/config/slideshow.builtin.yml

@@ -6,16 +6,24 @@
 #        libs: [ whatever ]
 
 
-# text filters
+helper:
+  unparsed: [ slide, style ]
+  renames: [ include, class ]
+  exprs: [ class, clear ]
 
+# text filters  
 filters:
+  - skip-end-directive
+  - directives_bang_style_to_percent_style
+  - directives_percent_style
   - comments-percent-style
   - leading-headers
-  - skip-end-directive
   - erb-django-style
-  - include-helper-hack
+  - erb-rename-helper-hack
+  - dump_content_to_file_debug_text_erb
   - erb
   - code-block-curly-style
+  - dump_content_to_file_debug_text
 
 
 # markup (textile, markdown) config

data/config/slideshow.yml

@@ -40,6 +40,8 @@ headers:
 #   map shortcut to URI
     
 fetch:
+    s6gradients: http://github.com/geraldb/slideshow-s6-gradients/raw/master/s6gradients.txt
+    s6syntax: http://github.com/geraldb/slideshow-s6-syntax-highlighter/raw/master/s6syntax.txt
     s6blank: http://github.com/geraldb/slideshow-s6-blank/raw/master/s6blank.txt
     s5blank: http://github.com/geraldb/slideshow-s5-blank/raw/master/s5blank.txt
     s5themes: http://github.com/geraldb/slideshow-s5-themes/raw/master/s5themes.txt
@@ -53,6 +55,10 @@ analytics:
     google: UA-XXX
     
 
+helper:
+  renames: []
+  exprs: []
+
 ### markup (textile, markdown) config
 
 # filters to run before markup processing

data/lib/slideshow.rb

@@ -14,6 +14,7 @@ require 'net/http'
 require 'ostruct'
 require 'date'
 require 'yaml'
+require 'cgi'
 
 # required gems
 require 'redcloth'  # default textile library
@@ -34,15 +35,22 @@ require 'slideshow/helpers/capture_helper'
 require 'slideshow/helpers/analytics_helper'
 require 'slideshow/helpers/table_helper'
 require 'slideshow/helpers/step_helper'
+require 'slideshow/helpers/background_helper'
+require 'slideshow/helpers/source_helper'
+require 'slideshow/helpers/directive_helper'
+require 'slideshow/helpers/markdown_helper'
+
+require 'slideshow/helpers/syntax/sh_helper'
 
 # load built-in filters
 require 'slideshow/filters/headers_filter'
 require 'slideshow/filters/text_filter'
+require 'slideshow/filters/debug_filter'
 
 
 module Slideshow
 
-  VERSION = '0.9.1'
+  VERSION = '0.9.2'
 
   # version string for generator meta tag (includes ruby version)
   def Slideshow.generator
@@ -70,8 +78,8 @@ end # module Slideshow
 #     gem install coderay
 #     gem install ultraviolet etc.
 BUILTIN_OPT_HELPERS = [
-  'slideshow/helpers/uv_helper.rb',
-  'slideshow/helpers/coderay_helper.rb',
+  'slideshow/helpers/syntax/uv_helper.rb',
+  'slideshow/helpers/syntax/coderay_helper.rb',
 ]
 
 BUILTIN_OPT_HELPERS.each do |helper| 

data/lib/slideshow/config.rb

@@ -39,18 +39,18 @@ class Config
     # textile:
     #   extnames:  [ .textile, .t ]
     
-    @hash[ 'textile' ][ 'extnames' ] + @hash[ 'builtin' ][ 'textile' ][ 'extnames' ] 
+    (@hash[ 'textile' ][ 'extnames' ] || []) + @hash[ 'builtin' ][ 'textile' ][ 'extnames' ] 
   end
 
   def known_markdown_extnames
-    @hash[ 'markdown' ][ 'extnames' ] + @hash[ 'builtin' ][ 'markdown' ][ 'extnames' ]   
+    (@hash[ 'markdown' ][ 'extnames' ] || []) + @hash[ 'builtin' ][ 'markdown' ][ 'extnames' ]   
   end
   
   def known_markdown_libs
     # returns an array of known markdown engines e.g.
     # [ rdiscount, rpeg-markdown, maruku, bluecloth, kramdown ]
     
-    @hash[ 'markdown' ][ 'libs' ] + @hash[ 'builtin' ][ 'markdown' ][ 'libs' ]
+    (@hash[ 'markdown' ][ 'libs' ] || []) + @hash[ 'builtin' ][ 'markdown' ][ 'libs' ]
   end
 
   def known_extnames
@@ -61,7 +61,22 @@ class Config
   end
   
   def text_filters
-    @hash[ 'builtin' ][ 'filters' ] + @hash[ 'filters' ] 
+    @hash[ 'builtin' ][ 'filters' ] + ( @hash[ 'filters' ] || [] ) 
+  end
+  
+  def helper_renames
+     @hash[ 'builtin' ][ 'helper' ][ 'renames' ] + ( @hash[ 'helper' ][ 'renames' ] || [] )
+  end
+
+  def helper_unparsed
+    # use unparsed params (passed along a single string)
+    @hash[ 'builtin' ][ 'helper' ][ 'unparsed' ]
+  end
+  
+  def helper_exprs
+    # allow expression as directives (no need for %end block)
+    # by default directives are assumed statements (e.g. %mydir  %end)
+    @hash[ 'builtin' ][ 'helper' ][ 'exprs' ] + ( @hash[ 'helper' ][ 'exprs' ] || [] )
   end
 
   def google_analytics_code

data/lib/slideshow/filters/debug_filter.rb

@@ -0,0 +1,44 @@
+module Slideshow
+  module DebugFilter
+
+# use it to dump content before erb merge
+
+def dump_content_to_file_debug_text_erb( content )
+
+  return content   unless logger.level == Logger::DEBUG
+
+  outname = "#{@name}.debug.text.erb"
+
+  puts "  Dumping content before erb merge to #{outname}..."
+
+  File.open( outname, 'w' ) do |f|
+    f.write( content )	
+  end
+
+  content
+end
+
+# use it to dump content before text-to-html conversion
+
+def dump_content_to_file_debug_text( content )
+
+  return content   unless logger.level == Logger::DEBUG
+
+  outname = "#{@name}.debug.text"
+
+  puts "  Dumping content before text-to-html conversion to #{outname}..."
+
+  File.open( outname, 'w' ) do |f|
+    f.write( content )	
+  end
+
+  content
+
+end
+  
+end  # module DebugFilter
+end # module Slideshow
+
+class Slideshow::Gen
+  include Slideshow::DebugFilter
+end

data/lib/slideshow/filters/headers_filter.rb

@@ -1,4 +1,5 @@
-module HeadersFilter
+module Slideshow
+  module HeadersFilter
 
 def leading_headers( content_with_headers )
   
@@ -38,8 +39,8 @@ def leading_headers( content_with_headers )
 end
   
 end  # module HeadersFilter
-
+end # module Slideshow
 
 class Slideshow::Gen
-  include HeadersFilter
+  include Slideshow::HeadersFilter
 end

data/lib/slideshow/filters/text_filter.rb

@@ -3,9 +3,91 @@
 #
 # use web filters for processing html/hypertext
 
-module TextFilter
+module Slideshow
+  module TextFilter
 
-  def comments_percent_style( content )    
+def directives_bang_style_to_percent_style( content )
+
+  # for compatibility allow !SLIDE/!STYLE as an alternative to %slide/%style-directive
+  
+  bang_count = 0
+
+  # get unparsed helpers e.g. SLIDE|STYLE  
+  unparsed = config.helper_unparsed.map { |item| item.upcase }.join( '|' )                                                                   
+  
+  content.gsub!(/^!(#{unparsed})/) do |match|
+    bang_count += 1
+    "%#{$1.downcase}"
+  end
+
+  puts "  Patching !-directives (#{bang_count} #{config.helper_unparsed.join('/')}-directives)..."
+
+  content
+end
+
+def directives_percent_style( content )
+
+  directive_unparsed  = 0
+  directive_expr      = 0
+  directive_block_beg = 0
+  directive_block_end = 0
+
+  # process directives (plus skip %begin/%end comment-blocks)
+
+  inside_block  = 0
+  inside_helper = false
+  
+  content2 = ""
+  
+  content.each_line do |line|
+    if line =~ /^%([a-zA-Z][a-zA-Z0-9_]*)(.*)/
+      directive = $1.downcase
+      params    = $2
+
+      logger.debug "processing %-directive: #{directive}"
+
+      # slide, style
+      if config.helper_unparsed.include?( directive )
+        directive_unparsed += 1
+        content2 << "<%= #{directive} '#{params ? params : ''}' %>"
+      elsif config.helper_exprs.include?( directive )
+        directive_expr += 1
+        content2 << "<%= #{directive} #{params ? erb_simple_params(directive,params) : ''} %>"        
+      elsif inside_helper && directive == 'end'
+        inside_helper = false
+        directive_block_end += 1
+        content2 << "%>"        
+      elsif inside_block > 0 && directive == 'end'
+        inside_block -= 1
+        directive_block_end += 1
+        content2 << "<% end %>"
+      elsif [ 'comment', 'comments', 'begin', 'end' ].include?( directive )  # skip begin/end comment blocks
+        content2 << line
+      elsif [ 'helper', 'helpers' ].include?( directive )
+        inside_helper = true
+        directive_block_beg += 1
+        content2 << "<%"
+      else
+        inside_block += 1
+        directive_block_beg += 1
+        content2 << "<% #{directive} #{params ? erb_simple_params(directive,params) : ''} do %>"
+      end
+    else
+      content2 << line
+    end
+  end  
+    
+  puts "  Preparing %-directives (" +
+      "#{directive_unparsed} #{config.helper_unparsed.join('/')} directives, " +
+      "#{directive_expr} #{config.helper_exprs.join('/')} expr-directives, " +
+      "#{directive_block_beg}/#{directive_block_end} block-directives)..."
+
+  content2
+end
+
+
+
+def comments_percent_style( content )    
     
     # remove comments
     # % comments
@@ -18,7 +100,7 @@ module TextFilter
     comments_end    = 0
 
     # remove multi-line comments
-    content.gsub!(/^%begin.*?%end/m) do |match|
+    content.gsub!(/^%(begin|comment|comments).*?%end/m) do |match|
       comments_multi += 1
       ""
     end
@@ -44,8 +126,8 @@ module TextFilter
       ""
     end
     
-    puts "  Removing comments (#{comments_single} %-lines, " +
-       "#{comments_multi} %begin/%end-blocks, #{comments_end} %end-blocks)..."
+    puts "  Removing %-comments (#{comments_single} lines, " +
+       "#{comments_multi} begin/end-blocks, #{comments_end} end-blocks)..."
     
     content    
   end
@@ -58,17 +140,21 @@ module TextFilter
     content
   end
   
-  def include_helper_hack( content )
-    # note: include is a ruby keyword; rename to __include__ so we can use it 
+  def erb_rename_helper_hack( content )
+    # note: include is a ruby keyword; rename to s9_include so we can use it 
+    
+    rename_counter = 0
     
-    include_counter = 0
+    # turn renames into something like:
+    #   include|class   etc.
+    renames = config.helper_renames.join( '|' )
     
-    content.gsub!( /<%=[ \t]*include/ ) do |match|
-      include_counter += 1
-      '<%= __include__' 
+    content.gsub!( /<%=[ \t]*(#{renames})/ ) do |match|
+      rename_counter += 1
+      "<%= s9_#{$1}" 
     end
 
-    puts "  Patching embedded Ruby (erb) code aliases (#{include_counter} include)..."
+    puts "  Patching embedded Ruby (erb) code for aliases (#{rename_counter} #{config.helper_renames.join('/')}-aliases)..."
 
     content
   end
@@ -81,32 +167,110 @@ module TextFilter
     content
   end
 
+  def erb_simple_params( method, params )
+    
+    # replace params to support html like attributes e.g.
+    #  plus add comma separator
+    #
+    #  class=part       -> :class => 'part'   
+    #  3rd/tutorial     -> '3rd/tutorial'
+    #  :css             -> :css
+    
+    return params   if params.nil? || params.strip.empty?
+
+    params.strip!    
+    ## todo: add check for " ??
+    if params.include?( '=>' )
+      puts "** warning: skipping patching of params for helper '#{method}'; already includes '=>':"
+      puts "  #{params}"
+      
+      return params
+    end
+    
+    before = params.clone
+    
+    # 1) string-ify values and keys (that is, wrap in '')
+    #  plus separate w/ commas
+    params.gsub!( /([:a-zA-Z0-9#][\w\/\-\.#()]*)|('[^'\n]*')/) do |match|
+      symbol = ( Regexp.last_match( 0 )[0,1] == ':' )
+      quoted = ( Regexp.last_match( 0 )[0,1] == "'" )
+      if symbol || quoted  # return symbols or quoted string as is
+        "#{Regexp.last_match( 0 )},"
+      else
+        "'#{Regexp.last_match( 0 )}',"
+      end
+    end
+        
+    # 2) symbol-ize hash keys
+    #    change = to =>
+    #    remove comma for key/value pairs
+    params.gsub!( /'(\w+)',[ \t]*=/ ) do |match|
+      ":#{$1}=>"
+    end
+    
+    # 3) remove trailing comma
+    params.sub!( /[ \t]*,[ \t]*$/, '' ) 
+     
+    puts "    Patching params for helper '#{method}' from '#{before}' to:"
+    puts "      #{params}"  
+       
+    params    
+  end
+
+
+  def erb_django_simple_params( code )
+    
+    # split into method/directive and parms plus convert params
+    code.sub!( /^[ \t]([\w.]+)(.*)/ ) do |match|
+      directive = $1
+      params    = $2
+      
+      "#{directive} #{params ? erb_simple_params(directive,params) : ''}"     
+    end
+    
+    code
+  end
+
   def erb_django_style( content )
 
     # replace expressions (support for single lines only)
     #  {{ expr }}  ->  <%= expr %>
     #  {% stmt %}  ->  <%  stmt %>   !! add in do if missing (for convenience)
+    #
+    # use use {{{ or {{{{ to escape expr back to literal value
+    # and use {%% %} to escape stmts
 
     erb_expr = 0
     erb_stmt_beg = 0
     erb_stmt_end = 0
 
-    content.gsub!( /\{\{([^{}\n]+?)\}\}/ ) do |match|
-      erb_expr += 1
-      "<%= #{$1} %>"
+    content.gsub!( /(\{{2,4})([^{}\n]+?)(\}{2,4})/ ) do |match|
+      escaped = ($1.length > 2)
+      if escaped
+        "{{#{$2}}}"
+      else
+        erb_expr += 1
+        "<%= #{erb_django_simple_params($2)} %>"        
+      end
     end
 
-    content.gsub!( /\{%[ \t]*end[ \t]*%\}/ ) do |match|
-      erb_stmt_end += 1
-      "<% end %>"
+    content.gsub!( /(\{%{1,2})([ \t]*end[ \t]*)%\}/ ) do |match|
+      escaped = ($1.length > 2)
+      if escaped
+        "{%#{$2}%}"
+      else
+        erb_stmt_end += 1
+        "<% end %>"
+      end
     end
 
-    content.gsub!( /\{%([^%\n]+?)%\}/ ) do |match|
-      erb_stmt_beg += 1
-      if $1.include?('do') 
-        "<% #{$1} %>"
+    content.gsub!( /(\{%{1,2})([^%\n]+?)%\}/ ) do |match|
+      escaped = ($1.length > 2)
+      if escaped
+        "{%#{$2}%}"
       else
-        "<% #{$1} do %>"
+        erb_stmt_beg += 1
+        "<% #{erb_django_simple_params($2)} do %>"
       end
     end
 
@@ -119,35 +283,46 @@ module TextFilter
   def code_block_curly_style( content )
     # replace {{{  w/ <pre class='code'>
     # replace }}}  w/ </pre>
+    # use 4-6 { or } to escape back to literal value (e.g. {{{{ or {{{{{{ => {{{ )
+    # note: {{{ / }}} are anchored to beginning of line ( spaces and tabs before {{{/}}}allowed )
     
     # track statistics
-    code_begin = 0
-    code_end   = 0    
-    
-    content.gsub!( "{{{{{{", "<pre class='code'>_S9BEGIN_" )
-    content.gsub!( "}}}}}}", "_S9END_</pre>" )  
-    
-    content.gsub!( "{{{" ) do |match|
-      code_begin += 1
-      "<pre class='code'>"
+    code_begin     = 0
+    code_begin_esc = 0
+    code_end       = 0    
+    code_end_esc   = 0    
+        
+    content.gsub!( /^[ \t]*(\{{3,6})/ ) do |match|
+      escaped = ($1.length > 3)
+      if escaped
+        code_begin_esc += 1
+        "{{{"
+      else
+        code_begin += 1
+        "<pre class='code'>"
+      end
     end    
     
-    content.gsub!( "}}}" ) do |match|
-      code_end += 1
-      "</pre>"
+    content.gsub!( /^[ \t]*(\}{3,6})/ ) do |match|
+      escaped = ($1.length > 3)
+      if escaped
+        code_end_esc += 1
+        "}}}"
+      else
+        code_end += 1
+        "</pre>"      
+      end
     end
-    
-    # restore escaped {{{}}} 
-    content.gsub!( "_S9BEGIN_", "{{{" )
-    content.gsub!( "_S9END_", "}}}" )
-    
-    puts "  Patching code blocks (#{code_begin}/#{code_end} {{{/}}}-lines)..."    
+        
+    puts "  Patching {{{/}}}-code blocks (#{code_begin}/#{code_end} blocks, " +
+         "#{code_begin_esc}/#{code_end_esc} escaped blocks)..."    
     
     content
   end
 
-end
+end   # module TextFilter
+end  # module Slideshow
 
 class Slideshow::Gen
-  include TextFilter
+  include Slideshow::TextFilter
 end