zlide 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+slides

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David Roetzel
+
+MIT License
+
+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,47 @@
+# zlide
+
+zlide is a tool to build web-based presentations from markdown files.
+
+It currently uses deck.js for handling of slides in the browser.
+
+## Alternatives
+
+zlide is currently a work in progress and you are probably better served by one of the many alternatives.
+
+If all you want is to generate and dynamically serve up deck.js presentations from markdown files, have a look at deck.rb (https://github.com/alexch/deck.rb).
+
+If you want a maximum of flexibility check out the excellent slideshow gem: http://slideshow.rubyforge.org/
+
+## Installation
+
+Install via rubygems:
+
+    $ gem install zlide
+
+## Usage
+
+Create a new slide deck:
+
+    $ zlide new <deck_name>
+
+This will scaffold a directory called 'deck_name' with a few files and directories to get you started.
+
+Change to the newly created directory, put one or more markdown files in the slides/ folder and you are good to go.
+
+Serve up your presentation:
+
+    $ zlide serve
+
+This will start a web server on port 4567. Just navigate to http://localhost:4567 in your web browser.
+
+Compile a pdf handout:
+
+    $ zlide pdf
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/zlide

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "zlide"
+
+if File.exist?('config/deck.yml')
+  CONFIG = YAML.load(File.read('config/deck.yml'))
+end
+
+Zlide::CLI::Base.start

data/lib/zlide.rb

@@ -0,0 +1,9 @@
+require "zlide/version"
+require "zlide/deck"
+require "zlide/server/base"
+require "zlide/cli/base"
+require "zlide/redcarpet/renderers"
+
+module Zlide
+  # Your code goes here...
+end

data/lib/zlide/cli/base.rb

@@ -0,0 +1,40 @@
+require 'thor'
+
+module Zlide
+  module CLI
+    class Base < Thor
+      include Thor::Actions
+
+      def self.source_root
+        File.expand_path("../../templates", __FILE__)
+      end
+
+      desc "new", "create a new slide deck"
+      def new(name)
+        empty_directory(name)
+        self.destination_root = name
+        ["slides", "public", "stylesheets", "config"].each do |subdirectory|
+          empty_directory(subdirectory)
+        end
+        @name = name
+        template "config/deck.yml.tt"
+        template "README.md.tt"
+        copy_file "stylesheets/deck-theme.css"
+        copy_file "stylesheets/highlight-theme.css"
+        copy_file "stylesheets/slides.css"
+      end
+
+      desc "serve", "serve your slides via http"
+      def serve
+        Zlide::Server::Base.run! 
+      end
+
+      desc "pdf", "create a pdf version of your slides"
+      def pdf
+        deck = Zlide::Deck.new
+        deck.to_pdf
+      end
+
+    end
+  end
+end

data/lib/zlide/deck.rb

@@ -0,0 +1,56 @@
+require 'haml'
+require 'yaml'
+
+module Zlide
+  
+  class Deck
+
+    def initialize
+      files = Dir.glob('slides/*.md')
+      @slides = Array.new
+      files.sort.each do |f|
+        slides = File.read(f).split(/(^!SLIDE.*$)/)[1..-1].each_slice(2).map(&:join)
+        slides.each do |slide|
+          @slides << {:file => f, :content => slide}
+        end
+      end
+    end
+
+    def slide(index)
+      @slides[index][:content]
+    end
+
+    def update_slide(index, content)
+      @slides[index][:content] = content
+      file = @slides[index][:file]
+      file_slides = @slides.select{|s| s[:file] == file}.map{|s| s[:content]}
+      File.open("#{file}.tmp", "w") {|f| f.write(file_slides.join)}
+      File.rename("#{file}.tmp", file)
+    end
+
+    def to_html
+      slides = markdown_parser(Zlide::Redcarpet::Renderers::HTML).render(full_markdown)
+      layout = File.read(File.join(File.dirname(__FILE__), "layouts", "deckjs.haml"))
+      layout_renderer = Haml::Engine.new(layout)
+      layout_renderer.render { slides }
+    end
+
+    def to_pdf
+      pdf = Zlide::Redcarpet::Renderers::PDF.new
+      markdown_parser(pdf).render(full_markdown)
+      pdf.write_file
+    end
+
+    private
+
+    def full_markdown
+      @slides.map{|s| s[:content]}.join
+    end
+
+    def markdown_parser(renderer)
+      ::Redcarpet::Markdown.new(renderer, :fenced_code_blocks => true, :tables => true)
+    end
+
+  end
+
+end

data/lib/zlide/layouts/deckjs.haml

@@ -0,0 +1,44 @@
+!!!
+%html
+  %head
+    %meta{:charset => "utf-8"}/
+    %meta{:content => "IE=edge,chrome=1", "http-equiv" => "X-UA-Compatible"}/
+    %meta{:content => "width=1024, user-scalable=no", :name => "viewport"}/
+    %title= CONFIG['title'] 
+    / Required stylesheet
+    %link{:href => "/stylesheets/deck.css", :rel => "stylesheet"}/
+    %link{:href => "/stylesheets/slides.css", :rel => "stylesheet"}/
+    / Required Modernizr file
+    %script{:src => "/javascripts/modernizr.custom.js"}
+  %body.deck-container
+    / Begin slides. Just make elements with a class of slide.
+    = yield
+    / End slides.
+    / Begin extension snippets. Add or remove as needed.
+    / deck.navigation snippet
+    %a.deck-prev-link{:href => "#", :title => "Previous"} ←
+    %a.deck-next-link{:href => "#", :title => "Next"} →
+    / deck.status snippet
+    %p.deck-status
+      %span.deck-status-current
+      \/
+      %span.deck-status-total
+    / deck.goto snippet
+    %form.goto-form{:action => ".", :method => "get"}
+      %label{:for => "goto-slide"} Go to slide:
+      %input#goto-slide{:list => "goto-datalist", :name => "slidenum", :type => "text"}/
+      %datalist#goto-datalist
+      %input{:type => "submit", :value => "Go"}/
+    / deck.hash snippet
+    %a.deck-permalink{:href => ".", :title => "Permalink to this slide"} #
+    / End extension snippets.
+    / Required JS files.
+    %script{:src => "/javascripts/jquery-1.7.2.min.js"}
+    %script{:src => "/javascripts/deck.js"}
+    %script{:src => "/javascripts/highlight.js"}
+    / Initialize the deck. You can put this in an external file if desired.
+    :javascript
+      $(function() {
+        $.deck('.slide');
+        $('pre code').each(function(i, e) {hljs.highlightBlock(e)});
+      });

data/lib/zlide/redcarpet/renderers.rb

@@ -0,0 +1,5 @@
+require "redcarpet"
+
+require "zlide/redcarpet/renderers/mock"
+require "zlide/redcarpet/renderers/html"
+require "zlide/redcarpet/renderers/pdf"

data/lib/zlide/redcarpet/renderers/html.rb

@@ -0,0 +1,35 @@
+module Zlide
+  module Redcarpet
+    module Renderers
+
+      class HTML < ::Redcarpet::Render::HTML
+
+        def initialize(options = {})
+          @slide_open = false
+          super(options)
+        end
+
+        def paragraph(text)
+          result = ""
+          if text =~ /^!SLIDE/
+            result += "</section>\n" if @slide_open
+            result += "<section class=\"slide\">\n"
+            @slide_open = true
+          else
+            result += "<p>#{text}</p>\n"
+          end
+          result
+        end
+
+        def doc_footer
+          if @slide_open
+            @slide_open = false
+            "</section>"
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/zlide/redcarpet/renderers/mock.rb

@@ -0,0 +1,31 @@
+module Zlide
+  module Redcarpet
+    module Renderers
+
+      class Mock < ::Redcarpet::Render::HTML #Base
+
+        def block_html(text)
+          puts "block html: #{text}"
+        end
+
+        def paragraph(text)
+          if text =~ /!SLIDE/
+            puts "p: #{text}"
+          else
+            puts super(text)
+          end
+        end
+
+        def header(text, level)
+          puts "header#{level}: #{text}"
+        end
+
+        def entity(text)
+          puts "ENTITY: #{text}"
+        end
+
+      end
+
+    end
+  end
+end

data/lib/zlide/redcarpet/renderers/pdf.rb

@@ -0,0 +1,214 @@
+# encoding: utf-8
+require 'prawn'
+require 'prawn/measurement_extensions'
+
+module Zlide
+  module Redcarpet
+    module Renderers
+
+      class PDF < ::Redcarpet::Render::Base
+
+        class ListData < ::Array ; end
+        class TableData < ::Array ; end
+
+        def initialize
+          @pdf = Prawn::Document.new(
+            :page_size => "A4", 
+            :page_layout => :landscape, 
+            :info => {:Title => CONFIG['title']}
+          )
+          @pdf.define_grid(:rows => 2, :columns => 2, :gutter => 1.cm)
+          @current_row = 0
+          @current_column = 0
+          @command_queue = []
+          @current_box = @pdf.grid(0,0)
+          @slide_open = false
+          @list_items = []
+          @table_cells = []
+          @table_rows = []
+          @table_cache = []
+          super
+        end
+
+        def header(text, level)
+          text_size = 17 - level
+          @command_queue << Proc.new do 
+            @pdf.text text, :size => text_size, :style => :bold, :inline_format => true
+            if level <= 2
+              @pdf.line_width 0.5 
+              @pdf.horizontal_rule
+              @pdf.stroke
+            end
+            @pdf.move_down text_size
+          end
+          ""
+        end
+
+        def list(content, type)
+          data = ListData.new 
+          counter = 1
+          number_of_items = content.count('.') 
+          @list_items.pop(number_of_items).each do |item|
+            if item.is_a? String
+              case type
+              when :unordered
+                data << ["•", item]
+              when :ordered
+                data << ["#{counter}.", item]
+                counter += 1
+              end
+            else
+              data << [nil, item]
+              @command_queue.delete(item)
+            end
+          end
+          index = @table_cache.size
+          @command_queue << data 
+          @table_cache << data
+          "__table_#{index}"
+        end
+
+        def list_item(text, type)
+          table = nil
+          matches = text.scan(/\n__table_\d+/)
+          if matches.any?
+            table_marker = matches.first
+            table = @table_cache[table_marker.sub("\n__table_", '').to_i]
+            text.sub!(table_marker, '')
+          end
+          @list_items << text
+          @list_items << table if table
+          table ? ".." : "."
+        end
+
+        def table(header, body)
+          data = TableData.new
+          body_rows = @table_rows.pop(body.count('.'))
+          header_rows = @table_rows.pop(body.count('.'))
+          data.concat header_rows.map{|row| row.map{|column| tag(:b, column)}}
+          data.concat body_rows
+          @command_queue << data
+          ""
+        end
+
+        def table_row(content)
+          @table_rows << @table_cells.pop(content.count('.'))
+          "."
+        end
+
+        def table_cell(content, alignment)
+          @table_cells << content
+          "."
+        end
+
+        def emphasis(text)
+          tag :i, text
+        end
+
+        def double_emphasis(text)
+          tag :b, text 
+        end
+
+        def strikethrough(text)
+          tag :strikethrough, text
+        end
+
+        def link(href, title, content)
+          "<link href='#{href}'>#{content}</link>"
+        end
+
+        def image(href, title, alt_text)
+          @command_queue << Proc.new do
+            @pdf.image File.join('public', href), :fit => [@pdf.bounds.width, @pdf.cursor - 5]
+          end
+          ""
+        end
+
+        def paragraph(text)
+          if text =~ /^!SLIDE/
+            if @slide_open
+              next_box
+            else
+              @slide_open = true
+            end
+          else
+            @command_queue << Proc.new { @pdf.text(text, :inline_format => true) }
+          end
+          "" 
+        end
+
+        def block_code(code, language)
+          code.gsub!(/^(\s+)/m) { |m| "\xC2\xA0" * m.size }
+          code_block = Proc.new do
+            font = @pdf.font.name
+            @pdf.bounding_box([5, @pdf.cursor], :width => @pdf.bounds.width - 10) do
+              @pdf.move_down 5
+              @pdf.font "Courier"
+              @pdf.indent(5) { @pdf.text code, :size => 9 }
+              @pdf.line_width 0.1
+              @pdf.join_style :round
+              @pdf.stroke_bounds
+            end
+            @pdf.font font
+          end
+          @command_queue << code_block 
+          ""
+        end
+
+        def write_file
+          @pdf.render_file("#{CONFIG['title']}.pdf")
+        end
+
+        private
+
+        def next_box
+          @current_box.bounding_box do
+            @pdf.line_width 0.5 
+            @pdf.stroke_bounds
+            @pdf.bounding_box([5,@pdf.bounds.top - 5], :width => @pdf.bounds.width - 10, :height => @pdf.bounds.height - 10) do
+              @command_queue.each do |c|
+                if c.is_a? Proc
+                  c.call
+                elsif c.is_a? ListData
+                  cell_style = {:borders => [], :padding => 2}
+                  data = c.map do |row|
+                    row.map do |cell|
+                      if cell.is_a? Array
+                        @pdf.make_table cell, :cell_style => cell_style.merge(:inline_format => true), :column_widths => [25, @pdf.bounds.width - 55]
+                      else
+                        cell
+                      end
+                    end
+                  end
+                  @pdf.table data, :cell_style => cell_style, :column_widths => [25, @pdf.bounds.width - 30] do |t|
+                    t.cells.grep(Prawn::Table::Cell::Text).each {|text| text.style({:inline_format => true})}
+                  end
+                elsif c.is_a? TableData
+                  @pdf.table c, :cell_style => {:inline_format => true, :border_width => 0.5}
+                end
+              end
+            end
+          end
+          @command_queue.clear 
+          if @current_row == 1 and @current_column == 1
+            @pdf.start_new_page
+            @current_row = 0
+            @current_column = 0
+          else
+            @current_column += 1
+            if @current_column > 1
+              @current_row += 1
+              @current_column = 0
+            end
+          end
+          @current_box = @pdf.grid(@current_row, @current_column)
+        end
+
+        def tag(type, content)
+          "<#{type}>#{content}</#{type}>"
+        end
+      end
+
+    end
+  end
+end