refinerycms-theming 0.9.8

data/app/helpers/themes_helper.rb

@@ -0,0 +1,34 @@
+module ThemesHelper
+  def image_tag(source, options={})
+    theme = (options.delete(:theme) == true)
+    tag = super
+    # inject /theme/ into the image tag src if this is themed.
+    tag.gsub!(/src=[\"|\']/) { |m| "#{m}/theme/" }.gsub!("//", "/") if theme
+    tag.gsub(/theme=(.+?)\ /, '') # we need to remove any addition of theme='false' etc.
+  end
+
+  def javascript_include_tag(*sources)
+    theme = (arguments = sources.dup).extract_options![:theme] == true # don't ruin the current sources object
+    tag = super
+    # inject /theme/ into the javascript include tag src if this is themed.
+    tag.gsub!(/\/javascripts\//, "/theme/javascripts/") if theme
+    tag.gsub(/theme=(.+?)\ /, '') # we need to remove any addition of theme='false' etc.
+  end
+
+  def stylesheet_link_tag(*sources)
+    theme = (arguments = sources.dup).extract_options![:theme] == true # don't ruin the current sources object
+    tag = super
+    # inject /theme/ into the stylesheet link tag href if this is themed.
+    tag.gsub!(/\/stylesheets\//, "/theme/stylesheets/") if theme
+    tag.gsub(/theme=(.+?)\ /, '') # we need to remove any addition of theme='false' etc.
+  end
+
+  def image_submit_tag(source, options = {})
+    theme = (options.delete(:theme) == true)
+
+    tag = super
+    # inject /theme/ into the image tag src if this is themed.
+    tag.gsub!(/src=[\"|\']/) { |m| "#{m}/theme/" }.gsub!("//", "/") if theme
+    tag.gsub(/theme=(.+?)\ /, '') # we need to remove any addition of theme='false' etc.
+  end
+end

data/app/models/theme.rb

@@ -0,0 +1,7 @@
+class Theme
+
+  def self.current_theme(env)
+    RefinerySetting[:theme]
+  end
+
+end

data/features/step_definitions/theme_generator_steps.rb

@@ -0,0 +1,15 @@
+Before do
+  @theme_generator_root  = File.join(File.dirname(__FILE__), "/../../")
+  @tmp_refinery_app_name  = "tmp_refinery_app"
+  @tmp_refinery_app_root  = File.join(@theme_generator_root, @tmp_refinery_app_name)
+  @app_root = @tmp_refinery_app_root
+  Rails::Generator::Base.append_sources(Rails::Generator::PathSource.new(:theme, "#{@theme_generator_root}/generators/"))
+end
+
+After do
+  FileUtils.rm_rf(@tmp_refinery_app_root)
+end
+
+When /^I generate a theme with the name of "([^"]*)"$/ do |name|
+  Rails::Generator::Scripts::Generate.new.run(['refinery_theme', name], {:quiet => true, :destination => @app_root})
+end

data/features/theme_generator.feature

@@ -0,0 +1,16 @@
+Feature: Theme generation
+  In order to create my own theme
+  As a refinery user
+  I want to generate a basic theme directory structure
+
+  Scenario: Generating a theme with a name
+    Given I have a refinery application
+    When I generate a theme with the name of "modern"
+    Then I should have a directory "themes/modern"
+    And I should have a file "themes/modern/stylesheets/application.css"
+    And I should have a file "themes/modern/stylesheets/home.css"
+    And I should have a file "themes/modern/stylesheets/formatting.css"
+    And I should have a file "themes/modern/views/layouts/application.html.erb"
+    And I should have a file "themes/modern/views/pages/home.html.erb"
+    And I should have a file "themes/modern/views/pages/show.html.erb"
+    And I should have a directory "themes/modern/javascripts"

data/lib/gemspec.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+version = '0.9.8'
+raise "Could not get version so gemspec can not be built" if version.nil?
+files = Dir[%q{**/*}].flatten.reject{|f| f =~ /\.gem$/}
+
+gemspec = <<EOF
+Gem::Specification.new do |s|
+  s.name              = %q{refinerycms-theming}
+  s.version           = %q{#{version}}
+  s.description       = %q{Theming functionality for the Refinery CMS project, extracted from Refinery CMS core.}
+  s.date              = %q{#{Time.now.strftime('%Y-%m-%d')}}
+  s.summary           = %q{Theming functionality for the Refinery CMS project.}
+  s.email             = %q{info@refinerycms.com}
+  s.homepage          = %q{http://refinerycms.com}
+  s.authors           = %w(Resolve\\ Digital)
+  s.require_paths     = %w(lib)
+
+  s.files             = [
+    '#{files.join("',\n    '")}'
+  ]
+  #{"s.test_files        = [
+    '#{Dir.glob("test/**/*.rb").join("',\n    '")}'
+  ]" if File.directory?("test")}
+  
+  s.add_dependency('refinerycms', '>= 0.9.8')
+end
+EOF
+
+File.open(File.expand_path("../../refinerycms-theming.gemspec", __FILE__), 'w').puts(gemspec)

data/lib/generators/refinery_theme/README

@@ -0,0 +1,17 @@
+== Refinery Theme Generator
+
+== Description
+
+Generate a new barebones Refinery theme.
+
+If you want this new theme to be the current theme used, set the "theme"
+setting in the Refinery backend to the name of this theme.
+
+== Usage
+rails generate refinery_theme theme_name
+
+== Example
+rails generate refinery_theme modern
+
+Results in:
+create  /themes/modern/...

data/lib/generators/refinery_theme/Rakefile

@@ -0,0 +1,11 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Generate documentation for the Refinery Theme Generator plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Refinery Theme Generator'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+end

data/lib/generators/refinery_theme/USAGE

@@ -0,0 +1,2 @@
+Usage:
+  rails generate refinery_theme modern

data/lib/generators/refinery_theme/refinery_theme_generator.rb

@@ -0,0 +1,23 @@
+class RefineryThemeGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)  
+  argument :theme_name, :type => :string
+
+  def create_theme
+    copy_file "stylesheets/application.css", "themes/#{theme_name}/stylesheets/application.css"
+    copy_file "stylesheets/formatting.css", "themes/#{theme_name}/stylesheets/formatting.css"
+    copy_file "stylesheets/home.css", "themes/#{theme_name}/stylesheets/home.css"
+
+    copy_file "views/layouts/application.html.erb", "themes/#{theme_name}/views/layouts/application.html.erb"
+
+    copy_file "views/pages/show.html.erb", "themes/#{theme_name}/views/pages/show.html.erb"
+    copy_file "views/pages/home.html.erb", "themes/#{theme_name}/views/pages/home.html.erb"
+
+    if RefinerySetting.get(:theme).nil?
+      RefinerySetting.set(:theme, theme_name)
+      puts "NOTE: \"theme\" setting created and set to #{theme_name}"
+    else
+      puts 'NOTE: If you want this new theme to be the current theme used, set the "theme" setting in the Refinery backend to the name of this theme.' unless RAILS_ENV == "test"
+    end
+  end
+
+end

data/lib/generators/refinery_theme/templates/stylesheets/application.css

@@ -0,0 +1,5 @@
+@import url('/stylesheets/refinery/application.css');
+/*
+    Override default refinery application CSS below.
+    Formatting applies to all frontend.
+*/

data/lib/generators/refinery_theme/templates/stylesheets/formatting.css

@@ -0,0 +1,7 @@
+@import url('/stylesheets/refinery/formatting.css');
+/*  
+    Override default refinery formatting below. 
+    Formatting applies to backend WYSIWYG editors and all frontend. 
+    This is the best place to put your heading and text related styles
+    like colours, fonts and line-height.
+*/

data/lib/generators/refinery_theme/templates/stylesheets/home.css

@@ -0,0 +1,5 @@
+@import url('/stylesheets/refinery/home.css');
+/* 
+    Override default refinery homepage styles here. 
+    These only apply to the homepage of your site. 
+*/

data/lib/generators/refinery_theme/templates/views/layouts/application.html.erb

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html>
+  <%= render :partial => "/shared/head", :locals => {:theme => true} %>
+  <body>
+    <%= render :partial => "/shared/site_bar" %>
+    <div id='page_container'>
+      <div id='page'>
+        <%= render :partial => "/shared/ie6check" if request.env['HTTP_USER_AGENT'] =~ /MSIE/ -%>
+        <div id='header'>
+          <%= render :partial => "/shared/header" %>
+        </div>
+        <div id='body' class='clearfix'>
+          <%= yield %>
+        </div>
+        <div id='footer'>
+          <%= render :partial => "/shared/footer" %>
+        </div>
+      </div>
+    </div>
+  </body>
+</html>

data/lib/generators/refinery_theme/templates/views/pages/home.html.erb

@@ -0,0 +1,4 @@
+<%# For the best way to modify this page with your own markup read %>
+<%# http://github.com/resolve/refinerycms-theming/blob/master/readme.md %>
+
+<%= render :partial => "/shared/content_page" %>

data/lib/generators/refinery_theme/templates/views/pages/show.html.erb

@@ -0,0 +1,4 @@
+<%# For the best way to modify this page with your own markup read %>
+<%# http://github.com/resolve/refinerycms-theming/blob/master/readme.md %>
+
+<%= render :partial => "/shared/content_page" %>

data/lib/refinerycms-theming.rb

@@ -0,0 +1,47 @@
+require File.expand_path('../theming', __FILE__)
+
+module Refinery
+  class ThemingEngine < ::Rails::Engine
+
+    config.to_prepare do
+      ::ApplicationController.module_eval do
+
+        # Add or remove theme paths to/from Refinery application
+        prepend_before_filter :attach_theme_to_refinery
+
+        def attach_theme_to_refinery
+          # remove any paths relating to any theme.
+          view_paths.reject! { |v| v.to_s =~ %r{^themes/} }
+
+          # add back theme paths if there is a theme present.
+          if (theme = ::Theme.current_theme(request.env)).present?
+            # Set up view path again for the current theme.
+            view_paths.unshift Rails.root.join("themes", theme, "views").to_s
+
+            # Ensure that routes within the application are top priority.
+            # Here we grab all the routes that are under the application's view folder
+            # and promote them ahead of any other path.
+            view_paths.select{|p| p.to_s =~ %r{^#{Rails.root.join('app', 'views')}}}.each do |app_path|
+              view_paths.unshift app_path
+            end
+          end
+
+          # Set up menu caching for this theme or lack thereof
+          if RefinerySetting.table_exists? and
+             RefinerySetting.get(:refinery_menu_cache_action_suffix) != (suffix = "#{"#{theme}_" if theme.present?}site_menu")
+            RefinerySetting.set(:refinery_menu_cache_action_suffix, suffix)
+          end
+        end
+        protected :attach_theme_to_refinery
+
+      end
+
+      ::ApplicationHelper.send :include, ::ThemesHelper
+    end
+
+    initializer 'themes.middleware' do |app|
+      app.config.middleware.insert_before ::ActionDispatch::Static, ::Refinery::ThemeServer
+    end
+
+  end
+end

data/lib/theme_server.rb

@@ -0,0 +1,32 @@
+# Allow the metal piece to run in isolation
+require File.expand_path('../../../config/environment', __FILE__) unless defined?(Rails)
+
+# Serves theme files from the theme directory without touching Rails too much
+module Refinery
+  class ThemeServer
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if env["PATH_INFO"] =~ /^\/theme\/(stylesheets|javascripts|images)/ and (theme = Theme.current_theme(env)).present?
+        env["PATH_INFO"].gsub!(/^\/theme\//, '')
+        if (file_path = (dir = Rails.root.join("themes", theme)).join(env["PATH_INFO"])).exist?
+          etag = Digest::MD5.hexdigest("#{file_path.to_s}#{file_path.mtime}")
+          unless (etag == env["HTTP_IF_NONE_MATCH"])
+            status, headers, body = Rack::File.new(dir).call(env)
+            [status, headers.update({"ETag" => etag}), body]
+          else
+            [304, {"ETag" => etag}, []]
+          end
+        else
+          [404, {}, []]
+        end
+      else
+        @app.call(env)
+      end
+    end
+
+  end
+end

data/lib/theming.rb

@@ -0,0 +1,2 @@
+# Before the application gets setup this will fail badly if there's no database.
+require File.expand_path('../theme_server', __FILE__)

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+ 
+Copyright (c) 2005-2010 [Resolve Digital Ltd.](http://www.resolvedigital.co.nz)
+ 
+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,118 @@
+# Themes
+
+## Introduction
+
+__Themes allow you to wrap up the design of your Refinery site into a single folder that is portable.__
+
+Refinery doesn't force you to learn a special templating language, but rather just uses the regular
+ERB views you're used to in Rails. This means creating a theme from your existing site is extremely easy.
+
+Think of a theme as your ``app/views`` directory with a few extra things like images, css and javascript.
+
+It's worth noting you don't need to use a theme if you don't want to. Placing files in the ``app/views`` directory like any other Rails app will work just fine. It's only if you want to wrap your design up into a single location that you would use a theme or allow your client to easily change between designs.
+
+## The Structure of a Theme
+
+Themes sit in your Rails app like this
+
+    app/
+    config/
+    db/
+    lib/
+    public/
+    themes/
+      |- mytheme/
+      |- othertheme/
+    plugins/
+    tests/
+
+Let's take the ``mytheme`` example theme shown above. This is how the theme is structured:
+
+    mytheme/
+       |- images
+       |    |- whatever.png
+       |    |- foo.jpg
+       |- javascripts
+       |    |- whatever.js
+       |- LICENSE
+       |- README
+       |- stylesheets/
+       |    |- application.css
+       |    |- whatever.css
+       |- views
+            |- pages
+            |    |- show.html.erb
+            |    |- index.html.erb
+            |- layouts
+                 |- application.html.erb
+
+   
+### Images
+
+Usually this would be just what you have in ``public/images`` except we move that to the theme instead.
+
+### Javascripts
+
+Same with javascripts, just what you normally have in ``public/javascripts`` but in this theme directory instead.
+
+### Readme
+
+The ``README`` file is just a description of your theme.
+
+### Views
+
+This is exactly the same as how you lay your views out in ``app/views/`` just instead of putting them in ``app/views/`` you put them into ``themes/mytheme/views/``
+
+## How do I make my own Theme?
+
+Simply use the Theme generator to make the basic structure of a new theme.
+
+    rails generate refinery_theme name_of_theme
+
+Don't forget to "activate" this new theme by setting the theme setting to the name of this new theme.
+
+## How do I select which Theme Refinery should use?
+
+In the admin area of Refinery go to the "Settings" area, locate the setting called "theme" and edit it.
+
+Set the value of that setting to the name of your themes folder. For example, if your theme is sitting in:
+
+    themes/my_theme
+
+set it to ``my_theme`` and hit save.
+
+## How do I install someone else's Theme?
+
+Just copy their theme directory into your themes folder and Refinery will see it.
+
+## How can I Convert my Current Views into a Theme?
+
+This should be fairly straightforward, just follow the directory structure outlined in 'The structure of a Theme'. 
+
+But there is one important difference that need to be addressed to convert your current site into a theme.
+
+If you have some CSS which refers to an image or URL:
+
+    #footer {
+      background: url('/images/footer_background.png') repeat-x;
+    }
+
+You need to update the URL so it requests ``/theme/images/`` instead of just ``/images``. This tells Refinery we need to actually load this image from the theme and not just the public directory.
+
+So the result is simply:
+
+    #footer {
+      background: url('/theme/images/footer_background.png') repeat-x;
+    }
+
+This is the same with linking to Javascript and Stylesheets in your view. Say our ``application.html.erb`` layout had something like this:
+
+    <%= stylesheet_link_tag 'application' %>
+
+You just need to change that to:
+
+    <%= stylesheet_link_tag 'application', :theme => true %>
+    
+## I'm Stuck, is there an Example Theme?
+
+Yep, there is an example theme called "demolicious" that comes with Refinery located in ``/themes/demolicious``. If you find yourself getting stuck, just check out that theme and get a feel for how it works.