themes_for_rails 0.4.3 → 0.5.0.pre

data/.gitignore

@@ -4,3 +4,4 @@ tmp
 .DS_Store
 spec/dummy/db/*.sqlite3
 spec/dummy/log/test.log
+.svn

data/.travis.yml

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

data/Gemfile.lock

@@ -1,45 +1,46 @@
 PATH
   remote: .
   specs:
-    themes_for_rails (0.4.3)
+    themes_for_rails (0.5.0.pre)
       rails (>= 3.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
     abstract (1.0.0)
-    actionmailer (3.0.5)
-      actionpack (= 3.0.5)
-      mail (~> 2.2.15)
-    actionpack (3.0.5)
-      activemodel (= 3.0.5)
-      activesupport (= 3.0.5)
+    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.4)
+      i18n (~> 0.5.0)
       rack (~> 1.2.1)
-      rack-mount (~> 0.6.13)
+      rack-mount (~> 0.6.14)
       rack-test (~> 0.5.7)
       tzinfo (~> 0.3.23)
-    activemodel (3.0.5)
-      activesupport (= 3.0.5)
+    activemodel (3.0.11)
+      activesupport (= 3.0.11)
       builder (~> 2.1.2)
-      i18n (~> 0.4)
-    activerecord (3.0.5)
-      activemodel (= 3.0.5)
-      activesupport (= 3.0.5)
-      arel (~> 2.0.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.5)
-      activemodel (= 3.0.5)
-      activesupport (= 3.0.5)
-    activesupport (3.0.5)
+    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)
@@ -48,32 +49,35 @@ GEM
     mime-types (1.17.2)
     mocha (0.9.12)
     polyglot (0.3.3)
-    rack (1.2.1)
-    rack-mount (0.6.13)
+    rack (1.2.5)
+    rack-mount (0.6.14)
       rack (>= 1.0.0)
     rack-test (0.5.7)
       rack (>= 1.0)
-    rails (3.0.5)
-      actionmailer (= 3.0.5)
-      actionpack (= 3.0.5)
-      activerecord (= 3.0.5)
-      activeresource (= 3.0.5)
-      activesupport (= 3.0.5)
+    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.5)
-    railties (3.0.5)
-      actionpack (= 3.0.5)
-      activesupport (= 3.0.5)
+      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.8.7)
-    sqlite3 (1.3.3)
+    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.24)
+    tzinfo (0.3.31)
 
 PLATFORMS
   ruby
@@ -81,6 +85,7 @@ PLATFORMS
 DEPENDENCIES
   contest
   mocha
+  rails (= 3.0.11)
   sqlite3
   test-unit
   themes_for_rails!

data/README.textile

@@ -1,258 +1,33 @@
 h1. Theme For Rails (3 and hopefully later)
 
-h2. Features list / Wish list
+h2. Features list 
 
 * Support for adding themes which includes stylesheets, javascripts, views and layouts. 
+* add a theme-image-url sass helper method for asset pipeline based themes
+* update the generators and rake tasks to support asset pipeline based themes
+* (NEW) works with the Rails Assets Pipeline without interfering, and leveraging it.   
 
-<pre>
-$app_root
-  themes/
-    [theme_name]
-      images/
-      stylesheets/
-      javascripts/
-      views/           <- you can override application views
-        layouts/         <- layout .rhtml or .liquid templates
-</pre>
-
-h2. Instructions
-
-Add themes_for_rails to your Gemfile.
-
-<pre>
-gem 'themes_for_rails'
-</pre>
-
-Add themes_for_rails to your config/routes.rb
-
-<pre>
-MySuperDuperApp::Application.routes.draw do
-  # ...
-  themes_for_rails
-  # ...
-end
-</pre>
-
-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 "themes_for_rails" route in the routes.rb.
-
-<pre>
-rails generate themes_for_rails:install  
-</pre>
-
-Inside the themes folder, it create a structure for my_theme.
-
-<pre>
-rails generate themes_for_rails:theme my_theme  
-</pre>
-
-h2. Changing things
-
-At least for now, you can change the ThemesForRails 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.themes_for_rails.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.themes_for_rails.themes_dir = "another_themes"
-
-  #...
-end
-</pre>
-
-h2. Sass support
-
-ThemesForRails 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.themes_for_rails.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/themes_for_rails.rb (for instance)
-ThemesForRails.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. Compatibility
 
+This gem works with Rails from version 3.0 to at least 3.2.1 (current at the moment of writing this readme file).
 
 h2. Documentation
 
-"Read it here":http://rubydoc.info/github/lucasefe/themes_for_rails/master/frames
+* "Rdoc":http://rubydoc.info/github/lucasefe/themes_for_rails/master/frames
+* "Wiki":https://github.com/lucasefe/themes_for_rails/wiki
+* "Old Readme File":https://github.com/lucasefe/themes_for_rails/blob/master/doc/README.textile
 
-h2. Ideas
+h2. Ideas / Inspiration
 
 * Add ThemesForRails::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. Rails 2 Support
 
 This gem only works with Rails 3 (duh). If you want the same exactly behavior, but for Rails 2.x, go "here":http://github.com/jystewart/theme_support .
 
-
 h2. Running tests
 
 <pre>
@@ -264,6 +39,7 @@ rake
 h2. Authors and contributors
 
 * lucasefe
+* jedifreeman
 * jbarreneche
 * kule
 * matheusmoreira

data/Rakefile

@@ -1,4 +1,5 @@
 #!/usr/bin/env rake
+# encoding: utf-8
 require "bundler/gem_tasks"
 task :default => :test
 

data/doc/README.textile

@@ -0,0 +1,363 @@
+h1. Theme For Rails (3 and hopefully later)
+
+h2. Features list / Wish list
+
+* Support for adding themes which includes stylesheets, javascripts, views and layouts. 
+* add a theme-image-url sass helper method for asset pipeline based themes
+* update the generators and rake tasks to support asset pipeline based themes
+
+<pre>
+$app_root
+  themes/
+    [theme_name]
+      images/
+      stylesheets/
+      javascripts/
+      views/           <- you can override application views
+        layouts/         <- layout .rhtml or .liquid templates
+</pre>
+
+h2. Instructions
+
+Add themes_for_rails to your Gemfile.
+
+<pre>
+gem 'themes_for_rails'
+</pre>
+
+Add themes_for_rails to your config/routes.rb
+
+<pre>
+MySuperDuperApp::Application.routes.draw do
+  # ...
+  themes_for_rails
+  # ...
+end
+</pre>
+
+h3. Additional Instructions for using the Rails Asset Pipeline
+
+In order to use themes_for_rails 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/themes_for_rails.rb (for instance)
+ThemesForRails.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/themes_for_rails.rb (for instance)
+ThemesForRails.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 "themes_for_rails" route in the routes.rb.
+
+<pre>
+rails generate themes_for_rails:install  
+</pre>
+
+Inside the themes folder, it create a structure for my_theme.
+
+<pre>
+rails generate themes_for_rails:theme my_theme  
+</pre>
+
+h2. Changing things
+
+At least for now, you can change the ThemesForRails 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.themes_for_rails.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.themes_for_rails.themes_dir = "another_themes"
+
+  #...
+end
+</pre>
+
+h2. Sass support
+
+ThemesForRails 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.themes_for_rails.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/themes_for_rails.rb (for instance)
+ThemesForRails.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. Documentation
+
+"Read it here":http://rubydoc.info/github/lucasefe/themes_for_rails/master/frames
+
+h2. Ideas
+
+* Add ThemesForRails::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. Rails 2 Support
+
+This gem only works with Rails 3 (duh). If you want the same exactly behavior, but for Rails 2.x, go "here":http://github.com/jystewart/theme_support .
+
+
+h2. Running tests
+
+<pre>
+gem install bundler
+bundle install
+rake
+</pre>
+
+h2. Authors and contributors
+
+* lucasefe
+* jbarreneche
+* kule
+* matheusmoreira
+* rafaelss
+* maxjgon
+
+h2. Last but not least
+
+If you are using this gem, please, take a minute to recommend me at Working With Rails. 
+
+<a href="http://www.workingwithrails.com/recommendation/new/person/7277-lucas-florio"><img alt="Recommend Me" src="http://workingwithrails.com/images/tools/compact-small.jpg" /></a>