Module: Rapidoc::ResourcesExtractor

Included in:
Rapidoc
Defined in:
lib/rapidoc/resources_extractor.rb

Overview

This module get resources info.

Info of each route include:

  • method

  • action

  • url

  • controller_file

Instance Method Summary collapse

Instance Method Details

#get_resources ⇒ Array

Create new ResourceDoc for each resource extracted from RoutesDoc

Returns:

  • (Array) —

    ResourceDoc array



35
36
37
38
39
40
41
42
43
 
# File 'lib/rapidoc/resources_extractor.rb', line 35

def get_resources
  routes_doc = get_routes_doc
  resources_names = routes_doc.get_resources_names - resources_black_list

  resources_names.map do |resource|
    puts "Generating #{resource} documentation..." if trace?
    ResourceDoc.new( resource, routes_doc.get_actions_route_info( resource ) )
  end
end

#get_routes_doc ⇒ RoutesDoc

Reads ‘rake routes’ output and gets the routes info

Returns:



18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/rapidoc/resources_extractor.rb', line 18

def get_routes_doc
  puts "Executing 'rake routes'..." if trace?

  routes_doc = RoutesDoc.new
  routes = Dir.chdir( ::Rails.root.to_s ) { `rake routes` }

  routes.split("\n").each do |entry|
    routes_doc.add_route( entry ) unless entry.match(/URI/)
  end

  routes_doc
end