slideshow 0.7.8 → 0.8

data/History.txt

@@ -1,6 +1,13 @@
+=== 0.8 / 2009-03-14
+
+* Added -f/--fetch URI option; lets you fetch templates from the internet
+* Added -l/--list option; list all installed templates
+* Added -c/--config PATH option; lets you set config folder (default is ~/.slideshow)
+* Moved S5 v11 blank package out of core/gem
+
 === 0.7.8 / 2009-03-09
 
-* Adding SLIDESHOWOPT env variable; lets you set default command line options (e.g. -o slides)
+* Added SLIDESHOWOPT env variable; lets you set default command line options (e.g. -o slides)
 * Using Hoe Rake tasks to manage gem; adding required files and build script
 * Move templates folder to top-level (out of lib/)
 * Minor code clean-up

data/Manifest.txt

@@ -28,22 +28,6 @@ templates/s5/print.css
 templates/s5/s5-core.css
 templates/s5/slides.js
 templates/s5/style.css.erb
-templates/s5blank.txt.gen
-templates/s5blank.txt.sample
-templates/s5blank/blank.textile
-templates/s5blank/footer.html.erb
-templates/s5blank/header.html.erb
-templates/s5blank/ui/default/blank.gif
-templates/s5blank/ui/default/bodybg.gif
-templates/s5blank/ui/default/framing.css
-templates/s5blank/ui/default/iepngfix.htc
-templates/s5blank/ui/default/opera.css
-templates/s5blank/ui/default/outline.css
-templates/s5blank/ui/default/pretty.css
-templates/s5blank/ui/default/print.css
-templates/s5blank/ui/default/s5-core.css
-templates/s5blank/ui/default/slides.css
-templates/s5blank/ui/default/slides.js
 templates/s6.txt
 templates/s6.txt.gen
 templates/s6.txt.sample

data/README.txt

@@ -14,22 +14,35 @@ The Slide Show (S9) project also collects and welcomes themes and ships
 == SYNOPSIS:
 
   Usage: slideshow [options] name
- 
+    -o, --output PATH                Output Path
+    -g, --generate                   Generate Slide Show Templates
+    -t, --template MANIFEST          Template Manifest
+        --s5                         S5-Compatible Slide Show (same as -t s5.txt)
+        --fullerscreen               FullerScreen-Compatible Slide Show (same as -t fullerscreen.txt)
+    -f, --fetch URI                  Fetch Templates
+    -c, --config PATH                Configuration Path (default is ~/.slideshow)
+    -l, --list                       List Installed Templates
+    -v, --verbose                    Show debug trace
+    -h, --help                       Show this message
+
 Examples:
 
   slideshow microformats
   slideshow microformats.textile
-  slideshow -s5 microformats       # S5 compatible
-  slideshow -f microformats        # FullerScreen compatible
-  slideshow -o slides microformats # Output slideshow to slides folder
+  slideshow -o slides microformats       # Output slideshow to slides folder
+  slideshow --s5 microformats            # Use S5-compatible slide show templates
+  slideshow --fullerscreen microformats  # Use FullerScreen-compatible slide show templates
 
 More examles:
 
-  slideshow -g      # Generate slide show templates
-  slideshow -g -s5  # Generate S5 compatible slide show templates
-  slideshow -g -f   # Generate FullerScreen compatible slide show templates
+  slideshow -g                           # Generate slide show templates
+  slideshow -g --s5                      # Generate S5 compatible slide show templates
+  slideshow -g --fullerscreen            # Generate FullerScreen compatible slide show templates
+
+  slideshow -l                           # List installed slide show templates
+  slideshow -f s5blank                   # Fetch (install) S5 blank starter template from internet
+  slideshow -t s5blank.txt microformats  # Use your own slide show templates (e.g. s5blank.txt)
 
-  slideshow -t s3.txt microformats     # Use custom slide show templates
 
 == REQUIREMENTS:
 

data/lib/slideshow.rb

@@ -10,6 +10,8 @@ require 'logger'
 require 'fileutils'
 require 'ftools'
 require 'pp'
+require 'uri'
+require 'net/http'
 
 # required gems
 require 'redcloth'
@@ -20,7 +22,7 @@ require 'slideshow/gen'
 
 module Slideshow
 
-  VERSION = '0.7.8'
+  VERSION = '0.8'
 
   def Slideshow.main
     

data/lib/slideshow/gen.rb

@@ -22,40 +22,21 @@ class Gen
     [ 'bluecloth',      lambda { |content| BlueCloth.new( content ).to_html } ]
   ] 
   
-  BUILTIN_MANIFESTS       = [ 'fullerscreen.txt', 'fullerscreen.txt.gen',
-                              's5.txt', 's5.txt.gen',
-                              's6.txt', 's6.txt.gen',
-                              's5blank.txt.gen' ]
-  
   def initialize
     @logger = Logger.new(STDOUT)
     @logger.level = Logger::INFO
     @opts = Opts.new
   end
 
-  # replace w/ attr_reader :logger, :opts ??
-
-  def logger 
-    @logger
-  end
-  
-  def opts
-    @opts
-  end
+  attr_reader :logger, :opts
+  attr_reader :session      # give helpers/plugins a session-like hash
   
   def headers
     # give access to helpers to opts with a different name
     @opts
   end
-  
-  def session
-    # give helpers/plugins a session-like hash
-    @session
-  end
-  
-  def markup_type
-    @markup_type   # :textile, :markdown
-  end
+
+  attr_reader :markup_type  # :textile, :markdown
   
   def load_markdown_libs
     # check for available markdown libs/gems
@@ -108,29 +89,30 @@ class Gen
            "local cache of stylesheets for syntax highlighting and more."
       return false
     else
-      return File.join(home, 'slideshow')
+      return File.join(home, '.slideshow')
     end
   end
-
-  def load_manifest( path )
+  
+  def config_dir
+    unless @config_dir  # first time? calculate config_dir value to "cache"
+      
+      if opts.config_path
+        @config_dir = opts.config_path
+      else
+        @config_dir = cache_dir
+      end
     
-    # check if file exists (if yes use custom template package!) - allows you to override builtin package with same name
-    if BUILTIN_MANIFESTS.include?( path ) && !File.exists?( path )  
-      templatesdir = "#{File.dirname( LIB_PATH )}/templates"
-      logger.debug "use builtin template package"
-      logger.debug "templatesdir=#{templatesdir}"
-      filename = "#{templatesdir}/#{path}"
-    else
-      templatesdir = File.dirname( path )
-      logger.debug "use custom template package"
-      logger.debug "templatesdir=#{templatesdir}"
-      filename = path
+      # make sure path exists
+      File.makedirs( @config_dir ) unless File.directory? @config_dir
     end
-  
+    
+    @config_dir
+  end
+
+  def load_manifest_core( path )
     manifest = []
-    puts "  Loading template manifest #{filename}..." 
   
-    File.open( filename ).readlines.each_with_index do |line,i|
+    File.open( path ).readlines.each_with_index do |line,i|
       case line
       when /^\s*$/
         # skip empty lines
@@ -142,13 +124,7 @@ class Gen
         
         # add source for shortcuts (assumes relative path; if not issue warning/error)
         values << values[0] if values.size == 1
-        
-        # normalize all source paths (1..-1) /make full path/add template dir
-        (1..values.size-1).each do |i|
-          values[i] = "#{templatesdir}/#{values[i]}"
-          logger.debug "  path[#{i}]=>#{values[i]}<"
-        end
-        
+                
         manifest << values
       end      
     end
@@ -156,6 +132,79 @@ class Gen
     manifest
   end
 
+  def load_manifest( path )
+        
+    filename = path
+ 
+    puts "  Loading template manifest #{filename}..."  
+    manifest = load_manifest_core( filename )
+    
+    # post-processing
+    # normalize all source paths (1..-1) /make full path/add template dir
+
+    templatesdir = File.dirname( path )
+    logger.debug "templatesdir=#{templatesdir}"
+
+    manifest.each do |values|
+      (1..values.size-1).each do |i|
+        values[i] = "#{templatesdir}/#{values[i]}"
+        logger.debug "  path[#{i}]=>#{values[i]}<"
+      end
+    end
+             
+    manifest
+  end
+
+  def find_manifests( patterns )
+    manifests = []
+    
+    patterns.each do |pattern|
+      pattern.gsub!( '\\', '/')  # normalize path; make sure all path use / only
+      logger.debug "Checking #{pattern}"
+      Dir.glob( pattern ) do |file|
+        logger.debug "  Found manifest: #{file}"
+        manifests << [ File.basename( file ), file ]
+      end    
+    end
+    
+    manifests
+  end
+
+  def installed_generator_manifests
+    # 1) search gem/templates 
+
+    builtin_patterns = [
+      "#{File.dirname( LIB_PATH )}/templates/*.txt.gen"
+    ]
+
+    find_manifests( builtin_patterns )
+  end
+
+  def installed_template_manifests
+    # 1) search ./templates
+    # 2) search config_dir/templates
+    # 3) search gem/templates
+
+    builtin_patterns = [
+      "#{File.dirname( LIB_PATH )}/templates/*.txt"
+    ]
+    config_patterns  = [
+      "#{config_dir}/templates/*.txt",
+      "#{config_dir}/templates/*/*.txt"
+    ]
+    current_patterns = [
+      "templates/*.txt",
+      "templates/*/*.txt"
+    ]
+    
+    patterns = []
+    patterns += current_patterns  unless LIB_PATH == File.expand_path( 'lib' )  # don't include working dir if we test code from repo (don't include slideshow/templates)
+    patterns += config_patterns
+    patterns += builtin_patterns
+ 
+    find_manifests( patterns )
+  end
+
   def load_template( path ) 
     puts "  Loading template #{path}..."
     return File.read( path )
@@ -192,10 +241,112 @@ class Gen
     File.makedirs( dest_path ) unless File.directory? dest_path
     dest_full
   end
+  
+
+  def fetch_file( dest, src )
+    logger.debug "fetch( dest: #{dest}, src: #{src})"
+
+    uri = URI.parse( src )
+  
+    # todo: add our own agent HTTP header for identification?
+    response = Net::HTTP.get_response( uri )
+
+    unless response.code == '200'   # note: responsoe.code is a string
+      msg = "#{response.code} #{response.message}" 
+      puts "*** error: #{msg}"
+      return   # todo: throw StandardException?
+    end
+
+    logger.debug "  content_type: #{response.content_type}, content_length: #{response.content_length}"
+  
+    # check for content type; use 'wb' for images
+    if response.content_type =~ /image/
+		  logger.debug '  switching to binary'
+		  flags = 'wb'
+    else
+      flags = 'w'
+    end
+  
+    File.open( dest, flags ) do |f|
+		  f.write( response.body )	
+	  end
+  end
+  
+  
+  def fetch_slideshow_templates
+    logger.debug "fetch_uri=#{opts.fetch_uri}"
+    
+    src = opts.fetch_uri 
+    # src = 'http://github.com/geraldb/slideshow/raw/d98e5b02b87ee66485431b1bee8fb6378297bfe4/code/templates/fullerscreen.txt'
+    # src = 'http://github.com/geraldb/sandbox/raw/13d4fec0908fbfcc456b74dfe2f88621614b5244/s5blank/s5blank.txt'
+    uri = URI.parse( src )
+  
+    logger.debug "host: #{uri.host}, port: #{uri.port}, path: #{uri.path}"
+  
+    dirname  = File.dirname( uri.path )    
+    basename = File.basename( uri.path, '.*' ) # e.g. fullerscreen     (without extension)
+    filename = File.basename( uri.path )       # e.g. fullerscreen.txt (with extension)
+
+    logger.debug "dirname: #{dirname}"
+    logger.debug "basename: #{basename}, filename: #{filename}"
+
+    dlbase = "http://#{uri.host}:#{uri.port}#{dirname}"
+    pkgpath = File.expand_path( "#{config_dir}/templates/#{basename}" )
+  
+    logger.debug "dlpath: #{dlbase}"
+    logger.debug "pkgpath: #{pkgpath}"
+  
+    File.makedirs( pkgpath ) unless File.directory? pkgpath 
+   
+    puts "Fetching template package '#{basename}'"
+    puts "  : from '#{dlbase}'"
+    puts "  : saving to '#{pkgpath}'"
+  
+    # download manifest
+    dest = "#{pkgpath}/#{filename}"
+
+    puts "  Downloading manifest '#{filename}'..."
+
+    fetch_file( dest, src )
+
+    manifest = load_manifest_core( dest )
+      
+    # download templates listed in manifest
+    manifest.each do |values|
+      values[1..-1].each do |file|
+      
+        dest = "#{pkgpath}/#{file}"
+
+        # make sure path exists
+        destpath = File.dirname( dest )
+        File.makedirs( destpath ) unless File.directory? destpath
+    
+        src = "#{dlbase}/#{file}"
+    
+        puts "  Downloading template '#{file}'..."
+        fetch_file( dest, src )
+      end
+    end   
+    puts "Done."  
+  end
 
   def create_slideshow_templates
-    logger.debug "manifest=#{opts.manifest}.gen"
-    manifest = load_manifest( opts.manifest+".gen" )
+    
+    manifest_name = opts.manifest 
+    logger.debug "manifest=#{manifest_name}"
+    
+    manifests = installed_generator_manifests
+    
+    # check for builtin generator manifests
+    matches = manifests.select { |m| m[0] == manifest_name+".gen" }
+    
+    if matches.empty?
+      puts "*** error: unknown template manifest '#{manifest_name}'"  
+      # todo: list installed manifests
+      exit 2
+    end
+        
+    manifest = load_manifest( matches[0][1] )
 
     # expand output path in current dir and make sure output path exists
     outpath = File.expand_path( opts.output_path ) 
@@ -212,13 +363,40 @@ class Gen
     
     puts "Done."   
   end
+  
+  def list_slideshow_templates
+    manifests = installed_template_manifests
+    
+    puts ''
+    puts 'Installed templates include:'
+    
+    manifests.each do |manifest|
+      puts "  #{manifest[0]} (#{manifest[1]})"
+    end
+  end
 
   def create_slideshow( fn )
 
-    logger.debug "manifest=#{opts.manifest}"
-    manifest = load_manifest( opts.manifest )
-    # pp manifest
-
+    manifest_path_or_name = opts.manifest
+    logger.debug "manifest=#{manifest_path_or_name}"
+    
+    # check if file exists (if yes use custom template package!) - allows you to override builtin package with same name 
+    if File.exists?( manifest_path_or_name )
+      manifest = load_manifest( manifest_path_or_name )
+    else
+      # check for builtin manifests
+      manifests = installed_template_manifests
+      matches = manifests.select { |m| m[0] == manifest_path_or_name } 
+
+      if matches.empty?
+        puts "*** error: unknown template manifest '#{manifest_path_or_name}'"  
+        # todo: list installed manifests
+        exit 2
+      end
+        
+      manifest = load_manifest( matches[0][1] )
+    end
+  
     # expand output path in current dir and make sure output path exists
     outpath = File.expand_path( opts.output_path ) 
     logger.debug "outpath=#{outpath}"
@@ -382,23 +560,20 @@ class Gen
 end
 
 def load_plugins
+    
+  patterns = []
+  patterns << "#{config_dir}/lib/**/*.rb"
+  patterns << 'lib/**/*.rb' unless LIB_PATH == File.expand_path( 'lib' )  # don't include lib if we are in repo (don't include slideshow/lib)
   
-  # use lib folder unless we're in our very own folder 
-  #  (that already uses lib for its core functionality), thus, use plugins instead  
-  if( LIB_PATH == 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}"
+  patterns.each do |pattern|
+    pattern.gsub!( '\\', '/')  # normalize path; make sure all path use / only
+    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
 end
@@ -413,7 +588,7 @@ def run( args )
 
     cmd.on( '-g', '--generate',  'Generate Slide Show Templates' ) { opts.put( 'generate', true ) }
     
-    cmd.on( "-t", "--template TEMPLATE", "Template Manifest" ) do |t|
+    cmd.on( "-t", "--template MANIFEST", "Template Manifest" ) do |t|
       # todo: do some checks on passed in template argument
       opts.put( 'manifest', t )
     end
@@ -429,6 +604,16 @@ def run( args )
         
     # ?? cmd.on( '-i', '--include PATH', 'Load Path' ) { |s| opts.put( 'include', s ) }
 
+    cmd.on( '-f', '--fetch URI', 'Fetch Templates' ) do |u|
+      opts.put( 'fetch_uri', u )
+    end
+    
+    cmd.on( '-c', '--config PATH', 'Configuration Path (default is ~/.slideshow)' ) do |p|
+      opts.put( 'config_path', p )
+    end
+    
+    cmd.on( '-l', '--list', 'List Installed Templates' ) { opts.put( 'list', true ) }
+
     # todo: find different letter for debug trace switch (use v for version?)
     cmd.on( "-v", "--verbose", "Show debug trace" )  do
        logger.datetime_format = "%H:%H:%S"
@@ -452,10 +637,10 @@ def run( args )
          puts "  slideshow -g                           # Generate slide show templates"
          puts "  slideshow -g --s5                      # Generate S5 compatible slide show templates"
          puts "  slideshow -g --fullerscreen            # Generate FullerScreen compatible slide show templates"
-         puts "  slideshow -g -t s5blank.txt            # Generate S5 blank starter templates"
-         puts
-         puts "  slideshow -t s3.txt microformats       # Use your own slide show templates (e.g. s3.txt)"
          puts
+         puts "  slideshow -l                           # List installed slide show templates"
+         puts "  slideshow -f s5blank                   # Fetch (install) S5 blank starter template from internet"
+         puts "  slideshow -t s5blank.txt microformats  # Use your own slide show templates (e.g. s5blank.txt)"
          puts
          puts "Further information:"
          puts "  http://slideshow.rubyforge.org" 
@@ -467,8 +652,12 @@ def run( args )
 
   puts "Slide Show (S9) Version: #{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
 
-  if opts.generate?
+  if opts.list?
+    list_slideshow_templates
+  elsif opts.generate?
     create_slideshow_templates
+  elsif opts.fetch?
+    fetch_slideshow_templates
   else
     load_markdown_libs
     load_plugins  # check for optional plugins/extension in ./lib folder