themes_on_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d025d6301cdac27ace8312ce556aaac0e017be31
+  data.tar.gz: a71f476abd9d2660d7c42f9a29482db576166599
+SHA512:
+  metadata.gz: 8e7bbbd53e44d4eca576d9fbc0cc3f2bbbec9aae7ab6931cc0e69ee5f265bb09c8a8dd496ba5c496cef2772b11a9953457e043b8b7ce01a52289d6efdd23678b
+  data.tar.gz: c889fd6896ec5c11be83a59d3a4299eb697266e72d1932cb33be144d8dde06398dcbf4bcb9f3c459fe77ef40392130771abee3343e527ba29bf78691653b61d7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Chamnap Chhorn
+
+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.md

@@ -0,0 +1,110 @@
+# ThemesOnRails [![Build Status](https://travis-ci.org/yoolk/themes_on_rails.png?branch=master)](https://travis-ci.org/yoolk/themes_on_rails) [![Dependency Status](https://gemnasium.com/yoolk/themes_on_rails.png)](https://gemnasium.com/yoolk/themes_on_rails) [![Code Climate](https://codeclimate.com/github/yoolk/themes_on_rails.png)](https://codeclimate.com/github/yoolk/themes_on_rails) [![Coverage Status](https://coveralls.io/repos/yoolk/themes_on_rails/badge.png?branch=master)](https://coveralls.io/r/yoolk/themes_on_rails?branch=master)
+
+## Installation
+
+The simplest way to install is to use Bundler.
+
+Add this gem to your Gemfile:
+
+    gem "themes_on_rails"
+
+Then, use Bundler to install the gem and its dependencies:
+
+    $ bundle install
+
+## Usage
+
+A theme is composed of two things:
+
+  1. Views: templates and layouts (erb, haml, or other template engines)
+  2. Assets: images, javascripts, stylesheets
+
+### Generator
+
+To generate theme inside your app:
+
+    $ rails g themes_on_rails:theme theme_name
+
+<pre>
+app/
+  themes/
+    [theme_name]/
+      assets/
+        images/
+          [theme_name]/
+        stylesheets/
+          [theme_name]/
+            all.css
+        javascripts/
+          [theme_name]/
+            all.js
+      views/
+        layouts/
+          [theme_name].html.erb
+</pre>
+
+It's best advisable to namespace your assets directory so that it won't conflict with assets in other themes.
+
+```ruby
+image_tag           "professional_blue/logo.png" # => app/themes/professional_blue/assets/images/professional_blue/logo.png
+javascript_link_tag "professional_blue/all"      # => app/themes/professional_blue/assets/javascripts/professional_blue/all.js
+stylesheet_link_tag "professional_blue/all"      # => app/themes/professional_blue/assets/stylesheets/professional_blue/all.css
+```
+
+### Controller
+
+You can set theme in your controllers by using the `theme` declaration. For example:
+
+```ruby
+class HomeController < ApplicationController
+  theme "basic"
+
+  def index
+    ...
+  end
+end
+```
+
+With this declaration, all of the views rendered by the home controller will use `app/themes/basic/views/home/index.html.erb` as its templates and use `app/themes/basic/views/layouts/basic.html.erb`.
+
+You can use a symbol to defer the choice of theme until a request is processed:
+
+```ruby
+class HomeController < ApplicationController
+  theme :theme_resolver
+
+  def index
+    ...
+  end
+
+  private
+
+    def theme_resolver
+      params[:theme].presence || "professional"
+    end
+end
+```
+
+Now, if there is a `params[:theme]`, it will use that theme. Otherwise, it will use **professional** theme.
+
+You can even use an inline method, such as a **Proc**, to determine the theme. For example, if you pass a **Proc** object, the block you give the **Proc** will be given the controller instance, so the theme can be determined based on the current request:
+
+```ruby
+class HomeController < ApplicationController
+  theme Proc.new { |controller| params[:theme].presence || "professional" }
+end
+```
+
+Theme specified at the controller level support the `:only` and `:except` options. These options take either a method name, or an array of method names, corresponding to method names within the controller:
+
+```ruby
+class HomeController < ApplicationController
+  theme "basic", except: [:rss]
+end
+```
+
+With this declaration, the **basic** theme would be used for everything but the `rss` index methods.
+
+## Authors
+
+* [Chamnap Chhorn](https://github.com/chamnap)

data/Rakefile

@@ -0,0 +1,60 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+# bunlder tasks
+Bundler::GemHelper.install_tasks
+
+# dummy app tasks
+require 'rake'
+load File.expand_path('spec/dummy/Rakefile')
+
+ENV["RAILS_ENV"] = "test"
+
+# spec tasks
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+# Add two methods to Rake::Task
+class Rake::Task
+  def overwrite(&block)
+    @actions.clear
+    prerequisites.clear
+    enhance(&block)
+  end
+
+  def abandon
+    prerequisites.clear
+    @actions.clear
+  end
+end
+
+# Remove orginial `rake spec`
+Rake::Task[:spec].abandon
+
+RSpec::Core::RakeTask.new(:spec => 'db:test:prepare') do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => "spec:all"
+
+namespace :spec do
+  %w(rails_40 rails_32).each do |gemfile|
+    desc "Run Tests against #{gemfile}"
+    task gemfile do
+      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle --quiet"
+      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle exec rake spec"
+    end
+  end
+
+  desc "Run Tests against rails versions"
+  task :all do
+    %w(rails_40 rails_32).each do |gemfile|
+      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle --quiet"
+      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle exec rake spec"
+    end
+  end
+end

data/lib/generators/themes_on_rails/templates/all.css

@@ -0,0 +1,9 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *
+
+ *= require_self
+ *= require_tree .
+*/

data/lib/generators/themes_on_rails/templates/all.js

@@ -0,0 +1,7 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require_tree .

data/lib/generators/themes_on_rails/templates/layout.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= theme_name.humanize %></title>
+  <%%= stylesheet_link_tag    "<%= %Q{#{theme_name}/all} %>", media: "all", "data-turbolinks-track" => true %>
+  <%%= javascript_include_tag "<%= %Q{#{theme_name}/all} %>", "data-turbolinks-track" => true %>
+  <%%= csrf_meta_tags %>
+</head>
+<body>
+
+<%%= yield %>
+
+</body>
+</html>

data/lib/generators/themes_on_rails/templates/layout.html.haml

@@ -0,0 +1,9 @@
+!!!
+%html
+  %head
+    %title <%= "#{theme_name.humanize}" %>
+    = stylesheet_link_tag    "<%= %Q{#{theme_name}/all} %>", media: "all", "data-turbolinks-track" => true
+    = javascript_include_tag "<%= %Q{#{theme_name}/all} %>", "data-turbolinks-track" => true
+    = csrf_meta_tags
+  %body
+    = yield

data/lib/generators/themes_on_rails/theme_generator.rb

@@ -0,0 +1,52 @@
+module ThemesOnRails
+  module Generators
+    class ThemeGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      argument    :theme_name, type: :string
+      desc        "Creates a new theme"
+
+     def create_theme_directory
+        empty_directory theme_views_layout
+        empty_directory theme_images_directory
+        empty_directory theme_javascripts_directory
+        empty_directory theme_stylesheets_directory
+        create_file     "#{theme_images_directory}/.gitkeep", nil
+      end
+
+      def copy_manifest_files
+        copy_file       "all.js", "#{theme_javascripts_directory}/all.js"
+        copy_file       "all.css", "#{theme_stylesheets_directory}/all.css"
+      end
+
+      def copy_layout_file
+        if Rails.configuration.app_generators.rails[:template_engine] == :haml
+          template "layout.html.haml", "#{theme_views_layout}/#{theme_name}.html.haml"
+        else
+          template "layout.html.erb", "#{theme_views_layout}/#{theme_name}.html.erb"
+        end
+      end
+
+      private
+
+        def theme_directory
+          "app/themes/#{theme_name}"
+        end
+
+        def theme_views_layout
+          "#{theme_directory}/views/layouts"
+        end
+
+        def theme_images_directory
+          "#{theme_directory}/assets/images/#{theme_name}"
+        end
+
+        def theme_javascripts_directory
+          "#{theme_directory}/assets/javascripts/#{theme_name}"
+        end
+
+        def theme_stylesheets_directory
+          "#{theme_directory}/assets/stylesheets/#{theme_name}"
+        end
+    end
+  end
+end

data/lib/themes_on_rails/action_controller.rb

@@ -0,0 +1,61 @@
+module ThemesOnRails
+  class ActionController
+    attr_reader :theme_name
+
+    class << self
+      def apply_theme(controller_class, theme, options={})
+        filter_method = before_filter_method(options)
+        options       = options.slice(:only, :except)
+
+        controller_class.send(filter_method, options) do |controller|
+
+          # initialize
+          instance = ThemesOnRails::ActionController.new(controller, theme)
+
+          # set layout
+          controller_class.layout(instance.theme_name, options)
+
+          # prepend view path
+          controller.prepend_view_path instance.theme_view_path
+        end
+      end
+
+      private
+
+        def before_filter_method(options)
+          case Rails::VERSION::MAJOR
+          when 3
+            options.delete(:prepend) ? :prepend_before_filter : :before_filter
+          when 4
+            options.delete(:prepend) ? :prepend_before_action : :before_action
+          end
+        end
+    end
+
+    def initialize(controller, theme)
+      @controller = controller
+      @theme_name = _theme_name(theme)
+    end
+
+    def theme_view_path
+      "#{prefix_path}/#{@theme_name}/views"
+    end
+
+    def prefix_path
+      "#{Rails.root}/app/themes"
+    end
+
+    private
+
+      def _theme_name(theme)
+        case theme
+        when String     then theme
+        when Proc       then theme.call(@controller).to_s
+        when Symbol     then @controller.respond_to?(theme, true) ? @controller.send(theme).to_s : theme.to_s
+        else
+          raise ArgumentError,
+            "String, Proc, or Symbol, expected for `theme'; you passed #{theme.inspect}"
+        end
+      end
+  end
+end

data/lib/themes_on_rails/controller_additions.rb

@@ -0,0 +1,13 @@
+module ThemesOnRails
+  module ControllerAdditions
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def theme(theme, options={})
+        @_theme         = theme
+        @_theme_options = options
+        ThemesOnRails::ActionController.apply_theme(self, theme, options)
+      end
+    end
+  end
+end

data/lib/themes_on_rails/engine.rb

@@ -0,0 +1,6 @@
+require "rails/generators"
+
+module ThemesOnRails
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/themes_on_rails/railtie.rb

@@ -0,0 +1,17 @@
+module ThemesOnRails
+  class Railtie < ::Rails::Railtie
+
+    initializer "themes_on_rails.action_controller" do |app|
+      ActiveSupport.on_load :action_controller do
+        include ThemesOnRails::ControllerAdditions
+      end
+    end
+
+    initializer "themes_on_rails.assets_path" do |app|
+      Dir.glob("#{Rails.root}/app/themes/*/assets/*").each do |dir|
+        app.config.assets.paths << dir
+      end
+    end
+
+  end
+end

data/lib/themes_on_rails/version.rb

@@ -0,0 +1,3 @@
+module ThemesOnRails
+  VERSION = "0.1.0"
+end

data/lib/themes_on_rails.rb

@@ -0,0 +1,9 @@
+require "themes_on_rails/version"
+require "active_support/concern"
+
+module ThemesOnRails
+  autoload :ActionController,    "themes_on_rails/action_controller"
+  autoload :ControllerAdditions, "themes_on_rails/controller_additions"
+end
+
+require "themes_on_rails/railtie" if defined?(Rails)

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.