habarico 7.2.0.pre.beta.5

data/lib/habarico/definition/actions/delete_action.rb

@@ -0,0 +1,20 @@
+module Habarico
+  class DeleteAction < ResourceAction
+    include DefinitionModel
+
+    def initialize(params = {})
+      @name = 'delete'
+      @icon = 'Delete'
+      @color = 'error'
+      @is_detail = true # -> tied to a single resource item
+      @show_in_detail = false # -> do not show in detail views
+      @show_in_list = true # -> show in list views (for each item in the list)
+      @endpoint_method = :delete # -> use HTTP DELETE method
+      @confirm_dialog_title = I18n.t('confirmations.common.delete.title', default: nil)
+      @confirm_dialog_message = I18n.t('confirmations.common.delete.message', default: nil)
+      @permission = :delete
+      super(params)
+    end
+
+  end
+end

data/lib/habarico/definition/actions/edit_action.rb

@@ -0,0 +1,18 @@
+module Habarico
+  class EditAction < ViewAction
+    include DefinitionModel
+
+    def initialize(params = {})
+      @name = 'edit'
+      @icon = 'Edit'
+      @is_detail = true # -> tied to a single resource item
+      @show_in_detail = true # -> show in detail views (on top of the detail)
+      @show_in_list = true # -> show in list views (for each item in the list)
+      @view_name = 'edit' # -> connect it to the Habarico::EditView or any other view named 'edit'
+      @view_mode = :redirect # -> open the view on the new page
+      @permission = :update
+      super(params)
+    end
+
+  end
+end

data/lib/habarico/definition/actions/link_action.rb

@@ -0,0 +1,11 @@
+module Habarico
+  class LinkAction < Action
+    include DefinitionModel
+
+    def initialize(params = {})
+      @type = :link
+      super(params)
+    end
+
+  end
+end

data/lib/habarico/definition/actions/resource_action.rb

@@ -0,0 +1,12 @@
+module Habarico
+  class ResourceAction < Action
+    include DefinitionModel
+
+    def initialize(params = {})
+      @type = :resource
+      @is_background = false
+      super(params)
+    end
+
+  end
+end

data/lib/habarico/definition/actions/save_action.rb

@@ -0,0 +1,14 @@
+module Habarico
+  class SaveAction < Action
+    include DefinitionModel
+
+    def initialize(params = {})
+      @type = :save
+      @name = 'save'
+      @icon = 'Check'
+      @color = :primary
+      super(params)
+    end
+
+  end
+end

data/lib/habarico/definition/actions/show_action.rb

@@ -0,0 +1,18 @@
+module Habarico
+  class ShowAction < ViewAction
+    include DefinitionModel
+
+    def initialize(params = {})
+      @name = 'show'
+      @icon = 'Visibility'
+      @is_detail = true # -> tied to a single resource item
+      @show_in_detail = true # -> show in detail views (on top of the detail)
+      @show_in_list = true # -> show in list views (for each item in the list)
+      @view_name = 'show' # -> connect it to the Habarico::ShowView or any other view named 'show'
+      @view_mode = :redirect # -> open the view on the new page
+      @permission = :read
+      super(params)
+    end
+
+  end
+end

data/lib/habarico/definition/actions/upload_images_action.rb

@@ -0,0 +1,11 @@
+module Habarico
+  class UploadImagesAction < Action
+    include DefinitionModel
+
+    def initialize(params = {})
+      @type = :"upload-images"
+      super(params)
+    end
+
+  end
+end

data/lib/habarico/definition/actions/view_action.rb

@@ -0,0 +1,11 @@
+module Habarico
+  class ViewAction < Action
+    include DefinitionModel
+
+    def initialize(params = {})
+      @type = :view
+      super(params)
+    end
+
+  end
+end

data/lib/habarico/definition/boxes/array_box.rb

@@ -0,0 +1,10 @@
+module Habarico
+  class ArrayBox < Box
+    include DefinitionModel
+
+    def initialize(params = {})
+      super(params)
+      @type = 'array'
+    end
+  end
+end

data/lib/habarico/definition/boxes/box.rb

@@ -0,0 +1,32 @@
+module Habarico
+  class Box
+    include DefinitionModel
+
+    attr_accessor :type, :label, :name, :read_only, :card, :collapsible, :boxes, :show_query, :required_query, :toolbar_actions, :bottom_actions
+
+    # Gallery
+    attr_accessor :reference, :target, :image_field, :schema_params, :extra_filters
+
+    # Array
+    attr_accessor :target, :inline # rubocop:disable Lint/DuplicateMethods -- intentional for readability
+
+    # Grid Item
+    attr_accessor :xs, :sm, :md, :lg, :xl
+
+    # List
+    attr_accessor :reference, :target, :extra_filters, :row_actions, :list_toolbar_actions, :list_actions, :filters, :default_sorting, # rubocop:disable Lint/DuplicateMethods -- intentional for readability
+                  :sortable_field_name, :sortable_sort_for_filters, :single_click_action, :double_click_action
+
+    # Object
+    attr_accessor :target # rubocop:disable Lint/DuplicateMethods -- intentional for readability
+
+    # Tab / Wizard
+    attr_accessor :show_toolbar_navigation, :validate_steps
+
+    def initialize(params = {})
+      super(params)
+      @type = 'simple'
+    end
+
+  end
+end

data/lib/habarico/definition/boxes/gallery_box.rb

@@ -0,0 +1,10 @@
+module Habarico
+  class GalleryBox < Box
+    include DefinitionModel
+
+    def initialize(params = {})
+      super(params)
+      @type = 'gallery'
+    end
+  end
+end

data/lib/habarico/definition/boxes/grid_box.rb

@@ -0,0 +1,10 @@
+module Habarico
+  class GridBox < Box
+    include DefinitionModel
+
+    def initialize(params = {})
+      super(params)
+      @type = 'grid'
+    end
+  end
+end

data/lib/habarico/definition/boxes/grid_item_box.rb

@@ -0,0 +1,10 @@
+module Habarico
+  class GridItemBox < Box
+    include DefinitionModel
+
+    def initialize(params = {})
+      super(params)
+      @type = 'grid-item'
+    end
+  end
+end

data/lib/habarico/definition/boxes/list_box.rb

@@ -0,0 +1,10 @@
+module Habarico
+  class ListBox < Box
+    include DefinitionModel
+
+    def initialize(params = {})
+      super(params)
+      @type = 'list'
+    end
+  end
+end

data/lib/habarico/definition/boxes/object_box.rb

@@ -0,0 +1,10 @@
+module Habarico
+  class ObjectBox < Box
+    include DefinitionModel
+
+    def initialize(params = {})
+      super(params)
+      @type = 'object'
+    end
+  end
+end

data/lib/habarico/definition/boxes/tab_box.rb

@@ -0,0 +1,10 @@
+module Habarico
+  class TabBox < Box
+    include DefinitionModel
+
+    def initialize(params = {})
+      super(params)
+      @type = 'tab'
+    end
+  end
+end

data/lib/habarico/definition/boxes/tab_item_box.rb

@@ -0,0 +1,10 @@
+module Habarico
+  class TabItemBox < Box
+    include DefinitionModel
+
+    def initialize(params = {})
+      super(params)
+      @type = 'tab-item'
+    end
+  end
+end

data/lib/habarico/definition/boxes/wizard_box.rb

@@ -0,0 +1,10 @@
+module Habarico
+  class WizardBox < Box
+    include DefinitionModel
+
+    def initialize(params = {})
+      super(params)
+      @type = 'wizard'
+    end
+  end
+end

data/lib/habarico/definition/concerns/definition_model.rb

@@ -0,0 +1,38 @@
+module Habarico
+  module DefinitionModel
+    extend ActiveSupport::Concern
+
+    def initialize(params = {})
+      self.class.attrs.each do |attr|
+        if params.key?(attr)
+          self.send("#{attr}=", params[attr])
+        end
+      end
+    end
+
+    def assign(params = {})
+      self.class.attrs.each do |attr|
+        if params.key?(attr)
+          self.send("#{attr}=", params[attr])
+        end
+      end
+    end
+
+    class_methods do
+
+      def attrs
+        if @attrs.nil?
+          @attrs = []
+          @attrs.concat(self.superclass.attrs) if self.superclass.respond_to?(:attrs)
+        end
+        @attrs
+      end
+
+      def attr_accessor(*attrs)
+        self.attrs.concat(attrs)
+        super(*attrs)
+      end
+    end
+
+  end
+end

data/lib/habarico/definition/definition.rb

@@ -0,0 +1,206 @@
+module Habarico
+  class Definition
+    include DefinitionModel
+
+    attr_accessor :model, :default_sorting, :force_sorting, :default_filter, :includes, :prefetch, :scopes,
+
+                  # Metadata
+                  :tags,
+
+                  # Navigation
+                  :icon, :label, :fields, :menu_path, :menu_item, :breadcrumbs,
+
+                  # Search (per-resource; the cross-resource spotlight search adds
+                  # `global_fulltext_search_enabled` from habarico-enterprise - HAB-812)
+                  :search_fields,
+
+                  # Fields and filters
+                  :sorting_fields, :read_only_fields, :write_only_fields, :filters,
+
+                  # Pagination (per resource; `nil` falls back to `Habarico::Config` and then to
+                  # the eluvia-base defaults - see `Habarico::Controller#set_list_pagination`)
+                  :default_page_limit, :max_page_limit,
+
+                  # Aggregation and dashboard are paid: habarico-enterprise adds
+                  # `aggregate_enabled`, `aggregate_max_buckets`, `aggregate_fields`,
+                  # `aggregate_schema_generator` and `dashboard_enabled` here (HAB-812).
+
+                  # Views and actions
+                  :views, :actions,
+
+                  # Permissions
+                  :can, :can_read, :can_create, :can_update, :can_delete, :allow_read_by_id,
+                  :policy_scope,
+
+                  # Generator classes - action
+                  :link_action_parameters_generator, :resource_action_endpoint_parameters_generator,
+                  :resource_action_parameters_generator, :save_action_parameters_generator, :action_schema_generator,
+                  :view_action_endpoint_parameters_generator, :view_action_parameters_generator,
+                  :confirm_dialog_properties_generator, :global_resource_action_schema_generator,
+                  :resource_action_schema_generator, :upload_images_action_parameters_generator,
+
+                  # Generator classes - endpoint
+                  :dynamic_render_options_generator, :method_schema_generator, :endpoints_schema_generator,
+                  :enum_type_generator, :field_options_generator, :field_schema_generator,
+                  :fields_schema_generator, :filter_schema_generator, :filters_schema_generator,
+                  :number_field_options_generator, :phone_field_options_generator, :relation_field_options_generator,
+                  :search_filter_schema_generator,
+
+                  # Generator classes - menu
+                  :menu_group_schema_generator, :menu_link_parameters_generator, :menu_schema_generator,
+                  :menu_view_endpoint_parameters_generator, :menu_view_parameters_generator,
+
+                  # Generator classes - resource
+                  :action_resource_schema_generator, :global_resource_schema_generator,
+                  :local_resource_schema_generator, :object_resource_schema_generator,
+
+                  # Generator classes - view
+                  :action_descriptor_generator, :array_box_parameters_generator, :box_options_generator,
+                  :box_schema_generator, :field_descriptor_generator, :filter_descriptor_generator,
+                  :gallery_box_parameters_generator, :global_view_schema_generator, :grid_item_box_parameters_generator,
+                  :list_box_parameters_generator, :object_box_parameters_generator, :sort_descriptor_generator,
+                  :tab_box_parameters_generator, :wizard_box_parameters_generator, :detail_view_parameters_generator,
+                  :view_endpoint_parameters_generator, :list_view_parameters_generator, :view_schema_generator
+
+    def initialize
+
+      # No column is assumed to exist. Without a declaration the list is ordered by the primary
+      # key alone, which `Habarico::Controller#append_order_by_tiebreaker` appends anyway
+      # (HAB-915).
+      @default_sorting = nil
+      @force_sorting = false
+      @default_filter = {}
+      @includes = []
+      @scopes = []
+
+      # Fields and filters
+      @fields = []
+      @read_only_fields = []
+      @write_only_fields = []
+      @sorting_fields = []
+      @filters = []
+
+      # Aggregation
+
+      # Dashboard
+
+      # Views and actions
+      @views = %i[list show]
+      @actions = [:show]
+
+      # Search
+      @search_fields = []
+
+      # ***********************************************************************
+      # Permissions
+      # ***********************************************************************
+
+      @can_read = true
+      @can_create = false
+      @can_update = false
+      @can_delete = false
+      # Explicit opt-in for ID-based reads without `can_read`: `show` by ID and the id__in-only
+      # `index` mode. Cross-service reference resources (resolved via `ReferenceField`) need this.
+      @allow_read_by_id = false
+
+      # ***********************************************************************
+      # Generator classes
+      # ***********************************************************************
+
+      # Action
+      @link_action_parameters_generator = Habarico::LinkActionParametersGenerator
+      @resource_action_endpoint_parameters_generator = Habarico::ResourceActionEndpointParametersGenerator
+      @resource_action_parameters_generator = Habarico::ResourceActionParametersGenerator
+      @save_action_parameters_generator = Habarico::SaveActionParametersGenerator
+      @action_schema_generator = Habarico::ActionSchemaGenerator
+      @view_action_endpoint_parameters_generator = Habarico::ViewActionEndpointParametersGenerator
+      @view_action_parameters_generator = Habarico::ViewActionParametersGenerator
+      @confirm_dialog_properties_generator = Habarico::ConfirmDialogPropertiesGenerator
+      @global_resource_action_schema_generator = Habarico::GlobalResourceActionSchemaGenerator
+      @resource_action_schema_generator = Habarico::ResourceActionSchemaGenerator
+      @upload_images_action_parameters_generator = Habarico::UploadImagesActionParametersGenerator
+
+      # Endpoint
+      @dynamic_render_options_generator = Habarico::DynamicRenderOptionsGenerator
+      @method_schema_generator = Habarico::MethodSchemaGenerator
+      @endpoints_schema_generator = Habarico::EndpointsSchemaGenerator
+      @enum_type_generator = Habarico::EnumTypeGenerator
+      @field_options_generator = Habarico::FieldOptionsGenerator
+      @field_schema_generator = Habarico::FieldSchemaGenerator
+      @fields_schema_generator = Habarico::FieldsSchemaGenerator
+      @filter_schema_generator = Habarico::FilterSchemaGenerator
+      @filters_schema_generator = Habarico::FiltersSchemaGenerator
+      @number_field_options_generator = Habarico::NumberFieldOptionsGenerator
+      @phone_field_options_generator = Habarico::PhoneFieldOptionsGenerator
+      @relation_field_options_generator = Habarico::RelationFieldOptionsGenerator
+      @search_filter_schema_generator = Habarico::SearchFilterSchemaGenerator
+
+      # Aggregate
+
+      # Menu
+      @menu_group_schema_generator = Habarico::MenuGroupSchemaGenerator
+      @menu_link_parameters_generator = Habarico::MenuLinkParametersGenerator
+      @menu_schema_generator = Habarico::MenuSchemaGenerator
+      @menu_view_endpoint_parameters_generator = Habarico::MenuViewEndpointParametersGenerator
+      @menu_view_parameters_generator = Habarico::MenuViewParametersGenerator
+
+      # Resource
+      @action_resource_schema_generator = Habarico::ActionResourceSchemaGenerator
+      @global_resource_schema_generator = Habarico::GlobalResourceSchemaGenerator
+      @local_resource_schema_generator = Habarico::LocalResourceSchemaGenerator
+      @object_resource_schema_generator = Habarico::ObjectResourceSchemaGenerator
+
+      # View
+      @action_descriptor_generator = Habarico::ActionDescriptorGenerator
+      @array_box_parameters_generator = Habarico::ArrayBoxParametersGenerator
+      @box_options_generator = Habarico::BoxOptionsGenerator
+      @box_schema_generator = Habarico::BoxSchemaGenerator
+      @field_descriptor_generator = Habarico::FieldDescriptorGenerator
+      @filter_descriptor_generator = Habarico::FilterDescriptorGenerator
+      @gallery_box_parameters_generator = Habarico::GalleryBoxParametersGenerator
+      @global_view_schema_generator = Habarico::GlobalViewSchemaGenerator
+      @grid_item_box_parameters_generator = Habarico::GridItemBoxParametersGenerator
+      @list_box_parameters_generator = Habarico::ListBoxParametersGenerator
+      @object_box_parameters_generator = Habarico::ObjectBoxParametersGenerator
+      @sort_descriptor_generator = Habarico::SortDescriptorGenerator
+      @tab_box_parameters_generator = Habarico::TabBoxParametersGenerator
+      @wizard_box_parameters_generator = Habarico::WizardBoxParametersGenerator
+      @detail_view_parameters_generator = Habarico::DetailViewParametersGenerator
+      @view_endpoint_parameters_generator = Habarico::ViewEndpointParametersGenerator
+      @list_view_parameters_generator = Habarico::ListViewParametersGenerator
+      @view_schema_generator = Habarico::ViewSchemaGenerator
+
+    end
+
+    def normalized_actions
+      @actions.map do |action|
+        if action.is_a?(String) || action.is_a?(Symbol)
+          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
+        elsif action.is_a?(Habarico::Action)
+          action
+        end
+      end.compact
+    end
+
+    def normalized_views
+      @views.map do |view|
+        if view.is_a?(String) || view.is_a?(Symbol)
+          case view.to_sym
+          when :list then Habarico::ListView.new
+          when :show then Habarico::ShowView.new
+          when :edit then Habarico::EditView.new
+          when :create then Habarico::CreateView.new
+          end
+        elsif view.is_a?(Habarico::View)
+          view
+        end
+      end.compact
+    end
+
+  end
+end

data/lib/habarico/definition/field_reference.rb

@@ -0,0 +1,9 @@
+module Habarico
+  class FieldReference
+    include DefinitionModel
+
+    attr_accessor :name, :label, :short_label, :help_text, :sortable, :sort_by, :read_only, :write_only, :default_value,
+                  :show_query, :required_query, :text_align, :target, :action, :wrapper, :phone, :icons_key,
+                  :resize_width, :crop_aspect_ratio, :parent, :ai_source_fields, :relation, :format, :max_size, :accept
+  end
+end

data/lib/habarico/definition/filter_reference.rb

@@ -0,0 +1,7 @@
+module Habarico
+  class FilterReference
+    include DefinitionModel
+
+    attr_accessor :name, :label, :help_text, :is_always_on, :default_value
+  end
+end

data/lib/habarico/definition/menu/link_menu_item.rb

@@ -0,0 +1,12 @@
+module Habarico
+  class LinkMenuItem < MenuItem
+    include DefinitionModel
+
+    def initialize(params = {})
+      @type = :link
+      @priority = 1
+      super(params)
+    end
+
+  end
+end

data/lib/habarico/definition/menu/menu_item.rb

@@ -0,0 +1,9 @@
+module Habarico
+  class MenuItem
+    include DefinitionModel
+
+    attr_accessor :name, :label, :type, :icon, :color, :priority, :view_name, :view_mode, :dialog_width, :view_keep_linked_parent, :link_url, :link_target,
+                  :reference, :reference_action_name
+
+  end
+end

data/lib/habarico/definition/menu/text_menu_item.rb

@@ -0,0 +1,12 @@
+module Habarico
+  class TextMenuItem < MenuItem
+    include DefinitionModel
+
+    def initialize(params = {})
+      @type = :text
+      @priority = 1
+      super(params)
+    end
+
+  end
+end

data/lib/habarico/definition/menu/view_menu_item.rb

@@ -0,0 +1,13 @@
+module Habarico
+  class ViewMenuItem < MenuItem
+    include DefinitionModel
+
+    def initialize(params = {})
+      @type = :view
+      @view_mode = :redirect # -> open the view on the new page
+      @priority = 1
+      super(params)
+    end
+
+  end
+end

data/lib/habarico/definition/response.rb

@@ -0,0 +1,13 @@
+module Habarico
+  class Response
+    include DefinitionModel
+
+    attr_accessor :message, :state, :action
+
+    def initialize(params = {})
+      @state = :success
+      super(params)
+    end
+
+  end
+end

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

@@ -0,0 +1,11 @@
+module Habarico
+  class ActionView < View
+    include DefinitionModel
+
+    def initialize(params = {})
+      @type = :action
+      super(params)
+    end
+
+  end
+end

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

@@ -0,0 +1,15 @@
+module Habarico
+  class CreateView < View
+    include DefinitionModel
+
+    def initialize(params = {})
+      @type = :create
+      @name = 'create'
+      @is_detail = false
+      @endpoint_method = :post
+      @permission = :create
+      super(params)
+    end
+
+  end
+end

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

@@ -0,0 +1,15 @@
+module Habarico
+  class EditView < View
+    include DefinitionModel
+
+    def initialize(params = {})
+      @type = :edit
+      @name = 'edit'
+      @is_detail = true
+      @endpoint_method = :patch
+      @permission = :update
+      super(params)
+    end
+
+  end
+end

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

@@ -0,0 +1,17 @@
+module Habarico
+  class ListView < View
+    include DefinitionModel
+
+    attr_accessor :filters
+
+    def initialize(params = {})
+      @type = :list
+      @name = 'list'
+      @is_detail = false
+      @endpoint_method = :get
+      @permission = :read
+      super(params)
+    end
+
+  end
+end

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

@@ -0,0 +1,15 @@
+module Habarico
+  class ShowView < View
+    include DefinitionModel
+
+    def initialize(params = {})
+      @type = :show
+      @name = 'show'
+      @is_detail = true
+      @endpoint_method = :get
+      @permission = :read
+      super(params)
+    end
+
+  end
+end