themes_for_rails 0.2.1

data/lib/themes_for_rails/common_methods.rb

@@ -0,0 +1,48 @@
+module ThemesForRails
+  module CommonMethods
+    def view_path_for(theme)
+      File.join(theme_path_for(theme), "views")
+    end
+    def theme_name
+      @cached_theme_name ||= begin
+        case @theme_name
+        when Symbol then 
+          self.respond_to?(@theme_name) ? 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 << ActionView::FileSystemResolver.new(view_path_for(name))
+    end
+    def public_theme_path
+      theme_path("/")
+    end
+    def theme_path(base = ::Rails.root)
+      theme_path_for(theme_name, base)
+    end
+    def theme_path_for(name, base = ::Rails.root)
+      File.join(base, "themes", name)
+    end
+  end
+end

data/lib/themes_for_rails/controller_methods.rb

@@ -0,0 +1,23 @@
+module ThemesForRails
+  module ControllerMethods
+    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
+    end
+  end
+end
+
+ActiveSupport.on_load(:action_controller) { include ThemesForRails::ControllerMethods }

data/lib/themes_for_rails/railtie.rb

@@ -0,0 +1,18 @@
+# ActiveSupport.on_load(:action_view) { include Devise::Controllers::UrlHelpers }
+
+module ThemesForRails
+  class Railtie < ::Rails::Railtie
+    config.themes_for_rails = ActiveSupport::OrderedOptions.new
+    config.themes_for_rails.on = true
+    # config.themes_for_rails.base_path = File.join([::Rails.root, 'themes'])
+    rake_tasks do
+      load "tasks/themes_for_rails.rake"
+    end
+
+    config.to_prepare do
+      ThemesForRails::Railtie.config.themes_for_rails.each do |k, v|
+        Rails.logger.info "themes_for_rails.#{k}: #{v}"
+      end
+    end
+  end
+end

data/lib/themes_for_rails/routes.rb

@@ -0,0 +1,15 @@
+module ThemesForRails
+  module Routes
+    def themes_for_rails
+      match 'themes/:theme/stylesheets/:asset(.:extension)' => 'themes_for_rails/assets#stylesheets', :as => :base_theme_stylesheet
+      match 'themes/:theme/javascripts/:asset(.:extension)' => 'themes_for_rails/assets#javascripts', :as => :base_theme_javascript
+      match 'themes/:theme/images/:asset(.:extension)' => 'themes_for_rails/assets#images', :as => :base_theme_image
+    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,23 @@
+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, :extension => 'css')
+      end
+      def current_theme_javascript_path(asset)
+        base_theme_javascript_path(:theme => self.theme_name, :asset => asset, :extension => 'js')
+      end
+      def current_theme_image_path(asset)
+        image, extension = asset.split(".")
+        base_theme_image_path(:theme => self.theme_name, :asset => image, :extension => extension)
+      end
+    end
+  end
+end

data/lib/themes_for_rails/version.rb

@@ -0,0 +1,3 @@
+module ThemesForRails
+  VERSION = "0.2.1"
+end

data/lib/themes_for_rails/view_helpers.rb

@@ -0,0 +1,37 @@
+module ThemesForRails
+  module ViewHelpers
+    extend ActiveSupport::Concern
+    included do
+      include ThemesForRails::CommonMethods
+    end
+    module InstanceMethods
+      def current_theme_stylesheet_path(asset)
+        base_theme_stylesheet_path(:theme => self.theme_name, :asset => asset, :extension => 'css')
+      end
+      def current_theme_javascript_path(asset)
+        base_theme_javascript_path(:theme => self.theme_name, :asset => asset, :extension => 'js')
+      end
+      def current_theme_image_path(asset)
+        image, extension = asset.split(".")
+        self.base_theme_image_path(:theme => self.theme_name, :asset => image, :extension => extension)
+      end
+      alias_method :theme_image_path, :current_theme_image_path
+      alias_method :theme_javascript_path, :current_theme_javascript_path
+      alias_method :theme_stylesheet_path, :current_theme_stylesheet_path
+      
+      def theme_image_tag(source)
+        image_tag(theme_image_path(source))
+      end
+      def theme_javascript_include_tag(*files)
+        files.collect! {|file| theme_javascript_path(file) }
+        javascript_include_tag *files
+      end
+      def theme_stylesheet_link_tag(*files)
+        files.collect! {|file| theme_stylesheet_path(file) }
+        stylesheet_link_tag *files
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:action_view) { include ThemesForRails::ViewHelpers }

data/test/assets_controller_test.rb

@@ -0,0 +1,46 @@
+require "test_helper"
+
+module ThemesForRails
+  class AssetsControllerTest < ActionController::TestCase  
+    tests ThemesForRails::AssetsController
+    should "respond to stylesheets" do
+      assert @controller.respond_to?(:stylesheets)
+    end
+    should "respond with the right stylesheet file when requested" do
+      get 'stylesheets', { :theme => 'default', :asset => 'style', :extension => 'css'}
+      assert_response :success
+      assert_equal @response.content_type, 'text/css'
+    end
+    should "not be success when the stylesheet file is not found" do
+      get 'stylesheets', { :theme => 'default', :asset => 'oldstyle', :extension => 'css'}
+      assert_response :missing
+    end
+    # javascripts
+    should "respond to javascripts" do
+      assert @controller.respond_to?(:javascripts)
+    end
+    should "respond with the right javascript file when requested" do
+      get 'javascripts', { :theme => 'default', :asset => 'app', :extension => 'js'}
+      assert_response :success
+      assert_equal @response.content_type, 'text/javascript'
+    end
+    should "not be success when the javascript file is not found" do
+      get 'javascripts', { :theme => 'default', :asset => 'oldapp', :extension => 'js'}
+      assert_response :missing
+    end
+    
+    # images
+    should "respond to images" do
+      assert @controller.respond_to?(:images)
+    end
+    should "respond with the right image file when requested" do
+      get 'images', { :theme => 'default', :asset => 'logo', :extension => 'png'}
+      assert_response :success
+      assert_equal @response.content_type, 'image/png'
+    end
+    should "not be success when the image file is not found" do
+      get 'images', { :theme => 'default', :asset => 'i_am_not_here', :extension => 'jpg'}
+      assert_response :missing
+    end
+  end
+end

data/test/controller_methods_test.rb

@@ -0,0 +1,78 @@
+require "test_helper"
+
+class MyController < ActionController::Base
+  def hello
+    render :text => "Just a test"
+  end
+end
+class CustomThemeController < ActionController::Base
+  def hello
+    render :text => "Just a test"
+  end
+end
+module ThemesForRails
+  class ControllerMethodsTest < ActionController::TestCase  
+    context "at class level" do
+      should "respond_to theme" do
+        assert ApplicationController.respond_to?(:theme)
+      end
+      context "setting the theme with a String" do
+        tests MyController
+        should "set the selected theme for all actions" do
+          MyController.theme 'default'
+          @controller.expects(:set_theme).with('default')
+          assert_equal nil, @controller.theme_name
+          get :hello
+        end        
+      end
+      context "setting the theme with a Symbol" do
+        tests CustomThemeController
+        should "call the selected method" do
+          @controller.expects(:theme_selector).returns('custom')
+          CustomThemeController.theme :theme_selector
+          assert_equal nil, @controller.theme_name
+          get :hello
+        end
+      end
+    end
+    context "at instance level" do
+      tests ApplicationController
+      should "respond_to theme" do
+        assert @controller.respond_to?(:theme)
+      end
+      should "should store the theme's name" do
+        @controller.theme 'default'
+        assert_equal @controller.theme_name, 'default'
+      end
+      context "when a theme has been set" do
+        tests ApplicationController
+        should "add the theme's view path to the list of general view paths" do
+          antes = @controller.view_paths.size
+          @controller.theme 'default'  
+          assert_equal antes + 1, @controller.view_paths.size
+        end
+        should "have a proper view path" do
+          @controller.theme 'default'
+          view_path = @controller.view_paths.last
+          theme_path = File.join(File.expand_path(File.dirname(__FILE__)), "dummy_app", "themes", "default", "views")
+          assert_equal view_path.to_s, theme_path
+        end
+      end
+    end
+    context "using url helpers" do
+      tests ApplicationController
+      should "provide url method to access a given stylesheet file in the current theme" do
+        @controller.theme 'default'
+        assert_equal @controller.send(:current_theme_stylesheet_path, "style"), "/themes/default/stylesheets/style.css"
+      end
+      should "provide url method to access a given javascript file in the current theme" do
+        @controller.theme 'default'
+        assert_equal @controller.send(:current_theme_javascript_path, "app"), "/themes/default/javascripts/app.js"
+      end
+      should "provide url method to access a given image file in the current theme" do
+        @controller.theme 'default'
+        assert_equal @controller.send(:current_theme_image_path, "logo.png"), "/themes/default/images/logo.png"
+      end
+    end
+  end
+end

data/test/dummy_app/.gitignore

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

data/test/dummy_app/Gemfile

@@ -0,0 +1,30 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.0'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3-ruby', :require => 'sqlite3'
+
+# Use unicorn as the web server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'ruby-debug'
+
+# Bundle the extra gems:
+# gem 'bj'
+# gem 'nokogiri'
+# gem 'sqlite3-ruby', :require => 'sqlite3'
+# gem 'aws-s3', :require => 'aws/s3'
+
+# Bundle gems for the local environment. Make sure to
+# put test-only gems in this group so their generators
+# and rake tasks are available in development mode:
+# group :development, :test do
+#   gem 'webrat'
+# end

data/test/dummy_app/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+DummyApp::Application.load_tasks

data/test/dummy_app/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy_app/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>DummyApp</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy_app/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run DummyApp::Application

data/test/dummy_app/config/application.rb

@@ -0,0 +1,42 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+# If you have a Gemfile, require the gems listed there, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(:default, Rails.env) if defined?(Bundler)
+
+module DummyApp
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/test/dummy_app/config/boot.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+
+# Set up gems listed in the Gemfile.
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+begin
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+rescue Bundler::GemNotFound => e
+  STDERR.puts e.message
+  STDERR.puts "Try running `bundle install`."
+  exit!
+end if File.exist?(gemfile)

data/test/dummy_app/config/database.yml

@@ -0,0 +1,18 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: ":memory:"
+
+production:
+  adapter: sqlite3
+  database: ":memory:"