avo 1.1.0 → 1.2.6.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1535b91dc05b50bd35b9842c10c5ed266edaec91eced513b8102776637f21fd2
-  data.tar.gz: b1ed85745075ff3aac0f32170c39323a6b070b38649d43470222cc56d554cff9
+  metadata.gz: 14e502a4a38c39f136298b688cb7df3be49612444de569c358aff07828c5ab7d
+  data.tar.gz: cf7bdebe1e32e73021c1b78a7200887b26e766471300ff6645c62353c9b9f1fd
 SHA512:
-  metadata.gz: 14461575f33ab286f132e5b1965c2b504f30edec5ec97cb8695333f63ba93ee08ac9dcb91b1a54fc5cf4421e850018b5298cc76d79586674b5eca722fd1fa30b
-  data.tar.gz: c845a9413d258f181a40ea7b0ec816ce2c267c1e0c2d369d131c610e4d65085169945482cd3746de0cc5bb85d7eade7f9ef05cd28a75f2e183a9b938e09c7c36
+  metadata.gz: 412610059431101fdebbcadeee2618941aa072ace0305937918ff78127409288e23109f4a3d4653d4a7a6495aa25a78066dc5f8e37ca1654bfe53aa5abed086a
+  data.tar.gz: 943c91cf7c347952a8b7c9da989b23d8ed45d6362547e2bc23524a0725008f87fc8f23ab9ad31f380564efd61fd5aee30b8c864def7eb9998a217e4f1bb81c01

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.1.0)
+    avo (1.2.6.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

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/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

@@ -4,9 +4,11 @@ module Avo
     include Pagy::Backend
     protect_from_forgery with: :exception
     before_action :init_app
+    before_action :check_avo_license
     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
@@ -33,6 +35,20 @@ module Avo
       end
     end
 
+    def render(*args)
+      raise Avo::LicenseTinkeredError, "License verification mechanism tinkered with." unless method(:check_avo_license).source_location.first.match?(/.*\/app\/controllers\/avo\/application_controller\.rb/)
+
+      super(*args)
+    end
+
+    def check_avo_license
+      unless request.original_url.match?(/.*\/avo\/resources\/.*/)
+        if !Rails.env.development? && (@license.invalid? || @license.lacks(:custom_tools))
+          raise Avo::LicenseInvalidError, "Your license is invalid."
+        end
+      end
+    end
+
     def _current_user
       instance_eval(&Avo.configuration.current_user)
     end
@@ -240,5 +256,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

data/app/controllers/avo/base_controller.rb

@@ -9,6 +9,9 @@ module Avo
     before_action :set_model, only: [:show, :edit, :destroy, :update]
 
     def index
+      @page_title = resource_name.humanize
+      add_breadcrumb resource_name.humanize
+
       set_index_params
       set_filters
       set_actions
@@ -48,15 +51,28 @@ module Avo
       set_actions
 
       @resource = @resource.hydrate(model: @model, view: :show, user: _current_user, params: params)
+
+      @page_title = @resource.default_panel_name
+      add_breadcrumb resource_name.humanize, resources_path(@resource.model_class)
+      add_breadcrumb @resource.model_title
     end
 
     def new
       @model = @resource.model_class.new
       @resource = @resource.hydrate(model: @model, view: :new, user: _current_user)
+
+      @page_title = @resource.default_panel_name
+      add_breadcrumb resource_name.humanize, resources_path(@resource.model_class)
+      add_breadcrumb t("avo.new").humanize
     end
 
     def edit
       @resource = @resource.hydrate(model: @model, view: :edit, user: _current_user)
+
+      @page_title = @resource.default_panel_name
+      add_breadcrumb resource_name.humanize, resources_path(@resource.model_class)
+      add_breadcrumb @resource.model_title, resource_path(@resource.model)
+      add_breadcrumb t("avo.edit").humanize
     end
 
     def create

data/app/controllers/avo/home_controller.rb

@@ -3,7 +3,11 @@ require_dependency "avo/application_controller"
 module Avo
   class HomeController < ApplicationController
     def index
-      unless Rails.env.development?
+      @page_title = "Get started"
+
+      if Avo.configuration.home_path.present?
+        redirect_to Avo.configuration.home_path
+      elsif !Rails.env.development?
         redirect_to resources_path Avo::App.get_resources.min_by { |resource| resource.route_key }.model_class
       end
     end

data/app/helpers/avo/application_helper.rb

@@ -21,12 +21,6 @@ module Avo
       }
     end
 
-    def panel(**args, &block)
-      render(Avo::PanelComponent.new(**args)) do |component|
-        capture(component, &block)
-      end
-    end
-
     def empty_state(resource_name)
       render partial: "avo/partials/empty_state", locals: {resource_name: resource_name}
     end

data/app/packs/entrypoints/application.css

@@ -14,6 +14,7 @@
 @import './../stylesheets/alerts.css';
 @import './../stylesheets/loader.css';
 @import './../stylesheets/pagination.css';
+@import './../stylesheets/breadcrumbs.css';
 
 @import './../stylesheets/components/status.css';
 @import './../stylesheets/components/code.css';

data/app/packs/stylesheets/breadcrumbs.css

@@ -0,0 +1,12 @@
+.breadcrumbs {
+  @apply relative text-sm text-gray-400 font-bold;
+
+  a,
+  span {
+    @apply inline-block text-gray-400;
+  }
+
+  a {
+    @apply hover:text-gray-500;
+  }
+}

data/app/packs/stylesheets/components/code.css

@@ -9,3 +9,8 @@
   height: var(--height) !important;
   min-height: auto;
 }
+
+/* overlay CodeMirror fullscreen & Preview on small screens */
+.CodeMirror-fullscreen, .editor-preview-active-side {
+  z-index: 50;
+}

data/app/packs/svgs/chevron-right.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" class="h-6 w-6" fill="none" viewBox="0 0 24 24" stroke="currentColor">
+  <path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M9 5l7 7-7 7" />
+</svg>

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

@@ -9,7 +9,7 @@
   >
     <%= form_with model: @model, scope: 'fields', url: "/avo/resources/#{@resource.model_class.model_name.route_key}/actions/#{@action.param_id}", data: {'turbo-frame': '_top', 'action-target': 'form'} do |form| %>
       <%= render Avo::ModalComponent.new do |c| %>
-        <% c.with :heading do %>
+        <% c.heading do %>
           <%= @action.name %>
         <% end %>
 
@@ -25,7 +25,7 @@
           <% end %>
         <% end %>
 
-        <% c.with :controls do %>
+        <% c.controls do %>
           <%= a_button @action.cancel_button_label, 'data-action': 'click->modal#close', size: :sm %>
           <%= a_button @action.confirm_button_label, type: :submit, color: :green, size: :sm %>
         <% end %>

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

@@ -1,16 +1,16 @@
 <div>
   <h3>Actions</h3>
 
-  <div class="mt-2" data-controller="hidden-input">
+  <div class="mt-2">
     Avo actions allow you to perform specific tasks on one or more of your records. For example, you might want to mark a user as inactive and optionally send a message that may be customized by the person that wants to run the action.
 
-    <strong class="cursor-pointer block mt-2" data-action="click->hidden-input#showContent">Generate action 👇</strong>
-
-    <div class="mt-2 hidden" data-hidden-input-target="content">
+    <div class="mt-2">
       <code class="text-lg">Toggle published</code>
-      <div>
+      <div class="mt-1">
         <code class="p-1 rounded bg-light-blue-500 text-white">bin/rails generate avo:action toggle_published</code>
       </div>
     </div>
+
+    <a href="https://docs.avohq.io/1.0/actions.html" target="_blank" title="Avo Actions documentation" class="text-bold cursor-pointer block mt-2">Actions in the docs 👉</a>
   </div>
 </div>