showoff 0.9.7.1 → 0.9.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 756658ffcc3440e126ed64c256a82ed7f188d1e0
-  data.tar.gz: 6558c0816fe2ee1c4bfe1b18bf228b70f708a87e
+  metadata.gz: e0cff52fdf5f38360a5e10678acb81713da42532
+  data.tar.gz: 3dd12a4a362f8b0de756df4de1a34727533ee89c
 SHA512:
-  metadata.gz: 2fe546cdf496d75232a11593820ef1070c66f4089598aaf9c9679d2f593446e0b47df3e6b08815180d21edac570e4f9e517ce28bb27277d26d8520d757eab551
-  data.tar.gz: f6d1c58f94860d0f31982f91f3a64687fd80709a93f982a0c32a925a1189ecdf0ca6cfb773acb16495191d061e21f84762df78a0171efeb3769e13135a0cd6da
+  metadata.gz: fe5086466395d08f3667f90a76729d16d0546e5e57144ddf9a3dbcf69a1715f4cf57c6c658801f8a47d6ec4bb2e6090e707c69720eb7d4387d8670981d23b74b
+  data.tar.gz: 45a82534917bbdf68e3f792a381bac569a699184aa4bb3efe3b3013eda3b2367c89e3ef54f8b634d2ddaece0bd6b88fef46f7a171f9827ae23ac4e580028900b

data/bin/showoff

@@ -99,6 +99,9 @@ command :serve do |c|
   c.desc 'Show verbose messaging'
   c.switch :verbose
 
+  c.desc 'Enable code review'
+  c.switch :review
+
   c.desc 'Port on which to run'
   c.default_value "9090"
   c.flag [:p,:port]
@@ -138,6 +141,7 @@ To run it from presenter view, go to: [ #{url}/presenter ]
                   :pres_file => options[:f],
                   :pres_dir  => args[0],
                   :verbose   => options[:verbose],
+                  :review    => options[:review],
                   :bind      => options[:h]
   end
 end

data/lib/showoff.rb

@@ -14,13 +14,15 @@ require "#{here}/commandline_parser"
 begin
   require 'RMagick'
 rescue LoadError
-  $stderr.puts 'WARN: image sizing disabled - install rmagick'
+  $stderr.puts 'NOTICE: * automatic image sizing unavailable; install RMagick for this functionality.'
 end
 
 begin
   require 'pdfkit'
 rescue LoadError
-  $stderr.puts 'WARN: pdf generation disabled - install pdfkit'
+  $stderr.puts 'NOTICE: * internal pdf generation disabled; install PDFKit for this functionality'
+  $stderr.puts 'NOTICE:   the PDFKit integration will likely be deprecated. Instead, you should'
+  $stderr.puts 'NOTICE:   simply use your browser to print from the /print endpoint.'
 end
 
 require 'tilt'
@@ -43,6 +45,8 @@ class ShowOff < Sinatra::Application
   set :presenters, []
 
   set :verbose, false
+  set :review, false
+
   set :pres_dir, '.'
   set :pres_file, 'showoff.json'
   set :page_size, "Letter"
@@ -69,6 +73,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
+
     dir = File.expand_path(File.join(File.dirname(__FILE__), '..'))
     @logger.debug(dir)
 
@@ -590,13 +596,21 @@ class ShowOff < Sinatra::Application
         @asset_path = "./"
       end
 
+      # Display favicon in the window if configured
+      @favicon  = settings.showoff_config['favicon']
+
       # Check to see if the presentation has enabled feedback
-      @feedback = settings.showoff_config['feedback']
+      @feedback = settings.showoff_config['feedback'] unless params[:feedback] == 'false'
+
+      # Provide a button in the sidebar for interactive editing if configured
+      @edit     = settings.showoff_config['edit'] if @review
+
       erb :index
     end
 
     def presenter
       @issues    = settings.showoff_config['issues']
+      @edit      = settings.showoff_config['edit'] if @review
       @@cookie ||= guid()
       response.set_cookie('presenter', @@cookie)
       erb :presenter
@@ -645,17 +659,20 @@ 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
 
     def print(static=false)
       @slides = get_slides_html(:static=>static, :toc=>true, :print=>true)
+      @favicon = settings.showoff_config['favicon']
       erb :onepage
     end
 
     def supplemental(content, static=false)
       @slides = get_slides_html(:static=>static, :supplemental=>content)
+      @favicon = settings.showoff_config['favicon']
       @wrapper_classes = ['supplemental']
       erb :onepage
     end
@@ -665,6 +682,7 @@ class ShowOff < Sinatra::Application
         shared = Dir.glob("#{settings.pres_dir}/_files/share/*").map { |path| File.basename(path) }
         # We use the icky -999 magic index because it has to be comparable for the view sort
         @downloads = { -999 => [ true, 'Shared Files', shared ] }
+        @favicon = settings.showoff_config['favicon']
       rescue Errno::ENOENT => e
         # don't fail if the directory doesn't exist
         @downloads = {}
@@ -964,8 +982,7 @@ class ShowOff < Sinatra::Application
       protected! if settings.showoff_config['protected'].include? what
     end
 
-    # this hasn't been set to anything remotely interesting for a long time now
-    @asset_path = nil
+    @asset_path = env['SCRIPT_NAME'] == '' ? nil : env['SCRIPT_NAME'].gsub(/^\/?/, '/').gsub(/\/?$/, '/')
 
     begin
       if (what != "favicon.ico")

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.7.1'
+SHOWOFF_VERSION = '0.9.8'

data/public/css/showoff.css

@@ -38,6 +38,7 @@
       border-top-left-radius: 3px;
       border-top-right-radius: 3px;
       z-index: 2147483647; /* max, see http://www.puidokas.com/max-z-index/ */
+      display: none;
   }
   #followMode {
     display: none;
@@ -134,7 +135,8 @@
 }
 
 /* nested lists get their bullets back */
-.content ul ul {
+.content ul ul,
+.content ol ul {
   list-style: disc;
   margin: 10px 10px;
   padding-left: 40px;
@@ -299,6 +301,17 @@ img#disconnected {
   text-align: center;
 }
 
+#feedbackSidebar div.row.tools {
+  position: absolute;
+  bottom: 30px;
+  width: 100%;
+  text-align: center;
+}
+
+#feedbackSidebar div.row.tools button#editSlide {
+  width: 90%%;
+  margin: auto 5%;
+}
 
 .fg-menu-container {
     z-index: 2147483647; /* max, see http://www.puidokas.com/max-z-index/ */
@@ -487,10 +500,6 @@ ul#downloads li {
     margin: 0.5em;
 }
 
-span#issueUrl {
-  display: none;
-}
-
 /**********************
  ***   stats page   ***
  **********************/

data/public/js/presenter.js

@@ -1,11 +1,12 @@
 // presenter js
 var slaveWindow = null;
+var nextWindow = null;
 
 var paceData = [];
 
 $(document).ready(function(){
   // set up the presenter modes
-  mode = { track: false, follow: true, update: true, slave: false };
+  mode = { track: false, follow: true, update: true, slave: false, next: false};
 
   // attempt to open another window for the presentation if the mode defaults
   // to enabling this. It does not by default, so this is likely a no-op.
@@ -103,9 +104,14 @@ function popupLoader(elem, page, id, event)
 }
 
 function reportIssue() {
-  var slide  = $("span#slideFile").text();
-  var issues = $("span#issueUrl").text();
-  var link = issues + encodeURIComponent('Issue with slide: ' + slide);
+  var slide = $("span#slideFile").text();
+  var link  = issueUrl + encodeURIComponent('Issue with slide: ' + slide);
+  window.open(link);
+}
+
+function editSlide() {
+  var slide = $("span#slideFile").text();
+  var link  = editUrl + slide + ".md";
   window.open(link);
 }
 
@@ -152,6 +158,58 @@ function openSlave()
   }
 }
 
+function nextSlideNum(url) {
+  // Some fudging because the first slide is slide[0] but numbered 1 in the URL
+  console.log(typeof(url));
+  var snum;
+  if (typeof(url) == 'undefined') { snum = currentSlideFromParams()+1; }
+  else { snum = currentSlideFromParams()+2; }
+  return snum;
+}
+
+function toggleNext() {
+  mode.next = !mode.next;
+  openNext();
+}
+
+function openNext()
+{
+  if (mode.next) {
+    try {
+      if(nextWindow == null || typeof(nextWindow) == 'undefined' || nextWindow.closed){
+          nextWindow = window.open('/?track=false&feedback=false&next=true#' + nextSlideNum(true),'','width=300,height=200');
+      }
+      else if(nextWindow.location.hash != '#' + nextSlideNum(true)) {
+        // maybe we need to reset content?
+        nextWindow.location.href = '/?track=false&feedback=false&next=true#' + nextSlideNum(true);
+      }
+
+      // maintain the pointer back to the parent.
+      nextWindow.presenterView = window;
+      nextWindow.mode = { track: false, next: true, follow: true };
+
+      $('#nextWindow').addClass('enabled');
+    }
+    catch(e) {
+      console.log('Failed to open or connect next window. Popup blocker?');
+    }
+
+    // Set up a maintenance loop to keep the connection between windows. I wish there were a cleaner way to do this.
+    //if (typeof maintainNext == 'undefined') {
+    //  maintainNext = setInterval(openNext, 1000);
+    //}
+  }
+  else {
+    try {
+      nextWindow && nextWindow.close();
+      $('#nextWindow').removeClass('enabled');
+    }
+    catch (e) {
+      console.log('Next window failed to close properly.');
+    }
+  }
+}
+
 function askQuestion(question) {
   $("#questions ul").prepend($('<li/>').text(question));
 }
@@ -264,11 +322,12 @@ function register() {
 
 function presPrevStep()
 {
-    prevStep();
-    try { slaveWindow.prevStep(false) } catch (e) {};
-    postSlide();
+  prevStep();
+  try { slaveWindow.prevStep(false) } catch (e) {};
+  try { nextWindow.gotoSlide(nextSlideNum()) } catch (e) {};
+  postSlide();
 
-    update();
+  update();
 }
 
 function presNextStep()
@@ -278,8 +337,9 @@ function presNextStep()
     incrCurr = slaveWindow.incrCurr
     incrSteps = slaveWindow.incrSteps
 */
-	nextStep();
+  nextStep();
 	try { slaveWindow.nextStep(false) } catch (e) {};
+  try { nextWindow.gotoSlide(nextSlideNum()) } catch (e) {};
 	postSlide();
 
 	update();

data/public/js/sh_lang/sh_docker.js

@@ -0,0 +1,137 @@
+if (! this.sh_languages) {
+  this.sh_languages = {};
+}
+sh_languages['docker'] = [
+  [
+    [
+      /\b[+-]?(?:(?:0x[A-Fa-f0-9]+)|(?:(?:[\d]*\.)?[\d]+(?:[eE][+-]?[\d]+)?))u?(?:(?:int(?:8|16|32|64))|L)?\b/g,
+      'sh_number',
+      -1
+    ],
+    [
+      /"/g,
+      'sh_string',
+      1
+    ],
+    [
+      /'/g,
+      'sh_string',
+      2
+    ],
+    [
+      /</g,
+      'sh_string',
+      3
+    ],
+    [
+      /\/[^\n]*\/\s/g,  // anchor to \s to avoid matching directory names.
+      'sh_regexp',
+      -1
+    ],
+    [
+      /(%r)(\{(?:\\\}|#\{[A-Za-z0-9]+\}|[^}])*\})/g,
+      ['sh_symbol', 'sh_regexp'],
+      -1
+    ],
+    [
+      /\b[A-Za-z0-9]+(?=\s*[=|\+]>)/g,
+      'sh_attribute',
+      -1
+    ],
+    [
+      /\b(?:FROM|MAINTAINER|ENV|ADD|RUN|WORKDIR|VOLUME|ONBUILD|CMD|ENTRYPOINT|EXPOSE|USER)\b/g,
+      'sh_keyword',
+      -1
+    ],
+    [
+      /(?:^\=begin)/g,
+      'sh_comment',
+      4
+    ],
+    [
+      /[A-Za-z0-9]+(?:\?|!)/g,
+      'sh_normal',
+      -1
+    ],
+    [
+      /~|!|%|\^|\*|\(|\)|-|\+|=|\[|\]|\\|:|;|,|\.|\/|\?|&|<|>|\|/g,
+      'sh_symbol',
+      -1
+    ],
+    [
+      /(#)(\{)/g,
+      ['sh_symbol', 'sh_cbracket'],
+      -1
+    ],
+    [
+      /#/g,
+      'sh_comment',
+      1
+    ],
+    [
+      /\{|\}/g,
+      'sh_cbracket',
+      -1
+    ]
+  ],
+  [
+    [
+      /$/g,
+      null,
+      -2
+    ],
+    [
+      /\\(?:\\|")/g,
+      null,
+      -1
+    ],
+    [
+      /"/g,
+      'sh_string',
+      -2
+    ]
+  ],
+  [
+    [
+      /$/g,
+      null,
+      -2
+    ],
+    [
+      /\\(?:\\|')/g,
+      null,
+      -1
+    ],
+    [
+      /'/g,
+      'sh_string',
+      -2
+    ]
+  ],
+  [
+    [
+      /$/g,
+      null,
+      -2
+    ],
+    [
+      />/g,
+      'sh_string',
+      -2
+    ]
+  ],
+  [
+    [
+      /^(?:\=end)/g,
+      'sh_comment',
+      5
+    ]
+  ],
+  [
+    [
+      /$/g,
+      null,
+      -2
+    ]
+  ]
+];

data/public/js/sh_lang/sh_docker.min.js

@@ -0,0 +1 @@
+if(!this.sh_languages){this.sh_languages={}}sh_languages.docker=[[[/\b[+-]?(?:(?:0x[A-Fa-f0-9]+)|(?:(?:[\d]*\.)?[\d]+(?:[eE][+-]?[\d]+)?))u?(?:(?:int(?:8|16|32|64))|L)?\b/g,"sh_number",-1],[/"/g,"sh_string",1],[/'/g,"sh_string",2],[/</g,"sh_string",3],[/\/[^\n]*\/\s/g,"sh_regexp",-1],[/(%r)(\{(?:\\\}|#\{[A-Za-z0-9]+\}|[^}])*\})/g,["sh_symbol","sh_regexp"],-1],[/\b[A-Za-z0-9]+(?=\s*[=|\+]>)/g,"sh_attribute",-1],[/\b(?:FROM|MAINTAINER|ENV|ADD|RUN|WORKDIR|VOLUME|ONBUILD|CMD|ENTRYPOINT|EXPOSE|USER)\b/g,"sh_keyword",-1],[/(?:^\=begin)/g,"sh_comment",4],[/[A-Za-z0-9]+(?:\?|!)/g,"sh_normal",-1],[/~|!|%|\^|\*|\(|\)|-|\+|=|\[|\]|\\|:|;|,|\.|\/|\?|&|<|>|\|/g,"sh_symbol",-1],[/(#)(\{)/g,["sh_symbol","sh_cbracket"],-1],[/#/g,"sh_comment",1],[/\{|\}/g,"sh_cbracket",-1]],[[/$/g,null,-2],[/\\(?:\\|")/g,null,-1],[/"/g,"sh_string",-2]],[[/$/g,null,-2],[/\\(?:\\|')/g,null,-1],[/'/g,"sh_string",-2]],[[/$/g,null,-2],[/>/g,"sh_string",-2]],[[/^(?:\=end)/g,"sh_comment",5]],[[/$/g,null,-2]]];

data/public/js/showoff.js

@@ -60,6 +60,9 @@ function setupPreso(load_slides, prefix) {
   // give us the ability to disable tracking via url parameter
   if(query.track == 'false') mode.track = false;
 
+  // make sure that the next view doesn't bugger things on the first load
+  if(query.next == 'true')   mode.next = true;
+
   // Make sure the slides always look right.
   // Better would be dynamic calculations, but this is enough for now.
   $(window).resize(function(){location.reload();});
@@ -83,6 +86,7 @@ function setupPreso(load_slides, prefix) {
   $("#sendFeedback").click(function() {
     sendFeedback($( "input:radio[name=rating]:checked" ).val(), $("textarea#feedback").val())
   });
+  $("#editSlide").click(function() { editSlide(); });
 
   $("textarea#question").val(questionPrompt);
   $("textarea#feedback").val(feedbackPrompt);
@@ -90,7 +94,9 @@ function setupPreso(load_slides, prefix) {
   $("textarea#feedback").focus(function() { clearIf($(this), feedbackPrompt) });
 
   // Open up our control socket
-  connectControlChannel();
+  if(mode.track) {
+    connectControlChannel();
+  }
 /*
   ws           = new WebSocket('ws://' + location.host + '/control');
   ws.onopen    = function()  { connected();          };
@@ -195,17 +201,33 @@ function checkSlideParameter() {
 	}
 }
 
+function currentSlideFromName(name) {
+  var count = 0;
+	slides.each(function(s, slide) {
+	  if (name == $(slide).find(".content").attr("ref") ) {
+	    found = count;
+	    return false;
+	  }
+	  count++;
+	});
+	return count;
+}
+
 function currentSlideFromParams() {
 	var result;
 	if (result = window.location.hash.match(/#([0-9]+)/)) {
 		return result[result.length - 1] - 1;
 	}
+	else {
+	  var hash = window.location.hash
+	  return currentSlideFromName(hash.substr(1, hash.length))
+  }
 }
 
 function setupSlideParamsCheck() {
 	var check = function() {
 		var currentSlide = currentSlideFromParams();
-		if (slidenum != currentSlide) {
+		if (!isNaN(currentSlide) && slidenum != currentSlide) {
 			slidenum = currentSlide;
 			showSlide();
 		}
@@ -283,7 +305,7 @@ function showSlide(back_step, updatepv) {
   $('#slideFilename').text(fileName);
 
   // Update presenter view, if we spawned one
-	if (updatepv && 'presenterView' in window) {
+	if (updatepv && 'presenterView' in window && ! mode.next) {
     var pv = window.presenterView;
 		pv.slidenum = slidenum;
     pv.incrCurr = incrCurr
@@ -448,6 +470,13 @@ function track() {
   }
 }
 
+// Open a new tab with an online code editor, if so configured
+function editSlide() {
+  var slide = $("span#slideFilename").text();
+  var link  = editUrl + slide + ".md";
+  window.open(link);
+}
+
 function follow(slide) {
   if (mode.follow) {
     console.log("New slide: " + slide);

data/views/header.erb

@@ -5,6 +5,10 @@
 
   <link rel="stylesheet" href="<%= @asset_path %>/css/reset.css" type="text/css"/>
 
+  <% if @favicon %>
+  <link rel="icon" href="<%= @favicon %>"/>
+  <% end %>
+
   <link type="text/css" href="<%= @asset_path %>/css/fg.menu.css" media="screen" rel="stylesheet" />
   <link type="text/css" href="<%= @asset_path %>/css/theme/ui.all.css" media="screen" rel="stylesheet" />
   <link type="text/css" href="<%= @asset_path %>/css/sh_style.css" rel="stylesheet" />
@@ -44,7 +48,9 @@
   <% end %>
 
   <script type="text/javascript">
-  $(function(){
+    $(function(){
       setupPreso(<%= @slides.nil? ? "true" : "false"%>, '<%= @asset_path %>');
-  });
+    });
+
+    editUrl  = "<%= @edit %>";
   </script>

data/views/header_mini.erb

@@ -3,6 +3,10 @@
 
   <meta name="viewport" content="width=device-width"/>
 
+  <% if @favicon %>
+    <link rel="icon" href="<%= @favicon %>"/>
+  <% end %>
+
   <link rel="stylesheet" href="<%= @asset_path %>/css/reset.css" type="text/css"/>
   <link rel="stylesheet" href="<%= @asset_path %>/css/showoff.css" type="text/css"/>
 

data/views/index.erb

@@ -41,6 +41,11 @@
           <textarea id="feedback"></textarea>
           <button id="sendFeedback">Send Feedback</button>
         </div>
+        <% if @edit then %>
+        <div class="row tools">
+          <button id="editSlide">Edit Current Slide</button>
+        </div>
+        <% end %>
         <div id="disclaimer">All features are anonymous</div>
     </div>
     <div id="feedbackHandle"></div>

data/views/onepage.erb

@@ -5,6 +5,10 @@
 	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
   <title><%= @title %></title>
 
+  <% if @favicon %>
+    <link rel="icon" href="<%= @favicon %>"/>
+  <% end %>
+
   <% if @inline %>
 
     <%= inline_css(['reset.css', 'showoff.css', 'theme/ui.all.css', 'sh_style.css', 'onepage.css'], 'public/css') %>

data/views/presenter.erb

@@ -6,12 +6,14 @@
   <%= erb :header %>
   <link rel="stylesheet" href="<%= @asset_path %>/css/presenter.css" type="text/css"/>
   <script type="text/javascript" src="<%= @asset_path %>/js/presenter.js"></script>
+  <script type="text/javascript">
+    editUrl  = "<%= @edit %>";
+    issueUrl = "<%= @issues %>";
+  </script>
 </head>
 
 <body>
 
-<span id="issueUrl"><%= @issues %></span>
-
 <div id="help">
   <table>
     <tr><td class="key">z, ?</td><td>toggle help (this)</td></tr>
@@ -33,12 +35,16 @@
     </div>
     <span id="links">
       <span class="desktop">
+        <% if @edit %>
+          <a id="edit" href="javascript:editSlide();" title="Edit current slide in new window.">Edit Slide</a>
+        <% end %>
         <% if @issues %>
           <a id="report" href="javascript:reportIssue();" title="Report an issue with the current slide.">Report Issue With Slide</a>
         <% end %>
         <a id="stats" href="/stats" target="_showoffchild">Viewing Statistics</a>
         <a id="downloads" href="/download" target="_showoffchild">Downloads</a>
-        <a id="slaveWindow" href="javascript:toggleSlave();" title="Enable the slave window.">Enable Slave Window</a>
+        <a id="slaveWindow" href="javascript:toggleSlave();" title="Enable the slave window.">Slave Window</a>
+        <a id="nextWindow" href="javascript:toggleNext();" title="Enable the next window view.">Next Window</a>
         <a id="generatePDF" href="/pdf" title="Call out to wkhtmltopdf to generate a PDF.">Generate PDF</a>
         <a id="onePage" href="/onepage" title="Load the single page view. Useful for printing.">Single Page</a>
       </span>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: showoff
 version: !ruby/object:Gem::Version
-  version: 0.9.7.1
+  version: 0.9.8
 platform: ruby
 authors:
 - Scott Chacon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-20 00:00:00.000000000 Z
+date: 2014-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -239,6 +239,8 @@ files:
 - public/js/sh_lang/sh_cucumber.min.js
 - public/js/sh_lang/sh_desktop.min.js
 - public/js/sh_lang/sh_diff.min.js
+- public/js/sh_lang/sh_docker.js
+- public/js/sh_lang/sh_docker.min.js
 - public/js/sh_lang/sh_erlang.min.js
 - public/js/sh_lang/sh_flex.min.js
 - public/js/sh_lang/sh_gherkin.js
@@ -301,7 +303,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: The best damn presentation software a developer could ever love.