mongo_session_store-rails3 3.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (117) hide show
  1. data/.gitignore +6 -0
  2. data/Gemfile +32 -0
  3. data/README.md +128 -0
  4. data/Rakefile +49 -0
  5. data/VERSION +1 -0
  6. data/lib/mongo_session_store-rails3.rb +32 -0
  7. data/lib/mongo_session_store/mongo_mapper_store.rb +20 -0
  8. data/lib/mongo_session_store/mongo_store.rb +80 -0
  9. data/lib/mongo_session_store/mongo_store_base.rb +77 -0
  10. data/lib/mongo_session_store/mongoid_store.rb +34 -0
  11. data/mongo_session_store-rails3.gemspec +16 -0
  12. data/perf/benchmark.rb +93 -0
  13. data/spec/integration_with_devise_spec.rb +84 -0
  14. data/spec/rails_3.0_app/.gitignore +4 -0
  15. data/spec/rails_3.0_app/README +256 -0
  16. data/spec/rails_3.0_app/Rakefile +7 -0
  17. data/spec/rails_3.0_app/app/controllers/application_controller.rb +3 -0
  18. data/spec/rails_3.0_app/app/controllers/home_controller.rb +4 -0
  19. data/spec/rails_3.0_app/app/helpers/application_helper.rb +2 -0
  20. data/spec/rails_3.0_app/app/models/user.rb +8 -0
  21. data/spec/rails_3.0_app/app/views/devise/confirmations/new.html.erb +12 -0
  22. data/spec/rails_3.0_app/app/views/devise/mailer/confirmation_instructions.html.erb +5 -0
  23. data/spec/rails_3.0_app/app/views/devise/mailer/reset_password_instructions.html.erb +8 -0
  24. data/spec/rails_3.0_app/app/views/devise/mailer/unlock_instructions.html.erb +7 -0
  25. data/spec/rails_3.0_app/app/views/devise/passwords/edit.html.erb +16 -0
  26. data/spec/rails_3.0_app/app/views/devise/passwords/new.html.erb +12 -0
  27. data/spec/rails_3.0_app/app/views/devise/registrations/edit.html.erb +25 -0
  28. data/spec/rails_3.0_app/app/views/devise/registrations/new.html.erb +18 -0
  29. data/spec/rails_3.0_app/app/views/devise/sessions/new.html.erb +17 -0
  30. data/spec/rails_3.0_app/app/views/devise/shared/_links.erb +25 -0
  31. data/spec/rails_3.0_app/app/views/devise/unlocks/new.html.erb +12 -0
  32. data/spec/rails_3.0_app/app/views/home/index.html.erb +10 -0
  33. data/spec/rails_3.0_app/app/views/layouts/application.html.erb +15 -0
  34. data/spec/rails_3.0_app/config.ru +4 -0
  35. data/spec/rails_3.0_app/config/application.rb +47 -0
  36. data/spec/rails_3.0_app/config/boot.rb +6 -0
  37. data/spec/rails_3.0_app/config/environment.rb +5 -0
  38. data/spec/rails_3.0_app/config/environments/development.rb +26 -0
  39. data/spec/rails_3.0_app/config/environments/production.rb +49 -0
  40. data/spec/rails_3.0_app/config/environments/test.rb +35 -0
  41. data/spec/rails_3.0_app/config/initializers/backtrace_silencers.rb +7 -0
  42. data/spec/rails_3.0_app/config/initializers/devise.rb +204 -0
  43. data/spec/rails_3.0_app/config/initializers/inflections.rb +10 -0
  44. data/spec/rails_3.0_app/config/initializers/mime_types.rb +5 -0
  45. data/spec/rails_3.0_app/config/initializers/secret_token.rb +7 -0
  46. data/spec/rails_3.0_app/config/initializers/session_store.rb +8 -0
  47. data/spec/rails_3.0_app/config/locales/devise.en.yml +53 -0
  48. data/spec/rails_3.0_app/config/locales/en.yml +5 -0
  49. data/spec/rails_3.0_app/config/mongo.yml +18 -0
  50. data/spec/rails_3.0_app/config/mongoid.yml +20 -0
  51. data/spec/rails_3.0_app/config/routes.rb +4 -0
  52. data/spec/rails_3.0_app/lib/tasks/.gitkeep +0 -0
  53. data/spec/rails_3.0_app/public/404.html +26 -0
  54. data/spec/rails_3.0_app/public/422.html +26 -0
  55. data/spec/rails_3.0_app/public/500.html +26 -0
  56. data/spec/rails_3.0_app/public/favicon.ico +0 -0
  57. data/spec/rails_3.0_app/public/javascripts/.gitkeep +0 -0
  58. data/spec/rails_3.0_app/public/javascripts/application.js +0 -0
  59. data/spec/rails_3.0_app/public/robots.txt +5 -0
  60. data/spec/rails_3.0_app/public/stylesheets/.gitkeep +0 -0
  61. data/spec/rails_3.0_app/script/rails +6 -0
  62. data/spec/rails_3.0_app/vendor/plugins/.gitkeep +0 -0
  63. data/spec/rails_3.1_app/.gitignore +5 -0
  64. data/spec/rails_3.1_app/README +261 -0
  65. data/spec/rails_3.1_app/Rakefile +7 -0
  66. data/spec/rails_3.1_app/app/assets/javascripts/application.js +7 -0
  67. data/spec/rails_3.1_app/app/assets/stylesheets/application.css +7 -0
  68. data/spec/rails_3.1_app/app/controllers/application_controller.rb +3 -0
  69. data/spec/rails_3.1_app/app/controllers/home_controller.rb +4 -0
  70. data/spec/rails_3.1_app/app/helpers/application_helper.rb +2 -0
  71. data/spec/rails_3.1_app/app/mailers/.gitkeep +0 -0
  72. data/spec/rails_3.1_app/app/models/.gitkeep +0 -0
  73. data/spec/rails_3.1_app/app/models/user.rb +8 -0
  74. data/spec/rails_3.1_app/app/views/devise/confirmations/new.html.erb +12 -0
  75. data/spec/rails_3.1_app/app/views/devise/mailer/confirmation_instructions.html.erb +5 -0
  76. data/spec/rails_3.1_app/app/views/devise/mailer/reset_password_instructions.html.erb +8 -0
  77. data/spec/rails_3.1_app/app/views/devise/mailer/unlock_instructions.html.erb +7 -0
  78. data/spec/rails_3.1_app/app/views/devise/passwords/edit.html.erb +16 -0
  79. data/spec/rails_3.1_app/app/views/devise/passwords/new.html.erb +12 -0
  80. data/spec/rails_3.1_app/app/views/devise/registrations/edit.html.erb +25 -0
  81. data/spec/rails_3.1_app/app/views/devise/registrations/new.html.erb +18 -0
  82. data/spec/rails_3.1_app/app/views/devise/sessions/new.html.erb +17 -0
  83. data/spec/rails_3.1_app/app/views/devise/shared/_links.erb +25 -0
  84. data/spec/rails_3.1_app/app/views/devise/unlocks/new.html.erb +12 -0
  85. data/spec/rails_3.1_app/app/views/home/index.html.erb +10 -0
  86. data/spec/rails_3.1_app/app/views/layouts/application.html.erb +15 -0
  87. data/spec/rails_3.1_app/config.ru +4 -0
  88. data/spec/rails_3.1_app/config/application.rb +47 -0
  89. data/spec/rails_3.1_app/config/boot.rb +6 -0
  90. data/spec/rails_3.1_app/config/environment.rb +5 -0
  91. data/spec/rails_3.1_app/config/environments/development.rb +27 -0
  92. data/spec/rails_3.1_app/config/environments/production.rb +54 -0
  93. data/spec/rails_3.1_app/config/environments/test.rb +39 -0
  94. data/spec/rails_3.1_app/config/initializers/backtrace_silencers.rb +7 -0
  95. data/spec/rails_3.1_app/config/initializers/devise.rb +204 -0
  96. data/spec/rails_3.1_app/config/initializers/inflections.rb +10 -0
  97. data/spec/rails_3.1_app/config/initializers/mime_types.rb +5 -0
  98. data/spec/rails_3.1_app/config/initializers/secret_token.rb +7 -0
  99. data/spec/rails_3.1_app/config/initializers/session_store.rb +8 -0
  100. data/spec/rails_3.1_app/config/initializers/wrap_parameters.rb +12 -0
  101. data/spec/rails_3.1_app/config/locales/devise.en.yml +53 -0
  102. data/spec/rails_3.1_app/config/locales/en.yml +5 -0
  103. data/spec/rails_3.1_app/config/mongo.yml +18 -0
  104. data/spec/rails_3.1_app/config/mongoid.yml +20 -0
  105. data/spec/rails_3.1_app/config/routes.rb +4 -0
  106. data/spec/rails_3.1_app/lib/tasks/.gitkeep +0 -0
  107. data/spec/rails_3.1_app/log/.gitkeep +0 -0
  108. data/spec/rails_3.1_app/public/404.html +26 -0
  109. data/spec/rails_3.1_app/public/422.html +26 -0
  110. data/spec/rails_3.1_app/public/500.html +26 -0
  111. data/spec/rails_3.1_app/public/favicon.ico +0 -0
  112. data/spec/rails_3.1_app/public/robots.txt +5 -0
  113. data/spec/rails_3.1_app/script/rails +6 -0
  114. data/spec/rails_3.1_app/vendor/assets/stylesheets/.gitkeep +0 -0
  115. data/spec/rails_3.1_app/vendor/plugins/.gitkeep +0 -0
  116. data/spec/spec_helper.rb +33 -0
  117. metadata +318 -0
@@ -0,0 +1,10 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Add new inflection rules using the following format
4
+ # (all these examples are active by default):
5
+ # ActiveSupport::Inflector.inflections do |inflect|
6
+ # inflect.plural /^(ox)$/i, '\1en'
7
+ # inflect.singular /^(ox)en/i, '\1'
8
+ # inflect.irregular 'person', 'people'
9
+ # inflect.uncountable %w( fish sheep )
10
+ # end
@@ -0,0 +1,5 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Add new mime types for use in respond_to blocks:
4
+ # Mime::Type.register "text/richtext", :rtf
5
+ # Mime::Type.register_alias "text/html", :iphone
@@ -0,0 +1,7 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Your secret key for verifying the integrity of signed cookies.
4
+ # If you change this key, all old signed cookies will become invalid!
5
+ # Make sure the secret is at least 30 characters and all random,
6
+ # no regular words or you'll be exposed to dictionary attacks.
7
+ Rails30App::Application.config.secret_token = 'a0e9004e4e8e865a46e229c63a4df1cc2b25b79103f140b5bc21f8edce46f87547865c01e4392b83a60449c03effce34cf0e53fc7f8af5f9736c4f9aaa436605'
@@ -0,0 +1,8 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Rails30App::Application.config.session_store :cookie_store, :key => '_rails_3.0_app_session'
4
+
5
+ # Use the database for sessions instead of the cookie-based default,
6
+ # which shouldn't be used to store highly confidential information
7
+ # (create the session table with "rails generate session_migration")
8
+ Rails30App::Application.config.session_store :"#{ENV['MONGO_SESSION_STORE_ORM']}_store"
@@ -0,0 +1,53 @@
1
+ # Additional translations at http://github.com/plataformatec/devise/wiki/I18n
2
+
3
+ en:
4
+ errors:
5
+ messages:
6
+ expired: "has expired, please request a new one"
7
+ not_found: "not found"
8
+ already_confirmed: "was already confirmed, please try signing in"
9
+ not_locked: "was not locked"
10
+ not_saved:
11
+ one: "1 error prohibited this %{resource} from being saved:"
12
+ other: "%{count} errors prohibited this %{resource} from being saved:"
13
+
14
+ devise:
15
+ failure:
16
+ already_authenticated: 'You are already signed in.'
17
+ unauthenticated: 'You need to sign in or sign up before continuing.'
18
+ unconfirmed: 'You have to confirm your account before continuing.'
19
+ locked: 'Your account is locked.'
20
+ invalid: 'Invalid email or password.'
21
+ invalid_token: 'Invalid authentication token.'
22
+ timeout: 'Your session expired, please sign in again to continue.'
23
+ inactive: 'Your account was not activated yet.'
24
+ sessions:
25
+ signed_in: 'Signed in successfully.'
26
+ signed_out: 'Signed out successfully.'
27
+ passwords:
28
+ send_instructions: 'You will receive an email with instructions about how to reset your password in a few minutes.'
29
+ updated: 'Your password was changed successfully. You are now signed in.'
30
+ send_paranoid_instructions: "If your e-mail exists on our database, you will receive a password recovery link on your e-mail"
31
+ confirmations:
32
+ send_instructions: 'You will receive an email with instructions about how to confirm your account in a few minutes.'
33
+ send_paranoid_instructions: 'If your e-mail exists on our database, you will receive an email with instructions about how to confirm your account in a few minutes.'
34
+ confirmed: 'Your account was successfully confirmed. You are now signed in.'
35
+ registrations:
36
+ signed_up: 'Welcome! You have signed up successfully.'
37
+ inactive_signed_up: 'You have signed up successfully. However, we could not sign you in because your account is %{reason}.'
38
+ updated: 'You updated your account successfully.'
39
+ destroyed: 'Bye! Your account was successfully cancelled. We hope to see you again soon.'
40
+ unlocks:
41
+ send_instructions: 'You will receive an email with instructions about how to unlock your account in a few minutes.'
42
+ unlocked: 'Your account was successfully unlocked. You are now signed in.'
43
+ send_paranoid_instructions: 'If your account exists, you will receive an email with instructions about how to unlock it in a few minutes.'
44
+ omniauth_callbacks:
45
+ success: 'Successfully authorized from %{kind} account.'
46
+ failure: 'Could not authorize you from %{kind} because "%{reason}".'
47
+ mailer:
48
+ confirmation_instructions:
49
+ subject: 'Confirmation instructions'
50
+ reset_password_instructions:
51
+ subject: 'Reset password instructions'
52
+ unlock_instructions:
53
+ subject: 'Unlock Instructions'
@@ -0,0 +1,5 @@
1
+ # Sample localization file for English. Add more files in this directory for other locales.
2
+ # See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
3
+
4
+ en:
5
+ hello: "Hello world"
@@ -0,0 +1,18 @@
1
+ defaults: &defaults
2
+ host: 127.0.0.1
3
+ port: 27017
4
+
5
+ development:
6
+ <<: *defaults
7
+ database: rails30_app_development
8
+
9
+ test:
10
+ <<: *defaults
11
+ database: rails30_app_test
12
+
13
+ # set these environment variables on your prod server
14
+ production:
15
+ <<: *defaults
16
+ database: rails30_app
17
+ username: <%= ENV['MONGO_USERNAME'] %>
18
+ password: <%= ENV['MONGO_PASSWORD'] %>
@@ -0,0 +1,20 @@
1
+ development:
2
+ host: localhost
3
+ database: rails30_app_development
4
+
5
+ test:
6
+ host: localhost
7
+ database: rails30_app_test
8
+
9
+ # set these environment variables on your prod server
10
+ production:
11
+ host: <%= ENV['MONGOID_HOST'] %>
12
+ port: <%= ENV['MONGOID_PORT'] %>
13
+ username: <%= ENV['MONGOID_USERNAME'] %>
14
+ password: <%= ENV['MONGOID_PASSWORD'] %>
15
+ database: <%= ENV['MONGOID_DATABASE'] %>
16
+ # slaves:
17
+ # - host: slave1.local
18
+ # port: 27018
19
+ # - host: slave2.local
20
+ # port: 27019
@@ -0,0 +1,4 @@
1
+ Rails30App::Application.routes.draw do
2
+ devise_for :users
3
+ root :to => "home#index"
4
+ end
File without changes
@@ -0,0 +1,26 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>The page you were looking for doesn't exist (404)</title>
5
+ <style type="text/css">
6
+ body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
7
+ div.dialog {
8
+ width: 25em;
9
+ padding: 0 4em;
10
+ margin: 4em auto 0 auto;
11
+ border: 1px solid #ccc;
12
+ border-right-color: #999;
13
+ border-bottom-color: #999;
14
+ }
15
+ h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
16
+ </style>
17
+ </head>
18
+
19
+ <body>
20
+ <!-- This file lives in public/404.html -->
21
+ <div class="dialog">
22
+ <h1>The page you were looking for doesn't exist.</h1>
23
+ <p>You may have mistyped the address or the page may have moved.</p>
24
+ </div>
25
+ </body>
26
+ </html>
@@ -0,0 +1,26 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>The change you wanted was rejected (422)</title>
5
+ <style type="text/css">
6
+ body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
7
+ div.dialog {
8
+ width: 25em;
9
+ padding: 0 4em;
10
+ margin: 4em auto 0 auto;
11
+ border: 1px solid #ccc;
12
+ border-right-color: #999;
13
+ border-bottom-color: #999;
14
+ }
15
+ h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
16
+ </style>
17
+ </head>
18
+
19
+ <body>
20
+ <!-- This file lives in public/422.html -->
21
+ <div class="dialog">
22
+ <h1>The change you wanted was rejected.</h1>
23
+ <p>Maybe you tried to change something you didn't have access to.</p>
24
+ </div>
25
+ </body>
26
+ </html>
@@ -0,0 +1,26 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>We're sorry, but something went wrong (500)</title>
5
+ <style type="text/css">
6
+ body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
7
+ div.dialog {
8
+ width: 25em;
9
+ padding: 0 4em;
10
+ margin: 4em auto 0 auto;
11
+ border: 1px solid #ccc;
12
+ border-right-color: #999;
13
+ border-bottom-color: #999;
14
+ }
15
+ h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
16
+ </style>
17
+ </head>
18
+
19
+ <body>
20
+ <!-- This file lives in public/500.html -->
21
+ <div class="dialog">
22
+ <h1>We're sorry, but something went wrong.</h1>
23
+ <p>We've been notified about this issue and we'll take a look at it shortly.</p>
24
+ </div>
25
+ </body>
26
+ </html>
File without changes
File without changes
@@ -0,0 +1,5 @@
1
+ # See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
2
+ #
3
+ # To ban all spiders from the entire site uncomment the next two lines:
4
+ # User-Agent: *
5
+ # Disallow: /
File without changes
@@ -0,0 +1,6 @@
1
+ #!/usr/bin/env ruby
2
+ # This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
3
+
4
+ APP_PATH = File.expand_path('../../config/application', __FILE__)
5
+ require File.expand_path('../../config/boot', __FILE__)
6
+ require 'rails/commands'
File without changes
@@ -0,0 +1,5 @@
1
+ .bundle
2
+ db/*.sqlite3
3
+ log/*.log
4
+ tmp/
5
+ .sass-cache/
@@ -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.