Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Plugin guide: added model and controller sections
- Loading branch information
Showing
7 changed files
with
384 additions
and
144 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
59 changes: 59 additions & 0 deletions
59
railties/doc/guides/source/creating_plugins/controllers.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -0,0 +1,59 @@ | |||
== Add a controller == | |||
|
|||
This section describes how to add a controller named 'woodpeckers' to your plugin that will behave the same as a controller in your main app. This is very similar to adding a model. | |||
|
|||
You can test your plugin's controller as you would test any other controller: | |||
|
|||
*vendor/plugins/yaffle/yaffle/woodpeckers_controller_test.rb:* | |||
|
|||
[source, ruby] | |||
---------------------------------------------- | |||
require File.dirname(__FILE__) + '/test_helper.rb' | |||
require 'woodpeckers_controller' | |||
require 'action_controller/test_process' | |||
|
|||
class WoodpeckersController; def rescue_action(e) raise e end; end | |||
|
|||
class WoodpeckersControllerTest < Test::Unit::TestCase | |||
def setup | |||
@controller = WoodpeckersController.new | |||
@request = ActionController::TestRequest.new | |||
@response = ActionController::TestResponse.new | |||
end | |||
|
|||
def test_index | |||
get :index | |||
assert_response :success | |||
end | |||
end | |||
---------------------------------------------- | |||
|
|||
This is just a simple test to make sure the controller is being loaded correctly. After watching it fail with `rake`, you can make it pass like so: | |||
|
|||
*vendor/plugins/yaffle/lib/yaffle.rb:* | |||
|
|||
[source, ruby] | |||
---------------------------------------------- | |||
%w{ models controllers }.each do |dir| | |||
path = File.join(File.dirname(__FILE__), 'app', dir) | |||
$LOAD_PATH << path | |||
ActiveSupport::Dependencies.load_paths << path | |||
ActiveSupport::Dependencies.load_once_paths.delete(path) | |||
end | |||
---------------------------------------------- | |||
|
|||
|
|||
*vendor/plugins/yaffle/lib/app/controllers/woodpeckers_controller.rb:* | |||
|
|||
[source, ruby] | |||
---------------------------------------------- | |||
class WoodpeckersController < ActionController::Base | |||
|
|||
def index | |||
render :text => "Squawk!" | |||
end | |||
|
|||
end | |||
---------------------------------------------- | |||
|
|||
Now your test should be passing, and you should be able to use the Woodpeckers controller in your app. If you add a route for the woodpeckers controller you can start up your server and go to http://localhost:3000/woodpeckers to see your controller in action. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -0,0 +1,76 @@ | |||
== Add a model == | |||
|
|||
This section describes how to add a model named 'Woodpecker' to your plugin that will behave the same as a model in your main app. When storing models, controllers, views and helpers in your plugin, it's customary to keep them in directories that match the rails directories. For this example, create a file structure like this: | |||
|
|||
--------------------------------------------------------- | |||
vendor/plugins/yaffle/ | |||
|-- lib | |||
| |-- app | |||
| | |-- controllers | |||
| | |-- helpers | |||
| | |-- models | |||
| | | `-- woodpecker.rb | |||
| | `-- views | |||
| |-- yaffle | |||
| | |-- acts_as_yaffle.rb | |||
| | |-- commands.rb | |||
| | `-- core_ext.rb | |||
| `-- yaffle.rb | |||
--------------------------------------------------------- | |||
|
|||
As always, start with a test: | |||
|
|||
*vendor/plugins/yaffle/yaffle/woodpecker_test.rb:* | |||
|
|||
[source, ruby] | |||
---------------------------------------------- | |||
require File.dirname(__FILE__) + '/test_helper.rb' | |||
|
|||
class WoodpeckerTest < Test::Unit::TestCase | |||
load_schema | |||
|
|||
def test_woodpecker | |||
assert_kind_of Woodpecker, Woodpecker.new | |||
end | |||
end | |||
---------------------------------------------- | |||
|
|||
This is just a simple test to make sure the class is being loaded correctly. After watching it fail with `rake`, you can make it pass like so: | |||
|
|||
*vendor/plugins/yaffle/lib/yaffle.rb:* | |||
|
|||
[source, ruby] | |||
---------------------------------------------- | |||
%w{ models }.each do |dir| | |||
path = File.join(File.dirname(__FILE__), 'app', dir) | |||
$LOAD_PATH << path | |||
ActiveSupport::Dependencies.load_paths << path | |||
ActiveSupport::Dependencies.load_once_paths.delete(path) | |||
end | |||
---------------------------------------------- | |||
|
|||
Adding directories to the load path makes them appear just like files in the the main app directory - except that they are only loaded once, so you have to restart the web server to see the changes in the browser. Removing directories from the 'load_once_paths' allow those changes to picked up as soon as you save the file - without having to restart the web server. This is particularly useful as you develop the plugin. | |||
|
|||
|
|||
*vendor/plugins/yaffle/lib/app/models/woodpecker.rb:* | |||
|
|||
[source, ruby] | |||
---------------------------------------------- | |||
class Woodpecker < ActiveRecord::Base | |||
end | |||
---------------------------------------------- | |||
|
|||
Finally, add the following to your plugin's 'schema.rb': | |||
|
|||
*vendor/plugins/yaffle/test/schema.rb:* | |||
|
|||
[source, ruby] | |||
---------------------------------------------- | |||
ActiveRecord::Schema.define(:version => 0) do | |||
create_table :woodpeckers, :force => true do |t| | |||
t.string :name | |||
end | |||
end | |||
---------------------------------------------- | |||
|
|||
Now your test should be passing, and you should be able to use the Woodpecker model from within your rails app, and any changes made to it are reflected immediately when running in development mode. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters