api

api

ここは質問票の管理作成などを行うための API を提供するバックエンド部分のコードを管理します。

開発には以下のものを用います。他の依存するライブラリは Gemfile をみてください。

• Ruby 2.3.0
• Rails 5.0.0 beta4

なお特に断らない場合、コマンドなどは Mac OS X での実行を前提としています。 Ubuntu などの Linux でも同様に動作することが期待されますが、Windows は動作しないことが多くあります。

Windows での開発はまず、 VirtualBox などの仮想マシン上に Ubuntu Server をインストールした上で、 その Ubuntu 上で開発することをお勧めします。

ディレクトリレイアウト

Rails の標準的なディレクトリレイアウトに準じています。

Gemfile
Gemfile.lock
README.md
Rakefile
app
bin
config
config.ru
db
lib
log
public
test
tmp
vendor

開発環境の準備

既存の Ruby や Rails とぶつからないようにするために RVM を利用して、 開発用の環境を用意します。その後、Rails のインストールを行います。

RVM のインストール

ターミナルで、以下のコマンドを実行してインストールを行います。

$ gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3
$ curl -sSL https://get.rvm.io | bash -s stable

1 つ目のコマンドは、rvm.io で利用している公開鍵のインポートを行っています。

2 つ目のコマンドで、インストール用のシェルスクリプトをダウンロードし、それを実行しています。

rvm help とターミナルで入力し、以下のようなヘルプが表示されればインストールは完了です。

$ rvm help
= rvm

* https://rvm.io/
* https://github.com/rvm/rvm/

== DESCRIPTION:

RVM is the Ruby enVironment Manager (rvm).

開発用の Ruby 環境の用意

RVM を利用すると、利用する Ruby のバージョンや、インストールされたライブラリのセットなどを切り替えられます。

まず install コマンドと gemset create コマンドで、開発用の環境を用意します。 次に use コマンドで開発用の環境へとスイッチします。

$ rvm install 2.3.0
$ rvm gemset create lod2016s
$ rvm use 2.3.0@lod2016s

Bundler のインストール

Bundler は Ruby のライブラリ管理ツールです。これを利用すれば、Gemfile / Gemfile.lock に記載されている情報をもとに、 必要なライブラリをインストールできます。

標準ではインストールされていないので、以下のコマンドを実行してインストールします。

$ gem install bundler

ライブラリのインストール

bundle コマンドを利用して、利用するライブラリをインストールします。

$ bundle install

インストール後、以下のコマンドを実行してバージョン番号が正しく表示されればインストール完了です。

$ ./bin/rails -v
Rails 5.0.0.beta4

開発の流れ

1. issue を立てる
2. ブランチを作成する
3. テストコードを書く
4. 機能を実装
5. pull request の送信

issue を立てる

やることを、できるだけ明確に書きましょう。

バグ修正の場合は、以下のことを書き、その後修正を行いましょう。

• バグの再現方法
• 望ましい振る舞い
• 実際の振る舞い

新機能の追加の場合は、以下のことを書くと良いでしょう。

• 追加、もしくは修正する end point
• 入力として与えるパラメータのリストと、その意味。可能であればサンプルも
• 望ましい結果
• 出力されるレスポンスの属性一覧と、その意味。可能であればサンプルも

ブランチを作成する

好きな名前でブランチを作成しましょう。思いつかない場合は issue + issue 番号で作るとよいでしょう (e.g. isseu 123 の実装をするなら issue123）。

テストコードを書いて実装する

issue に書いた仕様をより正確に記述するために、テストコードを書きましょう。

その後、テストに成功するように実装しましょう。

pull request を作成する

実装が終了し、テストに通ったら、pull request を作成します。 GitHub Desktop を使うと、cmd + r で pull request が作られます。

pull request を送るときは以下のことに注意しましょう：

• 作成前に upstream の master ブランチ内容を pull する
• 元の issue がわかるように、コメントに issue 番号を入れておく

開発の心がけ

• 気がついたことがあれば、どんなに小さいことでも共有しましょう
  • 書かないと忘れます
  • issue にする、design にドキュメントを追加する、slack に書く、などなど、共有の仕方はいろいろあります
  • ちょっとしたメモを残しておくことが、報告書や論文を書くときに役立ちます
• コミットはこまめに
  • データは壊れます。忙しいときに限って
  • コミットと、push は自分の身を助けます
  • バージョン管理していないデータは、バックアップをできる限りとりましょう
• 迷ったらつくる
  • 必要か、不必要かはっきりしない場合は作りましょう
  • つくればはっきりすることが多くあります
  • 他の人の刺激になるかもしれません
• 名前は的確に
  • キラキラした名前はあとで後悔します
  • とはいえ悩みすぎても仕方がないので、とりあえずつけることも大切です
  • 悩んだら他の人に相談しましょう