rails 4.1.4 → 5.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +24 -18
- metadata +51 -304
- data/guides/CHANGELOG.md +0 -41
- data/guides/Rakefile +0 -77
- data/guides/assets/images/akshaysurve.jpg +0 -0
- data/guides/assets/images/belongs_to.png +0 -0
- data/guides/assets/images/book_icon.gif +0 -0
- data/guides/assets/images/bullet.gif +0 -0
- data/guides/assets/images/chapters_icon.gif +0 -0
- data/guides/assets/images/check_bullet.gif +0 -0
- data/guides/assets/images/credits_pic_blank.gif +0 -0
- data/guides/assets/images/csrf.png +0 -0
- data/guides/assets/images/edge_badge.png +0 -0
- data/guides/assets/images/favicon.ico +0 -0
- data/guides/assets/images/feature_tile.gif +0 -0
- data/guides/assets/images/footer_tile.gif +0 -0
- data/guides/assets/images/fxn.png +0 -0
- data/guides/assets/images/getting_started/article_with_comments.png +0 -0
- data/guides/assets/images/getting_started/challenge.png +0 -0
- data/guides/assets/images/getting_started/confirm_dialog.png +0 -0
- data/guides/assets/images/getting_started/forbidden_attributes_for_new_article.png +0 -0
- data/guides/assets/images/getting_started/form_with_errors.png +0 -0
- data/guides/assets/images/getting_started/index_action_with_edit_link.png +0 -0
- data/guides/assets/images/getting_started/new_article.png +0 -0
- data/guides/assets/images/getting_started/rails_welcome.png +0 -0
- data/guides/assets/images/getting_started/routing_error_no_controller.png +0 -0
- data/guides/assets/images/getting_started/routing_error_no_route_matches.png +0 -0
- data/guides/assets/images/getting_started/show_action_for_articles.png +0 -0
- data/guides/assets/images/getting_started/template_is_missing_articles_new.png +0 -0
- data/guides/assets/images/getting_started/unknown_action_create_for_articles.png +0 -0
- data/guides/assets/images/getting_started/unknown_action_new_for_articles.png +0 -0
- data/guides/assets/images/grey_bullet.gif +0 -0
- data/guides/assets/images/habtm.png +0 -0
- data/guides/assets/images/has_many.png +0 -0
- data/guides/assets/images/has_many_through.png +0 -0
- data/guides/assets/images/has_one.png +0 -0
- data/guides/assets/images/has_one_through.png +0 -0
- data/guides/assets/images/header_backdrop.png +0 -0
- data/guides/assets/images/header_tile.gif +0 -0
- data/guides/assets/images/i18n/demo_html_safe.png +0 -0
- data/guides/assets/images/i18n/demo_localized_pirate.png +0 -0
- data/guides/assets/images/i18n/demo_translated_en.png +0 -0
- data/guides/assets/images/i18n/demo_translated_pirate.png +0 -0
- data/guides/assets/images/i18n/demo_translation_missing.png +0 -0
- data/guides/assets/images/i18n/demo_untranslated.png +0 -0
- data/guides/assets/images/icons/README +0 -5
- data/guides/assets/images/icons/callouts/1.png +0 -0
- data/guides/assets/images/icons/callouts/10.png +0 -0
- data/guides/assets/images/icons/callouts/11.png +0 -0
- data/guides/assets/images/icons/callouts/12.png +0 -0
- data/guides/assets/images/icons/callouts/13.png +0 -0
- data/guides/assets/images/icons/callouts/14.png +0 -0
- data/guides/assets/images/icons/callouts/15.png +0 -0
- data/guides/assets/images/icons/callouts/2.png +0 -0
- data/guides/assets/images/icons/callouts/3.png +0 -0
- data/guides/assets/images/icons/callouts/4.png +0 -0
- data/guides/assets/images/icons/callouts/5.png +0 -0
- data/guides/assets/images/icons/callouts/6.png +0 -0
- data/guides/assets/images/icons/callouts/7.png +0 -0
- data/guides/assets/images/icons/callouts/8.png +0 -0
- data/guides/assets/images/icons/callouts/9.png +0 -0
- data/guides/assets/images/icons/caution.png +0 -0
- data/guides/assets/images/icons/example.png +0 -0
- data/guides/assets/images/icons/home.png +0 -0
- data/guides/assets/images/icons/important.png +0 -0
- data/guides/assets/images/icons/next.png +0 -0
- data/guides/assets/images/icons/note.png +0 -0
- data/guides/assets/images/icons/prev.png +0 -0
- data/guides/assets/images/icons/tip.png +0 -0
- data/guides/assets/images/icons/up.png +0 -0
- data/guides/assets/images/icons/warning.png +0 -0
- data/guides/assets/images/nav_arrow.gif +0 -0
- data/guides/assets/images/oscardelben.jpg +0 -0
- data/guides/assets/images/polymorphic.png +0 -0
- data/guides/assets/images/radar.png +0 -0
- data/guides/assets/images/rails4_features.png +0 -0
- data/guides/assets/images/rails_guides_kindle_cover.jpg +0 -0
- data/guides/assets/images/rails_guides_logo.gif +0 -0
- data/guides/assets/images/rails_logo_remix.gif +0 -0
- data/guides/assets/images/session_fixation.png +0 -0
- data/guides/assets/images/tab_grey.gif +0 -0
- data/guides/assets/images/tab_info.gif +0 -0
- data/guides/assets/images/tab_note.gif +0 -0
- data/guides/assets/images/tab_red.gif +0 -0
- data/guides/assets/images/tab_yellow.gif +0 -0
- data/guides/assets/images/tab_yellow.png +0 -0
- data/guides/assets/images/vijaydev.jpg +0 -0
- data/guides/assets/javascripts/guides.js +0 -53
- data/guides/assets/javascripts/jquery.min.js +0 -4
- data/guides/assets/javascripts/responsive-tables.js +0 -43
- data/guides/assets/javascripts/syntaxhighlighter/shBrushAS3.js +0 -59
- data/guides/assets/javascripts/syntaxhighlighter/shBrushAppleScript.js +0 -75
- data/guides/assets/javascripts/syntaxhighlighter/shBrushBash.js +0 -59
- data/guides/assets/javascripts/syntaxhighlighter/shBrushCSharp.js +0 -65
- data/guides/assets/javascripts/syntaxhighlighter/shBrushColdFusion.js +0 -100
- data/guides/assets/javascripts/syntaxhighlighter/shBrushCpp.js +0 -97
- data/guides/assets/javascripts/syntaxhighlighter/shBrushCss.js +0 -91
- data/guides/assets/javascripts/syntaxhighlighter/shBrushDelphi.js +0 -55
- data/guides/assets/javascripts/syntaxhighlighter/shBrushDiff.js +0 -41
- data/guides/assets/javascripts/syntaxhighlighter/shBrushErlang.js +0 -52
- data/guides/assets/javascripts/syntaxhighlighter/shBrushGroovy.js +0 -67
- data/guides/assets/javascripts/syntaxhighlighter/shBrushJScript.js +0 -52
- data/guides/assets/javascripts/syntaxhighlighter/shBrushJava.js +0 -57
- data/guides/assets/javascripts/syntaxhighlighter/shBrushJavaFX.js +0 -58
- data/guides/assets/javascripts/syntaxhighlighter/shBrushPerl.js +0 -72
- data/guides/assets/javascripts/syntaxhighlighter/shBrushPhp.js +0 -88
- data/guides/assets/javascripts/syntaxhighlighter/shBrushPlain.js +0 -33
- data/guides/assets/javascripts/syntaxhighlighter/shBrushPowerShell.js +0 -74
- data/guides/assets/javascripts/syntaxhighlighter/shBrushPython.js +0 -64
- data/guides/assets/javascripts/syntaxhighlighter/shBrushRuby.js +0 -55
- data/guides/assets/javascripts/syntaxhighlighter/shBrushSass.js +0 -94
- data/guides/assets/javascripts/syntaxhighlighter/shBrushScala.js +0 -51
- data/guides/assets/javascripts/syntaxhighlighter/shBrushSql.js +0 -66
- data/guides/assets/javascripts/syntaxhighlighter/shBrushVb.js +0 -56
- data/guides/assets/javascripts/syntaxhighlighter/shBrushXml.js +0 -69
- data/guides/assets/javascripts/syntaxhighlighter/shCore.js +0 -17
- data/guides/assets/stylesheets/fixes.css +0 -16
- data/guides/assets/stylesheets/kindle.css +0 -11
- data/guides/assets/stylesheets/main.css +0 -710
- data/guides/assets/stylesheets/print.css +0 -52
- data/guides/assets/stylesheets/reset.css +0 -43
- data/guides/assets/stylesheets/responsive-tables.css +0 -50
- data/guides/assets/stylesheets/style.css +0 -13
- data/guides/assets/stylesheets/syntaxhighlighter/shCore.css +0 -226
- data/guides/assets/stylesheets/syntaxhighlighter/shCoreDefault.css +0 -328
- data/guides/assets/stylesheets/syntaxhighlighter/shCoreDjango.css +0 -331
- data/guides/assets/stylesheets/syntaxhighlighter/shCoreEclipse.css +0 -339
- data/guides/assets/stylesheets/syntaxhighlighter/shCoreEmacs.css +0 -324
- data/guides/assets/stylesheets/syntaxhighlighter/shCoreFadeToGrey.css +0 -328
- data/guides/assets/stylesheets/syntaxhighlighter/shCoreMDUltra.css +0 -324
- data/guides/assets/stylesheets/syntaxhighlighter/shCoreMidnight.css +0 -324
- data/guides/assets/stylesheets/syntaxhighlighter/shCoreRDark.css +0 -324
- data/guides/assets/stylesheets/syntaxhighlighter/shThemeDefault.css +0 -117
- data/guides/assets/stylesheets/syntaxhighlighter/shThemeDjango.css +0 -120
- data/guides/assets/stylesheets/syntaxhighlighter/shThemeEclipse.css +0 -128
- data/guides/assets/stylesheets/syntaxhighlighter/shThemeEmacs.css +0 -113
- data/guides/assets/stylesheets/syntaxhighlighter/shThemeFadeToGrey.css +0 -117
- data/guides/assets/stylesheets/syntaxhighlighter/shThemeMDUltra.css +0 -113
- data/guides/assets/stylesheets/syntaxhighlighter/shThemeMidnight.css +0 -113
- data/guides/assets/stylesheets/syntaxhighlighter/shThemeRDark.css +0 -113
- data/guides/assets/stylesheets/syntaxhighlighter/shThemeRailsGuides.css +0 -116
- data/guides/bug_report_templates/action_controller_gem.rb +0 -47
- data/guides/bug_report_templates/action_controller_master.rb +0 -53
- data/guides/bug_report_templates/active_record_gem.rb +0 -40
- data/guides/bug_report_templates/active_record_master.rb +0 -49
- data/guides/code/getting_started/Gemfile +0 -40
- data/guides/code/getting_started/Gemfile.lock +0 -125
- data/guides/code/getting_started/README.rdoc +0 -28
- data/guides/code/getting_started/Rakefile +0 -6
- data/guides/code/getting_started/app/assets/javascripts/application.js +0 -15
- data/guides/code/getting_started/app/assets/javascripts/comments.js.coffee +0 -3
- data/guides/code/getting_started/app/assets/javascripts/posts.js.coffee +0 -3
- data/guides/code/getting_started/app/assets/javascripts/welcome.js.coffee +0 -3
- data/guides/code/getting_started/app/assets/stylesheets/application.css +0 -13
- data/guides/code/getting_started/app/assets/stylesheets/comments.css.scss +0 -3
- data/guides/code/getting_started/app/assets/stylesheets/posts.css.scss +0 -3
- data/guides/code/getting_started/app/assets/stylesheets/welcome.css.scss +0 -3
- data/guides/code/getting_started/app/controllers/application_controller.rb +0 -5
- data/guides/code/getting_started/app/controllers/comments_controller.rb +0 -23
- data/guides/code/getting_started/app/controllers/posts_controller.rb +0 -53
- data/guides/code/getting_started/app/controllers/welcome_controller.rb +0 -4
- data/guides/code/getting_started/app/helpers/application_helper.rb +0 -2
- data/guides/code/getting_started/app/helpers/comments_helper.rb +0 -2
- data/guides/code/getting_started/app/helpers/posts_helper.rb +0 -2
- data/guides/code/getting_started/app/helpers/welcome_helper.rb +0 -2
- data/guides/code/getting_started/app/models/comment.rb +0 -3
- data/guides/code/getting_started/app/models/post.rb +0 -7
- data/guides/code/getting_started/app/views/comments/_comment.html.erb +0 -15
- data/guides/code/getting_started/app/views/comments/_form.html.erb +0 -13
- data/guides/code/getting_started/app/views/layouts/application.html.erb +0 -14
- data/guides/code/getting_started/app/views/posts/_form.html.erb +0 -27
- data/guides/code/getting_started/app/views/posts/edit.html.erb +0 -5
- data/guides/code/getting_started/app/views/posts/index.html.erb +0 -21
- data/guides/code/getting_started/app/views/posts/new.html.erb +0 -5
- data/guides/code/getting_started/app/views/posts/show.html.erb +0 -18
- data/guides/code/getting_started/app/views/welcome/index.html.erb +0 -4
- data/guides/code/getting_started/bin/bundle +0 -4
- data/guides/code/getting_started/bin/rails +0 -4
- data/guides/code/getting_started/bin/rake +0 -4
- data/guides/code/getting_started/config/application.rb +0 -18
- data/guides/code/getting_started/config/boot.rb +0 -4
- data/guides/code/getting_started/config/database.yml +0 -25
- data/guides/code/getting_started/config/environment.rb +0 -5
- data/guides/code/getting_started/config/environments/development.rb +0 -30
- data/guides/code/getting_started/config/environments/production.rb +0 -80
- data/guides/code/getting_started/config/environments/test.rb +0 -36
- data/guides/code/getting_started/config/initializers/backtrace_silencers.rb +0 -7
- data/guides/code/getting_started/config/initializers/filter_parameter_logging.rb +0 -4
- data/guides/code/getting_started/config/initializers/inflections.rb +0 -16
- data/guides/code/getting_started/config/initializers/locale.rb +0 -9
- data/guides/code/getting_started/config/initializers/mime_types.rb +0 -5
- data/guides/code/getting_started/config/initializers/secret_token.rb +0 -12
- data/guides/code/getting_started/config/initializers/session_store.rb +0 -3
- data/guides/code/getting_started/config/initializers/wrap_parameters.rb +0 -14
- data/guides/code/getting_started/config/locales/en.yml +0 -23
- data/guides/code/getting_started/config/routes.rb +0 -7
- data/guides/code/getting_started/config.ru +0 -4
- data/guides/code/getting_started/db/migrate/20130122042648_create_posts.rb +0 -10
- data/guides/code/getting_started/db/migrate/20130122045842_create_comments.rb +0 -11
- data/guides/code/getting_started/db/schema.rb +0 -33
- data/guides/code/getting_started/db/seeds.rb +0 -7
- data/guides/code/getting_started/public/404.html +0 -60
- data/guides/code/getting_started/public/422.html +0 -60
- data/guides/code/getting_started/public/500.html +0 -59
- data/guides/code/getting_started/public/favicon.ico +0 -0
- data/guides/code/getting_started/public/robots.txt +0 -5
- data/guides/code/getting_started/test/controllers/comments_controller_test.rb +0 -7
- data/guides/code/getting_started/test/controllers/posts_controller_test.rb +0 -7
- data/guides/code/getting_started/test/controllers/welcome_controller_test.rb +0 -9
- data/guides/code/getting_started/test/fixtures/comments.yml +0 -11
- data/guides/code/getting_started/test/fixtures/posts.yml +0 -9
- data/guides/code/getting_started/test/helpers/comments_helper_test.rb +0 -4
- data/guides/code/getting_started/test/helpers/posts_helper_test.rb +0 -4
- data/guides/code/getting_started/test/helpers/welcome_helper_test.rb +0 -4
- data/guides/code/getting_started/test/models/comment_test.rb +0 -7
- data/guides/code/getting_started/test/models/post_test.rb +0 -7
- data/guides/code/getting_started/test/test_helper.rb +0 -12
- data/guides/rails_guides/generator.rb +0 -248
- data/guides/rails_guides/helpers.rb +0 -53
- data/guides/rails_guides/indexer.rb +0 -68
- data/guides/rails_guides/kindle.rb +0 -119
- data/guides/rails_guides/levenshtein.rb +0 -31
- data/guides/rails_guides/markdown/renderer.rb +0 -82
- data/guides/rails_guides/markdown.rb +0 -163
- data/guides/rails_guides.rb +0 -63
- data/guides/source/2_2_release_notes.md +0 -435
- data/guides/source/2_3_release_notes.md +0 -621
- data/guides/source/3_0_release_notes.md +0 -611
- data/guides/source/3_1_release_notes.md +0 -556
- data/guides/source/3_2_release_notes.md +0 -565
- data/guides/source/4_0_release_notes.md +0 -276
- data/guides/source/4_1_release_notes.md +0 -731
- data/guides/source/_license.html.erb +0 -2
- data/guides/source/_welcome.html.erb +0 -25
- data/guides/source/action_controller_overview.md +0 -1175
- data/guides/source/action_mailer_basics.md +0 -689
- data/guides/source/action_view_overview.md +0 -1610
- data/guides/source/active_model_basics.md +0 -200
- data/guides/source/active_record_basics.md +0 -373
- data/guides/source/active_record_callbacks.md +0 -410
- data/guides/source/active_record_querying.md +0 -1773
- data/guides/source/active_record_validations.md +0 -1169
- data/guides/source/active_support_core_extensions.md +0 -3864
- data/guides/source/active_support_instrumentation.md +0 -496
- data/guides/source/api_documentation_guidelines.md +0 -315
- data/guides/source/asset_pipeline.md +0 -1163
- data/guides/source/association_basics.md +0 -2229
- data/guides/source/caching_with_rails.md +0 -354
- data/guides/source/command_line.md +0 -603
- data/guides/source/configuring.md +0 -942
- data/guides/source/contributing_to_ruby_on_rails.md +0 -544
- data/guides/source/credits.html.erb +0 -80
- data/guides/source/debugging_rails_applications.md +0 -707
- data/guides/source/development_dependencies_install.md +0 -278
- data/guides/source/documents.yaml +0 -193
- data/guides/source/engines.md +0 -1391
- data/guides/source/form_helpers.md +0 -1001
- data/guides/source/generators.md +0 -663
- data/guides/source/getting_started.md +0 -1947
- data/guides/source/i18n.md +0 -1043
- data/guides/source/index.html.erb +0 -27
- data/guides/source/initialization.md +0 -657
- data/guides/source/kindle/copyright.html.erb +0 -1
- data/guides/source/kindle/layout.html.erb +0 -27
- data/guides/source/kindle/rails_guides.opf.erb +0 -52
- data/guides/source/kindle/toc.html.erb +0 -24
- data/guides/source/kindle/toc.ncx.erb +0 -64
- data/guides/source/kindle/welcome.html.erb +0 -5
- data/guides/source/layout.html.erb +0 -146
- data/guides/source/layouts_and_rendering.md +0 -1226
- data/guides/source/maintenance_policy.md +0 -56
- data/guides/source/migrations.md +0 -1109
- data/guides/source/nested_model_forms.md +0 -225
- data/guides/source/plugins.md +0 -444
- data/guides/source/rails_application_templates.md +0 -248
- data/guides/source/rails_on_rack.md +0 -333
- data/guides/source/routing.md +0 -1115
- data/guides/source/ruby_on_rails_guides_guidelines.md +0 -128
- data/guides/source/security.md +0 -1018
- data/guides/source/testing.md +0 -1052
- data/guides/source/upgrading_ruby_on_rails.md +0 -899
- data/guides/source/working_with_javascript_in_rails.md +0 -405
- data/guides/w3c_validator.rb +0 -95
@@ -1,82 +0,0 @@
|
|
1
|
-
module RailsGuides
|
2
|
-
class Markdown
|
3
|
-
class Renderer < Redcarpet::Render::HTML
|
4
|
-
def initialize(options={})
|
5
|
-
super
|
6
|
-
end
|
7
|
-
|
8
|
-
def block_code(code, language)
|
9
|
-
<<-HTML
|
10
|
-
<div class="code_container">
|
11
|
-
<pre class="brush: #{brush_for(language)}; gutter: false; toolbar: false">
|
12
|
-
#{ERB::Util.h(code)}
|
13
|
-
</pre>
|
14
|
-
</div>
|
15
|
-
HTML
|
16
|
-
end
|
17
|
-
|
18
|
-
def header(text, header_level)
|
19
|
-
# Always increase the heading level by, so we can use h1, h2 heading in the document
|
20
|
-
header_level += 1
|
21
|
-
|
22
|
-
%(<h#{header_level}>#{text}</h#{header_level}>)
|
23
|
-
end
|
24
|
-
|
25
|
-
def paragraph(text)
|
26
|
-
if text =~ /^(TIP|IMPORTANT|CAUTION|WARNING|NOTE|INFO|TODO)[.:](.*?)/
|
27
|
-
convert_notes(text)
|
28
|
-
elsif text =~ /^\[<sup>(\d+)\]:<\/sup> (.+)$/
|
29
|
-
linkback = %(<a href="#footnote-#{$1}-ref"><sup>#{$1}</sup></a>)
|
30
|
-
%(<p class="footnote" id="footnote-#{$1}">#{linkback} #{$2}</p>)
|
31
|
-
else
|
32
|
-
text = convert_footnotes(text)
|
33
|
-
"<p>#{text}</p>"
|
34
|
-
end
|
35
|
-
end
|
36
|
-
|
37
|
-
private
|
38
|
-
|
39
|
-
def convert_footnotes(text)
|
40
|
-
text.gsub(/\[<sup>(\d+)\]<\/sup>/i) do
|
41
|
-
%(<sup class="footnote" id="footnote-#{$1}-ref">) +
|
42
|
-
%(<a href="#footnote-#{$1}">#{$1}</a></sup>)
|
43
|
-
end
|
44
|
-
end
|
45
|
-
|
46
|
-
def brush_for(code_type)
|
47
|
-
case code_type
|
48
|
-
when 'ruby', 'sql', 'plain'
|
49
|
-
code_type
|
50
|
-
when 'erb'
|
51
|
-
'ruby; html-script: true'
|
52
|
-
when 'html'
|
53
|
-
'xml' # html is understood, but there are .xml rules in the CSS
|
54
|
-
else
|
55
|
-
'plain'
|
56
|
-
end
|
57
|
-
end
|
58
|
-
|
59
|
-
def convert_notes(body)
|
60
|
-
# The following regexp detects special labels followed by a
|
61
|
-
# paragraph, perhaps at the end of the document.
|
62
|
-
#
|
63
|
-
# It is important that we do not eat more than one newline
|
64
|
-
# because formatting may be wrong otherwise. For example,
|
65
|
-
# if a bulleted list follows the first item is not rendered
|
66
|
-
# as a list item, but as a paragraph starting with a plain
|
67
|
-
# asterisk.
|
68
|
-
body.gsub(/^(TIP|IMPORTANT|CAUTION|WARNING|NOTE|INFO|TODO)[.:](.*?)(\n(?=\n)|\Z)/m) do
|
69
|
-
css_class = case $1
|
70
|
-
when 'CAUTION', 'IMPORTANT'
|
71
|
-
'warning'
|
72
|
-
when 'TIP'
|
73
|
-
'info'
|
74
|
-
else
|
75
|
-
$1.downcase
|
76
|
-
end
|
77
|
-
%(<div class="#{css_class}"><p>#{$2.strip}</p></div>)
|
78
|
-
end
|
79
|
-
end
|
80
|
-
end
|
81
|
-
end
|
82
|
-
end
|
@@ -1,163 +0,0 @@
|
|
1
|
-
# encoding: utf-8
|
2
|
-
|
3
|
-
require 'redcarpet'
|
4
|
-
require 'nokogiri'
|
5
|
-
require 'rails_guides/markdown/renderer'
|
6
|
-
|
7
|
-
module RailsGuides
|
8
|
-
class Markdown
|
9
|
-
def initialize(view, layout)
|
10
|
-
@view = view
|
11
|
-
@layout = layout
|
12
|
-
@index_counter = Hash.new(0)
|
13
|
-
@raw_header = ''
|
14
|
-
@node_ids = {}
|
15
|
-
end
|
16
|
-
|
17
|
-
def render(body)
|
18
|
-
@raw_body = body
|
19
|
-
extract_raw_header_and_body
|
20
|
-
generate_header
|
21
|
-
generate_title
|
22
|
-
generate_body
|
23
|
-
generate_structure
|
24
|
-
generate_index
|
25
|
-
render_page
|
26
|
-
end
|
27
|
-
|
28
|
-
private
|
29
|
-
|
30
|
-
def dom_id(nodes)
|
31
|
-
dom_id = dom_id_text(nodes.last.text)
|
32
|
-
|
33
|
-
# Fix duplicate node by prefix with its parent node
|
34
|
-
if @node_ids[dom_id]
|
35
|
-
if @node_ids[dom_id].size > 1
|
36
|
-
duplicate_nodes = @node_ids.delete(dom_id)
|
37
|
-
new_node_id = "#{duplicate_nodes[-2][:id]}-#{duplicate_nodes.last[:id]}"
|
38
|
-
duplicate_nodes.last[:id] = new_node_id
|
39
|
-
@node_ids[new_node_id] = duplicate_nodes
|
40
|
-
end
|
41
|
-
|
42
|
-
dom_id = "#{nodes[-2][:id]}-#{dom_id}"
|
43
|
-
end
|
44
|
-
|
45
|
-
@node_ids[dom_id] = nodes
|
46
|
-
dom_id
|
47
|
-
end
|
48
|
-
|
49
|
-
def dom_id_text(text)
|
50
|
-
text.downcase.gsub(/\?/, '-questionmark').gsub(/!/, '-bang').gsub(/[^a-z0-9]+/, ' ')
|
51
|
-
.strip.gsub(/\s+/, '-')
|
52
|
-
end
|
53
|
-
|
54
|
-
def engine
|
55
|
-
@engine ||= Redcarpet::Markdown.new(Renderer, {
|
56
|
-
no_intra_emphasis: true,
|
57
|
-
fenced_code_blocks: true,
|
58
|
-
autolink: true,
|
59
|
-
strikethrough: true,
|
60
|
-
superscript: true,
|
61
|
-
tables: true
|
62
|
-
})
|
63
|
-
end
|
64
|
-
|
65
|
-
def extract_raw_header_and_body
|
66
|
-
if @raw_body =~ /^\-{40,}$/
|
67
|
-
@raw_header, _, @raw_body = @raw_body.partition(/^\-{40,}$/).map(&:strip)
|
68
|
-
end
|
69
|
-
end
|
70
|
-
|
71
|
-
def generate_body
|
72
|
-
@body = engine.render(@raw_body)
|
73
|
-
end
|
74
|
-
|
75
|
-
def generate_header
|
76
|
-
@header = engine.render(@raw_header).html_safe
|
77
|
-
end
|
78
|
-
|
79
|
-
def generate_structure
|
80
|
-
@headings_for_index = []
|
81
|
-
if @body.present?
|
82
|
-
@body = Nokogiri::HTML(@body).tap do |doc|
|
83
|
-
hierarchy = []
|
84
|
-
|
85
|
-
doc.at('body').children.each do |node|
|
86
|
-
if node.name =~ /^h[3-6]$/
|
87
|
-
case node.name
|
88
|
-
when 'h3'
|
89
|
-
hierarchy = [node]
|
90
|
-
@headings_for_index << [1, node, node.inner_html]
|
91
|
-
when 'h4'
|
92
|
-
hierarchy = hierarchy[0, 1] + [node]
|
93
|
-
@headings_for_index << [2, node, node.inner_html]
|
94
|
-
when 'h5'
|
95
|
-
hierarchy = hierarchy[0, 2] + [node]
|
96
|
-
when 'h6'
|
97
|
-
hierarchy = hierarchy[0, 3] + [node]
|
98
|
-
end
|
99
|
-
|
100
|
-
node[:id] = dom_id(hierarchy)
|
101
|
-
node.inner_html = "#{node_index(hierarchy)} #{node.inner_html}"
|
102
|
-
end
|
103
|
-
end
|
104
|
-
end.to_html
|
105
|
-
end
|
106
|
-
end
|
107
|
-
|
108
|
-
def generate_index
|
109
|
-
if @headings_for_index.present?
|
110
|
-
raw_index = ''
|
111
|
-
@headings_for_index.each do |level, node, label|
|
112
|
-
if level == 1
|
113
|
-
raw_index += "1. [#{label}](##{node[:id]})\n"
|
114
|
-
elsif level == 2
|
115
|
-
raw_index += " * [#{label}](##{node[:id]})\n"
|
116
|
-
end
|
117
|
-
end
|
118
|
-
|
119
|
-
@index = Nokogiri::HTML(engine.render(raw_index)).tap do |doc|
|
120
|
-
doc.at('ol')[:class] = 'chapters'
|
121
|
-
end.to_html
|
122
|
-
|
123
|
-
@index = <<-INDEX.html_safe
|
124
|
-
<div id="subCol">
|
125
|
-
<h3 class="chapter"><img src="images/chapters_icon.gif" alt="" />Chapters</h3>
|
126
|
-
#{@index}
|
127
|
-
</div>
|
128
|
-
INDEX
|
129
|
-
end
|
130
|
-
end
|
131
|
-
|
132
|
-
def generate_title
|
133
|
-
if heading = Nokogiri::HTML(@header).at(:h2)
|
134
|
-
@title = "#{heading.text} — Ruby on Rails Guides".html_safe
|
135
|
-
else
|
136
|
-
@title = "Ruby on Rails Guides"
|
137
|
-
end
|
138
|
-
end
|
139
|
-
|
140
|
-
def node_index(hierarchy)
|
141
|
-
case hierarchy.size
|
142
|
-
when 1
|
143
|
-
@index_counter[2] = @index_counter[3] = @index_counter[4] = 0
|
144
|
-
"#{@index_counter[1] += 1}"
|
145
|
-
when 2
|
146
|
-
@index_counter[3] = @index_counter[4] = 0
|
147
|
-
"#{@index_counter[1]}.#{@index_counter[2] += 1}"
|
148
|
-
when 3
|
149
|
-
@index_counter[4] = 0
|
150
|
-
"#{@index_counter[1]}.#{@index_counter[2]}.#{@index_counter[3] += 1}"
|
151
|
-
when 4
|
152
|
-
"#{@index_counter[1]}.#{@index_counter[2]}.#{@index_counter[3]}.#{@index_counter[4] += 1}"
|
153
|
-
end
|
154
|
-
end
|
155
|
-
|
156
|
-
def render_page
|
157
|
-
@view.content_for(:header_section) { @header }
|
158
|
-
@view.content_for(:page_title) { @title }
|
159
|
-
@view.content_for(:index_section) { @index }
|
160
|
-
@view.render(:layout => @layout, :text => @body)
|
161
|
-
end
|
162
|
-
end
|
163
|
-
end
|
data/guides/rails_guides.rb
DELETED
@@ -1,63 +0,0 @@
|
|
1
|
-
pwd = File.dirname(__FILE__)
|
2
|
-
$:.unshift pwd
|
3
|
-
|
4
|
-
# This is a predicate useful for the doc:guides task of applications.
|
5
|
-
def bundler?
|
6
|
-
# Note that rake sets the cwd to the one that contains the Rakefile
|
7
|
-
# being executed.
|
8
|
-
File.exist?('Gemfile')
|
9
|
-
end
|
10
|
-
|
11
|
-
begin
|
12
|
-
# Guides generation in the Rails repo.
|
13
|
-
as_lib = File.join(pwd, "../activesupport/lib")
|
14
|
-
ap_lib = File.join(pwd, "../actionpack/lib")
|
15
|
-
|
16
|
-
$:.unshift as_lib if File.directory?(as_lib)
|
17
|
-
$:.unshift ap_lib if File.directory?(ap_lib)
|
18
|
-
rescue LoadError
|
19
|
-
# Guides generation from gems.
|
20
|
-
gem "actionpack", '>= 3.0'
|
21
|
-
end
|
22
|
-
|
23
|
-
begin
|
24
|
-
require 'redcarpet'
|
25
|
-
rescue LoadError
|
26
|
-
# This can happen if doc:guides is executed in an application.
|
27
|
-
$stderr.puts('Generating guides requires Redcarpet 2.1.1+.')
|
28
|
-
$stderr.puts(<<ERROR) if bundler?
|
29
|
-
Please add
|
30
|
-
|
31
|
-
gem 'redcarpet', '~> 2.1.1'
|
32
|
-
|
33
|
-
to the Gemfile, run
|
34
|
-
|
35
|
-
bundle install
|
36
|
-
|
37
|
-
and try again.
|
38
|
-
ERROR
|
39
|
-
exit 1
|
40
|
-
end
|
41
|
-
|
42
|
-
begin
|
43
|
-
require 'nokogiri'
|
44
|
-
rescue LoadError
|
45
|
-
# This can happen if doc:guides is executed in an application.
|
46
|
-
$stderr.puts('Generating guides requires Nokogiri.')
|
47
|
-
$stderr.puts(<<ERROR) if bundler?
|
48
|
-
Please add
|
49
|
-
|
50
|
-
gem 'nokogiri'
|
51
|
-
|
52
|
-
to the Gemfile, run
|
53
|
-
|
54
|
-
bundle install
|
55
|
-
|
56
|
-
and try again.
|
57
|
-
ERROR
|
58
|
-
exit 1
|
59
|
-
end
|
60
|
-
|
61
|
-
require 'rails_guides/markdown'
|
62
|
-
require "rails_guides/generator"
|
63
|
-
RailsGuides::Generator.new.generate
|