keydown 0.7.1 → 0.9.0

data/.gitignore

@@ -3,3 +3,5 @@
 pkg/*
 *.gem
 .bundle
+Gemfile.lock
+binstubs/*

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 1.8.7
+  - 1.9.2

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Infews LLC
+Copyright (c) 2010, 2011 Infews LLC
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -3,7 +3,10 @@
 KeyDown is another 'Presentation System in a single HTML page' inspired by [Showoff](http://github.com/drnic/showoff), [Slidedown](http://github.com/nakajima/slidedown),
 [HTML5 Rocks](http://studio.html5rocks.com/#Deck), with a little [Presentation Zen](http://amzn.to/8X55H2) thrown in.
 
+It uses the excellent [deck.js](http://imakewebthings.github.com/deck.js) and its extensions for the presentation.
+
 ## Usage
+    $ gem install keydown
 
 ### Generate a Template
 
@@ -15,8 +18,10 @@ This will make:
 
     | - my_presentation/
       | - css/               - Keydown CSS and a file for you to customize
+      | - deck.js/
       | - images/            - Some Keydown images, but also for you
       | - js/                - Keydown JavaScript, and a file for you to customize
+      | 
       | - my_presentation.md
 
 ### Write your presentation in Markdown
@@ -67,24 +72,14 @@ Give your presentation! Open `my_presentation.html` in a browser and talk away:
 
 ### Presentation Title
 
-An optional first `H1` before a `!SLIDE` is treated as the presentation title. It will be on the configuration page and set as the HTML `<title>`.
+An optional first `H1` before a `!SLIDE` is treated as the presentation title in the HTML `<title>`.
 	
-### Configuration Page & Navigation
-
-The first page of a Keydown presentation is a configuration page that shows the presentation title, how to navigate the presentation, and some visual effect options.
-
 ### Slide classes
 
 Any text that follows `!SLIDE` will be added to the slide as CSS classes. 
 
     !SLIDE dark
 
-There are some built-in classes you can use:
-
-* `middle` will center all the elements on the slide
-* `bulleted` - by default, lists to not have bullets; use this class to add them back
-* `dark` - by default, slides are light with dark fonts; this swaps a slide
-
 You can define your own CSS classes (see below).
 
 ### Images 
@@ -115,7 +110,7 @@ If you wish to have attribution text, an icon (currently Flickr and Creative Com
 
 ### Syntax Highlighting
 
-Code syntax highlighting is done via [Pygments](http://pygments.org), which must be installed locally to work. All Pygments lexers are supported.
+Code syntax highlighting is done via [CodeMirror](http://codemirror.net).
 
 Mark your code by block escaping via `@@@` or ` ``` `
 
@@ -149,18 +144,23 @@ All css files in the `css` directory will be linked into your presentation HTML
 
 All JavaScript files in the `js` directory will be linked in your presentation HTML file.
 
+### Deck.js Extensions
+
+Any extension CSS and JS will be loaded if copied into the project.
+
+
 ## Requirements
 
 ### For Use
 
    * Ruby and Rubygems
-   * [Pygments](http://pygments.org) is required for code syntax highlighting
    * Other dependent gems will be installed
 
 ### For Development
 
    * RSpec
    * Nokogiri
+   * Other dependent gems will be installed
 
 ## Note on Patches/Pull Requests
  
@@ -174,10 +174,11 @@ All JavaScript files in the `js` directory will be linked in your presentation H
 
 Thanks to:
 
-* HTML5 Rocks guys for a great presentation template
+* HTML5 Rocks guys for the original great presentation template
 * [@nakajima](http://twitter.com/nakajima) & [Slidedown](http://github.com/nakajima/slidedown) for some parsing
+* [Caleb](http://github.com/imakewebthings) for making deck.js & testing it with [Jasmine](http://pivotal.github.com/jasmine)
 * The various Github guys for Albino, Gollum, etc.
 
 ## Copyright
 
-Copyright &copy;  Infews LLC. See LICENSE for details.
+Copyright &copy; Infews LLC. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.9.0

data/keydown.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "version"
+$:.push File.expand_path('lib', __FILE__)
+require './lib/version.rb'
 
 Gem::Specification.new do |s|
   s.name        = "keydown"
@@ -10,13 +10,16 @@ Gem::Specification.new do |s|
   s.email       = ["dwfrank@infe.ws"]
   s.homepage    = "http://rubygems.org/gems/keydown"
   s.summary     = %q{Yet another "Slides in HTML" generator}
-  s.description = %q{Bastard child of Slidedown, HTML5 Rocks, and organic fair trade Bolivian coffee}
+  s.description = %q{Bastard child of Slidedown, deck.js and organic fair trade Bolivian coffee}
 
-  s.add_dependency 'thor', '>= 0.14.0'
+  s.add_dependency 'thor'
+  s.add_dependency 'tilt'
+  s.add_dependency 'haml'
+  s.add_dependency 'sass'
   s.add_dependency 'rdiscount', '>= 1.6.8'
-  s.add_dependency 'coderay', '~> 0.9.8'
 
-  s.add_development_dependency "rspec", ">= 2.5.0"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
   s.add_development_dependency "fuubar"
   s.add_development_dependency "nokogiri"
   s.add_development_dependency "gem-release"

data/lib/keydown.rb

@@ -1,22 +1,9 @@
-require 'thor'
-
-module Keydown
-  class Tasks < Thor
-    include Thor::Actions
-
-    @@source_root = File.join(File.dirname(__FILE__), '..')
-
-    def self.source_root
-      @@source_root
-    end
-
-    def self.template_dir
-      @@template_dir
-    end
-
-  end
-end
-
-Dir["#{File.dirname(__FILE__)}/keydown/**/*.rb"].each do |file|
-  require file
-end
+require 'ostruct'
+require 'digest/sha1'
+require 'tilt'
+
+require 'version'
+require 'keydown/html_helpers'
+require 'keydown/slide'
+require 'keydown/slidedeck'
+require 'keydown/tasks'

data/lib/keydown/html_helpers.rb

@@ -0,0 +1,12 @@
+module Keydown
+  module HtmlHelpers
+
+    def stylesheet(src)
+      %Q{<link href="#{src}" rel="stylesheet" type="text/css"/>}
+    end
+
+    def script(src)
+      %Q{<script src="#{src}" type="text/javascript"></script>}
+    end
+  end
+end

data/lib/keydown/{lib/slide.rb → slide.rb}

@@ -1,5 +1,3 @@
-require 'digest/sha1'
-
 module Keydown
   class Slide
 
@@ -27,7 +25,7 @@ module Keydown
     end
 
     def classnames
-      @classnames.join(' ')
+      @classnames.length > 0 ? { :class => @classnames.join(' ') } : {}
     end
 
     def container_classnames
@@ -44,25 +42,24 @@ module Keydown
     end
 
     def background_attribution_classnames
-      names = ['attribution']
-
-      names << if background_image[:attribution_text]
-        background_image[:service]
-               else
-                 'hidden'
-               end
+      return [] unless background_image[:attribution_text] || background_image[:service]
 
-      names.join(' ')
+      ['attribution', background_image[:service]].join(' ')
     end
 
     def to_html
-      require 'erb'
+      require 'tilt'
       require 'rdiscount'
 
-      html_content = RDiscount.new(@content).to_html
-      template = File.new(File.join(Tasks.template_dir, 'slide.rhtml'))
+      markdown = RDiscount.new(@content)
+      context = OpenStruct.new(:html_content => markdown.to_html,
+                               :container_classnames => container_classnames,
+                               :classnames => classnames,
+                               :background_attribution_classnames => background_attribution_classnames,
+                               :background_image => background_image)
 
-      ERB.new(template.read).result(binding)
+      slide = Tilt.new(File.join(Tasks.template_dir, 'slide.html.haml'))
+      slide.render(context)
     end
 
     private
@@ -112,17 +109,17 @@ module Keydown
 
     def highlight_code!
       @codemap.each do |id, code_block|
-        lang = code_block[:lang]
+        language = code_block[:lang]
         code = code_block[:code]
         if code.lines.all? { |line| line =~ /\A\r?\n\Z/ || line =~ /^(  |\t)/ }
           code.gsub!(/^(  |\t)/m, '')
         end
 
-        tokens = CodeRay.scan code, lang.to_sym
+        context = OpenStruct.new :language => language, :code => code
+        template = Tilt.new(File.join(Tasks.template_dir, 'code.html.haml'))
 
-        @content.gsub!(id, tokens.html.div)
+        @content.gsub!(id, template.render(context))
       end
     end
-
   end
 end

data/lib/keydown/{lib/slidedeck.rb → slidedeck.rb}

@@ -1,6 +1,10 @@
 module Keydown
   class SlideDeck
 
+    class Context < OpenStruct
+      include HtmlHelpers
+    end
+
     attr_reader :title
     attr_reader :slides
 
@@ -15,16 +19,27 @@ module Keydown
     end
 
     def to_html
-      require 'erb'
+      require 'tilt'
 
       css_files = ['css/keydown.css']
       css_files += Dir.glob('css/*.css')
       css_files.uniq!
-      css_files -= ['css/rocks.css']
-      js_files = Dir.glob('js/*.js') - ['js/rocks.js']
 
-      template = File.new(File.join(Tasks.template_dir, 'index.rhtml'))
-      ERB.new(template.read).result(binding)
+      extension_dirs = Dir.glob('deck.js/extensions/*').select {|f| File.directory? f}
+      extension_css = extension_dirs.inject([]) do |files, dir|
+        files += Dir.glob("#{dir}/*.css")
+        files
+      end
+
+      context = Context.new(:title => @title,
+                            :css_files => css_files,
+                            :js_files => Dir.glob('js/**/*.js') || [],
+                            :slides => @slides,
+                            :extensions_js_files => Dir.glob('deck.js/extensions/**/*.js') || [],
+                            :extensions_css_files => extension_css)
+
+      template = Tilt.new(File.join(Tasks.template_dir, 'index.html.haml'))
+      template.render(context)
     end
 
     private

data/lib/keydown/tasks.rb

@@ -0,0 +1,5 @@
+require 'thor'
+
+require 'keydown/tasks/base'
+require 'keydown/tasks/generate'
+require 'keydown/tasks/slides'

data/lib/keydown/tasks/base.rb

@@ -0,0 +1,15 @@
+module Keydown
+  class Tasks < Thor
+    include Thor::Actions
+
+    @@source_root = File.join(File.dirname(__FILE__), '..', '..', '..')
+
+    def self.source_root
+      @@source_root
+    end
+
+    def self.template_dir
+      @@template_dir
+    end
+  end
+end

data/lib/keydown/tasks/generate.rb

@@ -5,8 +5,12 @@ module Keydown
     desc "generate NAME", "Make a directory & sample files for presentation NAME"
 
     def generate(name)
-      @presentation_name = name
+      @presentation_name = name # instance variable used when the directory is copied
       directory "templates/generate", name
+
+      copy_file "templates/generate/deck.js/themes/transition/horizontal-slide.css", "#{name}/css/horizontal-slide.css"
+      copy_file "templates/generate/deck.js/themes/style/swiss.css", "#{name}/css/swiss.css"
+      copy_file "templates/generate/deck.js/extensions/codemirror/themes/default.css", "#{name}/css/default.css"
     end
   end
 end

data/lib/keydown/tasks/slides.rb

@@ -12,7 +12,7 @@ module Keydown
         return
       end
 
-      @@template_dir = File.join(Keydown::Tasks.source_root, 'templates', 'rocks')
+      @@template_dir = File.join(Keydown::Tasks.source_root, 'templates', 'deck.js')
 
       say "Creating Keydown presentation from #{file}", :yellow
 

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Keydown
-  VERSION = "0.7.1"
+  VERSION = "0.9.0"
 end

data/spec/lib/html_helpers_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Keydown::HtmlHelpers do
+
+  before do
+
+    class TestContext
+      include Keydown::HtmlHelpers
+    end
+
+    @context = TestContext.new
+  end
+
+  describe "#stylesheet" do
+    it "should produce an HTML stylesheet link tag" do
+      @context.stylesheet("/foo/bar/baz.css").should == %q{<link href="/foo/bar/baz.css" rel="stylesheet" type="text/css"/>}
+    end
+  end
+
+  describe "#script" do
+    it "should produce an HTML JavaScript script tag" do
+      @context.script("/foo/bar/baz.js").should == %q{<script src="/foo/bar/baz.js" type="text/javascript"></script>}
+    end
+  end
+
+end

data/spec/lib/slide_spec.rb

@@ -1,11 +1,11 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe Keydown::Slide do
   before :each do
     module Keydown
       class Tasks
         def self.template_dir
-          File.join(Keydown::Tasks.source_root, 'templates', 'rocks')
+          File.join(Keydown::Tasks.source_root, 'templates', 'deck.js')
         end
       end
     end
@@ -48,8 +48,12 @@ describe Keydown::Slide do
   end
 
   shared_examples_for "syntax highlighting" do
-    it "should colorize the code fragments" do
-      @doc.css('.CodeRay').length.should == 1
+    it "setup the code segments for highlighting" do
+      @doc.css('textarea').length.should == 1
+
+      code_block = @doc.css('textarea')[0]
+      code_block['class'].should == 'code'
+      code_block['mode'].should == 'ruby'
     end
   end
 
@@ -64,7 +68,7 @@ With some text
 a simple note
       SLIDE
 
-      @classnames = ''
+      @classnames = {}
       @slide = Keydown::Slide.new(@slide_text)
     end
 
@@ -92,7 +96,7 @@ With some text
 a simple note
       SLIDE
 
-      @classnames = 'foo'
+      @classnames = {:class => 'foo'}
       @slide = Keydown::Slide.new(@slide_text, 'foo')
     end
 
@@ -102,7 +106,7 @@ a simple note
       before :each do
         @html = @slide.to_html
         @doc = Nokogiri(@html)
-        @slide_selector = "section.#{@classnames}"
+        @slide_selector = "section.#{@classnames[:class]}"
       end
 
       it_should_behave_like "generating HTML"
@@ -120,7 +124,7 @@ With some text
 a simple note
       SLIDE
 
-      @classnames = 'foo bar'
+      @classnames = {:class => 'foo bar'}
       @slide = Keydown::Slide.new(@slide_text, 'foo bar')
 
     end
@@ -131,7 +135,7 @@ a simple note
       before :each do
         @html = @slide.to_html
         @doc = Nokogiri(@html)
-        @slide_selector = "section.#{@classnames}"
+        @slide_selector = "section.#{@classnames[:class]}"
       end
       it_should_behave_like "generating HTML"
     end
@@ -145,7 +149,7 @@ a simple note
 With some text
       SLIDE
 
-      @classnames = ''
+      @classnames = {}
       @slide = Keydown::Slide.new(@slide_text)
     end
 
@@ -188,7 +192,7 @@ a simple note
 
         SLIDE
 
-        @classnames = ''
+        @classnames = {}
         template_dir = File.join(Keydown::Tasks.source_root, 'templates', 'rocks')
         @slide = Keydown::Slide.new(@slide_text)
       end
@@ -225,7 +229,7 @@ a simple note
 
         SLIDE
 
-        @classnames = ''
+        @classnames = {}
         @slide = Keydown::Slide.new(@slide_text)
       end
 
@@ -240,11 +244,15 @@ a simple note
 
         it_should_behave_like "generating HTML"
         it_should_behave_like "syntax highlighting"
+
+        it "should not have a an attribution for the background image" do
+          @doc.css('.attribution').length.should == 0
+        end
       end
     end
   end
 
-  describe "with an image for a full-bleed background" do
+  describe "with an image for a full-bleed background without attribution" do
     before(:each) do
       @slide_text = <<-SLIDE
 
@@ -258,7 +266,7 @@ a simple note
 
       SLIDE
 
-      @classnames = ''
+      @classnames = {}
       @slide = Keydown::Slide.new(@slide_text.chomp)
     end
 
@@ -269,7 +277,7 @@ a simple note
         @html = @slide.to_html
         @doc = Nokogiri(@html)
         @slide_selector = "section"
-        @slide_container = @doc.css('div.slide')[0]
+        @slide_container = @doc.css('section.slide')[0]
       end
 
       it_should_behave_like "generating HTML"
@@ -290,6 +298,10 @@ a simple note
         @slide_container['class'].split(' ').should include('my_background')
       end
 
+      it "should not have a an attribution for the background image" do
+        @doc.css('.attribution').length.should == 0
+      end
+
     end
   end
 
@@ -307,7 +319,7 @@ a simple note
 
       SLIDE
 
-      @classnames = ''
+      @classnames = {}
       @slide = Keydown::Slide.new(@slide_text.chomp)
     end
 
@@ -318,7 +330,7 @@ a simple note
         @html = @slide.to_html
         @doc = Nokogiri(@html)
         @slide_selector = "section"
-        @slide_container = @doc.css('div.slide')[0]
+        @slide_container = @doc.css('section.slide')[0]
       end
 
       it_should_behave_like "generating HTML"