themes_for_rails4 1.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a72e664f53d3d34f71ff0cbb6096f8058c694fa
+  data.tar.gz: 6dc0f2abaec5f2f6ca2eeece355b4866b8714309
+SHA512:
+  metadata.gz: a81364248c59bd2fdae3f83cb1fb46180a90bb264fe38747341bb70f1b114dd1ceb52b488d9760aaa6ff713136d1a6a5d85ddaf7756f1fb8e77cd6cf266a88d9
+  data.tar.gz: a5927642b68c108a7f5feb88da7c0bf5626648a7923c9c8f9591408fbd761a481f430f395a27b7ca9d38e33051297340b236a7469f89e51c83732377ce6b7e4a

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/.travis.yml

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

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://ruby.taobao.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,117 @@
+PATH
+  remote: .
+  specs:
+    themes_for_rails4 (1.5.1)
+      rails (>= 3.0.0)
+
+GEM
+  remote: https://ruby.taobao.org/
+  specs:
+    actionmailer (4.2.1)
+      actionpack (= 4.2.1)
+      actionview (= 4.2.1)
+      activejob (= 4.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.1)
+      actionview (= 4.2.1)
+      activesupport (= 4.2.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    actionview (4.2.1)
+      activesupport (= 4.2.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    activejob (4.2.1)
+      activesupport (= 4.2.1)
+      globalid (>= 0.3.0)
+    activemodel (4.2.1)
+      activesupport (= 4.2.1)
+      builder (~> 3.1)
+    activerecord (4.2.1)
+      activemodel (= 4.2.1)
+      activesupport (= 4.2.1)
+      arel (~> 6.0)
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.0)
+    builder (3.2.2)
+    contest (0.1.3)
+    erubis (2.7.0)
+    globalid (0.3.5)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    metaclass (0.0.1)
+    mime-types (2.6.1)
+    mini_portile (0.6.2)
+    minitest (5.7.0)
+    mocha (0.12.2)
+      metaclass (~> 0.0.1)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.1)
+      actionmailer (= 4.2.1)
+      actionpack (= 4.2.1)
+      actionview (= 4.2.1)
+      activejob (= 4.2.1)
+      activemodel (= 4.2.1)
+      activerecord (= 4.2.1)
+      activesupport (= 4.2.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.1)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.6)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    railties (4.2.1)
+      actionpack (= 4.2.1)
+      activesupport (= 4.2.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    sprockets (3.2.0)
+      rack (~> 1.0)
+    sprockets-rails (2.3.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.6)
+    test-unit (2.5.1)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  contest
+  mocha
+  sqlite3
+  test-unit
+  themes_for_rails4!
+
+BUNDLED WITH
+   1.10.5

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,53 @@
+h1. Theme For Rails (3 and hopefully later)
+
+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.   
+
+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
+
+* "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 / 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. 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
+* jedifreeman
+* 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>

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/doc/README.textile

@@ -0,0 +1,380 @@
+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.
+
+You will need to enable asset digests in your rails app. This is normally enabled in production mode but you can add it to your development environment to
+test locally.
+
+<pre>
+# config/environments/development.rb
+
+config.assets.digest = true
+
+</pre>
+
+h4. PLEASE ADD themes_for_rails TO THE ASSETS GROUP IN YOUR GEMFILE!
+In order to automatically add the themes to your asset pipeline you need to add the themes_for_rails gem to the assets group in your Gemfile.
+
+
+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]
+          assets/          <-- this is your theme_assets_dir
+            [theme_name]   <-- this ensures that the assets are namespaced and don't clobber eachother.
+              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.assets_dir = 'app/assets/themes/:name/assets'
+  # ...
+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]
+          assets/          <-- this is your theme_assets_dir
+            [theme_name]   <-- this ensures that the assets are namespaced and don't clobber eachother.
+              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/:name/assets'
+  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')   # => /assets/default/images/logo.png
+current_theme_stylesheet_path('style') # => /assets/default/stylesheets/logo.css
+current_theme_javascript_path('app')   # => /assets/default/stylesheets/app.js
+</pre>
+
+Or a given theme:
+
+<pre>
+current_theme_image_path('logo.png', 'purple')   # => /assets/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>

data/doc/RMU_REVIEW

@@ -0,0 +1,26 @@
+- Setup
+
+Add themes_for_rails to your Gemfile.
+
+gem 'themes_for_rails'
+
+Add themes_for_rails to your config/routes.rb
+
+Then follow the instructions provided in the README file. 
+
+- Accomplishments
+
+I've accomplished several things:
+
+* I got the chance to know a lot about the Raisl 3 public API. I have worked a lot on hooking the themes support cleanly, and not using monkey patching. 
+
+* I also learned about testing with the minimal. In this project I am not using rspec, but test_unit, so this was different from what I was used to. 
+
+* This time, I build the library step by step, one part at a time, which was pretty different from what I did with the twitter lib. Progressively built. I required to do design first and then coding. Leasson learned. 
+
+* Finally, coding style. Use vertical spaces. 
+
+---NOTE---
+
+More information reading the specs, or the README. 
+

data/doc/TODO.textile

@@ -0,0 +1,3 @@
+- Allow to change the way the view path is added. Before or after. 
+
+- Research how to integrate SASS to this scheme. 

data/lib/generators/themes_for_rails/install_generator.rb

@@ -0,0 +1,16 @@
+module ThemesForRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Creates a ThemeForRails basic structure."
+
+      def create_themes_folder
+        empty_directory(ThemesForRails.config.themes_path)
+      end
+      
+      def add_themes_for_rails_routes
+        route "themes_for_rails"
+      end
+      
+    end
+  end
+end

data/lib/generators/themes_for_rails/theme_generator.rb

@@ -0,0 +1,14 @@
+module ThemesForRails
+  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(ThemesForRails.config.themes_path, name)
+        directory  'theme', theme_dir
+      end
+
+    end
+  end
+end