avo 1.4.4 → 1.4.5.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ab528ed4c8361ffed46892c8e838897c9f834a6bba2ad4d5c2134a33381bcb0
-  data.tar.gz: 6a01552f743f231a4e1de2a81a85814b9a5e4708a22c514f54e1f48df37b9319
+  metadata.gz: 46a795d39c0e6c43399df4c10b3a75891557f6e1d525ec737420573e3042521a
+  data.tar.gz: 970f8657291f6b9a0d1338265e9253120135128eb3a248c88ca4a457f7273d64
 SHA512:
-  metadata.gz: 2d46d15e71d47b3eaf1f698572aa9f5edb2de0a5699926ef57373bce6f45b00afded60f8cf74016a1d393cadddf3aa807ea16fe7a6e4f3812f44b04ac9ce2bb7
-  data.tar.gz: 8d62dfe3b1e41ee0a91281b848eb5a5af48738d5c85bd25c94c0167813df1a5378b3b9393d7d0778630757ccb336801382e8b59d8769b790825138699ddbff32
+  metadata.gz: c0886bf3479f6eaf19d674b60e81906714666433d3b90d5b3685fac16ed558a18aeb099826ffc8e8ba798fa4149586ee36b4c447c6c05ce1141effd0c144a5a8
+  data.tar.gz: d8afee4446cef7180453beb74ef91cdf68f860e59ae8baa62c660075c4de8656ecabf2c6668318a21a85ca410112caa3b39b43b5f88cbaea5fbe3d1bd6b8ea21

data/Gemfile

@@ -125,3 +125,5 @@ gem 'meta-tags'
 gem 'breadcrumbs_on_rails'
 
 gem 'manifester'
+
+gem 'ransack'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    avo (1.4.4)
+    avo (1.4.5.pre.1)
       active_link_to
       addressable
       breadcrumbs_on_rails
@@ -14,6 +14,7 @@ PATH
       pagy
       pundit
       rails (>= 6.0)
+      ransack
       view_component
       zeitwerk
 
@@ -235,6 +236,10 @@ GEM
       thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
     rake (13.0.3)
+    ransack (2.4.2)
+      activerecord (>= 5.2.4)
+      activesupport (>= 5.2.4)
+      i18n
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
@@ -390,6 +395,7 @@ DEPENDENCIES
   pundit
   rails (~> 6.0.2, >= 6.0.2.2)
   rails-controller-testing
+  ransack
   rspec-rails (~> 4.0.0)
   ruby-debug-ide
   sass-rails (>= 6)

data/README.md

@@ -29,13 +29,13 @@ Avo is a beautiful next-generation framework that empowers you, the developer, t
   - **Actions** - Run custom actions to one or more of your resources with as little as pressing a button 💪
   - **Filters** - Write your own custom filters to quickly segment your data.
   - **Keeps your app clean** - You don't need to change your app to use Avo. Drop it in your existing app or add it to a new one and you're done 🙌
-  - **Custom fields***- No worries if we missed a field you need. Generate a custom field in a jiffy.
-  - **Dashboard widgets and metrics*** - Customize your dashboard with the tools and analytics you need.
+  - **Custom fields**- No worries if we missed a field you need. Generate a custom field in a jiffy.
   - **Custom tools** - You need to add a page with something completely new, you've got it!
   - **Authorization** - Leverage Pundit policies to build a robust and scalable authorization system.
-  - **Themable*** - Dress it up into your own colors.
-  - **Localization*** - Have it available in any language you need.
+  - **Localization** - Have it available in any language you need.
   - **No asset pipeline pollution** - Bring your own asset pipeline.
+  - **Dashboard widgets and metrics*** - Customize your dashboard with the tools and analytics you need.
+  - **Themable*** - Dress it up into your own colors.
 
 *Features still under development
 

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

@@ -22,12 +22,12 @@
   <% end %>
 
   <% c.body do %>
-    <div class="flex justify-between py-6 min-h-24"
+    <div class="flex justify-between pt-2 pb-2 min-h-16"
       data-selected-resources-name="<%= @resource.plural_name.downcase %>"
       data-selected-resources="[]"
     >
       <div class="flex items-center px-6 w-64">
-        <%# search %>
+        <%= render partial: 'avo/partials/resource_search', locals: {resource: @resource.route_key} if @resource.search_query.present? %>
       </div>
       <div class="flex justify-end items-center px-6 space-x-3">
         <%= render partial: 'avo/partials/view_toggle_button', locals: { available_view_types: available_view_types, view_type: view_type, turbo_frame: @turbo_frame } if @models.present? %>
@@ -36,7 +36,7 @@
     </div>
 
     <% if view_type.to_sym == :table %>
-      <div class="w-full overflow-auto flex flex-col">
+      <div class="w-full overflow-auto flex flex-col mt-4">
         <div class="relative flex-1 flex">
           <%= render(Avo::Index::ResourceTableComponent.new(resources: @resources, resource: @resource, reflection: @reflection, parent_model: @parent_model)) %>
         </div>

data/app/controllers/avo/application_controller.rb

@@ -17,7 +17,7 @@ module Avo
     add_flash_types :info, :warning, :success, :error
 
     def init_app
-      Avo::App.init request: request, context: context
+      Avo::App.init request: request, context: context, current_user: _current_user
 
       @license = Avo::App.license
     end
@@ -38,18 +38,25 @@ module Avo
     def render(*args)
       raise Avo::LicenseVerificationTemperedError, "License verification mechanism tempered with." unless method(:check_avo_license).source_location.first.match?(/.*\/app\/controllers\/avo\/application_controller\.rb/)
 
+      if params[:controller] == "avo/search" && params[:action] == "index"
+        raise Avo::LicenseVerificationTemperedError, "License verification mechanism tempered with." unless method(:index).source_location.first.match?(/.*\/app\/controllers\/avo\/search_controller\.rb/)
+      end
+
       super(*args)
     end
 
     def check_avo_license
+      # Check to see if the path is on a custom tool
       unless on_root_path || on_resources_path || on_api_path
-        if @license.invalid? || @license.lacks(:custom_tools)
-          if Rails.env.development?
+        # Display alert on custom tool page if in development.
+        if @license.lacks(:custom_tools) || @license.invalid?
+          if Rails.env.development? || Rails.env.test?
             @custom_tools_alert_visible = true
-          else
-            raise Avo::LicenseInvalidError, "Your license is invalid or doesn't support custom tools."
           end
         end
+
+        # Raise error in non-development environments.
+        raise Avo::LicenseInvalidError, "Your license is invalid or doesn't support custom tools." if @license.lacks_with_trial(:custom_tools)
       end
     end
 
@@ -157,9 +164,9 @@ module Avo
 
     def authorize_action
       if @model.present?
-        @authorization.set_record(@model).authorize_action :index
+        @authorization.set_record(@model).authorize_action action_name.to_sym
       else
-        @authorization.set_record(@resource.model_class).authorize_action :index
+        @authorization.set_record(@resource.model_class).authorize_action action_name.to_sym
       end
     end
 

data/app/controllers/avo/relations_controller.rb

@@ -17,7 +17,7 @@ module Avo
       @resource = @related_resource
       @parent_model = @parent_resource.model_class.find(params[:id])
       @parent_resource.hydrate(model: @parent_model)
-      @query = @parent_model.public_send(params[:related_name])
+      @query = @authorization.apply_policy @parent_model.public_send(params[:related_name])
 
       super
     end

data/app/controllers/avo/search_controller.rb

@@ -2,56 +2,71 @@ require_dependency "avo/application_controller"
 
 module Avo
   class SearchController < ApplicationController
-    # before_action :authorize_user
+    before_action :set_resource_name, only: [:show]
+    before_action :set_resource, only: [:show]
 
     def index
-      @authorization.set_record(resource_model).authorize_action :index
-      resources = []
-
-      App.resources
-        .select { |resource| resource.search.present? }
-        .select { |resource| AuthorizationService.authorize_action _current_user, resource.model, "index" }
-        .each do |resource_model|
-          found_resources = add_link_to_search_results(search_resource(resource_model), resource_model)
-          resources.push({
-            label: resource_model.name,
-            resources: found_resources
-          })
-        end
+      raise ActionController::BadRequest.new("This feature requires the pro license https://avohq.io/purchase/pro") if App.license.lacks_with_trial(:global_search)
 
-      render json: {
-        resources: resources
-      }
+      render json: search_resources(Avo::App.resources)
     end
 
-    def resource
-      render json: {
-        resources: add_link_to_search_results(search_resource(avo_resource), avo_resource)
-      }
+    def show
+      render json: search_resources([resource])
     end
 
     private
 
-    def add_link_to_search_results(resources, avo_resource)
-      resources.map do |model|
-        {
-          id: model.id,
-          search_label: model.send(avo_resource.class.title),
-          link: "/resources/#{model.class.to_s.singularize.underscore}/#{model.id}"
-        }
+    def search_resources(resources)
+      resources.map do |resource|
+        # Apply authorization
+        next unless @authorization.set_record(resource.model_class).authorize_action(:index, raise_exception: false)
+        # Filter out the models without a search_query
+        next if resource.search_query.nil?
+
+        search_resource resource
       end
+        .select do |payload|
+          payload.present?
+        end
+        .sort do |payload|
+          payload.last[:count]
+        end
+        .reverse
+        .to_h
     end
 
-    def search_resource(avo_resource)
-      avo_resource.query_search(query: params[:q], via_resource_name: params[:via_resource_name], via_resource_id: params[:via_resource_id], user: _current_user)
+    def search_resource(resource)
+      results = apply_search_metadata(resource.search_query.call(params: params).limit(8), resource)
+
+      result_object = {
+        header: resource.name.pluralize,
+        results: results,
+        count: results.length
+      }
+
+      [resource.name.pluralize.downcase, result_object]
     end
 
-    # def authorize_user
-    #   return if params[:action] == 'index'
+    def apply_search_metadata(models, avo_resource)
+      models.map do |model|
+        resource = avo_resource.dup.hydrate(model: model).hydrate_fields(model: model)
 
-    #   action = params[:action] == 'resource' ? :index : params[:action]
+        result = {
+          _id: model.id,
+          _label: resource.label,
+          _url: resource.avo_path,
+          model: model
+        }
 
-    #   return render_unauthorized unless AuthorizationService::authorize_action _current_user, avo_resource.model, action
-    # end
+        if App.license.has_with_trial(:enhanced_search_results)
+          result[:_description] = resource.description
+          result[:_avatar] = resource.avatar
+          result[:_avatar_type] = resource.avatar_type
+        end
+
+        result
+      end
+    end
   end
 end

data/app/packs/entrypoints/application.css

@@ -4,7 +4,7 @@
 @import './../../../node_modules/tippy.js/themes/light.css';
 @import './../../../node_modules/trix/dist/trix.css';
 @import './../../../node_modules/flatpickr/dist/flatpickr.css';
-
+@import './../../../node_modules/@algolia/autocomplete-theme-classic/dist/theme.css';
 
 @import './../stylesheets/tailwindcss/base.css';
 
@@ -15,6 +15,7 @@
 @import './../stylesheets/loader.css';
 @import './../stylesheets/pagination.css';
 @import './../stylesheets/breadcrumbs.css';
+@import './../stylesheets/search.css';
 
 @import './../stylesheets/components/status.css';
 @import './../stylesheets/components/code.css';

data/app/packs/entrypoints/application.js

@@ -45,6 +45,9 @@ document.addEventListener('turbo:load', () => {
 })
 document.addEventListener('turbo:visit', () => document.body.classList.add('turbo-loading'))
 document.addEventListener('turbo:submit-start', () => document.body.classList.add('turbo-loading'))
+document.addEventListener('turbo:before-cache', () => {
+  document.querySelectorAll('[data-turbo-remove-before-cache]').forEach((element) => element.remove())
+})
 
 // Uncomment to copy all static images under ../images to the output folder and reference
 // them with the image_pack_tag helper in views (e.g <%= image_pack_tag 'rails.png' %>)

data/app/packs/js/controllers/search_controller.js

@@ -0,0 +1,120 @@
+/* eslint-disable no-underscore-dangle */
+import * as Mousetrap from 'mousetrap'
+import { Controller } from 'stimulus'
+import { Turbo } from '@hotwired/turbo-rails'
+import { autocomplete } from '@algolia/autocomplete-js'
+import debouncePromise from '@/js/helpers/debounce_promise'
+
+export default class extends Controller {
+  static targets = ['autocomplete', 'button']
+
+  debouncedFetch = debouncePromise(fetch, this.debounceTimeout)
+
+  get translationKeys() {
+    let keys
+    try {
+      keys = JSON.parse(this.autocompleteTarget.dataset.translationKeys)
+    } catch (error) {
+      keys = {}
+    }
+
+    return keys
+  }
+
+  get debounceTimeout() {
+    return this.autocompleteTarget.dataset.debounceTimeout
+  }
+
+  get searchResource() {
+    return this.autocompleteTarget.dataset.searchResource
+  }
+
+  get isGlobalSearch() {
+    return this.searchResource === 'global'
+  }
+
+  get searchUrl() {
+    return this.isGlobalSearch ? '/avo/avo_api/search' : `/avo/avo_api/${this.searchResource}/search`
+  }
+
+  addSource(resourceName, data) {
+    const that = this
+
+    return {
+      sourceId: resourceName,
+      getItems: () => data.results,
+      onSelect({ item }) {
+        Turbo.visit(item._url, { action: 'replace' })
+      },
+      templates: {
+        header() {
+          return data.header
+        },
+        item({ item, createElement }) {
+          let element = ''
+
+          if (item._avatar) {
+            let classes
+
+            switch (item._avatar_type) {
+              default:
+              case 'circle':
+                classes = 'rounded-full'
+                break
+              case 'rounded':
+                classes = 'rounded'
+                break
+            }
+
+            element += `<img src="${item._avatar}" alt="${item._label}" class="flex-shrink-0 w-8 h-8 my-[2px] inline mr-2 ${classes}" />`
+          }
+          element += `<div>${item._label}`
+
+          if (item._description) {
+            element += `<div class="aa-ItemDescription">${item._description}</div>`
+          }
+
+          element += '</div>'
+
+          return createElement('div', {
+            class: 'flex',
+            dangerouslySetInnerHTML: {
+              __html: element,
+            },
+          })
+        },
+        noResults() {
+          return that.translationKeys.no_item_found.replace('%{item}', resourceName)
+        },
+      },
+    }
+  }
+
+  showSearchPanel() {
+    this.autocompleteTarget.querySelector('button').click()
+  }
+
+  connect() {
+    const that = this
+
+    this.buttonTarget.onclick = () => this.showSearchPanel()
+
+    if (this.isGlobalSearch) {
+      Mousetrap.bind(['command+k', 'ctrl+k'], () => this.showSearchPanel())
+    }
+
+    autocomplete({
+      container: this.autocompleteTarget,
+      placeholder: 'Search',
+      openOnFocus: true,
+      detachedMediaQuery: '',
+      getSources: ({ query }) => {
+        const endpoint = `${that.searchUrl}?q=${query}`
+
+        return that.debouncedFetch(endpoint)
+          .then((response) => response.json())
+          .then((data) => Object.keys(data).map((resourceName) => that.addSource(resourceName, data[resourceName])))
+      },
+    })
+  }
+}

data/app/packs/js/helpers/debounce_promise.js

@@ -0,0 +1,13 @@
+export default (fn, time) => {
+  let timerId
+
+  return (...args) => {
+    if (timerId) {
+      clearTimeout(timerId)
+    }
+
+    return new Promise((resolve) => {
+      timerId = setTimeout(() => resolve(fn(...args)), time)
+    })
+  }
+}

data/app/packs/stylesheets/search.css

@@ -0,0 +1,79 @@
+:root {
+  --aa-primary-color: --tw-ring-color;
+  --aa-selected-color: --tw-ring-color;
+  --aa-primary-color-rgb: 5, 150, 105;
+}
+
+.global-search {
+  .aa-DetachedSearchButton:focus,
+  .aa-DetachedSearchButton {
+    border: none !important;
+  }
+}
+
+.resource-search {
+  .aa-Autocomplete {
+    @apply w-full;
+  }
+
+  .aa-DetachedSearchButton {
+    @apply rounded-full border-gray-300;
+  }
+}
+
+.aa-SourceHeader {
+  @apply uppercase text-xs font-semibold;
+}
+
+.aa-DetachedFormContainer,
+.aa-DetachedContainer .aa-Panel {
+  @apply bg-blue-gray-100 border-b-0;
+}
+
+.aa-Form {
+  &:focus-within {
+    @apply ring-0 !important;
+  }
+
+  input {
+    @apply focus:ring-0 !important;
+  }
+  &:focus-within {
+    .aa-InputWrapperPrefix{
+      .aa-SubmitButton {
+        @apply ring-0;
+      }
+    }
+  }
+}
+.aa-Input {
+  @apply focus:ring-green-600;
+}
+
+.aa-DetachedContainer {
+  .aa-PanelLayout {
+    @apply pt-0 space-y-3;
+  }
+
+  .aa-Source {
+    .aa-List {
+      @apply space-y-1;
+
+      .aa-Item {
+        @apply bg-white rounded-md px-3 py-4 shadow;
+
+        .aa-ItemDescription {
+          @apply text-gray-500 text-sm;
+        }
+
+        &[aria-selected=true]{
+          @apply bg-blue-700 text-white;
+
+          .aa-ItemDescription {
+            @apply text-white;
+          }
+        }
+      }
+    }
+  }
+}