wbzyl-sinatra-rdiscount 0.0.4 → 0.0.6

data/examples/app.rb

@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+
+require 'rubygems'
+require 'sinatra'
+require 'sinatra/rdiscount'
+
+get "/hello" do
+  @name = "RDiscount"
+  rdiscount :hello, :layout => false
+end
+
+get "/hello2" do
+  @name = "RDiscount"
+  rdiscount :hello2, :layout => :layout2
+end

data/examples/config.ru

@@ -0,0 +1,9 @@
+# run with:  thin --rackup config.ru -p 4567 start
+
+require 'app'
+
+use Rack::Static,
+    :urls => ["/stylesheets"],
+    :root => "public"
+
+run Sinatra::Application

data/examples/public/stylesheets/application.css

@@ -0,0 +1,29 @@
+html {
+  margin: 0;
+  padding: 0;
+  background-color: #0C7D85;
+  line-height: 1.6;
+}
+
+body {
+  margin: 1em auto 1em auto;
+  padding: 1em 2em 2em 1em;
+  width: 760px;
+  border: 1px solid black;
+  background-color: #E8DDCB;
+}
+
+pre {
+  padding: 0.5em 0 0.5em 2em;
+  background-color: #D7D3C1;
+}
+
+h1, h2, h3 {
+  color: #0C7D85;
+}
+
+/* rdiscount comments */
+
+h6 {
+  display: none;
+}

data/examples/views/hello.rdiscount

@@ -0,0 +1,4 @@
+# Hello {%= @name %}
+
+Try `localhost:4567/hello2` to get styled page
+with intro to *Markdown*.

data/examples/views/hello2.rdiscount

@@ -0,0 +1,305 @@
+###### {% @title = "Sinatra is Awesome!" %}
+
+Hello {%= @name %}: Markdown Basics
+===================================
+
+<ul>
+    <li><a href="/projects/markdown/" title="Markdown Project Page">Main</a></li>
+    <li><a class="selected" title="Markdown Basics">Basics</a></li>
+    <li><a href="/projects/markdown/syntax" title="Markdown Syntax Documentation">Syntax</a></li>
+    <li><a href="/projects/markdown/license" title="Pricing and License Information">License</a></li>
+    <li><a href="/projects/markdown/dingus" title="Online Markdown Web Form">Dingus</a></li>
+</ul>
+
+
+Getting the Gist of Markdown's Formatting Syntax
+------------------------------------------------
+
+This page offers a brief overview of what it's like to use Markdown.
+The [syntax page] [s] provides complete, detailed documentation for
+every feature, but Markdown should be very easy to pick up simply by
+looking at a few examples of it in action. The examples on this page
+are written in a before/after style, showing example syntax and the
+HTML output produced by Markdown.
+
+It's also helpful to simply try Markdown out; the [Dingus] [d] is a
+web application that allows you type your own Markdown-formatted text
+and translate it to XHTML.
+
+  [s]: /projects/markdown/syntax  "Markdown Syntax"
+  [d]: /projects/markdown/dingus  "Markdown Dingus"
+  [src]: /projects/markdown/basics.text
+
+
+## Paragraphs, Headers, Blockquotes ##
+
+A paragraph is simply one or more consecutive lines of text, separated
+by one or more blank lines. (A blank line is any line that looks like a
+blank line -- a line containing nothing spaces or tabs is considered
+blank.) Normal paragraphs should not be intended with spaces or tabs.
+
+Markdown offers two styles of headers: *Setext* and *atx*.
+Setext-style headers for `<h1>` and `<h2>` are created by
+"underlining" with equal signs (`=`) and hyphens (`-`), respectively.
+To create an atx-style header, you put 1-6 hash marks (`#`) at the
+beginning of the line -- the number of hashes equals the resulting
+HTML header level.
+
+Blockquotes are indicated using email-style '`>`' angle brackets.
+
+Markdown:
+
+    A First Level Header
+    ====================
+    
+    A Second Level Header
+    ---------------------
+
+    Now is the time for all good men to come to
+    the aid of their country. This is just a
+    regular paragraph.
+
+    The quick brown fox jumped over the lazy
+    dog's back.
+    
+    ### Header 3
+
+    > This is a blockquote.
+    > 
+    > This is the second paragraph in the blockquote.
+    >
+    > ## This is an H2 in a blockquote
+
+
+Output:
+
+    <h1>A First Level Header</h1>
+    
+    <h2>A Second Level Header</h2>
+    
+    <p>Now is the time for all good men to come to
+    the aid of their country. This is just a
+    regular paragraph.</p>
+    
+    <p>The quick brown fox jumped over the lazy
+    dog's back.</p>
+    
+    <h3>Header 3</h3>
+    
+    <blockquote>
+        <p>This is a blockquote.</p>
+        
+        <p>This is the second paragraph in the blockquote.</p>
+        
+        <h2>This is an H2 in a blockquote</h2>
+    </blockquote>
+
+
+
+### Phrase Emphasis ###
+
+Markdown uses asterisks and underscores to indicate spans of emphasis.
+
+Markdown:
+
+    Some of these words *are emphasized*.
+    Some of these words _are emphasized also_.
+    
+    Use two asterisks for **strong emphasis**.
+    Or, if you prefer, __use two underscores instead__.
+
+Output:
+
+    <p>Some of these words <em>are emphasized</em>.
+    Some of these words <em>are emphasized also</em>.</p>
+    
+    <p>Use two asterisks for <strong>strong emphasis</strong>.
+    Or, if you prefer, <strong>use two underscores instead</strong>.</p>
+   
+
+
+## Lists ##
+
+Unordered (bulleted) lists use asterisks, pluses, and hyphens (`*`,
+`+`, and `-`) as list markers. These three markers are
+interchangable; this:
+
+    *   Candy.
+    *   Gum.
+    *   Booze.
+
+this:
+
+    +   Candy.
+    +   Gum.
+    +   Booze.
+
+and this:
+
+    -   Candy.
+    -   Gum.
+    -   Booze.
+
+all produce the same output:
+
+    <ul>
+    <li>Candy.</li>
+    <li>Gum.</li>
+    <li>Booze.</li>
+    </ul>
+
+Ordered (numbered) lists use regular numbers, followed by periods, as
+list markers:
+
+    1.  Red
+    2.  Green
+    3.  Blue
+
+Output:
+
+    <ol>
+    <li>Red</li>
+    <li>Green</li>
+    <li>Blue</li>
+    </ol>
+
+If you put blank lines between items, you'll get `<p>` tags for the
+list item text. You can create multi-paragraph list items by indenting
+the paragraphs by 4 spaces or 1 tab:
+
+    *   A list item.
+    
+        With multiple paragraphs.
+
+    *   Another item in the list.
+
+Output:
+
+    <ul>
+    <li><p>A list item.</p>
+    <p>With multiple paragraphs.</p></li>
+    <li><p>Another item in the list.</p></li>
+    </ul>
+    
+
+
+### Links ###
+
+Markdown supports two styles for creating links: *inline* and
+*reference*. With both styles, you use square brackets to delimit the
+text you want to turn into a link.
+
+Inline-style links use parentheses immediately after the link text.
+For example:
+
+    This is an [example link](http://example.com/).
+
+Output:
+
+    <p>This is an <a href="http://example.com/">
+    example link</a>.</p>
+
+Optionally, you may include a title attribute in the parentheses:
+
+    This is an [example link](http://example.com/ "With a Title").
+
+Output:
+
+    <p>This is an <a href="http://example.com/" title="With a Title">
+    example link</a>.</p>
+
+Reference-style links allow you to refer to your links by names, which
+you define elsewhere in your document:
+
+    I get 10 times more traffic from [Google][1] than from
+    [Yahoo][2] or [MSN][3].
+
+    [1]: http://google.com/        "Google"
+    [2]: http://search.yahoo.com/  "Yahoo Search"
+    [3]: http://search.msn.com/    "MSN Search"
+
+Output:
+
+    <p>I get 10 times more traffic from <a href="http://google.com/"
+    title="Google">Google</a> than from <a href="http://search.yahoo.com/"
+    title="Yahoo Search">Yahoo</a> or <a href="http://search.msn.com/"
+    title="MSN Search">MSN</a>.</p>
+
+The title attribute is optional. Link names may contain letters,
+numbers and spaces, but are *not* case sensitive:
+
+    I start my morning with a cup of coffee and
+    [The New York Times][NY Times].
+
+    [ny times]: http://www.nytimes.com/
+
+Output:
+
+    <p>I start my morning with a cup of coffee and
+    <a href="http://www.nytimes.com/">The New York Times</a>.</p>
+
+
+### Images ###
+
+Image syntax is very much like link syntax.
+
+Inline (titles are optional):
+
+    ![alt text](/path/to/img.jpg "Title")
+
+Reference-style:
+
+    ![alt text][id]
+
+    [id]: /path/to/img.jpg "Title"
+
+Both of the above examples produce the same output:
+
+    <img src="/path/to/img.jpg" alt="alt text" title="Title" />
+
+
+
+### Code ###
+
+In a regular paragraph, you can create code span by wrapping text in
+backtick quotes. Any ampersands (`&`) and angle brackets (`<` or
+`>`) will automatically be translated into HTML entities. This makes
+it easy to use Markdown to write about HTML example code:
+
+    I strongly recommend against using any `<blink>` tags.
+
+    I wish SmartyPants used named entities like `&mdash;`
+    instead of decimal-encoded entites like `&#8212;`.
+
+Output:
+
+    <p>I strongly recommend against using any
+    <code>&lt;blink&gt;</code> tags.</p>
+    
+    <p>I wish SmartyPants used named entities like
+    <code>&amp;mdash;</code> instead of decimal-encoded
+    entites like <code>&amp;#8212;</code>.</p>
+
+
+To specify an entire block of pre-formatted code, indent every line of
+the block by 4 spaces or 1 tab. Just like with code spans, `&`, `<`,
+and `>` characters will be escaped automatically.
+
+Markdown:
+
+    If you want your page to validate under XHTML 1.0 Strict,
+    you've got to put paragraph tags in your blockquotes:
+
+        <blockquote>
+            <p>For example.</p>
+        </blockquote>
+
+Output:
+
+    <p>If you want your page to validate under XHTML 1.0 Strict,
+    you've got to put paragraph tags in your blockquotes:</p>
+    
+    <pre><code>&lt;blockquote&gt;
+        &lt;p&gt;For example.&lt;/p&gt;
+    &lt;/blockquote&gt;
+    </code></pre>

data/examples/views/layout2.rdiscount

@@ -0,0 +1,15 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" http://www.w3.org/TR/html4/strict.dtd">
+<html>
+  <head>
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8">
+    <link rel="stylesheet" href="/stylesheets/application.css" 
+          type="text/css" media="screen" charset="utf-8">
+    <title><%= @title || "My Sinatra App" %></title>
+  </head>
+  
+  <body>
+
+    <%= yield %>
+    
+  </body>
+</html>

data/lib/sinatra/rdiscount.rb

@@ -0,0 +1,32 @@
+require 'sinatra/base'
+
+module Sinatra
+  module RDiscountTemplate
+
+    def rdiscount(template, options={}, locals={})
+      require 'erubis' unless defined? ::Erubis::Eruby      
+      require 'rdiscount' unless defined? ::RDiscount
+      render :rdiscount, template, options, locals
+    end
+    
+  private
+    
+    def render_rdiscount(template, data, options, locals, &block)
+      if block_given?
+        # render layout
+        instance = ::Erubis::Eruby.new(data)
+      else
+        # render template
+        markdown = ::RDiscount.new(data)
+        html = markdown.to_html
+        instance = ::Erubis::Eruby.new(html, :pattern => '\{% %\}')
+      end
+      locals_assigns = locals.to_a.collect { |k,v| "#{k} = locals[:#{k}]" }
+      src = "#{locals_assigns.join("\n")}\n#{instance.src}"
+      eval src, binding, '(__ERB__)', locals_assigns.length + 1
+    end
+
+  end
+
+  helpers RDiscountTemplate
+end

data/sinatra-rdiscount.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "sinatra-rdiscount"
-  s.version = '0.0.4'
+  s.version = '0.0.6'
   s.date = '2009-03-31'
   
   s.summary = "RDiscount templates for Sinatra applications"
@@ -10,8 +10,19 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/wbzyl/sinatra-rdiscount"
   s.description = "RDiscount templates for Sinatra applications"
   s.authors = ["Włodek Bzyl"]
-  s.files = Dir['lib/**/*.rb'] + Dir['test/**/*.rb'] + Dir['examples/**/*.{rb,ru,css,rdiscount}'] +
-    %w{.gitignore sinatra-rdiscount.gemspec Rakefile README.markdown LICENSE} 
+  s.files = %w{.gitignore
+               sinatra-rdiscount.gemspec
+               Rakefile
+               README.markdown
+               LICENSE
+               lib/sinatra/rdiscount.rb
+               test/spec_sinatra_rdiscount.rb
+               examples/app.rb
+               examples/config.ru
+               examples/views/layout2.rdiscount
+               examples/views/hello2.rdiscount
+               examples/views/hello.rdiscount
+               examples/public/stylesheets/application.css}
 
   s.add_dependency 'sinatra', '>=0.9.1'
   s.add_dependency 'rdiscount', '>=1.3.4'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wbzyl-sinatra-rdiscount
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors: 
 - "W\xC5\x82odek Bzyl"
@@ -56,6 +56,14 @@ files:
 - Rakefile
 - README.markdown
 - LICENSE
+- lib/sinatra/rdiscount.rb
+- test/spec_sinatra_rdiscount.rb
+- examples/app.rb
+- examples/config.ru
+- examples/views/layout2.rdiscount
+- examples/views/hello2.rdiscount
+- examples/views/hello.rdiscount
+- examples/public/stylesheets/application.css
 has_rdoc: false
 homepage: http://github.com/wbzyl/sinatra-rdiscount
 post_install_message: