avo 3.0.1.beta6 → 3.0.1.beta8

data/lib/avo/fields/base_field.rb

@@ -7,6 +7,7 @@ module Avo
       prepend Avo::Concerns::IsResourceItem
       include Avo::Concerns::IsVisible
       include Avo::Concerns::VisibleInDifferentViews
+      include Avo::Concerns::HasHelpers
       include Avo::Fields::Concerns::HasFieldName
       include Avo::Fields::Concerns::HasDefault
       include Avo::Fields::Concerns::HasHTMLAttributes
@@ -14,6 +15,7 @@ module Avo
       include Avo::Fields::Concerns::IsReadonly
       include Avo::Fields::Concerns::IsDisabled
       include Avo::Fields::Concerns::IsRequired
+      include Avo::Fields::Concerns::UseViewComponents
 
       include ActionView::Helpers::UrlHelper
 
@@ -73,11 +75,12 @@ module Avo
         @visible = args[:visible]
         @as_avatar = args[:as_avatar] || false
         @html = args[:html] || nil
-        @view = args[:view] || nil
+        @view = Avo::ViewInquirer.new(args[:view]) || nil
         @value = args[:value] || nil
         @stacked = args[:stacked] || nil
         @for_presentation_only = args[:for_presentation_only] || false
         @resource = args[:resource]
+        @components = args[:components] || {}
 
         @args = args
 
@@ -192,7 +195,8 @@ module Avo
             key: key,
             value: value,
             resource: resource,
-            field: self
+            field: self,
+            include: self.class.included_modules
           ).handle
         end
 
@@ -220,35 +224,8 @@ module Avo
         id.to_sym
       end
 
-      def view_component_name
-        "#{type.camelize}Field"
-      end
-
-      # For custom components the namespace will be different than Avo::Fields so we should take that into account.
-      def view_component_namespace
-        "#{self.class.to_s.deconstantize}::#{view_component_name}"
-      end
-
-      # Try and build the component class or fallback to a blank one
-      def component_for_view(view = :index)
-        # Use the edit variant for all "update" views
-        view = :edit if view.in? [:new, :create, :update]
-
-        component_class = "#{view_component_namespace}::#{view.to_s.camelize}Component"
-        component_class.constantize
-      rescue
-        unless Rails.env.test?
-          Avo.logger.info "Failed to find component for the `#{self.class}` field on the `#{view}` view."
-        end
-        # When returning nil, a race condition happens and throws an error in some environments.
-        # See https://github.com/avo-hq/avo/pull/365
-        ::Avo::BlankFieldComponent
-      end
-
       def record_errors
-        return {} if record.nil?
-
-        record.errors
+        record.nil? ? {} : record.errors
       end
 
       def type
@@ -289,11 +266,7 @@ module Avo
       private
 
       def model_or_class(model)
-        if model.instance_of?(String)
-          "class"
-        else
-          "model"
-        end
+        model.instance_of?(String) ? "class" : "model"
       end
 
       def is_model?(model)
@@ -305,7 +278,7 @@ module Avo
       end
 
       def on_create?
-        @view.in?([:new, :create])
+        @view.in?(%w[new create])
       end
 
       def in_action?

data/lib/avo/fields/belongs_to_field.rb

@@ -259,7 +259,7 @@ module Avo
       end
 
       def name
-        return polymorphic_as.to_s.humanize if polymorphic_as.present? && view == :index
+        return polymorphic_as.to_s.humanize if polymorphic_as.present? && view.index?
 
         super
       end

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

@@ -13,6 +13,8 @@ module Avo
         # get_html :classes, view: :show, element: :wrapper
         # get_html :styles, view: :index, element: :wrapper
         def get_html(name = nil, element:, view:)
+          view = view.to_sym if view.present?
+
           if [view, element].any?(&:nil?)
             default_attribute_value name
           end

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

@@ -0,0 +1,45 @@
+module Avo
+  module Fields
+    module Concerns
+      module UseViewComponents
+        extend ActiveSupport::Concern
+
+        included do
+          attr_reader :components
+        end
+
+        def view_component_name
+          "#{type.camelize}Field"
+        end
+
+        # For custom components the namespace will be different than Avo::Fields so we should take that into account.
+        def view_component_namespace
+          "#{self.class.to_s.deconstantize}::#{view_component_name}"
+        end
+
+        # Try and build the component class or fallback to a blank one
+        def component_for_view(view = :index)
+          # Use the edit variant for all "update" views
+          view = :edit if view.in? [:new, :create, :update]
+
+          custom_components = Avo::ExecutionContext.new(
+            target: components,
+            resource: @resource,
+            record: @record,
+            view: view
+          ).handle
+
+          component_class = custom_components.dig("#{view}_component".to_sym) || "#{view_component_namespace}::#{view.to_s.camelize}Component"
+          component_class.to_s.constantize
+        rescue
+          unless Rails.env.test?
+            Avo.logger.info "Failed to find component for the `#{self.class}` field on the `#{view}` view."
+          end
+          # When returning nil, a race condition happens and throws an error in some environments.
+          # See https://github.com/avo-hq/avo/pull/365
+          ::Avo::BlankFieldComponent
+        end
+      end
+    end
+  end
+end

data/lib/avo/fields/has_base_field.rb

@@ -79,8 +79,8 @@ module Avo
 
       # Adds the view override component
       # has_one, has_many, has_and_belongs_to_many fields don't have edit views
-      def component_for_view(view = :index)
-        view = :show if view.in? [:new, :create, :update, :edit]
+      def component_for_view(view = Avo::ViewInquirer.new("index"))
+        view = Avo::ViewInquirer.new("show") if view.in? %w[new create update edit]
 
         super view
       end

data/lib/avo/resources/items/item_group.rb

@@ -3,7 +3,7 @@ class Avo::Resources::Items::ItemGroup
 
   include Avo::Concerns::HasItems
   include Avo::Concerns::HasItemType
-  include Avo::Concerns::IsVisible
+  include Avo::Concerns::VisibleItems
   include Avo::Concerns::VisibleInDifferentViews
 
   attr_reader :name
@@ -13,7 +13,7 @@ class Avo::Resources::Items::ItemGroup
 
   def initialize(name: nil, description: nil, view: nil, **args)
     @name = name
-    @view = view
+    @view = Avo::ViewInquirer.new view
     @description = description
     @items_holder = Avo::Resources::Items::Holder.new
     @args = args

data/lib/avo/resources/items/row.rb

@@ -2,7 +2,7 @@ class Avo::Resources::Items::Row
   include Avo::Concerns::IsResourceItem
   include Avo::Concerns::HasItems
   include Avo::Concerns::HasItemType
-  include Avo::Concerns::IsVisible
+  include Avo::Concerns::VisibleItems
 
   class_attribute :item_type, default: :row
 
@@ -12,12 +12,12 @@ class Avo::Resources::Items::Row
   delegate :items, :add_item, to: :items_holder
 
   def initialize(view: nil)
-    @view = view
+    @view = Avo::ViewInquirer.new view
     @items_holder = Avo::Resources::Items::Holder.new
   end
 
   def hydrate(view: nil, resource: nil, **args)
-    @view = view
+    @view = Avo::ViewInquirer.new view
     @resource = resource
 
     self

data/lib/avo/resources/items/sidebar.rb

@@ -13,7 +13,7 @@ class Avo::Resources::Items::Sidebar
   def initialize(name: nil, view: nil, **args)
     @name = name
     @items_holder = Avo::Resources::Items::Holder.new
-    @view = view
+    @view = Avo::ViewInquirer.new view
     @args = args
 
     post_initialize if respond_to?(:post_initialize)

data/lib/avo/resources/items/tab.rb

@@ -3,7 +3,7 @@ class Avo::Resources::Items::Tab
 
   include Avo::Concerns::HasItems
   include Avo::Concerns::HasItemType
-  include Avo::Concerns::IsVisible
+  include Avo::Concerns::VisibleItems
   include Avo::Concerns::VisibleInDifferentViews
 
   delegate :items, :add_item, to: :items_holder
@@ -14,7 +14,7 @@ class Avo::Resources::Items::Tab
     @name = name
     @description = description
     @items_holder = Avo::Resources::Items::Holder.new
-    @view = view
+    @view = Avo::ViewInquirer.new view
     @args = args
 
     post_initialize if respond_to?(:post_initialize)

data/lib/avo/resources/items/tab_group.rb

@@ -12,7 +12,7 @@ class Avo::Resources::Items::TabGroup
   def initialize(index: 0, view: nil, style: nil, **args)
     @index = index
     @items_holder = Avo::Resources::Items::Holder.new
-    @view = view
+    @view = Avo::ViewInquirer.new view
     @style = style
     @args = args
 

data/lib/avo/resources/resource_manager.rb

@@ -152,7 +152,12 @@ module Avo
       def get_available_resources(user = nil)
         valid_resources
           .select do |resource|
-            Services::AuthorizationService.authorize user, resource.model_class, Avo.configuration.authorization_methods.stringify_keys["index"], raise_exception: false
+            resource.authorization.class.authorize(
+              user,
+              resource.model_class,
+              Avo.configuration.authorization_methods.stringify_keys["index"],
+              raise_exception: false
+            )
           end
           .sort_by { |r| r.name }
       end

data/lib/avo/version.rb

@@ -1,3 +1,3 @@
 module Avo
-  VERSION = "3.0.1.beta6" unless const_defined?(:VERSION)
+  VERSION = "3.0.1.beta8" 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]
+    FORM_VIEWS = %w[new edit]
+
+    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

@@ -116,6 +116,15 @@ module Avo
       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

data/lib/generators/avo/eject_generator.rb

@@ -18,6 +18,16 @@ module Generators
         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
 
       namespace "avo:eject"
@@ -38,12 +48,17 @@ module Generators
           eject_partial
         elsif options[:component].present?
           eject_component
+        elsif options["field-components"].present?
+          eject_field_components
         else
           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
@@ -60,8 +75,14 @@ module Generators
           path.present? && File.file?(::Avo::Engine.root.join(path))
         end
 
-        def eject(path, dest_path = nil)
-          copy_file ::Avo::Engine.root.join(path), ::Rails.root.join(dest_path || 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
@@ -83,27 +104,33 @@ module Generators
           end
         end
 
-        def eject_component
+        def eject_component(component_to_eject = options[:component], confirmation: true)
           # Underscore the component name
           # Example: Avo::Views::ResourceIndexComponent => avo/views/resource_index_component
-          component = options[:component].underscore
+          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 `#{options[:component]}` component.", :yellow)
+            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 = component.gsub("avo/views/", "avo/views/#{options[:scope]}/")
+            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
-          return unless confirm_ejection_on component.camelize
+          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"
@@ -117,27 +144,77 @@ module Generators
           # Example: Avo::Views::ResourceIndexComponent => Avo::Views::Admins::ResourceIndexComponent
           if added_scope
             [dest_rb, dest_erb].each do |path|
-              modified_content = File.read(path).gsub("Avo::Views::", "Avo::Views::#{options[:scope].camelize}::")
+              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
 
-            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
+            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)
-          say("By ejecting the '#{path}' \033[1myou'll take on the responsibility for maintain it.", :yellow)
-          yes?("Are you sure you want to eject the '#{path}'? [y/N]", :yellow)
+        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/") && options[:scope].present?
+          (component.starts_with?("avo/views/") || component.starts_with?("avo/fields/")) && options[:scope].present?
         end
       end
     end

data/lib/generators/avo/resource_generator.rb

@@ -21,7 +21,7 @@ module Generators
       end
 
       def resource_class
-        "#{class_name.remove(":")}"
+        class_name.remove(":").to_s
       end
 
       def controller_class
@@ -29,7 +29,7 @@ module Generators
       end
 
       def resource_name
-        "#{model_resource_name}"
+        model_resource_name.to_s
       end
 
       def controller_name
@@ -139,12 +139,12 @@ module Generators
 
         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
@@ -166,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/templates/initializer/avo.tt

@@ -1,10 +1,15 @@
 # For more information regarding these settings check out our docs https://docs.avohq.io
+# The values disaplayed here are the default ones. Uncomment and change them to fit your needs.
 Avo.configure do |config|
   ## == Routing ==
   config.root_path = '/<%= options[:path] %>'
   # used only when you have custom `map` configuration in your config.ru
   # config.prefix_path = "/internal"
 
+  # Sometimes you migth want to mount Avo's engines yourself.
+  # https://docs.avohq.io/3.0/routing.html
+  # config.mount_avo_engines = true
+
   # Where should the user be redirected when visting the `/<%= options[:path] %>` url
   # config.home_path = nil