avo 2.18.1 → 2.20.0

data/lib/avo/base_action.rb

@@ -19,6 +19,7 @@ module Avo
     attr_accessor :model
     attr_accessor :resource
     attr_accessor :user
+    attr_reader :arguments
 
     delegate :view, to: :class
     delegate :context, to: ::Avo::App
@@ -34,9 +35,9 @@ 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, remote: false}
+          {turbo: false, remote: false, action_target: :form}
         else
-          {"turbo-frame": "_top", "action-target": "form"}
+          {turbo_frame: :_top, action_target: :form}
         end
       end
 
@@ -56,11 +57,12 @@ module Avo
       self.class.to_s.demodulize.underscore.humanize(keep_id_suffix: true)
     end
 
-    def initialize(model: nil, resource: nil, user: nil, view: nil)
+    def initialize(model: nil, resource: nil, user: nil, view: nil, arguments: {})
       self.class.model = model if model.present?
       self.class.resource = resource if resource.present?
       self.class.user = user if user.present?
       self.class.view = view if view.present?
+      @arguments = arguments
 
       self.class.message ||= I18n.t("avo.are_you_sure_you_want_to_run_this_option")
       self.class.confirm_button_label ||= I18n.t("avo.run")
@@ -114,15 +116,26 @@ module Avo
       self
     end
 
-    def visible_in_view
-      # Run the visible block if available
-      return instance_exec(resource: self.class.resource, view: view, &visible) if visible.present?
+    def visible_in_view(parent_model: nil, parent_resource: nil)
+      if visible.blank?
+        # Hide on the :new view by default
+        return false if view == :new
 
-      # Hide on the :new view by default
-      return false if view == :new
+        # Show on all other views
+        return true
+      end
 
-      # Show on all other views
-      true
+      # Run the visible block if available
+      Avo::Hosts::VisibilityHost.new(
+        block: visible,
+        model: self.class.model,
+        params: params,
+        parent_model: parent_model,
+        parent_resource: parent_resource,
+        resource: self.class.resource,
+        view: self.class.view,
+        arguments: arguments
+      ).handle
     end
 
     def param_id
@@ -136,6 +149,12 @@ module Avo
     end
 
     def fail(text)
+      Rails.logger.warn "DEPRECATION WARNING: Action fail method is deprecated in favor of error method and will be removed from Avo version 3.0.0"
+
+      error text
+    end
+
+    def error(text)
       add_message text, :error
 
       self
@@ -153,6 +172,12 @@ module Avo
       self
     end
 
+    def keep_modal_open
+      response[:keep_modal_open] = true
+
+      self
+    end
+
     # Add a placeholder silent message from when a user wants to do a redirect action or something similar
     def silent
       add_message nil, :silent

data/lib/avo/base_card.rb

@@ -15,6 +15,7 @@ module Avo
 
     attr_accessor :dashboard
     attr_accessor :options
+    attr_accessor :arguments
     attr_accessor :index
     attr_accessor :params
 
@@ -26,9 +27,10 @@ module Avo
       end
     end
 
-    def initialize(dashboard:, options: {}, index: 0, cols: nil, rows: nil, label: nil, description: nil, refresh_every: nil)
+    def initialize(dashboard:, options: {}, arguments: {}, index: 0, cols: nil, rows: nil, label: nil, description: nil, refresh_every: nil)
       @dashboard = dashboard
       @options = options
+      @arguments = arguments
       @index = index
       @cols = cols
       @rows = rows

data/lib/avo/base_resource.rb

@@ -49,6 +49,7 @@ module Avo
     class_attribute :record_selector, default: true
     class_attribute :keep_filters_panel_open, default: false
     class_attribute :extra_params
+    class_attribute :link_to_child_resource, default: false
 
     class << self
       delegate :t, to: ::I18n
@@ -61,16 +62,18 @@ module Avo
         self.grid_loader = grid_collector
       end
 
-      def action(action_class)
+      def action(action_class, arguments: {})
         self.actions_loader ||= Avo::Loaders::Loader.new
 
-        self.actions_loader.use action_class
+        action = { class: action_class, arguments: arguments }
+        self.actions_loader.use action
       end
 
-      def filter(filter_class)
+      def filter(filter_class, arguments: {})
         self.filters_loader ||= Avo::Loaders::Loader.new
 
-        self.filters_loader.use filter_class
+        filter = { class: filter_class , arguments: arguments }
+        self.filters_loader.use filter
       end
 
       # This is the search_query scope
@@ -169,12 +172,24 @@ module Avo
       self.class.filters_loader.bag
     end
 
+    def get_filter_arguments(filter_class)
+      filter = get_filters.find { |filter| filter[:class] == filter_class.constantize }
+
+      filter[:arguments]
+    end
+
     def get_actions
       return [] if self.class.actions_loader.blank?
 
       self.class.actions_loader.bag
     end
 
+    def get_action_arguments(action_class)
+      action = get_actions.find { |action| action[:class].to_s == action_class.to_s }
+
+      action[:arguments]
+    end
+
     def default_panel_name
       return @params[:related_name].capitalize if @params.present? && @params[:related_name].present?
 
@@ -422,9 +437,7 @@ module Avo
     end
 
     def label
-      label_field.value || model_title
-    rescue
-      model_title
+      label_field&.value || model_title
     end
 
     def avatar_field
@@ -460,9 +473,7 @@ module Avo
     end
 
     def description
-      description_field.value
-    rescue
-      nil
+      description_field&.value
     end
 
     def form_scope

data/lib/avo/concerns/breadcrumbs.rb

@@ -0,0 +1,96 @@
+module Avo
+  module Concerns
+    # This is a custom implementation of breadcrumbs largely based on breadcrumbs_on_rails gem
+    # created by Simone Carletti (@weppos) and released on MIT license.
+    #
+    # https://github.com/weppos/breadcrumbs_on_rails
+    #
+    # The reason to use custom implementation is to
+    #   * Avoid naming conflicts with other gems adding helpers like `breadcrumbs`
+    #   * Reduce number of dependencies
+    module Breadcrumbs
+      extend ActiveSupport::Concern
+
+      included do |base|
+        helper HelperMethods
+        extend ClassMethods
+        helper_method :add_breadcrumb, :avo_breadcrumbs
+      end
+
+      Crumb = Struct.new(:name, :path) unless defined?(Crumb)
+
+      class Builder
+        DEFAULT_SEPARATOR = " » ".freeze unless defined?(DEFAULT_SEPARATOR)
+
+        attr_reader :context, :options
+
+        def initialize(context, options)
+          @context = context
+          @options = options
+        end
+
+        def render
+          separator = options.fetch(:separator, DEFAULT_SEPARATOR)
+          breadcrumbs.map(&method(:render_element)).join(separator)
+        end
+
+        private
+
+        def breadcrumbs
+          context.avo_breadcrumbs
+        end
+
+        def render_element(element)
+          content = element.path.nil? ? compute_name(element) : context.link_to_unless_current(compute_name(element), compute_path(element))
+          options[:tag] ? context.content_tag(options[:tag], content) : ERB::Util.h(content)
+        end
+
+        def compute_name(element)
+          case name = element.name
+          when Symbol
+            context.send(name)
+          when Proc
+            name.call(context)
+          else
+            name.to_s
+          end
+        end
+
+        def compute_path(element)
+          case path = element.path
+          when Symbol
+            context.send(path)
+          when Proc
+            path.call(context)
+          else
+            context.url_for(path)
+          end
+        end
+      end
+
+      module ClassMethods
+        def add_breadcrumb(name, path = nil)
+          before_action(filter_options) do |controller|
+            controller.send(:add_breadcrumb, name, path)
+          end
+        end
+      end
+
+      def add_breadcrumb(name, path = nil)
+        avo_breadcrumbs << Crumb.new(name, path)
+      end
+
+      def avo_breadcrumbs
+        @avo_breadcrumbs ||= []
+      end
+
+      module HelperMethods
+        def render_avo_breadcrumbs(options = {}, &block)
+          builder = Builder.new(self, options)
+          content = builder.render.html_safe
+          block_given? ? capture(content, &block) : content
+        end
+      end
+    end
+  end
+end

data/lib/avo/concerns/filters_session_handler.rb

@@ -0,0 +1,43 @@
+
+module Avo
+  module Concerns
+    module FiltersSessionHandler
+      def reset_filters
+        return unless cache_resource_filters?
+
+        session.delete(filters_session_key)
+      end
+
+      def fetch_filters
+        return filters_from_params unless cache_resource_filters?
+
+        (filters_from_params && save_filters_to_session) || filters_from_session
+      end
+
+      def filters_from_params
+        params[Avo::Filters::BaseFilter::PARAM_KEY].presence
+      end
+
+      def save_filters_to_session
+        session[filters_session_key] = params[Avo::Filters::BaseFilter::PARAM_KEY]
+      end
+
+      def filters_from_session
+        session[filters_session_key]
+      end
+
+      def filters_session_key
+        @filters_session_key ||= '/filters/' << %w[
+          turbo_frame controller resource_name related_name
+          action id
+        ].map { |key| params[key] }.compact.join('/')
+      end
+
+      def cache_resource_filters?
+        return Avo.configuration.cache_resource_filters unless Avo.configuration.cache_resource_filters.is_a?(Proc)
+
+        Avo.configuration.cache_resource_filters.call(current_user: current_user, resource: @resource)
+      end
+    end
+  end
+end

data/lib/avo/concerns/has_fields.rb

@@ -270,6 +270,8 @@ module Avo
           end
           # each field has it's own visibility checker
           if item.respond_to? :visible?
+            item.hydrate(view: view) if item.view.nil?
+
             next unless item.visible?
           end
           # check if the user is authorized to view it

data/lib/avo/concerns/has_html_attributes.rb

@@ -16,12 +16,14 @@ module Avo
           default_attribute_value name
         end
 
-        attributes = if html_builder.is_a? Hash
-          get_html_from_hash name, element: element, view: view
-        elsif html_builder.is_a? Avo::HTML::Builder
-          get_html_from_block name, element: element, view: view
-        elsif html_builder.nil?
-          # Handle empty html_builder by returning an empty state
+        parsed = parse_html
+
+        attributes = if parsed.is_a? Hash
+          get_html_from_hash name, element: element, hash: parsed, view: view
+        elsif parsed.is_a? Avo::HTML::Builder
+          get_html_from_block name, element: element, html_builder: parsed, view: view
+        elsif parsed.nil?
+          # Handle empty parsed by returning an empty state
           default_attribute_value name
         end
 
@@ -30,19 +32,15 @@ module Avo
 
       private
 
-      def html_builder
-        return @parsed_html if @parsed_html.present?
-
+      # Returns Hash, HTML::Builder, or nil.
+      def parse_html
         return if @html.nil?
 
-        # Memoize the value
-        @parsed_html = if @html.is_a? Hash
+        if @html.is_a? Hash
           @html
         elsif @html.respond_to? :call
           Avo::HTML::Builder.parse_block(record: model, resource: resource, &@html)
         end
-
-        @parsed_html
       end
 
       def default_attribute_value(name)
@@ -64,7 +62,7 @@ module Avo
         end
       end
 
-      def get_html_from_block(name = nil, element:, view:)
+      def get_html_from_block(name = nil, element:, html_builder:, view:)
         values = []
 
         # get view ancestor
@@ -83,9 +81,9 @@ module Avo
         merge_values_as(as: values_type, values: values)
       end
 
-      def get_html_from_hash(name = nil, element:, view:)
+      def get_html_from_hash(name = nil, element:, hash:, view:)
         # @todo: what if this is not a Hash but a string?
-        html_builder.dig(view, element, name) || {}
+        hash.dig(view, element, name) || {}
       end
 
       # Merge the values from all possible locations.

data/lib/avo/concerns/visible_items.rb

@@ -0,0 +1,44 @@
+# This concern helps us figure out what items are visible for each tab, panel or sidebar
+module Avo
+  module Concerns
+    module VisibleItems
+      extend ActiveSupport::Concern
+      def items
+        if items_holder.present?
+          items_holder.items
+        else
+          []
+        end
+      end
+
+      def visible_items
+        items
+          .map do |item|
+            visible(item) ? item : nil
+          end
+          .compact
+      end
+
+      def visible(item)
+        if item.is_field?
+          item.visible? && item.visible_on?(view)
+        else
+          item.visible?
+        end
+      end
+
+      def visible?
+        any_item_visible = visible_items.any?
+        return any_item_visible unless respond_to?(:visible_on?)
+
+        visible_on?(view) && any_item_visible
+      end
+
+      def hydrate(view: nil)
+        @view = view
+
+        self
+      end
+    end
+  end
+end

data/lib/avo/configuration/branding.rb

@@ -1,10 +1,11 @@
 class Avo::Configuration::Branding
-  def initialize(colors: nil, chart_colors: nil, logo: nil, logomark: nil, placeholder: nil)
+  def initialize(colors: nil, chart_colors: nil, logo: nil, logomark: nil, placeholder: nil, favicon: nil)
     @colors = colors || {}
     @chart_colors = chart_colors
     @logo = logo
     @logomark = logomark
     @placeholder = placeholder
+    @favicon = favicon
 
     @default_colors = {
       background: "#F6F6F7",
@@ -16,7 +17,8 @@ class Avo::Configuration::Branding
     @default_chart_colors = ["#0B8AE2", "#34C683", "#2AB1EE", "#34C6A8"]
     @default_logo = "/avo-assets/logo.png"
     @default_logomark = "/avo-assets/logomark.png"
-    @default_placeholder = "placeholder.svg"
+    @default_placeholder = "/avo-assets/placeholder.svg"
+    @default_favicon = "/avo-assets/favicon.ico"
   end
 
   def css_colors
@@ -53,6 +55,12 @@ class Avo::Configuration::Branding
     @chart_colors || @default_chart_colors
   end
 
+  def favicon
+    return @default_favicon if Avo::App.license.lacks_with_trial(:branding)
+
+    @favicon || @default_favicon
+  end
+
   private
 
   def colors

data/lib/avo/configuration.rb

@@ -20,6 +20,7 @@ module Avo
     attr_accessor :full_width_container
     attr_accessor :full_width_index_view
     attr_accessor :cache_resources_on_index_view
+    attr_accessor :cache_resource_filters
     attr_accessor :context
     attr_accessor :display_breadcrumbs
     attr_accessor :hide_layout_when_printing
@@ -39,6 +40,7 @@ module Avo
     attr_accessor :resource_default_view
     attr_accessor :authorization_client
     attr_accessor :field_wrapper_layout
+    attr_accessor :sign_out_path_name
     attr_writer :branding
 
     def initialize
@@ -68,6 +70,7 @@ module Avo
       @full_width_container = false
       @full_width_index_view = false
       @cache_resources_on_index_view = Avo::PACKED
+      @cache_resource_filters = false
       @context = proc {}
       @initial_breadcrumbs = proc {
         add_breadcrumb I18n.t("avo.home").humanize, avo.root_path

data/lib/avo/dashboards/base_dashboard.rb

@@ -12,7 +12,12 @@ module Avo
       class_attribute :index, default: 0
 
       class << self
-        def card(klass, label: nil, description: nil, cols: nil, rows: nil, refresh_every: nil, options: {})
+        def options_deprecation_message
+          Rails.logger.warn "DEPRECATION WARNING: Card options parameter is deprecated in favor of arguments parameter and will be removed from Avo version 3.0.0"
+        end
+
+        def card(klass, label: nil, description: nil, cols: nil, rows: nil, refresh_every: nil, options: {}, arguments: {})
+          options_deprecation_message if options.present?
           self.items_holder ||= []
 
           self.items_holder << klass.new(dashboard: self,
@@ -22,6 +27,7 @@ module Avo
             rows: rows,
             refresh_every: refresh_every,
             options: options,
+            arguments: arguments,
             index: index
           )
           self.index += 1

data/lib/avo/dynamic_router.rb

@@ -1,21 +1,22 @@
 module Avo
-  module DynamicRouter
-    def self.routes(router)
-      Rails.application.eager_load! unless Rails.env.production?
+  class DynamicRouter
+    def self.routes
+      Avo::Engine.routes.draw do
+        scope "resources", as: "resources" do
+          Avo::App.eager_load(:resources) unless Rails.application.config.eager_load
 
-      BaseResource.descendants
-        .select do |resource|
-          resource != :BaseResource
-        end
-        .select do |resource|
-          resource.is_a? Class
-        end
-        # .select do |resource|
-        #   resource.model_class.present?
-        # end
-        .map do |resource|
-          router.resources resource.new.route_key
+          BaseResource.descendants
+            .select do |resource|
+              resource != :BaseResource
+            end
+            .select do |resource|
+              resource.is_a? Class
+            end
+            .map do |resource|
+              resources resource.new.route_key
+            end
         end
+      end
     end
   end
 end

data/lib/avo/engine.rb

@@ -27,15 +27,7 @@ module Avo
     end
 
     initializer "avo.autoload" do |app|
-      [
-        ["app", "avo", "fields"],
-        ["app", "avo", "filters"],
-        ["app", "avo", "actions"],
-        ["app", "avo", "resources"],
-        ["app", "avo", "dashboards"],
-        ["app", "avo", "cards"],
-        ["app", "avo", "resource_tools"]
-      ].each do |path_params|
+      Avo::ENTITIES.values.each do |path_params|
         path = Rails.root.join(*path_params)
 
         if File.directory? path.to_s
@@ -72,6 +64,11 @@ module Avo
       g.test_framework :rspec, view_specs: false
     end
 
+    generators do |app|
+      Rails::Generators.configure! app.config.generators
+      require_relative "../generators/model_generator"
+    end
+
     # After deploy we want to make sure the license response is being cleared.
     # We need a fresh license response.
     # This is disabled in development because the initialization process might be triggered more than once.

data/lib/avo/fields/base_field.rb

@@ -14,6 +14,7 @@ module Avo
       include Avo::Concerns::HasHTMLAttributes
       include Avo::Fields::Concerns::IsRequired
       include Avo::Fields::Concerns::IsReadonly
+      include Avo::Fields::Concerns::HasDefault
 
       delegate :view_context, to: ::Avo::App
       delegate :simple_format, :content_tag, to: :view_context
@@ -83,7 +84,7 @@ module Avo
 
         @args = args
 
-        @updatable = true
+        @updatable = !readonly
         @computable = true
         @computed = block.present?
         @computed_value = nil
@@ -145,9 +146,11 @@ module Avo
       end
 
       def placeholder
-        return @placeholder if @placeholder.present?
+        if @placeholder.respond_to?(:call)
+          return Avo::Hosts::ResourceViewRecordHost.new(block: @placeholder, record: @model, resource: @resource, view: @view).handle
+        end
 
-        name
+        @placeholder || name
       end
 
       def visible?
@@ -166,15 +169,9 @@ module Avo
         # Get model value
         final_value = @model.send(property) if is_model?(@model) && @model.respond_to?(property)
 
-        # On new views and actions modals we need to prefill the fields
-        if @view.in?([:new, :create]) || @action.present?
-          if default.present?
-            final_value = if default.respond_to?(:call)
-              default.call
-            else
-              default
-            end
-          end
+        # On new views and actions modals we need to prefill the fields with the default value
+        if should_fill_with_default_value? && default.present?
+          final_value = computed_default_value
         end
 
         # Run computable callback block if present
@@ -269,6 +266,18 @@ module Avo
       def is_model?(model)
         model_or_class(model) == "model"
       end
+
+      def should_fill_with_default_value?
+        on_create? || in_action?
+      end
+
+      def on_create?
+        @view.in?([:new, :create])
+      end
+
+      def in_action?
+        @action.present?
+      end
     end
   end
 end

data/lib/avo/fields/concerns/has_default.rb

@@ -0,0 +1,17 @@
+module Avo
+  module Fields
+    module Concerns
+      module HasDefault
+        extend ActiveSupport::Concern
+
+        def computed_default_value
+          if default.respond_to? :call
+            Avo::Hosts::ResourceViewRecordHost.new(block: default, record: model, view: view, resource: resource).handle
+          else
+            default
+          end
+        end
+      end
+    end
+  end
+end