slideshow 0.7.5 → 0.7.6

data/lib/helpers/capture_helper.rb

@@ -0,0 +1,134 @@
+# Originally based on code from Rails and Merb; adapted from Webby.
+
+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
+ 
+Slideshow::Gen.__send__( :include, CaptureHelper )

data/lib/helpers/text_helper.rb

@@ -0,0 +1,10 @@
+module TextHelper
+  
+def __include__( name, opts = {} )
+  puts "  Including '#{name}'..." 
+  content = File.read( name )
+end
+
+end # module TextHelper
+
+Slideshow::Gen.__send__( :include, TextHelper )

data/lib/slideshow.rb

@@ -15,9 +15,9 @@ require 'pp'
 
 module Slideshow
 
-  VERSION = '0.7.5'
+  VERSION = '0.7.6'
 
-class Params 
+class ParamsOldDelete 
   
   def initialize( name, headers )
     @name    =  name
@@ -195,6 +195,8 @@ class Gen
     @opts = Opts.new
   end
 
+  # replace w/ attr_reader :logger, :opts ??
+
   def logger 
     @logger
   end
@@ -203,7 +205,7 @@ class Gen
     @opts
   end
   
-  def check_markdown_libs
+  def load_markdown_libs
     # check for available markdown libs/gems
     # try to require each lib and remove any not installed
     @markdown_libs = []
@@ -288,8 +290,8 @@ class Gen
     return File.read( path )
   end
   
-  def render_template( content, b=TOPLEVEL_BINDING )
-    ERB.new( content ).result( b )
+  def render_template( content, the_binding )
+    ERB.new( content ).result( the_binding )
   end
 
   def load_template_old_delete( name, builtin )
@@ -356,6 +358,15 @@ class Gen
     extname  = File.extname( fn )
     logger.debug "dirname=#{dirname}, basename=#{basename}, extname=#{extname}"
 
+    # shared variables for templates (binding)
+    @content_for = {}  # reset content_for hash
+    @name        = basename
+    @headers     = @opts
+
+    puts "Preparing slideshow '#{basename}'..."
+
+
+
   known_extnames = KNOWN_TEXTILE_EXTNAMES + KNOWN_MARKDOWN_EXTNAMES
                 
   if extname.empty? then
@@ -374,8 +385,20 @@ class Gen
   inname  =  "#{dirname}/#{basename}#{extname}"
 
   logger.debug "inname=#{inname}"
+    
+  source = File.read( inname )
+  
+  # ruby note: .*? is non-greedy (shortest-possible) regex match
+  source.gsub!(/__SKIP__.*?__END__/m, '')
+  source.sub!(/__END__.*/m, '')
+  
+  # allow plugins/helpers; process source (including header) using erb
+  
+  # note: include is a ruby keyword; rename to __include__ so we can use it 
+  source.gsub!( /<%=[ \t]*include/, '<%= __include__' )
+  
+  source =  ERB.new( source ).result( binding )
   
-  content = File.read( inname )
   
   # todo: read headers before command line options (lets you override options using commandline switch)
   
@@ -384,8 +407,10 @@ class Gen
 
   read_headers = true
   content = ""
+  
+   # fix: allow comments in header too (#)
 
-  File.open( inname ).readlines.each do |line|
+  source.each do |line|
     if read_headers && line =~ /^\s*(\w[\w-]*)[ \t]*:[ \t]*(.*)/
       key = $1.downcase
       value = $2.strip
@@ -411,11 +436,7 @@ class Gen
   content.gsub!( "_S9BEGIN_", "{{{" )
   content.gsub!( "_S9END_", "}}}" )
 
-  opts.set_defaults
-  
-  params = Params.new( basename, opts )
-  
-  puts "Preparing slideshow '#{basename}'..."
+  opts.set_defaults  
 
   # convert light-weight markup to hypertext
   
@@ -495,11 +516,11 @@ class Gen
 
       out = File.new( with_output_path( outname, outpath ), "w+" )
 
-      out << render_template( load_template( entry[1] ), params.params_binding )
+      out << render_template( load_template( entry[1] ), binding )
       
       if entry.size > 2 # more than one source file? assume header and footer with content added inbetween
         out << content2 
-        out << render_template( load_template( entry[2] ), params.params_binding )
+        out << render_template( load_template( entry[2] ), binding )
       end
 
       out.flush
@@ -535,6 +556,27 @@ class Gen
   puts "Done."
 end
 
+def load_plugins
+  
+  # use lib folder unless we're in our very own folder 
+  #  (that use lib for its core functionality), thus, use plugins instead  
+  if( File.expand_path( File.dirname(__FILE__) ) == File.expand_path( 'lib' ) )
+    pattern = 'plugins/**/*.rb'
+  else
+    pattern = 'lib/**/*.rb'
+  end
+  
+  logger.debug "pattern=#{pattern}"
+  
+  Dir.glob( pattern ) do |plugin|
+    begin
+      puts "Loading plugins in '#{plugin}'..."
+      require( plugin )
+    rescue Exception => e
+      puts "** error: failed loading plugins in '#{plugin}': #{e}"
+    end
+  end
+end
 
 def run( args )
 
@@ -601,7 +643,8 @@ def run( args )
   if opts.generate?
     create_slideshow_templates
   else
-    check_markdown_libs
+    load_markdown_libs
+    load_plugins  # check for optional plugins/extension in ./lib folder
     
     args.each { |fn| create_slideshow( fn ) }
   end
@@ -615,4 +658,8 @@ end
 
 end # module Slideshow
 
+# load built-in helpers/plugins
+require "#{File.dirname(__FILE__)}/helpers/text_helper.rb"
+require "#{File.dirname(__FILE__)}/helpers/capture_helper.rb"
+
 Slideshow.main if __FILE__ == $0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: slideshow
 version: !ruby/object:Gem::Version 
-  version: 0.7.5
+  version: 0.7.6
 platform: ruby
 authors: 
 - Gerald Bauer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-19 00:00:00 +01:00
+date: 2009-02-24 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,6 +41,9 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/helpers
+- lib/helpers/capture_helper.rb
+- lib/helpers/text_helper.rb
 - lib/slideshow.rb
 - lib/templates
 - lib/templates/footer.html.erb