showoff 0.16.1 → 0.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f799ced051d346d7788de67fc8737fce0f374f2e
-  data.tar.gz: 315d9a402e3ace5d16c1f6184518c0aeb84495ba
+  metadata.gz: bcb7404f722269ce7b4c571c0a7d34c72f76d684
+  data.tar.gz: 7a2b4b825af14a88c58fccd9a851f51587894d9f
 SHA512:
-  metadata.gz: a8c3c7c3462fbb722ea6097d53264f271ca0e10ab111a71d9fb4f242adfa59f934926a05a42403535b011148c324be0832219f64682de87df3e29b1146f84fcd
-  data.tar.gz: 564ec5a49755719797eb3f07f759f91e0be067e13fff279b84cdc9441a2d12ed4fc330cd67487aaeba2187a59d363998f4d73b4090730d3fc5829a7335f94c8c
+  metadata.gz: 180720b95f90f0948642258fca4c84327da441b85d7b23bb00203272ee05c7ed07c85af8665a5938c5c1b8ca683e98887aa1b98514ae4b59d32c9e8dde41af2e
+  data.tar.gz: 38036fa41718cf12953dd2db5a32cdc2b05840c11fea9652dfe8a525b0a095238a97bffbf643ddd5d4ea1ac57b0b2ce5af89929c7710761467e6323169dd3167

data/bin/showoff

@@ -4,6 +4,7 @@ $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'showoff'
 require 'showoff/version'
 require 'rubygems'
+require 'fidget'
 require 'gli'
 
 # See https://github.com/davetron5000/gli/issues/196 for rationale for this silly wrapper
@@ -98,24 +99,24 @@ module Wrapper
   arg_name 'heroku_name'
   long_desc 'Creates the configuration files needed to Herokuize a Showoff presentation and then deploys it for you.'
   command :heroku do |c|
-  
+
     c.desc 'add password protection to your heroku site'
     c.flag [:p,:password]
-  
+
     c.desc 'force overwrite of existing Gemfile/.gems and config.ru files if they exist'
     c.switch [:f,:force]
-  
+
     c.action do |global_options,options,args|
       raise "heroku_name is required" if args.empty?
       raise "Name must start with a letter and can only contain lowercase letters, numbers, and dashes." unless args.first =~ /^[a-z][a-z1-9-]*$/
-  
+
       unless system('git remote get-url heroku')
         ShowOffUtils.command("heroku create #{args[0]}", "Please ensure that the heroku gem is installed and you're logged in.")
       end
-  
+
       if ShowOffUtils.heroku(args[0],options[:f],options[:p])
         ShowOffUtils.command('bundle install', 'Please ensure that the bundler gem is installed.')
-  
+
         begin
           ShowOffUtils.command('git add Procfile Gemfile Gemfile.lock config.ru')
           ShowOffUtils.command('git commit -m "Herokuized by Showoff"')
@@ -129,11 +130,11 @@ module Wrapper
           puts
           puts 'When done, please run "git push heroku master"'
         end
-  
+
         if options[:p]
           puts "CAREFUL: you are commiting your access password - anyone with read access to the repo can access the preso\n\n"
         end
-  
+
         puts 'Your presentation has been Herokuized. Run `heroku open` to see it.'
       end
     end
@@ -159,6 +160,9 @@ module Wrapper
     c.desc 'Disable content caching'
     c.switch :nocache
 
+    c.desc 'Prevent the computer from sleeping during your presentation'
+    c.switch :nosleep
+
     c.desc 'Port on which to run'
     c.default_value "9090"
     c.flag [:p, :port]
@@ -230,6 +234,11 @@ module Wrapper
 
   "
 
+      if options[:nosleep] and Fidget.current_process
+        puts '**** System sleep has been suspended. ****'
+        puts
+      end
+
       if options[:url]
         ShowOffUtils.clone(options[:git_url], options[:git_branch], options[:git_path]) do
           ShowOff.run!(options) do |server|

data/lib/showoff.rb

@@ -140,6 +140,7 @@ class ShowOff < Sinatra::Application
     @section_major = 0
     @section_minor = 0
     @section_title = settings.showoff_config['name'] rescue 'Showoff Presentation'
+    @@slide_titles  = [] # a list of generated slide names, used for cross references later.
 
     @logger.debug settings.pres_template
 
@@ -161,12 +162,16 @@ class ShowOff < Sinatra::Application
     begin
       @@counter = JSON.parse(File.read("#{settings.statsdir}/#{settings.viewstats}"))
 
-      # port old format stats
+      # TODO: remove this logic 4/15/2017: port old format stats
       unless @@counter.has_key? 'user_agents'
-        @@counter = { 'user_agents' => {}, 'pageviews' => @@counter }
+        @@counter['pageviews'] = @@counter
       end
+
+      @@counter['current']     ||= {}
+      @@counter['pageviews']   ||= {}
+      @@counter['user_agents'] ||= {}
     rescue
-      @@counter = { 'user_agents' => {}, 'pageviews' => {} }
+      @@counter = { 'user_agents' => {}, 'pageviews' => {}, 'current' => {} }
     end
 
     # keeps track of form responses. In memory to avoid concurrence issues.
@@ -395,11 +400,9 @@ class ShowOff < Sinatra::Application
 
         # name the slide. If we've got multiple slides in this file, we'll have a sequence number
         # include that sequence number to index directly into that content
-        if seq
-          content += "<div class=\"content #{classes}\" ref=\"#{name}:#{seq.to_s}\">\n"
-        else
-          content += "<div class=\"content #{classes}\" ref=\"#{name}\">\n"
-        end
+        ref = seq ? "#{name}:#{seq.to_s}" : name
+        content += "<div class=\"content #{classes}\" ref=\"#{ref}\">\n"
+        @@slide_titles << ref
 
         # renderers like wkhtmltopdf needs an <h1> tag to use for a section title, but only when printing.
         if opts[:print]
@@ -492,12 +495,6 @@ class ShowOff < Sinatra::Application
       # Turn this into a document for munging
       doc = Nokogiri::HTML::DocumentFragment.parse(result)
 
-      if opts[:section]
-        doc.css('div.notes-section').each do |section|
-          section.remove unless section.attr('class').split.include? opts[:section]
-        end
-      end
-
       filename = File.join(settings.pres_dir, '_notes', "#{name}.md")
       @logger.debug "personal notes filename: #{filename}"
       if [nil, 'notes'].include? opts[:section] and File.file? filename
@@ -519,9 +516,68 @@ class ShowOff < Sinatra::Application
         end
       end
 
-      # Now add a target so we open all external links from notes in a new window
+      doc.css('.callout.glossary').each do |item|
+        next unless item.content =~ /^([^|]+)\|([^:]+):(.*)$/
+        item['data-term']   = $1
+        item['data-target'] = $2
+        item['data-text']   = $3
+        item.content        = $3
+
+        glossary = (item.attr('class').split - ['callout', 'glossary']).first
+        address  = glossary ? "#{glossary}/#{$2}" : $2
+        frag     = "<a class=\"processed label\" href=\"glossary://#{address}\">#{$1}</a>"
+
+        item.children.before(Nokogiri::HTML::DocumentFragment.parse(frag))
+      end
+
+      # Process links
       doc.css('a').each do |link|
-        link.set_attribute('target', '_blank') unless link['href'].start_with? '#'
+        next if link['href'].start_with? '#'
+        next if link['class'].split.include? 'processed' rescue nil
+
+        # If these are glossary links, populate the notes/handouts sections
+        if link['href'].start_with? 'glossary://'
+          doc.add_child '<div class="notes-section notes"></div>' if doc.css('div.notes-section.notes').empty?
+          doc.add_child '<div class="notes-section handouts"></div>' if doc.css('div.notes-section.handouts').empty?
+
+          term = link.content
+          text = link['title']
+          href = link['href']
+          href.slice!('glossary://')
+
+          parts  = href.split('/')
+          target = parts.pop
+          name   = parts.pop # either the glossary name or nil
+
+          link['class']  = 'term'
+
+          label = link.clone
+          label['class'] = 'label processed'
+
+          frag = Nokogiri::HTML::DocumentFragment.parse('<p></p>')
+          definition = frag.children.first
+          definition['class'] = "callout glossary #{name}"
+          definition['data-term']   = term
+          definition['data-target'] = target
+          definition['data-text']   = text
+          definition.content = text
+          definition.children.before(label)
+
+          [doc.css('div.notes-section.notes'), doc.css('div.notes-section.handouts')].each do |section|
+            section.first.add_child(definition.clone)
+          end
+
+        else
+          # Add a target so we open all external links from notes in a new window
+          link.set_attribute('target', '_blank')
+        end
+      end
+
+      # finally, remove any sections we don't want to print
+      if opts[:section]
+        doc.css('div.notes-section').each do |section|
+          section.remove unless section.attr('class').split.include? opts[:section]
+        end
       end
 
       doc.to_html
@@ -552,31 +608,87 @@ class ShowOff < Sinatra::Application
     end
 
     def process_content_for_all_slides(content, num_slides, opts={})
+      # this has to be text replacement for now, since the string can appear in any context
       content.gsub!("~~~NUM_SLIDES~~~", num_slides.to_s)
+      doc = Nokogiri::HTML::DocumentFragment.parse(content)
 
       # Should we build a table of contents?
       if opts[:toc]
-        frag = Nokogiri::HTML::DocumentFragment.parse ""
-        toc = Nokogiri::XML::Node.new('div', frag)
-        toc['id'] = 'toc'
-        frag.add_child(toc)
-
-        Nokogiri::HTML(content).css('div.subsection > h1:not(.section_title)').each do |section|
-          entry = Nokogiri::XML::Node.new('div', frag)
-          entry['class'] = 'tocentry'
-          toc.add_child(entry)
-
-          link = Nokogiri::XML::Node.new('a', frag)
-          link['href'] = "##{section.parent.parent['id']}"
-          link.content = section.content
-          entry.add_child(link)
+        toc = Nokogiri::HTML::DocumentFragment.parse("<p id=\"toc\"></p>")
+
+        doc.css('div.subsection > h1:not(.section_title)').each do |section|
+          href = section.parent.parent['id']
+          frag = "<div class=\"tocentry\"><a href=\"##{href}\">#{section.content}</a></div>"
+          link = Nokogiri::HTML::DocumentFragment.parse(frag)
+
+          toc.children.first.add_child(link)
         end
 
         # swap out the tag, if found, with the table of contents
-        content.gsub!("~~~TOC~~~", frag.to_html)
+        doc.at('p:contains("~~~TOC~~~")').replace(toc)
       end
 
-      content
+      doc.css('.slide.glossary .content').each do |glossary|
+        name = (glossary.attr('class').split - ['content', 'glossary']).first
+        list = Nokogiri::HTML::DocumentFragment.parse('<ul class="glossary terms"></ul>')
+        seen = []
+
+        doc.css('.callout.glossary').each do |item|
+          target = (item.attr('class').split - ['callout', 'glossary']).first
+
+          # if the name matches or if we didn't name it to begin with.
+          next unless target == name
+
+          # the definition can exist in multiple places, so de-dup it here
+          term = item.attr('data-term')
+          next if seen.include? term
+          seen << term
+
+          # excrutiatingly find the parent slide content and grab the ref
+          # in a library less shitty, this would be something like
+          # $(this).parent().siblings('.content').attr('ref')
+          href = nil
+          item.ancestors('.slide').first.traverse do |element|
+            next if element['class'].nil?
+            next unless element['class'].split.include? 'content'
+
+            href = element.attr('ref').gsub('/', '_')
+          end
+
+          text   = item.attr('data-text')
+          link   = item.attr('data-target')
+          page   = glossary.attr('ref')
+          anchor = "#{page}+#{link}"
+          next if href.nil? or text.nil? or link.nil?
+
+          frag = "<li><a id=\"#{anchor}\" class=\"label\">#{term}</a>#{text}<a href=\"##{href}\" class=\"return\">↩</a></li>"
+          item = Nokogiri::HTML::DocumentFragment.parse(frag)
+
+          list.children.first.add_child(item)
+        end
+
+        glossary.add_child(list)
+      end
+
+      # now fix all the links to point to the glossary page
+      doc.css('a').each do |link|
+        next if link['href'].nil?
+        next unless link['href'].start_with? 'glossary://'
+
+        href = link['href']
+        href.slice!('glossary://')
+
+        parts  = href.split('/')
+        target = parts.pop
+        name   = parts.pop # either the glossary name or nil
+
+        classes = name.nil? ? ".slide.glossary" : ".slide.glossary.#{name}"
+        href    = doc.at("#{classes} .content").attr('ref') rescue nil
+
+        link['href'] = "##{href}+#{target}"
+      end
+
+      doc.to_html
     end
 
     # Find any lines that start with a <p>.(something), remove the ones tagged with
@@ -991,6 +1103,14 @@ class ShowOff < Sinatra::Application
       # Provide a button in the sidebar for interactive editing if configured
       @edit     = settings.showoff_config['edit'] if @review
 
+      # store a cookie to tell clients apart. More reliable than using IP due to proxies, etc.
+      unless request.cookies['client_id']
+        @client_id = guid()
+        response.set_cookie('client_id', @client_id)
+      else
+        @client_id = request.cookies['client_id']
+      end
+
       erb :index
     end
 
@@ -1046,6 +1166,7 @@ class ShowOff < Sinatra::Application
 
       # if we have a cache and we're not asking to invalidate it
       return @@cache if (@@cache and params['cache'] != 'clear')
+      @@slide_titles = []
       content = get_slides_html(:static=>static)
 
       # allow command line cache disabling
@@ -1081,12 +1202,79 @@ class ShowOff < Sinatra::Application
       erb :download
     end
 
+    def stats_data()
+      data = {}
+      begin
+
+        # what are viewers looking at right now?
+        now = Time.now.to_i # let's throw away viewers who haven't done anything in 5m
+        active  = @@counter['current'].select {|client, view| (now - view[1]).abs < 300 }
+
+        # percentage of stray viewers
+        stray   = active.select {|client, view| view[0] != @@current[:name] }
+        stray_p = ((stray.size.to_f / active.size.to_f) * 100).to_i rescue 0
+        data['stray_p'] = stray_p
+
+        # percentage of idle viewers
+        idle    = @@counter['current'].size - active.size
+        idle_p  = ((idle.to_f / @@counter['current'].size.to_f) * 100).to_i rescue 0
+        data['idle_p']  = idle_p
+
+        viewers = @@slide_titles.map do |slide|
+          count = active.select {|client, view| view[0] == slide }.size
+          flags = (slide == @@current[:name]) ? 'current' : nil
+          [count, slide, nil, flags]
+        end
+
+        # trim the ends, if nobody's looking we don't much care.
+        viewers.pop while viewers.last[0] == 0
+        viewers.shift while viewers.first[0] == 0
+        viewmax = viewers.max_by {|view| view[0] }.first
+
+        data['viewers'] = viewers
+        data['viewmax'] = viewmax
+      rescue => e
+        @logger.warn "Not enough data to generate pageviews."
+        @logger.debug e.message
+        @logger.debug e.backtrace.first
+      end
+
+      begin
+        # current elapsed time for the zoomline view
+        elapsed = @@slide_titles.map do |slide|
+          if @@counter['pageviews'][slide].nil?
+            time = 0
+          else
+            time = @@counter['pageviews'][slide].inject(0) do |outer, (viewer, views)|
+              outer += views.inject(0) { |inner, view| inner += view['elapsed'] }
+            end
+          end
+          string = Time.at(time).gmtime.strftime('%M:%S')
+          flags  = (slide == @@current[:name]) ? 'current' : nil
+
+          [ time, slide, string, flags ]
+        end
+        maxtime = elapsed.max_by {|view| view[0] }.first
+
+        data['elapsed'] = elapsed
+        data['maxtime'] = maxtime
+      rescue => e
+        # expected if this is loaded before a presentation has been compiled
+        @logger.warn "Not enough data to generate elapsed time."
+        @logger.debug e.message
+        @logger.debug e.backtrace.first
+      end
+
+      data.to_json
+    end
+
     def stats()
-      if request.env['REMOTE_HOST'] == 'localhost'
+      if localhost?
         # the presenter should have full stats in the erb
         @counter = @@counter['pageviews']
       end
 
+      # for the full page view. Maybe to be disappeared
       @all = Hash.new
       @@counter['pageviews'].each do |slide, stats|
         @all[slide] = 0
@@ -1095,10 +1283,6 @@ class ShowOff < Sinatra::Application
         end
       end
 
-      # most and least five viewed slides
-      @least = @all.sort_by {|slide, time| time}[0..4]
-      @most = @all.sort_by {|slide, time| -time}[0..4]
-
       erb :stats
     end
 
@@ -1131,7 +1315,7 @@ class ShowOff < Sinatra::Application
   end
 
 
-   def self.do_static(args, opts = {})
+  def self.do_static(args, opts = {})
       args ||= [] # handle nil arguments
       what   = args[0] || "index"
       opt    = args[1]
@@ -1319,18 +1503,20 @@ class ShowOff < Sinatra::Application
     (0..15).to_a.map{|a| rand(16).to_s(16)}.join
   end
 
-  def valid_cookie?
+  def valid_presenter_cookie?
+    return false if @@cookie.nil?
     (request.cookies['presenter'] == @@cookie)
   end
 
   post '/form/:id' do |id|
-    @logger.warn("Saving form answers from ip:#{request.ip} for id:##{id}")
+    client_id = request.cookies['client_id']
+    @logger.warn("Saving form answers from ip:#{request.ip} with ID of #{client_id} for id:##{id}")
 
     form = params.reject { |k,v| ['splat', 'captures', 'id'].include? k }
 
     # make sure we've got a bucket for this form, then save our answers
     @@forms[id] ||= {}
-    @@forms[id][request.ip] = form
+    @@forms[id][client_id] = form
 
     form.to_json
   end
@@ -1445,13 +1631,13 @@ class ShowOff < Sinatra::Application
           begin
             control = JSON.parse(data)
 
-            @logger.warn "#{control.inspect}"
+            @logger.debug "#{control.inspect}"
 
             case control['message']
             when 'update'
               # websockets don't use the same auth standards
               # we use a session cookie to identify the presenter
-              if valid_cookie?
+              if valid_presenter_cookie?
                 name  = control['name']
                 slide = control['slide'].to_i
                 increment = control['increment'].to_i rescue 0
@@ -1472,29 +1658,37 @@ class ShowOff < Sinatra::Application
 
             when 'register'
               # save a list of presenters
-              if valid_cookie?
+              if valid_presenter_cookie?
                 remote = request.env['REMOTE_HOST'] || request.env['REMOTE_ADDR']
                 settings.presenters << ws
                 @logger.warn "Registered new presenter: #{remote}"
               end
 
             when 'track'
-              remote = valid_cookie? ? 'presenter' : (request.env['REMOTE_HOST'] || request.env['REMOTE_ADDR'])
+              remote = valid_presenter_cookie? ? 'presenter' : request.cookies['client_id']
               slide  = control['slide']
-              time   = control['time'].to_f
 
-              # record the UA of the client if we haven't seen it before
-              @@counter['user_agents'][remote] ||= request.user_agent
+              if control.has_key? 'time'
+                time = control['time'].to_f
+
+                # record the UA of the client if we haven't seen it before
+                @@counter['user_agents'][remote] ||= request.user_agent
 
-              views = @@counter['pageviews']
-              # a bucket for this slide
-              views[slide] ||= Hash.new
-              # a bucket of slideviews for this address
-              views[slide][remote] ||= Array.new
-              # and add this slide viewing to the bucket
-              views[slide][remote] << { 'elapsed' => time, 'timestamp' => Time.now.to_i, 'presenter' => @@current[:name] }
+                views = @@counter['pageviews']
+                # a bucket for this slide
+                views[slide] ||= Hash.new
+                # a bucket of slideviews for this address
+                views[slide][remote] ||= Array.new
+                # and add this slide viewing to the bucket
+                views[slide][remote] << { 'elapsed' => time, 'timestamp' => Time.now.to_i, 'presenter' => @@current[:name] }
+
+                @logger.debug "Logged #{time} on slide #{slide} for #{remote}"
+
+              else
+                @@counter['current'][remote] = [slide, Time.now.to_i]
+                @logger.debug "Recorded current slide #{slide} for #{remote}"
+              end
 
-              @logger.debug "Logged #{time} on slide #{slide} for #{remote}"
 
             when 'position'
               ws.send( { 'current' => @@current[:number] }.to_json ) unless @@cookie.nil?