slideshow 0.5.2 → 0.6

data/lib/slideshow.rb

@@ -11,25 +11,170 @@ require 'uv'
 
 module Slideshow
 
-class Params
+  VERSION = '0.6'
+
+class Params 
   
   def initialize( name, headers )
-      @svgname =  "#{name}.svg"
-      @cssname =  "#{name}.css"
-      @headers =  headers
+    @svgname =  "#{name}.svg"
+    @cssname =  "#{name}.css"
+    @headers =  headers
   end
     
   def params_binding
-      binding
+    binding
   end
 
 end
 
-def Slideshow.cache_dir
+# todo: split (command line) options and headers?
+# e.g. share (command line) options between slide shows (but not headers?)
+
+class Opts
+  
+  def initialize
+    @hash = {}
+  end
+  
+  def put( key, value )
+    key = key.downcase
+    if key.eql? 'code-theme' then
+      code_theme = value 
+    elsif key.eql? 'gradient' then
+      gradient = value
+    elsif key.eql? 'gradient-colors' then
+      gradient_colors = value 
+    elsif key.eql? 'gradient-color' then
+      gradient_color = value
+    elsif key.eql? 'gradient-theme' then
+      gradient-theme = value
+    else
+      @hash[ key ] = value
+    end
+  end
+  
+  def code_theme=( value )
+    @hash[ 'code-theme' ] = value.tr( '-', '_' )
+  end
+
+  def gradient=( value )
+      values = value.split( ' ' )
+      @hash[ 'gradient-theme'  ] = values[0].tr( '-', '_' )
+      @hash[ 'gradient-color1' ] = values[1] if values[1] 
+      @hash[ 'gradient-color2' ] = values[2] if values[2]
+  end
+  
+  def gradient_colors=( value )
+    values = value.split( ' ' )
+    @hash[ 'gradient-color1' ] = values[0] 
+    @hash[ 'gradient-color2' ] = values[1] if values[1]
+  end
+
+  def gradient_color=( value )
+    @hash[ 'gradient-color1' ] = value
+  end
+  
+  def gradient_theme=( value )
+    @hash[ 'gradient-theme' ] = value.tr( '-', '_' )
+  end
+
+  def get( key, default )
+    value = @hash[ key ]
+    value.nil? ? default : value
+  end
+  
+  def []( key )
+    value = @hash[ key ]
+    value.nil? ? "- #{key} not found -" : value
+  end
+
+  def get_boolean( key, default )
+    value = @hash[ key ]
+    if value.nil?
+      default
+    else
+      if( value == true || value.downcase == 'true' || value.downcase == 'yes' || value.downcase == 'on' )
+        true
+      else
+        false
+      end
+    end
+  end
+
+  def generate?
+    get_boolean( 'generate', false )
+  end
+  
+  def has_includes?
+    @hash[ 'include' ]
+  end
+  
+  def includes
+    # fix: use os-agnostic delimiter (use : for Mac/Unix?)
+    has_includes? ? @hash['include'].split( ';' ) : []
+  end
+  
+  def s5?  
+    get_boolean( 's5', false )
+  end
+  
+  def fullerscreen?
+    get_boolean( 'fuller', false ) || get_boolean( 'fullerscreen', false )
+  end
+
+  def code_theme
+    get( 'code-theme', 'amy' )
+  end  
+  
+  def code_line_numbers?
+    get_boolean( 'code-line-numbers', true )
+  end 
+
+  DEFAULTS =
+  [
+    [ 'title',             'Untitled Slide Show' ],
+    [ 'gradient-theme',    'dark' ],
+    [ 'gradient-color1',   'red' ],
+    [ 'gradient-color2',   'black' ],
+    [ 'code-theme',        'amy' ],
+    [ 'code-line-numbers', 'true' ]
+  ]
+
+  def set_defaults  
+    DEFAULTS.each do | item |
+      key   = item[0]
+      value = item[1]
+      @hash[ key ] = value if @hash[ key ].nil?
+    end
+  end
+  
+end # class Opts
+
+
+class Gen
+
+  KNOWN_TEXTILE_EXTNAMES  = [ '.textile', '.t' ]
+  KNOWN_MARKDOWN_EXTNAMES = [ '.markdown', '.mark', '.m', '.txt', '.text' ]
+
+  def initialize
+    @logger = Logger.new(STDOUT)
+    @logger.level = Logger::INFO
+    @opts = Opts.new
+  end
+
+  def logger 
+    @logger
+  end
+  
+  def opts
+    @opts
+  end
+
+  def cache_dir
     PLATFORM =~ /win32/ ? win32_cache_dir : File.join(File.expand_path("~"), ".slideshow")
-end
+  end
 
-def Slideshow.win32_cache_dir
+  def win32_cache_dir
     unless File.exists?(home = ENV['HOMEDRIVE'] + ENV['HOMEPATH'])
       puts "No HOMEDRIVE or HOMEPATH environment variable.  Set one to save a" +
            "local cache of stylesheets for syntax highlighting and more."
@@ -37,46 +182,90 @@ def Slideshow.win32_cache_dir
     else
       return File.join(home, 'slideshow')
     end
-end
+  end
+
+  def load_template( name, builtin )
+    
+    if opts.has_includes? 
+      opts.includes.each do |path|
+        logger.debug "File.exists? #{path}/#{name}"
+        if File.exists?( "#{path}/#{name}" ) then         
+         
+          puts "Loading custom template #{path}/#{name}..."
+          return File.read( "#{path}/#{name}" )
+  
+        end
+      end       
+    end
+    # fallback load builtin template packaged with gem
+    load_builtin_template( builtin )
+  end
 
-def Slideshow.load_template( name )
+  def load_builtin_template( name )
+    templatesdir = "#{File.dirname(__FILE__)}/templates"
+    logger.debug "templatesdir=#{templatesdir}"
 
-  templatesdir = "#{File.dirname(__FILE__)}/templates"
-  logger.debug "templatesdir=#{templatesdir}"
+    File.read( "#{templatesdir}/#{name}" )
+  end
 
-  File.read( "#{templatesdir}/#{name}" )
-end
+  def render_template( content, b=TOPLEVEL_BINDING )
+    ERB.new( content ).result( b )
+  end
 
-def Slideshow.render_template( content, b=TOPLEVEL_BINDING )
-  ERB.new( content ).result( b )
-end
 
+  def create_slideshow_templates
+
+    if opts.s5?
+      files = [[ 's5/header.html.erb', 'header.html.erb' ],
+               [ 's5/footer.html.erb', 'footer.html.erb' ],
+               [ 's5/style.css.erb',   'style.css.erb'   ]]
+    elsif opts.fullerscreen?  # use fullerscreen templates
+      files = [[ 'header.html.erb', 'header.html.erb' ], 
+               [ 'footer.html.erb', 'footer.html.erb' ], 
+               [ 'style.css.erb',   'style.css.erb' ]]       
+    else  # use default s6 templates
+      files = [[ 's6/header.html.erb', 'header.html.erb'  ],
+               [ 's6/footer.html.erb', 'footer.html.erb'  ],
+               [ 's6/style.css.erb',   'style.css.erb'    ]]
+    end
+  
+    # background theming shared between s5/s6/fullerscreen
+    files << [ 'gradient.svg.erb',   'gradient.svg.erb' ]
+         
+    files.each do |file|
+      source = "#{File.dirname(__FILE__)}/templates/#{file[0]}"
+      dest   = "#{file[1]}"
+        
+      puts  "Copying '#{source}' to '#{dest}'"     
+      File.copy( source, dest )
+    end
+    
+    puts "Done."
+  end
 
-def Slideshow.create_slideshow( fn )
+  def create_slideshow( fn )
 
-  if get_boolean_option( 's5', false )
-    headerdoc   = load_template( 's5/header.html.erb' )
-    footerdoc   = load_template( 's5/footer.html.erb' )
-    styledoc    = load_template( 's5/style.css.erb' )
-  elsif get_boolean_option( 'fuller', false ) || get_boolean_option( 'fullerscreen', false )  # use fullerscreen templates
-    headerdoc   = load_template( 'header.html.erb' )
-    footerdoc   = load_template( 'footer.html.erb' )
-    styledoc    = load_template( 'style.css.erb' )      
+  if opts.s5?
+    headerdoc   = load_template( 'header.html.erb', 's5/header.html.erb' )
+    footerdoc   = load_template( 'footer.html.erb', 's5/footer.html.erb' )
+    styledoc    = load_template( 'style.css.erb',   's5/style.css.erb' )
+  elsif opts.fullerscreen?  # use fullerscreen templates
+    headerdoc   = load_template( 'header.html.erb', 'header.html.erb' )
+    footerdoc   = load_template( 'footer.html.erb', 'footer.html.erb' )
+    styledoc    = load_template( 'style.css.erb',   'style.css.erb' )      
   else  # use default s6 templates
-    headerdoc   = load_template( 's6/header.html.erb' )
-    footerdoc   = load_template( 's6/footer.html.erb' )
-    styledoc    = load_template( 's6/style.css.erb' )    
+    headerdoc   = load_template( 'header.html.erb', 's6/header.html.erb' )
+    footerdoc   = load_template( 'footer.html.erb', 's6/footer.html.erb' )
+    styledoc    = load_template( 'style.css.erb',   's6/style.css.erb' )    
   end
   
   # background theming shared between s5/s6/fullerscreen
-  gradientdoc = load_template( 'gradient.svg.erb' )
+  gradientdoc = load_template( 'gradient.svg.erb', 'gradient.svg.erb' )
 
   basename = File.basename( fn, '.*' )
   extname  = File.extname( fn )
 
-  known_textile_extnames = [ '.textile', '.t' ]
-  known_markdown_extnames =  [ '.markdown', '.mark', '.m', '.txt', '.text' ]
-  known_extnames = known_textile_extnames + known_markdown_extnames
+  known_extnames = KNOWN_TEXTILE_EXTNAMES + KNOWN_MARKDOWN_EXTNAMES
                 
   if extname.eql?("") then
     extname  = ".textile"   # default to .textile 
@@ -112,11 +301,11 @@ def Slideshow.create_slideshow( fn )
       value = $2.strip
     
       logger.debug "  adding option: key=>#{key}< value=>#{value}<"
-      store_option( key, value )
+      opts.put( key, value )
     elsif line =~ /^\s*$/
       content << line  unless read_headers
     else
-      read_headers =false
+      read_headers = false
       content << line
     end
   end
@@ -132,8 +321,9 @@ def Slideshow.create_slideshow( fn )
   content.gsub!( "_S9BEGIN_", "{{{" )
   content.gsub!( "_S9END_", "}}}" )
 
-  set_default_options()
-  params = Params.new( basename, $options )
+  opts.set_defaults
+  
+  params = Params.new( basename, opts )
 
   puts "Preparing slideshow theme '#{svgname}'..."
   
@@ -146,11 +336,15 @@ def Slideshow.create_slideshow( fn )
 
   # convert light-weight markup to hypertext
   
-  if known_markdown_extnames.include?( extname )
+  if KNOWN_MARKDOWN_EXTNAMES.include?( extname )
     content = Maruku.new( content, {:on_error => :raise} ).to_html
     # old code: content = BlueCloth.new( content ).to_html
   else
-    content = RedCloth.new( content ).to_html
+    # turn off hard line breaks
+    # turn off span caps (see http://rubybook.ca/2008/08/16/redcloth)
+    red = RedCloth.new( content, [:no_span_caps] )
+    red.hard_breaks = false
+    content = red.to_html
   end
   
 
@@ -194,10 +388,7 @@ def Slideshow.create_slideshow( fn )
             # todo: missing any other entities? use CGI::unescapeHTML?
             logger.debug "code=>#{code}<"
             
-            # get options using headers
-            code_line_numbers = get_boolean_option( 'code-line-numbers', true )
-            code_theme        = get_option( 'code-theme', 'amy' )
-            code_highlighted = Uv.parse( code, "xhtml", lang, code_line_numbers, code_theme )
+            code_highlighted = Uv.parse( code, "xhtml", lang, opts.code_line_numbers?, opts.code_theme )
             # old code: e.inner_html = code_highlighted
             # todo: is it ok to replace the pre.code enclosing element to avoid duplicates?
             e.swap( code_highlighted )
@@ -228,7 +419,7 @@ def Slideshow.create_slideshow( fn )
      FileUtils.mkdir(cache_dir) unless File.exists?(cache_dir) if cache_dir
      Uv.copy_files "xhtml", cache_dir
 
-     theme = get_option( 'code-theme', 'amy' )
+     theme = opts.code_theme
   
      theme_content = File.read( "#{cache_dir}/css/#{theme}.css" )
      
@@ -241,7 +432,7 @@ def Slideshow.create_slideshow( fn )
   out.close
 
   
-  if get_boolean_option( 's5', false )
+  if opts.s5?
     # copy s5 machinery to s5 folder
     # todo/fix: is there a better way to check if the dir exists?
     Dir.mkdir( 's5' ) unless File.directory?( 's5' )
@@ -254,7 +445,7 @@ def Slideshow.create_slideshow( fn )
       logger.debug "copying '#{source} ' to '#{dest}'"     
       File.copy( source, dest )
     end
-  elsif get_boolean_option( 'fuller', false ) || get_boolean_option( 'fullerscreen', false )
+  elsif opts.fullerscreen?
      # do nothing; slideshow machinery built into plugin (requires install!)
   else
     # copy s6 machinery to s6 folder
@@ -273,102 +464,48 @@ def Slideshow.create_slideshow( fn )
   puts "Done."
 end
 
-def Slideshow.logger 
-   if @@logger.nil?
-      @@logger = Logger.new(STDOUT)
-   end
-   @@logger
-end
-
-
-def Slideshow.set_default_options()
-  defaults =
-  [
-    [ 'title',             'Untitled Slide Show' ],
-    [ 'gradient-theme',    'dark' ],
-    [ 'gradient-color1',   'red' ],
-    [ 'gradient-color2',   'black' ],
-    [ 'code-theme',        'amy' ],
-    [ 'code-line-numbers', 'true' ]
-  ]
-  
-  defaults.each do | item |
-     key   = item[0]
-     value = item[1]
-     $options[ key ] = value if $options[ key ].nil?
-  end
-end
-
-def Slideshow.store_option( key, value )
-  key = key.downcase
-  if key.eql? 'code-theme' then
-    $options[ 'code-theme' ] = value.tr( '-', '_' )
-  elsif key.eql? 'gradient' then
-    values = value.split( ' ' )
-    $options[ 'gradient-theme'  ] = values[0].tr( '-', '_' )
-    $options[ 'gradient-color1' ] = values[1] if values[1] 
-    $options[ 'gradient-color2' ] = values[2] if values[2]
-  elsif key.eql? 'gradient-colors' then
-    values = value.split( ' ' )
-    $options[ 'gradient-color1' ] = values[0] 
-    $options[ 'gradient-color2' ] = values[1] if values[1]
-  elsif key.eql? 'gradient-color' then
-    $options[ 'gradient-color1' ] = value
-  elsif key.eql? 'gradient-theme' then
-    $options[ 'gradient-theme' ] = value.tr( '-', '_' )
-  else
-    $options[ key ] = value
-  end
-end
-
-def Slideshow.get_option( key, default )
-   value = $options[ key ]
-   value.nil? ? default : value
-end
-
-def Slideshow.get_boolean_option( key, default )
-   value = $options[ key ]
-   if value.nil?
-      default
-   else
-      if( value == true || value.downcase == 'true' || value.downcase == 'yes' || value.downcase == 'on' )
-         true
-      else
-         false
-      end
-   end
-end
-
-def Slideshow.main
-
-  @@logger = nil
-  $options = {}
 
-  logger.level = Logger::INFO
+def run( args )
 
-  opt=OptionParser.new do |opts|
-    opts.banner = "Usage: slideshow [options] name"
+  opt=OptionParser.new do |cmd|
+    
+    cmd.banner = "Usage: slideshow [options] name"
     
     #todo/fix: use -s5 option without optional hack? possible with OptionParser package/lib?
     # use -5 switch instead?
-    opts.on( '-s[OPTIONAL]', '--s5', 'S5 Compatible Slide Show' ) { $options[ 's5' ] = true;  }
-    opts.on( '-f[OPTIONAL]', '--fullerscreen', 'FullerScreen Compatible Slide Show' ) { $options[ 'fuller' ] = true; }
+    cmd.on( '-s[OPTIONAL]', '--s5', 'S5 Compatible Slide Show' ) { opts.put( 's5', true ) }
+    cmd.on( '-f[OPTIONAL]', '--fullerscreen', 'FullerScreen Compatible Slide Show' ) { opts.put( 'fuller', true ) }
     # opts.on( "-s", "--style STYLE", "Select Stylesheet" ) { |s| $options[:style]=s }
     # opts.on( "-v", "--version", "Show version" )  {}
-    opts.on( "-t", "--trace", "Show debug trace" ) {
+    
+    cmd.on( '-g', '--generate',  'Generate Slide Show Templates' ) { opts.put( 'generate', true ) }
+    # use -d or -o  to select output directory for slideshow or slideshow templates?
+    # cmd.on( '-d', '--directory DIRECTORY', 'Output Directory' ) { |s| opts.put( 'directory', s )  }
+    cmd.on( '-i', '--include PATH', 'Load Path' ) { |s| opts.put( 'include', s ) }
+    
+    cmd.on( "-t", "--trace", "Show debug trace" ) {
        logger.datetime_format = "%H:%H:%S"
        logger.level = Logger::DEBUG
      }
-    opts.on_tail( "-h", "--help", "Show this message" ) {
+    cmd.on_tail( "-h", "--help", "Show this message" ) {
          puts 
          puts "Slide Show (S9) is a free web alternative to PowerPoint or KeyNote in Ruby"
          puts
-         puts opts.help
+         puts cmd.help
          puts
          puts "Examples:"
          puts "  slideshow microformats"
          puts "  slideshow microformats.textile"
          puts "  slideshow -s5 microformats  # S5 compatible"
+         puts "  slideshow -f microformats   # FullerScreen compatible"
+         puts 
+         puts "More examles:"
+         puts "  slideshow -g      # Generate slide show templates"
+         puts "  slideshow -g -s5  # Generate S5 compatible slide show templates"
+         puts "  slideshow -g -f   # Generate FullerScreen compatible slide show templates"
+         puts
+         puts "  slideshow -i . microformats     # Use slide show templates in path ."
+         puts "  slideshow -i . -s5 microformats # Use S5 compatible slide show templates in path ."
          puts
          puts "Further information:"
          puts "  http://slideshow.rubyforge.org" 
@@ -376,13 +513,23 @@ def Slideshow.main
        }
   end
 
-  opt.parse!
+  opt.parse!( args )
 
-  puts "Slide Show (S9) Version: 0.5.2 on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  puts "Slide Show (S9) Version: #{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
 
-  ARGV.each { |fn| Slideshow.create_slideshow( fn ) }
+  if opts.generate?
+    create_slideshow_templates
+  else
+    args.each { |fn| create_slideshow( fn ) }
+  end
 end
 
+end # class Gen
+
+def Slideshow.main
+  Gen.new.run(ARGV)
 end
 
+end # module Slideshow
+
 Slideshow.main if __FILE__ == $0

data/lib/templates/header.html.erb

@@ -14,7 +14,7 @@
 
 <div class="layout"> 
   <div class="background">  
-    <object data="<%= @svgname %>" width="100%" height="100%">
+    <object data="<%= @svgname %>" width="100%" height="100%"></object>
   </div>    
 </div> 
 

data/lib/templates/s5/header.html.erb

@@ -23,7 +23,7 @@
 <div class="layout">
   
   <div class="background">  
-    <object data="<%= @svgname %>" width="100%" height="100%">
+    <object data="<%= @svgname %>" width="100%" height="100%"></object>
   </div>   
   
 <div id="controls"><!-- DO NOT EDIT --></div>

data/lib/templates/s6/header.html.erb

@@ -23,6 +23,7 @@
   
   <div class="background">  
     <object data="<%= @svgname %>" width="100%" height="100%">
+		</object>
   </div>   
   
 <div id="controls"><!-- DO NOT EDIT --></div>

data/lib/templates/s6/outline.css

@@ -1,6 +1,6 @@
 /* don't change this unless you want the layout stuff to show up in the outline view! */
 
-.layout *, #footer *, #navLinks * { display: none; }
+.layout > *, #controls *, #footer *, #navLinks * { display: none; }
 
 #controls, #navLinks, #toggle {
   display: block; visibility: visible; margin: 0; padding: 0;}

data/lib/templates/s6/slides.js

@@ -178,7 +178,7 @@ $(document).ready(function(){
         
   if( $.browser.msie )
         {
-          $( '.layout *').hide();
+          $( '.layout > *').hide();
           $( '.presentation').hide();
           
           $( '#microsoft' ).show();          

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: slideshow
 version: !ruby/object:Gem::Version 
-  version: 0.5.2
+  version: "0.6"
 platform: ruby
 authors: 
 - Gerald Bauer
@@ -9,12 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-22 00:00:00 -07:00
+date: 2008-08-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: RedCloth
-  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -24,7 +23,6 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: maruku
-  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -34,7 +32,6 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: hpricot
-  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -44,7 +41,6 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: ultraviolet
-  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -53,7 +49,7 @@ dependencies:
         version: 0.10.2
     version: 
 description: 
-email: geraldbauer2007@gmail.com
+email: webslideshow@googlegroups.com
 executables: 
 - slideshow
 extensions: []
@@ -108,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: slideshow
-rubygems_version: 1.2.0
+rubygems_version: 1.1.1
 signing_key: 
 specification_version: 2
 summary: Slide Show (S9) - A Free Web Alternative to PowerPoint and KeyNote in Ruby