waw 0.2.2

data/LICENCE.rdoc

@@ -0,0 +1,25 @@
+= Licence
+
+	The MIT License
+
+	Copyright (c) 2009 Bernard & Louis Lambeau and the University of Louvain 
+	(Universite Catholique de Louvain, Louvain-la-Neuve, Belgium)
+	
+	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.rdoc

@@ -0,0 +1,32 @@
+= Waw, making web applications simple
+
+Waw is a web framework written in Ruby. It provides an alternative to Rails and other frameworks
+written in Ruby as well. It is designed to be somewhere in the middle between Rails (sometimes a 
+bit too heavy) and Rack (not really a framework, sometimes too low-level).
+
+== Main features
+
+Waw basically provides an overall architecture for web sites and/or applications. Its main 
+features are
+
+- It proposes the development of secure web applications, avoiding code injection as much 
+  as possible and enforcing validation of both input data (coming from formularies, for example) 
+  and application state (user authentification or administration level for invoking specific 
+  services or to access specific pages)
+  
+- A simple but powerful templating engine, not restricted to HTML... Creating XML files for AJAX
+  services, creating text reports and so on are all as easy as generating html.
+  
+- Invoking webservices through AJAX is made declarative. The javascript code is automatically
+  generated!
+  
+- When things become too restrictive for you (you don't fit the architecture exactly) you can 
+  access lower stages ... edit the underlying Rack configuration and install your own services
+  in a few minutes, bypassing waw when needed!
+  
+== Dependencies
+
+Waw requires the following ruby gems
+
+- rack >= 1.1.0 (provided through <code>gem install rack</code>)
+- wlang >= 0.9.0 (provided in the vendors folder)

data/bin/waw

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+#
+#  Waw - making web development simple
+#        (see lib/waw/waw.rb for more information)
+#
+#  Copyright (c) 2010 University of Louvain, Bernard & Louis Lambeau
+#  Released under a MIT or Ruby licence
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'waw'
+require 'waw/wawgen'
+
+begin
+  if ARGV.size < 1
+    puts "Usage: waw create [options] ProjectName"
+  elsif ARGV[0] != 'create'
+    puts "Unknown command #{ARGV[0]}"
+    puts "Usage: waw create [options] ProjectName"
+  else
+    r = Waw::Wawgen::Create.new.run ARGV[1..-1]
+  end
+rescue Interrupt => e
+  $stderr.puts
+  $stderr.puts "Interrupted"
+  raise e
+rescue OptionParser::ParseError => e
+  $stderr.puts e.message
+  raise e
+rescue => e
+  $stderr.puts e.message
+  raise e
+end

data/bin/waw-profile

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+#
+#  Waw - making web development simple
+#        (see lib/waw/waw.rb for more information)
+#
+#  Copyright (c) 2010 University of Louvain, Bernard & Louis Lambeau
+#  Released under a MIT or Ruby licence
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'waw'
+require 'waw/commands/command'
+require 'waw/commands/profile_command'
+
+begin
+  r = Waw::Commands::ProfileCommand.new.run '.', ARGV
+rescue Interrupt => e
+  $stderr.puts
+  $stderr.puts "Interrupted"
+  raise e
+rescue OptionParser::ParseError => e
+  $stderr.puts e.message
+  raise e
+rescue => e
+  $stderr.puts e.message
+  raise e
+end

data/bin/waw-start

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+#
+#  Waw - making web development simple
+#        (see lib/waw/waw.rb for more information)
+#
+#  Copyright (c) 2010 University of Louvain, Bernard & Louis Lambeau
+#  Released under a MIT or Ruby licence
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'waw'
+require 'waw/commands/command'
+require 'waw/commands/start_command'
+
+begin
+  r = Waw::Commands::StartCommand.new.run '.', ARGV
+rescue Interrupt => e
+  $stderr.puts
+  $stderr.puts "Interrupted"
+  raise e
+rescue OptionParser::ParseError => e
+  $stderr.puts e.message
+  raise e
+rescue => e
+  $stderr.puts e.message
+  raise e
+end

data/bin/wspec

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+#
+#  WSpec - Executes wspec waw tests
+#         (see lib/waw/waw.rb for more information)
+#
+#  Copyright (c) 2010 University of Louvain, Bernard & Louis Lambeau
+#  Released under a MIT or Ruby licence
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'waw'
+
+# Abord execution
+def abord(message, code)
+  puts message
+  exit(code)
+end
+
+unless ARGV.size == 1 
+  abord("Usage: wspec a_test.wspec", 0)
+else
+  # Checks that the test exists
+  wspec_file = ARGV[0]
+  abord("Unable to find .wspec file #{wspec_file}", -1) unless File.exists?(wspec_file)
+  
+  # Load the waw application for having configuration
+  app = Waw.autoload(wspec_file)
+  raise "Tests cannot be run in production mode, to avoid modifying real database "\
+        "or sending spam mails to real users." unless app.config.deploy_mode=='devel'
+  
+  # Load the wspec runner now
+  require 'waw/wspec/runner'
+  load(wspec_file)
+end

data/layouts/empty/Rakefile

@@ -0,0 +1,14 @@
+require "rake/rdoctask"
+require "rake/testtask"
+require "rubygems"
+require "waw"
+
+task :default => [:test]
+
+desc "Launches all wspec tests"
+task :wspec do
+  require('test/wspec/test_all.rb')
+end
+
+desc "Launches all tests"
+task :test => [:wspec]

data/layouts/empty/config.ru

@@ -0,0 +1,5 @@
+#!/usr/bin/env rackup
+require "rubygems"
+gem 'waw', '>= +(Waw::VERSION)'
+require "waw"
+run Waw.autoload(__FILE__)

data/layouts/empty/config/commons.cfg

@@ -0,0 +1,31 @@
+# The following paths will be automatically added to the $LOAD_PATH 
+# ruby global variable when the web application is loaded.
+# load_path            'lib'
+
+# The following names will be ruby-required when the web application 
+# is loaded.
+# requires             '+(project.lowname)'
+
+# A simple ruby name for the web application. This name is used in 
+# different part of the waw architecture (including code generation).
+# It MUST respect [a-z][a-z_]*, to avoid strange behaviors.
+application_name     '+(project.lowname)'
+
+# Deployment mode; accepted values are 'devel', 'test' 'acceptation' 
+# and 'production'. The deployment mode drives the way critical code is 
+# executed. Your wspec tests cannot be run in production mode, for example, 
+# to avoid modifying your production database, sending mails to real people, 
+# and so on.
+#
+# This is set to 'devel' by default, to avoid waw failures for developers
+# forgetting to set this configuration parameter. It should be overrided
+# on producion and test environments.
+deploy_mode          'devel'
+
+# Generate javascript (and additional) code at startup? By default, code
+# is generated at startup time in devel mode only.
+code_at_startup      { deploy_mode=='devel' }
+
+# About the Rack session
+rack_session         true
+rack_session_expire  60 * 60 * 24 * 265

data/layouts/empty/config/devel.cfg

@@ -0,0 +1,21 @@
+# Deployment mode; accepted values are 'devel', 'test' 'acceptation' 
+# and 'production'. The deployment mode drives the way critical code is 
+# executed. Your wspec tests cannot be run in production mode, for example, 
+# to avoid modifying your production database, sending mails to real people, 
+# and so on.
+deploy_mode       'devel'
+
+# Web domain, web port and web base. The later is the url to put in 
+# <base href=""/>. This url should always include http:// and should not 
+# contain the index.html suffix.
+web_domain         '127.0.0.1'
+web_port           9292
+web_base           "http://#{web_domain}:#{web_port}/"
+
+# Logger configuration. Follows what ruby Logger class expects.
+#log_io               STDOUT
+log_dir              'logs'
+log_file             "#{application_name}.log"
+log_frequency        'weekly'
+log_level            Logger::DEBUG
+

data/layouts/empty/ignore

@@ -0,0 +1,7 @@
+# This file helps you developing your web application with a version-control 
+# system like Git or Subversion. The following waw files should always be ignored
+# to avoid overriding configuration of other developers or production deployments
+waw.deploy
+config/*.cfg
+tmp
+logs

data/layouts/empty/resources/messages.rs

@@ -0,0 +1 @@
+# Messages that the waw application use

data/layouts/empty/test/wspec/site_respond.wspec

@@ -0,0 +1,3 @@
+requirement("The web server should at least be reachable") do
+  i_reach index_page
+end

data/layouts/empty/test/wspec/test_all.rb

@@ -0,0 +1,13 @@
+# Requires
+require 'rubygems'
+gem 'waw', '>= +(Waw::VERSION)'
+require 'waw/wspec/runner'
+
+# Load the waw application for having configuration
+app = Waw.autoload(__FILE__)
+raise "Tests cannot be run in production mode, to avoid modifying real database "\
+      "or sending spam mails to real users." unless ['devel', 'test'].include\?(app.config.deploy_mode\)
+
+# Load all tests now
+test_files = Dir[File.join(File.dirname(__FILE__), '**/*.wspec')]
+test_files.each { |file| load(file) }

data/layouts/empty/waw.deploy

@@ -0,0 +1 @@
+commons devel

data/layouts/empty/waw.routing

@@ -0,0 +1,6 @@
+Waw.rack do
+  use ::Rack::CommonLogger,  Waw.logger
+  use ::Rack::Session::Pool, :domain       => Waw.config.web_domain,
+                             :expire_after => Waw.config.rack_session_expire
+  run lambda {|env| [200, {'Content-Type' => 'text/plain'}, 'OK']}
+end

data/layouts/static/dependencies

@@ -0,0 +1 @@
+empty

data/layouts/static/public/.wawaccess

@@ -0,0 +1,18 @@
+wawaccess do
+
+  # .wawaccess files are never served
+  match /.wawaccess$/ do
+    deny
+  end
+
+  # We serve all as static file by default
+  match file do
+    static
+  end
+  
+  # When something is not found, we look in the pages wawaccess
+  match true do
+    apply "/pages/#{served_file}"
+  end
+
+end

data/layouts/static/public/pages/.wawaccess

@@ -0,0 +1,30 @@
+wawaccess do
+  
+  # We don't inherits static configuration
+  inherits false
+  
+  # .wawaccess files are never served
+  match /.wawaccess$/ do
+    deny
+  end
+  
+  # When a folder is requested, find the associated index file
+  match directory do
+    apply "#{served_file}/index.wtpl"
+  end
+
+  # We match .wtpl files using wlang
+  match file(:extension => '.wtpl') do
+    wlang '../templates/layout.wtpl'
+  end
+  
+  # When the file cannot be found
+  match true do
+    if /\.wtpl$/ =~ served_file
+      apply "pages/404.wtpl", 404
+    else
+      apply "#{served_file}.wtpl"
+    end
+  end
+  
+end

data/layouts/static/public/pages/404.wtpl

@@ -0,0 +1 @@
+<p>404 not found, the requested page does not exists</p>

data/layouts/static/public/pages/index.wtpl

@@ -0,0 +1,5 @@
+<h1>Hello !</h1>
+
+<p>This is the layout-ed index page of your waw-driven website</p>
+
+<p>Enjoy!</p>

data/layouts/static/public/templates/.wawaccess

@@ -0,0 +1,9 @@
+wawaccess do
+  strategy :deny_all
+  inherits false
+  
+  match true do
+    deny 
+  end
+
+end

data/layouts/static/public/templates/layout.wtpl

@@ -0,0 +1,17 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+	<head>
+		<meta http-equiv="Content-type" content="text/html; charset=UTF-8" />
+    <base href="{config.web_base}"/>
+		<title>+(project.upname)</title>
+		*{css_files as css}{
+  		<link rel="stylesheet" type="text/css" href="{css}" />
+  	}
+		*{js_files as js}{
+  		<script type="text/javascript" src="{js}"></script>
+  	}
+	</head>
+	<body>
+	  <<+{../${served_file} share all}
+	</body>
+</html>

data/layouts/static/test/wspec/static_pages_are_served.wspec

@@ -0,0 +1,21 @@
+scenario __FILE__ do
+  because("The root website URL is correctly served") {
+    i_reach index_page
+    i_see "Hello !"
+  }
+  because("Static files (css, js, images, ...) are correctly served") {
+    i_reach index_page + 'css/style.css'
+    i_reach index_page + 'js/+(project.lowname).js'
+  }
+  because(".wawaccess files are correctly written") {
+    i_may_not_reach index_page + '.wawaccess'
+    i_may_not_reach index_page + 'pages/.wawaccess'
+    i_may_not_reach index_page + 'templates/.wawaccess'
+    i_may_not_reach index_page + 'templates/layout.wtpl'
+  }
+  because("the default wlang context is correct") {
+    i_reach index_page
+    i_see_tag "link",   {:rel => "stylesheet", :type => "text/css", :href => /^.*\.css/}
+    i_see_tag "script", {:type => "text/javascript", :src => /^.*\.js$/}
+  }
+end

data/layouts/static/waw.routing

@@ -0,0 +1,8 @@
+Waw.rack do
+  use ::Rack::CommonLogger,  Waw.logger
+  use ::Rack::Session::Pool, :domain       => Waw.config.web_domain,
+                             :expire_after => Waw.config.rack_session_expire
+  map '/' do
+    run ::Waw::StaticController.new(:root => 'public')
+  end
+end

data/lib/waw.rb

@@ -0,0 +1,99 @@
+$waw_deprecated_io = nil
+require 'singleton'
+require 'waw/ext/core'
+require 'waw/ext/rack'
+# 
+# Main waw module, providing the strict micro kernel of waw loader
+#
+module Waw
+  
+  # Requirements on gems for this version
+  GEM_REQUIREMENTS = {
+    :rack  => '>= 1.1.0',
+    :wlang => '>= 0.9.0',
+    :json  => '>= 1.1.9'
+  }
+  
+  # Waw version
+  VERSION = "0.2.2".freeze
+  
+  # Waw loading mutex
+  WAW_KERNELS_LOCK = Mutex.new
+  
+  # Loaded kernels
+  KERNELS = []
+  
+  # Autoloads and returns a waw application
+  def self.autoload(from)
+    WAW_KERNELS_LOCK.synchronize {
+      KERNELS << (app = ::Waw::Kern::App.new)
+      app.autoload(from)
+    }
+  end
+  
+  # Loads a rack application
+  def self.rack(&block)
+    ::Rack::Builder.new(&block).to_app
+  end
+  
+  # Returns the last loaded waw kernel
+  deprecated "Waw.kernel will be removed in version 0.3.0"
+  def self.kernel
+    KERNELS.last
+  end
+  
+  # Sets the current kernel
+  deprecated "Waw.kernel= will be removed in version 0.3.0"
+  def self.kernel=(kernel)
+    KERNELS << kernel
+  end
+  
+  # Install a logger on waw itself
+  def self.logger=(logger)
+    @logger = logger
+  end
+  
+  # Returns the waw logger, which always works on STDOUT
+  def self.logger
+    @logger || (self.kernel && self.kernel.logger) || Logger.new(STDOUT)
+  end
+  
+  # Install other deprecated methods now
+  def self.method_missing(name, *args, &block)
+    k = self.kernel
+    if k and k.respond_to?(name)
+      $waw_deprecated_io << "Waw.#{name} will be removed in version 0.3.0. "\
+                            "Please use the current kernel instance instead." if $waw_deprecated_io
+      k.send(name, *args, &block)
+    else
+      super(name, *args, &block)
+    end
+  end
+  
+end
+
+# Now, make ruby requires
+require 'rubygems'
+Waw::GEM_REQUIREMENTS.each_pair {|name, version|
+  gem(name.to_s, version)
+  require(name.to_s)
+}
+require 'waw/errors'
+require 'waw/scope_utils'
+require 'waw/ext'
+require 'waw/utils/dsl_helper'
+require 'waw/resource_collection'
+require 'waw/config'
+require 'waw/kern'
+require 'waw/validation'
+require 'waw/environment_utils'
+require 'waw/fullstate'
+require 'waw/session'
+require 'waw/controller'
+require 'waw/restart'
+require 'waw/controllers/json_controller'
+require 'waw/controllers/action_controller'
+require 'waw/controllers/static_controller'
+require 'waw/controllers/no_cache'
+require 'waw/controllers/error_handler'
+require 'waw/routing'