theme_generator 1.1.0

data/USAGE

@@ -0,0 +1,21 @@
+NAME
+     theme - Initializes the application to support themes and creates a new theme
+             folder structure.
+
+SYNOPSIS
+     theme [theme name]
+
+DESCRIPTION
+     This generator creates general purpose theme support. It's designed to leverage
+     webservers for the static content of the theme (images, stylesheets, javascripts, 
+     etc).
+
+     Included:
+      - Abstraction of Typo style theme support
+      - New View Tag Helpers for accessing themed content
+
+EXAMPLE
+      ./script/generate theme default
+
+     This will generate the file structure for a theme named 'default' and prepare 
+     the rails application for theme support. 

data/templates/README

@@ -0,0 +1,55 @@
+== Usage
+
+You can specify the current theme the same way you would a layout:
+
+  class ApplicationController < ActionController::Base
+    
+    layout 'default'
+    theme 'blue'
+    
+  end
+
+If your application supports per-user themes, and the user's selected theme is 
+stored in the user object, you could implement that like this:
+
+  class ApplicationController < ActionController::Base
+  
+    layout 'default'
+    theme :get_user_theme
+
+    # If a user is logged in, use their theme choice, otherwise
+    # use the theme named 'default'
+    def get_user_theme
+       return @session[:user].theme unless @session[:user].nil?
+       'default'
+    end
+  
+  end
+
+In the views, there are theme specific helper tags available to you.
+
+ - theme_image_tag
+ - theme_image_path
+ - theme_javascript_include_tag
+ - theme_javascript_path
+ - theme_stylesheet_link_tag
+ - theme_stylesheet_path
+
+
+== In the future...
+
+ - Add a rake task to pre-cache all static theme files (stylesheets, images, and javascript)
+ - Add a rake task to remove all cached theme files
+
+
+== Changelog
+
+1.0.0 - Initial release
+1.0.1 - Added 'themes' directory, theme definition file, and symlinks 
+        to the appropriate directories on supported platforms.
+1.0.2 - The current_theme is now retrieved from the controller. Where
+        symlinks are created on *nix systems, shortcuts are created 
+        on Windows if Win32Utils is installed.
+1.1.0 - [Breaking] Abstraction of the Typo theme system. The themes are
+        now the same as is used in Typo. The theme engine itself is a
+        combination of plugins and a component.

data/templates/about.markdown

@@ -0,0 +1,3 @@
+### <%= class_name %>
+
+This description can be found in  themes/<%= class_name %>/about.markdown

data/templates/actioncontroller_ex.rb

@@ -0,0 +1,45 @@
+# Extend the Base ActionController to support themes
+#
+ActionController::Base.class_eval do 
+
+   attr_accessor :current_theme
+
+   def self.theme(theme_name, conditions = {})
+     # TODO: Allow conditions... (?)
+     write_inheritable_attribute "theme", theme_name
+   end
+
+   # You need to override this in your +ApplicationController+
+   # This should return the current theme name
+   def current_theme(passed_theme=nil)
+     theme = passed_theme || self.class.read_inheritable_attribute("theme")
+     
+     active_theme = case theme
+       when Symbol then send(theme)
+       when Proc   then theme.call(self)
+       when String then theme
+     end
+   end
+
+private
+
+   alias_method :__active_layout, :active_layout
+
+   def active_layout(passed_layout = nil)
+      unless current_theme.nil?
+        puts "THEME LAYOUT"
+        layout = passed_layout || self.class.read_inheritable_attribute("layout")
+        
+        active_layout = case layout
+          when Symbol then send(layout)
+          when Proc   then layout.call(self)
+          when String then layout
+        end
+
+        active_layout.include?("/") ? active_layout : Theme.new(current_theme).layout(active_layout) if active_layout
+      else
+        __active_layout(passed_layout)
+      end
+   end
+
+end

data/templates/actionview_ex.rb

@@ -0,0 +1,21 @@
+module ActionView
+  class Base
+    alias_method :__render_file, :render_file
+    
+    def render_file(template_path, use_full_path = true, local_assigns = {})
+      if use_full_path
+        begin
+          theme_path = "../../themes/#{controller.current_theme}/views/#{template_path}"
+          template_extension = pick_template_extension(theme_path)
+          __render_file(theme_path, use_full_path, local_assigns)
+        rescue => err
+          __render_file(template_path, use_full_path, local_assigns)
+        end
+      else
+        __render_file(template_path, use_full_path, local_assigns)
+      end
+    end
+  end
+  
+  
+end

data/templates/init.rb

@@ -0,0 +1,6 @@
+require 'actionview_ex'
+require 'actioncontroller_ex'
+require 'routeset_ex'
+require 'theme_helpers'
+
+ActionController::Routing::Routes.create_theme_routes

data/templates/layout.rhtml

@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+   <head>
+      <title></title>
+      <%%= theme_stylesheet_link_tag %>
+   </head>
+   <body>
+      <%%= @content_for_layout %>
+   </body>
+</html>

data/templates/routeset_ex.rb

@@ -0,0 +1,22 @@
+
+class ActionController::Routing::RouteSet
+
+  alias_method :__reload, :reload
+
+  def reload
+    __reload
+    create_theme_routes
+  end
+
+  def create_theme_routes    
+    named_route 'theme_images', "/themes/:theme/images/:filename", :controller=>'theme_system/theme', :action=>'images'
+    named_route 'theme_stylesheets', "/themes/:theme/stylesheets/:filename", :controller=>'theme_system/theme', :action=>'stylesheets'
+    named_route 'theme_javascript', "/themes/:theme/javascript/:filename", :controller=>'theme_system/theme', :action=>'javascript'
+
+    connect "/themes/*", :controller=>'theme_system/theme', :action=>'error'
+
+    write_generation
+    write_recognition
+    ActionController::Routing::NamedRoutes.install
+  end
+end

data/templates/theme.css

@@ -0,0 +1,5 @@
+/*
+   Main StyleSheet for the '<%= class_name %>' theme
+*/
+
+/* Your CSS here... */

data/templates/theme.rb

@@ -0,0 +1,59 @@
+class Theme
+  cattr_accessor :cache_theme_lookup
+  @@cache_theme_lookup = false
+
+  attr_accessor :name, :path, :description_html
+
+  def initialize(name, path=nil)
+    @name = name
+    @path = path ||= Theme.path_to_theme(name)
+  end
+  
+  def layout(layout='default')
+    "../../themes/#{name}/layouts/#{layout}"
+  end
+
+  def description
+    File.read("#{path}/about.markdown") rescue "### #{name}"
+  end
+  
+  def self.themes_root
+    RAILS_ROOT + "/themes"
+  end
+
+  # DEPRECATED: There is no 'current' theme, at least, not from here...
+  def self.current_theme_path
+    raise 'DEPRECATED: The current theme is set in the controller'
+    "#{themes_root}/#{config[:theme]}"
+  end
+  # DEPRECATED: There is no 'current' theme, at least, not from here...
+  def self.current
+    theme_from_path(current_theme_path)
+  end
+  
+  
+  def self.path_to_theme(theme)
+    "#{themes_root}/#{theme}"
+  end
+  
+  def self.theme_from_path(path)
+    name = path.scan(/[-\w]+$/i).flatten.first
+    self.new(name, path)
+  end
+
+  def self.find_all
+    installed_themes.inject([]) do |array, path|
+      array << theme_from_path(path)
+    end
+  end
+
+  def self.installed_themes
+    cache_theme_lookup ? @theme_cache ||= search_theme_directory : search_theme_directory
+  end  
+
+  def self.search_theme_directory
+    Dir.glob("#{themes_root}/[-_a-zA-Z0-9]*").collect do |file|
+      file if File.directory?(file)      
+    end.compact
+  end  
+end

data/templates/theme_controller.rb

@@ -0,0 +1,59 @@
+class ThemeSystem::ThemeController < ActionController::Base
+
+  after_filter :cache_theme_files
+  
+  def stylesheets
+    render_theme_item(:stylesheets, params[:filename], params[:theme], 'text/css')
+  end
+
+  def javascript
+    render_theme_item(:javascript, params[:filename], params[:theme], 'text/javascript')
+  end
+
+  def images
+    render_theme_item(:images, params[:filename], params[:theme])
+  end
+
+  def error
+    render :nothing => true, :status => 404
+  end
+  
+  private
+  
+  def render_theme_item(type, file, theme, mime = mime_for(file))
+    render :text => "Not Found", :status => 404 and return if file.split(%r{[\\/]}).include?("..")
+    send_file "#{Theme.path_to_theme(theme)}/#{type}/#{file}", :type => mime, :disposition => 'inline', :stream => false
+  end
+
+  def cache_theme_files
+    path = request.request_uri
+    begin
+      ThemeSystem::ThemeController.cache_page( response.body, path )
+    rescue
+      #STERR.puts "Cache Exception: #{$!}"
+    end
+  end
+
+    
+  def mime_for(filename)
+    case filename.downcase
+    when /\.js$/
+      'text/javascript'
+    when /\.css$/
+      'text/css'
+    when /\.gif$/
+      'image/gif'
+    when /(\.jpg|\.jpeg)$/
+      'image/jpeg'
+    when /\.png$/
+      'image/png'
+    when /\.swf$/
+      'application/x-shockwave-flash'
+    else
+      'application/binary'
+    end
+  end  
+  
+
+end
+

data/templates/theme_helpers.rb

@@ -0,0 +1,69 @@
+#
+# These are theme helper tags
+#
+module ActionView
+   module Helpers
+      module AssetTagHelper
+
+         # TODO: Convert these to user the named route helpers (?)
+
+         # returns the public path to a theme stylesheet
+         def theme_stylesheet_path( source=nil, theme=nil )
+            theme = theme || controller.current_theme
+            compute_public_path(source || "theme", "themes/#{theme}/stylesheets", 'css')
+         end
+
+         # returns the path to a theme image
+         def theme_image_path( source, theme=nil )
+            theme = theme || controller.current_theme
+            compute_public_path(source, "themes/#{theme}/images", 'png')
+         end
+
+         # returns the path to a theme javascript
+         def theme_javascript_path( source, theme=nil )
+            theme = theme || controller.current_theme
+            compute_public_path(source, "themes/#{theme}/javascript", 'js')
+         end
+         
+
+         # This tag it will automatially include the 'theme' css, plus any other 
+         # stylesheets you include in the params...
+         # This doesn't support overriding the Theme -- it will use the current theme
+         def theme_stylesheet_link_tag(*sources)
+            sources << controller.current_theme.to_s
+            sources.uniq!
+            options = sources.last.is_a?(Hash) ? sources.pop.stringify_keys : { }
+            sources.collect { |source|
+               source = theme_stylesheet_path(source)
+               tag("link", { "rel" => "Stylesheet", "type" => "text/css", "media" => "screen", "href" => source }.merge(options))
+            }.join("\n")
+         end
+         
+         # This tag will return a theme-specific IMG
+         def theme_image_tag(source, options = {})
+           options.symbolize_keys
+
+           options[:src] = theme_image_path(source)
+           options[:alt] ||= File.basename(options[:src], '.*').split('.').first.capitalize
+
+           if options[:size]
+             options[:width], options[:height] = options[:size].split("x")
+             options.delete :size
+           end
+
+           tag("img", options)
+         end
+         
+         # This tag can be used to return theme-specific javscripts
+         def theme_javascript_include_tag(*sources)
+           options = sources.last.is_a?(Hash) ? sources.pop.stringify_keys : { }
+           sources = ['prototype', 'effects', 'controls', 'dragdrop'] if sources.first == :defaults
+           sources.collect { |source|
+             source = theme_javascript_path(source)        
+             content_tag("script", "", { "type" => "text/javascript", "src" => source }.merge(options))
+           }.join("\n")
+         end
+
+      end 
+   end
+end

data/theme_generator.rb

@@ -0,0 +1,37 @@
+class ThemeGenerator < Rails::Generator::NamedBase
+   def manifest
+      record do |m|
+         # Readme file
+         m.template 'README', "README_THEMES"
+
+         # Theme folder(s)
+         m.directory File.join( "themes", file_name )
+         m.template 'about.markdown', File.join( 'themes', file_name, 'about.markdown' )
+         m.template 'preview.png', File.join( 'themes', file_name, 'preview.png' )
+         
+         m.directory File.join( "themes", file_name, "stylesheets" )
+         m.template "theme.css", File.join( "themes", file_name, "stylesheets", "#{file_name}.css" )
+
+         m.directory File.join( "themes", file_name, "layouts" )
+         m.template 'layout.rhtml', File.join( 'themes', file_name, 'layouts', 'default.rhtml' )
+
+         m.directory File.join( "themes", file_name, "views" )
+         m.directory File.join( "themes", file_name, "images" )
+         m.directory File.join( "themes", file_name, "javascript" )
+
+         # The ThemeEngine plugins
+         m.directory File.join( "vendor", "plugins", "theme_engine" )
+         m.template 'init.rb', File.join( 'vendor', 'plugins', 'theme_engine', 'init.rb' )
+         m.directory File.join( "vendor", "plugins", "theme_engine", "lib" )
+         m.template 'actioncontroller_ex.rb', File.join( 'vendor', 'plugins', 'theme_engine', 'lib', 'actioncontroller_ex.rb' )
+         m.template 'actionview_ex.rb', File.join( 'vendor', 'plugins', 'theme_engine', 'lib', 'actionview_ex.rb' )
+         m.template 'routeset_ex.rb', File.join( 'vendor', 'plugins', 'theme_engine', 'lib', 'routeset_ex.rb' )
+         m.template 'theme_helpers.rb', File.join( 'vendor', 'plugins', 'theme_engine', 'lib', 'theme_helpers.rb' )
+
+         # The ThemeSystem Component
+         m.directory File.join( "components", "theme_system" )
+         m.template 'theme.rb', File.join( 'components', 'theme_system', 'theme.rb' )
+         m.template 'theme_controller.rb', File.join( 'components', 'theme_system', 'theme_controller.rb' )
+      end
+   end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: theme_generator
+version: !ruby/object:Gem::Version 
+  version: 1.1.0
+date: 2005-10-27 00:00:00 -05:00
+summary: "[Rails] Theme generator adds support for themes into Rails applications"
+require_paths: 
+  - lib
+email: darthapo@gmail.com
+homepage: http://www.mattmccray.com
+rubyforge_project: 
+description: 
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+  - M@ McCray
+files: 
+  - templates/README
+  - templates/actionview_ex.rb
+  - templates/preview.png
+  - templates/theme.rb
+  - templates/about.markdown
+  - templates/init.rb
+  - templates/routeset_ex.rb
+  - templates/theme_controller.rb
+  - templates/actioncontroller_ex.rb
+  - templates/layout.rhtml
+  - templates/theme.css
+  - templates/theme_helpers.rb
+  - USAGE
+  - theme_generator.rb
+test_files: []
+rdoc_options: []
+extra_rdoc_files: []
+executables: []
+extensions: []
+requirements: []
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rails
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Version::Requirement 
+      requirements: 
+        - 
+          - ">"
+          - !ruby/object:Gem::Version 
+            version: 0.0.0
+      version: