Commit: 490139b9ffa85c0e7e262b695ee57f8f211f2cc6 - RedmineVotePlugin (git)

Redmine Vote Plugin

Commit MetaInfo

• Révision: 490139b9ffa85c0e7e262b695ee57f8f211f2cc6 (tree)
• l'heure: 2012-07-15 19:59:52
• Auteur: root <root@ip-1...>
• Commiter: root

Message de Log

PluginTutorial

Change Summary

• add: doc/PluginTutorial.txt

Modification

--- /dev/null
+++ b/doc/PluginTutorial.txt
@@ -0,0 +1,295 @@
+プラグインチュートリアル
+日本語部分翻訳
+
+2012年7月15日　福島英俊
+
+http://www.redmine.org/projects/redmine/wiki/Plugin_Tutorial
+
+Redmine 2.x用のチュートリアルです。
+
+新しいプラグインの作成
+========================
+
+RAILS_ENV環境変数を設定します。
+
+$ export RAILS_ENV="production"
+
+Redmine plugin generatorを使って新しいプラグインを作成します。
+
+ruby script/rails generate redmine_plugin <plugin_name>
+
+Redmineのディレクトリに移動し、下記のコマンドを実行します。
+
+$ ruby script/rails generate redmine_plugin Polls
+      create  plugins/polls/app
+      create  plugins/polls/app/controllers
+      create  plugins/polls/app/helpers
+      create  plugins/polls/app/models
+      create  plugins/polls/app/views
+      create  plugins/polls/db/migrate
+      create  plugins/polls/lib/tasks
+      create  plugins/polls/assets/images
+      create  plugins/polls/assets/javascripts
+      create  plugins/polls/assets/stylesheets
+      create  plugins/polls/config/locales
+      create  plugins/polls/test
+      create  plugins/polls/README.rdoc
+      create  plugins/polls/init.rb
+      create  plugins/polls/config/routes.rb
+      create  plugins/polls/config/locales/en.yml
+      create  plugins/polls/test/test_helper.rb
+
+plugins/pollsディレクトリに、プラグインの構造がつくられます。plugins/polls/init.rbを編集します。
+
+Redmine::Plugin.register :polls do
+  name 'Polls plugin'
+  author 'John Smith'
+  description 'A plugin for managing polls'
+  version '0.0.1'
+end
+
+アプリケーションを再起動します。ブラウザで、http://localhost:3000/admin/pluginsを開きます。
+
+モデルの作成
+==============
+
+モデルを作成します。
+
+ruby script/rails generate redmine_plugin_model <plugin_name> <model_name> [field[:type][:index] field[:type][:index] ...]
+
+これは、Pollモデルと、マイグレーションファイル、001_create_polls.rbを生成します。
+
+class CreatePolls < ActiveRecord::Migration
+  def change
+    create_table :polls do |t|
+      t.string :question
+      t.integer :yes, :default => 0
+      t.integer :no, :default => 0
+    end
+  end
+end
+
+あなたはマイグレーションファイルを修正できます。それから、下記のコマンドでデータベスを変更します。
+
+$ rake redmine:plugins:migrate
+
+Migrating polls (Polls plugin)...
+==  CreatePolls: migrating ====================================================
+-- create_table(:polls)
+   -> 0.0410s
+==  CreatePolls: migrated (0.0420s) ===========================================
+
+plugins/polls/app/models/poll.rbファイルを編集します。コントローラーから呼び出される#voteメソッドを追加します。
+
+class Poll < ActiveRecord::Base
+  def vote(answer)
+    increment(answer == 'yes' ? :yes : :no)
+  end
+end
+
+コントローラーの作成
+======================
+
+プラグインのコントローラーを作成します。
+
+ruby script/rails generate redmine_plugin_controller <plugin_name> <controller_name> [<actions>]
+
+$ ruby script/rails generate redmine_plugin_controller Polls polls index vote
+      create  plugins/polls/app/controllers/polls_controller.rb
+      create  plugins/polls/app/helpers/polls_helper.rb
+      create  plugins/polls/test/functional/polls_controller_test.rb
+      create  plugins/polls/app/views/polls/index.html.erb
+      create  plugins/polls/app/views/polls/vote.html.erb
+
+2つのアクシション（#index と #vote）を持つPollsControllerがつくられます。
+2つのアクションを実装するためにplugins/polls/app/controllers/polls_controller.rbを編集します。
+
+class PollsController < ApplicationController
+  unloadable
+
+  def index
+    @polls = Poll.all
+  end
+
+  def vote
+    poll = Poll.find(params[:id])
+    poll.vote(params[:answer])
+    if poll.save
+      flash[:notice] = 'Vote saved.'
+    end
+    redirect_to :action => 'index'
+  end
+end
+
+ポールを表示するplugins/polls/app/views/polls/index.html.erbを編集します。
+
+<h2>Polls</h2>
+
+<% @polls.each do |poll| %>
+  <p>
+  <%= poll.question %>?
+  <%= link_to 'Yes', { :action => 'vote', :id => poll[:id], :answer => 'yes' }, :method => :post %> (<%= poll.yes %>) /
+  <%= link_to 'No', { :action => 'vote', :id => poll[:id], :answer => 'no' }, :method => :post %> (<%= poll.no %>)
+  </p>
+<% end %>
+
+ルーティングの追加
+====================
+
+Redmineはデフォルトのワイルドカードルート(':controller/:action/:id')を提供しません。プラグインは、固有のconfig/routes.rbファイルで、ルーティングを明示しなけければなりません。そこで、plugins/polls/config/routes.rbを編集し、2つのアクションのための2つのルートを追加します。
+
+get 'polls', :to => 'polls#index'
+post 'post/:id/vote', :to => 'polls#vote'
+
+Railsのルーティングについてのより詳しい情報は、下記ページを見てください。
+
+http://guides.rubyonrails.org/routing.html
+
+アプリケーションを再起動し、ブラウザーでhttp://localhost:3000/pollsを開きます。２つのポールが表示され、投票することが可能です。
+
+国際化
+========
+
+翻訳ファイルは、config/localesに保存します。例：plugins/polls/config/locales/
+
+メニューの拡張
+================
+
+これで、コントローラーは動作しますが、ユーザーはURLを知らなければなりません。Redmine plugin APIを使って、標準メニューを拡張することができます。それでは、アプリケーションメニューに、新しい項目を追加しましょう。
+
+アプリケーションメニューの拡張
+--------------------------------
+
+plugin registration blockの最後に下記の行を追加するためにプラグインディレクトリのrootにあるplugins/polls/init.rbを編集します。
+
+Redmine::Plugin.register :redmine_polls do
+  [...]
+
+  menu :application_menu, :polls, { :controller => 'polls', :action => 'index' }, :caption => 'Polls'
+end
+
+文法：
+
+menu(menu_name, item_name, url, options={})
+
+下記の5つのメニューを拡張可能です。
+
+    :top_menu - the top left menu
+    :account_menu - the top right menu with sign in/sign out links
+    :application_menu - the main menu displayed when the user is not inside a project
+    :project_menu - the main menu displayed when the user is inside a project
+    :admin_menu - the menu displayed on the Administration page (can only insert after Settings, before Plugins)
+
+オプション：
+
+    :param - the parameter key that is used for the project id (default is :id)
+    :if - a Proc that is called before rendering the item, the item is displayed only if it returns true
+    :caption - the menu caption that can be:
+        a localized string Symbol
+        a String
+        a Proc that can take the project as argument
+
+    :before, :after - specify where the menu item should be inserted (eg. :after => :activity)
+    :first, :last - if set to true, the item will stay at the beginning/end of the menu (eg. :last => true)
+    :html - a hash of html options that are passed to link_to when rendering the menu item
+
+プロジェクトメニューの拡張
+----------------------------
+
+（飛ばし）
+
+新しい権限の追加
+==================
+
+今のところ、だれでも調査に投票可能です。権限の定義を変更することによって、設定可能にしましょう。私たちは、2つのプロジェクトベースの権限を定義するつもりです。1つは、投票結果を見ること、もう1つは投票することです。
+
+権限定義を変更するためにplugins/polls/init.rbを編集します。
+
+permission :view_polls, :polls => :index
+permission :vote_polls, :polls => :vote
+
+アプリケーションを再起動し、http://localhost:3000/roles/reportを開きます。
+
+あなたは今、これらの権限を既にある役割に追加することができます。
+
+もちろん、カレントユーザーの権限によって、アクションが実際に保護されるようにPollsController にいくつかのコードを追加する必要があります。
+
+#indexアクションがどのようになるか示します。
+
+class PollsController < ApplicationController
+  unloadable
+
+  before_filter :find_project, :authorize, :only => :index
+
+  [...]
+
+  def index
+    @polls = Poll.find(:all) # @project.polls
+  end
+
+  [...]
+
+  private
+
+  def find_project
+    # @project variable must be set before calling the authorize filter
+    @project = Project.find(params[:project_id])
+  end
+end
+
+Retrieving the current project before the #vote action could be done using a similar way.
+After this, viewing and voting polls will be only available to admin users or users that have the appropriate role on the project.
+
+If you want to display the symbols of your permissions in a multilangual way, you need to add the necessary text labels in a language file.
+Simply create an *.yml (eg. en.yml) file in plugins/polls/config/locales and fill it with labels like this:
+
+en:
+  permission_view_polls: View Polls
+  permission_vote_polls: Vote Polls
+
+In this example the created file is known as en.yml, but all other supported language files are also possible too.
+As you can see on the example above, the labels consists of the permission symbols :view_polls and :vote_polls with an additional permission_ added at the front.
+
+Restart your application and point the permission section.
+
+プロジェクトモジュールの作成
+==============================
+
+プラグイン表示の改善
+======================
+
+CSSの追加
+-----------
+
+ページタイトルの設定
+----------------------
+
+フックの使用
+==============
+
+ビューでのフック
+-----------------
+
+コントローラーでのフック
+--------------------------
+
+プラグインの設定の作成
+========================
+
+TODO
+
+プラグインのテスト
+====================
+
+以上
+
+
+
+
+
+
+
+
+
+
+