DEV Community

Ivana
Ivana

Posted on • Originally published at Medium on

Sinatra MVC File Structure

Sinatra is a Domain Specific Language (DSL) for creating web applications in Ruby. It is dependent on the Rack web server interface.

Companies that use Sinatara include Apple, BBC, GitHub, LinkedIn, National Security Agency, Heroku and many more.

Working with Sinatra allows you to dive in deep with the major concepts of MVC (Models-Views-Controllers), a system for building web applications that governs majority of the worlds’ apps.

MVC is a pattern for the architecture of a software application. It separates an application into the following components:

  • Models for handling data and business logic
  • Controllers for handling the user interface and application
  • Views for handling graphical user interface objects and presentation

Models, views and controllers of the MVC framework

The Models, Views and Controllers will be grouped into a folder named app directory where we spend most of our time coding. All the main files are organized inside an app folder with subfolders corresponding to each component of MVC: models for object model files, views ** for html template files, and **controllers for controller files.

models directory

This directory holds the logic behind our application. Typically, these files represent either a component of our application, such as a User, Post, or Comment… Each file in models typically contains a different class.

In Sinatra, models are generally written as Ruby classes.

For example, dog.rb would contain a class called Dog and have name, breed, and age attributes which can be set on initialization. We should be able to read and write to these attributes and this class should also keep track of each instance of dog created, as well as a class method all to return an array of those instances:

controllers directory

The controllers, such as application_controller.rb, are where the application configurations, routes, and controller actions are implemented. Controllers represent the application logic, generally; the interface and flow of our application. There is typically a class, in this case we will call it ApplicationController, that represents an instance of our application when the server is up and running. The application_controller.rb file represents the “C” components of the MVC paradigm.

In Sinatra, controllers are written in Ruby and consist of ‘routes’ that take requests sent from the browser (“GET this data”, “POST that data”), run code based on those requests by using models, and then render the .erb (view) files for the user to see. We’ve created a controller action that can receive and respond to a GET request to the root URL ‘/’. This GET request loads the index.erb file.

views directory

This directory holds the code that will be displayed in the browser. By convention, our file names will match up with the action that renders them. For example, a GET request to / typically renders a file called index.erb.

In Sinatra, views are written as .erb files, consisting of HTML and embedded Ruby (Ruby code written within HTML). They are what the user actually sees when they use your web application. We created a file called index.erb inside of the views directory with the following code:

We’ve already told the controller how to load this file in the view.

How things look and are displayed in our application

To test our app we used Shotgun — Ruby gem that makes it easier to develop and test Rack-based Ruby web applications locally by starting Rack with automatic code reloading.

After we run shotgun to start a local server and test our app in browser, this is how things are displayed:

Connect on LinkedIn

Originally published at https://ivanadokic.github.io on January 5, 2020.

Top comments (0)