user_impersonate 0.7.0
Sign up to get free protection for your applications and to get access to all the features.
- data/MIT-LICENSE +20 -0
- data/README.md +155 -0
- data/Rakefile +41 -0
- data/app/assets/javascripts/user_impersonate/application.js +15 -0
- data/app/assets/javascripts/user_impersonate/impersonate.js +2 -0
- data/app/assets/stylesheets/user_impersonate/application.css +13 -0
- data/app/assets/stylesheets/user_impersonate/impersonate.css +4 -0
- data/app/controllers/user_impersonate/application_controller.rb +4 -0
- data/app/controllers/user_impersonate/impersonate_controller.rb +107 -0
- data/app/helpers/user_impersonate/application_helper.rb +4 -0
- data/app/views/layouts/user_impersonate/application.html.erb +14 -0
- data/app/views/user_impersonate/_header.html.erb +60 -0
- data/app/views/user_impersonate/impersonate/index.html.erb +30 -0
- data/config/cucumber.yml +8 -0
- data/config/routes.rb +6 -0
- data/lib/generators/user_impersonate/USAGE +6 -0
- data/lib/generators/user_impersonate/templates/app/views/user_impersonate/_header.html.erb +60 -0
- data/lib/generators/user_impersonate/templates/config/initializers/user_impersonate.rb +11 -0
- data/lib/generators/user_impersonate/user_impersonate_generator.rb +15 -0
- data/lib/tasks/user_impersonate_tasks.rake +4 -0
- data/lib/user_impersonate.rb +5 -0
- data/lib/user_impersonate/devise_helpers.rb +31 -0
- data/lib/user_impersonate/engine.rb +12 -0
- data/lib/user_impersonate/version.rb +3 -0
- data/test/dummy/README.rdoc +261 -0
- data/test/dummy/Rakefile +7 -0
- data/test/dummy/app/assets/javascripts/application.js +15 -0
- data/test/dummy/app/assets/javascripts/home.js +2 -0
- data/test/dummy/app/assets/stylesheets/application.css +16 -0
- data/test/dummy/app/assets/stylesheets/home.css +7 -0
- data/test/dummy/app/controllers/application_controller.rb +3 -0
- data/test/dummy/app/controllers/home_controller.rb +4 -0
- data/test/dummy/app/helpers/application_helper.rb +2 -0
- data/test/dummy/app/helpers/home_helper.rb +2 -0
- data/test/dummy/app/models/user.rb +12 -0
- data/test/dummy/app/views/home/index.html.erb +11 -0
- data/test/dummy/app/views/layouts/application.html.erb +22 -0
- data/test/dummy/app/views/user_impersonate/_header.html.erb +65 -0
- data/test/dummy/config.ru +4 -0
- data/test/dummy/config/application.rb +60 -0
- data/test/dummy/config/boot.rb +10 -0
- data/test/dummy/config/database.yml +25 -0
- data/test/dummy/config/environment.rb +5 -0
- data/test/dummy/config/environments/development.rb +40 -0
- data/test/dummy/config/environments/production.rb +67 -0
- data/test/dummy/config/environments/test.rb +37 -0
- data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/test/dummy/config/initializers/devise.rb +232 -0
- data/test/dummy/config/initializers/inflections.rb +15 -0
- data/test/dummy/config/initializers/mime_types.rb +5 -0
- data/test/dummy/config/initializers/secret_token.rb +7 -0
- data/test/dummy/config/initializers/session_store.rb +8 -0
- data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
- data/test/dummy/config/locales/devise.en.yml +58 -0
- data/test/dummy/config/locales/en.yml +5 -0
- data/test/dummy/config/routes.rb +8 -0
- data/test/dummy/db/development.sqlite3 +0 -0
- data/test/dummy/db/migrate/20120914174453_devise_create_users.rb +48 -0
- data/test/dummy/db/migrate/20120914184123_add_staff_flag_to_users.rb +5 -0
- data/test/dummy/db/schema.rb +36 -0
- data/test/dummy/db/test.sqlite3 +0 -0
- data/test/dummy/lib/tasks/cucumber.rake +65 -0
- data/test/dummy/log/development.log +10062 -0
- data/test/dummy/log/test.log +10080 -0
- data/test/dummy/public/404.html +26 -0
- data/test/dummy/public/422.html +26 -0
- data/test/dummy/public/500.html +25 -0
- data/test/dummy/public/favicon.ico +0 -0
- data/test/dummy/script/rails +6 -0
- data/test/dummy/test/fixtures/users.yml +14 -0
- data/test/dummy/test/unit/helpers/home_helper_test.rb +4 -0
- data/test/dummy/test/unit/user_test.rb +7 -0
- data/test/dummy/tmp/cache/assets/C0C/820/sprockets%2F2d9383a79c508f97f230886454184881 +0 -0
- data/test/dummy/tmp/cache/assets/C20/590/sprockets%2F235093f56314718870f0b3a4306ef981 +0 -0
- data/test/dummy/tmp/cache/assets/C2F/CD0/sprockets%2F03eaf29b936263599b816c6558761441 +0 -0
- data/test/dummy/tmp/cache/assets/C50/CE0/sprockets%2Fac24523561a51d8b542e705627985f44 +0 -0
- data/test/dummy/tmp/cache/assets/C51/630/sprockets%2F6acb2453ed54725270a79286038036d9 +0 -0
- data/test/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953 +0 -0
- data/test/dummy/tmp/cache/assets/CDF/870/sprockets%2Fb878faf942403e313a5b103e5d80488e +0 -0
- data/test/dummy/tmp/cache/assets/CDF/E90/sprockets%2F9621b3e1f0ea31cd644eb79996e76000 +0 -0
- data/test/dummy/tmp/cache/assets/CEB/3F0/sprockets%2F661a60a2c7729f6d58ee1b74b366a588 +0 -0
- data/test/dummy/tmp/cache/assets/CF9/7C0/sprockets%2F40fc2f3d2a468a00e463f1d313cb1683 +0 -0
- data/test/dummy/tmp/cache/assets/D05/360/sprockets%2Fa0b6daa86d2b41682b983a2715e7138a +0 -0
- data/test/dummy/tmp/cache/assets/D05/D40/sprockets%2F1c9faaf28d05409b88ad3113374d613c +0 -0
- data/test/dummy/tmp/cache/assets/D0A/D80/sprockets%2F7b632c53b622d38b006e5537c84d3fbe +0 -0
- data/test/dummy/tmp/cache/assets/D28/EE0/sprockets%2F3db0c2fc877f0331a811af24b5eb2802 +0 -0
- data/test/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705 +0 -0
- data/test/dummy/tmp/cache/assets/D43/B90/sprockets%2F726a02947dce8f83fa9181d8ad550ac3 +0 -0
- data/test/dummy/tmp/cache/assets/D44/EF0/sprockets%2F8d4c011dff114dcee37337d0e776299d +0 -0
- data/test/dummy/tmp/cache/assets/D45/0E0/sprockets%2F3e99ab70e0b37bdeb2f674633e2c8835 +0 -0
- data/test/dummy/tmp/cache/assets/D47/3E0/sprockets%2Fd66b712f3d268a1b607eb686ef2b82d9 +0 -0
- data/test/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655 +0 -0
- data/test/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6 +0 -0
- data/test/dummy/tmp/cache/assets/D6A/190/sprockets%2F759e72ee0bd652de230c2eac42c14f86 +0 -0
- data/test/dummy/tmp/cache/assets/D74/880/sprockets%2Fd5c41f40fb2af2c59969ebb1fb865804 +0 -0
- data/test/dummy/tmp/cache/assets/D7B/FD0/sprockets%2F72f171394cbb96492f3d0dca87dfff44 +0 -0
- data/test/dummy/tmp/cache/assets/D7C/110/sprockets%2F2bce4ec3f4f837664329f89ecc35a36a +0 -0
- data/test/dummy/tmp/cache/assets/D98/8B0/sprockets%2Fedbef6e0d0a4742346cf479f2c522eb0 +0 -0
- data/test/dummy/tmp/cache/assets/D9C/BF0/sprockets%2F936aa1edf76c03ce37fa4256ba7764bb +0 -0
- data/test/dummy/tmp/cache/assets/DA0/FF0/sprockets%2F4fd6b0f0ccd929d2d8e5e2714c524b8c +0 -0
- data/test/dummy/tmp/cache/assets/DAF/CD0/sprockets%2Fb69c4f14808eb26ba5d52e67ddef496f +0 -0
- data/test/dummy/tmp/cache/assets/DB1/3D0/sprockets%2Fcd635da8eb5a88d563febe9d4a468545 +0 -0
- data/test/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994 +0 -0
- data/test/dummy/tmp/cache/assets/DF0/7A0/sprockets%2F2063d2525df419c0c6df4fbacdc4ced2 +0 -0
- data/test/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af +0 -0
- data/test/dummy/tmp/cache/assets/E1C/610/sprockets%2Fc6bef1e11d6b0cdfab292b90cf16bd44 +0 -0
- data/test/dummy/tmp/capybara/capybara-201209141022223935955827.html +16 -0
- data/test/dummy/tmp/capybara/capybara-201209141022422048391033.html +16 -0
- data/test/dummy/tmp/capybara/capybara-201209141022483207542727.html +16 -0
- data/test/dummy/tmp/capybara/capybara-201209141025331953416679.html +16 -0
- data/test/dummy/tmp/capybara/capybara-201209141025405140553066.html +16 -0
- data/test/dummy/tmp/capybara/capybara-201209141025479189502384.html +16 -0
- data/test/dummy/tmp/capybara/capybara-201209141025536572788101.html +16 -0
- data/test/dummy/tmp/capybara/capybara-201209141026535496719019.html +16 -0
- data/test/dummy/tmp/capybara/capybara-201209141027001260256891.html +16 -0
- data/test/dummy/tmp/capybara/capybara-201209141030296650320780.html +16 -0
- data/test/dummy/tmp/capybara/capybara-201209141031072084990548.html +16 -0
- data/test/dummy/tmp/capybara/capybara-201209141035147052886495.html +16 -0
- data/test/dummy/tmp/capybara/capybara-201209141035572336747180.html +16 -0
- data/test/dummy/tmp/capybara/capybara-201209141036191976624121.html +16 -0
- data/test/dummy/tmp/capybara/capybara-201209141036193465232588.html +14 -0
- data/test/dummy/tmp/capybara/capybara-20120914103619649823379.html +14 -0
- data/test/dummy/tmp/capybara/capybara-20120914103639499751538.html +14 -0
- data/test/dummy/tmp/capybara/capybara-201209141036396957096322.html +16 -0
- data/test/dummy/tmp/capybara/capybara-201209141036398706428277.html +14 -0
- data/test/dummy/tmp/capybara/capybara-201209141036581687315384.html +16 -0
- data/test/dummy/tmp/capybara/capybara-201209141036584316306451.html +16 -0
- data/test/dummy/tmp/capybara/capybara-201209141036588664819750.html +16 -0
- data/test/dummy/tmp/pids/server.pid +1 -0
- data/test/integration/navigation_test.rb +10 -0
- data/test/test_helper.rb +15 -0
- data/test/unit/helpers/user_impersonate/impersonate_helper_test.rb +6 -0
- data/test/user_impersonate_test.rb +7 -0
- metadata +407 -0
@@ -0,0 +1,30 @@
|
|
1
|
+
<h1>Default impersonation home page</h1>
|
2
|
+
|
3
|
+
<p>
|
4
|
+
It is recommended you ignore this page and integrate the
|
5
|
+
<code>impersonate_engine.impersonate_user_path(user)</code> URL helpers into your main app.
|
6
|
+
</p>
|
7
|
+
|
8
|
+
<p>Search for a user to impersonate:</p>
|
9
|
+
|
10
|
+
<%= form_tag root_url, :method => 'get' do %>
|
11
|
+
<p>
|
12
|
+
<%= text_field_tag :search, params[:search] %>
|
13
|
+
<%= submit_tag "Search", :name => nil %>
|
14
|
+
</p>
|
15
|
+
<% end %>
|
16
|
+
|
17
|
+
<% if @users %>
|
18
|
+
<% if @users.empty? %>
|
19
|
+
<p>No users found</p>
|
20
|
+
<% else %>
|
21
|
+
<ul>
|
22
|
+
<% @users.each do |user| %>
|
23
|
+
<li>
|
24
|
+
<%= user %>
|
25
|
+
<%= link_to "Impersonate", impersonate_user_path(user) %>
|
26
|
+
</li>
|
27
|
+
<% end %>
|
28
|
+
</ul>
|
29
|
+
<% end %>
|
30
|
+
<% end %>
|
data/config/cucumber.yml
ADDED
@@ -0,0 +1,8 @@
|
|
1
|
+
<%
|
2
|
+
rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
|
3
|
+
rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
|
4
|
+
std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} --strict --tags ~@wip"
|
5
|
+
%>
|
6
|
+
default: <%= std_opts %> features
|
7
|
+
wip: --tags @wip:3 --wip features
|
8
|
+
rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip
|
data/config/routes.rb
ADDED
@@ -0,0 +1,60 @@
|
|
1
|
+
<style>
|
2
|
+
#impersonating {
|
3
|
+
width: 100%;
|
4
|
+
margin: 0;
|
5
|
+
padding: 12px 0;
|
6
|
+
background: #c70000;
|
7
|
+
border-bottom: 1px solid black;
|
8
|
+
line-height: 1.9;
|
9
|
+
font-size: 12px;
|
10
|
+
font-family: "Lucida Sans Unicode","Lucida Grande",Verdana,Arial,Helvetica,sans-serif;
|
11
|
+
}
|
12
|
+
#impersonating .impersonate-controls {
|
13
|
+
color: white;
|
14
|
+
font-weight: normal;
|
15
|
+
font-size: 15px;
|
16
|
+
max-width: 960px;
|
17
|
+
margin-left: auto;
|
18
|
+
margin-right: auto;
|
19
|
+
}
|
20
|
+
#impersonating .impersonate-controls .impersonate-info {
|
21
|
+
margin-bottom: 6px;
|
22
|
+
padding-bottom: 2px;
|
23
|
+
border-bottom: 1px solid #dd0000;
|
24
|
+
}
|
25
|
+
#impersonating .impersonate-controls form {
|
26
|
+
display: inline;
|
27
|
+
margin-right: 16px;
|
28
|
+
}
|
29
|
+
#impersonating .impersonate-controls .revert-form {
|
30
|
+
margin-left: 16px;
|
31
|
+
}
|
32
|
+
#impersonating .impersonate-controls select {
|
33
|
+
background: white;
|
34
|
+
}
|
35
|
+
#impersonating .impersonate-controls .admin_name, #impersonating .impersonate-controls .user_name, #impersonating .impersonate-controls .user_id, #impersonating .impersonate-controls .account_id {
|
36
|
+
font-weight: bold;
|
37
|
+
}
|
38
|
+
#impersonating .impersonate-controls a {
|
39
|
+
text-decoration: underline;
|
40
|
+
color: white;
|
41
|
+
}
|
42
|
+
</style>
|
43
|
+
<div id="impersonating">
|
44
|
+
<div class="impersonate-controls">
|
45
|
+
<div class="impersonate-info">
|
46
|
+
You (
|
47
|
+
<span class="admin_name"><%= current_staff_user %></span>
|
48
|
+
) are impersonating
|
49
|
+
<span class="admin_name"><%= current_user %></span>
|
50
|
+
( User id: <%= current_user.to_param %> )
|
51
|
+
</div>
|
52
|
+
|
53
|
+
<div class="impersonate-buttons">
|
54
|
+
<%= form_tag impersonate_engine.revert_impersonate_user_url,
|
55
|
+
:method => :delete, :class => 'revert-form' do %>
|
56
|
+
<button type = "submit"> Revert to admin</button>
|
57
|
+
<% end %>
|
58
|
+
</div>
|
59
|
+
</div>
|
60
|
+
</div>
|
@@ -0,0 +1,11 @@
|
|
1
|
+
module UserImpersonate
|
2
|
+
class Engine < Rails::Engine
|
3
|
+
config.user_class = "User"
|
4
|
+
config.user_finder = "find" # User.find
|
5
|
+
config.user_id_column = "id" # Such that User.find(aUser.id) works
|
6
|
+
config.user_is_staff_method = "staff?" # current_user.staff?
|
7
|
+
|
8
|
+
config.redirect_on_impersonate = "/"
|
9
|
+
config.redirect_on_revert = "/impersonate"
|
10
|
+
end
|
11
|
+
end
|
@@ -0,0 +1,15 @@
|
|
1
|
+
class UserImpersonateGenerator < Rails::Generators::Base
|
2
|
+
source_root File.expand_path('../templates', __FILE__)
|
3
|
+
|
4
|
+
def engine_routes
|
5
|
+
route 'mount UserImpersonate::Engine => "/impersonate", as: "impersonate_engine"'
|
6
|
+
end
|
7
|
+
|
8
|
+
def configuration
|
9
|
+
directory "config"
|
10
|
+
end
|
11
|
+
|
12
|
+
def views
|
13
|
+
directory "app/views"
|
14
|
+
end
|
15
|
+
end
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# TODO store staff user via Warden
|
2
|
+
module UserImpersonate
|
3
|
+
module DeviseHelpers
|
4
|
+
module Helpers
|
5
|
+
# current_user changes from a staff user to
|
6
|
+
# +new_user+; current user stored in +session[:staff_user_id]+
|
7
|
+
def impersonate(new_user)
|
8
|
+
session[:staff_user_id] = current_user.id #
|
9
|
+
sign_in new_user, bypass: true
|
10
|
+
end
|
11
|
+
|
12
|
+
# revert the +current_user+ back to the staff user
|
13
|
+
# stored in +session[:staff_user_id]+
|
14
|
+
def revert_impersonate
|
15
|
+
return unless current_staff_user
|
16
|
+
sign_in current_staff_user, bypass: true
|
17
|
+
session[:staff_user_id] = nil
|
18
|
+
end
|
19
|
+
end
|
20
|
+
|
21
|
+
module UrlHelpers
|
22
|
+
def current_staff_user
|
23
|
+
return unless session[:staff_user_id]
|
24
|
+
user_finder_method = (UserImpersonate::Engine.config.user_finder || "find").to_sym
|
25
|
+
user_class_name = UserImpersonate::Engine.config.user_class || "User"
|
26
|
+
user_class = user_class_name.constantize
|
27
|
+
@staff_user ||= user_class.send(user_finder_method, session[:staff_user_id])
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
31
|
+
end
|
@@ -0,0 +1,12 @@
|
|
1
|
+
module UserImpersonate
|
2
|
+
class Engine < ::Rails::Engine
|
3
|
+
isolate_namespace UserImpersonate
|
4
|
+
|
5
|
+
initializer "user_impersonate.devise_helpers" do
|
6
|
+
if Object.const_defined?("Devise")
|
7
|
+
require "user_impersonate/devise_helpers"
|
8
|
+
Devise.include_helpers(UserImpersonate::DeviseHelpers)
|
9
|
+
end
|
10
|
+
end
|
11
|
+
end
|
12
|
+
end
|
@@ -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
|
+
| `-- tasks
|
177
|
+
|-- log
|
178
|
+
|-- public
|
179
|
+
|-- script
|
180
|
+
|-- test
|
181
|
+
| |-- fixtures
|
182
|
+
| |-- functional
|
183
|
+
| |-- integration
|
184
|
+
| |-- performance
|
185
|
+
| `-- unit
|
186
|
+
|-- tmp
|
187
|
+
| |-- cache
|
188
|
+
| |-- pids
|
189
|
+
| |-- sessions
|
190
|
+
| `-- sockets
|
191
|
+
`-- vendor
|
192
|
+
|-- assets
|
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.
|