Merge pull request #27863 from robin850/api-improvements

Some improvements to the API site's sidebar

3 files changed, 47 insertions, 16 deletions

diff --git a/railties/lib/rails/api/generator.rb b/railties/lib/rails/api/generator.rb
new file mode 100644
index 0000000000..dcc491783c
--- /dev/null
+++ b/railties/lib/rails/api/generator.rb
@@ -0,0 +1,28 @@
+require "sdoc"
+
+class RDoc::Generator::API < RDoc::Generator::SDoc # :nodoc:
+  RDoc::RDoc.add_generator self
+
+  def generate_class_tree_level(classes, visited = {})
+    # Only process core extensions on the first visit.
+    if visited.empty?
+      core_exts, classes = classes.partition { |klass| core_extension?(klass) }
+
+      super.unshift([ "Core extensions", "", "", build_core_ext_subtree(core_exts, visited) ])
+    else
+      super
+    end
+  end
+
+  private
+    def build_core_ext_subtree(classes, visited)
+      classes.map do |klass|
+        [ klass.name, klass.document_self_or_methods ? klass.path : "", "",
+            generate_class_tree_level(klass.classes_and_modules, visited) ]
+      end
+    end
+
+    def core_extension?(klass)
+      klass.name != "ActiveSupport" && klass.in_files.any? { |file| file.absolute_name.include?("core_ext") }
+    end
+end
diff --git a/railties/lib/rails/api/task.rb b/railties/lib/rails/api/task.rb
index bc670b1d75..d1f984be1d 100644
--- a/railties/lib/rails/api/task.rb
+++ b/railties/lib/rails/api/task.rb
@@ -1,4 +1,5 @@
 require "rdoc/task"
+require "rails/api/generator"
 
 module Rails
   module API
@@ -8,8 +9,7 @@ module Rails
           include: %w(
             README.rdoc
             lib/active_support/**/*.rb
-          ),
-          exclude: "lib/active_support/vendor/*"
+          )
         },
 
         "activerecord" => {
@@ -69,7 +69,11 @@ module Rails
             README.rdoc
             lib/**/*.rb
           ),
-          exclude: "lib/rails/generators/rails/**/templates/**/*.rb"
+          exclude: %w(
+            lib/rails/generators/rails/**/templates/**/*.rb
+            lib/rails/test_unit/*
+            lib/rails/api/generator.rb
+          )
         }
       }
 
@@ -80,7 +84,7 @@ module Rails
         # Be lazy computing stuff to have as light impact as possible to
         # the rest of tasks.
         before_running_rdoc do
-          load_and_configure_sdoc
+          configure_sdoc
           configure_rdoc_files
           setup_horo_variables
         end
@@ -91,20 +95,15 @@ module Rails
         # no-op
       end
 
-      def load_and_configure_sdoc
-        require "sdoc"
-
+      def configure_sdoc
         self.title    = "Ruby on Rails API"
         self.rdoc_dir = api_dir
 
         options << "-m"  << api_main
         options << "-e"  << "UTF-8"
 
-        options << "-f"  << "sdoc"
+        options << "-f"  << "api"
         options << "-T"  << "rails"
-      rescue LoadError
-        $stderr.puts %(Unable to load SDoc, please add\n\n    gem 'sdoc', require: false\n\nto the Gemfile.)
-        exit 1
       end
 
       def configure_rdoc_files
@@ -147,7 +146,7 @@ module Rails
     end
 
     class RepoTask < Task
-      def load_and_configure_sdoc
+      def configure_sdoc
         super
         options << "-g" # link to GitHub, SDoc flag
       end
diff --git a/railties/lib/rails/test_help.rb b/railties/lib/rails/test_help.rb
index 5fda160012..0f9bf98737 100644
--- a/railties/lib/rails/test_help.rb
+++ b/railties/lib/rails/test_help.rb
@@ -14,10 +14,12 @@ require "active_support/testing/autorun"
 if defined?(ActiveRecord::Base)
   ActiveRecord::Migration.maintain_test_schema!
 
-  class ActiveSupport::TestCase
-    include ActiveRecord::TestFixtures
-    self.fixture_path = "#{Rails.root}/test/fixtures/"
-    self.file_fixture_path = fixture_path + "files"
+  module ActiveSupport
+    class TestCase
+      include ActiveRecord::TestFixtures
+      self.fixture_path = "#{Rails.root}/test/fixtures/"
+      self.file_fixture_path = fixture_path + "files"
+    end
   end
 
   ActionDispatch::IntegrationTest.fixture_path = ActiveSupport::TestCase.fixture_path
@@ -27,6 +29,8 @@ if defined?(ActiveRecord::Base)
   end
 end
 
+# :enddoc:
+
 class ActionController::TestCase
   def before_setup # :nodoc:
     @routes = Rails.application.routes