habarico 7.2.0.pre.beta.5

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

@@ -0,0 +1,45 @@
+module Habarico
+  class NumberFieldOptionsGenerator < AbstractGenerator
+
+    def generate(model, attr_name)
+      Habarico::NumberFieldOptions.new(
+        style: generate_style(model, attr_name),
+        currency: generate_currency(model, attr_name),
+        unit: generate_unit(model, attr_name),
+        minimum_fraction_digits: generate_minimum_fraction_digits(model, attr_name),
+        maximum_fraction_digits: generate_maximum_fraction_digits(model, attr_name),
+      )
+    end
+
+    protected
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_style(model, attr_name)
+      return 'currency' if Habarico::AttributesHelper.is_amount_major_attr?(model, attr_name)
+      nil
+    end
+
+    def generate_currency(model, attr_name)
+      return Habarico::Config.currency if Habarico::AttributesHelper.is_amount_major_attr?(model, attr_name)
+      nil
+    end
+
+    def generate_unit(_model, _attr_name)
+      # not implemented
+    end
+
+    def generate_minimum_fraction_digits(model, attr_name)
+      return 2 if Habarico::AttributesHelper.is_amount_major_attr?(model, attr_name)
+      nil
+    end
+
+    def generate_maximum_fraction_digits(model, attr_name)
+      return 2 if Habarico::AttributesHelper.is_amount_major_attr?(model, attr_name)
+      nil
+    end
+
+  end
+end

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

@@ -0,0 +1,29 @@
+module Habarico
+  class PhoneFieldOptionsGenerator < AbstractGenerator
+
+    def generate(model, field_reference)
+      phone = field_reference.phone
+      return nil if phone.blank?
+
+      Habarico::PhoneFieldOptions.new(
+        default_region: generate_default_region(model, phone),
+        allowed_regions: generate_allowed_regions(model, phone),
+      )
+    end
+
+    protected
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_default_region(_model, phone)
+      phone[:default_region]
+    end
+
+    def generate_allowed_regions(_model, phone)
+      phone[:allowed_regions]
+    end
+
+  end
+end

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

@@ -0,0 +1,90 @@
+module Habarico
+  class RelationFieldOptionsGenerator < AbstractGenerator
+
+    def generate(model, field_reference)
+      relation = field_reference.relation
+      parent = field_reference.parent
+
+      return nil if relation.present? && !relation.is_a?(Hash)
+      return nil if relation.blank? && parent.blank?
+
+      hash = relation.is_a?(Hash) ? relation : {}
+
+      Habarico::RelationFieldOptions.new(
+        show_link: generate_show_link(model, hash),
+        link_mode: generate_link_mode(model, hash),
+        dialog_width: generate_dialog_width(model, hash),
+        keep_linked_parent: generate_keep_linked_parent(model, hash),
+        show_edit_button: generate_show_edit_button(model, hash),
+        show_create_button: generate_show_create_button(model, hash),
+        preserve_order: generate_preserve_order(model, hash),
+        filters: generate_filters(model, hash),
+        sort: generate_sort(model, hash),
+        parent: generate_parent(model, hash, parent),
+      )
+    end
+
+    protected
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_show_link(_model, hash)
+      hash[:show_link]
+    end
+
+    def generate_link_mode(_model, hash)
+      hash[:link_mode]
+    end
+
+    def generate_dialog_width(_model, hash)
+      hash[:dialog_width]
+    end
+
+    def generate_keep_linked_parent(_model, hash)
+      hash[:keep_linked_parent]
+    end
+
+    def generate_show_edit_button(_model, hash)
+      hash[:show_edit_button]
+    end
+
+    def generate_show_create_button(_model, hash)
+      hash[:show_create_button]
+    end
+
+    def generate_preserve_order(_model, hash)
+      hash[:preserve_order]
+    end
+
+    def generate_filters(_model, hash)
+      Array(hash[:filters]).map do |f|
+        next f if f.is_a?(Habarico::KeyValue)
+        Habarico::KeyValue.new(key: f[:key] || f['key'], value: f[:value] || f['value'])
+      end.presence
+    end
+
+    def generate_sort(_model, hash)
+      sort = hash[:sort]
+      if sort.is_a?(String)
+        # Support 'field_name:direction' format (e.g. 'email:asc', 'created_at:desc')
+        parts = sort.split(':')
+        Habarico::SortDescriptor.new(
+          field_name: parts[0],
+          direction: parts[1] == 'desc' ? 'desc' : 'asc'
+        )
+      elsif sort.is_a?(Hash)
+        Habarico::SortDescriptor.new(
+          field_name: sort[:field_name] || sort['field_name'],
+          direction: sort[:direction] || sort['direction']
+        )
+      end
+    end
+
+    def generate_parent(_model, hash, field_reference_parent)
+      hash[:parent] || field_reference_parent
+    end
+
+  end
+end

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

@@ -0,0 +1,44 @@
+module Habarico
+  class SearchFilterSchemaGenerator < AbstractGenerator
+
+    def generate(model)
+      Habarico::FilterSchema.new(
+        name: generate_name(model),
+        type: generate_type(model),
+        format: generate_format(model),
+        label: generate_label(model),
+        help_text: generate_help_text(model),
+      )
+    end
+
+    protected
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_name(_model)
+      'search'
+    end
+
+    def generate_type(_model)
+      'string'
+    end
+
+    def generate_format(_model)
+      'search'
+    end
+
+    def generate_label(model)
+      # Per-model override first (e.g. "Search by VS or counter-account"), then Habarico's
+      # generic translated label, and finally the literal 'search' as a last resort.
+      I18n.t("#{model.i18n_scope}.attributes.#{model.model_name.i18n_key}.search",
+             default: I18n.t('filters.common.search', default: 'search'))
+    end
+
+    def generate_help_text(model)
+      generate_label(model)
+    end
+
+  end
+end

data/lib/habarico/generators/menu/menu_group_schema_generator.rb

@@ -0,0 +1,63 @@
+module Habarico
+  class MenuGroupSchemaGenerator < AbstractGenerator
+
+    def generate(menu_path)
+      # Validate arguments
+      raise Eluvia::Errors::StandardError.new('Argument `menu_path` must be an array of Habarico::MenuItem objects') unless menu_path.is_a?(::Array) && menu_path.all? { |b| b.is_a?(Habarico::MenuItem) }
+
+      # Pop last breadcrumb as current menu item
+      menu_path_2 = menu_path.dup
+      menu_item = menu_path_2.pop
+      return nil if menu_item.nil?
+
+      # Create model
+      Habarico::MenuGroupSchema.new(
+        name: generate_name(menu_item),
+        label: generate_label(menu_item),
+        icon: generate_icon(menu_item),
+        color: generate_color(menu_item),
+        priority: generate_priority(menu_item),
+        parent: generate_parent(menu_path_2),
+      )
+    end
+
+    protected
+
+    def menu_group_schema_generator
+      @menu_group_schema_generator ||= definition.menu_group_schema_generator.new(definition, resource_path)
+    end
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_name(menu_item)
+      menu_item.name
+    end
+
+    def generate_label(menu_item)
+      menu_item.label
+    end
+
+    def generate_icon(menu_item)
+      menu_item.icon
+    end
+
+    def generate_color(menu_item)
+      menu_item.color
+    end
+
+    def generate_priority(menu_item)
+      menu_item.priority
+    end
+
+    def generate_parent(menu_path)
+      if menu_path.empty?
+        nil
+      else
+        menu_group_schema_generator.generate(menu_path)
+      end
+    end
+
+  end
+end

data/lib/habarico/generators/menu/menu_link_parameters_generator.rb

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

data/lib/habarico/generators/menu/menu_schema_generator.rb

@@ -0,0 +1,105 @@
+module Habarico
+  class MenuSchemaGenerator < AbstractGenerator
+
+    def generate(menu_item, menu_path)
+      # Validate arguments
+      raise Eluvia::Errors::StandardError.new('Definition `menu_item` must be a Habarico::MenuItem object') unless menu_item.is_a?(Habarico::MenuItem)
+
+      # Create model
+      Habarico::MenuSchema.new(
+        name: generate_name(menu_item),
+        label: generate_label(menu_item),
+        icon: generate_icon(menu_item),
+        color: generate_color(menu_item),
+        priority: generate_priority(menu_item),
+        type: generate_type(menu_item),
+        view: generate_view(menu_item),
+        link: generate_link(menu_item),
+        parent: generate_parent(menu_path)
+      )
+    end
+
+    protected
+
+    def menu_group_schema_generator
+      @menu_group_schema_generator ||= definition.menu_group_schema_generator.new(definition, resource_path)
+    end
+
+    def menu_view_parameters_generator
+      @menu_view_parameters_generator ||= definition.menu_view_parameters_generator.new(definition, resource_path)
+    end
+
+    def menu_link_parameters_generator
+      @menu_link_parameters_generator ||= definition.menu_link_parameters_generator.new(definition, resource_path)
+    end
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_name(menu_item)
+      return menu_item.name if menu_item.name
+
+      # Compute prefix from this or referenced resource
+      prefix = nil
+      if menu_item.reference.present?
+        prefix = Habarico::ResourceService.instance.find_resource_name_by_model_class_or_instance(menu_item.reference)
+      end
+      if prefix.nil?
+        prefix = resource_path.last
+      end
+
+      # Compute suffix from view name or link url
+      suffix = if menu_item.type.to_sym == :view && menu_item.view_name
+                 menu_item.view_name
+               elsif menu_item.type.to_sym == :link && menu_item.link_url
+                 menu_item.link_url.gsub(/[^a-zA-Z0-9]/, '_')
+               else
+                 'item'
+               end
+
+      "#{prefix}-#{suffix}"
+    end
+
+    def generate_label(menu_item)
+      menu_item.label || definition.label || I18n.t("resources.#{resource_path.join('.')}", default: generate_name(menu_item).to_s.humanize)
+    end
+
+    def generate_icon(menu_item)
+      menu_item.icon || definition.icon
+    end
+
+    def generate_color(menu_item)
+      menu_item.color
+    end
+
+    def generate_priority(menu_item)
+      menu_item.priority
+    end
+
+    def generate_type(menu_item)
+      menu_item.type
+    end
+
+    def generate_view(menu_item)
+      if menu_item.type.to_sym == :view
+        menu_view_parameters_generator.generate(menu_item)
+      end
+    end
+
+    def generate_link(menu_item)
+      if menu_item.type.to_sym == :link
+        menu_link_parameters_generator.generate(menu_item)
+      end
+    end
+
+    def generate_parent(menu_path)
+      if menu_path.blank? || menu_path.empty?
+        nil
+      else
+        menu_group_schema_generator.generate(menu_path)
+      end
+    end
+
+  end
+end

data/lib/habarico/generators/menu/menu_view_endpoint_parameters_generator.rb

@@ -0,0 +1,44 @@
+module Habarico
+  class MenuViewEndpointParametersGenerator < AbstractGenerator
+
+    def generate(menu_item)
+      # Validate arguments
+      raise Eluvia::Errors::StandardError.new('Argument `menu_item` must be a Habarico::MenuItem') unless menu_item.is_a?(Habarico::MenuItem)
+      raise Eluvia::Errors::StandardError.new('Argument `menu_item` must be of :view type') unless menu_item.type.to_sym == :view
+
+      # Create model
+      Habarico::ViewActionEndpointParameters.new(
+        reference: generate_reference(menu_item),
+        action_name: generate_action_name(menu_item),
+        record_pk: generate_record_pk(menu_item)
+      )
+    end
+
+    protected
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_reference(menu_item)
+      if menu_item.reference.present?
+        return Habarico::ResourceService.instance.find_resource_name_by_model_class_or_instance(menu_item.reference)
+      end
+      nil
+    end
+
+    def generate_action_name(menu_item)
+      menu_item.reference_action_name
+    end
+
+    def generate_record_pk(menu_item)
+      if menu_item.reference.present?
+        if Habarico::ReflectionHelper.is_active_record_instance?(menu_item.reference)
+          return menu_item.reference.id
+        end
+      end
+      nil
+    end
+
+  end
+end

data/lib/habarico/generators/menu/menu_view_parameters_generator.rb

@@ -0,0 +1,50 @@
+module Habarico
+  class MenuViewParametersGenerator < AbstractGenerator
+
+    def generate(menu_item)
+      # Validate arguments
+      raise Eluvia::Errors::StandardError.new('Argument `menu_item` must be a Habarico::MenuItem') unless menu_item.is_a?(Habarico::MenuItem)
+      raise Eluvia::Errors::StandardError.new('Argument `menu_item` must be of :view type') unless menu_item.type.to_sym == :view
+
+      # Create model
+      Habarico::ViewActionParameters.new(
+        name: generate_name(menu_item),
+        mode: generate_mode(menu_item),
+        dialog_width: generate_dialog_width(menu_item),
+        endpoint: generate_endpoint(menu_item),
+        keep_linked_parent: generate_keep_linked_parent(menu_item)
+      )
+    end
+
+    protected
+
+    def menu_view_endpoint_parameters_generator
+      @menu_view_endpoint_parameters_generator ||= definition.menu_view_endpoint_parameters_generator.new(definition, resource_path)
+    end
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_name(menu_item)
+      menu_item.view_name
+    end
+
+    def generate_mode(menu_item)
+      menu_item.view_mode
+    end
+
+    def generate_dialog_width(menu_item)
+      menu_item.dialog_width
+    end
+
+    def generate_endpoint(menu_item)
+      menu_view_endpoint_parameters_generator.generate(menu_item)
+    end
+
+    def generate_keep_linked_parent(menu_item)
+      menu_item.view_keep_linked_parent
+    end
+
+  end
+end

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

@@ -0,0 +1,84 @@
+module Habarico
+  class ActionResourceSchemaGenerator < ResourceSchemaGenerator
+
+    def generate(action_name, context)
+      view = definition.normalized_views.find { |view| view.endpoint_action_name == action_name }
+      action = definition.normalized_actions.find { |action| action.is_a?(Habarico::ResourceAction) && action.endpoint_action_name == action_name }
+      if view
+        generate_view_action(action_name, view, context)
+      elsif action
+        generate_resource_action(action_name, action, context)
+      else
+        Habarico::LocalResourceSchema.new(
+          name: generate_name,
+          label: generate_label,
+          pk_field_name: generate_pk_field_name
+        )
+      end
+    end
+
+    protected
+
+    def resource_action_schema_generator
+      @resource_action_schema_generator ||= definition.resource_action_schema_generator.new(definition, resource_path)
+    end
+
+    def view_schema_generator
+      @view_schema_generator ||= definition.view_schema_generator.new(definition, resource_path)
+    end
+
+    def endpoints_schema_generator
+      @endpoints_schema_generator ||= definition.endpoints_schema_generator.new(definition, resource_path)
+    end
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_actions(_action_name, _context)
+      []
+    end
+
+    def generate_view_action(action_name, view, context)
+      # Generate view schema
+      view_schema = view_schema_generator.generate(view, context)
+
+      # Generate endpoint schema
+      model = view.model || definition.model
+      read_fields = write_fields = view.boxes
+      endpoints_schema = endpoints_schema_generator.generate(model, read_fields, write_fields, [], [view_schema.endpoint.method.to_sym])
+
+      # Create model
+      Habarico::LocalResourceSchema.new(
+        name: generate_name,
+        label: generate_label,
+        pk_field_name: generate_pk_field_name,
+        actions: generate_actions(action_name, context),
+        views: [view_schema],
+        endpoints: endpoints_schema
+      )
+    end
+
+    def generate_resource_action(action_name, action, context)
+      # Generate resource action schema
+      resource_action_schema = resource_action_schema_generator.generate(action, context)
+      raise Eluvia::Errors::StandardError.new("Action `#{action_name}` must be a resource action") unless resource_action_schema.resource&.endpoint
+
+      # Generate endpoint schema
+      endpoints_schema = endpoints_schema_generator.generate(definition.model,
+                                                           [], [], [],
+                                                           [resource_action_schema.resource.endpoint.method.to_sym])
+
+      # Create model
+      Habarico::LocalResourceSchema.new(
+        name: generate_name,
+        label: generate_label,
+        pk_field_name: generate_pk_field_name,
+        actions: generate_actions(action_name, context),
+        views: [],
+        endpoints: endpoints_schema
+      )
+    end
+
+  end
+end

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

@@ -0,0 +1,70 @@
+module Habarico
+  class GlobalResourceSchemaGenerator < ResourceSchemaGenerator
+
+    def generate(context)
+      Habarico::GlobalResourceSchema.new(
+        name: generate_name,
+        label: generate_label,
+        pk_field_name: generate_pk_field_name,
+        actions: generate_actions(context),
+        views: generate_views(context),
+        menu: generate_menu(context),
+      )
+    end
+
+    protected
+
+    def global_resource_action_schema_generator
+      @global_resource_action_schema_generator ||= definition.global_resource_action_schema_generator.new(definition, resource_path)
+    end
+
+    def global_view_schema_generator
+      @global_view_schema_generator ||= definition.global_view_schema_generator.new(definition, resource_path)
+    end
+
+    def menu_schema_generator
+      @menu_schema_generator ||= definition.menu_schema_generator.new(definition, resource_path)
+    end
+
+    # ***********************************************************************
+    # Attribute generators
+    # ***********************************************************************
+
+    def generate_actions(context)
+      # Generate and filter actions based on permissions
+      definition.normalized_actions.select do |action|
+
+        # Action must be allowed by permissions
+        context.can?(action.permission)
+
+      end.map do |action|
+
+        # Generate action schema
+        global_resource_action_schema_generator.generate(action)
+
+      end
+    end
+
+    def generate_views(context)
+      # Generate and filter views based on permissions
+      definition.normalized_views.select do |view|
+
+        # View must be allowed by permissions
+        context.can?(view.permission)
+
+      end.map do |view|
+
+        # Generate view schema
+        global_view_schema_generator.generate(view)
+
+      end
+    end
+
+    def generate_menu(context)
+      return nil unless context.can?(:read)
+      return nil if definition.menu_item == false
+      menu_schema_generator.generate(definition.menu_item || Habarico::ViewMenuItem.new(view_name: 'list'), definition.menu_path)
+    end
+
+  end
+end