From de64c4c45656b0a933c31862f084ac7b70079e3d Mon Sep 17 00:00:00 2001 From: Jean-Philippe Lang Date: Fri, 5 Sep 2008 11:04:54 +0000 Subject: [PATCH] Sync with trunk r1786. git-svn-id: http://redmine.rubyforge.org/svn/branches/work@1787 e93f8b46-1217-0410-a6f0-8f06a7374b81 --- groups/app/controllers/issues_controller.rb | 1 + groups/app/helpers/issues_helper.rb | 3 +- groups/app/models/repository.rb | 1 + groups/app/views/issues/_form.rhtml | 2 + groups/app/views/issues/bulk_edit.rhtml | 1 + groups/app/views/issues/show.rhtml | 1 + groups/app/views/layouts/base.rhtml | 7 +- .../views/projects/settings/_members.rhtml | 2 + groups/app/views/versions/show.rhtml | 2 + groups/lib/generators/redmine_plugin/USAGE | 18 +++ .../redmine_plugin_generator.rb | 31 +++++ .../redmine_plugin/templates/README | 3 + .../redmine_plugin/templates/en.yml | 2 + .../redmine_plugin/templates/init.rb | 8 ++ .../redmine_plugin/templates/test_helper.rb | 5 + .../redmine_plugin_controller/USAGE | 5 + .../redmine_plugin_controller_generator.rb | 18 +++ .../templates/controller.rb | 7 ++ .../templates/functional_test.rb | 8 ++ .../templates/helper.rb | 2 + .../templates/view.html.erb | 1 + .../lib/generators/redmine_plugin_model/USAGE | 5 + .../redmine_plugin_model_generator.rb | 18 +++ .../templates/fixtures.yml | 11 ++ .../templates/migration.rb | 13 +++ .../redmine_plugin_model/templates/model.rb | 2 + .../templates/unit_test.rb | 10 ++ groups/lib/redmine.rb | 1 + groups/lib/redmine/hook.rb | 109 ++++++++++++++++++ groups/lib/tasks/plugins.rake | 38 ++++++ .../functional/projects_controller_test.rb | 19 +++ groups/test/unit/lib/redmine/hook_test.rb | 83 +++++++++++++ 32 files changed, 433 insertions(+), 4 deletions(-) create mode 100644 groups/lib/generators/redmine_plugin/USAGE create mode 100644 groups/lib/generators/redmine_plugin/redmine_plugin_generator.rb create mode 100644 groups/lib/generators/redmine_plugin/templates/README create mode 100644 groups/lib/generators/redmine_plugin/templates/en.yml create mode 100644 groups/lib/generators/redmine_plugin/templates/init.rb create mode 100644 groups/lib/generators/redmine_plugin/templates/test_helper.rb create mode 100644 groups/lib/generators/redmine_plugin_controller/USAGE create mode 100644 groups/lib/generators/redmine_plugin_controller/redmine_plugin_controller_generator.rb create mode 100644 groups/lib/generators/redmine_plugin_controller/templates/controller.rb create mode 100644 groups/lib/generators/redmine_plugin_controller/templates/functional_test.rb create mode 100644 groups/lib/generators/redmine_plugin_controller/templates/helper.rb create mode 100644 groups/lib/generators/redmine_plugin_controller/templates/view.html.erb create mode 100644 groups/lib/generators/redmine_plugin_model/USAGE create mode 100644 groups/lib/generators/redmine_plugin_model/redmine_plugin_model_generator.rb create mode 100644 groups/lib/generators/redmine_plugin_model/templates/fixtures.yml create mode 100644 groups/lib/generators/redmine_plugin_model/templates/migration.rb create mode 100644 groups/lib/generators/redmine_plugin_model/templates/model.rb create mode 100644 groups/lib/generators/redmine_plugin_model/templates/unit_test.rb create mode 100644 groups/lib/redmine/hook.rb create mode 100644 groups/lib/tasks/plugins.rake create mode 100644 groups/test/unit/lib/redmine/hook_test.rb diff --git a/groups/app/controllers/issues_controller.rb b/groups/app/controllers/issues_controller.rb index 76b851111..5ead7611f 100644 --- a/groups/app/controllers/issues_controller.rb +++ b/groups/app/controllers/issues_controller.rb @@ -233,6 +233,7 @@ class IssuesController < ApplicationController issue.start_date = params[:start_date] unless params[:start_date].blank? issue.due_date = params[:due_date] unless params[:due_date].blank? issue.done_ratio = params[:done_ratio] unless params[:done_ratio].blank? + call_hook(:controller_issues_bulk_edit_before_save, { :params => params, :issue => issue }) # Don't save any change to the issue if the user is not authorized to apply the requested status if (status.nil? || (issue.status.new_status_allowed_to?(status, current_role, issue.tracker) && issue.status = status)) && issue.save # Send notification for each issue (if changed) diff --git a/groups/app/helpers/issues_helper.rb b/groups/app/helpers/issues_helper.rb index c6de00c10..43acabd19 100644 --- a/groups/app/helpers/issues_helper.rb +++ b/groups/app/helpers/issues_helper.rb @@ -89,7 +89,8 @@ module IssuesHelper when 'attachment' label = l(:label_attachment) end - + call_hook(:helper_issues_show_detail_after_setting, {:detail => detail, :label => label, :value => value, :old_value => old_value }) + label ||= detail.prop_key value ||= detail.value old_value ||= detail.old_value diff --git a/groups/app/models/repository.rb b/groups/app/models/repository.rb index 9768e3e3c..81e6647a2 100644 --- a/groups/app/models/repository.rb +++ b/groups/app/models/repository.rb @@ -134,6 +134,7 @@ class Repository < ActiveRecord::Base def clear_changesets connection.delete("DELETE FROM changes WHERE changes.changeset_id IN (SELECT changesets.id FROM changesets WHERE changesets.repository_id = #{id})") + connection.delete("DELETE FROM changesets_issues WHERE changesets_issues.changeset_id IN (SELECT changesets.id FROM changesets WHERE changesets.repository_id = #{id})") connection.delete("DELETE FROM changesets WHERE changesets.repository_id = #{id}") end end diff --git a/groups/app/views/issues/_form.rhtml b/groups/app/views/issues/_form.rhtml index 4eca3cb4a..419536fee 100644 --- a/groups/app/views/issues/_form.rhtml +++ b/groups/app/views/issues/_form.rhtml @@ -48,4 +48,6 @@

<%= render :partial => 'attachments/form' %>

<% end %> +<%= call_hook(:view_issues_form_details_bottom, { :issue => @issue, :form => f }) %> + <%= wikitoolbar_for 'issue_description' %> diff --git a/groups/app/views/issues/bulk_edit.rhtml b/groups/app/views/issues/bulk_edit.rhtml index 86bc76765..b916cf092 100644 --- a/groups/app/views/issues/bulk_edit.rhtml +++ b/groups/app/views/issues/bulk_edit.rhtml @@ -38,6 +38,7 @@

+<%= call_hook(:view_issues_bulk_edit_details_bottom, { :issues => @issues }) %>
<%= l(:field_notes) %> diff --git a/groups/app/views/issues/show.rhtml b/groups/app/views/issues/show.rhtml index 2dd1bacaa..463fa6960 100644 --- a/groups/app/views/issues/show.rhtml +++ b/groups/app/views/issues/show.rhtml @@ -53,6 +53,7 @@ <%end end %> +<%= call_hook(:view_issues_show_details_bottom, :issue => @issue) %>
diff --git a/groups/app/views/layouts/base.rhtml b/groups/app/views/layouts/base.rhtml index 62d542b7b..8c1c01903 100644 --- a/groups/app/views/layouts/base.rhtml +++ b/groups/app/views/layouts/base.rhtml @@ -6,7 +6,7 @@ <%= stylesheet_link_tag 'application', :media => 'all' %> -<%= javascript_include_tag :defaults %> +<%= javascript_include_tag :defaults, :cache => true %> <%= stylesheet_link_tag 'jstoolbar' %> - -<%= yield :header_tags %> +<%= call_hook :view_layouts_base_html_head %> + +<%= yield :header_tags -%>
diff --git a/groups/app/views/projects/settings/_members.rhtml b/groups/app/views/projects/settings/_members.rhtml index 10c506451..b74c6810f 100644 --- a/groups/app/views/projects/settings/_members.rhtml +++ b/groups/app/views/projects/settings/_members.rhtml @@ -11,6 +11,7 @@ <%= l(:label_member) %> <%= l(:label_role) %> + <%= call_hook(:view_projects_settings_members_table_header) %> <% members.each do |member| %> @@ -31,6 +32,7 @@ }, :title => l(:button_delete), :class => 'icon icon-del' %> + <%= call_hook(:view_projects_settings_members_table_row, :member => @member) %> <% end; reset_cycle %> diff --git a/groups/app/views/versions/show.rhtml b/groups/app/views/versions/show.rhtml index 7f9518af8..7e5264562 100644 --- a/groups/app/views/versions/show.rhtml +++ b/groups/app/views/versions/show.rhtml @@ -45,4 +45,6 @@ <% end %>
+<%= call_hook :view_versions_show_bottom, :version => @version %> + <% html_title @version.name %> diff --git a/groups/lib/generators/redmine_plugin/USAGE b/groups/lib/generators/redmine_plugin/USAGE new file mode 100644 index 000000000..65a45d163 --- /dev/null +++ b/groups/lib/generators/redmine_plugin/USAGE @@ -0,0 +1,18 @@ +Description: + The plugin generator creates stubs for a new Redmine plugin. + +Example: + ./script/generate redmine_plugin meetings + create vendor/plugins/redmine_meetings/app/controllers + create vendor/plugins/redmine_meetings/app/helpers + create vendor/plugins/redmine_meetings/app/models + create vendor/plugins/redmine_meetings/app/views + create vendor/plugins/redmine_meetings/db/migrate + create vendor/plugins/redmine_meetings/lib/tasks + create vendor/plugins/redmine_meetings/assets/images + create vendor/plugins/redmine_meetings/assets/javascripts + create vendor/plugins/redmine_meetings/assets/stylesheets + create vendor/plugins/redmine_meetings/lang + create vendor/plugins/redmine_meetings/README + create vendor/plugins/redmine_meetings/init.rb + create vendor/plugins/redmine_meetings/lang/en.yml diff --git a/groups/lib/generators/redmine_plugin/redmine_plugin_generator.rb b/groups/lib/generators/redmine_plugin/redmine_plugin_generator.rb new file mode 100644 index 000000000..666386abd --- /dev/null +++ b/groups/lib/generators/redmine_plugin/redmine_plugin_generator.rb @@ -0,0 +1,31 @@ +class RedminePluginGenerator < Rails::Generator::NamedBase + attr_reader :plugin_path, :plugin_name, :plugin_pretty_name + + def initialize(runtime_args, runtime_options = {}) + super + @plugin_name = "redmine_#{file_name.underscore}" + @plugin_pretty_name = plugin_name.titleize + @plugin_path = "vendor/plugins/#{plugin_name}" + end + + def manifest + record do |m| + m.directory "#{plugin_path}/app/controllers" + m.directory "#{plugin_path}/app/helpers" + m.directory "#{plugin_path}/app/models" + m.directory "#{plugin_path}/app/views" + m.directory "#{plugin_path}/db/migrate" + m.directory "#{plugin_path}/lib/tasks" + m.directory "#{plugin_path}/assets/images" + m.directory "#{plugin_path}/assets/javascripts" + m.directory "#{plugin_path}/assets/stylesheets" + m.directory "#{plugin_path}/lang" + m.directory "#{plugin_path}/test" + + m.template 'README', "#{plugin_path}/README" + m.template 'init.rb', "#{plugin_path}/init.rb" + m.template 'en.yml', "#{plugin_path}/lang/en.yml" + m.template 'test_helper.rb', "#{plugin_path}/test/test_helper.rb" + end + end +end diff --git a/groups/lib/generators/redmine_plugin/templates/README b/groups/lib/generators/redmine_plugin/templates/README new file mode 100644 index 000000000..7a31a890e --- /dev/null +++ b/groups/lib/generators/redmine_plugin/templates/README @@ -0,0 +1,3 @@ += <%= file_name %> + +Description goes here diff --git a/groups/lib/generators/redmine_plugin/templates/en.yml b/groups/lib/generators/redmine_plugin/templates/en.yml new file mode 100644 index 000000000..e338591ef --- /dev/null +++ b/groups/lib/generators/redmine_plugin/templates/en.yml @@ -0,0 +1,2 @@ +# English strings go here +my_label: "My label" diff --git a/groups/lib/generators/redmine_plugin/templates/init.rb b/groups/lib/generators/redmine_plugin/templates/init.rb new file mode 100644 index 000000000..1ffcd7bb8 --- /dev/null +++ b/groups/lib/generators/redmine_plugin/templates/init.rb @@ -0,0 +1,8 @@ +require 'redmine' + +Redmine::Plugin.register :<%= plugin_name %> do + name '<%= plugin_pretty_name %> plugin' + author 'Author name' + description 'This is a plugin for Redmine' + version '0.0.1' +end diff --git a/groups/lib/generators/redmine_plugin/templates/test_helper.rb b/groups/lib/generators/redmine_plugin/templates/test_helper.rb new file mode 100644 index 000000000..bd1ed0c5d --- /dev/null +++ b/groups/lib/generators/redmine_plugin/templates/test_helper.rb @@ -0,0 +1,5 @@ +# Load the normal Rails helper +require File.expand_path(File.dirname(__FILE__) + '/../../../../test/test_helper') + +# Ensure that we are using the temporary fixture path +Engines::Testing.set_fixture_path diff --git a/groups/lib/generators/redmine_plugin_controller/USAGE b/groups/lib/generators/redmine_plugin_controller/USAGE new file mode 100644 index 000000000..8336e7117 --- /dev/null +++ b/groups/lib/generators/redmine_plugin_controller/USAGE @@ -0,0 +1,5 @@ +Description: + Generates a plugin controller. + +Example: + ./script/generate redmine_plugin_controller MyPlugin Pools index show vote diff --git a/groups/lib/generators/redmine_plugin_controller/redmine_plugin_controller_generator.rb b/groups/lib/generators/redmine_plugin_controller/redmine_plugin_controller_generator.rb new file mode 100644 index 000000000..533d65ce8 --- /dev/null +++ b/groups/lib/generators/redmine_plugin_controller/redmine_plugin_controller_generator.rb @@ -0,0 +1,18 @@ +require 'rails_generator/base' +require 'rails_generator/generators/components/controller/controller_generator' + +class RedminePluginControllerGenerator < ControllerGenerator + attr_reader :plugin_path, :plugin_name, :plugin_pretty_name + + def initialize(runtime_args, runtime_options = {}) + runtime_args = runtime_args.dup + @plugin_name = "redmine_" + runtime_args.shift.underscore + @plugin_pretty_name = plugin_name.titleize + @plugin_path = "vendor/plugins/#{plugin_name}" + super(runtime_args, runtime_options) + end + + def destination_root + File.join(RAILS_ROOT, plugin_path) + end +end diff --git a/groups/lib/generators/redmine_plugin_controller/templates/controller.rb b/groups/lib/generators/redmine_plugin_controller/templates/controller.rb new file mode 100644 index 000000000..615986d9e --- /dev/null +++ b/groups/lib/generators/redmine_plugin_controller/templates/controller.rb @@ -0,0 +1,7 @@ +class <%= class_name %>Controller < ApplicationController +<% actions.each do |action| -%> + + def <%= action %> + end +<% end -%> +end diff --git a/groups/lib/generators/redmine_plugin_controller/templates/functional_test.rb b/groups/lib/generators/redmine_plugin_controller/templates/functional_test.rb new file mode 100644 index 000000000..876bd79e2 --- /dev/null +++ b/groups/lib/generators/redmine_plugin_controller/templates/functional_test.rb @@ -0,0 +1,8 @@ +require File.dirname(__FILE__) + '/../test_helper' + +class <%= class_name %>ControllerTest < ActionController::TestCase + # Replace this with your real tests. + def test_truth + assert true + end +end diff --git a/groups/lib/generators/redmine_plugin_controller/templates/helper.rb b/groups/lib/generators/redmine_plugin_controller/templates/helper.rb new file mode 100644 index 000000000..3fe2ecdc7 --- /dev/null +++ b/groups/lib/generators/redmine_plugin_controller/templates/helper.rb @@ -0,0 +1,2 @@ +module <%= class_name %>Helper +end diff --git a/groups/lib/generators/redmine_plugin_controller/templates/view.html.erb b/groups/lib/generators/redmine_plugin_controller/templates/view.html.erb new file mode 100644 index 000000000..c24afaa6e --- /dev/null +++ b/groups/lib/generators/redmine_plugin_controller/templates/view.html.erb @@ -0,0 +1 @@ +

<%= class_name %>#<%= action %>

diff --git a/groups/lib/generators/redmine_plugin_model/USAGE b/groups/lib/generators/redmine_plugin_model/USAGE new file mode 100644 index 000000000..0cb55a186 --- /dev/null +++ b/groups/lib/generators/redmine_plugin_model/USAGE @@ -0,0 +1,5 @@ +Description: + Generates a plugin model. + +Examples: + ./script/generate redmine_plugin_model MyPlugin pool title:string question:text diff --git a/groups/lib/generators/redmine_plugin_model/redmine_plugin_model_generator.rb b/groups/lib/generators/redmine_plugin_model/redmine_plugin_model_generator.rb new file mode 100644 index 000000000..b712d9b07 --- /dev/null +++ b/groups/lib/generators/redmine_plugin_model/redmine_plugin_model_generator.rb @@ -0,0 +1,18 @@ +require 'rails_generator/base' +require 'rails_generator/generators/components/model/model_generator' + +class RedminePluginModelGenerator < ModelGenerator + attr_accessor :plugin_path, :plugin_name, :plugin_pretty_name + + def initialize(runtime_args, runtime_options = {}) + runtime_args = runtime_args.dup + @plugin_name = "redmine_" + runtime_args.shift.underscore + @plugin_pretty_name = plugin_name.titleize + @plugin_path = "vendor/plugins/#{plugin_name}" + super(runtime_args, runtime_options) + end + + def destination_root + File.join(RAILS_ROOT, plugin_path) + end +end diff --git a/groups/lib/generators/redmine_plugin_model/templates/fixtures.yml b/groups/lib/generators/redmine_plugin_model/templates/fixtures.yml new file mode 100644 index 000000000..6be3c81be --- /dev/null +++ b/groups/lib/generators/redmine_plugin_model/templates/fixtures.yml @@ -0,0 +1,11 @@ +# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html +one: + id: 1 +<% for attribute in attributes -%> + <%= attribute.name %>: <%= attribute.default %> +<% end -%> +two: + id: 2 +<% for attribute in attributes -%> + <%= attribute.name %>: <%= attribute.default %> +<% end -%> diff --git a/groups/lib/generators/redmine_plugin_model/templates/migration.rb b/groups/lib/generators/redmine_plugin_model/templates/migration.rb new file mode 100644 index 000000000..2a305a6a9 --- /dev/null +++ b/groups/lib/generators/redmine_plugin_model/templates/migration.rb @@ -0,0 +1,13 @@ +class <%= migration_name %> < ActiveRecord::Migration + def self.up + create_table :<%= table_name %> do |t| +<% for attribute in attributes -%> + t.column :<%= attribute.name %>, :<%= attribute.type %> +<% end -%> + end + end + + def self.down + drop_table :<%= table_name %> + end +end diff --git a/groups/lib/generators/redmine_plugin_model/templates/model.rb b/groups/lib/generators/redmine_plugin_model/templates/model.rb new file mode 100644 index 000000000..8d4c89e91 --- /dev/null +++ b/groups/lib/generators/redmine_plugin_model/templates/model.rb @@ -0,0 +1,2 @@ +class <%= class_name %> < ActiveRecord::Base +end diff --git a/groups/lib/generators/redmine_plugin_model/templates/unit_test.rb b/groups/lib/generators/redmine_plugin_model/templates/unit_test.rb new file mode 100644 index 000000000..cc8b2e591 --- /dev/null +++ b/groups/lib/generators/redmine_plugin_model/templates/unit_test.rb @@ -0,0 +1,10 @@ +require File.dirname(__FILE__) + '/../test_helper' + +class <%= class_name %>Test < Test::Unit::TestCase + fixtures :<%= table_name %> + + # Replace this with your real tests. + def test_truth + assert true + end +end diff --git a/groups/lib/redmine.rb b/groups/lib/redmine.rb index 33d33752b..3ba2f2cc3 100644 --- a/groups/lib/redmine.rb +++ b/groups/lib/redmine.rb @@ -4,6 +4,7 @@ require 'redmine/activity' require 'redmine/mime_type' require 'redmine/core_ext' require 'redmine/themes' +require 'redmine/hook' require 'redmine/plugin' begin diff --git a/groups/lib/redmine/hook.rb b/groups/lib/redmine/hook.rb new file mode 100644 index 000000000..9bf92b3e7 --- /dev/null +++ b/groups/lib/redmine/hook.rb @@ -0,0 +1,109 @@ +# Redmine - project management software +# Copyright (C) 2006-2008 Jean-Philippe Lang +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 2 +# of the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + +module Redmine + module Hook + @@listener_classes = [] + @@listeners = nil + @@hook_listeners = {} + + class << self + # Adds a listener class. + # Automatically called when a class inherits from Redmine::Hook::Listener. + def add_listener(klass) + raise "Hooks must include Singleton module." unless klass.included_modules.include?(Singleton) + @@listener_classes << klass + clear_listeners_instances + end + + # Returns all the listerners instances. + def listeners + @@listeners ||= @@listener_classes.collect {|listener| listener.instance} + end + + # Returns the listeners instances for the given hook. + def hook_listeners(hook) + @@hook_listeners[hook] ||= listeners.select {|listener| listener.respond_to?(hook)} + end + + # Clears all the listeners. + def clear_listeners + @@listener_classes = [] + clear_listeners_instances + end + + # Clears all the listeners instances. + def clear_listeners_instances + @@listeners = nil + @@hook_listeners = {} + end + + # Calls a hook. + # Returns the listeners response. + def call_hook(hook, context={}) + response = '' + hook_listeners(hook).each do |listener| + response << listener.send(hook, context).to_s + end + response + end + end + + # Base class for hook listeners. + class Listener + include Singleton + + # Registers the listener + def self.inherited(child) + Redmine::Hook.add_listener(child) + super + end + end + + # Listener class used for views hooks. + # Listeners that inherit this class will include various helpers by default. + class ViewListener < Listener + include ERB::Util + include ActionView::Helpers::TagHelper + include ActionView::Helpers::FormHelper + include ActionView::Helpers::FormTagHelper + include ActionView::Helpers::FormOptionsHelper + include ActionView::Helpers::JavaScriptHelper + include ActionView::Helpers::PrototypeHelper + include ActionView::Helpers::NumberHelper + include ActionView::Helpers::UrlHelper + include ActionView::Helpers::AssetTagHelper + include ActionView::Helpers::TextHelper + include ActionController::UrlWriter + include ApplicationHelper + end + + # Helper module included in ApplicationHelper so that hooks can be called + # in views like this: + # <%= call_hook(:some_hook) %> + # <%= call_hook(:another_hook, :foo => 'bar' %> + # + # Current project is automatically added to the call context. + module Helper + def call_hook(hook, context={}) + Redmine::Hook.call_hook(hook, {:project => @project}.merge(context)) + end + end + end +end + +ApplicationHelper.send(:include, Redmine::Hook::Helper) diff --git a/groups/lib/tasks/plugins.rake b/groups/lib/tasks/plugins.rake new file mode 100644 index 000000000..136877164 --- /dev/null +++ b/groups/lib/tasks/plugins.rake @@ -0,0 +1,38 @@ +require 'source_annotation_extractor' + +# Modified version of the SourceAnnotationExtractor in railties +# Will search for runable code that uses call_hook +class PluginSourceAnnotationExtractor < SourceAnnotationExtractor + # Returns a hash that maps filenames under +dir+ (recursively) to arrays + # with their annotations. Only files with annotations are included, and only + # those with extension +.builder+, +.rb+, +.rxml+, +.rjs+, +.rhtml+, and +.erb+ + # are taken into account. + def find_in(dir) + results = {} + + Dir.glob("#{dir}/*") do |item| + next if File.basename(item)[0] == ?. + + if File.directory?(item) + results.update(find_in(item)) + elsif item =~ /(hook|test)\.rb/ + # skip + elsif item =~ /\.(builder|(r(?:b|xml|js)))$/ + results.update(extract_annotations_from(item, /\s*(#{tag})\(?\s*(.*)$/)) + elsif item =~ /\.(rhtml|erb)$/ + results.update(extract_annotations_from(item, /<%=\s*\s*(#{tag})\(?\s*(.*?)\s*%>/)) + end + end + + results + end +end + +namespace :redmine do + namespace :plugins do + desc "Enumerate all Redmine plugin hooks and their context parameters" + task :hook_list do + PluginSourceAnnotationExtractor.enumerate 'call_hook' + end + end +end diff --git a/groups/test/functional/projects_controller_test.rb b/groups/test/functional/projects_controller_test.rb index 03773ccdb..8e57dc5fd 100644 --- a/groups/test/functional/projects_controller_test.rb +++ b/groups/test/functional/projects_controller_test.rb @@ -316,4 +316,23 @@ class ProjectsControllerTest < Test::Unit::TestCase end end end + + # A hook that is manually registered later + class ProjectBasedTemplate < Redmine::Hook::ViewListener + def view_layouts_base_html_head(context) + # Adds a project stylesheet + stylesheet_link_tag(context[:project].identifier) if context[:project] + end + end + # Don't use this hook now + Redmine::Hook.clear_listeners + + def test_hook_response + Redmine::Hook.add_listener(ProjectBasedTemplate) + get :show, :id => 1 + assert_tag :tag => 'link', :attributes => {:href => '/stylesheets/ecookbook.css'}, + :parent => {:tag => 'head'} + + Redmine::Hook.clear_listeners + end end diff --git a/groups/test/unit/lib/redmine/hook_test.rb b/groups/test/unit/lib/redmine/hook_test.rb new file mode 100644 index 000000000..0d76374b6 --- /dev/null +++ b/groups/test/unit/lib/redmine/hook_test.rb @@ -0,0 +1,83 @@ +# redMine - project management software +# Copyright (C) 2006-2008 Jean-Philippe Lang +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 2 +# of the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + +require File.dirname(__FILE__) + '/../../../test_helper' + +class Redmine::Hook::ManagerTest < Test::Unit::TestCase + + # Some hooks that are manually registered in these tests + class TestHook < Redmine::Hook::Listener; end + + class TestHook1 < TestHook + def view_layouts_base_html_head(context) + 'Test hook 1 listener.' + end + end + + class TestHook2 < TestHook + def view_layouts_base_html_head(context) + 'Test hook 2 listener.' + end + end + + class TestHook3 < TestHook + def view_layouts_base_html_head(context) + "Context keys: #{context.keys.collect(&:to_s).sort.join(', ')}." + end + end + Redmine::Hook.clear_listeners + + def setup + @hook_module = Redmine::Hook + end + + def teardown + @hook_module.clear_listeners + end + + def test_clear_listeners + assert_equal 0, @hook_module.hook_listeners(:view_layouts_base_html_head).size + @hook_module.add_listener(TestHook1) + @hook_module.add_listener(TestHook2) + assert_equal 2, @hook_module.hook_listeners(:view_layouts_base_html_head).size + + @hook_module.clear_listeners + assert_equal 0, @hook_module.hook_listeners(:view_layouts_base_html_head).size + end + + def test_add_listener + assert_equal 0, @hook_module.hook_listeners(:view_layouts_base_html_head).size + @hook_module.add_listener(TestHook1) + assert_equal 1, @hook_module.hook_listeners(:view_layouts_base_html_head).size + end + + def test_call_hook + @hook_module.add_listener(TestHook1) + assert_equal 'Test hook 1 listener.', @hook_module.call_hook(:view_layouts_base_html_head) + end + + def test_call_hook_with_context + @hook_module.add_listener(TestHook3) + assert_equal 'Context keys: bar, foo.', @hook_module.call_hook(:view_layouts_base_html_head, :foo => 1, :bar => 'a') + end + + def test_call_hook_with_multiple_listeners + @hook_module.add_listener(TestHook1) + @hook_module.add_listener(TestHook2) + assert_equal 'Test hook 1 listener.Test hook 2 listener.', @hook_module.call_hook(:view_layouts_base_html_head) + end +end