Please export s2cgi from following svn repository.

• https://www.seasar.org/svn/sandbox/s2container.ruby/trunk/s2cgi/

As follows, a project directory will be created.

project/
  config/        # configuration files are stored.
  lib/           # Service and Logic classes are stored.
  public/        # published to WEB.
  test/          # UnitTests are stroed.
  tpl/           # erb template files are stored.
  var/           # Data and Logs are stored.
  vendor/        # Dependent Libraries are stored.

Please install S2Container.Ruby following an install document.

Please install Rack, if you use it.

Extension cgi is registered as a cgi script.
And publish to WEB the public directory.

AddHandler cgi-script .cgi
Alias /s2cgi/ "/path/to/project/public/"
<Directory "/path/to/project/public">
    Options ExecCGI
    AllowOverride None
    Order allow,deny
    Allow from localhost
</Directory>

Base URL should be set up appropriately. You can set Base URL in environment.rb file of a config directory.

% cat config/environment.rb | grep BASE_URL
BASE_URL = '/s2cgi'
%

Please check the owner and the right of execution of a cgi script of a public directory. Shebang of cgi script should be set up appropriately.

% ls -l public/cgi/quick1.cgi
-rwxr--r-- 1 apache apache 1250 Feb  1 00:00 public/cgi/quick1.cgi
% head -1 public/cgi/quick1.cgi
#!/usr/bin/env ruby
%

Please check the owner and the right of execution of var directory.

% ls -ld var
drwxr-xr-x 6 apache apache 4096 Feb  1 00:00 var
%

The method used for every validation type is defined in Seasar::Validate::Utils module. A method name becomes the name which added "?" to the validation type. A method name becomes "int?" when a validation type is ":int."
Moreover, the procedure object registered into Seasar::Validate::Utils::Validators Hash is also used. Symbol specified by a validation type is used as a Hash key.

:int. 

It is verified whether it is Integer.
The method used is Seasar::Validate::Utils.int?.
An option is specified by Hash. (omissible)

• :min => Minimum value
• :max => Maximum value
• :include => Include :min、:max value or not. default is True.
• :required => Request parameter must be exists or not. default is True.

The example of param method is as follows.

param :year, :int, :min => 2000, :max => 2050

:numeric. 

It is verified whether it is a numerical string.
The method used is Seasar::Validate::Utils.numeric?.
An option is specified by Hash. (omissible)

• :min => Minimum value
• :max => Maximum value
• :include => Include :min、:max value or not. default is True.
• :required => Request parameter must be exists or not. default is True.

The example of param method is as follows.

param :year, :int, :min => 2000, :max => 2050

:string. 

It is verified whether it is String.
The method used is Seasar::Validate::Utils.string?.
An option is specified by Hash. (omissible)

• :min => Minimum length
• :max => Maximum length
• :include => Include :min、:max value or not. default is True.
• :required => Request parameter must be exists or not. default is True.

The example of param method is as follows.

param :name, :string, :min => 6, :max => 8

:array. 

It is verified whether it is Array.
The method used is Seasar::Validate::Utils.array?.
An option is specified by Hash. (omissible)

• :min => Minimum size
• :max => Maximum size
• :include => Include :min、:max value or not. default is True.
• :required => Request parameter must be exists or not. default is True.

The example of param method is as follows.

param :names, :array, :min => 6, :max => 8

:member, :in. 

It is verified whether it is member of array specified as an option.
The method used is Seasar::Validate::Utils.member?.
An option is specified by Hash or Array.

• :items => Member Array
• :required => Request parameter must be exists or not. default is True.

The example of param method is as follows.

param :names, :member, %w[foo bar hoge huga]

:regexp. 

It is verified whether Regexp specified as an option is matched.
The method used is Seasar::Validate::Utils.regexp?.
An option is specified by Hash or Regexp.

• :regexp => Regexp
• :required => Request parameter must be exists or not. default is True.

The example of param method is as follows.

param :name, :regexp, /^abc/

:alpha. 

It verifies whether it is an alphabetical-letter sequence.
The method used is Seasar::Validate::Utils.alpha?.
An option is specified by Hash. (omissible)

• :case => :down or :up
• :required => Request parameter must be exists or not. default is True.

The example of param method is as follows.

param :name, :alpha, :case => :down

Instead of registering verification block by a validate method, Validation can be performed by defining a validate_get method to GET access, or defining a validate_post method to POST access.

class Page < Seasar::CGI::Page
  def validate_get   # performs in GET request.
    param :year, :numeric
    valid?
  end

  def validate_post  # performs in POST request.
    param :year, :numeric
    valid?
  end
end

Starting of CGI Framework will be done by calling Seasar::Rack::CGI.run method. As an example, let's create the following quick1.cgi in public/rack directory.

% cat public/rack/quick1.cgi
#!/usr/bin/env ruby
# -*- coding: utf-8 -*-

require File.dirname(__FILE__) + '/../../config/rack.rb'
Seasar::Rack::CGI.run
%

Next, the erb template file of quick1.cgi is created as quick1.html in a tpl/rack directory.

% cat tpl/rack/quick1.html
Hello World
%

Please browse http://localhost/s2cgi/rack/quick1.cgi, you can see "Hello World".

You can set the instance of Seasar::Rack::CGI::Page class as the argument of Seasar::CGI.run method. As an example, let's create the following quick2.cgi in public/rack directory.

% cat public/rack/quick2.cgi
#!/usr/bin/env ruby
# -*- coding: utf-8 -*-

require File.dirname(__FILE__) + '/../../config/rack.rb'

class Page < Seasar::Rack::CGI::Page; end
Seasar::Rack::CGI.run(Page.new)
%

Next, the erb template file of quick2.cgi is created as quick2.html in a tpl/rack directory.

% cat tpl/cgi/quick2.html
Hello World 2
%

Please browse http://localhost/s2cgi/rack/quick2.cgi, you can see "Hello World 2".

Seasar::Rack::CGI.run method gets the component of Seasar::Rack::CGI::Page class from S2Container, when an argument is nil. When the component of Seasar::Rack::CGI::Page class does not exist in a container, the instance of Seasar::Rack::CGI::Page class is generated automatically.

@env. 

Rack environment argument passed to Seasar::Rack::CGI::Page#call method is set.

@request. 

Rack::Request instance is set.

@response. 

Rack::Response instance is set. @response.finish method is automatically called after a call of a get/post method.

@auto_render. 

It is set up by Boolean whether a render method is called automatically, when the size of @response.body.size is 0 and @response.status is 200 after calling get/post method.

The procedure object which performs Rack Up is set as Seasar::Rack::CGI::Page.rack class variable. As a default value, it is set up as follows in config/rack.rb.

Seasar::Rack::CGI::Page.rack {|page|
  Rack::Builder.app do
    use Seasar::Rack::CGI::Stdin2StringIO
    use Rack::ShowStatus
    use Rack::ShowExceptions
    use Rack::MethodOverride
    use Rack::ContentLength
    use Rack::Session::Cookie
    run page
  end
}

Rack Up procedure object is called within a CGI.run method. The Page instance gotten from S2Container or the Page instance generated newly is passed as an argument.
Moreover, Rack Up procedure object can be set up also as a block argument of Seasar::Rack::CGI.run method.

% cat public/rack/quick3.cgi
#!/usr/bin/env ruby
# -*- coding: utf-8 -*-

require File.dirname(__FILE__) + '/../../config/rack.rb'
class Page < Seasar::Rack::CGI::Page
  s2comp
  def get
    puts 'Hello World 3'
  end
end
Seasar::Rack::CGI.run {|page|
  Rack::Builder.app do
    use Seasar::Rack::CGI::Stdin2StringIO
    run page
  end
}
%