rest_framework 0.8.13 → 0.8.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e6db6727ad85819540fc9d5977205f553523fe2f1f4431c985193ffd47f27bc
-  data.tar.gz: cddc4ff0d75aa6d2856d1c6bde681d38f955675a9c11b3853eef617e1abfad8b
+  metadata.gz: '0528c2ec3d68b9a457b8c35bd00aa8ad7f19d0bb440fe0d75652b8bade7f7312'
+  data.tar.gz: 364a40189c072a0064397e9410c8c8e93b5b9348f478dc8283de3b8786cd8009
 SHA512:
-  metadata.gz: 86384e43ffa97406feb6a9760cb9ca425cbc725cb41324fe21a688216cf075ccdf2e27b682231dd11d4d7507740a8645eb66c4076df165d69da4a56d87d11efd
-  data.tar.gz: 7b22d9730b039452065db1e27d580ee1db4105861f323bd2800906a8c5197ed4d8cf76bb532c193dd3ab3255d491faeb04cbf47a677acbb1dbb46bfc0b6f2fc3
+  metadata.gz: ab0cb394bd1528a03d8b1fd7b42d09c77c076ebabfdd8c8b54816187cad2984b1e22db29f26acf3408edb9f2afefc6261248b4833e8ba857265282107ff6af36
+  data.tar.gz: 72d2ae348a3eea1a7a7c7964f08f7ef79286a75b6b3029241ba84e0ea36be1ec6211ce694fc3ce760aa08a2cdcca5474764bd505e92d44dc24b7723a541859f8

data/VERSION

@@ -1 +1 @@
-0.8.13
+0.8.14

data/lib/rest_framework/controller_mixins/base.rb

@@ -60,7 +60,10 @@ module RESTFramework::BaseControllerMixin
 
     # Get a label from a field/column name, titleized and inflected.
     def get_label(s)
-      return RESTFramework::Utils.inflect(s.titleize(keep_id_suffix: true), self.inflect_acronyms)
+      return RESTFramework::Utils.inflect(
+        s.to_s.titleize(keep_id_suffix: true),
+        self.inflect_acronyms,
+      )
     end
 
     # Collect actions (including extra actions) metadata for this controller.
@@ -71,16 +74,20 @@ module RESTFramework::BaseControllerMixin
       RESTFramework::BUILTIN_ACTIONS.merge(
         RESTFramework::RRF_BUILTIN_ACTIONS,
       ).each do |action, methods|
-        if self.method_defined?(action)
-          actions[action] = {path: "", methods: methods, type: :builtin}
-        end
+        next unless self.method_defined?(action)
+
+        actions[action] = {
+          path: "", methods: methods, type: :builtin, metadata: {label: self.get_label(action)}
+        }
       end
 
       # Add builtin bulk actions.
       RESTFramework::RRF_BUILTIN_BULK_ACTIONS.each do |action, methods|
-        if self.method_defined?(action)
-          actions[action] = {path: "", methods: methods, type: :builtin}
-        end
+        next unless self.method_defined?(action)
+
+        actions[action] = {
+          path: "", methods: methods, type: :builtin, metadata: {label: self.get_label(action)}
+        }
       end
 
       # Add extra actions.
@@ -97,9 +104,11 @@ module RESTFramework::BaseControllerMixin
 
       # Start with builtin actions.
       RESTFramework::BUILTIN_MEMBER_ACTIONS.each do |action, methods|
-        if self.method_defined?(action)
-          actions[action] = {path: "", methods: methods, type: :builtin}
-        end
+        next unless self.method_defined?(action)
+
+        actions[action] = {
+          path: "", methods: methods, type: :builtin, metadata: {label: self.get_label(action)}
+        }
       end
 
       # Add extra actions.

data/lib/rest_framework/utils.rb

@@ -1,5 +1,5 @@
 module RESTFramework::Utils
-  HTTP_METHOD_ORDERING = %w(GET POST PUT PATCH DELETE OPTIONS HEAD)
+  HTTP_VERB_ORDERING = %w(GET POST PUT PATCH DELETE OPTIONS HEAD)
 
   # Convert `extra_actions` hash to a consistent format: `{path:, methods:, kwargs:}`, and
   # additional metadata fields.
@@ -8,6 +8,7 @@ module RESTFramework::Utils
   def self.parse_extra_actions(extra_actions, controller: nil)
     return (extra_actions || {}).map { |k, v|
       path = k
+      metadata = {}
 
       # Convert structure to path/methods/kwargs.
       if v.is_a?(Hash)  # Allow kwargs to be used to define path differently from the key.
@@ -39,14 +40,19 @@ module RESTFramework::Utils
         methods = v
       end
 
+      # Insert action label if it's not provided.
+      if controller
+        metadata[:label] ||= controller.get_label(k)
+      end
+
       next [
         k,
         {
           path: path,
           methods: methods,
           kwargs: kwargs,
-          metadata: metadata.presence,
           type: :extra,
+          metadata: metadata.presence,
         }.compact,
       ]
     }.to_h
@@ -119,9 +125,15 @@ module RESTFramework::Utils
         _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]
+      [
+        # Sort by levels first, so routes matching closely with current request show first.
+        r[:_levels],
+        # Then match by path, but manually sort ':' to the end using knowledge that Ruby sorts the
+        # pipe character '|' after alphanumerics.
+        r[:path].tr(":", "|"),
+        # Finally, match by HTTP verb.
+        HTTP_VERB_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]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 0.8.13
+  version: 0.8.14
 platform: ruby
 authors:
 - Gregory N. Schmit