vebdew 0.0.3 → 0.1.0

data/Gemfile

@@ -1,9 +1,10 @@
 source "http://rubygems.org"
 
 gem "erubis"
+gem "htmlentities"
 
 group :development do
-  gem "shoulda", ">= 0"
+  gem "bacon", "~> 1.1.0"
   gem "rdoc", "~> 3.12"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.8.3"

data/Gemfile.lock

@@ -1,8 +1,10 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    bacon (1.1.0)
     erubis (2.7.0)
     git (1.2.5)
+    htmlentities (4.3.1)
     jeweler (1.8.3)
       bundler (~> 1.0)
       git (>= 1.2.5)
@@ -12,18 +14,14 @@ GEM
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
-    shoulda (3.0.1)
-      shoulda-context (~> 1.0.0)
-      shoulda-matchers (~> 1.0.0)
-    shoulda-context (1.0.0)
-    shoulda-matchers (1.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  bacon (~> 1.1.0)
   bundler (~> 1.0.0)
   erubis
+  htmlentities
   jeweler (~> 1.8.3)
   rdoc (~> 3.12)
-  shoulda

data/README.md

@@ -1,11 +1,12 @@
 # vebdew
 
 A simple HTML5 slide generator.
-Converts vew files into HTML5 slides.
+Converts vew files (markdown like syntax) into HTML5 slides.
 
 ## Library used
-- reveal.js
-- erubis
+- reveal.js: for the slides animation
+- erubis: for the template
+- htmlentities: for escaping the HTML
 
 ## Install
 ```
@@ -20,17 +21,21 @@ Run `new` to create a new project, `generate` to convert all vew files in the pr
 Usage: vebdew COMMAND
 
 Directory:
-  - /vew           \# Vew file
-    - template.erb
-  - /css           \# CSS styles
-  - /js            \# Javascript files
-  - *.html         \# Compiled html slides
+  - /vew           # Vew file, all the *.vew files will be compiled to html
+                   # when running the `generate` command
+    - template.erb # ERB template for the HTML
+                   # @header meta tags and stylesheets
+                   # @body   for the contents
+                   # @footer for the javascripts
+  - /css           # CSS styles
+  - /js            # Javascript files
+  - *.html         # Compiled html slides
 
 Commands:
-  new      \# Create a new slide project
-  generate \# Generate slides for current directory  (shortcut: g)
-  compile  \# Compiles single file into HTML5 slides (shortcut: c)
-           \# [VEW FILE] [ERB TEMPLATE] [HTML SLIDE]
+  new      # Create a new slide project
+  generate # Generate slides for current directory  (shortcut: g)
+  compile  # Compiles single file into HTML5 slides (shortcut: c)
+           # [VEW FILE] [ERB TEMPLATE] [HTML SLIDE]
 ```
 
 ## Vew file syntax
@@ -112,7 +117,7 @@ generating
 Another example is:
 
 ```
-`<input>` tag has an attribute called `type`{:.attr[title="checkbox|radio|submit"]}
+`<input>` tag has an attribute called {:.attr[title=checkbox|radio|submit]}`type`
 ```
 
 emits

data/Rakefile

@@ -25,11 +25,9 @@ Jeweler::Tasks.new do |gem|
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+desc 'Run test'
+task :test do
+  sh "bundle exec bacon -a"
 end
 
 task :default => :test

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.1.0

data/lib/template/config.ru

@@ -0,0 +1 @@
+run Rack::Directory.new(".")

data/lib/vebdew/parser.rb

@@ -1,3 +1,5 @@
+require 'htmlentities'
+
 module Vebdew
   class Parser
     attr_reader :header, :body, :footer
@@ -15,36 +17,71 @@ module Vebdew
     end
 
   protected
+    CMD        = /^:(\w+) (.*)$/
+    SLIDE      = /^\!SLIDE$/
+    ENDSLIDE   = /^\!ENDSLIDE$/
+    STACK      = /^\!STACK$/
+    ENDSTACK   = /^\!ENDSTACK$/
+    SELECTOR   = /^\{:([^\}]+)\}$/
+    CURLY_BAR  = /^~{2,}$/
+    GRAVE_BAR  = /^`{2,}$/
+    SINGLE_BAR = /^-{2,}$/
+    DOUBLE_BAR = /^={2,}$/
+    SHARP      = /^(#+) (.+)$/
+    UL         = /^\* (.+)$/
+
     def parse
       for raw_line in @lines
         line = raw_line.lstrip
 
         # special case for no enders
-        close_flag :ul if @flag[:ul] and !line.match(/^\* (.+)/)
+        close_flag :ul if @flag[:ul] and !line.match(UL)
+
+        # special case for blocks
+        block_flag = false
+        [[:sample, CURLY_BAR], [:code, GRAVE_BAR]].each do |rule, mth|
+          if @flag[rule] and !line.match(mth)
+            @buffer << raw_line
+            block_flag = true
+            break
+          end
+        end
+        next if block_flag
 
         case line
-        when /^:(\w+) (.*)$/
+        when CMD
           command $1, $2
-        when /^\!SLIDE/
+        when SLIDE
           close_buffer
           close_flag :slide
           start_flag :slide
-        when /^\!ENDSLIDE/
+        when ENDSLIDE
           close_buffer
           close_flag :slide
-        when /^\!STACK/
+        when STACK
           close_buffer
           close_flag :slide
           close_flag :stack
           start_flag :stack
-        when /^\!ENDSTACK/
+        when ENDSTACK
           close_buffer
           close_flag :slide
           close_flag :stack
-        when /\{:([^\}]+)\}/
+        when SELECTOR
+          close_buffer
           selector $1
-        when /^~+/
+        when CURLY_BAR
+          if @flag[:sample]
+            @body << @buffer.join
+            @buffer.clear
+            close_flag :sample
+          else
+            close_buffer
+            start_flag :sample
+          end
+        when GRAVE_BAR
           if @flag[:code]
+            format_indent
             @body << @buffer.join
             @buffer.clear
             close_flag :code
@@ -52,24 +89,24 @@ module Vebdew
             close_buffer
             start_flag :code
           end
-        when /^(#+) (.*)/
+        when SHARP
           level = $1.size
-          @body << "<h#{level}#{append}>#{$2}</h#{level}>"
-        when /^-+/
+          @body << "<h#{level}#{append}>#{format_content $2}</h#{level}>"
+        when SINGLE_BAR
           tagged = @buffer.pop
           close_buffer
           if tagged and !tagged.empty?
-            @body << "<h2#{append}>#{tagged.strip}</h2>"
+            @body << "<h2#{append}>#{format_content tagged.strip}</h2>"
           else
             @body << "<hr#{append}>"
           end
-        when /^=+/
+        when DOUBLE_BAR
           tagged = @buffer.pop
           close_buffer
           if tagged and !tagged.empty?
-            @body << "<h1#{append}>#{tagged.strip}</h1>"
+            @body << "<h1#{append}>#{format_content tagged.strip}</h1>"
           end
-        when /^\* (.+)/
+        when UL
           start_flag :ul unless @flag[:ul]
           @body << "<li#{append}>#{format_content($1)}</li>"
         else
@@ -79,6 +116,7 @@ module Vebdew
       close_buffer
       close_flag :slide
       close_flag :stack
+      close_flag :ul
     end
 
     def command type, body
@@ -111,21 +149,23 @@ module Vebdew
       @buffer.clear
     end
 
-    START_STR = { :slide => "<section>",
-                  :stack => "<section>",
-                  :code => "<script type='text/x-sample'>",
-                  :ul => "<ul>" }
+    START_STR = { :slide => "<section$>",
+                  :stack => "<section$>",
+                  :sample => '<script type="text/x-sample"$>',
+                  :code => '<pre$><code><!--',
+                  :ul => "<ul$>" }
 
     def start_flag flag
-      str = START_STR[flag]
-      str[-1] = "#{append}>" unless @attrs.empty?
+      str = START_STR[flag].dup
+      str['$'] = append
       @body << str
       @flag[flag] = true
     end
 
     CLOSE_STR = { :slide => "</section>",
                   :stack => "</section>",
-                  :code => "</script>",
+                  :sample => "</script>",
+                  :code => '--></code></pre>',
                   :ul => "</ul>" }
 
     def close_flag flag
@@ -133,16 +173,20 @@ module Vebdew
       @flag[flag] = false
     end
 
+    SEL_CLASS = /\.([^\.\[#]+)/
+    SEL_ID    = /#([^\.\[#]+)/
+    SEL_ATTR  = /\[([^\.\]=#]+)=([^\.\]]+)\]/
+
     def selector str
-      klass = str.scan(/\.([^\.\[#]+)/).flatten
-      id = str.scan(/#([^\.\[#])+/).flatten
-      attrs = str.scan(/\[([^\.\]=#]+)=([^\.\]]+)\]/)
+      klass = str.scan(SEL_CLASS).flatten
+      id = str.scan(SEL_ID).flatten
+      attrs = str.scan(SEL_ATTR)
 
       @attrs = ""
-      @attrs += " class='#{klass.join(' ')}'" unless klass.empty?
-      @attrs += " id='#{id.join(' ')}'" unless id.empty?
+      @attrs += %Q{ class="#{klass.join(' ')}"} unless klass.empty?
+      @attrs += %Q{ id="#{id.join(' ')}"} unless id.empty?
       attrs.each do |a|
-        @attrs += " #{a[0]}='#{a[1]}'"
+        @attrs += %Q{ #{a[0]}="#{a[1]}"}
       end
     end
 
@@ -152,22 +196,50 @@ module Vebdew
       str
     end
 
+    ESCAPER = HTMLEntities.new
+
     def escape_html str
-      str.gsub(/>/, "&gt;").gsub(/</, "&lt;")
+      ESCAPER.encode str
+    end
+
+    def format_indent
+      indent = @buffer.map{ |l| l =~ /[^\s]/ }.reject{ |l| l == 0 }.min
+      @buffer.map! { |l| escape_html(l.gsub(/^\s{#{indent}}/, '')) }
+      @buffer[0] = "-->" + @buffer[0]
+      @buffer[-1] += "<!--"
     end
 
     def format_buffer
       @buffer.map! do |buf|
-        "<p#{append}>#{format_content(buf)}</p>"
+        "<p#{append}>#{format_content(buf)}</p>" unless buf.empty?
       end
     end
 
+    INL_SELECTOR = /\{:([^\}]+)\}/
+    INL_CODE     = /`(([^\\`]|\\.)*)`/
+    INL_IMG_ALT  = /\!\[([^\]]+)\]\(([^\)]+)\)/
+    INL_IMG      = /\!\[([^\]]+)\]/
+    INL_A        = /\[([^\]]+)\]\(([^\)]+)\)/
+
     def format_content str
       str.strip!
-      str.gsub!(/`(([^\\`]|\\.)*)`/) {%Q{<code>#{escape_html($1)}</code>}}
-      str.gsub! /\!\[([^\]]+)\]\(([^\)]+)\)/, %q{<img src='\1' alt='\2'>}
-      str.gsub! /\!\[([^\]]+)\]/, %q{<img src='\1'>}
-      str.gsub! /\[([^\]]+)\]\(([^\)]+)\)/, %q{<a href='\1'>\2</a>}
+      loop do
+        case str
+        when INL_SELECTOR
+          selector $1
+          str.sub!(INL_SELECTOR, "")
+        when INL_CODE
+          str.sub!(INL_CODE) {%Q{<code#{append}>#{escape_html($1)}</code>}}
+        when INL_IMG_ALT
+          str.sub!(INL_IMG_ALT) {%Q{<img src="#{$1}" alt="#{$2}"#{append}>}}
+        when INL_IMG
+          str.sub!(INL_IMG) {%Q{<img src="#{$1}"#{append}>}}
+        when INL_A
+          str.sub!(INL_A) {%Q{<a href="#{$1}"#{append}>#{$2}</a>}}
+        else
+          break
+        end
+      end
       str
     end
   end

data/test/test_parser.rb

@@ -0,0 +1,87 @@
+require 'vebdew'
+require 'bacon'
+
+describe 'Parser' do
+  Q_AND_A = [[["!SLIDE\n", "a\n", "!ENDSLIDE\n"],
+              ["<section>","<p>a</p>","</section>"]],
+             [["!STACK\n", "!SLIDE\n", "!ENDSTACK\n"],
+              ["<section>", "<section>", "</section>", "</section>"]],
+             [["~~~", "  <tag>AS-IS</tag>", "~~~"],
+              ["<script type=\"text/x-sample\">", "  <tag>AS-IS</tag>", "</script>"]],
+             [["```\n", "  if(a)\n", "# unindented comment\n", "    b\n", "    <tag>\n", "  end\n", "```\n"],
+              ["<pre><code><!--", "-->if(a)\n# unindented comment\n  b\n  &lt;tag&gt;\nend\n<!--", "--></code></pre>"]],
+             [["---"],
+              ["<hr>"]],
+             [["abc", "---"],
+              ["<h2>abc</h2>"]],
+             [["abc", "==="],
+              ["<h1>abc</h1>"]],
+             [["### qqq"],
+              ["<h3>qqq</h3>"]],
+             [["* qqq", "* www"],
+              ["<ul>", "<li>qqq</li>", "<li>www</li>", "</ul>"]],
+             [["![a.jpg](haha)"],
+              ['<p><img src="a.jpg" alt="haha"></p>']],
+             [["![b.jpg]"],
+              ['<p><img src="b.jpg"></p>']],
+             [["[google.com](you)"],
+              ['<p><a href="google.com">you</a></p>']],
+
+             # attributes
+             [["{:.pre}`aloha`"],
+              ['<p><code class="pre">aloha</code></p>']],
+             [["{:#def.abc[data=you]}", "papa"],
+              ['<p class="abc" id="def" data="you">papa</p>']],
+             [["{:#id.test[data=you]}", "~~~", "lalala", "~~~"],
+              ['<script type="text/x-sample" class="test" id="id" data="you">',
+               'lalala','</script>']],
+             [["{:#id.test[data=you]}", "abc", "==="],
+              ['<h1 class="test" id="id" data="you">abc</h1>']],
+             [["{:#id.test[data=you]}", "abc", "---"],
+              ['<h2 class="test" id="id" data="you">abc</h2>']],
+             [["{:.demo}", "lala"],
+              ['<p class="demo">lala</p>']],
+             [["{:.class#id}","!SLIDE", "a\n", "!ENDSLIDE\n"],
+              ["<section class=\"class\" id=\"id\">","<p>a</p>","</section>"]],
+             [["", "{:.def}", "abc"],
+              [nil, '<p class="def">abc</p>']],
+             [["", "{:.sld}", "!SLIDE"],
+              [nil, '<section class="sld">', '</section>']],
+             [["abc", "{:.la}", "oop"],
+              ["<p>abc</p>", '<p class="la">oop</p>']],
+             [["```", '# cmt', "```"],
+              ["<pre><code><!--", '--># cmt<!--', "--></code></pre>"]],
+
+             # checks whether buffer clears
+             [[
+                '!SLIDE',
+                '{:.demo}',
+                '~~~',
+                '  should_have_demo_class',
+                '~~~',
+                '!SLIDE',
+                '~~~',
+                '  should_not_have_demo_class',
+                '~~~'
+              ],
+              [
+                '<section>',
+                '<script type="text/x-sample" class="demo">',
+                '  should_have_demo_class',
+                '</script>',
+                '</section>',
+                '<section>',
+                '<script type="text/x-sample">',
+                '  should_not_have_demo_class',
+                '</script>',
+                '</section>'
+              ]]
+            ]
+
+  for q, a in Q_AND_A
+    it "should parse #{q}" do
+      parser = Vebdew::Parser.new(q)
+      parser.body.should == a
+    end
+  end
+end

data/vebdew.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "vebdew"
-  s.version = "0.0.3"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew Liu"]
-  s.date = "2012-03-10"
+  s.date = "2012-03-14"
   s.description = "Generate HTML5 slides"
   s.email = "andrewliu33@gmail.com"
   s.executables = ["vebdew"]
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "bin/vebdew",
+    "lib/template/config.ru",
     "lib/template/css/images/ui-bg_flat_0_aaaaaa_40x100.png",
     "lib/template/css/images/ui-bg_glass_95_fef1ec_1x400.png",
     "lib/template/css/images/ui-bg_gloss-wave_16_121212_500x100.png",
@@ -60,8 +61,7 @@ Gem::Specification.new do |s|
     "lib/vebdew/formatter.rb",
     "lib/vebdew/parser.rb",
     "lib/vebdew/runner.rb",
-    "test/helper.rb",
-    "test/test_vebdew.rb",
+    "test/test_parser.rb",
     "vebdew.gemspec"
   ]
   s.homepage = "http://github.com/eggegg/vebdew"
@@ -75,20 +75,23 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<erubis>, [">= 0"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<htmlentities>, [">= 0"])
+      s.add_development_dependency(%q<bacon>, ["~> 1.1.0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
     else
       s.add_dependency(%q<erubis>, [">= 0"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<htmlentities>, [">= 0"])
+      s.add_dependency(%q<bacon>, ["~> 1.1.0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
     end
   else
     s.add_dependency(%q<erubis>, [">= 0"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<htmlentities>, [">= 0"])
+    s.add_dependency(%q<bacon>, ["~> 1.1.0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.3"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vebdew
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-10 00:00:00.000000000Z
+date: 2012-03-14 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
-  requirement: &2154113200 !ruby/object:Gem::Requirement
+  requirement: &2158521880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,32 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2154113200
+  version_requirements: *2158521880
 - !ruby/object:Gem::Dependency
-  name: shoulda
-  requirement: &2154112480 !ruby/object:Gem::Requirement
+  name: htmlentities
+  requirement: &2158515640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2158515640
+- !ruby/object:Gem::Dependency
+  name: bacon
+  requirement: &2158514720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *2154112480
+  version_requirements: *2158514720
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &2154111680 !ruby/object:Gem::Requirement
+  requirement: &2158512780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +54,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *2154111680
+  version_requirements: *2158512780
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2154110680 !ruby/object:Gem::Requirement
+  requirement: &2158511560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +65,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2154110680
+  version_requirements: *2158511560
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2154109620 !ruby/object:Gem::Requirement
+  requirement: &2158509380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +76,7 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *2154109620
+  version_requirements: *2158509380
 description: Generate HTML5 slides
 email: andrewliu33@gmail.com
 executables:
@@ -83,6 +94,7 @@ files:
 - Rakefile
 - VERSION
 - bin/vebdew
+- lib/template/config.ru
 - lib/template/css/images/ui-bg_flat_0_aaaaaa_40x100.png
 - lib/template/css/images/ui-bg_glass_95_fef1ec_1x400.png
 - lib/template/css/images/ui-bg_gloss-wave_16_121212_500x100.png
@@ -117,8 +129,7 @@ files:
 - lib/vebdew/formatter.rb
 - lib/vebdew/parser.rb
 - lib/vebdew/runner.rb
-- test/helper.rb
-- test/test_vebdew.rb
+- test/test_parser.rb
 - vebdew.gemspec
 homepage: http://github.com/eggegg/vebdew
 licenses:
@@ -135,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2574970994430618005
+      hash: -4101904603546961614
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/test/helper.rb

@@ -1,18 +0,0 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'vebdew'
-
-class Test::Unit::TestCase
-end

data/test/test_vebdew.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestVebdew < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end