Class: RestfulDocGenerator

Inherits:
Object
  • Object
show all
Defined in:
lib/praxis/tasks/api_docs.rb

Defined Under Namespace

Classes: Resource

Constant Summary collapse

API_DOCS_DIRNAME = 
'api_docs'
EXCLUDED_TYPES_FROM_TOP_LEVEL = 
Set.new( [Attributor::Boolean, Attributor::CSV, Attributor::DateTime, Attributor::Float, Attributor::Hash, Attributor::Ids, Attributor::Integer, Attributor::Object,  Attributor::String ] ).freeze

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(root_dir) ⇒ RestfulDocGenerator

Returns a new instance of RestfulDocGenerator.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/praxis/tasks/api_docs.rb', line 90

def initialize(root_dir)
  @root_dir = root_dir
  @doc_root_dir = File.join(@root_dir, API_DOCS_DIRNAME)
  @resources = []

  remove_previous_doc_data
  load_resources

  # Gather all reachable types (grouped by version)
  types_for = Hash.new
  @resources.each do |r|
    types_for[r.version] ||= Set.new
    types_for[r.version] += r.reachable_types
  end

  write_resources
  write_types(types_for)
  write_index(types_for)
  write_templates(types_for)
end

Class Attribute Details

.inspected_types ⇒ Object (readonly)

Returns the value of attribute inspected_types.



4
5
6
 
# File 'lib/praxis/tasks/api_docs.rb', line 4

def inspected_types
  @inspected_types
end

Class Method Details

.inspect_attributes(the_type) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/praxis/tasks/api_docs.rb', line 12

def self.inspect_attributes(the_type)

  reachable = Set.new
  return reachable if the_type.nil? || the_type.is_a?(Praxis::SimpleMediaType)

  # If an attribute comes in, get its type
  the_type = the_type.type if the_type.is_a? Attributor::Attribute

  # Collection types are special since they wrap a member type, so let's reach in and grab it
  the_type = the_type.member_attribute.type if the_type < Attributor::Collection

  if @inspected_types.include? the_type
    # We're done if we've already inspected it
    return reachable
  else
    # Mark it as inspected (before recursing)
    @inspected_types << the_type  unless the_type.name == nil # Don't bother with anon structs
  end
  #puts "Inspecting type: #{the_type.name}"    if the_type.name != nil

  reachable << the_type  unless the_type.name == nil # Don't bother with anon structs
  if the_type.respond_to? :attributes
    the_type.attributes.each do |name, attr|
      attr_type = attr.type
      #puts "Inspecting attr: #{name} (class: #{attr_type.name}) #{attr_type.inspect}"
      reachable += self.inspect_attributes(attr_type)
    end
  end
  reachable
end

Instance Method Details

#dump_example_for(context_name, object) ⇒ Object 



118
119
120
121
122
123
124
125
 
# File 'lib/praxis/tasks/api_docs.rb', line 118

def dump_example_for(context_name, object)
  example = object.example(Array(context_name))
  if object.is_a? Praxis::Blueprint
    example.render(:master)
  else
    example.dump
  end
end

#load_resources ⇒ Object 



111
112
113
114
115
116
 
# File 'lib/praxis/tasks/api_docs.rb', line 111

def load_resources
  Praxis::Application.instance.resource_definitions.map do |resource|
    @resources << Resource.new(resource)
  end

end

#write_index(versioned_types) ⇒ Object

index looks like something like this:

{'1.0':
       {
       // Typical entry for controller with an associated mediatype
       "Post" : { media_type: "V1::MT:Post" , controller: "V1:Ctrl:Post"}
       // Unusual entry for controller without an associated mediatype
       "Admin" : { controller: "V1:Ctrl:Admin" }
       // Entry for mediatype that somehow is not associated with any controller...
       "RemoteMT" : { media_type: "V1:Ctrl:RemoteMT" }
       // Entry to a non-primitive type (but not a mediatype), that it is not covered by any related controller or mt
       "Locale" : { kind: "Module::Locale"}
       }

'2.0': {  ... }
}



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/praxis/tasks/api_docs.rb', line 202

def write_index( versioned_types )
  index = Hash.new
  media_types_seen_from_controllers = Set.new
  # Process the resources first

  @resources.each do |r|
    index[r.version] ||= Hash.new
    info = {controller: r.id}
    if r.media_type
      info[:media_type] = r.media_type.name
      media_types_seen_from_controllers << r.media_type
    end
    display_name  = r.id.split("::").last
    index[r.version][display_name] = info
  end

  versioned_types.each do |version, types|
    # Discard any mediatypes that we've already seen and processed as controller related
    reportable_types = types - media_types_seen_from_controllers - EXCLUDED_TYPES_FROM_TOP_LEVEL
    #TODO: think about these special cases, is it needed?
    reportable_types.reject!{|type| type < Praxis::Links || type < Praxis::MediaTypeCollection } 

    reportable_types.each do |type|
      index[version] ||= Hash.new
      display_name = type.name.split("::").last + " (*)" #somehow this is just a MT so we probably wanna mark it different
      if index[version].has_key? display_name
        raise "Display name already taken for version #{version}! #{display_name}"
      end
      index[version][display_name] = if type < Praxis::MediaType
        {media_type: type.name }
      else
        {kind: type.name}
      end
    end
  end
  filename = File.join(@doc_root_dir, "index.json")
  dirname = File.dirname(filename)
  FileUtils.mkdir_p dirname unless File.exists? dirname
  File.open(filename, 'w') {|f| f.write(JSON.dump(index))}
end

#write_resources ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/praxis/tasks/api_docs.rb', line 127

def write_resources
  @resources.each do |r|
    filename = File.join(@doc_root_dir, r.version, "resources","#{r.id}.json")
    #puts "Dumping #{r.id} to #{filename}"
    base = File.dirname(filename)
    FileUtils.mkdir_p base unless File.exists? base
    resource_description = r.controller_config.describe
    # Go through the params/payload of each action and generate an example for them (then stick it into the description hash)
    r.controller_config.actions.each do |action_name, action|
      generated_examples = {}
      if action.params
        generated_examples[:params] = dump_example_for( r.id, action.params )
      end
      if action.payload
        generated_examples[:payload] = dump_example_for( r.id, action.payload )
      end
      action_description = resource_description[:actions].find{|a| a[:name] == action_name }
      action_description[:params][:example] = generated_examples[:params] if generated_examples[:params]
      action_description[:payload][:example] = generated_examples[:payload] if generated_examples[:payload]
    end

    File.open(filename, 'w') {|f| f.write(JSON.dump(resource_description))}
  end
end

#write_template(version, top_templates = nil) ⇒ Object 



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/praxis/tasks/api_docs.rb', line 252

def write_template(version,top_templates=nil)
  # Collect template filenames (grouped by type: embedded vs. standalone)
  templates_dir = File.join(@root_dir,"doc_browser","templates",version)

  # Slurp in any top level (unversioned) templates if any
  # Top level templates will apply to any versioned one (and can be overwritten
  # if the version defines their own)
  templates = {embedded: {}, standalone: {} }
  if top_templates
    templates[:embedded] = top_templates[:embedded].clone
    templates[:standalone] = top_templates[:standalone].clone
  end

  dual = Dir.glob(File.join(templates_dir,"*.tmpl"))
  embedded = Dir.glob(File.join(templates_dir,"embedded","*.tmpl"))
  standalone = Dir.glob(File.join(templates_dir,"standalone","*.tmpl"))

  # TODO: Encode the contents more appropriately rather than dumping a string
  # Templates defined at the top will apply to both embedded and standalone
  # But it can be overriden if the same type exists in the more specific directory
  dual.each do |filename|
    type_key = File.basename(filename).gsub(/.tmpl$/,'')
    contents = IO.read(filename)
    templates[:embedded][type_key] = contents
    templates[:standalone][type_key] = contents
  end

  # For each embedded one, create a key in the embedded section, and encode the file contents in the value
  embedded.each do |filename|
    type_key = File.basename(filename).gsub(/.tmpl$/,'')
    templates[:embedded][type_key] = IO.read(filename)
  end
  # For each standalone one, create a key in the standalone section, and encode the file contents in the value
  standalone.each do |filename|
    type_key = File.basename(filename).gsub(/.tmpl$/,'')
    templates[:standalone][type_key] = IO.read(filename)
  end

  [:embedded,:standalone].each do |type|
    v = version.empty? ? "top level": version
    puts "Packaging #{v} #{type} templates for: #{templates[type].keys}" unless templates[type].keys.empty?
  end

  # Write the resulting hash to the final file in the docs directory
  filename = File.join(@doc_root_dir, version, "templates.json")
  dirname = File.dirname(filename)
  FileUtils.mkdir_p dirname unless File.exists? dirname
  File.open(filename, 'w') {|f| f.write(JSON.dump(templates))}
  return templates
end

#write_templates(versioned_types) ⇒ Object 



243
244
245
246
247
248
249
250
 
# File 'lib/praxis/tasks/api_docs.rb', line 243

def write_templates(versioned_types)
  # Calculate and write top-level (non-versioned) templates
  top_templates = write_template("")
  # Calculate and write versioned templates (passing the top level ones for inheritance)
  versioned_types.keys.each do |version|
    write_template(version,top_templates)
  end
end

#write_types(versioned_types) ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/praxis/tasks/api_docs.rb', line 152

def write_types( versioned_types )
  versioned_types.each do |version, types|
    dirname = File.join(@doc_root_dir, version, "types")
    FileUtils.mkdir_p dirname unless File.exists? dirname
    reportable_types = types - EXCLUDED_TYPES_FROM_TOP_LEVEL
    reportable_types.each do |type|
      filename = File.join(dirname, "#{type.name}.json")
      #puts "Dumping #{type.name} to #{filename}"
      type_output = type.describe
      example_data = type.example(type.to_s)
      if type_output[:views]
        type_output[:views].delete(:master)
        type_output[:views].each do |view_name, view_info|
          # Add and example for each view
          unless( type < Praxis::Links ) #TODO: why do we need to skip an example for links?
            view_info[:example] = example_data.render(view_name)
          end
        end
      end
      # Save a full type example
      # ...but not for links or link classes (there's no object container context if done alone!!)
      unless( type < Praxis::Links ) #TODO: again, why is this special?
        type_output[:example] = if example_data.respond_to? :render
          example_data.render(:master)
        else
          example_data.dump
        end
      end

      # add an example for each attribute??
      File.open(filename, 'w') {|f| f.write(JSON.dump(type_output))}
    end
  end
end