Download as PDF, PPTX
![メニューの追加はinit.rbで
Redmine::Plugin.register :redmine_demo do
[...]
!
# プロジェクトメニューの定義
menu :project_menu, :demo, { :controller => 'demo',
:action => 'sample_action' }, :caption => :demo
end](https://image.slidesharecdn.com/redmine-140712014208-phpapp02/75/Redmine-28-2048.jpg)
![twitterマクロ(from Wiki Extensions)
Redmine::WikiFormatting::Macros.register do
# マクロの説明
desc "Creates link to twitter account page.nn" +
" !{{twitter(user_name)}}n”
# マクロの定義
macro :twitter do |obj, args|
return nil if args.length < 1 #引数が無かったら何もしない
user_name = args[0].strip # 第一引数をuser_nameに代入
# twitterへのリンクを作成
link_to(h("@#{user_name}"), "http://www.twitter.com/#{user_name}").html_safe
end
end](https://image.slidesharecdn.com/redmine-140712014208-phpapp02/75/Redmine-32-2048.jpg)
![Controller Hooksの書き方
class DemoHookListener < Redmine::Hook::Listener
!
def controller_issues_new_after_save(context = { })
project = context[:project]
request = context[:request]
!
#ここに処理を書く
end
end
• Listenerを継承したクラスを作成
• Hookと同じ名前のメソッドを定義](https://image.slidesharecdn.com/redmine-140712014208-phpapp02/75/Redmine-40-2048.jpg)
Redmineをプラグインで拡張しよう
- 1.
- 2. 飯田治行 静岡県在住 Redmineのプラグイン開発多数 Code Review, WikiExtensions, Logs, ThemeChanger… r-labs管理者 shinagawa.redmine立ち上げメンバ
- 3. 宣伝 • 日経BPムック • ￥1944 •「必ず役立つ厳選プラ グイン２０」を執筆
- 4.
- 5.
- 6. プラグインの 作り方 How to makeplugin
- 7.
- 8. 参考書(Web) • Redmine本家のDeveloperガイド(英語) • http://www.redmine.org/projects/ redmine/wiki/Developer_Guide •r-labsのプラグイン開発ガイド(日本語) • http://www.r-labs.org/projects/r-labs/ wiki/プラグイン開発ガイド
- 9.
- 10.
- 11. 用意するもの • 開発マシン • 開発ツール •Ruby • Redmine
- 12.
- 13. Ruby Windows • RubyInstaller forWindows + DevKit +pikがお勧め • http://rubyinstaller.org • 面倒ならBitNamiでRedmineごとインストール • https://bitnami.com/stack/redmine Mac, Linux • rbenvで複数バージョンのrubyを管理
- 14.
- 15.
- 16.
- 17. Plugin Generator $ $ruby script/rails generate redmine_plugin redmine_demo create plugins/redmine_demo/app create plugins/redmine_demo/app/controllers create plugins/redmine_demo/app/helpers create plugins/redmine_demo/app/models create plugins/redmine_demo/app/views create plugins/redmine_demo/db/migrate create plugins/redmine_demo/lib/tasks create plugins/redmine_demo/assets/images create plugins/redmine_demo/assets/javascripts create plugins/redmine_demo/assets/stylesheets create plugins/redmine_demo/config/locales create plugins/redmine_demo/test create plugins/redmine_demo/test/fixtures create plugins/redmine_demo/test/unit create plugins/redmine_demo/test/functional create plugins/redmine_demo/test/integration create plugins/redmine_demo/README.rdoc create plugins/redmine_demo/init.rb create plugins/redmine_demo/config/routes.rb create plugins/redmine_demo/config/locales/en.yml create plugins/redmine_demo/test/test_helper.rb プラグインのひな形を作成するコマンド Redmineインストールディレクトリ直下で実行する
- 18.
- 19. modelとcontrollerもスクリ プトで生成 $ ruby script/railsgenerate redmine_plugin_model redmine_demo sample_models field1:string field2:integer create plugins/redmine_demo/app/models/sample_models.rb create plugins/redmine_demo/test/unit/sample_models_test.rb create plugins/redmine_demo/db/migrate/001_create_sample_models.rb $ ruby script/rails generate redmine_plugin_controller redmine_demo Demo sample_action create plugins/redmine_demo/app/controllers/Demo_controller.rb create plugins/redmine_demo/app/helpers/Demo_helper.rb create plugins/redmine_demo/test/functional/Demo_controller_test.rb create plugins/redmine_demo/app/views/Demo/sample_action.html.erb テストコードのひな形も作成される
- 20. init.rb Redmine::Plugin.register :redmine_demo do name'Redmine Demo plugin' author 'Author name' description 'This is a plugin for Redmine' version '0.0.1' url 'http://example.com/path/to/plugin' author_url 'http://example.com/about' end プラグインの情報を定義する場所 Plugin Generatorが出力した内容を適宜書き 換える。 特に公開する場合は重要な情報となる。
- 21.
- 22.
- 23.
- 24. • メニュー追加 • Wikiマクロ • Hook
- 25.
- 26. メニューの種類 • TOPメニュー • アプリケーションメニュー •プロジェクトメニュー • アカウントメニュー • アドミンメニュー
- 27.
- 28. メニューの追加はinit.rbで Redmine::Plugin.register :redmine_demo do [...] ! #プロジェクトメニューの定義 menu :project_menu, :demo, { :controller => 'demo', :action => 'sample_action' }, :caption => :demo end
- 29.
- 30.
- 31. wikiマクロ • wikiの文法を拡張できる • 一つぐらいならinit.rbに定義する •たくさん作るならlibの下に定義を作ってinit.rb でロードする • Wiki Extensionsにはたくさんのwikiマクロが あるので参考にしてください。
- 32. twitterマクロ(from Wiki Extensions) Redmine::WikiFormatting::Macros.registerdo # マクロの説明 desc "Creates link to twitter account page.nn" + " !{{twitter(user_name)}}n” # マクロの定義 macro :twitter do |obj, args| return nil if args.length < 1 #引数が無かったら何もしない user_name = args[0].strip # 第一引数をuser_nameに代入 # twitterへのリンクを作成 link_to(h("@#{user_name}"), "http://www.twitter.com/#{user_name}").html_safe end end
- 33.
- 34.
- 35.
- 36. Hookの種類 • Controller Hooks •View Hooks • Model Hooks • Helper Hooks http://www.redmine.org/projects/redmine/ wiki/Hooks_List
- 37. View Hooks • 一番よく使うHook •Remine本体のページに任意のhtmlコードを 挿入する
- 38. View Hooksの書き方 # リスナークラスを定義。init.rbで読み込ませる classDemoHookViewListener < Redmine::Hook::ViewListener render_on :view_issues_new_top, :partial => "Demo/issue_note" end • ViewListenerを継承したクラスを作成 • render_onでHookと読み込むerbファイルを指定
- 39.
- 40. Controller Hooksの書き方 class DemoHookListener< Redmine::Hook::Listener ! def controller_issues_new_after_save(context = { }) project = context[:project] request = context[:request] ! #ここに処理を書く end end • Listenerを継承したクラスを作成 • Hookと同じ名前のメソッドを定義
- 41.
- 42.
- 43.
- 44. JavaScriptでRedmineが吐く HTMLを動的に書き換え • Redmineの既存のページを変更したい場合に使 う。 • JQueryでDOMをゴリゴリ編集するロジックを ViewHooksで挿入する。 •もはや何でもアリ。見た目をどうとでも変えられる • RedmineのバージョンアップによってDOMの構造 が変わると破綻するので注意
- 45.
- 46.
- 47.
- 48. alias_method_chain • Redmineの既存の処理を書き換える def save_with_demo #置き換えたい処理の内容 end ! alias_method_chain :save, :demo def save #処理 end
- 49. しくみを詳しく知りたければ • Rubyの魔法が判る本 • PaoloPerrotta 著 • 角征典 訳 • 定価：3,024円
- 50.
- 51.
- 52.
- 53.
- 54.
- 55.
- 56.
- 57. 宣伝しよう • 公開したら宣伝 • ブログ、SNS等 ! •もれなくあきぴーさんが拾って「プログラ マーの思索」で紹介されるシステム。
- 58.
- 59.
- 60. • 開発ツールのお勧めはRubyMine • Plugingeneratorで雛形作成 • 他のプラグインを真似する • 作ったら公開しよう • 公開したら宣伝しよう これであなたもプラグイン作者！！