slideshow-models 2.4.0

data/lib/slideshow/helpers/capture_helper.rb

@@ -0,0 +1,138 @@
+# encoding: utf-8
+
+# Originally based on code from Rails and Merb; adapted from Webby.
+
+module Slideshow
+  module CaptureHelper
+ 
+  # Called in pages and partials to store up content for later use. Takes a
+  # string and/or a block. First, the string is evaluated, and then the
+  # block is captured using the capture() helper provided by the template
+  # languages. The two are concatenated together.
+  #
+  # Content is retrieved by calling the method without a string or a block.
+  #
+  # ==== Parameters
+  # obj<Object>:: The key in the content_for hash.
+  # string<String>:: Textual content. Defaults to nil.
+  # &block:: A block to be evaluated and concatenated to string.
+  #
+  # ==== Returns
+  # Any content associated with the key (or nil).
+  #
+  # ==== Example
+  #   content_for(:foo, "Foo")
+  #   content_for(:foo)             #=> "Foo"
+  #   content_for(:foo, "Bar")
+  #   content_for(:foo)             #=> "FooBar"
+  #
+  def content_for( obj, string = nil, &block )
+    return @content_for[obj] unless string || block_given?
+ 
+    cur = @content_for[obj].to_s
+    new = string.to_s + (block_given? ? capture_erb(&block) : "")
+    @content_for[obj] = cur + new
+  end
+ 
+  # Returns true if there is content for the given key. Otherwise returns
+  # false.
+  #
+  # ==== Parameters
+  # obj<Object>:: The key in the conetnt_for hash.
+  #
+  # ==== Example
+  #   content_for(:foo, "Foo")
+  #   content_for?(:foo)            #=> true
+  #   content_for?(:bar)            #=> false
+  #
+  def content_for?( obj )
+    @content_for.key?(obj)
+  end
+ 
+  # Deletes any content associated with the given object in the content_for
+  # hash.
+  #
+  # ==== Parameters
+  # obj<Object>:: The key in the conetnt_for hash.
+  #
+  # ==== Returns
+  # Any content associated with the key (or nil).
+  #
+  # ==== Example
+  #   content_for(:foo, "Foo")
+  #   content_for?(:foo)            #=> true
+  #   delete_content_for(:foo)
+  #   content_for?(:foo)            #=> false
+  #
+  def delete_content_for( obj )
+    @content_for.delete(obj)
+  end
+ 
+  # This method is used to capture content from an ERB filter evaluation. It
+  # is useful to helpers that need to process chunks of data during ERB filter
+  # processing.
+  #
+  # ==== Parameters
+  # *args:: Arguments to pass to the block.
+  # &block:: The ERB block to call.
+  #
+  # ==== Returns
+  # String:: The output of the block.
+  #
+  # ==== Examples
+  # Capture being used in an ERB page:
+  # 
+  #   <% @foo = capture_erb do %>
+  #     <p>Some Foo content!</p> 
+  #   <% end %>
+  #
+  def capture_erb( *args, &block )
+    # get the buffer from the block's binding
+    buffer = _erb_buffer(block.binding) rescue nil
+ 
+    # If there is no buffer, just call the block and get the contents
+    if buffer.nil?
+      block.call(*args)
+    # If there is a buffer, execute the block, then extract its contents
+    else
+      pos = buffer.length
+      block.call(*args)
+ 
+      # extract the block
+      data = buffer[pos..-1]
+ 
+      # replace it in the original with empty string
+      buffer[pos..-1] = ""
+ 
+      data
+    end
+  end
+ 
+  # This method is used to concatenate content into the ERB output buffer.
+  # It is usefule to helpers that need to insert transformed text back into
+  # the ERB output buffer.
+  #
+  # ==== Parameters
+  # string<String>:: The string to insert into the ERB output.
+  # the_binding<Binding>:: The binding to pass to the buffer.
+  #
+  def concat_erb( string, the_binding )
+    _erb_buffer(the_binding) << string
+  end
+ 
+  # Provides direct acccess to the ERB buffer in the conext of the binding.
+  #
+  # ==== Parameters
+  # the_binding<Binding>:: The binding to pass to the buffer.
+  #
+  # ==== Returns
+  # The current ERB output buffer.
+  #
+  def _erb_buffer( the_binding )
+    eval('_erbout', the_binding, __FILE__, __LINE__)
+  end
+ 
+end  # module CaptureHelper
+end # module Slideshow 
+ 
+Slideshow::Gen.__send__( :include, Slideshow::CaptureHelper )

data/lib/slideshow/helpers/directive_helper.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+module Slideshow
+  module DirectiveHelper
+
+# css directive:
+#
+# lets you use:
+#   %css
+#     -- inline css code here
+#   %end
+#
+# shortcut for:
+#   %content_for :css
+#     -- inline css code here
+#   %end
+#  or
+#  <% content_for :css do %>
+#    -- inline css code here
+#  <% end %>
+
+def css( &block )
+  content_for( :css, nil, &block )
+end
+    
+def slide( params )
+  # note: to avoid runons with blocks (wrap in double newlines)
+  
+  "\n\n<!-- _S9SLIDE_ #{params ? params : ''} -->\n\n"
+end
+
+def style( params )
+  # note: to avoid runons with blocks (wrap in double newlines)
+
+  "\n\n<!-- _S9STYLE_ #{params ? params : ''} -->\n\n"
+end
+
+
+end # module DirectiveHelper
+end # module Slideshow
+
+class Slideshow::Gen
+  include Slideshow::DirectiveHelper
+end
+

data/lib/slideshow/helpers/markdown_helper.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module Slideshow
+  module MarkdownHelper
+
+def s9_class( clazz )
+  "{: .#{clazz.strip}}"
+end
+
+def clear
+  "{: .clear}"
+end
+
+
+end # module MarkdownHelper
+end # module Slideshow
+
+class Slideshow::Gen
+  include Slideshow::MarkdownHelper
+end

data/lib/slideshow/helpers/source_helper.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+module Slideshow
+  module SourceHelper
+
+
+def source( *args )
+
+ # make everyting optional; use it like: 
+ #   source( name_or_path, opts={} )
+
+ # check for optional hash for options
+ opts = args.last.kind_of?(Hash) ? args.pop : {}
+
+ # check for optional name or path
+ name_or_path = args.last.kind_of?(String) ? args.pop : "#{@name}#{@extname}" 
+
+ link_text   = opts[:text] || '(Source)' 
+ 
+ # add extra path (e.g. 3rd) if present
+ name_or_path = "#{opts[:path]}/#{name_or_path}"   if opts[:path]
+ 
+ # add file extension if missing (for convenience)
+ name_or_path << @extname   if File.extname( name_or_path ).empty?
+
+  base = 'http://github.com/geraldb/slideshow/raw/master/samples'
+
+  buf = "<a href='#{base}/#{name_or_path}'>#{link_text}</a>"
+  
+  puts "  Adding HTML for source link to '#{name_or_path}'..."      
+  
+  guard_inline( buf )      
+end
+    
+  
+end # module SourceHelper
+end # module Slideshow
+
+class Slideshow::Gen
+  include Slideshow::SourceHelper
+end

data/lib/slideshow/helpers/step_helper.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+module Slideshow
+  module StepHelper
+
+  
+def step( opts={}, &blk )
+     
+  puts "  Adding HTML div block for step (incremental display)..."
+    
+  text = capture_erb(&blk)
+      
+  before  = "<!-- begin step #{opts.inspect} -->\n"
+  before << "<div class='step' markdown='block'>\n"
+  
+  after   = "</div>\n"  
+  after  << "<!-- end step -->\n"
+
+  html  = ""
+  html << guard_block( before )
+  html << text
+  html << guard_block( after )
+
+  concat_erb( html, blk.binding )
+  return
+end
+  
+  
+end # module StepHelper
+end # module Slideshow
+
+class Slideshow::Gen
+  include Slideshow::StepHelper
+end
+

data/lib/slideshow/helpers/syntax/coderay_helper.rb

@@ -0,0 +1,86 @@
+# encoding: utf-8
+
+require 'coderay'
+
+module Slideshow
+ module Syntax 
+  module CodeRayHelper
+
+  # coderay option defaults
+  CR_LANG         = 'ruby'
+  CR_LINE_NUMBERS = 'table'  # table | list | inline
+
+ def coderay_worker( code, opts )
+    
+  lang              = opts.fetch( :lang, CR_LANG )
+  line_numbers      = opts.fetch( :line_numbers, headers.get('code-line-numbers', CR_LINE_NUMBERS ) ) 
+  line_number_start = opts.fetch( :start, nil )
+  
+  cr_opts = {}
+  cr_opts[ :line_numbers ]      = line_numbers.to_sym
+  cr_opts[ :line_number_start ] = line_number_start.to_i if line_number_start
+   
+  # todo: add options for bold_every, tab_width (any others?)
+ 
+  code_highlighted = CodeRay.scan( code, lang.to_sym ).html(cr_opts)
+
+  # first time? get built-in coderay stylesheet
+  cr_first_time = session.fetch( :cr_first_time, true )
+  if cr_first_time
+    session[ :cr_first_time ] = false
+
+    theme_content = CodeRay::Encoders[:html]::CSS.new.stylesheet
+
+    theme_out =  %{/* styles for built-in coderay syntax highlighting theme */\n\n}
+    theme_out << theme_content
+    theme_out << %{\n\n}
+
+    content_for( :css, theme_out ) 
+  end
+
+  css_class = 'code'
+  css_class_opt = opts.fetch( :class, nil ) #  large, small, tiny, etc.
+  css_class << " #{css_class_opt}" if css_class_opt   # e.g. use/allow multiple classes -> code small, code large, etc.
+ 
+  name        = opts.fetch( :name, nil )
+  txmt_value  = opts.fetch( :txmt, headers.code_txmt )
+  txmt        = (txmt_value =~ /true|yes|on/i) ? true : false
+
+  out =  %{<div class='CodeRay'>}
+  out << %{<pre '#{css_class}'>\n}
+  out << code_highlighted
+  out << %{</pre>}
+  out << %{</div>}
+
+  # add optional href link for textmate
+  if name
+    out << %{<div class="codeurl">}
+    out << %{<a href="txmt://open?url=file://#{File.expand_path(name)}">} if txmt  
+    out << name
+    out << %{</a>} if txmt
+    out << %{</div>\n}
+  end
+  
+  return out 
+end
+
+def coderay( *args, &blk )
+  # check for optional hash for options
+  opts = args.last.kind_of?(Hash) ? args.pop : {}
+   
+  code = capture_erb(&blk)
+  return if code.empty?
+  
+  code_highlighted = coderay_worker( code, opts )
+    
+  concat_erb( wrap_markup( code_highlighted ), blk.binding )
+  return
+end
+
+end # module   CodeRayHelper
+end # module  Syntax
+end # module Slideshow
+
+class Slideshow::Gen
+  include Slideshow::Syntax::CodeRayHelper
+end

data/lib/slideshow/helpers/syntax/sh_helper.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+
+module Slideshow
+ module Syntax
+  module ShHelper
+
+  # sh option defaults
+  SH_LANG         = 'ruby'
+  SH_LINE_NUMBERS = 'true'
+
+def sh_worker( code, opts )
+  
+  lang         = opts.fetch( :lang, headers.get( 'code-language', SH_LANG ))
+  line_numbers_value = opts.fetch( :line_numbers, headers.get( 'code-line-numbers', SH_LINE_NUMBERS ))
+  line_numbers = (line_numbers_value =~ /true|yes|on/i) ? true : false
+     
+  # note: code gets highlighted at runtime in client (using JavaScript)  
+  code_highlighted = CGI::escapeHTML( code )
+  
+  css_class = 'code'
+  css_class_opt = opts.fetch( :class, nil ) #  large, small, tiny, etc.
+  css_class << " #{css_class_opt}" if css_class_opt   # e.g. use/allow multiple classes -> code small, code large, etc.
+   
+  out =  %{<div class='#{css_class}'><pre class='brush: #{lang} toolbar: false gutter: #{line_numbers ? 'true' : 'false'}'>}
+  out << code_highlighted
+  out << %{</pre></div>\n}
+    
+  name        = opts.fetch( :name, nil )
+  txmt_value  = opts.fetch( :txmt, headers.code_txmt )
+  txmt        = (txmt_value =~ /true|yes|on/i) ? true : false
+    
+  # add optional href link for textmate
+  if name
+    out << %{<div class="codeurl">}
+    out << %{<a href="txmt://open?url=file://#{File.expand_path(name)}">} if txmt  
+    out << name
+    out << %{</a>} if txmt
+    out << %{</div>\n}
+  end
+          
+  return out 
+end  
+
+def sv( *args, &blk )   
+  # check for optional hash for options
+  opts = args.last.kind_of?(Hash) ? args.pop : {}
+   
+  code = capture_erb(&blk)
+  return if code.empty?
+    
+  code_highlighted = sv_worker( code, opts )
+    
+  concat_erb( guard_block( code_highlighted ), blk.binding )
+  return
+end  
+    
+end   # module ShHelper
+end  # module Syntax
+end # module Slideshow
+
+class Slideshow::Gen
+  include Slideshow::Syntax::ShHelper
+end

data/lib/slideshow/helpers/syntax/uv_helper.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+
+require 'uv'
+
+module Slideshow
+ module Syntax
+  module UvHelper
+
+  # uv option defaults
+  UV_LANG         = 'ruby'
+  UV_LINE_NUMBERS = 'true'
+  UV_THEME        = 'amy'
+
+def uv_worker( code, opts )
+  
+  lang         = opts.fetch( :lang, UV_LANG )  
+  line_numbers_value = opts.fetch( :line_numbers, headers.get( 'code-line-numbers', UV_LINE_NUMBERS ))
+  line_numbers = (line_numbers_value =~ /true|yes|on/i) ? true : false
+  
+  # change all-hallows-eve (CSS-style/convention) to all_hallows_eve (uv internal-style)
+  theme   = opts.fetch( :theme, headers.get( 'code-theme', UV_THEME )).tr( '-', '_' )
+    
+  code_highlighted = Uv.parse( code, "xhtml", lang, line_numbers, theme )
+
+  # first time? copy all uv built-in themes (css styles) to temporary cache (~/.slideshow/*)
+  uv_first_time = session.fetch( :uv_first_time, true )
+  if uv_first_time
+    session[ :uv_first_time ] = false
+    logger.debug "cache_dir=#{config.cache_dir}"
+
+    FileUtils.mkdir(config.cache_dir) unless File.exists?(config.cache_dir) if config.cache_dir
+    Uv.copy_files "xhtml", config.cache_dir
+  end
+    
+  # first time this theme gets used add it to content_for hash for templates to include   
+  uv_themes = session[ :uv_themes ] ||= {} 
+  if uv_themes[ theme ].nil?
+    uv_themes[ theme ] = true
+    
+    theme_content = File.read( "#{config.cache_dir}/css/#{theme}.css" )
+
+    theme_out =  %{/* styles for ultraviolet code syntax highlighting theme '#{theme}' */\n\n}
+    theme_out << theme_content
+    theme_out << %{\n\n}
+
+    content_for( :css, theme_out ) 
+  end  
+
+  css_class = 'code'
+  css_class_opt = opts.fetch( :class, nil ) #  large, small, tiny, etc.
+  css_class << " #{css_class_opt}" if css_class_opt   # e.g. use/allow multiple classes -> code small, code large, etc.
+ 
+  name        = opts.fetch( :name, nil )
+  txmt_value  = opts.fetch( :txmt, headers.code_txmt )
+  txmt        = (txmt_value =~ /true|yes|on/i) ? true : false
+  
+  out =  %{<pre class='#{css_class}'>\n}
+  out << code_highlighted
+  out << %{</pre>\n}
+  
+  # add optional href link for textmate
+  if name
+    out << %{<div class="codeurl">}
+    out << %{<a href="txmt://open?url=file://#{File.expand_path(name)}">} if txmt  
+    out << name
+    out << %{</a>} if txmt
+    out << %{</div>\n}
+  end
+  
+  return out 
+end  
+
+def uv( *args, &blk )   
+  # check for optional hash for options
+  opts = args.last.kind_of?(Hash) ? args.pop : {}
+   
+  code = capture_erb(&blk)
+  return if code.empty?
+    
+  code_highlighted = uv_worker( code, opts )
+    
+  concat_erb( wrap_markup( code_highlighted ), blk.binding )
+  return
+end  
+    
+end   # module UvHelper
+end  # module Syntax
+end # module Slideshow
+
+class Slideshow::Gen
+  include Slideshow::Syntax::UvHelper
+end