avo 2.9.1.pre7 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1125e5ae529c104548f0c947d1f878be1fa5aafc821d745df6c7a09077c1cb8
-  data.tar.gz: c85ba14cf3905f39ba12c688166ee88819c33c8b07af4507accdedfb8463311f
+  metadata.gz: 75872d452d6a4918c39857b6dbc0075477f13a87fa42d6bba3cc1da5fa924be0
+  data.tar.gz: e3b24ecd70d7fc005a33fd4b4fd34b79fd1c228db6125be80574968f639677b8
 SHA512:
-  metadata.gz: 587d36901f4ef5b250200c1903c7e7a8833933e9ff4a1fe565fe79ffef96abc9583eea274bc94e0ffbd62f29c1a567a7f5b758cf934bf04a09284e943cc6203e
-  data.tar.gz: 2efbbc0b87bff85f640e1a591c4341f39c1588938d3e7553600a069fc1f9d4b6fe79f3723d0c60972bffeee54c3dd4d3946e22871900bec6efcfa42ce652400a
+  metadata.gz: 88ba446afaeca394f7231314e12e87d535c995fc92009f1f9010729a43a817680fd2290e8513bc643a5b4c446c3f4323b4db15f3f073b536b138ca8751a8d2dc
+  data.tar.gz: f3e4ca2474e497d4693c68cb899d724ce511bba93a55db8d2c9666658c3f46c4744d635ed489001e9a9ca4e3921979fc503329a64b8686e875e2072a3033ce84

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    avo (2.9.1.pre7)
+    avo (2.10.0)
       active_link_to
       addressable
       breadcrumbs_on_rails
@@ -138,7 +138,7 @@ GEM
       xpath (~> 3.2)
     chartkick (4.2.0)
     childprocess (4.1.0)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     countries (4.2.1)
       i18n_data (~> 0.15.0)
       sixarm_ruby_unaccent (~> 1.1)
@@ -238,7 +238,7 @@ GEM
     mini_magick (4.11.0)
     mini_mime (1.1.2)
     mini_portile2 (2.8.0)
-    minitest (5.15.0)
+    minitest (5.16.2)
     msgpack (1.4.4)
     multi_xml (0.6.0)
     net-protocol (0.1.2)
@@ -252,8 +252,6 @@ GEM
     nokogiri (1.13.4)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    nokogiri (1.13.4-x86_64-linux)
-      racc (~> 1.4)
     orm_adapter (0.5.0)
     pagy (5.10.1)
       activesupport
@@ -393,7 +391,7 @@ GEM
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
-    view_component (2.49.1)
+    view_component (2.57.1)
       activesupport (>= 5.0.0, < 8.0)
       method_source (~> 1.0)
     warden (1.2.9)
@@ -416,7 +414,7 @@ GEM
     websocket-extensions (0.1.5)
     xpath (3.2.0)
       nokogiri (~> 1.8)
-    zeitwerk (2.5.4)
+    zeitwerk (2.6.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -69,6 +69,10 @@ Please read [CONTRIBUTING.MD](./CONTRIBUTING.MD)
 
 Please read the [UPGRADE_GUIDE.MD](https://docs.avohq.io/2.0/upgrade.html)
 
+# Release schedule
+
+Please read the [RELEASE.MD](./RELEASE.MD)
+
 # ✨ Contributors
 
 <a href="https://github.com/avo-hq/avo/graphs/contributors">

data/app/assets/stylesheets/css/buttons.css

@@ -1,8 +1,11 @@
 .button-group {
   @apply flex;
+
   .button-component {
+    @apply -mr-px;
+
     &:first-child {
-      @apply rounded-l -mr-px;
+      @apply rounded-l;
     }
 
     &:last-child {

data/app/components/avo/base_component.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 class Avo::BaseComponent < ViewComponent::Base
+  include Turbo::FramesHelper
+
   def has_with_trial(ability)
     ::Avo::App.license.has_with_trial(ability)
   end

data/app/components/avo/button_component.rb

@@ -26,9 +26,11 @@ class Avo::ButtonComponent < ViewComponent::Base
   def args
     if @args[:loading]
       @args[:"data-controller"] = "loading-button"
+      @args[:"data-loading-button-confirmed-value"] = false
+      @args[:"data-action"] = "click->loading-button#attemptSubmit"
 
       if @args[:confirm]
-        @args[:"data-avo-confirm"] = @args.delete(:confirm)
+        @args[:"data-loading-button-confirmation-message-value"] = @args.delete(:confirm)
       end
     end
 

data/app/components/avo/fields/edit_component.rb

@@ -3,6 +3,7 @@
 class Avo::Fields::EditComponent < ViewComponent::Base
   include Avo::ResourcesHelper
 
+  attr_reader :field
   attr_reader :view
 
   def initialize(field: nil, resource: nil, index: 0, form: nil, displayed_in_modal: false)
@@ -17,4 +18,8 @@ class Avo::Fields::EditComponent < ViewComponent::Base
   def classes(extra_classes = "")
     helpers.input_classes("#{@field.get_html(:classes, view: view, element: :input)} #{extra_classes}", has_error: @field.model_errors.include?(@field.id))
   end
+
+  def render?
+    !field.computed
+  end
 end

data/app/components/avo/fields/show_component.rb

@@ -5,7 +5,7 @@ class Avo::Fields::ShowComponent < ViewComponent::Base
 
   attr_reader :view
 
-  def initialize(field: nil, resource: nil, index: 0)
+  def initialize(field: nil, resource: nil, index: 0, form: nil)
     @field = field
     @resource = resource
     @index = index

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

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 class Avo::Index::Ordering::ButtonComponent < Avo::Index::Ordering::BaseComponent
-  delegate :view_context, to: ::Avo::App
-
   attr_accessor :resource
   attr_accessor :reflection
   attr_accessor :direction
@@ -20,10 +18,10 @@ class Avo::Index::Ordering::ButtonComponent < Avo::Index::Ordering::BaseComponen
   end
 
   def order_path(args)
-     if reflection.present?
-      view_context.avo.associations_order_path(reflection_parent_resource.route_key, params[:id], field.id, resource.model.id, **args)
+    if reflection.present?
+      Avo::App.view_context.avo.associations_order_path(reflection_parent_resource.route_key, params[:id], field.id, resource.model.id, **args)
     else
-      view_context.avo.resources_order_path(resource.route_key, resource.model.id, **args)
+      Avo::App.view_context.avo.resources_order_path(resource.route_key, resource.model.id, **args)
     end
   end
 end

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

@@ -1,6 +1,6 @@
 <div class="w-full ">
   <table class="w-full px-4 bg-white" data-resource-name='<%= @resource.model_key %>' data-controller='item-select-all'>
-    <%= render partial: 'avo/partials/table_header', locals: {fields: @resource.get_fields(reflection: @reflection)} %>
+    <%= render partial: 'avo/partials/table_header', locals: {fields: @resource.get_fields(reflection: @reflection, only_root: true)} %>
     <tbody class="divide-y">
       <% @resources.each_with_index do |resource, index| %>
         <% cache_if Avo.configuration.cache_resources_on_index_view, resource.cache_hash(@parent_model), expires_in: 1.day do %>

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

@@ -9,7 +9,7 @@
       </div>
     </td>
   <% end %>
-  <% @resource.get_fields(reflection: @reflection).each_with_index do |field, index| %>
+  <% @resource.get_fields(reflection: @reflection, only_root: true).each_with_index do |field, index| %>
     <%= render field.component_for_view(:index).new(field: field, resource: @resource, index: index, parent_model: @parent_model) %>
   <% end %>
   <td class="text-right whitespace-nowrap px-2">

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

@@ -0,0 +1,19 @@
+<% if item.is_tool? %>
+  <% if item&.partial.present? %>
+    <%= render item.partial, tool: item %>
+  <% end %>
+<% elsif item.is_panel? %>
+  <%= render Avo::PanelComponent.new(title: item.name, description: item.description, index: index, view: view) do |c| %>
+    <% c.body do %>
+      <div class="divide-y">
+        <% item.items.each_with_index do |field, index| %>
+          <%= render field.hydrate(resource: @resource, model: @resource.model, user: resource.user, view: view).component_for_view(view).new(field: field, resource: @resource, index: index, form: form) %>
+        <% end %>
+      </div>
+    <% end %>
+  <% end %>
+<% elsif item.is_tab_group? %>
+  <%= render tab_group_component %>
+<% elsif item.is_field? %>
+  <%= render field_component %>
+<% end %>

data/app/components/avo/item_switcher_component.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class Avo::ItemSwitcherComponent < Avo::BaseComponent
+  include Turbo::FramesHelper
+
+  attr_reader :resource
+  attr_reader :reflection
+  attr_reader :index
+  attr_reader :item
+  attr_reader :view
+
+  def initialize(resource: nil, reflection: nil, item: nil, index: nil, view: nil, form: nil)
+    @resource = resource
+    @reflection = reflection
+    @form = form
+    @index = index
+    @item = item
+    @view = view
+  end
+
+  def form
+    @form || nil
+  end
+
+  def render?
+    # Stops rendering if the field should be hidden in reflections
+    if item.is_field?
+      return false if in_reflection? && item.hidden_in_reflection?
+    end
+
+    true
+  end
+
+  def in_reflection?
+    @reflection.present?
+  end
+
+  def tab_group_component
+    Avo::TabGroupComponent.new resource: @resource, group: item.hydrate(view: view), index: index, params: params, form: form, view: view
+  end
+
+  def field_component
+    item.component_for_view(@view).new(field: item.hydrate(resource: @resource, view: @view, model: @resource.model), resource: @resource, index: index, form: form)
+  end
+end

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

@@ -1,4 +1,4 @@
-<div <%== data_attributes %>>
+<%= content_tag :div, data: data_attributes, class: classes do %>
   <% if render_header? %>
     <div class="flex-1 flex flex-col xl:flex-row justify-between mb-4">
       <div class="overflow-hidden flex flex-col">
@@ -7,18 +7,15 @@
             <%= 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-semibold text-gray-800 truncate items-center flex flex-1" data-target="title">
-          <span><%= @title %></span>
+          <span><%= @name %></span>
         </div>
-
         <% if description.present? %>
-        <div class="text-sm tracking-normal font-medium text-gray-600" data-target="description">
-          <%== description %>
-        </div>
+          <div class="text-sm tracking-normal font-medium text-gray-600" data-target="description">
+            <%== description %>
+          </div>
         <% end %>
       </div>
-
       <% if tools.present? %>
         <div class="flex-1 w-full flex flex-col sm:flex-row xl:justify-end sm:items-end space-y-2 sm:space-y-0 sm:space-x-2 mt-4 xl:mt-0">
           <%= tools %>
@@ -26,26 +23,28 @@
       <% end %>
     </div>
   <% end %>
-
-  <div class="relative <%= white_panel_classes %> <%= @body_classes %>">
-    <%= body %>
-  </div>
-
-  <div class="relative">
-    <%= bare_content %>
-  </div>
-
-  <% if footer_tools.present? %>
+  <% if body? %>
+    <div class="relative <%= white_panel_classes %> <%= @body_classes %>">
+      <%= body %>
+    </div>
+  <% end %>
+  <% if bare_content? %>
+    <div class="relative">
+      <%= bare_content %>
+    </div>
+  <% end %>
+  <% if footer_tools? %>
     <div class="<%= white_panel_classes %> p-4 flex-1 flex flex-col xl:flex-row justify-between mt-6">
       <div class="flex-1 w-full flex flex-col sm:flex-row xl:justify-end sm:items-end space-y-2 sm:space-y-0 sm:space-x-2 mt-4 xl:mt-0">
         <%= footer_tools %>
       </div>
     </div>
   <% end %>
-
-  <div class="flex justify-end w-full">
-    <div>
-      <%= footer %>
+  <% if footer? %>
+    <div class="flex justify-end w-full">
+      <div>
+        <%= footer %>
+      </div>
     </div>
-  </div>
-</div>
+  <% end %>
+<% end %>

data/app/components/avo/panel_component.rb

@@ -2,6 +2,8 @@
 
 class Avo::PanelComponent < ViewComponent::Base
   attr_reader :title
+  attr_reader :name
+  attr_reader :classes
 
   renders_one :tools
   renders_one :body
@@ -9,13 +11,17 @@ class Avo::PanelComponent < ViewComponent::Base
   renders_one :footer_tools
   renders_one :footer
 
-  def initialize(title: nil, description: nil, body_classes: nil, data: {}, display_breadcrumbs: false, index: nil)
+  def initialize(title: nil, name: nil, description: nil, body_classes: nil, data: {}, display_breadcrumbs: false, index: nil, classes: nil, view: nil)
+    # deprecating title in favor of name
     @title = title
+    @name = name || title
     @description = description
+    @classes = classes
     @body_classes = body_classes
     @data = data
     @display_breadcrumbs = display_breadcrumbs
     @index = index
+    @view = view
   end
 
   private
@@ -26,9 +32,6 @@ class Avo::PanelComponent < ViewComponent::Base
 
   def data_attributes
     @data.merge({"panel-index": @index})
-      .map do |key, value|
-        " data-#{key}=\"#{value}\""
-      end.join
   end
 
   def display_breadcrumbs?
@@ -42,7 +45,7 @@ class Avo::PanelComponent < ViewComponent::Base
   end
 
   def render_header?
-    @title.present? || description.present? || tools.present? || display_breadcrumbs?
+    @name.present? || description.present? || tools.present? || display_breadcrumbs?
   end
 
   def render_footer_tools?

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

@@ -0,0 +1,53 @@
+<%= content_tag :div,
+  data: {
+    target: "tab-group",
+    index: index,
+    controller: "tabs",
+    tabs_view_value: view,
+    tabs_active_tab_value: active_tab_name
+  },
+  class: 'space-y-12' do %>
+  <% visible_tabs.each_with_index do |tab, index| %>
+    <%
+      args = {
+        # Hide the turbo frames that aren't in the current tab
+        # This way we can lazy load the un-selected tabs on the show view
+        class: "block #{'hidden' unless tab.name == active_tab_name}",
+        data: {
+          # Add a marker to know if we already loaded a turbo frame
+          loaded: tab.name == active_tab_name,
+          tabs_target: :tab,
+          tab_id: tab.name,
+        }
+      }
+
+      is_current_tab = active_tab_name.to_s == tab.name.to_s
+
+      # On edit screens we want to load each tab because we wnst the DOM to have the fields present on form submission.
+      # If you have a field which is in the second tab and it's required, the form submission will fail because the required field is not in view, and we don't want that.
+      # We also want to load the current tab
+      should_lazy_load = if @view.to_s.in?(['edit', 'new'])
+        false
+      else
+        !is_current_tab
+      end
+
+      if should_lazy_load
+        args[:src] = helpers.resource_path(resource: @resource, model: @resource.model, keep_query_params: true, active_tab_name: tab.name, tab_turbo_frame: group.turbo_frame_id)
+        args[:loading] = :lazy
+      end
+    %>
+    <%= turbo_frame_tag tab.turbo_frame_id(parent: @group), **args do %>
+      <div class="border rounded-lg p-2 -mx-2 -my-2 lg:p-4 lg:-mx-4 lg:-my-4 space-y-4">
+        <%= render Avo::TabSwitcherComponent.new resource: @resource, current_tab: tab, group: group, active_tab_name: active_tab_name, view: view %>
+        <% if !should_lazy_load && !tab.empty? %>
+          <div class="space-y-12">
+            <% tab.visible_items.each do |item| %>
+              <%= render Avo::ItemSwitcherComponent.new resource: @resource, item: item, index: index, form: form, view: @view %>
+            <% end %>
+          </div>
+        <% end %>
+      </div>
+    <% end %>
+  <% end %>
+<% end %>

data/app/components/avo/tab_group_component.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+class Avo::TabGroupComponent < Avo::BaseComponent
+  attr_reader :group
+  attr_reader :index
+  attr_reader :view
+  attr_reader :form
+
+  def initialize(resource:, group:, index:, form:, params:, view:)
+    @resource = resource
+    @group = group
+    @index = index
+    @form = form
+    @params = params
+    @view = view
+
+    @group.index = index
+  end
+
+  def render?
+    tabs_have_content? && visible_tabs.present?
+  end
+
+  def tabs_have_content?
+    visible_tabs.present?
+  end
+
+  def active_tab_name
+    params[:active_tab_name] || group.visible_items&.first&.name
+  end
+
+  def tabs
+    @group.items.map do |tab|
+      tab.hydrate(view: view)
+    end
+  end
+
+  def visible_tabs
+    tabs.select do |tab|
+      !tab.empty?
+    end
+  end
+
+  def active_tab
+    return if group.visible_items.blank?
+
+    group.visible_items.find do |tab|
+      tab.name.to_s == active_tab_name.to_s
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+<div class="flex" data-target="tab-switcher">
+  <div class="button-group">
+    <% visible_items.each do |tab| %>
+      <%= a_link tab_path(tab),
+          color: selected?(tab) ? :gray : :primary,
+          rounded: false,
+          size: :sm,
+          class: selected?(tab) ? ' bg-gray-100 border-gray-300' : ' z-20',
+          title: tab.description,
+          data: {
+            tippy: tab.description.present? ? 'tooltip' : '',
+            control: "view-type-toggle-#{tab.name}",
+            selected: selected?(tab),
+            action: 'click->tabs#changeTab',
+            tabs_id_param: tab.name
+          } do %>
+        <%= tab.name %>
+      <% end %>
+    <% end %>
+  </div>
+</div>

data/app/components/avo/tab_switcher_component.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+class Avo::TabSwitcherComponent < Avo::BaseComponent
+  include Avo::UrlHelpers
+  include Avo::ApplicationHelper
+
+  attr_reader :active_tab_name
+  attr_reader :group
+  attr_reader :current_tab
+  attr_reader :tabs
+  attr_reader :view
+
+  def initialize(resource:, group:, current_tab:, active_tab_name:, view:)
+    @active_tab_name = active_tab_name
+    @resource = resource
+    @group = group
+    @current_tab = current_tab
+    @tabs = group.items
+    @view = view
+  end
+
+  def tab_path(tab)
+    if is_edit?
+      helpers.edit_resource_path(resource: @resource, model: @resource.model, keep_query_params: true, active_tab_name: tab.name, tab_turbo_frame: group.turbo_frame_id)
+    elsif is_new?
+      helpers.new_resource_path(resource: @resource, keep_query_params: true, active_tab_name: tab.name, tab_turbo_frame: group.turbo_frame_id)
+    else
+      helpers.resource_path(resource: @resource, model: @resource.model, keep_query_params: true, active_tab_name: tab.name, tab_turbo_frame: group.turbo_frame_id)
+    end
+  end
+
+  def is_edit?
+    @view == :edit
+  end
+
+  def is_new?
+    @view == :new
+  end
+
+  def is_initial_load?
+    params[:active_tab_name].blank?
+  end
+
+  # On initial load we want that each tab button to be the selected one.
+  # We do that so we don't get the wrongly selected item for a quick brief when first switching from one panel to another.
+  def selected?(tab)
+    if is_initial_load?
+      current_tab.name.to_s == tab.name.to_s
+    else
+      tab.name.to_s == active_tab_name.to_s
+    end
+  end
+
+  # Goes through all items and removes the ones that are not supposed to be visible.
+  # Example below:
+  # tabs do
+  #   field :comments, as: :has_many
+  # end
+  # Because the developer hasn't specified that it should be visible on edit views (with the show_on: :edit option),
+  # the field should not be visible in the item switcher either.
+  def visible_items
+    tabs.select do |item|
+      visible = true
+
+      if item.items.blank?
+        visible = false
+      end
+
+      first_item = item.items.first
+      if item.items.count == 1 && first_item.is_field? && first_item.has_own_panel? && !first_item.visible_on?(view)
+        # Return nil if tab contians a has_many type of fields and it's hidden in current view
+        visible = false
+      end
+
+      if item.respond_to?(:visible_on?)
+        visible = item.visible_on? view
+      end
+
+      if item.respond_to?(:visible?)
+        visible = item.visible?
+      end
+
+      visible
+    end
+  end
+end