avo 2.46.0 → 3.0.2

data/lib/avo/test_helpers.rb

@@ -0,0 +1,362 @@
+module Avo
+  module TestHelpers
+    # Finds the wrapper element on the index view for the given field id and type, and associated with the given record id
+    # Example usage:
+    #   index_field_wrapper(id: "name", type: "text", record_id: 2)
+    #   index_field_wrapper(id: "name", record_id: 2)
+    def index_field_wrapper(id:, record_id:, type: nil)
+      base_data = "#{row(record_id)} [data-field-id='#{id}']"
+
+      if type.present?
+        find("#{base_data}[data-resource-index-target='#{wrapper_name_for(id: id, type: type)}']")
+      else
+        find(base_data)
+      end
+    end
+
+    # Finds the wrapper element on the index grid view type for the given record id
+    # Example usage:
+    #   grid_field_wrapper(record_id: 5)
+    def grid_field_wrapper(record_id:)
+      find("[data-component-name='avo/index/grid_item_component'][data-resource-id='#{record_id}']")
+    end
+
+    # Finds the wrapper element on the show view for the given field id and type
+    # Example usage:
+    #   show_field_wrapper(id: "name", type: "text")
+    #   show_field_wrapper(id: "name")
+    def show_field_wrapper(id:, type: nil)
+      base_data = "[data-panel-id='main'] [data-field-id='#{id}']"
+
+      if type.present?
+        find("#{base_data}[data-resource-show-target='#{wrapper_name_for(id: id, type: type)}']")
+      else
+        find(base_data)
+      end
+    end
+
+    # Finds the table on the show view for the given has_many field id and view
+    # Example usage:
+    #   has_many_field_wrapper(id: :users)
+    #   has_many_field_wrapper(id: :users, view: :edit)
+    def has_many_field_wrapper(id:, view: :show)
+      related_field_context(id: id, relation: :has_many, view: view)
+    end
+
+    # Finds the table on the show view for the given has_and_belongs_to_many field id and view
+    # Example usage:
+    #   has_and_belongs_to_many_field_wrapper(id: :users)
+    #   has_and_belongs_to_many_field_wrapper(id: :users, view: :edit)
+    def has_and_belongs_to_many_field_wrapper(id:, view: :show)
+      related_field_context(id: id, relation: :has_and_belongs_to_many, view: view)
+    end
+
+    # Finds the table on the show view for the given has_one field id and view
+    # Example usage:
+    #   has_one_field_wrapper(id: :users)
+    #   has_one_field_wrapper(id: :users, view: :edit)
+    def has_one_field_wrapper(id:, view: :show)
+      related_field_context(id: id, relation: :has_one, view: view)
+    end
+
+    # Finds the label element on the index view for the given field id
+    # Example usage:
+    #   index_field_label(id: "name")
+    def index_field_label(id:)
+      find("[data-component-name='avo/partials/table_header'] [data-table-header-field-id='#{id}']").text
+    end
+
+    # Finds the label element on the show view for the given field id
+    # Example usage:
+    #   show_field_label(id: "name")
+    def show_field_label(id:)
+      within(show_field_wrapper(id: id)) { find("[data-slot='label']").text }
+    end
+
+    # Finds the value element on the index view for the given field id
+    # Example usage:
+    #   index_field_value(id: "name", record_id: 2)
+    def index_field_value(id:, record_id:, type: nil)
+      index_field_wrapper(id: id, record_id: record_id, type: type).text
+    end
+
+    # Finds the value element on the show view for the given field id
+    # Example usage:
+    #   show_field_value(id: "name")
+    def show_field_value(id:, type: nil)
+      within(show_field_wrapper(id: id, type: type)) { find("[data-slot='value']").text }
+    end
+
+    def empty_dash
+      "—"
+    end
+
+    def confirm_alert
+      Capybara.using_wait_time(1) do
+        page.driver.browser.switch_to.alert.accept
+      rescue Selenium::WebDriver::Error::NoSuchAlertError
+        retry
+      end
+    end
+
+    # Example usage:
+    #   click_resource_search_input # opens the first search box on the given page
+    #   opens the search box for the "users" resource
+    #   within(has_and_belongs_to_many_field_wrapper(id: :users)) {
+    #     click_resource_search_input
+    #     write_in_search("Bob")
+    #   }
+    def click_resource_search_input
+      first("[data-search-resource]:not([data-search-resource='global'])").click
+      wait_for_search_loaded
+    end
+
+    def click_global_search_input
+      page.find(:xpath, "//*[contains(@class, 'global-search')]").click
+      wait_for_search_loaded
+    end
+
+    # Should use the click_global_search_input or click_resource_search_input method to open the search box first.
+    # Example usage:
+    #   open_search_box(:users)
+    #   within(has_and_belongs_to_many_field_wrapper(id: :users)) {
+    #     click_resource_search_input # opens the search box for the "users" resource
+    #     write_in_search("Bob")
+    #   }
+    def write_in_search(input)
+      # Use xpath to find outside of within context if any
+      find(:xpath, "//input[@class='aa-Input']").set(input)
+      wait_for_search_loaded
+    end
+
+    # Should use the click_global_search_input or click_resource_search_input method to open the search box first and optionaly write_in_search.
+    # Example usage:
+    #   open_search_box(:users) # opens the search box for the "users" resource
+    #   write_in_search("John Doe")
+    #   select_first_result_in_search
+    def select_first_result_in_search
+      find(".aa-Input").send_keys :arrow_down
+      find(".aa-Input").send_keys :enter
+      wait_for_search_loaded
+    end
+
+    # Save a record and wait for the page to load
+    def save
+      click_on "Save"
+      wait_for_loaded
+    end
+
+    def click_tab(tab_name = "", within_target: nil, **args)
+      if within_target.present?
+        within within_target do
+          within find('[data-controller="tabs"] turbo-frame:not(.hidden) [data-target="tab-switcher"]') do
+            find_link(tab_name).click
+          end
+        end
+      else
+        within find('[data-controller="tabs"] turbo-frame:not(.hidden) [data-target="tab-switcher"]') do
+          find_link(tab_name).click
+        end
+      end
+    end
+
+    def tab_group(index = 0)
+      find_all('[data-controller="tabs"]')[index]
+    end
+
+    def first_tab_group
+      tab_group 0
+    end
+
+    def second_tab_group
+      tab_group 1
+    end
+
+    def third_tab_group
+      tab_group 3
+    end
+
+    def click_on_sidebar_item(label)
+      within main_sidebar do
+        click_on label
+      end
+    end
+
+    def set_picker_day(date)
+      find(".flatpickr-day[aria-label=\"#{date}\"]").click
+      sleep 0.2
+    end
+
+    def set_picker_hour(value)
+      find(".flatpickr-hour").set(value)
+    end
+
+    def set_picker_minute(value)
+      find(".flatpickr-minute").set(value)
+    end
+
+    def set_picker_second(value)
+      find(".flatpickr-second").set(value)
+    end
+
+    def open_picker
+      text_input.click
+    end
+
+    def close_picker
+      find('[data-target="title"]').click
+      sleep 0.3
+    end
+
+    # Click on the action from the panel (index and show above the table)
+    # Pass list: nil to run an action outside of the list
+    # Pass list: "List name" if list is not the default "Actions"
+    # Example usage:
+    #   open_panel_action(action_name: "Dummy action")
+    #   open_panel_action(list: nil, action_name: "Release fish")
+    #   open_panel_action(list: "Runnables", action_name: "Release fish")
+    def open_panel_action(action_name:, list: "Actions")
+      open_action(action_name: action_name, list: list, context: first("[data-target='panel-tools']"))
+    end
+
+    # Open the action from the record_id row
+    # Pass list: nil to run an action outside of the list
+    # Pass list: "List name" if list is not the default "Actions"
+    # Example usage:
+    #   open_row_action(action_name: "Dummy action")
+    #   open_row_action(list: nil, action_name: "Release fish")
+    #   open_row_action(list: "Runnables", action_name: "Release fish")
+    def open_row_action(record_id:, action_name:, list: "Actions")
+      open_action(action_name: action_name, list: list, context: row(record_id))
+    end
+
+    # Click on submit action button if dialog is open
+    def run_action
+      within(find("[role='dialog']")) do
+        find("[data-target='submit_action']").click
+      end
+
+      wait_for_action_dialog_to_disappear
+    end
+
+    def check_select_all
+      find("input[type='checkbox'][name='Select all'][data-action='input->item-select-all#toggle']").set(true)
+    end
+
+    def toggle_collapsable(section)
+      find("[data-action='click->menu#triggerCollapse'][data-menu-key-param*='main_menu.#{section.underscore}'] svg").click
+    end
+
+    # Example usage:
+    #   expect(add_tag(field: :tags, tag: "one")).to eq ["one"]
+    #   add_tag(field: :tags, tag: "two")
+    def add_tag(field:, tag:)
+      # Find the input field for the specified field
+      input = find("[data-field-id='#{field}'] [data-slot='value'] [role='textbox']")
+
+      # Enter the specified tag into the input field
+      input.set(tag)
+      sleep 0.1
+
+      input.send_keys :return
+      wait_for_tag_to_appear(tag)
+
+      # Return an array of the current tags
+      tags(field: field)
+    end
+
+    # Example usage:
+    #   expect(remove_tag(field: :tags, tag: "one")).to eq ["three"]
+    #   remove_tag(field: :tags, tag: "one")
+    def remove_tag(field:, tag:)
+      # Within the specified field
+      within("[data-field-id='#{field}'] [data-slot='value']") do
+        # Find the tag with the specified text and click the remove button for the tag
+        page.find(".tagify__tag", text: tag).find(".tagify__tag__removeBtn").click
+
+        wait_for_tag_to_disappear(tag)
+      end
+
+      # Return an array of the current tags
+      tags(field: field)
+    end
+
+    # Example usage:
+    #   expect(tags(field: :tags)).to eq ["one", "two", "three"]
+    #   expect(tags(field: :tags)).to eq []
+    def tags(field:)
+      # Find all elements with class 'tagify__tag'
+      # Map the elements to their 'label' attribute values and return the array of labels
+      page.all(".tagify__tag").map { |element| element[:label] }
+    end
+
+    # Example usage:
+    #   expect(tag_suggestions(field: :tags, input: "")).to eq ["one", "two", "three"]
+    #   expect(tag_suggestions(field: :tags, input: "t")).to eq ["two", "three"]
+    def tag_suggestions(field:, input:)
+      # Find the input field for the specified tag field
+      input_area = find("[data-field-id='#{field}'] [data-slot='value'] [role='textbox']")
+
+      # If the input argument is present, enter it into the input field
+      # Else, just click on the middle of the input field to display the dropdown
+      if input.present?
+        input_area.set(input)
+      else
+        input_area.click(x: input_area.native.size.width / 2, y: input_area.native.size.height / 2)
+      end
+      wait_for_tag_suggestions_to_appear
+
+      # Find all elements with class 'tagify_dropdown_item' within the dropdown
+      # Map the elements to their 'label' attribute values and return the array of labels
+      page.all(".tagify__dropdown__item").map { |element| element[:label] }
+    end
+
+    private
+
+    # Returns the name of the wrapper element for the given field id and type
+    def wrapper_name_for(id:, type:)
+      "#{id.camelize(:lower)}#{type.camelize}Wrapper"
+    end
+
+    # Finds the context element for the related field with the given id, relation, and view
+    # ex: has_and_belongs_to_many_users = related_field_context(id: :users, relation: :has_and_belongs_to_many)
+    # Now on the returend element you can do:
+    # first_name_wrapper = within has_and_belongs_to_many_users do
+    #   index_field_wrapper(id: "first_name", type: "text", record_id: 7)
+    # end
+    def related_field_context(id:, relation:, view: :show)
+      turbo_frame = "#{relation}_field_#{view}_#{id}"
+      find("[id='#{turbo_frame}']")
+    end
+
+    def main_sidebar
+      find('[data-sidebar-target="sidebar"]')
+    end
+
+    # Opens an action. If a list is provided, it will click on the list first
+    # and then find the specified action name within the panel.
+    # If no list is present, it will directly click on the action link.
+    def open_action(action_name:, list:, context:, &block)
+      within(context) do
+        if list.present?
+          sleep 0.1
+          click_on list
+          within("[data-toggle-target='panel']") do
+            find("a[data-action-name='#{action_name}']").click
+          end
+        else
+          click_link(action_name)
+        end
+      end
+
+      # Within the dialog, ensure that the action name is present
+      within(find("[role='dialog']")) do
+        expect(page).to have_content(action_name)
+      end
+    end
+
+    def row(id)
+      "[data-component-name='avo/index/table_row_component'][data-resource-id='#{id}']"
+    end
+  end
+end

data/lib/avo/tools/tool_manager.rb

@@ -0,0 +1,30 @@
+module Avo
+  module Tools
+    class ToolManager
+      class << self
+        def build
+          new
+        end
+      end
+
+      # Insert any partials that we find in app/views/avo/sidebar/items.
+      def get_sidebar_partials
+        Dir.glob(Rails.root.join("app", "views", "avo", "sidebar", "items", "*.html.erb"))
+          .map do |path|
+            File.basename path
+          end
+          .map do |filename|
+            # remove the leading underscore (_)
+            filename[0] = ""
+            # remove the extension
+            filename.gsub!(".html.erb", "")
+            filename
+          end
+      end
+
+      def tools_for_navigation
+        get_sidebar_partials
+      end
+    end
+  end
+end

data/lib/avo/version.rb

@@ -1,3 +1,3 @@
 module Avo
-  VERSION = "2.46.0" unless const_defined?(:VERSION)
+  VERSION = "3.0.2" unless const_defined?(:VERSION)
 end

data/lib/avo/view_inquirer.rb

@@ -0,0 +1,36 @@
+# Allows to check the the view type by using `view.index?` or `view.edit?` etc...
+# It also allows to check if the view is a form or a display view by using `view.form?` or `view.display?`
+module Avo
+  class ViewInquirer < ActiveSupport::StringInquirer
+    DISPLAY_VIEWS = %w[index show].freeze unless defined? DISPLAY_VIEWS
+    FORM_VIEWS = %w[new edit].freeze unless defined? FORM_VIEWS
+
+    def initialize(view)
+      super(view.to_s)
+
+      @display = in? DISPLAY_VIEWS
+      @form = in? FORM_VIEWS
+    end
+
+    def display?
+      @display
+    end
+
+    def form?
+      @form
+    end
+
+    # To avoid breaking changes we allow the comparison with symbols
+    def ==(other)
+      if other.is_a? Symbol
+        to_sym == other
+      else
+        super(other)
+      end
+    end
+
+    def in?(another_object)
+      super another_object.map(&:to_s)
+    end
+  end
+end

data/lib/avo.rb

@@ -11,37 +11,16 @@ loader.inflector.inflect(
 loader.ignore("#{__dir__}/generators")
 loader.setup
 
-#                                      .//*,,.....,,*/(*
-#                                   **,,..............,*#.
-#                               ,*,,.....         .....*/#.
-#                            **,,....             ....,*/%%
-#                        ,**,,.......           . ....*/#&%
-#                    **,,,...... .             . ....*/#&&%
-#                **,,........ .           .     ...,//#&&&.
-#            */*,,..*//***,,,,*/(,..      .. .....*//%&%&*
-#         ,/**,..**/******,,***/(###,...........,//(%&&%.
-#       /**,,..((//*****////((##%%%%%*.........*//%%&&%
-#     ****,...#/**,,,*,*/(#%##%%%%&&&(*,.....,*/(%&&&/
-#    /**,....(/*,,,,,,,*(##%%%%%&&&&&(,.....,*(#&&&&.
-#  ,//*,.....(/*,,**//(##%%%%&&&&@&&%/,....,*((&&&&*
-# .//*,,.....(((//(((##%%%&&&&&&&&@#/,....,*/#%&&&#
-# (/**,,......###%%%%%&&&&&&&&&&@#/,,...,,*/#&&&&&
-# (/**,,........%%%%%&&&&&&&&@%(*,...,,,*//(&&&&%.
-# ///*,,,.........,*#&&&&#(/,,.....,,,*//(%&&&&%*
-#  (//**,,,.....................,,,,*//(%&&&&&&*
-#   *(///**,,,,............,,,,,,**/((&&&&&&&%.
-#     ((///*****,,,,,,,,,,,,***//((&&&&&%&%&#
-#       .((((////********///(((%&%&&&&%%%%%
-#           (############%%%%%%%%%%%%%%%*
-#               ,(############%%%%%#*
-
 module Avo
+  extend ActiveSupport::LazyLoadHooks
+
   ROOT_PATH = Pathname.new(File.join(__dir__, ".."))
   IN_DEVELOPMENT = ENV["AVO_IN_DEVELOPMENT"] == "1"
   PACKED = !IN_DEVELOPMENT
   COOKIES_KEY = "avo"
   ENTITIES = {
     cards: ["app", "avo", "cards"],
+    scopes: ["app", "avo", "scopes"],
     fields: ["app", "avo", "fields"],
     filters: ["app", "avo", "filters"],
     actions: ["app", "avo", "actions"],
@@ -59,6 +38,112 @@ module Avo
   class NoPolicyError < StandardError; end
 
   class MissingGemError < StandardError; end
+
+  class DeprecatedAPIError < StandardError; end
+
+  class << self
+    attr_reader :logger
+    attr_reader :cache_store
+    attr_reader :field_manager
+
+    delegate :license, :app, :error_manager, :tool_manager, :resource_manager, to: Avo::Current
+
+    def boot
+      boot_logger
+      boot_fields
+      @cache_store = Avo.configuration.cache_store
+      plugin_manager.boot_plugins
+      Avo.run_load_hooks(:boot, self)
+    end
+
+    def init
+      Avo::Current.error_manager = Avo::ErrorManager.build
+      Avo::Current.resource_manager = Avo::Resources::ResourceManager.build
+      Avo::Current.tool_manager = Avo::Tools::ToolManager.build
+
+      Avo.run_load_hooks(:init, self)
+    end
+
+    # Generate a dynamic root path using the URIService
+    def root_path(paths: [], query: {}, **args)
+      Avo::Services::URIService.parse(Avo::Current.view_context.avo.root_url.to_s)
+        .append_paths(paths)
+        .append_query(query)
+        .to_s
+    end
+
+    def mount_path
+      Avo::Engine.routes.find_script_name({})
+    end
+
+    def main_menu
+      return unless Avo.plugin_manager.installed?("avo-menu")
+
+      # Return empty menu if the app doesn't have the profile menu configured
+      return Avo::Menu::Builder.new.build unless has_main_menu?
+
+      Avo::Menu::Builder.parse_menu(&Avo.configuration.main_menu)
+    end
+
+    def profile_menu
+      return unless Avo.plugin_manager.installed?("avo-menu")
+
+      # Return empty menu if the app doesn't have the profile menu configured
+      return Avo::Menu::Builder.new.build unless has_profile_menu?
+
+      Avo::Menu::Builder.parse_menu(&Avo.configuration.profile_menu)
+    end
+
+    def app_status
+      license.valid?
+    end
+
+    def avo_dynamic_filters_installed?
+      defined?(Avo::DynamicFilters).present?
+    end
+
+    def has_main_menu?
+      return false if Avo.license.lacks_with_trial(:menu_editor)
+      return false if Avo.configuration.main_menu.nil?
+
+      true
+    end
+
+    def has_profile_menu?
+      return false if Avo.license.lacks_with_trial(:menu_editor)
+      return false if Avo.configuration.profile_menu.nil?
+
+      true
+    end
+
+    # Mount all Avo engines
+    def mount_engines
+      -> {
+        mount Avo::DynamicFilters::Engine, at: "/avo-dynamic_filters" if defined?(Avo::DynamicFilters::Engine)
+        mount Avo::Dashboards::Engine, at: "/dashboards" if defined?(Avo::Dashboards::Engine)
+        mount Avo::Pro::Engine, at: "/avo-pro" if defined?(Avo::Pro::Engine)
+      }
+    end
+
+    private
+
+    def boot_logger
+      file_logger = ActiveSupport::Logger.new(Rails.root.join("log", "avo.log"))
+
+      file_logger.datetime_format = "%Y-%m-%d %H:%M:%S"
+      file_logger.formatter = proc do |severity, time, progname, msg|
+        "[Avo] #{time}: #{msg}\n".tap do |i|
+          puts i
+        end
+      end
+
+      @logger = file_logger
+    end
+
+    def boot_fields
+      @field_manager = Avo::Fields::FieldManager.build
+    end
+  end
 end
 
 loader.eager_load

data/lib/generators/avo/action_generator.rb

@@ -5,20 +5,20 @@ module Generators
     class ActionGenerator < NamedBaseGenerator
       source_root File.expand_path("templates", __dir__)
 
-      class_option :standalone, type: :boolean
+      class_option :standalone, type: :boolean, default: false
+      class_option :name, type: :string
 
       namespace "avo:action"
 
       def create_resource_file
-        type = "resource"
+        template "action.tt", "app/avo/actions/#{singular_name}.rb"
+      end
 
-        type = "standalone" if options[:standalone]
+      def configuration_options
+        configuration = "  self.name = \"#{options[:name] || name.titleize}\""
+        configuration += "\n  self.standalone = true" if options[:standalone]
 
-        if type == "standalone"
-          template "standalone_action.tt", "app/avo/actions/#{singular_name}.rb"
-        else
-          template "action.tt", "app/avo/actions/#{singular_name}.rb"
-        end
+        configuration
       end
     end
   end

data/lib/generators/avo/card_generator.rb

@@ -0,0 +1,27 @@
+require_relative "named_base_generator"
+
+module Generators
+  module Avo
+    class Card < NamedBaseGenerator
+      namespace "avo:card"
+      source_root File.expand_path("templates", __dir__)
+      class_option :type, type: :string
+
+      def handle
+        raise "Invalid card type '#{options[:type]}'" unless card_types.include? options[:type]
+
+        template "cards/#{options[:type]}_card_sample.tt", "app/avo/cards/#{name.underscore}.rb"
+
+        if options[:type].to_sym == :partial
+          template "cards/partial_card_partial.tt", "app/views/avo/cards/_#{name.underscore}.html.erb"
+        end
+      end
+
+      private
+
+      def card_types
+        %w[metric chartkick partial]
+      end
+    end
+  end
+end

data/lib/generators/avo/concerns/parent_controller.rb

@@ -0,0 +1,20 @@
+module Generators
+  module Avo
+    module Concerns
+      module ParentController
+        extend ActiveSupport::Concern
+
+        included do
+          class_option "parent-controller",
+            desc: "The name of the parent controller.",
+            type: :string,
+            required: false
+        end
+
+        def parent_controller
+          options["parent-controller"] || ::Avo.configuration.resource_parent_controller
+        end
+      end
+    end
+  end
+end

data/lib/generators/avo/controller_generator.rb

@@ -1,8 +1,11 @@
 require_relative "named_base_generator"
+require_relative "concerns/parent_controller"
 
 module Generators
   module Avo
     class ControllerGenerator < NamedBaseGenerator
+      include Generators::Avo::Concerns::ParentController
+
       source_root File.expand_path("templates", __dir__)
 
       namespace "avo:controller"