slippers 0.0.10

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 starapor
+
+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

@@ -0,0 +1,56 @@
+There are many template engines that you can choose for the generation of views in your mvc application. The problem with most of the them, however, is that they are too permissive. These turing-complete engines allow for many complex constructs within the template, which begin at simple if statements and for loops, and expand to complex object traversal. While these permissive languages are intended to offer great flexibility, in reality they promote bad practices. Allowing logic to permeate your view is bad for many reasons: firstly, the code in views is rarely tested; secondly, the separation between the models and the view blurs and business logic creeps into the view.
+
+All we want our template engine to do is read a string which has holes in it, and replace those holes with the desired string, much like mail merge. String Template is a template engine originally for Java but now ported to C# and python, which enforces strict separation of model and view by only supporting these strings with holes. Unfortunately, it has not been ported to ruby...until now.
+
+Introducing...Slippers, a strict template engine for ruby. Slippers supports the syntax from string template.
+
+Examples
+1. Rendering template of a string without any holes
+  template = "This is a string without any holes in it"
+  engine = Slippers::Engine.new(template)
+  engine.render #=> "This is a string without any holes in it"
+
+2. Filling in a hole within a template
+  template = "This is a string with a message of $message$"
+  engine = Slippers::Engine.new(template)
+  engine.render(:message => "hello world") #=> "This is a string with a message of hello world"
+
+3. Rendering a subtemplate within a template
+  subtemplate = Slippers::Template.new("this is a subtemplate")
+  template_group = Slippers::TemplateGroup.new(:templates => {:message => subtemplate})
+  template = "This is a template and then $message()$"
+  engine = Slippers::Engine.new(template, :template_group => template_group)
+  engine.render #=> "This is a template and then this is a subtemplate"
+
+4. Applying an object to a subtemplate
+  subtemplate = Slippers::Template.new("this is a subtemplate with a message of $saying$")
+  template_group = Slippers::TemplateGroup.new(:templates => {:message_subtemplate => subtemplate})
+  template = "This is a template and then $message:message_subtemplate()$!"
+  engine = Slippers::Engine.new(template, :template_group => template_group)
+  engine.render(:message => {:saying => 'hello world'}) #=> "This is a template and then this is a subtemplate with a message of hello world!"
+
+5. Applying an object to an anonymous subtemplate
+  template = "This is a template and then $message:{this is a subtemplate with a message of $saying$}$!"
+  engine = Slippers::Engine.new(template)
+  engine.render(:message => {:saying => 'hello world'}) #=> "This is a template and then this is a subtemplate with a message of hello world!"
+
+6. Render a subtemplate using a different rendering technology
+	age_renderer = AgeRenderer.new
+	subtemplate = Slippers::Engine.new('$first$ $last$')
+	person = OpenStruct.new({:name => {:first => 'Fred', :last => 'Flinstone'}, :dob => Date.new(DateTime.now.year - 34, 2, 4)})
+	template_group = Slippers::TemplateGroup.new(:templates => {:name => subtemplate, :age => age_renderer})
+	engine = Slippers::Engine.new("Introducing $name:name()$ who is $dob:age()$.", :template_group => template_group)
+	engine.render(person) #=> "Introducing Fred Flinstone who is 34 years old."
+	
+7. Select a renderer based on the type of the object to render
+    person = OpenStruct.new({:name => {:first => 'Fred', :last => 'Flinstone'}, :dob => Date.new(DateTime.now.year-34, 2, 4)})
+    template_group = Slippers::TemplateGroup.new(:templates => {:name => Slippers::Engine.new('$first$ $last$'), Date => AgeRenderer.new})
+    engine = Slippers::Engine.new("Introducing $name:name()$ who is $dob$.", :template_group => template_group)
+    engine.render(person) #=> "Introducing Fred Flinstone who is 34 years old."
+
+8. Use the specified expression options to render list items
+  template = 'This is a list of values $values; null="-1", seperator=", "$'
+  engine = Slippers::Engine.new(template)
+  engine.render(:values => [1,2,3,nil]) #=> "This is a list of values 1, 2, 3, -1"
+
+

data/Rakefile

@@ -0,0 +1,27 @@
+load File.expand_path(File.dirname(__FILE__) + "/tasks/spec.rake")
+#load File.expand_path(File.dirname(__FILE__) + "/tasks/git.rake")
+
+require 'rake'
+require 'spec/rake/spectask'
+
+desc "Generate the gem using technicalpickles jeweler"
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "slippers"
+    gem.summary = "A strict templating library for Ruby"
+    gem.email = "me@sarahtaraporewalla.com"
+    gem.homepage = "http://github.com/starapor/slippers"
+    gem.description = "A strict templating library for ruby"
+    gem.authors = ["Sarah Taraporewalla"]
+    gem.files =  FileList["[A-Z]*", "{bin,lib,spec,examples}/**/*"]
+    gem.add_dependency 'schacon-git'
+    gem.add_dependency 'treetop'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
+end
+
+task :default => "spec:run"
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 10
+:major: 0
+:minor: 0

data/examples/blog/README

@@ -0,0 +1,3 @@
+A simple blog engine that uses Sequel as the persistence layer.
+Sequel uses sqlite as the default DBMS engine and will create the database
+automatically on startup.

data/examples/blog/controller/main.rb

@@ -0,0 +1,30 @@
+class MainController < Ramaze::Controller
+  layout '/layout'
+  engine :Slippers
+  
+  def index
+    @entries = Entry.order(:created.desc).all
+  end
+
+  def delete id
+    entry = Entry[id]
+    entry.delete
+    redirect :/
+  end
+
+  def edit id
+    @entry = Entry[id]
+    redirect_referrer unless @entry
+  end
+
+  def create
+    Entry.add(*request[:title, :content])
+    redirect :/
+  end
+
+  def save
+    redirect_referer unless  entry = Entry[request[:id]]
+    entry.update(*request[:title, :content])
+    redirect :/
+  end
+end

data/examples/blog/model/entry.rb

@@ -0,0 +1,31 @@
+require 'sequel'
+Sequel::Model.plugin(:schema)
+
+DB = Sequel.connect("sqlite:///#{__DIR__}/../blog.db")
+
+class Entry < Sequel::Model(:entry)
+  set_schema do
+    primary_key :id
+
+    time :created
+    time :updated
+    text :title
+    text :content
+  end
+
+  def self.add(title, content)
+    create :title => title, :content => content,
+      :created => Time.now, :updated => Time.now
+  end
+
+  def update(title = title, content = content)
+    self.title, self.content, self.updated = title, content, Time.now
+    save
+  end
+end
+
+Entry.create_table! unless Entry.table_exists?
+
+if Entry.empty?
+  Entry.add 'Blog created', 'Exciting news today, this blog was created'
+end

data/examples/blog/public/styles/blog.css

@@ -0,0 +1,132 @@
+body {
+  margin: 0;
+  padding: 0;
+}
+
+h1 {
+  background: #FFC;
+  margin: 0;
+  padding: 0.25em 3em 0.25em 0.25em;
+  font-size: 32pt;
+  text-align: right;
+  color: #884;
+  border-bottom: 1px solid #004;
+}
+
+h2 {
+  margin: 8pt 0 0 0;
+  padding: 0 8pt 4pt 8pt;
+  font-size: 24pt;
+  color: #884;
+}
+
+div#actions {
+  margin: -1px 8pt 0 0;
+  padding: 2pt 8pt 4pt 8pt;
+  float: right;
+  background: #FFC;
+  border-style: solid;
+  border-width: 0 2px 2px 1px;
+  border-color: 0 #004 #004 #448;
+  font-size: 10pt;
+  color: #884;
+}
+
+div#actions a {
+  color: inherit;
+  text-decoration: none;
+}
+
+div#actions a:hover {
+  color: black;
+}
+
+div#entries {
+  margin: 0pt 20pt 10pt 12pt;
+}
+
+div.entry {
+  margin: 10pt 0 0 0;
+  padding: 0;
+  background-color: #FFD;
+  border-left: 8pt solid #CC8;
+  border-top: 1px solid #CC8;
+}
+
+div.entry div.header {
+  background-color: #EEA;
+  border-bottom: 1px solid #CC8;
+}
+
+div.entry div.header div.title {
+  font-size: 18pt;
+  color: black;
+  padding: 2pt 4pt 2pt 4pt;
+}
+
+div.entry div.header div.title input {
+  width: 100%;
+  border: none;
+  font-size: inherit;
+}
+
+div.entry div.header ul {
+  float: left;
+  margin: 0;
+  padding: 0;
+}
+
+div.entry div.header ul li {
+  background-color: #EEA;
+  margin: 0 0 0 4pt;
+  padding: 0 4pt 0 4pt;
+  display: inline;
+  border-style: none solid solid solid;
+  border-width: 1px;
+  border-color: #CC8;
+  font-size: 9pt;
+  color: #884;
+}
+
+div.entry div.header ul li:hover {
+  color: black;
+}
+
+div.entry div.header ul li a {
+  text-decoration: none;
+  color: inherit;
+}
+
+div.entry div.header div.created {
+  float: right;
+  font-size: 8pt;
+  color: #888;
+  margin: 0.25em 0.5em 0 0;
+}
+
+div.entry div.content {
+  padding: 24pt 16pt 16pt 16pt;
+  border-bottom: 1px solid #CC8;
+}
+
+div.entry div.content textarea {
+  width: 100%;
+  border: none;
+  font-size: inherit;
+  height: 12em;
+  margin: -16pt -8pt -8pt -8pt;
+  padding: 8pt;
+}
+
+div.entry input[type=submit] {
+  margin: 4pt 16pt 4pt 4pt;
+  border: 1px solid #CC8;
+  background-color: #EEC;
+}
+
+div.entry div.updated {
+  float: right;
+  font-size: 8pt;
+  color: #888;
+  margin: -1.25em 0.5em 0 0;
+}

data/examples/blog/spec/blog.rb

@@ -0,0 +1,87 @@
+require 'ramaze'
+require 'ramaze/spec/helper'
+
+spec_require 'hpricot', 'sequel'
+
+$LOAD_PATH.unshift base = __DIR__('..')
+require 'start'
+
+describe 'Blog' do
+  behaves_like 'http'
+  ramaze :public_root => base/:public,
+         :view_root   => base/:view
+
+  after do
+    Entry.each{|e| e.delete unless e.id == 1 }
+  end
+
+  def check_page(name = '')
+    page = get("/#{name}")
+    page.status.should == 200
+    page.body.should.not == nil
+
+    doc = Hpricot(page.body)
+    doc.at('title').inner_html.should == 'Blog'
+    doc.at('h1').inner_html.should == 'Blog'
+
+    doc.search('div#entries').size.should == 1
+
+    doc
+  end
+
+  def create_page(title,content)
+    page = post('/create','title'=>title,'content'=>content)
+    page.status.should == 302
+    page.location.should == '/'
+  end
+
+  it 'should have main page' do
+    doc = check_page
+    doc.at('div#actions>a').inner_html.should == 'new entry'
+    doc.search('div.entry').size.should == 1
+  end
+
+  it 'should have new entry page' do
+    doc = check_page('new')
+    form = doc.at('div.entry>form')
+    form.at('input[@name=title]')['value'].should == ''
+    form.at('textarea').inner_html.should == ''
+    form.at('input[@type=submit]')['value'].should == 'Add Entry'
+  end
+
+  it 'should add new pages' do
+    create_page('new page', 'cool! a new page')
+    doc = check_page
+    entry = doc.search('div.entry')
+    entry.size.should == 2
+    entry = entry.last
+
+    entry.at('div.title').inner_html == 'new page'
+    entry.at('div.content').inner_html == 'cool! a new page'
+  end
+
+  it 'should edit existing pages' do
+    create_page('new page', 'cool! a new page')
+    post('/save','id'=>'2','title'=>'new title','content'=>'bla bla')
+    doc = check_page
+    entries = doc/'div.entry'
+    entries.size.should == 2
+    entry = entries.first
+
+    entry.at('div.title').inner_html == 'new title'
+    entry.at('div.content').inner_html == 'bla bla'
+  end
+
+  it 'should delete existing pages' do
+    create_page("page to delete", 'content')
+    entries = check_page/'div.entry'
+    entries.size.should == 2
+    delete_link = entries.last.at("a:contains('delete')")
+    page = get(delete_link[:href])
+    page.status.should == 302
+    page.location.should == '/'
+    (check_page/'div.entry').size.should == 1
+  end
+
+  FileUtils.rm_f(__DIR__('../blog.db'))
+end

data/examples/blog/start.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'ramaze'
+
+require 'model/entry'
+require 'controller/main'
+
+Ramaze.start :port => 3000

data/examples/blog/view/edit.st

@@ -0,0 +1,19 @@
+<h2>Editing entry</h2>
+<div id="entries">
+  <div class="entry">
+	$entry:{
+    <form method="post" action="/save">
+      <input name="id" type="hidden" value="$id$"/>
+      <div class="header">
+        <div class="title">
+          <input name="title" type="text" value="$title$"/>
+        </div>
+      </div>
+      <div class="content">
+        <textarea name="content">$content$</textarea>
+      </div>
+      <input type="submit" value="Update Entry"/>
+    </form>
+	}$
+  </div>
+</div>

data/examples/blog/view/edit.xhtml

@@ -0,0 +1,17 @@
+<h2>Editing entry</h2>
+<div id="entries">
+  <div class="entry">
+    <form method="post" action="#{R self,:save}">
+      <input name="id" type="hidden" value="#{@entry.id}"/>
+      <div class="header">
+        <div class="title">
+          <input name="title" type="text" value="#{@entry.title}"/>
+        </div>
+      </div>
+      <div class="content">
+        <textarea name="content">#{@entry.content}</textarea>
+      </div>
+      <input type="submit" value="Update Entry"/>
+    </form>
+  </div>
+</div>

data/examples/blog/view/entry.st

@@ -0,0 +1,12 @@
+<div class="entry">
+  <div class="header">
+    <div class="title">$title$</div>
+    <div class="created">Created: $created$</div>
+    <ul>
+      <li><a href='/edit/$id$'>edit</a></li>
+      <li><a href='/delete/$id$'>delete</a></li>
+    </ul>
+  </div>
+  <div class="content">$content$</div>
+  <div class="updated">Last updated: $updated$</div>
+</div>

data/examples/blog/view/index.st

@@ -0,0 +1,4 @@
+<div id="actions"><a href="/new">new entry</a></div>
+<div id="entries">
+  $entries:entry()$
+</div>

data/examples/blog/view/index.xhtml

@@ -0,0 +1,17 @@
+<div id="actions">#{A 'new entry', :href => Rs(:new)}</div>
+<div id="entries">
+  <?r @entries.each do |entry| ?>
+  <div class="entry">
+    <div class="header">
+      <div class="title">#{entry.title}</div>
+      <div class="created">Created: #{entry.created}</div>
+      <ul>
+        <li>#{A 'edit', :href => Rs(:edit, entry.id)}</li>
+        <li>#{A 'delete', :href => Rs(:delete, entry.id)}</li>
+      </ul>
+    </div>
+    <div class="content">#{entry.content}</div>
+    <div class="updated">Last updated: #{entry.updated}</div>
+  </div>
+  <?r end ?>
+</div>

data/examples/blog/view/layout.st

@@ -0,0 +1,11 @@
+<html>
+  <head>
+    <title>Blog</title>
+    <link rel="stylesheet" href="/styles/blog.css" type="text/css"/>
+  </head>
+  <body>
+    <h1>Blog</h1>
+    #@content
+  </body>
+</html>
+

data/examples/blog/view/layout.xhtml

@@ -0,0 +1,11 @@
+<html>
+  <head>
+    <title>Blog</title>
+    <link rel="stylesheet" href="/styles/blog.css" type="text/css"/>
+  </head>
+  <body>
+    <h1>Blog</h1>
+    #@content
+  </body>
+</html>
+

data/examples/blog/view/new.st

@@ -0,0 +1,16 @@
+<h2>New entry</h2>
+<div id="entries">
+  <div class="entry">
+    <form method="post" action="/create">
+      <div class="header">
+        <div class="title">
+          <input name="title" type="text" value=""/>
+        </div>
+      </div>
+      <div class="content">
+        <textarea name="content"></textarea>
+      </div>
+      <input type="submit" value="Add Entry"/>
+    </form>
+  </div>
+</div>

data/examples/blog/view/new.xhtml

@@ -0,0 +1,16 @@
+<h2>New entry</h2>
+<div id="entries">
+  <div class="entry">
+    <form method="post" action="#{R self,:create}">
+      <div class="header">
+        <div class="title">
+          <input name="title" type="text" value=""/>
+        </div>
+      </div>
+      <div class="content">
+        <textarea name="content"></textarea>
+      </div>
+      <input type="submit" value="Add Entry"/>
+    </form>
+  </div>
+</div>

data/examples/forms/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc "Run all examples"
+Spec::Rake::SpecTask.new('examples') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << 'lib' << 'spec'
+  t.spec_files = FileList['spec/**/*.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.libs << 'lib' << 'spec'
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+end
+
+
+task :default => :examples  

data/examples/forms/controller/init.rb

@@ -0,0 +1,12 @@
+# Define a subclass of Ramaze::Controller holding your defaults for all
+# controllers
+
+class Controller < Ramaze::Controller
+  layout '/page'
+  helper :xhtml
+  engine :Slippers
+end
+
+# Here go your requires for subclasses of Controller:
+require 'controller/main'
+require 'controller/registration'

data/examples/forms/controller/main.rb

@@ -0,0 +1,20 @@
+# Default url mappings are:
+#  a controller called Main is mapped on the root of the site: /
+#  a controller called Something is mapped on: /something
+# If you want to override this, add a line like this inside the class
+#  map '/otherurl'
+# this will force the controller to be mounted on: /otherurl
+
+class MainController < Controller
+  # the index action is called automatically when no other action is specified
+  def index
+    @title = "Welcome to Ramaze!"
+  end
+
+  # the string returned at the end of the function is used as the html body
+  # if there is no template for the action. if there is a template, the string
+  # is silently ignored
+  def notemplate
+    "there is no 'notemplate.xhtml' associated with this action"
+  end
+end

data/examples/forms/controller/registration.rb

@@ -0,0 +1,24 @@
+class RegistrationController < Controller
+
+  def initialize
+    @registrationRepository = RegistrationRepository.new
+    @registrationValidator = RegistrationValidator.new
+  end
+  def index
+    key = request[:key]
+    @form =  @registrationRepository.find(key)
+    @message = flash[:message] if flash[:message]
+  end
+  
+  def save
+    key=request[:key]    
+    form = @registrationRepository.find(key)
+    form.update(:name => request[:name], :address => request[:address], :email => request[:email], :phone => request[:phone])
+    
+    @registrationValidator.validate(form)
+    
+    @registrationRepository.save(form)
+    flash[:message] = "Saved!"
+    redirect route('/registration', :index, :key=>form[:key])
+  end
+end

data/examples/forms/model/core_extensions/string_extensions.rb

@@ -0,0 +1,5 @@
+class String
+  def is_numeric?
+    true if Float(object) rescue false
+  end
+end

data/examples/forms/model/field.rb

@@ -0,0 +1,33 @@
+class Field
+  
+  def initialize(key, value)
+    @key = key
+    @value = value
+    @errors = []
+  end
+  
+  def update(value)
+    @value = value
+  end
+  
+  def value
+    @value
+  end
+  
+  def is?(key)
+    @key == key
+  end
+  
+  def is_valid?
+    @errors.empty?
+  end
+  
+  def invalid(error)
+    @errors << error
+  end
+  
+  def errors
+    @errors
+  end
+  
+end