avo 1.23.0 → 1.24.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93ddc5b52a7eb149886833f2eda8dcf69e5cfa29af5d357f57dfbc3b6e03800e
-  data.tar.gz: 44050a09443ff49550f7d9e3c22c3a4b03eea83f9c0d3a08bbc4a97d5084a355
+  metadata.gz: 4990a8b947c8086e635f9a4efedf7b58692ffbeebcd7bbc5ee002f8526a0e1fc
+  data.tar.gz: 80f48c2eaf8dbe17271afbb64dfb07e3c7b2710371dd049d293981ed0ddf2cb3
 SHA512:
-  metadata.gz: 346e58ffb98b4b60576282f43a766f6e9e388dcf83041dffc8b1f9c1e81292271869e2f356df92471afa77e51eff5945f127a236e2adc1c41a24ccb6847d2a5f
-  data.tar.gz: 5dbeae53b1d1179117f035c1bc2b806c9f88064f5af9c9c1498fbd6fe24107d96a67c02345f437f2cd73789de4935932c97f52730142e970808a68e49c5e2aa0
+  metadata.gz: 53cdb462a0b8dbb76060ab440760115b309c05d16dbbde23108811b1b369eeb4a59763d908ff4f5466fe15596f35427817443c146994d9c4466cb2955cdbb6e0
+  data.tar.gz: 83afde6824181a8354d20fb8d9197734abc3d162200625731a47f2adf17501f43f1d08abf897f3e60fbe01960893d2ad71ef2ba4fee540b2c4f943859199eb2a

data/Gemfile

@@ -133,3 +133,5 @@ gem 'friendly_id', '~> 5.4.0'
 gem 'aws-sdk-s3', require: false
 
 gem 'net-smtp', require: false
+
+gem 'acts_as_list'

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    avo (1.23.0)
+    avo (1.24.2)
       active_link_to
       addressable
       breadcrumbs_on_rails
       countries
+      dry-initializer
       hotwire-rails
       httparty
       image_processing
@@ -81,6 +82,8 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
+    acts_as_list (1.0.4)
+      activerecord (>= 4.2)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ap (0.1.1)
@@ -153,6 +156,7 @@ GEM
     dotenv-rails (2.7.6)
       dotenv (= 2.7.6)
       railties (>= 3.2)
+    dry-initializer (3.1.1)
     erubi (1.10.0)
     factory_bot (6.2.0)
       activesupport (>= 5.0.0)
@@ -397,6 +401,7 @@ PLATFORMS
 
 DEPENDENCIES
   active_link_to
+  acts_as_list
   addressable
   ap
   appraisal

data/app/assets/svgs/arrow-down.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" class="h-6 w-6" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2">
+  <path stroke-linecap="round" stroke-linejoin="round" d="M19 14l-7 7m0 0l-7-7m7 7V3" />
+</svg>

data/app/assets/svgs/arrow-up.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" class="h-6 w-6" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2">
+  <path stroke-linecap="round" stroke-linejoin="round" d="M5 10l7-7m0 0l7 7m-7-7v18" />
+</svg>

data/app/assets/svgs/download-solid-reversed.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" class="h-5 w-5" viewBox="0 0 20 20" fill="currentColor" transform="rotate(-180)">
+  <path fill-rule="evenodd" d="M3 17a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zm3.293-7.707a1 1 0 011.414 0L9 10.586V3a1 1 0 112 0v7.586l1.293-1.293a1 1 0 111.414 1.414l-3 3a1 1 0 01-1.414 0l-3-3a1 1 0 010-1.414z" clip-rule="evenodd" />
+</svg>

data/app/assets/svgs/download-solid.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" class="h-5 w-5" viewBox="0 0 20 20" fill="currentColor">
+  <path fill-rule="evenodd" d="M3 17a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zm3.293-7.707a1 1 0 011.414 0L9 10.586V3a1 1 0 112 0v7.586l1.293-1.293a1 1 0 111.414 1.414l-3 3a1 1 0 01-1.414 0l-3-3a1 1 0 010-1.414z" clip-rule="evenodd" />
+</svg>

data/app/assets/svgs/switch-vertical.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" class="h-6 w-6" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2">
+  <path stroke-linecap="round" stroke-linejoin="round" d="M7 16V4m0 0L3 8m4-4l4 4m6 0v12m0 0l4-4m-4 4l-4-4" />
+</svg>

data/app/components/avo/base_component.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+class Avo::BaseComponent < ViewComponent::Base
+  def has_with_trial(ability)
+    ::Avo::App.license.has_with_trial(ability)
+  end
+
+  private
+
+  # Figure out what is the corresponding field for this @reflection
+  def field
+    fields = ::Avo::App.get_resource_by_model_name(@reflection.active_record.name).get_field_definitions
+    fields.find { |f| f.id == @reflection.name }
+  rescue
+    nil
+  end
+
+  def relation_resource
+    ::Avo::App.get_resource_by_model_name params[:via_resource_class].safe_constantize
+  end
+
+  # Get the resource for the resource using the klass attribute so we get the namespace too
+  def reflection_resource
+    ::Avo::App.get_resource_by_model_name(@reflection.klass.to_s)
+  rescue
+    nil
+  end
+
+  # Get the resource for the resource using the klass attribute so we get the namespace too
+  def reflection_parent_resource
+    ::Avo::App.get_resource_by_model_name(@reflection.active_record.to_s)
+  rescue
+    nil
+  end
+end

data/app/components/avo/index/grid_item_component.html.erb

@@ -32,7 +32,7 @@
       </div>
     </div>
     <div class="w-full place-self-end">
-      <%= render(Avo::Index::ResourceControlsComponent.new(resource: @resource, reflection: @reflection, parent_model: @parent_model)) %>
+      <%= render(Avo::Index::ResourceControlsComponent.new(resource: @resource, reflection: @reflection, parent_model: @parent_model, view_type: :grid)) %>
     </div>
   </div>
 </div>

data/app/components/avo/index/ordering/base_component.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Avo::Index::Ordering::BaseComponent < Avo::BaseComponent
+  private
+
+  def order_actions
+    @resource.class.order_actions
+  end
+end

data/app/components/avo/index/ordering/button_component.html.erb

@@ -0,0 +1,11 @@
+<%= button_to order_path(direction: direction, referrer: request.fullpath),
+  title: t("avo.order.#{direction}").capitalize,
+  method: :patch,
+  class: 'flex items-center',
+  data: {
+    target: "order:#{direction}",
+    'turbo-frame': params[:turbo_frame],
+    'tippy': 'tooltip',
+  } do %>
+  <%= helpers.svg(svg, class: 'text-gray-400 h-6 hover:text-gray-600') %>
+<% end %>

data/app/components/avo/index/ordering/button_component.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+class Avo::Index::Ordering::ButtonComponent < Avo::Index::Ordering::BaseComponent
+  attr_accessor :resource
+  attr_accessor :reflection
+  attr_accessor :direction
+  attr_accessor :svg
+
+  def initialize(resource:, direction:, svg: nil,  reflection: nil)
+    @resource = resource
+    @reflection = reflection
+    @direction = direction
+    @svg = svg
+  end
+
+  def render?
+    order_actions[direction].present?
+  end
+
+  def order_path(args)
+    if reflection.present?
+      path = "#{::Avo::App.root_path}/resources/#{reflection_parent_resource.route_key}/#{params[:id]}/#{field.id}/#{resource.model.id}/order"
+    else
+      path = "#{::Avo::App.root_path}/resources/#{resource.route_key}/#{resource.model.id}/order"
+    end
+
+    if args.present?
+      string_args = args.map do |key, value|
+        "#{key}=#{value}"
+      end.join('&')
+
+      path = "#{path}?#{string_args}"
+    end
+
+    path
+  end
+end

data/app/components/avo/index/ordering/buttons_component.html.erb

@@ -0,0 +1,32 @@
+<div class="flex items-center justify-center">
+  <% if display_inline? %>
+    <div class="flex max-w-xs rounded">
+      <%= render Avo::Index::Ordering::ButtonComponent.new resource: @resource, reflection: @reflection, direction: :higher, svg: 'arrow-up' %>
+      <%= render Avo::Index::Ordering::ButtonComponent.new resource: @resource, reflection: @reflection, direction: :lower, svg: 'arrow-down' %>
+      <%= render Avo::Index::Ordering::ButtonComponent.new resource: @resource, reflection: @reflection, direction: :to_top, svg: 'download-solid-reversed' %>
+      <%= render Avo::Index::Ordering::ButtonComponent.new resource: @resource, reflection: @reflection, direction: :to_bottom, svg: 'download-solid' %>
+    </div>
+  <% else %>
+    <div class="popover inline-block"
+      data-controller="popover"
+      data-popover-translate-x="-100%"
+      data-popover-translate-y="-32px"
+      data-action="mouseover->popover#mouseOver mouseout->popover#mouseOut"
+      >
+      <%= button_tag nil,
+        title: t('avo.order.reorder_record').capitalize,
+        class: 'flex items-center',
+        data: {
+          'tippy': 'tooltip',
+        } do
+      %>
+      <%= helpers.svg('switch-vertical', class: 'text-gray-400 h-6 hover:text-gray-600') %>
+    <% end %>
+    <div class="flex hidden absolute max-w-xs bg-white rounded p-2 z-40" data-popover-target="content">
+      <%= render Avo::Index::Ordering::ButtonComponent.new resource: @resource, reflection: @reflection, direction: :higher, svg: 'arrow-up' %>
+      <%= render Avo::Index::Ordering::ButtonComponent.new resource: @resource, reflection: @reflection, direction: :lower, svg: 'arrow-down' %>
+      <%= render Avo::Index::Ordering::ButtonComponent.new resource: @resource, reflection: @reflection, direction: :to_top, svg: 'download-solid-reversed' %>
+      <%= render Avo::Index::Ordering::ButtonComponent.new resource: @resource, reflection: @reflection, direction: :to_bottom, svg: 'download-solid' %>
+    </div>
+  <% end %>
+</div>

data/app/components/avo/index/ordering/buttons_component.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class Avo::Index::Ordering::ButtonsComponent < Avo::Index::Ordering::BaseComponent
+  def initialize(resource: nil, reflection: nil, view_type: nil)
+    @resource = resource
+    @reflection = reflection
+    @view_type = view_type
+  end
+
+  def render?
+    has_with_trial(:resource_ordering) && can_order_any? && view_type_is_table? && enabled_in_view?
+  end
+
+  private
+
+  def can_order_any?
+    order_actions.present?
+  end
+
+  def view_type_is_table?
+    @view_type.to_sym == :table
+  end
+
+  def display_inline?
+    ordering[:display_inline]
+  end
+
+  def enabled_in_view?
+    in_association = @reflection.present?
+
+    if in_association
+      visible_on_option.include? :association
+    else
+      visible_on_option.include? :index
+    end
+  end
+
+  def visible_on_option
+    [ordering[:visible_on]].flatten
+  end
+
+  def ordering
+    @resource.class.ordering
+  end
+end

data/app/components/avo/index/resource_controls_component.html.erb

@@ -1,14 +1,16 @@
-<div class="space-x-2 flex flex-row justify-around w-full">
+<div class="space-x-2 flex flex-row justify-around items-center w-full">
+  <%= render Avo::Index::Ordering::ButtonsComponent.new resource: @resource, reflection: @reflection, view_type: @view_type %>
+
   <% if can_view? %>
     <%= link_to helpers.svg('eye', class: 'text-gray-400 h-6 hover:text-gray-600'),
       show_path,
-      title: t('avo.view_item',  item: singular_resource_name).capitalize,
+      title: t('avo.view_item', item: singular_resource_name).capitalize,
       data: {
         target: 'control:view',
         control: :show,
         'tippy': 'tooltip',
       }
-      %>
+    %>
   <% end %>
 
   <% if can_edit? %>
@@ -45,7 +47,10 @@
   <% end %>
 
   <% if can_delete? %>
-    <%= form_with url: helpers.resource_path(model: @resource.model, resource: @resource), method: :delete, html: {
+    <%= form_with url: helpers.resource_path(model: @resource.model, resource: @resource),
+      method: :delete,
+      class: 'flex items-center',
+      html: {
         'data-turbo-frame': params[:turbo_frame]
       } do |form| %>
       <%= form.button helpers.svg('trash', class: 'text-gray-400 h-6 hover:text-gray-600'),

data/app/components/avo/index/resource_controls_component.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 class Avo::Index::ResourceControlsComponent < Avo::ResourceComponent
-  def initialize(resource: nil, reflection: nil, parent_model: nil)
+  def initialize(resource: nil, reflection: nil, parent_model: nil, view_type: :table)
     @resource = resource
     @reflection = reflection
     @parent_model = parent_model
+    @view_type = view_type
   end
 
   def can_detach?

data/app/components/avo/index/table_row_component.html.erb

@@ -12,7 +12,7 @@
   <% end %>
   <td class="text-right whitespace-nowrap px-2">
     <div class="flex items-center justify-end flex-grow-0 h-full w-full">
-      <%= render(Avo::Index::ResourceControlsComponent.new(resource: @resource, reflection: @reflection, parent_model: @parent_model)) %>
+      <%= render(Avo::Index::ResourceControlsComponent.new(resource: @resource, reflection: @reflection, parent_model: @parent_model, view_type: :table)) %>
     </div>
   </td>
 </tr>

data/app/components/avo/resource_component.rb

@@ -1,4 +1,4 @@
-class Avo::ResourceComponent < ViewComponent::Base
+class Avo::ResourceComponent < Avo::BaseComponent
   def can_create?
     return authorize_association_for(:create) if @reflection.present?
 
@@ -30,25 +30,4 @@ class Avo::ResourceComponent < ViewComponent::Base
 
     association_policy
   end
-
-  private
-
-  # Figure out what is the corresponding field for this @reflection
-  def field
-    fields = ::Avo::App.get_resource_by_model_name(@reflection.active_record.name).get_field_definitions
-    fields.find { |f| f.id == @reflection.name }
-  rescue
-    nil
-  end
-
-  def relation_resource
-    ::Avo::App.get_resource_by_model_name params[:via_resource_class].safe_constantize
-  end
-
-  # Get the resource for the resource using the klass attribute so we get the namespace too
-  def reflection_resource
-    ::Avo::App.get_resource_by_model_name(@reflection.klass.to_s)
-  rescue
-    nil
-  end
 end

data/app/components/avo/turbo_frame_wrapper_component.html.erb

@@ -3,7 +3,9 @@
     # When rendering the frames the flashed content gets lost.
     # By including the alerts partial, the stimulus will pick them up and display them to the user.
   %>
-  <%= render Avo::AlertsComponent.new if helpers.flash.present? && name.present? %>
+  <% if helpers.turbo_frame_request? %>
+    <%= render Avo::AlertsComponent.new if helpers.flash.present? && name.present? %>
+  <% end %>
 
   <%= content %>
 <% if name.present? %></turbo-frame><% end %>

data/app/controllers/avo/application_controller.rb

@@ -24,7 +24,7 @@ module Avo
     rescue_from Pundit::NotAuthorizedError, with: :render_unauthorized
     rescue_from ActiveRecord::RecordInvalid, with: :exception_logger
 
-    helper_method :_current_user, :resources_path, :resource_path, :new_resource_path, :edit_resource_path, :resource_attach_path, :resource_detach_path, :related_resources_path
+    helper_method :_current_user, :resources_path, :resource_path, :new_resource_path, :edit_resource_path, :resource_attach_path, :resource_detach_path, :related_resources_path, :turbo_frame_request?
     add_flash_types :info, :warning, :success, :error
 
     def init_app
@@ -79,6 +79,12 @@ module Avo
       instance_eval(&Avo.configuration.context)
     end
 
+    # This is coming from Turbo::Frames::FrameRequest module.
+    # Exposing it as public method
+    def turbo_frame_request?
+      super
+    end
+
     private
 
     def set_resource_name

data/app/controllers/avo/base_controller.rb

@@ -5,7 +5,7 @@ module Avo
     before_action :set_resource_name
     before_action :set_resource
     before_action :hydrate_resource
-    before_action :set_model, only: [:show, :edit, :destroy, :update]
+    before_action :set_model, only: [:show, :edit, :destroy, :update, :order]
     before_action :set_model_to_fill
     before_action :fill_model, only: [:create, :update]
     before_action :authorize_action
@@ -190,6 +190,21 @@ module Avo
       end
     end
 
+    def order
+      direction = params[:direction].to_sym
+
+      if direction.present?
+        @resource
+          .hydrate(model: @model, params: params)
+          .ordering_host
+          .order direction
+      end
+
+      respond_to do |format|
+        format.html { redirect_to params[:referrer] || resources_path(resource: @resource) }
+      end
+    end
+
     private
 
     def model_params

data/app/controllers/avo/relations_controller.rb

@@ -2,15 +2,15 @@ require_dependency "avo/base_controller"
 
 module Avo
   class RelationsController < BaseController
-    before_action :set_model, only: [:show, :index, :new, :create, :destroy]
+    before_action :set_model, only: [:show, :index, :new, :create, :destroy, :order]
     before_action :set_related_resource_name
-    before_action :set_related_resource, only: [:show, :index, :new, :create, :destroy]
-    before_action :hydrate_related_resource, only: [:show, :index, :new, :create, :destroy]
-    before_action :set_related_model, only: [:show]
-    before_action :set_attachment_class, only: [:show, :index, :new, :create, :destroy]
-    before_action :set_attachment_resource, only: [:show, :index, :new, :create, :destroy]
-    before_action :set_attachment_model, only: [:create, :destroy]
-    before_action :set_reflection, only: [:index, :show]
+    before_action :set_related_resource, only: [:show, :index, :new, :create, :destroy, :order]
+    before_action :hydrate_related_resource, only: [:show, :index, :new, :create, :destroy, :order]
+    before_action :set_related_model, only: [:show, :order]
+    before_action :set_attachment_class, only: [:show, :index, :new, :create, :destroy, :order]
+    before_action :set_attachment_resource, only: [:show, :index, :new, :create, :destroy, :order]
+    before_action :set_attachment_model, only: [:create, :destroy, :order]
+    before_action :set_reflection, only: [:index, :show, :order]
 
     def index
       @parent_resource = @resource.dup
@@ -71,6 +71,13 @@ module Avo
       end
     end
 
+    def order
+      @parent_resource = @resource.dup
+      @resource, @model = @related_resource, @related_model
+
+      super
+    end
+
     private
 
     def set_attachment_class

data/app/helpers/avo/url_helpers.rb

@@ -73,5 +73,9 @@ module Avo
 
       avo.resources_associations_index_path(@parent_resource.model_class.model_name.route_key, @parent_resource.model.id, **existing_params, **args )
     end
+
+    def order_up_resource_path(model:, resource:, **args)
+      avo.send :"order_up_resources_#{resource.singular_model_key}_path", model, **args
+    end
   end
 end

data/app/javascript/js/application.js

@@ -1,4 +1,5 @@
 import { Application } from '@hotwired/stimulus'
+import { Popover } from 'tailwindcss-stimulus-components'
 
 const application = Application.start()
 
@@ -6,4 +7,7 @@ const application = Application.start()
 application.debug = false
 window.Stimulus = application
 
+// Register stimulus-components controller
+application.register('popover', Popover)
+
 export { application }

data/avo.gemspec

@@ -44,4 +44,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "addressable"
   spec.add_dependency "meta-tags"
   spec.add_dependency "breadcrumbs_on_rails"
+  spec.add_dependency "dry-initializer"
 end

data/config/routes.rb

@@ -17,6 +17,10 @@ Avo::Engine.routes.draw do
     get "/:resource_name/:id/active_storage_attachments/:attachment_name/:signed_attachment_id", to: "attachments#show"
     delete "/:resource_name/:id/active_storage_attachments/:attachment_name/:signed_attachment_id", to: "attachments#destroy"
 
+    # Ordering
+    patch "/:resource_name/:id/order", to: "resources#order"
+    patch "/:resource_name/:id/:related_name/:related_id/order", to: "relations#order", as: "associations_order"
+
     # Actions
     get "/:resource_name(/:id)/actions/:action_id", to: "actions#show"
     post "/:resource_name(/:id)/actions/:action_id", to: "actions#handle"

data/lib/avo/base_resource.rb

@@ -14,6 +14,7 @@ module Avo
 
     attr_accessor :view
     attr_accessor :model
+    attr_accessor :reflection
     attr_accessor :user
     attr_accessor :params
 
@@ -36,6 +37,7 @@ module Avo
     class_attribute :unscoped_queries_on_index, default: false
     class_attribute :resolve_query_scope
     class_attribute :resolve_find_scope
+    class_attribute :ordering
 
     class << self
       def grid(&block)
@@ -80,6 +82,12 @@ module Avo
       def authorization
         Avo::Services::AuthorizationService.new Avo::App.current_user
       end
+
+      def order_actions
+        return {} if ordering.blank?
+
+        ordering.dig(:actions) || {}
+      end
     end
 
     def initialize
@@ -135,6 +143,7 @@ module Avo
             # we're matching the reflection inverse_of foriegn key with the field's foreign_key
             if field.is_a?(Avo::Fields::BelongsToField)
               if field.respond_to?(:foreign_key) &&
+                reflection.inverse_of.present? &&
                 reflection.inverse_of.foreign_key == field.foreign_key
                 is_valid = false
               end
@@ -469,5 +478,9 @@ module Avo
     def form_scope
       model_class.base_class.to_s.underscore.downcase
     end
+
+    def ordering_host(**args)
+      Avo::Hosts::Ordering.new resource: self, options: self.class.ordering, **args
+    end
   end
 end

data/lib/avo/hosts/ordering.rb

@@ -0,0 +1,22 @@
+require 'dry-initializer'
+
+module Avo
+  module Hosts
+    class Ordering
+      extend Dry::Initializer
+
+      option :options, default: proc { {} }
+      option :resource
+      option :record, default: proc { resource.model }
+      option :params, default: proc { resource.params }
+
+      def order(direction)
+        action = options.dig(:actions, direction.to_sym)
+
+        if action.present?
+          instance_exec(&action)
+        end
+      end
+    end
+  end
+end

data/lib/avo/licensing/pro_license.rb

@@ -9,6 +9,7 @@ module Avo
           :global_search,
           :enhanced_search_results,
           :searchable_belongs_to,
+          :resource_ordering,
         ]
       end
     end

data/lib/avo/version.rb

@@ -1,3 +1,3 @@
 module Avo
-  VERSION = "1.23.0"
+  VERSION = "1.24.2"
 end

data/lib/generators/avo/templates/locales/avo.en.yml

@@ -95,3 +95,9 @@ en:
     was_successfully_updated: 'was successfully updated'
     clear_value: "Clear value"
     tools: Tools
+    order:
+      reorder_record: Reorder record
+      higher: Move record higher
+      lower: Move record lower
+      to_top: Move record to top
+      to_bottom: Move record to bottom

data/public/avo-assets/avo.css

@@ -6791,6 +6791,10 @@ progress[value]::-moz-progress-bar{
   max-width:100%
 }
 
+.max-w-xs{
+  max-width:20rem
+}
+
 .flex-1{
   flex:1 1 0%
 }