avo 2.9.1.pre5 → 2.10.0

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
@@ -67,7 +67,7 @@ class Avo::Menu::Builder
   # Add all the tools
   def all_tools(**args)
     Avo::App.tools_for_navigation.each do |tool|
-      link tool.humanize, path: "#{root_path}/#{tool}"
+      link tool.humanize, path: root_path(paths: [tool])
     end
   end
 

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/services/uri_service.rb

@@ -0,0 +1,71 @@
+module Avo
+  module Services
+    class URIService
+      class << self
+        def parse(path)
+          self.new path
+        end
+      end
+
+      attr_reader :uri
+
+      def initialize(path = '')
+        @uri = Addressable::URI.parse(path)
+      end
+
+      def append_paths(*paths)
+        paths = Array.wrap(paths).flatten
+
+        return self if paths.blank?
+
+        # Add the intermediary forward slash
+        @uri.path = @uri.path.concat("/") unless @uri.path.ends_with? "/"
+
+        # Add the paths to the URI
+        @uri.merge!(path: @uri.path.concat(join_paths(paths)))
+
+        self
+      end
+      alias_method :append_path, :append_paths
+
+      def append_query(params)
+        params = if params.is_a? Hash
+          params.map do |key, value|
+            "#{key}=#{value}"
+          end
+        else
+          {}
+        end
+
+        return self if params.blank?
+
+        # Add the query params to the URI
+        @uri.merge!(query: [@uri.query, *params].compact.join("&"))
+
+        self
+      end
+
+      def to_s
+        @uri.to_s
+      end
+
+      private
+
+      def join_paths(paths)
+        paths.map do |path|
+          sanitize_path path
+        end
+        .join("/")
+      end
+
+      # Removes the forward slash if it's present at the start of the path
+      def sanitize_path(path)
+        if path.to_s.starts_with? '/'
+          path = path[1..-1]
+        end
+
+        path
+      end
+    end
+  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.pre5" unless const_defined?(:VERSION)
+  VERSION = "2.10.0" unless const_defined?(:VERSION)
 end

data/lib/avo.rb

@@ -5,6 +5,7 @@ require_relative "avo/engine" if defined?(Rails)
 loader = Zeitwerk::Loader.for_gem
 loader.inflector.inflect(
   "html" => "HTML",
+  "uri_service" => "URIService",
   "has_html_attributes" => "HasHTMLAttributes"
 )
 loader.ignore("#{__dir__}/generators")

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