jro_apps/redmine Commit - r12175:0dc98aabe635

Adds an option for formatter display name....

Jean-Philippe Lang -

r12175:0dc98aabe635

parent child

Context file:

r12175:0dc98aabe635

Collapse all files

app/views/settings/_general.html.erb +1 -1

             <%= form_tag({:action => 'edit'}) do %>
             <div class="box tabular settings">
             <p><%= setting_text_field :app_title, :size => 30 %></p>
             <p><%= setting_text_area :welcome_text, :cols => 60, :rows => 5, :class => 'wiki-edit' %></p>
             <%= wikitoolbar_for 'settings_welcome_text' %>
             <p><%= setting_text_field :attachment_max_size, :size => 6 %> <%= l(:"number.human.storage_units.units.kb") %></p>
             <p><%= setting_text_field :per_page_options, :size => 20 %>
             <em class="info"><%= l(:text_comma_separated) %></em></p>
             <p><%= setting_text_field :activity_days_default, :size => 6 %> <%= l(:label_day_plural) %></p>
             <p><%= setting_text_field :host_name, :size => 60 %>
             <em class="info"><%= l(:label_example) %>: <%= @guessed_host_and_path %></em></p>
             <p><%= setting_select :protocol, [['HTTP', 'http'], ['HTTPS', 'https']] %></p>
-            <p><%= setting_select :text_formatting, Redmine::WikiFormatting.format_names.collect{|name| [name, name.to_s]}, :blank => :label_none %></p>
+            <p><%= setting_select :text_formatting, Redmine::WikiFormatting.formats_for_select, :blank => :label_none %></p>
             <p><%= setting_check_box :cache_formatted_text %></p>
             <p><%= setting_select :wiki_compression, [['Gzip', 'gzip']], :blank => :label_none %></p>
             <p><%= setting_text_field :feeds_limit, :size => 6 %></p>
             <p><%= setting_text_field :file_max_size_displayed, :size => 6 %> <%= l(:"number.human.storage_units.units.kb") %></p>
             <p><%= setting_text_field :diff_max_lines_displayed, :size => 6 %></p>
             <p><%= setting_text_field :repositories_encodings, :size => 60 %>
             <em class="info"><%= l(:text_comma_separated) %></em></p>
             <%= call_hook(:view_settings_general_form) %>
             </div>
             <%= submit_tag l(:button_save) %>
             <% end %>

lib/redmine/wiki_formatting.rb +12 -3

             # Redmine - project management software
             # Copyright (C) 2006-2013  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 'digest/md5'
             module Redmine
               module WikiFormatting
                 class StaleSectionError < Exception; end
                 @@formatters = {}
                 class << self
                   def map
                     yield self
                   end
-                  def register(name, formatter, helper)
+                  def register(name, formatter, helper, options={})
-                    raise ArgumentError, "format name '#{name}' is already taken" if @@formatters[name.to_s]
+                    name = name.to_s
-                    @@formatters[name.to_s] = {:formatter => formatter, :helper => helper}
+                    raise ArgumentError, "format name '#{name}' is already taken" if @@formatters[name]
+                    @@formatters[name] = {
+                      :formatter => formatter,
+                      :helper => helper,
+                      :label => options[:label] || name.humanize
+                    }
                   end
                   def formatter
                     formatter_for(Setting.text_formatting)
                   end
                   def formatter_for(name)
                     entry = @@formatters[name.to_s]
                     (entry && entry[:formatter]) || Redmine::WikiFormatting::NullFormatter::Formatter
                   end
                   def helper_for(name)
                     entry = @@formatters[name.to_s]
                     (entry && entry[:helper]) || Redmine::WikiFormatting::NullFormatter::Helper
                   end
                   def format_names
                     @@formatters.keys.map
                   end
+                  def formats_for_select
+                    @@formatters.map {|name, options| [options[:label], name]}
+                  end
                   def to_html(format, text, options = {})
                     text = if Setting.cache_formatted_text? && text.size > 2.kilobyte && cache_store && cache_key = cache_key_for(format, text, options[:object], options[:attribute])
                       # Text retrieved from the cache store may be frozen
                       # We need to dup it so we can do in-place substitutions with gsub!
                       cache_store.fetch cache_key do
                         formatter_for(format).new(text).to_html
                       end.dup
                     else
                       formatter_for(format).new(text).to_html
                     end
                     text
                   end
                   # Returns true if the text formatter supports single section edit
                   def supports_section_edit?
                     (formatter.instance_methods & ['update_section', :update_section]).any?
                   end
                   # Returns a cache key for the given text +format+, +text+, +object+ and +attribute+ or nil if no caching should be done
                   def cache_key_for(format, text, object, attribute)
                     if object && attribute && !object.new_record? && format.present?
                       "formatted_text/#{format}/#{object.class.model_name.cache_key}/#{object.id}-#{attribute}-#{Digest::MD5.hexdigest text}"
                     end
                   end
                   # Returns the cache store used to cache HTML output
                   def cache_store
                     ActionController::Base.cache_store
                   end
                 end
                 module LinksHelper
                   AUTO_LINK_RE = %r{
                                   (                          # leading text
                                     <\w+.*?>|                # leading HTML tag, or
                                     [\s\(\[,;]|              # leading punctuation, or
                                     ^                        # beginning of line
                                   )
                                   (
                                     (?:https?://)|           # protocol spec, or
                                     (?:s?ftps?://)|
                                     (?:www\.)                # www.*
                                   )
                                   (
                                     ([^<]\S*?)               # url
                                     (\/)?                    # slash
                                   )
                                   ((?:&gt;)?|[^[:alnum:]_\=\/;\(\)]*?)               # post
                                   (?=<|\s|$)
                                  }x unless const_defined?(:AUTO_LINK_RE)
                   # Destructively remplaces urls into clickable links
                   def auto_link!(text)
                     text.gsub!(AUTO_LINK_RE) do
                       all, leading, proto, url, post = $&, $1, $2, $3, $6
                       if leading =~ /<a\s/i || leading =~ /![<>=]?/
                         # don't replace URL's that are already linked
                         # and URL's prefixed with ! !> !< != (textile images)
                         all
                       else
                         # Idea below : an URL with unbalanced parethesis and
                         # ending by ')' is put into external parenthesis
                         if ( url[-1]==?) and ((url.count("(") - url.count(")")) < 0 ) )
                           url=url[0..-2] # discard closing parenth from url
                           post = ")"+post # add closing parenth to post
                         end
                         content = proto + url
                         href = "#{proto=="www."?"http://www.":proto}#{url}"
                         %(#{leading}<a class="external" href="#{ERB::Util.html_escape href}">#{ERB::Util.html_escape content}</a>#{post}).html_safe
                       end
                     end
                   end
                   # Destructively remplaces email addresses into clickable links
                   def auto_mailto!(text)
                     text.gsub!(/([\w\.!#\$%\-+.]+@[A-Za-z0-9\-]+(\.[A-Za-z0-9\-]+)+)/) do
                       mail = $1
                       if text.match(/<a\b[^>]*>(.*)(#{Regexp.escape(mail)})(.*)<\/a>/)
                         mail
                       else
                         %(<a class="email" href="mailto:#{ERB::Util.html_escape mail}">#{ERB::Util.html_escape mail}</a>).html_safe
                       end
                     end
                   end
                 end
                 # Default formatter module
                 module NullFormatter
                   class Formatter
                     include ActionView::Helpers::TagHelper
                     include ActionView::Helpers::TextHelper
                     include ActionView::Helpers::UrlHelper
                     include Redmine::WikiFormatting::LinksHelper
                     def initialize(text)
                       @text = text
                     end
                     def to_html(*args)
                       t = CGI::escapeHTML(@text)
                       auto_link!(t)
                       auto_mailto!(t)
                       simple_format(t, {}, :sanitize => false)
                     end
                   end
                   module Helper
                     def wikitoolbar_for(field_id)
                     end
                     def heads_for_wiki_formatter
                     end
                     def initial_page_content(page)
                       page.pretty_title.to_s
                     end
                   end
                 end
               end
             end

test/unit/lib/redmine/wiki_formatting_test.rb +4 0

             # Redmine - project management software
             # Copyright (C) 2006-2013  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.expand_path('../../../../test_helper', __FILE__)
             class Redmine::WikiFormattingTest < ActiveSupport::TestCase
               fixtures :issues
               def test_textile_formatter
                 assert_equal Redmine::WikiFormatting::Textile::Formatter, Redmine::WikiFormatting.formatter_for('textile')
                 assert_equal Redmine::WikiFormatting::Textile::Helper, Redmine::WikiFormatting.helper_for('textile')
               end
               def test_null_formatter
                 assert_equal Redmine::WikiFormatting::NullFormatter::Formatter, Redmine::WikiFormatting.formatter_for('')
                 assert_equal Redmine::WikiFormatting::NullFormatter::Helper, Redmine::WikiFormatting.helper_for('')
               end
+              def test_formats_for_select
+                assert_include ['Textile', 'textile'], Redmine::WikiFormatting.formats_for_select
+              end
               def test_should_link_urls_and_email_addresses
                 raw = <<-DIFF
             This is a sample *text* with a link: http://www.redmine.org
             and an email address foo@example.net
             DIFF
                 expected = <<-EXPECTED
             <p>This is a sample *text* with a link: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a><br />
             and an email address <a class="email" href="mailto:foo@example.net">foo@example.net</a></p>
             EXPECTED
                 assert_equal expected.gsub(%r{[\r\n\t]}, ''), Redmine::WikiFormatting::NullFormatter::Formatter.new(raw).to_html.gsub(%r{[\r\n\t]}, '')
               end
               def test_supports_section_edit
                 with_settings :text_formatting => 'textile' do
                   assert_equal true, Redmine::WikiFormatting.supports_section_edit?
                 end
                 with_settings :text_formatting => '' do
                   assert_equal false, Redmine::WikiFormatting.supports_section_edit?
                 end
               end
               def test_cache_key_for_saved_object_should_no_be_nil
                 assert_not_nil Redmine::WikiFormatting.cache_key_for('textile', 'Text', Issue.find(1), :description)
               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