simple_contact 0.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (93) hide show
  1. checksums.yaml +7 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README.rdoc +3 -0
  4. data/Rakefile +40 -0
  5. data/app/assets/javascripts/simple_contact/application.js +15 -0
  6. data/app/assets/javascripts/simple_contact/contact.js +2 -0
  7. data/app/assets/stylesheets/simple_contact/application.css +13 -0
  8. data/app/assets/stylesheets/simple_contact/contact.css +4 -0
  9. data/app/controllers/simple_contact/application_controller.rb +5 -0
  10. data/app/controllers/simple_contact/contact_controller.rb +22 -0
  11. data/app/helpers/simple_contact/application_helper.rb +4 -0
  12. data/app/helpers/simple_contact/contact_helper.rb +4 -0
  13. data/app/mailers/simple_contact/contact_mailer.rb +8 -0
  14. data/app/models/simple_contact/message.rb +23 -0
  15. data/app/views/simple_contact/contact/new.html.erb +31 -0
  16. data/app/views/simple_contact/contact_mailer/contact_message.html.erb +9 -0
  17. data/config/locales/en.yml +15 -0
  18. data/config/routes.rb +4 -0
  19. data/lib/simple_contact/engine.rb +5 -0
  20. data/lib/simple_contact/version.rb +3 -0
  21. data/lib/simple_contact.rb +4 -0
  22. data/lib/tasks/simple_contact_tasks.rake +4 -0
  23. data/test/dummy/README.rdoc +261 -0
  24. data/test/dummy/Rakefile +7 -0
  25. data/test/dummy/app/assets/javascripts/application.js +15 -0
  26. data/test/dummy/app/assets/javascripts/home.js +2 -0
  27. data/test/dummy/app/assets/stylesheets/application.css +13 -0
  28. data/test/dummy/app/assets/stylesheets/home.css +4 -0
  29. data/test/dummy/app/controllers/application_controller.rb +3 -0
  30. data/test/dummy/app/controllers/home_controller.rb +4 -0
  31. data/test/dummy/app/helpers/application_helper.rb +2 -0
  32. data/test/dummy/app/helpers/home_helper.rb +2 -0
  33. data/test/dummy/app/views/home/index.html.erb +2 -0
  34. data/test/dummy/app/views/layouts/application.html.erb +22 -0
  35. data/test/dummy/config/application.rb +59 -0
  36. data/test/dummy/config/boot.rb +10 -0
  37. data/test/dummy/config/database.yml +25 -0
  38. data/test/dummy/config/environment.rb +5 -0
  39. data/test/dummy/config/environments/development.rb +37 -0
  40. data/test/dummy/config/environments/production.rb +67 -0
  41. data/test/dummy/config/environments/test.rb +37 -0
  42. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  43. data/test/dummy/config/initializers/inflections.rb +15 -0
  44. data/test/dummy/config/initializers/mime_types.rb +5 -0
  45. data/test/dummy/config/initializers/secret_token.rb +7 -0
  46. data/test/dummy/config/initializers/session_store.rb +8 -0
  47. data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
  48. data/test/dummy/config/locales/en.yml +5 -0
  49. data/test/dummy/config/routes.rb +7 -0
  50. data/test/dummy/config.ru +4 -0
  51. data/test/dummy/db/development.sqlite3 +0 -0
  52. data/test/dummy/log/development.log +6783 -0
  53. data/test/dummy/public/404.html +26 -0
  54. data/test/dummy/public/422.html +26 -0
  55. data/test/dummy/public/500.html +25 -0
  56. data/test/dummy/public/favicon.ico +0 -0
  57. data/test/dummy/script/rails +6 -0
  58. data/test/dummy/test/controllers/home_controller_test.rb +9 -0
  59. data/test/dummy/test/helpers/home_helper_test.rb +9 -0
  60. data/test/dummy/tmp/cache/assets/CB4/050/sprockets%2F97c1850b55cf4129b1285f355bc28f35 +0 -0
  61. data/test/dummy/tmp/cache/assets/CC4/F80/sprockets%2F141783134e9aa01271bccc1e5aa15780 +0 -0
  62. data/test/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953 +0 -0
  63. data/test/dummy/tmp/cache/assets/CDE/070/sprockets%2F62fb2f204d1b163283bf9c54e847a763 +0 -0
  64. data/test/dummy/tmp/cache/assets/CDF/870/sprockets%2Fb878faf942403e313a5b103e5d80488e +0 -0
  65. data/test/dummy/tmp/cache/assets/CEF/D90/sprockets%2Ff10210d03a1aab12db54763255c0f78f +0 -0
  66. data/test/dummy/tmp/cache/assets/CF9/7C0/sprockets%2F40fc2f3d2a468a00e463f1d313cb1683 +0 -0
  67. data/test/dummy/tmp/cache/assets/D05/D40/sprockets%2F1c9faaf28d05409b88ad3113374d613c +0 -0
  68. data/test/dummy/tmp/cache/assets/D1B/F00/sprockets%2Ff9754282954d3e38d0d6bb51dbad8493 +0 -0
  69. data/test/dummy/tmp/cache/assets/D1E/240/sprockets%2F6e162d45e288b9ae1f94b1546c95e3f4 +0 -0
  70. data/test/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705 +0 -0
  71. data/test/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655 +0 -0
  72. data/test/dummy/tmp/cache/assets/D59/6B0/sprockets%2F00e0ec406a5f0b0a67eabf612db82982 +0 -0
  73. data/test/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6 +0 -0
  74. data/test/dummy/tmp/cache/assets/D6A/E70/sprockets%2F0917684d61dad4deae7107484b3dbb7a +0 -0
  75. data/test/dummy/tmp/cache/assets/D8A/2F0/sprockets%2F92cc0ca4452a969b0b31e407a3aebe6b +0 -0
  76. data/test/dummy/tmp/cache/assets/D98/8B0/sprockets%2Fedbef6e0d0a4742346cf479f2c522eb0 +0 -0
  77. data/test/dummy/tmp/cache/assets/D99/0A0/sprockets%2Fdc1d37bab88b90027cd8a5bf83bb6309 +0 -0
  78. data/test/dummy/tmp/cache/assets/D9D/250/sprockets%2F7b1d7b8b2d290ca72dade9132de6a894 +0 -0
  79. data/test/dummy/tmp/cache/assets/DA3/AC0/sprockets%2Fbacca6e53be8a60f9af42e833b846458 +0 -0
  80. data/test/dummy/tmp/cache/assets/DAA/730/sprockets%2F66140a4ee6e9e778cc5bea1369ce2dc8 +0 -0
  81. data/test/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994 +0 -0
  82. data/test/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af +0 -0
  83. data/test/dummy/tmp/cache/assets/E0C/150/sprockets%2F598d5d80d9cf96a6afbcff06f31d5ca4 +0 -0
  84. data/test/dummy/tmp/restart.txt +0 -0
  85. data/test/fixtures/simple_contact/messages.yml +11 -0
  86. data/test/functional/simple_contact/contact_controller_test.rb +9 -0
  87. data/test/functional/simple_contact/contact_mailer_test.rb +9 -0
  88. data/test/integration/navigation_test.rb +10 -0
  89. data/test/simple_contact_test.rb +7 -0
  90. data/test/test_helper.rb +19 -0
  91. data/test/unit/helpers/simple_contact/contact_helper_test.rb +6 -0
  92. data/test/unit/simple_contact/message_test.rb +9 -0
  93. metadata +276 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 89490a82edf10e775a3d64cdb669dea4d4af91d7
4
+ data.tar.gz: f2f7234624ed6cb0a6e3ec51864894e62bad43c9
5
+ SHA512:
6
+ metadata.gz: 3142659b83ddc060badc1d54cf5fdc19ad1308e24de0d556d28d8a396dd26c858cfc951266516adcdc4d3c599acc3470ecb43b7c25bc516f1fa93dab8b02e688
7
+ data.tar.gz: 3a2ded199cbad1374723d73e709e2a23b8ab5e91a4b9f89664b9248881374dcf7a55a885b67db5071b0fda0fd6b7fa70426c96936c5a3fa7e82eecad974e56ed
data/MIT-LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright 2013 YOURNAME
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.rdoc ADDED
@@ -0,0 +1,3 @@
1
+ = SimpleContact
2
+
3
+ This project rocks and uses MIT-LICENSE.
data/Rakefile ADDED
@@ -0,0 +1,40 @@
1
+ #!/usr/bin/env rake
2
+ begin
3
+ require 'bundler/setup'
4
+ rescue LoadError
5
+ puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
6
+ end
7
+ begin
8
+ require 'rdoc/task'
9
+ rescue LoadError
10
+ require 'rdoc/rdoc'
11
+ require 'rake/rdoctask'
12
+ RDoc::Task = Rake::RDocTask
13
+ end
14
+
15
+ RDoc::Task.new(:rdoc) do |rdoc|
16
+ rdoc.rdoc_dir = 'rdoc'
17
+ rdoc.title = 'SimpleContact'
18
+ rdoc.options << '--line-numbers'
19
+ rdoc.rdoc_files.include('README.rdoc')
20
+ rdoc.rdoc_files.include('lib/**/*.rb')
21
+ end
22
+
23
+ APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
24
+ load 'rails/tasks/engine.rake'
25
+
26
+
27
+
28
+ Bundler::GemHelper.install_tasks
29
+
30
+ require 'rake/testtask'
31
+
32
+ Rake::TestTask.new(:test) do |t|
33
+ t.libs << 'lib'
34
+ t.libs << 'test'
35
+ t.pattern = 'test/**/*_test.rb'
36
+ t.verbose = false
37
+ end
38
+
39
+
40
+ task :default => :test
@@ -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,2 @@
1
+ // Place all the behaviors and hooks related to the matching controller here.
2
+ // All this logic will automatically be available in application.js.
@@ -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
+ */
@@ -0,0 +1,4 @@
1
+ /*
2
+ Place all the styles related to the matching controller here.
3
+ They will automatically be included in application.css.
4
+ */
@@ -0,0 +1,5 @@
1
+ module SimpleContact
2
+ class ApplicationController < ActionController::Base
3
+ layout 'application'
4
+ end
5
+ end
@@ -0,0 +1,22 @@
1
+ require_dependency "simple_contact/application_controller"
2
+
3
+ module SimpleContact
4
+ class ContactController < ApplicationController
5
+ def new
6
+ @message = SimpleContact::Message.new
7
+ end
8
+
9
+ def create
10
+ @message = SimpleContact::Message.new(params[:message])
11
+ if @message.valid?
12
+ ContactMailer.contact_message(@message).deliver
13
+ redirect_to main_app.root_path, notice: I18n.translate(:mailer_success_message)
14
+ else
15
+ flash.now.alert = "#{I18n.translate(:mailer_error_message)}"
16
+ render :new
17
+ end
18
+ end
19
+ end
20
+
21
+
22
+ end
@@ -0,0 +1,4 @@
1
+ module SimpleContact
2
+ module ApplicationHelper
3
+ end
4
+ end
@@ -0,0 +1,4 @@
1
+ module SimpleContact
2
+ module ContactHelper
3
+ end
4
+ end
@@ -0,0 +1,8 @@
1
+ module SimpleContact
2
+ class ContactMailer < ActionMailer::Base
3
+ def contact_message(message)
4
+ @message = message
5
+ mail(to: ENV['SIMPLE_CONTACT_TO_EMAIL'], from: @message.email, subject: "#{ENV['SIMPLE_CONTACT_SUBJECT_PREFIX']} #{@message.subject}" )
6
+ end
7
+ end
8
+ end
@@ -0,0 +1,23 @@
1
+ module SimpleContact
2
+ class Message
3
+
4
+ include ActiveModel::Validations
5
+ include ActiveModel::Conversion
6
+ extend ActiveModel::Naming
7
+
8
+ attr_accessor :body, :email, :name, :subject
9
+
10
+ validates :body, :subject, :name, :email, presence: true
11
+ validates :email, format: { with: /\A[^@\s]+@([^@\s]+\.)+[^@\s]+\z/ }
12
+
13
+ def initialize(attributes = {})
14
+ attributes.each do |name, value|
15
+ send("#{name}=", value)
16
+ end
17
+ end
18
+
19
+ def persisted?
20
+ false
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,31 @@
1
+ <div class='page-header'>
2
+ <h1>
3
+ <%= t(:contact_me) %>
4
+ <small> <%= t(:get_in_touch) %></small>
5
+ </h1>
6
+ <%= form_for @message, url: simple_contact.contact_path do |f| %>
7
+ <% if @message.errors.any? %>
8
+ <p><%= t(:message_errors_present) %></p>
9
+ <ul>
10
+ <% @message.errors.full_messages.each do |error| %>
11
+ <li><%= error %></li>
12
+ <% end %>
13
+ </ul>
14
+ <% end %>
15
+ <div class="form-inputs">
16
+ <%= f.label :email, "#{t(:email_address_label)}" %>
17
+ <%= f.text_field :email, placeholder: "#{t(:email_address_placeholder)}" %> <br />
18
+ <%= f.label :name, "#{t(:email_name_label)}" %>
19
+ <%= f.text_field :name, placeholder: "#{t(:email_name_placeholder)}" %> <br />
20
+ <%= f.label :subject, "#{t(:email_subject_label)}" %>
21
+ <%= f.text_field :subject, placeholder: "#{t(:email_subject_placeholder)}" %> <br />
22
+ <%= f.label :body, "#{t(:email_body_label)}" %>
23
+ <%= f.text_area :body, placeholder: "#{t(:email_body_placeholder)}", as: :text, input_html: {rows: 8} %> <br />
24
+ </div>
25
+ <br />
26
+ <div class='text-center'>
27
+ <%= f.submit :submit, class: 'btn btn-primary' %>
28
+ </div>
29
+ <% end %>
30
+ </div>
31
+
@@ -0,0 +1,9 @@
1
+ <h3> You've received a new message from: <%= mail_to @message.email, @message.name %> </h3>
2
+ <hr />
3
+ <h3> <%=@message.subject %> </h3>
4
+
5
+ <%= simple_format(@message.body) %>
6
+
7
+ <hr />
8
+
9
+ <p> Please respond to them within the next 24 hours </p>
@@ -0,0 +1,15 @@
1
+ en:
2
+ contact_me: "Contact Me"
3
+ get_in_touch: "Get in touch"
4
+
5
+ email_address_label: "Email Address"
6
+ email_address_placeholder: "Please enter your email address"
7
+ email_name_label: "Your Name"
8
+ email_name_placeholder: "Please enter your full name"
9
+ email_subject_label: "Email Subject"
10
+ email_subject_placeholder: "Tell us what you want to know about"
11
+ email_body_label: "Message"
12
+ email_body_placeholder: "Please write your message..."
13
+ message_errors_present: "Please correct the following errors"
14
+ mailer_success_message: "Thanks for contacting us. We'll be in touch soon!"
15
+ mailer_error_message: "Please correct the errors below"
data/config/routes.rb ADDED
@@ -0,0 +1,4 @@
1
+ SimpleContact::Engine.routes.draw do
2
+ get "/", to: 'contact#new', as: :contact
3
+ post "/", to: 'contact#create', as: :contact
4
+ end
@@ -0,0 +1,5 @@
1
+ module SimpleContact
2
+ class Engine < ::Rails::Engine
3
+ isolate_namespace SimpleContact
4
+ end
5
+ end
@@ -0,0 +1,3 @@
1
+ module SimpleContact
2
+ VERSION = "0.0.2"
3
+ end
@@ -0,0 +1,4 @@
1
+ require "simple_contact/engine"
2
+
3
+ module SimpleContact
4
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :simple_contact do
3
+ # # Task goes here
4
+ # 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
+ | |-- assets
177
+ | `-- tasks
178
+ |-- log
179
+ |-- public
180
+ |-- script
181
+ |-- test
182
+ | |-- fixtures
183
+ | |-- functional
184
+ | |-- integration
185
+ | |-- performance
186
+ | `-- unit
187
+ |-- tmp
188
+ | `-- cache
189
+ | `-- assets
190
+ `-- vendor
191
+ |-- assets
192
+ | |-- javascripts
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.