Module: GrapeOAS::Exporter::Concerns::TagBuilder

Included in:
OAS2Schema, OAS3Schema
Defined in:
lib/grape_oas/exporter/concerns/tag_builder.rb

Overview

Shared tag-building logic for OAS2 and OAS3 schema exporters. Extracts tag definitions from operations and normalizes tag formats.

Instance Method Summary collapse

Instance Method Details

#build_tags ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/grape_oas/exporter/concerns/tag_builder.rb', line 9

def build_tags
  used_tag_names = collect_used_tag_names
  seen_names = Set.new
  tags = Array(@api.tag_defs).filter_map do |tag|
    normalized = normalize_tag(tag)
    tag_name = normalized["name"]
    # Only include tags that are actually used by operations and not already seen
    next if seen_names.include?(tag_name) || !used_tag_names.include?(tag_name)

    seen_names << tag_name
    normalized
  end
  tags.empty? ? nil : tags
end

#collect_used_tag_names ⇒ Object 



43
44
45
46
47
48
49
50
51
 
# File 'lib/grape_oas/exporter/concerns/tag_builder.rb', line 43

def collect_used_tag_names
  used_tags = Set.new
  @api.paths.each do |path|
    path.operations.each do |op|
      Array(op.tag_names).each { |t| used_tags << t }
    end
  end
  used_tags
end

#normalize_tag(tag) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/grape_oas/exporter/concerns/tag_builder.rb', line 24

def normalize_tag(tag)
  if tag.is_a?(Hash)
    # Convert symbol keys to string keys
    tag.transform_keys(&:to_s)
  elsif tag.respond_to?(:name)
    h = { "name" => tag.name.to_s }
    h["description"] = tag.description if tag.respond_to?(:description)
    h
  else
    name = tag.to_s
    desc = if defined?(ActiveSupport::Inflector)
             "Operations about #{ActiveSupport::Inflector.pluralize(name)}"
           else
             "Operations about #{name}s"
           end
    { "name" => name, "description" => desc }
  end
end