avo 2.43.0 → 3.0.2

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"

data/lib/generators/avo/eject_generator.rb

@@ -3,7 +3,30 @@ require_relative "base_generator"
 module Generators
   module Avo
     class EjectGenerator < BaseGenerator
-      argument :filename, type: :string, required: true
+      class_option :partial,
+        desc: "The partial to eject. Example: ':logo', 'app/views/layouts/avo/application.html.erb'",
+        type: :string,
+        required: false
+
+      class_option :component,
+        desc: "The component to eject. Example: 'Avo::Index::TableRowComponent', 'avo/index/table_row_component'",
+        type: :string,
+        required: false
+
+      class_option :scope,
+        desc: "The scope of the component. Example: 'users', 'admins'",
+        type: :string,
+        required: false
+
+      class_option "field-components",
+        desc: "The field components to eject. Example: 'trix', 'text'",
+        type: :string,
+        required: false
+
+      class_option :view,
+        desc: "The view of the component to eject when using --field-component option. Example: 'index', 'show'",
+        type: :string,
+        required: false
 
       source_root ::Avo::Engine.root
 
@@ -21,19 +44,23 @@ module Generators
       }
 
       def handle
-        if @filename.starts_with?(":")
-          template_id = path_to_sym @filename
-          template_path = TEMPLATES[template_id]
-
-          if path_exists? template_path
-            eject template_path
-          else
-            say("Failed to find the `#{template_id.to_sym}` template.", :yellow)
-          end
-        elsif path_exists? @filename
-          eject @filename
+        if options[:partial].present?
+          eject_partial
+        elsif options[:component].present?
+          eject_component
+        elsif options["field-components"].present?
+          eject_field_components
         else
-          say("Failed to find the `#{@filename}` template.", :yellow)
+          say "Please specify a partial or a component to eject.\n" \
+              "Examples: rails g avo:eject --partial :logo\n" \
+              "          rails g avo:eject --partial app/views/layouts/avo/application.html.erb\n" \
+              "          rails g avo:eject --component Avo::Index::TableRowComponent\n" \
+              "          rails g avo:eject --component avo/index/table_row_component\n" \
+              "          rails g avo:eject --field-components trix\n" \
+              "          rails g avo:eject --field-components trix --scope users\n" \
+              "          rails g avo:eject --field-components text --scope users --view edit\n" \
+              "          rails g avo:eject --component Avo::Views::ResourceIndexComponent --scope users\n" \
+              "          rails g avo:eject --component avo/views/resource_index_component --scope users", :yellow
         end
       end
 
@@ -48,8 +75,146 @@ module Generators
           path.present? && File.file?(::Avo::Engine.root.join(path))
         end
 
-        def eject(path)
-          copy_file ::Avo::Engine.root.join(path), ::Rails.root.join(path)
+        def dir_exists?(path)
+          path.present? && Dir.exist?(::Avo::Engine.root.join(path))
+        end
+
+        def eject(path, dest_path = nil, is_directory: false)
+          method = is_directory ? :directory : :copy_file
+
+          send method, ::Avo::Engine.root.join(path), ::Rails.root.join(dest_path || path)
+        end
+
+        def eject_partial
+          if options[:partial].starts_with?(":")
+            template_id = path_to_sym options[:partial]
+            template_path = TEMPLATES[template_id]
+
+            if path_exists? template_path
+              return unless confirm_ejection_on template_path
+              eject template_path
+            else
+              say("Failed to find the `#{template_id.to_sym}` template.", :yellow)
+            end
+          elsif path_exists? options[:partial]
+            return unless confirm_ejection_on template_path
+            eject options[:partial]
+          else
+            say("Failed to find the `#{options[:partial]}` template.", :yellow)
+          end
+        end
+
+        def eject_component(component_to_eject = options[:component], confirmation: true)
+          # Underscore the component name
+          # Example: Avo::Views::ResourceIndexComponent => avo/views/resource_index_component
+          component = component_to_eject.underscore
+
+          # Get the component path for both, the rb and erb files
+          rb, erb = ["app/components/#{component}.rb", "app/components/#{component}.html.erb"]
+
+          # Return if one of the components doesn't exist
+          if !path_exists?(rb) || !path_exists?(erb)
+            return say("Failed to find the `#{component_to_eject}` component.", :yellow)
+          end
+
+          # Add the scope to the component if it's possible
+          if add_scope? component
+            component = if component.starts_with?("avo/views/")
+              component.gsub("avo/views/", "avo/views/#{options[:scope].underscore}/")
+            elsif component.starts_with?("avo/fields/")
+              component.gsub("avo/fields/", "avo/fields/#{options[:scope].underscore}/")
+            end
+            added_scope = true
+          end
+
+          # Confirm the ejection
+          if confirmation
+            return if !confirm_ejection_on(component.camelize)
+          end
+
+          # Get the destination path for both, the rb and erb files
+          dest_rb = "#{::Avo.configuration.view_component_path}/#{component}.rb"
+          dest_erb = "#{::Avo.configuration.view_component_path}/#{component}.html.erb"
+
+          # Eject the component
+          eject rb, dest_rb
+          eject erb, dest_erb
+
+          # Remame the component class if scope was added
+          # Example: Avo::Views::ResourceIndexComponent => Avo::Views::Admins::ResourceIndexComponent
+          if added_scope
+            [dest_rb, dest_erb].each do |path|
+              if component.starts_with?("avo/views/")
+                modified_content = File.read(path).gsub("Avo::Views::", "Avo::Views::#{options[:scope].camelize}::")
+              elsif component.starts_with?("avo/fields/")
+                modified_content = File.read(path).gsub("#{options["field-components"].camelize}Field", "#{options[:scope].camelize}::#{options["field-components"].camelize}Field")
+              end
+
+              File.open(path, "w") do |file|
+                file.puts modified_content
+              end
+            end
+
+            if component.starts_with?("avo/views/")
+              say "You can now use this component on any resource by configuring the 'self.components' option.\n" \
+                  "  self.components = {\n" \
+                  "    #{component.split("/").last}: #{component.camelize}\n" \
+                  "  }", :green
+            elsif component.starts_with?("avo/fields/")
+              say "You can now use this component on any field by configuring the 'components' option.\n" \
+                  "  field :name, as: :#{options["field-components"]}, components: {\n" \
+                  "    #{component.split("/").last}: #{component.camelize}\n" \
+                  "  }", :green
+            end
+          end
+        end
+
+        def eject_field_components
+          # Check if the field exists
+          field_path = "lib/avo/fields/#{options["field-components"]}_field.rb"
+          return say("Failed to find the `#{options["field-components"]}` field.", :yellow) if !path_exists?(field_path)
+
+          # Eject single component if view is specified
+          if options[:view].present?
+            return eject_component "Avo::Fields::#{options["field-components"].camelize}Field::#{options[:view].camelize}Component"
+          end
+
+          # Check if the field components directory exist
+          components_path = "app/components/avo/fields/#{options["field-components"]}_field"
+          return say("Failed to find the `#{options["field-components"]}` field components.", :yellow) if !dir_exists?(components_path)
+
+          # Build the destination path for the components directory add the scope
+          destination_components_path = "#{::Avo.configuration.view_component_path}/#{components_path.gsub("app/components/", "")}"
+
+          if options[:scope].present?
+            destination_components_path = destination_components_path.gsub("avo/fields/", "avo/fields/#{options[:scope].underscore}/")
+          end
+
+          # Confirm the ejection
+          confirm_ejection_on destination_components_path, is_directory: true
+
+          # Eject the components directory
+          eject components_path, destination_components_path, is_directory: true
+
+          # Rename the component classes if scope was added
+          if options[:scope].present?
+            Dir.glob("#{destination_components_path}/*").each do |file|
+              modified_content = File.read(file).gsub("#{options["field-components"].camelize}Field", "#{options[:scope].camelize}::#{options["field-components"].camelize}Field")
+
+              File.open(file, "w") do |open_file|
+                open_file.puts modified_content
+              end
+            end
+          end
+        end
+
+        def confirm_ejection_on(path, is_directory: false)
+          say("By ejecting the '#{path}'#{" directory" if is_directory} \033[1myou'll take on the responsibility for maintain it.", :yellow)
+          yes?("Are you sure you want to eject the '#{path}'#{" directory" if is_directory}? [y/N]", :yellow)
+        end
+
+        def add_scope?(component)
+          (component.starts_with?("avo/views/") || component.starts_with?("avo/fields/")) && options[:scope].present?
         end
       end
     end

data/lib/generators/avo/field_generator.rb

@@ -8,9 +8,56 @@ module Generators
       namespace "avo:field"
       desc "Add a custom Avo field to your project."
 
+      class_option "field-template", type: :string, required: false
+
       def handle
-        directory "field/components", "#{::Avo.configuration.view_component_path}/avo/fields/#{singular_name}_field"
-        template "field/%singular_name%_field.rb.tt", "app/avo/fields/#{singular_name}_field.rb"
+        return field_from_template if field_template.present?
+
+        directory "field/components", destination_components_path
+        template "field/%singular_name%_field.rb.tt", destination_field_path
+      end
+
+      no_tasks do
+        def field_from_template
+          if !File.file? ::Avo::Engine.root.join(template_field_path)
+            return say("Failed to find the `#{field_template}` template field.", :yellow)
+          end
+
+          if !Dir.exist? ::Avo::Engine.root.join(template_components_path)
+            return say("Failed to find the `#{field_template}` template field components.", :yellow)
+          end
+
+          directory ::Avo::Engine.root.join(template_components_path), destination_components_path
+          copy_file ::Avo::Engine.root.join(template_field_path), destination_field_path
+
+          Dir.glob("#{destination_components_path}/*").push(destination_field_path).each do |file|
+            modified_content = File.read(file).gsub("#{field_template.camelize}Field", "#{singular_name.camelize}Field")
+
+            File.open(file, "w") do |open_file|
+              open_file.puts modified_content
+            end
+          end
+        end
+
+        def field_template
+          options["field-template"]
+        end
+
+        def template_field_path
+          "lib/avo/fields/#{field_template}_field.rb"
+        end
+
+        def template_components_path
+          "app/components/avo/fields/#{field_template}_field"
+        end
+
+        def destination_components_path
+          "#{::Avo.configuration.view_component_path}/avo/fields/#{singular_name}_field"
+        end
+
+        def destination_field_path
+          "app/avo/fields/#{singular_name}_field.rb"
+        end
       end
     end
   end

data/lib/generators/avo/filter_generator.rb

@@ -5,20 +5,20 @@ module Generators
     class FilterGenerator < NamedBaseGenerator
       source_root File.expand_path("templates", __dir__)
 
-      class_option :multiple_select, type: :boolean
-      class_option :select, type: :boolean
-      class_option :text, type: :boolean
+      class_option :type, type: :string, default: "boolean"
 
       namespace "avo:filter"
 
       def create_resource_file
-        type = "boolean"
+        raise "Invalid filter type '#{options[:type]}'" unless filter_types.include? options[:type]
 
-        type = "multiple_select" if options[:multiple_select]
-        type = "select" if options[:select]
-        type = "text" if options[:text]
+        template "filters/#{options[:type]}_filter.tt", "app/avo/filters/#{singular_name}.rb"
+      end
+
+      private
 
-        template "filters/#{type}_filter.tt", "app/avo/filters/#{singular_name}.rb"
+      def filter_types
+        %w[boolean select text multiple_select]
       end
     end
   end

data/lib/generators/avo/js/install_generator.rb

@@ -31,7 +31,7 @@ module Generators
             end
 
             say "Ejecting the _head.html.erb partial"
-            Rails::Generators.invoke("avo:eject", [":head", "--skip-avo-version"], {destination_root: Rails.root})
+            Rails::Generators.invoke("avo:eject", ["--partial", ":head", "--skip-avo-version"], {destination_root: Rails.root})
 
             say "Adding the JS asset to the partial"
             append_to_file Rails.root.join("app", "views", "avo", "partials", "_head.html.erb"), "<%= javascript_importmap_tags \"avo.custom\" %>"
@@ -48,7 +48,7 @@ module Generators
             end
 
             say "Ejecting the _head.html.erb partial"
-            Rails::Generators.invoke("avo:eject", [":head", "--skip-avo-version"], {destination_root: Rails.root})
+            Rails::Generators.invoke("avo:eject", ["--partial", ":head", "--skip-avo-version"], {destination_root: Rails.root})
 
             say "Adding the JS asset to the partial"
             append_to_file Rails.root.join("app", "views", "avo", "partials", "_head.html.erb"), "<%= javascript_include_tag \"avo.custom\", \"data-turbo-track\": \"reload\", defer: true %>"

data/lib/generators/avo/resource_generator.rb

@@ -1,16 +1,19 @@
 require_relative "named_base_generator"
+require_relative "concerns/parent_controller"
 
 module Generators
   module Avo
     class ResourceGenerator < NamedBaseGenerator
+      include Generators::Avo::Concerns::ParentController
+
       source_root File.expand_path("templates", __dir__)
 
       namespace "avo:resource"
 
       class_option "model-class",
+        desc: "The name of the model.",
         type: :string,
-        required: false,
-        desc: "The name of the model."
+        required: false
 
       def create
         template "resource/resource.tt", "app/avo/resources/#{resource_name}.rb"
@@ -18,7 +21,7 @@ module Generators
       end
 
       def resource_class
-        "#{class_name.remove(":")}Resource"
+        class_name.remove(":").to_s
       end
 
       def controller_class
@@ -26,7 +29,7 @@ module Generators
       end
 
       def resource_name
-        "#{model_resource_name}_resource"
+        model_resource_name.to_s
       end
 
       def controller_name
@@ -132,16 +135,16 @@ module Generators
       def generated_fields_template
         return if fields.blank?
 
-        fields_string = "\n  # Fields generated from the model"
+        fields_string = ""
 
         fields.each do |field_name, field_options|
           # if field_options are not available (likely a missing resource for an association), skip the field
-          fields_string += "\n  # Could not generate a field for #{field_name}" and next unless field_options
-          
+          fields_string += "\n    # Could not generate a field for #{field_name}" and next unless field_options
+
           options = ""
           field_options[:options].each { |k, v| options += ", #{k}: #{v}" } if field_options[:options].present?
 
-          fields_string += "\n  #{field_string field_name, field_options[:field], options}"
+          fields_string += "\n    #{field_string field_name, field_options[:field], options}"
         end
 
         fields_string
@@ -163,7 +166,7 @@ module Generators
 
       def fields_from_model_rich_texts
         rich_texts.each do |name, _|
-          fields[(name.delete_prefix("rich_text_"))] = {field: "trix"}
+          fields[name.delete_prefix("rich_text_")] = {field: "trix"}
         end
       end
 

data/lib/generators/avo/scope_generator.rb

@@ -0,0 +1,15 @@
+require_relative "named_base_generator"
+
+module Generators
+  module Avo
+    class ScopeGenerator < NamedBaseGenerator
+      source_root File.expand_path("templates", __dir__)
+
+      namespace "avo:scope"
+
+      def create
+        template "scope.tt", "app/avo/scopes/#{singular_name}.rb"
+      end
+    end
+  end
+end