Initial crack at getting Refinery to be module based and only activated when included.

Author: parndt

Rakefile

@@ -4,4 +4,4 @@
 require File.expand_path('../config/application', __FILE__)
 require 'rake'
 
-Refinery::Application.load_tasks
+RefineryApp::Application.load_tasks

app/controllers/application_controller.rb

@@ -1,9 +1,6 @@
 # Filters added to this controller apply to all controllers in the application.
 # Likewise, all the methods added will be available for all controllers.
 
-# You can extend refinery with your own functions here and they will likely not get overriden in an update.
-
 class ApplicationController < ActionController::Base
-  include Refinery::ApplicationController
 
 end

app/helpers/application_helper.rb

@@ -1,7 +1,5 @@
 # Methods added to this helper will be available to all templates in the application.
 
-# You can extend refinery with your own functions here and they will likely not get overriden in an update.
 module ApplicationHelper
-  include Refinery::ApplicationHelper # leave this line in to include all of Refinery's core helper methods.
 
 end

config.ru

@@ -1,4 +1,4 @@
 # This file is used by Rack-based servers to start the application.
 
 require ::File.expand_path('../config/environment',  __FILE__)
-run Refinery::Application
+run RefineryApp::Application

config/application.rb

@@ -6,8 +6,11 @@
 # you've limited to :test, :development, or :production.
 Bundler.require(:default, Rails.env) if defined?(Bundler)
 
-module Refinery
+module RefineryApp
   class Application < Rails::Application
+    # Includes Refinery's application
+    include ::Refinery::Application
+
     # Settings in config/environments/* take precedence over those specified here.
     # Application configuration should go into files in config/initializers
     # -- all .rb files in that directory are automatically loaded.
@@ -25,26 +28,5 @@ class Application < Rails::Application
     # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
     # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
     # config.time_zone = 'Central Time (US & Canada)'
-
-    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
-    config.i18n.load_path += Dir[Refinery.root.join('vendor', 'refinerycms', '*/config/locales/*.{rb,yml}').to_s]
-    # config.i18n.default_locale = :de
-
-    # JavaScript files you want as :defaults (application.js is always included).
-    config.action_view.javascript_expansions[:defaults] = %w()
-
-    # Configure the default encoding used in templates for Ruby 1.9.
-    config.encoding = "utf-8"
-
-    # Configure sensitive parameters which will be filtered from the log file.
-    config.filter_parameters += [:password, :password_confirmation]
-
-    # Specify a cache store to use
-    config.cache_store = :memory_store
-
-    # load in any settings that the developer wants after the initialization.
-    config.after_initialize do
-      require Rails.root.join('config', 'settings.rb')
-    end if Rails.root.join('config', 'settings.rb').exist?
   end
-end
+end

config/environment.rb

@@ -2,4 +2,4 @@
 require File.expand_path('../application', __FILE__)
 
 # Initialize the rails application
-Refinery::Application.initialize!
+RefineryApp::Application.initialize!

config/environments/development.rb

@@ -1,4 +1,4 @@
-Refinery::Application.configure do
+RefineryApp::Application.configure do
   # Settings specified here will take precedence over those in config/environment.rb
 
   # In the development environment your application's code is reloaded on

config/environments/production.rb

@@ -1,4 +1,4 @@
-Refinery::Application.configure do
+RefineryApp::Application.configure do
   # Settings specified here will take precedence over those in config/environment.rb
 
   # The production environment is meant for finished, "live" apps.

config/environments/test.rb

@@ -1,4 +1,4 @@
-Refinery::Application.configure do
+RefineryApp::Application.configure do
   # Settings specified here will take precedence over those in config/environment.rb
 
   # The test environment is used exclusively to run your application's

config/initializers/secret_token.rb

@@ -4,4 +4,4 @@
 # If you change this key, all old signed cookies will become invalid!
 # Make sure the secret is at least 30 characters and all random,
 # no regular words or you'll be exposed to dictionary attacks.
-Refinery::Application.config.secret_token = 'a87f3b2cd301eab5bfd6b21288123b0a76fc604844f73e2eeca7dd6936330d86e2b057ee91304b9b4244eb1aed83eaef882194983abdcfb0b75ba3714708e668'
+::Refinery::Application.config.secret_token = 'a87f3b2cd301eab5bfd6b21288123b0a76fc604844f73e2eeca7dd6936330d86e2b057ee91304b9b4244eb1aed83eaef882194983abdcfb0b75ba3714708e668'

config/initializers/session_store.rb

@@ -1,8 +1,8 @@
 # Be sure to restart your server when you modify this file.
 
-Refinery::Application.config.session_store :cookie_store, :key => '_rails_Refinery_session'
+::Refinery::Application.config.session_store :cookie_store, :key => '_rails_Refinery_session'
 
 # Use the database for sessions instead of the cookie-based default,
 # which shouldn't be used to store highly confidential information
 # (create the session table with "rake db:sessions:create")
-# Refinery::Application.config.session_store :active_record_store
+# ::Refinery::Application.config.session_store :active_record_store

config/routes.rb

@@ -1,19 +1,4 @@
-Refinery::Application.routes.draw do
-
-  # REFINERY CMS ================================================================
-
-  filter(:refinery_locales) if defined?(RoutingFilter::RefineryLocales) # optionally use i18n.
-
-  root :to => 'pages#home'
-
-  scope(:path => 'refinery', :as => 'admin', :module => 'admin') do
-    root :to => 'dashboard#index'
-  end
-
-  # Marketable URLs should be appended to routes by the Pages Engine.
-  # Catch all routes should be appended to routes by the Core Engine.
-
-  # END REFINERY CMS ============================================================
+::RefineryApp::Application.routes.draw do
 
   # The priority is based upon order of creation:
   # first created -> highest priority.

refinerycms.gemspec

@@ -268,6 +268,7 @@ Gem::Specification.new do |s|
     'vendor/refinerycms/core/lib/refinery',
     'vendor/refinerycms/core/lib/refinery/activity.rb',
     'vendor/refinerycms/core/lib/refinery/admin_base_controller.rb',
+    'vendor/refinerycms/core/lib/refinery/application.rb',
     'vendor/refinerycms/core/lib/refinery/application_controller.rb',
     'vendor/refinerycms/core/lib/refinery/application_helper.rb',
     'vendor/refinerycms/core/lib/refinery/base_presenter.rb',

vendor/refinerycms/authentication/config/routes.rb

@@ -1,4 +1,4 @@
-Refinery::Application.routes.draw do
+::Refinery::Application.routes.draw do
 
   resource :session, :only => [:new, :create, :destroy]
   match '/users/reset/:reset_code', :to => 'users#reset', :as => 'reset_users'

vendor/refinerycms/authentication/features/lost_password.feature

@@ -36,6 +36,8 @@ Feature: Lost Password
       When I go to the reset password page
       And I fill in "Password" with "cukes"
       And I fill in "Password confirmation" with "cukes"
+      Then show me the page
       And I press "Reset password"
+      Then show me the page
       Then I should be on the admin root
       And I should see "Password reset successfully for"

vendor/refinerycms/authentication/features/step_definitions/lost_password.rb

@@ -1,8 +1,8 @@
 Given /^I have a user with email "(.*)"$/ do |email|
-  Factory(:user, :email => email)
+  Factory(:refinery_user, :email => email)
 end
 
 Given /^I am (not )?requesting password reset$/ do |action|
-  @user = Factory(:user, :updated_at => 11.minutes.ago)
+  @user = Factory(:refinery_user, :updated_at => 11.minutes.ago)
   @user.reset_perishable_token! if action.nil?
 end

vendor/refinerycms/core/app/views/admin/_head.html.erb

@@ -17,7 +17,7 @@
   end
 -%>
 <head>
-  <meta charset='<%= Refinery::Application.config.encoding %>' />
+  <meta charset='<%= ::Refinery::Application.config.encoding %>' />
   <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
   <%= yield :meta %>
   <title><%= RefinerySetting.find_or_set(:site_name, 'Company Name') -%> - Refinery</title>

vendor/refinerycms/core/app/views/wymiframe.html.erb

@@ -2,7 +2,7 @@
 <html>
   <head>
     <title>WYMeditor</title>
-    <meta charset='<%= Refinery::Application.config.encoding %>' />
+    <meta charset='<%= ::Refinery::Application.config.encoding %>' />
     <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
     <%= stylesheet_link_tag "wymeditor/skins/refinery/wymiframe", :media => "all" %>
     <%= stylesheet_link_tag "refinery/formatting", :media => "all" if RefinerySetting.find_or_set(:frontend_refinery_stylesheets_enabled, true) %>

vendor/refinerycms/core/config/routes.rb

@@ -1,15 +1,19 @@
-Refinery::Application.routes.draw do
+::Refinery::Application.routes.draw do
+  filter(:refinery_locales) if defined?(RoutingFilter::RefineryLocales) # optionally use i18n.
+
+  root :to => 'pages#home'
 
   match 'wymiframe(/:id)', :to => 'refinery/fast#wymiframe', :as => :wymiframe
 
   # TODO: is this needed or it can be removed?
   scope(:path => 'refinery', :as => 'admin', :module => 'admin') do
     resources :refinery_core
+    root :to => 'dashboard#index'
+    resources :dialogs, :only => :show
   end
 
   match '/refinery/update_menu_positions', :to => 'admin/refinery_core#update_plugin_positions'
-
-  scope(:path => 'refinery', :as => 'admin', :module => 'admin') do
-    resources :dialogs, :only => :show
-  end
+  
+  # Marketable URLs should be appended to routes by the Pages Engine.
+  # Catch all routes should be appended to routes by the Core Engine.
 end

vendor/refinerycms/core/lib/core.rb

@@ -11,6 +11,8 @@
 require 'rails/generators/migration'
 
 module Refinery
+
+  autoload :Application, File.expand_path('../refinery/application', __FILE__)
   autoload :Plugin,  File.expand_path('../refinery/plugin', __FILE__)
   autoload :Plugins, File.expand_path('../refinery/plugins', __FILE__)
   autoload :Activity, File.expand_path('../refinery/activity', __FILE__)

vendor/refinerycms/core/lib/refinery/application.rb

@@ -0,0 +1,43 @@
+module Refinery
+  module Application
+    def self.included(base)
+      self.instance_eval %(
+        def self.method_missing(method_sym, *arguments, &block)
+          #{base}.send(method_sym)
+        end
+      )
+
+      # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+      base.config.i18n.load_path += Dir[Refinery.root.join('vendor', 'refinerycms', '*/config/locales/*.{rb,yml}').to_s]
+      # config.i18n.default_locale = :de
+
+      # JavaScript files you want as :defaults (application.js is always included).
+      base.config.action_view.javascript_expansions[:defaults] = %w()
+
+      # Configure the default encoding used in templates for Ruby 1.9.
+      base.config.encoding = "utf-8"
+
+      # Configure sensitive parameters which will be filtered from the log file.
+      base.config.filter_parameters += [:password, :password_confirmation]
+
+      # Specify a cache store to use
+      base.config.cache_store = :memory_store
+
+      # Extend the application controller
+      base.config.to_prepare do
+        ::ApplicationController.instance_eval do
+          include ::Refinery::ApplicationController
+        end if defined?(::ApplicationController)
+
+        ::ApplicationHelper.instance_eval do
+          include ::Refinery::ApplicationHelper
+        end if defined?(::ApplicationHelper)
+      end
+
+      # load in any settings that the developer wants after the initialization.
+      base.config.after_initialize do
+        require Rails.root.join('config', 'settings.rb')
+      end if Rails.root.join('config', 'settings.rb').exist?
+    end
+  end
+end

vendor/refinerycms/core/lib/refinery/catch_all_routes.rb

@@ -1,4 +1,4 @@
-Refinery::Application.routes.draw do
+::Refinery::Application.routes.draw do
   match '/admin(/*path)', :to => redirect {|params, request|
     request.flash[:message] = "<p>
       The URL '/<strong>admin</strong>#{"/#{params[:path]}" unless params[:path].blank?}' will be removed in Refinery CMS version 1.0

vendor/refinerycms/dashboard/config/routes.rb

@@ -1,4 +1,4 @@
-Refinery::Application.routes.draw do
+::Refinery::Application.routes.draw do
   scope(:path => 'refinery', :as => 'admin', :module => 'admin') do
     match 'dashboard',
           :to => 'dashboard#index',

vendor/refinerycms/images/config/routes.rb

@@ -1,4 +1,4 @@
-Refinery::Application.routes.draw do
+::Refinery::Application.routes.draw do
   scope(:path => 'refinery', :as => 'admin', :module => 'admin') do
     resources :images, :except => :show do
       collection do

vendor/refinerycms/pages/config/routes.rb

@@ -1,4 +1,4 @@
-Refinery::Application.routes.draw do
+::Refinery::Application.routes.draw do
   get '/pages/:id', :to => 'pages#show', :as => :page
 
   scope(:path => 'refinery', :as => 'admin', :module => 'admin') do

vendor/refinerycms/pages/lib/pages/marketable_routes.rb

@@ -1,3 +1,3 @@
-Refinery::Application.routes.draw do
+::Refinery::Application.routes.draw do
   match '*path' => 'pages#show'
 end

vendor/refinerycms/resources/config/routes.rb

@@ -1,4 +1,4 @@
-Refinery::Application.routes.draw do
+::Refinery::Application.routes.draw do
 
   scope(:path => 'refinery', :as => 'admin', :module => 'admin') do
     resources :resources, :except => :show do

vendor/refinerycms/settings/config/routes.rb

@@ -1,4 +1,4 @@
-Refinery::Application.routes.draw do
+::Refinery::Application.routes.draw do
   scope(:path => 'refinery', :as => 'admin', :module => 'admin') do
     resources :settings,
               :except => :show,