vebdew 0.0.1 → 0.0.2

data/README.md

@@ -0,0 +1,102 @@
+# vebdew
+
+A simple HTML5 slide generate.
+Using reveal.js as default.
+
+## Usage
+
+  Usage: vebdew COMMAND
+
+  Directory:
+    - /vew           \# Vew file
+      - template.erb
+    - /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]
+
+## Vew file syntax
+
+### Head elements
+
+  :title <Page title>
+  :description <Description>
+  :author <Author Name>
+  :email <Author email>
+  :stylesheet_link_tag <File Path>
+  :javascript_include_tag <File Path>
+
+- Head elements should be put on the top of the document.
+- When any of the body elements are reached, head element is closed. That is, </head> is emitted and the Reveal.js body structure is established.
+
+### !SLIDE, !ENDSLIDE
+
+Marks the starting and ending of a slide (`<section>`) block.
+Current slide is closed and a new slide is created when a "!SLIDE" token is encountered. Thus the ending is not mandatory.
+
+### !STACK, !ENDSTACK
+Marks the starting and ending of a stack (vertical slide stack). Rules are the same as !SLIDE and !ENDSLIDE.
+
+### Code spans & code blocks
+Code spans are wrapped by ``. This emits a `<code>` block. Brackets (<, >) are escaped to &lt; and &gt; automatically. To output a '`' charactor, escape it like '\`'.
+
+Two types of code blocks are supported here. The code blocks wrapped in three or more '`'s. This kind of code blocks emits <pre><code>...</code></pre>. The second kind is wrapped in three or more '~'s. This kind of code blocks emits <script type="text/x-sample">...</script>, which makes uses of sample.js.
+
+
+### HTML elements
+HTML tags are allowed in the syntax and is outputted as-is. Since we do not have any token that emits custom <div>, one can write <div class="whatever" id="they-want"></div> in vebdew directly.
+
+### Headers
+The following syntaxes are allowed:
+
+  # H1 Header
+  ## H2 Header
+  ...
+  ###### H6 Header
+
+  H1 Header
+  =========
+
+  H2 Header
+  ---------
+
+### Horizontal Rules
+Three or more '-' in a row with a leading and trailing blank line emits a <hr> tag.
+
+### Paragraphs
+Lines with leading and trailing blank lines, if not matched by any of the rules above, are treated as a paragraph. (p element).
+
+### Attributes
+CSS-Selector like decorators can be appended to any of the elements above. The syntax is like:
+  {:#ID.class[attr=value]}
+Such examples are:
+
+  {:.inverted}
+  Introducing HTML
+  ================
+
+generating
+
+  <h1 class="inverted">Introducing HTML</h1>
+
+Another example is:
+
+  `<input>` tag has an attribute called `type`{:.attr[title="checkbox|radio|submit"]}
+
+emits
+
+  <code>&lt;input&gt;</code> tag has an attribute called <code class="attr" title="checkbox|radio|submit">type</code>
+
+
+## Copyright
+
+Release under MIT license.
+
+Copyright (c) 2012 Andrew Liu. See LICENSE.txt for
+further details.
+

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/bin/vebdew

@@ -2,8 +2,30 @@
 
 require 'vebdew'
 
-unless ARGV.size == 3
-  puts "[USAGE] vebdew [VEW FILE] [ERB FILE] [HTML FILE]"
+usage =
+"Usage: vebdew COMMAND
+
+Directory:
+  - /vew           \# Vew file
+    - template.erb
+  - /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]
+"
+
+case ARGV[0]
+when /new/
+  Vebdew::Runner.create
+when /generate|g/
+  Vebdew::Runner.generate
+when /compile|c/
+  Vebdew::Runner.compile ARGV[1], ARGV[2], ARGV[3]
 else
-  Vebdew::Runner.generate ARGV[0], ARGV[1], ARGV[2]
+  puts usage
 end

data/lib/template/vew/sample.vew

@@ -0,0 +1,84 @@
+:title 學 CSS
+
+:description 不囉唆學 CSS。以 reveal.js 製作的 HTML / CSS / JS 投影片。
+:author MrOrz
+:email johnsonliang7@gmail.com
+
+:stylesheet_link_tag css/main.css, css/style.css, css/sample.css, css/jquery-ui.css
+:stylesheet_link_tag css/ruler.css, css/zenburn.css
+
+:javascript_include_tag js/jquery.min.js
+:javascript_include_tag https://ajax.googleapis.com/ajax/libs/jqueryui/1.8.16/jquery-ui.min.js
+:javascript_include_tag js/reveal.js, lib/highlight.js, js/ruler.js, js/sample.js
+:javascript_include_tag js/index.js
+
+!SLIDE
+
+CSS
+===
+{:.nav}
+* [html.html](HTML)
+* Javascript
+
+!STACK
+
+  !SLIDE
+  長這樣
+  -----
+  {:.nopreview}
+  ~~~
+    html, body {
+      position: relative;
+      padding: 0; margin: 0;
+      overflow: hidden;
+      font-family: '文泉驛微米黑', 'LiHei Pro', '微軟正黑體';
+      font-weight: 200;
+      letter-spacing: -0.02em;
+      color: #eee; width: 100%; height: 100%;
+      min-height: 400px;
+    }
+
+    table {
+      border-collapse: collapse;
+      border-spacing: 0;
+    }
+  ~~~
+
+  !SLIDE
+  CSS Syntax
+  ---
+
+    ![images/css/selector.gif](Selection and declaration)
+
+    [http://w3schools.com/css/css_syntax.asp](Source: W3Schools)
+
+
+  !SLIDE
+  怎麼加進 HTML
+  ------------
+
+  在 `<head>` 中加入
+
+  {:.nopreview}
+  ~~~~~~~
+   <link rel="stylesheet" type="text/css" href="path/to/style.css">
+  ~~~~~~~
+
+  或直接把 CSS 寫在 `<style>` 裡；
+
+  ~~~~~~~
+    <style type="text/css">
+      div {
+        color: blue;
+      }
+    </style>
+    <div>I am div!</div>
+  ~~~~~~~
+
+  `<style>` 可放在 `<head>` 或 `<body>` 均可。
+
+!ENDSTACK
+
+!SLIDE.chapter#attribute
+CSS Selectors
+---

data/lib/template/vew/template.erb

@@ -0,0 +1,30 @@
+<!doctype html>
+<html lang="zh_TW">
+
+  <head>
+    <meta charset="utf-8">
+    <%= @header %>
+  </head>
+
+  <body>
+    <div id="reveal">
+      <div class="slides">
+        <%= @body %>
+      </div>
+
+      <!-- The navigational controls UI -->
+      <aside class="controls">
+        <a class="left" href="#">&#x25C4;</a>
+        <a class="right" href="#">&#x25BA;</a>
+        <a class="up" href="#">&#x25B2;</a>
+        <a class="down" href="#">&#x25BC;</a>
+      </aside>
+
+      <!-- Displays presentation progress, max value changes via JS to reflect # of slides -->
+      <div class="progress"><span></span></div>
+
+    </div>
+    <%= @footer %>
+  </body>
+
+</html>

data/lib/vebdew/parser.rb

@@ -8,6 +8,7 @@ module Vebdew
       @body = []
       @footer = []
       @buffer = []
+      @attrs = ""
       @flag = Hash.new { |h, k| h[k] = false }
 
       parse
@@ -40,6 +41,8 @@ module Vebdew
           close_buffer
           close_flag :slide
           close_flag :stack
+        when /\{:([^\}]+)\}/
+          selector $1
         when /^~+/
           if @flag[:code]
             @body << @buffer.join
@@ -49,23 +52,26 @@ module Vebdew
             close_buffer
             start_flag :code
           end
+        when /^(#+) (.*)/
+          level = $1.size
+          @body << "<h#{level}#{append}>#{$2}</h#{level}>"
         when /^-+/
           tagged = @buffer.pop
           close_buffer
           if tagged and !tagged.empty?
-            @body << "<h2>#{tagged.strip}</h2>"
+            @body << "<h2#{append}>#{tagged.strip}</h2>"
           else
-            @body << "<hr>"
+            @body << "<hr#{append}>"
           end
         when /^=+/
           tagged = @buffer.pop
           close_buffer
           if tagged and !tagged.empty?
-            @body << "<h1>#{tagged.strip}</h1>"
+            @body << "<h1#{append}>#{tagged.strip}</h1>"
           end
         when /^\* (.+)/
           start_flag :ul unless @flag[:ul]
-          @body << "<li>#{format_content($1)}</li>"
+          @body << "<li#{append}>#{format_content($1)}</li>"
         else
           @buffer << raw_line
         end
@@ -111,7 +117,9 @@ module Vebdew
                   :ul => "<ul>" }
 
     def start_flag flag
-      @body << START_STR[flag]
+      str = START_STR[flag]
+      str[-1] = "#{append}>" unless @attrs.empty?
+      @body << str
       @flag[flag] = true
     end
 
@@ -125,9 +133,28 @@ module Vebdew
       @flag[flag] = false
     end
 
+    def selector str
+      klass = str.scan(/\.([^\.\[#]+)/).flatten
+      id = str.scan(/#([^\.\[#])+/).flatten
+      attrs = str.scan(/\[([^\.\]=#]+)=([^\.\]]+)\]/)
+
+      @attrs = ""
+      @attrs += " class='#{klass.join(' ')}'" unless klass.empty?
+      @attrs += " id='#{id.join(' ')}'" unless id.empty?
+      attrs.each do |a|
+        @attrs += " #{a[0]}='#{a[1]}'"
+      end
+    end
+
+    def append
+      str = @attrs
+      @attrs = ""
+      str
+    end
+
     def format_buffer
       @buffer.map! do |buf|
-        "<p>#{format_content(buf)}</p>"
+        "<p#{append}>#{format_content(buf)}</p>"
       end
     end
 

data/lib/vebdew/runner.rb

@@ -1,11 +1,44 @@
+require 'fileutils'
+
 module Vebdew
   module Runner
     module_function
 
-    def generate vew, erb, html
-      parser = Parser.new(IO.readlines(vew))
-      result = Formatter.new(parser, File.read(erb)).to_html
-      File.open(html, "w") { |f| f.write result }
+    def create
+      dir = File.join File.dirname(__FILE__), "../template/*"
+      Dir[File.expand_path dir].each do |file|
+        FileUtils.cp_r file, Dir.pwd
+      end
+      puts "Vebdew project generated!"
+    end
+
+    def generate
+      vew = File.join Dir.pwd, "vew"
+      temp = File.join vew, "template.erb"
+
+      if !File.exist?(vew) or !File.directory?(vew)
+        puts "Is this a Vebdew project? 'vew' directory does not exist!"
+      elsif !File.exist?(temp)
+        puts "The template file 'vew/template.erb' does not exist!"
+      else
+        Dir[File.join vew, "*.vew"].each do |file|
+          html = File.basename(file, ".vew") + ".html"
+          compile file, temp, File.join(Dir.pwd, html)
+          puts "#{html} compiled!"
+        end
+      end
+    end
+
+    def compile vew, erb, html
+      if !File.exist?(vew)
+        puts "Vew file doesn't exist!"
+      elsif !File.exist?(erb)
+        puts "Erb template doesn't exist!"
+      else
+        parser = Parser.new(IO.readlines(vew))
+        result = Formatter.new(parser, File.read(erb)).to_html
+        File.open(html, "w") { |f| f.write result }
+      end
     end
   end
 end

data/vebdew.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "vebdew"
+  s.version = "0.0.2"
+
+  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.description = "Generate HTML5 slides"
+  s.email = "andrewliu33@gmail.com"
+  s.executables = ["vebdew"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/vebdew",
+    "lib/template/vew/sample.vew",
+    "lib/template/vew/template.erb",
+    "lib/vebdew.rb",
+    "lib/vebdew/formatter.rb",
+    "lib/vebdew/parser.rb",
+    "lib/vebdew/runner.rb",
+    "test/helper.rb",
+    "test/test_vebdew.rb",
+    "vebdew.gemspec"
+  ]
+  s.homepage = "http://github.com/eggegg/vebdew"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "HTML5 slides generator"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    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_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<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<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vebdew
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-08 00:00:00.000000000Z
+date: 2012-03-10 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
-  requirement: &2154928420 !ruby/object:Gem::Requirement
+  requirement: &2154377100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2154928420
+  version_requirements: *2154377100
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &2154927900 !ruby/object:Gem::Requirement
+  requirement: &2154376360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154927900
+  version_requirements: *2154376360
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &2154927320 !ruby/object:Gem::Requirement
+  requirement: &2154375620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *2154927320
+  version_requirements: *2154375620
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2154926720 !ruby/object:Gem::Requirement
+  requirement: &2154374500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2154926720
+  version_requirements: *2154374500
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2154926140 !ruby/object:Gem::Requirement
+  requirement: &2154371000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *2154926140
+  version_requirements: *2154371000
 description: Generate HTML5 slides
 email: andrewliu33@gmail.com
 executables:
@@ -73,22 +73,25 @@ executables:
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .document
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - bin/vebdew
+- lib/template/vew/sample.vew
+- lib/template/vew/template.erb
 - lib/vebdew.rb
 - lib/vebdew/formatter.rb
 - lib/vebdew/parser.rb
 - lib/vebdew/runner.rb
 - test/helper.rb
 - test/test_vebdew.rb
+- vebdew.gemspec
 homepage: http://github.com/eggegg/vebdew
 licenses:
 - MIT
@@ -104,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -757110420489084152
+      hash: 3658937832927531774
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/README.rdoc

@@ -1,19 +0,0 @@
-= vebdew
-
-Description goes here.
-
-== Contributing to vebdew
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2012 Andrew Liu. See LICENSE.txt for
-further details.
-