habarico 7.3.0.pre.beta.2 → 7.3.0.pre.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da37ba29d89a66e75d207995933a5034fc8f404d03e95e701b301b4e37964adb
-  data.tar.gz: bc191e762ed87d1627d97088325ae61a32da42e314f32592e1ee449de8f67e05
+  metadata.gz: 6be967b0f84be5812add3427f8150fc6d8b01909b1441ef70a04a5579f737587
+  data.tar.gz: d16af3d641bcc6b8a84f3663c38ade72c6ae96666ad5987258948bb70b0e9e9c
 SHA512:
-  metadata.gz: f959dcd0c250c92e576c639be808ae7cb0af79bf3597b2b1b7ba9237f7ce6a44ae6d366f980eebd43fdb5a8f5caadcc223705c7b8bb2dd2bfc304ee3f486eb30
-  data.tar.gz: d900620185f6b9d0eb913a7ef5cd593beaa4c754d212c97ad44495ca4d7ed6d4867b93613cf8884e6f3696d9c8a63a70f608274275013b960a9022304dde2cc4
+  metadata.gz: '078b5e0d648bed830162d2850b971f19b2cca505928d223ac4242939f017985896d04b594f69528e4bc3efa69e2b212d6c2638b425b8bfcb2ba5730f61f78a12'
+  data.tar.gz: db8b3494d1d9964aed2ab58d91ac6cd11bda53259d49779d5ff837dcdc5fd349dbca96c18677d55a15e071043ecd1172114cf85de63e068ee549c45b94a28eb5

data/VERSION

@@ -1 +1 @@
-7.3.0-beta.2
+7.3.0-beta.3

data/lib/habarico/controller.rb

@@ -234,26 +234,32 @@ module Habarico
       }
     end
 
+    # Renders an `ActionResult`: `message`, `state` and `trigger_action` live under `meta`, and the
+    # response's own `data` is merged next to it. This is the shape the contract prescribes and the
+    # only one the frontend reads - it looks at `resp.data.meta` and nowhere else.
     def render_response(response)
-      if response.action
-        action = definition.normalized_actions.find { |a| a.name.to_s == response.action.to_s }
-        if action
-          resource_path = Habarico::ResourceService.instance.get_resource_path(controller_name)
-          action_schema_generator = definition.action_schema_generator.new(definition, resource_path)
-          trigger_action = action_schema_generator.generate(action, context).as_json.deep_compact(compactable: [nil, {}].freeze)
-        end
-      end
-      render json: {
-        state: response.state,
-        message: response.message,
-        trigger_action: trigger_action
-      }.deep_compact
+      meta = {
+        'message' => response.message,
+        'state' => response.state,
+        'trigger_action' => build_action_schema(response.action)&.as_json&.deep_compact(compactable: [nil, {}].freeze)
+      }.compact
+      render json: { 'meta' => meta }.merge(response.data.presence || {})
     end
 
     def get_trigger_action_schema(_record)
       nil # override in subclasses to return an ActionSchema instance
     end
 
+    # Builds the complete `Habarico::ActionSchema` of `action` - a declared action's name or a
+    # `Habarico::Action` - for `get_trigger_action_schema` or `Habarico::Response.new(action: ...)`.
+    # `record` builds the context from that record, `record_pk` and `reference` retarget the action.
+    def build_action_schema(action, record: nil, record_pk: nil, reference: nil)
+      resource_path = Habarico::ResourceService.instance.get_resource_path(controller_name)
+      definition.trigger_action_schema_generator
+                .new(definition, resource_path)
+                .generate(action, record ? _context(record) : context, record_pk: record_pk, reference: reference)
+    end
+
     # Checks the `order_by` query parameter against what this resource offers for sorting.
     #
     # The notation itself - `field:direction`, exactly one `:`, a lower-case `asc`/`desc` - and the

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

@@ -4,11 +4,16 @@ module Habarico
 
     attr_accessor :type, :label, :icon, :color, :is_detail, :name, :show_in_detail, :show_in_list,
                   :confirm_dialog_title, :confirm_dialog_message, :permission
-    attr_accessor :view_name, :view_mode, :dialog_width, :view_parameters, :view_keep_linked_parent # attributes for type = :view
-    attr_accessor :endpoint_action_name, :endpoint_method, :endpoint_reference # attributes for type = :view or :resource
+    attr_accessor :view_name, :view_mode, :dialog_width, :view_parameters, :view_keep_linked_parent, :view_choices # attributes for type = :view
+    # `endpoint_record_pk` pins the action to one concrete record instead of the one in the
+    # context. It is what lets a trigger action point at a record of another resource - together
+    # with `endpoint_reference` it spells out the whole target, so neither side has to be guessed
+    # from the request the action ran on.
+    attr_accessor :endpoint_action_name, :endpoint_method, :endpoint_reference, :endpoint_record_pk # attributes for type = :view or :resource
     attr_accessor :is_background, :data # attributes for type = :resource
+    attr_accessor :after_save # attributes for type = :save
     attr_accessor :link_url, :link_target, :if # attributes for type = :link
-    attr_accessor :upload_images_reference, :upload_images_target, :upload_images_accept, :upload_images_image_field # attributes for type = :"upload-images"
+    attr_accessor :upload_images_reference, :upload_images_target, :upload_images_accept, :upload_images_image_field, :upload_images_data # attributes for type = :"upload-images"
 
   end
 end

data/lib/habarico/definition/definition.rb

@@ -38,6 +38,7 @@ module Habarico
                   :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,
+                  :trigger_action_schema_generator,
 
                   # Generator classes - endpoint
                   :dynamic_render_options_generator, :method_schema_generator, :endpoints_schema_generator,
@@ -119,6 +120,7 @@ module Habarico
       @global_resource_action_schema_generator = Habarico::GlobalResourceActionSchemaGenerator
       @resource_action_schema_generator = Habarico::ResourceActionSchemaGenerator
       @upload_images_action_parameters_generator = Habarico::UploadImagesActionParametersGenerator
+      @trigger_action_schema_generator = Habarico::TriggerActionSchemaGenerator
 
       # Endpoint
       @dynamic_render_options_generator = Habarico::DynamicRenderOptionsGenerator

data/lib/habarico/definition/response.rb

@@ -2,7 +2,14 @@ module Habarico
   class Response
     include DefinitionModel
 
-    attr_accessor :message, :state, :action
+    # `action` is the follow-up action the frontend runs once it has this response. It accepts the
+    # name of an action declared in `actions`, a `Habarico::Action` built on the spot (an ad-hoc
+    # action the resource does not declare) or a complete `Habarico::ActionSchema` - see
+    # `Habarico::Controller#build_action_schema`.
+    #
+    # `data` is merged next to `meta` in the rendered `ActionResult`, which is where the contract
+    # allows an action to return a payload of its own.
+    attr_accessor :message, :state, :action, :data
 
     def initialize(params = {})
       @state = :success

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

@@ -97,8 +97,10 @@ module Habarico
 
     def generate_save(action, context)
       if action.type.to_sym == :save
+        # Either parameter on its own is worth sending: `after_save` changes where the form goes
+        # after the save, with no data to add to the record.
         data = Habarico::CallableHelper.resolve(action.data, context)
-        save_action_parameters_generator.generate(action, context) unless data.nil?
+        save_action_parameters_generator.generate(action, context) unless data.nil? && action.after_save.nil?
       end
     end
 

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

@@ -22,7 +22,10 @@ module Habarico
     # ***********************************************************************
 
     def generate_path(action, context)
-      return nil if Habarico::ActionHelper.is_standard_action?(action)
+      # A standard action of the current resource needs no path - the frontend already knows the
+      # endpoint. One that names its own target does: the path is what points the call at the
+      # other resource or record.
+      return nil if Habarico::ActionHelper.is_standard_action?(action) && !Habarico::ActionHelper.has_explicit_target?(action)
       url_prefix = Habarico::Config.routing_url_prefix.trim('/')
       result = !url_prefix.blank? ? "/#{url_prefix}" : ''
 
@@ -30,6 +33,7 @@ module Habarico
       reference = generate_reference(action, context)
       if reference.present?
         resource_path_2 = ResourceService.instance.get_resource_path(reference)
+        raise Eluvia::Errors::StandardError.new("Resource `#{reference}` referenced by action `#{action.name}` is not registered.") if resource_path_2.blank?
         result += "/#{resource_path_2.join('/')}"
       else
         result += "/#{resource_path.join('/')}"
@@ -56,14 +60,16 @@ module Habarico
     end
 
     def generate_action_name(action, _context)
+      return action.endpoint_action_name if action.endpoint_action_name.present?
       return nil if Habarico::ActionHelper.is_standard_action?(action)
-      action.endpoint_action_name || action.name
+      action.name
     end
 
     def generate_record_pk(action, context)
-      if action&.is_detail
-        context.record_pk
-      end
+      # An explicit record pk on the action wins over the record in the context: it is how an
+      # action targets a record other than the one it was invoked on.
+      return action.endpoint_record_pk if action.endpoint_record_pk.present?
+      context.record_pk if action&.is_detail
     end
 
   end

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

@@ -8,7 +8,8 @@ module Habarico
 
       # Create model
       Habarico::SaveActionParameters.new(
-        data: generate_data(action, context)
+        data: generate_data(action, context),
+        after_save: generate_after_save(action, context)
       )
     end
 
@@ -22,5 +23,9 @@ module Habarico
       Habarico::CallableHelper.resolve(action.data, context)
     end
 
+    def generate_after_save(action, _context)
+      action.after_save
+    end
+
   end
 end

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

@@ -0,0 +1,52 @@
+module Habarico
+  # Builds the `Habarico::ActionSchema` of a trigger action - the follow-up action the frontend
+  # runs after a custom action's response, or the one attached to a serialized record.
+  class TriggerActionSchemaGenerator < AbstractGenerator
+
+    # `action` is the name of an action declared in `actions`, a `Habarico::Action` or a ready
+    # `Habarico::ActionSchema`, which is returned as is. `record_pk` and `reference` retarget the
+    # action at another record and another resource.
+    def generate(action, context, record_pk: nil, reference: nil)
+      return nil if action.nil?
+      return action if action.is_a?(Habarico::ActionSchema)
+
+      action = find_declared_action!(action) if action.is_a?(::String) || action.is_a?(::Symbol)
+      unless action.is_a?(Habarico::Action)
+        raise Eluvia::Errors::StandardError.new(
+          "Trigger action must be a Habarico::ActionSchema, a Habarico::Action or an action name, got `#{action.class}`."
+        )
+      end
+
+      action_schema_generator.generate(retarget(action, record_pk, reference), context)
+    end
+
+    protected
+
+    def action_schema_generator
+      @action_schema_generator ||= definition.action_schema_generator.new(definition, resource_path)
+    end
+
+    # Copies the action before setting the target, so a declared action is never mutated.
+    def retarget(action, record_pk, reference)
+      return action if record_pk.blank? && reference.blank?
+
+      action = action.dup
+      action.endpoint_record_pk = record_pk if record_pk.present?
+      action.endpoint_reference = reference if reference.present?
+      action
+    end
+
+    # An unknown name raises, since it is far more likely a typo than a deliberately empty trigger.
+    def find_declared_action!(name)
+      declared = definition.normalized_actions
+      action = declared.find { |declared_action| declared_action.name.to_s == name.to_s }
+      return action if action
+
+      raise Eluvia::Errors::StandardError.new(
+        "Action `#{name}` is not declared in `actions` of resource `#{resource_path&.last}`. " \
+        "Declared actions: #{declared.map(&:name).join(', ').presence || 'none'}."
+      )
+    end
+
+  end
+end

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

@@ -11,7 +11,8 @@ module Habarico
         reference: generate_reference(action, context),
         target: generate_target(action, context),
         accept: generate_accept(action, context),
-        image_field: generate_image_field(action, context)
+        image_field: generate_image_field(action, context),
+        data: generate_data(action, context)
       )
     end
 
@@ -37,5 +38,9 @@ module Habarico
       action.upload_images_image_field
     end
 
+    def generate_data(action, context)
+      Habarico::CallableHelper.resolve(action.upload_images_data, context)
+    end
+
   end
 end

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

@@ -24,13 +24,18 @@ module Habarico
     end
 
     def generate_action_name(action, _context)
-      action.endpoint_action_name || action.name
+      return action.endpoint_action_name if action.endpoint_action_name.present?
+      # A standard action is reached through the resource's standard endpoint, which carries no
+      # action name - the frontend derives it from the view alone.
+      return nil if Habarico::ActionHelper.is_standard_action?(action)
+      action.name
     end
 
     def generate_record_pk(action, context)
-      if action&.is_detail
-        context.record_pk
-      end
+      # An explicit record pk on the action wins over the record in the context: it is how an
+      # action targets a record other than the one it was invoked on.
+      return action.endpoint_record_pk if action.endpoint_record_pk.present?
+      context.record_pk if action&.is_detail
     end
 
   end

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

@@ -12,6 +12,7 @@ module Habarico
         mode: generate_mode(action, context),
         dialog_width: generate_dialog_width(action, context),
         parameters: generate_parameters(action, context),
+        choices: generate_choices(action, context),
         endpoint: generate_endpoint(action, context),
         keep_linked_parent: generate_keep_linked_parent(action, context)
       )
@@ -43,8 +44,15 @@ module Habarico
       Habarico::CallableHelper.resolve(action.view_parameters, context)
     end
 
+    def generate_choices(action, context)
+      Habarico::CallableHelper.resolve(action.view_choices, context)
+    end
+
     def generate_endpoint(action, context)
-      return nil if Habarico::ActionHelper.is_standard_action?(action)
+      # A standard action of the current resource needs no endpoint - the frontend opens the view
+      # over the record it already has. One that names its own target does: the endpoint is where
+      # the target resource and record are written down.
+      return nil if Habarico::ActionHelper.is_standard_action?(action) && !Habarico::ActionHelper.has_explicit_target?(action)
       view_action_endpoint_parameters_generator.generate(action, context)
     end
 

data/lib/habarico/helpers/action_helper.rb

@@ -5,5 +5,13 @@ module Habarico
       %w[show create update delete].include?(action.name)
     end
 
+    # An action that spells out its own target - another resource, another record, or both. Such an
+    # action always needs its endpoint in the schema, even when its name is one of the standard
+    # ones: the endpoint is the only place the target is written down, and without it the frontend
+    # falls back to the resource and the record the action ran on.
+    def self.has_explicit_target?(action)
+      action.endpoint_reference.present? || action.endpoint_record_pk.present?
+    end
+
   end
 end

data/lib/habarico/schema/action/save_action_parameters.rb

@@ -2,9 +2,15 @@ module Habarico
   class SaveActionParameters
     include ::ActiveModel::Model
     include Eluvia::ActiveModel::Attributes
+    include Eluvia::ActiveModel::EnumAttribute
 
     # Data that will be added to the object before saving
     any_attr :data
 
+    # Where the form goes once the record is saved. When not set, the frontend keeps its own
+    # default behaviour.
+    string_attr :after_save
+    enum_attr :after_save, Types::AFTER_SAVE_TYPE
+
   end
 end

data/lib/habarico/schema/action/upload_images_action_parameters.rb

@@ -19,5 +19,8 @@ module Habarico
     # frontend to know which attribute to set on the record it creates for each upload.
     string_attr :image_field
 
+    # Additional data added to every image record the frontend creates for an upload
+    any_attr :data
+
   end
 end

data/lib/habarico/schema/action/view_action_parameters.rb

@@ -20,6 +20,9 @@ module Habarico
     # Additional parameters to be passed to the view
     has_many_attr :parameters, 'String', underlying_type: :hash
 
+    # Choices offered before the view opens, each carrying its own view parameters
+    has_many_attr :choices, 'Habarico::ActionViewChoice'
+
     # Keep linked parent in the URL when navigating to the linked resource
     boolean_attr :keep_linked_parent
 

data/lib/habarico/schema/types.rb

@@ -52,6 +52,9 @@ module Habarico
     # LinkTargetType - where a link action opens
     LINK_TARGET_TYPE = %i[self blank].freeze
 
+    # AfterSaveType - where a save action goes once the record is saved
+    AFTER_SAVE_TYPE = %i[stay prev show list].freeze
+
     # TextAlignType - horizontal alignment of a field value
     TEXT_ALIGN_TYPE = %i[left center right].freeze
 

data/lib/habarico.rb

@@ -133,6 +133,7 @@ require "habarico/generators/action/global_resource_action_schema_generator"
 require "habarico/generators/action/resource_action_schema_generator"
 require "habarico/generators/action/save_action_parameters_generator"
 require "habarico/generators/action/upload_images_action_parameters_generator"
+require "habarico/generators/action/trigger_action_schema_generator"
 
 # Endpoint generators
 require "habarico/generators/endpoint/method_schema_generator"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: habarico
 version: !ruby/object:Gem::Version
-  version: 7.3.0.pre.beta.2
+  version: 7.3.0.pre.beta.3
 platform: ruby
 authors:
 - Matěj Outlý
@@ -177,6 +177,7 @@ files:
 - lib/habarico/generators/action/resource_action_parameters_generator.rb
 - lib/habarico/generators/action/resource_action_schema_generator.rb
 - lib/habarico/generators/action/save_action_parameters_generator.rb
+- lib/habarico/generators/action/trigger_action_schema_generator.rb
 - lib/habarico/generators/action/upload_images_action_parameters_generator.rb
 - lib/habarico/generators/action/view_action_endpoint_parameters_generator.rb
 - lib/habarico/generators/action/view_action_parameters_generator.rb