showoff 0.9.11.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 990f271a37037bd5e09efb8c4a3bd53b9f8ffaeb
-  data.tar.gz: c22c8d8658cd69d1a3c63647f5c24ae9865ff02b
+  metadata.gz: b86b769faaf0f2bf83c369521ebe23d39dcff438
+  data.tar.gz: 721f97d05ded288194ae3d7bedb0d0dfe5fc900d
 SHA512:
-  metadata.gz: 8f7d574f59622d367d5faed0c588ffaf914e06268ad410a3339a3ef4169570717522f4b50607429e27391929b63bba616034ee0af219c50527c804ef3a5870ed
-  data.tar.gz: 6cd69aab79af8adf782fc2a257cb973850bd71edec506db3cf10cbc1015f189bada20d3267f61635632354c7c5751e4056c61f173e82adf7b8498d8434b35a3f
+  metadata.gz: 547eca4f0044dd9a209884011b932d79d223e5b9bb14771cf0ac2f5e0b794d000010868922ac3d7bbb0705228b6995cd13448bc0d95b13a5f1b020172fb471e4
+  data.tar.gz: 5c8b9f6d938a534a3dd2d711c44284a9ee678709153db6406c2bec10dc70ff885c7ff8b1d9127fb9c79cf8b4e99ee01503fa62fdb9cf085a4d493e4f4825ab0c

data/bin/showoff

@@ -122,6 +122,9 @@ command :serve do |c|
   c.desc 'Enable code review'
   c.switch :review
 
+  c.desc 'Enable remote code execution'
+  c.switch [:x,:executecode]
+
   c.desc 'Port on which to run'
   c.default_value "9090"
   c.flag [:p,:port]
@@ -163,6 +166,7 @@ To run it from presenter view, go to: [ #{url}/presenter ]
                   :pres_dir  => args[0],
                   :verbose   => options[:verbose],
                   :review    => options[:review],
+                  :execute   => options[:x],
                   :bind      => options[:h]
   end
 end

data/lib/keymap.rb

@@ -0,0 +1,30 @@
+module Keymap
+  def self.default()
+    {
+      'space'       => 'NEXT',
+      'd'           => 'DEBUG',
+      'up'          => 'PREV',
+      'left'        => 'PREV',
+      'pageup'      => 'PREV',
+      'down'        => 'NEXT',
+      'right'       => 'NEXT',
+      'pagedown'    => 'NEXT',
+      'r'           => 'RELOAD',
+      'c'           => 'CONTENTS',
+      't'           => 'CONTENTS',
+      'h'           => 'HELP',
+      '/'           => 'HELP',
+      '?'           => 'HELP',
+      'b'           => 'BLANK',
+      '.'           => 'BLANK',
+      'F'           => 'FOOTER',
+      'f'           => 'FOLLOW',
+      'n'           => 'NOTES',
+      'esc'         => 'CLEAR',
+      'p'           => 'PAUSE',
+      'P'           => 'PRESHOW',
+      'x'           => 'EXECUTE',
+      'f5'           => 'EXECUTE',
+    }
+  end
+end

data/lib/showoff/version.rb

@@ -1,3 +1,3 @@
 # No namespace here since ShowOff is a class and I'd have to inherit from
 # Sinatra::Application (which we don't want to load here)
-SHOWOFF_VERSION = '0.9.11.1'
+SHOWOFF_VERSION = '0.10.0'

data/lib/showoff.rb

@@ -10,6 +10,7 @@ require 'sinatra-websocket'
 here = File.expand_path(File.dirname(__FILE__))
 require "#{here}/showoff_utils"
 require "#{here}/commandline_parser"
+require "#{here}/keymap"
 
 begin
   require 'RMagick'
@@ -44,7 +45,8 @@ class ShowOff < Sinatra::Application
   set :presenters, []
 
   set :verbose, false
-  set :review, false
+  set :review,  false
+  set :execute, false
 
   set :pres_dir, '.'
   set :pres_file, 'showoff.json'
@@ -59,7 +61,8 @@ class ShowOff < Sinatra::Application
     @logger.formatter = proc { |severity,datetime,progname,msg| "#{progname} #{msg}\n" }
     @logger.level = settings.verbose ? Logger::DEBUG : Logger::WARN
 
-    @review = settings.review
+    @review  = settings.review
+    @execute = settings.execute
 
     dir = File.expand_path(File.join(File.dirname(__FILE__), '..'))
     @logger.debug(dir)
@@ -68,6 +71,11 @@ class ShowOff < Sinatra::Application
     settings.pres_dir ||= Dir.pwd
     @root_path = "."
 
+    # Load up the default keymap, then merge in any customizations
+    keymapfile   = File.expand_path(File.join('~', '.showoff', 'keymap.json'))
+    @keymap      = Keymap.default
+    @keymap.merge! JSON.parse(File.read(keymapfile)) rescue {}
+
     settings.pres_dir = File.expand_path(settings.pres_dir)
     if (settings.pres_file)
       ShowOffUtils.presentation_config_file = settings.pres_file
@@ -85,6 +93,18 @@ class ShowOff < Sinatra::Application
       settings.pres_template = showoff_json["templates"]
     end
 
+    # code execution timeout
+    settings.showoff_config['timeout'] ||= 15
+
+    # highlightjs syntax style
+    @highlightStyle = settings.showoff_config['highlight'] || 'default'
+
+    # variables used for building section numbering and title
+    @slide_count   = 0
+    @section_major = 0
+    @section_minor = 0
+    @section_title = settings.showoff_config['name'] rescue 'Showoff Presentation'
+
     @logger.debug settings.pres_template
 
     @cached_image_size = {}
@@ -180,11 +200,21 @@ class ShowOff < Sinatra::Application
       Dir.glob("#{settings.pres_dir}/*.js").map { |path| File.basename(path) }
     end
 
-
     def preshow_files
       Dir.glob("#{settings.pres_dir}/_preshow/*").map { |path| File.basename(path) }.to_json
     end
 
+    # return a list of keys associated with a given action in the keymap
+    def mapped_keys(action, klass='key')
+      list = @keymap.select { |key,value| value == action }.keys
+
+      if klass
+        list.map { |val| "<span class=\"#{klass}\">#{val}</span>" }.join
+      else
+        list.join ', '
+      end
+    end
+
     # todo: move more behavior into this class
     class Slide
       attr_reader :classes, :text, :tpl, :bg
@@ -376,13 +406,16 @@ class ShowOff < Sinatra::Application
 
       # Load and replace any file tags
       content.scan(/(~~~FILE:([^:]*):?(.*)?~~~)/).each do |match|
-        # get the file content and parse out html entities
-        file = HTMLEntities.new.encode(File.read(File.join(settings.pres_dir, '_files', match[1])))
+        # make a list of code highlighting classes to include
+        css  = match[2].split.collect {|i| "language-#{i.downcase}" }.join(' ')
 
-        # make a list of sh_highlight classes to include
-        css  = match[2].split.collect {|i| "sh_#{i.downcase}" }.join(' ')
+        # get the file content and parse out html entities
+        name = match[1]
+        file = File.read(File.join(settings.pres_dir, '_files', name)) rescue "Nonexistent file: #{name}"
+        file = "Empty file: #{name}" if file.empty?
+        file = HTMLEntities.new.encode(file) rescue "HTML parsing of #{name} failed"
 
-        result.gsub!(match[0], "<pre class=\"#{css}\"><code>#{file}</code></pre>")
+        result.gsub!(match[0], "<pre class=\"highlight\"><code class=\"#{css}\">#{file}</code></pre>")
       end
 
       result
@@ -712,10 +745,15 @@ class ShowOff < Sinatra::Application
       html.css('pre').each do |pre|
         pre.css('code').each do |code|
           out = code.text
+
+          # Skip this if we've got an empty code block
+          next if out.empty?
+
           lines = out.split("\n")
           if lines.first.strip[0, 3] == '@@@'
             lang = lines.shift.gsub('@@@', '').strip
-            pre.set_attribute('class', 'sh_' + lang.downcase) if !lang.empty?
+            pre.set_attribute('class', 'highlight')
+            code.set_attribute('class', 'language-' + lang.downcase) if !lang.empty?
             code.content = lines.join("\n")
           end
         end
@@ -752,10 +790,6 @@ class ShowOff < Sinatra::Application
     end
 
     def get_slides_html(opts={:static=>false, :pdf=>false, :toc=>false, :supplemental=>nil})
-      @slide_count   = 0
-      @section_major = 0
-      @section_minor = 0
-      @section_title = settings.showoff_config['name']
 
       sections = ShowOffUtils.showoff_sections(settings.pres_dir, @logger)
       files = []
@@ -829,9 +863,6 @@ class ShowOff < Sinatra::Application
         @slides = get_slides_html(:static=>static)
         @pause_msg = ShowOffUtils.pause_msg
 
-        # Identify which languages to bundle for highlighting
-        @languages = @slides.scan(/<pre class=".*(?!sh_sourceCode)(sh_[\w-]+).*"/).uniq.map{ |w| "sh_lang/#{w[0]}.min.js"}
-
         @asset_path = "./"
       end
 
@@ -899,7 +930,7 @@ class ShowOff < Sinatra::Application
     def onepage(static=false)
       @slides = get_slides_html(:static=>static, :toc=>true)
       @favicon = settings.showoff_config['favicon']
-      #@languages = @slides.scan(/<pre class=".*(?!sh_sourceCode)(sh_[\w-]+).*"/).uniq.map{ |w| "/sh_lang/#{w[0]}.min.js"}
+
       erb :onepage
     end
 
@@ -955,9 +986,6 @@ class ShowOff < Sinatra::Application
       @slides = get_slides_html(:static=>static, :pdf=>true)
       @inline = true
 
-      # Identify which languages to bundle for highlighting
-      @languages = @slides.scan(/<pre class=".*(?!sh_sourceCode)(sh_[\w-]+).*"/).uniq.map{ |w| "/sh_lang/#{w[0]}.min.js"}
-
       html = erb :onepage
       # TODO make a random filename
 
@@ -1065,11 +1093,16 @@ class ShowOff < Sinatra::Application
       end
     end
 
-   def eval_ruby code
-     eval(code).to_s
-   rescue => e
-     e.message
-   end
+  # Load a slide file from disk, parse it and return the text of a code block by index
+  def get_code_from_slide(path, index)
+    slide = "#{path}.md"
+    return unless File.exists? slide
+
+    html = process_markdown(slide, File.read(slide), {})
+    doc  = Nokogiri::HTML::DocumentFragment.parse(html)
+
+    return doc.css('code.execute')[index.to_i].text rescue 'Invalid code block index'
+  end
 
   # Basic auth boilerplate
   def protected!
@@ -1133,10 +1166,39 @@ class ShowOff < Sinatra::Application
     end.to_json
   end
 
-  get '/eval_ruby' do
-    return eval_ruby(params[:code]) if ENV['SHOWOFF_EVAL_RUBY']
+  # Evaluate known good code from a slide file on disk.
+  get '/execute/:lang' do |lang|
+    return 'Run showoff with -x or --executecode to enable code execution' unless @execute
+
+    code = get_code_from_slide(params[:path], params[:index])
 
-    return "Ruby Evaluation is off. To turn it on set ENV['SHOWOFF_EVAL_RUBY']"
+    require 'timeout'
+    require 'open3' # for 1.8 compatibility :/
+    begin
+      Timeout::timeout(settings.showoff_config['timeout']) do
+        case lang
+        when 'ruby'
+          eval(code).to_s
+        when 'shell'
+          %x(#{code})
+        when 'puppet'
+          stdout, err = Open3.capture2('puppet', 'apply', '--color=false', '-e', code)
+          stdout
+        when 'python'
+          stdout, err = Open3.capture2('python', '-c', code)
+          stdout
+        when 'perl'
+          stdout, err = Open3.capture2('perl', '-e', code)
+          stdout
+        when 'null'
+          code
+        else
+          "No exec handler for #{lang}"
+        end
+      end
+    rescue => e
+      e.message
+    end.gsub(/\n/, '<br />')
   end
 
   # provide a callback to trigger a local file editor, but only when called when viewing from localhost.
@@ -1316,7 +1378,7 @@ class ShowOff < Sinatra::Application
 
   not_found do
     # Why does the asset path start from cwd??
-    @asset_path.slice!(/^./)
+    @asset_path.slice!(/^./) rescue nil
     @env = request.env
     erb :'404'
   end

data/public/css/highlight/agate.css

@@ -0,0 +1,137 @@
+/*!
+ * Agate by Taufik Nurrohman <https://github.com/tovic>
+ * ----------------------------------------------------
+ *
+ * #ade5fc
+ * #a2fca2
+ * #c6b4f0
+ * #d36363
+ * #fcc28c
+ * #fc9b9b
+ * #ffa
+ * #fff
+ * #333
+ * #62c8f3
+ * #888
+ *
+ */
+
+.hljs {
+  display: block;
+  overflow-x: auto;
+  padding: .5em;
+  background: #333;
+  color: white;
+  -webkit-text-size-adjust: none;
+}
+
+.asciidoc .hljs-title,
+.hljs-label,
+.hljs-tag .hljs-title,
+.hljs-prompt,
+.http .hljs-request {
+  font-weight: bold;
+}
+
+.hljs-change,
+.hljs-code {
+  font-style: italic;
+}
+
+.hljs-tag,
+.ini .hljs-title {
+  color: #62c8f3;
+}
+
+.hljs-id,
+.hljs-cbracket,
+.hljs-tag .hljs-value {
+  color: #ade5fc;
+}
+
+.hljs-string,
+.hljs-bullet {
+  color: #a2fca2;
+}
+
+.hljs-type,
+.hljs-variable,
+.hljs-name,
+.actionscript .hljs-title,
+.aspectj .hljs-annotation,
+.aspectj .hljs-title,
+.hljs-attribute,
+.hljs-change,
+.hljs-blockquote,
+.hljs-built_in {
+  color: #ffa;
+}
+
+.hljs-number,
+.hljs-hexcolor,
+.hljs-link_label,
+.hljs-link_reference {
+  color: #d36363;
+}
+
+.hljs-keyword,
+.hljs-literal,
+.hljs-constant,
+.css .hljs-tag,
+.hljs-typename,
+.hljs-winutils {
+  color: #fcc28c;
+}
+
+.hljs-comment,
+.hljs-cdata,
+.hljs-preprocessor,
+.hljs-annotation,
+.hljs-decorator,
+.hljs-doctype,
+.hljs-deletion,
+.hljs-shebang,
+.apache .hljs-sqbracket,
+.tex .hljs-formula,
+.hljs-header,
+.hljs-horizontal_rule,
+.hljs-code {
+  color: #888;
+}
+
+.hljs-regexp,
+.hljs-attr_selector {
+  color: #c6b4f0;
+}
+
+.hljs-important,
+.hljs-doctype,
+.hljs-pi,
+.hljs-chunk,
+.actionscript .hljs-type,
+.hljs-shebang,
+.hljs-pragma,
+.http .hljs-attribute {
+  color: #fc9b9b;
+}
+
+.hljs-deletion {
+  background-color: #fc9b9b;
+  color: #333;
+}
+
+.hljs-addition {
+  background-color: #a2fca2;
+  color: #333;
+}
+
+.hljs a,
+.hljs-tag .hljs-attribute {
+  color: inherit;
+}
+
+.hljs a:focus,
+.hljs a:hover {
+  color: inherit;
+  text-decoration: underline;
+}

data/public/css/highlight/androidstudio.css

@@ -0,0 +1,53 @@
+/*
+Date: 24 Fev 2015
+Author: Pedro Oliveira <kanytu@gmail . com>
+*/
+
+.hljs {
+  color: #a9b7c6;
+  background: #282b2e;
+  display: block;
+  overflow-x: auto;
+  padding: 0.5em;
+  -webkit-text-size-adjust: none;
+}
+
+.hljs-number {
+  color: #6897BB;
+}
+
+.hljs-keyword,
+.hljs-deletion {
+  color: #cc7832;
+}
+
+.hljs-comment {
+  color: #808080;
+}
+
+.hljs-annotation {
+  color: #bbb529;
+}
+
+.hljs-string,
+.hljs-addition {
+  color: #6A8759;
+}
+
+.hljs-function .hljs-title,
+.hljs-change {
+  color: #ffc66d;
+}
+
+.hljs-tag .hljs-title,
+.hljs-doctype {
+  color: #e8bf6a;
+}
+
+.hljs-tag .hljs-attribute {
+  color: #bababa;
+}
+
+.hljs-tag .hljs-value {
+  color: #a5c261;
+}

data/public/css/highlight/arta.css

@@ -0,0 +1,138 @@
+/*
+Date: 17.V.2011
+Author: pumbur <pumbur@pumbur.net>
+*/
+
+.hljs {
+  display: block;
+  overflow-x: auto;
+  padding: 0.5em;
+  background: #222;
+  -webkit-text-size-adjust: none;
+}
+
+.profile .hljs-header *,
+.ini .hljs-title,
+.nginx .hljs-title {
+  color: #fff;
+}
+
+.hljs-comment,
+.hljs-preprocessor,
+.hljs-preprocessor .hljs-title,
+.hljs-pragma,
+.hljs-shebang,
+.profile .hljs-summary,
+.diff,
+.hljs-pi,
+.hljs-doctype,
+.hljs-tag,
+.css .hljs-rule,
+.tex .hljs-special {
+  color: #444;
+}
+
+.hljs-string,
+.hljs-symbol,
+.diff .hljs-change,
+.hljs-regexp,
+.xml .hljs-attribute,
+.smalltalk .hljs-char,
+.xml .hljs-value,
+.ini .hljs-value,
+.clojure .hljs-attribute,
+.coffeescript .hljs-attribute {
+  color: #ffcc33;
+}
+
+.hljs-number,
+.hljs-addition {
+  color: #00cc66;
+}
+
+.hljs-built_in,
+.hljs-literal,
+.hljs-type,
+.hljs-typename,
+.go .hljs-constant,
+.ini .hljs-keyword,
+.lua .hljs-title,
+.perl .hljs-variable,
+.php .hljs-variable,
+.mel .hljs-variable,
+.django .hljs-variable,
+.css .funtion,
+.smalltalk .method,
+.hljs-hexcolor,
+.hljs-important,
+.hljs-flow,
+.hljs-inheritance,
+.hljs-name,
+.parser3 .hljs-variable {
+  color: #32aaee;
+}
+
+.hljs-keyword,
+.hljs-tag .hljs-title,
+.css .hljs-tag,
+.css .hljs-class,
+.css .hljs-id,
+.css .hljs-pseudo,
+.css .hljs-attr_selector,
+.hljs-winutils,
+.tex .hljs-command,
+.hljs-request,
+.hljs-status {
+  color: #6644aa;
+}
+
+.hljs-title,
+.ruby .hljs-constant,
+.vala .hljs-constant,
+.hljs-parent,
+.hljs-deletion,
+.hljs-template_tag,
+.css .hljs-keyword,
+.objectivec .hljs-class .hljs-id,
+.smalltalk .hljs-class,
+.lisp .hljs-keyword,
+.apache .hljs-tag,
+.nginx .hljs-variable,
+.hljs-envvar,
+.bash .hljs-variable,
+.go .hljs-built_in,
+.vbscript .hljs-built_in,
+.lua .hljs-built_in,
+.rsl .hljs-built_in,
+.tail,
+.avrasm .hljs-label,
+.tex .hljs-formula,
+.tex .hljs-formula * {
+  color: #bb1166;
+}
+
+.hljs-doctag,
+.profile .hljs-header,
+.ini .hljs-title,
+.apache .hljs-tag,
+.parser3 .hljs-title {
+  font-weight: bold;
+}
+
+.coffeescript .javascript,
+.javascript .xml,
+.tex .hljs-formula,
+.xml .javascript,
+.xml .vbscript,
+.xml .css,
+.xml .hljs-cdata {
+  opacity: 0.6;
+}
+
+.hljs,
+.hljs-subst,
+.diff .hljs-chunk,
+.css .hljs-value,
+.css .hljs-attribute {
+  color: #aaa;
+}

data/public/css/highlight/ascetic.css

@@ -0,0 +1,52 @@
+/*
+
+Original style from softwaremaniacs.org (c) Ivan Sagalaev <Maniac@SoftwareManiacs.Org>
+
+*/
+
+.hljs {
+  display: block;
+  overflow-x: auto;
+  padding: 0.5em;
+  background: white;
+  color: black;
+  -webkit-text-size-adjust: none;
+}
+
+.hljs-string,
+.hljs-tag .hljs-value,
+.hljs-filter .hljs-argument,
+.hljs-addition,
+.hljs-change,
+.hljs-name,
+.apache .hljs-tag,
+.apache .hljs-cbracket,
+.nginx .hljs-built_in,
+.tex .hljs-formula {
+  color: #888;
+}
+
+.hljs-comment,
+.hljs-shebang,
+.hljs-doctype,
+.hljs-pi,
+.hljs-deletion,
+.apache .hljs-sqbracket {
+  color: #ccc;
+}
+
+.hljs-keyword,
+.hljs-tag .hljs-title,
+.ini .hljs-title,
+.lisp .hljs-title,
+.http .hljs-title,
+.nginx .hljs-title,
+.css .hljs-tag,
+.hljs-winutils,
+.hljs-flow,
+.apache .hljs-tag,
+.tex .hljs-command,
+.hljs-request,
+.hljs-status {
+  font-weight: bold;
+}