avo 3.0.1.beta2 → 3.0.1.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2032ff971d1b4fadddfd033ccc539b722d4296b766840575f71cf1edde3d5b33
-  data.tar.gz: eab6052b7a291a942a1871badbdb76f18b8797ec6b9e791d9ec7a51316705abe
+  metadata.gz: 737f7485e4fbc1d44c4241c0f39010b74d078f58e0cc06279223bb81e9878079
+  data.tar.gz: b19cc62af7812c430274e0f0b002843a7601ef16e81fa32b0dfc2ae8d96ca304
 SHA512:
-  metadata.gz: 8789e31fd450e04667412526084899ae175bcee356cd3d9f33a396610e773cadfa83294a2aeb7c800f527f94d77fdd0d4236073373af4544cd33141e61478bf6
-  data.tar.gz: c2b5d6df49088c094d0499e039de9793a1e8f2d37a7ddc9db0489b95ec8fec29594dbe6167ac7cd7361ab6f43198c613face277b59466480fa1122124bc1b5ec
+  metadata.gz: 995a9e1a12c9bce7368abdc7fb6b5cae46dff35603f3d7b51e4942a730d4f314f52fbfd04ee38948b3c919d3bf25440131559b5bed3a5af7331b608c50ef69d0
+  data.tar.gz: 8491c4c0b5a55144ee300574788591c45596b9b97e193e26688f01e8b319f0895eff3b3b55e9c7dca74bf18021f0cb00180f7d624bf22d4e7690daae1456c096

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    avo (3.0.1.beta2)
+    avo (3.0.1.beta4)
       actionview (>= 6.1)
       active_link_to
       activerecord (>= 6.1)

data/app/components/avo/views/resource_show_component.html.erb

@@ -4,7 +4,7 @@
     resource_name: @resource.class.to_s,
     record_id: @resource.record.id,
     selected_resources_name: @resource.model_key,
-    selected_resources: [@resource.record.id],
+    selected_resources: [@resource.record.to_param],
     **@resource.stimulus_data_attributes
   } do %>
   <%= render Avo::PanelComponent.new(name: title, description: @resource.description, display_breadcrumbs: @reflection.blank?, index: 0, data: { panel_id: "main" }) do |c| %>

data/app/controllers/avo/base_controller.rb

@@ -75,6 +75,8 @@ module Avo
       @resources = @records.map do |record|
         @resource.hydrate(record: record, params: params).dup
       end
+
+      set_component_for __method__
     end
 
     def show
@@ -98,6 +100,8 @@ module Avo
 
       add_breadcrumb @resource.record_title
       add_breadcrumb I18n.t("avo.details").upcase_first
+
+      set_component_for __method__
     end
 
     def new
@@ -119,6 +123,8 @@ module Avo
 
       add_breadcrumb @resource.plural_name.humanize, resources_path(resource: @resource)
       add_breadcrumb t("avo.new").humanize
+
+      set_component_for __method__, fallback_view: :edit
     end
 
     def create
@@ -161,6 +167,8 @@ module Avo
       add_breadcrumb t("avo.new").humanize
       set_actions
 
+      set_component_for :edit
+
       if saved
         create_success_action
       else
@@ -170,6 +178,8 @@ module Avo
 
     def edit
       set_actions
+
+      set_component_for __method__
     end
 
     def update
@@ -178,6 +188,8 @@ module Avo
       @resource = @resource.hydrate(record: @record, view: :edit, user: _current_user)
       set_actions
 
+      set_component_for :edit
+
       if saved
         update_success_action
       else
@@ -540,5 +552,31 @@ module Avo
     def pagy_query
       @query
     end
+
+    # Set the view component for the current view
+    # It will try to use the custom component if it's set, otherwise it will use the default one
+    def set_component_for(view, fallback_view: nil)
+      # Fetch the components from the resource
+      components = Avo::ExecutionContext.new(
+        target: @resource.components,
+        resource: @resource,
+        record: @record,
+        view: @view
+      ).handle
+
+      # If the component is not set, use the default one
+      if (custom_component = components.dig("resource_#{view}_component".to_sym)).nil?
+        return @component = "Avo::Views::Resource#{(fallback_view || view).to_s.classify}Component".constantize
+      end
+
+      # If the component is set, try to use it
+      @component = custom_component.to_s.safe_constantize
+
+      # If the component is not found, raise an error
+      if @component.nil?
+        raise "The component '#{custom_component}' was not found.\n" \
+        "That component was fetched from 'self.components' option inside '#{@resource.class}' resource."
+      end
+    end
   end
 end

data/app/helpers/avo/resources_helper.rb

@@ -38,7 +38,7 @@ module Avo
     end
 
     def item_selector_init(resource)
-      "data-resource-name='#{resource.model_key}' data-resource-id='#{resource.record.id}' data-controller='item-selector'"
+      "data-resource-name='#{resource.model_key}' data-resource-id='#{resource.record.to_param}' data-controller='item-selector'"
     end
 
     def item_selector_input(floating: false, size: :md)

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

@@ -21,7 +21,7 @@
         <%= @action.get_message %>
       </div>
       <%= hidden_field_tag :action_id, @action.param_id %>
-      <%= form.hidden_field :avo_resource_ids, value: params[:id] || params[:resource_ids], 'data-action-target': 'resourceIds' %>
+      <%= form.hidden_field :avo_resource_ids, value: params[:resource_ids], 'data-action-target': 'resourceIds' %>
       <%= form.hidden_field :avo_selected_query, 'data-action-target': 'selectedAllQuery' %>
       <%= form.hidden_field :arguments, value: params[:arguments] %>
       <% if @action.get_fields.present? %>

data/app/views/avo/base/edit.html.erb

@@ -1 +1 @@
-<%= render Avo::Views::ResourceEditComponent.new(resource: @resource, view: @view, actions: @actions) %>
+<%= render @component.new(resource: @resource, view: @view, actions: @actions) %>

data/app/views/avo/base/index.html.erb

@@ -1,5 +1,5 @@
 <%= render Avo::TurboFrameWrapperComponent.new(params[:turbo_frame]) do %>
-  <%= render Avo::Views::ResourceIndexComponent.new(
+  <%= render @component.new(
       resource: @resource,
       resources: @resources,
       records: @records,

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

@@ -1,2 +1,2 @@
-<%= render Avo::Views::ResourceEditComponent.new(resource: @resource, record: @record, view: @view, actions: @actions) %>
+<%= render @component.new(resource: @resource, record: @record, view: @view, actions: @actions) %>
 

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

@@ -1,5 +1,5 @@
 <%= render Avo::TurboFrameWrapperComponent.new(params[:turbo_frame]) do %>
-  <%= render Avo::Views::ResourceShowComponent.new(
+  <%= render @component.new(
     resource: @resource,
     reflection: @reflection,
     actions: @actions,

data/lib/avo/base_resource.rb

@@ -65,6 +65,7 @@ module Avo
     class_attribute :extra_params
     class_attribute :link_to_child_resource, default: false
     class_attribute :map_view
+    class_attribute :components, default: {}
 
     # EXTRACT:
     class_attribute :ordering
@@ -293,7 +294,11 @@ module Avo
 
       # def get_action_arguments / def get_filter_arguments / def get_scope_arguments
       define_method "get_#{entity}_arguments" do |entity_class|
-        send("get_#{plural_entity}").find { |entity| entity[:class].to_s == entity_class.to_s }[:arguments]
+        klass = send("get_#{plural_entity}").find { |entity| entity[:class].to_s == entity_class.to_s }
+        
+        raise "Couldn't find '#{entity_class}' in the 'def #{plural_entity}' method on your '#{self.class}' resource." if klass.nil?
+
+        klass[:arguments]
       end
     end
 

data/lib/avo/configuration.rb

@@ -43,6 +43,7 @@ module Avo
     attr_accessor :sign_out_path_name
     attr_accessor :resources
     attr_accessor :prefix_path
+    attr_accessor :resource_parent_controller
 
     def initialize
       @root_path = "/avo"
@@ -93,6 +94,7 @@ module Avo
       @authorization_client = :pundit
       @field_wrapper_layout = :inline
       @resources = nil
+      @resource_parent_controller = "Avo::ResourcesController"
     end
 
     def current_user_method(&block)

data/lib/avo/dsl/field_parser.rb

@@ -47,7 +47,7 @@ module Avo
         else
           # The symbol can be transformed to a class and found.
           class_name = as.to_s.camelize
-          field_class = "#{class_name}Field"
+          field_class = "Avo::Fields::#{class_name}Field"
 
           # Discover & load custom field classes
           if Object.const_defined? field_class

data/lib/avo/licensing/license_manager.rb

@@ -11,6 +11,9 @@ module Avo
           CommunityLicense.new @hq_response
         when "pro"
           ProLicense.new @hq_response
+        # temporary fix
+        when "advanced"
+          ProLicense.new @hq_response
         else
           NilLicense.new @hq_response
         end

data/lib/avo/version.rb

@@ -1,3 +1,3 @@
 module Avo
-  VERSION = "3.0.1.beta2" unless const_defined?(:VERSION)
+  VERSION = "3.0.1.beta4" unless const_defined?(:VERSION)
 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,20 @@ 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
 
       source_root ::Avo::Engine.root
 
@@ -21,19 +34,18 @@ 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
         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 --component Avo::Views::ResourceIndexComponent --scope users\n" \
+              "          rails g avo:eject --component avo/views/resource_index_component --scope users", :yellow
         end
       end
 
@@ -48,8 +60,84 @@ 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 eject(path, dest_path = nil)
+          copy_file ::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
+          # Underscore the component name
+          # Example: Avo::Views::ResourceIndexComponent => avo/views/resource_index_component
+          component = options[:component].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)
+          end
+
+          # Add the scope to the component if it's possible
+          if add_scope? component
+            component = component.gsub("avo/views/", "avo/views/#{options[:scope]}/")
+            added_scope = true
+          end
+
+          # Confirm the ejection
+          return unless confirm_ejection_on component.camelize
+
+          # 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|
+              modified_content = File.read(path).gsub("Avo::Views::", "Avo::Views::#{options[:scope].camelize}::")
+
+              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
+          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)
+        end
+
+        def add_scope?(component)
+          component.starts_with?("avo/views/") && 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/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"

data/lib/generators/avo/templates/initializer/avo.tt

@@ -66,6 +66,7 @@ Avo.configure do |config|
   # config.disabled_features = []
   # config.buttons_on_form_footers = true
   # config.field_wrapper_layout = true
+  # config.resource_parent_controller = "Avo::ResourcesController"
 
   ## == Branding ==
   # config.branding = {

data/lib/generators/avo/templates/resource/controller.tt

@@ -1,4 +1,4 @@
 # This controller has been generated to enable Rails' resource routes.
 # More information on https://docs.avohq.io/2.0/controllers.html
-class <%= controller_class %> < Avo::ResourcesController
+class <%= controller_class %> < <%= parent_controller %>
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: avo
 version: !ruby/object:Gem::Version
-  version: 3.0.1.beta2
+  version: 3.0.1.beta4
 platform: ruby
 authors:
 - Adrian Marin
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-07 00:00:00.000000000 Z
+date: 2023-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -1846,6 +1846,7 @@ files:
 - lib/generators/avo/action_generator.rb
 - lib/generators/avo/base_generator.rb
 - lib/generators/avo/card_generator.rb
+- lib/generators/avo/concerns/parent_controller.rb
 - lib/generators/avo/controller_generator.rb
 - lib/generators/avo/dashboard_generator.rb
 - lib/generators/avo/eject_generator.rb