contact_form 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +7 -0
- data/Gemfile +17 -0
- data/Gemfile.lock +100 -0
- data/MIT-LICENSE +20 -0
- data/README.rdoc +43 -0
- data/Rakefile +40 -0
- data/app/assets/images/contact_form/.gitkeep +0 -0
- data/app/assets/javascripts/contact_form/application.js +15 -0
- data/app/assets/javascripts/contact_form/custom_contact_form.js +0 -0
- data/app/assets/stylesheets/contact_form/application.css +13 -0
- data/app/assets/stylesheets/contact_form/custom_contact_form.scss.css +1 -0
- data/app/assets/stylesheets/contact_form/forms.scss.css +69 -0
- data/app/controllers/contact_form/application_controller.rb +4 -0
- data/app/controllers/contact_form/forms_controller.rb +28 -0
- data/app/helpers/contact_form/application_helper.rb +16 -0
- data/app/mailers/contact_form/form_mailer.rb +17 -0
- data/app/models/contact_form/form.rb +25 -0
- data/app/validators/email_validator.rb +15 -0
- data/app/views/contact_form/form_mailer/auto_reply.html.erb +9 -0
- data/app/views/contact_form/form_mailer/new_contact.html.erb +16 -0
- data/app/views/contact_form/forms/new.html.erb +22 -0
- data/app/views/layouts/contact_form/application.html.erb +16 -0
- data/config/locales/contact_form.de.yml +24 -0
- data/config/locales/contact_form.en.yml +24 -0
- data/config/routes.rb +6 -0
- data/contact_form.gemspec +26 -0
- data/lib/contact_form.rb +4 -0
- data/lib/contact_form/engine.rb +5 -0
- data/lib/contact_form/version.rb +3 -0
- data/lib/generators/contact_form/all/all_generator.rb +21 -0
- data/lib/generators/contact_form/controllers/controllers_generator.rb +18 -0
- data/lib/generators/contact_form/install/install_generator.rb +23 -0
- data/lib/generators/contact_form/install/templates/contact_form.de.yml +24 -0
- data/lib/generators/contact_form/install/templates/contact_form.en.yml +24 -0
- data/lib/generators/contact_form/install/templates/contact_form.rb +1 -0
- data/lib/generators/contact_form/install/templates/contact_form.yml +3 -0
- data/lib/generators/contact_form/mailers/mailers_generator.rb +18 -0
- data/lib/generators/contact_form/models/models_generator.rb +18 -0
- data/lib/generators/contact_form/views/views_generator.rb +18 -0
- data/lib/tasks/contact_form_tasks.rake +4 -0
- data/script/rails +8 -0
- data/test/dummy/README.rdoc +261 -0
- data/test/dummy/Rakefile +7 -0
- data/test/dummy/app/assets/javascripts/application.js +15 -0
- data/test/dummy/app/assets/stylesheets/application.css +13 -0
- data/test/dummy/app/controllers/application_controller.rb +3 -0
- data/test/dummy/app/helpers/application_helper.rb +2 -0
- data/test/dummy/app/mailers/.gitkeep +0 -0
- data/test/dummy/app/models/.gitkeep +0 -0
- data/test/dummy/app/views/layouts/application.html.erb +14 -0
- data/test/dummy/config.ru +4 -0
- data/test/dummy/config/application.rb +59 -0
- data/test/dummy/config/boot.rb +10 -0
- data/test/dummy/config/contact_form.yml +3 -0
- data/test/dummy/config/database.yml +25 -0
- data/test/dummy/config/environment.rb +5 -0
- data/test/dummy/config/environments/development.rb +37 -0
- data/test/dummy/config/environments/production.rb +67 -0
- data/test/dummy/config/environments/test.rb +37 -0
- data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/test/dummy/config/initializers/contact_form.rb +1 -0
- data/test/dummy/config/initializers/inflections.rb +15 -0
- data/test/dummy/config/initializers/mime_types.rb +5 -0
- data/test/dummy/config/initializers/secret_token.rb +7 -0
- data/test/dummy/config/initializers/session_store.rb +8 -0
- data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
- data/test/dummy/config/locales/contact_form.de.yml +24 -0
- data/test/dummy/config/locales/contact_form.en.yml +24 -0
- data/test/dummy/config/locales/en.yml +5 -0
- data/test/dummy/config/routes.rb +4 -0
- data/test/dummy/lib/assets/.gitkeep +0 -0
- data/test/dummy/log/.gitkeep +0 -0
- data/test/dummy/public/404.html +26 -0
- data/test/dummy/public/422.html +26 -0
- data/test/dummy/public/500.html +25 -0
- data/test/dummy/public/favicon.ico +0 -0
- data/test/dummy/script/rails +6 -0
- data/test/integration/navigation_test.rb +10 -0
- data/test/test_helper.rb +15 -0
- metadata +204 -0
@@ -0,0 +1,15 @@
|
|
1
|
+
require 'mail'
|
2
|
+
# coding: utf-8
|
3
|
+
class EmailValidator < ActiveModel::EachValidator
|
4
|
+
def validate_each(record,attribute,value)
|
5
|
+
begin
|
6
|
+
m = Mail::Address.new(value)
|
7
|
+
r = m.domain && m.address == value
|
8
|
+
t = m.__send__(:tree)
|
9
|
+
r &&= (t.domain.dot_atom_text.elements.size > 1)
|
10
|
+
rescue Exception => e
|
11
|
+
r = false
|
12
|
+
end
|
13
|
+
record.errors[attribute] << (options[:message] || "is invalid") unless r
|
14
|
+
end
|
15
|
+
end
|
@@ -0,0 +1,16 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
|
5
|
+
</head>
|
6
|
+
<body>
|
7
|
+
<p><%= I18n.t(".contact_form.views.form_mailer.new_contact.headline") %></p>
|
8
|
+
|
9
|
+
<p>
|
10
|
+
<%= I18n.t(".contact_form.models.form.attributes.name") %>: <%= @form.name %><br/>
|
11
|
+
<%= I18n.t(".contact_form.models.form.attributes.email") %>: <%= @form.email %><br/>
|
12
|
+
<%= I18n.t(".contact_form.models.form.attributes.message") %>: <%= @form.message %>
|
13
|
+
</p>
|
14
|
+
|
15
|
+
</body>
|
16
|
+
</html>
|
@@ -0,0 +1,22 @@
|
|
1
|
+
<div id="new_form">
|
2
|
+
<%= form_for @form do |f| %>
|
3
|
+
<div class="field">
|
4
|
+
<%= f.label :name %>
|
5
|
+
<%= f.text_field :name %>
|
6
|
+
</div>
|
7
|
+
|
8
|
+
<div class="field">
|
9
|
+
<%= f.label :email %>
|
10
|
+
<%= f.email_field :email %>
|
11
|
+
</div>
|
12
|
+
|
13
|
+
<div class="field">
|
14
|
+
<%= f.label :message %>
|
15
|
+
<%= f.text_area :message %>
|
16
|
+
</div>
|
17
|
+
|
18
|
+
<div class="actions">
|
19
|
+
<%= f.submit I18n.t(".contact_form.views.forms.new.send") %>
|
20
|
+
</div>
|
21
|
+
<% end %>
|
22
|
+
</div>
|
@@ -0,0 +1,16 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<title>ContactForm</title>
|
5
|
+
<%= stylesheet_link_tag "contact_form/application", :media => "all" %>
|
6
|
+
<%= javascript_include_tag "contact_form/application" %>
|
7
|
+
<%= csrf_meta_tags %>
|
8
|
+
</head>
|
9
|
+
<body>
|
10
|
+
|
11
|
+
<%= flash_errors_and_notices %>
|
12
|
+
|
13
|
+
<%= yield %>
|
14
|
+
|
15
|
+
</body>
|
16
|
+
</html>
|
@@ -0,0 +1,24 @@
|
|
1
|
+
de:
|
2
|
+
contact_form:
|
3
|
+
models:
|
4
|
+
form:
|
5
|
+
attributes:
|
6
|
+
name: "Name"
|
7
|
+
email: "Email"
|
8
|
+
message: "Nachricht"
|
9
|
+
mailers:
|
10
|
+
form_mailer:
|
11
|
+
auto_reply_subject: "YOUR-DOMAIN - Danke für Ihre Anfrage"
|
12
|
+
new_contact_subject: "YOUR-DOMAIN: neue Kontaktanfrage"
|
13
|
+
views:
|
14
|
+
forms:
|
15
|
+
new:
|
16
|
+
send: "Absenden"
|
17
|
+
form_mailer:
|
18
|
+
new_contact:
|
19
|
+
headline: "YOUR-DOMAIN: neue Kontaktanfrage eingetroffen:"
|
20
|
+
auto_reply:
|
21
|
+
text_html: "<p>Danke für Ihre Anfrage auf unserer Homepage.</p>"
|
22
|
+
controllers:
|
23
|
+
forms_controller:
|
24
|
+
success: "Danke für Ihre Anfrage"
|
@@ -0,0 +1,24 @@
|
|
1
|
+
en:
|
2
|
+
contact_form:
|
3
|
+
models:
|
4
|
+
form:
|
5
|
+
attributes:
|
6
|
+
name: "Name"
|
7
|
+
email: "Email"
|
8
|
+
message: "Message"
|
9
|
+
mailers:
|
10
|
+
form_mailer:
|
11
|
+
auto_reply_subject: "YOUR-DOMAIN - Thank you for your request"
|
12
|
+
new_contact_subject: "YOUR-DOMAIN: new contact request"
|
13
|
+
views:
|
14
|
+
forms:
|
15
|
+
new:
|
16
|
+
send: "Send"
|
17
|
+
form_mailer:
|
18
|
+
new_contact:
|
19
|
+
headline: "YOUR-DOMAIN: new contact request:"
|
20
|
+
auto_reply:
|
21
|
+
text_html: "<p>Thank you for your contact request.</p>"
|
22
|
+
controllers:
|
23
|
+
forms_controller:
|
24
|
+
success: "Thank you for your interest."
|
data/config/routes.rb
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
$:.push File.expand_path("../lib", __FILE__)
|
2
|
+
|
3
|
+
# Maintain your gem's version:
|
4
|
+
require "contact_form/version"
|
5
|
+
|
6
|
+
Gem::Specification.new do |s|
|
7
|
+
s.name = "contact_form"
|
8
|
+
s.version = ContactForm::VERSION
|
9
|
+
s.platform = Gem::Platform::RUBY
|
10
|
+
s.authors = ["Matthias Frick"]
|
11
|
+
s.email = ["matthias@frick-web.at"]
|
12
|
+
s.homepage = "https://github.com/mattherick/contact_form"
|
13
|
+
s.description = "A simple contact form for a contact page."
|
14
|
+
s.summary = "contact_form-#{s.version}"
|
15
|
+
s.rubyforge_project = "contact_form"
|
16
|
+
|
17
|
+
s.add_dependency "rails", "~> 3.2.8"
|
18
|
+
s.add_dependency "jquery-rails"
|
19
|
+
s.add_dependency "i18n"
|
20
|
+
s.add_dependency "mail"
|
21
|
+
s.add_development_dependency "sqlite3"
|
22
|
+
|
23
|
+
s.files = `git ls-files`.split("\n")
|
24
|
+
s.executables = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
|
25
|
+
s.require_path = 'lib'
|
26
|
+
end
|
data/lib/contact_form.rb
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
module ContactForm
|
2
|
+
module Generators
|
3
|
+
class AllGenerator < Rails::Generators::Base
|
4
|
+
|
5
|
+
source_root File.expand_path("../../../../../app", __FILE__)
|
6
|
+
|
7
|
+
desc <<-MSG
|
8
|
+
Description:
|
9
|
+
Copies all ContactForm files into your application.
|
10
|
+
MSG
|
11
|
+
|
12
|
+
def copy_all
|
13
|
+
generate "contact_form:controllers"
|
14
|
+
generate "contact_form:mailers"
|
15
|
+
generate "contact_form:models"
|
16
|
+
generate "contact_form:views"
|
17
|
+
end
|
18
|
+
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
module ContactForm
|
2
|
+
module Generators
|
3
|
+
class ControllersGenerator < Rails::Generators::Base
|
4
|
+
|
5
|
+
source_root File.expand_path("../../../../../app", __FILE__)
|
6
|
+
|
7
|
+
desc <<-MSG
|
8
|
+
Description:
|
9
|
+
Copies ContactForm controllers into your application.
|
10
|
+
MSG
|
11
|
+
|
12
|
+
def copy_controllers
|
13
|
+
directory "controllers", "app/controllers"
|
14
|
+
end
|
15
|
+
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
module ContactForm
|
2
|
+
module Generators
|
3
|
+
class InstallGenerator < ::Rails::Generators::Base
|
4
|
+
|
5
|
+
source_root File.expand_path('../templates', __FILE__)
|
6
|
+
desc "create initializer, config yml and locales"
|
7
|
+
|
8
|
+
def copy_config
|
9
|
+
copy_file "contact_form.yml", "config/contact_form.yml"
|
10
|
+
end
|
11
|
+
|
12
|
+
def copy_initializer
|
13
|
+
copy_file "contact_form.rb", "config/initializers/contact_form.rb"
|
14
|
+
end
|
15
|
+
|
16
|
+
def copy_locales
|
17
|
+
copy_file "contact_form.de.yml", "config/locales/contact_form.de.yml"
|
18
|
+
copy_file "contact_form.en.yml", "config/locales/contact_form.en.yml"
|
19
|
+
end
|
20
|
+
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
de:
|
2
|
+
contact_form:
|
3
|
+
models:
|
4
|
+
form:
|
5
|
+
attributes:
|
6
|
+
name: "Name"
|
7
|
+
email: "Email"
|
8
|
+
message: "Nachricht"
|
9
|
+
mailers:
|
10
|
+
form_mailer:
|
11
|
+
auto_reply_subject: "YOUR-DOMAIN - Danke für Ihre Anfrage"
|
12
|
+
new_contact_subject: "YOUR-DOMAIN: neue Kontaktanfrage"
|
13
|
+
views:
|
14
|
+
forms:
|
15
|
+
new:
|
16
|
+
send: "Absenden"
|
17
|
+
form_mailer:
|
18
|
+
new_contact:
|
19
|
+
headline: "YOUR-DOMAIN: neue Kontaktanfrage eingetroffen:"
|
20
|
+
auto_reply:
|
21
|
+
text_html: "<p>Danke für Ihre Anfrage auf unserer Homepage.</p>"
|
22
|
+
controllers:
|
23
|
+
forms_controller:
|
24
|
+
success: "Danke für Ihre Anfrage"
|
@@ -0,0 +1,24 @@
|
|
1
|
+
en:
|
2
|
+
contact_form:
|
3
|
+
models:
|
4
|
+
form:
|
5
|
+
attributes:
|
6
|
+
name: "Name"
|
7
|
+
email: "Email"
|
8
|
+
message: "Message"
|
9
|
+
mailers:
|
10
|
+
form_mailer:
|
11
|
+
auto_reply_subject: "YOUR-DOMAIN - Thank you for your request"
|
12
|
+
new_contact_subject: "YOUR-DOMAIN: new contact request"
|
13
|
+
views:
|
14
|
+
forms:
|
15
|
+
new:
|
16
|
+
send: "Send"
|
17
|
+
form_mailer:
|
18
|
+
new_contact:
|
19
|
+
headline: "YOUR-DOMAIN: new contact request:"
|
20
|
+
auto_reply:
|
21
|
+
text_html: "<p>Thank you for your contact request.</p>"
|
22
|
+
controllers:
|
23
|
+
forms_controller:
|
24
|
+
success: "Thank you for your interest."
|
@@ -0,0 +1 @@
|
|
1
|
+
CONTACT_FORM_CONFIG = YAML.load_file("#{Rails.root}/config/contact_form.yml")
|
@@ -0,0 +1,18 @@
|
|
1
|
+
module ContactForm
|
2
|
+
module Generators
|
3
|
+
class MailersGenerator < Rails::Generators::Base
|
4
|
+
|
5
|
+
source_root File.expand_path("../../../../../app", __FILE__)
|
6
|
+
|
7
|
+
desc <<-MSG
|
8
|
+
Description:
|
9
|
+
Copies ContactForm mailers into your application.
|
10
|
+
MSG
|
11
|
+
|
12
|
+
def copy_mailers
|
13
|
+
directory "mailers", "app/mailers"
|
14
|
+
end
|
15
|
+
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
module ContactForm
|
2
|
+
module Generators
|
3
|
+
class ModelsGenerator < Rails::Generators::Base
|
4
|
+
|
5
|
+
source_root File.expand_path("../../../../../app", __FILE__)
|
6
|
+
|
7
|
+
desc <<-MSG
|
8
|
+
Description:
|
9
|
+
Copies ContactForm models into your application.
|
10
|
+
MSG
|
11
|
+
|
12
|
+
def copy_models
|
13
|
+
directory "models", "app/models"
|
14
|
+
end
|
15
|
+
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
module ContactForm
|
2
|
+
module Generators
|
3
|
+
class ViewsGenerator < Rails::Generators::Base
|
4
|
+
|
5
|
+
source_root File.expand_path("../../../../../app", __FILE__)
|
6
|
+
|
7
|
+
desc <<-MSG
|
8
|
+
Description:
|
9
|
+
Copies ContactForm views into your application.
|
10
|
+
MSG
|
11
|
+
|
12
|
+
def copy_views
|
13
|
+
directory "views", "app/views"
|
14
|
+
end
|
15
|
+
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
data/script/rails
ADDED
@@ -0,0 +1,8 @@
|
|
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
|
+
ENGINE_ROOT = File.expand_path('../..', __FILE__)
|
5
|
+
ENGINE_PATH = File.expand_path('../../lib/contact_form/engine', __FILE__)
|
6
|
+
|
7
|
+
require 'rails/all'
|
8
|
+
require 'rails/engine/commands'
|
@@ -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.
|