railties 3.0.0.beta2 → 3.0.0.beta3

data/CHANGELOG

@@ -1,3 +1,8 @@
+*Rails 3.0.0 [beta 3] (April 13th, 2010)*
+
+* Renamed config.cookie_secret to config.secret_token and pass it as env key. [JV]
+
+
 *Rails 3.0.0 [beta 2] (April 1st, 2010)*
 
 * Session store configuration has changed [YK & CL]
@@ -6,12 +11,11 @@
     config.cookie_secret = "fdsfhisdghfidugnfdlg"
 
 * railtie_name and engine_name are deprecated. You can now add any object to
-  the configuration object: config.your_plugin = {} [JK]
+  the configuration object: config.your_plugin = {} [JV]
 
 * Added config.generators.templates to provide alternative paths for the generators
   to look for templates [JV]
 
-
 *Rails 3.0.0 [beta 1] (February 4, 2010)*
 
 * Added "rake about" as a replacement for script/about [DHH]

data/guides/{files → assets}/stylesheets/main.css

@@ -92,7 +92,7 @@ body {
 }
 
 #header {
-	background: #c52f24 url(../../images/header_tile.gif) repeat-x;
+	background: #c52f24 url(../images/header_tile.gif) repeat-x;
 	color: #FFF;
 	padding: 1.5em 0;
 	position: relative;
@@ -100,7 +100,7 @@ body {
 	}
 
 #feature {
-	background: #d5e9f6 url(../../images/feature_tile.gif) repeat-x;
+	background: #d5e9f6 url(../images/feature_tile.gif) repeat-x;
 	color: #333;
 	padding: 0.5em 0 1.5em;
 }
@@ -132,7 +132,7 @@ body {
 
 #footer {
 	padding: 2em 0;
-	background: url(../../images/footer_tile.gif) repeat-x;
+	background: url(../images/footer_tile.gif) repeat-x;
 	}
 #footer .wrapper {
 	padding-left: 2em;
@@ -179,7 +179,7 @@ a, a:link, a:visited {
 }
 
 #header .nav .index a {
-	background: #980905 url(../../images/nav_arrow.gif) no-repeat right top;
+	background: #980905 url(../images/nav_arrow.gif) no-repeat right top;
 	padding-right: 1em;	
 	position: relative;
 	z-index: 15;
@@ -285,7 +285,7 @@ h6 {
 
 #header h1 {
 	float: left;
-	background: url(../../images/rails_guides_logo.gif) no-repeat;
+	background: url(../images/rails_guides_logo.gif) no-repeat;
 	width: 297px;
 	text-indent: -9999em;
 	margin: 0;
@@ -306,7 +306,7 @@ h6 {
 #feature ul {margin-left: 0;}
 #feature ul li {
 	list-style: none;
-	background: url(../../images/check_bullet.gif) no-repeat left 0.5em;
+	background: url(../images/check_bullet.gif) no-repeat left 0.5em;
 	padding: 0.5em 1.75em 0.5em 1.75em;
 	font-size: 1.1428em;
 	font-weight: bold;
@@ -325,12 +325,12 @@ h6 {
 	font-size: 1.2857em;
 	padding: 0.125em 0 0.25em 0;
 	margin-bottom: 0;
-	/*background: url(../../images/book_icon.gif) no-repeat left top;
+	/*background: url(../images/book_icon.gif) no-repeat left top;
 	padding: 0.125em 0 0.25em 28px;*/
 }
 
 #mainCol dd.ticket, #subCol dd.ticket {
-	background: #fff9d8 url(../../images/tab_yellow.gif) no-repeat left top;
+	background: #fff9d8 url(../images/tab_yellow.gif) no-repeat left top;
 	border: none;
 	padding: 1.25em 1em 1.25em 48px;
 	margin-left: 0;
@@ -338,7 +338,7 @@ h6 {
 }
 
 #mainCol div.warning, #subCol dd.warning {
-	background: #f9d9d8 url(../../images/tab_red.gif) no-repeat left top;
+	background: #f9d9d8 url(../images/tab_red.gif) no-repeat left top;
 	border: none;
 	padding: 1.25em 1.25em 1.25em 48px;
 	margin-left: 0;
@@ -355,7 +355,7 @@ h6 {
 #subCol .chapters ul li {
 	list-style: none;
 	padding: 0 0 0 1em;
-	background: url(../../images/bullet.gif) no-repeat left 0.45em;
+	background: url(../images/bullet.gif) no-repeat left 0.45em;
 	margin-left: 0;
 	font-size: 1em;
 	font-weight: normal;
@@ -366,7 +366,7 @@ tt {
 }
 
 div.code_container {
-	background: #EEE url(../../images/tab_grey.gif) no-repeat left top;
+	background: #EEE url(../images/tab_grey.gif) no-repeat left top;
 	padding: 0.25em 1em 0.5em 48px;    
 }
 
@@ -378,14 +378,14 @@ code {
 }
 
 .note {
-	background: #fff9d8 url(../../images/tab_note.gif) no-repeat left top;
+	background: #fff9d8 url(../images/tab_note.gif) no-repeat left top;
 	border: none;
 	padding: 1em 1em 0.25em 48px;
 	margin: 0.25em 0 1.5em 0;
 }
 
 .info {
-	background: #d5e9f6 url(../../images/tab_info.gif) no-repeat left top;
+	background: #d5e9f6 url(../images/tab_info.gif) no-repeat left top;
 	border: none;
 	padding: 1em 1em 0.25em 48px;
 	margin: 0.25em 0 1.5em 0;
@@ -395,7 +395,7 @@ code {
 
 #mainCol ul li {
 	list-style:none;
-	background: url(../../images/grey_bullet.gif) no-repeat left 0.5em;
+	background: url(../images/grey_bullet.gif) no-repeat left 0.5em;
 	padding-left: 1em;
 	margin-left: 0;
 }
@@ -437,5 +437,16 @@ div.code_container, div.important, div.caution, div.warning, div.note, div.info
 /* Remove bottom margin of paragraphs in special boxes, otherwise they get a
 spurious blank area below with the box background. */
 div.important p, div.caution p, div.warning p, div.note p, div.info p {
-    margin-bottom: 0px;
+    margin-bottom: 1em;
+}
+
+/* Edge Badge
+--------------------------------------- */
+
+#edge-badge {
+  position: fixed;
+  right: 0px;
+  top: 0px;
+  z-index: 100;
+  border: none;
 }

data/guides/rails_guides/generator.rb

@@ -1,7 +1,54 @@
+# ---------------------------------------------------------------------------
+#
+# This script generates the guides. It can be invoked either directly or via the
+# generate_guides rake task within the railties directory.
+#
+# Guides are taken from the source directory, and the resulting HTML goes into the
+# output directory. Assets are stored under files, and copied to output/files as
+# part of the generation process.
+#
+# Some arguments may be passed via environment variables:
+#
+#   WARNINGS
+#     If you are writing a guide, please work always with WARNINGS=1. Users can
+#     generate the guides, and thus this flag is off by default.
+#
+#     Internal links (anchors) are checked. If a reference is broken levenshtein
+#     distance is used to suggest an existing one. This is useful since IDs are
+#     generated by Textile from headers and thus edits alter them.
+#
+#     Also detects duplicated IDs. They happen if there are headers with the same
+#     text. Please do resolve them, if any, so guides are valid XHTML.
+#
+#   ALL
+#    Set to "1" to force the generation of all guides.
+#
+#   ONLY
+#     Use ONLY if you want to generate only one or a set of guides. Prefixes are
+#     enough:
+#
+#       # generates only association_basics.html
+#       ONLY=assoc ruby rails_guides.rb
+#
+#     Separate many using commas:
+#
+#       # generates only 
+#       ONLY=assoc,migrations ruby rails_guides.rb
+#
+#     Note that if you are working on a guide generation will by default process
+#     only that one, so ONLY is rarely used nowadays.
+#
+#   EDGE
+#     Set to "1" to indicate generated guides should be marked as edge. This
+#     inserts a badge and changes the preamble of the home page.
+#
+# ---------------------------------------------------------------------------
+
 require 'set'
 require 'fileutils'
 
 require 'active_support/core_ext/string/output_safety'
+require 'active_support/core_ext/object/blank'
 require 'action_controller'
 require 'action_view'
 
@@ -11,11 +58,14 @@ require 'rails_guides/levenshtein'
 
 module RailsGuides
   class Generator
-    attr_reader :guides_dir, :source_dir, :output_dir 
+    attr_reader :guides_dir, :source_dir, :output_dir, :edge, :warnings, :all
+
+    GUIDES_RE = /\.(?:textile|html\.erb)$/
 
     def initialize(output=nil)
       initialize_dirs(output)
       create_output_dir_if_needed
+      set_flags_from_environment
     end
 
     def generate
@@ -32,7 +82,13 @@ module RailsGuides
 
     def create_output_dir_if_needed
       FileUtils.mkdir_p(output_dir)
-    end  
+    end
+
+    def set_flags_from_environment
+      @edge     = ENV['EDGE']     == '1'
+      @warnings = ENV['WARNINGS'] == '1'
+      @all      = ENV['ALL']      == '1'
+    end
 
     def generate_guides
       guides_to_generate.each do |guide|
@@ -42,42 +98,40 @@ module RailsGuides
     end
 
     def guides_to_generate
-      guides = Dir.entries(source_dir).grep(/\.textile(?:\.erb)?$/)
-      ENV.key?("ONLY") ? select_only(guides) : guides
+      guides = Dir.entries(source_dir).grep(GUIDES_RE)
+      ENV.key?('ONLY') ? select_only(guides) : guides
     end
 
     def select_only(guides)
-      prefixes = ENV["ONLY"].split(",").map(&:strip)
+      prefixes = ENV['ONLY'].split(",").map(&:strip)
       guides.select do |guide|
         prefixes.any? {|p| guide.start_with?(p)}
       end
     end
 
     def copy_assets
-      FileUtils.cp_r(File.join(guides_dir, 'images'), File.join(output_dir, 'images'))
-      FileUtils.cp_r(File.join(guides_dir, 'files'), File.join(output_dir, 'files'))      
+      FileUtils.cp_r(Dir.glob("#{guides_dir}/assets/*"), output_dir)
     end
 
     def output_file_for(guide)
-      guide.sub(/\.textile(?:\.erb)?$/, '.html')
+      guide.sub(GUIDES_RE, '.html')
     end
     
     def generate?(source_file, output_file)
       fin  = File.join(source_dir, source_file)
       fout = File.join(output_dir, output_file)
-      ENV['ALL'] == '1' || !File.exists?(fout) || File.mtime(fout) < File.mtime(fin)
+      all || !File.exists?(fout) || File.mtime(fout) < File.mtime(fin)
     end
 
     def generate_guide(guide, output_file)
       puts "Generating #{output_file}"
       File.open(File.join(output_dir, output_file), 'w') do |f|
-        view = ActionView::Base.new(source_dir)
+        view = ActionView::Base.new(source_dir, :edge => edge)
         view.extend(Helpers)
-        
-        if guide =~ /\.textile\.erb$/
-          # Generate the erb pages with textile formatting - e.g. index/authors
+
+        if guide =~ /\.html\.erb$/
+          # Generate the special pages like the home.
           result = view.render(:layout => 'layout', :file => guide)
-          result = textile(result)
         else
           body = File.read(File.join(source_dir, guide))
           body = set_header_section(body, view)
@@ -85,10 +139,9 @@ module RailsGuides
 
           result = view.render(:layout => 'layout', :text => textile(body))
 
-          warn_about_broken_links(result) if ENV.key?("WARN_BROKEN_LINKS")
+          warn_about_broken_links(result) if @warnings
         end
-        
-        result = insert_edge_badge(result) if ENV.key?('INSERT_EDGE_BADGE')
+
         f.write result
       end
     end
@@ -98,7 +151,7 @@ module RailsGuides
       header = $1
 
       header =~ /h2\.(.*)/
-      page_title = $1.strip
+      page_title = "Ruby on Rails Guides: #{$1.strip}"
 
       header = textile(header)
 
@@ -114,19 +167,19 @@ module RailsGuides
         <ol class="chapters">
       INDEX
 
-      i = Indexer.new(body)
+      i = Indexer.new(body, warnings)
       i.index
 
       # Set index for 2 levels
       i.level_hash.each do |key, value|
-        link = view.content_tag(:a, :href => key[:id]) { textile(key[:title]).html_safe }
+        link = view.content_tag(:a, :href => key[:id]) { textile(key[:title], true).html_safe }
 
         children = value.keys.map do |k|
-          l = view.content_tag(:a, :href => k[:id]) { textile(k[:title]).html_safe }
-          view.content_tag(:li, l.html_safe)
+          view.content_tag(:li,
+            view.content_tag(:a, :href => k[:id]) { textile(k[:title], true).html_safe })
         end
 
-        children_ul = view.content_tag(:ul, children.join(" ").html_safe)
+        children_ul = children.empty? ? "" : view.content_tag(:ul, children.join(" ").html_safe)
 
         index << view.content_tag(:li, link.html_safe + children_ul.html_safe)
       end
@@ -139,11 +192,12 @@ module RailsGuides
       i.result
     end
 
-    def textile(body)
+    def textile(body, lite_mode=false)
       # If the issue with notextile is fixed just remove the wrapper.
       with_workaround_for_notextile(body) do |body|
         t = RedCloth.new(body)
         t.hard_breaks = false
+        t.lite_mode = lite_mode
         t.to_html(:notestuff, :plusplus, :code, :tip)
       end
     end
@@ -177,7 +231,7 @@ module RailsGuides
       anchors = Set.new
       html.scan(/<h\d\s+id="([^"]+)/).flatten.each do |anchor|
         if anchors.member?(anchor)
-          puts "*** DUPLICATE HEADER ID: #{anchor}, please consider rewording" if ENV.key?("WARN_DUPLICATE_HEADERS")
+          puts "*** DUPLICATE ID: #{anchor}, please put and explicit ID, e.g. h4(#explicit-id), or consider rewording"
         else
           anchors << anchor
         end
@@ -199,9 +253,5 @@ module RailsGuides
         end
       end
     end
-    
-    def insert_edge_badge(html)
-      html.sub(/<body[^>]*>/, '\&<img src="images/edge_badge.png" style="position:fixed; right:0px; top:0px; border:none; z-index:100"/>')
-    end
   end
 end