Rack Server Pages
Rack middleware and application for serving dynamic pages in very simple way. There are no controllers or models, just only views like a jsp, asp and php!
http://github.com/migrs/rack-server-pages
Features
- Serving dynamic pages (default: ERB)
- Serving static files
- No requirements (except Rack)
- Tilt support (optional)
- Include a partial template
- Layout template
- Before/After filters
- Handle exceptions
- Include helpers
- Integrate with any rack applications (Rails, Sinatra, etc...)
- Extremely simple and easy to use!
Requirements
Install
RubyGems available
gem install rack-server-pages
Basic usage
Run as Rack application
Create config.ru
require 'rack-server-pages'
run Rack::ServerPages
Create public/index.erb
<h1>Hello rack!</h1>
<p><%= Time.now %></p>
Finally running rackup
rackup
and visit http://localhost:9292/
Valid requests,
- http://localhost:9292/
- http://localhost:9292/index
- http://localhost:9292/index.erb
- http://localhost:9292/index.html
Use as Rack middleware
Edit config.ru
require 'rack-server-pages'
use Rack::ServerPages
run Rack::ServerPages::NotFound # or your MyApp
And same as above.
Template bindings
-
CoreHelper
-
- request
- env
- params
- session
- cookies
- logger
-
- response
- headers
- set_cookies
- delete_cookie
-
- h (alias for: html_escape)
- u (alias for: url_encode)
Configurations
Rack middleware
with parameter
use Rack::ServerPages, :view_path => 'public'
with block
use Rack::ServerPages do |config|
config.view_path = 'public'
end
Rack application
with parameter
run Rack::ServerPages[:view_path => 'public']
with block
run Rack::ServerPages.new { |config|
config.view_path = 'public'
}
Options
-
view_path
- Views folders to load templates from.
- default: [views, public]
-
effective_path
- default: nil
-
default_charset
- default: utf-8
-
cache_control
- default: nil
-
failure_app
- default: nil
Helpers
with helpers block
use Rack::ServerPages do |config|
config.helpers do
def three_times(name)
"#{([name.to_s]*3).join(' ')}!!"
end
end
end
in view file (erb)
<%= three_times('blah') %>
with helper module
module SampleHelper
def three_times(name)
"#{([name.to_s]*3).join(' ')}!!"
end
end
use Rack::ServerPages do |config|
config.helpers SampleHelper
end
with procs
help1 = proc do
def three_times(name)
"#{([name.to_s]*3).join(' ')}!!"
end
end
help2 = proc {...}
use Rack::ServerPages do |config|
config.helpers help1, help2
end
Filters
with before/after block
use Rack::ServerPages do |config|
config.before do
@title = 'Hello!'
end
config.after do
logger.debug 'xxxx'
end
end
with procs
proc1 = proc { @name = 'Jonny' }
proc2 = proc { @age = 24 }
proc3 = proc { logger.debug 'xxxx' }
use Rack::ServerPages do |config|
config.before proc1, proc2
config.after proc3
end
if you define before/after method in helper module, it will be treated as filters
module SampleHelper
def before
@title = 'Hello!'
end
def three_times(name)
"#{([name.to_s]*3).join(' ')}!!"
end
end
use Rack::ServerPages do |config|
config.helpers SampleHelper
end
in view file
<%= three_times(@title) %>
Tilt support
Tilt is generic interface to multiple Ruby template engines.
If you want to use Tilt, just require 'tilt'
and require template engine libraries that you want.
require 'rack-server-pages'
require 'tilt'
require 'rdiscount' # markdown library
run Rack::ServerPages
or put your Gemfile
views/article.html.md
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.
### Header 3
> This is a blockquote.
> Thank you
[source](http://github.com/migrs/rack-server-pages)
http://localhost:9292/article.html
<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>
<h3>Header 3</h3>
<blockquote><p>This is a blockquote.
Thank you</p></blockquote>
<p><a href="http://github.com/migrs/rack-server-pages">source</a></p>
views/about.html.slim
doctype html
html
head
title Slim Core Example
meta name="keywords" content="template language"
body
h1 Markup examples
div id="content" class="example1"
p Nest by indentation
http://localhost:9292/about.html
<!DOCTYPE html>
<html>
<head>
<title>Slim Core Example</title>
<meta content="template language" name="keywords" />
</head>
<body>
<h1>Markup examples</h1>
<div class="example1" id="content">
<p>Nest by indentation</p>
</div>
</body>
</html>
views/betty.css.sass
$blue: #3bbfce
$margin: 16px
.content-navigation
border-color: $blue
color: darken($blue, 9%)
.border
padding: $margin / 2
margin: $margin / 2
border-color: $blue
http://localhost:9292/betty.css
.content-navigation {
border-color: #3bbfce;
color: #2ca2af; }
.border {
padding: 8px;
margin: 8px;
border-color: #3bbfce; }
views/contact.xml.builder
xml.instruct!
xml.result do |result|
result.name "John"
result.phone "910-1974"
end
http://localhost:9292/contact.xml
<result>
<name>John</name>
<phone>910-1974</phone>
</result>
views/script.js.coffee
number = 42
opposite = true
number = -42 if opposite
square = (x) -> x * x
list = [1, 2, 3, 4, 5]
math =
root: Math.sqrt
square: square
cube: (x) -> x * square x
http://localhost:9292/script.js
(function() {
var list, math, number, opposite, square;
number = 42;
opposite = true;
if (opposite) number = -42;
square = function(x) {
return x * x;
};
list = [1, 2, 3, 4, 5];
math = {
root: Math.sqrt,
square: square,
cube: function(x) {
return x * square(x);
}
};
}).call(this);
see more http://localhost:9292/examples/
Integrate with Rack applications
At first, create sample file: public/hello.erb
or views/hello.html.erb
<p>Hello Rack Server Pages!</p>
<p><%= Time.now %></p>
Rails
Add to config/environment.rb
(Rails2) or config/application.rb
(Rails3)
config.middleware.use Rack::ServerPages
And run
Rails2
script/server
Rails3
rails s
- http://localhost:3000/ is Rails response
- http://localhost:3000/hello is Rack Server Pages response
Sinatra
Create sinatra_sample.rb
require 'sinatra'
require 'rack-server-pages'
use Rack::ServerPages
get '/' do
'<p>Hello Sinatra!</p>'
end
And run
ruby sinatra_sample.rb
- http://localhost:4567/ is Sinatra response
- http://localhost:4567/hello is Rack Server Pages response
Customization
Customize file extension associations
e.g. .php as ERB
ERBTemplate (default)
Rack::ServerPages::Template::ERBTemplate.extensions << 'php'
TiltTemplate (see. Template Mappings)
Tilt.register Tilt::ERBTemplate, 'php'
And create public/info.php
:)
<%= phpinfo(); %>
http://localhost:9292/info.php
Demo site
http://rack-server-pages.heroku.com/
ToDo
Implements
- Static file generator (for designer)
Tasks
- Tutorials
- for PHP user
- for Designer
- for Windows user
- More documents
- Deployment using apache / passenger / nginx
- Complete Tilt examples
- Philosophy
- Benchmark
License
rack-server-pages is Copyright (c) 2012-2016 Masato Igarashi(@migrs) and Contributors.
Distributed under the MIT license.