themes_for_rails4 1.5.1

data/lib/tasks/themes_for_rails.rake

@@ -0,0 +1,40 @@
+namespace :themes do
+  desc "Creates the cached theme folder"
+  task :create_cache => :environment do
+    for theme in ThemesForRails.available_themes
+      theme_name = File.basename(theme)
+      theme_dir = ThemesForRails.config.themes_dir
+      theme_base = "#{Rails.public_path}/#{theme_dir}/#{theme_name}"
+      puts "Creating #{theme_base}"
+
+      FileUtils.mkdir_p "#{theme_base}"
+      FileUtils.cp_r Dir["#{theme}/{images,stylesheets,javascripts}"], theme_base, :verbose => true
+    end
+  end
+  desc "Removes the cached (public) theme folders"
+  task :remove_cache => :environment do
+    theme_dir = ThemesForRails.config.themes_dir
+    puts "Removing #{Rails.public_path}/#{theme_dir}"
+    FileUtils.rm_r "#{Rails.public_path}/#{theme_dir}", :force => true
+  end
+  desc "Updates the cached (public) theme folders"
+  task :update_cache => [:remove_cache, :create_cache]
+
+  desc "Add theme view paths to ActionView PathSet"
+  task :add_theme_to_view_paths => :environment do
+    raise 'you must provide THEME for theme support to work' unless theme = ENV['THEME']
+    puts "adding theme [#{theme}] to view path"
+    require 'themes_for_rails/common_methods'
+    include ThemesForRails::CommonMethods
+
+    theme_view_path=theme_view_path_for(theme)
+    ActionController::Base.view_paths.paths.prepend(theme_view_path) if theme
+  end
+end
+
+namespace :cache_digests do
+  puts "patching cache_digests with themes_for_rails support"
+  # Add themes support to cache_digest gem rake tasks
+  task :nested_dependencies => ['themes:add_theme_to_view_paths']
+  task :dependencies => ['themes:add_theme_to_view_paths']
+end

data/lib/themes_for_rails/action_controller.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+module ThemesForRails
+
+  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
+
+    def theme(name)
+      set_theme(name)
+    end
+
+  end
+
+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] || headers['X-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,66 @@
+# 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 => digest_for_stylesheet("#{asset}.css", self.theme_name))
+    end
+
+    def current_theme_javascript_path(asset)
+      base_theme_javascript_path(:theme => self.theme_name, :asset => digest_for_javascript("#{asset}.js", self.theme_name))
+    end
+
+    def current_theme_image_path(asset)
+      image, extension = name_ext(asset)
+      base_theme_image_path(:theme => self.theme_name, :asset => digest_for_image("#{image}.#{extension}", self.theme_name))
+    end
+
+    def theme_stylesheet_path(asset, new_theme_name = self.theme_name)
+      base_theme_stylesheet_path(:theme => new_theme_name, :asset => digest_for_stylesheet("#{asset}.css", new_theme_name))
+    end
+
+    def theme_javascript_path(asset, new_theme_name = self.theme_name)
+      base_theme_javascript_path(:theme => new_theme_name, :asset => digest_for_javascript("#{asset}.js", new_theme_name))
+    end
+
+    def theme_image_path(asset, new_theme_name = self.theme_name)
+      image, extension = name_ext(asset)
+      base_theme_image_path(:theme => new_theme_name, :asset => digest_for_image("#{image}.#{extension}", new_theme_name))
+    end
+
+    def theme_image_tag(source, options = {})
+      image, extension = name_ext(source)
+      image_tag(theme_image_path(digest_for_image("#{image}.#{extension}", self.theme_name)), options)
+    end
+
+    def theme_image_submit_tag(source, options = {})
+      image, extension = name_ext(source)
+      image_submit_tag(theme_image_path(digest_for_image("#{image}.#{extension}", self.theme_name)), options)
+    end
+
+    def theme_javascript_include_tag(*files)
+      options = files.extract_options!
+      options.merge!({ :type => "text/javascript" })
+      files_with_options = files.collect {|file| theme_javascript_path(file) }
+      files_with_options += [options]
+
+      javascript_include_tag(*files_with_options)
+    end
+
+    def theme_stylesheet_link_tag(*files)
+      options = files.extract_options!
+      options.merge!({ :type => "text/css" })
+      files_with_options = files.collect {|file| theme_stylesheet_path(file) }
+      files_with_options += [options]
+
+      stylesheet_link_tag(*files_with_options)
+    end
+  end
+end

data/lib/themes_for_rails/assets_controller.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+require "action_controller/metal"
+
+module ThemesForRails
+  class AssetsController < ActionController::Base
+
+    def stylesheets
+      handle_asset("stylesheets")
+    end
+
+    def javascripts
+      handle_asset("javascripts")
+    end
+
+    def images
+      handle_asset("images")
+    end
+
+  private
+    
+    def handle_asset(prefix)
+      asset, theme = params[:asset], params[:theme]
+      find_themed_asset(asset, theme, prefix) do |path, mime_type|
+        response.headers['ETag'] = %("#{Digest::MD5.hexdigest(ActiveSupport::Cache.expand_cache_key(File.mtime(path).to_s + path))}")
+        response.headers['Cache-Control'] = "public, max-age=2592000"
+        send_file path, :type => mime_type, :disposition => "inline"
+      end
+    end
+    
+    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_type, &block) 
+      else
+        render_not_found
+      end
+    end
+
+    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
+    end
+      
+    def mime_type_for(request)
+      existing_mime_type = mime_type_from_uri(request.path_info)
+      unless existing_mime_type.nil? 
+        existing_mime_type.to_s
+      else
+        "image/#{extension_from(request.path_info)}"
+      end
+    end
+    
+    def mime_type_from_uri(path)
+      extension = extension_from(path)
+      Mime::Type.lookup_by_extension(extension)
+    end
+    
+    def extension_from(path)
+      File.extname(path).to_s[1..-1]
+    end
+  end
+end

data/lib/themes_for_rails/common_methods.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+module ThemesForRails
+  module CommonMethods
+
+    include ThemesForRails::Interpolation
+
+    def theme_name
+      @cached_theme_name ||= begin
+        case @theme_name
+        when Symbol then
+          self.respond_to?(@theme_name, true) ? self.send(@theme_name) : @theme_name.to_s
+        when String then @theme_name
+        else
+          nil
+        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
+
+    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(theme_view_path_for(name))
+    end
+
+    def digest_for_image(asset, theme_context)
+      if ThemesForRails.config.asset_digests_enabled?
+        asset_paths.digest_for("#{theme_context}/images/#{asset}") || asset
+      else
+        asset
+      end
+    end
+
+    def digest_for_javascript(asset, theme_context)
+      if ThemesForRails.config.asset_digests_enabled?
+        asset_paths.digest_for("#{theme_context}/javascripts/#{asset}") || asset
+      else
+        asset
+      end
+    end
+
+    def digest_for_stylesheet(asset, theme_context)
+      if ThemesForRails.config.asset_digests_enabled?
+        #Rails.application.config.assets.digests["#{theme_context}/stylesheets/#{asset}"] || asset
+        asset_paths.digest_for("#{theme_context}/stylesheets/#{asset}") || asset
+      else
+        asset
+      end
+    end
+
+    def name_ext(file_name)
+      ext = File.extname(file_name)
+      name = File.basename(file_name, ext)
+      ext.slice!(0) if ext.length > 0
+      return name, ext
+    end
+
+    def public_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_view_path_for(theme_name)
+      interpolate(ThemesForRails.config.views_dir, theme_name)
+    end
+
+    def theme_asset_path_for(theme_name)
+      interpolate(ThemesForRails.config.assets_dir, theme_name)
+    end
+  end
+end

data/lib/themes_for_rails/config.rb

@@ -0,0 +1,79 @@
+# encoding: utf-8
+module ThemesForRails
+  class Config
+
+    attr_writer :base_dir, :themes_dir, :assets_dir, :views_dir, :themes_routes_dir
+    attr_accessor :use_sass, :default_theme, :asset_digests_enabled
+    
+    include Interpolation
+
+    def initialize(&block)
+      @use_sass = true
+      @default_theme = 'default'
+      @asset_digests_enabled = nil
+      yield if block_given?
+    end
+    
+    def base_dir
+      @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 ||= ":root/themes"
+    end
+    
+    # Full path to themes
+    def themes_path
+      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
+      @themes_dir = nil
+      @assets_dir = nil
+      @views_dir  = nil
+    end
+
+    def use_sass?
+      @use_sass and sass_is_available?
+    end
+
+    def sass_is_available?
+      !!defined?Sass::Plugin
+    end
+
+    def asset_digests_enabled?
+      @asset_digests_enabled
+    end
+  end  
+end

data/lib/themes_for_rails/digested_action_view.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+module ThemesForRails
+
+  module DigestedActionView
+
+    extend ActiveSupport::Concern
+
+    included do
+      include ThemesForRails::CommonMethods
+    end
+
+    def current_theme_stylesheet_path(asset)
+      digest_for_stylesheet("#{asset}.css", self.theme_name)
+    end
+
+    def current_theme_javascript_path(asset)
+      digest_for_javascript("#{asset}.js", self.theme_name)
+    end
+
+    def current_theme_image_path(asset)
+      image, extension = name_ext(asset)
+      digest_for_image("#{image}.#{extension}", self.theme_name)
+    end
+
+    def theme_stylesheet_path(asset, new_theme_name = self.theme_name)
+      digest_for_stylesheet("#{asset}.css", new_theme_name)
+    end
+
+    def theme_javascript_path(asset, new_theme_name = self.theme_name)
+      digest_for_javascript("#{asset}.js", new_theme_name)
+    end
+
+    def theme_image_path(asset, new_theme_name = self.theme_name)
+      path_to_image(digest_for_image(asset, new_theme_name))
+    end
+
+    def theme_image_tag(source, options = {})
+      image_tag(theme_image_path("#{source}", self.theme_name), options)
+    end
+
+    def theme_image_submit_tag(source, options = {})
+      image, extension = name_ext(source)
+      image_submit_tag(theme_image_path("#{image}.#{extension}", self.theme_name), options)
+    end
+
+    def theme_javascript_include_tag(*files)
+      options = files.extract_options!
+      options.merge!({ :type => "text/javascript" })
+      files_with_options = files.collect {|file| theme_javascript_path(file) }
+      files_with_options += [options]
+
+      javascript_include_tag(*files_with_options)
+    end
+
+    def theme_stylesheet_link_tag(*files)
+      options = files.extract_options!
+      options.merge!({ :type => "text/css" })
+      files_with_options = files.collect {|file| theme_stylesheet_path(file) }
+      files_with_options += [options]
+
+      stylesheet_link_tag(*files_with_options)
+    end
+  end
+end

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.to_s).gsub(":name", name.to_s)
+    end
+
+  end
+  
+end

data/lib/themes_for_rails/railtie.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+module ThemesForRails
+  class Railtie < ::Rails::Railtie
+
+    config.themes_for_rails = ActiveSupport::OrderedOptions.new
+
+    config.to_prepare do
+      ThemesForRails::Railtie.config.themes_for_rails.each do |key, value|
+        ThemesForRails.config.send "#{key}=".to_sym, value
+      end
+      
+      # Adding theme stylesheets path to sass, automatically.
+      ThemesForRails.add_themes_path_to_sass if ThemesForRails.config.use_sass?
+
+      # Check if asset pipeline enabled
+      ThemesForRails.check_asset_pipeline
+
+      # Adding theme assets to the asset pipeline, automatically.
+      ThemesForRails.add_themes_assets_to_asset_pipeline if ThemesForRails.config.asset_digests_enabled?
+
+      ActiveSupport.on_load(:action_view) do
+        include ThemesForRails::ActionView
+        if ThemesForRails.config.asset_digests_enabled?
+          require 'themes_for_rails/digested_action_view'
+          include ThemesForRails::DigestedActionView
+        end
+      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
+      load "tasks/themes_for_rails.rake"
+    end
+  end
+end

data/lib/themes_for_rails/routes.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+module ThemesForRails
+  module Routes
+
+    def themes_for_rails
+      theme_dir = ThemesForRails.config.themes_routes_dir
+      constraints = { :theme => /[\w\.]*/ } 
+      
+      # Lets not pollute the routes if they aren't being used.
+      unless ThemesForRails.config.asset_digests_enabled?
+        get "#{theme_dir}/:theme/stylesheets/*asset" => 'themes_for_rails/assets#stylesheets',
+          :as => :base_theme_stylesheet, :constraints => constraints
+        get "#{theme_dir}/:theme/javascripts/*asset" => 'themes_for_rails/assets#javascripts',
+          :as => :base_theme_javascript, :constraints => constraints
+        get "#{theme_dir}/:theme/images/*asset" => 'themes_for_rails/assets#images',
+          :as => :base_theme_image, :constraints => constraints
+      end
+    end
+
+  end
+end
+
+module ActionDispatch::Routing
+  class Mapper #:nodoc:
+
+    include ThemesForRails::Routes
+
+  end
+end
+

data/lib/themes_for_rails/url_helpers.rb

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

data/lib/themes_for_rails/version.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+module ThemesForRails
+  VERSION = "1.5.1"
+end

data/lib/themes_for_rails.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+module ThemesForRails
+
+  class << self
+
+    def config
+      @config ||= ThemesForRails::Config.new
+      yield(@config) if block_given?
+      @config
+    end
+    
+    def available_themes(&block)
+      Dir.glob(File.join(config.themes_path, "*"), &block) 
+    end
+    alias each_theme_dir available_themes
+    
+    def available_theme_names
+      available_themes.map {|theme| File.basename(theme) } 
+    end
+    
+    def add_themes_path_to_sass
+      if ThemesForRails.config.sass_is_available?
+        each_theme_dir do |dir|
+          if File.directory?(dir) # Need to get rid of the '.' and '..'
+
+            sass_dir = "#{dir}/stylesheets/sass"
+            css_dir = "#{dir}/stylesheets"
+
+            unless already_configured_in_sass?(sass_dir)
+              Sass::Plugin.add_template_location sass_dir, css_dir 
+            end
+          end
+        end 
+      else
+        raise "Sass is not available. What are you trying to do?"
+      end
+    end
+
+    def check_asset_pipeline
+      config.asset_digests_enabled ||= Rails.application.config.respond_to?(:assets) && Rails.application.config.assets.digest == true
+    end
+
+    def add_themes_assets_to_asset_pipeline
+      Rails.logger.info "Start adding themes to assets [#{ThemesForRails.config.asset_digests_enabled?}]"
+      if ThemesForRails.config.asset_digests_enabled?
+        available_theme_names.each do |theme_name|
+          theme_asset_path = ThemesForRails.config.assets_dir.gsub(":root", ThemesForRails.config.base_dir).gsub(":name", theme_name.to_s)
+          Rails.logger.info "== Adding theme [#{theme_name}] asset dir [#{theme_asset_path}] to asset pipeline"
+          Rails.application.config.assets.paths.prepend(theme_asset_path) unless Rails.application.config.assets.paths.include?(theme_asset_path)
+        end unless ThemesForRails.config.base_dir =~ %r!/app/assets/!
+      end
+    end
+
+    def already_configured_in_sass?(sass_dir)
+      Sass::Plugin.template_location_array.map(&:first).include?(sass_dir)
+    end
+    
+  end
+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/action_view'
+require 'themes_for_rails/assets_controller'
+require 'themes_for_rails/action_controller'
+require 'themes_for_rails/action_mailer'
+require 'themes_for_rails/railtie'
+require 'themes_for_rails/routes'
+

data/test/dummy_app/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/**/*