showoff 0.1.4 → 0.2.0

data/README.rdoc

@@ -0,0 +1,280 @@
+= ShowOff Presentation Software
+
+ShowOff is a Sinatra web app that reads simple configuration files for a
+presentation.  It is sort of like a Keynote web app engine - think S5 +
+Slidedown.  I am using it to do all my talks in 2010, because I have a deep
+hatred in my heart for Keynote and yet it is by far the best in the field.
+
+The idea is that you setup your markdown slide files in section subdirectories
+and then startup the showoff server in that directory.  It will read in your
+showoff.json file for which sections go in which order and then will give
+you a URL to present from.
+
+It can:
+
+* show simple text
+* show images
+* show syntax highlighted code
+* bullets with incremental advancing
+* re-enact command line interactions
+* call up a menu of sections/slides at any time to jump around
+* execute javascript or ruby live and display results
+* do simple transitions (instant, fade, slide in)
+
+It might will can:
+
+* show a timer - elapsed / remaining
+* perform simple animations of images moving between keyframes
+* show syncronized, hidden notes on another browser (like an iphone)
+* show audience questions / comments (twitter or direct)
+* let audience members go back / catch up as you talk
+* let audience members vote on sections (?)
+* broadcast itself on Bonjour
+* let audience members download slides, code samples or other supplementary material
+
+Some of the nice things are that you can easily version control it, you
+can easily move sections between presentations, and you can rearrange or
+remove sections easily.
+
+= Usage
+
+ShowOff is meant to be run in a ShowOff formatted repository - that means that it has a showoff.json file and a number of sections (subdirectories) with markdown files for the slides you're presenting.
+
+    $ gem install showoff
+    $ git clone (showoff-repo)
+    $ 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.
+
+= Slide Format
+
+You can break your slides up into sections of however many subdirectories deep
+you need.  ShowOff will recursively check all the directories mentioned in
+your showoff.json file for any markdown files (.md).  Each markdown file can
+have any number of slides in it, seperating each slide with the '!SLIDE'
+keyword and optional slide styles.
+
+For example, if you run 'showoff create my_new_pres' it will create a new
+starter presentation for you with one .md file at one/slide.md which will have
+the following contents:
+
+    !SLIDE
+
+    # My Presentation #
+
+    !SLIDE bullets incremental transition=fade
+
+    # Bullet Points #
+
+    * first point
+    * second point
+    * third point
+
+That represents two slides, the first contains just a large title, and the
+second is faded into view showing the title and three bullets that are then
+incrementally shown. In order for ShowOff to see those slides, your 
+showoff.json file needs to look something like this:
+
+    [
+      {"section":"one"}
+    ]
+
+If you have multiple sections in your talk, you can make this json array
+include all the sections you want to show in which order you want to show
+them.
+
+Some useful styles for each slide are:
+
+* center - centers images on a slide
+* full-page - allows an image to take up the whole slide
+* bullets - sizes and seperates bullets properly (fits up to 5, generally)
+* smbullets - sizes and seperates more bullets (smaller, closer together)
+* subsection - creates a different background for titles
+* command - monospaces h1 title slides
+* commandline - for pasted commandline sections (needs leading '$' for commands, then output on subsequent lines)
+* code - monospaces everything on the slide
+* incremental - can be used with 'bullets' and 'commandline' styles, will incrementally update elements on arrow key rather than switch slides
+* small - make all slide text 80%
+* smaller - make all slide text 70%
+* execute - on js highlighted code slides, you can click on the code to execute it and display the results on the slide
+
+Check out the example directory included to see examples of most of these.
+
+Transitions can be supplied through the use of transition=tname on the !SLIDE
+definition, where tname is one of the following supported transitions:
+
+* blindX
+* blindY
+* blindZ
+* cover
+* curtainX
+* curtainY
+* fade
+* fadeZoom
+* growX
+* growY
+* none (this is the default)
+* scrollUp
+* scrollDown
+* scrollLeft
+* scrollRight
+* scrollHorz
+* scrollVert
+* shuffle
+* slideX
+* slideY
+* toss
+* turnUp
+* turnDown
+* turnLeft
+* turnRight
+* uncover
+* wipe
+* zoom
+
+The transitions are provided by jQuery Cycle plugin. See http://www.malsup.com/jquery/cycle/browser.html to view the effects and http://www.malsup.com/jquery/cycle/adv2.html for how to add custom effects.
+
+You can manage the presentation with the following keys:
+
+* space, cursor right: next slide
+* cursor left: previous slide
+* d: debug mode
+* c: table of contents (vi)
+* f: toggle footer
+* z: toggle help
+
+= Editor integration
+
+The "add slide" feature can allow you to add the necessary boilerplate from your editor.  If you are using vim, you can
+
+    !showoff add -t code Check This Code
+
+And your buffer will get
+
+    !SLIDE 
+    # Check This Code #
+        @@@ Ruby
+        code_here()
+
+added where your cursor was.  Binding this to a keybinding can allow you to add new slides quickly.
+
+= Command Line Interface
+
+    showoff command_name [command-specific options] [--] arguments...
+
+* Use the command +help+ to get a summary of commands
+* Use the command <tt>help command_name</tt> to get a help for +command_name+
+* Use <tt>--</tt> to stop command line argument processing; useful if your arguments have dashes in them
+
+== Commands
+[<tt>add</tt>] Add a new slide at the end in a given dir
+[<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>serve</tt>] Serves the showoff presentation in the current directory
+
+=== <tt>add [title]</tt>
+
+Add a new slide at the end in a given dir
+
+*Aliases*
+* <tt><b>new</b></tt>
+
+Outputs or creates a new slide.  With -d and -n, a new slide is created in the given dir, numbered to appear as the last slide in that dir (use -u to avoid numbering).  Without those, outputs the slide markdown to stdout (useful for shelling out from your editor). You may also specify a source file to use for a code slide
+
+==== Options
+These options are specified *after* the command.
+
+[<tt>-d, --dir=dir</tt>] Slide dir (where to put a new slide file)
+[<tt>-n, --name=basename</tt>] Slide name (name of the new slide file)
+[<tt>-s, --source=path to file</tt>] Include code from the given file as the slide body
+[<tt>-t, --style, --type=valid showoff style/type</tt>] Slide Type/Style <i>( default: <tt>title</tt>)</i>
+[<tt>-u, --nonumber</tt>] Dont number the slide, use the given name verbatim
+=== <tt>create dir_name</tt>
+
+Create new showoff presentation
+
+*Aliases*
+* <tt><b>init</b></tt>
+
+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.
+
+==== Options
+These options are specified *after* the command.
+
+[<tt>-d, --slidedir=arg</tt>] sample slide directory name <i>( default: <tt>one</tt>)</i>
+[<tt>-n, --nosamples</tt>] Dont create sample slides
+=== <tt>help [command]</tt>
+
+Shows list of commands or help for one command
+
+=== <tt>heroku heroku_name</tt>
+
+Setup your presentation to serve on Heroku
+
+=== <tt>serve </tt>
+
+Serves the showoff presentation in the current directory
+
+
+
+==== Options
+These options are specified *after* the command.
+
+[<tt>-p, --port=arg</tt>] Port on which to run <i>( default: <tt>9090</tt>)</i>
+= Real World Usage
+
+So far, ShowOff has been used in the following presentations:
+
+* LinuxConf.au 2010 - Wrangling Git - Scott Chacon
+  http://github.com/schacon/showoff-wrangling-git
+* SF Ruby Meetup - Resque! - Chris Wanstrath
+  http://github.com/defunkt/sfruby-meetup-resque
+* RORO Sydney Talk, Feb 2010 - Beyond Actions - Dave Bolton
+  http://github.com/lightningdb/roro-syd-beyond-actions
+* LRUG's February meeting - Showing Off with Ruby - Joel Chippindale
+  http://github.com/mocoso/showing-off-with-ruby
+* PyCon 2010 - Hg and Git; Can't we all just get along? - Scott Chacon
+  http://github.com/schacon/pycon-hg-git
+* PdxJs Tech Talk - Asynchronous Coding For My Tiny Ruby Brain - Rick Olson
+  http://github.com/technoweenie/pdxjs-twitter-node
+* RORO Perth Talk - Rails 3; A Brief Introduction Darcy Laycock
+  http://github.com/Sutto/roro-perth-rails-3
+* PDXRB Tech Talk - Here's Sinatra - Jesse Cooke
+  http://github.com/jc00ke/pdxrb_sinatra
+
+If you use it for something, please let me know so I can add it.
+
+= Future Plans
+
+I really want this to evolve into a dynamic presentation software server,
+that gives the audience a lot of interaction into the presentation -
+helping them decide dynamically what the content of the presentation is,
+ask questions without interupting the presenter, etc.  I want the audience
+to be able to download a dynamically generated PDF of either the actual
+talk that was given, or all the available slides, plus supplementary
+material. And I want the presenter (me) to be able to push each
+presentation to Heroku or GitHub pages for archiving super easily.
+
+= Why Not S5 or Slidy or Slidedown?
+
+S5 and Slidy are really cool, and I was going to use them, but mainly I wanted
+something more dynamic.  I wanted Slidy + Slidedown, where I could write my
+slideshows in a structured format in sections, where the sections could easily
+be moved around and between presentations and could be written in Markdown. I
+also like the idea of having interactive presentation system and didn't need
+half the features of S5/Slidy (style based print view, auto-scaling, themes,
+etc).
+
+= Requirements
+
+* Ruby (duh)
+* Sinatra (and thus Rack)
+* BlueCloth
+* Nokogiri
+* json
+* GLI gem
+* Firefox or Chrome to present
+

data/bin/showoff

@@ -2,19 +2,115 @@
 
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'showoff'
-command = ARGV.shift
-
-case command
-when 'create'
-  ShowOffUtils.create
-when 'add'
-  ShowOffUtils.add_slide
-when 'heroku'
-  ShowOffUtils.heroku
-when 'serve'
-  ShowOff.run! :host => 'localhost', :port => 9090
-when 'static' 
-  ShowOff.do_static(ARGV)
-else
-  ShowOffUtils.help
+require 'rubygems'
+require 'gli'
+
+include GLI
+
+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.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])
+  end
+end
+
+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.'
+command :heroku do |c|
+  c.action do |global_options,options,args|
+    raise "heroku_name is required" if args.empty?
+    ShowOffUtils.heroku(args[0])
+  end
+end
+
+desc 'Serves the showoff presentation in the current directory'
+command :serve do |c|
+
+  c.desc 'Port on which to run'
+  c.default_value "9090"
+  c.flag [:p,:port]
+
+  c.desc 'Host or ip to run on'
+  c.default_value "localhost"
+  c.flag [:h,:host]
+
+  c.action do |global_options,options,args|
+    raise "fail. not a showoff directory" if !File.exists?(ShowOffUtils::SHOWOFF_JSON_FILE)
+    ShowOff.run! :host => options[:h], :port => options[:p].to_i
+  end
+end
+
+desc 'Add a new slide at the end in a given dir'
+arg_name '[title]'
+long_desc 'Outputs or creates a new slide.  With -d and -n, a new slide is created in the given dir, numbered to appear as the last slide in that dir (use -u to avoid numbering).  Without those, outputs the slide markdown to stdout (useful for shelling out from your editor). You may also specify a source file to use for a code slide'
+command [:add,:new] do |c|
+  c.desc 'Don''t number the slide, use the given name verbatim'
+  c.switch [:u,:nonumber]
+
+  c.desc 'Include code from the given file as the slide body'
+  c.arg_name 'path to file'
+  c.flag [:s,:source]
+
+  c.desc 'Slide Type/Style'
+  c.arg_name 'valid showoff style/type'
+  c.default_value 'title'
+  c.flag [:t,:type,:style]
+
+  c.desc 'Slide dir (where to put a new slide file)'
+  c.arg_name 'dir'
+  c.flag [:d,:dir]
+
+  c.desc 'Slide name (name of the new slide file)'
+  c.arg_name 'basename'
+  c.flag [:n,:name]
+
+  c.action do |global_options,options,args|
+    title = args.join(" ")
+    ShowOffUtils.add_slide(:dir => options[:d],
+                           :name => options[:n],
+                           :title => title,
+                           :number => !options[:m],
+                           :code => options[:s],
+                           :type => options[:t])
+  end
+end
+
+desc 'Generate static version of presentation'
+arg_name 'name'
+long_desc 'Creates a static, one page version of the presentation as {name}.html'
+command [:static] do |c|
+  c.action do |global_options,options,args|
+    ShowOff.do_static(args[0])
+  end
 end
+
+pre do |global,command,options,args|
+  # Pre logic here
+  # Return true to proceed; false to abourt and not call the
+  # chosen command
+  true
+end
+
+post do |global,command,options,args|
+  # Post logic here
+end
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  true
+end
+
+GLI.run(ARGV)

data/lib/showoff.rb

@@ -6,6 +6,18 @@ require 'showoff_utils'
 require 'princely'
 require 'ftools'
 
+begin
+  require 'RMagick'
+rescue LoadError
+  puts 'image sizing disabled - install RMagick'
+end
+
+begin
+  require 'prawn'
+  require 'princely'
+rescue LoadError
+  puts 'pdf generation disabled - install prawn'
+end
 
 begin 
   require 'rdiscount'
@@ -17,6 +29,8 @@ require 'pp'
 
 class ShowOff < Sinatra::Application
 
+  attr_reader :cached_image_size
+
   set :views, File.dirname(__FILE__) + '/../views'
   set :public, File.dirname(__FILE__) + '/../public'
   set :pres_dir, 'example'
@@ -31,6 +45,7 @@ class ShowOff < Sinatra::Application
       options.pres_dir = Dir.pwd
       @root_path = ".."
     end
+    @cached_image_size = {}
     puts options.pres_dir
     @pres_name = options.pres_dir.split('/').pop
   end
@@ -93,13 +108,33 @@ class ShowOff < Sinatra::Application
       paths = path.split('/')
       paths.pop
       path = paths.join('/')
-      if static
-        slide.gsub(/img src=\"(.*?)\"/, 'img src="file://'+options.pres_dir+'/static/' + path + '/\1"') 
-      else
-        slide.gsub(/img src=\"(.*?)\"/, 'img src="/image/' + path + '/\1"') 
+      replacement_prefix = static ?
+        %(img src="file://#{options.pres_dir}/static/#{path}) :
+        %(img src="/image/#{path})
+      slide.gsub(/img src=\"(.*?)\"/) do |s|
+        img_path = File.join(path, $1)
+        w, h     = get_image_size(img_path)
+        src      = %(#{replacement_prefix}/#{$1}")
+        if w && h
+          src << %( width="#{w}" height="#{h}")
+        end
+        src
       end
     end
-    
+
+    if defined?(Magick)
+      def get_image_size(path)
+        if !cached_image_size.key?(path)
+          img = Magick::Image.ping(path).first
+          cached_image_size[path] = [img.columns, img.rows]
+        end
+        cached_image_size[path]
+      end
+    else
+      def get_image_size(path)
+      end
+    end
+
     def update_commandline_code(slide)
       html = Nokogiri::XML.parse(slide)
       
@@ -137,7 +172,7 @@ class ShowOff < Sinatra::Application
     end
     
     def get_slides_html(static=false)
-      index = File.join(options.pres_dir, 'showoff.json')
+      index = File.join(options.pres_dir, ShowOffUtils::SHOWOFF_JSON_FILE )
       files = []
       if File.exists?(index)
         order = JSON.parse(File.read(index))
@@ -214,8 +249,8 @@ class ShowOff < Sinatra::Application
   end
   
   
-   def self.do_static(args)
-      what = args.shift || "index"  
+   def self.do_static(what)
+      what = "index" if !what
       
       # Nasty hack to get the actual ShowOff module
       showoff = ShowOff.new
@@ -236,11 +271,12 @@ class ShowOff < Sinatra::Application
         file.puts(data)
         file.close
         # Now copy all the js and css
+        my_path = File.join( File.dirname(__FILE__), '..', 'public')
         ["js", "css"].each { |dir|
-          FileUtils.copy_entry("#{path}/public/#{dir}", "#{out}/#{dir}")
+          FileUtils.copy_entry("#{my_path}/#{dir}", "#{out}/#{dir}")
         }
         # And copy the directory
-        Dir.glob("#{path}/#{name}/*").each { |subpath| 
+        Dir.glob("#{my_path}/#{name}/*").each { |subpath| 
           base = File.basename(subpath)
           next if "static" == base
           next unless File.directory?(subpath) || base.match(/\.(css|js)$/)
@@ -258,14 +294,16 @@ class ShowOff < Sinatra::Application
   end
 
   get %r{/(.*)} do
-     what = params[:captures].first
-     what = 'index' if "" == what 
-     data = send(what)
-     if data.is_a?(File)
-       send_file data.path
-     else
-       data
-     end
+    what = params[:captures].first
+    what = 'index' if "" == what 
+    if (what != "favicon.ico")
+      data = send(what)
+      if data.is_a?(File)
+        send_file data.path
+      else
+        data
+      end
+    end
   end