devise_g5_authenticatable 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (120) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +21 -0
  3. data/.rspec +2 -0
  4. data/.ruby-version +1 -0
  5. data/CHANGELOG.md +25 -0
  6. data/Gemfile +23 -0
  7. data/LICENSE +20 -0
  8. data/README.md +243 -0
  9. data/Rakefile +20 -0
  10. data/app/controllers/devise_g5_authenticatable/registrations_controller.rb +5 -0
  11. data/app/controllers/devise_g5_authenticatable/sessions_controller.rb +58 -0
  12. data/circle.yml +4 -0
  13. data/config/initializers/devise_g5_authenticatable.rb +3 -0
  14. data/config/locales/en.yml +6 -0
  15. data/devise_g5_authenticatable.gemspec +24 -0
  16. data/lib/devise_g5_authenticatable.rb +16 -0
  17. data/lib/devise_g5_authenticatable/controllers/helpers.rb +37 -0
  18. data/lib/devise_g5_authenticatable/controllers/url_helpers.rb +13 -0
  19. data/lib/devise_g5_authenticatable/engine.rb +11 -0
  20. data/lib/devise_g5_authenticatable/g5.rb +4 -0
  21. data/lib/devise_g5_authenticatable/g5/auth_password_validator.rb +30 -0
  22. data/lib/devise_g5_authenticatable/g5/auth_user_creator.rb +48 -0
  23. data/lib/devise_g5_authenticatable/g5/auth_user_updater.rb +43 -0
  24. data/lib/devise_g5_authenticatable/g5/user_exporter.rb +61 -0
  25. data/lib/devise_g5_authenticatable/models/g5_authenticatable.rb +99 -0
  26. data/lib/devise_g5_authenticatable/models/protected_attributes.rb +16 -0
  27. data/lib/devise_g5_authenticatable/omniauth.rb +9 -0
  28. data/lib/devise_g5_authenticatable/routes.rb +58 -0
  29. data/lib/devise_g5_authenticatable/version.rb +3 -0
  30. data/lib/tasks/g5/export_users.rake +13 -0
  31. data/spec/controllers/helpers_spec.rb +295 -0
  32. data/spec/controllers/sessions_controller_spec.rb +256 -0
  33. data/spec/controllers/url_helpers_spec.rb +332 -0
  34. data/spec/dummy/.gitignore +15 -0
  35. data/spec/dummy/README.rdoc +261 -0
  36. data/spec/dummy/Rakefile +7 -0
  37. data/spec/dummy/app/assets/images/rails.png +0 -0
  38. data/spec/dummy/app/assets/javascripts/application.js +15 -0
  39. data/spec/dummy/app/assets/javascripts/custom_sessions.js +2 -0
  40. data/spec/dummy/app/assets/javascripts/home.js +2 -0
  41. data/spec/dummy/app/assets/stylesheets/application.css +13 -0
  42. data/spec/dummy/app/assets/stylesheets/custom_sessions.css +4 -0
  43. data/spec/dummy/app/assets/stylesheets/home.css +4 -0
  44. data/spec/dummy/app/controllers/application_controller.rb +3 -0
  45. data/spec/dummy/app/controllers/custom_registrations_controllers.rb +2 -0
  46. data/spec/dummy/app/controllers/custom_sessions_controller.rb +2 -0
  47. data/spec/dummy/app/controllers/home_controller.rb +4 -0
  48. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  49. data/spec/dummy/app/helpers/custom_sessions_helper.rb +2 -0
  50. data/spec/dummy/app/helpers/home_helper.rb +2 -0
  51. data/spec/dummy/app/mailers/.gitkeep +0 -0
  52. data/spec/dummy/app/models/admin.rb +3 -0
  53. data/spec/dummy/app/models/user.rb +10 -0
  54. data/spec/dummy/app/views/anonymous/new.html.erb +0 -0
  55. data/spec/dummy/app/views/home/index.html.erb +1 -0
  56. data/spec/dummy/app/views/layouts/application.html.erb +16 -0
  57. data/spec/dummy/config.ru +4 -0
  58. data/spec/dummy/config/application.rb +64 -0
  59. data/spec/dummy/config/boot.rb +10 -0
  60. data/spec/dummy/config/database.yml.ci +6 -0
  61. data/spec/dummy/config/database.yml.sample +13 -0
  62. data/spec/dummy/config/environment.rb +5 -0
  63. data/spec/dummy/config/environments/development.rb +39 -0
  64. data/spec/dummy/config/environments/production.rb +67 -0
  65. data/spec/dummy/config/environments/test.rb +37 -0
  66. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  67. data/spec/dummy/config/initializers/devise.rb +259 -0
  68. data/spec/dummy/config/initializers/inflections.rb +15 -0
  69. data/spec/dummy/config/initializers/mime_types.rb +5 -0
  70. data/spec/dummy/config/initializers/secret_token.rb +7 -0
  71. data/spec/dummy/config/initializers/session_store.rb +8 -0
  72. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  73. data/spec/dummy/config/locales/devise.en.yml +60 -0
  74. data/spec/dummy/config/locales/en.yml +5 -0
  75. data/spec/dummy/config/routes.rb +70 -0
  76. data/spec/dummy/db/migrate/20131230235849_devise_create_users.rb +42 -0
  77. data/spec/dummy/db/migrate/20140102213131_drop_database_authenticatable.rb +16 -0
  78. data/spec/dummy/db/migrate/20140103032308_drop_recoverable.rb +16 -0
  79. data/spec/dummy/db/migrate/20140103042329_drop_rememberable.rb +13 -0
  80. data/spec/dummy/db/migrate/20140103174810_add_omniauth_columns_to_users.rb +18 -0
  81. data/spec/dummy/db/migrate/20140103191601_add_email_back_to_user.rb +8 -0
  82. data/spec/dummy/db/migrate/20140113202948_devise_create_admins.rb +42 -0
  83. data/spec/dummy/db/migrate/20140113233821_add_provider_and_uid_to_admins.rb +8 -0
  84. data/spec/dummy/db/schema.rb +50 -0
  85. data/spec/dummy/db/seeds.rb +7 -0
  86. data/spec/dummy/lib/assets/.gitkeep +0 -0
  87. data/spec/dummy/lib/tasks/.gitkeep +0 -0
  88. data/spec/dummy/log/.gitkeep +0 -0
  89. data/spec/dummy/public/404.html +26 -0
  90. data/spec/dummy/public/422.html +26 -0
  91. data/spec/dummy/public/500.html +25 -0
  92. data/spec/dummy/public/favicon.ico +0 -0
  93. data/spec/dummy/public/robots.txt +5 -0
  94. data/spec/dummy/script/rails +6 -0
  95. data/spec/dummy/vendor/assets/javascripts/.gitkeep +0 -0
  96. data/spec/dummy/vendor/assets/stylesheets/.gitkeep +0 -0
  97. data/spec/dummy/vendor/plugins/.gitkeep +0 -0
  98. data/spec/factories/admin.rb +10 -0
  99. data/spec/factories/user.rb +10 -0
  100. data/spec/features/edit_registration_spec.rb +109 -0
  101. data/spec/features/registration_spec.rb +99 -0
  102. data/spec/features/sign_in_spec.rb +91 -0
  103. data/spec/features/sign_out_spec.rb +7 -0
  104. data/spec/g5/auth_password_validator_spec.rb +81 -0
  105. data/spec/g5/auth_user_creator_spec.rb +100 -0
  106. data/spec/g5/auth_user_updater_spec.rb +113 -0
  107. data/spec/g5/user_exporter_spec.rb +105 -0
  108. data/spec/models/g5_authenticatable_spec.rb +540 -0
  109. data/spec/models/protected_attributes_spec.rb +17 -0
  110. data/spec/routing/registrations_routing_spec.rb +107 -0
  111. data/spec/routing/sessions_routing_spec.rb +111 -0
  112. data/spec/spec_helper.rb +44 -0
  113. data/spec/support/devise.rb +3 -0
  114. data/spec/support/omniauth.rb +3 -0
  115. data/spec/support/shared_contexts/oauth_error.rb +9 -0
  116. data/spec/support/shared_contexts/rake.rb +21 -0
  117. data/spec/support/shared_examples/registration_error.rb +15 -0
  118. data/spec/support/user_feature_methods.rb +26 -0
  119. data/spec/tasks/export_users_spec.rb +90 -0
  120. metadata +293 -0
@@ -0,0 +1,332 @@
1
+ require 'spec_helper'
2
+
3
+ describe DeviseG5Authenticatable::UrlHelpers do
4
+ controller(ActionController::Base) do
5
+ include DeviseG5Authenticatable::UrlHelpers
6
+ end
7
+
8
+ describe '#g5_authorize_path' do
9
+ subject(:authorize_path) { controller.g5_authorize_path(resource_or_scope) }
10
+
11
+ context 'with main_app router' do
12
+ context 'with user resource' do
13
+ let(:resource_or_scope) { build_stubbed(:user) }
14
+
15
+ it { should == user_g5_authorize_path }
16
+ end
17
+
18
+ context 'with admin resource' do
19
+ let(:resource_or_scope) { build_stubbed(:admin) }
20
+
21
+ it { should == admin_g5_authorize_path }
22
+ end
23
+
24
+ context 'with user scope' do
25
+ let(:resource_or_scope) { :user }
26
+
27
+ it { should == user_g5_authorize_path }
28
+ end
29
+
30
+ context 'with admin scope' do
31
+ let(:resource_or_scope) { :admin }
32
+
33
+ it { should == admin_g5_authorize_path}
34
+ end
35
+ end
36
+
37
+ context 'with custom router' do
38
+ before { Devise.router_name = :my_engine }
39
+ after { Devise.router_name = nil }
40
+
41
+ let(:custom_router) do
42
+ double(:my_engine_router, user_g5_authorize_path: 'foo',
43
+ admin_g5_authorize_path: 'bar')
44
+ end
45
+ before { controller.stub(my_engine: custom_router) }
46
+
47
+ context 'with user resource' do
48
+ let(:resource_or_scope) { build_stubbed(:user) }
49
+
50
+ it { should == custom_router.user_g5_authorize_path }
51
+ end
52
+
53
+ context 'with admin resource' do
54
+ let(:resource_or_scope) { build_stubbed(:admin) }
55
+
56
+ it { should == custom_router.admin_g5_authorize_path }
57
+ end
58
+
59
+ context 'with user scope' do
60
+ let(:resource_or_scope) { :user }
61
+
62
+ it { should == custom_router.user_g5_authorize_path }
63
+ end
64
+
65
+ context 'with admin scope' do
66
+ let(:resource_or_scope) { :admin }
67
+
68
+ it { should == custom_router.admin_g5_authorize_path}
69
+ end
70
+ end
71
+ end
72
+
73
+ describe '#g5_callback_path' do
74
+ subject(:callback_path) { controller.g5_callback_path(resource_or_scope) }
75
+
76
+ context 'with main_app router' do
77
+ context 'with user resource' do
78
+ let(:resource_or_scope) { build_stubbed(:user) }
79
+
80
+ it { should == user_g5_callback_path }
81
+ end
82
+
83
+ context 'with admin resource' do
84
+ let(:resource_or_scope) { build_stubbed(:admin) }
85
+
86
+ it { should == admin_g5_callback_path }
87
+ end
88
+
89
+ context 'with user scope' do
90
+ let(:resource_or_scope) { :user }
91
+
92
+ it { should == user_g5_callback_path }
93
+ end
94
+
95
+ context 'with admin scope' do
96
+ let(:resource_or_scope) { :admin }
97
+
98
+ it { should == admin_g5_callback_path }
99
+ end
100
+ end
101
+
102
+ context 'with custom router' do
103
+ before { Devise.router_name = :my_engine }
104
+ after { Devise.router_name = nil }
105
+
106
+ let(:custom_router) do
107
+ double(:my_engine_router, user_g5_callback_path: 'foo_callback',
108
+ admin_g5_callback_path: 'bar_callback')
109
+ end
110
+ before { controller.stub(my_engine: custom_router) }
111
+
112
+ context 'with user resource' do
113
+ let(:resource_or_scope) { build_stubbed(:user) }
114
+
115
+ it { should == custom_router.user_g5_callback_path }
116
+ end
117
+
118
+ context 'with admin resource' do
119
+ let(:resource_or_scope) { build_stubbed(:admin) }
120
+
121
+ it { should == custom_router.admin_g5_callback_path }
122
+ end
123
+
124
+ context 'with user scope' do
125
+ let(:resource_or_scope) { :user }
126
+
127
+ it { should == custom_router.user_g5_callback_path }
128
+ end
129
+
130
+ context 'with admin scope' do
131
+ let(:resource_or_scope) { :admin }
132
+
133
+ it { should == custom_router.admin_g5_callback_path}
134
+ end
135
+ end
136
+ end
137
+
138
+ describe '#new_session_path' do
139
+ subject(:new_session_path) { controller.new_session_path(resource_or_scope) }
140
+
141
+ context 'with main_app router' do
142
+ context 'with user resource' do
143
+ let(:resource_or_scope) { build_stubbed(:user) }
144
+
145
+ it { should == new_user_session_path }
146
+ end
147
+
148
+ context 'with admin resource' do
149
+ let(:resource_or_scope) { build_stubbed(:admin) }
150
+
151
+ it { should == new_admin_session_path }
152
+ end
153
+
154
+ context 'with user scope' do
155
+ let(:resource_or_scope) { :user }
156
+
157
+ it { should == new_user_session_path }
158
+ end
159
+
160
+ context 'with admin scope' do
161
+ let(:resource_or_scope) { :admin }
162
+
163
+ it { should == new_admin_session_path }
164
+ end
165
+ end
166
+
167
+ context 'with custom router' do
168
+ before { Devise.router_name = :my_engine }
169
+ after { Devise.router_name = nil }
170
+
171
+ let(:custom_router) do
172
+ double(:my_engine_router, new_user_session_path: 'foo',
173
+ new_admin_session_path: 'bar')
174
+ end
175
+ before { controller.stub(my_engine: custom_router) }
176
+
177
+ context 'with user resource' do
178
+ let(:resource_or_scope) { build_stubbed(:user) }
179
+
180
+ it { should == custom_router.new_user_session_path }
181
+ end
182
+
183
+ context 'with admin resource' do
184
+ let(:resource_or_scope) { build_stubbed(:admin) }
185
+
186
+ it { should == custom_router.new_admin_session_path }
187
+ end
188
+
189
+ context 'with user scope' do
190
+ let(:resource_or_scope) { :user }
191
+
192
+ it { should == custom_router.new_user_session_path }
193
+ end
194
+
195
+ context 'with admin scope' do
196
+ let(:resource_or_scope) { :admin }
197
+
198
+ it { should == custom_router.new_admin_session_path}
199
+ end
200
+ end
201
+ end
202
+
203
+ describe '#destroy_session_path' do
204
+ subject(:destroy_session_path) { controller.destroy_session_path(resource_or_scope) }
205
+
206
+ context 'with main_app router' do
207
+ context 'with user resource' do
208
+ let(:resource_or_scope) { build_stubbed(:user) }
209
+
210
+ it { should == destroy_user_session_path }
211
+ end
212
+
213
+ context 'with admin resource' do
214
+ let(:resource_or_scope) { build_stubbed(:admin) }
215
+
216
+ it { should == destroy_admin_session_path }
217
+ end
218
+
219
+ context 'with user scope' do
220
+ let(:resource_or_scope) { :user }
221
+
222
+ it { should == destroy_user_session_path }
223
+ end
224
+
225
+ context 'with admin scope' do
226
+ let(:resource_or_scope) { :admin }
227
+
228
+ it { should == destroy_admin_session_path }
229
+ end
230
+ end
231
+
232
+ context 'with custom router' do
233
+ before { Devise.router_name = :my_engine }
234
+ after { Devise.router_name = nil }
235
+
236
+ let(:custom_router) do
237
+ double(:my_engine_router, destroy_user_session_path: 'foo',
238
+ destroy_admin_session_path: 'bar')
239
+ end
240
+ before { controller.stub(my_engine: custom_router) }
241
+
242
+ context 'with user resource' do
243
+ let(:resource_or_scope) { build_stubbed(:user) }
244
+
245
+ it { should == custom_router.destroy_user_session_path }
246
+ end
247
+
248
+ context 'with admin resource' do
249
+ let(:resource_or_scope) { build_stubbed(:admin) }
250
+
251
+ it { should == custom_router.destroy_admin_session_path }
252
+ end
253
+
254
+ context 'with user scope' do
255
+ let(:resource_or_scope) { :user }
256
+
257
+ it { should == custom_router.destroy_user_session_path }
258
+ end
259
+
260
+ context 'with admin scope' do
261
+ let(:resource_or_scope) { :admin }
262
+
263
+ it { should == custom_router.destroy_admin_session_path}
264
+ end
265
+ end
266
+ end
267
+
268
+ describe '#session_path' do
269
+ subject(:session_path) { controller.session_path(resource_or_scope) }
270
+
271
+ context 'with main_app router' do
272
+ context 'with user resource' do
273
+ let(:resource_or_scope) { build_stubbed(:user) }
274
+
275
+ it { should == user_session_path }
276
+ end
277
+
278
+ context 'with admin resource' do
279
+ let(:resource_or_scope) { build_stubbed(:admin) }
280
+
281
+ it { should == admin_session_path }
282
+ end
283
+
284
+ context 'with user scope' do
285
+ let(:resource_or_scope) { :user }
286
+
287
+ it { should == user_session_path }
288
+ end
289
+
290
+ context 'with admin scope' do
291
+ let(:resource_or_scope) { :admin }
292
+
293
+ it { should == admin_session_path }
294
+ end
295
+ end
296
+
297
+ context 'with custom router' do
298
+ before { Devise.router_name = :my_engine }
299
+ after { Devise.router_name = nil }
300
+
301
+ let(:custom_router) do
302
+ double(:my_engine_router, user_session_path: 'foo',
303
+ admin_session_path: 'bar')
304
+ end
305
+ before { controller.stub(my_engine: custom_router) }
306
+
307
+ context 'with user resource' do
308
+ let(:resource_or_scope) { build_stubbed(:user) }
309
+
310
+ it { should == custom_router.user_session_path }
311
+ end
312
+
313
+ context 'with admin resource' do
314
+ let(:resource_or_scope) { build_stubbed(:admin) }
315
+
316
+ it { should == custom_router.admin_session_path }
317
+ end
318
+
319
+ context 'with user scope' do
320
+ let(:resource_or_scope) { :user }
321
+
322
+ it { should == custom_router.user_session_path }
323
+ end
324
+
325
+ context 'with admin scope' do
326
+ let(:resource_or_scope) { :admin }
327
+
328
+ it { should == custom_router.admin_session_path}
329
+ end
330
+ end
331
+ end
332
+ end
@@ -0,0 +1,15 @@
1
+ # See http://help.github.com/ignore-files/ for more about ignoring files.
2
+ #
3
+ # If you find yourself ignoring temporary files generated by your text editor
4
+ # or operating system, you probably want to add a global ignore instead:
5
+ # git config --global core.excludesfile ~/.gitignore_global
6
+
7
+ # Ignore bundler config
8
+ /.bundle
9
+
10
+ # Ignore the default SQLite database.
11
+ /db/*.sqlite3
12
+
13
+ # Ignore all logfiles and tempfiles.
14
+ /log/*.log
15
+ /tmp
@@ -0,0 +1,261 @@
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.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.org/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
+ | |-- assets
160
+ | | |-- images
161
+ | | |-- javascripts
162
+ | | `-- stylesheets
163
+ | |-- controllers
164
+ | |-- helpers
165
+ | |-- mailers
166
+ | |-- models
167
+ | `-- views
168
+ | `-- layouts
169
+ |-- config
170
+ | |-- environments
171
+ | |-- initializers
172
+ | `-- locales
173
+ |-- db
174
+ |-- doc
175
+ |-- lib
176
+ | |-- assets
177
+ | `-- tasks
178
+ |-- log
179
+ |-- public
180
+ |-- script
181
+ |-- test
182
+ | |-- fixtures
183
+ | |-- functional
184
+ | |-- integration
185
+ | |-- performance
186
+ | `-- unit
187
+ |-- tmp
188
+ | `-- cache
189
+ | `-- assets
190
+ `-- vendor
191
+ |-- assets
192
+ | |-- javascripts
193
+ | `-- stylesheets
194
+ `-- plugins
195
+
196
+ app
197
+ Holds all the code that's specific to this particular application.
198
+
199
+ app/assets
200
+ Contains subdirectories for images, stylesheets, and JavaScript files.
201
+
202
+ app/controllers
203
+ Holds controllers that should be named like weblogs_controller.rb for
204
+ automated URL mapping. All controllers should descend from
205
+ ApplicationController which itself descends from ActionController::Base.
206
+
207
+ app/models
208
+ Holds models that should be named like post.rb. Models descend from
209
+ ActiveRecord::Base by default.
210
+
211
+ app/views
212
+ Holds the template files for the view that should be named like
213
+ weblogs/index.html.erb for the WeblogsController#index action. All views use
214
+ eRuby syntax by default.
215
+
216
+ app/views/layouts
217
+ Holds the template files for layouts to be used with views. This models the
218
+ common header/footer method of wrapping views. In your views, define a layout
219
+ using the <tt>layout :default</tt> and create a file named default.html.erb.
220
+ Inside default.html.erb, call <% yield %> to render the view using this
221
+ layout.
222
+
223
+ app/helpers
224
+ Holds view helpers that should be named like weblogs_helper.rb. These are
225
+ generated for you automatically when using generators for controllers.
226
+ Helpers can be used to wrap functionality for your views into methods.
227
+
228
+ config
229
+ Configuration files for the Rails environment, the routing map, the database,
230
+ and other dependencies.
231
+
232
+ db
233
+ Contains the database schema in schema.rb. db/migrate contains all the
234
+ sequence of Migrations for your schema.
235
+
236
+ doc
237
+ This directory is where your application documentation will be stored when
238
+ generated using <tt>rake doc:app</tt>
239
+
240
+ lib
241
+ Application specific libraries. Basically, any kind of custom code that
242
+ doesn't belong under controllers, models, or helpers. This directory is in
243
+ the load path.
244
+
245
+ public
246
+ The directory available for the web server. Also contains the dispatchers and the
247
+ default HTML files. This should be set as the DOCUMENT_ROOT of your web
248
+ server.
249
+
250
+ script
251
+ Helper scripts for automation and generation.
252
+
253
+ test
254
+ Unit and functional tests along with fixtures. When using the rails generate
255
+ command, template test files will be generated for you and placed in this
256
+ directory.
257
+
258
+ vendor
259
+ External libraries that the application depends on. Also includes the plugins
260
+ subdirectory. If the app has frozen rails, those gems also go here, under
261
+ vendor/rails/. This directory is in the load path.