dancroak-slidedown 0.1.0 → 0.1.2

data/README.md

@@ -74,6 +74,11 @@ Or for JavaScript
 * Generate PDFs (maybe via cucumber)
 * Stop making Nokogiri sad when parsing out snippets
 
+## Contributors
+
+* Pat Nakajima
+* Dan Croak
+
 (c) Copyright 2009 Pat Nakajima
 
 Permission is hereby granted, free of charge, to any person

data/lib/slide.rb

@@ -1,12 +1,24 @@
 class Slide
-  attr_accessor :text, :classes
+  attr_accessor :text, :classes, :notes
 
   def initialize(text, *classes)
     @text    = text
     @classes = classes
+    @notes   = nil
+    
+    extract_notes!
   end
 
   def html
     MakersMark::Generator.new(@text).to_html
   end
+  
+  private
+  
+  def extract_notes!
+    @text.gsub!(/^!NOTES\s*(.*\n)$/m) do |note|
+      @notes = note.to_s.chomp.gsub('!NOTES', '')
+      ''
+    end
+  end
 end

data/lib/slidedown.rb

@@ -1,7 +1,6 @@
 require 'rubygems'
 require 'optparse'
 require 'nokogiri'
-require 'rdiscount'
 require 'makers-mark'
 require 'erb'
 require File.join(File.dirname(__FILE__), 'slide')
@@ -10,8 +9,9 @@ $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
 
   def self.run!(argv = ARGV)
@@ -46,9 +46,12 @@ class SlideDown
   end
 
   # Ensures that the first slide has proper !SLIDE declaration
-  def initialize(raw)
+  def initialize(raw, opts = {})
     @raw = raw =~ /\A!SLIDE/ ? raw : "!SLIDE\n#{raw}"
     extract_classes!
+
+    self.stylesheets = opts[:stylesheets] || local_stylesheets
+    self.title =       opts[:title]       || "Slides"
   end
 
   def slides
@@ -60,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
 
@@ -72,11 +79,11 @@ class SlideDown
     @lines ||= @raw.split(/^!SLIDE\s*([a-z\s]*)$/).reject { |line| line.empty? }
   end
 
-  def stylesheets
-    Dir[Dir.pwd + '/*.stylesheets'].map { |path| File.read(path) }
+  def local_stylesheets
+    Dir[Dir.pwd + '/*.stylesheets']
   end
 
-  def jabascripts
+  def javascripts
     Dir[Dir.pwd + '/*.javascripts'].map { |path| File.read(path) }
   end
 
@@ -88,4 +95,17 @@ class SlideDown
     end
     @classes
   end
+
+  def extract_notes!
+    @raw.gsub!(/^!NOTES\s*(.*)!SLIDE$/m) do |note|
+      '!SLIDE'
+    end
+    @raw.gsub!(/^!NOTES\s*(.*\n)$/m) do |note|
+      ''
+    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

@@ -1,13 +1,11 @@
 <html>
   <head>
-    <title>Slides</title>
+    <title><%= title %></title>
     <style type="text/css" media="screen">
       <%= read('stylesheets/slides.css') %>
     </style>
     <% stylesheets.each do |style| %>
-      <style type="text/css" media="screen">
-        <%= style %>
-      </style>
+      <link rel="stylesheet" href="<%= style %>" type="text/css" media="screen" charset="utf-8" />
     <% end %>
     <script type="text/javascript">
       <%= read('javascripts/jquery-1.3.2.js') %>
@@ -21,9 +19,9 @@
     <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>

data/templates/javascripts/slides.js

@@ -72,17 +72,28 @@
       37: -1, // ARROW LEFT
       39: 1,  // ARROW RIGHT
       32: 1,  // SPACE BAR
-      13: 1   // RETURN
+      13: 1,   // RETURN
+      left: -1,
+      right: 1
     }
     
-    if (dir = DIRECTIONS[event.which]) {
+    if (dir = DIRECTIONS[event.which || event]) {
       setIndex(getIndex() + dir);
     }
   }
   
+  function clickMove(e) {
+    if (e.pageX < ($(window).width() / 2)) {
+      move('left');
+    } else {
+      move('right');
+    }
+  }
+  
   $(window).bind('resize', function() { adjustSlides(); });
   $(document).bind('keydown', move);
   $(document).bind('hash.changed', adjustSlides);
+  $(document).bind('click', clickMove);
   $(document).ready(function() {
     setIndex(getIndex() || 0);
     $(this).trigger('hash.changed');

data/vendor/albino.rb

@@ -41,7 +41,7 @@
 # Chris Wanstrath // chris@ozmm.org 
 #         GitHub // http://github.com
 #
-require 'open4'
+require 'open3'
 
 class Albino
   @@bin = '/usr/local/bin/pygmentize'
@@ -60,7 +60,7 @@ class Albino
   end
 
   def execute(command)
-    pid, stdin, stdout, stderr = Open4.popen4(command)
+    stdin, stdout, stderr = Open3.popen3(command)
     stdin.puts @target
     stdin.close
     stdout.read.strip

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification 
 name: dancroak-slidedown
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors: 
 - Pat Nakajima
+- Dan Croak
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-03-09 21:00:00 -07:00
+date: 2009-09-24 00:00:00 -07:00
 default_executable: slidedown
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rdiscount
+  name: makers-mark
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -38,8 +39,8 @@ executables:
 - slidedown
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.md
 files: 
 - README.md
 - bin/slidedown
@@ -47,20 +48,19 @@ files:
 - lib/slidedown.rb
 - templates/default.erb
 - templates/import.erb
-- templates/javascripts
 - templates/javascripts/jquery-1.3.2.js
 - templates/javascripts/jquery.easing.js
 - templates/javascripts/jquery.hash-changed.js
 - templates/javascripts/slides.js
-- templates/stylesheets
 - templates/stylesheets/screen.css
 - templates/stylesheets/slides.css
 - vendor/albino.rb
-has_rdoc: true
-homepage: 
+has_rdoc: false
+homepage: http://github.com/nakajima/slidedown
+licenses: 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 - vendor
@@ -79,9 +79,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 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