jro_apps/redmine Commit - r1158:792b7f30e32e

Menus items:...

Jean-Philippe Lang -

r1158:792b7f30e32e

parent child

Context file:

r1158:792b7f30e32e

Collapse all files

extra/sample_plugin/init.rb +1 -1

             # Redmine sample plugin
             require 'redmine'
             RAILS_DEFAULT_LOGGER.info 'Starting Example plugin for RedMine'
             Redmine::Plugin.register :sample_plugin do
               name 'Example plugin'
               author 'Author name'
               description 'This is a sample plugin for Redmine'
               version '0.0.1'
               settings :default => {'sample_setting' => 'value', 'foo'=>'bar'}, :partial => 'settings/settings'
               # This plugin adds a project module
               # It can be enabled/disabled at project level (Project settings -> Modules)
               project_module :example_module do
                 # A public action
                 permission :example_say_hello, {:example => [:say_hello]}, :public => true
                 # This permission has to be explicitly given
                 # It will be listed on the permissions screen
                 permission :example_say_goodbye, {:example => [:say_goodbye]}
               end
               # A new item is added to the project menu
-              menu :project_menu, :label_plugin_example, :controller => 'example', :action => 'say_hello'
+              menu :project_menu, :sample_plugin, { :controller => 'example', :action => 'say_hello' }, :caption => 'Sample'
             end

lib/redmine/menu_manager.rb +7 -2

             # redMine - project management software
             # Copyright (C) 2006-2007  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 MenuManager
                 module MenuController
                   def self.included(base)
                     base.extend(ClassMethods)
                   end
                   module ClassMethods
                     @@menu_items = Hash.new {|hash, key| hash[key] = {:default => key, :actions => {}}}
                     mattr_accessor :menu_items
                     # Set the menu item name for a controller or specific actions
                     # Examples:
                     #   * menu_item :tickets # => sets the menu name to :tickets for the whole controller
                     #   * menu_item :tickets, :only => :list # => sets the menu name to :tickets for the 'list' action only
                     #   * menu_item :tickets, :only => [:list, :show] # => sets the menu name to :tickets for 2 actions only
                     #
                     # The default menu item name for a controller is controller_name by default
                     # Eg. the default menu item name for ProjectsController is :projects
                     def menu_item(id, options = {})
                       if actions = options[:only]
                         actions = [] << actions unless actions.is_a?(Array)
                         actions.each {|a| menu_items[controller_name.to_sym][:actions][a.to_sym] = id}
                       else
                         menu_items[controller_name.to_sym][:default] = id
                       end
                     end
                   end
                   def menu_items
                     self.class.menu_items
                   end
                   # Returns the menu item name according to the current action
                   def current_menu_item
                     menu_items[controller_name.to_sym][:actions][action_name.to_sym] ||
                       menu_items[controller_name.to_sym][:default]
                   end
                 end
                 module MenuHelper
                   # Returns the current menu item name
                   def current_menu_item
                     @controller.current_menu_item
                   end
                   # Renders the application main menu
                   def render_main_menu(project)
                     render_menu((project && !project.new_record?) ? :project_menu : :application_menu, project)
                   end
                   def render_menu(menu, project=nil)
                     links = []
                     Redmine::MenuManager.allowed_items(menu, User.current, project).each do |item|
                       unless item.condition && !item.condition.call(project)
                         url = case item.url
                         when Hash
                           project.nil? ? item.url : {item.param => project}.merge(item.url)
                         when Symbol
                           send(item.url)
                         else
                           item.url
                         end
                         #url = (project && item.url.is_a?(Hash)) ? {item.param => project}.merge(item.url) : (item.url.is_a?(Symbol) ? send(item.url) : item.url)
                         links << content_tag('li',
                           link_to(l(item.caption), url, (current_menu_item == item.name ? item.html_options.merge(:class => 'selected') : item.html_options)))
                       end
                     end
                     links.empty? ? nil : content_tag('ul', links.join("\n"))
                   end
                 end
                 class << self
                   def map(menu_name)
                     mapper = Mapper.new
                     yield mapper
                     @items ||= {}
                     @items[menu_name.to_sym] ||= []
                     @items[menu_name.to_sym] += mapper.items
                   end
                   def items(menu_name)
                     @items[menu_name.to_sym] || []
                   end
                   def allowed_items(menu_name, user, project)
                     project ? items(menu_name).select {|item| user && user.allowed_to?(item.url, project)} : items(menu_name)
                   end
                 end
                 class Mapper
                   # Adds an item at the end of the menu. Available options:
                   # * param: the parameter name 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 localized string key that is used as the item label
                   # * html_options: a hash of html options that are passed to link_to
                   def push(name, url, options={})
                     items << MenuItem.new(name, url, options)
                   end
                   def items
                     @items ||= []
                   end
                 end
                 class MenuItem
                   include GLoc
-                  attr_reader :name, :url, :param, :condition, :caption, :html_options
+                  attr_reader :name, :url, :param, :condition, :html_options
                   def initialize(name, url, options)
                     raise "Invalid option :if for menu item '#{name}'" if options[:if] && !options[:if].respond_to?(:call)
                     raise "Invalid option :html for menu item '#{name}'" if options[:html] && !options[:html].is_a?(Hash)
                     @name = name
                     @url = url
                     @condition = options[:if]
                     @param = options[:param] || :id
-                    @caption = options[:caption] || (l_has_string?("label_#{name}".to_sym) ? "label_#{name}".to_sym : name.to_s.humanize)
+                    @caption_key = options[:caption]
                     @html_options = options[:html] || {}
                   end
+                  def caption
+                    # check if localized string exists on first render (after GLoc strings are loaded)
+                    @caption ||= (@caption_key || (l_has_string?("label_#{@name}".to_sym) ? "label_#{@name}".to_sym : @name.to_s.humanize))
+                  end
                 end
               end
             end

lib/redmine/plugin.rb +5 -4

             # redMine - project management software
             # Copyright (C) 2006-2007  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 #:nodoc:
               # Base class for Redmine plugins.
               # Plugins are registered using the <tt>register</tt> class method that acts as the public constructor.
               #
               #   Redmine::Plugin.register :example do
               #     name 'Example plugin'
               #     author 'John Smith'
               #     description 'This is an example plugin for Redmine'
               #     version '0.0.1'
               #     settings :default => {'foo'=>'bar'}, :partial => 'settings/settings'
               #   end
               #
               # === Plugin attributes
               #
               # +settings+ is an optional attribute that let the plugin be configurable.
               # It must be a hash with the following keys:
               # * <tt>:default</tt>: default value for the plugin settings
               # * <tt>:partial</tt>: path of the configuration partial view, relative to the plugin <tt>app/views</tt> directory
               # Example:
               #   settings :default => {'foo'=>'bar'}, :partial => 'settings/settings'
               # In this example, the settings partial will be found here in the plugin directory: <tt>app/views/settings/_settings.rhtml</tt>.
               #
               # When rendered, the plugin settings value is available as the local variable +settings+
               class Plugin
                 @registered_plugins = {}
                 class << self
                   attr_reader :registered_plugins
                   private :new
                   def def_field(*names)
                     class_eval do
                       names.each do |name|
                         define_method(name) do |*args|
                           args.empty? ? instance_variable_get("@#{name}") : instance_variable_set("@#{name}", *args)
                         end
                       end
                     end
                   end
                 end
                 def_field :name, :description, :author, :version, :settings
                 # Plugin constructor
                 def self.register(name, &block)
                   p = new
                   p.instance_eval(&block)
                   Plugin.registered_plugins[name] = p
                 end
                 # Adds an item to the given +menu+.
                 # The +id+ parameter (equals to the project id) is automatically added to the url.
-                #   menu :project_menu, :label_plugin_example, :controller => 'example', :action => 'say_hello'
+                #   menu :project_menu, :plugin_example, { :controller => 'example', :action => 'say_hello' }, :caption => 'Sample'
                 #
-                # Currently, only the project menu can be extended. Thus, the +name+ parameter must be +:project_menu+
+                # +name+ parameter can be: :top_menu, :account_menu, :application_menu or :project_menu
-                def menu(name, label, url)
-                  Redmine::MenuManager.map(name) {|menu| menu.push label, url}
+                def menu(name, item, url, options={})
+                  Redmine::MenuManager.map(name) {|menu| menu.push item, url, options}
                 end
                 # Defines a permission called +name+ for the given +actions+.
                 #
                 # The +actions+ argument is a hash with controllers as keys and actions as values (a single value or an array):
                 #   permission :destroy_contacts, { :contacts => :destroy }
                 #   permission :view_contacts, { :contacts => [:index, :show] }
                 #
                 # The +options+ argument can be used to make the permission public (implicitly given to any user)
                 # or to restrict users the permission can be given to.
                 #
                 # Examples
                 #   # A permission that is implicitly given to any user
                 #   # This permission won't appear on the Roles & Permissions setup screen
                 #   permission :say_hello, { :example => :say_hello }, :public => true
                 #
                 #   # A permission that can be given to any user
                 #   permission :say_hello, { :example => :say_hello }
                 #
                 #   # A permission that can be given to registered users only
                 #   permission :say_hello, { :example => :say_hello }, :require => loggedin
                 #
                 #   # A permission that can be given to project members only
                 #   permission :say_hello, { :example => :say_hello }, :require => member
                 def permission(name, actions, options = {})
                   if @project_module
                     Redmine::AccessControl.map {|map| map.project_module(@project_module) {|map|map.permission(name, actions, options)}}
                   else
                     Redmine::AccessControl.map {|map| map.permission(name, actions, options)}
                   end
                 end
                 # Defines a project module, that can be enabled/disabled for each project.
                 # Permissions defined inside +block+ will be bind to the module.
                 #
                 #   project_module :things do
                 #     permission :view_contacts, { :contacts => [:list, :show] }, :public => true
                 #     permission :destroy_contacts, { :contacts => :destroy }
                 #   end
                 def project_module(name, &block)
                   @project_module = name
                   self.instance_eval(&block)
                   @project_module = nil
                 end
                 # Returns +true+ if the plugin can be configured.
                 def configurable?
                   settings && settings.is_a?(Hash) && !settings[:partial].blank?
                 end
               end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages