mongo_session_store-rails3 3.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +6 -0
- data/Gemfile +32 -0
- data/README.md +128 -0
- data/Rakefile +49 -0
- data/VERSION +1 -0
- data/lib/mongo_session_store-rails3.rb +32 -0
- data/lib/mongo_session_store/mongo_mapper_store.rb +20 -0
- data/lib/mongo_session_store/mongo_store.rb +80 -0
- data/lib/mongo_session_store/mongo_store_base.rb +77 -0
- data/lib/mongo_session_store/mongoid_store.rb +34 -0
- data/mongo_session_store-rails3.gemspec +16 -0
- data/perf/benchmark.rb +93 -0
- data/spec/integration_with_devise_spec.rb +84 -0
- data/spec/rails_3.0_app/.gitignore +4 -0
- data/spec/rails_3.0_app/README +256 -0
- data/spec/rails_3.0_app/Rakefile +7 -0
- data/spec/rails_3.0_app/app/controllers/application_controller.rb +3 -0
- data/spec/rails_3.0_app/app/controllers/home_controller.rb +4 -0
- data/spec/rails_3.0_app/app/helpers/application_helper.rb +2 -0
- data/spec/rails_3.0_app/app/models/user.rb +8 -0
- data/spec/rails_3.0_app/app/views/devise/confirmations/new.html.erb +12 -0
- data/spec/rails_3.0_app/app/views/devise/mailer/confirmation_instructions.html.erb +5 -0
- data/spec/rails_3.0_app/app/views/devise/mailer/reset_password_instructions.html.erb +8 -0
- data/spec/rails_3.0_app/app/views/devise/mailer/unlock_instructions.html.erb +7 -0
- data/spec/rails_3.0_app/app/views/devise/passwords/edit.html.erb +16 -0
- data/spec/rails_3.0_app/app/views/devise/passwords/new.html.erb +12 -0
- data/spec/rails_3.0_app/app/views/devise/registrations/edit.html.erb +25 -0
- data/spec/rails_3.0_app/app/views/devise/registrations/new.html.erb +18 -0
- data/spec/rails_3.0_app/app/views/devise/sessions/new.html.erb +17 -0
- data/spec/rails_3.0_app/app/views/devise/shared/_links.erb +25 -0
- data/spec/rails_3.0_app/app/views/devise/unlocks/new.html.erb +12 -0
- data/spec/rails_3.0_app/app/views/home/index.html.erb +10 -0
- data/spec/rails_3.0_app/app/views/layouts/application.html.erb +15 -0
- data/spec/rails_3.0_app/config.ru +4 -0
- data/spec/rails_3.0_app/config/application.rb +47 -0
- data/spec/rails_3.0_app/config/boot.rb +6 -0
- data/spec/rails_3.0_app/config/environment.rb +5 -0
- data/spec/rails_3.0_app/config/environments/development.rb +26 -0
- data/spec/rails_3.0_app/config/environments/production.rb +49 -0
- data/spec/rails_3.0_app/config/environments/test.rb +35 -0
- data/spec/rails_3.0_app/config/initializers/backtrace_silencers.rb +7 -0
- data/spec/rails_3.0_app/config/initializers/devise.rb +204 -0
- data/spec/rails_3.0_app/config/initializers/inflections.rb +10 -0
- data/spec/rails_3.0_app/config/initializers/mime_types.rb +5 -0
- data/spec/rails_3.0_app/config/initializers/secret_token.rb +7 -0
- data/spec/rails_3.0_app/config/initializers/session_store.rb +8 -0
- data/spec/rails_3.0_app/config/locales/devise.en.yml +53 -0
- data/spec/rails_3.0_app/config/locales/en.yml +5 -0
- data/spec/rails_3.0_app/config/mongo.yml +18 -0
- data/spec/rails_3.0_app/config/mongoid.yml +20 -0
- data/spec/rails_3.0_app/config/routes.rb +4 -0
- data/spec/rails_3.0_app/lib/tasks/.gitkeep +0 -0
- data/spec/rails_3.0_app/public/404.html +26 -0
- data/spec/rails_3.0_app/public/422.html +26 -0
- data/spec/rails_3.0_app/public/500.html +26 -0
- data/spec/rails_3.0_app/public/favicon.ico +0 -0
- data/spec/rails_3.0_app/public/javascripts/.gitkeep +0 -0
- data/spec/rails_3.0_app/public/javascripts/application.js +0 -0
- data/spec/rails_3.0_app/public/robots.txt +5 -0
- data/spec/rails_3.0_app/public/stylesheets/.gitkeep +0 -0
- data/spec/rails_3.0_app/script/rails +6 -0
- data/spec/rails_3.0_app/vendor/plugins/.gitkeep +0 -0
- data/spec/rails_3.1_app/.gitignore +5 -0
- data/spec/rails_3.1_app/README +261 -0
- data/spec/rails_3.1_app/Rakefile +7 -0
- data/spec/rails_3.1_app/app/assets/javascripts/application.js +7 -0
- data/spec/rails_3.1_app/app/assets/stylesheets/application.css +7 -0
- data/spec/rails_3.1_app/app/controllers/application_controller.rb +3 -0
- data/spec/rails_3.1_app/app/controllers/home_controller.rb +4 -0
- data/spec/rails_3.1_app/app/helpers/application_helper.rb +2 -0
- data/spec/rails_3.1_app/app/mailers/.gitkeep +0 -0
- data/spec/rails_3.1_app/app/models/.gitkeep +0 -0
- data/spec/rails_3.1_app/app/models/user.rb +8 -0
- data/spec/rails_3.1_app/app/views/devise/confirmations/new.html.erb +12 -0
- data/spec/rails_3.1_app/app/views/devise/mailer/confirmation_instructions.html.erb +5 -0
- data/spec/rails_3.1_app/app/views/devise/mailer/reset_password_instructions.html.erb +8 -0
- data/spec/rails_3.1_app/app/views/devise/mailer/unlock_instructions.html.erb +7 -0
- data/spec/rails_3.1_app/app/views/devise/passwords/edit.html.erb +16 -0
- data/spec/rails_3.1_app/app/views/devise/passwords/new.html.erb +12 -0
- data/spec/rails_3.1_app/app/views/devise/registrations/edit.html.erb +25 -0
- data/spec/rails_3.1_app/app/views/devise/registrations/new.html.erb +18 -0
- data/spec/rails_3.1_app/app/views/devise/sessions/new.html.erb +17 -0
- data/spec/rails_3.1_app/app/views/devise/shared/_links.erb +25 -0
- data/spec/rails_3.1_app/app/views/devise/unlocks/new.html.erb +12 -0
- data/spec/rails_3.1_app/app/views/home/index.html.erb +10 -0
- data/spec/rails_3.1_app/app/views/layouts/application.html.erb +15 -0
- data/spec/rails_3.1_app/config.ru +4 -0
- data/spec/rails_3.1_app/config/application.rb +47 -0
- data/spec/rails_3.1_app/config/boot.rb +6 -0
- data/spec/rails_3.1_app/config/environment.rb +5 -0
- data/spec/rails_3.1_app/config/environments/development.rb +27 -0
- data/spec/rails_3.1_app/config/environments/production.rb +54 -0
- data/spec/rails_3.1_app/config/environments/test.rb +39 -0
- data/spec/rails_3.1_app/config/initializers/backtrace_silencers.rb +7 -0
- data/spec/rails_3.1_app/config/initializers/devise.rb +204 -0
- data/spec/rails_3.1_app/config/initializers/inflections.rb +10 -0
- data/spec/rails_3.1_app/config/initializers/mime_types.rb +5 -0
- data/spec/rails_3.1_app/config/initializers/secret_token.rb +7 -0
- data/spec/rails_3.1_app/config/initializers/session_store.rb +8 -0
- data/spec/rails_3.1_app/config/initializers/wrap_parameters.rb +12 -0
- data/spec/rails_3.1_app/config/locales/devise.en.yml +53 -0
- data/spec/rails_3.1_app/config/locales/en.yml +5 -0
- data/spec/rails_3.1_app/config/mongo.yml +18 -0
- data/spec/rails_3.1_app/config/mongoid.yml +20 -0
- data/spec/rails_3.1_app/config/routes.rb +4 -0
- data/spec/rails_3.1_app/lib/tasks/.gitkeep +0 -0
- data/spec/rails_3.1_app/log/.gitkeep +0 -0
- data/spec/rails_3.1_app/public/404.html +26 -0
- data/spec/rails_3.1_app/public/422.html +26 -0
- data/spec/rails_3.1_app/public/500.html +26 -0
- data/spec/rails_3.1_app/public/favicon.ico +0 -0
- data/spec/rails_3.1_app/public/robots.txt +5 -0
- data/spec/rails_3.1_app/script/rails +6 -0
- data/spec/rails_3.1_app/vendor/assets/stylesheets/.gitkeep +0 -0
- data/spec/rails_3.1_app/vendor/plugins/.gitkeep +0 -0
- data/spec/spec_helper.rb +33 -0
- metadata +318 -0
@@ -0,0 +1,16 @@
|
|
1
|
+
Gem::Specification.new do |s|
|
2
|
+
s.name = "mongo_session_store-rails3"
|
3
|
+
s.version = `cat VERSION`.strip
|
4
|
+
|
5
|
+
s.authors = ["Brian Hempel", "Nicolas M\303\251rouze", "Tony Pitale", "Chris Brickley"]
|
6
|
+
s.email = ["plasticchicken@gmail.com"]
|
7
|
+
s.files = `git ls-files`.split("\n")
|
8
|
+
s.test_files = `git ls-files -- {test,spec,features,perf}/*`.split("\n")
|
9
|
+
s.homepage = "http://github.com/brianhempel/mongo_session_store"
|
10
|
+
s.require_paths = ["lib"]
|
11
|
+
s.rubygems_version = "1.3.7"
|
12
|
+
s.summary = "Rails 3.0 and 3.1 session stores for MongoMapper, Mongoid, or any other ODM."
|
13
|
+
|
14
|
+
s.add_dependency "mongo"
|
15
|
+
s.add_dependency "actionpack", ">= 3.0"
|
16
|
+
end
|
data/perf/benchmark.rb
ADDED
@@ -0,0 +1,93 @@
|
|
1
|
+
require 'benchmark'
|
2
|
+
require 'rubygems'
|
3
|
+
require 'bundler/setup'
|
4
|
+
|
5
|
+
Bundler.require(:development)
|
6
|
+
|
7
|
+
require 'action_dispatch'
|
8
|
+
require File.join(File.dirname(__FILE__),'..','lib','mongo_session_store')
|
9
|
+
|
10
|
+
MongoMapper.database = "test_session_stores"
|
11
|
+
Mongoid.database = Mongo::Connection.new.db("test_session_stores")
|
12
|
+
|
13
|
+
RUNS = 2000
|
14
|
+
|
15
|
+
def benchmark(test_name, &block)
|
16
|
+
time = Benchmark.realtime do
|
17
|
+
RUNS.times do
|
18
|
+
yield
|
19
|
+
end
|
20
|
+
end
|
21
|
+
puts "#{(time/RUNS*100_000).round / 100.0}ms per #{test_name}"
|
22
|
+
end
|
23
|
+
|
24
|
+
def benchmark_store(store)
|
25
|
+
collection = store.class.session_class.collection
|
26
|
+
collection.remove
|
27
|
+
|
28
|
+
large_session = {
|
29
|
+
:something => "not nothing",
|
30
|
+
:left => "not right",
|
31
|
+
:welcome => "not despised",
|
32
|
+
:visits => [
|
33
|
+
"http://www.google.com",
|
34
|
+
"localhost:3000",
|
35
|
+
"http://localhost:3000/increment_session",
|
36
|
+
"http://www.iso.org/iso/country_codes/iso_3166_code_lists/iso-3166-1_decoding_table.htm",
|
37
|
+
"http://www.geonames.org/search.html?q=2303+australia&country="
|
38
|
+
],
|
39
|
+
:one_k_of_data => "a"*1024,
|
40
|
+
:another_k => "b"*1024,
|
41
|
+
:more_data => [5]*500,
|
42
|
+
:too_much_data_for_a_cookie => "c"*8000,
|
43
|
+
:a_bunch_of_floats_in_embedded_docs => [{:float_a => 3.141, :float_b => -1.1}]*100
|
44
|
+
}
|
45
|
+
|
46
|
+
ids = []
|
47
|
+
|
48
|
+
env = {
|
49
|
+
'rack.session' => large_session,
|
50
|
+
'rack.session.options' => { :id => store.send(:generate_sid) }
|
51
|
+
}
|
52
|
+
benchmark "session save" do
|
53
|
+
id = store.send(:generate_sid)
|
54
|
+
ids << id
|
55
|
+
store.send(:set_session, env.merge({'rack.session.options' => { :id => id }}), id, env['rack.session'])
|
56
|
+
# store.send(:commit_session, env.merge({'rack.session.options' => { :id => ids.last }}), 200, {}, [])
|
57
|
+
end
|
58
|
+
|
59
|
+
ids.shuffle!
|
60
|
+
|
61
|
+
env = {
|
62
|
+
'rack.request.cookie_string' => "",
|
63
|
+
'HTTP_COOKIE' => "",
|
64
|
+
'rack.request.cookie_hash' => { '_session_id' => store.class.session_class.last._id }
|
65
|
+
}
|
66
|
+
benchmark "session load" do
|
67
|
+
id = ids.pop
|
68
|
+
local_env = env.merge({'rack.request.cookie_hash' => { '_session_id' => id }})
|
69
|
+
# store.send(:prepare_session, local_env)
|
70
|
+
sid, data = store.send(:get_session, local_env, id)
|
71
|
+
# something = local_env['rack.session']["something"] # trigger the load
|
72
|
+
raise data.inspect unless data[:something] == "not nothing" && data[:a_bunch_of_floats_in_embedded_docs][0] == {:float_a => 3.141, :float_b => -1.1}
|
73
|
+
end
|
74
|
+
|
75
|
+
stats = collection.stats
|
76
|
+
puts " Total Size: #{stats['size']}"
|
77
|
+
puts " Object count: #{stats['count']}"
|
78
|
+
puts " Average object size: #{stats['avgObjSize']}"
|
79
|
+
puts " Index sizes: #{stats['indexSizes'].inspect}"
|
80
|
+
end
|
81
|
+
|
82
|
+
mongo_mapper_store = ActionDispatch::Session::MongoMapperStore.new(nil)
|
83
|
+
mongoid_store = ActionDispatch::Session::MongoidStore.new(nil)
|
84
|
+
mongo_store = ActionDispatch::Session::MongoStore.new(nil)
|
85
|
+
|
86
|
+
puts "MongoMapperStore..."
|
87
|
+
benchmark_store(mongo_mapper_store)
|
88
|
+
|
89
|
+
puts "MongoidStore..."
|
90
|
+
benchmark_store(mongoid_store)
|
91
|
+
|
92
|
+
puts "MongoStore..."
|
93
|
+
benchmark_store(mongo_store)
|
@@ -0,0 +1,84 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
|
3
|
+
describe Devise::SessionsController do
|
4
|
+
def create_user
|
5
|
+
post_data = {
|
6
|
+
'user[email]' => 'person@example.com',
|
7
|
+
'user[password]' => 'secret',
|
8
|
+
'user[password_confirmation]' => 'secret'
|
9
|
+
}
|
10
|
+
post '/users', post_data
|
11
|
+
end
|
12
|
+
|
13
|
+
def login
|
14
|
+
post_data = {
|
15
|
+
'user[email]' => 'person@example.com',
|
16
|
+
'user[password]' => 'secret',
|
17
|
+
'user[password_confirmation]' => 'secret'
|
18
|
+
}
|
19
|
+
post '/users/sign_in', post_data
|
20
|
+
end
|
21
|
+
|
22
|
+
def logout
|
23
|
+
delete '/users/sign_out'
|
24
|
+
end
|
25
|
+
|
26
|
+
def i_should_be_logged_in
|
27
|
+
controller.user_signed_in?.should be_true
|
28
|
+
get '/'
|
29
|
+
response.body.squish.should =~ /You are logged in as person@example.com/
|
30
|
+
end
|
31
|
+
|
32
|
+
def i_should_not_be_logged_in
|
33
|
+
controller.user_signed_in?.should be_false
|
34
|
+
get '/'
|
35
|
+
response.body.squish.should =~ /You are logged out/
|
36
|
+
end
|
37
|
+
|
38
|
+
it "does not explode" do
|
39
|
+
end
|
40
|
+
|
41
|
+
it "allows user creation" do
|
42
|
+
create_user
|
43
|
+
response.status.should == 302
|
44
|
+
get response.redirect_url
|
45
|
+
response.body.squish.should =~ /You are logged in as person@example.com/
|
46
|
+
end
|
47
|
+
|
48
|
+
it "allows user logout" do
|
49
|
+
create_user
|
50
|
+
i_should_be_logged_in
|
51
|
+
logout
|
52
|
+
response.status.should == 302
|
53
|
+
i_should_not_be_logged_in
|
54
|
+
end
|
55
|
+
|
56
|
+
it "allows user login" do
|
57
|
+
create_user
|
58
|
+
logout
|
59
|
+
i_should_not_be_logged_in
|
60
|
+
login
|
61
|
+
response.status.should == 302
|
62
|
+
i_should_be_logged_in
|
63
|
+
end
|
64
|
+
|
65
|
+
it "uses the right session store class" do
|
66
|
+
store = Rails.application.config.session_store
|
67
|
+
store.session_class.to_s.should == "ActionDispatch::Session::#{ENV["MONGO_SESSION_STORE_ORM"].camelize}Store::Session"
|
68
|
+
end
|
69
|
+
|
70
|
+
it "stores the session in the sessions collection" do
|
71
|
+
collection = db["sessions"]
|
72
|
+
collection.count.should == 0
|
73
|
+
create_user
|
74
|
+
collection.count.should == 1
|
75
|
+
end
|
76
|
+
|
77
|
+
it "allows renaming of the collection that stores the sessions" do
|
78
|
+
collection = db["dance_parties"]
|
79
|
+
collection.count.should == 0
|
80
|
+
MongoSessionStore.collection_name = "dance_parties"
|
81
|
+
create_user
|
82
|
+
collection.count.should == 1
|
83
|
+
end
|
84
|
+
end
|
@@ -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.
|