Riot.js Observable Rails 4 / 5 「完了したTodoをチェック出来るようにする」
はじめに
Riot.js Redux Railsシリーズで作ったTodoアプリのRedux部分をObservableを使って書いた。 (Observerパターンとか全然わかってない。ReduxをObservableで置き換える意味があるかもわからない。なんとなく似ていると思ったのでやってみた。)
Riot.js Redux Railsで作ったTodoアプリと全く同じものを作成するのでコードが大分重なっている(Redux部分をObservableにしたのと、それに伴う変更以外全く同じ)が、今回の一連の記事だけ読んでも出来るように省略はしない。
環境構築
Todo Appの作成
- Riot.js Observable Rails 2 / 5 「Todoリストを表示する」
- Riot.js Observable Rails 3 / 5 「新たなTodoを追加出来るようにする」
- Riot.js Observable Rails 4 / 5 「完了したTodoをチェック出来るようにする」
- Riot.js Observable Rails 5 / 5 「チェックしてあるタスクを削除出来るようにする」
最終的に完成したTodo App
https://github.com/atfeo/Riot_Observable_Rails
参考
checkbox
チェックボックスを作成。
// ./client/src/tags/task-list.tag <task-list> <ul> <li each={task in this.opts.tasks}> <label class={completed: task.isComplete}> <input type="checkbox" id={task.id} checked={task.isComplete} onchange={handleCheck} > {task.name} </label> </li> </ul> <script> handleCheck(e) { this.opts.handlecheck(e.target.id, e.target.checked) } </script> </task-list>
todo-app.tagにマウントされているtask-listタグに
// ./client/src/tags/todo-app.tag <task-list tasks={this.state.tasks} handlecheck={handleTaskCompletionChange} > </task-list> handleTaskCompletionChange(id, isComplete) { actions.toggleComplete(store, id, isComplete) }
サーバーにチェックの状態を送るメソッドなどをactions.jsに追加。
// ./client/src/actions.js module.exports = { loadTasks, addTask, textExists, // 追加 toggleComplete, }; function toggleComplete(store, id, isComplete) { $.ajax({ url: `/api/tasks/${id}`, type: 'PATCH', dataType: 'json', data: { isComplete }, success: (res) => { completeChanged(store, res.id, res.isComplete); }, error: (xhr, status, err) => { console.log(`/api/tasks/${id}`, status, err.toString()); }, }); } function completeChanged(store, id, isComplete) { store.trigger('TASK_COMPLETION_CHANGED', { data: { id, isComplete } }); }
イベントがトリガーされた時の処理をindex.jsに追加。
// ./client/src/index.js store.on('TASK_COMPLETION_CHANGED', (action) => { const taskIndex = store.getState().tasks.findIndex((task) => { return task.id == action.data.id; }); const newTasks = [ ...store.getState().tasks.slice(0, taskIndex), Object.assign({}, store.getState().tasks[taskIndex], { isComplete: action.data.isComplete }), ...store.getState().tasks.slice(taskIndex + 1), ]; store.setState({ tasks: newTasks }); });
チェックした時のスタイルを追加。
/* ./app/assets/stylesheets/application.css */ .completed { text-decoration: line-through; color: #ccc; } label { cursor: pointer; }
ここまででviewは完成。
Rails
Migration
サーバー側でisCompleteを扱えるようにする。 ターミナルでctrl-cでforemanを終了させてから
$ rails g migration addIsCompleteToTasks isComplete:boolean
できたマイグレーションファイルに , default: false を追加し
# ./db/migrate/日付_add_is_complete_to_tasks.rb class AddIsCompleteToTasks < ActiveRecord::Migration[5.0] def change add_column :tasks, :isComplete, :boolean, default: false end end
マイグレーションを反映させる。
$ rails db:migrate
これでデータベースのテーブルにisCompleteカラムが追加された。
Controller
次にcontrollerでupdateについての処理を書く。
# ./app/controllers/api/tasks_controller.rb def update @task = Task.find(params[:id]) @task.assign_attributes(task_params) if @task.save render :show, status: :ok else head :unprocessable_entity end end private # isCompleteの追加 def task_params params.permit(:name, :isComplete) end
View(JSON)
JSONがisCompleteも返すようにindex.json.jbuilderにisCompleteを追加。
# ./app/views/api/tasks/index.json.jbuilder json.tasks(@tasks) { |t| json.extract! t, :id, :name, :isComplete }
同じく、JSONがisCompleteを返すようにshow.json.jbuilderにisCompleteを追加。
# ./app/views/api/tasks/show.json.jbuilder json.extract! @task, :id, :name, :isComplete
再びターミナルで
$ foreman start
でサーバーを開始。
ブラウザでlocalhost:5000を更新してチェックしてもエラーにならないことを確認。
また更新後チェックの状態が維持されることも確認。
サーバーエラー時の処理
チェックの状態が変更された時にサーバー側でエラーが起きると、サーバー側とブラウザ側で矛盾が生じる(checkされているのにisCompleteがfalseまたはその逆)。それを防ぐために、エラー時にチェックを反転させる処理をactions.jsに書く。
// ./client/src/actions.js function toggleComplete(store, id, isComplete) { $.ajax({ url: `/api/tasks/${id}`, type: 'PATCH', dataType: 'json', data: { isComplete }, success: (res) => { completeChanged(store, res.id, res.isComplete); }, error: (xhr, status, err) => { // 追加 completeChanged(store, id, !isComplete); console.log(`/api/tasks/${id}`, status, err.toString()); }, }); }; }
またこの時エラーが起こったことがわかりやすいように、エラーメッセージが表示されるようにする。
まずerror-messageタグを作成。
// ./client/src/tags/error-message.tag <error-message> <div show={this.opts.iserror}> {this.opts.message} </div> <style scoped> :scope div { margin-top: 5px; padding-left: 10px; color: white; background-color: red; } </style> </error-message>
todo-app.tagでerror-messageタグをマウントさせる。
// ./client/src/tags/todo-app.tag </task-form> <error-message message={"Text Message"} iserror={true} > </error-message> <loading-indicator
タグを使うためにindex.jsで読み込む。
// ./client/src/index.js import './tags/error-message.tag';
ブラウザでlocalhost:5000を更新して Text Message というメッセージが表示されていることを確認。
エラーメッセージが表示できるようになったので、エラーが起こった時にだけ表示されるようにする。
showErrorメソッドを作成し、サーバーのエラー時の処理に追加。
// ./client/src/action.js error: (xhr, status, err) => { // 追加 showError(store, 'API Error'); completeChanged(store, id, !isComplete); console.log(`/api/tasks/${id}`, status, err.toString()); } function showError(store, message) { store.trigger('SHOW_ERROR', { data: message }); }
イベントがトリガーされたときの処理を追加。
// ./client/src/index.js store.on('SHOW_ERROR',(action) => { store.setState({ isError: true, errorMessage: action.data }); }
先程のように固定ではなく、stateの変化に対応できるよう書き換え。
<!-- ./client/src/tags/todo-app.tag --> <error-message message={this.state.errorMessage} iserror={this.state.isError} > </error-message>
ここでわざとサーバーのurlを間違えたものにしておき、エラーが起こるようにしておく。
ブラウザでlocalhost:5000を更新する。チェックの状態を変更するとエラーが起こりエラーメッセージが表示されること、チェックが反転されることを確認。
次にエラーメッセージが2秒後消えるようにする。
// ./client/src/action.js error: (xhr, status, err) => { // 書き換え tempErrorMessage(store, 'API Error'); completeChanged(store, id, !isComplete); console.log(`/api/tasks/${id}`, status, err.toString()); }, // 追加 function hideError(store) { store.trigger('HIDE_ERROR'); } function tempErrorMessage(store, message) { showError(store, message); setTimeout(() => { hideError(store); }, 2000); }
新たなイベントの処理を追加。
// ./client/src/index.js store.on('HIDE_ERROR', () => { store.setState({ isError: false, errorMessage: '' }); });
ブラウザでlocalhost:5000を更新する。チェックの状態を変更するとエラーが起こりエラーメッセージが表示され2秒後に消えること、チェックが反転されることを確認。
一応loadTasks()やaddTask()などサーバーと通信している他のメソッドにも
error: (xhr, status, err) => { toggleLoading(store, false); // 追加 tempErrorMessage(store, 'API Error');
このように追加して、エラーメッセージが表示されるようにしておく。
次回はTodoを削除できるようにする。