活動
2018/07/10から2018/08/08まで
2018/07/29
- 高徹 19:21 機能 #83: Redmine Glossaryプラグインをリファクタリングする
- h4. リファクタリングの試み（第1回）
結果：破綻
作業経緯：
まず、[#86]から着手することとし、モデルクラスのクラス名およびファイル名の変更、次にユニットテストを通すことを目標に修正を実施した。
データベースのテーブル名を変更するマイグレーションスクリプトを作成し、モデル内、ユニットテスト内、fixtureのクラス名を修正。
コントローラーの修正に入るところで、ルーティング設定、アクションの定義、などなどで修正範囲が拡大し破綻。
* リン... - 高徹 14:37 機能 #83: Redmine Glossaryプラグインをリファクタリングする
- リファクタリング作業の主幹となるブランチを作成した。
- 高徹 14:26 機能 #83 (進行中): Redmine Glossaryプラグインをリファクタリングする
- 高徹 01:39 機能 #88 (却下): acts_as_listをacts_as_positionedで置き換え
- acts_as_listはRedmine 4.0で除外されたので、Redmine 4.0対応[#81]では外部gemとしてacts_as_listを追加指定した。
Redmine 4.0本体には、lib/redmine/acts/positioned.rb ファイルでacts_as_positionedが提供される（？）ので、これを利用するように変更する。
Redmine本体のモデルクラスでもいくつかでacts_as_positionedを使用している。
@B...
2018/07/23
- 高徹 22:40 機能 #87 (却下): リソースルーティングの導入
- Railsで推奨されるルーティング設定はRESTfulなresources、resourceの設定で、それぞれデフォルトで生成されるアクションとHTTPメソッドの組み合わせが決まっている。
現行のGlossaryプラグインは、RESTfulなresources、resourceの設定とは異なるアクションとHTTPメソッドの組み合わせを使っているので、理解が難しくなっている面がある。
例えば、リソース（モデル）を生成するときは、resourcesで定義した場合、
... - 高徹 21:58 機能 #86 (却下): テーブル名（モデル名）の衝突可能性低減
- Redmineのデータベースは本体・プラグインを含めフラットなため、名前の付け方に注意をしないとRedmine本体のバージョンアップや別なプラグインの導入でデータベースのテーブル名が衝突することがあります。
そこで、プラグインにちなむテーブルには接頭辞glossaryを付けることとします。
|_. No. |_. 現行のテーブル名|_. リファクタリング後のテーブル名|
|=. 1 |terms |glossary_terms... - 高徹 06:56 機能 #81: Redmine 4.0でglossary pluginを動くようにする
- glossary_controller のテストで nilに対するempty?呼び出しで例外発生
* fixtures/terms.yml
2018/07/22
- 高徹 18:15 機能 #84: 不要ファイルの削除
- app/views/glossary_styles/edit.html.erb
これは中身がダミーなので不要ファイルでは？ - 高徹 05:15 機能 #84: 不要ファイルの削除
- app/helpers/term_categories_helper.rb はモジュールの枠だけ定義されているので不要
- 高徹 18:13 機能 #81: Redmine 4.0でglossary pluginを動くようにする
- glossary_styles_controller#edit のロジックが複雑な件について
|/2. anonymous |params[:clear]指定あり |session[:glossary_style] = nil |
|params[:clear]指定なし |session[:glossasy_style] = params[:glossary_style] |
glossary_styles_control... - 高徹 08:32 機能 #81: Redmine 4.0でglossary pluginを動くようにする
- 用意されているテスト・フィクスチャの内容確認
* term_categories.yml
|_. id |_. name|_. project_id|_. position|
| 1 | one | 1 | 1 |
| 2 | two | 1 | 1 |
* terms.yml
|_. id |_. name |_. project_id|_. category_id|
| 1 | term one | 1 | NULL |
| 2 | ... - 高徹 05:09 機能 #81: Redmine 4.0でglossary pluginを動くようにする
- コントローラーのテスト（ActiveController::TestCase継承で）
まず、一番単純なモデルであるカテゴリのコントローラーのテストを行う。
indexアクションのテストが実行できるまでの流れをはてな日記に記載。
http://d.hatena.ne.jp/torutk/20180721/p1
- 高徹 15:29 機能 #85 (却下): コントローラーのbefore_actionでプロジェクトを取得する際はRedmineのAPIを呼ぶ
- コントローラーのbefore_actionでプロジェクトを取得するロジックを、各コントローラーのprivateメソッドに同じコードを記述するのではなく、Redmineで用意するメソッドを呼ぶ。
例）term_categories_controller.rb
2018/07/17
- 高徹 23:33 機能 #84: 不要ファイルの削除
- test/functionals/ にある次の２つのファイル
* glossary_styles_controller_test.rb
* glossray_styles_controller_test.rb
中身はクラス名（ファイル名に基づくため）だけが異なる。後者はスペルミスなので削除すべしと推定。
同ディレクトリにある次のファイル
* term_queries_controller_test.rb
TermQueryというモデルはな...
2018/07/16
- 高徹 22:58 機能 #81: Redmine 4.0でglossary pluginを動くようにする
- 用語のユニットテスト実施メモ
Termのカラムには、created_onとupdated_onがある。
用語を新規作成すると、作成時点での日時が両方のカラムに入る。
用語を編集すると、編集時点の日時がupdated_onに入る。
よって、terms.ymlの有効な定義とするには、created_onとupdated_onの双方に日時の指定要。
- 高徹 21:46 機能 #81: Redmine 4.0でglossary pluginを動くようにする
- 用語のユニットテスト実施メモ
Termクラスではvalidationを次のように指定している。 - 高徹 17:12 機能 #81: Redmine 4.0でglossary pluginを動くようにする
- ユニットテスト（Model）を実施して問題発見
* app/models/term_category.rb - 高徹 09:24 機能 #81: Redmine 4.0でglossary pluginを動くようにする
- テスト実行時に次の警告メッセージが表示されます。
- 高徹 17:10 機能 #84 (進行中): 不要ファイルの削除
- test/fixtures/にある次の2つのファイル
* glossary_styles.yml
* view_styles.yml
この2つのファイルは中身が同一。テストファイルから参照されているのはglossary_styles.ymlなので、view_styles.ymlは不要ファイルと推定。
- 高徹 16:44 機能 #84 (却下): 不要ファイルの削除
- 不要なファイルがあれば削除する。
調査結果、次のファイルは不要と思われる。
* app/views/glossary_styles
** edit.html.erb
* app/helpers
** term_categories_helper.rb
* test/fixtures/
** view_styles.yml
* test/functionals/
** glossray_styles_controller_test.rb
** ... - 高徹 09:35 機能 #83 (却下): Redmine Glossaryプラグインをリファクタリングする
- Redminge GlossaryプラグインのRedmine 4.0（Rails 5.2）対応作業を通じて、今後のメインテナンスを良好にするにはリファクタリングが必要と強く感じた。
* Railsのリソース指向な構造に合わせる
** コントローラーのアクションがルーティングでresources/resourceを使うのに馴染まない
** newやeditのアクションの遷移が独特（new→create、edit→updateとなっていない）
* 命名を一貫させ...
2018/07/14
- 高徹 12:44 機能 #81: Redmine 4.0でglossary pluginを動くようにする
- Redmine 4以降で動作するプラグインを作る場合、init.rbのrequires_redmineにバージョンを指定することになるが、trunkのredmineは3.4.6のままなので、テスト時にredmineのバージョンを4.0.0に修正したい。
バージョンを定義するファイルを探したところ
* lib/redmine/version.rb にあり