Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

180 lines (116 sloc) 4.056 kb

Actions

The cornerstone of any Espresso app.

Namely, actions are the workhorses that creates the routes to be served by app, as well as running our code.

If we need user to see "Hello World!" when he visits "/hello" address in the browser, we simply do like this:

def hello
  "Hello World!"
end

It is really straightforward to define actions in Espresso cause they are usual Ruby methods.

Worth to note that actions can be shared between controllers by using modules:

module SharedActions

  def foo
    # ...
  end
end

class App < E
  include SharedActions

  def bar
    # ...
  end
end

[ contents ↑ ]

Controllers

A controller is meant to organize and setup actions.

The basic setup is base URL. It is defaulted to the controller's underscored name and are used by all actions.

Other setups are action-specific and can be set for N or for all actions.
To define a setup for all actions, simply call appropriate method at controller's class level.
To setup specific actions, call appropriate methods inside setup proc that will accept action names as arguments.
Action names can also be given as regular expressions.

Example: - Creating a controller that will serve "/pages/latest" and "/pages/rss" URLs

class Pages < E

  # setup for all actions
  charset 'UTF-8'

  # setup for `rss` action
  setup :rss do
    content_type '.rss'
  end

  def latest
    # ...
  end

  def rss
    # ...
  end
end

That's it, controllers are usual Ruby classes with inheritance from E class.

[ contents ↑ ]

Slices

A slice is meant to organize and setup controllers.

The basic setup is, again, base URL. It is used by all controllers.

Other setups are controller-specific and can be set for N or all controllers.

A slice is a usual Ruby module containing Espresso controllers.
It can be mounted under any path that will serve as base URL for all controllers inside.

Example: - Create a slice that will serve "/cms/articles", "/cms/news" and "/cms/pages" URLs

module Cms

  class Articles < E
    # ...
  end

  class News < E
    # ...
  end

  class Pages < E
    # ...
  end
end

app = Cms.mount '/cms'
# or just `Cms.mount` to mount the slice into / and serve
# "/articles", "/news" and "/pages" URLs

app.run

To setup controllers, simply pass a block to mount method.

Let's say we have N controllers that using Haml engine.
Then we simply do like this:

app = MySlice.mount do
  engine :Haml
end
app.run

When you need to setup only a specific controller, use the mount block with a single param that will be set to the controller actually being configured.

app = MySlice.mount do |ctrl|
  engine :ERB if ctrl == Articles
end

[ contents ↑ ]

Applications

Applications are meant to bundle, setup and run controllers and slices.

To create a new Espresso application use E.new:

class MyController < E
  # ...
end

app = E.new
app.mount MyController
app.run

MVC?

Espresso does not impose any design patterns.

You are free to create projects of any types using any design patterns.
Espresso wont stay in your way nor bombarding you with conventions.

And when you want to simplify the routine use Enginery

It will build a ready-to-use application and will help to easily generate controllers, routes, specs, models, migrations etc. from command line.

[ contents ↑ ]

Models?

Espresso by itself does not deal with models, migrations etc.

It is the responsibility of the ORM you choose to use.

Also you can use some sort of app builders like Enginery to generate models, migrations etc.

[ contents ↑ ]

Jump to Line
Something went wrong with that request. Please try again.