From 7a5aa720c417a0a9beb843a41561e26f69f79c99 Mon Sep 17 00:00:00 2001
From: Xavier Noria <fxn@hashref.com>
Date: Fri, 29 Mar 2013 21:16:12 +0100
Subject: encapsulates API generation in Rails::API::Task

---
 railties/lib/rails/api/task.rb | 122 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 122 insertions(+)
 create mode 100644 railties/lib/rails/api/task.rb

(limited to 'railties')

diff --git a/railties/lib/rails/api/task.rb b/railties/lib/rails/api/task.rb
new file mode 100644
index 0000000000..92bd192468
--- /dev/null
+++ b/railties/lib/rails/api/task.rb
@@ -0,0 +1,122 @@
+require 'rdoc/task'
+
+module Rails
+  module API
+    class Task < RDoc::Task
+      RDOC_FILES = {
+        'activesupport' => {
+          :include => %w(
+            README.rdoc
+            CHANGELOG.md
+            lib/active_support/**/*.rb
+          ),
+          :exclude => 'lib/active_support/vendor/*'
+        },
+
+        'activerecord' => {
+          :include => %w(
+            README.rdoc
+            CHANGELOG.md
+            lib/active_record/**/*.rb
+          ),
+          :exclude => 'lib/active_record/vendor/*'
+        },
+
+        'activemodel' => {
+          :include => %w(
+            README.rdoc
+            CHANGELOG.md
+            lib/active_model/**/*.rb
+          )
+        },
+
+        'actionpack' => {
+          :include => %w(
+            README.rdoc
+            CHANGELOG.md
+            lib/abstract_controller/**/*.rb
+            lib/action_controller/**/*.rb
+            lib/action_dispatch/**/*.rb
+            lib/action_view/**/*.rb
+          ),
+          :exclude => 'lib/action_controller/vendor/*'
+        },
+
+        'actionmailer' => {
+          :include => %w(
+            README.rdoc
+            CHANGELOG.md
+            lib/action_mailer/**/*.rb
+          ),
+          :exclude => 'ib/action_mailer/vendor/*'
+        },
+
+        'railties' => {
+          :include => %w(
+            README.rdoc
+            CHANGELOG.md
+            MIT-LICENSE
+            lib/**/*.rb
+          )
+        }
+      }
+
+      def initialize(name)
+        super
+
+        self.title    = 'Ruby on Rails API'
+        self.rdoc_dir = api_dir
+
+        options << '-m'  << api_main
+        options << '-e'  << 'UTF-8'
+        options << '-f'  << 'sdoc'
+        options << '-T'  << 'rails'
+        options << '-g' # link to GitHub, SDoc flag
+
+        configure_rdoc_files
+
+        before_running_rdoc do
+          setup_horo_variables
+        end
+      end
+
+      # Hack, ignore the desc calls performed by the original initializer.
+      def desc(description)
+        # no-op
+      end
+
+      def configure_rdoc_files
+        rdoc_files.include(api_main)
+
+        RDOC_FILES.each do |component, cfg|
+          cdr = component_root_dir(component)
+
+          Array(cfg[:include]).each do |pattern|
+            rdoc_files.include("#{cdr}/#{pattern}")
+          end
+
+          Array(cfg[:exclude]).each do |pattern|
+            rdoc_files.exclude("#{cdr}/#{pattern}")
+          end
+        end
+      end
+
+      def api_main
+        'RDOC_MAIN.rdoc'
+      end
+
+      def api_dir
+        'doc/rdoc'
+      end
+
+      def component_root_dir(component)
+        component
+      end
+
+      def setup_horo_variables
+        ENV['HORO_PROJECT_NAME']    = 'Ruby on Rails'
+        ENV['HORO_PROJECT_VERSION'] = "master@#{`git rev-parse HEAD`[0, 7]}"
+      end
+    end
+  end
+end
-- 
cgit v1.2.3