avo 1.7.0 → 1.8.0

data/app/components/avo/views/resource_index_component.rb

@@ -77,7 +77,7 @@ class Avo::Views::ResourceIndexComponent < Avo::ResourceComponent
   end
 
   def attach_path
-    "#{Avo.configuration.root_path}#{request.env["PATH_INFO"]}/new"
+    "#{Avo::App.root_path}#{request.env["PATH_INFO"]}/new"
   end
 
   def detach_path

data/app/controllers/avo/actions_controller.rb

@@ -12,7 +12,7 @@ module Avo
 
     def handle
       resource_ids = action_params[:fields][:resource_ids].split(",").map(&:to_i)
-      models = @resource.model_class.find resource_ids
+      models = @resource.class.find_scope.find resource_ids
 
       fields = action_params[:fields].select do |key, value|
         key != "resource_ids"
@@ -33,7 +33,7 @@ module Avo
       action_class = params[:action_id].gsub("avo_actions_", "").classify.safe_constantize
 
       if params[:id].present?
-        model = @resource.model_class.find params[:id]
+        model = @resource.class.find_scope.find params[:id]
       end
 
       @action = action_class.new(model: model, resource: resource, user: _current_user)

data/app/controllers/avo/application_controller.rb

@@ -17,7 +17,7 @@ module Avo
     add_flash_types :info, :warning, :success, :error
 
     def init_app
-      Avo::App.init request: request, context: context, current_user: _current_user
+      Avo::App.init request: request, context: context, root_path: avo.root_path.delete_suffix("/"), current_user: _current_user
 
       @license = Avo::App.license
     end
@@ -78,6 +78,7 @@ module Avo
           existing_params = Addressable::URI.parse(request.fullpath).query_values.symbolize_keys
         end
       rescue; end
+
       avo.send :"resources_#{model.model_name.route_key}_path", **existing_params, **args
     end
 
@@ -91,7 +92,7 @@ module Avo
           existing_params = Addressable::URI.parse(request.fullpath).query_values.symbolize_keys
         end
       rescue; end
-      Addressable::Template.new("#{Avo.configuration.root_path}/resources/#{@parent_resource.model.model_name.route_key}/#{@parent_resource.model.id}/#{@resource.route_key}{?query*}")
+      Addressable::Template.new("#{Avo::App.root_path}/resources/#{@parent_resource.model.model_name.route_key}/#{@parent_resource.model.id}/#{@resource.route_key}{?query*}")
         .expand({query: {**existing_params, **args}})
         .to_str
     end
@@ -103,7 +104,7 @@ module Avo
     end
 
     def resource_attach_path(model_name, model_id, related_name, related_id = nil)
-      path = "#{Avo.configuration.root_path}/resources/#{model_name}/#{model_id}/#{related_name}/new"
+      path = "#{Avo::App.root_path}/resources/#{model_name}/#{model_id}/#{related_name}/new"
 
       path += "/#{related_id}" if related_id.present?
 
@@ -111,7 +112,7 @@ module Avo
     end
 
     def resource_detach_path(model_name, model_id, related_name, related_id = nil)
-      path = "#{Avo.configuration.root_path}/resources/#{model_name}/#{model_id}/#{related_name}"
+      path = "#{Avo::App.root_path}/resources/#{model_name}/#{model_id}/#{related_name}"
 
       path += "/#{related_id}" if related_id.present?
 
@@ -147,11 +148,11 @@ module Avo
     end
 
     def set_model
-      @model = eager_load_files(@resource, @resource.model_class).find params[:id]
+      @model = eager_load_files(@resource, @resource.class.find_scope).find params[:id]
     end
 
     def set_related_model
-      @related_model = eager_load_files(@related_resource, @related_resource.model_class).find params[:related_id]
+      @related_model = eager_load_files(@related_resource, @related_resource.class.find_scope).find params[:related_id]
     end
 
     def hydrate_resource
@@ -179,7 +180,7 @@ module Avo
 
       begin
         request.path
-          .match(/\/?#{Avo.configuration.root_path.delete('/')}\/resources\/([a-z1-9\-_]*)\/?/mi)
+          .match(/\/?#{Avo::App.root_path.delete('/')}\/resources\/([a-z1-9\-_]*)\/?/mi)
           .captures
           .first
       rescue
@@ -273,15 +274,15 @@ module Avo
     end
 
     def on_root_path
-      [Avo.configuration.root_path, "#{Avo.configuration.root_path}/"].include?(request.original_fullpath)
+      [Avo::App.root_path, "#{Avo::App.root_path}/"].include?(request.original_fullpath)
     end
 
     def on_resources_path
-      request.original_url.match?(/.*#{Avo.configuration.root_path}\/resources\/.*/)
+      request.original_url.match?(/.*#{Avo::App.root_path}\/resources\/.*/)
     end
 
     def on_api_path
-      request.original_url.match?(/.*#{Avo.configuration.root_path}\/avo_api\/.*/)
+      request.original_url.match?(/.*#{Avo::App.root_path}\/avo_api\/.*/)
     end
   end
 end

data/app/controllers/avo/base_controller.rb

@@ -7,6 +7,8 @@ module Avo
     before_action :hydrate_resource
     before_action :authorize_action
     before_action :set_model, only: [:show, :edit, :destroy, :update]
+    before_action :reset_pagination_if_filters_changed, only: :index
+    before_action :cache_applied_filters, only: :index
 
     def index
       @page_title = resource_name.humanize
@@ -18,7 +20,7 @@ module Avo
 
       # If we don't get a query object predefined from a child controller like relations, just spin one up
       unless defined? @query
-        @query = @authorization.apply_policy @resource.model_class
+        @query = @resource.class.query_scope
       end
 
       # Remove default_scope for index view
@@ -62,7 +64,7 @@ module Avo
       # If we're accessing this resource via another resource add the parent to the breadcrumbs.
       if params[:via_resource_class].present? && params[:via_resource_id].present?
         via_resource = Avo::App.get_resource_by_model_name params[:via_resource_class]
-        via_model = via_resource.model_class.find params[:via_resource_id]
+        via_model = via_resource.class.find_scope.find params[:via_resource_id]
         via_resource.hydrate model: via_model
 
         add_breadcrumb via_resource.plural_name, resources_path(via_resource.model_class)
@@ -91,7 +93,7 @@ module Avo
       # If we're accessing this resource via another resource add the parent to the breadcrumbs.
       if params[:via_resource_class].present? && params[:via_resource_id].present?
         via_resource = Avo::App.get_resource_by_model_name params[:via_resource_class]
-        via_model = via_resource.model_class.find params[:via_resource_id]
+        via_model = via_resource.class.find_scope.find params[:via_resource_id]
         via_resource.hydrate model: via_model
 
         add_breadcrumb via_resource.plural_name, resources_path(via_resource.model_class)
@@ -235,7 +237,7 @@ module Avo
 
     def set_actions
       if params[:resource_id].present?
-        model = @resource.model_class.find params[:resource_id]
+        model = @resource.class.find_scope.find params[:resource_id]
       end
 
       @actions = @resource.get_actions.map do |action|
@@ -260,5 +262,19 @@ module Avo
 
       filter_defaults
     end
+
+    def cache_applied_filters
+      ::Avo::App.cache_store.delete applied_filters_cache_key if params[:filters].nil?
+
+      ::Avo::App.cache_store.write(applied_filters_cache_key, params[:filters], expires_in: 7.days)
+    end
+
+    def reset_pagination_if_filters_changed
+      params[:page] = 1 if params[:filters] != ::Avo::App.cache_store.read(applied_filters_cache_key)
+    end
+
+    def applied_filters_cache_key
+      "avo.base_controller.#{@resource.route_key}.applied_filters"
+    end
   end
 end

data/app/controllers/avo/relations_controller.rb

@@ -15,7 +15,7 @@ module Avo
     def index
       @parent_resource = @resource.dup
       @resource = @related_resource
-      @parent_model = @parent_resource.model_class.find(params[:id])
+      @parent_model = @parent_resource.class.find_scope.find(params[:id])
       @parent_resource.hydrate(model: @parent_model)
       @query = @authorization.apply_policy @parent_model.public_send(params[:related_name])
 

data/app/controllers/avo/search_controller.rb

@@ -2,6 +2,8 @@ require_dependency "avo/application_controller"
 
 module Avo
   class SearchController < ApplicationController
+    include Rails.application.routes.url_helpers
+
     before_action :set_resource_name, only: [:show]
     before_action :set_resource, only: [:show]
 
@@ -18,14 +20,15 @@ module Avo
     private
 
     def search_resources(resources)
-      resources.map do |resource|
-        # Apply authorization
-        next unless @authorization.set_record(resource.model_class).authorize_action(:index, raise_exception: false)
-        # Filter out the models without a search_query
-        next if resource.search_query.nil?
+      resources
+        .map do |resource|
+          # Apply authorization
+          next unless @authorization.set_record(resource.model_class).authorize_action(:index, raise_exception: false)
+          # Filter out the models without a search_query
+          next if resource.search_query.nil?
 
-        search_resource resource
-      end
+          search_resource resource
+        end
         .select do |payload|
           payload.present?
         end
@@ -61,7 +64,7 @@ module Avo
 
         if App.license.has_with_trial(:enhanced_search_results)
           result[:_description] = resource.description
-          result[:_avatar] = resource.avatar
+          result[:_avatar] = resource.avatar.present? ? main_app.url_for(resource.avatar) : nil
           result[:_avatar_type] = resource.avatar_type
         end
 

data/app/packs/js/controllers/fields/trix_field_controller.js

@@ -21,6 +21,18 @@ export default class extends Controller {
     return castBoolean(this.controllerTarget.dataset.attachmentsDisabled)
   }
 
+  get hideAttachmentFilename() {
+    return castBoolean(this.controllerTarget.dataset.hideAttachmentFilename)
+  }
+
+  get hideAttachmentFilesize() {
+    return castBoolean(this.controllerTarget.dataset.hideAttachmentFilesize)
+  }
+
+  get hideAttachmentUrl() {
+    return castBoolean(this.controllerTarget.dataset.hideAttachmentUrl)
+  }
+
   get uploadUrl() {
     return `${window.location.origin}${window.Avo.configuration.root_path}/avo_api/resources/${this.resourceName}/${this.resourceId}/attachments`
   }
@@ -102,6 +114,10 @@ export default class extends Controller {
           href: response.href,
         }
 
+        if (this.hideAttachmentFilename) attributes.filename = null
+        if (this.hideAttachmentFilesize) attributes.filesize = null
+        if (this.hideAttachmentUrl) attributes.href = null
+
         successCallback(attributes)
       }
     })

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

@@ -7,7 +7,7 @@
     data-resource-id="<%= params[:id] %>"
     class="hidden text-blue-gray-800"
   >
-    <%= form_with model: @model, scope: 'fields', url: "#{Avo.configuration.root_path}/resources/#{@resource.model_class.model_name.route_key}/actions/#{@action.param_id}", data: {'turbo-frame': '_top', 'action-target': 'form'} do |form| %>
+    <%= form_with model: @model, scope: 'fields', url: "#{avo.root_path}resources/#{@resource.model_class.model_name.route_key}/actions/#{@action.param_id}", data: {'turbo-frame': '_top', 'action-target': 'form'} do |form| %>
       <%= render Avo::ModalComponent.new do |c| %>
         <% c.heading do %>
           <%= @action.action_name %>

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

@@ -1,5 +1,5 @@
 <%= turbo_frame_tag 'destroy_attachment_form' do %>
-  <%= form_with url: "#{Avo.configuration.root_path}/resources/#{params[:resource_name]}/#{params[:id]
+  <%= form_with url: "#{avo.root_path}resources/#{params[:resource_name]}/#{params[:id]
     }/active_storage_attachments/#{params[:attachment_name]}/#{params[:signed_attachment_id]}",
     method: :delete,
     html: {

data/app/views/avo/base/_actions.html.erb

@@ -15,8 +15,8 @@
       <%
         @actions.each_with_index do |action, index|
           path = action_name == 'show' ?
-            "#{Avo.configuration.root_path}/resources/#{@resource.model_class.model_name.route_key}/#{@model.id}/actions/#{action.param_id}" :
-            "#{Avo.configuration.root_path}/resources/#{@resource.model_class.model_name.route_key}/actions/#{action.param_id}"
+            "#{avo.root_path}resources/#{@resource.model_class.model_name.route_key}/#{@model.id}/actions/#{action.param_id}" :
+            "#{avo.root_path}resources/#{@resource.model_class.model_name.route_key}/actions/#{action.param_id}"
       %>
         <%= link_to path,
           'data-turbo-frame': 'actions_show',

data/app/views/avo/home/index.html.erb

@@ -28,8 +28,8 @@
               <li><span class="mr-2">👍</span> Authorization</li>
               <li><span class="mr-2">👍</span> Localization</li>
               <li><span class="mr-2">👍</span> Custom tools</li>
-              <li><span class="mr-2">⏳</span> Custom fields</li>
-              <li><span class="mr-2">⏳</span> Search</li>
+              <li><span class="mr-2">👍</span> Custom fields</li>
+              <li><span class="mr-2">👍</span> Search</li>
               <li><span class="mr-2">🕐</span> Dashboards</li>
               <li><span class="mr-2">🕐</span> Themes</li>
             </ul>

data/app/views/avo/partials/_javascript.html.erb

@@ -1,5 +1,5 @@
 <%= javascript_tag nonce: true do %>
   window.Avo = window.Avo || { configuration: {} }
   Avo.configuration.timezone = '<%= Avo.configuration.timezone %>'
-  Avo.configuration.root_path = '<%= Avo.configuration.root_path %>'
+  Avo.configuration.root_path = '<%= Avo::App.root_path %>'
 <% end %>

data/app/views/avo/partials/_resource_search.html.erb

@@ -6,5 +6,5 @@
     data-debounce-timeout='<%= Avo.configuration.search_debounce %>'
   >
   </div>
-  <div class="relative inline-flex text-gray-400 text-sm border border-gray-300 rounded-full cursor-pointer" data-search-target="button"></div>
+  <div class="hidden relative inline-flex text-gray-400 text-sm border border-gray-300 rounded-full cursor-pointer" data-search-target="button"></div>
 </div>

data/app/views/avo/relations/new.html.erb

@@ -1,6 +1,6 @@
 <%= turbo_frame_tag 'attach_modal' do %>
   <%= form_with scope: 'fields',
-    url: "#{Avo.configuration.root_path}/resources/#{params[:resource_name]}/#{params[:id]}/#{params[:related_name]}/",
+    url: "#{avo.root_path}resources/#{params[:resource_name]}/#{params[:id]}/#{params[:related_name]}/",
     data: {
       'turbo-frame': '_top'
     } do |form| %>

data/app/views/avo/sidebar/_sidebar.html.erb

@@ -6,7 +6,7 @@
 
     <div class="flex-1 flex flex-col justify-between">
       <div class="tools py-4">
-        <%= render Avo::NavigationLinkComponent.new label: 'Get started', path: Avo.configuration.root_path, active: :exclusive if Rails.env.development? && Avo.configuration.home_path.nil?  %>
+        <%= render Avo::NavigationLinkComponent.new label: 'Get started', path: avo.root_path, active: :exclusive if Rails.env.development? && Avo.configuration.home_path.nil?  %>
 
         <%= render Avo::NavigationHeadingComponent.new label: t('avo.resources') %>
 

data/config/initializers/friendly_id.rb

@@ -0,0 +1,107 @@
+# FriendlyId Global Configuration
+#
+# Use this to set up shared configuration options for your entire application.
+# Any of the configuration options shown here can also be applied to single
+# models by passing arguments to the `friendly_id` class method or defining
+# methods in your model.
+#
+# To learn more, check out the guide:
+#
+# http://norman.github.io/friendly_id/file.Guide.html
+
+FriendlyId.defaults do |config|
+  # ## Reserved Words
+  #
+  # Some words could conflict with Rails's routes when used as slugs, or are
+  # undesirable to allow as slugs. Edit this list as needed for your app.
+  config.use :reserved
+
+  config.reserved_words = %w(new edit index session login logout users admin
+    stylesheets assets javascripts images)
+
+  # This adds an option to treat reserved words as conflicts rather than exceptions.
+  # When there is no good candidate, a UUID will be appended, matching the existing
+  # conflict behavior.
+
+  # config.treat_reserved_as_conflict = true
+
+  #  ## Friendly Finders
+  #
+  # Uncomment this to use friendly finders in all models. By default, if
+  # you wish to find a record by its friendly id, you must do:
+  #
+  #    MyModel.friendly.find('foo')
+  #
+  # If you uncomment this, you can do:
+  #
+  #    MyModel.find('foo')
+  #
+  # This is significantly more convenient but may not be appropriate for
+  # all applications, so you must explicity opt-in to this behavior. You can
+  # always also configure it on a per-model basis if you prefer.
+  #
+  # Something else to consider is that using the :finders addon boosts
+  # performance because it will avoid Rails-internal code that makes runtime
+  # calls to `Module.extend`.
+  #
+  # config.use :finders
+  #
+  # ## Slugs
+  #
+  # Most applications will use the :slugged module everywhere. If you wish
+  # to do so, uncomment the following line.
+  #
+  # config.use :slugged
+  #
+  # By default, FriendlyId's :slugged addon expects the slug column to be named
+  # 'slug', but you can change it if you wish.
+  #
+  # config.slug_column = 'slug'
+  #
+  # By default, slug has no size limit, but you can change it if you wish.
+  #
+  # config.slug_limit = 255
+  #
+  # When FriendlyId can not generate a unique ID from your base method, it appends
+  # a UUID, separated by a single dash. You can configure the character used as the
+  # separator. If you're upgrading from FriendlyId 4, you may wish to replace this
+  # with two dashes.
+  #
+  # config.sequence_separator = '-'
+  #
+  # Note that you must use the :slugged addon **prior** to the line which
+  # configures the sequence separator, or else FriendlyId will raise an undefined
+  # method error.
+  #
+  #  ## Tips and Tricks
+  #
+  #  ### Controlling when slugs are generated
+  #
+  # As of FriendlyId 5.0, new slugs are generated only when the slug field is
+  # nil, but if you're using a column as your base method can change this
+  # behavior by overriding the `should_generate_new_friendly_id?` method that
+  # FriendlyId adds to your model. The change below makes FriendlyId 5.0 behave
+  # more like 4.0.
+  # Note: Use(include) Slugged module in the config if using the anonymous module.
+  # If you have `friendly_id :name, use: slugged` in the model, Slugged module
+  # is included after the anonymous module defined in the initializer, so it
+  # overrides the `should_generate_new_friendly_id?` method from the anonymous module.
+  #
+  # config.use :slugged
+  # config.use Module.new {
+  #   def should_generate_new_friendly_id?
+  #     slug.blank? || <your_column_name_here>_changed?
+  #   end
+  # }
+  #
+  # FriendlyId uses Rails's `parameterize` method to generate slugs, but for
+  # languages that don't use the Roman alphabet, that's not usually sufficient.
+  # Here we use the Babosa library to transliterate Russian Cyrillic slugs to
+  # ASCII. If you use this, don't forget to add "babosa" to your Gemfile.
+  #
+  # config.use Module.new {
+  #   def normalize_friendly_id(text)
+  #     text.to_slug.normalize! :transliterations => [:russian, :latin]
+  #   end
+  # }
+end

data/db/migrate/20210525143134_add_slug_to_users.rb

@@ -0,0 +1,6 @@
+class AddSlugToUsers < ActiveRecord::Migration[6.0]
+  def change
+    add_column :users, :slug, :string
+    add_index :users, :slug, unique: true
+  end
+end