avo 1.1.0 → 1.2.6.pre.1

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

@@ -4,6 +4,6 @@
   <div class="mt-2">
     We take pride in our documentation. Please check it out to see what you can build with Avo
 
-    <a href="https://docs.avohq.io" class="text-bold cursor-pointer block mt-2">Check out the docs 👉</a>
+    <a href="https://docs.avohq.io" target="_blank" title="Avo documentation" class="text-bold cursor-pointer block mt-2">Check out the docs 👉</a>
   </div>
 </div>

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

@@ -4,13 +4,13 @@
   <div class="mt-2" data-controller="hidden-input">
     Filters allow you to better scope the index queries for records you are looking for.
 
-    <strong class="cursor-pointer block mt-2" data-action="click->hidden-input#showContent">Generate filter 👇</strong>
-
-    <div class="mt-2 hidden" data-hidden-input-target="content">
+    <div class="mt-2">
       <code class="text-lg">Published filter</code>
-      <div>
+      <div class="mt-1">
         <code class="p-1 rounded bg-light-blue-500 text-white">bin/rails generate avo:filter published_filter</code>
       </div>
     </div>
+
+    <a href="https://docs.avohq.io/1.0/filters.html" target="_blank" title="Avo Filters documentation" class="text-bold cursor-pointer block mt-2">Filters in the docs 👉</a>
   </div>
 </div>

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

@@ -1,5 +1,9 @@
 <%
-  models = ApplicationRecord.descendants
+  models = begin
+    ApplicationRecord.descendants
+  rescue => exception
+    []
+  end
 %>
 <div>
   <h3>Resources</h3>
@@ -10,7 +14,7 @@
     <div class="mt-2" data-controller="hidden-input">
       It seems you already have <%= models.count %> <%= 'model'.pluralize models.count %> in your app. You can generate resources for each one with the following commands.
 
-      <strong class="cursor-pointer block mt-2" data-action="click->hidden-input#showContent">Generate resources 👇</strong>
+      <strong class="cursor-pointer block mt-2" data-action="click->hidden-input#showContent">Generate resources 👇 (click to reveal)</strong>
 
       <div class="mt-2 hidden" data-hidden-input-target="content">
         <% models.each do |model| %>
@@ -22,7 +26,16 @@
       </div>
     </div>
   <% else %>
+    <div class="mt-2" data-controller="hidden-input">
+      You may generate a resource using the following command:
+      <br>
 
+      <code class="p-1 rounded bg-light-blue-500 text-white">bin/rails generate avo:resource post</code>
+    </div>
   <% end %>
+
+  <p>
+    <a href="https://docs.avohq.io/1.0/resources.html" target="_blank" title="Avo Resources documentation">Docs</a>
+  </p>
 </div>
 

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>
@@ -27,7 +27,7 @@
               <li><span class="mr-2">👍</span> Grid view</li>
               <li><span class="mr-2">👍</span> Authorization</li>
               <li><span class="mr-2">👍</span> Localization</li>
-              <li><span class="mr-2">⏳</span> Custom tools</li>
+              <li><span class="mr-2">👍</span> Custom tools</li>
               <li><span class="mr-2">⏳</span> Custom fields</li>
               <li><span class="mr-2">⏳</span> Search</li>
               <li><span class="mr-2">🕐</span> Dashboards</li>

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

@@ -6,7 +6,8 @@
 
     <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? && Avo.configuration.home_path.nil?  %>
+
         <%= render Avo::NavigationHeadingComponent.new label: t('avo.resources') %>
 
         <div class="w-full">

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 %>
@@ -44,6 +44,7 @@
   <% end %>
 </div>
 
-<%= render partial: "avo/partials/footer" %>
+<%= 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.rb

@@ -10,6 +10,10 @@ module Avo
   IN_DEVELOPMENT = ENV["AVO_IN_DEVELOPMENT"] == "1"
   PACKED = !IN_DEVELOPMENT
 
+  class LicenseTinkeredError < StandardError; end
+
+  class LicenseInvalidError < StandardError; end
+
   class << self
     def webpacker
       @webpacker ||= ::Webpacker::Instance.new(

data/lib/avo/app.rb

@@ -26,12 +26,16 @@ module Avo
         self.request = request
         self.context = context
 
+        self.license = Licensing::LicenseManager.new(Licensing::HQ.new(request).response).license
+
         # Set the current host for ActiveStorage
-        ActiveStorage::Current.host = request.base_url
+        begin
+          ActiveStorage::Current.host = request.base_url
+        rescue => exception
+          Rails.logger.debug "[Avo] Failed to set ActiveStorage::Current.host, #{exception.inspect}"
+        end
 
         init_resources
-
-        self.license = Licensing::LicenseManager.new(Licensing::HQ.new(request).response).license
       end
 
       def cache_store
@@ -133,6 +137,9 @@ module Avo
         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.
@@ -144,6 +151,8 @@ module Avo
           .map do |filename|
             # remove the leading underscore (_)
             filename[0] = ""
+            # remove the extension
+            filename.gsub!('.html.erb', '')
             filename
           end
       end
@@ -157,16 +166,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)

data/lib/avo/configuration.rb

@@ -19,10 +19,13 @@ 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
+    attr_accessor :home_path
 
     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 +51,11 @@ 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
+      @home_path = nil
     end
 
     def locale_tag
@@ -71,6 +79,14 @@ module Avo
     def set_context(&block)
       @context = block if block.present?
     end
+
+    def set_initial_breadcrumbs(&block)
+      @initial_breadcrumbs = block if block.present?
+    end
+
+    def namespace
+      root_path.delete "/"
+    end
   end
 
   def self.configuration

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/licensing/h_q.rb

@@ -3,8 +3,8 @@ module Avo
     class HQ
       attr_accessor :current_request
 
-      ENDPOINT = "https://avohq.io/api/v1/licenses/check" unless const_defined?(:ENDPOINT)
-      CACHE_KEY = "avo.hq.response" unless const_defined?(:CACHE_KEY)
+      ENDPOINT = "https://avohq.io/api/v1/licenses/check".freeze unless const_defined?(:ENDPOINT)
+      CACHE_KEY = "avo.hq.response".freeze unless const_defined?(:CACHE_KEY)
       REQUEST_TIMEOUT = 5 unless const_defined?(:REQUEST_TIMEOUT) # seconds
 
       def initialize(current_request)
@@ -54,7 +54,7 @@ module Avo
       end
 
       def perform_request
-        puts "Performing request to avohq.io API to check license availability.".inspect if Rails.env.development?
+        ::Rails.logger.debug "[Avo] Performing request to avohq.io API to check license availability." if Rails.env.development?
 
         HTTParty.post ENDPOINT, body: payload.to_json, headers: {'Content-type': "application/json"}, timeout: REQUEST_TIMEOUT
       end

data/lib/avo/licensing/license.rb

@@ -4,11 +4,13 @@ module Avo
       attr_accessor :id
       attr_accessor :response
       attr_accessor :valid
+      attr_accessor :payload
 
       def initialize(response)
         @response = response
         @id = response["id"]
         @valid = response["valid"]
+        @payload = response["payload"]
       end
 
       def valid?

data/lib/avo/licensing/pro_license.rb

@@ -3,7 +3,8 @@ module Avo
     class ProLicense < License
       def abilities
         [
-          :authorization
+          :authorization,
+          :custom_tools
         ]
       end
     end

data/lib/avo/version.rb

@@ -1,3 +1,3 @@
 module Avo
-  VERSION = "1.1.0"
+  VERSION = "1.2.6.pre.1"
 end

data/lib/generators/avo/templates/initializer/avo.tt

@@ -29,10 +29,10 @@ Avo.configure do |config|
   # }
 
   ## == Localization ==
+  # config.locale = 'en-US'
 
   ## == Customization ==
   # config.app_name = 'Avocadelicious'
-  # config.locale = 'en-US'
   # config.timezone = 'UTC'
   # config.currency = 'USD'
   # config.per_page = 24
@@ -43,4 +43,13 @@ Avo.configure do |config|
   # config.full_width_container = false
   # config.full_width_index_view = false
   # config.cache_resources_on_index_view = true
+
+  # Where should the user be redirected when he hits the `/<%= options[:path] %>` url
+  # config.home_path = nil
+
+  ## == Breadcrumbs ==
+  # config.display_breadcrumbs = true
+  # config.set_initial_breadcrumbs do
+  #   add_breadcrumb "Home", '/<%= options[:path] %>'
+  # end
 end

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

@@ -1,10 +1,10 @@
 <div class="flex flex-col">
-  <%%= panel title: '<%= human_name %>' do |c| %>
-    <%% c.with :tools do %>
+  <%%= 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.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>What a nice new tool 👋</h3>

data/lib/generators/avo/tool_generator.rb

@@ -21,9 +21,11 @@ module Generators
         end
 
         # Add controller method
-        inject_into_class controller_path, 'Avo::ToolsController' do
+        inject_into_class controller_path, "Avo::ToolsController" do
           <<-METHOD
   def #{file_name}
+    @page_title = "#{human_name}"
+    add_breadcrumb "#{human_name}"
   end
           METHOD
         end
@@ -32,8 +34,8 @@ module Generators
         template "tool/view.tt", "app/views/avo/tools/#{file_name}.html.erb"
 
         route <<-ROUTE
-namespace :#{::Avo.configuration.root_path.gsub('/', '')} do
-  get "#{file_name}", to: "tools##{file_name}"
+scope :#{::Avo.configuration.namespace} do
+  get "#{file_name}", to: "avo/tools##{file_name}"
 end
         ROUTE
       end

data/public/avo-packs/css/{application-9d115b7e.css → application-b5f285ce.css}

@@ -3051,6 +3051,40 @@ svg.tea #steamR {
   color: rgba(255, 255, 255, var(--tw-text-opacity))
 }
 
+.breadcrumbs {
+
+  position: relative;
+
+  font-size: 0.875rem;
+
+  line-height: 1.25rem;
+
+  font-weight: 700;
+
+  --tw-text-opacity: 1;
+
+  color: rgba(156, 163, 175, var(--tw-text-opacity));
+}
+
+  .breadcrumbs a, .breadcrumbs span {
+
+  display: inline-block
+}
+
+  .breadcrumbs a, .breadcrumbs span {
+
+  --tw-text-opacity: 1;
+
+  color: rgba(156, 163, 175, var(--tw-text-opacity))
+}
+
+  .breadcrumbs a:hover {
+
+  --tw-text-opacity: 1;
+
+  color: rgba(107, 114, 128, var(--tw-text-opacity))
+}
+
 .spinner {
   position: relative;
   display: inline-block;
@@ -3612,6 +3646,11 @@ span.CodeMirror-selectedtext { background: none; }
   min-height: auto;
 }
 
+/* overlay CodeMirror fullscreen & Preview on small screens */
+.CodeMirror-fullscreen, .editor-preview-active-side {
+  z-index: 50;
+}
+
 .container {
     width: 100%;
 }
@@ -4533,6 +4572,9 @@ span.CodeMirror-selectedtext { background: none; }
 .bottom-0 {
     bottom: 0px
 }
+.top-\[-1px\] {
+    top: -1px
+}
 .z-10 {
     z-index: 10
 }
@@ -4595,6 +4637,9 @@ span.CodeMirror-selectedtext { background: none; }
 .mb-0 {
     margin-bottom: 0px
 }
+.mt-1 {
+    margin-top: 0.25rem
+}
 .-ml-20 {
     margin-left: -5rem
 }
@@ -4637,9 +4682,6 @@ span.CodeMirror-selectedtext { background: none; }
 .mb-6 {
     margin-bottom: 1.5rem
 }
-.mb-3 {
-    margin-bottom: 0.75rem
-}
 .mb-8 {
     margin-bottom: 2rem
 }
@@ -4700,15 +4742,15 @@ span.CodeMirror-selectedtext { background: none; }
 .h-16 {
     height: 4rem
 }
+.h-3 {
+    height: 0.75rem
+}
 .h-10 {
     height: 2.5rem
 }
 .h-12 {
     height: 3rem
 }
-.h-3 {
-    height: 0.75rem
-}
 .max-h-168 {
     max-height: 42rem
 }
@@ -5869,4 +5911,4 @@ html, body{
 }
 
 
-/*# sourceMappingURL=application-9d115b7e.css.map*/
+/*# sourceMappingURL=application-b5f285ce.css.map*/