themes_for_rails 0.4.3 → 0.5.0.pre

data/lib/themes_for_rails.rb

@@ -1,7 +1,6 @@
+# encoding: utf-8
 module ThemesForRails
-  
-  VERSION = '0.4.3'
-  
+
   class << self
 
     def config
@@ -45,13 +44,15 @@ module ThemesForRails
 end
 
 require 'active_support/dependencies'
+require 'themes_for_rails/interpolation'
 require 'themes_for_rails/config'
 require 'themes_for_rails/common_methods'
 require 'themes_for_rails/url_helpers'
-require 'themes_for_rails/view_helpers'
+
+require 'themes_for_rails/action_view'
 require 'themes_for_rails/assets_controller'
-require 'themes_for_rails/controller_methods'
-require 'themes_for_rails/mailer_methods'
+require 'themes_for_rails/action_controller'
+require 'themes_for_rails/action_mailer'
 require 'themes_for_rails/railtie'
 require 'themes_for_rails/routes'
 

data/lib/themes_for_rails/{controller_methods.rb → action_controller.rb}

@@ -1,26 +1,32 @@
+# encoding: utf-8
 module ThemesForRails
-  module ControllerMethods
+
+  module ActionController
+
     extend ActiveSupport::Concern
+
     included do
+
       include ThemesForRails::CommonMethods
       include ThemesForRails::UrlHelpers
+
     end
+
     module ClassMethods
+
       def theme(name, options = {})
         before_filter(options) do |controller|
           controller.set_theme(name)
         end
       end
+
     end
-    module InstanceMethods
-      def theme(name)
-        set_theme(name)
-      end
+
+    def theme(name)
+      set_theme(name)
     end
-  end
-end
 
-ActiveSupport.on_load(:action_controller) { include ThemesForRails::ControllerMethods }
+  end
 
-ActiveSupport.on_load(:action_mailer) { include ThemesForRails::ControllerMethods }
+end
 

data/lib/themes_for_rails/action_mailer.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+module ThemesForRails
+
+  module ActionMailer
+
+    extend ActiveSupport::Concern
+
+    included do
+      include ThemesForRails::ActionController
+      alias_method_chain :mail, :theme
+    end
+
+    def mail_with_theme(headers = {}, &block)
+      theme_opts = headers[:theme] || self.class.default[:theme]
+      theme(theme_opts) if theme_opts
+
+      mail_without_theme(headers, &block)
+    end
+    
+  end
+
+end

data/lib/themes_for_rails/action_view.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+module ThemesForRails
+  
+  module ActionView
+
+    extend ActiveSupport::Concern
+
+    included do
+      include ThemesForRails::CommonMethods
+    end
+
+    def current_theme_stylesheet_path(asset)
+      base_theme_stylesheet_path(:theme => self.theme_name, :asset => "#{asset}.css")
+    end
+    
+    def current_theme_javascript_path(asset)
+      base_theme_javascript_path(:theme => self.theme_name, :asset => "#{asset}.js")
+    end
+
+    def current_theme_image_path(asset)
+      base_theme_image_path(:theme => self.theme_name, :asset => asset)
+    end
+
+    def theme_stylesheet_path(asset, new_theme_name = self.theme_name)
+      base_theme_stylesheet_path(:theme => new_theme_name, :asset => "#{asset}.css")
+    end
+
+    def theme_javascript_path(asset, new_theme_name = self.theme_name)
+      base_theme_javascript_path(:theme => new_theme_name, :asset => "#{asset}.js")
+    end
+
+    def theme_image_path(asset, new_theme_name = self.theme_name)
+      base_theme_image_path(:theme => new_theme_name, :asset => asset)
+    end
+    
+    def theme_image_tag(source, options = {})
+      image_tag(theme_image_path(source), options)
+    end
+
+    def theme_image_submit_tag(source, options = {})
+      image_submit_tag(theme_image_path(source), options)
+    end
+
+    def theme_javascript_include_tag(*files)
+      options = files.extract_options!
+      options.merge!({ :type => "text/javascript" })
+      files.collect! {|file| theme_javascript_path(file) }
+      javascript_include_tag(*files, options)
+    end
+
+    def theme_stylesheet_link_tag(*files)
+      options = files.extract_options!
+      options.merge!({ :type => "text/css" })
+      files.collect! {|file| theme_stylesheet_path(file) }
+      stylesheet_link_tag(*files, options)
+    end
+  end
+end
+

data/lib/themes_for_rails/assets_controller.rb

@@ -1,49 +1,48 @@
+# encoding: utf-8
 require "action_controller/metal"
 
 module ThemesForRails
   class AssetsController < ActionController::Base
 
-    include ThemesForRails::CommonMethods
-    include ThemesForRails::UrlHelpers
-
     def stylesheets
-      handle_asset(params[:asset], params[:theme], "stylesheets")
+      handle_asset("stylesheets")
     end
 
     def javascripts
-      handle_asset(params[:asset], params[:theme], "javascripts")
+      handle_asset("javascripts")
     end
 
     def images
-      handle_asset(params[:asset], params[:theme], "images")
+      handle_asset("images")
     end
 
   private
     
-    def handle_asset(asset, theme, prefix)
+    def handle_asset(prefix)
+      asset, theme = params[:asset], params[:theme]
       find_themed_asset(asset, theme, prefix) do |path, mime_type|
         send_file path, :type => mime_type, :disposition => "inline"
       end
     end
     
-    def find_themed_asset(asset_name, asset_theme, asset_prefix, &block)
-      path = asset_path(asset_name, asset_theme, asset_prefix)
+    def find_themed_asset(asset_name, asset_theme, asset_type, &block)
+      path = asset_path(asset_name, asset_theme, asset_type)
       if File.exists?(path)
         yield path, mime_type_for(request)
       elsif File.extname(path).blank?
         asset_name = "#{asset_name}.#{extension_from(request.path_info)}"
-        return find_themed_asset(asset_name, asset_theme, asset_prefix, &block) 
+        return find_themed_asset(asset_name, asset_theme, asset_type, &block) 
       else
         render_not_found
       end
     end
 
-    def asset_path(asset_name, asset_theme, asset_prefix)
-      File.join(theme_path_for(asset_theme), asset_prefix, asset_name)
+    def asset_path(asset_name, asset_theme, asset_type)
+      File.join(theme_asset_path_for(asset_theme), asset_type, asset_name)
     end
 
     def render_not_found
-      render :text => 'not found', :status => 404
+      render :text => 'Not found', :status => 404
     end
       
     def mime_type_for(request)

data/lib/themes_for_rails/common_methods.rb

@@ -1,8 +1,9 @@
+# encoding: utf-8
 module ThemesForRails
   module CommonMethods
-    def view_path_for(theme)
-      File.join(theme_path_for(theme), "views")
-    end
+
+    include ThemesForRails::Interpolation
+
     def theme_name
       @cached_theme_name ||= begin
         case @theme_name
@@ -14,35 +15,52 @@ module ThemesForRails
         end
       end
     end
+    
     def theme_name=(name)
       @theme_name = name
     end
+
     def set_theme(name)
       self.theme_name = name
       if valid_theme?
         add_theme_view_path
       end
     end
-  public
+    
+    public
+    
     def valid_theme?
       !self.theme_name.nil?
     end
+    
     # will add the view path for the current theme
     def add_theme_view_path
       add_theme_view_path_for(self.theme_name)
     end
+    
     # will add the view path for a given theme name
     def add_theme_view_path_for(name)
-      self.view_paths.insert 0, ActionView::FileSystemResolver.new(view_path_for(name))
+      self.view_paths.insert 0, ::ActionView::FileSystemResolver.new(theme_view_path_for(name))
     end
+
     def public_theme_path
-      theme_path("/")
+      theme_view_path("/")
+    end
+
+    def theme_asset_path
+      theme_asset_path_for(theme_name)
+    end
+
+    def theme_view_path
+      theme_view_path_for(theme_name)
     end
-    def theme_path(base = ThemesForRails.config.base_dir)
-      theme_path_for(theme_name, base)
+
+    def theme_view_path_for(theme_name)
+      interpolate(ThemesForRails.config.views_dir, theme_name)
     end
-    def theme_path_for(name, base = ThemesForRails.config.base_dir, theme_dir = ThemesForRails.config.themes_dir)
-      File.join(base, theme_dir, name)
+
+    def theme_asset_path_for(theme_name)
+      interpolate(ThemesForRails.config.assets_dir, theme_name)
     end
   end
 end

data/lib/themes_for_rails/config.rb

@@ -1,29 +1,66 @@
+# encoding: utf-8
 module ThemesForRails
   class Config
 
-    attr_writer :base_dir, :themes_dir
-    attr_accessor :use_sass
+    attr_writer :base_dir, :themes_dir, :assets_dir, :views_dir, :themes_routes_dir
+    attr_accessor :use_sass, :default_theme
     
+    include Interpolation
+
     def initialize(&block)
       @use_sass = true
+      @default_theme = 'default'
       yield if block_given?
     end
     
     def base_dir
-      @base_dir ||= Rails.root
+      @base_dir ||= Rails.root.to_s
+    end
+    
+    # relative assets dir for view overloading support
+    # used for theme_view_path_for method to get theme path and add to view paths.
+    # Defaults to themes_dir for non asset pipeline users
+    #
+    # If you are using the Rails Asset Pipeline, this should be changed to the 
+    # path of your assets in your app. For example, if you store your themes
+    # under /app/assets/themes - {Rails.root}/app/assets/themes
+    # you would need to set this to 'app/assets/themes' in your initializer config
+    def assets_dir
+      @assets_dir ||= ":root/themes/:name"
+    end
+    
+    # relative views directory for theme views to be separated from assets
+    # used for Asset Pipeline support. Defaults to match {assets_dir}/views
+    def views_dir
+      @views_dir ||= ":root/themes/:name/views"
     end
     
     def themes_dir
-      @themes_dir ||= "themes"
+      @themes_dir ||= ":root/themes"
     end
     
+    # Full path to themes
     def themes_path
-      File.join(base_dir, themes_dir)
+      interpolate(themes_dir)
     end
-    
+
+    # This is the base themes dir that is used for mapping URL paths.
+    # 
+    # If you are using the Rails Asset Pipeline, this should be changed to the
+    # prefix dir of your assets path. For example, if you store your themes
+    # under /app/assets/themes - {Rails.root}/app/assets/themes
+    # you would need to set this value to 'assets' to match up with the Sprockets
+    # path resolution process.
+
+    def themes_routes_dir
+      @themes_routes_dir ||= "themes"  
+    end
+
     def clear
-      @base_dir = nil
+      @base_dir   = nil
       @themes_dir = nil
+      @assets_dir = nil
+      @views_dir  = nil
     end
 
     def use_sass?

data/lib/themes_for_rails/interpolation.rb

@@ -0,0 +1,11 @@
+module ThemesForRails
+
+  module Interpolation
+
+    def interpolate(pattern, name = nil)
+      pattern.gsub(":root", ThemesForRails.config.base_dir).gsub(":name", name.to_s)
+    end
+
+  end
+  
+end

data/lib/themes_for_rails/railtie.rb

@@ -1,7 +1,7 @@
-# ActiveSupport.on_load(:action_view) { include Devise::Controllers::UrlHelpers }
-
+# encoding: utf-8
 module ThemesForRails
   class Railtie < ::Rails::Railtie
+
     config.themes_for_rails = ActiveSupport::OrderedOptions.new
 
     config.to_prepare do
@@ -12,6 +12,17 @@ module ThemesForRails
       # Adding theme stylesheets path to sass, automatically. 
       ThemesForRails.add_themes_path_to_sass if ThemesForRails.config.use_sass?
       
+      ActiveSupport.on_load(:action_view) do
+        include ThemesForRails::ActionView
+      end
+
+      ActiveSupport.on_load(:action_controller) do
+        include ThemesForRails::ActionController
+      end
+
+      ActiveSupport.on_load(:action_mailer) do
+        include ThemesForRails::ActionMailer
+      end
     end
     
     rake_tasks do

data/lib/themes_for_rails/routes.rb

@@ -1,16 +1,27 @@
+# encoding: utf-8
 module ThemesForRails
   module Routes
+
     def themes_for_rails
-      theme_dir = ThemesForRails.config.themes_dir
-      match "#{theme_dir}/:theme/stylesheets/*asset" => 'themes_for_rails/assets#stylesheets', :as => :base_theme_stylesheet
-      match "#{theme_dir}/:theme/javascripts/*asset" => 'themes_for_rails/assets#javascripts', :as => :base_theme_javascript
-      match "#{theme_dir}/:theme/images/*asset" => 'themes_for_rails/assets#images', :as => :base_theme_image
+      theme_dir = ThemesForRails.config.themes_routes_dir
+      constraints = { :theme => /[\w\.]*/ } 
+      
+      match "#{theme_dir}/:theme/stylesheets/*asset" => 'themes_for_rails/assets#stylesheets', 
+        :as => :base_theme_stylesheet, :constraints => constraints
+      match "#{theme_dir}/:theme/javascripts/*asset" => 'themes_for_rails/assets#javascripts', 
+        :as => :base_theme_javascript, :constraints => constraints
+      match "#{theme_dir}/:theme/images/*asset" => 'themes_for_rails/assets#images', 
+        :as => :base_theme_image, :constraints => constraints
     end
+
   end
 end
+
 module ActionDispatch::Routing
   class Mapper #:nodoc:
+
     include ThemesForRails::Routes
+
   end
 end
 

data/lib/themes_for_rails/url_helpers.rb

@@ -1,23 +1,27 @@
+# encoding: utf-8
 module ThemesForRails
   module UrlHelpers
+
     extend ActiveSupport::Concern
+    
     included do
-      include ThemesForRails::CommonMethods
       helper_method :current_theme_stylesheet_path, 
         :current_theme_javascript_path, 
         :current_theme_image_path
     end
-    module InstanceMethods
-      def current_theme_stylesheet_path(asset)
-        base_theme_stylesheet_path(:theme => self.theme_name, :asset => "#{asset}.css")
-      end
-      def current_theme_javascript_path(asset)
-        base_theme_javascript_path(:theme => self.theme_name, :asset => "#{asset}.js")
-      end
-      def current_theme_image_path(asset)
-        image, extension = asset.split(".")
-        base_theme_image_path(:theme => self.theme_name, :asset => "#{image}.#{extension}")
-      end
+    
+    def current_theme_stylesheet_path(asset)
+      base_theme_stylesheet_path(:theme => self.theme_name, :asset => "#{asset}.css")
     end
+
+    def current_theme_javascript_path(asset)
+      base_theme_javascript_path(:theme => self.theme_name, :asset => "#{asset}.js")
+    end
+
+    def current_theme_image_path(asset)
+      image, extension = asset.split(".")
+      base_theme_image_path(:theme => self.theme_name, :asset => "#{image}.#{extension}")
+    end
+
   end
 end