Ruby LotusでWeb Appを作ってみる

注意 この記事はIBM製のコラボレーションソフトについてのページではありません。Rubyで書かれたLotusというWebフレームワークについての記事です。

内容

Lotusとは何か

Lotusは新しいRubyで書かれたWebフレームワークです。比較的少人数のlotusチームが開発しています。 2014年9月の時点ではまだ本番環境では使えませんが、簡単なアプリを作るには十分に動作します。

Lotusのプロジェクトページに書かれているスローガンを見たときに一瞬で一目惚れしました。

ページにはこう書いてあります。(かなり意訳です)

Lotusは軽量で高速かつテストが容易なフレームワークです。Lotusはオブジェクト指向プログラミングのエッセンスを取り戻し、安定したAPI、最小限のDSLを提供してシンプルなオブジェクトに基づいたWeb開発を可能にします。

このスローガンを読んだ時、探していたものはこれだと思いました。(後で詳しく説明します)ちょうど個人でやっているプロジェクトでシンプルなAPIサーバを作ろうとしていたので早速Lotusを使ってみることにしました。 まだ情報がほとんど世の中に存在しないので色々苦労しましたが、最近は少しずつ Lotus Way がわかってきたのでこの記事で紹介しようと思います。

なぜRailsではなくLotusか

最近はアプリケーションをモジュール方式で開発する機会が増えてきました。この開発方法をSOAと呼ぼうがMicroserviceと呼ぼうがなんでもいいですが、多くのプロジェクトがこの開発方式を採用するようになってきています。 (Fylnnはお気に入りの例です)

アプリをモジュール方式で開発する利点はいくつかあります。

  • テストがしやすい
  • 高いポータビリティ
  • 再利用しやすい
  • デプロイが容易

Railsを使ってこれらのことを実現するのは簡単ではありません。Railsは素晴らしいですが、フレームワークスタックは巨大で沢山の機能が最初からビルトインされています。 要するにRailsは小さいコンポーネントを沢山作るには大きすぎます。

Sinatrarails-apiが使えるのでは?と思う人もいると思います。 確かにSinatraは軽量です。ただ最近個人的にはDSLよりも 純粋なRubyのコード を好むようになってきました。学習コストを低く抑えれるからです。 正直rails-apiは使ったことがないのでよくわかりません。ただ、Railsがベースなのでそこまで軽量ではないのではないかと思っています。もし、知ってる人がいたら教えてください。

LotusのGithubページを見ればわかりますが、Lotusは複数のコンポーネントからできているので、この中の一つだけを自分のプロジェクトで使うことも可能です。 例えば、lotus-routerだけを自分のRackアプリに組み込んでHTTPルーターとして使うことができます。

またLotusはRailsのようにフルスタックなフレームワークとして使うこともできます。LotusはRailsのいいとこ取りをしているので(例えばCoCの積極的に採用)比較的少ないコードでアプリケーションを作ることもできます。

つまり、LotusはSinatraのように軽量なアプリを作ることができる一方で、Railsのようにフルスタックなアプリも作ることができるということです。

One-fileアプリケーションを作る

Lotusを使ってOne-fileアプリケーションを作ってみます。LotusのGithubに掲載されているone file applicationを参考にします。

まずは、プロジェクト用のディレクトリを作成します。今後の説明はこのディレクトリをカレントディレクトリに設定しているいう前提で進めます。

1
mkdir onefileapp && cd onefileapp

Lotusの公式なgemはまだ配布されていません。ここにありますが更新日は2014年1月となっています。最新のmasterブランチは これよりずっと進んでいるので、ソースからインストールします。そのために、まずLotusレポジトリをクローンします。

1
git clone https://github.com/lotus/lotus.git

Gemの管理にbundlerを使います。Gemfileを作成しましょう。

1
bundle init

次にGemfileを編集します。<your-path-to-lotus-repo>をクローンしてきたLotusのレポジトリのディレクトリに適宜変更してください。

1
2
source "https://rubygems.org"
gem 'lotusrb', :path => <your-path-to-lotus-repo>

Gemをインストールします。

1
bundle install --path vendor/

これでアプリケーションを書く準備が整いました(といっても1ファイルですが)。以下のコードを config.ru として保存してください。

config.ru

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
require 'lotus'

module OneFile
  class Application < Lotus::Application
    configure do
      routes do
        get '/', to: 'home#index'
      end
    end
    load!
  end

  module Controllers
    module Home
      include OneFile::Controller

      action 'Index' do
        def call(params)
        end
      end
    end
  end

  module Views
    module Home
      class Index
        include OneFile::View

        def render
          "Hello, Lotus"
        end
      end
    end
  end
end

run OneFile::Application.new

保存したらアプリを起動してみましょう。最新のmasterブランチには lotus server コマンドがあるのでこれを使います。

1
bundle exec lotus server

起動できましたか?それではブラウザで http://localhost:2300 にアクセスしてみてください。 Hello, Lotus と表示されるはずです。

コードの説明をします。

まず、最初に気づくことはControllersViewsモジュール内で定義されているクラスは継承を使っていないということです。 Lotusの哲学の一つにモジュールをインクルードして最小限のインターフェースを実装するというものがあります。 この哲学は開発者に本当に必要なものだけをMixinして使うことを推奨します。

次にApplicationクラスを見てみましょう。今回の例ではこのクラスはルートの設定をしているだけです。 get '/', to: 'home#index'とすることでGET /のルートはHome::Indexコントローラを使うように設定しています。 今回はひとつだけしかルートを設定していませんが他のHTTPメソッドも同じように設定できます。

1
2
3
4
5
6
7
8
routes do
  post   '/books',             to: 'book#create'
  put    '/books/:id',         to: 'book#update'
  delete '/books/:id',         to: 'book#destroy'

  # ワンライナーレスポンス
  get    '/ping',              to: ->(env) {[200, {}, ['pong']]}
end

次にControllersを見てみましょう。actionを呼んでいる以外は何もしていません。

actionとは何でしょうか?actionはHTTPリクエストのエンドポイントとして動き、ここでリクエストの中身を見たりレスポンスを生成したりします。 リクエストに対するビジネスロジックもここに書きます。多分、actionはRailsのControllerとほとんど同じものだと考えていいと思います。 ここでは先ほどみたルートから呼び出されるIndex actionを定義しています。

最後にViewsを見ましょう。このクラスの仕事はRailsのViewとは異なります。 RailsではViewはブラウザでレンダリングされるコンテンツを吐き出すコードを書く場所でした。LotusではこれはTemplateで行います。(今回の例ではTemplateはでてきません)

LotusではViewはPresenterレイヤーとして動きます。RailsではPresenterは標準ではありません。(Draperなどのgemで使えるようになります) Presenterの仕事はデータをControllerから受け取って抽象化してTemplateに見せることです。 このようにすることでコンテンツ描画コードをクリーンに保つことができるので最近では有名なデザインパターンです。

コードの説明に戻ります。ここではrenderメソッドを実装してHello, Lotusというメッセージを表示しています。

この例はあまり面白くないですね。ViewとControllerを連携させてデータのやりとりをさせてみましょう。

Controllerのコードを以下のように編集します。

1
2
3
4
5
6
7
8
9
10
11
12
13
module Controllers
  module Home
    include OneFile::Controller
    action 'Index' do

      expose :time

      def call(params)
        @time = Time.now
      end
    end
  end
end

2つ新しいメソッドが出てきました。exposecallです。

ControllerからViewにデータを渡すには、exposeを使って明示的に公開する変数を指定しないといけません。 これも本当に必要なものだけを使うというLotusの哲学の現れです。

callはHTTPリクエストのエントリーポイントとして動きます。さっきも少し触れたようにこの中にビジネスロジックやレスポンス生成のコードを書きます。

ViewをControllerからデータを受け取るように変更しましょう。

1
2
3
4
5
6
7
8
9
10
11
module Views
  module Home
    class Index
      include OneFile::View

      def render
        "Current time: #{time}"
      end
    end
  end
end

Controllerが@timeexposeで公開しているので、Viewはこのデータにtime変数経由でアクセスすることができます。

アプリケーションを再起動してください。ブラウザで同じページにアクセスするとCurrent time: 2014-09-11 23:18:30 +0900のように表示されるはずです。

まとめ

LotusでWebアプリを書くのはとても簡単だということがわかってもらえたでしょうか?

ええ、あなたの心の声が聞こえてきますよ。この例は単純すぎて全然実用的ではないじゃないか という声が、、、

確かにその通りです。ですが、それは次の記事で紹介させてください。本当はFull stackアプリケーションに作り方まで紹介する予定だったのですが この記事を書くのに予想より手間取ってしまいました。

次の記事は、Ruby LotusでフルスタックWeb Appを作ってみる みたな感じになる予定です。

Comments

« Creating Web Application with Ruby Lotus The Practices of Backbone.Marionette That I believe The Best »