avo 1.0.4 → 1.3.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f9541820f46494f3f993a870b717fb817ecaa83f4bd8cc6aa8b9e80d586a0cb
-  data.tar.gz: f9bd42e6372e23153ac57aefb13373cdb9662f74bf410ee82e25f7d482c64626
+  metadata.gz: a62f55a2092f0dd2716cdaacc87e2eea086745d164d032ff8024757748830e54
+  data.tar.gz: a104302aecf8c7f57ac9915fe61eaf26866d3ac25678f40eee2b2244de5d3664
 SHA512:
-  metadata.gz: 49d6e0faa8b0ac9386702b11cf7301f993211c89bb4f8368b8c6fefaa09167c492d9f5bc6f55cf622854d1c56231924dfa4fd78b9664cab49bd09cb0a56d33da
-  data.tar.gz: ba3295cd86157590af2b60bd364089210aa8e8b516b22b7cd4e8ddf09b6b9ca4e700216d099cf2722973e6125aa876c3f349b56c17ecfc00ae4457e5f3d42d2e
+  metadata.gz: 88e0ca48ccbc7ff735cbf14178e8bfce1085b34996ed3cad80238e3a625adc0eeab918092b5fee304a3fc31ab9d2465a5f0b5580aac6b5efd308b09218f340cd
+  data.tar.gz: 8b1847c9083ef9998ee2e6a49202addcb9e670c2b5fa1904672287bfa902dd886df4ed5a6ba21de1f5db9020a3a1bc1e5e868765d672677928840d9c14ad83e1

data/Gemfile

@@ -52,7 +52,7 @@ gem "byebug", platforms: [:mri, :mingw, :x64_mingw]
 gem "dotenv-rails"
 # Access an interactive console on exception pages or by calling 'console' anywhere in the code.
 gem "web-console", ">= 3.3.0"
-gem "listen", ">= 3.3.0"
+gem "listen", ">= 3.5.1"
 # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
 gem "spring"
 
@@ -119,3 +119,7 @@ gem "view_component", require: "view_component/engine"
 gem "addressable"
 
 gem "appraisal"
+
+gem 'meta-tags'
+
+gem 'breadcrumbs_on_rails'

data/Gemfile.lock

@@ -1,13 +1,15 @@
 PATH
   remote: .
   specs:
-    avo (1.0.4)
+    avo (1.3.0.pre.1)
       active_link_to
       addressable
+      breadcrumbs_on_rails
       countries
       hotwire-rails
       httparty
       image_processing
+      meta-tags
       pagy
       pundit
       rails (>= 6.0)
@@ -87,6 +89,8 @@ GEM
     bindex (0.8.1)
     bootsnap (1.4.8)
       msgpack (~> 1.0)
+    breadcrumbs_on_rails (4.0.0)
+      rails (>= 5.0)
     builder (3.2.4)
     bump (0.9.0)
     byebug (11.1.3)
@@ -161,6 +165,8 @@ GEM
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     marcel (1.0.0)
+    meta-tags (2.14.0)
+      actionpack (>= 3.2.0, < 6.2)
     method_source (1.0.0)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
@@ -356,6 +362,7 @@ DEPENDENCIES
   appraisal
   avo!
   bootsnap (>= 1.4.2)
+  breadcrumbs_on_rails
   bump
   byebug
   capybara (>= 2.15)
@@ -372,7 +379,8 @@ DEPENDENCIES
   image_processing (~> 1.2)
   iso
   jbuilder (~> 2.7)
-  listen (>= 3.3.0)
+  listen (>= 3.5.1)
+  meta-tags
   pg (>= 0.18, < 2.0)
   puma (~> 4.3.5)
   pundit
@@ -397,4 +405,4 @@ DEPENDENCIES
   zeitwerk (~> 2.3)
 
 BUNDLED WITH
-   2.2.15
+   2.2.5

data/README.md

@@ -15,10 +15,12 @@ Avo is a beautiful next-generation framework that empowers you, the developer, t
 **Documentation**: [docs.avohq.io](https://docs.avohq.io)\
 **Twitter**: [avo_hq](https://twitter.com/avo_hq)\
 **Community chat**: [discord](https://discord.gg/pkTF6y8)\
-**Issue tracker**: [GitHub issues](http://github.com/avo-hq/avo/issues)
+**Issue tracker**: [GitHub issues](http://github.com/avo-hq/avo/issues)\
+**Discussions and feature requests**: [GitHub issues](http://github.com/avo-hq/avo/discussions)
 
 ## Features
 
+  - **Powered by Hotwire** - Rails ❤️  Hotwire
   - **Code driven configuration** - Configure your Rails dashboard entirely by writing Ruby code.
   - **Resource Management** - Create a CRUD interface for Active Record from one command. No more copy-pasting view and controller files around.
   - **Active Storage support** - Amazingly easy, **one-line**, single or multi-file integration with **ActiveStorage**.

data/app/components/avo/common/key_value_component.html.erb

@@ -0,0 +1,53 @@
+<div class="w-full shadow-lg rounded-lg overflow-hidden"
+  data-controller="key-value"
+  data-key-value-target="controller"
+  data-options="<%= @field.options.to_json %>"
+  data-input-classes="<%= input_classes %>"
+  data-editable="<%= @view.in?([:edit, :create]) %>"
+>
+  <div class="w-full flex flex-col">
+    <div class="flex w-full">
+      <div class="flex w-full bg-gray-800 shadow overflow-hidden">
+        <div class="w-1/2 py-3 px-3 uppercase font-semibold text-xs text-white border-gray-600 border-r">
+          <%= @field.key_label %>
+        </div>
+        <div class="w-1/2 py-3 px-3 uppercase font-semibold text-xs text-white">
+          <%= @field.value_label %>
+        </div>
+        <% if @view.in?([:edit, :create]) %>
+          <div class="flex items-center justify-center p-2 px-3 border-l border-gray-600">
+            <a href="javascript:void(0);"
+              title="<%= @field.action_text %>"
+              data-tippy="tooltip"
+              data-button="add-row"
+              data-action="click->key-value#addRow"
+              <% if @field.disable_adding_rows %>
+                class="cursor-not-allowed"
+              <% end %>
+            >
+              <%= svg 'plus-circle', class: 'text-gray-400 h-5 hover:text-gray-500' %>
+            </a>
+          </div>
+        <% end %>
+      </div>
+    </div>
+    <div data-key-value-target="rows"></div>
+  </div>
+  <% if @form.present? %>
+    <%= @form.text_area @field.id,
+      value: @field.parsed_value,
+      class: 'hidden',
+      placeholder: @field.placeholder,
+      'data-key-value-target': 'input',
+      'data-view': :edit
+    %>
+  <% else %>
+    <%= text_area_tag @field.id,
+      @field.parsed_value,
+      class: 'hidden',
+      placeholder: @field.placeholder,
+      'data-key-value-target': 'input',
+      'data-view': :edit
+    %>
+  <% end %>
+</div>

data/app/components/avo/common/key_value_component.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Avo::Common::KeyValueComponent < ViewComponent::Base
+  include Avo::ApplicationHelper
+
+  def initialize(field:, form: nil, view: :show)
+    @field = field
+    @form = form
+    @view = view
+  end
+end

data/app/components/avo/edit/fields/belongs_to_field_component.html.erb

@@ -1,5 +1,4 @@
 <%= edit_field_wrapper field: @field, index: @index, form: @form, resource: @resource, displayed_in_modal: @displayed_in_modal do %>
-  <% disabled = @field.readonly || params[:via_resource_id] %>
   <%= @form.select @field.foreign_key, @field.options.map { |o| [o[:label], o[:value]] },
     {
       include_blank: @field.placeholder,

data/app/components/avo/edit/fields/belongs_to_field_component.rb

@@ -1,4 +1,11 @@
 # frozen_string_literal: true
 
 class Avo::Edit::Fields::BelongsToFieldComponent < Avo::Edit::Fields::FieldComponent
+  def disabled
+    return true if @field.readonly
+    return true if @field.target_resource.model_class.name == params[:via_resource_class]
+    return true if @field.id.to_s == params[:via_relation].to_s
+
+    false
+  end
 end

data/app/components/avo/edit/fields/key_value_field_component.html.erb

@@ -0,0 +1,3 @@
+<%= edit_field_wrapper field: @field, index: @index, form: @form, resource: @resource, displayed_in_modal: @displayed_in_modal do %>
+  <%= render Avo::Common::KeyValueComponent.new field: @field, form: @form, view: :edit %>
+<% end %>

data/app/components/avo/edit/fields/key_value_field_component.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class Avo::Edit::Fields::KeyValueFieldComponent < Avo::Edit::Fields::FieldComponent
+end

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

@@ -0,0 +1,3 @@
+<div class="absolute bg-gray-100 w-full h-full">
+  <%= helpers.svg 'avocado', class: 'relative transform -translate-x-1/2 -translate-y-1/2 h-20 text-gray-400 inset-auto top-1/2 left-1/2' %>
+</div>

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

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class Avo::Index::GridCoverEmptyStateComponent < ViewComponent::Base
+end

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

@@ -4,7 +4,9 @@
   <div class="relative w-full pb-3/4 rounded-t-xl overflow-hidden">
     <%== item_selector_input floating: true, size: :lg %>
 
-    <% if cover.respond_to? :to_image %>
+    <% if cover.blank? %>
+      <%= render Avo::Index::GridCoverEmptyStateComponent.new %>
+    <% elsif cover.respond_to? :to_image %>
       <%= link_to_if cover.link_to_resource, image_tag(cover.to_image, class: 'absolute h-full w-full object-cover'), helpers.resource_path(@resource.model), class: 'absolute h-full w-full object-cover', title: title.value %>
     <% elsif cover.type == 'file' %>
       <% if cover.value.attached? && cover.value.representable? %>
@@ -18,9 +20,7 @@
       <% if cover.value.present? %>
         <%= link_to_if cover.link_to_resource, image_tag(cover.value, class: 'absolute h-full w-full object-cover'), helpers.resource_path(@resource.model), class: 'absolute h-full w-full object-cover', title: title.value %>
       <% else %>
-        <div class="absolute bg-gray-100 w-full h-full">
-          <%= helpers.svg 'avocado', class: 'relative transform -translate-x-1/2 -translate-y-1/2 h-20 text-gray-400 inset-auto top-1/2 left-1/2' %>
-        </div>
+        <%= render Avo::Index::GridCoverEmptyStateComponent.new %>
       <% end %>
     <% end %>
   </div>

data/app/components/avo/modal_component.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 class Avo::ModalComponent < ViewComponent::Base
-  with_content_areas :heading, :controls
+  renders_one :heading
+  renders_one :controls
 end

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

@@ -1,7 +1,12 @@
 <div <%== data_attributes %>>
   <div class="mb-6">
-    <div class="text-2xl tracking-normal font-bold text-gray-800 truncate mb-3">
-      <%= @title %>
+    <div>
+      <div class="breadcrumbs">
+        <%= 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>
+      <div class="text-2xl tracking-normal font-bold text-gray-800 truncate">
+        <%= @title %>
+      </div>
     </div>
 
     <div>

data/app/components/avo/panel_component.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 class Avo::PanelComponent < ViewComponent::Base
-  with_content_areas :tools, :body, :bare_content, :footer
+  renders_one :tools
+  renders_one :body
+  renders_one :bare_content
+  renders_one :footer
 
   def initialize(title: nil, body_classes: nil, data: {})
     @title = title

data/app/components/avo/show/fields/has_one_field_component.html.erb

@@ -3,14 +3,14 @@
     <%= render(Avo::LoadingComponent.new(title: @field.name)) %>
   </turbo-frame>
 <% else %>
-  <%= panel(title: @field.id.capitalize) do |c| %>
-    <% c.with :tools do %>
+  <%= render Avo::PanelComponent.new(title: @field.id.capitalize) do |c| %>
+    <% c.tools do %>
       <%= a_link helpers.resource_attach_path(@resource.model.model_name.route_key, @resource.model.id, @field.id), color: 'indigo', 'data-turbo-frame': 'attach_modal' do %>
         <%= svg 'view-grid-add' %> <%= t('avo.attach_item', item: @field.id).capitalize %>
       <% end %>
     <% end %>
 
-    <% c.with :body do %>
+    <% c.body do %>
       <div class="py-8 flex justify-center items-center">
         <%= empty_state @field.id %>
       </div>

data/app/components/avo/show/fields/key_value_field_component.html.erb

@@ -0,0 +1,3 @@
+<%= show_field_wrapper field: @field, index: @index do %>
+  <%= render Avo::Common::KeyValueComponent.new field: @field, view: :show %>
+<% end %>

data/app/components/avo/show/fields/key_value_field_component.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class Avo::Show::Fields::KeyValueFieldComponent < Avo::Show::Fields::FieldComponent
+end

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

@@ -3,8 +3,8 @@
     <%= form_with model: @resource.model, url: helpers.resource_path(@resource.model), method: :put, multipart: true do |form| %>
       <%= hidden_field_tag :referrer, back_path if params[:via_resource_class] %>
 
-      <%= panel(title: resource_panel[:name]) do |component| %>
-        <% component.with :tools do %>
+      <%= render Avo::PanelComponent.new(title: resource_panel[:name]) do |c| %>
+        <% c.tools do %>
           <div class="flex justify-end space-x-2">
             <%= a_link back_path do %>
               <%= helpers.svg 'arrow-left' %> <%= t('avo.cancel').capitalize %>
@@ -18,7 +18,7 @@
           </div>
         <% end %>
 
-        <% component.with :body do %>
+        <% c.body do %>
           <% @resource.get_fields.each_with_index do |field, index| %>
             <%= edit_field field, index, @resource, form unless field.computed %>
           <% end %>

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

@@ -1,5 +1,5 @@
-<%= panel title: title, body_classes: 'py-4', data: { component: 'resources-index' } do |c| %>
-  <% c.with :tools do %>
+<%= render Avo::PanelComponent.new title: title, body_classes: 'py-4', data: { component: 'resources-index' } do |c| %>
+  <% c.tools do %>
     <%= render 'actions' if @actions.present? %>
 
     <% if can_create? %>
@@ -21,7 +21,7 @@
     <% end %>
   <% end %>
 
-  <% c.with :body do %>
+  <% c.body do %>
     <div class="flex justify-between py-6 min-h-24"
       data-selected-resources-name="<%= @resource.plural_name.downcase %>"
       data-selected-resources="[]"
@@ -51,7 +51,7 @@
   <% end %>
 
   <% if view_type.to_sym == :grid %>
-    <% c.with :bare_content do %>
+    <% c.bare_content do %>
       <%= render Avo::Index::ResourceGridComponent.new(resources: @resources, resource: @resource, reflection: @reflection, parent_model: @parent_model) %>
 
       <div class="bg-white rounded-xl shadow-xl mt-8 py-6">

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

@@ -1,8 +1,8 @@
 <div>
   <% @resource.panels.each do |resource_panel| %>
     <%= form_with model: @resource.model, url: helpers.resources_path(@resource.model, via_relation_class: params[:via_relation_class], via_resource_id: params[:via_resource_id]), local: true, multipart: true do |form| %>
-      <%= panel(title: resource_panel[:name]) do |component| %>
-        <% component.with :tools do %>
+      <%= render Avo::PanelComponent.new(title: resource_panel[:name]) do |c| %>
+        <% c.tools do %>
           <div class="flex justify-end space-x-2">
             <%= a_link back_path do %>
               <%= svg 'arrow-left' %> <%= t('avo.cancel').capitalize %>
@@ -14,7 +14,7 @@
           </div>
         <% end %>
 
-        <% component.with :body do %>
+        <% c.body do %>
           <% @resource.get_fields.each_with_index do |field, index| %>
             <%= edit_field field, index, @resource, form unless field.computed %>
           <% end %>

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

@@ -4,7 +4,7 @@
 >
   <% @resource.panels.each do |resource_panel| %>
     <%= render(Avo::PanelComponent.new(title: resource_panel[:name])) do |c| %>
-      <% c.with :tools do %>
+      <% c.tools do %>
         <% if resource_panel[:name] == @resource.default_panel_name %>
           <%= render 'actions' %>
 
@@ -44,7 +44,7 @@
         <% end %>
       <% end %>
 
-      <% c.with :body do %>
+      <% c.body do %>
         <% if fields_by_panel[resource_panel[:name]].present? %>
           <% fields_by_panel[resource_panel[:name]].each_with_index do |field, index| %>
             <%= show_field field, index, @resource %>

data/app/controllers/avo/application_controller.rb

@@ -7,6 +7,7 @@ module Avo
     before_action :set_authorization
     before_action :_authenticate!
     before_action :set_container_classes
+    before_action :add_initial_breadcrumbs
 
     rescue_from Pundit::NotAuthorizedError, with: :render_unauthorized
     rescue_from ActiveRecord::RecordInvalid, with: :exception_logger
@@ -51,7 +52,7 @@ module Avo
           existing_params = Addressable::URI.parse(request.fullpath).query_values.symbolize_keys
         end
       rescue; end
-      send :"resources_#{model.model_name.route_key}_path", **existing_params, **args
+      avo.send :"resources_#{model.model_name.route_key}_path", **existing_params, **args
     end
 
     def related_resources_path(parent_model, model, keep_query_params: false, **args)
@@ -70,9 +71,9 @@ module Avo
     end
 
     def resource_path(model = nil, resource_id: nil, keep_query_params: false, **args)
-      return send :"resources_#{model.model_name.route_key.singularize}_path", resource_id, **args if resource_id.present?
+      return avo.send :"resources_#{model.model_name.route_key.singularize}_path", resource_id, **args if resource_id.present?
 
-      send :"resources_#{model.model_name.route_key.singularize}_path", model, **args
+      avo.send :"resources_#{model.model_name.route_key.singularize}_path", model, **args
     end
 
     def resource_attach_path(model_name, model_id, related_name, related_id = nil)
@@ -92,11 +93,11 @@ module Avo
     end
 
     def new_resource_path(model, **args)
-      send :"new_resources_#{model.model_name.route_key.singularize}_path", **args
+      avo.send :"new_resources_#{model.model_name.route_key.singularize}_path", **args
     end
 
     def edit_resource_path(model, **args)
-      send :"edit_resources_#{model.model_name.route_key.singularize}_path", model, **args
+      avo.send :"edit_resources_#{model.model_name.route_key.singularize}_path", model, **args
     end
 
     private
@@ -110,6 +111,8 @@ module Avo
     end
 
     def set_resource
+      raise ActionController::RoutingError.new "No route matches" if resource.nil?
+
       @resource = resource.hydrate(params: params)
     end
 
@@ -182,8 +185,6 @@ module Avo
     def eager_load_files(resource, query)
       if resource.attached_file_fields.present?
         resource.attached_file_fields.map do |field|
-          # abort "#{field.pluralize}".inspect
-          # abort field.class.inspect
           attachment = case field.class.to_s
           when "Avo::Fields::FileField"
             "attachment"
@@ -194,7 +195,6 @@ module Avo
           end
 
           return query.eager_load "#{field.id}_#{attachment}": :blob
-          # return query.send :"with_attached_#{field}"
         end
       end
 
@@ -241,5 +241,9 @@ module Avo
 
       @container_classes = contain ? "2xl:container 2xl:mx-auto" : ""
     end
+
+    def add_initial_breadcrumbs
+      instance_eval(&Avo.configuration.initial_breadcrumbs) if Avo.configuration.initial_breadcrumbs.present?
+    end
   end
 end