require 'fileutils'
namespace :apipie do
desc "Generate static documentation" # You can specify OUT=output_base_file to have the following structure: # # output_base_file.html # output_base_file-onepage.html # output_base_file # | - resource1.html # | - resource1 # | - | - method1.html # | - | - method2.html # | - resource2.html # # By default OUT="#{Rails.root}/doc/apidoc" task :static, [:version] => :environment do |t, args| with_loaded_documentation do args.with_defaults(:version => Apipie.configuration.default_version) out = ENV["OUT"] || File.join(::Rails.root, 'doc', 'apidoc') subdir = File.basename(out) copy_jscss(out) Apipie.configuration.version_in_url = false Apipie.url_prefix = "./#{subdir}" doc = Apipie.to_json(args[:version]) generate_one_page(out, doc) generate_plain_page(out, doc) generate_index_page(out, doc) Apipie.url_prefix = "../#{subdir}" generate_resource_pages(args[:version], out, doc) Apipie.url_prefix = "../../#{subdir}" generate_method_pages(args[:version], out, doc) end end desc "Generate cache to avoid production dependencies on markup languages" task :cache => :environment do with_loaded_documentation do cache_dir = Apipie.configuration.cache_dir subdir = Apipie.configuration.doc_base_url.sub(/\A\//,"") file_base = File.join(cache_dir, Apipie.configuration.doc_base_url) Apipie.url_prefix = "./#{subdir}" doc = Apipie.to_json(Apipie.configuration.default_version) generate_index_page(file_base, doc, true) Apipie.available_versions.each do |version| file_base_version = File.join(file_base, version) Apipie.url_prefix = "../#{subdir}" doc = Apipie.to_json(version) generate_index_page(file_base_version, doc, true, true) Apipie.url_prefix = "../../#{subdir}" generate_resource_pages(version, file_base_version, doc, true) Apipie.url_prefix = "../../../#{subdir}" generate_method_pages(version, file_base_version, doc, true) end end end def renderer ActionView::Base.new(File.expand_path("../../../app/views/apipie/apipies", __FILE__)) end def render_page(file_name, template, variables, layout = 'apipie') av = renderer File.open(file_name, "w") do |f| variables.each do |var, val| av.instance_variable_set("@#{var}", val) end f.write av.render( :template => "#{template}", :layout => (layout && "../../layouts/apipie/#{layout}")) end end def generate_one_page(file_base, doc) FileUtils.mkdir_p(File.dirname(file_base)) unless File.exists?(File.dirname(file_base)) render_page("#{file_base}-onepage.html", "static", {:doc => doc[:docs]}) end def generate_plain_page(file_base, doc) FileUtils.mkdir_p(File.dirname(file_base)) unless File.exists?(File.dirname(file_base)) render_page("#{file_base}-plain.html", "plain", {:doc => doc[:docs]}, nil) end def generate_index_page(file_base, doc, include_json = false, show_versions = false) FileUtils.mkdir_p(File.dirname(file_base)) unless File.exists?(File.dirname(file_base)) versions = show_versions && Apipie.available_versions render_page("#{file_base}.html", "index", {:doc => doc[:docs], :versions => versions}) File.open("#{file_base}.json", "w") { |f| f << doc.to_json } if include_json end def generate_resource_pages(version, file_base, doc, include_json = false) doc[:docs][:resources].each do |resource_name, _| resource_file_base = File.join(file_base, resource_name.to_s) FileUtils.mkdir_p(File.dirname(resource_file_base)) unless File.exists?(File.dirname(resource_file_base)) doc = Apipie.to_json(version, resource_name) render_page("#{resource_file_base}.html", "resource", {:doc => doc[:docs], :resource => doc[:docs][:resources].first}) File.open("#{resource_file_base}.json", "w") { |f| f << doc.to_json } if include_json end end def generate_method_pages(version, file_base, doc, include_json = false) doc[:docs][:resources].each do |resource_name, resource_params| resource_params[:methods].each do |method| method_file_base = File.join(file_base, resource_name.to_s, method[:name].to_s) FileUtils.mkdir_p(File.dirname(method_file_base)) unless File.exists?(File.dirname(method_file_base)) doc = Apipie.to_json(version, resource_name, method[:name]) render_page("#{method_file_base}.html", "method", {:doc => doc[:docs], :resource => doc[:docs][:resources].first, :method => doc[:docs][:resources].first[:methods].first}) File.open("#{method_file_base}.json", "w") { |f| f << doc.to_json } if include_json end end end def with_loaded_documentation Apipie.configuration.use_cache = false # we don't want to skip DSL evaluation Dir[File.join(Rails.root, "app", "controllers", "**","*.rb")].each {|f| load f} yield end def copy_jscss(dest) src = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'app', 'public', 'apipie')) FileUtils.mkdir_p dest FileUtils.cp_r "#{src}/.", dest end desc "Generate CLI client for API documented with apipie gem. (deprecated)" task :client do puts <<MESSAGE
The apipie gem itself doesn't provide client code generator. See github.com/Pajk/apipie-rails/wiki/CLI-client for more information on how to write your own generator. MESSAGE
end def plaintext(text) text.gsub(/<.*?>/, '').gsub("\n",' ').strip end desc "Update api description in controllers base on routes" task :update_from_routes => [:environment] do Apipie.configuration.force_dsl = true ignored = Apipie.configuration.ignored_by_recorder with_loaded_documentation do apis_from_routes = Apipie::Extractor.apis_from_routes apis_from_routes.each do |(controller, action), apis| next if ignored.include?(controller) next if ignored.include?("#{controller}##{action}") Apipie::Extractor::Writer.update_action_description(controller.constantize, action) do |u| u.update_apis(apis) end end end end
end