themes_for_rails4 1.5.1

data/test/dummy_app/public/javascripts/rails.js

@@ -0,0 +1,175 @@
+(function() {
+  // Technique from Juriy Zaytsev
+  // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/
+  function isEventSupported(eventName) {
+    var el = document.createElement('div');
+    eventName = 'on' + eventName;
+    var isSupported = (eventName in el);
+    if (!isSupported) {
+      el.setAttribute(eventName, 'return;');
+      isSupported = typeof el[eventName] == 'function';
+    }
+    el = null;
+    return isSupported;
+  }
+
+  function isForm(element) {
+    return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM'
+  }
+
+  function isInput(element) {
+    if (Object.isElement(element)) {
+      var name = element.nodeName.toUpperCase()
+      return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA'
+    }
+    else return false
+  }
+
+  var submitBubbles = isEventSupported('submit'),
+      changeBubbles = isEventSupported('change')
+
+  if (!submitBubbles || !changeBubbles) {
+    // augment the Event.Handler class to observe custom events when needed
+    Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap(
+      function(init, element, eventName, selector, callback) {
+        init(element, eventName, selector, callback)
+        // is the handler being attached to an element that doesn't support this event?
+        if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) ||
+             (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) {
+          // "submit" => "emulated:submit"
+          this.eventName = 'emulated:' + this.eventName
+        }
+      }
+    )
+  }
+
+  if (!submitBubbles) {
+    // discover forms on the page by observing focus events which always bubble
+    document.on('focusin', 'form', function(focusEvent, form) {
+      // special handler for the real "submit" event (one-time operation)
+      if (!form.retrieve('emulated:submit')) {
+        form.on('submit', function(submitEvent) {
+          var emulated = form.fire('emulated:submit', submitEvent, true)
+          // if custom event received preventDefault, cancel the real one too
+          if (emulated.returnValue === false) submitEvent.preventDefault()
+        })
+        form.store('emulated:submit', true)
+      }
+    })
+  }
+
+  if (!changeBubbles) {
+    // discover form inputs on the page
+    document.on('focusin', 'input, select, texarea', function(focusEvent, input) {
+      // special handler for real "change" events
+      if (!input.retrieve('emulated:change')) {
+        input.on('change', function(changeEvent) {
+          input.fire('emulated:change', changeEvent, true)
+        })
+        input.store('emulated:change', true)
+      }
+    })
+  }
+
+  function handleRemote(element) {
+    var method, url, params;
+
+    var event = element.fire("ajax:before");
+    if (event.stopped) return false;
+
+    if (element.tagName.toLowerCase() === 'form') {
+      method = element.readAttribute('method') || 'post';
+      url    = element.readAttribute('action');
+      params = element.serialize();
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onComplete:    function(request) { element.fire("ajax:complete", request); },
+      onSuccess:     function(request) { element.fire("ajax:success",  request); },
+      onFailure:     function(request) { element.fire("ajax:failure",  request); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function handleMethod(element) {
+    var method = element.readAttribute('data-method'),
+        url = element.readAttribute('href'),
+        csrf_param = $$('meta[name=csrf-param]')[0],
+        csrf_token = $$('meta[name=csrf-token]')[0];
+
+    var form = new Element('form', { method: "POST", action: url, style: "display: none;" });
+    element.parentNode.insert(form);
+
+    if (method !== 'post') {
+      var field = new Element('input', { type: 'hidden', name: '_method', value: method });
+      form.insert(field);
+    }
+
+    if (csrf_param) {
+      var param = csrf_param.readAttribute('content'),
+          token = csrf_token.readAttribute('content'),
+          field = new Element('input', { type: 'hidden', name: param, value: token });
+      form.insert(field);
+    }
+
+    form.submit();
+  }
+
+
+  document.on("click", "*[data-confirm]", function(event, element) {
+    var message = element.readAttribute('data-confirm');
+    if (!confirm(message)) event.stop();
+  });
+
+  document.on("click", "a[data-remote]", function(event, element) {
+    if (event.stopped) return;
+    handleRemote(element);
+    event.stop();
+  });
+
+  document.on("click", "a[data-method]", function(event, element) {
+    if (event.stopped) return;
+    handleMethod(element);
+    event.stop();
+  });
+
+  document.on("submit", function(event) {
+    var element = event.findElement(),
+        message = element.readAttribute('data-confirm');
+    if (message && !confirm(message)) {
+      event.stop();
+      return false;
+    }
+
+    var inputs = element.select("input[type=submit][data-disable-with]");
+    inputs.each(function(input) {
+      input.disabled = true;
+      input.writeAttribute('data-original-value', input.value);
+      input.value = input.readAttribute('data-disable-with');
+    });
+
+    var element = event.findElement("form[data-remote]");
+    if (element) {
+      handleRemote(element);
+      event.stop();
+    }
+  });
+
+  document.on("ajax:after", "form", function(event, element) {
+    var inputs = element.select("input[type=submit][disabled=true][data-disable-with]");
+    inputs.each(function(input) {
+      input.value = input.readAttribute('data-original-value');
+      input.removeAttribute('data-original-value');
+      input.disabled = false;
+    });
+  });
+})();

data/test/dummy_app/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/test/dummy_app/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/test/dummy_app/themes/default/javascripts/app.js

@@ -0,0 +1 @@
+//js

data/test/dummy_app/themes/default/stylesheets/style2.css

@@ -0,0 +1,3 @@
+a {
+  color: green;
+}

data/test/dummy_app/themes/default/views/layouts/default.html.erb

@@ -0,0 +1,10 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+  <head>
+    <title>App!</title>
+  </head>
+  <body>
+    
+  </body>
+</html>

data/test/lib/action_controller_test.rb

@@ -0,0 +1,170 @@
+# encoding: utf-8
+require File.expand_path("test/test_helper.rb")
+
+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
+  
+  def theme_selector
+    'custom'
+  end
+
+end
+
+class PrivateCustomThemeController < ActionController::Base
+
+  def hello
+    render :text => "Just a test"
+  end
+
+  private
+  
+  def private_theme_selector
+    'private_custom'
+  end
+
+end
+
+class ActionMailerInclusionTest < Test::Unit::TestCase
+
+  should "include the ActionController module" do
+    assert ActionMailer::Base.included_modules.include?(ThemesForRails::ActionController)
+  end
+
+end
+
+class ActionControllerInclusionTest < Test::Unit::TestCase
+  should "include the ActionController module" do
+    assert ActionController::Base.included_modules.include?(ThemesForRails::ActionController)
+  end
+end
+
+class ApplicationControllerInclusionTest < Test::Unit::TestCase
+  should "include the ActionController module" do
+    assert ApplicationController.included_modules.include?(ThemesForRails::ActionController)
+  end
+end
+
+module ThemesForRails
+  class ActionControllerTest < ::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 private method" do
+          CustomThemeController.theme :theme_selector
+          get :hello
+          assert_equal 'custom', @controller.theme_name
+        end
+      end
+
+      context "setting the theme with a Symbol (private)" do
+
+        tests PrivateCustomThemeController
+
+        should "call the selected private method" do
+          PrivateCustomThemeController.theme :private_theme_selector
+          get :hello
+          assert_equal 'private_custom', @controller.theme_name
+        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 front of the 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.first
+          theme_view_path = File.expand_path(File.join("test", "dummy_app", "themes", "default", "views"))
+          assert_equal view_path.to_s, theme_view_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
+
+      context "with multiple dots" 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.compact"), "/themes/default/stylesheets/style.compact.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.min"), "/themes/default/javascripts/app.min.js"
+        end
+        
+      end
+
+    end
+  end
+end

data/test/lib/action_mailer_test.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+require File.expand_path("test/test_helper.rb")
+
+THEME = 'pink'
+
+class Notifier < ActionMailer::Base
+  default :theme => THEME
+
+  def welcome(user)
+    mail(:theme => user.theme)
+  end
+
+  def thanks(user)
+    mail
+  end
+end
+
+module ThemesForRails
+  class ActionMailerTest < ::ActionController::TestCase
+
+    should "set theme using mail headers" do
+      Notifier.any_instance.expects(:theme).with("purple")
+
+      user = mock("User", :theme => "purple")
+      Notifier.welcome(user)
+    end
+
+    should "set theme using mail default opts" do
+      Notifier.any_instance.expects(:theme).with("pink")
+
+      user = mock("User")
+      Notifier.thanks(user)
+    end
+  end
+end

data/test/lib/action_view_test.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+require File.expand_path("test/test_helper.rb")
+
+class ViewHelpersTest < ::ActionController::IntegrationTest
+  
+  include ::ThemesForRails::ActionView
+  include ::ActionView::Helpers::AssetTagHelper
+  include ::ERB::Util
+  include ::ActionView::Helpers::TagHelper    
+  include ::ActionView::Helpers::FormTagHelper 
+  def theme_name
+    'default'
+  end
+
+  def config
+    @config ||= stub({:perform_caching => false, :asset_path => "/assets", :asset_host => ''})
+  end
+end
+
+module ThemesForRails
+  class CommonViewHelpersTest < ViewHelpersTest
+    
+    should "provide path helpers for a given theme name" do
+      
+      assert_equal "/themes/sometheme/stylesheets/style.css", theme_stylesheet_path('style', "sometheme")
+      assert_equal "/themes/sometheme/javascripts/app.js", theme_javascript_path('app', "sometheme")
+      assert_equal "/themes/sometheme/images/logo.png", theme_image_path('logo.png', "sometheme")
+      
+    end
+
+    should "provide path helpers for a given theme name with dots" do
+      
+      assert_equal "/themes/some.theme/stylesheets/style.css", theme_stylesheet_path('style', "some.theme")
+      assert_equal "/themes/some.theme/javascripts/app.js", theme_javascript_path('app', "some.theme")
+      assert_equal "/themes/some.theme/images/logo.png", theme_image_path('logo.png', "some.theme")
+      
+    end
+    
+    should 'delegate to stylesheet_link_tag' do
+      assert_match /media=.screen/, theme_stylesheet_link_tag('cuac.css')
+    end
+
+    should 'delegate options (lazy testing, I know)' do
+      assert_match /media=.print/, theme_stylesheet_link_tag('cuac.css', :media => 'print')
+    end
+    should 'delegate options in image_tag' do
+      assert_match /width=.40/, theme_image_tag('image.css', :size => '40x50')
+    end
+
+    should 'delegate options in image_submit_tag' do
+      assert_match /class=.search_button/, theme_image_submit_tag('image.png', :class => 'search_button')
+    end
+  end
+end

data/test/lib/assets_controller_test.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+require File.expand_path("test/test_helper.rb")
+
+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.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.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.js'}
+      assert_response :success
+      assert_equal @response.content_type, 'text/javascript'
+    end
+
+    should "respond with the right javascript file when requested (including multiple dot on the filename)" do
+      get 'javascripts', { :theme => 'default', :asset => 'app.min.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.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.png'}
+      assert_response :success
+      assert_equal  'image/png', @response.content_type
+    end
+    
+    should "not be success when the image file is not found" do
+      get 'images', { :theme => 'default', :asset => 'i_am_not_here.jpg'}
+      assert_response :missing
+    end
+    
+    should "respond with a nested asset" do
+      get 'images', { :theme => 'default', :asset => 'nested/logo.png'}
+      assert_response :success
+      assert_equal 'image/png', @response.content_type
+    end
+    
+    should "respond with properly even when requesting an image inside the stylesheets folder" do
+      get 'stylesheets', { :theme => 'default', :asset => 'images/logo.png'}
+      assert_response :success
+      assert_equal @response.content_type, 'image/png'
+    end
+  end
+end

data/test/lib/common_methods_test.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+require File.expand_path("test/test_helper.rb")
+
+class ThemesForRailsTest < Test::Unit::TestCase
+  setup do
+    @common = Object.new
+    @common.extend ThemesForRails::CommonMethods
+    @common.theme_name = "awesome"
+    ThemesForRails.config.clear
+  end
+
+  should 'use config base_dir to build theme path' do
+    ThemesForRails.config.base_dir = '/some_path'
+    assert_match /some_path/, @common.theme_view_path
+  end
+
+  should 'use config views_dir to build theme path' do
+    ThemesForRails.config.views_dir =':root/skinner/:name/views'
+    assert_match /skinner/, @common.theme_view_path_for('awesome')
+    assert_match /skinner/, @common.theme_view_path
+  end
+
+  should 'use config base_dir to build theme path for theme' do
+    ThemesForRails.config.base_dir ='some_path'
+    assert_match /some_path/, @common.theme_view_path_for('doodley')
+  end
+
+end

data/test/lib/config_test.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+require File.expand_path("test/test_helper.rb")
+
+class ThemesForRailsTest < Test::Unit::TestCase
+  
+  should 'change the base directory' do
+    ThemesForRails.config do |config|
+      config.base_dir = 'empty_themes'
+    end
+    
+    assert_equal [], ThemesForRails.available_theme_names
+  end
+  
+  should 'change the directory to views' do
+    ThemesForRails.config do |config|
+      config.themes_dir = ':root/another_themes'
+    end
+    
+    assert_equal ['another_default'], ThemesForRails.available_theme_names
+  end
+  
+  teardown do
+    ThemesForRails.config.clear
+  end
+  
+end

data/test/lib/integration_test.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+require File.expand_path("test/test_helper.rb")
+
+class ThemesForRailsIntegrationTest < ::ActionController::IntegrationTest
+
+  should "work with Rails 3.0 default configuration" do
+    asset_path = "/themes/default/stylesheets/style.css"
+    get asset_path
+    assert_equal 200, status
+    assert_equal asset_path, path
+  end
+end

data/test/lib/routes_test.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+require File.expand_path("test/test_helper.rb")
+
+module ThemesForRails
+  class RoutingTest < ::ActionController::TestCase  
+    should "recognize stylesheets route" do
+      assert_generates('/themes/default/stylesheets/app.css', { 
+        :controller => 'themes_for_rails/assets', 
+        :action => 'stylesheets',
+        :theme => 'default', 
+        :asset => 'app.css'
+      })
+    end
+    should "recognize javascripts route" do
+      assert_generates('/themes/default/javascripts/app.js', { 
+        :controller => 'themes_for_rails/assets', 
+        :action => 'javascripts',
+        :theme => 'default', 
+        :asset => 'app.js'
+      })
+    end
+    should "recognize images route" do
+      assert_generates('/themes/default/images/logo.png', { 
+        :controller => 'themes_for_rails/assets', 
+        :action => 'images',
+        :theme => 'default', 
+        :asset => 'logo.png'
+      })
+    end
+    
+    should "recognize nested route" do
+      assert_generates('/themes/default/images/nested/logo.png', { 
+        :controller => 'themes_for_rails/assets', 
+        :action => 'images',
+        :theme => 'default', 
+        :asset => 'nested/logo.png'
+      })
+    end
+  end
+end