rest_framework 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e34db1e862327396b55e22abc5431e1b2679944c109e3313167bb387860c42c
-  data.tar.gz: 45597aaf31d61d53ffcfcebd632444cb1c69bf959f94647192d1749917fd5ff8
+  metadata.gz: 0343a285f928c169815684c0cbb0176fc1cc1781cb7f4208bb7ea3f756e11f17
+  data.tar.gz: 683fe62f24ecbeb83441e48b235f1842717722f4a48e861108faa91b6499f105
 SHA512:
-  metadata.gz: 53ba45cf9b152c71c2db719e4f41890632e9f438f127ad6380d08e101a207eca5ef14b00c625de58854e618b410ac9709770687094cf6e2df5f7eb9ebd8814b4
-  data.tar.gz: 9552f475a0b11c8573825a4132e8683aad6943a2012f261b86538628c0c344d5755d8806629310e0162e77b9553cc4bf854c2d54170d8b5b4b80ab77c98ee87d
+  metadata.gz: 33ca1398d2585b92741d4c005ae8fa2f88f320945befaf54b099c67882021d3a2357a5bca4cabfe95b31a90357c4cc83f8fad0d94e120db73a6538c3971b081d
+  data.tar.gz: 86b469abf36473dbecc5a90785b7d185655dc290ae14aa270d5a2019c61a9f3bda170689b9ef7c1983fd8ea918e59b3ec1af072c347baa614fd6c832ce287066

data/VERSION

@@ -1 +1 @@
-0.7.2
+0.7.3

data/lib/rest_framework/controller_mixins/models.rb

@@ -81,7 +81,7 @@ module RESTFramework::BaseModelControllerMixin
     def get_fields_metadata(fields: nil)
       # Get metadata sources.
       model = self.get_model
-      fields ||= self.fields || model.column_names || []
+      fields ||= self.get_fields
       fields = fields.map(&:to_s)
       columns = model.columns_hash
       column_defaults = model.column_defaults
@@ -244,14 +244,27 @@ module RESTFramework::BaseModelControllerMixin
     return (action_config[action] if action) || self.class.send(generic_config_key)
   end
 
+  # Get fields without any action context. Always fallback to columns at the class level.
+  def self.get_fields
+    if self.fields.is_a?(Hash)
+      return RESTFramework::Utils.parse_fields_hash(self.fields, self.get_model)
+    end
+
+    return self.fields || self.get_model&.column_names || []
+  end
+
   # Get a list of fields for the current action. Returning `nil` indicates that anything should be
   # accepted unless `fallback` is true, in which case we should fallback to this controller's model
   # columns, or en empty array.
   def get_fields(fallback: false)
     fields = _get_specific_action_config(:action_fields, :fields)
 
-    if fallback
-      fields ||= self.class.get_model&.column_names || []
+    # If fields is a hash, then parse using columns as a base, respecting `only` and `except`.
+    if fields.is_a?(Hash)
+      return RESTFramework::Utils.parse_fields_hash(fields, self.class.get_model)
+    elsif !fields && fallback
+      # Otherwise, if fields is nil and fallback is true, then fallback to columns.
+      return self.class.get_model&.column_names || []
     end
 
     return fields

data/lib/rest_framework/utils.rb

@@ -79,7 +79,7 @@ module RESTFramework::Utils
     current_route ||= self.get_request_route(application_routes, request)
     current_path = current_route.path.spec.to_s.gsub("(.:format)", "")
     current_levels = current_path.count("/")
-    current_comparable_path = self.comparable_path(current_path)
+    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] }
@@ -96,7 +96,7 @@ module RESTFramework::Utils
       # to show.
       (
         (r.defaults[:subdomain].blank? || r.defaults[:subdomain] == request.subdomain) &&
-        self.comparable_path(r.path.spec.to_s).start_with?(current_comparable_path) &&
+        current_comparable_path.match?(self.comparable_path(r.path.spec.to_s)) &&
         r.defaults[:controller].present? &&
         r.defaults[:action].present?
       )
@@ -137,4 +137,17 @@ module RESTFramework::Utils
 
     return s
   end
+
+  # Parse fields hashes.
+  def self.parse_fields_hash(fields_hash, model)
+    parsed_fields = fields_hash[:only] || model&.column_names || []
+    parsed_fields -= fields_hash[:except] if fields_hash[:except]
+
+    # Warn for any unknown keys.
+    (fields_hash.keys - [:only, :except]).each do |k|
+      Rails.logger.warn("RRF: Unknown key in fields hash: #{k}")
+    end
+
+    return parsed_fields
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-05 00:00:00.000000000 Z
+date: 2023-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails