habarico 7.2.0.pre.beta.5

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

@@ -0,0 +1,56 @@
+module Habarico
+  class ViewActionParametersGenerator < 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 :view type') unless action.type.to_sym == :view
+
+      # Create model
+      Habarico::ViewActionParameters.new(
+        name: generate_name(action, context),
+        mode: generate_mode(action, context),
+        dialog_width: generate_dialog_width(action, context),
+        parameters: generate_parameters(action, context),
+        endpoint: generate_endpoint(action, context),
+        keep_linked_parent: generate_keep_linked_parent(action, context)
+      )
+    end
+
+    protected
+
+    def view_action_endpoint_parameters_generator
+      @view_action_endpoint_parameters_generator ||= definition.view_action_endpoint_parameters_generator.new(definition, resource_path)
+    end
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_name(action, _context)
+      action.view_name
+    end
+
+    def generate_mode(action, _context)
+      action.view_mode
+    end
+
+    def generate_dialog_width(action, _context)
+      action.dialog_width
+    end
+
+    def generate_parameters(action, context)
+      Habarico::CallableHelper.resolve(action.view_parameters, context)
+    end
+
+    def generate_endpoint(action, context)
+      return nil if Habarico::ActionHelper.is_standard_action?(action)
+      view_action_endpoint_parameters_generator.generate(action, context)
+    end
+
+    def generate_keep_linked_parent(action, _context)
+      action.view_keep_linked_parent
+    end
+
+  end
+end

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

@@ -0,0 +1,26 @@
+module Habarico
+  class DynamicRenderOptionsGenerator < AbstractGenerator
+
+    def generate(model, box_or_field_reference)
+      Habarico::DynamicRenderOptions.new(
+        show_query: generate_show_query(model, box_or_field_reference),
+        required_query: generate_required_query(model, box_or_field_reference),
+      )
+    end
+
+    protected
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_show_query(_model, box_or_field_reference)
+      box_or_field_reference.show_query
+    end
+
+    def generate_required_query(_model, box_or_field_reference)
+      box_or_field_reference.required_query
+    end
+
+  end
+end

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

@@ -0,0 +1,61 @@
+module Habarico
+  class EndpointsSchemaGenerator < AbstractGenerator
+
+    def generate(model, read_fields, write_fields, filters, methods)
+      # Validate arguments
+      validate_fields_argument!('read_fields', read_fields)
+      validate_fields_argument!('write_fields', write_fields)
+      raise Eluvia::Errors::StandardError.new('Argument `filters` must be an Array of String or Symbol instances') unless filters.is_a?(::Array) && filters.all? { |f| f.is_a?(::String) || f.is_a?(::Symbol) }
+      raise Eluvia::Errors::StandardError.new('Argument `methods` must be an array of String or Symbol instances') unless methods.is_a?(::Array) && methods.all? { |m| m.is_a?(::String) || m.is_a?(::Symbol) }
+
+      # Create model
+      Habarico::EndpointsSchema.new(
+        get: methods.include?(:get) || methods.include?('get') ? generate_get(model, read_fields, write_fields, filters) : nil,
+        post: methods.include?(:post) || methods.include?('post') ? generate_post(model, read_fields, write_fields, filters) : nil,
+        put: methods.include?(:put) || methods.include?('put') ? generate_put(model, read_fields, write_fields, filters) : nil,
+        patch: methods.include?(:patch) || methods.include?('patch') ? generate_patch(model, read_fields, write_fields, filters) : nil,
+        delete: methods.include?(:delete) || methods.include?('delete') ? generate_delete(model, read_fields, write_fields, filters) : nil
+      )
+    end
+
+    protected
+
+    def validate_fields_argument!(name, fields)
+      valid = fields.is_a?(::Array) && fields.all? do |f|
+        f.is_a?(::String) || f.is_a?(::Symbol) || f.is_a?(::Hash) || f.is_a?(Habarico::FieldReference)
+      end
+      return if valid
+
+      raise Eluvia::Errors::StandardError.new("Argument `#{name}` must be an Array of String, Symbol, Hash or Habarico::FieldReference instances")
+    end
+
+    def method_schema_generator
+      @method_schema_generator ||= definition.method_schema_generator.new(definition, resource_path)
+    end
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_get(model, read_fields, _write_fields, filters)
+      method_schema_generator.generate(model, read_fields, filters)
+    end
+
+    def generate_post(model, _read_fields, write_fields, _filters)
+      method_schema_generator.generate(model, write_fields, [])
+    end
+
+    def generate_put(model, _read_fields, write_fields, _filters)
+      method_schema_generator.generate(model, write_fields, [])
+    end
+
+    def generate_patch(model, _read_fields, write_fields, _filters)
+      method_schema_generator.generate(model, write_fields, [])
+    end
+
+    def generate_delete(model, _read_fields, _write_fields, _filters)
+      method_schema_generator.generate(model, [], [])
+    end
+
+  end
+end

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

@@ -0,0 +1,45 @@
+module Habarico
+  class EnumTypeGenerator < AbstractGenerator
+
+    def generate(model, attr_name, value)
+      # Validate arguments
+      raise Eluvia::Errors::StandardError.new("Model `#{model.model_name}` does not have enum attribute `#{attr_name}`") unless model.has_enum_attr?(attr_name)
+      raise Eluvia::Errors::StandardError.new("Enum attribute `#{attr_name}` of model `#{model.model_name}` does not have a choice with value `#{value}`") unless model.find_enum_attr(attr_name).fetch(value.to_s, nil)
+
+      # Create model
+      Habarico::EnumType.new(
+        value: generate_value(model, attr_name, value),
+        label: generate_label(model, attr_name, value),
+        color: generate_color(model, attr_name, value),
+        icon: generate_icon(model, attr_name, value)
+      )
+    end
+
+    protected
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_value(model, attr_name, value)
+      choice = model.find_enum_attr(attr_name).fetch(value.to_s, nil)
+      choice[:value].to_s
+    end
+
+    def generate_label(model, attr_name, value)
+      choice = model.find_enum_attr(attr_name).fetch(value.to_s, nil)
+      choice[:label].to_s
+    end
+
+    def generate_color(model, attr_name, value)
+      choice = model.find_enum_attr(attr_name).fetch(value.to_s, nil)
+      choice[:color].to_s
+    end
+
+    def generate_icon(model, attr_name, value)
+      choice = model.find_enum_attr(attr_name).fetch(value.to_s, nil)
+      choice[:icon]
+    end
+
+  end
+end

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

@@ -0,0 +1,179 @@
+module Habarico
+  class FieldOptionsGenerator < AbstractGenerator
+
+    def generate(model, attr_name, field_reference)
+      if field_reference.present?
+        return Habarico::FieldOptions.new(
+          prefix: generate_prefix_fr(model, field_reference),
+          postfix: generate_postfix_fr(model, field_reference),
+          text_align: generate_text_align_fr(model, field_reference),
+          target: generate_target_fr(model, field_reference),
+          number: generate_number_fr(model, field_reference),
+          dynamic_render: generate_dynamic_render_fr(model, field_reference),
+          relation: generate_relation_fr(model, field_reference),
+          phone: generate_phone_fr(model, field_reference),
+          choices: generate_choices_fr(model, field_reference),
+          image: generate_image_fr(model, field_reference),
+          ai: generate_ai_fr(model, field_reference),
+          max_size: generate_max_size_fr(model, field_reference),
+          accept: generate_accept_fr(model, field_reference),
+        )
+      end
+      if attr_name.present?
+        return Habarico::FieldOptions.new(
+          prefix: generate_prefix_at(model, attr_name),
+          postfix: generate_postfix_at(model, attr_name),
+          text_align: generate_text_align_at(model, attr_name),
+          target: generate_target_at(model, attr_name),
+          number: generate_number_at(model, attr_name),
+          dynamic_render: generate_dynamic_render_at(model, attr_name),
+          max_size: generate_max_size_at(model, attr_name),
+          accept: generate_accept_at(model, attr_name),
+        )
+      end
+      nil
+    end
+
+    protected
+
+    # ***********************************************************************
+    # Schema generators
+    # ***********************************************************************
+
+    def number_field_options_generator
+      @number_field_options_generator ||= definition.number_field_options_generator.new(definition, resource_path)
+    end
+
+    def dynamic_render_options_generator
+      @dynamic_render_options_generator ||= definition.dynamic_render_options_generator.new(definition, resource_path)
+    end
+
+    def relation_field_options_generator
+      @relation_field_options_generator ||= definition.relation_field_options_generator.new(definition, resource_path)
+    end
+
+    # Memoized per `(model, attr_name)` so `generate_max_size_*` and `generate_accept_*` - two
+    # independent generator methods, called separately for the same field - derive it only once
+    # instead of each re-running `model.validators_on(attachment)` and the Marcel content-type
+    # guess for the half of the result the other one does not need.
+    def file_validation_rules(model, attr_name)
+      @file_validation_rules ||= {}
+      @file_validation_rules[[model, attr_name]] ||= Habarico::FileValidations.for_model(model, attr_name)
+    end
+
+    def phone_field_options_generator
+      @phone_field_options_generator ||= definition.phone_field_options_generator.new(definition, resource_path)
+    end
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_prefix_at(_model, _attr_name)
+      # not implemented yet
+    end
+
+    def generate_postfix_at(_model, _attr_name)
+      # not implemented yet
+    end
+
+    def generate_text_align_at(model, attr_name)
+      return 'right' if Habarico::AttributesHelper.is_amount_major_attr?(model, attr_name)
+      nil
+    end
+
+    def generate_target_at(_model, _attr_name)
+      # not implemented yet
+    end
+
+    def generate_number_at(model, attr_name)
+      number_field_options_generator.generate(model, attr_name)
+    end
+
+    def generate_dynamic_render_at(_model, _attr_name)
+      nil # not possible to generate dynamic render without FieldReference
+    end
+
+    # Largest file (bytes) this `file_attr` 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::FileValidations.for_model`.
+    #
+    # A bare symbol declaration has no `FieldReference` to set an explicit override on - see
+    # `generate_max_size_fr` for that.
+    def generate_max_size_at(model, attr_name)
+      file_validation_rules(model, attr_name).max_size
+    end
+
+    # File types this `file_attr` accepts, derived from its own `active_storage_validations`
+    # content-type declaration (HAB-966).
+    def generate_accept_at(model, attr_name)
+      Habarico::FileValidations.accept_for(file_validation_rules(model, attr_name).allowed_content_types)
+    end
+
+    def generate_prefix_fr(_model, _field_reference)
+      # not implemented yet
+    end
+
+    def generate_postfix_fr(_model, _field_reference)
+      # not implemented yet
+    end
+
+    def generate_text_align_fr(_model, field_reference)
+      field_reference.text_align
+    end
+
+    def generate_target_fr(_model, field_reference)
+      field_reference.target
+    end
+
+    def generate_number_fr(_model, _field_reference)
+      # not implemented yet
+    end
+
+    def generate_dynamic_render_fr(model, field_reference)
+      dynamic_render_options_generator.generate(model, field_reference)
+    end
+
+    def generate_relation_fr(model, field_reference)
+      relation_field_options_generator.generate(model, field_reference)
+    end
+
+    def generate_phone_fr(model, field_reference)
+      phone_field_options_generator.generate(model, field_reference)
+    end
+
+    def generate_choices_fr(_model, field_reference)
+      icons_key = field_reference.icons_key
+      return nil if icons_key.blank?
+      Habarico::ChoicesFieldOptions.new(icons_key: icons_key)
+    end
+
+    def generate_image_fr(_model, field_reference)
+      resize_width = field_reference.resize_width
+      crop_aspect_ratio = field_reference.crop_aspect_ratio
+      return nil if resize_width.blank? && crop_aspect_ratio.blank?
+      Habarico::ImageFieldOptions.new(resize_width: resize_width, crop_aspect_ratio: crop_aspect_ratio)
+    end
+
+    def generate_ai_fr(_model, field_reference)
+      source_fields = field_reference.ai_source_fields
+      return nil if source_fields.blank?
+      Habarico::AiFieldOptions.new(source_fields: source_fields)
+    end
+
+    # `field_reference.max_size` is a deliberate override, the same way `resize_width` /
+    # `icons_key` above are - set by hand it always wins over what the attachment's own validators
+    # imply.
+    def generate_max_size_fr(model, field_reference)
+      return field_reference.max_size if field_reference.max_size.present?
+      file_validation_rules(model, field_reference.name).max_size
+    end
+
+    def generate_accept_fr(model, field_reference)
+      return field_reference.accept if field_reference.accept.present?
+      Habarico::FileValidations.accept_for(file_validation_rules(model, field_reference.name).allowed_content_types)
+    end
+
+  end
+end