mongo_session_store-rails3 3.0.2 → 3.0.3
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +3 -1
- data/Gemfile +8 -6
- data/README.md +10 -11
- data/Rakefile +18 -17
- data/VERSION +1 -1
- data/lib/mongo_session_store-rails3.rb +3 -3
- data/lib/mongo_session_store/mongo_mapper_store.rb +17 -21
- data/lib/mongo_session_store/mongoid_store.rb +20 -24
- data/mongo_session_store-rails3.gemspec +1 -1
- data/spec/rails_3.2_app/.gitignore +5 -0
- data/spec/rails_3.2_app/README +261 -0
- data/spec/rails_3.2_app/Rakefile +7 -0
- data/spec/rails_3.2_app/app/assets/javascripts/application.js +7 -0
- data/spec/rails_3.2_app/app/assets/stylesheets/application.css +7 -0
- data/spec/rails_3.2_app/app/controllers/application_controller.rb +3 -0
- data/spec/rails_3.2_app/app/controllers/home_controller.rb +4 -0
- data/spec/rails_3.2_app/app/helpers/application_helper.rb +2 -0
- data/spec/rails_3.2_app/app/mailers/.gitkeep +0 -0
- data/spec/rails_3.2_app/app/models/.gitkeep +0 -0
- data/spec/rails_3.2_app/app/models/user.rb +8 -0
- data/spec/rails_3.2_app/app/views/devise/confirmations/new.html.erb +12 -0
- data/spec/rails_3.2_app/app/views/devise/mailer/confirmation_instructions.html.erb +5 -0
- data/spec/rails_3.2_app/app/views/devise/mailer/reset_password_instructions.html.erb +8 -0
- data/spec/rails_3.2_app/app/views/devise/mailer/unlock_instructions.html.erb +7 -0
- data/spec/rails_3.2_app/app/views/devise/passwords/edit.html.erb +16 -0
- data/spec/rails_3.2_app/app/views/devise/passwords/new.html.erb +12 -0
- data/spec/rails_3.2_app/app/views/devise/registrations/edit.html.erb +25 -0
- data/spec/rails_3.2_app/app/views/devise/registrations/new.html.erb +18 -0
- data/spec/rails_3.2_app/app/views/devise/sessions/new.html.erb +17 -0
- data/spec/rails_3.2_app/app/views/devise/shared/_links.erb +25 -0
- data/spec/rails_3.2_app/app/views/devise/unlocks/new.html.erb +12 -0
- data/spec/rails_3.2_app/app/views/home/index.html.erb +10 -0
- data/spec/rails_3.2_app/app/views/layouts/application.html.erb +15 -0
- data/spec/rails_3.2_app/config.ru +4 -0
- data/spec/rails_3.2_app/config/application.rb +47 -0
- data/spec/rails_3.2_app/config/boot.rb +6 -0
- data/spec/rails_3.2_app/config/environment.rb +5 -0
- data/spec/rails_3.2_app/config/environments/development.rb +27 -0
- data/spec/rails_3.2_app/config/environments/production.rb +54 -0
- data/spec/rails_3.2_app/config/environments/test.rb +39 -0
- data/spec/rails_3.2_app/config/initializers/backtrace_silencers.rb +7 -0
- data/spec/rails_3.2_app/config/initializers/devise.rb +204 -0
- data/spec/rails_3.2_app/config/initializers/inflections.rb +10 -0
- data/spec/rails_3.2_app/config/initializers/mime_types.rb +5 -0
- data/spec/rails_3.2_app/config/initializers/secret_token.rb +7 -0
- data/spec/rails_3.2_app/config/initializers/session_store.rb +8 -0
- data/spec/rails_3.2_app/config/initializers/wrap_parameters.rb +12 -0
- data/spec/rails_3.2_app/config/locales/devise.en.yml +53 -0
- data/spec/rails_3.2_app/config/locales/en.yml +5 -0
- data/spec/rails_3.2_app/config/mongo.yml +18 -0
- data/spec/rails_3.2_app/config/mongoid.yml +20 -0
- data/spec/rails_3.2_app/config/routes.rb +4 -0
- data/spec/rails_3.2_app/lib/tasks/.gitkeep +0 -0
- data/spec/rails_3.2_app/log/.gitkeep +0 -0
- data/spec/rails_3.2_app/public/404.html +26 -0
- data/spec/rails_3.2_app/public/422.html +26 -0
- data/spec/rails_3.2_app/public/500.html +26 -0
- data/spec/rails_3.2_app/public/favicon.ico +0 -0
- data/spec/rails_3.2_app/public/robots.txt +5 -0
- data/spec/rails_3.2_app/script/rails +6 -0
- data/spec/rails_3.2_app/vendor/assets/stylesheets/.gitkeep +0 -0
- data/spec/rails_3.2_app/vendor/plugins/.gitkeep +0 -0
- metadata +112 -8
data/.gitignore
CHANGED
data/Gemfile
CHANGED
@@ -1,24 +1,26 @@
|
|
1
1
|
source :rubygems
|
2
2
|
|
3
|
-
MONGO_VERS = '1.
|
3
|
+
MONGO_VERS = '1.5.2' unless defined? MONGO_VERS
|
4
4
|
|
5
5
|
RAILS_VERS = case ENV['RAILS_VERS']
|
6
6
|
when '3.0'
|
7
|
-
'~>3.0'
|
7
|
+
'~>3.0.0'
|
8
8
|
when '3.1'
|
9
|
-
'
|
9
|
+
'~>3.1.0'
|
10
|
+
when '3.2'
|
11
|
+
'~>3.2.0'
|
10
12
|
when nil
|
11
13
|
nil
|
12
14
|
else
|
13
|
-
raise "Invalid RAILS_VERS. Available versions are 3.0 and 3.
|
15
|
+
raise "Invalid RAILS_VERS. Available versions are 3.0, 3.1, and 3.2."
|
14
16
|
end
|
15
17
|
|
16
18
|
gemspec
|
17
19
|
|
18
20
|
group :development, :test do
|
19
21
|
gem 'rake'
|
20
|
-
gem 'mongo_mapper', '>= 0.
|
21
|
-
gem 'mongoid', '>= 2.
|
22
|
+
gem 'mongo_mapper', '>= 0.10.1'
|
23
|
+
gem 'mongoid', '>= 2.2.5'
|
22
24
|
gem 'mongo', MONGO_VERS
|
23
25
|
gem 'bson_ext', MONGO_VERS
|
24
26
|
|
data/README.md
CHANGED
@@ -6,7 +6,7 @@ MongoSessionStore is a collection of Rails-compatible session stores for MongoMa
|
|
6
6
|
|
7
7
|
## Usage
|
8
8
|
|
9
|
-
MongoSessionStore is compatible with Rails 3.0 and 3.
|
9
|
+
MongoSessionStore is compatible with Rails 3.0, 3.1, and 3.2.
|
10
10
|
|
11
11
|
In your Gemfile:
|
12
12
|
|
@@ -19,17 +19,17 @@ In the session_store initializer (config/initializers/session_store.rb):
|
|
19
19
|
|
20
20
|
```ruby
|
21
21
|
# MongoMapper
|
22
|
-
MyApp::Application.config.session_store
|
22
|
+
MyApp::Application.config.session_store :mongo_mapper_store
|
23
23
|
|
24
24
|
# Mongoid
|
25
|
-
MyApp::Application.config.session_store
|
25
|
+
MyApp::Application.config.session_store :mongoid_store
|
26
26
|
|
27
27
|
# anything else
|
28
|
-
MyApp::Application.config.session_store
|
28
|
+
MyApp::Application.config.session_store :mongo_store
|
29
29
|
MongoStore::Session.database = Mongo::Connection.new.db('my_app_development')
|
30
30
|
```
|
31
31
|
|
32
|
-
Note: If you choose to use
|
32
|
+
Note: If you choose to use `:mongo_store` you only need to set its database if you aren't using MongoMapper or Mongoid in your project.
|
33
33
|
|
34
34
|
By default, the sessions will be stored in the "sessions" collection in MongoDB. If you want to use a different collection, you can set that in the initializer:
|
35
35
|
|
@@ -83,18 +83,17 @@ To run all the tests:
|
|
83
83
|
|
84
84
|
rake
|
85
85
|
|
86
|
-
To switch to the
|
86
|
+
To switch to the Gemfile.lock for a certain Rails version:
|
87
87
|
|
88
88
|
rake use_rails_30
|
89
|
-
|
90
|
-
To switch to the Rails 3.1 Gemfile.lock:
|
91
|
-
|
92
89
|
rake use_rails_31
|
90
|
+
rake use_rails_32
|
93
91
|
|
94
92
|
To run the tests for a specific store:
|
95
93
|
|
96
94
|
MONGO_SESSION_STORE_ORM=mongo_mapper bundle exec rspec spec
|
97
|
-
MONGO_SESSION_STORE_ORM=mongoid bundle exec rspec spec
|
95
|
+
MONGO_SESSION_STORE_ORM=mongoid bundle exec rspec spec
|
96
|
+
MONGO_SESSION_STORE_ORM=mongo bundle exec rspec spec
|
98
97
|
|
99
98
|
## Previous contributors
|
100
99
|
|
@@ -109,7 +108,7 @@ MongoSessionStore started as a fork of the DataMapper session store, modified to
|
|
109
108
|
|
110
109
|
## License
|
111
110
|
|
112
|
-
Copyright (c) 2011 Brian Hempel
|
111
|
+
Copyright (c) 2011-2012 Brian Hempel
|
113
112
|
Copyright (c) 2010 Nicolas Mérouze
|
114
113
|
Copyright (c) 2009 Chris Brickley
|
115
114
|
Copyright (c) 2009 Tony Pitale
|
data/Rakefile
CHANGED
@@ -9,7 +9,7 @@ end
|
|
9
9
|
|
10
10
|
def set_rails_version(rails_vers)
|
11
11
|
unless File.exists?("Gemfile_Rails_#{rails_vers}.lock")
|
12
|
-
run_with_output "export RAILS_VERS=#{rails_vers}; bundle update
|
12
|
+
run_with_output "export RAILS_VERS=#{rails_vers}; bundle update"
|
13
13
|
run_with_output "cp Gemfile.lock Gemfile_Rails_#{rails_vers}.lock"
|
14
14
|
else
|
15
15
|
run_with_output "rm Gemfile.lock"
|
@@ -17,6 +17,8 @@ def set_rails_version(rails_vers)
|
|
17
17
|
end
|
18
18
|
end
|
19
19
|
|
20
|
+
@rails_versions = ['3.0', '3.1', '3.2']
|
21
|
+
|
20
22
|
task :default => :test_all
|
21
23
|
|
22
24
|
desc 'Test each session store against Rails 3.0 and Rails 3.1'
|
@@ -24,26 +26,25 @@ task :test_all do
|
|
24
26
|
# inspired by http://pivotallabs.com/users/jdean/blog/articles/1728-testing-your-gem-against-multiple-rubies-and-rails-versions-with-rvm
|
25
27
|
|
26
28
|
orms = ['mongo_mapper', 'mongoid', 'mongo']
|
27
|
-
|
28
|
-
set_rails_version('3.0')
|
29
|
-
|
30
|
-
orms.each do |orm|
|
31
|
-
run_with_output "export MONGO_SESSION_STORE_ORM=#{orm}; bundle exec rspec spec"
|
32
|
-
end
|
33
29
|
|
34
|
-
|
30
|
+
@rails_versions.each do |rails_version|
|
31
|
+
|
32
|
+
set_rails_version(rails_version)
|
35
33
|
|
36
|
-
|
37
|
-
|
34
|
+
orms.each do |orm|
|
35
|
+
run_with_output "export MONGO_SESSION_STORE_ORM=#{orm}; bundle exec rspec spec"
|
36
|
+
end
|
37
|
+
|
38
38
|
end
|
39
39
|
end
|
40
40
|
|
41
|
-
desc 'Set Rails version to 3.0'
|
42
|
-
task :use_rails_30 do
|
43
|
-
set_rails_version('3.0')
|
44
|
-
end
|
45
41
|
|
46
|
-
|
47
|
-
|
48
|
-
|
42
|
+
|
43
|
+
@rails_versions.each do |rails_version|
|
44
|
+
|
45
|
+
desc "Set Rails version to #{rails_version}"
|
46
|
+
task :"use_rails_#{rails_version.gsub('.', '')}" do
|
47
|
+
set_rails_version(rails_version)
|
48
|
+
end
|
49
|
+
|
49
50
|
end
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
3.0.
|
1
|
+
3.0.3
|
@@ -27,6 +27,6 @@ module MongoSessionStore
|
|
27
27
|
self.collection_name = "sessions"
|
28
28
|
end
|
29
29
|
|
30
|
-
|
31
|
-
|
32
|
-
|
30
|
+
autoload :MongoMapperStore,'mongo_session_store/mongo_mapper_store'
|
31
|
+
autoload :MongoidStore, 'mongo_session_store/mongoid_store'
|
32
|
+
autoload :MongoStore, 'mongo_session_store/mongo_store'
|
@@ -1,26 +1,22 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
require 'mongo_session_store/mongo_store_base'
|
1
|
+
require 'mongo_mapper'
|
2
|
+
require 'mongo_session_store/mongo_store_base'
|
4
3
|
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
end
|
18
|
-
|
4
|
+
module ActionDispatch
|
5
|
+
module Session
|
6
|
+
class MongoMapperStore < MongoStoreBase
|
7
|
+
|
8
|
+
class Session
|
9
|
+
include MongoMapper::Document
|
10
|
+
set_collection_name MongoSessionStore.collection_name
|
11
|
+
|
12
|
+
key :_id, String
|
13
|
+
key :data, Binary, :default => Marshal.dump({})
|
14
|
+
|
15
|
+
timestamps!
|
19
16
|
end
|
17
|
+
|
20
18
|
end
|
21
19
|
end
|
20
|
+
end
|
22
21
|
|
23
|
-
|
24
|
-
|
25
|
-
rescue LoadError
|
26
|
-
end
|
22
|
+
MongoMapperStore = ActionDispatch::Session::MongoMapperStore
|
@@ -1,31 +1,27 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
require 'mongo_session_store/mongo_store_base'
|
1
|
+
require 'mongoid'
|
2
|
+
require 'mongo_session_store/mongo_store_base'
|
4
3
|
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
class Session
|
10
|
-
include Mongoid::Document
|
11
|
-
include Mongoid::Timestamps
|
12
|
-
self.collection_name = MongoSessionStore.collection_name
|
13
|
-
|
14
|
-
identity :type => String
|
4
|
+
module ActionDispatch
|
5
|
+
module Session
|
6
|
+
class MongoidStore < MongoStoreBase
|
15
7
|
|
16
|
-
|
17
|
-
|
8
|
+
class Session
|
9
|
+
include Mongoid::Document
|
10
|
+
include Mongoid::Timestamps
|
11
|
+
self.collection_name = MongoSessionStore.collection_name
|
18
12
|
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
13
|
+
identity :type => String
|
14
|
+
|
15
|
+
field :data, :type => BSON::Binary, :default => BSON::Binary.new(Marshal.dump({}))
|
16
|
+
end
|
17
|
+
|
18
|
+
private
|
19
|
+
def pack(data)
|
20
|
+
BSON::Binary.new(Marshal.dump(data))
|
24
21
|
end
|
22
|
+
|
25
23
|
end
|
26
24
|
end
|
27
|
-
|
28
|
-
MongoidStore = ActionDispatch::Session::MongoidStore
|
25
|
+
end
|
29
26
|
|
30
|
-
|
31
|
-
end
|
27
|
+
MongoidStore = ActionDispatch::Session::MongoidStore
|
@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
|
|
9
9
|
s.homepage = "http://github.com/brianhempel/mongo_session_store"
|
10
10
|
s.require_paths = ["lib"]
|
11
11
|
s.rubygems_version = "1.3.7"
|
12
|
-
s.summary = "Rails
|
12
|
+
s.summary = "Rails session stores for MongoMapper, Mongoid, or any other ODM. Rails 3.0, 3.1, and 3.2 compatible."
|
13
13
|
|
14
14
|
s.add_dependency "mongo"
|
15
15
|
s.add_dependency "actionpack", ">= 3.0"
|
@@ -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.
|