More Related Content
Similar to View customize1.2.0の紹介 (20)
View customize1.2.0の紹介
- 2. 自己紹介
• Hirokazu Onozato (onozaty)
• https://twitter.com/onozaty
• https://github.com/onozaty
• http://www.enjoyxstudy.com/
• 株式会社ユニスティ所属
• エンジニア
• アプリケーション開発
• 個人でも作ったものを公開
• Redmine歴9年
- 4. View customize plugin
• Redmineの画面をカスタマイズするためのPlugin
• https://github.com/onozaty/redmine-view-customize
• 特定の画面に対して、JavaScript、CSSを埋め込む
機能を提供
- 6. できることの例
• プロジェクト毎にヘッダの色を変える
• チケット一覧を識別しやすいように装飾
• カスタムフィールドを連動させる(親の値に応じて、子を絞り込む)
• 担当者を入力補完で選択可能に
• チケット作成時にトラッカーに応じてデフォルト値を設定
• サイドバーを開閉式に
• 「全てのチケット一覧」リンクをヘッダに
• 進行中にもかかわらず担当者が未設定の場合に警告を表示
• ユーザ選択のカスタムフィールドで自分を選択する項目を先頭に追加
• プロジェクト一覧からの各プロジェクトへのリンク先を変更
- 13. Bottom of issue form (チケット入力欄の下)
• チケットの入力欄は、トラッカーやステータスを
変えた際に再構築されるが、再構築の際にも一緒
に再度挿入される
- 14. Bottom of issue form (チケット入力欄の下)
• 今まで面倒だった、入力欄が再構築された際に再
度実行するための考慮が不要に
// ステータス変更時などにDOMが差し替えられるので
// フォームの内容が書き変わるたびに表示切替
var _replaceIssueFormWith = replaceIssueFormWith;
replaceIssueFormWith = function(html){
_replaceIssueFormWith(html);
executeScript();
};
- 20. ViewCustomize = {
"context": {
"user": {
"id": 1,
"login": "admin",
"admin": true,
"firstname": "Redmine",
"lastname": "Admin",
"groups": [
{"id": 5, "name": "Group1"}
],
"apiKey": "3dd35b5ad8456d90d21ef882f7aea651d367a9d8",
"customFields": [
{"id": 1, "name": "[Custom field] Text", "value": "text"}
]
},
"project": {
"identifier": "project-a",
"name": "Project A",
"roles": [
{"id": 6, "name": "RoleX"}
]
},
"issue": {
"id": 1
}
}
}
ViewCustomize.context
- 22. 例: グループを使った適用ユーザ切り替え
$(function() {
var isEnabled = ViewCustomize.context.user.groups.some(function(group) {
return group.id == 5; // 有効にしたいグループのIDと比較
});
if (!isEnabled) {
// 無効の場合は処理終了
return;
}
// 以降実際に実行したいスクリプト
console.log('execute script.');
});
- 24. 例: カスタムフィールドを使った制御
$(function() {
var isEnabled = ViewCustomize.context.user.customFields
.some(function(customField) {
// チェックしたいカスタムフィールドのIDと値でチェック ("1"がtrue)
return customField.id == 1 && customField.value == '1';
});
if (!isEnabled) {
// 無効の場合は処理終了
return;
}
// 以降実際に実行したいスクリプト
console.log('execute script.');
});
- 27. 例: APIキーを使ってREST APIを呼び出し
$.ajax({
type: 'PUT‘,
url: '/issues/' + issueId + '.json‘,
headers: {
'X-Redmine-API-Key': ViewCustomize.context.user.apiKey
},
// 更新時はレスポンスのコンテンツが無く、jsonだとエラーとなるのでtextにしておく
dataType: 'text‘,
contentType: 'application/json‘,
data: JSON.stringify({
'issue': {
'parent_issue_id': '' // 親チケットIDをクリア
}
})
})
.done(function(data) {
// 成功したらリロード
location.reload();
})
.fail(function(data) {
alert('失敗しました');
});
- 28. 例: APIキーを使ってREST APIを呼び出し
• サンプルコード全体は下記にて
• 子チケット一覧に親子関係を外すアイコンを追加
https://github.com/onozaty/redmine-view-customize-
scripts/blob/master/delete_parentage_relationship_using_rest_api.js
• 複数の子チケットをまとめて作成するボタン追加
https://github.com/onozaty/redmine-view-customize-
scripts/blob/master/create_children_issues_using_rest_api.js
- 37. 今後の対応
• Redmine 4.0 対応
• 既に最新trunkでの動作検証済み
• 4.0 のリリース後に検証してリリース
• スクリプトサンプルの整理
• https://github.com/onozaty/redmine-view-customize-scripts
• 1.2.0 に対応したスクリプトを増やしていく予定
• 多言語リソース追加
• Pull request 募集中
- 38. View customizeの情報源 (1)
• GitHub - onozaty/redmine-view-customize
https://github.com/onozaty/redmine-view-customize
• View customize の提供サイト
• Star つけると、作者のやる気Up
• GitHub - onozaty/redmine-view-customize-scripts
https://github.com/onozaty/redmine-view-customize-scripts
• View customizeのサンプル集
• Blogなどで紹介したスクリプトは全てここに
• Twitter – onozaty https://twitter.com/onozaty
• 作者のTwitter
• 新しいサンプル書いたりしたらつぶやくので、ぜひフォローを
- 39. View customizeの情報源 (2)
• View customize pluginを使いこなす
https://www.slideshare.net/onozaty/view-customizeplugin-62005780
• 第10回 redmine.tokyo での発表資料
• 1.2.0の情報は無いが、現時点でView customizeの利用方法につい
て一番詳しく書かれたもの(だと思う)
他にもQiitaやredmine.tokyoでのカスタマイズ事例なども参
考に
• 「view customize」の検索結果 - Qiita
https://qiita.com/search?q=view+customize
• 過去講演一覧-プラグイン・カスタマイズ - redmine.tokyo
https://redmine.tokyo/projects/shinared/wiki/過去講演一覧-プラグイン・カスタマ
イズ