sinatra-maruku 0.9.4.0

data/.gitignore

@@ -0,0 +1,5 @@
+pkg
+*~
+\#*
+.\#*
+

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2008 Wlodek Bzyl
+
+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.markdown

@@ -0,0 +1,84 @@
+# Sinatra Maruku Extension for Sinatra v0.9.4
+
+The *sinatra-maruku* extension provides `maruku` helper method
+for rendering Maruku templates.
+
+To install it, run: 
+
+    sudo gem install -v0.9.4.0 sinatra-maruku
+
+To test it, create a simple Sinatra application:
+
+    # app.rb
+    require 'rubygems'
+    require 'sinatra'
+      
+    require 'sinatra/maruku'
+    
+    get "/" do
+      maruku "# Hello Maruku"
+    end
+
+and run it with:
+
+    ruby app.rb
+
+The result could be seen at *http://localhost:4567*.
+
+Another example could be find in the *examples* directory. 
+Run it with:
+
+    rackup -p 4567 config.ru
+
+and visit *http://localhost:4567* to contemplate the sheer 
+beauty of rendered text written in Maruku notation.
+
+
+## Two links to Maruku related material
+
+* [Maruku features](http://maruku.rubyforge.org/maruku.html)
+* [Literate Maruku](http://www.slideshare.net/schmidt/literate-maruku)
+
+
+## Template Languages (*update to The Sinatra Book*) 
+
+### Maruku Templates
+
+This helper method:
+
+    get '/' do
+      maruku :index
+    end
+
+renders template *./views/index.maruku*.
+
+If a layout named *layout.maruku* exists, it will be used each time
+a template is rendered.
+
+You can disable layouts by passing `:layout => false` 
+to *maruku* helper. For example
+
+    get '/' do
+      maruku :index, :layout => false
+    end
+
+You can set a different layout from the default one with:
+
+    get '/' do
+      maruku :index, :layout => :application
+    end
+
+This renders *./views/index.maruku* template
+within *./views/application.maruku* layout.
+
+
+## Sample layout for Maruku templates
+
+    CSS: /stylesheets/application.css /stylesheets/print.css
+    Lang: pl
+    Title: Hello Maruku 
+    LaTeX preamble: preamble.tex
+    
+    # Hello Maruku  {.header}
+    
+    <%= yield %>

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rake'
+require 'rake/testtask'
+require "rake/clean"
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sinatra-maruku"
+    gem.summary = "An extension providing Maruku templates for Sinatra applications."
+    gem.email = "matwb@univ.gda.pl"
+    gem.homepage = "http://github.com/wbzyl/sinatra-maruku"
+    gem.description = gem.description
+    gem.authors = ["Wlodek Bzyl"]
+    
+    gem.add_runtime_dependency 'sinatra', '=0.9.4'            
+    gem.add_runtime_dependency 'maruku', '>=0.6.0'        
+    
+    gem.add_development_dependency 'rack', '>=1.0.0'
+    gem.add_development_dependency 'rack-test', '>=0.5.3'
+  end
+ Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available."
+  puts "Install it with:"
+  puts "  sudo gem install jeweler"
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:major: 0
+:minor: 9
+:patch: 4
+:build: 0

data/examples/app.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'sinatra'
+require 'sinatra/maruku'
+
+get "/" do
+  #maruku :hello, :layout => false
+  maruku :index
+end

data/examples/config.ru

@@ -0,0 +1,4 @@
+# run it:  rackup config.ru -p 4567
+
+require 'app'
+run Sinatra::Application

data/examples/mapp.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'sinatra/base'
+require 'sinatra/maruku'
+
+require 'rack'
+
+class MApp < Sinatra::Base
+  helpers Sinatra::Maruku
+
+  get '/' do
+    maruku "## hello form modular app"
+  end
+end
+
+Rack::Handler::Thin.run MApp.new, :Port => 4567

data/examples/public/stylesheets/application.css

@@ -0,0 +1,23 @@
+html {
+  margin: 0;
+  padding: 0;
+  background-color: #B5052E;
+  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: #B5052E;
+}

data/examples/views/index.maruku

@@ -0,0 +1,32 @@
+Maruku features
+===============
+
+Maruku allows you to write in an easy-to-read-and-write syntax, like this:
+
+> [This document in Markdown][this_md] 
+
+Then it can be translated to HTML:
+
+> [This document in HTML][this_html]
+	
+or LaTeX, which is then converted to PDF:
+
+> [This document in PDF][this_pdf]
+
+Maruku implements:
+
+* the original [Markdown syntax][markdown_html] 
+  ([HTML][markdown_html] or [PDF][markdown_pdf]), translated by Maruku).
+
+* all the improvements in PHP Markdown Extra. 
+
+* a new [meta-data syntax][meta_data_proposal]
+
+[markdown_html]: http://maruku.rubyforge.org/markdown_syntax.html
+[markdown_pdf]: http://maruku.rubyforge.org/markdown_syntax.pdf
+[this_md]: http://maruku.rubyforge.org/maruku.md
+[this_html]: http://maruku.rubyforge.org/maruku.html
+[this_pdf]: http://maruku.rubyforge.org/maruku.pdf
+[Andrea Censi]: http://www.dis.uniroma1.it/~acensi/
+
+[meta_data_proposal]: http://maruku.rubyforge.org/proposal.html

data/examples/views/layout.maruku

@@ -0,0 +1,9 @@
+CSS: /stylesheets/application.css /stylesheets/print.css
+Javascript: /javascriprs/application.js
+Lang: pl
+Title: Hello Maruku 
+LaTeX preamble: preamble.tex
+
+# Hello Maruku  {.header}
+
+<%= yield %>

data/lib/sinatra/maruku.rb

@@ -0,0 +1,27 @@
+require 'maruku'
+require 'sinatra/base'
+
+module Sinatra
+  module Maruku
+    
+    def maruku(template, options={}, locals={})
+      render :maruku, template, options, locals
+    end
+    
+  private
+    
+    def render_maruku(template, data, options, locals, &block)    
+      maruku_src = render_erb(template, data, options, locals, &block)
+      instance = ::Maruku.new(maruku_src, options)
+      if block_given?
+        # render layout
+        instance.to_html_document
+      else
+        # render template
+        instance.to_html
+      end  
+    end
+  end
+  
+  helpers Maruku
+end

data/sinatra-maruku.gemspec

@@ -0,0 +1,74 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sinatra-maruku}
+  s.version = "0.9.4.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Wlodek Bzyl"]
+  s.date = %q{2010-02-08}
+  s.description = %q{}
+  s.email = %q{matwb@univ.gda.pl}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION.yml",
+     "examples/app.rb",
+     "examples/config.ru",
+     "examples/mapp.rb",
+     "examples/public/javascripts/application.js",
+     "examples/public/stylesheets/application.css",
+     "examples/public/stylesheets/print.css",
+     "examples/views/index.maruku",
+     "examples/views/layout.maruku",
+     "lib/sinatra/maruku.rb",
+     "sinatra-maruku.gemspec",
+     "test/sinatra_maruku_test.rb",
+     "test/test_helper.rb",
+     "test/views/hello.maruku",
+     "test/views/layout2.maruku"
+  ]
+  s.homepage = %q{http://github.com/wbzyl/sinatra-maruku}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{An extension providing Maruku templates for Sinatra applications.}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/sinatra_maruku_test.rb",
+     "examples/mapp.rb",
+     "examples/app.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<sinatra>, ["= 0.9.4"])
+      s.add_runtime_dependency(%q<maruku>, [">= 0.6.0"])
+      s.add_development_dependency(%q<rack>, [">= 1.0.0"])
+      s.add_development_dependency(%q<rack-test>, [">= 0.5.3"])
+    else
+      s.add_dependency(%q<sinatra>, ["= 0.9.4"])
+      s.add_dependency(%q<maruku>, [">= 0.6.0"])
+      s.add_dependency(%q<rack>, [">= 1.0.0"])
+      s.add_dependency(%q<rack-test>, [">= 0.5.3"])
+    end
+  else
+    s.add_dependency(%q<sinatra>, ["= 0.9.4"])
+    s.add_dependency(%q<maruku>, [">= 0.6.0"])
+    s.add_dependency(%q<rack>, [">= 1.0.0"])
+    s.add_dependency(%q<rack-test>, [">= 0.5.3"])
+  end
+end
+

data/test/sinatra_maruku_test.rb

@@ -0,0 +1,91 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class SinatraMarukuTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+  
+  def maruku_app(&block)
+    mock_app {
+      set :views, File.dirname(__FILE__) + '/views'      
+      helpers Sinatra::Maruku
+      set :show_exceptions, false
+      get '/', &block
+    }
+    get '/'
+  end
+  
+  def test_renders_inline_strings
+    maruku_app { maruku 'hello world' }
+    assert last_response.ok?
+    assert_equal "<p>hello world</p>", last_response.body
+  end
+  
+  def test_renders_inline_erb_string
+    maruku_app { maruku '<%= 1 + 1 %>' }
+    assert last_response.ok?
+    assert_equal "<p>2</p>", last_response.body
+  end
+
+  def test_renders_files_in_views_path
+    maruku_app { maruku :hello }
+    assert last_response.ok?
+    assert_equal "<h1 id='hello_world'>hello world</h1>", last_response.body
+  end
+  
+  def test_takes_locals_option
+    maruku_app {
+      locals = {:foo => 'Bar'}
+      maruku "<%= foo %>", :locals => locals
+    }
+    assert last_response.ok?
+    assert_equal "<p>Bar</p>", last_response.body
+  end
+
+  def test_renders_with_inline_layouts
+    maruku_app {
+      maruku 'Sparta', :layout => 'THIS. IS. <%= yield.upcase %>' 
+    }
+    assert last_response.ok?
+    assert_equal "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<!DOCTYPE html PUBLIC\n    \"-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN\"\n    \"http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd\">\n<html xmlns:svg='http://www.w3.org/2000/svg' xml:lang='en' xmlns='http://www.w3.org/1999/xhtml'>\n<head><meta content='application/xhtml+xml;charset=utf-8' http-equiv='Content-type' /><title></title></head>\n<body>\n<p>THIS. IS. <P>SPARTA</P></p>\n</body></html>", last_response.body
+  end
+
+  def test_renders_with_file_layouts
+    maruku_app {
+      maruku 'hello world', :layout => :layout2
+    }
+    assert last_response.ok?
+    assert_equal "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<!DOCTYPE html PUBLIC\n    \"-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN\"\n    \"http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd\">\n<html xmlns:svg='http://www.w3.org/2000/svg' xml:lang='en' xmlns='http://www.w3.org/1999/xhtml'>\n<head><meta content='application/xhtml+xml;charset=utf-8' http-equiv='Content-type' /><title></title></head>\n<body>\n<p>erb layout <p>hello world</p></p>\n</body></html>", last_response.body
+  end
+
+  def test_renders_erb_with_blocks
+    mock_app {
+      set :views, File.dirname(__FILE__) + '/views'      
+      helpers Sinatra::Maruku
+      
+      def container
+        yield
+      end
+      def is
+        "THIS. IS. SPARTA!"
+      end
+      
+      get '/' do
+        maruku '<% container do %> <%= is %> <% end %>'
+      end
+    }
+    
+    get '/'
+    assert last_response.ok?
+    assert_equal "<p>THIS. IS. SPARTA!</p>", last_response.body
+  end
+  
+  def test_raises_error_if_template_not_found
+    mock_app {
+      set :views, File.dirname(__FILE__) + '/views'      
+      helpers Sinatra::Maruku
+      set :show_exceptions, false
+      
+      get('/') { maruku :no_such_template }
+    }
+    assert_raise(Errno::ENOENT) { get('/') }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'test/unit'
+require 'rack/test'
+
+path = File.expand_path("../lib" + File.dirname(__FILE__))
+$:.unshift(path) unless $:.include?(path)
+
+require 'sinatra/maruku'
+
+class Test::Unit::TestCase
+  include Rack::Test::Methods
+  
+  attr_reader :app
+
+  # Sets up a Sinatra::Base subclass defined with the block
+  # given. Used in setup or individual spec methods to establish
+  # the application.
+  def mock_app(base=Sinatra::Base, &block)
+    @app = Sinatra.new(base, &block)
+  end
+end

data/test/views/hello.maruku

@@ -0,0 +1 @@
+# hello world

data/test/views/layout2.maruku

@@ -0,0 +1,2 @@
+erb layout
+<%= yield %>

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-maruku
+version: !ruby/object:Gem::Version 
+  version: 0.9.4.0
+platform: ruby
+authors: 
+- Wlodek Bzyl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-08 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: maruku
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.3
+    version: 
+description: ""
+email: matwb@univ.gda.pl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION.yml
+- examples/app.rb
+- examples/config.ru
+- examples/mapp.rb
+- examples/public/javascripts/application.js
+- examples/public/stylesheets/application.css
+- examples/public/stylesheets/print.css
+- examples/views/index.maruku
+- examples/views/layout.maruku
+- lib/sinatra/maruku.rb
+- sinatra-maruku.gemspec
+- test/sinatra_maruku_test.rb
+- test/test_helper.rb
+- test/views/hello.maruku
+- test/views/layout2.maruku
+has_rdoc: true
+homepage: http://github.com/wbzyl/sinatra-maruku
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: An extension providing Maruku templates for Sinatra applications.
+test_files: 
+- test/test_helper.rb
+- test/sinatra_maruku_test.rb
+- examples/mapp.rb
+- examples/app.rb