theme_generator 1.1.1 → 1.2.0

data/USAGE

@@ -3,7 +3,7 @@ NAME
              folder structure.
 
 SYNOPSIS
-     theme [theme name]
+     theme [theme name]  (use _system_ to update theme system files only)
 
 DESCRIPTION
      This generator creates general purpose theme support. It's designed to leverage
@@ -12,10 +12,18 @@ DESCRIPTION
 
      Included:
       - Abstraction of Typo style theme support
-      - New View Tag Helpers for accessing themed content
+      - Tag helpers for accessing theme specfic content
+      - Support for overriding views in theme
+      - Support for ERb templates and Liquid templates
+      - Theme system can allow a mix of both template types, or Liquid templates only
+      - Liquid tag for accessing theme specfic content
 
 EXAMPLE
-      ./script/generate theme default
+     ./script/generate theme default
 
      This will generate the file structure for a theme named 'default' and prepare 
      the rails application for theme support. 
+
+	  Starting with version 1.2, you can update just the theme system files by running:
+
+ 	  ./script/generate theme _system_

data/templates/README

@@ -35,26 +35,73 @@ In the views, there are theme specific helper tags available to you.
  - theme_stylesheet_link_tag
  - theme_stylesheet_path
 
+Views can be overidden by placing templates in the themes/[theme_name]/views
+folder. You can use the default ERb templates, or Liquid templates.
+
+You can tell the theme system to only allow Liquid templates in a theme by
+setting 'force_liquid' in your controller:
+
+ class ApplicationController < ActionController::Base
+ 
+   layout 'default'
+   theme 'blue'
+
+   force_liquid true
+ 
+ end
+
+If force_liquid is set to true, the theme system will only render .liquid 
+template files. If .rhtml templates are found, an exception is raised.
+
+    Note: force_liquid is only for theme templates. Your 
+          application templates can still be ERb (.rhtml) 
+          files.
+
 Before hosting, I would recommend running the rake task to pre-cache all of 
 the theme files:
 
-  rake create_theme_cache
+  rake theme_create_cache
   
 There is also a handy rake task for removing all the cached theme files:
 
-  rake remove_theme_cache
+  rake theme_remove_cache
+
+You can also update the cache:
+
+  rake theme_update_cache
+
+== Upgrading
+
+Starting with version 1.2, you can update just the theme system files by
+running:
+
+  ./script/generate theme _system_
 
 
 == 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.2.0 - Updated actionview_ex with the new render_file additions from 
+        Typo. Renamed the rake tasks so that they all start with 
+				'theme' (theme_create_cache, theme_remove_cache, 
+				theme_update_cache). You can update the system files by running:
+				
+				  $ ./script/generate theme _system_
+
+        Full support for Liquid templates, as well as an option to only
+        allow Liquid templates in a theme.
+
+1.1.1 - Added rake tasks for pre-caching the themes, and removing the
+        cached themes. 
+
 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.
-1.1.1 - Added rake tasks for pre-caching the themes, and removing the
-        cached themes. 
+
+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.0.1 - Added 'themes' directory, theme definition file, and symlinks 
+        to the appropriate directories on supported platforms.
+
+1.0.0 - Initial release

data/templates/actioncontroller_ex.rb

@@ -3,42 +3,41 @@
 ActionController::Base.class_eval do 
 
    attr_accessor :current_theme
-
+   attr_accessor :force_liquid_template
+   
    def self.theme(theme_name, conditions = {})
      # TODO: Allow conditions... (?)
      write_inheritable_attribute "theme", theme_name
    end
 
+   def self.force_liquid(force_liquid_value, conditions = {})
+     # TODO: Allow conditions... (?)
+     write_inheritable_attribute "force_liquid", force_liquid_value
+   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
+     @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)
+   
+   def force_liquid_template(passed_value=nil)
+      force_liquid = passed_value || self.class.read_inheritable_attribute("force_liquid")
+
+      force_liquid_template = case force_liquid
+        when Symbol then send(force_liquid)
+        when Proc   then force_liquid.call(self)
+        when String then force_liquid == 'true'
+        when TrueClass then force_liquid
+        when FalseClass then force_liquid
+        when Fixnum then force_liquid == 1
       end
    end
 

data/templates/actionview_ex.rb

@@ -1,21 +1,46 @@
+# Extend the Base ActionView to support rendering themes
+#
 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)
+   class ThemeError < StandardError
+   end
+   
+   class Base
+      alias_method :__render_file, :render_file
+
+      def render_file(template_path, use_full_path = true, local_assigns = {})
+         search_path = [
+            "../themes/#{controller.current_theme}/views",      # for components
+            "../../themes/#{controller.current_theme}/views",   # for normal views
+            "../../themes/#{controller.current_theme}",         # for layouts
+            "."                                                 # fallback
+         ]
+
+         if use_full_path
+            search_path.each do |prefix|
+               theme_path = prefix +'/'+ template_path
+               begin
+                  template_extension = pick_template_extension(theme_path)
+                  
+                  # Prevent .rhtml (or any other template type) if force_liquid == true
+                  if controller.force_liquid_template and 
+                     template_extension.to_s != 'liquid' and 
+                     prefix != '.'
+                     raise ThemeError.new("Template '#{template_path}' must be a liquid document")
+                  end
+                  
+                  local_assigns['active_theme'] = controller.current_theme unless controller.current_theme.nil? 
+               rescue ActionView::ActionViewError => err
+                  next
+               rescue ThemeError => err
+                  # Should it raise an exception, or just call 'next' and revert to
+                  # the default template?
+                  raise err
+               end
+               return __render_file(theme_path, use_full_path, local_assigns)
+            end
+         else
+            __render_file(template_path, use_full_path, local_assigns)
+         end
       end
-    end
-  end
-  
-  
+   end
 end

data/templates/init.rb

@@ -3,4 +3,11 @@ require 'actioncontroller_ex'
 require 'routeset_ex'
 require 'theme_helpers'
 
+begin
+   require 'liquid_helpers'   
+rescue
+   # I guess Liquid isn't being used...
+   puts "Liquid helpers weren't loaded: #{$!}"
+end
+
 ActionController::Routing::Routes.install_theme_routes

data/templates/layout.liquid

@@ -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>
+      <link href="{% themeitem %} <%= file_name %> {% endthemeitem %}" media="screen" rel="Stylesheet" type="text/css" />
+   </head>
+   <body>
+      {{ content_for_layout }}
+   </body>
+</html>

data/templates/liquid_helpers.rb

@@ -0,0 +1,45 @@
+# A Liquid Tag for retrieving path information for theme specific media
+#
+# Returns the path based on the file extension
+#
+class Themeitem < Liquid::Block
+
+   @@image_exts = %w( .png .jpg .jpeg .jpe .gif )
+
+   @@stylesheet_exts = %w( .css )
+
+   @@javascript_exts = %w( .js .htc )
+                                      
+   def initialize(markup, tokens)
+      super
+      #@media_type = markup.strip
+   end
+
+   def block_delimiter
+     ["endthemeitem"]
+   end                           
+   
+   def block_name
+     "themeitem"
+   end
+
+   def render(context)
+      # Which, if either, of these are correct?
+      base_url = context['request'].relative_url_root || ActionController::Base.asset_host.to_s
+
+      filename = @nodelist.join('').strip
+      ext = File.extname( filename )
+
+      if @@image_exts.include?( ext )
+         "#{base_url}/themes/#{context['active_theme']}/images/#{filename}"
+
+      elsif @@stylesheet_exts.include?( ext )
+         "#{base_url}/themes/#{context['active_theme']}/stylesheets/#{filename}"
+         
+      elsif @@javascript_exts.include?( ext )
+         "#{base_url}/themes/#{context['active_theme']}/javascripts/#{filename}"
+      end
+   end   
+end
+
+Liquid::Template.register_block( 'themeitem', Themeitem )

data/templates/theme.rb

@@ -8,11 +8,7 @@ class Theme
     @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
@@ -20,17 +16,6 @@ class Theme
   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}"

data/templates/themes.rake

@@ -1,6 +1,6 @@
 
 desc "Creates the cached (public) theme folders"
-task :create_theme_cache do
+task :theme_create_cache do
   for theme in Dir.glob("#{RAILS_ROOT}/themes/*")
     theme_name = theme.split( File::Separator )[-1]
     puts "Creating #{RAILS_ROOT}/public/themes/#{theme_name}"
@@ -15,7 +15,11 @@ task :create_theme_cache do
 end
 
 desc "Removes the cached (public) theme folders"
-task :remove_theme_cache do
+task :theme_remove_cache do
+  puts "Creating #{RAILS_ROOT}/public/themes/#{theme_name}"
   FileUtils.rm_r Dir.glob("#{RAILS_ROOT}/public/themes/*")
   FileUtils.rm_r "#{RAILS_ROOT}/public/themes", :force => true
 end
+
+desc "Updates the cached (public) theme folders"
+task :theme_update_cache => [:theme_remove_cache, :theme_create_cache]

data/theme_generator.rb

@@ -1,23 +1,30 @@
 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' )
+         if file_name != '_system_'
+
+            # 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, "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.template 'layout.liquid', File.join( 'themes', file_name, 'layouts', 'default.liquid' )
 
-         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" )
+         
+         end
 
-         m.directory File.join( "themes", file_name, "views" )
-         m.directory File.join( "themes", file_name, "images" )
-         m.directory File.join( "themes", file_name, "javascript" )
+         # Readme file
+         m.template 'README', "README_THEMES"
 
          # The ThemeEngine plugins
          m.directory File.join( "vendor", "plugins", "theme_engine" )
@@ -25,6 +32,7 @@ class ThemeGenerator < Rails::Generator::NamedBase
          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 'liquid_helpers.rb', File.join( 'vendor', 'plugins', 'theme_engine', 'lib', 'liquid_helpers.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' )
          m.directory File.join( "vendor", "plugins", "theme_engine", "tasks" )
@@ -34,6 +42,7 @@ class ThemeGenerator < Rails::Generator::NamedBase
          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

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: theme_generator
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
-date: 2005-11-01 00:00:00 -06:00
+  version: 1.2.0
+date: 2005-11-11 00:00:00 -06:00
 summary: "[Rails] Theme generator adds support for themes into Rails applications"
 require_paths: 
   - lib
@@ -39,6 +39,8 @@ files:
   - templates/theme_controller.rb
   - templates/actioncontroller_ex.rb
   - templates/layout.rhtml
+  - templates/layout.liquid
+  - templates/liquid_helpers.rb
   - templates/theme.css
   - templates/theme_helpers.rb
   - templates/themes.rake