avo 2.11.1 → 2.11.2.pre.1

data/app/controllers/avo/associations_controller.rb

@@ -5,12 +5,16 @@ module Avo
     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, :order]
-    before_action :hydrate_related_resource, only: [:show, :index, :new, :create, :destroy, :order]
+    before_action :set_reflection_field
+    before_action :hydrate_related_resource, only: [:show, :index, :create, :destroy, :order]
     before_action :set_related_model, only: [:show, :order]
+    before_action :set_reflection
     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]
+    before_action :authorize_index_action, only: :index
+    before_action :authorize_attach_action, only: :new
+    before_action :authorize_detach_action, only: :destroy
 
     def index
       @parent_resource = @resource.dup
@@ -28,6 +32,8 @@ module Avo
     end
 
     def show
+      @parent_resource, @parent_model = @resource, @model
+
       @resource, @model = @related_resource, @related_model
 
       super
@@ -36,12 +42,6 @@ module Avo
     def new
       @resource.hydrate(model: @model)
 
-      begin
-        @field = @resource.get_field_definitions.find { |f| f.id == @related_resource_name.to_sym }
-        @field.hydrate(resource: @resource, model: @model, view: :new)
-      rescue
-      end
-
       if @field.present? && !@field.searchable
         query = @authorization.apply_policy @attachment_class
 
@@ -93,8 +93,12 @@ module Avo
 
     private
 
+    def set_reflection
+      @reflection = @model._reflections[params[:related_name].to_s]
+    end
+
     def set_attachment_class
-      @attachment_class = @model._reflections[params[:related_name].to_s].klass
+      @attachment_class = @reflection.klass
     end
 
     def set_attachment_resource
@@ -102,11 +106,13 @@ module Avo
     end
 
     def set_attachment_model
-      @attachment_model = @model._reflections[params[:related_name].to_s].klass.find attachment_id
+      @attachment_model = @attachment_class.find attachment_id
     end
 
-    def set_reflection
-      @reflection = @model._reflections[params[:related_name].to_s]
+    def set_reflection_field
+      @field = @resource.get_field_definitions.find { |f| f.id == @related_resource_name.to_sym }
+      @field.hydrate(resource: @resource, model: @model, view: :new)
+    rescue
     end
 
     def attachment_id
@@ -121,5 +127,25 @@ module Avo
 
       klass
     end
+
+    def authorize_if_defined(method)
+      @authorization.set_record(@model)
+
+      if @authorization.has_method?(method.to_sym)
+        @authorization.authorize_action method.to_sym
+      end
+    end
+
+    def authorize_index_action
+      authorize_if_defined "view_#{@field.id}?"
+    end
+
+    def authorize_attach_action
+      authorize_if_defined "attach_#{@field.id}?"
+    end
+
+    def authorize_detach_action
+      authorize_if_defined "detach_#{@field.id}?"
+    end
   end
 end

data/app/controllers/avo/base_controller.rb

@@ -10,7 +10,8 @@ module Avo
     before_action :set_model_to_fill
     before_action :set_edit_title_and_breadcrumbs, only: [:edit, :update]
     before_action :fill_model, only: [:create, :update]
-    before_action :authorize_action
+    # Don't run base authorizations for associations
+    before_action :authorize_base_action, if: -> {controller_name != "associations"}
 
     def index
       @page_title = @resource.plural_name.humanize
@@ -247,7 +248,11 @@ module Avo
     end
 
     def permitted_params
-      @resource.get_field_definitions.select(&:updatable).map(&:to_permitted_param)
+      @resource.get_field_definitions.select(&:updatable).map(&:to_permitted_param).concat extra_params
+    end
+
+    def extra_params
+      @resource.class.extra_params || []
     end
 
     def cast_nullable(params)

data/app/javascript/js/controllers/fields/key_value_controller.js

@@ -110,13 +110,15 @@ export default class extends Controller {
   }
 
   inputField(id = 'key', index, key, value) {
+    const inputValue = id === 'key' ? key : value
+
     return `<input
   class="${this.options.inputClasses} focus:bg-gray-100 !rounded-none border-gray-600 border-r border-l-0 border-b-0 border-t-0 focus:border-gray-300 w-1/2 focus:outline-none outline-none key-value-input-${id}"
   data-action="input->key-value#${id}FieldUpdated"
   placeholder="${this.options[`${id}_label`]}"
   data-index="${index}"
   ${this[`${id}InputDisabled`] ? "disabled='disabled'" : ''}
-  value="${id === 'key' ? key : value}"
+  value="${typeof inputValue === 'undefined' || inputValue === null ? '' : inputValue}"
 />`
   }
 

data/app/javascript/js/controllers/sidebar_controller.js

@@ -0,0 +1,49 @@
+import { Controller } from '@hotwired/stimulus'
+import { enter, leave, toggle } from 'el-transition'
+import Cookies from 'js-cookie'
+
+export default class extends Controller {
+  static targets = ['sidebar', 'mobileSidebar', 'mainArea']
+
+  static values = {
+    open: Boolean,
+  }
+
+  get cookieKey() {
+    return `${window.Avo.configuration.cookies_key}.sidebar.open`
+  }
+
+  get sidebarOpen() {
+    return Cookies.get(this.cookieKey) === '1'
+  }
+
+  set cookie(state) {
+    Cookies.set(this.cookieKey, state === true ? 1 : 0)
+  }
+
+  markSidebarClosed() {
+    Cookies.set(this.cookieKey, '0')
+    this.openValue = false
+    leave(this.sidebarTarget)
+    this.mainAreaTarget.classList.remove('sidebar-open')
+  }
+
+  markSidebarOpen() {
+    Cookies.set(this.cookieKey, '1')
+    this.openValue = true
+    enter(this.sidebarTarget)
+    this.mainAreaTarget.classList.add('sidebar-open')
+  }
+
+  toggleSidebar() {
+    if (this.openValue) {
+      this.markSidebarClosed()
+    } else {
+      this.markSidebarOpen()
+    }
+  }
+
+  toggleSidebarOnMobile() {
+    toggle(this.mobileSidebarTarget)
+  }
+}

data/app/javascript/js/controllers.js

@@ -16,7 +16,6 @@ import ItemSelectorController from './controllers/item_selector_controller'
 import KeyValueController from './controllers/fields/key_value_controller'
 import LoadingButtonController from './controllers/loading_button_controller'
 import MenuController from './controllers/menu_controller'
-import MobileController from './controllers/mobile_controller'
 import ModalController from './controllers/modal_controller'
 import MultipleSelectFilterController from './controllers/multiple_select_filter_controller'
 import PerPageController from './controllers/per_page_controller'
@@ -26,6 +25,7 @@ import ResourceShowController from './controllers/resource_show_controller'
 import SearchController from './controllers/search_controller'
 import SelectController from './controllers/select_controller'
 import SelectFilterController from './controllers/select_filter_controller'
+import SidebarController from './controllers/sidebar_controller'
 import SimpleMdeController from './controllers/fields/simple_mde_controller'
 import TabsController from './controllers/tabs_controller'
 import TagsFieldController from './controllers/fields/tags_field_controller'
@@ -46,7 +46,6 @@ application.register('item-select-all', ItemSelectAllController)
 application.register('item-selector', ItemSelectorController)
 application.register('loading-button', LoadingButtonController)
 application.register('menu', MenuController)
-application.register('mobile', MobileController)
 application.register('modal', ModalController)
 application.register('multiple-select-filter', MultipleSelectFilterController)
 application.register('per-page', PerPageController)
@@ -56,6 +55,7 @@ application.register('resource-show', ResourceShowController)
 application.register('search', SearchController)
 application.register('select', SelectController)
 application.register('select-filter', SelectFilterController)
+application.register('sidebar', SidebarController)
 application.register('tabs', TabsController)
 application.register('tags-field', TagsFieldController)
 application.register('text-filter', TextFilterController)

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

@@ -10,6 +10,7 @@
       reflection: @reflection,
       turbo_frame: params[:turbo_frame],
       parent_model: @parent_model,
+      parent_resource: @parent_resource,
       applied_filters: @applied_filters,
     )
   %>

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

@@ -1,3 +1,9 @@
 <%= render Avo::TurboFrameWrapperComponent.new(params[:turbo_frame]) do %>
-  <%= render Avo::Views::ResourceShowComponent.new(resource: @resource, reflection: @reflection, actions: @actions) %>
+  <%= render Avo::Views::ResourceShowComponent.new(
+    resource: @resource,
+    reflection: @reflection,
+    actions: @actions,
+    parent_model: @parent_model,
+    parent_resource: @parent_resource,
+  ) %>
 <% end %>

data/app/views/avo/home/failed_to_load.html copy.erb

@@ -0,0 +1,23 @@
+<%= render Avo::TurboFrameWrapperComponent.new(params[:turbo_frame]) do %>
+  <%
+  classes = 'absolute inset-auto left-1/2 top-1/2 transform -translate-x-1/2 -translate-y-1/2'
+  label = t 'avo.failed_to_load'
+%>
+  <div class="relative flex-1 py-12">
+    <div class="relative block text-gray-300 h-40 w-full">
+      <%= svg 'avocado', class: "#{classes} h-20 text-gray-400" %>
+      <%= svg 'code', class: "#{classes} h-8 -ml-20 -mt-12" %>
+      <%= svg 'fire', class: "#{classes} h-8 -ml-10 -mt-24" %>
+      <%= svg 'color-swatch', class: "#{classes} h-8 ml-8 -mt-24" %>
+      <%= svg 'globe', class: "#{classes} h-8 ml-20 -mt-12" %>
+      <%= svg 'library', class: "#{classes} h-8 -ml-20 mt-4" %>
+      <%= svg 'photograph', class: "#{classes} h-8 ml-20 mt-4" %>
+    </div>
+    <div class="relative block text-center text-lg text-gray-400 font-semibold -mt-10"><%= label %> <span class="border-b-2 border-dashed"><%= params[:turbo_frame].to_s.humanize.downcase if params[:turbo_frame].present? %></span> frame</div>
+  </div>
+  <% if Rails.env.development? %>
+    <div class="text-center text-sm w-full">
+      This is not an issue with Avo. Click <%= link_to 'this link', params[:src], target: :_blank %> to see why this frame failed to load.
+    </div>
+  <% end %>
+<% end %>

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

@@ -3,21 +3,15 @@
   classes = 'absolute inset-auto left-1/2 top-1/2 transform -translate-x-1/2 -translate-y-1/2'
   label = t 'avo.failed_to_load'
 %>
-  <div class="relative flex-1 py-12">
-    <div class="relative block text-gray-300 h-40 w-full">
-      <%= svg 'avocado', class: "#{classes} h-20 text-gray-400" %>
-      <%= svg 'code', class: "#{classes} h-8 -ml-20 -mt-12" %>
-      <%= svg 'fire', class: "#{classes} h-8 -ml-10 -mt-24" %>
-      <%= svg 'color-swatch', class: "#{classes} h-8 ml-8 -mt-24" %>
-      <%= svg 'globe', class: "#{classes} h-8 ml-20 -mt-12" %>
-      <%= svg 'library', class: "#{classes} h-8 -ml-20 mt-4" %>
-      <%= svg 'photograph', class: "#{classes} h-8 ml-20 mt-4" %>
+  <div class="relative flex-1 py-4">
+    <div class="relative block text-gray-300 h-64 w-full">
+      <%= svg 'failed_to_load', class: "#{classes} h-52 text-gray-400" %>
     </div>
-    <div class="relative block text-center text-lg text-gray-400 font-semibold -mt-10"><%= label %> <span class="border-b-2 border-dashed"><%= params[:turbo_frame].to_s.humanize.downcase if params[:turbo_frame].present? %></span> frame</div>
+    <div class="relative block text-center text-lg text-gray-400 font-semibold pb-6"><%= label %> <span class="border-b-2 border-dashed"><%= params[:turbo_frame].to_s.humanize.downcase if params[:turbo_frame].present? %></span> frame</div>
+    <% if Rails.env.development? %>
+      <div class="text-center text-sm w-full pb-3">
+        This is not an issue with Avo. Use <%= link_to 'this page', params[:src], target: :_blank %> to see why this frame failed to load.
+      </div>
+    <% end %>
   </div>
-  <% if Rails.env.development? %>
-    <div class="text-center text-sm w-full">
-      This is not an issue with Avo. Click <%= link_to 'this link', params[:src], target: :_blank %> to see why this frame failed to load.
-    </div>
-  <% end %>
 <% end %>

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

@@ -3,4 +3,5 @@
   Avo.configuration.timezone = '<%= Avo.configuration.timezone %>'
   Avo.configuration.root_path = '<%= root_path_without_url %>'
   Avo.configuration.search_debounce = '<%= Avo.configuration.search_debounce %>'
+  Avo.configuration.cookies_key = '<%= Avo::COOKIES_KEY %>'
 <% end %>

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

@@ -2,8 +2,11 @@
   class="fixed bg-white p-2 w-full flex flex-shrink-0 items-center z-50 px-4 lg:px-4 border-b space-x-4 lg:space-x-0 h-16 <%= 'print:hidden' if Avo.configuration.hide_layout_when_printing %>"
   v-if="layout !== 'blank'"
 >
-  <div class="flex items-center space-x-2 lg:space-x-0 w-auto lg:w-64 flex-shrink-0 h-full">
-    <%= a_button class: 'lg:hidden', icon: 'menu', size: :xs, compact: true, style: :text, data: { action: 'click->mobile#toggleSidebar' } %>
+  <div class="flex items-center space-x-2 w-auto lg:w-64 flex-shrink-0 h-full">
+    <div>
+      <%= a_button class: 'lg:hidden', icon: 'menu', size: :xs, compact: true, style: :text, data: { action: 'click->sidebar#toggleSidebarOnMobile' } %>
+      <%= a_button class: 'hidden lg:block', icon: 'menu', size: :xs, compact: true, style: :text, data: { action: 'click->sidebar#toggleSidebar' } %>
+    </div>
     <%= render partial: "avo/partials/logo" %>
   </div>
   <div class="flex-1 flex items-center justify-between lg:justify-start space-x-2 sm:space-x-8 lg:pl-4">

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

@@ -1,9 +1,14 @@
 <thead class="bg-white border-b border-gray-200 pb-1">
   <% if @resource.record_selector %>
-    <th class="rounded-lg">
+    <th class="rounded-lg" data-control="item-select-th">
       <%== item_select_all_input %>
     </th>
   <% end %>
+  <% if Avo.configuration.resource_controls_on_the_left? %>
+    <th class="w-24" data-control="resource-controls-th">
+      <!-- Item controls cell -->
+    </th>
+  <% end %>
   <% fields.each_with_index do |field, index|  %>
     <%
       if params[:sort_by] == field.id.to_s
@@ -39,7 +44,7 @@
           ""
         end
     %>
-    <th class="text-left uppercase px-3 py-2 whitespace-nowrap rounded-l">
+    <th class="text-left uppercase px-3 py-2 whitespace-nowrap rounded-l" data-control="resource-field-th">
       <% if field.sortable %>
         <%= link_to params.permit!.merge(sort_by: sort_by, sort_direction: sort_direction), class: "flex items-center #{classes} #{'cursor-pointer' if field.sortable}", 'data-turbo-frame': params[:turbo_frame] do %>
           <%= field.name %>
@@ -52,7 +57,9 @@
       <% end %>
     </th>
   <% end %>
-  <th class="w-24">
-    <!-- Item controls cell -->
-  </th>
+  <% if Avo.configuration.resource_controls_on_the_right? %>
+    <th class="w-24" data-control="resource-controls-th">
+      <!-- Item controls cell -->
+    </th>
+  <% end %>
 </thead>

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

@@ -19,12 +19,17 @@
     <% end %>
   </head>
   <body class="bg-gray-25 os-mac">
-    <div class="relative flex flex-1 w-full min-h-full" data-controller="mobile">
+    <div class="relative flex flex-1 w-full min-h-full" data-controller="sidebar" data-sidebar-open-value="<%= @sidebar_open %>">
       <div class="flex-1 flex flex-col max-w-full">
         <%= render partial: "avo/partials/navbar" %>
-        <div class="flex-1 flex pt-16 relative">
-          <%= render Avo::SidebarComponent.new %>
-          <div class="lg:pl-64 flex-1 flex flex-col min-h-full max-w-full">
+        <div data-sidebar-target="mainArea" class="content-area flex-1 flex pt-16 relative <%= 'sidebar-open' if @sidebar_open %>">
+          <div class="hidden lg:flex">
+            <%= render Avo::SidebarComponent.new sidebar_open: @sidebar_open %>
+          </div>
+          <div class="flex lg:hidden">
+            <%= render Avo::SidebarComponent.new sidebar_open: false, for_mobile: true %>
+          </div>
+          <div class="main-content-area flex-1 flex flex-col min-h-full max-w-full">
             <div class="content p-4 lg:p-6 flex-1 flex flex-col justify-between items-stretch <%= @container_classes %>">
               <%= render partial: "avo/partials/custom_tools_alert" %>
               <div class="flex flex-1 flex-col justify-between items-stretch space-y-8">

data/bin/init

@@ -28,6 +28,11 @@ app_root do
   header 'Preparing the database'
   run! 'bin/rails db:setup'
 
+  header 'Building assets'
+  run! 'yarn build:js'
+  run! 'yarn build:custom-js'
+  run! 'yarn build:css'
+
   if use_docker == 'y'
     header 'Stopping the Docker image'
     run! 'docker-compose stop'

data/lib/avo/base_resource.rb

@@ -47,6 +47,7 @@ module Avo
     class_attribute :after_update_path, default: :show
     class_attribute :record_selector, default: true
     class_attribute :keep_filters_panel_open, default: false
+    class_attribute :extra_params
 
     class << self
       delegate :t, to: ::I18n
@@ -251,7 +252,7 @@ module Avo
       end
     end
 
-    def fill_model(model, params)
+    def fill_model(model, params, extra_params: [])
       # Map the received params to their actual fields
       fields_by_database_id = get_field_definitions
         .reject do |field|
@@ -262,6 +263,7 @@ module Avo
         end
         .to_h
 
+      # Write the field values
       params.each do |key, value|
         field = fields_by_database_id[key]
 
@@ -270,6 +272,19 @@ module Avo
         model = field.fill_field model, key, value, params
       end
 
+      # Write the user configured extra params to the model
+      if extra_params.present?
+        extra_params.each do |param_id|
+          # if it's a nested array, use the key
+          param_id = param_id.first.first if param_id.is_a? Hash
+
+          next unless @model.respond_to? "#{param_id}="
+
+          param_value = params[param_id]
+          @model.send("#{param_id}=", param_value)
+        end
+      end
+
       model
     end
 

data/lib/avo/concerns/has_fields.rb

@@ -13,8 +13,6 @@ module Avo
       end
 
       class_methods do
-        delegate :tool, to: :items_holder
-
         # DSL methods
         def field(name, **args, &block)
           ensure_items_holder_initialized
@@ -34,8 +32,14 @@ module Avo
           self.items_holder.tabs Avo::TabGroupBuilder.parse_block(&block)
         end
 
+        def tool(klass, **args)
+          ensure_items_holder_initialized
+
+          items_holder.tool klass, **args
+        end
+
         def heading(body, **args)
-          self.items_holder.add_item Avo::Fields::HeadingField.new(body, order_index: items_index, **args)
+          self.items_holder.heading body, **args
         end
         # END DSL methods
 
@@ -252,9 +256,14 @@ module Avo
           if item.respond_to? :visible_on?
             next unless item.visible_on?(view)
           end
+          # each field has it's own visibility checker
           if item.respond_to? :visible?
             next unless item.visible?
           end
+          # check if the user is authorized to view it
+          if item.respond_to? :authorized?
+            next unless item.hydrate(model: @model).authorized?
+          end
 
           if item.is_field?
             if item.has_own_panel?

data/lib/avo/concerns/has_html_attributes.rb

@@ -58,7 +58,7 @@ module Avo
             end
             .to_h
 
-          extra_attributes.merge attributes
+          attributes.merge extra_attributes
         else
           attributes
         end

data/lib/avo/concerns/model_class_constantized.rb

@@ -14,7 +14,7 @@ module Avo
           when String, Symbol
             value.to_s.safe_constantize
           else
-            raise ArgumentError.new "Failed to find a proper model class for #{self.to_s}"
+            raise ArgumentError.new "Failed to find a proper model class for #{self}"
           end
         end
       end

data/lib/avo/configuration/resource_configuration.rb

@@ -0,0 +1,21 @@
+module Avo
+  class Configuration
+    module ResourceConfiguration
+      def resource_controls_placement=(val)
+        @resource_controls_placement_instance = val
+      end
+
+      def resource_controls_placement
+        @resource_controls_placement_instance || :right
+      end
+
+      def resource_controls_on_the_left?
+        resource_controls_placement == :left
+      end
+
+      def resource_controls_on_the_right?
+        resource_controls_placement == :right
+      end
+    end
+  end
+end

data/lib/avo/configuration.rb

@@ -1,5 +1,7 @@
 module Avo
   class Configuration
+    include ResourceConfiguration
+
     attr_writer :root_path
     attr_accessor :app_name
     attr_accessor :timezone

data/lib/avo/fields/has_base_field.rb

@@ -78,6 +78,17 @@ module Avo
 
         super view
       end
+
+      def authorized?
+        method = "view_#{id}?".to_sym
+        service = resource.authorization
+
+        if service.has_method? method
+          service.authorize_action(method, raise_exception: false)
+        else
+          true
+        end
+      end
     end
   end
 end

data/lib/avo/fields/text_field.rb

@@ -3,12 +3,14 @@ module Avo
     class TextField < BaseField
       attr_reader :link_to_resource
       attr_reader :as_html
+      attr_reader :protocol
 
       def initialize(id, **args, &block)
         super(id, **args, &block)
 
-        @link_to_resource = args[:link_to_resource].present? ? args[:link_to_resource] : false
-        @as_html = args[:as_html].present? ? args[:as_html] : false
+        add_boolean_prop args, :link_to_resource
+        add_boolean_prop args, :as_html
+        add_string_prop args, :protocol
       end
     end
   end

data/lib/avo/items_holder.rb

@@ -49,6 +49,12 @@ module Avo
       add_item panel
     end
 
+    def heading(body = nil, **args, &block)
+      field = Avo::Fields::HeadingField.new(body, **args)
+
+      add_item field
+    end
+
     def add_item(instance)
       @items << instance
 

data/lib/avo/panel_builder.rb

@@ -5,6 +5,7 @@ class Avo::PanelBuilder
     end
   end
 
+  delegate :heading, to: :items_holder
   delegate :field, to: :items_holder
   delegate :items, to: :items_holder