themes_for_rails 0.2.1

data/.gitignore

@@ -0,0 +1,3 @@
+.bundle
+pkg
+tmp

data/.rvmrc

@@ -0,0 +1,5 @@
+if [[ -n "$rvm_environments_path" && -s "$rvm_environments_path/ruby-1.9.2-p0@theme_support" ]] ; then
+  \. "$rvm_environments_path/ruby-1.9.2-p0@theme_support"
+else
+  rvm --create use  "ruby-1.9.2-p0@theme_support"
+fi

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem 'sqlite3-ruby', :require => 'sqlite3'
+gem "rails", "3.0.0"
+gem 'test-unit', :require => 'test/unit'
+gem "rspec-rails", ">= 2.0.0.beta.20"
+gem 'themes_for_rails', :path => '.'
+gem 'jeweler'
+gem "contest"
+gem 'mocha'
+

data/Gemfile.lock

@@ -0,0 +1,108 @@
+PATH
+  remote: .
+  specs:
+    themes_for_rails (0.2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.0)
+      actionpack (= 3.0.0)
+      mail (~> 2.2.5)
+    actionpack (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    contest (0.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    i18n (0.4.1)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    mail (2.2.5)
+      activesupport (>= 2.3.6)
+      mime-types
+      treetop (>= 1.4.5)
+    mime-types (1.16)
+    mocha (0.9.8)
+      rake
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.4)
+      rack (>= 1.0)
+    rails (3.0.0)
+      actionmailer (= 3.0.0)
+      actionpack (= 3.0.0)
+      activerecord (= 3.0.0)
+      activeresource (= 3.0.0)
+      activesupport (= 3.0.0)
+      bundler (~> 1.0.0)
+      railties (= 3.0.0)
+    railties (3.0.0)
+      actionpack (= 3.0.0)
+      activesupport (= 3.0.0)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    rspec (2.0.0.beta.20)
+      rspec-core (= 2.0.0.beta.20)
+      rspec-expectations (= 2.0.0.beta.20)
+      rspec-mocks (= 2.0.0.beta.20)
+    rspec-core (2.0.0.beta.20)
+    rspec-expectations (2.0.0.beta.20)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.20)
+    rspec-rails (2.0.0.beta.20)
+      rspec (= 2.0.0.beta.20)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    sqlite3-ruby (1.3.1)
+    test-unit (2.1.1)
+    thor (0.14.0)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  contest
+  jeweler
+  mocha
+  rails (= 3.0.0)
+  rspec-rails (>= 2.0.0.beta.20)
+  sqlite3-ruby
+  test-unit
+  themes_for_rails!

data/README.textile

@@ -0,0 +1,155 @@
+h1. Theme For Rails (3 and hopefully later)
+
+h2. Features list / Wish list
+
+* Support for adding themes which includes stylesheets, javascripts, views and layouts. 
+
+<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. 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.
+
+<pre>
+rails generate theme_for_rails:install  
+</pre>
+
+Inside the themes folder, it create a structure for my_theme.
+
+<pre>
+rails generate theme_for_rails:theme my_theme  
+</pre>
+
+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. Running tests
+
+<pre>
+gem install bundler
+bundle install
+rake
+</pre>
+
+h2. Authors and contributors
+
+* lucasefe

data/Rakefile

@@ -0,0 +1,33 @@
+# require File.join(File.dirname(__FILE__), 'lib', 'themes_for_rails')
+require File.dirname(__FILE__) + "/lib/themes_for_rails/version.rb"
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run tests for all ORMs.'
+task :default => :test
+
+desc 'Run unit tests.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+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
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+

data/init.rb

@@ -0,0 +1 @@
+require "themes_for_rails"

data/lib/generators/theme_for_rails/install_generator.rb

@@ -0,0 +1,11 @@
+module ThemeForRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Creates a ThemeForRails basic structure."
+
+      def create_themes_folder
+        empty_directory(File.join(Rails.root, 'themes'))
+      end
+    end
+  end
+end

data/lib/generators/theme_for_rails/theme_generator.rb

@@ -0,0 +1,17 @@
+module ThemeForRails
+  module Generators
+    class ThemeGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+      desc "Creates an empty theme."
+      
+      def create_theme
+        theme_dir = File.join(themes_path, name)
+        directory  'theme', theme_dir
+      end
+    private
+      def themes_path
+        File.join(Rails.root, "themes")
+      end
+    end
+  end
+end

data/lib/tasks/themes_for_rails.rake

@@ -0,0 +1,21 @@
+namespace :themes do
+  desc "Creates the cached theme folder"
+  task :create_cache => :environment do
+    for theme in ThemesForRails.available_themes
+      theme_name = File.basename(theme)
+      puts "Creating #{Rails.public_path}/themes/#{theme_name}"
+  
+      FileUtils.mkdir_p "#{Rails.public_path}/themes/#{theme_name}"      
+      FileUtils.cp_r "#{theme}/images", "#{Rails.public_path}/themes/#{theme_name}/images", :verbose => true
+      FileUtils.cp_r "#{theme}/stylesheets", "#{Rails.public_path}/themes/#{theme_name}/stylesheets", :verbose => true
+      FileUtils.cp_r "#{theme}/javascripts", "#{Rails.public_path}/themes/#{theme_name}/javascripts", :verbose => true
+    end
+  end
+  desc "Removes the cached (public) theme folders"
+  task :remove_cache => :environment do
+    puts "Removing #{Rails.public_path}/themes"
+    FileUtils.rm_r "#{Rails.public_path}/themes", :force => true
+  end
+  desc "Updates the cached (public) theme folders"
+  task :update_cache => [:remove_cache, :create_cache]
+end

data/lib/themes_for_rails.rb

@@ -0,0 +1,23 @@
+module ThemesForRails
+  class << self
+    def theme_base_dir
+      Rails.root
+    end
+    def available_themes
+      Dir.glob("#{theme_base_dir}/themes/*")
+    end
+    def available_theme_names
+      @available_theme_names ||= available_themes.map {|theme| File.basename(theme) } 
+    end
+  end
+end
+
+require 'active_support/dependencies'
+require 'themes_for_rails/common_methods'
+require 'themes_for_rails/url_helpers'
+require 'themes_for_rails/view_helpers'
+require 'themes_for_rails/assets_controller'
+require 'themes_for_rails/controller_methods'
+require 'themes_for_rails/railtie'
+require 'themes_for_rails/routes'
+require 'themes_for_rails/version'

data/lib/themes_for_rails/assets_controller.rb

@@ -0,0 +1,37 @@
+require "action_controller/metal"
+
+module ThemesForRails
+  class AssetsController < ActionController::Base
+    include ThemesForRails::CommonMethods
+    include ThemesForRails::UrlHelpers
+    def stylesheets
+      render_asset theme_stylesheet_path_for(params[:theme], params[:asset]), 'text/css'
+    end
+    def javascripts
+      render_asset theme_javascript_path_for(params[:theme], params[:asset]), 'text/javascript'
+    end
+    def images
+      render_asset theme_image_path_for(params[:theme], params[:asset], params[:extension]), "image/#{params[:extension]}"
+    end
+  private
+    def render_asset(asset, mime_type)
+      unless File.exists?(asset)
+        render :text => 'not found', :status => 404
+      else
+        send_file asset, :type => mime_type
+      end
+    end
+    # Physical paths
+    def theme_stylesheet_path_for(name, asset)
+      File.join(theme_path_for(name), 'stylesheets', "#{asset}.css")
+    end
+    def theme_javascript_path_for(name, asset)
+      File.join(theme_path_for(name), 'javascripts', "#{asset}.js")
+    end
+    def theme_image_path_for(name, asset, extension = nil)
+      extension ||= "png"
+      extension = ".#{extension}"
+      File.join(theme_path_for(name), 'images', "#{asset}#{extension}")
+    end
+  end
+end