keydown 0.5.0

data/spec/lib/slide_spec.rb

@@ -0,0 +1,365 @@
+require File.expand_path(File.dirname(__FILE__) + '/../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')
+        end
+      end
+    end
+  end
+
+  shared_examples_for 'extracting slide data' do
+
+    it "should set the CSS classnames" do
+      @slide.classnames.should == @classnames
+    end
+
+    it "should extract the slide content" do
+      @slide.content.should match(/^# A Slide/)
+      @slide.content.should match(/With some text/)
+    end
+
+    it "should remove the notes from the content" do
+      @slide.content.should_not match(/a simple note/)
+    end
+
+    it "should extract the notes" do
+      @slide.notes.should match(/a simple note/)
+    end
+  end
+
+  shared_examples_for "generating HTML" do
+    it "should assign the classname(s) to the section" do
+      @doc.css(@slide_selector).should_not be_nil
+    end
+
+    it "should convert the content via Markdown" do
+      @doc.css('section h1').text.should == 'A Slide'
+    end
+
+    it "should not include the notes in the HTML" do
+      @doc.css('section p').each do |node|
+        node.text.should_not match(/!NOTES/)
+      end
+    end
+  end
+
+  shared_examples_for "Pygmentizing code fragments" do
+    it "should colorize the code fragments" do
+      @doc.css('.highlight').length.should == 1
+    end
+  end
+
+  describe 'without a CSS classname' do
+    before :each do
+      @slide_text = <<-SLIDE
+
+# A Slide
+With some text
+
+!NOTES
+a simple note
+      SLIDE
+
+      @classnames = ''
+      @slide = Keydown::Slide.new(@slide_text)
+    end
+
+    it_should_behave_like "extracting slide data"
+
+    describe "when generating HTML" do
+      before :each do
+        @html = @slide.to_html
+        @doc = Nokogiri(@html)
+        @slide_selector = "section"
+      end
+
+      it_should_behave_like "generating HTML"
+    end
+  end
+
+  describe "with a single CSS classname" do
+    before :each do
+      @slide_text = <<-SLIDE
+
+# A Slide
+With some text
+
+!NOTES
+a simple note
+      SLIDE
+
+      @classnames = 'foo'
+      @slide = Keydown::Slide.new(@slide_text, 'foo')
+    end
+
+    it_should_behave_like "extracting slide data"
+
+    describe "when generating HTML" do
+      before :each do
+        @html = @slide.to_html
+        @doc = Nokogiri(@html)
+        @slide_selector = "section.#{@classnames}"
+      end
+
+      it_should_behave_like "generating HTML"
+    end
+  end
+
+  describe "with multiple CSS classnames" do
+    before :each do
+      @slide_text = <<-SLIDE
+
+# A Slide
+With some text
+
+!NOTES
+a simple note
+      SLIDE
+
+      @classnames = 'foo bar'
+      @slide = Keydown::Slide.new(@slide_text, 'foo bar')
+
+    end
+
+    it_should_behave_like "extracting slide data"
+
+    describe "generating HTML" do
+      before :each do
+        @html = @slide.to_html
+        @doc = Nokogiri(@html)
+        @slide_selector = "section.#{@classnames}"
+      end
+      it_should_behave_like "generating HTML"
+    end
+  end
+
+  describe "without a note" do
+    before :each do
+      @slide_text = <<-SLIDE
+
+# A Slide
+With some text
+      SLIDE
+
+      @classnames = ''
+      @slide = Keydown::Slide.new(@slide_text)
+    end
+
+    it "should set the CSS classnames" do
+      @slide.classnames.should == @classnames
+    end
+
+    it "should extract the slide content" do
+      @slide.content.should match(/^# A Slide/)
+      @slide.content.should match(/With some text/)
+    end
+
+    describe "when generating HTML" do
+      before :each do
+        @html = @slide.to_html
+        @doc = Nokogiri(@html)
+        @slide_selector = "section"
+      end
+
+      it_should_behave_like "generating HTML"
+    end
+  end
+
+  describe "with code to higlight" do
+
+    describe "using the Slidedown syntax" do
+      before :each do
+        @slide_text = <<-SLIDE
+
+# A Slide
+With some text
+
+@@@ ruby
+  def a_method(options)
+    puts "I can has options " + options
+  end
+@@@
+!NOTES
+a simple note
+
+        SLIDE
+
+        @classnames = ''
+        template_dir = File.join(Keydown::Tasks.source_root, 'templates', 'rocks')
+        @slide = Keydown::Slide.new(@slide_text)
+      end
+
+      it_should_behave_like "extracting slide data"
+
+      describe "when generating HTML" do
+        before :each do
+          @html = @slide.to_html
+          @doc = Nokogiri(@html)
+          @slide_selector = "section"
+        end
+
+        it_should_behave_like "generating HTML"
+
+        it_should_behave_like "Pygmentizing code fragments"
+      end
+    end
+
+    describe "using the Github markup syntax" do
+      before :each do
+        @slide_text = <<-SLIDE
+
+# A Slide
+With some text
+
+``` ruby
+  def a_method(options)
+    puts "I can has options " + options
+  end
+```
+!NOTES
+a simple note
+
+        SLIDE
+
+        @classnames = ''
+        @slide = Keydown::Slide.new(@slide_text)
+      end
+
+      it_should_behave_like "extracting slide data"
+
+      describe "when generating HTML" do
+        before :each do
+          @html = @slide.to_html
+          @doc = Nokogiri(@html)
+          @slide_selector = "section"
+        end
+
+        it_should_behave_like "generating HTML"
+        it_should_behave_like "Pygmentizing code fragments"
+      end
+    end
+  end
+
+  describe "with an image for a full-bleed background" do
+    before(:each) do
+      @slide_text = <<-SLIDE
+
+# A Slide
+With some text
+
+}}} images/my_background.png
+
+!NOTES
+a simple note
+
+      SLIDE
+
+      @classnames = ''
+      @slide = Keydown::Slide.new(@slide_text.chomp)
+    end
+
+    it_should_behave_like "extracting slide data"
+
+    describe "when generating HTML" do
+      before :each do
+        @html = @slide.to_html
+        @doc = Nokogiri(@html)
+        @slide_selector = "section"
+        @slide_container = @doc.css('div.slide')[0]
+      end
+
+      it_should_behave_like "generating HTML"
+
+      it "should remove any declaration of a background image" do
+        @doc.css(@slide_selector)[0].content.should_not match(/\}\}\}\s+images\/my_background\.png/)
+      end
+
+      it "should save off the background image info for use when generating the HTML" do
+        @slide.background_image.should == {:classname => 'my_background', :path => 'images/my_background.png'}
+      end
+
+      it "should add the full-background class to the containing div" do
+        @slide_container['class'].split(' ').should include('full-background')
+      end
+
+      it "should add the background image class to the containing div" do
+        @slide_container['class'].split(' ').should include('my_background')
+      end
+
+    end
+  end
+
+  describe "with an image for a full-bleed background with a Flickr attribution" do
+    before(:each) do
+      @slide_text = <<-SLIDE
+
+# A Slide
+With some text
+
+}}} images/my_background.png::cprsize::flickr::http://flickr.com/1234
+
+!NOTES
+a simple note
+
+      SLIDE
+
+      @classnames = ''
+      @slide = Keydown::Slide.new(@slide_text.chomp)
+    end
+
+    it_should_behave_like "extracting slide data"
+
+    describe "when generating HTML" do
+      before :each do
+        @html = @slide.to_html
+        @doc = Nokogiri(@html)
+        @slide_selector = "section"
+        @slide_container = @doc.css('div.slide')[0]
+      end
+
+      it_should_behave_like "generating HTML"
+
+      it "should remove any declaration of a background image" do
+        @doc.css(@slide_selector)[0].content.should_not match(/\}\}\}\s+images\/my_background\.png/)
+      end
+
+      it "should save off the background image info for use when generating the HTML" do
+        @slide.background_image[:classname].should == 'my_background'
+        @slide.background_image[:path].should == 'images/my_background.png'
+        @slide.background_image[:service].should == 'flickr'
+        @slide.background_image[:attribution_text].should == 'cprsize'
+        @slide.background_image[:attribution_link].should == 'http://flickr.com/1234'
+      end
+
+      it "should add the full-background class to the containing div" do
+        @slide_container['class'].split(' ').should include('full-background')
+      end
+
+      it "should add the background image class to the containing div" do
+        @slide_container['class'].split(' ').should include('my_background')
+      end
+
+      describe "it makes an attribution element that" do
+        before(:each) do
+          @attribution = @doc.css('.attribution')[0]
+        end
+
+        it "should have the specified CSS class" do
+          @attribution['class'].split(' ').should include('flickr')
+        end
+
+        it "should have the specified text" do
+          @attribution.content.should match(/cprsize/)
+        end
+
+        it "should have the specified link" do
+          @attribution.css('a')[0]['href'].should match('http://flickr.com/1234')
+        end
+      end
+    end
+  end
+end

data/spec/lib/slidedeck_spec.rb

@@ -0,0 +1,133 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Keydown::SlideDeck do
+
+  shared_examples_for "finding slides" do
+    describe "when building slides" do
+
+      it "should find the document's title" do
+        @deck.title.should == "Kermit the Frog Says..."
+      end
+
+      it "should find all the slides in the markdown" do
+        @deck.slides.length.should == 3
+      end
+    end
+  end
+
+
+  before :each do
+    module Keydown
+      class Tasks
+        def self.template_dir
+          File.join(Keydown::Tasks.source_root, 'templates', 'rocks')
+        end
+      end
+    end
+  end
+
+  describe "with a title" do
+    before :each do
+      @slides_text = <<-SLIDES
+# Kermit the Frog Says...
+
+!SLIDE
+
+# This Presentation
+
+!NOTE
+
+I think this should be ignored
+
+!SLIDE foo
+
+# Is Brought to You By
+
+!NOTE
+
+and this
+
+!SLIDE foo bar
+
+# The Letter Q
+
+      SLIDES
+
+      @deck = Keydown::SlideDeck.new(@slides_text)
+    end
+
+    it_should_behave_like "finding slides"
+
+    describe "when generating HTML" do
+      before :each do
+        @html = @deck.to_html
+        @doc = Nokogiri(@html)
+      end
+
+      it "should set the document's title" do
+        @doc.css('title').text.should == "Kermit the Frog Says..."
+      end
+
+      it "should generate the correct number of slides" do
+        @doc.css('div.slide').length.should == 4
+      end
+
+      it "should set the CSS classnames of each slide" do
+        slides = @doc.css('div.slide section')
+
+        slides[0]['class'].should == 'middle' # config/start slide
+        slides[1]['class'].should == nil
+        slides[2]['class'].should == 'foo'
+        slides[3]['class'].should == 'foo bar'
+      end
+    end
+  end
+
+  describe "with a background image" do
+    before :each do
+      @slides_text = <<-SLIDES
+# Kermit the Frog Says...
+
+!SLIDE
+
+# This Presentation
+
+}}} images/my_background.png
+
+!SLIDE foo
+
+# Is Brought to You By
+
+!NOTE
+
+and this
+
+!SLIDE foo bar
+
+# The Letter Q
+      SLIDES
+
+      @deck = Keydown::SlideDeck.new(@slides_text)
+    end
+
+    it_should_behave_like "finding slides"
+
+    describe "when generating HTML" do
+      before(:each) do
+        @html = @deck.to_html
+        @doc = Nokogiri(@html)
+        @slide_with_background = @doc.css('div.slide')[1]
+      end
+
+      it "should add the full-bleed background CSS classname to any slide that specifies a background" do
+        @slide_with_background['class'].split(' ').should include('full-background')
+      end
+
+      it "should add a custom classname to a slide that specifies a background" do
+        @slide_with_background['class'].split(' ').should include('my_background')
+      end
+    end
+
+
+  end
+end