Browse Source

Extract classes to their own files to prevent loading issues (#20508).

git-svn-id: http://svn.redmine.org/redmine/trunk@14694 e93f8b46-1217-0410-a6f0-8f06a7374b81
tags/3.2.0
Jean-Philippe Lang 8 years ago
parent
commit
9244f67e28
4 changed files with 112 additions and 71 deletions
  1. 2
    0
      lib/redmine.rb
  2. 0
    71
      lib/redmine/hook.rb
  3. 32
    0
      lib/redmine/hook/listener.rb
  4. 78
    0
      lib/redmine/hook/view_listener.rb

+ 2
- 0
lib/redmine.rb View File

@@ -60,6 +60,8 @@ require 'redmine/views/builders'

require 'redmine/themes'
require 'redmine/hook'
require 'redmine/hook/listener'
require 'redmine/hook/view_listener'
require 'redmine/plugin'

Redmine::Scm::Base.add "Subversion"

+ 0
- 71
lib/redmine/hook.rb View File

@@ -64,77 +64,6 @@ module Redmine
end
end

# Base class for hook listeners.
class Listener
include Singleton
include Redmine::I18n

# 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::NumberHelper
include ActionView::Helpers::UrlHelper
include ActionView::Helpers::AssetTagHelper
include ActionView::Helpers::TextHelper
include Rails.application.routes.url_helpers
include ApplicationHelper

# Default to creating links using only the path. Subclasses can
# change this default as needed
def self.default_url_options
{:only_path => true, :script_name => Redmine::Utils.relative_url_root}
end

# Helper method to directly render using the context,
# render_options must be valid #render options.
#
# class MyHook < Redmine::Hook::ViewListener
# render_on :view_issues_show_details_bottom, :partial => "show_more_data"
# end
#
# class MultipleHook < Redmine::Hook::ViewListener
# render_on :view_issues_show_details_bottom,
# {:partial => "show_more_data"},
# {:partial => "show_even_more_data"}
# end
#
def self.render_on(hook, *render_options)
define_method hook do |context|
render_options.map do |options|
if context[:hook_caller].respond_to?(:render)
context[:hook_caller].send(:render, {:locals => context}.merge(options))
elsif context[:controller].is_a?(ActionController::Base)
context[:controller].send(:render_to_string, {:locals => context}.merge(options))
else
raise "Cannot render #{self.name} hook from #{context[:hook_caller].class.name}"
end
end
end
end
def controller
nil
end
def config
ActionController::Base.config
end
end

# Helper module included in ApplicationHelper and ActionController so that
# hooks can be called in views like this:
#

+ 32
- 0
lib/redmine/hook/listener.rb View File

@@ -0,0 +1,32 @@
# Redmine - project management software
# Copyright (C) 2006-2015 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
# Base class for hook listeners.
class Listener
include Singleton
include Redmine::I18n

# Registers the listener
def self.inherited(child)
Redmine::Hook.add_listener(child)
super
end
end
end
end

+ 78
- 0
lib/redmine/hook/view_listener.rb View File

@@ -0,0 +1,78 @@
# Redmine - project management software
# Copyright (C) 2006-2015 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 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::NumberHelper
include ActionView::Helpers::UrlHelper
include ActionView::Helpers::AssetTagHelper
include ActionView::Helpers::TextHelper
include Rails.application.routes.url_helpers
include ApplicationHelper

# Default to creating links using only the path. Subclasses can
# change this default as needed
def self.default_url_options
{:only_path => true, :script_name => Redmine::Utils.relative_url_root}
end

# Helper method to directly render using the context,
# render_options must be valid #render options.
#
# class MyHook < Redmine::Hook::ViewListener
# render_on :view_issues_show_details_bottom, :partial => "show_more_data"
# end
#
# class MultipleHook < Redmine::Hook::ViewListener
# render_on :view_issues_show_details_bottom,
# {:partial => "show_more_data"},
# {:partial => "show_even_more_data"}
# end
#
def self.render_on(hook, *render_options)
define_method hook do |context|
render_options.map do |options|
if context[:hook_caller].respond_to?(:render)
context[:hook_caller].send(:render, {:locals => context}.merge(options))
elsif context[:controller].is_a?(ActionController::Base)
context[:controller].send(:render_to_string, {:locals => context}.merge(options))
else
raise "Cannot render #{self.name} hook from #{context[:hook_caller].class.name}"
end
end
end
end
def controller
nil
end
def config
ActionController::Base.config
end
end
end
end

Loading…
Cancel
Save