themes_for_rails 0.5.1 → 1.0.0rc1

data/.rvmrc

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

data/Gemfile.lock

@@ -1,79 +1,102 @@
 PATH
   remote: .
   specs:
-    themes_for_rails (0.5.1)
-      rails (>= 3.0.0)
+    themes_for_rails (1.0.0rc1)
+      rails (~> 3.1.0)
+      themes_for_rails
 
 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)
+    actionmailer (3.1.1)
+      actionpack (= 3.1.1)
+      mail (~> 2.3.0)
+    actionpack (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.2)
+      rack-cache (~> 1.1)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.2)
+    activemodel (3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    arel (2.2.1)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    json (1.6.1)
+    mail (2.3.0)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.17.2)
-    mocha (0.9.12)
+    multi_json (1.0.3)
     polyglot (0.3.3)
-    rack (1.2.5)
-    rack-mount (0.6.14)
+    rack (1.3.5)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
       rack (>= 1.0.0)
-    rack-test (0.5.7)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
       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)
+    rails (3.1.1)
+      actionmailer (= 3.1.1)
+      actionpack (= 3.1.1)
+      activerecord (= 3.1.1)
+      activeresource (= 3.1.1)
+      activesupport (= 3.1.1)
       bundler (~> 1.0)
-      railties (= 3.0.11)
-    railties (3.0.11)
-      actionpack (= 3.0.11)
-      activesupport (= 3.0.11)
+      railties (= 3.1.1)
+    railties (3.1.1)
+      actionpack (= 3.1.1)
+      activesupport (= 3.1.1)
+      rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
-      thor (~> 0.14.4)
+      thor (~> 0.14.6)
     rake (0.9.2.2)
-    rdoc (3.12)
+    rdoc (3.11)
       json (~> 1.4)
-    sqlite3 (1.3.5)
-    test-unit (2.2.0)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    rspec-rails (2.7.0)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.7.0)
+    sprockets (2.0.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.4)
     thor (0.14.6)
+    tilt (1.3.3)
     treetop (1.4.10)
       polyglot
       polyglot (>= 0.3.1)
@@ -83,9 +106,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  contest
-  mocha
-  rails (= 3.0.11)
+  rails (~> 3.1)
+  rspec
+  rspec-rails
   sqlite3
-  test-unit
   themes_for_rails!

data/README.textile

@@ -1,33 +1,258 @@
 h1. Theme For Rails (3 and hopefully later)
 
-h2. Features list 
+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
-* (NEW) works with the Rails Assets Pipeline without interfering, and leveraging it.   
 
-h2. Compatibility
+<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. :)
 
-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
 
-* "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
+"Read it here":http://rubydoc.info/github/lucasefe/themes_for_rails/master/frames
 
-h2. Ideas / Inspiration
+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>
@@ -39,7 +264,6 @@ rake
 h2. Authors and contributors
 
 * lucasefe
-* jedifreeman
 * jbarreneche
 * kule
 * matheusmoreira

data/Rakefile

@@ -1,11 +1,31 @@
-#!/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
+# require File.join(File.dirname(__FILE__), 'lib', 'themes_for_rails')
+require File.dirname(__FILE__) + "/lib/themes_for_rails/version.rb"
+
+require 'rake'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Default: run rspec for all'
+task :default => :spec
+
+desc "Run the code examples"
+RSpec::Core::RakeTask.new(:spec ) do |t|
+  t.pattern = "./spec/**/*_spec.rb"
+end
+
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "themes_for_rails"
+    gemspec.summary = "Themes support for rails (3)"
+    gemspec.description = "It allows an application to have many different ways of rendering static assets and dynamic views."
+    gemspec.email = "lucasefe@gmail.com"
+    gemspec.homepage = "http://github.com/lucasefe/themes_for_rails"
+    gemspec.authors = ["Lucas Florio"]
+    gemspec.version = ThemesForRails::VERSION
+    gemspec.add_dependency "rails", "~> 3.1.0"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end