avo 2.9.1.pre7 → 2.10.0

data/lib/avo/dsl/field_parser.rb

@@ -0,0 +1,83 @@
+module Avo
+  module Dsl
+    class FieldParser
+      attr_reader :as
+      attr_reader :args
+      attr_reader :id
+      attr_reader :block
+      attr_reader :instance
+      attr_reader :order_index
+
+      def initialize(id:, order_index: 0, **args, &block)
+        @id = id
+        @as = args.fetch(:as, nil)
+        @order_index = order_index
+        @args = args
+        @block = block
+        @instance = nil
+      end
+
+      def valid?
+        instance.present?
+      end
+
+      def invalid?
+        !valid?
+      end
+
+      def parse
+        # The field is passed as a symbol eg: :text, :color_picker, :trix
+        @instance = if as.is_a? Symbol
+          parse_from_symbol
+        elsif as.is_a? Class
+          parse_from_class
+        end
+
+        self
+      end
+
+      private
+
+      def parse_from_symbol
+        field_class = field_class_from_symbol(as)
+
+        if field_class.present?
+          # The field has been registered before.
+          instantiate_field(id, klass: field_class, **args, &block)
+        else
+          # The symbol can be transformed to a class and found.
+          class_name = as.to_s.camelize
+          field_class = "#{class_name}Field"
+
+          # Discover & load custom field classes
+          if Object.const_defined? field_class
+            instantiate_field(id, klass: field_class.safe_constantize, **args, &block)
+          end
+        end
+      end
+
+      def parse_from_class
+        # The field has been passed as a class.
+        if Object.const_defined? as.to_s
+          instantiate_field(id, klass: as, **args, &block)
+        end
+      end
+
+      def instantiate_field(id, klass:, **args, &block)
+        if block
+          klass.new(id, **args || {}, &block)
+        else
+          klass.new(id, **args || {})
+        end
+      end
+
+      def field_class_from_symbol(symbol)
+        matched_field = Avo::App.fields.find do |field|
+          field[:name].to_s == symbol.to_s
+        end
+
+        return matched_field[:class] if matched_field.present? && matched_field[:class].present?
+      end
+    end
+  end
+end

data/lib/avo/fields/base_field.rb

@@ -4,8 +4,11 @@ module Avo
       extend ActiveSupport::DescendantsTracker
       extend Avo::Fields::FieldExtensions::HasFieldName
 
-      include Avo::Fields::FieldExtensions::VisibleInDifferentViews
+      include Avo::Concerns::IsResourceItem
+      include Avo::Concerns::HandlesFieldArgs
+
       include ActionView::Helpers::UrlHelper
+      include Avo::Fields::FieldExtensions::VisibleInDifferentViews
 
       include Avo::Concerns::HandlesFieldArgs
       include Avo::Concerns::HasHTMLAttributes
@@ -48,8 +51,9 @@ module Avo
       attr_reader :panel_name
 
       class_attribute :field_name_attribute
+      class_attribute :item_type, default: :field
 
-      def initialize(id, _options: {}, **args, &block)
+      def initialize(id, **args, &block)
         super(id, **args, &block)
 
         @id = id
@@ -206,9 +210,14 @@ module Avo
 
       # Try and build the component class or fallback to a blank one
       def component_for_view(view = :index)
+        # Use the edit variant for all "update" views
+        view = :edit if view.in? [:new, :create, :update]
+
         component_class = "::Avo::Fields::#{view_component_name}::#{view.to_s.camelize}Component"
         component_class.constantize
       rescue
+        # When returning nil, a race condition happens and throws an error in some environments.
+        # See https://github.com/avo-hq/avo/pull/365
         ::Avo::BlankFieldComponent
       end
 
@@ -228,6 +237,14 @@ module Avo
         true
       end
 
+      def visible_in_reflection?
+        true
+      end
+
+      def hidden_in_reflection?
+        !visible_in_reflection?
+      end
+
       private
 
       def model_or_class(model)

data/lib/avo/fields/field_extensions/visible_in_different_views.rb

@@ -7,13 +7,20 @@ module Avo
         attr_accessor :show_on_new
         attr_accessor :show_on_edit
 
-        def initialize(id, **args, &block)
+        def initialize(id = nil, **args, &block)
           @show_on_index = @show_on_index.nil? ? true : @show_on_index
           @show_on_show = @show_on_show.nil? ? true : @show_on_show
           @show_on_new = @show_on_new.nil? ? true : @show_on_new
           @show_on_edit = @show_on_edit.nil? ? true : @show_on_edit
         end
 
+        # Validates if the field is visible on certain view
+        def visible_on?(view)
+          raise "No view specified on visibility check." if view.blank?
+
+          send :"show_on_#{view.to_s}"
+        end
+
         def show_on(*where)
           return show_on_all if where.include? :all
 
@@ -44,6 +51,16 @@ module Avo
           end
         end
 
+        # When submitting the form on creation, the new page will be create but we don't have a visibility marker for create so we'll default to new
+        def show_on_create
+          show_on_new
+        end
+
+        # When submitting the form on update, the new page will be create but we don't have a visibility marker for update so we'll default to edit
+        def show_on_update
+          show_on_edit
+        end
+
         private
 
         def show_on_view(view)

data/lib/avo/fields/has_base_field.rb

@@ -31,7 +31,8 @@ module Avo
       def frame_url
         Avo::Services::URIService.parse(@resource.record_path)
           .append_path(id.to_s)
-          .append_query(turbo_frame: turbo_frame.to_s).to_s
+          .append_query(turbo_frame: turbo_frame.to_s)
+          .to_s
       end
 
       # The value
@@ -61,6 +62,22 @@ module Avo
       def placeholder
         @placeholder || I18n.t("avo.choose_an_option")
       end
+
+      def has_own_panel?
+        true
+      end
+
+      def visible_in_reflection?
+        false
+      end
+
+      # Adds the view override component
+      # has_one, has_many, has_and_belongs_to_many fields don't have edit views
+      def component_for_view(view = :index)
+        view = :show if view.in? [:new, :create, :update, :edit]
+
+        super view
+      end
     end
   end
 end

data/lib/avo/grid_collector.rb

@@ -13,15 +13,18 @@ module Avo
     end
 
     def cover(field_name, as:, **args, &block)
-      self.cover_field = self.class.parse_field(field_name, as: as, **args, &block)
+      field_parser = Avo::Dsl::FieldParser.new(id: field_name, as: as, order_index: items_index, **args, &block).parse
+      self.cover_field = field_parser.instance if field_parser.valid?
     end
 
     def title(field_name, as:, **args, &block)
-      self.title_field = self.class.parse_field(field_name, as: as, **args, &block)
+      field_parser = Avo::Dsl::FieldParser.new(id: field_name, as: as, order_index: items_index, **args, &block).parse
+      self.title_field = field_parser.instance if field_parser.valid?
     end
 
     def body(field_name, as:, **args, &block)
-      self.body_field = self.class.parse_field(field_name, as: as, **args, &block)
+      field_parser = Avo::Dsl::FieldParser.new(id: field_name, as: as, order_index: items_index, **args, &block).parse
+      self.body_field = field_parser.instance if field_parser.valid?
     end
 
     def hydrate(model:, view:, resource:)

data/lib/avo/items_holder.rb

@@ -0,0 +1,68 @@
+module Avo
+  class ItemsHolder
+    attr_reader :tools
+    attr_accessor :items
+    attr_accessor :invalid_fields
+
+    def initialize
+      @items = []
+      @items_index = 0
+      @invalid_fields = []
+    end
+
+    # Adds a field to the bag
+    def field(field_name, **args, &block)
+      field_parser = Avo::Dsl::FieldParser.new(id: field_name, order_index: @items_index, **args, &block).parse
+
+      if field_parser.invalid?
+        as = args.fetch(:as, nil)
+
+        # End execution ehre and add the field to the invalid_fileds payload so we know to wanr the developer about that.
+        # @todo: Make sure this warning is still active
+        return add_invalid_field({
+          name: field_name,
+          as: as,
+          # resource: resource_class.name,
+          message: "There's an invalid field configuration for this resource. <br/> <code class='px-1 py-px rounded bg-red-600'>field :#{field_name}, as: #{as}</code>"
+        })
+      end
+
+      add_item field_parser.instance
+    end
+
+    def tabs(instance)
+      add_item instance
+    end
+
+    def tab(name, **args, &block)
+      add_item Avo::TabBuilder.parse_block(name: name, **args, &block)
+    end
+
+    def tool(klass, **args)
+      instance = klass.new(**args)
+      add_item instance
+    end
+
+    def panel(panel_name = nil, **args, &block)
+      panel = Avo::PanelBuilder.parse_block(name: panel_name, **args, &block)
+
+      add_item panel
+    end
+
+    def add_item(instance)
+      @items << instance
+
+      increment_order_index
+    end
+
+    private
+
+    def add_invalid_field(payload)
+      @invalid_fields << payload
+    end
+
+    def increment_order_index
+      @items_index += 1
+    end
+  end
+end

data/lib/avo/licensing/h_q.rb

@@ -98,6 +98,7 @@ module Avo
           **other_metadata(:filters),
           main_menu_present: Avo.configuration.main_menu.present?,
           profile_menu_present: Avo.configuration.profile_menu.present?,
+          **config_metadata
         }
       rescue
         {}
@@ -178,6 +179,15 @@ module Avo
         }
       end
 
+      def config_metadata
+        {
+          config: {
+            root_path: Avo.configuration.root_path,
+            app_name: Avo.configuration.app_name
+          }
+        }
+      end
+
       def cache_and_return_error(error, exception_message = "")
         cache_response response: {error: error, exception_message: exception_message}.stringify_keys, time: 5.minutes.to_i
       end

data/lib/avo/main_panel.rb

@@ -0,0 +1,3 @@
+class Avo::MainPanel < Avo::Panel
+  class_attribute :item_type, default: :main_panel
+end

data/lib/avo/menu/builder.rb

@@ -5,12 +5,12 @@ class Avo::Menu::Builder
     end
   end
 
-  delegate :context, to: Avo::App
-  delegate :current_user, to: Avo::App
-  delegate :params, to: Avo::App
-  delegate :request, to: Avo::App
-  delegate :root_path, to: Avo::App
-  delegate :view_context, to: Avo::App
+  delegate :context, to: ::Avo::App
+  delegate :current_user, to: ::Avo::App
+  delegate :params, to: ::Avo::App
+  delegate :request, to: ::Avo::App
+  delegate :root_path, to: ::Avo::App
+  delegate :view_context, to: ::Avo::App
 
   def initialize(name: nil, items: [])
     @menu = Avo::Menu::Menu.new

data/lib/avo/panel.rb

@@ -0,0 +1,25 @@
+class Avo::Panel
+  include Avo::Concerns::IsResourceItem
+
+  class_attribute :item_type, default: :panel
+
+  attr_reader :name
+  attr_reader :description
+  attr_accessor :items_holder
+
+  delegate :items, :add_item, to: :items_holder
+
+  def initialize(name: nil, description: nil)
+    @name = name
+    @description = description
+    @items_holder = Avo::ItemsHolder.new
+  end
+
+  def add_item(item)
+    @items << item
+  end
+
+  def has_items?
+    @items.present?
+  end
+end

data/lib/avo/panel_builder.rb

@@ -0,0 +1,23 @@
+class Avo::PanelBuilder
+  class << self
+    def parse_block(**args, &block)
+      Docile.dsl_eval(new(**args), &block).build
+    end
+  end
+
+  delegate :field, to: :items_holder
+  delegate :items, to: :items_holder
+
+  attr_reader :items_holder
+
+  def initialize(name: nil, **args)
+    @panel = Avo::Panel.new(name: name, **args)
+    @items_holder = Avo::ItemsHolder.new
+  end
+
+  # Fetch the tab
+  def build
+    @panel.items_holder = @items_holder
+    @panel
+  end
+end

data/lib/avo/tab.rb

@@ -0,0 +1,78 @@
+class Avo::Tab
+  include Avo::Concerns::IsResourceItem
+  include Avo::Fields::FieldExtensions::VisibleInDifferentViews
+
+  class_attribute :item_type, default: :tab
+  delegate :items, :add_item, to: :items_holder
+
+  attr_reader :name
+  attr_reader :view
+  attr_accessor :description
+  attr_accessor :items_holder
+  attr_accessor :holds_one_field
+
+  def initialize(name: nil, description: nil, view: nil, holds_one_field: false, **args)
+    # Initialize the visibility markers
+    super
+
+    @name = name
+    @description = description
+    @holds_one_field = holds_one_field
+    @items_holder = Avo::ItemsHolder.new
+    @view = view
+
+    show_on args[:show_on] if args[:show_on].present?
+    hide_on args[:hide_on] if args[:hide_on].present?
+    only_on args[:only_on] if args[:only_on].present?
+    except_on args[:except_on] if args[:except_on].present?
+  end
+
+  def hydrate(view: nil)
+    @view = view
+
+    self
+  end
+
+  def turbo_frame_id(parent: nil)
+    id = "#{Avo::Tab.to_s.parameterize} #{name}".parameterize
+
+    return id if parent.nil?
+
+    "#{parent.turbo_frame_id} #{id}".parameterize
+  end
+
+  def empty?
+    visible_items.blank?
+  end
+
+  # Checks for visibility on itself or on theone field it holds
+  def visible_on?(view)
+    if holds_one_field
+      super(view) && items.first.visible_on?(view)
+    else
+      super(view)
+    end
+  end
+
+  def items
+    if self.items_holder.present?
+      self.items_holder.items
+    else
+      []
+    end
+  end
+
+  def visible_items
+    items.map do |item|
+      if item.is_field?
+        visible = item.visible_on?(view)
+        # Remove the fields that shouldn't be visible in this view
+        # eg: has_many fields on edit
+        item = nil unless visible
+      end
+
+      item
+    end
+    .compact
+  end
+end

data/lib/avo/tab_builder.rb

@@ -0,0 +1,25 @@
+class Avo::TabBuilder
+  class << self
+    def parse_block(**args, &block)
+      Docile.dsl_eval(new(**args), &block).build
+    end
+  end
+
+  attr_reader :items_holder
+
+  delegate :field, to: :items_holder
+  delegate :tool, to: :items_holder
+  delegate :panel, to: :items_holder
+  delegate :items, to: :items_holder
+
+  def initialize(name: nil, **args)
+    @tab = Avo::Tab.new(name: name, **args)
+    @items_holder = Avo::ItemsHolder.new
+  end
+
+  # Fetch the tab
+  def build
+    @tab.items_holder = @items_holder
+    @tab
+  end
+end

data/lib/avo/tab_group.rb

@@ -0,0 +1,40 @@
+class Avo::TabGroup
+  include Avo::Concerns::HasFields
+  include Avo::Concerns::IsResourceItem
+
+  class_attribute :item_type, default: :tab_group
+
+  attr_reader :view
+  attr_accessor :index
+  attr_accessor :items_holder
+
+  def initialize(index: 0, view: nil)
+    @index = index
+    @items_holder = Avo::ItemsHolder.new
+    @view = view
+  end
+
+  def hydrate(view: nil)
+    @view = view
+
+    self
+  end
+
+  def visible_items
+    items.map do |item|
+      item.hydrate view: view
+    end
+    .select do |item|
+      # Remove items hidden in this view
+      item.visible_on? view
+    end
+    .select do |item|
+      # Remove empty items
+      !item.empty?
+    end
+  end
+
+  def turbo_frame_id
+    "#{Avo::TabGroup.to_s.parameterize} #{index}".parameterize
+  end
+end

data/lib/avo/tab_group_builder.rb

@@ -0,0 +1,43 @@
+class Avo::TabGroupBuilder
+  class << self
+    def parse_block(&block)
+      Docile.dsl_eval(new, &block).build
+    end
+  end
+
+  attr_reader :items_holder
+
+  delegate :tab, to: :items_holder
+
+  def initialize
+    @group = Avo::TabGroup.new
+    @items_holder = Avo::ItemsHolder.new
+  end
+
+  def field(field_name, **args, &block)
+    parsed = Avo::Dsl::FieldParser.new(id: field_name, order_index: @items_index, **args, &block).parse
+    field_instance = parsed.instance
+
+    name = field_instance.name
+    tab = Avo::Tab.new name: name
+
+    if field_instance.has_own_panel?
+      tab.items_holder.add_item parsed.instance
+      tab.holds_one_field = true
+    else
+      # If the field is not in a panel, create one and add it
+      panel = Avo::Panel.new name: name
+      panel.items_holder.add_item parsed.instance
+      # Add that panel to the bag
+      tab.items_holder.add_item panel
+    end
+
+    @items_holder.tabs tab
+  end
+
+  # Fetch the tab
+  def build
+    @group.items_holder = @items_holder
+    @group
+  end
+end

data/lib/avo/version.rb

@@ -1,3 +1,3 @@
 module Avo
-  VERSION = "2.9.1.pre7" unless const_defined?(:VERSION)
+  VERSION = "2.10.0" unless const_defined?(:VERSION)
 end

data/lib/generators/avo/templates/resource/controller.tt

@@ -1,2 +1,4 @@
+# This controller has been generated to enable Rails' resource routes.
+# You shouldn't need to modify it in order to use Avo.
 class <%= controller_class %> < Avo::ResourcesController
 end

data/lib/generators/avo/templates/resource_tools/partial.tt

@@ -1,5 +1,5 @@
 <div class="flex flex-col">
-  <%%= render Avo::PanelComponent.new title: "<%= human_name %>" do |c| %>
+  <%%= render Avo::PanelComponent.new(name: "<%= human_name %>") do |c| %>
     <%% c.tools do %>
       <%%= a_link('/avo', icon: 'heroicons/solid/academic-cap', style: :primary) do %>
         Dummy link

data/lib/generators/avo/templates/tool/view.tt

@@ -1,5 +1,5 @@
 <div class="flex flex-col">
-  <%%= render Avo::PanelComponent.new title: '<%= human_name %>', display_breadcrumbs: true do |c| %>
+  <%%= render Avo::PanelComponent.new(name: '<%= human_name %>', display_breadcrumbs: true) do |c| %>
     <%% c.tools do %>
       <div class="text-sm italic">This is the panels tools section.</div>
     <%% end %>

data/public/avo-assets/avo.css

@@ -3977,9 +3977,9 @@ a{
   display:flex;
 }
 
-.button-group .button-component:first-child{
-      margin-right:-1px
-    }
+.button-group .button-component{
+    margin-right:-1px
+  }
 
 .button-group .button-component:first-child{
       border-top-left-radius:0.25rem;
@@ -6354,6 +6354,16 @@ trix-editor .attachment__metadata .attachment__size {
   margin-bottom:0px
 }
 
+.-mx-2{
+  margin-left:-0.5rem;
+  margin-right:-0.5rem
+}
+
+.-my-2{
+  margin-top:-0.5rem;
+  margin-bottom:-0.5rem
+}
+
 .mx-6{
   margin-left:1.5rem;
   margin-right:1.5rem
@@ -8885,6 +8895,16 @@ trix-editor {
 }
 
 @media (min-width: 1024px){
+  .lg\:-mx-4{
+    margin-left:-1rem;
+    margin-right:-1rem
+  }
+
+  .lg\:-my-4{
+    margin-top:-1rem;
+    margin-bottom:-1rem
+  }
+
   .lg\:flex{
     display:flex
   }
@@ -8927,6 +8947,10 @@ trix-editor {
     padding:1.5rem
   }
 
+  .lg\:p-4{
+    padding:1rem
+  }
+
   .lg\:px-8{
     padding-left:2rem;
     padding-right:2rem