avo 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34b59ecbd2212946c019ba83f43b8ffa86a4d40bc38e0911a6c5b338e8619350
-  data.tar.gz: 9f8d64af9b098b7cae3eb965d1b2145f41ba99d930e2fe34c7983b9c6d72e6d7
+  metadata.gz: 4c18a2259ce520af87a947e167a6410e9accb3190e323ecf7c5403f8f65bdec5
+  data.tar.gz: 0d04edf92b4bc3f59b3be0281f61ecba66a04a897e6528ae03276df034c26c94
 SHA512:
-  metadata.gz: 0134d6c61098b2d2ff8413253e69e5f050bfb4c73c692cade5f37b75e479b6577f3a9dff4996da8dd803e00ce85a2a805d2094d2650f0d6606366cf585234ee7
-  data.tar.gz: 8c3ea3599a893a33d1fcf6f4362effccab54fc906edfcbcc3638140d0a375117000de36f49c87ce59a50667e1125c9d313503716cb2f2301c5284eda86ee0389
+  metadata.gz: 0ddda49d846aa932c91acadfd88a917238efdbcd5b695ca8cafe25267ede23c4c52bf4758ba262a5ee45acfd83a243f77d3b32123c5113accb13b470867ae877
+  data.tar.gz: 2d8885cded2d11d46197248baf1fb2bb4aa5bbe349d129e810d24a8f58841db0e9a94d554f17f4cbd28fe08f4933fb5e0a9316ce12fe82259dfd2b6536a663ba

data/Gemfile

@@ -100,6 +100,7 @@ group :test do
   gem "simplecov-cobertura"
   gem "webmock"
   gem "spring-commands-rspec"
+  gem "launchy", require: false
 
   gem "test-prof"
 end
@@ -125,3 +126,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.2)
+    avo (1.5.0)
       active_link_to
       addressable
       breadcrumbs_on_rails
@@ -14,44 +14,45 @@ PATH
       pagy
       pundit
       rails (>= 6.0)
+      ransack
       view_component
       zeitwerk
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.3.6)
-      actionpack (= 6.0.3.6)
+    actioncable (6.0.3.7)
+      actionpack (= 6.0.3.7)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.3.6)
-      actionpack (= 6.0.3.6)
-      activejob (= 6.0.3.6)
-      activerecord (= 6.0.3.6)
-      activestorage (= 6.0.3.6)
-      activesupport (= 6.0.3.6)
+    actionmailbox (6.0.3.7)
+      actionpack (= 6.0.3.7)
+      activejob (= 6.0.3.7)
+      activerecord (= 6.0.3.7)
+      activestorage (= 6.0.3.7)
+      activesupport (= 6.0.3.7)
       mail (>= 2.7.1)
-    actionmailer (6.0.3.6)
-      actionpack (= 6.0.3.6)
-      actionview (= 6.0.3.6)
-      activejob (= 6.0.3.6)
+    actionmailer (6.0.3.7)
+      actionpack (= 6.0.3.7)
+      actionview (= 6.0.3.7)
+      activejob (= 6.0.3.7)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.3.6)
-      actionview (= 6.0.3.6)
-      activesupport (= 6.0.3.6)
+    actionpack (6.0.3.7)
+      actionview (= 6.0.3.7)
+      activesupport (= 6.0.3.7)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.3.6)
-      actionpack (= 6.0.3.6)
-      activerecord (= 6.0.3.6)
-      activestorage (= 6.0.3.6)
-      activesupport (= 6.0.3.6)
+    actiontext (6.0.3.7)
+      actionpack (= 6.0.3.7)
+      activerecord (= 6.0.3.7)
+      activestorage (= 6.0.3.7)
+      activesupport (= 6.0.3.7)
       nokogiri (>= 1.8.5)
-    actionview (6.0.3.6)
-      activesupport (= 6.0.3.6)
+    actionview (6.0.3.7)
+      activesupport (= 6.0.3.7)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
@@ -59,20 +60,20 @@ GEM
     active_link_to (1.0.5)
       actionpack
       addressable
-    activejob (6.0.3.6)
-      activesupport (= 6.0.3.6)
+    activejob (6.0.3.7)
+      activesupport (= 6.0.3.7)
       globalid (>= 0.3.6)
-    activemodel (6.0.3.6)
-      activesupport (= 6.0.3.6)
-    activerecord (6.0.3.6)
-      activemodel (= 6.0.3.6)
-      activesupport (= 6.0.3.6)
-    activestorage (6.0.3.6)
-      actionpack (= 6.0.3.6)
-      activejob (= 6.0.3.6)
-      activerecord (= 6.0.3.6)
+    activemodel (6.0.3.7)
+      activesupport (= 6.0.3.7)
+    activerecord (6.0.3.7)
+      activemodel (= 6.0.3.7)
+      activesupport (= 6.0.3.7)
+    activestorage (6.0.3.7)
+      actionpack (= 6.0.3.7)
+      activejob (= 6.0.3.7)
+      activerecord (= 6.0.3.7)
       marcel (~> 1.0.0)
-    activesupport (6.0.3.6)
+    activesupport (6.0.3.7)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -156,6 +157,8 @@ GEM
       i18n
     jbuilder (2.10.1)
       activesupport (>= 5.0.0)
+    launchy (2.5.0)
+      addressable (~> 2.7)
     listen (3.5.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
@@ -176,7 +179,7 @@ GEM
     mime-types-data (3.2021.0225)
     mini_magick (4.11.0)
     mini_mime (1.1.0)
-    mini_portile2 (2.5.0)
+    mini_portile2 (2.5.1)
     minitest (5.14.4)
     msgpack (1.4.2)
     multi_xml (0.6.0)
@@ -203,20 +206,20 @@ GEM
       rack
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.0.3.6)
-      actioncable (= 6.0.3.6)
-      actionmailbox (= 6.0.3.6)
-      actionmailer (= 6.0.3.6)
-      actionpack (= 6.0.3.6)
-      actiontext (= 6.0.3.6)
-      actionview (= 6.0.3.6)
-      activejob (= 6.0.3.6)
-      activemodel (= 6.0.3.6)
-      activerecord (= 6.0.3.6)
-      activestorage (= 6.0.3.6)
-      activesupport (= 6.0.3.6)
+    rails (6.0.3.7)
+      actioncable (= 6.0.3.7)
+      actionmailbox (= 6.0.3.7)
+      actionmailer (= 6.0.3.7)
+      actionpack (= 6.0.3.7)
+      actiontext (= 6.0.3.7)
+      actionview (= 6.0.3.7)
+      activejob (= 6.0.3.7)
+      activemodel (= 6.0.3.7)
+      activerecord (= 6.0.3.7)
+      activestorage (= 6.0.3.7)
+      activesupport (= 6.0.3.7)
       bundler (>= 1.3.0)
-      railties (= 6.0.3.6)
+      railties (= 6.0.3.7)
       sprockets-rails (>= 2.0.0)
     rails-controller-testing (1.0.5)
       actionpack (>= 5.0.1.rc1)
@@ -227,14 +230,18 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.3.6)
-      actionpack (= 6.0.3.6)
-      activesupport (= 6.0.3.6)
+    railties (6.0.3.7)
+      actionpack (= 6.0.3.7)
+      activesupport (= 6.0.3.7)
       method_source
       rake (>= 0.8.7)
       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)
@@ -242,7 +249,7 @@ GEM
     responders (3.0.1)
       actionpack (>= 5.0)
       railties (>= 5.0)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec-core (3.9.2)
       rspec-support (~> 3.9.3)
     rspec-expectations (3.9.2)
@@ -382,6 +389,7 @@ DEPENDENCIES
   image_processing (~> 1.2)
   iso
   jbuilder (~> 2.7)
+  launchy
   listen (>= 3.5.1)
   manifester
   meta-tags
@@ -390,6 +398,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)
@@ -409,4 +418,4 @@ DEPENDENCIES
   zeitwerk (~> 2.3)
 
 BUNDLED WITH
-   2.2.11
+   2.2.17

data/README.md

@@ -24,18 +24,19 @@ Avo is a beautiful next-generation framework that empowers you, the developer, t
   - **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.
+  - **Resource Search** - Quickly run a search through one or more resources at once.
   - **Active Storage support** - Amazingly easy, **one-line**, single or multi-file integration with **ActiveStorage**.
   - **Grid view** - Beautiful card layout to showcase your content.
   - **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