Sinatra Basics

Overview

We'll discuss modular Sinatra applications and mounting a controller.

Objectives

1. Distinguish between single file Sinatra apps and modular Sinatra apps
2. Explain the purpose of the config.ru and what is included in the file
3. Define and create a Sinatra controller
4. Mount a Sinatra controller in config.ru

Modular Sinatra Applications

Web applications, even simple Sinatra ones, tend to require a certain degree of complexity. For example, your application might have multiple routes, route-handlers, and configuration. To handle this, Sinatra is more commonly used through the Modular Sinatra Pattern (over the classical, single file app.rb pattern).

config.ru

The first new convention this pattern introduces is a config.ru file. The purpose of config.ru is to detail to Rack the environment requirements of the application and start the application.

A common 'config.ru' might look like:

require 'sinatra'

require_relative './app.rb'

run Application

In the first line of config.ru we load the Sinatra library. The second line requires our application file, defined in app.rb. The last line of the file uses run to start the application represented by the ruby class Application, which is defined in app.rb.

Sinatra Controllers: app.rb

config.ru requires a valid Sinatra Controller to run. A Sinatra Controller is simply a Ruby Class that inherits from Sinatra::Base. This inheritance transforms our plain old Ruby class into a web application by giving it a Rack-compatible interface through inheriting from the "base" of the Sinatra framework. Open app.rb

class Application < Sinatra::Base

  get '/' do
    "Hello, World!"
  end

end

We simply create a new class Application and inherit from Sinatra::Base. Our class constant could have been anything descriptive of the functionality provided by the class. The classes that inherit from Sinatra::Base and define the HTTP interface for our application are called Controllers.

In a single controller application, a single file defining the controller, like app.rb, will suffice. That controller will define every single URL and response of our application.

Controllers define an HTTP method using the sinatra routing DSL provided by methods like get and post. When you enclose these methods within a ruby class that is a Sinatra Controller, these HTTP routes are scoped and attached to the controller.

The final step in creating a controller is mounting it in config.ru. Mounting a controller means telling Rack that part of your web application is defined within the following class. We do this in config.ru by using run Application where run is the mounting method and Application is the controller class that inherits from Sinatra::Base and is defined in a previously required file.

The class name we defined in our application controller (app.rb) is just a normal Ruby class. We could have named it MyToDoApp:

class MyToDoApp < Sinatra::Base

  get '/' do
    "Hello, World!"
  end

end

If this was our class name, we would need to change config.ru to run the appropriate class:

run MyToDoApp

Resources

• Blake Mizerany - Ruby Learning Interview
• Companies Using Sinatra