vimdeck 0.0.9 → 0.1.0

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 gem 'artii'
 gem 'asciiart'
+gem 'redcarpet'

data/Gemfile.lock

@@ -6,6 +6,7 @@ GEM
       rainbow
       rmagick
     rainbow (1.1.4)
+    redcarpet (2.2.2)
     rmagick (2.13.2)
 
 PLATFORMS
@@ -14,3 +15,4 @@ PLATFORMS
 DEPENDENCIES
   artii
   asciiart
+  redcarpet

data/LICENSE.txt

@@ -0,0 +1,21 @@
+
+The MIT License (MIT)
+
+Copyright (c) [year] [fullname]
+
+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

@@ -1,8 +1,16 @@
-# vimdeck
+# Vimdeck
 
 VIM as a presentation tool
 
 
+## News
+
+Vimdeck now uses [redcarpet](http://github.com/vmg/redcarpet) to parse and render markdown!
+
+I've cleaned up the code significantly. So those of you who like more features in Vimdeck
+can fork and pull-request your buns off.
+
+
 ## Installation
 
 Install the vim plugin [SyntaxRange](https://github.com/vim-scripts/SyntaxRange).
@@ -25,6 +33,7 @@ Vimdeck will also provide a script file that will set up keybindings for you.
 
 - PageUp/Left go backwards
 - PageDown/Right go forward
+- Q closes presentation
 
 
 ## A Note about VIM
@@ -56,8 +65,8 @@ Example:
 Is less important
 ```
 
-Vimdeck does not compile markdown into something else.
-It uses a very small subset of markdown. List of items supported:
+Vimdeck uses redcarpet to parse its markdown and implements a custom renderer
+for things like ascii art. It uses a very small subset of markdown. List of items supported:
 
 - h1s
 - h2s
@@ -73,7 +82,22 @@ Fenced code blocks look like this:
        this.is = 'code'
     ```
 
-# Why Ruby?
+## Highlighting Syntax
+
+Vimdeck also supports "highlighting" parts of a slide. This is an experimental feature and needs more testing.
+
+Use `{~ unimportant_text_here ~}` to "unhighlight" portions of a slide:
+
+    # Slide Title
+
+    {~- Unimportant bullet~}
+    - Important bullet
+    {~- Really unimportant bullet~}
+
+This allows you to create multiple versions of the same slide but with different parts highlighted.
+Which is something I like to use often when presenting code snippets.
+
+## Why Ruby?
 
 Additionally, I want to point out that I realize that it's odd to have a VIM-based tool
 and not write it as a VIM script. Ruby was my language of choice only because the ascii art dependencies
@@ -97,3 +121,10 @@ Vimdeck will also augment its vimscript to provide syntax highlighting
 
 Images are even converted to ascii art!
 ![](img/demo4.png)
+
+
+
+
+---------------------
+
+Made by [tybenz](http://github.com/tybenz): [tybenz.com](http://tybenz.com) // [@tybenz](http://twitter.com/tybenz)

data/VERSION

@@ -1 +1 @@
-0.0.9
+0.1.0

data/bin/vimdeck

@@ -2,4 +2,4 @@
 
 require 'vimdeck'
 
-Vimdeck.slideshow(ARGV[0])
+Vimdeck::Slideshow.start(ARGV[0])

data/lib/templates/script.vim.erb

@@ -1,7 +1,9 @@
+set nonumber
 noremap <PageUp> :bp<CR>
 noremap <Left> :bp<CR>
 noremap <PageDown> :bn<CR>
 noremap <Right> :bn<CR>
+noremap Q :q<CR>
 
 <% @buffers.each do |buffer| %>
 b <%= buffer[:num] %>

data/lib/vimdeck.rb

@@ -1,120 +1,168 @@
+#!/usr/bin/env ruby
+
 require 'artii'
 require 'asciiart'
 require 'erb'
+require 'redcarpet'
 
 module Vimdeck
-  @slide_delimiter = "\n\n\n"
+  # Helper methods for ascii art conversion
+  class Ascii
+    def self.header(text, type)
+      if type == "large"
+        font = Artii::Base.new :font => 'slant'
+      else
+        font = Artii::Base.new :font => 'smslant'
+      end
 
-  def self.artii(text, type)
-    if type == "large"
-      font = Artii::Base.new :font => 'slant'
-    else
-      font = Artii::Base.new :font => 'smslant'
+      font.asciify(text)
     end
 
-    font.asciify(text)
+    def self.image(img)
+      a = AsciiArt.new(img)
+      a.to_ascii_art width: 30
+    end
   end
 
-  def self.ascii_art(img)
-    a = AsciiArt.new(img)
-    a.to_ascii_art width: 30
-  end
+  # Custom Redcarpet renderer handles headers and images
+  # Code blocks are ignored by the renderer because they have to be
+  # measured for the vimscript, so parsing of the fenced code blocks
+  # happens in the slideshow generator itself
+  class Render < Redcarpet::Render::Base
+    # Methods where the first argument is the text content
+    [
+      # block-level calls
+      :block_quote,
+      :block_html, :list, :list_item,
+
+      # span-level calls
+      :autolink, :codespan, :double_emphasis,
+      :emphasis, :underline, :raw_html,
+      :triple_emphasis, :strikethrough,
+      :superscript,
+
+      # footnotes
+      :footnotes, :footnote_def, :footnote_ref,
+
+      # low level rendering
+      :entity, :normal_text
+    ].each do |method|
+      define_method method do |*args|
+        args.first
+      end
+    end
+
+    def header(title, level)
+      case level
+      when 1
+        Vimdeck::Ascii.header(title, "large") + "\n"
+
+      when 2
+        Vimdeck::Ascii.header(title, "small") + "\n"
+      end
+    end
+
+    def link(link, title, content)
+      content
+    end
+
+    def paragraph(text)
+      text + "\n"
+    end
+
+    def block_code(code, language)
+      "```#{language}\n#{code}\n```"
+    end
 
-  def self.script_template
-    @template.result(binding)
+    def image(image, title, alt_text)
+      Vimdeck::Ascii.image(image)
+    end
   end
 
-  def self.create_slides(file)
-    slides = File.read(file).split(@slide_delimiter)
-
-    @template = ERB.new(File.read(File.dirname(__FILE__) + "/templates/script.vim.erb"))
-    @buffers = []
-
-    Dir.mkdir("presentation") unless File.exists?("presentation")
-
-    slides.each_with_index do |slide, i|
-      code_block = false
-
-      slide.each_line do |line|
-        match = line.match( /```(.*)$/ )
-        if !code_block && match && match[1]
-          code_block = true
-        elsif code_block && line.match( /```/ )
-          code_block=false
-        elsif !code_block
-          match = line.match( /##\s*(.*)/ )
-          if match && match[1]
-            slide.sub!( match[0], artii(match[1], "small") )
-          else
-            match = line.match( /#\s*(.*)/ )
-            if match && match[1]
-              slide.sub!( match[0], artii(match[1], "large") )
-            else
-              match = line.match( /\!\[\]\(([^\(\)]*)\)/ )
-              if match && match[1]
-                slide.sub!(match[0], self.ascii_art(match[1]))
-              end
-            end
+  class Slideshow
+    def self.slide_padding
+      "        "
+    end
+
+    def self.script_template
+      template = ERB.new(File.read(File.dirname(__FILE__) + "/templates/script.vim.erb"))
+      template.result(binding)
+    end
+
+    def self.generate(filename)
+      slides = File.read(filename)
+
+      renderer = Redcarpet::Markdown.new(Vimdeck::Render, :fenced_code_blocks => true)
+      Dir.mkdir("presentation") unless File.exists?("presentation")
+      @buffers = []
+
+      # Slide separator is 3 newlines
+      slides = slides.split("\n\n\n")
+      i = 0
+      slides.each do |slide|
+        # Pad file names with zeros. e.g. slide001.md, slide023.md, etc.
+        slide_num = "%03d" % (i+1)
+        slide = renderer.render(slide)
+
+        # buffer gets stashed into @buffers array for script template
+        # needs to track things like the buffer number, code highlighting
+        # and focus/unfocus stuff
+        buffer = {:num => i + 1}
+        code_height = 0
+        code = nil
+        code = slide.match( /```([^\n]*)\n.*\n```/m )
+        if code
+          buffer[:code] = { :language => code[1] }
+          code_height = code[0].split("\n").length - 2
+          code = code[0].gsub( /```[^\n]*\n/, '' ).gsub( /\n```/, '' )
+          slide = slide.gsub( /```[^\n]*\n/, '' ).gsub( /\n```/, '' )
+
+          if code_height > 0
+            start = slide.index(code)
+            start = slide[0..start].split("\n").length
+            buffer[:code][:end] = code_height + start - 1
+            buffer[:code][:start] = start
           end
         end
-      end
 
-      buffer = {:num => i + 1}
-      code_height = 0
-      code = nil
-      code = slide.match( /```([^\n]*)\n.*\n```/m )
-      if code
-        buffer[:code] = { :language => code[1] }
-        code_height = code[0].split("\n").length - 2
-        code = code[0].gsub( /```[^\n]*\n/, '' ).gsub( /\n```/, '' )
-        slide = slide.gsub( /```[^\n]*\n/, '' ).gsub( /\n```/, '' )
-
-        if code_height > 0
-          start = slide.index(code)
-          start = slide[0..start].split("\n").length
-          buffer[:code][:end] = code_height + start - 1
-          buffer[:code][:start] = start
+        # Prepending each line with slide_padding
+        # Removing trailing spaces
+        # Add newlines at end of the file to hide the slide identifier
+        slide = slide_padding + slide.gsub( /\n/, "\n#{slide_padding}" ).gsub( / *$/, "" ) + ("\n" * 80) + "slide #{i+1}"
+
+        # Buffers comments refers to items that need to be less focused/"unhighlighted"
+        # We add a regex to the vimscript for each slide with "comments"
+        # We use the hidden slide identifier to differentiate between slides
+        regex = /\{\~(.*?)\~\}/m
+        match = slide.match(regex)
+        buffer[:comments] = []
+        while match && match[1] && match.post_match do
+          slide.sub!(regex, match[1])
+          pattern = match[1] + "||(||_.*slide #{i+1}||)||@="
+          buffer[:comments] << pattern.gsub(/\n/, "||n").gsub(/\[/, "||[").gsub(/\]/, "||]").gsub(/\|/, "\\").gsub(/\"/, "\\\"")
+          match = match.post_match.match(regex)
         end
-      end
 
-      slide += "\n" * 80
-      slide += "slide #{i+1}"
-
-      spaces = "           "
-      slide = slide.gsub( /\n/, "\n#{spaces}" )
-      slide = spaces + slide
-      slide = slide.gsub( / *\n/, "\n" ).gsub( / *$/, '' )
-
-      regex = /\{\~(.*?)\~\}/m
-      match = slide.match(regex)
-      buffer[:comments] = []
-      while match && match[1] && match.post_match do
-        slide.sub!(regex, match[1])
-        pattern = match[1] + "||(||_.*slide #{i+1}||)||@="
-        buffer[:comments] << pattern.gsub(/\n/, "||n").gsub(/\[/, "||[").gsub(/\]/, "||]").gsub(/\|/, "\\").gsub(/\"/, "\\\"")
-        match = match.post_match.match(regex)
-      end
-
-      filenum = "%03d" % (i+1)
+        File.open("presentation/slide#{slide_num}.md", "w") do |file|
+          file.write slide
+        end
 
-      File.open("presentation/slide#{filenum}.md", "w") do |file|
-        file.write slide
+        @buffers << buffer
+        i += 1
       end
 
-      @buffers << buffer
+      File.open("presentation/script.vim", "w") do |file|
+        file.write script_template
+      end
     end
 
-    File.open("presentation/script.vim", "w") do |file|
-      file.write script_template
+    def self.open
+      exec 'vim presentation/*.md -S presentation/script.vim'
     end
-  end
 
-  def self.open_vim
-    exec 'vim presentation/*.md -S presentation/script.vim'
-  end
-
-  def self.slideshow(file)
-    create_slides(file)
-    open_vim
+    def self.start(filename)
+      generate(filename)
+      open
+    end
   end
 end

data/presentation/script.vim

@@ -0,0 +1,111 @@
+set nonumber
+noremap <PageUp> :bp<CR>
+noremap <Left> :bp<CR>
+noremap <PageDown> :bn<CR>
+noremap <Right> :bn<CR>
+noremap Q :q<CR>
+
+
+b 1
+
+
+
+b 2
+
+
+
+b 3
+
+
+
+b 4
+
+
+call matchadd("Comment", "• Second\\n        • Third\\(\\_.*slide 4\\)\\@=")
+
+
+b 5
+
+
+call matchadd("Comment", "• First\\(\\_.*slide 5\\)\\@=")
+
+call matchadd("Comment", "• Third\\(\\_.*slide 5\\)\\@=")
+
+
+b 6
+
+
+call matchadd("Comment", "• First\\n        • Second\\(\\_.*slide 6\\)\\@=")
+
+
+b 7
+
+6,17SyntaxInclude ruby
+
+
+
+b 8
+
+6,17SyntaxInclude ruby
+
+
+call matchadd("Comment", "module Parts\\n          class foo\\n            def slide\\n             \"of a\"\\n            end\\n\\n            def can\\n              highlight = \\(\\_.*slide 8\\)\\@=")
+
+call matchadd("Comment", "\\n            end\\n          end\\n        end\\(\\_.*slide 8\\)\\@=")
+
+
+b 9
+
+6,17SyntaxInclude ruby
+
+
+call matchadd("Comment", "module Parts\\n          class foo\\n            def slide\\n             \"of a\"\\n            end\\n\\n            def\\(\\_.*slide 9\\)\\@=")
+
+call matchadd("Comment", "highlight = \"vimdeck\"\\n            end\\n          end\\n        end\\(\\_.*slide 9\\)\\@=")
+
+
+b 10
+
+6,17SyntaxInclude ruby
+
+
+call matchadd("Comment", "module Parts\\n          class foo\\n            def slide\\n             \"of a\"\\n            end\\n\\n            def can\\(\\_.*slide 10\\)\\@=")
+
+call matchadd("Comment", "= \"vimdeck\"\\n            end\\n          end\\n        end\\(\\_.*slide 10\\)\\@=")
+
+
+b 11
+
+6,17SyntaxInclude ruby
+
+
+call matchadd("Comment", "module\\(\\_.*slide 11\\)\\@=")
+
+call matchadd("Comment", "class foo\\n            def slide\\n             \"of a\"\\n            end\\n\\n            def can\\n              highlight = \"vimdeck\"\\n            end\\n          end\\n        end\\(\\_.*slide 11\\)\\@=")
+
+
+b 12
+
+6,17SyntaxInclude ruby
+
+
+call matchadd("Comment", "module Parts\\n          class foo\\n            def slide\\(\\_.*slide 12\\)\\@=")
+
+call matchadd("Comment", "end\\n\\n            def can\\n              highlight = \"vimdeck\"\\n            end\\n          end\\n        end\\(\\_.*slide 12\\)\\@=")
+
+
+b 13
+
+6,17SyntaxInclude ruby
+
+
+call matchadd("Comment", "module Parts\\n          class foo\\n            def\\(\\_.*slide 13\\)\\@=")
+
+call matchadd("Comment", "\"of a\"\\n            end\\n\\n            def can\\n              highlight = \"vimdeck\"\\n            end\\n          end\\n        end\\(\\_.*slide 13\\)\\@=")
+
+
+b 14
+
+
+
+b 1

data/presentation/slide001.md

@@ -0,0 +1,92 @@
+         _    ________  _______  ______________ __
+        | |  / /  _/  |/  / __ \/ ____/ ____/ //_/
+        | | / // // /|_/ / / / / __/ / /   / ,<
+        | |/ // // /  / / /_/ / /___/ /___/ /| |
+        |___/___/_/  /_/_____/_____/\____/_/ |_|
+
+           ___  __  _____  ____  ___ _      ______________  __  _______
+          / _ \/ / / / _ \/ __/ / _ | | /| / / __/ __/ __ \/  |/  / __/
+         / ___/ /_/ / , _/ _/  / __ | |/ |/ / _/_\ \/ /_/ / /|_/ / _/
+        /_/   \____/_/|_/___/ /_/ |_|__/|__/___/___/\____/_/  /_/___/
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+slide 1