avo 1.19.1.pre.8 → 1.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0607ab6fcac318ac684bd207e030b59d18a595274fb848f8cd4ca99b493bffe7
-  data.tar.gz: a14bf800ea877f5063d172db128f2d45391c98a7af1f66d7335658353fd01778
+  metadata.gz: e21fad20822df8f410cc1a6eca03d840949a4acd6bee9e47ea320927fa9c253d
+  data.tar.gz: 61dc6595933b686526948f1ec9f7b37dfaad833f85928609d6bc296f9d6eb694
 SHA512:
-  metadata.gz: 4bd86190561a2e1cc073d54b9a6e367315c0c6d47cc9a4a09ac25a08299bffd452827b0a69e2b370a73aa286b1eb6015b858005e6912c1ce6f32024503c1c88d
-  data.tar.gz: '03991166fe7ac5b90975d37e15f0e698eed4aba13b572a6f292728fb7e1765fe0673e1becf39e9576d8a510a3821213aaacbe7feb2759a1f50c823115e5c2549'
+  metadata.gz: 04c07e302dc1cd1ab911edeed99543ab93dd7b8f29ddf460dd42a85e828412b07f3a5f9fd113eeb520185f712b5586f2be89b2cc58271fe3762b26acc7cb3c73
+  data.tar.gz: '09968da7c74ed31cd98d3fe99ef64578bc26466b30db7d10a087ecc63424e42af2809f20c68df228637c4c54acd80e4144d35e64cb21df5d96833e14894c34f2'

data/Gemfile

@@ -80,6 +80,7 @@ group :development do
 end
 
 group :development, :test do
+  gem 'ap'
   gem "faker", require: false
 end
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    avo (1.19.1.pre.8)
+    avo (1.20.1)
       active_link_to
       addressable
       breadcrumbs_on_rails
@@ -83,6 +83,8 @@ GEM
       zeitwerk (~> 2.3)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
+    ap (0.1.1)
+      httparty (>= 0.7.7)
     appraisal (2.4.1)
       bundler
       rake
@@ -228,7 +230,7 @@ GEM
       mini_portile2 (~> 2.7.0)
       racc (~> 1.4)
     orm_adapter (0.5.0)
-    pagy (5.10.0)
+    pagy (5.10.1)
       activesupport
     parallel (1.21.0)
     parser (3.1.0.0)
@@ -395,6 +397,7 @@ PLATFORMS
 DEPENDENCIES
   active_link_to
   addressable
+  ap
   appraisal
   avo!
   aws-sdk-s3

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

@@ -4,6 +4,7 @@
       show_path,
       title: t('avo.view_item',  item: singular_resource_name).capitalize,
       data: {
+        target: 'control:view',
         control: :show,
         'tippy': 'tooltip',
       }
@@ -15,6 +16,7 @@
       edit_path,
       title: t('avo.edit_item', item: singular_resource_name).capitalize,
       data: {
+        target: 'control:edit',
         control: :edit,
         'resource-id': @resource.model.id,
         'tippy': 'tooltip',
@@ -30,6 +32,7 @@
         title: t('avo.detach_item', item: singular_resource_name).capitalize,
         type: :submit,
         data: {
+          target: 'control:detach',
           confirm: t('avo.are_you_sure_detach_item', item: singular_resource_name),
           control: :detach,
           'resource-id': @resource.model.id,
@@ -49,6 +52,7 @@
         title: t('avo.delete_item',  item: singular_resource_name).capitalize,
         type: :submit,
         data: {
+          target: 'control:destroy',
           confirm: t('avo.are_you_sure',  item: singular_resource_name),
           control: :destroy,
           'resource-id': @resource.model.id,

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

@@ -10,15 +10,19 @@ class Avo::Index::ResourceControlsComponent < Avo::ResourceComponent
   def can_detach?
     @reflection.present? &&
       @resource.model.present? &&
-      (@reflection.is_a?(::ActiveRecord::Reflection::HasManyReflection) || @reflection.is_a?(::ActiveRecord::Reflection::ThroughReflection)) &&
+      is_has_many_association &&
       authorize_association_for("detach")
   end
 
   def can_edit?
+    return authorize_association_for(:edit) if @reflection.present?
+
     @resource.authorization.authorize_action(:edit, raise_exception: false)
   end
 
   def can_view?
+    return authorize_association_for(:view) if @reflection.present?
+
     @resource.authorization.authorize_action(:show, raise_exception: false)
   end
 
@@ -50,7 +54,7 @@ class Avo::Index::ResourceControlsComponent < Avo::ResourceComponent
 
   def singular_resource_name
     if @reflection.present?
-      ::Avo::App.get_resource_by_model_name(@reflection.class_name).name
+      reflection_resource.name
     else
       @resource.singular_name.present? ? @resource.singular_name : @resource.model_class.model_name.name.downcase
     end
@@ -61,4 +65,8 @@ class Avo::Index::ResourceControlsComponent < Avo::ResourceComponent
 
     ::Avo::App.get_resource_by_model_name @parent_model.class
   end
+
+  def is_has_many_association
+    @reflection.is_a?(::ActiveRecord::Reflection::HasManyReflection) || @reflection.is_a?(::ActiveRecord::Reflection::ThroughReflection)
+  end
 end

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

@@ -6,9 +6,12 @@
           <%= helpers.render_breadcrumbs(separator: helpers.svg('chevron-right', class: 'inline-block h-3 stroke-current relative top-[-1px] ml-1' )) if Avo.configuration.display_breadcrumbs %>
         </div>
       <% end %>
-      <div class="text-2xl tracking-normal font-bold text-gray-800 truncate">
+      <div class="text-2xl tracking-normal font-bold text-gray-800 truncate" data-target="title">
         <%= @title %>
       </div>
+      <div class="text-sm tracking-normal text-gray-600" data-target="description">
+        <%== description %>
+      </div>
     </div>
 
     <div>

data/app/components/avo/panel_component.rb

@@ -6,8 +6,9 @@ class Avo::PanelComponent < ViewComponent::Base
   renders_one :bare_content
   renders_one :footer
 
-  def initialize(title: nil, body_classes: nil, data: {}, display_breadcrumbs: false, index: nil)
+  def initialize(title: nil, description: nil, body_classes: nil, data: {}, display_breadcrumbs: false, index: nil)
     @title = title
+    @description = description
     @body_classes = body_classes
     @data = data
     @display_breadcrumbs = display_breadcrumbs
@@ -25,4 +26,10 @@ class Avo::PanelComponent < ViewComponent::Base
   def display_breadcrumbs?
     @display_breadcrumbs
   end
+
+  def description
+    return @description if @description.present?
+
+    '&nbsp;'
+  end
 end

data/app/components/avo/resource_component.rb

@@ -1,20 +1,27 @@
 class Avo::ResourceComponent < ViewComponent::Base
   def can_create?
+    return authorize_association_for(:create) if @reflection.present?
+
     @resource.authorization.authorize_action(:create, raise_exception: false)
   end
 
   def can_delete?
+    return authorize_association_for(:destroy) if @reflection.present?
+
     @resource.authorization.authorize_action(:destroy, raise_exception: false)
   end
 
   def authorize_association_for(policy_method)
     association_policy = true
+
     if @reflection.present?
       reflection_resource = ::Avo::App.get_resource_by_model_name(@reflection.active_record.name)
-      if reflection_resource.present?
-        method_name = "#{policy_method}_#{@reflection.name.to_s.underscore}?".to_sym
-        defined_policy_methods = reflection_resource.authorization.defined_methods(reflection_resource.model_class, raise_exception: false)
-        if defined_policy_methods.present? && defined_policy_methods.include?(method_name)
+      association_name = params['related_name']
+
+      if association_name.present?
+        method_name = "#{policy_method}_#{association_name}?".to_sym
+
+        if reflection_resource.authorization.has_method?(method_name, raise_exception: false)
           association_policy = reflection_resource.authorization.authorize_action(method_name, raise_exception: false)
         end
       end
@@ -25,7 +32,22 @@ class Avo::ResourceComponent < ViewComponent::Base
 
   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/views/resource_edit_component.html.erb

@@ -1,9 +1,13 @@
 <div data-model-id="<%= @resource.model.id %>">
   <% @resource.panels.each do |resource_panel| %>
-    <%= form_with model: @resource.model, scope: @resource.form_scope, url: helpers.resource_path(model: @resource.model, resource: @resource), method: :put, multipart: true do |form| %>
+    <%= form_with model: @resource.model,
+                  scope: @resource.form_scope,
+                  url: helpers.resource_path(model: @resource.model, resource: @resource),
+                  method: :put,
+                  multipart: true do |form| %>
       <%= hidden_field_tag :referrer, back_path if params[:via_resource_class] %>
 
-      <%= render Avo::PanelComponent.new(title: resource_panel[:name], display_breadcrumbs: true) do |c| %>
+      <%= render Avo::PanelComponent.new(title: resource_panel[:name], description: @resource.resource_description, display_breadcrumbs: true) do |c| %>
         <% c.tools do %>
           <div class="flex justify-end space-x-2">
             <%= a_link back_path do %>

data/app/components/avo/views/resource_index_component.html.erb

@@ -1,16 +1,18 @@
 <div>
-  <%= render Avo::PanelComponent.new(title: title, body_classes: 'py-4', data: { component: 'resources-index' }, display_breadcrumbs: @reflection.blank?) do |c| %>
+  <%= render Avo::PanelComponent.new(title: title, description: description, body_classes: 'py-4', data: { component: 'resources-index' }, display_breadcrumbs: @reflection.blank?) do |c| %>
     <% c.tools do %>
-      <%= render 'actions' if @actions.present? %>
+      <% if can_see_the_actions_button? %>
+        <%= render 'actions' %>
+      <% end %>
 
       <% if can_see_the_create_button? %>
-        <%= a_link create_path do %>
+        <%= a_link create_path, 'data-target': 'create' do %>
           <%= svg 'plus' %> <%= t('avo.create_new_item', item: singular_resource_name.downcase ) %>
         <% end %>
       <% end %>
 
       <% if can_attach? %>
-        <%= a_link attach_path, color: 'indigo', 'data-turbo-frame': 'attach_modal' do %>
+        <%= a_link attach_path, color: 'indigo', 'data-turbo-frame': 'attach_modal', 'data-target': 'attach' do %>
           <%= svg 'view-grid-add' %> <%= t('avo.attach_item', item: singular_resource_name).capitalize %>
         <% end %>
       <% end %>

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

@@ -30,7 +30,9 @@ class Avo::Views::ResourceIndexComponent < Avo::ResourceComponent
 
   def title
     if @reflection.present?
-      ::Avo::App.get_resource_by_model_name(@reflection.class_name).plural_name
+      return field.plural_name if field.present?
+
+      reflection_resource.plural_name
     else
       @resource.plural_name
     end
@@ -47,9 +49,19 @@ class Avo::Views::ResourceIndexComponent < Avo::ResourceComponent
   # The Create button is dependent on the new? policy method.
   # The create? should be called only when the user clicks the Save button so the developers gets access to the params from the form.
   def can_see_the_create_button?
+    return authorize_association_for("create") if @reflection.present?
+
     @resource.authorization.authorize_action(:new, raise_exception: false) && !has_reflection_and_is_read_only
   end
 
+  def can_see_the_actions_button?
+    return false if @actions.blank?
+
+    return authorize_association_for("act_on") if @reflection.present?
+
+    @resource.authorization.authorize_action(:act_on, raise_exception: false) && !has_reflection_and_is_read_only
+  end
+
   def can_attach?
     klass = @reflection
     klass = @reflection.through_reflection if klass.is_a? ::ActiveRecord::Reflection::ThroughReflection
@@ -107,12 +119,18 @@ class Avo::Views::ResourceIndexComponent < Avo::ResourceComponent
 
   def singular_resource_name
     if @reflection.present?
-      ::Avo::App.get_resource_by_model_name(@reflection.class_name).name
+      reflection_resource.name
     else
       @resource.singular_name || @resource.model_class.model_name.name.downcase
     end
   end
 
+  def description
+    return if @reflection.present?
+
+    @resource.resource_description
+  end
+
   private
 
   def reflection_model_class

data/app/components/avo/views/resource_new_component.html.erb

@@ -1,7 +1,14 @@
 <div>
   <% @resource.panels.each do |resource_panel| %>
-    <%= form_with model: @resource.model, url: helpers.resources_path(resource: @resource, via_relation_class: params[:via_relation_class], via_relation: params[:via_relation], via_resource_id: params[:via_resource_id]), local: true, multipart: true do |form| %>
-      <%= render Avo::PanelComponent.new(title: resource_panel[:name], display_breadcrumbs: true) do |c| %>
+    <%= form_with model: @resource.model,
+                  scope: @resource.form_scope,
+                  url: helpers.resources_path(resource: @resource,
+                                              via_relation_class: params[:via_relation_class],
+                                              via_relation: params[:via_relation],
+                                              via_resource_id: params[:via_resource_id]),
+                  local: true,
+                  multipart: true do |form| %>
+      <%= render Avo::PanelComponent.new(title: resource_panel[:name], description: @resource.resource_description, display_breadcrumbs: true) do |c| %>
         <% c.tools do %>
           <div class="flex justify-end space-x-2">
             <%= a_link back_path do %>

data/app/components/avo/views/resource_show_component.html.erb

@@ -3,7 +3,7 @@
   data-selected-resources='["<%= @resource.model.id %>"]'
 >
   <% @resource.panels.each_with_index do |resource_panel, index| %>
-    <%= render Avo::PanelComponent.new(title: resource_panel[:name], display_breadcrumbs: @reflection.blank?, index: index) do |c| %>
+    <%= render Avo::PanelComponent.new(title: title, description: @resource.resource_description, display_breadcrumbs: @reflection.blank?, index: index) do |c| %>
       <% c.tools do %>
         <% if resource_panel[:name] == @resource.default_panel_name %>
           <%= render 'actions' %>

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

@@ -6,13 +6,24 @@ class Avo::Views::ResourceShowComponent < Avo::ResourceComponent
 
   attr_reader :fields_by_panel, :has_one_panels, :has_many_panels, :has_as_belongs_to_many_panels
 
-  def initialize(resource: nil, reflection: nil, parent_model: nil)
+  def initialize(resource: nil, reflection: nil, parent_model: nil, resource_panel: nil)
     @resource = resource
     @reflection = reflection
+    @resource_panel = resource_panel
 
     split_panel_fields
   end
 
+  def title
+    if @reflection.present?
+      return field.name if field.present?
+
+      reflection_resource.name
+    else
+      @resource.panels.first[:name]
+    end
+  end
+
   def back_path
     if via_resource?
       helpers.resource_path(model: params[:via_resource_class].safe_constantize, resource: relation_resource, resource_id: params[:via_resource_id])

data/app/controllers/avo/base_controller.rb

@@ -194,7 +194,7 @@ module Avo
     private
 
     def model_params
-      model_param_key = @resource.singular_model_key
+      model_param_key = @resource.form_scope
 
       request_params = params.require(model_param_key).permit(permitted_params)
 

data/app/controllers/avo/relations_controller.rb

@@ -18,6 +18,11 @@ module Avo
       @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])
+      @association_field = @parent_resource.get_field params[:related_name]
+
+      if @association_field.present? && @association_field.scope.present?
+        @query = @query.instance_exec(&@association_field.scope)
+      end
 
       super
     end

data/config/routes.rb

@@ -23,7 +23,7 @@ Avo::Engine.routes.draw do
 
     # Generate resource routes as below:
     # resources :posts
-    instance_eval(&Avo::App.draw_routes)
+    Avo::DynamicRouter::routes(self)
 
     # Relations
     get "/:resource_name/:id/:related_name/new", to: "relations#new", as: "associations_new"

data/db/factories.rb

@@ -53,4 +53,12 @@ FactoryBot.define do
     name { "#{Faker::Name.first_name} #{Faker::Name.last_name}" }
     type { "Spouse" }
   end
+
+  factory :course do
+    name { Faker::Company.name }
+  end
+
+  factory :link do
+    name { Faker::Internet.url }
+  end
 end

data/lib/avo/app.rb

@@ -155,24 +155,6 @@ module Avo
             filename
           end
       end
-
-      def draw_routes
-        # We should eager load all the classes so we find all descendants
-        Rails.application.eager_load!
-
-        proc do
-          BaseResource.descendants
-            .select do |resource|
-              resource != :BaseResource
-            end
-            .select do |resource|
-              resource.is_a? Class
-            end
-            .map do |resource|
-              resources resource.new.model_key
-            end
-        end
-      end
     end
   end
 end

data/lib/avo/base_resource.rb

@@ -19,6 +19,7 @@ module Avo
 
     class_attribute :id, default: :id
     class_attribute :title, default: :id
+    class_attribute :description, default: :id
     class_attribute :search_query, default: nil
     class_attribute :search_query_help, default: ''
     class_attribute :includes, default: []
@@ -154,6 +155,12 @@ module Avo
       fields
     end
 
+    def get_field(id)
+      get_field_definitions.find do |f|
+        f.id == id.to_sym
+      end
+    end
+
     def get_grid_fields
       return if self.class.grid_loader.blank?
 
@@ -224,6 +231,16 @@ module Avo
       name
     end
 
+    def resource_description
+      return instance_exec(&self.class.description) if self.class.description.respond_to? :call
+
+      # Show the description only on the resource index view.
+      # If the user wants to conditionally it on all pages, they should use a block.
+      if view == :index
+        return self.class.description if self.class.description.is_a? String
+      end
+    end
+
     def translation_key
       return "avo.resource_translations.#{class_name_without_resource.underscore}" if self.class.translation_enabled
 
@@ -442,7 +459,7 @@ module Avo
     end
 
     def form_scope
-      model.class.base_class.to_s.underscore.downcase
+      model_class.base_class.to_s.underscore.downcase
     end
   end
 end

data/lib/avo/dynamic_router.rb

@@ -0,0 +1,18 @@
+module Avo
+  module DynamicRouter
+    def self.routes(router)
+      Rails.application.eager_load!
+
+      BaseResource.descendants
+        .select do |resource|
+          resource != :BaseResource
+        end
+        .select do |resource|
+          resource.is_a? Class
+        end
+        .map do |resource|
+          router.resources resource.new.model_key
+        end
+    end
+  end
+end

data/lib/avo/fields/base_field.rb

@@ -102,6 +102,12 @@ module Avo
         @id.to_s.humanize(keep_id_suffix: true)
       end
 
+      def plural_name
+        return I18n.t(translation_key, count: 2).capitalize if translation_key
+
+        name.pluralize
+      end
+
       def placeholder
         return @placeholder if @placeholder.present?
 

data/lib/avo/fields/has_base_field.rb

@@ -2,11 +2,13 @@ module Avo
   module Fields
     class HasBaseField < BaseField
       attr_accessor :display
+      attr_accessor :scope
 
       def initialize(id, **args, &block)
         super(id, **args, &block)
 
         @display = args[:display].present? ? args[:display] : :show
+        @scope = args[:scope].present? ? args[:scope] : nil
       end
 
       def resource

data/lib/avo/services/authorization_service.rb

@@ -37,6 +37,10 @@ module Avo
         self.class.defined_methods(user, model, **args)
       end
 
+      def has_method?(method, **args)
+        self.class.defined_methods(user, record, **args).include? method.to_sym
+      end
+
       class << self
         def authorize(user, record, action, **args)
           return true if skip_authorization
@@ -64,6 +68,9 @@ module Avo
         def authorize_action(user, record, action, **args)
           action = Avo.configuration.authorization_methods.stringify_keys[action.to_s] || action
 
+          # Add the question mark if it's missing
+          action = "#{action}?" unless action.end_with? '?'
+
           return true if action.nil?
 
           authorize user, record, action, **args
@@ -101,7 +108,7 @@ module Avo
             Pundit.policy!(user, record).methods
           rescue => error
             if args[:raise_exception] == false
-              false
+              []
             else
               raise error
             end

data/lib/avo/version.rb

@@ -1,3 +1,3 @@
 module Avo
-  VERSION = "1.19.1.pre.8"
+  VERSION = "1.20.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: avo
 version: !ruby/object:Gem::Version
-  version: 1.19.1.pre.8
+  version: 1.20.1
 platform: ruby
 authors:
 - Adrian Marin
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-03 00:00:00.000000000 Z
+date: 2022-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -206,9 +206,6 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
-- app/assets/builds/avo.css
-- app/assets/builds/avo.js
-- app/assets/builds/avo.js.map
 - app/assets/config/avo_manifest.js
 - app/assets/images/avo/logo.png
 - app/assets/stylesheets/avo.css
@@ -583,6 +580,7 @@ files:
 - lib/avo/base_action.rb
 - lib/avo/base_resource.rb
 - lib/avo/configuration.rb
+- lib/avo/dynamic_router.rb
 - lib/avo/engine.rb
 - lib/avo/fields/badge_field.rb
 - lib/avo/fields/base_field.rb
@@ -688,6 +686,7 @@ files:
 - public/avo-assets/fonts/nunito-v16-latin-regular.ttf
 - public/avo-assets/fonts/nunito-v16-latin-regular.woff
 - public/avo-assets/fonts/nunito-v16-latin-regular.woff2
+- public/avo-assets/logo.png
 homepage: https://avohq.io
 licenses:
 - Commercial
@@ -708,9 +707,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.3
 signing_key: