deckrb 0.1.0 → 0.1.1

data/README.md

@@ -11,6 +11,13 @@
   * Erector
   * Markdown
 * presentations can comprise several source files
+* source files look good as source, built HTML, preview HTML, or as a deck doc
+  * slide directives look like comments when rendered into HTML (e.g. as <!SLIDE>)
+  * links to auxiliary files (e.g. `img src`) are resolved relative to the source file
+  * generated HTML is pretty-printed
+* uses RedCarpet markdown extensions, including
+  * tables <http://michelf.com/projects/php-markdown/extra/#table>
+  * fenced code blocks <http://michelf.com/projects/php-markdown/extra/#fenced-code-blocks>
 
 ## Command-Line API (proposed)
 
@@ -18,7 +25,7 @@
 
  * start a local Rack server (probably Sinatra) on port 4333
  * http://localhost:4333/ serves the presentation in foo.md
- * can also specify multiple source files in a row
+ * can specify multiple source files in a row
 
 `deck build foo.md`
 
@@ -29,35 +36,63 @@
 
 `deck deploy` ???
 
- * some way to build/rebuild a project that is deployable to heroky
-
+ * some way to build/rebuild a project that is deployable to heroku
 
 ### Options
 
- * --output dir
- * --config deck.json
- * --port portnum
- * --theme themename
+* none yet :-)
 
 ## Credits
 
-* deck.js by Caleb at http://imakewebthings.com
-* deck.rb by Alex Chaffee http://alexchaffee.com, with help from
-  * Steven! Ragnarök @nuclearsandwich
+* deck.js by Caleb at <http://imakewebthings.com>
+* deck.rb by Alex Chaffee <http://alexchaffee.com>, with help from
+  * Steven! Ragnarök <http://nuclearsandwich.com>
+  
+### See Also
+
 * showoff by Scott Chacon
+* keydown by Davis Frank
+
+## Bugs and Limitations
+
+* auxiliary files are interleaved in URL path space, so overlapping file names might not resolve to the right file
+* H1s are converted to H2s for compatibility with deck.js's CSS
+  * unless they're the only item on the slide, in which case they remain H1s
 
 ## TODO
 
-* markdown
-* multiple files
-* rack app
+* config file
 * config: 
-  * show theme selector
-  * show page number/nav
+  * show/hide theme selector
+  * show/hide page number/nav
   * choose deck extensions
-* slim
-* haml
+* command-line tool can take a directory
+  * first pass: globs all *.md files in it
+* command-line options:
+  * --output dir
+  * --config deck.json
+  * --port portnum
+  * --theme themename
+* more slide file types
+  * html
+  * slim http://slim-lang.com/index.html
+  * haml
+  * tilt
 * specify Redcarpet Markdown extensions
-* syntax highlighting (using sh (js) or coderay (rack)?)
-* option to render all JS and CSS inline, for a self-contained HTML doc (and maybe images too)
-
+* option to render all JS and CSS inline, for a self-contained HTML doc 
+  * and maybe images too, base64-encoded
+* image scaling
+* build and push into a gh-pages branch
+* build and push into a heroku app
+* find any lines that start with a <p>.(something) and turn them into <p class="something">
+  * see showoff.rb:189
+* fix title tag (base it off of presentation name or something)
+
+## TODO (community)
+
+* submit theme-picker extension to deck.js
+* add to deck.js wiki https://github.com/imakewebthings/deck.js/wiki
+* announce on https://groups.google.com/forum/#!forum/webslideshow
+* mix with keydown https://github.com/infews/keydown
+* gh-pages documentation site
+* integrate with slideshow https://github.com/geraldb/slideshow-deck.js

data/bin/deck

@@ -1,12 +1,11 @@
 #!/usr/bin/env ruby
 
 here = File.expand_path(File.dirname(__FILE__))
-root = File.join(here, '..')
 $: << File.join(here, '..', 'lib')
 
 require "rack"
 require "deck"
-require "deck/app"
+require "deck/rack_app"
 
 command = ARGV.shift
 
@@ -26,7 +25,7 @@ when 'build'
   end
 
   File.open(output_path, "w") do |file|
-    deck = Deck.new :slides => slides
+    deck = SlideDeck.new :slides => slides
     # deck.to_pretty(:output => file)  # todo: figure out why this doesn't work
     file.write deck.to_pretty
   end
@@ -36,14 +35,10 @@ when 'run'
   # Fix Rack bug https://github.com/rack/rack/issues/301
   require 'deck/rack_static_patch'
   
+  
   port = 4333  # todo: option
-  app = Rack::Builder.app do
-    use Rack::ShowExceptions
-    use Rack::ShowStatus    
-    use Rack::Static, :urls => ["/deck"], :root => root
-    run Deck::App.new(Dir.pwd, ARGV)
-  end
-  Rack::Handler.default.run app, :Port => port
+  slide_files = ARGV
+  Rack::Handler.default.run Deck::RackApp.build(slide_files), :Port => port
   
 else
   puts "Unknown command '#{command}'"

data/lib/deck.rb

@@ -3,5 +3,5 @@ here = File.expand_path(File.dirname(__FILE__))
 module Deck
 end
 
-require "deck/deck"
+require "deck/slide_deck"
 require "deck/slide"

data/lib/deck/noko.rb

@@ -0,0 +1,15 @@
+require 'nokogiri'
+
+module Deck
+  # Wrappers around Nokogiri's occasionally inscrutable API
+  module Noko
+    def noko_html nokogiri_node
+      nokogiri_node.serialize(:save_with => 0).chomp
+    end
+
+    def noko_doc html_snippet
+      html_doc = html_snippet =~ /<html/ ? html_snippet : "<html>#{html_snippet}</html>"
+      Nokogiri.parse(html_doc)
+    end
+  end
+end

data/lib/deck/rack_app.rb

@@ -0,0 +1,61 @@
+here = File.expand_path File.dirname(__FILE__)
+
+require 'coderay'
+require 'rack/codehighlighter'
+
+module Deck
+  class RackApp
+    def self.app_root
+      here = File.dirname(__FILE__)
+      app_root = File.expand_path "#{here}/../.."
+    end
+
+    def self.build slide_files
+
+      if const_defined?(:Thin)
+        if require "thin/logging"
+          Thin::Logging.debug = true
+        end
+      end
+
+      Rack::Builder.app do
+        use Rack::ShowExceptions
+        use Rack::ShowStatus
+        use Rack::Codehighlighter, :coderay,
+          :element => "pre>code",
+          :markdown => true,
+          :pattern => /\A[:@]{3}\s?(\w+)\s*(\n|
)/i
+        run ::Deck::RackApp.new(slide_files)
+      end
+    end
+
+    def initialize slide_files
+      @slide_files = [slide_files].flatten
+
+      @file_servers =
+        [Rack::File.new("#{::Deck::RackApp.app_root}/public")] +
+        @slide_files.map do |slide_file|
+          Rack::File.new(File.dirname slide_file)
+        end
+    end
+
+    def call env
+      request = Rack::Request.new(env)
+      if request.path == "/"
+        slides = []
+        @slide_files.each do |file|
+          slides += Slide.from_file file
+        end
+        deck = SlideDeck.new :slides => slides
+        [200, {'Content-Type' => 'text/html'}, [deck.to_pretty]]
+      else
+        result = [404, {}, []]
+        @file_servers.each do |file_server|
+          result = file_server.call(env)
+          return result if result.first < 400
+        end
+        result
+      end
+    end
+  end
+end

data/lib/deck/slide.rb

@@ -1,10 +1,12 @@
 # based on work by Alex and others in Showoff
 require 'redcarpet'
-
+require 'deck/noko'
 
 module Deck
  class Slide < Erector::Widget
 
+  include Deck::Noko
+
   # todo: test this method
   def self.from_file markdown_file
     split File.read(markdown_file)
@@ -12,8 +14,10 @@ module Deck
 
   # given a chunk of Markdown text, splits it into an array of Slide objects
   def self.split content
-    unless content =~ /^\<?!SLIDE/m
-      content = content.gsub(/^# /m, "<!SLIDE>\n# ")
+    unless content =~ /^\<?!SLIDE/m     # this only applies to files with no !SLIDEs at all, which is odd
+      content = content.
+        gsub(/^# /m, "<!SLIDE>\n# ").
+        gsub(/^(.*)\n(===+)/, "<!SLIDE>\n\\1\n\\2")
     end
 
     lines = content.split("\n")
@@ -24,7 +28,7 @@ module Deck
       if line =~ /^<?!SLIDE(.*)>?/
         slides << (slide = Slide.new(:classes => $1))
 
-      elsif line =~ /^# / and !slide.empty?
+      elsif (line =~ /^# / or lines.first =~ /^(===+)/) and !slide.empty?
         # every H1 defines a new slide, unless there's a !SLIDE before it
         slides << (slide = Slide.new)
         slide << line
@@ -44,15 +48,15 @@ module Deck
   attr_reader :classes, :markdown_text
 
   needs :classes => nil, :markdown_text => nil, :slide_id => nil
-  
-  
+
+
   def initialize options = {}
     super options
-    
+
     @classes = process_classes
     @markdown_text = ""
   end
-  
+
   def process_classes
     ["slide"] + case @classes
     when NilClass
@@ -64,7 +68,7 @@ module Deck
     else
       raise "can't deal with :classes => #{@classes.inspect}"
     end
-  end  
+  end
 
   def markdown
     @@markdown ||= Redcarpet::Markdown.new(Redcarpet::Render::HTML,
@@ -79,42 +83,60 @@ module Deck
       :superscript => false
     )
   end
-  
+
   def <<(s)
     @markdown_text << s
     @markdown_text << "\n"
   end
-  
+
   def empty?
     @markdown_text.strip == ""
   end
-  
+
   def slide_id
     @slide_id ||= begin
       lines = @markdown_text.split("\n")
       raise "an empty slide has no id" if lines.empty?
-      lines.first.gsub(/^#*/, '').strip.downcase.gsub(/[^\w\s]/, '').gsub(/\s/, '_')
-    end
-  end
-  
-  def header_only?
-    markdown_text.strip =~ /^# / and markdown_text.strip.split("\n").size == 1
-  end
-  
-  def massaged_markdown_text
-    unless header_only?
-      "##{markdown_text.strip}"
-    else
-      markdown_text
+      lines.first.downcase.gsub(/[^\w\s]/, '').strip.gsub(/\s/, '_')
     end
   end
-  
+
   def content
     section :class => @classes, :id => slide_id do
       text "\n" # markdown HTML should be left-aligned, in case of PRE blocks and other quirks
-      html = markdown.render(massaged_markdown_text)
+      html = markdown.render(markdown_text)
+      html = munge(html)
       rawtext html
-    end    
+    end
   end
+
+  private
+
+    # if there is an H1, change it to an H2, unless it's the only thing there
+    # TODO: or unless the slide class is whatever
+    def mutate_h1? doc
+      h1s = doc.css('h1') || []
+      if h1s.size == 0
+        false
+      else
+        stuff = doc.css('body>*')
+        if stuff.size == 1
+          false
+        else
+          true
+        end
+      end
+    end
+
+    def munge html
+      doc = noko_doc(html)
+      if mutate_h1? doc
+        doc.css('h1').each {|node| node.node_name = "h2"}
+        doc.css('body').inner_html + "\n"
+      else
+        html
+      end
+    end
+
  end
 end

data/lib/deck/{deck.rb → slide_deck.rb}

@@ -4,23 +4,23 @@ require 'redcarpet'
 require "deck/slide"
 
 module Deck
- class Deck < Erector::Widgets::Page
+ class SlideDeck < Erector::Widgets::Page
   needs :title => "deck.rb presentation",
     :description => nil,
     :author => nil
-    
+
   needs :slides => nil
-  
+
   def page_title
     @title
   end
-  
+
   # todo: promote into Text
   # todo: support numbers a la '&#1234;'
   def entity entity_id
     raw("&#{entity_id};")
   end
-  
+
 # left over from deck.js' introduction/index.html
 
 # <!DOCTYPE html>
@@ -34,54 +34,55 @@ module Deck
     link({:rel => "stylesheet", :href => src}.merge(attributes))
   end
 
+  def extensions
+    @extensions || [
+      'goto',
+      'menu',
+      'navigation',
+      'status',
+      'hash',
+      'scale',
+      # 'theme-picker',
+    ]
+  end
+
   def head_content
     super
     meta 'charset' => 'utf-8'
     meta 'http-equiv'=>"X-UA-Compatible", 'content'=>"IE=edge,chrome=1"
-    meta :name=>"viewport", :content=>"width=1024, user-scalable=no"
+    meta :name => "viewport", :content=> "width=1024, user-scalable=no"
     meta :name => "description", :content=> @description if @description
     meta :name => "author", :content=> @author if @author
 
+    stylesheet "coderay.css"
+
     #  <!-- Core and extension CSS files -->
-    stylesheet "deck/core/deck.core.css"
-    
-    stylesheet "deck/extensions/goto/deck.goto.css"
-    stylesheet "deck/extensions/menu/deck.menu.css"
-    stylesheet "deck/extensions/navigation/deck.navigation.css"
-    stylesheet "deck/extensions/status/deck.status.css"
-    stylesheet "deck/extensions/hash/deck.hash.css"
-    stylesheet "deck/extensions/scale/deck.scale.css"
-    
-    stylesheet "deck/extensions/theme-picker/deck.theme-picker.css"
-  
+    stylesheet "deck.js/core/deck.core.css"
+    extensions.each do |extension|
+      stylesheet "deck.js/extensions/#{extension}/deck.#{extension}.css"
+    end
+
     # <!-- Theme CSS files (menu swaps these out) -->
-    stylesheet "deck/themes/style/web-2.0.css", :id=>"style-theme-link"
-    stylesheet "deck/themes/transition/horizontal-slide.css", :id => "transition-theme-link"
-  
-    script :src=>"deck/modernizr.custom.js"
+    stylesheet "deck.js/themes/style/swiss.css", :id=>"style-theme-link"
   end
 
   def scripts
+    script :src => "deck.js/modernizr.custom.js"
+
     # comment 'Grab CDN jQuery, with a protocol relative URL; fall back to local if offline'
     # script :src => '//ajax.aspnetcdn.com/ajax/jQuery/jquery-1.7.min.js'
-    script :src => './deck/jquery-1.7.min.js'
-    
-    comment 'Deck Core and extensions'
-    script :type => "text/javascript", :src => 'deck/core/deck.core.js'
+    script :src => 'deck.js/jquery-1.7.min.js'
 
-    script :type => "text/javascript", :src => 'deck/extensions/hash/deck.hash.js'
-    script :type => "text/javascript", :src => 'deck/extensions/menu/deck.menu.js'
-    script :type => "text/javascript", :src => 'deck/extensions/goto/deck.goto.js'
-    script :type => "text/javascript", :src => 'deck/extensions/status/deck.status.js'
-    script :type => "text/javascript", :src => 'deck/extensions/navigation/deck.navigation.js'
-    script :type => "text/javascript", :src => 'deck/extensions/scale/deck.scale.js'
+    comment 'Deck Core and extensions'
+    script :type => "text/javascript", :src => 'deck.js/core/deck.core.js'
 
+    extensions.each do |extension|
+      script :type => "text/javascript", :src => "deck.js/extensions/#{extension}/deck.#{extension}.js"
+    end
 
     # fire up deck.js
     script "$(function(){$.deck('.slide');});"
-    
-    script :type => "text/javascript", :src => 'deck/extensions/theme-picker/deck.theme-picker.js'
-    
+
   end
 
   def body_attributes
@@ -96,7 +97,7 @@ module Deck
     permalink
     scripts
   end
-    
+
   def slide slide_id
     # todo: use Slide object, but without markdown
     # slide = Slide.new(:slide_id => slide_id)
@@ -104,7 +105,7 @@ module Deck
       yield
     end
   end
-  
+
   def slides
     if @slides
       @slides.each do |slide|
@@ -114,14 +115,14 @@ module Deck
       default_slide
     end
   end
-  
+
   def default_slide
     slide 'readme' do
       h2 "deck.rb"
       ul {
         li "based on deck.js"
         li "create a subclass of Deck (see introduction.rb)"
-        li "run erector to build it"        
+        li "run erector to build it"
       }
       pre "erector --to-html ./deck.rb  # generates deck.html"
     end
@@ -145,7 +146,7 @@ module Deck
       end
     end
   end
-  
+
   def goto_slide
     form :action => '.', :method => 'get', :class => 'goto-form' do
       label :for => 'goto-slide' do
@@ -161,6 +162,6 @@ module Deck
   def permalink
     a "#", :href => '.', :title => 'Permalink to this slide', :class => 'deck-permalink'
   end
-  
+
  end
-end
+end