heritage 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +3 -0
- data/Gemfile +4 -0
- data/README.textile +246 -0
- data/Rakefile +2 -0
- data/heritage.gemspec +19 -0
- data/heritage_demo/.gitignore +4 -0
- data/heritage_demo/Gemfile +32 -0
- data/heritage_demo/Gemfile.lock +79 -0
- data/heritage_demo/README +256 -0
- data/heritage_demo/Rakefile +7 -0
- data/heritage_demo/app/controllers/application_controller.rb +3 -0
- data/heritage_demo/app/controllers/blog_posts_controller.rb +45 -0
- data/heritage_demo/app/controllers/image_posts_controller.rb +45 -0
- data/heritage_demo/app/controllers/posts_controller.rb +19 -0
- data/heritage_demo/app/helpers/application_helper.rb +2 -0
- data/heritage_demo/app/helpers/blog_posts_helper.rb +2 -0
- data/heritage_demo/app/helpers/image_posts_helper.rb +2 -0
- data/heritage_demo/app/helpers/posts_helper.rb +2 -0
- data/heritage_demo/app/models/blog_post.rb +9 -0
- data/heritage_demo/app/models/image_post.rb +5 -0
- data/heritage_demo/app/models/post.rb +9 -0
- data/heritage_demo/app/views/blog_posts/_form.html.erb +13 -0
- data/heritage_demo/app/views/blog_posts/edit.html.erb +2 -0
- data/heritage_demo/app/views/blog_posts/index.html.erb +11 -0
- data/heritage_demo/app/views/blog_posts/new.html.erb +2 -0
- data/heritage_demo/app/views/blog_posts/show.html.erb +12 -0
- data/heritage_demo/app/views/image_posts/_form.html.erb +13 -0
- data/heritage_demo/app/views/image_posts/edit.html.erb +2 -0
- data/heritage_demo/app/views/image_posts/index.html.erb +11 -0
- data/heritage_demo/app/views/image_posts/new.html.erb +2 -0
- data/heritage_demo/app/views/image_posts/show.html.erb +12 -0
- data/heritage_demo/app/views/layouts/application.html.erb +14 -0
- data/heritage_demo/app/views/posts/index.html.erb +9 -0
- data/heritage_demo/config.ru +4 -0
- data/heritage_demo/config/application.rb +42 -0
- data/heritage_demo/config/boot.rb +6 -0
- data/heritage_demo/config/database.yml +22 -0
- data/heritage_demo/config/environment.rb +5 -0
- data/heritage_demo/config/environments/development.rb +26 -0
- data/heritage_demo/config/environments/production.rb +49 -0
- data/heritage_demo/config/environments/test.rb +35 -0
- data/heritage_demo/config/initializers/backtrace_silencers.rb +7 -0
- data/heritage_demo/config/initializers/inflections.rb +10 -0
- data/heritage_demo/config/initializers/mime_types.rb +5 -0
- data/heritage_demo/config/initializers/secret_token.rb +7 -0
- data/heritage_demo/config/initializers/session_store.rb +8 -0
- data/heritage_demo/config/locales/en.yml +5 -0
- data/heritage_demo/config/routes.rb +62 -0
- data/heritage_demo/db/migrate/20110411095519_create_posts.rb +15 -0
- data/heritage_demo/db/migrate/20110411095612_create_blog_posts.rb +11 -0
- data/heritage_demo/db/migrate/20110411095655_create_image_posts.rb +11 -0
- data/heritage_demo/db/schema.rb +45 -0
- data/heritage_demo/db/seeds.rb +7 -0
- data/heritage_demo/doc/README_FOR_APP +2 -0
- data/heritage_demo/lib/tasks/.gitkeep +0 -0
- data/heritage_demo/public/404.html +26 -0
- data/heritage_demo/public/422.html +26 -0
- data/heritage_demo/public/500.html +26 -0
- data/heritage_demo/public/favicon.ico +0 -0
- data/heritage_demo/public/images/rails.png +0 -0
- data/heritage_demo/public/index.html +239 -0
- data/heritage_demo/public/javascripts/application.js +2 -0
- data/heritage_demo/public/javascripts/controls.js +965 -0
- data/heritage_demo/public/javascripts/dragdrop.js +974 -0
- data/heritage_demo/public/javascripts/effects.js +1123 -0
- data/heritage_demo/public/javascripts/prototype.js +6001 -0
- data/heritage_demo/public/javascripts/rails.js +191 -0
- data/heritage_demo/public/robots.txt +5 -0
- data/heritage_demo/public/stylesheets/.gitkeep +0 -0
- data/heritage_demo/script/rails +6 -0
- data/heritage_demo/test/fixtures/blog_posts.yml +9 -0
- data/heritage_demo/test/fixtures/image_posts.yml +9 -0
- data/heritage_demo/test/fixtures/posts.yml +11 -0
- data/heritage_demo/test/functional/blog_posts_controller_test.rb +8 -0
- data/heritage_demo/test/functional/image_posts_controller_test.rb +8 -0
- data/heritage_demo/test/functional/posts_controller_test.rb +8 -0
- data/heritage_demo/test/performance/browsing_test.rb +9 -0
- data/heritage_demo/test/test_helper.rb +13 -0
- data/heritage_demo/test/unit/blog_post_test.rb +8 -0
- data/heritage_demo/test/unit/helpers/blog_posts_helper_test.rb +4 -0
- data/heritage_demo/test/unit/helpers/image_posts_helper_test.rb +4 -0
- data/heritage_demo/test/unit/helpers/posts_helper_test.rb +4 -0
- data/heritage_demo/test/unit/image_post_test.rb +8 -0
- data/heritage_demo/test/unit/post_test.rb +8 -0
- data/heritage_demo/vendor/plugins/.gitkeep +0 -0
- data/lib/heritage.rb +5 -0
- data/lib/heritage/active_record/acts_as_heir.rb +57 -0
- data/lib/heritage/active_record/acts_as_predecessor.rb +31 -0
- data/lib/heritage/railtie.rb +20 -0
- data/lib/heritage/version.rb +3 -0
- metadata +157 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/README.textile
ADDED
@@ -0,0 +1,246 @@
|
|
1
|
+
h1. Heritage
|
2
|
+
|
3
|
+
Heritage is a gem that implements Multiple Table Inheritance for ActiveRecord models.
|
4
|
+
|
5
|
+
h2. Compatability
|
6
|
+
|
7
|
+
Heritage has only been tested with Rails 3
|
8
|
+
|
9
|
+
h2. Installation
|
10
|
+
|
11
|
+
Simply add Heritage to your Gemfile and bundle it up:
|
12
|
+
|
13
|
+
<pre>
|
14
|
+
gem 'heritage'
|
15
|
+
</pre>
|
16
|
+
|
17
|
+
h2. Usage
|
18
|
+
|
19
|
+
Heritage works by assigning one model as your @predecessor@, and one or more other models as it's @heir@.
|
20
|
+
The predecessor is the parent of it's heirs, and thereby implicitly gives it's heirs access to it's columns, and optionally exposing methods to them.
|
21
|
+
|
22
|
+
To mark a model as predecessor, simply use the @acts_as_predecessor@ class-method:
|
23
|
+
|
24
|
+
<pre>
|
25
|
+
class Post < ActiveRecord::Base
|
26
|
+
acts_as_predecessor
|
27
|
+
end
|
28
|
+
</pre>
|
29
|
+
|
30
|
+
To mark a model as heir, simply use the @acts_as_heir_of@ class-method, passing a symbol to the model that is to be the heirs predecessor.
|
31
|
+
|
32
|
+
<pre>
|
33
|
+
class BlogPost < ActiveRecord::Base
|
34
|
+
acts_as_heir_of :post
|
35
|
+
end
|
36
|
+
</pre>
|
37
|
+
|
38
|
+
This takes care of the model configuration. We however need to add two extra columns to the Posts table.
|
39
|
+
We need a @heir_id@ column of type @integer@ and a @heir_type@ column of type @string@.
|
40
|
+
|
41
|
+
<pre>
|
42
|
+
class CreatePosts < ActiveRecord::Migration
|
43
|
+
def self.up
|
44
|
+
create_table :posts do |t|
|
45
|
+
t.integer :heir_id
|
46
|
+
t.string :heir_type
|
47
|
+
t.string :title
|
48
|
+
t.timestamps
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
def self.down
|
53
|
+
drop_table :posts
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
class CreateBlogPosts < ActiveRecord::Migration
|
58
|
+
def self.up
|
59
|
+
create_table :blog_posts do |t|
|
60
|
+
t.text :body
|
61
|
+
end
|
62
|
+
end
|
63
|
+
|
64
|
+
def self.down
|
65
|
+
drop_table :blog_posts
|
66
|
+
end
|
67
|
+
end
|
68
|
+
<end>
|
69
|
+
|
70
|
+
When this is done and the database is migrated, we can begin using the models.
|
71
|
+
|
72
|
+
h2. Creating new instances
|
73
|
+
|
74
|
+
Now we can simply call the following to create a new @BlogPost@
|
75
|
+
|
76
|
+
<pre>
|
77
|
+
blog_post = BlogPost.create(:title => "Wow", :body => "That's a nice blog post!")
|
78
|
+
</pre>
|
79
|
+
|
80
|
+
Notice that the @title@ attribute belongs to the @Post@ model, and the @body@ attribute belongs to the @BlogPost@ model.
|
81
|
+
|
82
|
+
h2. Attributes
|
83
|
+
|
84
|
+
We can directly access the @title@ attribute through @BlogPost@ and even change it's value
|
85
|
+
|
86
|
+
<pre>
|
87
|
+
blog_post.title # "Wow"
|
88
|
+
blog_post.title = "Oh boy!"
|
89
|
+
blog_post.save!
|
90
|
+
blog_post.title # "Oh boy!"
|
91
|
+
</pre>
|
92
|
+
|
93
|
+
We can also update attributes like normal through @update_attributes@
|
94
|
+
|
95
|
+
<pre>
|
96
|
+
blog_post.update_attributes(:title => "Hubba Hubba", :body => "Nice blog post!")
|
97
|
+
blog_post.title # "Hubba Hubba"
|
98
|
+
blog_post.body # "Nice blog post!"
|
99
|
+
</pre>
|
100
|
+
|
101
|
+
h2. Methods
|
102
|
+
|
103
|
+
If we want to expose some methods from our predecessor model to it's heirs, we can do so when calling the @acts_as_predecessor@ class-method
|
104
|
+
|
105
|
+
<pre>
|
106
|
+
class Post < ActiveRecord::Base
|
107
|
+
|
108
|
+
acts_as_predecessor :exposes => :hello
|
109
|
+
|
110
|
+
def hello
|
111
|
+
"Hi there!"
|
112
|
+
end
|
113
|
+
|
114
|
+
end
|
115
|
+
</pre>
|
116
|
+
|
117
|
+
Now all heirs of @Post@ will have a hello-method, which we can call directly on the heir-model:
|
118
|
+
|
119
|
+
<pre>
|
120
|
+
blog_post = BlogPost.create(:title => "I am full", :body => "of methods...")
|
121
|
+
blog_post.hello # "Hi there!"
|
122
|
+
</pre>
|
123
|
+
|
124
|
+
If you for some reason need to override the method in one of your heir-models, you can simply implement the method, and it will override the method from the predecessor.
|
125
|
+
|
126
|
+
<pre>
|
127
|
+
class BlogPost < ActiveRecord::Base
|
128
|
+
|
129
|
+
acts_as_heir_of :post
|
130
|
+
|
131
|
+
def hello
|
132
|
+
"Yo!"
|
133
|
+
end
|
134
|
+
|
135
|
+
end
|
136
|
+
</pre>
|
137
|
+
|
138
|
+
Calling the @hello@ method on BlogPost will now yield another result:
|
139
|
+
|
140
|
+
<pre>
|
141
|
+
blog_post = BlogPost.create(:title => "I have", :body => "my own methods...")
|
142
|
+
blog_post.hello # "Yo!"
|
143
|
+
</pre>
|
144
|
+
|
145
|
+
If we need to combine the local method in the heir, with the method in the predecessor, we can do so through the @predecessor@ method of the heir model, kinda like you would use @super@.
|
146
|
+
|
147
|
+
<pre>
|
148
|
+
class BlogPost < ActiveRecord::Base
|
149
|
+
|
150
|
+
acts_as_heir_of :post
|
151
|
+
|
152
|
+
def hello
|
153
|
+
"Yo! #{predecessor.hello}"
|
154
|
+
end
|
155
|
+
|
156
|
+
end
|
157
|
+
</pre>
|
158
|
+
|
159
|
+
The result would now be a combination of the local method in the heir, and the method in the predecessor:
|
160
|
+
|
161
|
+
<pre>
|
162
|
+
blog_post = BlogPost.create(:title => "I have", :body => "my own methods...")
|
163
|
+
blog_post.hello # "Yo! Hi there!"
|
164
|
+
</pre>
|
165
|
+
|
166
|
+
h2. Listing and filtering
|
167
|
+
|
168
|
+
To list all your wonderful heir models you do as you normally would in ActiveRecord, with one single exception.
|
169
|
+
|
170
|
+
Normally you would call something like this, to show all @BlogPosts@
|
171
|
+
|
172
|
+
<pre>
|
173
|
+
@posts = BlogPost.all
|
174
|
+
</pre>
|
175
|
+
|
176
|
+
This however will result in 1 + the number of returned records SQL calls, which is hardly good.
|
177
|
+
Instead you need to tell ActiveRecord that it should include the predecessors of the heirs, like so:
|
178
|
+
|
179
|
+
<pre>
|
180
|
+
@posts = BlogPost.all(:include => :predecessor)
|
181
|
+
</pre>
|
182
|
+
|
183
|
+
We now only call the database twice; Once for loading the heirs, and once for loading all referenced predecessors.
|
184
|
+
|
185
|
+
Another gotcha is when you need to filter the heirs. You can't directly filter by attributes from the predecessor model.
|
186
|
+
So in our example where we have the @title@ attribute in the @Post@ model, we can't do the following:
|
187
|
+
|
188
|
+
<pre>
|
189
|
+
@posts = BLogPost.where("title = 'test'")
|
190
|
+
</pre>
|
191
|
+
|
192
|
+
Instead we need to reference predecessor attributes by the predecessors database-table, like so:
|
193
|
+
|
194
|
+
<pre>
|
195
|
+
@posts = BlogPost.where("posts.title = 'test'")
|
196
|
+
</pre>
|
197
|
+
|
198
|
+
Behind the scenes, heritage works just like a simple ActiveRecord association, so it makes sense.
|
199
|
+
|
200
|
+
h2. Timestamps
|
201
|
+
|
202
|
+
If all of your heir-models needs timestamps, then you can simply add timestamps to the predecessor model, and omit them from the heir-models.
|
203
|
+
Heritage will make sure, that whenever you update your heir-model, the @updated_at@ timestamp in the predecessor model will be updated.
|
204
|
+
|
205
|
+
h2. A note on destruction
|
206
|
+
|
207
|
+
Heritage depends on the destroy-method of the models, and as such you should always delete predecessor and heir models by calling the @destroy@ method on either, and NEVER by calling the @delete@ or @delete_all@ methods.
|
208
|
+
If you absolutely need to do a direct delete in the database, then you need to manually remove the counterpart as well.
|
209
|
+
|
210
|
+
For instance, if you manually delete a @BlogPost@ that is heir of @Post@, then you need to first find the right @Post@, then delete the heir and finally delete the predecessor.
|
211
|
+
|
212
|
+
h2. Questions, Feedback
|
213
|
+
|
214
|
+
Feel free to message me on Github (murui)
|
215
|
+
|
216
|
+
h2. Contributing to Heritage
|
217
|
+
|
218
|
+
Fork, fix, then send me a pull request.
|
219
|
+
|
220
|
+
h2. Credits
|
221
|
+
|
222
|
+
Credits goes out to Gerry from TechSpry.com for the idea for this implementation:
|
223
|
+
http://techspry.com/ruby_and_rails/multiple-table-inheritance-in-rails-3/
|
224
|
+
|
225
|
+
h2. Copyright
|
226
|
+
|
227
|
+
Copyright (c) 2011 Benjamin Media A/S
|
228
|
+
|
229
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
230
|
+
a copy of this software and associated documentation files (the
|
231
|
+
"Software"), to deal in the Software without restriction, including
|
232
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
233
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
234
|
+
permit persons to whom the Software is furnished to do so, subject to
|
235
|
+
the following conditions:
|
236
|
+
|
237
|
+
The above copyright notice and this permission notice shall be
|
238
|
+
included in all copies or substantial portions of the Software.
|
239
|
+
|
240
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
241
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
242
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
243
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
244
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
245
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
246
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/Rakefile
ADDED
data/heritage.gemspec
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
$:.push File.expand_path("../lib", __FILE__)
|
3
|
+
require "heritage/version"
|
4
|
+
|
5
|
+
Gem::Specification.new do |s|
|
6
|
+
s.name = "heritage"
|
7
|
+
s.version = Heritage::VERSION
|
8
|
+
s.platform = Gem::Platform::RUBY
|
9
|
+
s.authors = ["Thomas Dippel"]
|
10
|
+
s.email = ["thomasdi@benjamin.dk"]
|
11
|
+
s.homepage = "http://rubygems.org/gems/heritage"
|
12
|
+
s.summary = %q{A gem for implementing multiple table inheritance in rails 3}
|
13
|
+
s.description = %q{A gem for implementing multiple table inheritance in rails 3}
|
14
|
+
|
15
|
+
s.files = `git ls-files`.split("\n")
|
16
|
+
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
|
17
|
+
s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
|
18
|
+
s.require_paths = ["lib"]
|
19
|
+
end
|
@@ -0,0 +1,32 @@
|
|
1
|
+
source 'http://rubygems.org'
|
2
|
+
|
3
|
+
gem 'rails', '3.0.6'
|
4
|
+
|
5
|
+
# Bundle edge Rails instead:
|
6
|
+
# gem 'rails', :git => 'git://github.com/rails/rails.git'
|
7
|
+
|
8
|
+
gem 'sqlite3'
|
9
|
+
gem "heritage", :path => "~/Projects/benjamin/heritage"
|
10
|
+
|
11
|
+
# Use unicorn as the web server
|
12
|
+
# gem 'unicorn'
|
13
|
+
|
14
|
+
# Deploy with Capistrano
|
15
|
+
# gem 'capistrano'
|
16
|
+
|
17
|
+
# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
|
18
|
+
# gem 'ruby-debug'
|
19
|
+
# gem 'ruby-debug19', :require => 'ruby-debug'
|
20
|
+
|
21
|
+
# Bundle the extra gems:
|
22
|
+
# gem 'bj'
|
23
|
+
# gem 'nokogiri'
|
24
|
+
# gem 'sqlite3-ruby', :require => 'sqlite3'
|
25
|
+
# gem 'aws-s3', :require => 'aws/s3'
|
26
|
+
|
27
|
+
# Bundle gems for the local environment. Make sure to
|
28
|
+
# put test-only gems in this group so their generators
|
29
|
+
# and rake tasks are available in development mode:
|
30
|
+
# group :development, :test do
|
31
|
+
# gem 'webrat'
|
32
|
+
# end
|
@@ -0,0 +1,79 @@
|
|
1
|
+
PATH
|
2
|
+
remote: ~/Projects/benjamin/heritage
|
3
|
+
specs:
|
4
|
+
heritage (0.0.1)
|
5
|
+
|
6
|
+
GEM
|
7
|
+
remote: http://rubygems.org/
|
8
|
+
specs:
|
9
|
+
abstract (1.0.0)
|
10
|
+
actionmailer (3.0.6)
|
11
|
+
actionpack (= 3.0.6)
|
12
|
+
mail (~> 2.2.15)
|
13
|
+
actionpack (3.0.6)
|
14
|
+
activemodel (= 3.0.6)
|
15
|
+
activesupport (= 3.0.6)
|
16
|
+
builder (~> 2.1.2)
|
17
|
+
erubis (~> 2.6.6)
|
18
|
+
i18n (~> 0.5.0)
|
19
|
+
rack (~> 1.2.1)
|
20
|
+
rack-mount (~> 0.6.14)
|
21
|
+
rack-test (~> 0.5.7)
|
22
|
+
tzinfo (~> 0.3.23)
|
23
|
+
activemodel (3.0.6)
|
24
|
+
activesupport (= 3.0.6)
|
25
|
+
builder (~> 2.1.2)
|
26
|
+
i18n (~> 0.5.0)
|
27
|
+
activerecord (3.0.6)
|
28
|
+
activemodel (= 3.0.6)
|
29
|
+
activesupport (= 3.0.6)
|
30
|
+
arel (~> 2.0.2)
|
31
|
+
tzinfo (~> 0.3.23)
|
32
|
+
activeresource (3.0.6)
|
33
|
+
activemodel (= 3.0.6)
|
34
|
+
activesupport (= 3.0.6)
|
35
|
+
activesupport (3.0.6)
|
36
|
+
arel (2.0.9)
|
37
|
+
builder (2.1.2)
|
38
|
+
erubis (2.6.6)
|
39
|
+
abstract (>= 1.0.0)
|
40
|
+
i18n (0.5.0)
|
41
|
+
mail (2.2.15)
|
42
|
+
activesupport (>= 2.3.6)
|
43
|
+
i18n (>= 0.4.0)
|
44
|
+
mime-types (~> 1.16)
|
45
|
+
treetop (~> 1.4.8)
|
46
|
+
mime-types (1.16)
|
47
|
+
polyglot (0.3.1)
|
48
|
+
rack (1.2.2)
|
49
|
+
rack-mount (0.6.14)
|
50
|
+
rack (>= 1.0.0)
|
51
|
+
rack-test (0.5.7)
|
52
|
+
rack (>= 1.0)
|
53
|
+
rails (3.0.6)
|
54
|
+
actionmailer (= 3.0.6)
|
55
|
+
actionpack (= 3.0.6)
|
56
|
+
activerecord (= 3.0.6)
|
57
|
+
activeresource (= 3.0.6)
|
58
|
+
activesupport (= 3.0.6)
|
59
|
+
bundler (~> 1.0)
|
60
|
+
railties (= 3.0.6)
|
61
|
+
railties (3.0.6)
|
62
|
+
actionpack (= 3.0.6)
|
63
|
+
activesupport (= 3.0.6)
|
64
|
+
rake (>= 0.8.7)
|
65
|
+
thor (~> 0.14.4)
|
66
|
+
rake (0.8.7)
|
67
|
+
sqlite3 (1.3.3)
|
68
|
+
thor (0.14.6)
|
69
|
+
treetop (1.4.9)
|
70
|
+
polyglot (>= 0.3.1)
|
71
|
+
tzinfo (0.3.26)
|
72
|
+
|
73
|
+
PLATFORMS
|
74
|
+
ruby
|
75
|
+
|
76
|
+
DEPENDENCIES
|
77
|
+
heritage!
|
78
|
+
rails (= 3.0.6)
|
79
|
+
sqlite3
|
@@ -0,0 +1,256 @@
|
|
1
|
+
== Welcome to Rails
|
2
|
+
|
3
|
+
Rails is a web-application framework that includes everything needed to create
|
4
|
+
database-backed web applications according to the Model-View-Control pattern.
|
5
|
+
|
6
|
+
This pattern splits the view (also called the presentation) into "dumb"
|
7
|
+
templates that are primarily responsible for inserting pre-built data in between
|
8
|
+
HTML tags. The model contains the "smart" domain objects (such as Account,
|
9
|
+
Product, Person, Post) that holds all the business logic and knows how to
|
10
|
+
persist themselves to a database. The controller handles the incoming requests
|
11
|
+
(such as Save New Account, Update Product, Show Post) by manipulating the model
|
12
|
+
and directing data to the view.
|
13
|
+
|
14
|
+
In Rails, the model is handled by what's called an object-relational mapping
|
15
|
+
layer entitled Active Record. This layer allows you to present the data from
|
16
|
+
database rows as objects and embellish these data objects with business logic
|
17
|
+
methods. You can read more about Active Record in
|
18
|
+
link:files/vendor/rails/activerecord/README.html.
|
19
|
+
|
20
|
+
The controller and view are handled by the Action Pack, which handles both
|
21
|
+
layers by its two parts: Action View and Action Controller. These two layers
|
22
|
+
are bundled in a single package due to their heavy interdependence. This is
|
23
|
+
unlike the relationship between the Active Record and Action Pack that is much
|
24
|
+
more separate. Each of these packages can be used independently outside of
|
25
|
+
Rails. You can read more about Action Pack in
|
26
|
+
link:files/vendor/rails/actionpack/README.html.
|
27
|
+
|
28
|
+
|
29
|
+
== Getting Started
|
30
|
+
|
31
|
+
1. At the command prompt, create a new Rails application:
|
32
|
+
<tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
|
33
|
+
|
34
|
+
2. Change directory to <tt>myapp</tt> and start the web server:
|
35
|
+
<tt>cd myapp; rails server</tt> (run with --help for options)
|
36
|
+
|
37
|
+
3. Go to http://localhost:3000/ and you'll see:
|
38
|
+
"Welcome aboard: You're riding Ruby on Rails!"
|
39
|
+
|
40
|
+
4. Follow the guidelines to start developing your application. You can find
|
41
|
+
the following resources handy:
|
42
|
+
|
43
|
+
* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
|
44
|
+
* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
|
45
|
+
|
46
|
+
|
47
|
+
== Debugging Rails
|
48
|
+
|
49
|
+
Sometimes your application goes wrong. Fortunately there are a lot of tools that
|
50
|
+
will help you debug it and get it back on the rails.
|
51
|
+
|
52
|
+
First area to check is the application log files. Have "tail -f" commands
|
53
|
+
running on the server.log and development.log. Rails will automatically display
|
54
|
+
debugging and runtime information to these files. Debugging info will also be
|
55
|
+
shown in the browser on requests from 127.0.0.1.
|
56
|
+
|
57
|
+
You can also log your own messages directly into the log file from your code
|
58
|
+
using the Ruby logger class from inside your controllers. Example:
|
59
|
+
|
60
|
+
class WeblogController < ActionController::Base
|
61
|
+
def destroy
|
62
|
+
@weblog = Weblog.find(params[:id])
|
63
|
+
@weblog.destroy
|
64
|
+
logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
The result will be a message in your log file along the lines of:
|
69
|
+
|
70
|
+
Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
|
71
|
+
|
72
|
+
More information on how to use the logger is at http://www.ruby-doc.org/core/
|
73
|
+
|
74
|
+
Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
|
75
|
+
several books available online as well:
|
76
|
+
|
77
|
+
* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
|
78
|
+
* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
|
79
|
+
|
80
|
+
These two books will bring you up to speed on the Ruby language and also on
|
81
|
+
programming in general.
|
82
|
+
|
83
|
+
|
84
|
+
== Debugger
|
85
|
+
|
86
|
+
Debugger support is available through the debugger command when you start your
|
87
|
+
Mongrel or WEBrick server with --debugger. This means that you can break out of
|
88
|
+
execution at any point in the code, investigate and change the model, and then,
|
89
|
+
resume execution! You need to install ruby-debug to run the server in debugging
|
90
|
+
mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
|
91
|
+
|
92
|
+
class WeblogController < ActionController::Base
|
93
|
+
def index
|
94
|
+
@posts = Post.find(:all)
|
95
|
+
debugger
|
96
|
+
end
|
97
|
+
end
|
98
|
+
|
99
|
+
So the controller will accept the action, run the first line, then present you
|
100
|
+
with a IRB prompt in the server window. Here you can do things like:
|
101
|
+
|
102
|
+
>> @posts.inspect
|
103
|
+
=> "[#<Post:0x14a6be8
|
104
|
+
@attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
|
105
|
+
#<Post:0x14a6620
|
106
|
+
@attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
|
107
|
+
>> @posts.first.title = "hello from a debugger"
|
108
|
+
=> "hello from a debugger"
|
109
|
+
|
110
|
+
...and even better, you can examine how your runtime objects actually work:
|
111
|
+
|
112
|
+
>> f = @posts.first
|
113
|
+
=> #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
|
114
|
+
>> f.
|
115
|
+
Display all 152 possibilities? (y or n)
|
116
|
+
|
117
|
+
Finally, when you're ready to resume execution, you can enter "cont".
|
118
|
+
|
119
|
+
|
120
|
+
== Console
|
121
|
+
|
122
|
+
The console is a Ruby shell, which allows you to interact with your
|
123
|
+
application's domain model. Here you'll have all parts of the application
|
124
|
+
configured, just like it is when the application is running. You can inspect
|
125
|
+
domain models, change values, and save to the database. Starting the script
|
126
|
+
without arguments will launch it in the development environment.
|
127
|
+
|
128
|
+
To start the console, run <tt>rails console</tt> from the application
|
129
|
+
directory.
|
130
|
+
|
131
|
+
Options:
|
132
|
+
|
133
|
+
* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
|
134
|
+
made to the database.
|
135
|
+
* Passing an environment name as an argument will load the corresponding
|
136
|
+
environment. Example: <tt>rails console production</tt>.
|
137
|
+
|
138
|
+
To reload your controllers and models after launching the console run
|
139
|
+
<tt>reload!</tt>
|
140
|
+
|
141
|
+
More information about irb can be found at:
|
142
|
+
link:http://www.rubycentral.com/pickaxe/irb.html
|
143
|
+
|
144
|
+
|
145
|
+
== dbconsole
|
146
|
+
|
147
|
+
You can go to the command line of your database directly through <tt>rails
|
148
|
+
dbconsole</tt>. You would be connected to the database with the credentials
|
149
|
+
defined in database.yml. Starting the script without arguments will connect you
|
150
|
+
to the development database. Passing an argument will connect you to a different
|
151
|
+
database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
|
152
|
+
PostgreSQL and SQLite 3.
|
153
|
+
|
154
|
+
== Description of Contents
|
155
|
+
|
156
|
+
The default directory structure of a generated Ruby on Rails application:
|
157
|
+
|
158
|
+
|-- app
|
159
|
+
| |-- controllers
|
160
|
+
| |-- helpers
|
161
|
+
| |-- mailers
|
162
|
+
| |-- models
|
163
|
+
| `-- views
|
164
|
+
| `-- layouts
|
165
|
+
|-- config
|
166
|
+
| |-- environments
|
167
|
+
| |-- initializers
|
168
|
+
| `-- locales
|
169
|
+
|-- db
|
170
|
+
|-- doc
|
171
|
+
|-- lib
|
172
|
+
| `-- tasks
|
173
|
+
|-- log
|
174
|
+
|-- public
|
175
|
+
| |-- images
|
176
|
+
| |-- javascripts
|
177
|
+
| `-- stylesheets
|
178
|
+
|-- script
|
179
|
+
|-- test
|
180
|
+
| |-- fixtures
|
181
|
+
| |-- functional
|
182
|
+
| |-- integration
|
183
|
+
| |-- performance
|
184
|
+
| `-- unit
|
185
|
+
|-- tmp
|
186
|
+
| |-- cache
|
187
|
+
| |-- pids
|
188
|
+
| |-- sessions
|
189
|
+
| `-- sockets
|
190
|
+
`-- vendor
|
191
|
+
`-- plugins
|
192
|
+
|
193
|
+
app
|
194
|
+
Holds all the code that's specific to this particular application.
|
195
|
+
|
196
|
+
app/controllers
|
197
|
+
Holds controllers that should be named like weblogs_controller.rb for
|
198
|
+
automated URL mapping. All controllers should descend from
|
199
|
+
ApplicationController which itself descends from ActionController::Base.
|
200
|
+
|
201
|
+
app/models
|
202
|
+
Holds models that should be named like post.rb. Models descend from
|
203
|
+
ActiveRecord::Base by default.
|
204
|
+
|
205
|
+
app/views
|
206
|
+
Holds the template files for the view that should be named like
|
207
|
+
weblogs/index.html.erb for the WeblogsController#index action. All views use
|
208
|
+
eRuby syntax by default.
|
209
|
+
|
210
|
+
app/views/layouts
|
211
|
+
Holds the template files for layouts to be used with views. This models the
|
212
|
+
common header/footer method of wrapping views. In your views, define a layout
|
213
|
+
using the <tt>layout :default</tt> and create a file named default.html.erb.
|
214
|
+
Inside default.html.erb, call <% yield %> to render the view using this
|
215
|
+
layout.
|
216
|
+
|
217
|
+
app/helpers
|
218
|
+
Holds view helpers that should be named like weblogs_helper.rb. These are
|
219
|
+
generated for you automatically when using generators for controllers.
|
220
|
+
Helpers can be used to wrap functionality for your views into methods.
|
221
|
+
|
222
|
+
config
|
223
|
+
Configuration files for the Rails environment, the routing map, the database,
|
224
|
+
and other dependencies.
|
225
|
+
|
226
|
+
db
|
227
|
+
Contains the database schema in schema.rb. db/migrate contains all the
|
228
|
+
sequence of Migrations for your schema.
|
229
|
+
|
230
|
+
doc
|
231
|
+
This directory is where your application documentation will be stored when
|
232
|
+
generated using <tt>rake doc:app</tt>
|
233
|
+
|
234
|
+
lib
|
235
|
+
Application specific libraries. Basically, any kind of custom code that
|
236
|
+
doesn't belong under controllers, models, or helpers. This directory is in
|
237
|
+
the load path.
|
238
|
+
|
239
|
+
public
|
240
|
+
The directory available for the web server. Contains subdirectories for
|
241
|
+
images, stylesheets, and javascripts. Also contains the dispatchers and the
|
242
|
+
default HTML files. This should be set as the DOCUMENT_ROOT of your web
|
243
|
+
server.
|
244
|
+
|
245
|
+
script
|
246
|
+
Helper scripts for automation and generation.
|
247
|
+
|
248
|
+
test
|
249
|
+
Unit and functional tests along with fixtures. When using the rails generate
|
250
|
+
command, template test files will be generated for you and placed in this
|
251
|
+
directory.
|
252
|
+
|
253
|
+
vendor
|
254
|
+
External libraries that the application depends on. Also includes the plugins
|
255
|
+
subdirectory. If the app has frozen rails, those gems also go here, under
|
256
|
+
vendor/rails/. This directory is in the load path.
|