Skip to content

Commit

Permalink
Plugin guide: added model and controller sections
Browse files Browse the repository at this point in the history
  • Loading branch information
zilkey committed Nov 14, 2008
1 parent 8a9bd56 commit 7eb2492
Show file tree
Hide file tree
Showing 7 changed files with 384 additions and 144 deletions.
355 changes: 238 additions & 117 deletions railties/doc/guides/html/creating_plugins.html

Large diffs are not rendered by default.

59 changes: 59 additions & 0 deletions railties/doc/guides/source/creating_plugins/controllers.txt
@@ -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.
8 changes: 6 additions & 2 deletions railties/doc/guides/source/creating_plugins/index.txt
Expand Up @@ -35,12 +35,16 @@ include::core_ext.txt[]


include::acts_as_yaffle.txt[] include::acts_as_yaffle.txt[]


include::view_helper.txt[]

include::migration_generator.txt[] include::migration_generator.txt[]


include::generator_method.txt[] include::generator_method.txt[]


include::models.txt[]

include::controllers.txt[]

include::view_helper.txt[]

include::custom_route.txt[] include::custom_route.txt[]


include::odds_and_ends.txt[] include::odds_and_ends.txt[]
Expand Down
@@ -1,4 +1,4 @@
== Create a migration generator == == Create a generator ==


Many plugins ship with generators. When you created the plugin above, you specified the --with-generator option, so you already have the generator stubs in 'vendor/plugins/yaffle/generators/yaffle'. Many plugins ship with generators. When you created the plugin above, you specified the --with-generator option, so you already have the generator stubs in 'vendor/plugins/yaffle/generators/yaffle'.


Expand Down Expand Up @@ -30,7 +30,7 @@ require 'rails_generator'
require 'rails_generator/scripts/generate' require 'rails_generator/scripts/generate'
require 'rails_generator/scripts/destroy' require 'rails_generator/scripts/destroy'


class YaffleTest < Test::Unit::TestCase class GeneratorTest < Test::Unit::TestCase


def fake_rails_root def fake_rails_root
File.join(File.dirname(__FILE__), 'rails_root') File.join(File.dirname(__FILE__), 'rails_root')
Expand Down Expand Up @@ -124,7 +124,6 @@ end
------------------------------------------------------------------ ------------------------------------------------------------------





=== The USAGE file === === The USAGE file ===


Rails ships with several built-in generators. You can see all of the generators available to you by typing the following at the command line: Rails ships with several built-in generators. You can see all of the generators available to you by typing the following at the command line:
Expand Down
76 changes: 76 additions & 0 deletions railties/doc/guides/source/creating_plugins/models.txt
@@ -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.
22 changes: 0 additions & 22 deletions railties/doc/guides/source/creating_plugins/odds_and_ends.txt
Expand Up @@ -19,28 +19,6 @@ Once your comments are good to go, navigate to your plugin directory and run:


rake rdoc rake rdoc



=== Store models, views, helpers, and controllers in your plugins ===

You can easily store models, views, helpers and controllers in plugins. Just create a folder for each in the lib folder, add them to the load path and remove them from the load once path:

[source, ruby]
---------------------------------------------------------
# File: vendor/plugins/yaffle/init.rb

%w{ models controllers helpers }.each do |dir|
path = File.join(directory, 'lib', dir)
$LOAD_PATH << path
Dependencies.load_paths << path
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.

Adding directories to the load once paths allow those changes to picked up as soon as you save the file - without having to restart the web server.


=== Write custom Rake tasks in your plugin === === Write custom Rake tasks in your plugin ===


When you created the plugin with the built-in rails generator, it generated a rake file for you in 'vendor/plugins/yaffle/tasks/yaffle.rake'. Any rake task you add here will be available to the app. When you created the plugin with the built-in rails generator, it generated a rake file for you in 'vendor/plugins/yaffle/tasks/yaffle.rake'. Any rake task you add here will be available to the app.
Expand Down
3 changes: 3 additions & 0 deletions railties/doc/guides/source/creating_plugins/test_setup.txt
Expand Up @@ -115,6 +115,9 @@ ActiveRecord::Schema.define(:version => 0) do
t.string :last_tweet t.string :last_tweet
t.datetime :last_tweeted_at t.datetime :last_tweeted_at
end end
create_table :woodpeckers, :force => true do |t|
t.string :name
end
end end
---------------------------------------------- ----------------------------------------------


Expand Down

0 comments on commit 7eb2492

Please sign in to comment.