Permalink
Browse files

Update guides from docrails

  • Loading branch information...
lifo committed Nov 5, 2008
1 parent 32089cb commit 396d599e24cbfa15c62b20fab8cc02cdba046ce3
Showing with 1,476 additions and 368 deletions.
  1. +15 −6 railties/Rakefile
  2. +1 −1 railties/doc/guides/html/2_2_release_notes.html
  3. +218 −81 railties/doc/guides/html/actioncontroller_basics.html
  4. +267 −0 railties/doc/guides/html/activerecord_validations_callbacks.html
  5. +13 −0 railties/doc/guides/html/authors.html
  6. +158 −34 railties/doc/guides/html/debugging_rails_applications.html
  7. +15 −30 railties/doc/guides/html/finders.html
  8. +72 −4 railties/doc/guides/html/form_helpers.html
  9. +69 −45 railties/doc/guides/html/getting_started_with_rails.html
  10. +2 −18 railties/doc/guides/html/index.html
  11. +1 −1 railties/doc/guides/html/migrations.html
  12. +23 −44 railties/doc/guides/html/testing_rails_applications.html
  13. +1 −1 railties/doc/guides/source/2_2_release_notes.txt
  14. +5 −0 railties/doc/guides/source/actioncontroller_basics/changelog.txt
  15. +1 −1 railties/doc/guides/source/actioncontroller_basics/cookies.txt
  16. +32 −0 railties/doc/guides/source/actioncontroller_basics/csrf.txt
  17. +9 −9 railties/doc/guides/source/actioncontroller_basics/filters.txt
  18. +1 −1 railties/doc/guides/source/actioncontroller_basics/http_auth.txt
  19. +13 −1 railties/doc/guides/source/actioncontroller_basics/index.txt
  20. +4 −2 railties/doc/guides/source/actioncontroller_basics/introduction.txt
  21. +6 −4 railties/doc/guides/source/actioncontroller_basics/methods.txt
  22. +2 −2 railties/doc/guides/source/actioncontroller_basics/parameter_filtering.txt
  23. +35 −8 railties/doc/guides/source/actioncontroller_basics/params.txt
  24. +19 −11 railties/doc/guides/source/actioncontroller_basics/request_response_objects.txt
  25. +4 −4 railties/doc/guides/source/actioncontroller_basics/rescue.txt
  26. +12 −10 railties/doc/guides/source/actioncontroller_basics/session.txt
  27. +7 −7 railties/doc/guides/source/actioncontroller_basics/streaming.txt
  28. +3 −3 railties/doc/guides/source/actioncontroller_basics/verification.txt
  29. +1 −1 railties/doc/guides/source/active_record_basics.txt
  30. +25 −0 railties/doc/guides/source/activerecord_validations_callbacks.txt
  31. +14 −0 railties/doc/guides/source/authors.txt
  32. +225 −0 railties/doc/guides/source/configuring.txt
  33. +103 −7 railties/doc/guides/source/debugging_rails_applications.txt
  34. +0 −5 railties/doc/guides/source/finders.txt
  35. +80 −5 railties/doc/guides/source/form_helpers.txt
  36. +16 −7 railties/doc/guides/source/getting_started_with_rails.txt
  37. +2 −6 railties/doc/guides/source/index.txt
  38. +1 −1 railties/doc/guides/source/migrations/rakeing_around.txt
  39. +1 −8 railties/doc/guides/source/testing_rails_applications.txt
View
@@ -283,26 +283,35 @@ task :guides do
template = File.expand_path("doc/guides/source/templates/guides.html.erb")
- ignore = ['icons', 'images', 'templates', 'stylesheets']
+ ignore = ['..', 'icons', 'images', 'templates', 'stylesheets']
ignore << 'active_record_basics.txt'
indexless = ['index.txt', 'authors.txt']
- Dir.entries(source)[2..-1].each do |entry|
+ # Traverse all entries in doc/guides/source/
+ Dir.entries(source).each do |entry|
next if ignore.include?(entry)
if File.directory?(File.join(source, entry))
- input = File.join(source, entry, 'index.txt')
- output = File.join(html, entry)
+ # If the current entry is a directory, then we will want to compile
+ # the 'index.txt' file inside this directory.
+ if entry == '.'
+ input = File.join(source, 'index.txt')
+ output = File.join(html, "index.html")
+ else
+ input = File.join(source, entry, 'index.txt')
+ output = File.join(html, "#{entry}.html")
+ end
else
+ # If the current entry is a file, then we will want to compile this file.
input = File.join(source, entry)
- output = File.join(html, entry).sub(/\.txt$/, '')
+ output = File.join(html, entry).sub(/\.txt$/, '.html')
end
begin
puts "GENERATING => #{output}"
ENV['MANUALSONRAILS_TOC'] = 'no' if indexless.include?(entry)
- Mizuho::Generator.new(input, output, template).start
+ Mizuho::Generator.new(input, :output => output, :template => template).start
rescue Mizuho::GenerationError
STDERR.puts "*** ERROR"
exit 2
@@ -407,7 +407,7 @@ <h2 id="_documentation">2. Documentation</h2>
</li>
</ul></div>
<div class="para"><p>All told, the Guides provide tens of thousands of words of guidance for beginning and intermediate Rails developers.</p></div>
-<div class="para"><p>If you want to these generate guides locally, inside your application:</p></div>
+<div class="para"><p>If you want to generate these guides locally, inside your application:</p></div>
<div class="listingblock">
<div class="content"><!-- Generator: GNU source-highlight 2.9
by Lorenzo Bettini

Large diffs are not rendered by default.

Oops, something went wrong.
@@ -0,0 +1,267 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <title>Active Record Validations and Callbacks</title>
+ <!--[if lt IE 8]>
+ <script src="http://ie7-js.googlecode.com/svn/version/2.0(beta3)/IE8.js" type="text/javascript"></script>
+ <![endif]-->
+ <link href="stylesheets/base.css" media="screen" rel="Stylesheet" type="text/css" />
+ <link href="stylesheets/forms.css" media="screen" rel="Stylesheet" type="text/css" />
+ <link href="stylesheets/more.css" media="screen" rel="Stylesheet" type="text/css" />
+ <style type="text/css">
+ div#container {
+ max-width: 900px;
+ padding-bottom: 3em;
+}
+
+div#content {
+ margin-left: 200px;
+}
+
+div#container.notoc {
+ max-width: 600px;
+}
+
+.notoc div#content {
+ margin-left: 0;
+}
+
+pre {
+ line-height: 1.4em;
+}
+
+#content p tt {
+ background: #eeeeee;
+ border: solid 1px #cccccc;
+ padding: 3px;
+}
+
+dt {
+ font-weight: bold;
+}
+
+#content dt tt {
+ font-size: 10pt;
+}
+
+dd {
+ margin-left: 3em;
+}
+
+#content dt tt, #content pre tt {
+ background: none;
+ padding: 0;
+ border: 0;
+}
+
+#content .olist ol {
+ margin-left: 2em;
+}
+
+#header {
+ position: relative;
+ max-width: 840px;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+#header.notoc {
+ max-width: 580px;
+}
+
+#logo {
+ position: absolute;
+ left: 10px;
+ top: 10px;
+ width: 110px;
+ height: 140px;
+}
+
+div#header h1#site_title {
+ background: url('images/ruby_on_rails_by_mike_rundle2.gif') top left no-repeat;
+ position: absolute;
+ width: 392px;
+ height: 55px;
+ left: 145px;
+ top: 20px;
+ margin: 0;
+ padding: 0;
+}
+
+#site_title span {
+ display: none;
+}
+
+#site_title_tagline {
+ display: none;
+}
+
+ul#navMain {
+ position: absolute;
+ margin: 0;
+ padding: 0;
+ top: 97px;
+ left: 145px;
+}
+
+.left-floaty, .right-floaty {
+ padding: 15px;
+}
+
+.admonitionblock,
+.tableblock {
+ margin-left: 1em;
+ margin-right: 1em;
+ margin-top: 0.25em;
+ margin-bottom: 1em;
+}
+
+.admonitionblock .icon {
+ padding-right: 8px;
+}
+
+.admonitionblock .content {
+ border: solid 1px #ffda78;
+ background: #fffebd;
+ padding: 10px;
+ padding-top: 8px;
+ padding-bottom: 8px;
+}
+
+.admonitionblock .title {
+ font-size: 140%;
+ margin-bottom: 0.5em;
+}
+
+.tableblock table {
+ border: solid 1px #aaaaff;
+ background: #f0f0ff;
+}
+
+.tableblock th {
+ background: #e0e0e0;
+}
+
+.tableblock th,
+.tableblock td {
+ padding: 3px;
+ padding-left: 5px;
+ padding-right: 5px;
+}
+
+.sidebarblock {
+ margin-top: 0.25em;
+ margin: 1em;
+ border: solid 1px #ccccbb;
+ padding: 8px;
+ background: #ffffe0;
+}
+
+.sidebarblock .sidebar-title {
+ font-size: 140%;
+ font-weight: 600;
+ margin-bottom: 0.3em;
+}
+
+.sidebarblock .sidebar-content > .para:last-child > p {
+ margin-bottom: 0;
+}
+
+.sidebarblock .sidebar-title a {
+ text-decoration: none;
+}
+
+.sidebarblock .sidebar-title a:hover {
+ text-decoration: underline;
+}
+
+ </style>
+</head>
+<body>
+ <div id="header" >
+ <div id="logo">
+ <a href="index.html" title="Ruby on Rails"><img src="images/rails_logo_remix.gif" alt="Rails" height="140" width="110" /></a>
+ </div>
+
+ <h1 id="site_title"><span>Ruby on Rails</span></h1>
+ <h2 id="site_title_tagline">Sustainable productivity for web-application development</h2>
+
+ <ul id="navMain">
+ <li class="first-child"><a href="http://www.rubyonrails.org/" title="Ruby on Rails" class="ruby_on_rails">Ruby on Rails</a></li>
+ <li><a class="manuals" href="index.html" title="Manuals Index">Guides Index</a></li>
+ </ul>
+ </div>
+
+ <div id="container">
+
+ <div id="sidebar">
+ <h2>Chapters</h2>
+ <ol>
+ <li>
+ <a href="#_active_record_validations">Active Record Validations</a>
+ </li>
+ <li>
+ <a href="#_credits">Credits</a>
+ </li>
+ <li>
+ <a href="#_changelog">Changelog</a>
+ </li>
+ </ol>
+ </div>
+
+ <div id="content">
+ <h1>Active Record Validations and Callbacks</h1>
+ <div id="preamble">
+<div class="sectionbody">
+<div class="para"><p>This guide teaches you how to work with the lifecycle of your Active Record objects. More precisely, you will learn how to validate the state of your objects before they go into the database and also how to teach them to perform custom operations at certain points of their lifecycles.</p></div>
+<div class="para"><p>After reading this guide and trying out the presented concepts, we hope that you'll be able to:</p></div>
+<div class="ilist"><ul>
+<li>
+<p>
+Correctly use all the built-in Active Record validation helpers
+</p>
+</li>
+<li>
+<p>
+Create your own custom validation methods
+</p>
+</li>
+<li>
+<p>
+Work with the error messages generated by the validation proccess
+</p>
+</li>
+<li>
+<p>
+Register callback methods that will execute custom operations during your objects lifecycle, for example before/after they are saved.
+</p>
+</li>
+<li>
+<p>
+Create special classes that encapsulate common behaviour for your callbacks
+</p>
+</li>
+<li>
+<p>
+Create Observers - classes with callback methods specific for each of your models, keeping the callback code outside your models' declarations.
+</p>
+</li>
+</ul></div>
+</div>
+</div>
+<h2 id="_active_record_validations">1. Active Record Validations</h2>
+<div class="sectionbody">
+</div>
+<h2 id="_credits">2. Credits</h2>
+<div class="sectionbody">
+</div>
+<h2 id="_changelog">3. Changelog</h2>
+<div class="sectionbody">
+<div class="para"><p><a href="http://rails.lighthouseapp.com/projects/16213/tickets/26-active-record-validations-and-callbacks">http://rails.lighthouseapp.com/projects/16213/tickets/26-active-record-validations-and-callbacks</a></p></div>
+</div>
+
+ </div>
+ </div>
+</body>
+</html>
@@ -218,6 +218,19 @@ <h1>About the Authors</h1>
Cofounder of <a href="http://www.eventioz.com">Eventioz</a>. He has been using Rails since 2006 and contributing since early 2008.
Can be found at gmail, twitter, freenode, everywhere as miloops.</p></div>
</div></div>
+<div class="sidebarblock" id="hawe">
+<div class="sidebar-content">
+<div class="sidebar-title">Heiko Webers</div>
+<div class="para"><p>Heiko Webers is the founder of <a href="http://www.bauland42.de">bauland42</a>, a German web application security consulting and development
+company focused on Ruby on Rails. He blogs at <a href="http://www.rorsecurity.info">http://www.rorsecurity.info</a>. After 10 years of desktop application development,
+Heiko has rarely looked back.</p></div>
+</div></div>
+<div class="sidebarblock" id="toretore">
+<div class="sidebar-content">
+<div class="sidebar-title">Tore Darell</div>
+<div class="para"><p>Tore Darell is an independent developer based in Menton, France who specialises in cruft-free web applications using Ruby, Rails
+and unobtrusive JavaScript. His home on the internet is his blog <a href="http://tore.darell.no/">Sneaky Abstractions</a>.</p></div>
+</div></div>
</div>
</div>
Oops, something went wrong.

0 comments on commit 396d599

Please sign in to comment.