active_theme 0.5.0.pre

data/.gitignore

@@ -0,0 +1,8 @@
+.bundle
+pkg
+tmp
+.DS_Store
+spec/dummy/db/*.sqlite3
+spec/dummy/log/test.log
+.svn
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@themes_for_rails --create

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    active_theme (0.5.0.pre)
+      rails (>= 3.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.11)
+      actionpack (= 3.0.11)
+      mail (~> 2.2.19)
+    actionpack (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.11)
+      activesupport (= 3.0.11)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+    activesupport (3.0.11)
+    arel (2.0.10)
+    builder (2.1.2)
+    contest (0.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    json (1.6.5)
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.17.2)
+    mocha (0.9.12)
+    polyglot (0.3.3)
+    rack (1.2.5)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.11)
+      actionmailer (= 3.0.11)
+      actionpack (= 3.0.11)
+      activerecord (= 3.0.11)
+      activeresource (= 3.0.11)
+      activesupport (= 3.0.11)
+      bundler (~> 1.0)
+      railties (= 3.0.11)
+    railties (3.0.11)
+      actionpack (= 3.0.11)
+      activesupport (= 3.0.11)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.4)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    sqlite3 (1.3.5)
+    test-unit (2.2.0)
+    thor (0.14.6)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_theme!
+  contest
+  mocha
+  rails (= 3.0.11)
+  sqlite3
+  test-unit

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) Lucas Florio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.textile

@@ -0,0 +1,3 @@
+h1. ActiveTheme (Theme Support For Rails 3)
+
+This project is forked from "lucasefe/themes_for_rails":https://github.com/lucasefe/themes_for_rails

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+# encoding: utf-8
+require "bundler/gem_tasks"
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/active_theme.gemspec

@@ -0,0 +1,25 @@
+
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/active_theme/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Devin Zhang"]
+  gem.email         = ["daqing1986@gmail.com"]
+  gem.summary       = "Theme Support for Rails 3"
+  gem.description   = %q{It allows an application to have many different ways of rendering static assets and dynamic views.}
+  gem.homepage      = "https://github.com/daqing/active_theme"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "active_theme"
+  gem.require_paths = ["lib"]
+  gem.version       = ActiveTheme::VERSION
+
+  gem.add_dependency('rails', [">= 3.0.0"])
+  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "test-unit"
+  gem.add_development_dependency "contest"
+  gem.add_development_dependency "mocha"
+  gem.add_development_dependency('rails', ["= 3.0.11"])
+end

data/doc/README.textile

@@ -0,0 +1,332 @@
+h1. ActiveTheme (Theme Support For Rails 3)
+
+h2. Instructions
+
+Add active_theme to your Gemfile.
+
+<pre>
+gem 'active_theme'
+</pre>
+
+Add active_theme to your config/routes.rb
+
+<pre>
+MySuperDuperApp::Application.routes.draw do
+  # ...
+  active_theme
+  # ...
+end
+</pre>
+
+h3. Additional Instructions for using the Rails Asset Pipeline
+
+In order to use active_theme with the asset pipeline, you will need to configure a few settings and place your themes in the asset pipeline directory.
+
+First, move your assets into the asset pipeline. For example:
+
+<pre>
+$app_root
+  app/
+    assets/
+      images/      <-- default asset pipeline folder
+      javascripts/ <-- default asset pipeline folder
+      stylesheets/ <-- default asset pipeline folder
+      themes/      <-- your themes root
+        [theme_name]
+          images/
+          stylesheets/
+          javascripts/
+          views/           <- you can override application views
+            layouts/         <- layout .rhtml or .liquid templates
+</pre>
+
+Create an initializer for themes in your {Rails.root}/config/initializers directory and set the themes_dir and assets_dir settings appropriately.
+
+<pre>
+# Rails.root/config/initializers/active_theme.rb (for instance)
+ActiveTheme.config do |config|
+  #
+  # If you have placed your themes like the example path above within the asset pipeline:
+  config.themes_dir = 'assets'
+  config.assets_dir = 'app/assets/themes'
+  # ...
+end
+</pre>
+
+In your theme stylesheets directory, you can create an application.css file using the Sprockets require methods:
+
+<pre>
+/*
+ *= require global_stylesheet_name
+ *= require theme_name/stylesheets/stylesheet_name
+ */
+</pre>
+
+As you can see, if you do not preface with the theme_name/stylesheets it will reference the root /app/assets/stylesheets path for global stylesheets (great for mixins and reset styles)
+
+Currently, one unresolved issue with this setup is that you must pass the theme_name/images path into your sass image-url helper methods. For example, if you are including an image in the 'default' theme: <pre>image-url('default/images/background.png')</pre>
+
+If you do not want to have your views inside the asset pipeline dir, you can alternatively configure your application like this:
+
+<pre>
+$app_root
+  app/
+    assets/
+      images/      <-- default asset pipeline folder
+      javascripts/ <-- default asset pipeline folder
+      stylesheets/ <-- default asset pipeline folder
+      themes/      <-- your themes root
+        [theme_name]
+          images/
+          stylesheets/
+          javascripts/
+    views/
+      themes/       <-- note themes folder lives under views in this scenario
+        [theme_name]
+          layouts/         <- layout .rhtml or .liquid templates
+</pre>
+
+and in your initializer, you will need to set the views_dir config setting like so:
+
+<pre>
+# Rails.root/config/initializers/active_theme.rb (for instance)
+ActiveTheme.config do |config|
+  #
+  # If you have placed your themes like the example path above within the asset pipeline:
+  config.themes_dir = 'assets'
+  config.assets_dir = 'app/assets/themes'
+  config.views_dir  = 'app/views/themes'
+  # ...
+end
+</pre>
+
+After that, the rest of the config for asset pipeline styles and whatnot mentioned above will work.
+
+h3. And then?
+
+Now you'll be able to use themes like this:
+
+Inside method, for some explicit action:
+
+<pre>
+class MyController < ApplicationController
+  def show
+    theme "purple"
+  end
+end
+</pre>
+
+Or at class level definition, in order to set a theme for more than one action. I think this is is prettier, and less invasive.
+
+<pre>
+class MyController < ApplicationController
+  theme "purple" # all actions will use this theme
+  def show
+    ...
+  end
+end
+</pre>
+
+You could also enable a theme for some actions only
+
+<pre>
+class MyController < ApplicationController
+  theme "purple", :only => :show
+  def show
+    # with theme
+  end
+  def edit
+    # no theme
+  end
+end
+</pre>
+
+As a plus, you could do this to defer theme name resolution to a method:
+
+<pre>
+class MyController < ApplicationController
+  theme :theme_resolver
+  # ...
+private
+  def theme_resolver
+    current_user.theme # or anything else that return a string.
+  end
+end
+</pre>
+
+As a general rule, when passing a String, that becomes the theme name, but when a Symbol is sent, it gets treated as method message.
+
+
+h3. Action Mailer integration:
+
+As a plus, you can use it from Action Mailer too (thanks to rafaelss) like this:
+
+<pre>
+class MyMailer < ActionMailer::Base
+
+  def notify_someone
+    mail :theme => "blue" , :to => "some@one.com"
+  end
+
+end
+</pre>
+
+Or set the theme by default like this (thanks to maxjgon):
+
+<pre>
+class MyMailer < ActionMailer::Base
+
+  default :theme => "blue"
+
+  def notify_someone
+    mail :to => "some@one.com"
+  end
+
+end
+</pre>
+
+h3. Url Helpers
+
+In your views you should be able to access your assets like this (given the theme 'default' is set):
+
+<pre>
+current_theme_image_path('logo.png')   # => /themes/default/images/logo.png
+current_theme_stylesheet_path('style') # => /themes/default/stylesheets/logo.css
+current_theme_javascript_path('app')   # => /themes/default/stylesheets/app.js
+</pre>
+
+Or a given theme:
+
+<pre>
+current_theme_image_path('logo.png', 'purple')   # => /themes/purple/images/logo.png
+</pre>
+
+In your application views, there are theme specific helper tags
+available to you. For ERb templates they are:
+
+<pre>
+theme_image_tag
+theme_image_path
+theme_javascript_include_tag
+theme_javascript_path
+theme_stylesheet_link_tag
+theme_stylesheet_path
+</pre>
+
+h2. Generators
+
+For now, it only creates the theme folder and add the "active_theme" route in the routes.rb.
+
+<pre>
+rails generate active_theme:install
+</pre>
+
+Inside the themes folder, it create a structure for my_theme.
+
+<pre>
+rails generate active_theme:create my_theme
+</pre>
+
+h2. Changing things
+
+At least for now, you can change the ActiveTheme base dir in your app, in the corresponding environment file, or in your application.rb file. Do it like this:
+
+<pre>
+KillerApp::Application.configure do
+  #
+
+  config.active_theme.base_dir = File.join(Rails.root, "tmp")
+
+  #...
+end
+</pre>
+
+Thanks to matheusca, now you can change the name of the theme's dir.
+
+<pre>
+KillerApp::Application.configure do
+  #
+
+  config.active_theme.themes_dir = "another_themes"
+
+  #...
+end
+</pre>
+
+h2. Sass support
+
+ActiveTheme will automatically add the themes paths to Sass, if sass is available.
+
+For instance, everything you put inside themes/my_theme/stylesheets/sass will get compiled into themes/my_theme/stylesheets (duh, right?)
+
+To bypass sass configuration, do this:
+<pre>
+KillerApp::Application.configure do
+  #
+
+  config.active_theme.use_sass = false
+
+  #...
+end
+</pre>
+
+h2. Another way to change things
+
+If you don't like this approach and prefer something more like an initializer file, you could create one an put something like this.
+
+<pre>
+# Rails.root/config/initializers/active_theme.rb (for instance)
+ActiveTheme.config do |config|
+  #
+  config.themes_dir = 'another_themes'
+  # ...
+end
+</pre>
+
+
+
+h2. Notes and Warnings.
+
+If you are running an app in production mode, and you get the static files with no content, is because you don't have X-senfile enabled at your web server.
+
+You can do two things:
+
+comment out this line in your production.rb file:
+
+config.action_dispatch.x_sendfile_header = "X-Sendfile"
+
+or
+
+configure your web server to use it. :)
+
+
+h2. Ideas
+
+* Add ActiveTheme::Railtie for configuration, so we selectively set the plugin on or off. Also to be able to change several settings.
+* -Add routes to allow access to the theme's static resources (js and cs), unless cached on public folder by capistrano / rake.-
+* -Extend Action View path in order to make the views accessible. Same for the layouts.-
+* More tests ford edge cases. Now I am only testing the happy paths.
+
+h2. Things to remember.
+
+* -Final version should be a gem. Initialization hooks doesn't work when using this as a plugin (vendor/plugins).-
+* -Research about testing this kind of gem. I really don't have a clue.- Testing in place!
+* I should probably load the theme list at start time, to be able to consult it as needed. I am gonna need that when dealing with runtime  theme selection. Many themes are going to be used simultaneously, so I have to be able to switch view paths as fast as I can.
+
+h2. Running tests
+
+<pre>
+gem install bundler
+bundle install
+rake
+</pre>
+
+h2. Authors and contributors
+
+* lucasefe
+* jbarreneche
+* kule
+* matheusmoreira
+* rafaelss
+* maxjgon
+