habarico 7.3.0.pre.beta.10 → 7.3.0.pre.beta.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7be061178763fb2bb412e36877d25e44ff109c82c90955279bcf7ff038f1216b
-  data.tar.gz: 7f478d3e668b336f2b2226b0bd2ea099aae08a22514ede701142cfea3f40457a
+  metadata.gz: 4ddeb09d8eba0c8f227e02078ced119d7658696153db4fd3af5ab872cb50b6de
+  data.tar.gz: 2ebd161afbd8e260c57798e9b524b0f025a3baf61e9f912c18ab1f80ac797b03
 SHA512:
-  metadata.gz: 06bf7e5f65f10d91c1443235e11d180db58a3f34941367a5073f825b33ea26307bbaa522f4a283fd34ce9e11041626146c0636184d19c481ac761e231545d130
-  data.tar.gz: ca148d5c2f91c5fb53fdca5bb64dad14f12756a01b8408bdcb22bb5f92ce66eae70c20fa804a7819c0e6817137d1ad49895d36adddbcbfb6e64e22785a531022
+  metadata.gz: 4bb6cd1b02539eaef781b87745d45d4070bede289de5756273c0cb6faa0bda27875f36c61dfcc1290dfb5a19b14b524196a755f1dcab05a72cb403cba9caeb0e
+  data.tar.gz: e6e3fe637deb6d0ce0e60124130b6ff901da11e5d4cdf2875a3ffc8fc1397812a635a0af6573afd4a8d4716614444573201a5d37537ce973a6b0d41556452485

data/VERSION

@@ -1 +1 @@
-7.3.0-beta.10
+7.3.0-beta.12

data/lib/generators/habarico/preferences/install_generator.rb

@@ -1,5 +1,8 @@
 require "rails/generators"
 require "rails/generators/migration"
+# Defines ActiveRecord::Generators::Base, whose next_migration_number is reused below. Railties
+# does not autoload it, so without this require the generator fails with a NameError.
+require "rails/generators/active_record"
 
 module Habarico
   module Preferences

data/lib/habarico/config.rb

@@ -53,8 +53,8 @@ module Habarico
     # Name of the method Habarico calls (via `send`) as its authentication before_action, on both
     # Habarico::Controller and Habarico::ApplicationController. Point this at an existing no-argument
     # auth method on your ApplicationController (e.g. `:authenticate_user!`) to reuse it directly. If
-    # your auth method needs arguments (e.g. eluvia-auth's `authenticate(['public'])`), define a
-    # one-line wrapper method instead and point this at that.
+    # your auth method takes arguments, define a one-line wrapper method instead and point this at
+    # that.
     mattr_accessor :authenticate_method
     @@authenticate_method = :authenticate_request
 

data/lib/habarico/generators/endpoint/field_options_generator.rb

@@ -94,7 +94,7 @@ module Habarico
       nil # not possible to generate dynamic render without FieldReference
     end
 
-    # Largest file (bytes) this `file_attr` accepts, derived from its own
+    # Largest file (bytes) this file field accepts, derived from its own
     # `active_storage_validations` size declaration (HAB-966). `habarico_enterprise.uploads`, when
     # installed, additionally folds in the project-wide upload size ceiling for a field a
     # chunked-upload provider serves - see `Habarico::FileRulesResolver`.
@@ -105,7 +105,7 @@ module Habarico
       file_rules(model, attr_name).max_size
     end
 
-    # File types this `file_attr` accepts, derived from its own `active_storage_validations`
+    # File types this file field accepts, derived from its own `active_storage_validations`
     # content-type declaration (HAB-966).
     def generate_accept_at(model, attr_name)
       file_rules(model, attr_name).accept

data/lib/habarico/generators/endpoint/field_schema_generator.rb

@@ -46,7 +46,7 @@ module Habarico
         sort_by: generate_sort_by(model, field_name, attr_name, variant),
         reference: Habarico::ResourceReference.build(generate_reference(model, field_name, attr_name, variant)),
         enum: generate_enum(model, field_name, attr_name, variant),
-        items: generate_items(model, field_name, attr_name, variant, subfields),
+        items: generate_items(model, field_name, attr_name, variant, subfields, field_reference: field_reference),
         properties: generate_properties(model, field_name, attr_name, variant, subfields),
         options: generate_options(model, field_name, attr_name, variant),
       )
@@ -301,10 +301,22 @@ module Habarico
       nil
     end
 
-    def generate_items(model, field_name, attr_name, _variant, subfields)
+    def generate_items(model, field_name, attr_name, _variant, subfields, field_reference: nil)
       name = ''
       label = generate_label(model, field_name, attr_name, nil)
 
+      # "Append only" file array attribute is a list of uploads, each item a file the frontend uploads
+      if Habarico::ReflectionHelper.is_append_only_file_array_attr?(model, attr_name)
+        return Habarico::FieldSchema.new(
+          name: name,
+          label: label,
+          type: 'object',
+          format: model.find_file_array_attr(attr_name).fetch(:nature) == :image ? 'base64-image' : 'base64-file',
+          properties: fields_schema_generator.generate(Eluvia::File, %i[type url filename size content]),
+          options: field_options_generator.generate(model, attr_name, field_reference),
+        )
+      end
+
       # Manually declared "has many" reference is interpreted as array of relations, so we need to define items schema
       if Habarico::ReflectionHelper.is_has_many_reference?(model, field_name)
         reference = model.find_reference(field_name)
@@ -374,6 +386,9 @@ module Habarico
     end
 
     def generate_options(model, _field_name, attr_name, _variant)
+      # The upload options of an append-only file array are on its items, where the frontend reads them
+      return nil if Habarico::ReflectionHelper.is_append_only_file_array_attr?(model, attr_name)
+
       field_options_generator.generate(model, attr_name, nil)
     end
 

data/lib/habarico/generators/resource/local_resource_schema_generator.rb

@@ -89,9 +89,9 @@ module Habarico
     end
 
     def generate_endpoints(_context, endpoint_parameters)
-      # Determine endpoint methods to be included, base for the selection ale endpoint parameters collected from the
-      # actions and views without action name and without reference. Additionally, always include GET.
-      methods = endpoint_parameters.select { |e| e.action_name.blank? && e.reference.blank? }.map { |e| e.method.to_sym }
+      # Determine endpoint methods to be included from the endpoint parameters of the actions and views that address
+      # the resource itself (no reference; an action name always comes with one). Additionally, always include GET.
+      methods = endpoint_parameters.select { |e| e.reference.blank? }.map { |e| e.method.to_sym }
       methods << :get # Ensure GET is always present
       methods = methods.uniq
 

data/lib/habarico/helpers/reflection_helper.rb

@@ -21,6 +21,11 @@ module Habarico
       model_class.respond_to?(:has_reference?) && model_class.has_reference?(field_name, type: :has_many)
     end
 
+    def self.is_append_only_file_array_attr?(model_class, field_name)
+      model_class.respond_to?(:has_file_array_attr?) && model_class.has_file_array_attr?(field_name) &&
+        model_class.find_file_array_attr(field_name).fetch(:append_only)
+    end
+
     # *************************************************************************
     # Active model reflection methods
     # *************************************************************************

data/lib/habarico/resolvers/file_rules_resolver.rb

@@ -1,7 +1,7 @@
 require 'marcel'
 
 module Habarico
-  # The file rules of one `file_attr`: the allowed content types and the largest size its
+  # The file rules of one `file_attr` or `file_array_attr`: the allowed content types and the largest size its
   # `active_storage_validations` declarations admit - the rules a value is measured against, never
   # a value's own claimed properties. `allowed_content_types` is nil when the field declares no
   # content-type restriction; `max_size` is nil when it declares no upper bound.
@@ -22,12 +22,13 @@ module Habarico
     end
   end
 
-  # No declarations at all - what an unknown model, a non-`file_attr` attribute, or a host
-  # without `active_storage_validations` resolves to.
+  # No declarations at all - what an unknown model, an attribute that is not a file field, or a
+  # host without `active_storage_validations` resolves to.
   FileRules::NONE = FileRules.new(allowed_content_types: nil, max_size: nil).freeze
 
-  # Resolves the `FileRules` of a model's `file_attr` from the host's `active_storage_validations`
-  # declarations on its `underlying_attachment`. Mirrors the Python package's
+  # Resolves the `FileRules` of a model's `file_attr` or `file_array_attr` from the host's
+  # `active_storage_validations` declarations on its `underlying_attachment` /
+  # `underlying_attachments`. Mirrors the Python package's
   # `habarico.validators.content_types` / `habarico.validators.files`.
   #
   # `active_storage_validations` is deliberately NOT a dependency of this gem: a host that does not
@@ -38,22 +39,41 @@ module Habarico
     end
 
     # The `FileRules` of `attr_name`; `FileRules::NONE` when there is nothing to derive: no model,
-    # the attribute is not a `file_attr` or has no `underlying_attachment`, or
-    # `active_storage_validations` is not installed.
+    # the attribute is neither file field or has no underlying attachment, or
+    # `active_storage_validations` is not installed. An image `file_array_attr` keeps only the
+    # image types of its attachment's declaration, which may be shared with a file array filtered
+    # to the other types.
     def resolve(attr_name)
       return FileRules::NONE if @model.nil? || attr_name.blank?
-      return FileRules::NONE unless @model.respond_to?(:has_file_attr?) && @model.has_file_attr?(attr_name)
       return FileRules::NONE unless @model.respond_to?(:validators_on)
 
-      attachment = @model.find_file_attr(attr_name)&.fetch(:underlying_attachment, nil)
+      attachment, images_only = underlying_attachment(attr_name)
       return FileRules::NONE if attachment.blank?
 
       validators = @model.validators_on(attachment)
-      FileRules.new(allowed_content_types: content_types_from(validators), max_size: max_size_from(validators))
+      content_types = content_types_from(validators)
+      content_types = image_content_types(content_types) if images_only
+      FileRules.new(allowed_content_types: content_types, max_size: max_size_from(validators))
     end
 
     private
 
+    # The attachment name behind a file attribute, and whether only its image types apply.
+    def underlying_attachment(attr_name)
+      if @model.respond_to?(:has_file_attr?) && @model.has_file_attr?(attr_name)
+        [@model.find_file_attr(attr_name)&.fetch(:underlying_attachment, nil), false]
+      elsif @model.respond_to?(:has_file_array_attr?) && @model.has_file_array_attr?(attr_name)
+        spec = @model.find_file_array_attr(attr_name)
+        [spec[:underlying_attachments], spec[:nature] == :image]
+      end
+    end
+
+    def image_content_types(content_types)
+      return nil if content_types.nil?
+
+      content_types.select { |type| type.is_a?(::Regexp) || type.to_s.start_with?('image/') }.presence
+    end
+
     # The allowed content types of an `ActiveStorageValidations::ContentTypeValidator`, normalized
     # through Marcel exactly as the validator itself does at save time (`:png` and `'png'` both
     # become `'image/png'`), or nil when the field declares none.

data/lib/habarico/resolvers/record_params_resolver.rb

@@ -9,7 +9,7 @@ module Habarico
     # `params` narrowed to the resource's `fields` and `write_only_fields`.
     def resolve(params)
       write_fields = (@definition.fields + @definition.write_only_fields).uniq
-      params.permit(*write_fields.map { |field| permit_spec(field) })
+      params.permit(*write_fields.map { |field| permit_spec(field) }.uniq)
     end
 
     # A 422 with each error of `record` under every name its attribute is written by (an amount as
@@ -26,16 +26,22 @@ module Habarico
     private
 
     def permit_spec(field)
+      # Normalize Symbol/String/Hash/FieldReference entries so `permit` never receives a FieldReference.
+      name = Habarico::AttributesHelper.field_name(field)
+      model = @definition.model
+
+      # An append-only `file_array_attr` takes a list of base64 `{filename:, content:}` uploads,
+      # whatever subfields its declaration lists for reading.
+      return { name => %i[filename content] } if Habarico::ReflectionHelper.is_append_only_file_array_attr?(model, name)
+
       # Hash entries (`{ name => subfields }`) are already a nested permit spec - keep intact.
       return field if field.is_a?(::Hash)
 
-      # Normalize Symbol/String/FieldReference entries so `permit` never receives a FieldReference.
-      name = Habarico::AttributesHelper.field_name(field)
       # `ActionController::Parameters#permit` only allows scalar values for a bare field name -
       # a Hash value (e.g. a `file_attr` field's base64 `{filename:, content:}` or chunked-upload
       # `{upload_key:}` payload) is silently dropped unless its nested keys are explicitly
       # permitted. Expand file_attr fields into a nested permit spec; leave every other field as-is.
-      if @definition.model.respond_to?(:has_file_attr?) && @definition.model.has_file_attr?(name)
+      if model.respond_to?(:has_file_attr?) && model.has_file_attr?(name)
         { name => %i[filename content upload_key] }
       else
         name

data/lib/habarico/schema/endpoint/field_options.rb

@@ -42,13 +42,13 @@ module Habarico
     has_one_attr :ai, 'Habarico::AiFieldOptions'
 
     # Largest file (bytes) the frontend accepts for this field, checked before the upload starts.
-    # Derived from a `file_attr`'s own `active_storage_validations` size declaration (HAB-966); see
+    # Derived from a file field's own `active_storage_validations` size declaration (HAB-966); see
     # `Habarico::FileRulesResolver`. `habarico_enterprise.uploads` additionally folds in its
     # project-wide `Config.max_upload_size` ceiling for a field a chunked-upload provider serves.
     integer_attr :max_size
 
     # File types the frontend accepts for this field, checked before the upload starts. Derived
-    # from a `file_attr`'s own `active_storage_validations` content-type declaration (HAB-966); see
+    # from a file field's own `active_storage_validations` content-type declaration (HAB-966); see
     # `Habarico::FileRulesResolver`.
     has_many_attr :accept, 'String'
 

data/lib/habarico.rb

@@ -1,5 +1,11 @@
 require "eluvia-base"
 
+# Runtime dependencies of the gemspec. Bundler.require in a host app only requires what that app
+# lists itself, so without these a host gets `undefined method 'page'` on its first list request
+# (kaminari) or an uninitialised constant from a permission callable (pundit).
+require "kaminari"
+require "pundit"
+
 # *****************************************************************************
 # Basic library
 # *****************************************************************************

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: habarico
 version: !ruby/object:Gem::Version
-  version: 7.3.0.pre.beta.10
+  version: 7.3.0.pre.beta.12
 platform: ruby
 authors:
 - Matěj Outlý