avo 1.0.4 → 1.2.3

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/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/index.html.erb

@@ -1,10 +1,10 @@
 <div class="flex flex-col">
-  <%= panel title: 'Welcome to Avo' do |c| %>
-    <% c.with :tools do %>
+  <%= render Avo::PanelComponent.new title: 'Welcome to Avo' do |c| %>
+    <% c.tools do %>
       <div class="text-sm italic">This page is visible only in development. It will be hidden in other environments.</div>
     <% end %>
 
-    <% c.with :body do %>
+    <% c.body do %>
       <div class="flex flex-col justify-between py-6 min-h-24">
         <div class="px-6 space-y-4">
           <h3>About</h3>

data/app/views/avo/relations/new.html.erb

@@ -5,7 +5,7 @@
       'turbo-frame': '_top'
     } do |form| %>
     <%= render Avo::ModalComponent.new do |c| %>
-      <% c.with :heading do %>
+      <% c.heading do %>
         <%= t 'avo.choose_item', item: params[:related_name].downcase %>
       <% end %>
 
@@ -24,7 +24,7 @@
 
       <%#= form.hidden_field :resource_ids, value: params[:resource_ids], 'data-action-target': 'resourceIds' %>
 
-      <% c.with :controls do %>
+      <% c.controls do %>
         <%= a_button t('avo.cancel'), 'data-action': 'click->modal#close', size: :sm %>
         <%= a_button t('avo.attach'), type: :submit, color: :green, size: :sm %>
       <% end %>

data/app/views/avo/sidebar/_sidebar.html.erb

@@ -1,18 +1,27 @@
 <div class="application-sidebar flex h-full bg-white text-white w-56 z-50 border-r border-gray-300">
   <div class="flex flex-col w-full">
     <%= link_to root_path, class: 'logo-placeholder h-16 bg-white p-2 flex justify-center' do %>
-      <%= render_logo %>
+      <%= render partial: "avo/partials/logo" %>
     <% end %>
 
     <div class="flex-1 flex flex-col justify-between">
       <div class="tools py-4">
-        <%= render Avo::NavigationLinkComponent.new label: 'Get started', path: '/avo', active: :exclusive if Rails.env.development? %>
+        <%= render Avo::NavigationLinkComponent.new label: 'Get started', path: Avo.configuration.root_path, active: :exclusive if Rails.env.development? %>
         <%= render Avo::NavigationHeadingComponent.new label: t('avo.resources') %>
 
         <div class="w-full">
-          <% Avo::App.get_navigation_items(_current_user).each do |resource| %>
+          <% Avo::App.resources_navigation(_current_user).each do |resource| %>
             <%= render Avo::NavigationLinkComponent.new label: resource.name.pluralize.humanize, path: resources_path(resource.model_class) %>
           <% end %>
+
+          <% sidebar_partials = Avo::App.get_sidebar_partials %>
+          <% if sidebar_partials.present? %>
+            <%= render Avo::NavigationHeadingComponent.new label: t('avo.tools') %>
+
+            <% sidebar_partials.each do |partial| %>
+              <%= render partial: "/avo/sidebar/items/#{partial}" %>
+            <% end %>
+          <% end %>
         </div>
 
       </div>

data/app/views/layouts/avo/application.html.erb

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
 <head>
-  <title>Avo Hotwire</title>
+  <%= display_meta_tags site: Avo.configuration.app_name, reverse: true, separator: "—" %>
 
   <%= csrf_meta_tags %>
   <%= csp_meta_tag %>
@@ -20,7 +20,7 @@
     <div class="flex-1 flex flex-col h-full overflow-auto">
       <div class="relative bg-white p-2 shadow-md h-16 w-full flex flex-shrink-0 items-center z-50" v-if="layout !== 'blank'">
         <div class="ml-6">
-          <%= render_header %>
+          <%= render partial: "avo/partials/header" %>
         </div>
         <div class="flex-1 flex justify-center">
           <div class="w-64">
@@ -31,7 +31,7 @@
 
       <div class="content p-8 flex-1 flex flex-col justify-between items-stretch <%= @container_classes %>">
         <%= yield %>
-        <%= render_footer %>
+        <%= render partial: "avo/partials/footer" %>
       </div>
     </div>
   </div>
@@ -44,6 +44,7 @@
   <% end %>
 </div>
 
-<%= render_scripts %>
+<%= render partial: "avo/partials/scripts" %>
+<!-- Avo version: <%= Avo::VERSION %> -->
 </body>
 </html>

data/avo.gemspec

@@ -43,4 +43,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "view_component"
   spec.add_dependency "hotwire-rails"
   spec.add_dependency "addressable"
+  spec.add_dependency "meta-tags"
+  spec.add_dependency "breadcrumbs_on_rails"
 end

data/lib/avo/app.rb

@@ -129,10 +129,28 @@ module Avo
           .sort_by { |r| r.name }
       end
 
-      def get_navigation_items(user = nil)
+      def resources_navigation(user = nil)
         get_available_resources(user).select do |resource|
           resource.model_class.present?
         end
+          .select do |resource|
+            resource.visible_on_sidebar
+          end
+      end
+
+      # Insert any partials that we find in app/views/avo/sidebar/items.
+      def get_sidebar_partials
+        Dir.glob(Rails.root.join("app", "views", "avo", "sidebar", "items", "*.html.erb"))
+          .map do |path|
+            File.basename path
+          end
+          .map do |filename|
+            # remove the leading underscore (_)
+            filename[0] = ""
+            # remove the extension
+            filename.gsub!('.html.erb', '')
+            filename
+          end
       end
 
       def draw_routes
@@ -144,16 +162,17 @@ module Avo
             .select do |resource|
               resource != :BaseResource
             end
+            .select do |resource|
+              resource.is_a? Class
+            end
             .map do |resource|
-              if resource.is_a? Class
-                route_key = if resource.model_class.present?
-                  resource.model_class.model_name.route_key
-                else
-                  resource.to_s.underscore.gsub("_resource", "").downcase.pluralize.to_sym
-                end
-
-                resources route_key
+              route_key = if resource.model_class.present?
+                resource.model_class.model_name.route_key
+              else
+                resource.to_s.underscore.gsub("_resource", "").downcase.pluralize.to_sym
               end
+
+              resources route_key
             end
         end
       end

data/lib/avo/base_resource.rb

@@ -21,6 +21,7 @@ module Avo
     class_attribute :filters_loader
     class_attribute :fields
     class_attribute :grid_loader
+    class_attribute :visible_on_sidebar, default: true
 
     class << self
       def grid(&block)
@@ -260,28 +261,27 @@ module Avo
       end
     end
 
-    # For :new views we're hydrating the model with the values from the resource's default attribute.
     # We will not overwrite any attributes that come pre-filled in the model.
     def hydrate_model_with_default_values
       default_values = get_fields.select do |field|
         !field.computed
       end
         .map do |field|
-                         id = field.id
-                         value = field.value
+          id = field.id
+          value = field.value
 
-                         if field.respond_to? :foreign_key
-                           id = field.foreign_key.to_sym
+          if field.respond_to? :foreign_key
+            id = field.foreign_key.to_sym
 
-                           reflection = @model._reflections[@params[:via_relation]]
+            reflection = @model._reflections[@params[:via_relation]]
 
-                           if reflection.present? && reflection.foreign_key.present?
-                             value = @params[:via_resource_id]
-                           end
-                         end
+            if reflection.present? && reflection.foreign_key.present? && field.id.to_s == @params[:via_relation].to_s
+              value = @params[:via_resource_id]
+            end
+          end
 
-                         [id, value]
-                       end
+          [id, value]
+        end
         .to_h
         .select do |id, value|
         value.present?

data/lib/avo/configuration.rb

@@ -19,10 +19,12 @@ module Avo
     attr_accessor :full_width_index_view
     attr_accessor :cache_resources_on_index_view
     attr_accessor :context
+    attr_accessor :display_breadcrumbs
+    attr_accessor :initial_breadcrumbs
 
     def initialize
       @root_path = "/avo"
-      @app_name = Rails.application.class.to_s.split("::").first.underscore.humanize(keep_id_suffix: true)
+      @app_name = ::Rails.application.class.to_s.split("::").first.underscore.humanize(keep_id_suffix: true)
       @timezone = "UTC"
       @per_page = 24
       @per_page_steps = [12, 24, 48, 72]
@@ -48,6 +50,10 @@ module Avo
       @full_width_index_view = false
       @cache_resources_on_index_view = Avo::PACKED
       @context = proc {}
+      @initial_breadcrumbs = proc {
+        add_breadcrumb I18n.t("avo.home").humanize, avo.root_path
+      }
+      @display_breadcrumbs = true
     end
 
     def locale_tag
@@ -71,6 +77,10 @@ module Avo
     def set_context(&block)
       @context = block if block.present?
     end
+
+    def set_initial_breadcrumbs(&block)
+      @initial_breadcrumbs = block if block.present?
+    end
   end
 
   def self.configuration

data/lib/avo/fields/belongs_to_field.rb

@@ -50,8 +50,6 @@ module Avo
         foreign_key.to_sym
       end
 
-      private
-
       def target_resource
         if @model._reflections[id.to_s].klass.present?
           App.get_resource_by_model_name @model._reflections[id.to_s].klass.to_s

data/lib/avo/grid_collector.rb

@@ -27,7 +27,7 @@ module Avo
     def hydrate(model:, view:, resource:)
       cover_field.hydrate(model: model, view: view, resource: resource) if cover_field.present?
       title_field.hydrate(model: model, view: view, resource: resource) if title_field.present?
-      body_field.hydrate(model: model, view: view, resource: resource) if title_field.present?
+      body_field.hydrate(model: model, view: view, resource: resource) if body_field.present?
 
       self
     end

data/lib/avo/version.rb

@@ -1,3 +1,3 @@
 module Avo
-  VERSION = "1.0.4"
+  VERSION = "1.2.3"
 end

data/lib/generators/avo/eject_generator.rb

@@ -0,0 +1,55 @@
+require "rails/generators"
+require "fileutils"
+
+module Generators
+  module Avo
+    class EjectGenerator < ::Rails::Generators::Base
+      argument :filename, type: :string, required: true
+
+      source_root ::Avo::Engine.root
+
+      namespace "avo:eject"
+
+      TEMPLATES = {
+        sidebar: "app/views/avo/sidebar/_sidebar.html.erb",
+        logo: "app/views/avo/partials/logo.html.erb",
+        header: "app/views/avo/partials/header.html.erb",
+        footer: "app/views/avo/partials/footer.html.erb",
+        scripts: "app/views/avo/partials/scripts.html.erb"
+      }
+
+      def handle
+        if @filename.starts_with?(":")
+          template_id = path_to_sym @filename
+          template_path = TEMPLATES[template_id]
+
+          if path_exists? template_path
+            eject template_path
+          else
+            say("Failed to find the `#{template_id.to_sym}` template.", :yellow)
+          end
+        elsif path_exists? @filename
+          eject @filename
+        else
+          say("Failed to find the `#{@filename}` template.", :yellow)
+        end
+      end
+
+      no_tasks do
+        def path_to_sym(filename)
+          template_id = filename.dup
+          template_id[0] = ""
+          template_id.to_sym
+        end
+
+        def path_exists?(path)
+          path.present? && File.file?(::Avo::Engine.root.join(path))
+        end
+
+        def eject(path)
+          copy_file ::Avo::Engine.root.join(path), ::Rails.root.join(path)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,2 @@
+class Avo::ToolsController < Avo::ApplicationController
+end

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

@@ -0,0 +1 @@
+<%%= render Avo::NavigationLinkComponent.new label: '<%= human_name %>', path: '/avo/<%= file_name %>' %>

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

@@ -0,0 +1,27 @@
+<div class="flex flex-col">
+  <%%= render Avo::PanelComponent.new title: '<%= human_name %>' do |c| %>
+    <%% c.tools do %>
+      <div class="text-sm italic">This is the panels tools section.</div>
+    <%% end %>
+
+    <%% c.body do %>
+      <div class="flex flex-col justify-between py-6 min-h-24">
+        <div class="px-6 space-y-4">
+          <h3>What a nice new tool 👋</h3>
+
+          <p>
+            You can edit this file here <%= in_code "app/views/avo/tools/#{file_name}.html.erb" %>.
+          </p>
+
+          <p>
+            For this tool we created the <%= in_code file_name %> method in the <%= in_code "Avo::ToolsController" %>. You may delete it or move it to your own controller.
+          </p>
+
+          <p>
+            A new <%= in_code human_name %> item should have been added to the sidebar. Edit it in <%= in_code "app/views/avo/sidebar/items/_#{file_name}.html.erb" %>
+          </p>
+        </div>
+      </div>
+    <%% end %>
+  <%% end %>
+</div>

data/lib/generators/avo/tool_generator.rb

@@ -0,0 +1,62 @@
+require "rails/generators"
+require "fileutils"
+
+module Generators
+  module Avo
+    class ToolGenerator < ::Rails::Generators::Base
+      argument :name, type: :string, required: true
+
+      source_root File.expand_path("templates", __dir__)
+
+      namespace "avo:tool"
+
+      def handle
+        # Sidebar items
+        template "tool/sidebar_item.tt", "app/views/avo/sidebar/items/_#{file_name}.html.erb"
+
+        # Add controller if it doesn't exist
+        controller_path = "app/controllers/avo/tools_controller.rb"
+        unless File.file?(Rails.root.join(controller_path))
+          template "tool/controller.tt", controller_path
+        end
+
+        # Add controller method
+        inject_into_class controller_path, "Avo::ToolsController" do
+          <<-METHOD
+  def #{file_name}
+    @page_title = "#{human_name}"
+    add_breadcrumb "#{human_name}"
+  end
+          METHOD
+        end
+
+        # Add view file
+        template "tool/view.tt", "app/views/avo/tools/#{file_name}.html.erb"
+
+        route <<-ROUTE
+scope :#{::Avo.configuration.root_path.gsub('/', '')} do
+  get "#{file_name}", to: "avo/tools##{file_name}"
+end
+        ROUTE
+      end
+
+      no_tasks do
+        def file_name
+          name.to_s.underscore
+        end
+
+        def controller_name
+          file_name.to_s
+        end
+
+        def human_name
+          file_name.humanize
+        end
+
+        def in_code(text)
+          "<code class='p-1 rounded bg-gray-500 text-white text-sm'>#{text}</code>"
+        end
+      end
+    end
+  end
+end