Module: RESTFramework::Utils

Defined in:
lib/rest_framework/utils.rb

Constant Summary collapse

HTTP_METHOD_ORDERING = 
%w(GET POST PUT PATCH DELETE OPTIONS HEAD)
LABEL_FIELDS = 
%w(name label login title email username url)

Class Method Summary collapse

Class Method Details

.comparable_path(path) ⇒ Object

Normalize a path pattern by replacing URL params with generic placeholder, and removing the ‘(.:format)` at the end.



74
75
76
 
# File 'lib/rest_framework/utils.rb', line 74

def self.comparable_path(path)
  return path.gsub("(.:format)", "").gsub(/:[0-9A-Za-z_-]+/, ":x")
end

.fields_for(model, exclude_associations: nil) ⇒ Object

Get the fields for a given model, including not just columns (which includes foreign keys), but also associations.



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/rest_framework/utils.rb', line 161

def self.fields_for(model, exclude_associations: nil)
  foreign_keys = model.reflect_on_all_associations(:belongs_to).map(&:foreign_key)

  if exclude_associations
    return model.column_names.reject { |c| c.in?(foreign_keys) }
  end

  # Add associations in addition to normal columns.
  return model.column_names.reject { |c|
    c.in?(foreign_keys)
  } + model.reflections.map { |association, ref|
    # Exclude certain associations (by default, active storage and action text associations).
    if ref.class_name.in?(RESTFramework.config.exclude_association_classes)
      next nil
    end

    if ref.collection? && RESTFramework.config.large_reverse_association_tables&.include?(
      ref.table_name,
    )
      next nil
    end

    next association
  }.compact
end

.get_request_route(application_routes, request) ⇒ Object

Get the first route pattern which matches the given request.



68
69
70
 
# File 'lib/rest_framework/utils.rb', line 68

def self.get_request_route(application_routes, request)
  application_routes.router.recognize(request) { |route, _| return route }
end

.get_routes(application_routes, request, current_route: nil) ⇒ Object

Show routes under a controller action; used for the browsable API.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/rest_framework/utils.rb', line 79

def self.get_routes(application_routes, request, current_route: nil)
  current_route ||= self.get_request_route(application_routes, request)
  current_path = current_route.path.spec.to_s.gsub("(.:format)", "")
  current_path = "" if current_path == "/"
  current_levels = current_path.count("/")
  current_comparable_path = %r{^#{Regexp.quote(self.comparable_path(current_path))}(/|$)}

  # Add helpful properties of the current route.
  path_args = current_route.required_parts.map { |n| request.path_parameters[n] }
  route_props = {
    with_path_args: ->(r) {
      r.format(r.required_parts.each_with_index.map { |p, i| [p, path_args[i]] }.to_h)
    },
  }

  # Return routes that match our current route subdomain/pattern, grouped by controller. We
  # precompute certain properties of the route for performance.
  return route_props, application_routes.routes.select { |r|
    # We `select` first to avoid unnecessarily calculating metadata for routes we don't even want
    # to show.
    (
      (r.defaults[:subdomain].blank? || r.defaults[:subdomain] == request.subdomain) &&
      current_comparable_path.match?(self.comparable_path(r.path.spec.to_s)) &&
      r.defaults[:controller].present? &&
      r.defaults[:action].present?
    )
  }.map { |r|
    path = r.path.spec.to_s.gsub("(.:format)", "")
    levels = path.count("/")
    matches_path = current_path == path
    matches_params = r.required_parts.length == current_route.required_parts.length

    {
      route: r,
      verb: r.verb,
      path: path,
      # Starts at the number of levels in current path, and removes the `(.:format)` at the end.
      relative_path: path.split("/")[current_levels..]&.join("/").presence || "/",
      controller: r.defaults[:controller].presence,
      action: r.defaults[:action].presence,
      matches_path: matches_path,
      matches_params: matches_params,
      # The following options are only used in subsequent processing in this method.
      _levels: levels,
    }
  }.sort_by { |r|
    # Sort by levels first, so the routes matching closely with current request show first, then
    # by the path, and finally by the HTTP verb.
    [r[:_levels], r[:_path], HTTP_METHOD_ORDERING.index(r[:verb]) || 99]
  }.group_by { |r| r[:controller] }.sort_by { |c, _r|
    # Sort the controller groups by current controller first, then alphanumerically.
    [request.params[:controller] == c ? 0 : 1, c]
  }.to_h
end

.get_skipped_builtin_actions(controller_class) ⇒ Object

Get actions which should be skipped for a given controller.



59
60
61
62
63
64
65
 
# File 'lib/rest_framework/utils.rb', line 59

def self.get_skipped_builtin_actions(controller_class)
  return (
    RESTFramework::BUILTIN_ACTIONS.keys + RESTFramework::BUILTIN_MEMBER_ACTIONS.keys
  ).reject do |action|
    controller_class.method_defined?(action)
  end
end

.inflect(s, acronyms = nil) ⇒ Object

Custom inflector for RESTful controllers.



135
136
137
138
139
140
141
 
# File 'lib/rest_framework/utils.rb', line 135

def self.inflect(s, acronyms=nil)
  acronyms&.each do |acronym|
    s = s.gsub(/\b#{acronym}\b/i, acronym)
  end

  return s
end

.parse_extra_actions(extra_actions, controller: nil) ⇒ Object

Convert ‘extra_actions` hash to a consistent format: `methods:, kwargs:`, and additional metadata fields.

If a controller is provided, labels will be added to any metadata fields.



9
10
11
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/rest_framework/utils.rb', line 9

def self.parse_extra_actions(extra_actions, controller: nil)
  return (extra_actions || {}).map { |k, v|
    path = k

    # Convert structure to path/methods/kwargs.
    if v.is_a?(Hash)  # Allow kwargs to be used to define path differently from the key.
      # Symbolize keys (which also makes a copy so we don't mutate the original).
      v = v.symbolize_keys
      methods = v.delete(:methods)

      # First, remove any metadata keys.
      delegate = v.delete(:delegate)
      fields = v.delete(:fields)

      # Add label to fields.
      if controller && fields
        fields = fields.map { |f| [f, {}] }.to_h if f.is_a?(Array)
        fields&.each do |field, cfg|
          cfg[:label] = controller.get_label(field)
        end
      end

      # Override path if it's provided.
      if v.key?(:path)
        path = v.delete(:path)
      end

      # Pass any further kwargs to the underlying Rails interface.
      kwargs = v.presence
    elsif v.is_a?(Array) && v.length == 1
      methods = v[0]
    else
      methods = v
    end

    next [
      k,
      {
        path: path,
        methods: methods,
        kwargs: kwargs,
        delegate: delegate,
        fields: fields,
        type: :extra,
      }.compact,
    ]
  }.to_h
end

.parse_fields_hash(fields_hash, model, exclude_associations: nil) ⇒ Object

Parse fields hashes.



144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/rest_framework/utils.rb', line 144

def self.parse_fields_hash(fields_hash, model, exclude_associations: nil)
  parsed_fields = fields_hash[:only] || (
    model ? self.fields_for(model, exclude_associations: exclude_associations) : []
  )
  parsed_fields += fields_hash[:include] if fields_hash[:include]
  parsed_fields -= fields_hash[:exclude] if fields_hash[:exclude]

  # Warn for any unknown keys.
  (fields_hash.keys - [:only, :include, :exclude]).each do |k|
    Rails.logger.warn("RRF: Unknown key in fields hash: #{k}")
  end

  return parsed_fields
end

.sub_fields_for(ref) ⇒ Object

Get the sub-fields that may be serialized and filtered/ordered for a reflection.



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/rest_framework/utils.rb', line 188

def self.sub_fields_for(ref)
  if !ref.polymorphic? && model = ref.klass
    sub_fields = [model.primary_key].flatten.compact

    # Preferrably find a database column to use as label.
    if match = LABEL_FIELDS.find { |f| f.in?(model.column_names) }
      return sub_fields + [match]
    end

    # Otherwise, find a method.
    if match = LABEL_FIELDS.find { |f| model.method_defined?(f) }
      return sub_fields + [match]
    end

    return sub_fields
  end

  return ["id", "name"]
end