slideshow 1.2.4 → 1.2.5

data/README.markdown

@@ -1,6 +1,11 @@
-# Slide Show (S9) - A Free Web Alternative to PowerPoint and KeyNote in Ruby
+# Slide Show (S9) - A Free Web Alternative to PowerPoint and Keynote in Ruby
+
+* docu   :: [slideshow-s9.github.io](http://slideshow-s9.github.io)
+* source :: [github.com/geraldb/slideshow](https://github.com/geraldb/slideshow)
+* bugs   :: [github.com/geraldb/slideshow/issues](https://github.com/geraldb/slideshow/issues)
+* gem    :: [rubygems.org/gems/slideshow](https://rubygems.org/gems/slideshow)
+* rdoc   :: [rubydoc.info/gems/slideshow](http://rubydoc.info/gems/slideshow)
 
-* [`slideshow.rubyforge.org`](http://slideshow.rubyforge.org)
 
 ## DESCRIPTION
 
@@ -11,7 +16,7 @@ The Slide Show (S9) project also collects and welcomes themes and ships
 
 ## SYNOPSIS
 
-    Slide Show (S9) is a free web alternative to PowerPoint or KeyNote in Ruby
+    Slide Show (S9) is a free web alternative to PowerPoint or Keynote in Ruby
     
     Usage: slideshow [options] name
       -o, --output PATH                Output Path (default is .)

data/Rakefile

@@ -2,13 +2,12 @@ require 'hoe'
 require './lib/slideshow/version.rb'
 
 Hoe.spec 'slideshow' do
-  
+
   self.version = Slideshow::VERSION
-  
-  self.summary = 'Slide Show (S9) - A Free Web Alternative to PowerPoint and KeyNote in Ruby'
-  self.urls     = ['http://slideshow.rubyforge.org']
-  
-  
+
+  self.summary = 'Slide Show (S9) - A Free Web Alternative to PowerPoint and Keynote in Ruby'
+  self.urls     = ['http://slideshow-s9.github.io']
+
   self.author  = 'Gerald Bauer'
   self.email   = 'webslideshow@googlegroups.com'
   
@@ -18,9 +17,10 @@ Hoe.spec 'slideshow' do
     ['textutils','>= 0.2.0'],
     ['pakman','>= 0.4.0'],
     ['activesupport', '>= 3.2.6'],
-    ['RedCloth','>= 4.2.9']
+    ['RedCloth','>= 4.2.9'],
+    ['logutils','>=0.6.0']
   ]
-    
+
   # switch extension to .markdown for gihub formatting
   self.readme_file  = 'README.markdown'
   self.history_file = 'History.markdown'

data/lib/slideshow.rb

@@ -3,14 +3,13 @@
 ###
 # NB: for local testing run like:
 #
-# 1.8.x: ruby -Ilib -rrubygems lib/slideshow.rb
 # 1.9.x: ruby -Ilib lib/slideshow.rb
 
 
 # core and stlibs
 require 'optparse'
 require 'erb'
-require 'logger'
+require 'logger'               # todo: remove!! replaced by logutils gem
 require 'fileutils'
 require 'pp'
 require 'uri'
@@ -24,6 +23,8 @@ require 'cgi'
 # required gems
 require 'active_support/all'
 
+require 'logutils'       # logger utils library
+
 require 'redcloth'          # default textile library
 require 'markdown'          # default markdown library
 require 'fetcher'           # fetch docs and blogs via http, https, etc.

data/lib/slideshow/cli/commands/fetch.rb

@@ -4,13 +4,14 @@ class Fetch
 
 ### fix: remove opts, use config (wrapped!!)
   
-  def initialize( logger, opts, config )
-    @logger  = logger
+  include LogUtils::Logging
+  
+  def initialize( opts, config )
     @opts    = opts
     @config  = config
   end
 
-  attr_reader :logger, :opts, :config
+  attr_reader :opts, :config
 
 
   def run

data/lib/slideshow/cli/commands/gen.rb

@@ -1,22 +1,32 @@
+# encoding: utf-8
+
 module Slideshow
 
 ## fix:/todo: move generation code out of command into its own class
 ##   not residing/depending on cli
 
-class Gen
+class Gen     ## todo: rename command to build
+
+  include LogUtils::Logging
 
   include ManifestHelper
 
 ### fix: remove opts, use config (wrapped!!)
 
-  def initialize( logger, opts, config, headers )
-    @logger  = logger
+  def initialize( opts, config, headers )
     @opts    = opts
     @config  = config
     @headers = headers
+    
+    ## todo: check if we need to use expand_path - Dir.pwd always absolute (check ~/user etc.)
+    @usrdir = File.expand_path( Dir.pwd )  # save original (current) working directory 
   end
 
-  attr_reader :logger, :opts, :config, :headers
+  attr_reader :usrdir   # original working dir (user called slideshow from)
+  attr_reader :srcdir, :outdir, :pakdir    # NB: "initalized" in create_slideshow
+
+
+  attr_reader :opts, :config, :headers
   attr_reader :session      # give helpers/plugins a session-like hash
 
   attr_reader :markup_type  # :textile, :markdown, :rest
@@ -75,12 +85,14 @@ class Gen
   ##   from helpers
   ##  fix: cleanup and remove
 
-  def load_template( path ) 
+  def load_template( path )
+    puts "*** depreceated api - load_template() - use Pakman gem api"
     puts "  Loading template #{path}..."
     return File.read( path )
   end
   
   def render_template( content, the_binding )
+    puts "*** depreceated api - render_template() - use Pakman gem api"
     ERB.new( content ).result( the_binding )
   end
 
@@ -211,12 +223,12 @@ class Gen
     ##   do NOT default to cwd (because cwd will change!)
     
     # Reference src with absolute path, because this can be used with different pwd
-    manifestsrc = File.expand_path(manifestsrc)
+    manifestsrc = File.expand_path( manifestsrc, usrdir )
 
     # expand output path in current dir and make sure output path exists
-    outpath = File.expand_path( opts.output_path ) 
-    logger.debug "outpath=#{outpath}"
-    FileUtils.makedirs( outpath ) unless File.directory? outpath 
+    @outdir = File.expand_path( opts.output_path, usrdir )
+    logger.debug "setting outdir to >#{outdir}<"
+    FileUtils.makedirs( outdir ) unless File.directory? outdir
 
     dirname  = File.dirname( fn )
     basename = File.basename( fn, '.*' )
@@ -225,20 +237,13 @@ class Gen
 
     # change working dir to sourcefile dir
     # todo: add a -c option to commandline? to let you set cwd?
-    
-    newcwd  = File.expand_path( dirname )
-    oldcwd  = File.expand_path( Dir.pwd )
-
-    # check: assume pwd is always absolute?? check for home dir e.g. will use ~/ ?? or not?
-    # todo: use for File.expand_path
-    # fix: use ordir n srcdir etec instead of newcwd and oldcwd - 
-    srcdir_restore = File.expand_path( dirname )
-    orgdir_restore = File.expand_path( Dir.pwd )
-
-    unless newcwd == oldcwd then
-      logger.debug "oldcwd=#{oldcwd}"
-      logger.debug "newcwd=#{newcwd}"
-      Dir.chdir newcwd
+
+    @srcdir = File.expand_path( dirname, usrdir )
+    logger.debug "setting srcdir to >#{srcdir}<"
+
+    unless usrdir == srcdir
+      logger.debug "changing cwd to src - new >#{srcdir}<, old >#{Dir.pwd}<"
+      Dir.chdir srcdir
     end
 
     puts "Preparing slideshow '#{basename}'..."
@@ -300,33 +305,28 @@ class Gen
   #  nb: change cwd to template pak root
 
   @pakdir = File.dirname( manifestsrc )  # template pak root - make availabe too in erb via binding
-  logger.debug "  pakdir=>#{@pakdir}<"
+  logger.debug " setting pakdir to >#{pakdir}<"
 
   #  todo/fix: change current work dir (cwd) in pakman gem itself
   #   for now lets do it here
 
-  logger.debug "changing cwd to pak dir - oldcwd=>#{Dir.pwd}<, newcwd=>#{@pakdir}<"
-  Dir.chdir( @pakdir )
+  logger.debug "changing cwd to pak - new >#{pakdir}<, old >#{Dir.pwd}<"
+  Dir.chdir( pakdir )
 
 
-  pakpath     = opts.output_path
+  pakpath     = outdir
 
-  # expand output path in current dir and make sure output path exists
-  pakpath = File.expand_path( pakpath, orgdir_restore )
-  logger.debug "pakpath=#{pakpath}"
-  FileUtils.makedirs( pakpath ) unless File.directory? pakpath
+  logger.debug( "manifestsrc >#{manifestsrc}<, pakpath >#{pakpath}<" )
 
-  logger.debug( "manifestsrc=>#{manifestsrc}<, pakpath=>#{pakpath}<" )
-    
   Pakman::Templater.new( logger ).merge_pak( manifestsrc, pakpath, binding, basename )
 
-  logger.debug "restoring cwd to src dir - oldcwd=>#{Dir.pwd}<, newcwd=>#{srcdir_restore}<"
-  Dir.chdir( srcdir_restore )
+  logger.debug "restoring cwd to src - new >#{srcdir}<, old >#{Dir.pwd}<"
+  Dir.chdir( srcdir )
 
   ## pop/restore org (original) working folder/dir
-  unless newcwd == oldcwd
-    logger.debug "restoring cwd to org dir - oldcwd=>#{oldcwd}<, newcwd=>#{newcwd}<"
-    Dir.chdir( oldcwd )
+  unless usrdir == srcdir
+    logger.debug "restoring cwd to usr - new >#{usrdir}<, old >#{Dir.pwd}<"
+    Dir.chdir( usrdir )
   end
 
   puts "Done."

data/lib/slideshow/cli/commands/gen_templates.rb

@@ -3,15 +3,16 @@ module Slideshow
 class GenTemplates
 
 
+  include LogUtils::Logging
+
 ### fix: remove opts, use config (wrapped!!)
 
-  def initialize( logger, opts, config )
-    @logger  = logger
+  def initialize( opts, config )
     @opts    = opts
     @config  = config
   end
 
-  attr_reader :logger, :opts, :config
+  attr_reader :opts, :config
 
   def run
     manifest_name = opts.manifest

data/lib/slideshow/cli/commands/list.rb

@@ -2,17 +2,18 @@ module Slideshow
 
 class List
 
+  include LogUtils::Logging
+
   include ManifestHelper
 
 ### fix: remove opts, use config (wrapped!!)
   
-  def initialize( logger, opts, config )
-    @logger  = logger
+  def initialize( opts, config )
     @opts    = opts
     @config  = config
   end
 
-  attr_reader :logger, :opts, :config
+  attr_reader :opts, :config
 
   def run
     home = Env.home

data/lib/slideshow/cli/commands/plugins.rb

@@ -2,17 +2,18 @@ module Slideshow
 
 class Plugins
 
+  include LogUtils::Logging
+
   include PluginHelper
 
 ### fix: remove opts, use config (wrapped!!)
   
-  def initialize( logger, opts, config )
-    @logger  = logger
+  def initialize( opts, config )
     @opts    = opts
     @config  = config
   end
 
-  attr_reader :logger, :opts, :config
+  attr_reader :opts, :config
 
   def run
     puts ''

data/lib/slideshow/cli/commands/quick.rb

@@ -2,17 +2,18 @@ module Slideshow
 
 class Quick
 
+  include LogUtils::Logging
+
   include ManifestHelper
 
 ### fix: remove opts, use config (wrapped!!)
 
-  def initialize( logger, opts, config )
-    @logger  = logger
+  def initialize( opts, config )
     @opts    = opts
     @config  = config
   end
 
-  attr_reader :logger, :opts, :config
+  attr_reader :opts, :config
 
   def run
     manifest_name = opts.quick_manifest.gsub('.txt','').gsub('.quick','')  # make sure we get name w/o .quick and .txt extension

data/lib/slideshow/cli/opts.rb

@@ -30,6 +30,15 @@ class Opts
     @takahashi == true
   end
 
+  def verbose=(boolean)   # add: alias for debug ??
+    @verbose = boolean
+  end
+
+  def verbose?
+    return false if @verbose.nil?   # default verbose/debug flag is false
+    @verbose == true
+  end
+
 
   def quick=(boolean)
     @quick = boolean
@@ -77,10 +86,10 @@ class Opts
     @list == true
   end
 
- def fetch_all=(boolean)
+  def fetch_all=(boolean)
     @fetch_all = boolean
   end
-  
+
   def fetch_all?
     return false if @fetch_all.nil?  # default fetch all flag is false
     @fetch_all == true

data/lib/slideshow/cli/runner.rb

@@ -2,18 +2,21 @@ module Slideshow
 
 class Runner
 
+  include LogUtils::Logging
+
   include PluginHelper
 
-  def initialize
-    @logger = Logger.new(STDOUT)
-    @logger.level = Logger::INFO
 
+  def initialize
     @opts    = Opts.new
-    @config  = Config.new( @logger, @opts )
+    @config  = Config.new( @opts )
     @headers = Headers.new( @config )
+    
+    ## todo/fix: move into slideshow loader script - why? why not?
+    LogUtils::Logger.root.level = :info
   end
 
-  attr_reader :logger, :opts, :config, :headers
+  attr_reader :opts, :config, :headers
 
 
   def find_file_with_known_extension( fn )
@@ -124,7 +127,7 @@ def run( args )
     cmd.on( "-h", "--help", "Show this message" ) do
          puts <<EOS
          
-Slide Show (S9) is a free web alternative to PowerPoint or KeyNote in Ruby
+Slide Show (S9) is a free web alternative to PowerPoint or Keynote in Ruby
 
 #{cmd.help}
 
@@ -144,8 +147,8 @@ More examles:
   slideshow -t s5blank microformats      # Use your own slide show templates (e.g. s5blank)
 
 Further information:
-  http://slideshow.rubyforge.org
-  
+  http://slideshow-s9.github.io
+
 EOS
          exit
     end
@@ -191,17 +194,17 @@ EOS
 
 
     cmd.on( "--verbose", "(Debug) Show debug trace" )  do
-       logger.datetime_format = "%H:%H:%S"
-       logger.level = Logger::DEBUG
+       LogUtils::Logger.root.level = :debug
+       opts.verbose = true
     end
-        
+
   end
 
   opt.parse!( args )
   
   puts Slideshow.generator
 
-  if logger.level == Logger::DEBUG
+  if opts.verbose?
     # dump Slideshow settings
     config.dump
     puts
@@ -212,15 +215,15 @@ EOS
   end
 
   if opts.list?
-    List.new( logger, opts, config ).run   ### todo: remove opts (merge access into config)
+    List.new( opts, config ).run   ### todo: remove opts (merge access into config)
   elsif opts.plugins?
-    Plugins.new( logger, opts, config ).run  ### todo: remove opts (merge access into config)
+    Plugins.new( opts, config ).run  ### todo: remove opts (merge access into config)
   elsif opts.generate?
-    GenTemplates.new( logger, opts, config ).run  ###  todo: remove opts
+    GenTemplates.new( opts, config ).run  ###  todo: remove opts
   elsif opts.quick?
-    Quick.new( logger, opts, config ).run  ### todo: remove opts
+    Quick.new( opts, config ).run  ### todo: remove opts
   elsif opts.fetch? || opts.fetch_all?
-    Fetch.new( logger, opts, config ).run  ### todo: remove opts
+    Fetch.new( opts, config ).run  ### todo: remove opts
   else
     load_plugins  # check for optional plugins/extension in ./lib folder
 
@@ -228,7 +231,7 @@ EOS
       files = find_files( arg )
       files.each do |file| 
        ### fix/todo: reset/clean headers
-        Gen.new( logger, opts, config, headers ).create_slideshow( file )
+        Gen.new( opts, config, headers ).create_slideshow( file )
       end
     end
   end

data/lib/slideshow/config.rb

@@ -1,13 +1,14 @@
 module Slideshow
 
 class Config
-  
-  def initialize( logger, opts )
-    @logger = logger
+
+  include LogUtils::Logging
+
+  def initialize( opts )
     @opts   = opts
   end
 
-  attr_reader :logger, :opts
+  attr_reader :opts
 
   def header_level
     @opts.header_level

data/lib/slideshow/filters/debug_filter.rb

@@ -6,14 +6,18 @@ module Slideshow
 
 def dump_content_to_file_debug_text_erb( content )
 
-  return content   unless logger.level == Logger::DEBUG
+  # NB: using attribs from mixed in class
+  #   - opts
+  #   - outdir
 
-  outname = "#{@name}.debug.text.erb"
+  return content   unless opts.verbose?
+
+  outname = "#{outdir}/#{@name}.debug.text.erb"
 
   puts "  Dumping content before erb merge to #{outname}..."
 
   File.open( outname, 'w' ) do |f|
-    f.write( content )	
+    f.write( content )
   end
 
   content
@@ -23,14 +27,18 @@ end
 
 def dump_content_to_file_debug_html( content )
 
-  return content   unless logger.level == Logger::DEBUG
+  # NB: using attribs from mixed in class
+  #   - opts
+  #   - outdir
+
+  return content   unless opts.verbose?
 
-  outname = "#{@name}.debug.html"
+  outname = "#{outdir}/#{@name}.debug.html"
 
   puts "  Dumping content before html post processing to #{outname}..."
 
   File.open( outname, 'w' ) do |f|
-    f.write( content )	
+    f.write( content )
   end
 
   content
@@ -40,14 +48,18 @@ end
 
 def dump_content_to_file_debug_text( content )
 
-  return content   unless logger.level == Logger::DEBUG
+  # NB: using attribs from mixed in class
+  #   - opts
+  #   - outdir
+
+  return content   unless opts.verbose?
 
-  outname = "#{@name}.debug.text"
+  outname = "#{outdir}/#{@name}.debug.text"
 
   puts "  Dumping content before text-to-html conversion to #{outname}..."
 
   File.open( outname, 'w' ) do |f|
-    f.write( content )	
+    f.write( content )
   end
 
   content

data/lib/slideshow/version.rb

@@ -1,3 +1,3 @@
 module Slideshow
-  VERSION = '1.2.4'
+  VERSION = '1.2.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slideshow
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.2.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-15 00:00:00.000000000 Z
+date: 2013-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: props
-  requirement: &77883910 !ruby/object:Gem::Requirement
+  requirement: &84536570 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *77883910
+  version_requirements: *84536570
 - !ruby/object:Gem::Dependency
   name: markdown
-  requirement: &77883690 !ruby/object:Gem::Requirement
+  requirement: &84536350 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *77883690
+  version_requirements: *84536350
 - !ruby/object:Gem::Dependency
   name: textutils
-  requirement: &77883470 !ruby/object:Gem::Requirement
+  requirement: &84536130 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *77883470
+  version_requirements: *84536130
 - !ruby/object:Gem::Dependency
   name: pakman
-  requirement: &77883250 !ruby/object:Gem::Requirement
+  requirement: &84535910 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *77883250
+  version_requirements: *84535910
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &77883040 !ruby/object:Gem::Requirement
+  requirement: &84535700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 3.2.6
   type: :runtime
   prerelease: false
-  version_requirements: *77883040
+  version_requirements: *84535700
 - !ruby/object:Gem::Dependency
   name: RedCloth
-  requirement: &77882820 !ruby/object:Gem::Requirement
+  requirement: &84535480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,21 @@ dependencies:
         version: 4.2.9
   type: :runtime
   prerelease: false
-  version_requirements: *77882820
+  version_requirements: *84535480
+- !ruby/object:Gem::Dependency
+  name: logutils
+  requirement: &84535260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *84535260
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &77882600 !ruby/object:Gem::Requirement
+  requirement: &84535040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +98,10 @@ dependencies:
         version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *77882600
+  version_requirements: *84535040
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &77882380 !ruby/object:Gem::Requirement
+  requirement: &84534820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +109,7 @@ dependencies:
         version: '3.3'
   type: :development
   prerelease: false
-  version_requirements: *77882380
+  version_requirements: *84534820
 description: ! "The Slide Show (S9) Ruby gem lets you create slide shows and author
   slides in plain text\r\nusing a wiki-style markup language that's easy-to-write
   and easy-to-read.\r\nThe Slide Show (S9) project also collects and welcomes themes
@@ -166,7 +177,7 @@ files:
 - templates/style.css.erb
 - templates/welcome.text
 - templates/welcome.txt.quick
-homepage: http://slideshow.rubyforge.org
+homepage: http://slideshow-s9.github.io
 licenses: []
 post_install_message: ! '******************************************************************************
 
@@ -201,5 +212,5 @@ rubyforge_project: slideshow
 rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
-summary: Slide Show (S9) - A Free Web Alternative to PowerPoint and KeyNote in Ruby
+summary: Slide Show (S9) - A Free Web Alternative to PowerPoint and Keynote in Ruby
 test_files: []