slidedown 0.1.1 → 0.2.0

data/README.md

@@ -4,8 +4,7 @@ Generate slides with Markdown
 
 ## Usage
 
-Write your talk. Currently, the syntax highlight lexer defaults to Ruby.
-Adding support for specifying languages is in the TODOs.
+Write your talk.
 
     !SLIDE
     
@@ -35,7 +34,7 @@ Generate the output:
 
 ### Custom Styles
 
-To add custom styles to your slides, just create stylesheets in the same directory as your presentation's markdown file:
+To add custom styles to your slides, just create stylesheets in the same directory as your presentation markdown file:
 
     | - presentation-directory
       | - slides.md
@@ -43,28 +42,41 @@ To add custom styles to your slides, just create stylesheets in the same directo
 
 The additional styles will be added to your generated slides.
 
+## Navigation
+
+Give your presentation!
+
+* left, right arrows to navigate through slides
+* esc to go home
+
 ## Syntax Highlighting
 
-slidedown syntax highlighting works just like Lighthouse's:
+For Ruby:
 
     @@@ ruby
-    def foo
-      :bar
-    end
+        def foo
+          :bar
+        end
     @@@
 
-Or for JavaScript
+For Javascript
 
     @@@ js
-      function foo() {
-        return 'bar';
-      }
+        function foo() {
+          return 'bar';
+        }
+    @@@
+
+For ERb:
+
+    @@@ rhtml
+        <%= @post.created_at.to_s(:fancy) %>
     @@@
 
 ### Requirements
 
-* RDiscount
 * Nokogiri
+* makers-mark
 * pygments (for syntax highlighting)
 
 ## Todo
@@ -100,4 +112,4 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
+OTHER DEALINGS IN THE SOFTWARE.

data/lib/slidedown.rb

@@ -9,7 +9,7 @@ $SILENT = true
 
 class SlideDown
   USAGE = "The SlideDown command line interface takes a .md (Markdown) file as its only required argument. It will convert the file to HTML in standard out. Options:
-  -t, --template [TEMPLATE] the .erb files in /templates directory. Default is -t default, which prints stylesheets and javascripts inline. The import template uses link and script tags."
+  -t, --template [TEMPLATE] the .erb files in /templates directory. Default is -t default, which prints stylesheets and javascripts inline. The import template uses link and script tags. This can also accept an absolute path for templates outside the /templates directory."
 
   attr_accessor :stylesheets, :title
   attr_reader :classes
@@ -63,9 +63,13 @@ class SlideDown
   end
 
   def render(name)
-    directory = File.join(File.dirname(__FILE__), "..", "templates")
-    path      = File.join(directory, "#{name}.erb")
-    template  = File.read(path)
+    if is_absolute_path?(name)
+      template = File.read("#{name}.erb")
+    else
+      directory = File.join(File.dirname(__FILE__), "..", "templates")
+      path      = File.join(directory, "#{name}.erb")
+      template  = File.read(path)
+    end
     ERB.new(template).result(binding)
   end
 
@@ -79,7 +83,7 @@ class SlideDown
     Dir[Dir.pwd + '/*.stylesheets']
   end
 
-  def jabascripts
+  def javascripts
     Dir[Dir.pwd + '/*.javascripts'].map { |path| File.read(path) }
   end
 
@@ -100,4 +104,8 @@ class SlideDown
       ''
     end
   end
+
+  def is_absolute_path?(path)
+    path == File.expand_path(path)
+  end
 end

data/spec/commandline_spec.rb

@@ -0,0 +1,64 @@
+require File.join(File.dirname(__FILE__), 'helper')
+require 'tempfile'
+require 'ftools'
+
+describe 'slidedown commandline tool' do
+  include TestHelp
+
+  it "converts MD to HTML" do
+    run_slidedown
+    result_file_content.should == reference_file_content
+  end
+
+  it "accepts -t template-filename" do
+    run_slidedown("-t import")
+    result_file_content.should == reference_file_content("slides-import")
+  end
+
+  it "defaults to default template" do
+    run_slidedown("-t default")
+    result_file_content.should == reference_file_content
+  end
+
+  it "accepts -t /full/path/to/template-filename" do
+    import_template_path = File.join(root_path, 'templates', 'import.erb')
+    other_template_path  = Tempfile.new("slidedown-template").path
+    File.copy(import_template_path, "#{other_template_path}.erb")
+
+    run_slidedown("-t #{other_template_path}")
+
+    result_file_content.should == reference_file_content("slides-import")
+  end
+
+  def run_slidedown(opts = "")
+    `#{slidedown_path} #{source_path} #{opts} > #{result_file_path}`
+  end
+
+  def slidedown_path
+    File.join(root_path, 'bin', 'slidedown')
+  end
+
+  def source_path
+    File.join(root_path, 'example', 'slides.md')
+  end
+
+  def root_path
+    File.join(File.dirname(__FILE__), '..')
+  end
+
+  def reference_file_content(basename = 'slides')
+    open(reference_file_path(basename)).read
+  end
+
+  def reference_file_path(basename = 'slides')
+    File.join(root_path, 'example', "#{basename}.html")
+  end
+
+  def result_file_content
+    open(result_file_path).read
+  end
+
+  def result_file_path
+    @result_file_path_for_current_test ||= Tempfile.new("slidedown-specs").path
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'rubygems'
+require 'nokogiri'
+require 'spec'
+require File.join(File.dirname(__FILE__), *%w[.. lib slidedown])
+
+module TestHelp
+  def slide(*args)
+    Slide.new(@markdown, *args)
+  end
+
+  def slidedown
+    SlideDown.new(@markdown)
+  end
+
+  def with_markdown(markdown)
+    @markdown = markdown.gsub(/^\s*\|/, '')
+  end
+end

data/spec/slide_spec.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+describe 'SlideDown' do
+  include TestHelp
+
+  it 'has text' do
+    with_markdown <<-MD
+    |# foo
+    MD
+    slide.text.should include('# foo')
+  end
+  
+  it 'gets class names' do
+    with_markdown <<-MD
+    |# foo
+    MD
+    slide('code').classes.should == ['code']
+  end
+  
+  it 'gets html' do
+    with_markdown <<-MD
+    |# foo
+    MD
+    Nokogiri(slide.html).at('h1').text.should == 'foo'
+  end
+  
+  it 'syntax highlights' do
+    with_markdown <<-MD
+    |@@@ ruby
+    |  def foo
+    |    :bar
+    |  end
+    |@@@
+    MD
+    Nokogiri(slide.html).at('.code.ruby').should_not be_nil
+  end
+end

data/spec/slidedown_spec.rb

@@ -0,0 +1,87 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+describe 'SlideDown' do
+  include TestHelp
+
+  it 'finds slides' do
+    with_markdown <<-MD
+    |# First
+    |
+    |!SLIDE
+    |
+    |# Second
+    MD
+    slidedown.slides.length.should == 2
+  end
+
+  it 'generates HTML from markdown' do
+    with_markdown <<-MD
+    |!SLIDE
+    |# The title
+    |!SLIDE
+    MD
+    Nokogiri::HTML(slidedown.render('default')).at('h1').should_not be_nil
+  end
+
+  it 'adds class names to slides' do
+    with_markdown <<-MD
+    |# This is the title
+    |!SLIDE awesome
+    |# The title
+    MD
+    second_slide = Nokogiri::HTML(slidedown.render('default')).search('#track > div')[1]
+    second_slide['class'].should include('awesome')
+  end
+  
+  it 'ignores content after !NOTES declaration' do
+    with_markdown <<-MD
+    |# The Title
+    |!NOTES
+    |# Some Notes
+    |!SLIDE
+    |# Another Title
+    |!NOTES
+    |# More Notes
+    |!SLIDE
+    |# Yet Another Title
+    MD
+    
+    slidedown.slides.length.should == 3
+    
+    first_slide = Nokogiri::HTML(slidedown.render('default')).search('#track > div')[0].content
+    second_slide = Nokogiri::HTML(slidedown.render('default')).search('#track > div')[1].content
+    
+    first_slide.should_not include('Some Notes')
+    second_slide.should_not include('More Notes')
+  end
+
+  # this one is hard
+  it 'allows custom lexer' do
+    with_markdown <<-MD
+    |@@@ js
+    |  (function() { })();
+    |@@@
+    MD
+    # slidedown.render('default')
+    Nokogiri(slidedown.render('default')).at('.highlight.js').should_not be_nil
+  end
+
+  it 'links css files' do
+    stylesheets = ["reset.css", "my.css"]
+    doggles = SlideDown.new("# doggles", :stylesheets => stylesheets)
+
+    stylesheets.each do |stylesheet|
+      Nokogiri(doggles.render('default')).at("link[rel='stylesheet'][href='#{stylesheet}']").should_not be_nil
+    end
+  end
+
+  it 'has a default title' do
+    with_markdown("# broccoli")
+    Nokogiri(slidedown.render('default')).at("title").text.should == "Slides"
+  end
+
+  it 'can be given a custom title' do
+    broccoli = SlideDown.new("# broccoli", :title => "Choppin")
+    Nokogiri(broccoli.render('default')).at("title").text.should == "Choppin"
+  end
+end

data/templates/default.erb

@@ -19,13 +19,16 @@
     <script type="text/javascript" charset="utf-8">
       <%= read('javascripts/slides.js') %>
     </script>
-    <% jabascripts.each do |jaba| %>
+    <% javascripts.each do |javascript| %>
       <script type="text/javascript" charset="utf-8">
-        <%= jaba %>
+        <%= javascript %>
       </script>
     <% end %>
   </head>
   <body>
+    <div id="instructions">
+      Use the left/right arrow keys to navigate.
+    </div>
     <div id="slides">
       <div id="track">
         <% slides.each_with_index do |slide, idx| %>

data/templates/javascripts/slides.js

@@ -4,43 +4,43 @@
   var allSlides = function() {
     return $('#slides #track > div');
   }
-  
+
   var slideDimensions = function() {
     return {
       width: $(window).width(),
       height: $(window).height()
     }
   }
-  
+
   var getIndex = function() {
     var index = document.location.hash.split('#')[1];
     return Number(index);
   }
-  
+
   var setIndex = function(idx) {
     var newSlide = '#slide-' + idx;
     if ($(newSlide).size() < 1) { return false; }
     document.location.hash = '#' + idx;
   }
-  
+
   var setSlideDimensions = function() {
     var dimensions = slideDimensions();
-    
+
     $('#slides').height(dimensions.height);
     $('#slides').width(dimensions.width);
-    
+
     allSlides().height(dimensions.height);
     allSlides().width(dimensions.width);
   }
-  
+
   var showCurrentSlide = function() {
     var dimensions = slideDimensions();
     var index = getIndex();
     var offset = (index || 0) * dimensions.width;
-    
+
     $('#track').animate({ marginLeft: '-' + offset + 'px' }, 200);
   }
-  
+
   var verticalAlign = function() {
     var dimensions = slideDimensions();
     var margin = (dimensions.height - $(this).height()) / 2;
@@ -54,34 +54,42 @@
       overflow: 'hidden',
       fontSize: '26px'
     });
-    
+
     allSlides().find('.content').each(verticalAlign);
   }
-  
+
   var adjustSlides = function() {
     var dimensions = slideDimensions();
-    
+
     setSlideDimensions();
     showCurrentSlide();
 
     formatGist();
   }
-  
+
   var move = function(event) {
     var DIRECTIONS = {
-      37: -1, // ARROW LEFT
-      39: 1,  // ARROW RIGHT
-      32: 1,  // SPACE BAR
-      13: 1,   // RETURN
+      37: -1,     // ARROW LEFT
+      39: 1,      // ARROW RIGHT
+      32: 1,      // SPACE BAR
+      13: 1,      // RETURN
+      27: 'home', // ESCAPE
       left: -1,
       right: 1
     }
-    
+
     if (dir = DIRECTIONS[event.which || event]) {
-      setIndex(getIndex() + dir);
+      if (dir == 'home') {
+        event.preventDefault();
+        event.stopPropagation();
+        location.href = '/';
+      } else {
+        $('#instructions').slideUp(100);
+        setIndex(getIndex() + dir);
+      }
     }
   }
-  
+
   function clickMove(e) {
     if (e.pageX < ($(window).width() / 2)) {
       move('left');
@@ -89,7 +97,11 @@
       move('right');
     }
   }
-  
+
+  function hideInstructions() {
+    $('#instructions').slideUp(200);
+  }
+
   $(window).bind('resize', function() { adjustSlides(); });
   $(document).bind('keydown', move);
   $(document).bind('hash.changed', adjustSlides);
@@ -100,5 +112,7 @@
     if (document.location.search.indexOf('notes') == 1) {
       $('.notes').show();
     }
+
+    window.setTimeout(hideInstructions, 3000);
   });
-})(jQuery);
+})(jQuery);

data/templates/stylesheets/slides.css

@@ -8,6 +8,7 @@ body {
   font-size: 38px;
   color: #111;
   background: #fff;
+  overflow: hidden;
 }
 
 pre {
@@ -26,6 +27,17 @@ ul {
   padding: 0 0 0 1em;
 }
 
+#instructions {
+  position: absolute;
+  width: 99%;
+  text-align: center;
+  background: #ffd;
+  font-size: 20px;
+  padding: 10px;
+  font-weight: bold;
+  border-bottom: 1px solid #ff0;
+}
+
 #slides {
   overflow: hidden;
   text-align: left;
@@ -112,4 +124,4 @@ ul {
 .code .vc { color: #008080 } /* Name.Variable.Class */
 .code .vg { color: #008080 } /* Name.Variable.Global */
 .code .vi { color: #008080 } /* Name.Variable.Instance */
-.code .il { color: #009999 } /* Literal.Number.Integer.Long */
+.code .il { color: #009999 } /* Literal.Number.Integer.Long */

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: slidedown
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Pat Nakajima
@@ -10,37 +15,41 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-10 00:00:00 -04:00
+date: 2009-09-24 00:00:00 -04:00
 default_executable: slidedown
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: makers-mark
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: nokogiri
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id002
 description: 
 email: 
 executables: 
 - slidedown
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.md
 files: 
 - README.md
 - bin/slidedown
@@ -55,13 +64,17 @@ files:
 - templates/stylesheets/screen.css
 - templates/stylesheets/slides.css
 - vendor/albino.rb
+- spec/commandline_spec.rb
+- spec/helper.rb
+- spec/slide_spec.rb
+- spec/slidedown_spec.rb
 has_rdoc: true
-homepage: 
+homepage: http://github.com/nakajima/slidedown
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 - vendor
@@ -69,20 +82,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.3
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 2
 summary: Create slides with Markdown
-test_files: []
-
+test_files: 
+- spec/commandline_spec.rb
+- spec/helper.rb
+- spec/slide_spec.rb
+- spec/slidedown_spec.rb