exception_logger 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/MIT-LICENSE +20 -0
- data/Rakefile +2 -0
- data/app/assets/javascripts/exception_logger/application.js +15 -0
- data/app/assets/javascripts/exception_logger/exception_logger.js +69 -0
- data/app/assets/javascripts/exception_logger/logged_exceptions.js +2 -0
- data/app/assets/stylesheets/exception_logger/application.css +13 -0
- data/app/assets/stylesheets/exception_logger/exception_logger.css +301 -0
- data/app/assets/stylesheets/exception_logger/logged_exceptions.css +4 -0
- data/app/controllers/exception_logger/application_controller.rb +4 -0
- data/app/controllers/exception_logger/logged_exceptions_controller.rb +105 -0
- data/app/helpers/exception_logger/application_helper.rb +4 -0
- data/app/helpers/exception_logger/logged_exceptions_helper.rb +38 -0
- data/app/models/exception_logger/logged_exception.rb +99 -0
- data/app/views/exception_logger/logged_exceptions/_exceptions.html.erb +32 -0
- data/app/views/exception_logger/logged_exceptions/_feed.html.erb +3 -0
- data/app/views/exception_logger/logged_exceptions/_show.html.erb +33 -0
- data/app/views/exception_logger/logged_exceptions/destroy.js.erb +2 -0
- data/app/views/exception_logger/logged_exceptions/destroy_all.js.erb +2 -0
- data/app/views/exception_logger/logged_exceptions/feed.rss.builder +20 -0
- data/app/views/exception_logger/logged_exceptions/index.html.erb +46 -0
- data/app/views/exception_logger/logged_exceptions/index.js.erb +2 -0
- data/app/views/exception_logger/logged_exceptions/query.js.erb +2 -0
- data/app/views/exception_logger/logged_exceptions/show.html.erb +8 -0
- data/app/views/exception_logger/logged_exceptions/show.js.erb +2 -0
- data/app/views/layouts/exception_logger/application.html.erb +20 -0
- data/config/initializers/date_formats.rb +5 -0
- data/config/locales/en.yml +16 -0
- data/config/routes.rb +11 -0
- data/db/migrate/20120507081835_create_exception_logger_logged_exceptions.rb +14 -0
- data/lib/exception_logger/engine.rb +5 -0
- data/lib/exception_logger/version.rb +3 -0
- data/lib/exception_logger.rb +90 -0
- data/lib/tasks/exception_logger_tasks.rake +4 -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/stylesheets/application.css +13 -0
- data/test/dummy/app/controllers/application_controller.rb +3 -0
- data/test/dummy/app/controllers/simulate_controller.rb +10 -0
- data/test/dummy/app/helpers/application_helper.rb +2 -0
- data/test/dummy/app/helpers/simulate_helper.rb +2 -0
- data/test/dummy/app/views/layouts/application.html.erb +14 -0
- data/test/dummy/app/views/simulate/failure.html.erb +2 -0
- data/test/dummy/config/application.rb +50 -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 +29 -0
- data/test/dummy/config/environments/production.rb +63 -0
- data/test/dummy/config/environments/test.rb +33 -0
- data/test/dummy/config/initializers/backtrace_silencers.rb +7 -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/en.yml +5 -0
- data/test/dummy/config/routes.rb +6 -0
- data/test/dummy/config.ru +4 -0
- data/test/dummy/db/migrate/20120507083836_create_exception_logger_logged_exceptions.exception_logger.rb +15 -0
- data/test/dummy/db/schema.rb +27 -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/functional/simulate_controller_test.rb +9 -0
- data/test/dummy/test/unit/helpers/simulate_helper_test.rb +4 -0
- data/test/exception_logger_test.rb +7 -0
- data/test/fixtures/exception_logger/logged_exceptions.yml +11 -0
- data/test/functional/exception_logger/logged_exceptions_controller_test.rb +9 -0
- data/test/integration/navigation_test.rb +10 -0
- data/test/test_helper.rb +10 -0
- data/test/unit/exception_logger/logged_exception_test.rb +9 -0
- data/test/unit/helpers/exception_logger/logged_exceptions_helper_test.rb +6 -0
- metadata +204 -0
@@ -0,0 +1,32 @@
|
|
1
|
+
<div id="exceptions">
|
2
|
+
<div class="pages">
|
3
|
+
<%= link_to('Clear History', {:action => :clear}, :confirm => "are you sure?", :method => :post) %>
|
4
|
+
<%= link_to 'Delete Visible', { :action => 'destroy_all' }.merge(params_filters), :class => 'delete_visible_link' %>
|
5
|
+
<strong><%= will_paginate @exceptions, :params => { :controller => "logged_exceptions", :action => "index" }.merge(params_filters), :style => 'display:inline' %></strong>
|
6
|
+
</div>
|
7
|
+
<h1>Exceptions <%= raw "<span>(filtered)</span>" if filtered? %> </h1>
|
8
|
+
<table>
|
9
|
+
<thead>
|
10
|
+
<tr>
|
11
|
+
<th>Exception</th>
|
12
|
+
<th>Date</th>
|
13
|
+
<th></th>
|
14
|
+
</tr>
|
15
|
+
</thead>
|
16
|
+
<tbody>
|
17
|
+
<% @exceptions.each do |exception| %>
|
18
|
+
<tr id="<%= dom_id(exception) %>" class="<%= cycle("eor", "") %> exception">
|
19
|
+
<td>
|
20
|
+
<div class="expclass"><%= link_to exception.name, {:action => "show", :id => exception}, :class => 'show_link' %></div>
|
21
|
+
<span class="message"><%= h exception.message.truncate(255) %></span>
|
22
|
+
</td>
|
23
|
+
<td class="time"><%= pretty_exception_date(exception) %></td>
|
24
|
+
<td><%= link_to 'Delete', { :action => 'destroy', :id => exception }, :class => "util delete_link" %></td>
|
25
|
+
</tr>
|
26
|
+
<% end %>
|
27
|
+
</tbody>
|
28
|
+
</table>
|
29
|
+
<div class="pages pages-bottom">
|
30
|
+
<strong><%= will_paginate @exceptions, :params => { :controller => "logged_exceptions", :action => "index" }.merge(params_filters), :style => 'display:inline' %></strong>
|
31
|
+
</div>
|
32
|
+
</div> <!-- #exceptions -->
|
@@ -0,0 +1,33 @@
|
|
1
|
+
<div class="tools">
|
2
|
+
<%= link_to 'Delete', { :action => 'destroy', :id => @exception }, :class => "util delete_link" %>
|
3
|
+
<span class="pipe">|</span>
|
4
|
+
<%= link_to "Close", "#", :class => "util close_link" %>
|
5
|
+
</div>
|
6
|
+
|
7
|
+
<div class="date">
|
8
|
+
<%= @exception.created_at.strftime(Time::DATE_FORMATS[:exc_full]) %>
|
9
|
+
</div>
|
10
|
+
<h1><%= @exception.name %></h1>
|
11
|
+
|
12
|
+
<h2>Request</h2>
|
13
|
+
<%= pretty_format(@exception.request) %>
|
14
|
+
|
15
|
+
<h2>Exception Message</h2>
|
16
|
+
<pre><%= simple_format @exception.message.gsub(/\\n/,"<br />") %></pre>
|
17
|
+
|
18
|
+
<h2>Backtrace</h2>
|
19
|
+
<pre id="backtrace">
|
20
|
+
<%= raw @exception.backtrace.gsub(/\n/,"<br />") %>
|
21
|
+
</pre>
|
22
|
+
|
23
|
+
<h2>Environment</h2>
|
24
|
+
<pre><%= simple_format(@exception.environment) %></pre>
|
25
|
+
|
26
|
+
<style>
|
27
|
+
pre {
|
28
|
+
overflow: scroll;
|
29
|
+
background: #fff;
|
30
|
+
border: 3px solid #e4e4e4;
|
31
|
+
padding: 20px;
|
32
|
+
}
|
33
|
+
</style>
|
@@ -0,0 +1,20 @@
|
|
1
|
+
xml.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
|
2
|
+
|
3
|
+
xml.rss "version" => "2.0" do
|
4
|
+
xml.channel do
|
5
|
+
xml.title "#{ExceptionLogger::LoggedExceptionsController.application_name}"
|
6
|
+
xml.link url_for(:only_path => false, :skip_relative_url_root => false)
|
7
|
+
xml.language "en-us"
|
8
|
+
xml.ttl "60"
|
9
|
+
|
10
|
+
@exceptions.each do |exc|
|
11
|
+
xml.item do
|
12
|
+
xml.title "#{exc.name} @ #{exc.created_at.rfc822}"
|
13
|
+
xml.description exc.message
|
14
|
+
xml.pubDate exc.created_at.rfc822
|
15
|
+
xml.guid [request.host_with_port, 'exceptions', exc.id.to_s].join(":"), "isPermaLink" => "false"
|
16
|
+
xml.link url_for(:action => 'index', :anchor => "e#{exc.id}", :only_path => false, :skip_relative_url_root => false)
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1,46 @@
|
|
1
|
+
<% page_title t(".title") %>
|
2
|
+
<div id="right">
|
3
|
+
<h3><%=t(".filters")%></h3>
|
4
|
+
<ul id="all_exceptions" class="filters">
|
5
|
+
<li><%= link_to t(".latest_exceptions"), :action => 'index', :id => nil %></li>
|
6
|
+
</ul>
|
7
|
+
<h4><%=t(".exception")%></h4>
|
8
|
+
<ul id="exception_names" class="filters">
|
9
|
+
<% @exception_names.each do |name| %>
|
10
|
+
<li><%= link_to name, {:action => 'query', :exception_names_filter => "#{name}"}, :class => 'filter_link' %></li>
|
11
|
+
<% end %>
|
12
|
+
</ul>
|
13
|
+
<h4><%=t(".controller_action")%></h4>
|
14
|
+
<ul id="controller_actions" class="filters">
|
15
|
+
<% @controller_actions.each do |action| %>
|
16
|
+
<li><%= link_to action, {:action => 'query', :controller_actions_filter => "#{action}"}, :class => 'filter_link' %></li>
|
17
|
+
<% end %>
|
18
|
+
</ul>
|
19
|
+
<h4><%=t(".dates")%></h4>
|
20
|
+
<ul id="date_ranges" class="filters">
|
21
|
+
<li><%= link_to t(".today"), {:action => 'query', :date_ranges_filter => "1"}, :title => "1", :class => 'filter_link' %></li>
|
22
|
+
<li><%= link_to t(".last_few_days"), {:action => 'query', :date_ranges_filter => "3"}, :title => "3", :class => 'filter_link' %></li>
|
23
|
+
<li><%= link_to t(".last_7_days"), {:action => 'query', :date_ranges_filter => "7"}, :title => "7", :class => 'filter_link' %></li>
|
24
|
+
<li><%= link_to t(".last_30_days"), {:action => 'query', :date_ranges_filter => "30"}, :title => "30", :class => 'filter_link' %></li>
|
25
|
+
</ul>
|
26
|
+
<div id="search">
|
27
|
+
<%= form_tag "logged_exceptions/query", :id => 'query-form' %>
|
28
|
+
<div>
|
29
|
+
<%= text_field_tag :query, "", :size => 17 %>
|
30
|
+
<%= submit_tag :Find %>
|
31
|
+
<%= hidden_field_tag :exception_names_filter %>
|
32
|
+
<%= hidden_field_tag :date_ranges_filter %>
|
33
|
+
<%= hidden_field_tag :controller_actions_filter %>
|
34
|
+
<%= hidden_field_tag :page, (params[:page] || 1) %>
|
35
|
+
</div>
|
36
|
+
</form>
|
37
|
+
</div>
|
38
|
+
<%= render :partial => 'feed' %>
|
39
|
+
</div> <!-- right -->
|
40
|
+
<div id="left">
|
41
|
+
<div class="page" id="showpage" style="display:none;"></div>
|
42
|
+
<div class="page">
|
43
|
+
<%= render :partial => "exceptions" %>
|
44
|
+
</div>
|
45
|
+
</div>
|
46
|
+
<div id="activity" style="display:none;">Busy...</div>
|
@@ -0,0 +1,20 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="UTF-8" />
|
5
|
+
<%= csrf_meta_tag %>
|
6
|
+
<title><%= yield(:title) || "Exception Logger" %></title>
|
7
|
+
|
8
|
+
<%= stylesheet_link_tag "exception_logger/application" %>
|
9
|
+
|
10
|
+
<%= auto_discovery_link_tag(:rss, {:action => "feed"}, {:title => "RSS Feed"}) %>
|
11
|
+
</head>
|
12
|
+
<body>
|
13
|
+
<div id="container">
|
14
|
+
<%= yield %>
|
15
|
+
</div>
|
16
|
+
<br style="clear:both" />
|
17
|
+
|
18
|
+
<%= javascript_include_tag "exception_logger/application" %>
|
19
|
+
</body>
|
20
|
+
</html>
|
@@ -0,0 +1,16 @@
|
|
1
|
+
en:
|
2
|
+
exception_logger:
|
3
|
+
logged_exceptions:
|
4
|
+
index:
|
5
|
+
title: Logged Exceptions
|
6
|
+
filters: Filters
|
7
|
+
latest_exceptions: Latest Exceptions
|
8
|
+
exception: Exception
|
9
|
+
controller_action: Controller / Action
|
10
|
+
dates: Dates
|
11
|
+
today: Today
|
12
|
+
last_few_days: Last few days
|
13
|
+
last_7_days: Last 7 days
|
14
|
+
last_30_days: Last 30 days
|
15
|
+
show:
|
16
|
+
title: Logged Exception
|
data/config/routes.rb
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
class CreateExceptionLoggerLoggedExceptions < ActiveRecord::Migration
|
2
|
+
def change
|
3
|
+
create_table :logged_exceptions, :force => true do |t|
|
4
|
+
t.string :exception_class
|
5
|
+
t.string :controller_name
|
6
|
+
t.string :action_name
|
7
|
+
t.text :message
|
8
|
+
t.text :backtrace
|
9
|
+
t.text :environment
|
10
|
+
t.text :request
|
11
|
+
t.datetime :created_at
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,90 @@
|
|
1
|
+
require 'exception_logger/engine'
|
2
|
+
require 'will_paginate'
|
3
|
+
require 'ipaddr'
|
4
|
+
|
5
|
+
module ExceptionLogger
|
6
|
+
# Copyright (c) 2005 Jamis Buck
|
7
|
+
#
|
8
|
+
# Permission is hereby granted, free of charge, to any person obtaining
|
9
|
+
# a copy of this software and associated documentation files (the
|
10
|
+
# "Software"), to deal in the Software without restriction, including
|
11
|
+
# without limitation the rights to use, copy, modify, merge, publish,
|
12
|
+
# distribute, sublicense, and/or sell copies of the Software, and to
|
13
|
+
# permit persons to whom the Software is furnished to do so, subject to
|
14
|
+
# the following conditions:
|
15
|
+
#
|
16
|
+
# The above copyright notice and this permission notice shall be
|
17
|
+
# included in all copies or substantial portions of the Software.
|
18
|
+
#
|
19
|
+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
20
|
+
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
21
|
+
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
22
|
+
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
23
|
+
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
24
|
+
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
25
|
+
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
26
|
+
module ExceptionLoggable
|
27
|
+
def self.included(target)
|
28
|
+
target.extend(ClassMethods)
|
29
|
+
target.class_attribute :local_addresses, :exception_data
|
30
|
+
|
31
|
+
target.local_addresses = [IPAddr.new("127.0.0.1")]
|
32
|
+
end
|
33
|
+
|
34
|
+
module ClassMethods
|
35
|
+
def consider_local(*args)
|
36
|
+
local_addresses.concat(args.flatten.map { |a| IPAddr.new(a) })
|
37
|
+
end
|
38
|
+
end
|
39
|
+
|
40
|
+
def local_request?
|
41
|
+
remote = IPAddr.new(request.remote_ip)
|
42
|
+
!self.class.local_addresses.detect { |addr| addr.include?(remote) }.nil?
|
43
|
+
end
|
44
|
+
|
45
|
+
# we log the exception and raise it again, for the normal handling.
|
46
|
+
def log_exception_handler(exception)
|
47
|
+
ignore_classes = ['ActionController::UnknownFormat']
|
48
|
+
log_exception(exception) if ignore_classes.exclude?(exception.class.name)
|
49
|
+
raise exception
|
50
|
+
end
|
51
|
+
|
52
|
+
def rescue_action(exception)
|
53
|
+
status = response_code_for_rescue(exception)
|
54
|
+
log_exception(exception) if %i[not_found not_acceptable unprocessable_entity].exclude?(status)
|
55
|
+
super
|
56
|
+
end
|
57
|
+
|
58
|
+
def filter_sub_parameters(params, rails_filter_parameters = nil)
|
59
|
+
params.each do |key, value|
|
60
|
+
if(value.class != Hash && value.class != ActiveSupport::HashWithIndifferentAccess)
|
61
|
+
params[key] = '[FILTERED]' if rails_filter_parameters && rails_filter_parameters.include?(key.to_sym)
|
62
|
+
else
|
63
|
+
params[key] = filter_sub_parameters(value)
|
64
|
+
end
|
65
|
+
end
|
66
|
+
params
|
67
|
+
end
|
68
|
+
|
69
|
+
def log_exception(exception)
|
70
|
+
deliverer = self.class.exception_data
|
71
|
+
data = case deliverer
|
72
|
+
when nil then {}
|
73
|
+
when Symbol then send(deliverer)
|
74
|
+
when Proc then deliverer.call(self)
|
75
|
+
end
|
76
|
+
|
77
|
+
rails_filter_parameters = defined?(::Rails) ? ::Rails.application.config.filter_parameters : []
|
78
|
+
|
79
|
+
request.parameters.each do |key, value|
|
80
|
+
if(value.class != Hash && value.class != ActiveSupport::HashWithIndifferentAccess)
|
81
|
+
self.request.parameters[key] = '[FILTERED]' if rails_filter_parameters.include?(key.to_sym)
|
82
|
+
else
|
83
|
+
self.request.parameters[key] = filter_sub_parameters(value, rails_filter_parameters)
|
84
|
+
end
|
85
|
+
end if rails_filter_parameters.any?
|
86
|
+
|
87
|
+
LoggedException.create_from_exception(self, exception, data)
|
88
|
+
end
|
89
|
+
end
|
90
|
+
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.
|
data/test/dummy/Rakefile
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
#!/usr/bin/env rake
|
2
|
+
# Add your own tasks in files placed in lib/tasks ending in .rake,
|
3
|
+
# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
|
4
|
+
|
5
|
+
require File.expand_path('../config/application', __FILE__)
|
6
|
+
|
7
|
+
Dummy::Application.load_tasks
|
@@ -0,0 +1,15 @@
|
|
1
|
+
// This is a manifest file that'll be compiled into application.js, which will include all the files
|
2
|
+
// listed below.
|
3
|
+
//
|
4
|
+
// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
|
5
|
+
// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
|
6
|
+
//
|
7
|
+
// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
|
8
|
+
// the compiled file.
|
9
|
+
//
|
10
|
+
// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
|
11
|
+
// GO AFTER THE REQUIRES BELOW.
|
12
|
+
//
|
13
|
+
//= require jquery
|
14
|
+
//= require jquery_ujs
|
15
|
+
//= require_tree .
|
@@ -0,0 +1,13 @@
|
|
1
|
+
/*
|
2
|
+
* This is a manifest file that'll be compiled into application.css, which will include all the files
|
3
|
+
* listed below.
|
4
|
+
*
|
5
|
+
* Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
|
6
|
+
* or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
|
7
|
+
*
|
8
|
+
* You're free to add application-wide styles to this file and they'll appear at the top of the
|
9
|
+
* compiled file, but it's generally better to create a new file per style scope.
|
10
|
+
*
|
11
|
+
*= require_self
|
12
|
+
*= require_tree .
|
13
|
+
*/
|