jro_apps/redmine Commit - r4444:523febf9c1b3

Support for Javascript in Themes (#2803)....

Jean-Philippe Lang -

r4444:523febf9c1b3

parent child

Context file:

r4444:523febf9c1b3

Collapse all files

test/integration/lib/redmine/themes_test.rb created 644 +60 0

@@ -0,0 +1,60
	1	# Redmine - project management software
	2	# Copyright (C) 2006-2010 Jean-Philippe Lang
	3	#
	4	# This program is free software; you can redistribute it and/or
	5	# modify it under the terms of the GNU General Public License
	6	# as published by the Free Software Foundation; either version 2
	7	# of the License, or (at your option) any later version.
	8	#
	9	# This program is distributed in the hope that it will be useful,
	10	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	# GNU General Public License for more details.
	13	#
	14	# You should have received a copy of the GNU General Public License
	15	# along with this program; if not, write to the Free Software
	16	# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
	17
	18	require File.expand_path('../../../../test_helper', __FILE__)
	19
	20	class ThemesTest < ActionController::IntegrationTest
	21	fixtures :all
	22
	23	def setup
	24	@theme = Redmine::Themes.themes.last
	25	Setting.ui_theme = @theme.id
	26	end
	27
	28	def teardown
	29	Setting.ui_theme = ''
	30	end
	31
	32	def test_application_css
	33	get '/'
	34
	35	assert_response :success
	36	assert_tag :tag => 'link',
	37	:attributes => {:href => %r{^/themes/#{@theme.dir}/stylesheets/application.css}}
	38	end
	39
	40	def test_without_theme_js
	41	get '/'
	42
	43	assert_response :success
	44	assert_no_tag :tag => 'script',
	45	:attributes => {:src => %r{^/themes/#{@theme.dir}/javascripts/theme.js}}
	46	end
	47
	48	def test_with_theme_js
	49	# Simulates a theme.js
	50	@theme.javascripts << 'theme'
	51	get '/'
	52
	53	assert_response :success
	54	assert_tag :tag => 'script',
	55	:attributes => {:src => %r{^/themes/#{@theme.dir}/javascripts/theme.js}}
	56
	57	ensure
	58	@theme.javascripts.delete 'theme'
	59	end
	60	end

app/views/layouts/base.rhtml +1 0

             <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
             <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
             <head>
             <meta http-equiv="content-type" content="text/html; charset=utf-8" />
             <title><%=h html_title %></title>
             <meta name="description" content="<%= Redmine::Info.app_name %>" />
             <meta name="keywords" content="issue,bug,tracker" />
             <%= favicon %>
             <%= stylesheet_link_tag 'application', :media => 'all' %>
             <%= stylesheet_link_tag 'rtl', :media => 'all' if l(:direction) == 'rtl' %>
             <%= javascript_include_tag :defaults %>
+            <%= heads_for_theme %>
             <%= heads_for_wiki_formatter %>
             <!--[if IE]>
                 <style type="text/css">
                   * html body{ width: expression( document.documentElement.clientWidth < 900 ? '900px' : '100%' ); }
                   body {behavior: url(<%= stylesheet_path "csshover.htc" %>);}
                 </style>
             <![endif]-->
             <%= call_hook :view_layouts_base_html_head %>
             <!-- page specific tags -->
             <%= yield :header_tags -%>
             </head>
             <body class="<%= body_css_classes %>">
             <div id="wrapper">
             <div id="wrapper2">
             <div id="top-menu">
                 <div id="account">
                     <%= render_menu :account_menu -%>
                 </div>
                 <%= content_tag('div', "#{l(:label_logged_as)} #{link_to_user(User.current, :format => :username)}", :id => 'loggedas') if User.current.logged? %>
                 <%= render_menu :top_menu -%>
             </div>
             <div id="header">
                 <div id="quick-search">
                     <% form_tag({:controller => 'search', :action => 'index', :id => @project}, :method => :get ) do %>
                     <%= hidden_field_tag(controller.default_search_scope, 1, :id => nil) if controller.default_search_scope %>
                     <%= link_to l(:label_search), {:controller => 'search', :action => 'index', :id => @project}, :accesskey => accesskey(:search) %>:
                     <%= text_field_tag 'q', @question, :size => 20, :class => 'small', :accesskey => accesskey(:quick_search) %>
                     <% end %>
                     <%= render_project_jump_box %>
                 </div>
                 <h1><%= page_header_title %></h1>
                 <% if display_main_menu?(@project) %>
                 <div id="main-menu">
                     <%= render_main_menu(@project) %>
                 </div>
                 <% end %>
             </div>
             <%= tag('div', {:id => 'main', :class => (has_content?(:sidebar) ? '' : 'nosidebar')}, true) %>
                 <div id="sidebar">
                     <%= yield :sidebar %>
                     <%= call_hook :view_layouts_base_sidebar %>
                 </div>
                 <div id="content">
             				<%= render_flash_messages %>
                     <%= yield %>
                     <%= call_hook :view_layouts_base_content %>
             				<div style="clear:both;"></div>
                 </div>
             </div>
             <div id="ajax-indicator" style="display:none;"><span><%= l(:label_loading) %></span></div>
             <div id="footer">
               <div class="bgl"><div class="bgr">
                 Powered by <%= link_to Redmine::Info.app_name, Redmine::Info.url %> &copy; 2006-2010 Jean-Philippe Lang
               </div></div>
             </div>
             </div>
             </div>
             <%= call_hook :view_layouts_base_body_bottom %>
             </body>
             </html>

lib/redmine/themes.rb +45 -5

             # 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 Themes
                 # Return an array of installed themes
                 def self.themes
                   @@installed_themes ||= scan_themes
                 end
                 # Rescan themes directory
                 def self.rescan
                   @@installed_themes = scan_themes
                 end
                 # Return theme for given id, or nil if it's not found
                 def self.theme(id, options={})
                   found = themes.find {|t| t.id == id}
                   if found.nil? && options[:rescan] != false
                     rescan
                     found = theme(id, :rescan => false)
                   end
                   found
                 end
                 # Class used to represent a theme
                 class Theme
-                  attr_reader :name, :dir, :stylesheets
+                  attr_reader :path, :name, :dir
                   def initialize(path)
+                    @path = path
                     @dir = File.basename(path)
                     @name = @dir.humanize
-                    @stylesheets = Dir.glob("#{path}/stylesheets/*.css").collect {|f| File.basename(f).gsub(/\.css$/, '')}
+                    @stylesheets = nil
+                    @javascripts = nil
                   end
                   # Directory name used as the theme id
                   def id; dir end
                   def ==(theme)
                     theme.is_a?(Theme) && theme.dir == dir
                   end
                   def <=>(theme)
                     name <=> theme.name
                   end
+                  def stylesheets
+                    @stylesheets ||= assets("stylesheets", "css")
+                  end
+                  def javascripts
+                    @javascripts ||= assets("javascripts", "js")
+                  end
+                  def stylesheet_path(source)
+                    "/themes/#{dir}/stylesheets/#{source}"
+                  end
+                  def javascript_path(source)
+                    "/themes/#{dir}/javascripts/#{source}"
+                  end
+                  private
+                  def assets(dir, ext)
+                    Dir.glob("#{path}/#{dir}/*.#{ext}").collect {|f| File.basename(f).gsub(/\.#{ext}$/, '')}
+                  end
                 end
                 private
                 def self.scan_themes
                   dirs = Dir.glob("#{Rails.public_path}/themes/*").select do |f|
                     # A theme should at least override application.css
                     File.directory?(f) && File.exist?("#{f}/stylesheets/application.css")
                   end
                   dirs.collect {|dir| Theme.new(dir)}.sort
                 end
               end
             end
             module ApplicationHelper
+              def current_theme
+                unless instance_variable_defined?(:@current_theme)
+                  @current_theme = Redmine::Themes.theme(Setting.ui_theme)
+                end
+                @current_theme
+              end
               def stylesheet_path(source)
-                @current_theme ||= Redmine::Themes.theme(Setting.ui_theme)
+                if current_theme && current_theme.stylesheets.include?(source)
-                super((@current_theme && @current_theme.stylesheets.include?(source)) ?
+                  super current_theme.stylesheet_path(source)
-                  "/themes/#{@current_theme.dir}/stylesheets/#{source}" : source)
+                else
+                  super
+                end
               end
               def path_to_stylesheet(source)
                 stylesheet_path source
               end
+              # Returns the header tags for the current theme
+              def heads_for_theme
+                if current_theme && current_theme.javascripts.include?('theme')
+                  javascript_include_tag current_theme.javascript_path('theme')
+                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