keydown 0.5.0

data/.gitignore

@@ -0,0 +1,5 @@
+.idea/
+.DS_Store
+pkg/*
+*.gem
+.bundle

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format Fuubar

data/.rvmrc

@@ -0,0 +1 @@
+rvm use default@keydown

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in keydown.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    keydown (0.7.0)
+      rdiscount (>= 1.6.8)
+      thor (>= 0.14.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    chalofa_ruby-progressbar (0.0.9.1)
+    diff-lcs (1.1.2)
+    fuubar (0.0.4)
+      chalofa_ruby-progressbar (~> 0.0.9)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.1.4)
+    gem-release (0.0.16)
+    nokogiri (1.4.4)
+    rdiscount (1.6.8)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-instafail (0.1.7)
+    rspec-mocks (2.5.0)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fuubar
+  gem-release
+  keydown!
+  nokogiri
+  rdiscount (>= 1.6.8)
+  rspec (>= 2.5.0)
+  thor (>= 0.14.0)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Infews LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+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.

data/README.md

@@ -0,0 +1,183 @@
+# KeyDown
+
+KeyDown is another 'Presentation System in a single HTML page' inspired by [Showoff](http://github.com/dirnic/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.
+
+## Usage
+
+### Generate a Template
+
+Get started by making a sample project:
+
+    $ keydown generate my_presentation
+
+This will make:
+
+    | - my_presentation/
+      | - css/               - Keydown CSS and a file for you to customize
+      | - 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
+
+Edit `my_presentation.md` and write your presentation as if it were going to be HTML (because it will be):
+
+    !SLIDE
+    
+    # This is my talk
+    
+    !SLIDE
+    
+    ## I hope you enjoy it
+    
+    !SLIDE code
+    
+        def foo
+          :bar
+        end
+    
+	!NOTES
+	
+	  * make sure to explain the use of Ruby symbols	
+	
+    !SLIDE
+    
+    Google is [here](http://google.com)
+    
+    !SLIDE
+    
+    # Questions?
+
+`!NOTE` blocks will be ignored when generating the HTML.
+
+### Generate the Deck
+
+    $ keydown slides my_presentation.md
+
+..will generate `my_presentation.html`
+
+### Present
+
+Give your presentation! Open `my_presentation.html` in a browser and talk away:
+
+  * left, right arrows to navigate through slides
+
+## Usage
+
+### 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>`.
+	
+### 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 
+
+Your presentation will be generated in the same directory as your Markdown file. So URI references via relative paths
+are fine.  So feel free to use the local images directory (see the `generate` task above).
+
+### Full Screen background images
+
+Keydown supports slides with full screen background images, including attribution text.
+
+    !SLIDE
+    
+    # This slide has a background image
+    
+    }}} images/sunset.jpg
+
+This slide will have `sunset.jpg` as a full-bleed background image. It's aspect ratio will be preserved.
+
+If you wish to have attribution text, an icon (currently Flickr and Creative Commons graphics are supported via `flickr` and `cc` respectively), and link the text, separate the text with `::` like this:
+
+
+    !SLIDE
+    
+    # This slide has a background image
+     
+    }}} images/sunset.jpg::cprsize::flickr::http:://flickr.com/cprsize
+
+### Syntax Highlighting
+
+Code syntax highlighting is done via [Pygments](), which must be installed locally to work. All Pygments lexers are supported.
+
+Mark your code by block escaping via `@@@` or ` ``` `
+
+For Ruby:
+
+    @@@ ruby
+        def foo
+          :bar
+        end
+    @@@
+
+For JavaScript
+
+    ``` js
+        function foo() {
+          return 'bar';
+        }
+    ```
+
+For ERb:
+
+    @@@ rhtml
+        <%= @post.created_at.to_s(:fancy) %>
+    @@@
+
+### Custom CSS
+
+All css files in the `css` directory will be linked into your presentation HTML file.
+
+### Custom JavaScript.
+
+All JavaScript files in the `js` directory will be linked in your presentation HTML file.
+
+## Requirements
+
+### For Use
+
+   * Ruby and Rubygems
+   * [Pygments]() is required for code syntax highlighting
+   * Other dependent gems will be installed
+
+### For Development
+
+   * RSpec
+   * Nokogiri
+
+## Note on Patches/Pull Requests
+ 
+  * Fork the project.
+  * Make your feature addition or bug fix.
+  * Add tests for it. This is important so I don't break it in a future version unintentionally.
+  * Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+  * Send me a pull request. Bonus points for topic branches.
+
+## Thanks & Attribution
+
+Thanks to:
+
+* HTML5 Rocks guys for a great presentation template
+* [@nakajima](http://twitter.com/nakajima) & [Slidedown]() for some parsing
+* The various Github guys for Albino, Gollum, etc.
+
+## Copyright
+
+Copyright &copy;  Infews LLC. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc "Run all specs"
+task :spec do
+  system("rspec spec")
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.6.0

data/bin/keydown

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'keydown'
+
+Keydown::Tasks.start
+

data/keydown.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "version"
+
+Gem::Specification.new do |s|
+  s.name        = "keydown"
+  s.version     = Keydown::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Davis W. Frank"]
+  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.add_dependency 'thor', '>= 0.14.0'
+  s.add_dependency 'rdiscount', '>= 1.6.8'
+
+  s.add_development_dependency "rspec", ">= 2.5.0"
+  s.add_development_dependency "fuubar"
+  s.add_development_dependency "nokogiri"
+  s.add_development_dependency "gem-release"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/keydown/lib/slide.rb

@@ -0,0 +1,125 @@
+require 'digest/sha1'
+require 'albino'
+
+module Keydown
+  class Slide
+
+    attr_reader :content
+    attr_reader :notes
+    attr_reader :background_image
+
+    def initialize(text, classnames = '')
+      @content = text
+      @notes = ''
+      @codemap = {}
+      @background_image = {}
+
+      @classnames = []
+      classnames.split(' ').inject(@classnames) do |css_classnames, name|
+        css_classnames << name
+        css_classnames
+      end
+
+      extract_notes!
+      extract_content!
+      extract_code!
+      extract_background_image!
+      pygmentize_code!
+    end
+
+    def classnames
+      @classnames.join(' ')
+    end
+
+    def container_classnames
+      @names ||= begin
+        names = ['slide']
+
+        unless @background_image.empty?
+          names << 'full-background'
+          names << @background_image[:classname]
+        end
+
+        names.join(' ')
+      end
+    end
+
+    def background_attribution_classnames
+      names = ['attribution']
+
+      names << if background_image[:attribution_text]
+        background_image[:service]
+               else
+                 'hidden'
+               end
+
+      names.join(' ')
+    end
+
+    def to_html
+      require 'erb'
+      require 'rdiscount'
+
+      html_content = RDiscount.new(@content).to_html
+      template = File.new(File.join(Tasks.template_dir, 'slide.rhtml'))
+
+      ERB.new(template.read).result(binding)
+    end
+
+    private
+
+    def extract_notes!
+      @content.gsub!(/^!NOTE\s*(.*\n)$/m) do
+        @notes = $1.chomp
+        ''
+      end
+    end
+
+    def extract_content!
+      @content.gsub!(/^!NOTE(S)?\s*(.*\n)$/m, '')
+    end
+
+    def extract_code!
+      @content.gsub!(/^(```|@@@) ?(.+?)\r?\n(.+?)\r?\n(```|@@@)\r?$/m) do
+        id = Digest::SHA1.hexdigest($3)
+        @codemap[id] = {:lang => $2, :code => $3}
+        id
+      end
+    end
+
+    def extract_background_image!
+      images = []
+      @content.gsub!(/^(\}\}\}) ?(.+?)(\r?\n)?$/m) do
+        images << $2
+        ''
+      end
+
+      return unless images.first
+
+      split_line = images.first.split('::')
+      image_path = split_line[0]
+
+      @background_image = {:classname => image_path.match(/([\w-]+)\.?[\w]+$/)[1],
+                           :path => image_path}
+
+      unless split_line[1].nil? || split_line[1].empty?
+        @background_image.merge!({:attribution_text => split_line[1],
+                                  :service => split_line[2],
+                                  :attribution_link => split_line[3]})
+      end
+    end
+
+    def pygmentize_code!
+      @codemap.each do |id, spec|
+        lang = spec[:lang]
+        code = spec[:code]
+        if code.all? { |line| line =~ /\A\r?\n\Z/ || line =~ /^(  |\t)/ }
+          code.gsub!(/^(  |\t)/m, '')
+        end
+
+        @content.gsub!(id, Albino.new(code, lang).colorize)
+      end
+    end
+
+  end
+end

data/lib/keydown/lib/slidedeck.rb

@@ -0,0 +1,55 @@
+module Keydown
+  class SlideDeck
+
+    attr_reader :title
+    attr_reader :slides
+
+    def initialize(text)
+      @title = ''
+      @slides = []
+      @text = text
+
+      set_title
+      extract_classnames!
+      build_slides
+    end
+
+    def to_html
+      require 'erb'
+
+      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)
+    end
+
+    private
+
+    def set_title
+      match_data = @text.match(/\A\s*#\s*(.*)$/)
+
+      @title = match_data[1] if match_data
+    end
+
+    def extract_classnames!
+      @classnames = []
+      @text.gsub!(/^!SLIDE\s*([\w\s\-]*)\n/m) do
+        @classnames << $1.chomp
+        "!SLIDE\n"
+      end
+    end
+
+    def build_slides
+      slides_text = @text.split(/!SLIDE/).reject { |s| s.empty? }
+      slides_text[1..-1].each_with_index do |slide_text, i|
+        slide_text.gsub(/\A(\n+)/, '').chomp!
+        @slides << Keydown::Slide.new(slide_text, @classnames[i])
+      end
+    end
+  end
+
+end

data/lib/keydown/tasks/generate.rb

@@ -0,0 +1,12 @@
+module Keydown
+  class Tasks < Thor
+    attr_reader :presentation_name
+
+    desc "generate NAME", "Make a directory & sample files for presentation NAME"
+
+    def generate(name)
+      @presentation_name = name
+      directory "templates/generate", name
+    end
+  end
+end

data/lib/keydown/tasks/slides.rb

@@ -0,0 +1,36 @@
+module Keydown
+  class Tasks < Thor
+
+    desc "slides FILE", "Convert a Keydown FILE into an HTML presentation"
+
+    def slides(file)
+
+      file += '.md' unless file.match(/\.md$/)
+
+      unless File.exist?(file)
+        say "#{file} not found. Please call with a KeyDown Markdown file: keydown slides my_file.md", :red
+        return
+      end
+
+      @@template_dir = File.join(Keydown::Tasks.source_root, 'templates', 'rocks')
+
+      say "Creating Keydown presentation from #{file}", :yellow
+
+      slide_deck = SlideDeck.new(File.new(file).read)
+      backgrounds = slide_deck.slides.collect do |slide|
+        slide.background_image unless slide.background_image.empty?
+      end.compact
+
+      css_template = File.new(File.join(Tasks.template_dir, '..', 'keydown.css.erb'))
+      create_file 'css/keydown.css', :force => true do
+        ERB.new(css_template.read).result(binding)
+      end
+
+      presentation = file.gsub('md', 'html')
+
+      create_file presentation, :force => true do
+        slide_deck.to_html
+      end
+    end
+  end
+end

data/lib/keydown.rb

@@ -0,0 +1,22 @@
+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

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Keydown
+  VERSION = "0.5.0"
+end

data/spec/fixtures/custom.css

@@ -0,0 +1,5 @@
+/* A custom CSS file */
+
+section {
+  color: red;
+}

data/spec/fixtures/custom.js

@@ -0,0 +1,3 @@
+function foo() {
+
+}

data/spec/fixtures/with_backgrounds.md

@@ -0,0 +1,29 @@
+# Kermit the Frog Says...
+
+!SLIDE
+
+# Presenation Zen
+
+}}} images/one.png
+
+!NOTE
+
+I think this should be ignored
+
+!SLIDE foo
+
+# Makes for Awesome Decks
+
+}}} images/two.png
+
+!NOTE
+
+and this
+
+!SLIDE
+
+# But sometimes you don't need them
+
+!NOTE
+
+and this

data/spec/fixtures/with_code.md

@@ -0,0 +1,26 @@
+# Kermit the Frog Says...
+
+!SLIDE
+
+# This Presentation
+
+!NOTE
+
+I think this should be ignored
+
+!SLIDE foo
+
+# Is Brought to You by
+@@@ ruby
+  def a_method(options)
+    { :foo => 'bar }
+  end
+@@@
+
+!NOTE
+
+and this
+
+!SLIDE foo bar
+
+# The Letter Q

data/spec/fixtures/with_title.md

@@ -0,0 +1,21 @@
+# 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

data/spec/fixtures/without_title.md

@@ -0,0 +1,21 @@
+# 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