habarico 7.2.0.pre.beta.5

data/lib/habarico/definition/views/view.rb

@@ -0,0 +1,10 @@
+module Habarico
+  class View
+    include DefinitionModel
+
+    attr_accessor :type, :name, :label, :is_detail, :view_mode, :boxes, :filters, :toolbar_filters, :box, :endpoint_action_name,
+                  :endpoint_method, :endpoint_reference, :model, :default_sorting, :row_actions, :toolbar_actions, :list_actions,
+                  :single_click_action, :double_click_action, :permission
+
+  end
+end

data/lib/habarico/engine.rb

@@ -0,0 +1,6 @@
+module Habarico
+  class Engine < ::Rails::Engine
+    isolate_namespace Habarico
+
+  end
+end

data/lib/habarico/file_validations.rb

@@ -0,0 +1,119 @@
+require 'marcel'
+
+module Habarico
+  # Per-field file validations, read from the host's `active_storage_validations` declarations on
+  # a `file_attr`'s `underlying_attachment` (HAB-966). 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
+  # use it simply declares no such validators, and `for_model` resolves to `NONE`. Not upload-
+  # specific either - `habarico_enterprise.uploads` folds in its own project-wide size ceiling and
+  # content-type blocklist on top of this for a field a chunked-upload provider actually serves,
+  # but this module alone is what fills `max_size` / `accept` for every `file_attr`, enterprise or
+  # not.
+  module FileValidations
+
+    # What one field's declarations amount to - 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.
+    Rules = Struct.new(:allowed_content_types, :max_size, keyword_init: true)
+
+    # No declarations at all - what an unknown model, a non-`file_attr` attribute, or a host
+    # without `active_storage_validations` resolves to.
+    NONE = Rules.new(allowed_content_types: nil, max_size: nil).freeze
+
+    # ***********************************************************************
+    # Derivation
+    # ***********************************************************************
+
+    # The `Rules` for one `file_attr`, derived from the model class schema generation already has
+    # in hand. Returns `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.
+    def self.for_model(model, attr_name)
+      return NONE if model.nil? || attr_name.blank?
+      return NONE unless model.respond_to?(:has_file_attr?) && model.has_file_attr?(attr_name)
+      return NONE unless model.respond_to?(:validators_on)
+
+      attachment = model.find_file_attr(attr_name)&.fetch(:underlying_attachment, nil)
+      return NONE if attachment.blank?
+
+      validators = model.validators_on(attachment)
+      Rules.new(allowed_content_types: content_types_from(validators), max_size: max_size_from(validators))
+    end
+
+    # The `accept` field-schema option for a field's `allowed_content_types`, or nil when they have
+    # no client-checkable form.
+    #
+    # The frontend matches an entry as a filename extension, a concrete media type or a `type/*`
+    # wildcard (`isFileAccepted`), so concrete Marcel-normalized types map over directly. A
+    # `Regexp` entry has no such form, and dropping just the regex entries would leave a list
+    # *stricter* than the server's - refusing client-side what would otherwise be accepted - so a
+    # field declaring one advertises nothing and lets the server alone decide.
+    def self.accept_for(content_types)
+      return nil if content_types.blank?
+      return nil if content_types.any? { |type| type.is_a?(::Regexp) }
+
+      content_types.map(&:to_s)
+    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.
+    #
+    # A `Proc` option is resolved by the gem per-record (`ASVOptionable#set_flat_options`); there
+    # is no record yet at schema-generation time, so a field declaring one yields nil - the
+    # validator itself still runs on save.
+    def self.content_types_from(validators)
+      validator = find_validator(validators, 'ContentTypeValidator')
+      return nil if validator.nil?
+
+      declared = Array(validator.options[:with]) + Array(validator.options[:in])
+      return nil if declared.empty? || declared.any? { |type| type.is_a?(::Proc) }
+
+      declared.filter_map do |type|
+        case type
+        when ::String, ::Symbol then ::Marcel::MimeType.for(declared_type: type.to_s, extension: type.to_s)
+        when ::Regexp then type
+        end
+      end.presence
+    end
+
+    # The inclusive upper bound of an `ActiveStorageValidations::SizeValidator`, or nil when the
+    # field declares no upper bound (a `greater_than*`-only validator, a `Proc`, or a non-integer
+    # range). `less_than: n` becomes `n - 1` so the ceiling here is exactly the one the validator
+    # itself would enforce on save.
+    #
+    # The gem's `check_validity!` guarantees exactly one of these options is present.
+    def self.max_size_from(validators)
+      validator = find_validator(validators, 'SizeValidator')
+      return nil if validator.nil?
+
+      options = validator.options
+      return nil if options.values.any? { |value| value.is_a?(::Proc) }
+
+      range = options[:between]
+      return integer_bound(range.max) if range.is_a?(::Range) && range.first.is_a?(::Integer)
+      return integer_bound(options[:less_than])&.pred if options[:less_than]
+
+      integer_bound(options[:less_than_or_equal_to] || options[:equal_to])
+    end
+
+    def self.integer_bound(value)
+      value.is_a?(::Integer) ? value : nil
+    end
+
+    # nil unless `active_storage_validations` is installed - the gem requires every validator
+    # eagerly from its entry point, so the constant is defined as soon as it is loaded at all.
+    def self.find_validator(validators, class_name)
+      full_name = "ActiveStorageValidations::#{class_name}"
+      return nil unless ::Object.const_defined?(full_name)
+
+      klass = full_name.constantize
+      validators.find { |validator| validator.is_a?(klass) }
+    end
+
+    private_class_method :content_types_from, :max_size_from, :integer_bound, :find_validator
+
+  end
+end

data/lib/habarico/generators/abstract_generator.rb

@@ -0,0 +1,21 @@
+module Habarico
+  class AbstractGenerator
+
+    def initialize(definition, resource_path)
+      @definition = definition
+      @resource_path = resource_path
+    end
+
+    protected
+
+    attr_reader :definition
+
+    attr_reader :resource_path
+
+    def resource_name
+      @resource_path.last
+    end
+
+  end
+
+end

data/lib/habarico/generators/action/action_schema_generator.rb

@@ -0,0 +1,111 @@
+module Habarico
+  class ActionSchemaGenerator < AbstractGenerator
+
+    def generate(action, context)
+      # Validate arguments
+      raise Eluvia::Errors::StandardError.new('Argument `action` must be a Habarico::Action') unless action.is_a?(Habarico::Action)
+
+      # Create model
+      Habarico::ActionSchema.new(
+        type: generate_type(action, context),
+        is_detail: generate_is_detail(action, context),
+        label: generate_label(action, context),
+        icon: generate_icon(action, context),
+        color: generate_color(action, context),
+        confirm_dialog: generate_confirm_dialog(action, context),
+        view: generate_view(action, context),
+        resource: generate_resource(action, context),
+        link: generate_link(action, context),
+        save: generate_save(action, context),
+        upload_images: generate_upload_images(action, context)
+      )
+    end
+
+    protected
+
+    def view_action_parameters_generator
+      @view_action_parameters_generator ||= definition.view_action_parameters_generator.new(definition, resource_path)
+    end
+
+    def save_action_parameters_generator
+      @save_action_parameters_generator ||= definition.save_action_parameters_generator.new(definition, resource_path)
+    end
+
+    def resource_action_parameters_generator
+      @resource_action_parameters_generator ||= definition.resource_action_parameters_generator.new(definition, resource_path)
+    end
+
+    def link_action_parameters_generator
+      @link_action_parameters_generator ||= definition.link_action_parameters_generator.new(definition, resource_path)
+    end
+
+    def upload_images_action_parameters_generator
+      @upload_images_action_parameters_generator ||= definition.upload_images_action_parameters_generator.new(definition, resource_path)
+    end
+
+    def confirm_dialog_properties_generator
+      @confirm_dialog_properties_generator ||= definition.confirm_dialog_properties_generator.new(definition, resource_path)
+    end
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_type(action, _context)
+      action.type
+    end
+
+    def generate_is_detail(action, _context)
+      action.is_detail
+    end
+
+    def generate_label(action, _context)
+      action.label
+    end
+
+    def generate_icon(action, _context)
+      action.icon
+    end
+
+    def generate_color(action, _context)
+      action.color
+    end
+
+    def generate_confirm_dialog(action, context)
+      if !action.confirm_dialog_title.blank? || !action.confirm_dialog_message.blank?
+        confirm_dialog_properties_generator.generate(action, context)
+      end
+    end
+
+    def generate_view(action, context)
+      if action.type.to_sym == :view
+        view_action_parameters_generator.generate(action, context)
+      end
+    end
+
+    def generate_resource(action, context)
+      if action.type.to_sym == :resource
+        resource_action_parameters_generator.generate(action, context)
+      end
+    end
+
+    def generate_link(action, context)
+      if action.type.to_sym == :link
+        link_action_parameters_generator.generate(action, context)
+      end
+    end
+
+    def generate_save(action, context)
+      if action.type.to_sym == :save
+        data = Habarico::CallableHelper.resolve(action.data, context)
+        save_action_parameters_generator.generate(action, context) unless data.nil?
+      end
+    end
+
+    def generate_upload_images(action, context)
+      if action.type.to_sym == :'upload-images'
+        upload_images_action_parameters_generator.generate(action, context)
+      end
+    end
+  end
+end

data/lib/habarico/generators/action/confirm_dialog_properties_generator.rb

@@ -0,0 +1,30 @@
+module Habarico
+  class ConfirmDialogPropertiesGenerator < AbstractGenerator
+
+    def generate(action, context)
+      # Validate arguments
+      raise Eluvia::Errors::StandardError.new('Argument `action` must be a Habarico::Action') unless action.is_a?(Habarico::Action)
+
+      # Create model
+      Habarico::ConfirmDialogProperties.new(
+        title: generate_title(action, context),
+        message: generate_message(action, context),
+      )
+    end
+
+    protected
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_title(action, _context)
+      action.confirm_dialog_title
+    end
+
+    def generate_message(action, _context)
+      action.confirm_dialog_message
+    end
+
+  end
+end

data/lib/habarico/generators/action/global_resource_action_schema_generator.rb

@@ -0,0 +1,46 @@
+module Habarico
+  class GlobalResourceActionSchemaGenerator < ActionSchemaGenerator
+
+    def generate(action)
+      # Fallback to a simple Action object if a string or symbol is provided
+      if action.is_a?(String) || action.is_a?(Symbol)
+        action = case action.to_sym
+                 when :show then Habarico::ShowAction.new
+                 when :edit then Habarico::EditAction.new
+                 when :create then Habarico::CreateAction.new
+                 when :delete then Habarico::DeleteAction.new
+                 end
+      end
+
+      # Validate arguments
+      raise Eluvia::Errors::StandardError.new('Argument `action` must be a Habarico::Action') unless action.is_a?(Habarico::Action)
+
+      # Create model
+      Habarico::GlobalResourceActionSchema.new(
+        type: generate_type(action, Habarico::Context.new),
+        is_detail: generate_is_detail(action, Habarico::Context.new),
+        name: generate_name(action),
+        show_in_detail: generate_show_in_detail(action),
+        show_in_list: generate_show_in_list(action),
+      )
+    end
+
+    protected
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_name(action)
+      action.name
+    end
+
+    def generate_show_in_detail(action)
+      action.show_in_detail
+    end
+
+    def generate_show_in_list(action)
+      action.show_in_list
+    end
+  end
+end

data/lib/habarico/generators/action/link_action_parameters_generator.rb

@@ -0,0 +1,31 @@
+module Habarico
+  class LinkActionParametersGenerator < AbstractGenerator
+
+    def generate(action, context)
+      # Validate arguments
+      raise Eluvia::Errors::StandardError.new('Argument `action` must be a Habarico::Action') unless action.is_a?(Habarico::Action)
+      raise Eluvia::Errors::StandardError.new('Argument `action` must be of :link type') unless action.type.to_sym == :link
+
+      # Create model
+      Habarico::LinkActionParameters.new(
+        url: generate_url(action, context),
+        target: generate_target(action, context)
+      )
+    end
+
+    protected
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_url(action, context)
+      Habarico::CallableHelper.resolve(action.link_url, context)
+    end
+
+    def generate_target(action, _context)
+      action.link_target
+    end
+
+  end
+end

data/lib/habarico/generators/action/resource_action_endpoint_parameters_generator.rb

@@ -0,0 +1,70 @@
+module Habarico
+  class ResourceActionEndpointParametersGenerator < AbstractGenerator
+
+    def generate(action, context)
+      # Validate arguments
+      raise Eluvia::Errors::StandardError.new('Argument `action` must be a Habarico::Action') unless action.is_a?(Habarico::Action)
+
+      # Create model
+      Habarico::ResourceActionEndpointParameters.new(
+        path: generate_path(action, context),
+        method: generate_method(action, context),
+        reference: generate_reference(action, context),
+        action_name: generate_action_name(action, context),
+        record_pk: generate_record_pk(action, context)
+      )
+    end
+
+    protected
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_path(action, context)
+      return nil if Habarico::ActionHelper.is_standard_action?(action)
+      url_prefix = Habarico::Config.routing_url_prefix.trim('/')
+      result = !url_prefix.blank? ? "/#{url_prefix}" : ''
+
+      # Add resource path
+      reference = generate_reference(action, context)
+      if reference.present?
+        resource_path_2 = ResourceService.instance.get_resource_path(reference)
+        result += "/#{resource_path_2.join('/')}"
+      else
+        result += "/#{resource_path.join('/')}"
+      end
+
+      # Add record PK
+      record_pk = generate_record_pk(action, context)
+      result += "/#{record_pk}" if record_pk
+
+      # Add action name
+      action_name = generate_action_name(action, context)
+      result += "/#{action_name}" if action_name
+
+      # Return result
+      "#{result}/"
+    end
+
+    def generate_method(action, _context)
+      action.endpoint_method
+    end
+
+    def generate_reference(action, _context)
+      action.endpoint_reference
+    end
+
+    def generate_action_name(action, _context)
+      return nil if Habarico::ActionHelper.is_standard_action?(action)
+      action.endpoint_action_name || action.name
+    end
+
+    def generate_record_pk(action, context)
+      if action&.is_detail
+        context.record_pk
+      end
+    end
+
+  end
+end

data/lib/habarico/generators/action/resource_action_parameters_generator.rb

@@ -0,0 +1,40 @@
+module Habarico
+  class ResourceActionParametersGenerator < AbstractGenerator
+
+    def generate(action, context)
+      # Validate arguments
+      raise Eluvia::Errors::StandardError.new('Argument `action` must be a Habarico::Action') unless action.is_a?(Habarico::Action)
+      raise Eluvia::Errors::StandardError.new('Argument `action` must be of :resource type') unless action.type.to_sym == :resource
+
+      # Create model
+      Habarico::ResourceActionParameters.new(
+        is_background: generate_is_background(action, context),
+        data: generate_data(action, context),
+        endpoint: generate_endpoint(action, context)
+      )
+    end
+
+    protected
+
+    def resource_action_endpoint_parameters_generator
+      @resource_action_endpoint_parameters_generator ||= definition.resource_action_endpoint_parameters_generator.new(definition, resource_path)
+    end
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_is_background(action, _context)
+      action.is_background
+    end
+
+    def generate_data(action, context)
+      Habarico::CallableHelper.resolve(action.data, context)
+    end
+
+    def generate_endpoint(action, context)
+      resource_action_endpoint_parameters_generator.generate(action, context)
+    end
+
+  end
+end

data/lib/habarico/generators/action/resource_action_schema_generator.rb

@@ -0,0 +1,51 @@
+module Habarico
+  class ResourceActionSchemaGenerator < ActionSchemaGenerator
+
+    def generate(action, context)
+      # Validate arguments
+      raise Eluvia::Errors::StandardError.new('Argument `action` must be a Habarico::Action') unless action.is_a?(Habarico::Action)
+
+      # Create model
+      Habarico::ResourceActionSchema.new(
+        type: generate_type(action, context),
+        is_detail: generate_is_detail(action, context),
+        label: generate_label(action, context),
+        icon: generate_icon(action, context),
+        color: generate_color(action, context),
+        confirm_dialog: generate_confirm_dialog(action, context),
+        view: generate_view(action, context),
+        resource: generate_resource(action, context),
+        link: generate_link(action, context),
+        name: generate_name(action, context),
+        show_in_detail: generate_show_in_detail(action, context),
+        show_in_list: generate_show_in_list(action, context),
+      )
+    end
+
+    protected
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_label(action, context)
+      action_name = generate_name(action, context).to_s
+      action.label ||
+        I18n.t("actions.#{resource_path.join('.')}.#{action.name}", default: nil) ||
+        I18n.t("actions.common.#{action_name}", default: nil) ||
+        action_name.to_s.humanize
+    end
+
+    def generate_name(action, _context)
+      action.name
+    end
+
+    def generate_show_in_detail(action, _context)
+      action.show_in_detail
+    end
+
+    def generate_show_in_list(action, _context)
+      action.show_in_list
+    end
+  end
+end

data/lib/habarico/generators/action/save_action_parameters_generator.rb

@@ -0,0 +1,26 @@
+module Habarico
+  class SaveActionParametersGenerator < AbstractGenerator
+
+    def generate(action, context)
+      # Validate arguments
+      raise Eluvia::Errors::StandardError.new('Argument `action` must be a Habarico::Action') unless action.is_a?(Habarico::Action)
+      raise Eluvia::Errors::StandardError.new('Argument `action` must be of :save type') unless action.type.to_sym == :save
+
+      # Create model
+      Habarico::SaveActionParameters.new(
+        data: generate_data(action, context)
+      )
+    end
+
+    protected
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_data(action, context)
+      Habarico::CallableHelper.resolve(action.data, context)
+    end
+
+  end
+end

data/lib/habarico/generators/action/upload_images_action_parameters_generator.rb

@@ -0,0 +1,41 @@
+module Habarico
+  class UploadImagesActionParametersGenerator < AbstractGenerator
+
+    def generate(action, context)
+      # Validate arguments
+      raise Eluvia::Errors::StandardError.new('Argument `action` must be a Habarico::Action') unless action.is_a?(Habarico::Action)
+      raise Eluvia::Errors::StandardError.new('Argument `action` must be of :"upload-images" type') unless action.type.to_sym == :"upload-images"
+
+      # Create model
+      Habarico::UploadImagesActionParameters.new(
+        reference: generate_reference(action, context),
+        target: generate_target(action, context),
+        accept: generate_accept(action, context),
+        image_field: generate_image_field(action, context)
+      )
+    end
+
+    protected
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_reference(action, _context)
+      action.upload_images_reference
+    end
+
+    def generate_target(action, _context)
+      action.upload_images_target
+    end
+
+    def generate_accept(action, _context)
+      action.upload_images_accept
+    end
+
+    def generate_image_field(action, _context)
+      action.upload_images_image_field
+    end
+
+  end
+end

data/lib/habarico/generators/action/view_action_endpoint_parameters_generator.rb

@@ -0,0 +1,37 @@
+module Habarico
+  class ViewActionEndpointParametersGenerator < AbstractGenerator
+
+    def generate(action, context)
+      # Validate arguments
+      raise Eluvia::Errors::StandardError.new('Argument `action` must be a Habarico::Action') unless action.is_a?(Habarico::Action)
+
+      # Create model
+      Habarico::ViewActionEndpointParameters.new(
+        reference: generate_reference(action, context),
+        action_name: generate_action_name(action, context),
+        record_pk: generate_record_pk(action, context)
+      )
+    end
+
+    protected
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_reference(action, _context)
+      action.endpoint_reference
+    end
+
+    def generate_action_name(action, _context)
+      action.endpoint_action_name || action.name
+    end
+
+    def generate_record_pk(action, context)
+      if action&.is_detail
+        context.record_pk
+      end
+    end
+
+  end
+end