slideshow 2.3.0 → 2.4.0

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

@@ -1,52 +0,0 @@
-module Slideshow
-
-class GenTemplates
-
-
-  include LogUtils::Logging
-
-### fix: remove opts, use config (wrapped!!)
-
-  def initialize( opts, config )
-    @opts    = opts
-    @config  = config
-  end
-
-  attr_reader :opts, :config
-
-  def run
-    manifest_name = opts.manifest
-    manifest_name = manifest_name.downcase.gsub( '.txt', '' )  # remove (optional) .txt ending
-    logger.debug "manifest=#{manifest_name}"
-    
-    # check for builtin generator manifests
-    manifests = installed_generator_manifests.select { |m| m[0] == manifest_name+'.txt.gen' }
-    
-    if manifests.empty?
-      puts "*** error: unknown generator template pack '#{manifest_name}'"
-      # todo: list installed manifests
-      exit 2
-    end
-        
-    manifestsrc = manifests[0][1]
-    pakpath     = opts.output_path
-
-    logger.debug( "manifestsrc=>#{manifestsrc}<, pakpath=>#{pakpath}<" )
-    
-    Pakman::Copier.new( logger ).copy_pak( manifestsrc, pakpath )
-  end
-
-private
-
-  def installed_generator_manifests
-    # 1) search gem/templates 
-
-    patterns = [
-      "#{Slideshow.root}/templates/*.txt.gen"
-    ]
-
-    Pakman::Finder.new( logger ).find_manifests( patterns )
-  end
-
-end # class GenTemplates
-end # module Slideshow

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

@@ -1,70 +0,0 @@
-module Slideshow
-
-class List
-
-  include LogUtils::Logging
-
-  include ManifestHelper
-
-### fix: remove opts, use config (wrapped!!)
-  
-  def initialize( opts, config )
-    @opts    = opts
-    @config  = config
-  end
-
-  attr_reader :opts, :config
-
-  def run
-    home = Env.home
-    ## replace home w/ ~ (to make out more readable (shorter))
-    ## e.g. use gsub( home, '~' )
-
-    puts ''
-    puts 'Installed plugins in search path'
-
-    installed_plugin_manifest_patterns.each_with_index do |pattern,i|
-      puts "    [#{i+1}] #{pattern.gsub(home,'~')}"
-    end
-    puts '  include:'
-
-    installed_plugin_manifests.each do |manifest|
-      pakname      = manifest[0].gsub('.txt','').gsub('.plugin','')
-      manifestpath = manifest[1].gsub(home,'~')
-      puts "%16s (%s)" % [pakname,manifestpath]
-    end
-
-    puts ''
-    puts 'Installed quickstarter packs in search path'
-
-    installed_quick_manifest_patterns.each_with_index do |pattern,i|      
-      puts "    [#{i+1}] #{pattern.gsub(home,'~')}"
-    end
-    puts '  include:'
-    
-    installed_quick_manifests.each do |manifest|
-      pakname      = manifest[0].gsub('.txt','').gsub('.quick','')
-      manifestpath = manifest[1].gsub(home,'~')
-      puts "%16s (%s)" % [pakname,manifestpath]
-    end
-
-
-    puts ''
-    puts 'Installed template packs in search path'
-    
-    installed_template_manifest_patterns.each_with_index do |pattern,i|
-      puts "    [#{i+1}] #{pattern.gsub(home,'~')}"
-    end
-    puts '  include:'
-    
-    installed_template_manifests.each do |manifest|
-      pakname      = manifest[0].gsub('.txt','')
-      manifestpath = manifest[1].gsub(home,'~')
-      puts "%16s (%s)" % [pakname,manifestpath]
-    end
-    
-  end
-
-end # class List
-
-end # class Slideshow

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

@@ -1,44 +0,0 @@
-module Slideshow
-
-class Plugins
-
-  include LogUtils::Logging
-
-  include PluginHelper
-
-### fix: remove opts, use config (wrapped!!)
-  
-  def initialize( opts, config )
-    @opts    = opts
-    @config  = config
-  end
-
-  attr_reader :opts, :config
-
-  def run
-    home = Env.home
-    ## replace home w/ ~ (to make out more readable (shorter))
-    ## e.g. use gsub( home, '~' )
-
-    puts ''
-    puts 'Plugin scripts on the load path'
-    
-    find_plugin_patterns.each_with_index do |pattern,i|
-      puts "    [#{i+1}] #{pattern.gsub(home,'~')}"
-    end
-    puts '  include:'
-
-    plugins = find_plugins
-    if plugins.empty?
-      puts "    -- none --"
-    else
-      plugins.each do |plugin|
-        ## NB: use full_path - since Ruby 1.9.2 - ./ no longer included in load path for security
-        plugin_fullpath = File.expand_path( plugin )
-        puts "    #{plugin.gsub(home,'~')} (#{plugin_fullpath})"
-      end
-    end
-  end
-
-end # class Plugins
-end # module Slideshow

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

@@ -1,86 +0,0 @@
-module Slideshow
-
-class Quick
-
-  include LogUtils::Logging
-
-  include ManifestHelper
-
-### fix: remove opts, use config (wrapped!!)
-
-  def initialize( opts, config )
-    @opts    = opts
-    @config  = config
-  end
-
-  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
-    
-    ### todo:fix: always download quickstart templates (except welcome?)
-    # how to make sure the won't go stale in the cache after the download?
-    
-    manifests = installed_quick_manifests
-    matches = manifests.select { |m| (m[0] == manifest_name+'.txt.quick') || (m[0] == manifest_name+'.quick.txt') }
-
-    if matches.empty?
-      fetch_pak( manifest_name )
-      
-      # retry
-      manifests = installed_quick_manifests
-      matches = manifests.select { |m| (m[0] == manifest_name+'.txt.quick') || (m[0] == manifest_name+'.quick.txt') }
-      if matches.empty?
-        puts "*** error: quickstart template #{manifest_name} not found"
-        exit 2
-      end
-    end
-    
-    manifestsrc = matches[0][1]
-    pakpath     = opts.output_path
- 
-    logger.debug( "manifestsrc=>#{manifestsrc}<, pakpath=>#{pakpath}<" )
-    
-    Pakman::Copier.new( logger ).copy_pak( manifestsrc, pakpath )
-  end
-  
-  ## todo rename to fetch_quick_pak??
-  ##  share/use same code in fetch too??
-  
-  def fetch_pak( shortcut )
-
-    sources = config.map_fetch_shortcut( shortcut )
-      
-    if sources.empty?
-      puts "*** error: no mapping found for shortcut '#{shortcut}'."
-      exit 2
-    end
-
-    sources = sources.select { |s| s.include?('.txt.quick') || s.include?('.quick.txt') }
-
-    if sources.empty?
-      puts "*** error: no quick mapping found for shortcut '#{shortcut}'."
-      exit 2
-    end
-
-    src = sources[0]
-    
-    puts "  Mapping quick shortcut '#{shortcut}' to: #{src}"
-  
- 
-    # 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 "scheme: #{uri.scheme}, host: #{uri.host}, port: #{uri.port}, path: #{uri.path}"
-    
-    pakname = File.basename( uri.path ).downcase.gsub('.txt','')
-    pakpath = File.expand_path( "#{config.config_dir}/templates/#{pakname}" )
-    
-    logger.debug "pakname >#{pakname}<"
-    logger.debug "pakpath >#{pakpath}<"
- 
-    Pakman::Fetcher.new( logger ).fetch_pak( src, pakpath )
-  end # method fetch_pak
-
-end # class GenTemplates
-end # module Slideshow

data/lib/slideshow/config.rb

@@ -1,241 +0,0 @@
-module Slideshow
-
-class Config
-
-  include LogUtils::Logging
-
-  def initialize( opts )
-    @opts   = opts
-  end
-
-  attr_reader :opts
-
-  def header_level
-    @opts.header_level
-  end
-  
-  def slide?
-    @opts.slide?
-  end
-  
-  def takahashi?
-    @opts.takahashi?
-  end
-
-
-  # todo/fix: fix references after this move to here, that is, Config class
-  # - used in syntax/uv_helper (use config.cache_dir to access?)
-  
-  def cache_dir
-    File.join( Env.home, '.slideshow' )
-  end
-
-  def config_dir
-    unless @config_dir  # first time? calculate config_dir value to "cache"
-      @config_dir = opts.config_path
-    
-      # make sure path exists
-      FileUtils.makedirs( @config_dir ) unless File.directory? @config_dir
-    end
-    
-    @config_dir
-  end
-
-
-  def shortcut_index_file
-    ## e.g. ~/slideshow.index.yml
-    File.join( Env.home, 'slideshow.index.yml' )
-  end
-
-
-  def load_shortcuts
-    # load default index/registry for shortcuts
-    props_shortcuts_default_file = File.join( Slideshow.root, 'config', 'slideshow.index.yml' )
-    @props_shortcuts = @props_shortcuts_default = Props.load_file( props_shortcuts_default_file )
-
-    # check for update (slideshow.index.yml) in home folder
-
-    props_shortcuts_home_file = File.join( Env.home, 'slideshow.index.yml' )
-    if File.exists?( props_shortcuts_home_file )
-      puts "Loading shortcut index from '#{props_shortcuts_home_file}'..."
-      @props_shortcuts = @props_shortcuts_home = Props.load_file( props_shortcuts_home_file, @props_shortcuts )
-    end
-    
-    # todo: add props from (optional) fetch section from 'standard' props (e.g. props[:fetch])
-    #  - allows user to add own shortcuts in slideshow.yml settings
-  end
-
-
-  def map_fetch_shortcut( key )
-    # NB: always returns an array!!!  0,1 or more entries
-    # - no value - return empty ary
-    
-    ## todo: normalize key???
-    value = @props.fetch_from_section( 'fetch', key, @props_shortcuts.fetch( key, nil ))
-
-    if value.nil?
-      []
-    elsif value.kind_of?( String )
-      [value]
-    else  # assume it's an array already;  ## todo: check if it's an array
-      value
-    end
-  end
-
-
-  def default_fetch_shortcuts
-    ## NB: used by install --all
-
-    ['s6blank',
-     's6syntax',
-     's5blank',
-     's5themes',
-     'g5',
-     'slidy',
-     'deck.js',
-     'impress.js',
-     'analytics'
-    ]
-    
-    ## todo: use @props_shortcuts keys
-    #  and use
-    #
-    # fetch_shortcuts = fetch_shortcuts.clone
-    # fetch_shortcuts.delete( 'fullerscreen' )  # obsolete (do not promote any longer)
-    # fetch_shortcuts.delete( 'slippy' )  # needs update/maintainer anyone?
-    # fetch_shortcuts.delete( 'shower' )  # needs update/maintainer anyone?
-    # etc. to strip keys for all install
-  end
-
-
-  def load
-    
-    # load builtin config file @  <gem>/config/slideshow.yml
-    #
-    # NB: builtin use a different hierachy (not linked to default/home/user/cli props)
-    #     for now builtin has no erb processing
-    #     user cannot override builtin settings (only defaults see below)
-    props_builtin_file  = File.join( Slideshow.root, 'config', 'slideshow.builtin.yml' )
-    @props_builtin = Props.load_file( props_builtin_file )
-
-    props_default_file  = File.join( Slideshow.root, 'config', 'slideshow.yml' )
-    @props = @props_default = Props.load_file_with_erb( props_default_file, binding() )
-
-    # check for user settings (slideshow.yml) in home folder
-    
-    props_home_file = File.join( Env.home, 'slideshow.yml' )
-    if File.exists?( props_home_file )
-      puts "Loading settings from '#{props_home_file}'..."
-      @props = @props_home = Props.load_file_with_erb( props_home_file, binding(), @props )
-    end
-      
-    # check for user settings (slideshow.yml) in working folder
-    
-    props_work_file = File.join( '.', 'slideshow.yml' )
-    if File.exists?( props_work_file )
-      puts "Loading settings from '#{props_work_file}'..."
-      @props = @props_work = Props.load_file_with_erb( props_work_file, binding(), @props )
-    end
-    
-    # load shortcuts
-    load_shortcuts
-  end
-
-  def dump  # dump settings for debugging
-    puts "Slideshow settings:"
-    @props_builtin.dump  if @props_builtin
-    @props_default.dump  if @props_default
-    @props_home.dump     if @props_home
-    @props_work.dump     if @props_work
-    
-    puts "Slideshow shortcuts:"
-    @props_shortcuts_default.dump  if @props_shortcuts_default
-    @props_shortcuts_home.dump     if @props_shortcuts_home
-    ## todo: add props from 'standard' props via fetch key
-    
-    ## todo: add more config settings?
-  end
-
-
-  def header( key )
-    @props.fetch_from_section( 'headers', normalize_key( key ), nil )
-  end
-
-
-  def markdown_post_processing?( lib )
-    ## todo: normalize key/lib???
-    @props.fetch_from_section( lib, 'post-processing', true )
-  end
-  
-  def known_rest_extnames
-    @props.fetch_from_section( 'rest', 'extnames', [] )
-  end
-  
-  def known_textile_extnames
-    @props.fetch_from_section( 'textile', 'extnames', [] )
-  end
-
-  def known_mediawiki_extnames
-    @props.fetch_from_section( 'mediawiki', 'extnames', [] )
-  end
-
-  def known_markdown_extnames
-    ## delegate config to Markdown gem for now
-    ## todo/fix: how to pass on setting to Markdown gem??
-    Markdown.extnames
-  end
-  
-  def known_extnames
-    # returns an array of known file extensions e.g.
-    # [ '.textile', '.t' ]
-    #
-    # using nested key
-    # textile:
-    #   extnames:  [ .textile, .t ]
-    #
-    # ruby check: is it better self. ?? or more confusing
-    #  possible conflict only with write access (e.g. prop=) 
-    
-    known_textile_extnames + known_markdown_extnames + known_mediawiki_extnames + known_rest_extnames
-  end
-  
-  def text_filters
-    @props.fetch( 'filters', [] )
-  end
-  
-  def google_analytics_code
-    @props.fetch_from_section( 'analytics', 'google', nil )
-  end
-
-  def helper_renames
-    ## NB: for now user cannot override/extent renames
-    @props_builtin['helper']['renames']
-  end
-
-  def helper_unparsed
-    ## NB: for now user cannot override/extent unparsed helpers
-    # use unparsed params (passed along a single string)
-    @props_builtin['helper']['unparsed']
-  end
-  
-  def helper_exprs
-    ## NB: for now user cannot override/extent helper exprs
-    # allow expression as directives (no need for %end block)
-    # by default directives are assumed statements (e.g. %mydir  %end)
-    @props_builtin['helper']['exprs']
-  end
-
-private
-
-  def normalize_key( key )
-    #  make key all lower case/downcase (e.g. Content-Type  => content-type)
-    #  replace _ with -                 (e.g. gradient_color => gradient-color)
-    #  todo: replace space(s) with -  ??
-    #  todo: strip leading and trailing spaces - possible use case ??
-    
-    key.to_s.downcase.tr( '_', '-' )
-  end
-
-end # class Config
-
-end # module Slideshow