slideshow-models 2.4.0

data/lib/slideshow/helpers/text_helper.rb

@@ -0,0 +1,132 @@
+# encoding: utf-8
+
+module Slideshow
+  module TextHelper
+  
+def s9_include( name, opts = {} )
+  puts "  Including '#{name}'..." 
+  content = File.read( name )
+end
+
+
+# Usage example:
+#  <%= code 'code/file.rb#section', :lang => 'ruby', :class => 'small' %>
+#    or
+#  <% code :lang => 'ruby' do %>
+#    code goes here
+#  <% end %>
+#
+
+def code( *args, &blk )
+  # check for optional hash for options
+  opts = args.last.kind_of?(Hash) ? args.pop : {}
+  
+  name_plus_part = args.first   # check for optional filename
+    
+  if name_plus_part 
+    name, part = name_plus_part.split( '#' ) # split off optional part/anchor 
+    
+    content = find_content_from( name, part ) 
+    
+    # add name and part to opts so engine can use paras too  
+    opts[ :name ] = name  
+    opts[ :part ] = part if part
+    
+    return format_code( content, opts )
+  elsif blk # inline code via block?
+    content = capture_erb(&blk)
+    return if content.empty?
+
+    concat_erb( format_code( content, opts ), blk.binding )
+    return
+  else
+    msg = '*** warning: empty code directive; inline code or file para expected'
+    puts msg 
+    return wrap_markup( "<!-- #{msg} -->" )
+  end
+end
+
+
+def find_content_from( name, part )
+  begin
+    content = File.read( name )
+
+    # note: for now content with no parts selected gets filtered too and (part) marker lines get removed from source
+    lines = find_part_lines_in( content, part )
+
+    if part
+      puts "  Including code part '#{part}' in '#{name}' [#{lines.size} lines]..."
+      ## todo: issue warning if no lines found?
+    else
+      puts "  Including code in '#{name}' [#{lines.size} lines]..."
+    end
+  
+    return lines.join
+  rescue Exception => e
+    puts "*** error: reading '#{name}': #{e}"
+    exit 2
+  end
+end
+
+def find_part_lines_in( content, part )
+  result = []
+  state = part.nil? ? :normal : :skipping 
+  content.each_line do |line|
+    if line =~ /(START|END):(\w+)/
+      if $2 == part
+        if $1 == "START"
+          state = :normal
+        else
+          state = :skipping
+        end
+      end
+      next 
+    end
+    result << line unless state == :skipping
+  end
+  result
+end
+
+
+def format_code( code, opts )
+  
+  engine    = opts.fetch( :engine, headers.code_engine ).to_s.downcase  
+  
+  if engine == 'uv' || engine == 'ultraviolet'
+    if respond_to?( :uv_worker )
+      code_highlighted = uv_worker( code, opts )
+    else
+      puts "** error: ultraviolet gem required for syntax highlighting; install with gem install ultraviolet (or use a different engine)"
+      exit 2
+    end
+  elsif engine == 'cr' || engine == 'coderay'
+    if respond_to?( :coderay_worker )
+      code_highlighted = coderay_worker( code, opts )
+    else
+      puts "*** error: coderay gem required for syntax highlighting; install with gem install coderay (or use a different engine)"
+      exit 2
+    end
+  else
+    method_name = "#{engine}_worker".to_sym
+    if respond_to?( method_name )
+      # try to call custom syntax highlighting engine
+      code_highlighted = send( method_name, code, opts )
+    else
+      msg = "*** error: unkown syntax highlighting engine '#{engine}'; available built-in options include: uv, ultraviolet, cr, coderay"
+      puts msg
+      code_highlighted = "<!-- #{msg} -->"
+    end
+  end
+ 
+  out =  %{<!-- begin code#{opts.inspect} -->\n}
+  out << code_highlighted
+  out << %{<!-- end code -->\n}
+  
+  guard_block( out ) # saveguard with notextile wrapper etc./no further processing needed
+end
+
+
+end # module TextHelper
+end # module Slideshow
+
+Slideshow::Gen.__send__( :include, Slideshow::TextHelper )

data/lib/slideshow/manifest_helpers.rb

@@ -0,0 +1,99 @@
+# encoding: utf-8
+
+
+module Slideshow
+
+module ManifestHelper
+
+  ## shared methods for handling manifest lookups
+
+  def installed_plugin_manifest_patterns
+    # 1) search ./plugins
+    # 2) search config_dir/plugins
+
+    config_patterns  = [
+      "#{config.config_dir}/plugins/*.{txt.plugin,plugin.txt}",
+      "#{config.config_dir}/plugins/*/*.{txt.plugin,plugin.txt}"
+    ]
+    current_patterns = [
+      "plugins/*.{txt.plugin,plugin.txt}",
+      "plugins/*/*.{txt.plugin,plugin.txt}"
+    ]
+    
+    patterns = []
+    patterns += current_patterns
+    patterns += config_patterns
+  end
+
+  def installed_plugin_manifests  # quickstarter templates
+    Pakman::Finder.new.find_manifests( installed_plugin_manifest_patterns )
+  end
+
+
+  def installed_template_manifest_patterns
+    # 1) search ./templates
+    # 2) search config_dir/templates
+    # 3) search gem/templates
+
+    # Note: only include builtin patterns if slideshow-templates gem included/required (it's optional)
+    builtin_patterns = []
+    builtin_patterns << "#{SlideshowTemplates.root}/templates/*.txt"  if defined?( SlideshowTemplates )
+
+    config_patterns  = [
+      "#{config.config_dir}/templates/*.txt",
+      "#{config.config_dir}/templates/*/*.txt"
+    ]
+    current_patterns = [
+      "templates/*.txt",
+      "templates/*/*.txt"     # todo: use all in one line? {*.txt,*/*.txt} does it work?
+    ]
+
+    patterns = []
+    patterns += current_patterns
+    patterns += config_patterns
+    patterns += builtin_patterns
+  end
+
+  def installed_template_manifests
+    ## note: code moved to its own gem, that is, pakman
+    ## see https://github.com/geraldb/pakman
+  
+    ## exclude manifest.txt/i  (avoid confusion w/ ruby gem manifest; not a specific name anyway)
+    ##  also exclude patterns for quickstarter templates
+    
+    excludes = [
+      'manifest.txt',
+      '*/manifest.txt',
+      '*.{txt.quick,quick.txt}',
+      '*/*.{txt.quick,quick.txt}'
+    ]
+  
+    Pakman::Finder.new.find_manifests( installed_template_manifest_patterns, excludes )
+  end
+
+
+  def installed_quick_manifest_patterns
+    # 1) search config_dir/templates
+    # 2) search gem/templates 
+
+    # Note: only include builtin patterns if slideshow-templates gem included/required (it's optional)
+    builtin_patterns = []
+    builtin_patterns << "#{SlideshowTemplates.root}/templates/*.{txt.quick,quick.txt}"  if defined?( SlideshowTemplates )
+
+    config_patterns  = [
+      "#{config.config_dir}/templates/*.{txt.quick,quick.txt}",
+      "#{config.config_dir}/templates/*/*.{txt.quick,quick.txt}"
+    ]
+
+    patterns = []
+    patterns += config_patterns
+    patterns += builtin_patterns
+  end
+
+  def installed_quick_manifests  # quickstarter templates
+    Pakman::Finder.new.find_manifests( installed_quick_manifest_patterns )
+  end
+
+
+end # module Manifest
+end # module Slideshow

data/lib/slideshow/markup/markdown.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module Slideshow
+  module MarkdownEngines
+
+  ## note: code moved to its own gem, that is, markdown
+  ## see https://github.com/geraldb/markdown
+  
+  def markdown_to_html( content )
+    ##  puts "  Converting Markdown-text (#{content.length} bytes) to HTML using library '#{@markdown_libs.first}' calling '#{mn}'..."
+    
+    Markdown.new( content ).to_html
+  end
+
+end   # module MarkdownEngines
+end # module Slideshow
+
+class Slideshow::Gen
+  include Slideshow::MarkdownEngines
+end

data/lib/slideshow/markup/mediawiki.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+module Slideshow
+  module MediawikiEngines
+
+
+  def setup_mediawiki_engine
+    return if @mediawiki_engine_setup
+    logger.debug 'require wikicloth  -- load mediawiki library'
+    require 'wikicloth'          # default mediawiki library
+    @mediawiki_engine_setup = true
+  rescue LoadError
+    puts "You're missing a library required for Mediawiki to Hypertext conversion. Please run:"
+    puts "   $ gem install wikicloth"
+    #  check: raise exception instead of exit e.g
+    #  raise FatalException.new( 'Missing library dependency: wikicloth' )
+    exit 1
+  end
+
+
+  def mediawiki_to_html( content )
+    
+    setup_mediawiki_engine()
+    
+    puts "  Converting Mediawiki-text (#{content.length} bytes) to HTML..."
+
+    # NB: turn off table_of_contents (TOC) auto-generation with __NOTOC__
+    # NB: turn off adding of edit section/markers for headings (noedit:true)
+
+    wiki = WikiCloth::Parser.new( data: "__NOTOC__\n"+content, params: {} )
+
+    content = wiki.to_html( noedit: true )
+  end
+
+  end  # module MediawikiEngines
+end # module Slideshow
+
+class Slideshow::Gen
+  include Slideshow::MediawikiEngines
+end

data/lib/slideshow/markup/rest.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'pandoc-ruby'
+
+module Slideshow
+  module RestEngines  # reStructuredText
+
+  def rest_to_html( content )
+    puts "  Converting reStructuredText (#{content.length} bytes) to HTML..."
+
+    content = PandocRuby.new( content, :from => :rst, :to => :html ).convert
+  end
+    
+end   # module RestEngines
+end # module Slideshow
+
+class Slideshow::Gen
+  include Slideshow::RestEngines
+end  

data/lib/slideshow/markup/textile.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+module Slideshow
+  module TextileEngines
+
+  def redcloth_java_fix_escape_nonascii( txt )
+    txt.chars.map{ |x| x.size > 1 ? "&##{x.unpack("U*")};" : x }.join
+  end
+
+  def redcloth_java_fix_escape_nonascii_exclude_pre( txt )
+
+    buf  = ""
+    from = 0
+ 
+    while (pos = txt.index( /<pre.*?>.*?<\/pre>/m, from ))
+      # add text before pre block escaped
+      buf << redcloth_java_fix_escape_nonascii( txt[ from, pos-from] )
+     
+      # add pre block unescaped (otherwise html entities get escaped twice)
+      from = Regexp.last_match.end(0)
+      buf << txt[pos, from-pos]
+    end
+    buf << redcloth_java_fix_escape_nonascii( txt[from, txt.length-from] )
+   
+    buf
+  end 
+
+
+  def setup_textile_engine
+    return if @textile_engine_setup
+    logger.debug 'require redcloth  -- load textile library'
+    require 'redcloth'          # default textile library
+    @textile_engine_setup = true
+  rescue LoadError
+    puts "You're missing a library required for Textile to Hypertext conversion. Please run:"
+    puts "   $ gem install RedCloth"
+    #  check: raise exception instead of exit e.g
+    #  raise FatalException.new( 'Missing library dependency: RedCloth' )
+    exit 1
+  end
+
+
+  def textile_to_html( content )
+    
+    setup_textile_engine()   # optinal lib; extra; load only textile lib if used (soft dependency)
+    
+    puts "  Converting Textile-text (#{content.length} bytes) to HTML..."
+    
+    # JRuby workaround for RedCloth 4 multi-byte character bug
+    #  see http://jgarber.lighthouseapp.com/projects/13054/tickets/149-redcloth-4-doesnt-support-multi-bytes-content
+    # basically convert non-ascii chars (>127) to html entities
+    
+    if RedCloth::EXTENSION_LANGUAGE == "Java"
+      puts "  Patching RedCloth for Java; converting non-Ascii/multi-byte chars to HTML-entities..." 
+      content = redcloth_java_fix_escape_nonascii_exclude_pre( content )
+    end
+    
+    # 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
+
+end   # module TextileEngines
+end # module Slideshow
+
+class Slideshow::Gen
+  include Slideshow::TextileEngines
+end

data/lib/slideshow/models.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+
+
+# core and stlibs
+require 'erb'
+require 'pp'
+require 'date'
+require 'ostruct'
+require 'yaml'
+require 'json'
+require 'uri'
+require 'net/http'
+require 'net/https'
+require 'cgi'
+require 'fileutils'
+
+
+# required gems
+require 'active_support/all'
+
+require 'props'             # manage settings/env
+require 'logutils'       # logger utils library
+
+require 'markdown'          # default markdown library
+require 'fetcher'           # fetch docs and blogs via http, https, etc.
+
+
+class Env
+  def self.slideshowopt
+    ENV[ 'SLIDESHOWOPT' ]
+  end
+end # class Env
+
+require 'textutils'     # text filters and helpers
+require 'pakman'        # template pack manager
+
+
+# our own code
+require 'slideshow/version'   # note: let version always go first
+require 'slideshow/headers'
+require 'slideshow/config'
+require 'slideshow/manifest_helpers'
+require 'slideshow/plugin_helpers'
+require 'slideshow/slide'
+
+require 'slideshow/commands/fetch'
+require 'slideshow/commands/gen'
+require 'slideshow/commands/list'
+require 'slideshow/commands/plugins'
+require 'slideshow/commands/quick'
+
+
+require 'slideshow/markup/markdown'
+require 'slideshow/markup/mediawiki'
+require 'slideshow/markup/textile'
+
+
+# load built-in (required) helpers/plugins
+require 'slideshow/helpers/text_helper'
+require 'slideshow/helpers/capture_helper'
+require 'slideshow/helpers/step_helper'
+require 'slideshow/helpers/background_helper'
+require 'slideshow/helpers/source_helper'
+require 'slideshow/helpers/directive_helper'
+require 'slideshow/helpers/markdown_helper'
+
+require 'slideshow/helpers/syntax/sh_helper'
+
+# load built-in filters
+require 'slideshow/filters/headers_filter'
+require 'slideshow/filters/text_filter'
+require 'slideshow/filters/debug_filter'
+require 'slideshow/filters/slide_filter'
+
+
+
+# load built-in (optional) helpers/plugins/engines
+#   If a helper fails to load, simply ingnore it
+#   If you want to use it install missing required gems e.g.:
+#     gem install coderay
+#     gem install ultraviolet etc.
+BUILTIN_OPT_HELPERS = [
+  'slideshow/helpers/syntax/uv_helper.rb',
+  'slideshow/helpers/syntax/coderay_helper.rb',
+  'slideshow/markup/rest.rb',
+]
+
+BUILTIN_OPT_HELPERS.each do |helper| 
+  begin
+    require(helper)
+  rescue Exception => e
+    ;
+  end
+end
+
+
+# say hello
+puts Slideshow.banner   if $DEBUG || (defined?($RUBYLIBS_DEBUG) && $RUBYLIBS_DEBUG)