devise-formtastic 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (65) hide show
  1. data/.gitignore +22 -0
  2. data/CHANGELOG.md +5 -0
  3. data/Gemfile +5 -0
  4. data/LICENSE.txt +22 -0
  5. data/README.md +96 -0
  6. data/Rakefile +1 -0
  7. data/app/views/devise/confirmations/new.html.erb +10 -0
  8. data/app/views/devise/passwords/edit.html.erb +12 -0
  9. data/app/views/devise/passwords/new.html.erb +10 -0
  10. data/app/views/devise/registrations/edit.html.erb +33 -0
  11. data/app/views/devise/registrations/new.html.erb +12 -0
  12. data/app/views/devise/sessions/new.html.erb +16 -0
  13. data/app/views/devise/shared/_links.erb +25 -0
  14. data/app/views/devise/unlocks/new.html.erb +10 -0
  15. data/config/locales/en.yml +38 -0
  16. data/devise-formtastic.gemspec +24 -0
  17. data/lib/devise-formtastic.rb +15 -0
  18. data/lib/devise-formtastic/engine.rb +5 -0
  19. data/lib/devise-formtastic/version.rb +5 -0
  20. data/lib/generators/devise-formtastic/views_generator.rb +31 -0
  21. data/spec/dummy/README.rdoc +261 -0
  22. data/spec/dummy/Rakefile +7 -0
  23. data/spec/dummy/app/assets/javascripts/application.js +15 -0
  24. data/spec/dummy/app/assets/javascripts/public.js +2 -0
  25. data/spec/dummy/app/assets/stylesheets/application.css +12 -0
  26. data/spec/dummy/app/assets/stylesheets/public.css +4 -0
  27. data/spec/dummy/app/controllers/application_controller.rb +3 -0
  28. data/spec/dummy/app/controllers/public_controller.rb +4 -0
  29. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  30. data/spec/dummy/app/helpers/public_helper.rb +2 -0
  31. data/spec/dummy/app/mailers/.gitkeep +0 -0
  32. data/spec/dummy/app/models/.gitkeep +0 -0
  33. data/spec/dummy/app/models/user.rb +12 -0
  34. data/spec/dummy/app/views/layouts/application.html.erb +24 -0
  35. data/spec/dummy/app/views/public/index.html.erb +2 -0
  36. data/spec/dummy/config.ru +4 -0
  37. data/spec/dummy/config/application.rb +65 -0
  38. data/spec/dummy/config/boot.rb +10 -0
  39. data/spec/dummy/config/database.yml +25 -0
  40. data/spec/dummy/config/environment.rb +5 -0
  41. data/spec/dummy/config/environments/development.rb +39 -0
  42. data/spec/dummy/config/environments/production.rb +67 -0
  43. data/spec/dummy/config/environments/test.rb +37 -0
  44. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  45. data/spec/dummy/config/initializers/devise.rb +240 -0
  46. data/spec/dummy/config/initializers/formtastic.rb +76 -0
  47. data/spec/dummy/config/initializers/inflections.rb +15 -0
  48. data/spec/dummy/config/initializers/mime_types.rb +5 -0
  49. data/spec/dummy/config/initializers/secret_token.rb +7 -0
  50. data/spec/dummy/config/initializers/session_store.rb +8 -0
  51. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  52. data/spec/dummy/config/locales/devise.en.yml +60 -0
  53. data/spec/dummy/config/locales/en.yml +5 -0
  54. data/spec/dummy/config/routes.rb +5 -0
  55. data/spec/dummy/db/migrate/20130112221755_devise_create_users.rb +46 -0
  56. data/spec/dummy/db/schema.rb +41 -0
  57. data/spec/dummy/lib/assets/.gitkeep +0 -0
  58. data/spec/dummy/lib/templates/erb/scaffold/_form.html.erb +11 -0
  59. data/spec/dummy/log/.gitkeep +0 -0
  60. data/spec/dummy/public/404.html +26 -0
  61. data/spec/dummy/public/422.html +26 -0
  62. data/spec/dummy/public/500.html +25 -0
  63. data/spec/dummy/public/favicon.ico +0 -0
  64. data/spec/dummy/script/rails +6 -0
  65. metadata +224 -0
@@ -0,0 +1,22 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ tmp
16
+ .bundle/
17
+ log/*.log
18
+ pkg/
19
+ spec/dummy/db/*.sqlite3
20
+ spec/dummy/log/*.log
21
+ spec/dummy/tmp/
22
+ spec/dummy/.sass-cache
@@ -0,0 +1,5 @@
1
+ # Changelog
2
+
3
+ 0.0.1 (January 13, 2012)
4
+
5
+ * Initial release
data/Gemfile ADDED
@@ -0,0 +1,5 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ gem "jquery-rails"
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2013 Jari Jokinen
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,96 @@
1
+ # Devise Formtastic
2
+
3
+ Devise Formtastic is a [Formtastic](https://github.com/justinfrench/formtastic)
4
+ form builder for [Devise](https://github.com/plataformatec/devise) with some
5
+ extra features like full I18n support and dynamic page titles.
6
+
7
+ ## Requirements
8
+
9
+ * Ruby 1.9 or later
10
+ * Rails 3.2 or later
11
+
12
+ ## Installation
13
+
14
+ Add this line to your application's Gemfile:
15
+
16
+ gem "devise-formtastic"
17
+
18
+ And then execute:
19
+
20
+ $ bundle
21
+
22
+ Or install it yourself as:
23
+
24
+ $ gem install devise-formtastic
25
+
26
+ Devise Formtastic depends on latest stable versions of Devise and Formtastic
27
+ gems, so you don't have to add them in your Gemfile if you don't want to
28
+ specify version, git repository, etc.
29
+
30
+ All generators works as normal:
31
+
32
+ $ rails generate formtastic:install
33
+ $ rails generate devise:install
34
+ $ rails generate devise User
35
+
36
+ Don't forget to require Formtastic styles in your asset pipeline:
37
+
38
+ *= require formtastic
39
+
40
+ ## Usage
41
+
42
+ ### Generating views
43
+
44
+ If you want to modify Devise Formtastic views, you can copy them to app/views/:
45
+
46
+ $ rails g devise:views
47
+
48
+ ### Dynamic page titles
49
+
50
+ Devise Formtastic sets @title variable for each page (if it's not already set
51
+ in controllers), so you can use it in your layouts:
52
+
53
+ <head>
54
+ <title><%= "#{@title} | " unless @title.blank? %>Dummy App</title>
55
+ </head>
56
+
57
+ <body>
58
+ <%= content_tag(:h1, @title) unless @title.blank? %>
59
+ </body>
60
+
61
+ ### I18n support
62
+
63
+ All buttons, titles, links, hint texts, etc. are configurable using locales.
64
+
65
+ devise:
66
+ buttons:
67
+ sign_in: "Log in"
68
+ sign_up: "Sign up"
69
+ links:
70
+ sign_in: "Log in"
71
+ sign_up: "Join now"
72
+ titles:
73
+ sign_in: "Login"
74
+ sign_up: "Registration"
75
+
76
+ For full list of available options please take a look at
77
+ [default locale file](https://github.com/jarijokinen/devise-formtastic/blob/master/config/locales/en.yml).
78
+
79
+ ## Contributing
80
+
81
+ 1. Fork it
82
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
83
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
84
+ 4. Push to the branch (`git push origin my-new-feature`)
85
+ 5. Create new Pull Request
86
+
87
+ ## Support
88
+
89
+ If you have any questions or issues with Devise Formtastic, or if you like to
90
+ report a bug, please create an [issue on GitHub](https://github.com/jarijokinen/devise-formtastic/issues).
91
+
92
+ ## License
93
+
94
+ MIT License. Copyright (c) 2013 [Jari Jokinen](http://jarijokinen.com). See
95
+ [LICENSE](https://github.com/jarijokinen/devise-formtastic/blob/master/LICENSE.txt)
96
+ for further details.
@@ -0,0 +1 @@
1
+ require "bundler/gem_tasks"
@@ -0,0 +1,10 @@
1
+ <% @title ||= t("devise.titles.confirmation_instructions") %>
2
+
3
+ <%= semantic_form_for(resource, as: resource_name, url: confirmation_path(resource_name), html: {method: :post}) do |f| %>
4
+ <%= f.input :email, input_html: {autofocus: true} %>
5
+ <%= f.actions do %>
6
+ <%= f.action :submit, label: t("devise.buttons.confirmation_instructions") %>
7
+ <% end %>
8
+ <% end %>
9
+
10
+ <%= render "devise/shared/links" %>
@@ -0,0 +1,12 @@
1
+ <% @title ||= t("devise.titles.change_password") %>
2
+
3
+ <%= semantic_form_for(resource, as: resource_name, url: password_path(resource_name), html: {method: :put}) do |f| %>
4
+ <%= f.hidden_field :reset_password_token %>
5
+ <%= f.input :password, label: t("devise.labels.new_password"), input_html: {autofocus: true} %>
6
+ <%= f.input :password_confirmation, label: t("devise.labels.new_password_confirmation"), required: true %>
7
+ <%= f.actions do %>
8
+ <%= f.action :submit, label: t("devise.buttons.change_password") %>
9
+ <% end %>
10
+ <% end %>
11
+
12
+ <%= render "devise/shared/links" %>
@@ -0,0 +1,10 @@
1
+ <% @title ||= t("devise.titles.forgot_password") %>
2
+
3
+ <%= semantic_form_for(resource, as: resource_name, url: password_path(resource_name), html: {method: :post}) do |f| %>
4
+ <%= f.input :email, input_html: {autofocus: true} %>
5
+ <%= f.actions do %>
6
+ <%= f.action :submit, label: t("devise.buttons.reset_password") %>
7
+ <% end %>
8
+ <% end %>
9
+
10
+ <%= render "devise/shared/links" %>
@@ -0,0 +1,33 @@
1
+ <% @title ||= t("devise.titles.my_account",
2
+ model: resource_name.to_s.humanize,
3
+ downcase_model: resource_name.to_s.humanize.downcase) %>
4
+
5
+ <%= semantic_form_for(resource, as: resource_name, url: registration_path(resource_name), html: {method: :put}) do |f| %>
6
+ <%= f.input :email, input_html: {autofocus: true} %>
7
+
8
+ <% if resource.class.reconfirmable && resource.unconfirmed_email.present? %>
9
+ <div><%= t("devise.messages.waiting_confirmation", email: resource.unconfirmed_email) %></div>
10
+ <% end %>
11
+
12
+ <%= f.input :password, input_html: {autocomplete: "off"}, hint: t("devise.hints.password") %>
13
+ <%= f.input :password_confirmation %>
14
+ <%= f.input :current_password, required: true, hint: t("devise.hints.current_password") %>
15
+
16
+ <%= f.actions do %>
17
+ <%= f.action :submit, label: "Update" %>
18
+ <% end %>
19
+ <% end %>
20
+
21
+ <%= content_tag(:h2, t("devise.titles.cancel_account")) %>
22
+
23
+ <p><%=
24
+ button_to(
25
+ t("devise.buttons.cancel_account"),
26
+ registration_path(resource_name), data: {
27
+ confirm: t("devise.messages.cancel_account_confirmation"),
28
+ method: :delete
29
+ }
30
+ )
31
+ %></p>
32
+
33
+ <p><%= link_to t("devise.links.back"), :back %></p>
@@ -0,0 +1,12 @@
1
+ <% @title ||= t("devise.titles.sign_up") %>
2
+
3
+ <%= semantic_form_for(resource, as: resource_name, url: registration_path(resource_name)) do |f| %>
4
+ <%= f.input :email, input_html: {autofocus: true} %>
5
+ <%= f.input :password %>
6
+ <%= f.input :password_confirmation, required: true %>
7
+ <%= f.actions do %>
8
+ <%= f.action :submit, label: t("devise.buttons.sign_up") %>
9
+ <% end %>
10
+ <% end %>
11
+
12
+ <%= render "devise/shared/links" %>
@@ -0,0 +1,16 @@
1
+ <% @title ||= t("devise.titles.sign_in") %>
2
+
3
+ <%= semantic_form_for(resource, as: resource_name, url: session_path(resource_name)) do |f| %>
4
+ <%= f.input :email, input_html: {autofocus: true} %>
5
+ <%= f.input :password %>
6
+
7
+ <% if devise_mapping.rememberable? -%>
8
+ <%= f.input :remember_me, as: :boolean, label: false %>
9
+ <% end -%>
10
+
11
+ <%= f.actions do %>
12
+ <%= f.action :submit, label: t("devise.buttons.sign_in") %>
13
+ <% end %>
14
+ <% end %>
15
+
16
+ <%= render "devise/shared/links" %>
@@ -0,0 +1,25 @@
1
+ <%- if controller_name != 'sessions' %>
2
+ <%= link_to t("devise.links.sign_in"), new_session_path(resource_name) %><br />
3
+ <% end -%>
4
+
5
+ <%- if devise_mapping.registerable? && controller_name != 'registrations' %>
6
+ <%= link_to t("devise.links.sign_up"), new_registration_path(resource_name) %><br />
7
+ <% end -%>
8
+
9
+ <%- if devise_mapping.recoverable? && controller_name != 'passwords' %>
10
+ <%= link_to t("devise.links.forgot_password"), new_password_path(resource_name) %><br />
11
+ <% end -%>
12
+
13
+ <%- if devise_mapping.confirmable? && controller_name != 'confirmations' %>
14
+ <%= link_to t("devise.links.confirmation_instructions"), new_confirmation_path(resource_name) %><br />
15
+ <% end -%>
16
+
17
+ <%- if devise_mapping.lockable? && resource_class.unlock_strategy_enabled?(:email) && controller_name != 'unlocks' %>
18
+ <%= link_to t("devise.links.unlock_instructions"), new_unlock_path(resource_name) %><br />
19
+ <% end -%>
20
+
21
+ <%- if devise_mapping.omniauthable? %>
22
+ <%- resource_class.omniauth_providers.each do |provider| %>
23
+ <%= link_to t("devise.links.sign_in_with", provider: provider.to_s.titleize), omniauth_authorize_path(resource_name, provider) %><br />
24
+ <% end -%>
25
+ <% end -%>
@@ -0,0 +1,10 @@
1
+ <% @title ||= t("devise.titles.unlock_instructions") %>
2
+
3
+ <%= semantic_form_for(resource, as: resource_name, url: unlock_path(resource_name), html: {method: :post}) do |f| %>
4
+ <%= f.input :email, input_html: {autofocus: true} %>
5
+ <%= f.actions do %>
6
+ <%= f.action :submit, label: t("devise.buttons.unlock_instructions") %>
7
+ <% end %>
8
+ <% end %>
9
+
10
+ <%= render "devise/shared/links" %>
@@ -0,0 +1,38 @@
1
+ en:
2
+ devise:
3
+ buttons:
4
+ sign_in: "Sign in"
5
+ sign_up: "Sign up"
6
+ cancel_account: "Cancel my account"
7
+ reset_password: "Send me reset password instructions"
8
+ change_password: "Change password"
9
+ confirmation_instructions: "Resend confirmation instructions"
10
+ unlock_instructions: "Resend unlock instructions"
11
+ hints:
12
+ password: "(leave blank if you don't want to change it)"
13
+ current_password: "(we need your current password to confirm your changes)"
14
+ labels:
15
+ new_password: "New password"
16
+ new_password_confirmation: "Confirm new password"
17
+ links:
18
+ sign_in: "Sign in"
19
+ sign_in_with: "Sign in with %{provider}"
20
+ sign_up: "Sign up"
21
+ sign_out: "Sign out"
22
+ my_account: "My account"
23
+ back: "Back"
24
+ forgot_password: "Forgot your password?"
25
+ confirmation_instructions: "Didn't receive confirmation instructions?"
26
+ unlock_instructions: "Didn't receive unlock instructions?"
27
+ messages:
28
+ cancel_account_confirmation: "Are you sure?"
29
+ waiting_confirmation: "Currently waiting confirmation for %{email}"
30
+ titles:
31
+ sign_in: "Sign in"
32
+ sign_up: "Sign up"
33
+ my_account: "My %{downcase_model} account"
34
+ cancel_account: "Cancel my account"
35
+ forgot_password: "Forgot your password?"
36
+ change_password: "Change your password"
37
+ confirmation_instructions: "Resend confirmation instructions"
38
+ unlock_instructions: "Resend unlock instructions"
@@ -0,0 +1,24 @@
1
+ # -*- encoding: utf-8 -*-
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'devise-formtastic/version'
5
+
6
+ Gem::Specification.new do |gem|
7
+ gem.name = "devise-formtastic"
8
+ gem.version = Devise::Formtastic::VERSION
9
+ gem.authors = ["Jari Jokinen"]
10
+ gem.email = ["info@jarijokinen.com"]
11
+ gem.summary = "Formtastic form builder for Devise."
12
+ gem.description = "Formtastic form builder for Devise with some extra features like full I18n support and dynamic page titles."
13
+ gem.homepage = "https://github.com/jarijokinen/devise-formtastic"
14
+
15
+ gem.files = `git ls-files`.split($/)
16
+ gem.test_files = gem.files.grep(%r{^spec/})
17
+ gem.require_paths = ["lib"]
18
+
19
+ gem.add_dependency "rails", "~> 3.2.11"
20
+ gem.add_dependency "devise", "~> 2.2.1"
21
+ gem.add_dependency "formtastic", "~> 2.2.1"
22
+
23
+ gem.add_development_dependency "sqlite3"
24
+ end
@@ -0,0 +1,15 @@
1
+ require "rails"
2
+ require "devise"
3
+ require "formtastic"
4
+ require "devise-formtastic/version"
5
+
6
+ if defined?(Rails::Generators)
7
+ require "generators/devise-formtastic/views_generator"
8
+ else
9
+ require "devise-formtastic/engine"
10
+ end
11
+
12
+ module Devise
13
+ module Formtastic
14
+ end
15
+ end
@@ -0,0 +1,5 @@
1
+ module Devise::Formtastic
2
+ class Engine < Rails::Engine
3
+ config.railties_order = [Devise::Formtastic::Engine, :main_app, :all]
4
+ end
5
+ end
@@ -0,0 +1,5 @@
1
+ module Devise
2
+ module Formtastic
3
+ VERSION = "0.0.1"
4
+ end
5
+ end
@@ -0,0 +1,31 @@
1
+ require "generators/devise/views_generator"
2
+
3
+ module Devise
4
+ module Generators
5
+ class FormtasticGenerator < Rails::Generators::Base #:nodoc:
6
+ include Devise::Generators::ViewPathTemplates
7
+ source_root File.expand_path("../../../../app/views/devise", __FILE__)
8
+ desc "Copies Formtastic enabled views to your application."
9
+ hide!
10
+ end
11
+
12
+ class SharedViewsGenerator < Rails::Generators::Base #:nodoc:
13
+ include Devise::Generators::ViewPathTemplates
14
+ source_root File.expand_path("../../../../app/views/devise", __FILE__)
15
+ desc "Copies shared Formtastic enabled views to your application."
16
+ hide!
17
+
18
+ # Override copy_views to just copy mailer and shared.
19
+ def copy_views
20
+ view_directory :shared
21
+ end
22
+ end
23
+
24
+ class ViewsGenerator < Rails::Generators::Base
25
+ remove_hook_for :form_builder
26
+ hook_for :form_builder, aliases: "-b",
27
+ desc: "Form builder to be used",
28
+ default: defined?(Formtastic) ? "formtastic" : "form_for"
29
+ end
30
+ end
31
+ 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
+ | `-- 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.