rest_framework 0.9.11 → 0.9.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04ef01197efeca7c6276edbf2ed4c9ef3f50e4fc4d1df927c3d530953d5aab2a
-  data.tar.gz: 71bd781956d163f33cdc7fd6aa3950ce93d4f86a0c03325e2bebcd2ba1dfc74b
+  metadata.gz: 734af1c9a436fd842c36503794ef16b94e4b0d3f7ad91d011bcd12d06e4b1e21
+  data.tar.gz: d4c0140985a5405750cdd092c4a70b092be69b3523a3c088d2268711c38e5ad1
 SHA512:
-  metadata.gz: 96cbf98cec8f47c54309fa5b2b46c90c60249e7da1fa7142ef85c041bfee1154b9fd60c5d420d145a2dfb852df4d8af906e3577cb2f5f70d0bc6fd2da9beeb97
-  data.tar.gz: 4b0ab5e4d529f54e4890c8e0da2763ee8915a393ce1260da5c7ce70d6ef940c64e36f15d5a5b70cca255ec881c53b4c48bbcd5f95f2e7d83cc88e233b623b327
+  metadata.gz: 4fc442c77a0c8543913ceacd7a7116f9e044ee1d9b0e3e08a5c58ddb6d00ee12b7f719c83e7aed233070075bb031aa8a90cabc7337bd57e28883aca4221d5ea6
+  data.tar.gz: 2f60ffddea13e956a3a0a0ec909d2de533cc0c5b350af75467f7e006b5133c982192cbcc28da7cb566803458c76917ae702f4838c3f0096722a94f5309babb7a

data/README.md

@@ -149,4 +149,4 @@ end
 After you clone the repository, cd'ing into the directory should create a new gemset if you are using RVM.
 Then run `bin/setup` to install the appropriate gems and set things up.
 
-The top-level `bin/rails` proxies all Rails commands to the test project, so you can operate it via the usual commands (e.g., `rails test`, `rails server` and `rails console`).
+The top-level `bin/rails` proxies all Rails commands to the test project, so you can operate it via the usual commands (e.g., `rails test`, `rails server` and `rails console`). For development, use `foreman start` to run the web server and the job queue.

data/VERSION

@@ -1 +1 @@
-0.9.11
+0.9.15

data/app/views/rest_framework/routes_and_forms/_html_form.html.erb

@@ -10,13 +10,14 @@
     </label>
   </div>
 
-  <%= form_with(
+  <%= form_with(**{
     model: @record,
     url: "",
     method: :patch,
     id: "htmlForm",
     scope: "",
-  ) do |form| %>
+    local: true,
+  }.compact) do |form| %>
     <% controller.get_fields.map(&:to_s).each do |f| %>
       <%
         # Don't provide form fields for associations or primary keys.

data/app/views/rest_framework/routes_and_forms/_raw_form.html.erb

@@ -32,12 +32,13 @@
   <% if @is_model_controller && model = controller.class.get_model %>
     <% if attachment_reflections = model.attachment_reflections.presence %>
       <div class="mb-2" style="display: none" id="rawFilesFormWrapper">
-        <%= form_with(
+        <%= form_with(**{
           model: @record,
           url: "",
           id: "rawFilesForm",
           scope: "",
-        ) do |form| %>
+          local: true,
+        }.compact) do |form| %>
           <% attachment_reflections.each do |field, ref| %>
             <label class="form-label w-100"><%= controller.class.get_label(field) %>
               <%= form.file_field field, multiple: ref.macro == :has_many_attached %>

data/lib/rest_framework/filters/model_ordering_filter.rb

@@ -16,7 +16,8 @@ class RESTFramework::Filters::ModelOrderingFilter < RESTFramework::Filters::Base
     if order_string.present?
       ordering = {}.with_indifferent_access
 
-      order_string.split(",").each do |field|
+      order_string = order_string.join(",") if order_string.is_a?(Array)
+      order_string.split(",").map(&:strip).each do |field|
         if field[0] == "-"
           column = field[1..-1]
           direction = :desc

data/lib/rest_framework/mixins/model_controller_mixin.rb

@@ -6,9 +6,11 @@ module RESTFramework::Mixins::BaseModelControllerMixin
     return {
       io: StringIO.new(Base64.decode64(payload)),
       content_type: content_type,
-      filename: "image_#{field}#{Rack::Mime::MIME_TYPES.invert[content_type]}",
+      filename: "file_#{field}#{Rack::Mime::MIME_TYPES.invert[content_type]}",
     }
   }
+  ACTIVESTORAGE_KEYS = [:io, :content_type, :filename, :identify, :key]
+
   include RESTFramework::BaseControllerMixin
 
   RRF_BASE_MODEL_CONFIG = {
@@ -22,8 +24,6 @@ module RESTFramework::Mixins::BaseModelControllerMixin
 
     # Options for what should be included/excluded from default fields.
     exclude_associations: false,
-    include_active_storage: false,
-    include_action_text: false,
   }
   RRF_BASE_MODEL_INSTANCE_CONFIG = {
     # Attributes for finding records.
@@ -413,18 +413,21 @@ module RESTFramework::Mixins::BaseModelControllerMixin
     # For fields, automatically add `_id`/`_ids` and `_attributes` variations for associations.
     variations = []
     hash_variations = {}
+    alt_hash_variations = {}
     reflections = self.class.get_model.reflections
     @_get_allowed_parameters = self.get_fields.map { |f|
       f = f.to_s
 
       # ActiveStorage Integration: `has_one_attached`.
       if reflections.key?("#{f}_attachment")
+        hash_variations[f] = ACTIVESTORAGE_KEYS
         next f
       end
 
       # ActiveStorage Integration: `has_many_attached`.
       if reflections.key?("#{f}_attachments")
         hash_variations[f] = []
+        alt_hash_variations[f] = ACTIVESTORAGE_KEYS
         next nil
       end
 
@@ -445,7 +448,9 @@ module RESTFramework::Mixins::BaseModelControllerMixin
       end
 
       if self.permit_nested_attributes_assignment
-        hash_variations["#{f}_attributes"] = self.class.get_field_config(f)[:sub_fields]
+        hash_variations["#{f}_attributes"] = (
+          self.class.get_field_config(f)[:sub_fields] + ["_destroy"]
+        )
       end
 
       # Associations are not allowed to be submitted in their bare form.
@@ -453,6 +458,7 @@ module RESTFramework::Mixins::BaseModelControllerMixin
     }.compact
     @_get_allowed_parameters += variations
     @_get_allowed_parameters << hash_variations
+    @_get_allowed_parameters << alt_hash_variations
     return @_get_allowed_parameters
   end
 
@@ -522,14 +528,22 @@ module RESTFramework::Mixins::BaseModelControllerMixin
     #
     # rubocop:enable Layout/LineLength
     self.class.get_model.attachment_reflections.keys.each do |k|
-      next unless (body_params[k].is_a?(String) && body_params[k].match?(BASE64_REGEX)) ||
-        (body_params[k].is_a?(Array) && body_params[k].all? { |v|
-          v.is_a?(String) && v.match?(BASE64_REGEX)
-        })
-
       if body_params[k].is_a?(Array)
-        body_params[k] = body_params[k].map { |v| BASE64_TRANSLATE.call(k, v) }
-      else
+        body_params[k] = body_params[k].map { |v|
+          if v.is_a?(String)
+            BASE64_TRANSLATE.call(k, v)
+          elsif v.is_a?(ActionController::Parameters)
+            if v[:io].is_a?(String)
+              v[:io] = StringIO.new(Base64.decode64(v[:io]))
+            end
+            v
+          end
+        }
+      elsif body_params[k].is_a?(ActionController::Parameters)
+        if body_params[k][:io].is_a?(String)
+          body_params[k][:io] = StringIO.new(Base64.decode64(body_params[k][:io]))
+        end
+      elsif body_params[k].is_a?(String)
         body_params[k] = BASE64_TRANSLATE.call(k, body_params[k])
       end
     end

data/lib/rest_framework/serializers/native_serializer.rb

@@ -221,6 +221,14 @@ class RESTFramework::Serializers::NativeSerializer < RESTFramework::Serializers:
             self.define_singleton_method(f) do |record|
               next record.send(f).limit(limit).as_json(**sub_config)
             end
+
+            # Disable this for now, as it's not clear if this improves performance of count.
+            #
+            # # Even though we use a serializer method, if the count will later be added, then put
+            # # this field into the includes_map.
+            # if @controller.native_serializer_include_associations_count
+            #   includes_map[f] = f.to_sym
+            # end
           else
             includes[f] = sub_config
             includes_map[f] = f.to_sym
@@ -263,6 +271,9 @@ class RESTFramework::Serializers::NativeSerializer < RESTFramework::Serializers:
         end
       elsif @model.method_defined?(f)
         methods << f
+      else
+        # Assume anything else is a virtual column.
+        columns << f
       end
     end
 

data/lib/rest_framework/utils.rb

@@ -15,13 +15,18 @@ module RESTFramework::Utils
         # Symbolize keys (which also makes a copy so we don't mutate the original).
         v = v.symbolize_keys
         methods = v.delete(:methods)
+        if v.key?(:method)
+          methods = v.delete(:method)
+        end
 
         # First, remove the route metadata.
         metadata = v.delete(:metadata) || {}
 
         # Add label to fields.
         if controller && metadata[:fields]
-          metadata[:fields] = metadata[:fields].map { |f| [f, {}] }.to_h if f.is_a?(Array)
+          metadata[:fields] = metadata[:fields].map { |f|
+            [f, {}]
+          }.to_h if metadata[:fields].is_a?(Array)
           metadata[:fields]&.each do |field, cfg|
             cfg[:label] = controller.get_label(field) unless cfg[:label]
           end
@@ -99,12 +104,10 @@ module RESTFramework::Utils
     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) &&
+      (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("/")
@@ -156,9 +159,10 @@ module RESTFramework::Utils
     )
     parsed_fields += fields_hash[:include].map(&:to_s) if fields_hash[:include]
     parsed_fields -= fields_hash[:exclude].map(&:to_s) if fields_hash[:exclude]
+    parsed_fields -= fields_hash[:except].map(&:to_s) if fields_hash[:except]
 
     # Warn for any unknown keys.
-    (fields_hash.keys - [:only, :include, :exclude]).each do |k|
+    (fields_hash.keys - [:only, :except, :include, :exclude]).each do |k|
       Rails.logger.warn("RRF: Unknown key in fields hash: #{k}")
     end
 
@@ -171,15 +175,12 @@ module RESTFramework::Utils
   # strings, not symbols.
   def self.fields_for(model, exclude_associations: nil)
     foreign_keys = model.reflect_on_all_associations(:belongs_to).map(&:foreign_key)
+    base_fields = model.column_names.reject { |c| c.in?(foreign_keys) }
 
-    if exclude_associations
-      return model.column_names.reject { |c| c.in?(foreign_keys) }
-    end
+    return base_fields if exclude_associations
 
     # Add associations in addition to normal columns.
-    return model.column_names.reject { |c|
-      c.in?(foreign_keys)
-    } + model.reflections.map { |association, ref|
+    return base_fields + model.reflections.map { |association, ref|
       # Ignore associations for which we have custom integrations.
       if ref.class_name.in?(%w(ActiveStorage::Attachment ActiveStorage::Blob ActionText::RichText))
         next nil

data/lib/rest_framework.rb

@@ -149,7 +149,7 @@ module RESTFramework
     # Freeze configuration attributes during finalization to prevent accidental mutation.
     attr_accessor :freeze_config
 
-    # Specify reverse association tables that are typically very large, andd therefore should not be
+    # Specify reverse association tables that are typically very large, and therefore should not be
     # added to fields by default.
     attr_accessor :large_reverse_association_tables
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 0.9.11
+  version: 0.9.15
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-16 00:00:00.000000000 Z
+date: 2024-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails