69 lines
2.2 KiB
Ruby
69 lines
2.2 KiB
Ruby
#
|
|
# Copyright (C) 2011 Instructure, Inc.
|
|
#
|
|
# This file is part of Canvas.
|
|
#
|
|
# Canvas is free software: you can redistribute it and/or modify it under
|
|
# the terms of the GNU Affero General Public License as published by the Free
|
|
# Software Foundation, version 3 of the License.
|
|
#
|
|
# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
|
|
# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
|
|
# details.
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License along
|
|
# with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
|
|
require 'lib/api_route_set'
|
|
require 'bundler'
|
|
Bundler.setup
|
|
require 'action_controller'
|
|
if CANVAS_RAILS2
|
|
require 'fake_rails3_routes'
|
|
end
|
|
|
|
# load routing files, including those in plugins
|
|
require 'config/routes'
|
|
Dir.glob('vendor/plugins/*/config/routes.rb').each do |plugin_routes|
|
|
require plugin_routes.gsub(/\.rb$/, '')
|
|
end
|
|
|
|
# Extend YARD to generate our API documentation
|
|
YARD::Tags::Library.define_tag("Is an API method", :API)
|
|
YARD::Tags::Library.define_tag("API method argument", :argument)
|
|
YARD::Tags::Library.define_tag("API response field", :request_field)
|
|
YARD::Tags::Library.define_tag("API response field", :response_field)
|
|
YARD::Tags::Library.define_tag("API example request", :example_request)
|
|
YARD::Tags::Library.define_tag("API example response", :example_response)
|
|
YARD::Tags::Library.define_tag("API subtopic", :subtopic)
|
|
YARD::Tags::Library.define_tag("API resource is Beta", :beta)
|
|
YARD::Tags::Library.define_tag("API Object Definition", :object)
|
|
YARD::Tags::Library.define_tag("API Return Type", :returns)
|
|
YARD::Tags::Library.define_tag("API resource is internal", :internal)
|
|
|
|
module YARD::Templates::Helpers
|
|
module BaseHelper
|
|
def run_verifier(list)
|
|
list.select { |o| relevant_object?(o) }
|
|
end
|
|
|
|
def relevant_object?(object)
|
|
case object.type
|
|
when :root, :module, :constant
|
|
false
|
|
when :method, :class
|
|
!object.tags("API").empty? && (ENV['INCLUDE_INTERNAL'] || object.tags('internal').empty?)
|
|
else
|
|
if object.parent.nil?
|
|
false
|
|
else
|
|
relevant_object?(object.parent)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|