showoff 0.3.2 → 0.3.3

data/README.rdoc

@@ -47,8 +47,8 @@ ShowOff is meant to be run in a ShowOff formatted repository - that means that i
     $ cd (showoff-repo)
     $ showoff serve
 
-If you run 'showoff' in the ShowOff directory itself, it will show an example
-presentation from the 'example' subdirectory, so you can see what it's like.
+If you run 'showoff' in the example subdirectory of ShowOff itself, it will 
+show an example presentation, so you can see what it's like.
 
 = Slide Format
 
@@ -150,10 +150,10 @@ You can manage the presentation with the following keys:
 
 = Preshow
 
-If you want to show a slideshow while you wait to speak, you can run a preshow.  Add a `_preshow` directory
-to your project (I use a symlink, so I don't have to add all the images into Git), put a bunch of images in the `_preshow` directory and optionally add a `preshow.json` file that provides descriptions for any of the images.
+If you want to show a slideshow while you wait to speak, you can run a preshow.  Add a +_preshow+ directory
+to your project (I use a symlink, so I don't have to add all the images into Git), put a bunch of images in the +_preshow+ directory and optionally add a +preshow+.+json+ file that provides descriptions for any of the images.
 If you then press 'p' at the beginning of your presentation, it will prompt you for a number of minutes until
-you start.  Then it will count down the time until then, flipping through your pictures to entertain the 
+you start.  Then it will count down the time until then, flipping through your pictures to entertain the
 audience in the meantime.  Press 'p' again to stop, or wait until the timer runs out.
 
 = Custom JavaScript
@@ -213,6 +213,41 @@ press the right array key another time, you will switch to the next slide.
 The same applies to the *showoff:prev* event, of course.
 
 
+= Custom Stylesheets
+
+To insert custom Stylesheets into your presentation you can either place it into
+a file (with extension .css) or into the root directory of your presentation or
+you can embed a <+link+>-element directly into your slides. This stylesheet will
+be applied as soon as it is loaded.
+
+The content generated by the slide is wrapped with a +div+ with the class .+content+ like this.
+
+    <div ref="intro/01_slide/1" class="content" style="margin-top: 210px;">
+    <h1>jQuery &amp; Sinatra</h1>
+    <h2>A Classy Combination</h2>
+    </div>
+
+This makes the .+content+ tag a perfect place to add additional styling if that
+is your preference. An example of adding some styling is here.
+
+    .content {
+      color: black;
+      font-family: helvetica, arial;
+    }
+    h1, h2 {
+      color: rgb(79, 180, 226);
+      font-family: Georgia;
+    }
+    .content::after {
+      position: absolute;
+      right: 120px;
+      bottom: 120px;
+      content: url(jay_small.png);
+    }
+
+Note that the example above uses CSS3 styling with ::+after+ and the +content+
+-attribute to add an image to the slides.
+
 = Editor integration
 
 The "add slide" feature can allow you to add the necessary boilerplate from your editor.  If you are using vim, you can
@@ -241,8 +276,8 @@ added where your cursor was.  Binding this to a keybinding can allow you to add
 [<tt>create</tt>] Create new showoff presentation
 [<tt>help</tt>] Shows list of commands or help for one command
 [<tt>heroku</tt>] Setup your presentation to serve on Heroku
-[<tt>heroku_secure</tt>] Setup your presentation to serve on Heroku with password protection
 [<tt>serve</tt>] Serves the showoff presentation in the current directory
+[<tt>static</tt>] Generate static version of presentation
 
 === <tt>add [title]</tt>
 
@@ -283,19 +318,28 @@ Shows list of commands or help for one command
 
 Setup your presentation to serve on Heroku
 
-=== <tt>heroku_secure heroku_name password</tt>
+Creates the Gemfile and config.ru file needed to push a showoff pres to heroku.  It will then run heroku create for you to register the new project on heroku and add the remote for you.  Then all you need to do is commit the new created files and run git push heroku to deploy.
 
-Setup your presentation to serve on Heroku with password protection using HTTP Authentication
+==== Options
+These options are specified *after* the command.
 
+[<tt>-f, --force</tt>] force overwrite of existing Gemfile/.gems and config.ru files if they exist
+[<tt>-g, --dotgems</tt>] Use older-style .gems file instead of bundler-style Gemfile
+[<tt>-p, --password=arg</tt>] add password protection to your heroku site
 === <tt>serve </tt>
 
 Serves the showoff presentation in the current directory
 
 
+
 ==== Options
 These options are specified *after* the command.
 
+[<tt>-h, --host=arg</tt>] Host or ip to run on <i>( default: <tt>localhost</tt>)</i>
 [<tt>-p, --port=arg</tt>] Port on which to run <i>( default: <tt>9090</tt>)</i>
+=== <tt>static name</tt>
+
+Generate static version of presentation
 
 === ZSH completion
 You can complete commands and options in ZSH, by installing a script:
@@ -327,7 +371,7 @@ So far, ShowOff has been used in the following presentations (and many others):
 * Red Dirt Ruby Conference May 2010 - Plain Old Tokyo Storage - Jeremy Hinegardner
   http://github.com/copiousfreetime/plain-old-tokyo-storage-presentation
   http://plain-old-tokyo-storage.heroku.com/
-* Lambda Lounge - JavaScript Functions : The Good Parts - Idioms for Encapsulation and Inheritance - Scott Bale
+* Lambda Lounge and StrangeLoop 2010 - JavaScript Functions : The Good Parts - Idioms for Encapsulation and Inheritance - Scott Bale
   http://github.com/scottbale/JavaScript-Function-Idioms
 * Open Source Bridge 2010 - Creating a low-cost clustered virtualization environment w/ Ganeti - Lance Albertson
   http://github.com/ramereth/presentation-ganeti
@@ -379,6 +423,7 @@ etc).
 * json
 * GLI gem
 * Firefox or Chrome to present
+* PDFKit (optional, for generating PDF of presentation) https://github.com/jdpace/PDFKit
 
 = Contributing
 

data/bin/showoff

@@ -25,26 +25,24 @@ command [:create,:init] do |c|
   end
 end
 
-desc 'Same as heroku create, but also adds password protection'
-arg_name 'heroku_name password'
-long_desc 'Creates the .gems file and config.ru file needed to push a showoff pres to heroku with password protection.  it will then run ''heroku create'' for you to register the new project on heroku and add the remote for you.  then all you need to do is commit the new created files and run ''git push heroku'' to deploy.'
-command :heroku_secure do |c|
-  c.action do |global_options,options,args|
-		p args
-    raise "heroku_name is required" if args.empty?
-    raise "password is required" if args.length == 1
-    ShowOffUtils.heroku_secure(args[0], args[1])
-  end
-end
-
 desc 'Serves the showoff presentation in the current directory'
 desc 'Setup your presentation to serve on Heroku'
 arg_name 'heroku_name'
-long_desc 'Creates the .gems file and config.ru file needed to push a showoff pres to heroku.  it will then run ''heroku create'' for you to register the new project on heroku and add the remote for you.  then all you need to do is commit the new created files and run ''git push heroku'' to deploy.'
+long_desc 'Creates the Gemfile and config.ru file needed to push a showoff pres to heroku.  It will then run ''heroku create'' for you to register the new project on heroku and add the remote for you.  Then all you need to do is commit the new created files and run ''git push heroku'' to deploy.'
 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.desc 'Use older-style .gems file instead of bundler-style Gemfile'
+  c.switch [:g,:dotgems]
+
   c.action do |global_options,options,args|
     raise "heroku_name is required" if args.empty?
-    ShowOffUtils.heroku(args[0])
+    ShowOffUtils.heroku(args[0],options[:f],options[:p],options[:g])
   end
 end
 

data/lib/showoff.rb

@@ -13,9 +13,9 @@ rescue LoadError
 end
 
 begin
-  require 'princely'
+  require 'pdfkit'
 rescue LoadError
-  puts 'pdf generation disabled - install princely'
+  puts 'pdf generation disabled - install PDFKit'
 end
 
 begin
@@ -233,6 +233,10 @@ class ShowOff < Sinatra::Application
       js_content
     end
 
+    def inline_all_js(jses_directory)
+       inline_js(Dir.entries(File.join(File.dirname(__FILE__), '..', jses_directory)).find_all{|filename| filename.length > 2 }, jses_directory)
+    end
+
     def index(static=false)
       if static
         @title = ShowOffUtils.showoff_title
@@ -288,14 +292,18 @@ class ShowOff < Sinatra::Application
       erb :onepage
     end
 
-    def pdf(static=false)
+    def pdf(static=true)
       @slides = get_slides_html(static)
-      @no_js = true
+      @no_js = false
       html = erb :onepage
-      p = Princely.new
       # TODO make a random filename
-      p.pdf_from_string_to_file(html, '/tmp/preso.pdf')
-      File.new('/tmp/preso.pdf')
+
+      # PDFKit.new takes the HTML and any options for wkhtmltopdf
+      # run `wkhtmltopdf --extended-help` for a full list of options
+      kit = PDFKit.new(html, :page_size => 'Letter', :orientation => 'Landscape')
+
+      # Save the PDF to a file
+      file = kit.to_file('/tmp/preso.pdf')
     end
 
   end

data/lib/showoff_utils.rb

@@ -28,69 +28,67 @@ class ShowOffUtils
     end
   end
 
+  HEROKU_GEMS_FILE = '.gems'
+  HEROKU_BUNDLER_GEMS_FILE = 'Gemfile'
+  HEROKU_CONFIG_FILE = 'config.ru'
+
 	# Setup presentation to run on Heroku
-  def self.heroku(name)
+  #
+  # name         - String containing heroku name
+  # force        - boolean if .gems/Gemfile and config.ru should be overwritten if they don't exist
+  # password     - String containing password to protect your heroku site; nil means no password protection
+  # use_dot_gems - boolea that, if true, indicates we should use the old, deprecated .gems file instead of Bundler
+  def self.heroku(name,force,password,use_dot_gems)
     if !File.exists?(SHOWOFF_JSON_FILE)
       puts "fail. not a showoff directory"
       return false
     end
-    # create .gems file
-    File.open('.gems', 'w+') do |f|
-      f.puts "bluecloth"
-      f.puts "nokogiri"
-      f.puts "showoff"
-      f.puts "gli"
-    end if !File.exists?('.gems')
-
-    # create config.ru file
-    File.open('config.ru', 'w+') do |f|
-      f.puts 'require "showoff"'
-      f.puts 'run ShowOff.new'
-    end if !File.exists?('config.ru')
-
-    puts "herokuized. run something like this to launch your heroku presentation:
-
-      heroku create #{name}
-      git add .gems config.ru
-      git commit -m 'herokuized'
-      git push heroku master
-    "
-  end
 
-	# Setup the presentation to run on Heroku with password protection
-  def self.heroku_secure(name, password)
-    if !File.exists?(SHOWOFF_JSON_FILE)
-      puts "fail. not a showoff directory"
-      return false
+    modified_something = false
+
+    if use_dot_gems
+      modified_something = create_gems_file(HEROKU_GEMS_FILE,
+                                            !password.nil?,
+                                            force,
+                                            lambda{ |gem| gem })
+    else
+      modified_something = create_gems_file(HEROKU_BUNDLER_GEMS_FILE,
+                                            !password.nil?,
+                                            force,
+                                            lambda{ |gem| "gem '#{gem}'" },
+                                            lambda{ "source :rubygems" })
+    end
+
+    create_file_if_needed(HEROKU_CONFIG_FILE,force) do |file|
+      modified_something = true
+      file.puts 'require "showoff"'
+      if password.nil?
+        file.puts 'run ShowOff.new'
+      else
+        file.puts 'require "rack"'
+        file.puts 'showoff_app = ShowOff.new'
+        file.puts 'protected_showoff = Rack::Auth::Basic.new(showoff_app) do |username, password|'
+        file.puts	"\tpassword == '#{password}'"
+        file.puts 'end'
+        file.puts 'run protected_showoff'
+      end
     end
-    # create .gems file
-    File.open('.gems', 'w+') do |f|
-      f.puts "bluecloth"
-      f.puts "nokogiri"
-      f.puts "showoff"
-      f.puts "gli"
-      f.puts "rack"
-    end if !File.exists?('.gems')
-
-    # create config.ru file
-    File.open('config.ru', 'w+') do |f|
-      f.puts 'require "rack"'
-      f.puts 'require "showoff"'
-			f.puts 'showoff_app = ShowOff.new'
-			f.puts 'protected_showoff = Rack::Auth::Basic.new(showoff_app) do |username, password|'
-			f.puts	"\tpassword == '#{password}'"
-			f.puts 'end'
-			f.puts 'run protected_showoff'
-
-    end if !File.exists?('config.ru')
-
-    puts "herokuized. run something like this to launch your heroku presentation:
-
-      heroku create #{name}
-      git add .gems config.ru
-      git commit -m 'herokuized'
+
+    if modified_something
+      puts "herokuized. run something like this to launch your heroku presentation:
+
+      heroku create #{name}"
+
+      if use_dot_gems
+      puts "        git add #{HEROKU_GEMS_FILE} #{HEROKU_CONFIG_FILE}"
+      else
+      puts "      bundle install
+      git add Gemfile.lock #{HEROKU_GEMS_FILE} #{HEROKU_CONFIG_FILE}"
+      end
+      puts "      git commit -m 'herokuized'
       git push heroku master
-    "
+      "
+    end
   end
 
   # Makes a slide as a string.
@@ -293,4 +291,52 @@ class ShowOffUtils
     ext = File.extname(source_file).gsub(/^\./,'')
     EXTENSIONS[ext] || ext
   end
+
+  REQUIRED_GEMS = %w(bluecloth nokogiri showoff gli)
+
+  # Creates the file that lists the gems for heroku
+  #
+  # filename  - String name of the file
+  # password  - Boolean to indicate if we are setting a password
+  # force     - Boolean to indicate if we should overwrite the existing file
+  # formatter - Proc/lambda that takes 1 argument, the gem name, and formats it for the file
+  #             This is so we can support both the old .gems and the new bundler Gemfile
+  # header    - Proc/lambda that creates any header information in the file
+  #
+  # Returns a boolean indicating that we had to create the file or not.
+  def self.create_gems_file(filename,password,force,formatter,header=nil)
+    create_file_if_needed(filename,force) do |file|
+      file.puts header.call unless header.nil?
+      REQUIRED_GEMS.each { |gem| file.puts formatter.call(gem) }
+      file.puts formatter.call("rack") if password
+    end
+  end
+
+  # Creates the given filename if it doesn't exist or if force is true
+  #
+  # filename - String name of the file to create
+  # force    - if true, the file will always be created, if false, only create
+  #            if it's not there
+  # block    - takes a block that will be given the file handle to write
+  #            data into the file IF it's being created
+  #
+  # Examples
+  #
+  #   create_file_if_needed("config.ru",false) do |file|
+  #     file.puts "require 'showoff'"
+  #     file.puts "run ShowOff.new"
+  #   end
+  #
+  # Returns true if the file was created
+  def self.create_file_if_needed(filename,force)
+    if !File.exists?(filename) || force
+      File.open(filename, 'w+') do |f|
+        yield f
+      end
+      true
+    else
+      puts "#{filename} exists; not overwriting (see showoff help heroku)"
+      false
+    end
+  end
 end

data/public/js/showoff.js

@@ -86,6 +86,7 @@ function initializePresentation(prefix) {
 	}
 	setupSlideParamsCheck();
 	sh_highlightDocument(prefix+'/js/sh_lang/', '.min.js')
+	$(".preso").trigger("showoff:loaded");
 }
 
 function centerSlides(slides) {

data/views/onepage.erb

@@ -18,6 +18,7 @@
 
   <% if !@no_js %>
     <%= inline_js(['jquery-1.4.2.min.js', 'jquery-print.js', 'showoff.js', 'onepage.js', 'sh_main.min.js', 'core.js', 'showoffcore.js'], 'public/js') %>
+    <%= inline_all_js('public/js/sh_lang') %>
     <script type="text/javascript">
     $(document).ready(function() {
       setupOnePage()

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: showoff
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 3
-  - 2
-  version: 0.3.2
+  - 3
+  version: 0.3.3
 platform: ruby
 authors: 
 - Scott Chacon