avo 1.22.3 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0638fa0ab76323be01a732489a1ba96def10bde4897fd4231c7a1f4c41ece424'
-  data.tar.gz: 394c86583f0219b3f9c5d2cf1017db4348105ae8bc26cfbac1f5ca56e9ace62a
+  metadata.gz: 3bd7ab9c0d5e4743874638117c67d87e723a4300ef8342be0c3ef868ce0a07e2
+  data.tar.gz: 8229f364c7341342e7ac25a8da2be3fc15d10a1feeeb7c5f8c2a6fc270c4cde6
 SHA512:
-  metadata.gz: 292f817a4cc4498a4db69268def16be6ac719e5eee1178deb8cad7a26181aacb73ec5cbd9145fea1a0dc627a52f4bc7b9a3e61e5e6099946148239227b313e4d
-  data.tar.gz: bad4042ec546cb0c56e209a8c42b59a74a655a5bd8278c7f98baf5025f81d3457b566316fc4f7247d51e68d4add071d6207996e922449106ce3627357e1a2545
+  metadata.gz: cd6e21cbe3c211a4fa669970b9de4ead47566712fc6dadbcbce0c08e2d1cbf21cdd73e63e05677cc53cff591fb7420651aa8f8048f2329a760de8458addf2ed0
+  data.tar.gz: 98c83f4ea0c66bdb5016c650c1f29fd14f0a98f45a4bd024f5d0285d34bbb8a296d3cce94457443e95f6cff4293cac11155ce13339c6c9d5c630af9119669aaa

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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    avo (1.22.3)
+    avo (1.24.0)
       active_link_to
       addressable
       breadcrumbs_on_rails
@@ -81,6 +81,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)
@@ -397,6 +399,7 @@ PLATFORMS
 
 DEPENDENCIES
   active_link_to
+  acts_as_list
   addressable
   ap
   appraisal

data/README.md

@@ -73,3 +73,9 @@ Please read the [UPGRADE_GUIDE.MD](https://docs.avohq.io/1.0/upgrade.html)
 
 
 ![Alt](https://repobeats.axiom.co/api/embed/1481a6a259064f02a7936470d12a50802a9c98a4.svg "Repobeats analytics image")
+
+# Shoutouts
+
+[Get a box of waffles and some of the best app monitoring from Appsignal](https://appsignal.com/r/93dbe69bfb) 🧇
+
+[Get $100 in credits from Digital Ocean](https://www.digitalocean.com/?refcode=efc1fe881d74&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge) 💸

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/alert_component.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Avo::AlertComponent < ViewComponent::Base
+  attr_reader :type
+  attr_reader :message
+
+  def initialize(type, message)
+    @type = type
+    @message = message
+  end
+end

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

@@ -0,0 +1,3 @@
+<% helpers.flash.each do |type, message| %>
+  <%= render Avo::AlertComponent.new type.to_sym, message %>
+<% end %>

data/app/components/avo/alerts_component.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Avo::AlertsComponent < ViewComponent::Base
+
+end

data/app/components/avo/base_component.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Avo::BaseComponent < ViewComponent::Base
+  def has_with_trial(ability)
+    ::Avo::App.license.has_with_trial(ability)
+  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 < ViewComponent::Base
+  private
+
+  def order_actions
+    @resource.class.order_actions
+  end
+end

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

@@ -0,0 +1,10 @@
+<%= 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}",
+    '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,31 @@
+# frozen_string_literal: true
+
+class Avo::Index::Ordering::ButtonComponent < Avo::Index::Ordering::BaseComponent
+  attr_reader :resource
+  attr_reader :direction
+  attr_reader :svg
+
+  def initialize(resource: nil, direction: nil, svg: nil)
+    @resource = resource
+    @direction = direction
+    @svg = svg
+  end
+
+  def render?
+    order_actions[direction].present?
+  end
+
+  def order_path(args)
+    path = "#{::Avo::App.root_path}/resources/#{resource.route_key}/#{resource.model.id}/order"
+
+    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,30 @@
+<div class="flex items-center justify-center">
+  <% unless always_visible? %>
+    <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 %>
+  <% end %>
+  <% if always_visible? %>
+    <div class="flex max-w-xs rounded">
+    <% else %>
+      <div class="flex hidden absolute max-w-xs bg-white rounded p-2 z-40" data-popover-target="content">
+    <% end %>
+    <%= render Avo::Index::Ordering::ButtonComponent.new resource: @resource, direction: :higher, svg: 'arrow-up' %>
+    <%= render Avo::Index::Ordering::ButtonComponent.new resource: @resource, direction: :lower, svg: 'arrow-down' %>
+    <%= render Avo::Index::Ordering::ButtonComponent.new resource: @resource, direction: :to_top, svg: 'download-solid-reversed' %>
+    <%= render Avo::Index::Ordering::ButtonComponent.new resource: @resource, direction: :to_bottom, svg: 'download-solid' %>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class Avo::Index::Ordering::ButtonsComponent < Avo::Index::Ordering::BaseComponent
+  def initialize(resource: nil)
+    @resource = resource
+  end
+
+  def render?
+    can_order_any?
+  end
+
+  def can_order_any?
+    order_actions.present?
+  end
+
+  def always_visible?
+    @resource.class.ordering[:always_visible]
+  end
+end

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

@@ -1,14 +1,18 @@
-<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">
+  <% if view_is_table? && has_with_trial(:resource_ordering) %>
+    <%= render Avo::Index::Ordering::ButtonsComponent.new resource: @resource %>
+  <% end %>
+
   <% 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 +49,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?
@@ -69,4 +70,8 @@ class Avo::Index::ResourceControlsComponent < Avo::ResourceComponent
   def is_has_many_association
     @reflection.is_a?(::ActiveRecord::Reflection::HasManyReflection) || @reflection.is_a?(::ActiveRecord::Reflection::ThroughReflection)
   end
+
+  def view_is_table?
+    @view_type == :table
+  end
 end

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/navigation_link_component.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Avo::NavigationLinkComponent < ViewComponent::Base
-  def initialize(label: nil, path: nil, active: :inclusive, size: :md, target: "_self")
+  def initialize(label: nil, path: nil, active: :inclusive, size: :md, target: nil)
     @label = label
     @path = path
     @active = active

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?
 

data/app/{views/avo/partials/_turbo_frame_wrap.html.erb → 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 partial: 'avo/partials/alerts' if flash.present? && name.present? %>
+  <% if helpers.turbo_frame_request? %>
+    <%= render Avo::AlertsComponent.new if helpers.flash.present? && name.present? %>
+  <% end %>
 
-  <%= yield %>
+  <%= content %>
 <% if name.present? %></turbo-frame><% end %>

data/app/components/avo/turbo_frame_wrapper_component.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Avo::TurboFrameWrapperComponent < ViewComponent::Base
+  attr_reader :name
+
+  def initialize(name = nil)
+    @name = name
+  end
+end

data/app/controllers/avo/application_controller.rb

@@ -13,6 +13,7 @@ module Avo
     protect_from_forgery with: :exception
     before_action :init_app
     before_action :check_avo_license
+    before_action :set_locale
     before_action :set_authorization
     before_action :_authenticate!
     before_action :set_container_classes
@@ -23,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
@@ -78,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
@@ -245,5 +252,11 @@ module Avo
     def model_param_key
       @resource.form_scope
     end
+
+    def set_locale
+      I18n.locale = params[:locale] || I18n.default_locale
+
+      I18n.default_locale = I18n.locale
+    end
   end
 end

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
@@ -84,7 +84,6 @@ module Avo
     def new
       @model = @resource.model_class.new
       @resource = @resource.hydrate(model: @model, view: :new, user: _current_user)
-      # abort @model.course.inspect
 
       @page_title = @resource.default_panel_name
       add_breadcrumb resource_name.humanize, resources_path(resource: @resource)
@@ -191,6 +190,19 @@ module Avo
       end
     end
 
+    def order
+      direction = params[:direction].to_sym
+      order_actions = @resource.class.order_actions
+
+      if direction.present? && order_actions[direction].present?
+        order_actions[direction].call(@model)
+      end
+
+      respond_to do |format|
+        format.html { redirect_to params[:referrer] || resources_path(resource: @resource) }
+      end
+    end
+
     private
 
     def model_params

data/app/helpers/avo/application_helper.rb

@@ -21,7 +21,7 @@ module Avo
     end
 
     def turbo_frame_wrap(name, &block)
-      render layout: "avo/partials/turbo_frame_wrap", locals: {name: name} do
+      render Avo::TurboFrameWrapperComponent.new name do
         capture(&block)
       end
     end

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/app/javascript/js/controllers/modal_controller.js

@@ -8,4 +8,13 @@ export default class extends Controller {
 
     document.dispatchEvent(new Event('actions-modal:close'))
   }
+
+  delayedClose() {
+    const vm = this
+
+    setTimeout(() => {
+      vm.modalTarget.remove()
+      document.dispatchEvent(new Event('actions-modal:close'))
+    }, 500)
+  }
 }

data/app/javascript/js/controllers/search_controller.js

@@ -177,11 +177,16 @@ export default class extends Controller {
       openOnFocus: true,
       detachedMediaQuery: '',
       getSources: ({ query }) => {
+        document.body.classList.add('search-loading')
         const endpoint = that.searchUrl(query)
 
         return that
           .debouncedFetch(endpoint)
-          .then((response) => response.json())
+          .then((response) => {
+            document.body.classList.remove('search-loading')
+
+            return response.json()
+          })
           .then((data) => Object.keys(data).map((resourceName) => that.addSource(resourceName, data[resourceName])))
       },
     })

data/app/views/avo/actions/show.html.erb

@@ -7,7 +7,11 @@
     data-resource-id="<%= params[:id] %>"
     class="hidden text-slate-800"
   >
-    <%= form_with model: @model, scope: 'fields', url: "#{@resource.records_path}/actions/#{@action.param_id}", data: {'turbo-frame': '_top', 'action-target': 'form'} do |form| %>
+    <%= form_with model: @model,
+      scope: 'fields',
+      url: "#{@resource.records_path}/actions/#{@action.param_id}",
+      data: @action.class.form_data_attributes do |form|
+    %>
       <%= render Avo::ModalComponent.new do |c| %>
         <% c.heading do %>
           <%= @action.action_name %>
@@ -26,8 +30,8 @@
         <% end %>
 
         <% c.controls do %>
-          <%= a_button @action.cancel_button_label, 'data-action': 'click->modal#close', size: :sm %>
-          <%= a_button @action.confirm_button_label, type: :submit, color: :green, size: :sm %>
+          <%= a_button @action.cancel_button_label, data: { action: 'click->modal#close' }, size: :sm %>
+          <%= a_button @action.confirm_button_label, type: :submit, color: :green, size: :sm, data: @action.class.submit_button_data_attributes %>
         <% end %>
       <% end %>
     <% end %>

data/app/views/layouts/avo/application.html.erb

@@ -51,7 +51,7 @@
   <%= turbo_frame_tag 'destroy_attachment_form' %>
 
   <%= turbo_frame_tag 'alerts' do %>
-    <%= render partial: 'avo/partials/alerts' %>
+    <%= render Avo::AlertsComponent.new %>
   <% end %>
 </div>
 

data/config/routes.rb

@@ -17,6 +17,9 @@ 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"
+
     # 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_action.rb

@@ -15,6 +15,7 @@ module Avo
     class_attribute :fields
     class_attribute :standalone, default: false
     class_attribute :visible
+    class_attribute :may_download_file, default: false
 
     attr_accessor :response
     attr_accessor :model
@@ -22,6 +23,26 @@ module Avo
     attr_accessor :user
     attr_accessor :fields_loader
 
+    class << self
+      def form_data_attributes
+        # We can't respond with a file download from Turbo se we disable it on the form
+        if may_download_file
+          { 'turbo': false }
+        else
+          { 'turbo-frame': '_top', 'action-target': 'form' }
+        end
+      end
+
+      # We can't respond with a file download from Turbo se we disable close the modal manually after a while (it's a hack, we know)
+      def submit_button_data_attributes
+        if may_download_file
+          { action: 'click->modal#delayedClose' }
+        else
+          {}
+        end
+      end
+    end
+
     def action_name
       return name if name.present?
 

data/lib/avo/base_resource.rb

@@ -36,6 +36,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 +81,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 +142,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