From 876d3f23d2370790623c6ef261d7c2366fb404d3 Mon Sep 17 00:00:00 2001 From: Ryan Bigg Date: Thu, 6 Oct 2011 08:47:06 +1100 Subject: [PATCH] [engines guide] More explanation for 'Generating an engine' --- railties/guides/source/engines.textile | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/railties/guides/source/engines.textile b/railties/guides/source/engines.textile index 83672fd66c..ddd2e50a6c 100644 --- a/railties/guides/source/engines.textile +++ b/railties/guides/source/engines.textile @@ -34,11 +34,29 @@ The +--mountable+ option tells the plugin generator that you want to create an e Inside the +app+ directory there lives the standard +assets+, +controllers+, +helpers+, +mailers+, +models+ and +views+ directories that you should be familiar with from an application. +At the root of the engine's directory, lives a +blorgh.gemspec+ file. When you include the engine into the application later on, you will do so with this line in a Rails application's +Gemfile+: + + + gem 'blorgh', :path => "vendor/engines/blorgh" + + +By specifying it as a gem within the +Gemfile+, Bundler will load it as such, parsing this +blorgh.gemspec+ file and requiring a file within the +lib+ directory called +lib/blorgh.rb+. This file requires the +blorgh/engine.rb+ file (located at +lib/blorgh/engine.rb+) and defines a base module called +Blorgh+. + + +require "blorgh/engine" + +module Blorgh +end + + +Within +lib/blorgh/engine.rb+ is the base class for the engine: + + + TODO: lib/blorgh/engine.rb + + Within the +app/controllers+ directory there is a +blorgh+ directory and inside that a file called +application_controller.rb+. This file will provide any common functionality for the controllers of the engine. The +blorgh+ directory is where the other controllers for the engine will go. By placing them within this namespaced directory, you prevent them from possibly clashing with identically-named controllers within other engines or even within the application. - -TODO: Describe here the process of generating an engine and what an engine comes with. - h3. Providing engine functionality TODO: Brief explanation of what this engine is going to be doing and what we will have once we are done.