avo 2.0.0 → 2.1.2.pre1

data/app/controllers/avo/search_controller.rb

@@ -10,7 +10,11 @@ module Avo
     def index
       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: search_resources(Avo::App.resources)
+      resources = Avo::App.resources.reject do |resource|
+        resource.class.hide_from_global_search
+      end
+
+      render json: search_resources(resources)
     end
 
     def show

data/app/helpers/avo/url_helpers.rb

@@ -12,8 +12,12 @@ module Avo
         end
       end
 
-      # This entry uses `route_key` instead of `model_key` because it's rails that needs `fish_index` to build the correct path
-      avo.send :"resources_#{resource.route_key}_path", **existing_params, **args
+      # Create the `route_key` from the model key so the namespaced models get the proper path (SomeModule::Post -> some_module_post).
+      # Add the `_index` suffix for the uncountable models so they get the correct path (`fish_index`)
+      route_key = resource.model_key
+      route_key << "_index" if resource.model_name.singular == resource.model_name.plural
+
+      avo.send :"resources_#{route_key}_path", **existing_params, **args
     end
 
     def resource_path(

data/app/javascript/avo.js

@@ -71,12 +71,13 @@ document.addEventListener('turbo:frame-load', () => {
   initTippy()
 })
 
-document.addEventListener('turbo:before-fetch-response', (e) => {
+document.addEventListener('turbo:before-fetch-response', async (e) => {
   if (e.detail.fetchResponse.response.status === 500) {
-    const id = e.srcElement.getAttribute('id')
-    e.srcElement.src = `${window.Avo.configuration.root_path}/failed_to_load?turbo_frame=${id}`
+    const { id, src } = e.target
+    e.target.src = `${window.Avo.configuration.root_path}/failed_to_load?turbo_frame=${id}&src=${src}`
   }
 })
+
 document.addEventListener('turbo:visit', () => document.body.classList.add('turbo-loading'))
 document.addEventListener('turbo:submit-start', () => document.body.classList.add('turbo-loading'))
 document.addEventListener('turbo:submit-end', () => document.body.classList.remove('turbo-loading'))

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

@@ -10,6 +10,7 @@
     <%= form_with model: @model,
       scope: 'fields',
       url: "#{@resource.records_path}/actions/#{@action.param_id}",
+      local: true,
       data: @action.class.form_data_attributes do |form|
     %>
     <%= render Avo::ModalComponent.new do |c| %>

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

@@ -1,6 +1,7 @@
 <%= turbo_frame_tag 'attach_modal' do %>
   <%= form_with scope: 'fields',
     url: "#{avo.root_path}resources/#{params[:resource_name]}/#{params[:id]}/#{params[:related_name]}/",
+    local: true,
     data: {
       'turbo-frame': '_top'
     } do |form| %>

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

@@ -8,7 +8,10 @@
               <%= render Avo::Dashboards::DividerComponent.new(divider: item) %>
             <% elsif item.is_card? %>
               <%= content_tag(:div, class: "relative bg-white rounded shadow-panel space-y-2 #{item.card_classes} overflow-hidden") do %>
-                <turbo-frame id="<%= item.turbo_frame %>" src="<%= item.frame_url(enforced_range: @range) %>">
+                <turbo-frame id="<%= item.turbo_frame %>"
+                  src="<%= item.frame_url(enforced_range: @range, params: params) %>"
+                  data-card-index="<%= item.index %>"
+                >
                   <%= render(Avo::LoadingComponent.new(title: item.label)) %>
                 </turbo-frame>
               <% end %>

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

@@ -1,3 +1,23 @@
 <%= turbo_frame_wrap(params[:turbo_frame]) do %>
-  <%= render 'avo/partials/failed_state' %>
+  <%
+  classes = 'absolute inset-auto left-1/2 top-1/2 transform -translate-x-1/2 -translate-y-1/2'
+  label = t 'avo.failed_to_load'
+%>
+  <div class="relative flex-1 py-12">
+    <div class="relative block text-gray-300 h-40 w-full">
+      <%= svg 'avocado', class: "#{classes} h-20 text-gray-400" %>
+      <%= svg 'code', class: "#{classes} h-8 -ml-20 -mt-12" %>
+      <%= svg 'fire', class: "#{classes} h-8 -ml-10 -mt-24" %>
+      <%= svg 'color-swatch', class: "#{classes} h-8 ml-8 -mt-24" %>
+      <%= svg 'globe', class: "#{classes} h-8 ml-20 -mt-12" %>
+      <%= svg 'library', class: "#{classes} h-8 -ml-20 mt-4" %>
+      <%= svg 'photograph', class: "#{classes} h-8 ml-20 mt-4" %>
+    </div>
+    <div class="relative block text-center text-lg text-gray-400 font-semibold -mt-10"><%= label %> <span class="border-b-2 border-dashed"><%= params[:turbo_frame].to_s.humanize.downcase if params[:turbo_frame].present? %></span> frame</div>
+  </div>
+  <% if Rails.env.development? %>
+    <div class="text-center text-sm w-full">
+      This is not an issue with Avo. Click <%= link_to 'this link', params[:src], target: :_blank %> to see why this frame failed to load.
+    </div>
+  <% end %>
 <% end %>

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

@@ -42,6 +42,13 @@
 
 <%= turbo_frame_tag 'alerts', class: "fixed inset-0 bottom-0 flex flex-col space-y-4 items-end justify-right px-4 py-6 sm:p-6 justify-end z-50 pointer-events-none" do %>
   <%= render Avo::FlashAlertsComponent.new flashes: flash %>
+
+  <% # In case we have other general error messages %>
+  <% if @errors.present? %>
+    <% @errors.each do |message| %>
+      <%= render Avo::AlertComponent.new :error, message %>
+    <% end %>
+  <% end %>
 <% end %>
 
 <%= render partial: "avo/partials/scripts" %>

data/bin/dev

@@ -1,9 +1,10 @@
 #!/usr/bin/env bash
 
-if ! command -v foreman &> /dev/null
-then
-  echo "Installing foreman..."
-  gem install foreman
-fi
+PORT="${PORT:-3030}"
+export PORT
 
-foreman start -f Procfile.dev
+if command -v overmind &> /dev/null; then
+  overmind start -f Procfile.dev "$@"
+else
+  foreman start -f Procfile.dev "$@"
+fi

data/lib/avo/app.rb

@@ -10,6 +10,8 @@ module Avo
     class_attribute :current_user, default: nil
     class_attribute :root_path, default: nil
     class_attribute :view_context, default: nil
+    class_attribute :params, default: {}
+    class_attribute :translation_enabled, default: false
 
     class << self
       def boot
@@ -24,14 +26,16 @@ module Avo
         end
       end
 
-      def init(request:, context:, current_user:, root_path:, view_context:)
+      def init(request:, context:, current_user:, root_path:, view_context:, params:)
         self.request = request
         self.context = context
         self.current_user = current_user
         self.root_path = root_path
         self.view_context = view_context
+        self.params = params
 
         self.license = Licensing::LicenseManager.new(Licensing::HQ.new(request).response).license
+        self.translation_enabled = license.has(:localization)
 
         # Set the current host for ActiveStorage
         begin
@@ -89,6 +93,9 @@ module Avo
           .select do |dashboard|
             dashboard != Dashboards::BaseDashboard
           end
+          .uniq do |dashboard|
+            dashboard.id
+          end
       end
 
       # Returns the Avo dashboard by id

data/lib/avo/base_action.rb

@@ -13,6 +13,7 @@ module Avo
     class_attribute :user
     class_attribute :resource
     class_attribute :fields
+    class_attribute :invalid_fields
     class_attribute :standalone, default: false
     class_attribute :visible
     class_attribute :may_download_file, default: false
@@ -27,16 +28,16 @@ module Avo
       def form_data_attributes
         # We can't respond with a file download from Turbo se we disable it on the form
         if may_download_file
-          { 'turbo': false }
+          {turbo: false, remote: false}
         else
-          { 'turbo-frame': '_top', 'action-target': 'form' }
+          {"turbo-frame": "_top", "action-target": "form"}
         end
       end
 
       # We can't respond with a file download from Turbo se we disable close the modal manually after a while (it's a hack, we know)
       def submit_button_data_attributes
         if may_download_file
-          { action: 'click->modal#delayedClose' }
+          {action: "click->modal#delayedClose"}
         else
           {}
         end
@@ -109,7 +110,7 @@ module Avo
       args = {
         fields: processed_fields,
         current_user: current_user,
-        resource: resource,
+        resource: resource
       }
 
       args[:models] = models unless standalone

data/lib/avo/base_card.rb

@@ -0,0 +1,175 @@
+module Avo
+  class BaseCard
+    class_attribute :id
+    class_attribute :label
+    class_attribute :description
+    class_attribute :cols, default: 1
+    class_attribute :rows, default: 1
+    class_attribute :initial_range
+    class_attribute :ranges, default: []
+    class_attribute :refresh_every
+    class_attribute :display_header, default: true
+    # private
+    class_attribute :result_data
+    class_attribute :query_block
+
+    attr_accessor :dashboard
+    attr_accessor :options
+    attr_accessor :index
+    attr_accessor :params
+
+    delegate :context, to: ::Avo::App
+
+    class << self
+      def query(&block)
+        self.query_block = block
+      end
+    end
+
+    def initialize(dashboard:, options: {}, index: 0, cols: nil, rows: nil, label: nil, description: nil, refresh_every: nil)
+      @dashboard = dashboard
+      @options = options
+      @index = index
+      @cols = cols
+      @rows = rows
+      @label = label
+      @refresh_every = refresh_every
+      @description = description
+    end
+
+    def label
+      return @label.to_s if @label.present?
+      return self.class.label.to_s if self.class.label.present?
+
+      self.class.id.to_s.humanize
+    end
+
+    def description
+      @description || self.class.description
+    end
+
+    def refresh_every
+      @refresh_every || self.class.refresh_every
+    end
+
+    def translated_range(range)
+      return "#{range} days" if range.is_a? Integer
+
+      case range
+      when "MTD"
+        "Month to date"
+      when "QTD"
+        "Quarter to date"
+      when "YTD"
+        "Year to date"
+      when "TODAY"
+        "Today"
+      else
+        range
+      end
+    end
+
+    def parsed_ranges
+      return unless ranges.present?
+
+      ranges.map { |range| [translated_range(range), range] }
+    end
+
+    def turbo_frame
+      "#{dashboard.id}_#{id}"
+    end
+
+    def frame_url(enforced_range: nil, params: {})
+      enforced_range ||= initial_range || ranges.first
+
+      # append the parent params to the card request
+      begin
+        other_params = "&#{params.permit!.to_h.map { |k, v| "#{k}=#{v}" }.join("&")}"
+      rescue
+      end
+
+      "#{Avo::App.root_path}/dashboards/#{dashboard.id}/cards/#{id}?turbo_frame=#{turbo_frame}&index=#{index}&range=#{enforced_range}#{other_params}"
+    end
+
+    def card_classes
+      result = ""
+
+      # Writing down the classes so TailwindCSS knows not to purge them
+      classes_for_cols = {
+        1 => " sm:col-span-1",
+        2 => " sm:col-span-2",
+        3 => " sm:col-span-3",
+        4 => " sm:col-span-4",
+        5 => " sm:col-span-5",
+        6 => " sm:col-span-6"
+      }
+
+      classes_for_rows = {
+        1 => " h-36",
+        2 => " h-72",
+        3 => " h-[27rem]",
+        4 => " h-[36rem]",
+        5 => " h-[45rem]",
+        6 => " h-[54rem]"
+      }
+      # puts ["cols->", cols, classes_for_cols, classes_for_rows, classes_for_cols[cols.to_i]].inspect
+
+      result += classes_for_cols[cols.to_i] if classes_for_cols[cols.to_i].present?
+      result += classes_for_rows[rows.to_i] if classes_for_rows[rows.to_i].present?
+
+      result
+    end
+
+    def type
+      return :metric if self.class.superclass == ::Avo::Dashboards::MetricCard
+      return :chartkick if self.class.superclass == ::Avo::Dashboards::ChartkickCard
+      return :partial if self.class.superclass == ::Avo::Dashboards::PartialCard
+    end
+
+    def compute_result
+      Avo::Hosts::DashboardCard.new(card: self, dashboard: dashboard, params: params, context: context, range: range, options: options)
+        .compute_result
+
+      self
+    end
+
+    def hydrate(dashboard: nil, params: nil)
+      @dashboard = dashboard if dashboard.present?
+      @params = params if params.present?
+
+      self
+    end
+
+    def range
+      return params[:range] if params.dig(:range).present?
+
+      return initial_range if initial_range.present?
+
+      ranges.first
+    end
+
+    def result(data)
+      self.result_data = data
+
+      self
+    end
+
+    def is_card?
+      true
+    end
+
+    def is_divider?
+      false
+    end
+
+    private
+
+    def cols
+      @cols || self.class.cols
+    end
+
+    def rows
+      @rows || self.class.rows
+    end
+  end
+end

data/lib/avo/base_resource.rb

@@ -11,6 +11,7 @@ module Avo
     delegate :avo, to: :view_context
     delegate :resource_path, to: :view_context
     delegate :resources_path, to: :view_context
+    delegate :t, to: ::I18n
 
     attr_accessor :view
     attr_accessor :model
@@ -26,7 +27,7 @@ module Avo
     class_attribute :includes, default: []
     class_attribute :model_class
     class_attribute :translation_key
-    class_attribute :translation_enabled
+    class_attribute :translation_enabled, default: false
     class_attribute :default_view_type, default: :table
     class_attribute :devise_password_optional, default: false
     class_attribute :actions_loader
@@ -38,8 +39,14 @@ module Avo
     class_attribute :resolve_query_scope
     class_attribute :resolve_find_scope
     class_attribute :ordering
+    class_attribute :hide_from_global_search, default: false
+    class_attribute :after_create_path, default: :show
+    class_attribute :after_update_path, default: :show
+    class_attribute :invalid_fields
 
     class << self
+      delegate :t, to: ::I18n
+
       def grid(&block)
         grid_collector = GridCollector.new
         grid_collector.instance_eval(&block)
@@ -96,6 +103,8 @@ module Avo
           self.class.model_class = model_class.base_class
         end
       end
+
+      self.class.translation_enabled = ::Avo::App.translation_enabled
     end
 
     def hydrate(model: nil, view: nil, user: nil, params: nil)
@@ -215,7 +224,7 @@ module Avo
       when :edit
         model_title
       when :new
-        I18n.t("avo.create_new_item", item: name.downcase).upcase_first
+        t("avo.create_new_item", item: name.downcase).upcase_first
       end
     end
 
@@ -244,9 +253,18 @@ module Avo
       class_name_without_resource.safe_constantize
     end
 
+    def model_id
+      @model.send id
+    end
+
     def model_title
-      return @model.send title if @model.present?
+      return name if @model.nil?
+
+      the_title = @model.send title
+      return the_title if the_title.present?
 
+      model_id
+    rescue
       name
     end
 
@@ -267,11 +285,13 @@ module Avo
     end
 
     def name
+      default = class_name_without_resource.titlecase
+
       return @name if @name.present?
 
-      return I18n.t(translation_key, count: 1).capitalize if translation_key
+      return t(translation_key, count: 1, default: default).capitalize if translation_key
 
-      class_name_without_resource.titlecase
+      default
     end
 
     def singular_name
@@ -279,9 +299,11 @@ module Avo
     end
 
     def plural_name
-      return I18n.t(translation_key, count: 2).capitalize if translation_key
+      default = name.pluralize
+
+      return t(translation_key, count: 2, default: default).capitalize if translation_key
 
-      name.pluralize
+      default
     end
 
     def underscore_name
@@ -408,11 +430,15 @@ module Avo
     # This is used as the model class ID
     # We use this instead of the route_key to maintain compatibility with uncountable models
     # With uncountable models route key appends an _index suffix (Fish->fish_index)
-    # Example: User->users, MediaItem->medie_items, Fish->fish
+    # Example: User->users, MediaItem->media_items, Fish->fish
     def model_key
       model_class.model_name.plural
     end
 
+    def model_name
+      model_class.model_name
+    end
+
     def singular_model_key
       model_class.model_name.singular
     end

data/lib/avo/configuration.rb

@@ -28,6 +28,7 @@ module Avo
     attr_accessor :current_user_resource_name
     attr_accessor :raise_error_on_missing_policy
     attr_accessor :disabled_features
+    attr_accessor :buttons_on_form_footers
 
     def initialize
       @root_path = "/avo"
@@ -68,6 +69,7 @@ module Avo
       @current_user_resource_name = "user"
       @raise_error_on_missing_policy = false
       @disabled_features = []
+      @buttons_on_form_footers = false
     end
 
     def locale_tag

data/lib/avo/dashboards/base_dashboard.rb

@@ -8,12 +8,31 @@ module Avo
       class_attribute :description
       class_attribute :items_holder
       class_attribute :grid_cols, default: 3
+      class_attribute :visible, default: true
+      class_attribute :index, default: 0
 
       class << self
-        def card(klass)
+        def card(klass, label: nil, description: nil, cols: nil, rows: nil, refresh_every: nil, options: {})
           self.items_holder ||= []
 
-          self.items_holder << klass.new(dashboard: self)
+          self.items_holder << klass.new(dashboard: self,
+            label: label,
+            description: description,
+            cols: cols,
+            rows: rows,
+            refresh_every: refresh_every,
+            options: options,
+            index: index
+          )
+          self.index += 1
+        end
+
+        def item_at_index(index)
+          items.find do |item|
+            next if item.index.blank?
+
+            item.index == index
+          end
         end
 
         def divider(**args)
@@ -48,6 +67,22 @@ module Avo
         def navigation_path
           "#{Avo::App.root_path}/dashboards/#{id}"
         end
+
+        def is_visible?
+          # Default is true
+          return true if visible == true
+
+          # Hide if false
+          return false if visible == false
+
+          if visible.respond_to? :call
+            ::Avo::Hosts::DashboardVisibility.new(block: visible, dashboard: self).handle
+          end
+        end
+
+        def is_hidden?
+          !is_visible?
+        end
       end
     end
   end

data/lib/avo/dashboards/base_divider.rb

@@ -3,12 +3,14 @@ module Avo
     class BaseDivider
       attr_reader :label
       attr_reader :invisible
+      attr_reader :index
 
       class_attribute :id
 
-      def initialize(label: nil, invisible: false)
+      def initialize(label: nil, invisible: false, index: nil)
         @label = label
         @invisible = invisible
+        @index = index
       end
 
       def is_divider?

data/lib/avo/dashboards/chartkick_card.rb

@@ -24,7 +24,7 @@ module Avo
 
       def chartkick_options
         card_height = 144
-        card_heading = 32
+        card_heading = 40
 
         default = {
           # figure our the available height for the chart

data/lib/avo/dashboards/dashboard_card.rb

@@ -0,0 +1,6 @@
+module Avo
+  module Dashboards
+    class DashboardCard < Avo::BaseCard
+    end
+  end
+end

data/lib/avo/dashboards/partial_card.rb

@@ -1,6 +1,6 @@
 module Avo
   module Dashboards
-    class PartialCard < BaseCard
+    class PartialCard < Avo::BaseCard
       class_attribute :partial
     end
   end

data/lib/avo/fields/base_field.rb

@@ -10,6 +10,7 @@ module Avo
       delegate :view_context, to: "Avo::App"
       delegate :main_app, to: :view_context
       delegate :avo, to: :view_context
+      delegate :t, to: ::I18n
 
       attr_reader :id
       attr_reader :block
@@ -48,7 +49,7 @@ module Avo
         @id = id
         @name = args[:name]
         @translation_key = args[:translation_key]
-        @translation_enabled = false
+        @translation_enabled = ::Avo::App.translation_enabled
         @block = block
         @required = args[:required] || false
         @readonly = args[:readonly] || false
@@ -94,18 +95,26 @@ module Avo
         @translation_key
       end
 
+      # Getting the name of the resource (user/users, post/posts)
+      # We'll first check to see if the user passed a name
+      # Secondly we'll try to find a translation key
+      # We'll fallback to humanizing the id
       def name
+        default = @id.to_s.humanize(keep_id_suffix: true)
+
         return @name if @name.present?
 
-        return I18n.t(translation_key, count: 1).capitalize if translation_key
+        return t(translation_key, count: 1, default: default).capitalize if translation_key
 
-        @id.to_s.humanize(keep_id_suffix: true)
+        default
       end
 
       def plural_name
-        return I18n.t(translation_key, count: 2).capitalize if translation_key
+        default = name.pluralize
+
+        return t(translation_key, count: 2, default: default).capitalize if translation_key
 
-        name.pluralize
+        default
       end
 
       def placeholder
@@ -181,8 +190,12 @@ module Avo
         "#{type.camelize}Field"
       end
 
+      # Try and build the component class or fallback to a blank one
       def component_for_view(view = :index)
-        "Avo::Fields::#{view_component_name}::#{view.to_s.camelize}Component".safe_constantize
+        component_class = "::Avo::Fields::#{view_component_name}::#{view.to_s.camelize}Component"
+        component_class.constantize
+      rescue
+        ::Avo::BlankFieldComponent
       end
 
       def model_errors