showoff 0.20.1 → 0.20.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 604368cbb77db12fb0528dac9cb0155bebeff3be
-  data.tar.gz: 4129294c1e8c011521510f0496844b087247d52b
+SHA256:
+  metadata.gz: f61b9fc523ec9e56d30f4b62952fb0de93ffbba83f588fd9e753165cfb40fb3f
+  data.tar.gz: 9518221ae954431b7ac93a70e9f4fd6cd3e9fa6f0488993bd02b6602eb79bc67
 SHA512:
-  metadata.gz: 76e812ebaef4a6bd9279042bbfda4b02242cece988974506a9be49a097a6fd38696f40f68b0dce344c8354c0dcc4072a7ea21b1a7e247f2a399d601ce8fee4da
-  data.tar.gz: 850bf03967777e5d5101d6c7e8f44a5207a92086301d58f1ad95a99af6e2c6d62c95c7faf48226b1a85b302b9b117b948147fc4487a8cb97e12779003909e14b
+  metadata.gz: f5689f7fa30e67f3ad90699ef5611efe9809cbe20ac30a48fcfd65170632f2b4dc44b6292f4848f41ee04034a096c705860b11ec2f2f9ac49fd0ec1e22c0ebe2
+  data.tar.gz: 21b8af225ff1582354b3c82f4345b76fa354d249a3eedb1bf35c771073fbb8f6a43ccb442cf2dc8f60d8a7cce8ab42dac835b22e6cade3023dcb196b18c7a0e1

data/Rakefile

@@ -67,21 +67,33 @@ task 'doc:website' => [:doc] do
   end
 end
 
-desc "Run tests"
-task :test do
-  require 'rake/testtask'
-
-  Rake::TestTask.new do |t|
-    t.libs << 'lib'
-    t.pattern = 'test/**/*_test.rb'
-    t.verbose = false
+# These tests are currently unmaintained.
+# @todo: port and delete
+#
+# desc "Run tests"
+# task :test do
+#   require 'rake/testtask'
+#
+#   Rake::TestTask.new do |t|
+#     t.libs << 'lib'
+#     t.pattern = 'test/**/*_test.rb'
+#     t.verbose = false
+#   end
+#
+#   suffix = "-n #{ENV['TEST']}" if ENV['TEST']
+#   sh "turn test/*_test.rb #{suffix}"
+# end
+
+desc "Run RSpec unit tests"
+task :spec do
+  ENV["LOG_SPEC_ORDER"] = "true"
+  if ENV['verbose'] == 'true'
+    sh %{rspec #{ENV['TEST'] || ENV['TESTS'] || 'spec'} -fd}
+  else
+    sh %{rspec #{ENV['TEST'] || ENV['TESTS'] || 'spec'}}
   end
-
-  suffix = "-n #{ENV['TEST']}" if ENV['TEST']
-  sh "turn test/*_test.rb #{suffix}"
 end
 
-
 desc 'Validate translation files'
 task 'lang:check' do
   require 'yaml'

data/bin/showoff

@@ -1,7 +1,7 @@
 #! /usr/bin/env ruby
 
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
-require 'showoff'
+#require 'showoff'
 require 'showoff/version'
 require 'rubygems'
 require 'fidget'
@@ -16,7 +16,7 @@ module Wrapper
   program_desc <<-desc
   A web based presentation engine with awesome interaction features.
 
-    ShowOff uses Markdown files with a few custom extensions to generate slides
+    Showoff uses Markdown files with a few custom extensions to generate slides
     that are served locally for presentation via web browser. Your audience can
     view presentations directly as well, and interact with you in many ways.
 
@@ -28,7 +28,8 @@ module Wrapper
     The simplest use case is to run `showoff serve` from the directory containing
     the showoff.json file.
   desc
-
+  switch :dev, :desc => "Use the next-gen development version of Showoff"
+  switch :debug, :desc => "Show application backtraces on crash"
 
   desc 'Create new showoff presentation'
   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.'
@@ -43,9 +44,9 @@ module Wrapper
 
     c.action do |global_options,options,args|
       dir_name = args.first || '.'
-      ShowOffUtils.create(dir_name,!options[:n],options[:d])
+      ShowoffUtils.create(dir_name,!options[:n],options[:d])
       if options[:n]
-        puts "Add slides and update #{dir_name}/#{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"
@@ -63,7 +64,7 @@ module Wrapper
     c.flag [:f,:file]
 
     c.action do |global_options,options,args|
-      ShowOffUtils.skeleton(options[:f])
+      ShowoffUtils.skeleton(options[:f])
       puts "done. run 'showoff serve' to see your slideshow"
     end
   end
@@ -79,7 +80,7 @@ module Wrapper
     c.switch [:j,:json]
 
     c.action do |global_options,options,args|
-      ShowOffUtils.info(options[:f], options[:j])
+      ShowoffUtils.info(options[:f], options[:j])
     end
   end
 
@@ -91,7 +92,7 @@ module Wrapper
     c.flag [:f,:file]
 
     c.action do |global_options,options,args|
-      ShowOffUtils.validate(options[:f])
+      ShowoffUtils.validate(options[:f])
     end
   end
 
@@ -100,7 +101,7 @@ module Wrapper
   command :github do |c|
     c.action do |global_options,options,args|
       puts "Generating static content"
-      ShowOffUtils.github
+      ShowoffUtils.github
       puts "I've updated your 'gh-pages' branch with the static version of your presentation."
       puts "Push it to GitHub to publish it. Probably something like:"
       puts
@@ -126,16 +127,16 @@ module Wrapper
       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.")
+        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.')
+      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"')
-          ShowOffUtils.command('git push heroku master')
+          ShowoffUtils.command('git add Procfile Gemfile Gemfile.lock config.ru')
+          ShowoffUtils.command('git commit -m "Herokuized by Showoff"')
+          ShowoffUtils.command('git push heroku master')
         rescue => e
           puts 'Git operations failed. Please correct issues, then manually commit the following files:'
           puts ' * Procfile'
@@ -212,7 +213,7 @@ module Wrapper
 
       # This is gross. A serious revamp in config file parsing is due.
       config = JSON.parse(File.read(options[:f])) rescue {}
-      if Gem::Version.new(config['version']) > Gem::Version.new(SHOWOFF_VERSION) then
+      if Gem::Version.new(config['version'].to_s) > Gem::Version.new(SHOWOFF_VERSION) then
         raise "This presentation requires Showoff version #{config['version']} or greater."
       end
 
@@ -239,7 +240,7 @@ module Wrapper
       puts "
   -------------------------
 
-  Your ShowOff presentation is now starting up.
+  Your Showoff presentation is now starting up.
 
   To view it plainly, visit [ #{url} ]
 
@@ -255,8 +256,8 @@ module Wrapper
       end
 
       if options[:url]
-        ShowOffUtils.clone(options[:git_url], options[:git_branch], options[:git_path]) do
-          ShowOff.run!(options) do |server|
+        ShowoffUtils.clone(options[:git_url], options[:git_branch], options[:git_path]) do
+          Showoff.run!(options) do |server|
             if options[:ssl]
               server.ssl         = true
               server.ssl_options = ssl_options
@@ -265,7 +266,7 @@ module Wrapper
         end
 
       else
-        ShowOff.run!(options) do |server|
+        Showoff.run!(options) do |server|
           if options[:ssl]
             server.ssl         = true
             server.ssl_options = ssl_options
@@ -302,7 +303,7 @@ module Wrapper
 
     c.action do |global_options,options,args|
       title = args.join(" ")
-      ShowOffUtils.add_slide(:dir => options[:d],
+      ShowoffUtils.add_slide(:dir => options[:d],
                              :name => options[:n],
                              :title => title,
                              :number => !options[:u],
@@ -323,7 +324,7 @@ module Wrapper
     c.flag [:l, :lang, :language, :locale]
 
     c.action do |global_options,options,args|
-      ShowOff.do_static(args, options)
+      Showoff.do_static(args, options)
     end
   end
 
@@ -331,15 +332,37 @@ module Wrapper
   arg_name 'name'
   long_desc 'Creates a PDF version of the presentation as {name}.pdf'
   command [:pdf] do |c|
+    c.desc 'JSON file used to describe presentation'
+    c.default_value "showoff.json"
+    c.flag [:f, :file, :pres_file]
+
+    c.desc 'Language code to generate.'
+    c.flag [:l, :lang, :language, :locale]
+
     c.action do |global_options,options,args|
-      ShowOff.do_static(['pdf'].concat args)
+      Showoff.do_static(['pdf'].concat(args), options)
     end
   end
 
   pre do |global,command,options,args|
     # Pre logic here
-    # Return true to proceed; false to abourt and not call the
+    # Return true to proceed; false to abort and not call the
     # chosen command
+
+    if global[:debug]
+      ENV['GLI_DEBUG'] = 'true'
+    end
+
+    if global[:dev]
+      require 'showoff_ng'
+
+      if options[:file]
+        Showoff::Config.load(options[:file])
+      end
+    else
+      require 'showoff'
+    end
+
     true
   end
 

data/lib/showoff.rb

@@ -28,7 +28,7 @@ end
 
 require 'tilt'
 
-class ShowOff < Sinatra::Application
+class Showoff < Sinatra::Application
 
   attr_reader :cached_image_size
 
@@ -92,13 +92,13 @@ class ShowOff < Sinatra::Application
 
     settings.pres_dir = File.expand_path(settings.pres_dir)
     if (settings.pres_file and settings.pres_file != 'showoff.json')
-      ShowOffUtils.presentation_config_file = settings.pres_file
+      ShowoffUtils.presentation_config_file = settings.pres_file
     end
 
     # Load configuration for page size and template from the
     # configuration JSON file
-    if File.exist?(ShowOffUtils.presentation_config_file)
-      showoff_json = JSON.parse(File.read(ShowOffUtils.presentation_config_file))
+    if File.exist?(ShowoffUtils.presentation_config_file)
+      showoff_json = JSON.parse(File.read(ShowoffUtils.presentation_config_file))
       settings.showoff_config = showoff_json
 
       # Set options for encoding, template and page size
@@ -205,7 +205,7 @@ class ShowOff < Sinatra::Application
       Thread.new do
         loop do
           sleep 30
-          ShowOff.flush
+          Showoff.flush
         end
       end
     end
@@ -214,7 +214,7 @@ class ShowOff < Sinatra::Application
     MarkdownConfig::setup(settings.pres_dir)
 
     # Process renderer config options
-    @engine_options = ShowOffUtils.showoff_renderer_options(settings.pres_dir)
+    @engine_options = ShowoffUtils.showoff_renderer_options(settings.pres_dir)
 
   end
   # save stats to disk
@@ -245,7 +245,7 @@ class ShowOff < Sinatra::Application
 
   def self.pres_dir_current
     opt = {:pres_dir => Dir.pwd}
-    ShowOff.set opt
+    Showoff.set opt
   end
 
   def require_ruby_files
@@ -369,7 +369,7 @@ class ShowOff < Sinatra::Application
 
         # Parse the context string for options and content classes
         if context and context.match(/(\[(.*?)\])?(.*)/)
-          options = ShowOffUtils.parse_options($2)
+          options = ShowoffUtils.parse_options($2)
           @tpl = options["tpl"] if options["tpl"]
           @bg = options["bg"] if options["bg"]
           @classes += $3.strip.chomp('>').split if $3
@@ -573,7 +573,21 @@ class ShowOff < Sinatra::Application
 
       # Now check for any kind of options
       content.scan(/(~~~CONFIG:(.*?)~~~)/).each do |match|
-        result.gsub!(match[0], settings.showoff_config[match[1]]) if settings.showoff_config.key?(match[1])
+        parts = match[1].split('.') # Use dots ('.') to separate Hash keys
+        if parts.size > 1
+          value = settings.showoff_config.dig(parts[0]).to_h.dig(*parts[1..-1])
+        else
+          value = settings.showoff_config.fetch(parts[0],nil)
+        end
+
+        unless value.is_a?(String)
+          msg = "#{match[0]} refers to a non-String data type (#{value.class})"
+          msg = "#{match[0]}: not found in settings data" if value.nil?
+          @logger.warn(msg)
+          next
+        end
+
+        result.gsub!(match[0], value)
       end
 
       # Load and replace any file tags
@@ -1151,7 +1165,7 @@ class ShowOff < Sinatra::Application
     def get_slides_html(opts={:static=>false, :pdf=>false, :toc=>false, :supplemental=>nil, :section=>nil})
       sections = nil
       Dir.chdir(get_locale_dir('locales', @locale)) do
-        sections = ShowOffUtils.showoff_sections(settings.pres_dir, settings.showoff_config, @logger)
+        sections = ShowoffUtils.showoff_sections(settings.pres_dir, settings.showoff_config, @logger)
       end
 
       if sections
@@ -1219,9 +1233,9 @@ class ShowOff < Sinatra::Application
 
     def index(static=false)
       if static
-        @title = ShowOffUtils.showoff_title(settings.pres_dir)
+        @title = ShowoffUtils.showoff_title(settings.pres_dir)
         @slides = get_slides_html(:static=>static)
-        @pause_msg = ShowOffUtils.pause_msg
+        @pause_msg = ShowoffUtils.pause_msg
       end
 
       # Display favicon in the window if configured
@@ -1303,7 +1317,7 @@ class ShowOff < Sinatra::Application
       @logger.info "Generating locale: #{@locale}"
 
       # If we're displaying from a repository, let's update it
-      ShowOffUtils.update(settings.verbose) if settings.url
+      ShowoffUtils.update(settings.verbose) if settings.url
 
       @@slide_titles = []
       content = get_slides_html(:static=>static, :merged=>merged)
@@ -1450,7 +1464,7 @@ class ShowOff < Sinatra::Application
 
       # PDFKit.new takes the HTML and any options for wkhtmltopdf
       # run `wkhtmltopdf --extended-help` for a full list of options
-      kit = PDFKit.new(html, ShowOffUtils.showoff_pdf_options(settings.pres_dir))
+      kit = PDFKit.new(html, ShowoffUtils.showoff_pdf_options(settings.pres_dir))
 
       # Save the PDF to a file
       kit.to_file(name)
@@ -1464,11 +1478,11 @@ class ShowOff < Sinatra::Application
       what   = args[0] || "index"
       opt    = args[1]
 
-      ShowOffUtils.presentation_config_file = opts[:f]
+      ShowoffUtils.presentation_config_file = opts[:f]
 
       # Sinatra now aliases new to new!
       # https://github.com/sinatra/sinatra/blob/v1.3.3/lib/sinatra/base.rb#L1369
-      showoff = ShowOff.new!
+      showoff = Showoff.new!
 
       name = showoff.instance_variable_get(:@pres_name)
       path = showoff.instance_variable_get(:@root_path)
@@ -1504,6 +1518,8 @@ class ShowOff < Sinatra::Application
         ["js", "css"].each { |dir|
           FileUtils.copy_entry("#{my_path}/#{dir}", "#{out}/#{dir}", false, false, true)
         }
+
+        # @todo: uh. I don't know how this ever worked. my_path is showoff and name is presentation.
         # And copy the directory
         Dir.glob("#{my_path}/#{name}/*").each { |subpath|
           base = File.basename(subpath)
@@ -1519,7 +1535,12 @@ class ShowOff < Sinatra::Application
 
         # ..., copy all user-defined styles and javascript files
         showoff.css_files.each { |path|
-          dest = File.join(file_dir, path)
+          dest = File.join(out, path)
+          FileUtils.mkdir_p(File.dirname(dest))
+          FileUtils.copy(path, dest)
+        }
+        showoff.js_files.each { |path|
+          dest = File.join(out, path)
           FileUtils.mkdir_p(File.dirname(dest))
           FileUtils.copy(path, dest)
         }
@@ -1950,8 +1971,8 @@ class ShowOff < Sinatra::Application
   # gawd, this whole routing scheme is bollocks
   get %r{/([^/]*)/?([^/]*)} do
     @locale    = locale(request.cookies['locale'])
-    @title     = ShowOffUtils.showoff_title(settings.pres_dir)
-    @pause_msg = ShowOffUtils.pause_msg
+    @title     = ShowoffUtils.showoff_title(settings.pres_dir)
+    @pause_msg = ShowoffUtils.pause_msg
     what = params[:captures].first
     opt  = params[:captures][1]
     what = 'index' if "" == what
@@ -1966,6 +1987,8 @@ class ShowOff < Sinatra::Application
       if (what != "favicon.ico")
         if ['supplemental', 'print'].include? what
           data = send(what, opt)
+        elsif File.file? what
+          data = File.open(what)
         else
           data = send(what)
         end
@@ -1989,7 +2012,7 @@ class ShowOff < Sinatra::Application
   end
 
   at_exit do
-    ShowOff.flush
+    Showoff.flush
   end
 
 end

data/lib/showoff/compiler.rb

@@ -0,0 +1,106 @@
+require 'tilt'
+require 'tilt/erb'
+require 'nokogiri'
+
+class Showoff::Compiler
+  require 'showoff/compiler/form'
+  require 'showoff/compiler/variables'
+  require 'showoff/compiler/fixups'
+  require 'showoff/compiler/i18n'
+  require 'showoff/compiler/notes'
+  require 'showoff/compiler/glossary'
+  require 'showoff/compiler/downloads'
+  require 'showoff/compiler/table_of_contents'
+
+  def initialize(options)
+    @options = options
+    @profile = profile
+  end
+
+  # Configures Tilt with the selected engine and options.
+  #
+  # Returns render options profile hash
+  #
+  # Source:
+  #  https://github.com/puppetlabs/showoff/blob/3f43754c84f97be4284bb34f9bc7c42175d45226/lib/showoff_utils.rb#L671-L720
+  # TODO: per slide profiles of render options
+  def profile
+    renderer = Showoff::Config.get('markdown')
+    profile  = Showoff::Config.get(renderer)
+
+    begin
+      # Load markdown configuration
+      case renderer
+      when 'rdiscount'
+        Tilt.prefer Tilt::RDiscountTemplate, "markdown"
+
+      when 'maruku'
+        Tilt.prefer Tilt::MarukuTemplate, "markdown"
+        # Now check if we can go for latex mode
+        require 'maruku'
+        require 'maruku/ext/math'
+
+        if profile[:use_tex]
+          MaRuKu::Globals[:html_math_output_mathml] = false
+          MaRuKu::Globals[:html_math_output_png]    = true
+          MaRuKu::Globals[:html_math_engine]        = 'none'
+          MaRuKu::Globals[:html_png_engine]         = 'blahtex'
+          MaRuKu::Globals[:html_png_dir]            = profile[:png_dir]
+          MaRuKu::Globals[:html_png_url]            = profile[:html_png_url]
+        end
+
+      when 'bluecloth'
+        Tilt.prefer Tilt::BlueClothTemplate, "markdown"
+
+      when 'kramdown'
+        Tilt.prefer Tilt::KramdownTemplate, "markdown"
+
+      when 'commonmarker', 'commonmark'
+        Tilt.prefer Tilt::CommonMarkerTemplate, "markdown"
+
+      when 'redcarpet', :default
+        Tilt.prefer Tilt::RedcarpetTemplate, "markdown"
+
+      else
+        raise 'Unsupported markdown renderer'
+
+      end
+    rescue LoadError
+      puts "ERROR: The #{renderer} markdown rendering engine does not appear to be installed correctly."
+      exit! 1
+    end
+
+    profile
+  end
+
+  # Compiles markdown and all Showoff extensions into the final HTML output and notes.
+  #
+  # @param content [String] markdown content.
+  # @return [[String, Array<String>]] A tuple of (html content, array of notes contents)
+  #
+  # @todo I think the update_image_paths() malarky is redundant. Verify that.
+  def render(content)
+    Variables::interpolate!(content)
+    I18n.selectLanguage!(content)
+
+    html = Tilt[:markdown].new(nil, nil, @profile) { content }.render
+    doc  = Nokogiri::HTML::DocumentFragment.parse(html)
+
+    Form.render!(doc, @options)
+    Fixups.updateClasses!(doc)
+    Fixups.updateLinks!(doc)
+    Fixups.updateSyntaxHighlighting!(doc)
+    Fixups.updateCommandlineBlocks!(doc)
+    Fixups.updateImagePaths!(doc, @options)
+    Glossary.render!(doc)
+    Downloads.scanForFiles!(doc, @options)
+
+    # This call must be last in the chain because it separates notes from the
+    # content and returns them separately. If it's not last, then the notes
+    # won't have all the compilation steps applied to them.
+    #
+    # must pass in extra context because this will render markdown itself
+    Notes.render!(doc, @profile, @options)
+  end
+
+end