showoff 0.12.2 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec76aa0788c47474cae17e4e7fd001f5f59528fb
-  data.tar.gz: 672f97f4f81b725f1f0d68418b5a292f3061d58d
+  metadata.gz: c54ccde20fbe6df23ec6b8760dc4c379fdd5e510
+  data.tar.gz: 1da82fd0d90fbdeffee8da521ab4fba731046672
 SHA512:
-  metadata.gz: 46464828f157e75fd4783ef28628ff404573f57f69d3fa87da500a5cf4be46ce62a9e9639e695cf3f451eca27ec423ab9be48137ffc75fb45317b104c2218204
-  data.tar.gz: 6e3c5444159ce33d30e273de6de19da2357bec6b1aa82da65a7d7b4d5cad118bd472fba0289109c5a70eb0efd2184f080e64ec443aa0823f048445351acca284
+  metadata.gz: 8d3d1f9f9e699646c389383282dabb862dd7c9ae0fe681a9a63f1efc158dea921847ba10a34b415352a47e74bed93a0a040fac600e416445d2f2545d14481087
+  data.tar.gz: 6c100036f06dd912ba08f8eeca4670807d342103e4e9db5946fafbee629e10f9765785ef074a8aa06006c231b107d136090745ef3ed74c1fa5b34e661242621d

data/LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2009 Scott Chacon
+                    MIT License (MIT)
+
+Copyright (c) 2009-2016 Scott Chacon; Ben Ford; Puppet, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,8 +1,33 @@
-task default: :test
+task :default do
+  system("rake -T")
+end
 
 desc "Build HTML documentation"
 task :doc do
-  system("rdoc --main README.rdoc README.rdoc documentation/*.rdoc")
+  require 'fileutils'
+
+  FileUtils.rm_rf('doc')
+  Dir.chdir('documentation') do
+    system("rdoc --main -HOME.rdoc /*.rdoc --op ../doc")
+  end
+end
+
+desc "Update docs for webpage"
+task 'doc:website' => [:doc] do
+  require 'fileutils'
+
+  if system('git checkout gh-pages')
+    FileUtils.rm_rf('documentation')
+    FileUtils.mv('doc', 'documentation')
+    system('git add documentation')
+    system('git commit -m "updating docs"')
+    system('git checkout -')
+
+    puts "Publish updates by pushing to Github:"
+    puts
+    puts "    git push upstream gh-pages"
+    puts
+  end
 end
 
 desc "Run tests"

data/bin/showoff

@@ -21,10 +21,6 @@ A web based presentation engine with awesome interaction features.
   that are served locally for presentation via web browser. Your audience can
   view presentations directly as well, and interact with you in many ways.
 
-  ShowOff can optionally use the RMagick gem for automatic image resizing
-  functionality. If RMagick is available, images included in your presentation
-  will be resized down to meet size constraints of your presentation if needed.
-
   Showoff can optionally use the PDFKit gem to autogenerate PDF files on demand.
   Viewers can access the /pdf endpoint to download a generated PDF file. This
   functionality is likely to be deprecated, since it is simpler and easier to
@@ -36,29 +32,31 @@ desc
 
 
 desc 'Create new showoff presentation'
-arg_name 'dir_name'
 long_desc 'This command helps start a new showoff presentation by setting up the proper directory structure for you.  It takes the directory name you would like showoff to create for you.'
 command [:create,:init] do |c|
 
   c.desc 'Don''t create sample slides'
   c.switch [:n,:nosamples]
 
-  c.desc 'sample slide directory name'
+  c.desc 'Comma separated list of initial slide directory name(s).'
   c.default_value 'one'
   c.flag [:d,:slidedir]
 
   c.action do |global_options,options,args|
-    raise "dir_name is required" if args.empty?
-    ShowOffUtils.create(args[0],!options[:n],options[:d])
+    dir_name = args.first || '.'
+    ShowOffUtils.create(dir_name,!options[:n],options[:d])
     if options[:n]
-      puts "Add slides and update #{args[0]}/#{ShowOffUtils.presentation_config_file}"
+      puts "Add slides and update #{dir_name}/#{ShowOffUtils.presentation_config_file}"
+    end
+    if args.empty?
+      puts "Run 'showoff serve' to see your new slideshow"
+    else
+      puts "Run 'showoff serve' in the #{dir_name} directory to see your new slideshow"
     end
-    puts "Run 'showoff serve' in the #{args[0]} directory to see your new slideshow"
   end
 end
 
-desc 'Build a showoff presentation from a showoff.json outling'
-arg_name 'dir_name'
+desc 'Build a showoff presentation from a showoff.json outline'
 long_desc 'This command helps start a new showoff presentation by creating each slide listing in the showoff.json file.'
 command [:skeleton] do |c|
 
@@ -71,6 +69,18 @@ command [:skeleton] do |c|
   end
 end
 
+desc 'Validate the consistency of your presentation.'
+long_desc 'This ensures that each file listed in showoff.json exists and validates code blocks on each slide.'
+command [:validate] do |c|
+
+  c.desc 'alternate json filename'
+  c.flag [:f,:file]
+
+  c.action do |global_options,options,args|
+    ShowOffUtils.validate(options[:f])
+  end
+end
+
 desc 'Puts your showoff presentation into a gh-pages branch'
 long_desc 'Generates a static version of your presentation into your gh-pages branch for publishing to GitHub Pages'
 command :github do |c|

data/lib/showoff.rb

@@ -7,27 +7,13 @@ require 'pathname'
 require 'logger'
 require 'htmlentities'
 require 'sinatra-websocket'
+require 'tempfile'
 
 here = File.expand_path(File.dirname(__FILE__))
 require "#{here}/showoff_utils"
 require "#{here}/commandline_parser"
 require "#{here}/keymap"
 
-begin
-  require 'rmagick'
-  puts "********************************************************************************"
-  puts "                    RMagick support has been deprecated."
-  puts
-  puts "CSS auto-scaling has improved greatly, and the image manipulation should no"
-  puts "longer be required. If you have images that don't scale properly, then you"
-  puts "should write custom styles to size them appropriately."
-  puts
-  puts "        RMagic support will be removed completely in the next release."
-  puts "********************************************************************************"
-rescue LoadError
-  # nop
-end
-
 begin
   require 'pdfkit'
 rescue LoadError
@@ -128,6 +114,14 @@ class ShowOff < Sinatra::Application
       settings.showoff_config['locked'] ||= Array.new
     end
 
+    # default code validators
+    settings.showoff_config['validators'] ||= {}
+    settings.showoff_config['validators']['perl']   ||= 'perl -cw'
+    settings.showoff_config['validators']['puppet'] ||= 'puppet parser validate'
+    settings.showoff_config['validators']['python'] ||= 'python -m py_compile'
+    settings.showoff_config['validators']['ruby']   ||= 'ruby -c'
+    settings.showoff_config['validators']['shell']  ||= 'sh -n'
+
     # highlightjs syntax style
     @highlightStyle = settings.showoff_config['highlight'] || 'default'
 
@@ -453,7 +447,7 @@ class ShowOff < Sinatra::Application
       end
 
       # Load and replace any file tags
-      content.scan(/(~~~FILE:([^:]*):?(.*)?~~~)/).each do |match|
+      content.scan(/(~~~FILE:([^:~]*):?(.*)?~~~)/).each do |match|
         # make a list of code highlighting classes to include
         css  = match[2].split.collect {|i| "language-#{i.downcase}" }.join(' ')
 
@@ -809,35 +803,10 @@ class ShowOff < Sinatra::Application
         img_path  = Pathname.new(File.join(slide_dir, img[:src])).cleanpath.to_path
         src       = "#{replacement_prefix}/#{img_path}"
         img[:src] = src
-
-        # TDOD: deprecated and to be removed
-        w, h      = get_image_size(img_path)
-        if w && h
-          img[:width]  = w
-          img[:height] = h
-        end
       end
       doc.to_html
     end
 
-    if defined?(Magick)
-      def get_image_size(path)
-        if !cached_image_size.key?(path)
-          img = Magick::Image.ping(path).first
-          # don't set a size for svgs so they can expand to fit their container
-          if img.mime_type == 'image/svg+xml'
-            cached_image_size[path] = [nil, nil]
-          else
-            cached_image_size[path] = [img.columns, img.rows]
-          end
-        end
-        cached_image_size[path]
-      end
-    else
-      def get_image_size(path)
-      end
-    end
-
     def update_commandline_code(slide)
       html = Nokogiri::HTML::DocumentFragment.parse(slide)
       parser = CommandlineParser.new
@@ -1208,7 +1177,7 @@ class ShowOff < Sinatra::Application
     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)
+  def get_code_from_slide(path, index, executable=true)
     if path =~ /^(.*)(?::)(\d+)$/
       path = $1
       num  = $2.to_i
@@ -1216,6 +1185,8 @@ class ShowOff < Sinatra::Application
       num = 1
     end
 
+    classes = executable ? 'code.execute' : 'code'
+
     slide = "#{path}.md"
     return unless File.exist? slide
 
@@ -1227,7 +1198,14 @@ class ShowOff < Sinatra::Application
     html = process_markdown(slide, content, {})
     doc  = Nokogiri::HTML::DocumentFragment.parse(html)
 
-    return doc.css('code.execute')[index.to_i].text rescue 'Invalid code block index'
+    if index == 'all'
+      doc.css(classes).collect do |code|
+        lang = code.attr('class') =~ /language-(\S*)/ ? $1 : nil
+        [lang, code.text]
+      end
+    else
+      doc.css(classes)[index.to_i].text rescue 'Invalid code block index'
+    end
   end
 
   # Basic auth boilerplate

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.12.2'
+SHOWOFF_VERSION = '0.13.0'

data/lib/showoff_utils.rb

@@ -31,19 +31,26 @@ class ShowOffUtils
     @presentation_config_file = filename
   end
 
-  def self.create(dirname,create_samples,dir='one')
+  def self.create(dirname,create_samples,dirs='one')
     FileUtils.mkdir_p(dirname)
     Dir.chdir(dirname) do
-      if create_samples
-        # create section
-        FileUtils.mkdir_p(dir)
+      dirs = dirs.split(',')
 
-        # create markdown file
-        File.open("#{dir}/01_slide.md", 'w+') do |f|
-          f.puts make_slide("My Presentation")
-        end
-        File.open("#{dir}/02_slide.md", 'w+') do |f|
-          f.puts make_slide("Bullet Points","bullets incremental",["first point","second point","third point"])
+      if create_samples
+        dirs.each do |dir|
+          # create section
+          FileUtils.mkdir_p(dir)
+
+          # create markdown file
+          File.open("#{dir}/00_section.md", 'w+') do |f|
+            f.puts make_slide("Section Header", "center subsection")
+          end
+          File.open("#{dir}/01_slide.md", 'w+') do |f|
+            f.puts make_slide("My Presentation")
+          end
+          File.open("#{dir}/02_slide.md", 'w+') do |f|
+            f.puts make_slide("Bullet Points","bullets incremental",["first point","second point","third point"])
+          end
         end
       end
 
@@ -53,7 +60,8 @@ class ShowOffUtils
 
       # create showoff.json
       File.open(ShowOffUtils.presentation_config_file, 'w+') do |f|
-        f.puts JSON.pretty_generate({ "name" => "My Preso", "sections" => [ { "section" => dir } ]})
+        sections = dirs.collect {|dir| {"section" => dir} }
+        f.puts JSON.pretty_generate({ "name" => "My Preso", "sections" => sections })
       end
     end
   end
@@ -76,7 +84,12 @@ class ShowOffUtils
         FileUtils.mkdir_p File.dirname(filename)
 
         File.open(filename, 'w+') do |f|
-          f.puts make_slide("#{filename.sub(/\.md$/, '')}")
+          if filename =~ /section/i
+            # kind of looks like a section slide
+            f.puts make_slide("#{filename.sub(/\.md$/, '')}", "center subsection")
+          else
+            f.puts make_slide("#{filename.sub(/\.md$/, '')}")
+          end
         end
       else
         FileUtils.mkdir_p filename
@@ -84,6 +97,55 @@ class ShowOffUtils
     end
   end
 
+  def self.validate(config)
+    showoff    = ShowOff.new!(:pres_file  => config)
+    validators = showoff.settings.showoff_config['validators'] || {}
+    files      = []
+    errors     = []
+
+    # get a list of actual filenames
+    self.showoff_sections('.').each do |section|
+      if File.directory?(section)
+        files << showoff.load_section_files(section)
+      else
+        files << section
+      end
+    end
+
+    files.flatten!
+    files.each do |filename|
+      unless File.exist? filename
+        errors << "Missing path: #{filename}"
+        next
+      end
+
+      if filename.downcase.end_with? '.md'
+        print '.'
+        showoff.get_code_from_slide(filename.sub('.md',''), 'all', false).each_with_index do |block, index|
+          lang, code = block
+          validator = validators[lang]
+          if validator
+            # write out a tempfile because many validators require files to with
+            Tempfile.open('showoff-validation') do |f|
+              File.write(f.path, code)
+              unless system("#{validator} #{f.path}", :out => File::NULL, :err => File::NULL)
+                print 'F'
+                errors << "Invalid #{lang} code on #{filename} [#{index}]"
+              end
+            end
+          end
+       end
+      end
+    end
+
+    puts
+    puts "Found #{errors.size} errors."
+    unless errors.empty?
+      errors.each { |err| puts " * #{err}" }
+      exit!
+    end
+  end
+
   HEROKU_GEMS_FILE = '.gems'
   HEROKU_BUNDLER_GEMS_FILE = 'Gemfile'
   HEROKU_CONFIG_FILE = 'config.ru'
@@ -263,9 +325,12 @@ class ShowOffUtils
   # name a slide as the last slide in the dir.
   def self.find_next_number(slide_dir)
     slide_dir ||= '.'
-    next_num    = Dir.glob("#{slide_dir}/*.md").size + 1
+    max = Dir.glob("#{slide_dir}/*.md").collect do |f|
+      next unless f =~ /^#{slide_dir}\/(\d+)/
+      $1.to_i
+    end.compact.max || 0
 
-    sprintf("%02d", next_num)
+    sprintf("%02d", max+1)
   end
 
   def self.determine_title(title,slide_name,code)

data/public/css/showoff.css

@@ -47,6 +47,10 @@ pre code {
     overflow: hidden;
   }
 
+  body#download {
+    overflow: auto;
+  }
+
   #preso,
   .slide {
     background: #fff;
@@ -842,7 +846,8 @@ form .element {
   .callout.warning,
   .callout.question,
   .callout.exercise,
-  .callout.stop {
+  .callout.stop,
+  .callout.thumbsup {
     padding-left: 3em;
   }
 
@@ -851,6 +856,7 @@ form .element {
   .callout.question:before { content: "\f059"; } /* fa-question-circle */
   .callout.exercise:before { content: "\f41b"; } /* fa-pencil-square */
   .callout.stop:before     { content: "\f05e"; } /* fa-ban */
+  .callout.thumbsup:before { content: "\f164"; } /* fa-thumbs-up */
 
 /**********************
 ***  end callouts   ***
@@ -957,6 +963,11 @@ form .element {
     border-top: 2px dashed #999;
   }
 
+  .notes-section .callout {
+    margin-right: 1em;
+    margin-left: 1em;
+  }
+
   .notes-section.notes .personal {
     float: right;
     border-left: 2px solid #999;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: showoff
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.13.0
 platform: ruby
 authors:
 - Scott Chacon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-12 00:00:00.000000000 Z
+date: 2016-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -353,10 +353,6 @@ post_install_message: |2+
     means that if you've created your own custom styles, that you'll need to
     refactor them. We do hope you find the new styles simpler and better looking.
 
-    RMagick will be completely removed in the next major release. Pleas migrate
-    away from it now. Browsers can autoscale images on demand pretty well now,
-    so you probably won't miss it much.
-
     Showoff can optionally use the PDFKit gem to build PDF files using the
     `showoff pdf` command. If you'd like your audience to download the PDF,
     place it in `_files/share`.