avo 3.0.0.pre18 → 3.0.0.pre19

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/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(":")}"
+        class_name.remove(":").to_s
       end
 
       def controller_class
@@ -26,7 +29,7 @@ module Generators
       end
 
       def resource_name
-        "#{model_resource_name}"
+        model_resource_name.to_s
       end
 
       def controller_name
@@ -136,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
@@ -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/tailwindcss/install_generator.rb

@@ -11,17 +11,30 @@ module Generators
 
         def create_files
           unless tailwindcss_installed?
+            say "Installing Tailwindcss"
             system "./bin/bundle add tailwindcss-rails"
             system "./bin/rails tailwindcss:install"
           end
 
-          unless Rails.root.join("app", "assets", "stylesheets", "avo.tailwind.css").exist?
-            say "Add default app/assets/stylesheets/avo.tailwind.css"
-            copy_file template_path("avo.tailwind.css"), "app/assets/stylesheets/avo.tailwind.css"
+          unless (path = Rails.root.join("config", "avo", "tailwind.config.js")).exist?
+            say "Generating the Avo config file."
+            copy_file template_path("tailwind.config.js"), path
+          end
+
+          unless (path = Rails.root.join("app", "assets", "stylesheets", "avo", "tailwindcss")).exist?
+            say "Generating the tailwindcss directory."
+            directory ::Avo::Engine.root.join("app", "assets", "stylesheets", "css", "tailwindcss"), path
+          end
+
+
+          unless (path = Rails.root.join("app", "assets", "stylesheets", "avo" ,"tailwind.css")).exist?
+            say "Add default tailwind.css"
+            copy_file template_path("avo.tailwind.css"), path
           end
 
           if Rails.root.join("Procfile.dev").exist?
-            append_to_file "Procfile.dev", "avo_css: yarn avo:tailwindcss --watch\n"
+            say "Add #{cmd = "avo_css: yarn avo:tailwindcss --watch"} to Procfile.dev"
+            append_to_file "Procfile.dev", "#{cmd}\n"
           else
             say "Add default Procfile.dev"
             copy_file template_path("Procfile.dev"), "Procfile.dev"
@@ -30,17 +43,50 @@ module Generators
             run "gem install foreman"
           end
 
-          # Ensure that the _pre_head.html.erb template is available
-          unless Rails.root.join("app", "views", "avo", "partials", "_pre_head.html.erb").exist?
-            say "Ejecting the _pre_head.html.erb partial"
-            Rails::Generators.invoke("avo:eject", [":pre_head", "--skip-avo-version"], {destination_root: Rails.root})
+          script_name = "avo:tailwindcss"
+          script_command = "tailwindcss -i ./app/assets/stylesheets/avo/tailwind.css -o ./app/assets/builds/avo.tailwind.css -c ./config/avo/tailwind.config.js --minify"
+          pretty_script_command = "\"#{script_name}\": \"#{script_command}\""
+
+          if (path = Rails.root.join("package.json")).exist?
+            say "Add #{pretty_script_command} to package.json"
+            json_data = JSON.parse(File.read(path))
+            json_data["scripts"] ||= {}
+            json_data["scripts"][script_name] = script_command
+
+            File.open(path, 'w') do |file|
+              file.write(JSON.pretty_generate(json_data) + "\n")
+            end
+          else
+            say "package.json not found.", :yellow
+            say "Ensure you have the following script in your package.json file.", :yellow
+            say "\"scripts\": {\n" \
+              "  #{pretty_script_command}\n" \
+            "}", :green
           end
 
-          say "Adding the CSS asset to the partial"
-          prepend_to_file Rails.root.join("app", "views", "avo", "partials", "_pre_head.html.erb"), "<%= stylesheet_link_tag \"avo.tailwind.css\", media: \"all\" %>"
+          rake_enhance = <<~RUBY
 
-          say "Ensure you have the following script in your package.json file.", :yellow
-          say %("scripts": { "avo:tailwindcss": "tailwindcss -i ./app/assets/stylesheets/avo.tailwind.css -o ./app/assets/builds/avo.tailwind.css --minify" }), :green
+            Rake::Task["assets:precompile"].enhance(["avo:sym_link"])
+          RUBY
+
+          if (path = Rails.root.join("Rakefile")).exist?
+            say "Add #{rake_enhance.strip} to Rakefile"
+            append_to_file path, rake_enhance
+          else
+            say "Rakefile not found.", :yellow
+            say "Ensure you have the following code in your Rakefile file.", :yellow
+            say rake_enhance, :green
+          end
+
+          say "Make sure you run \"bundle exec rake avo:sym_link\" before compiling the assets with the \"#{script_name}\" task.", :green
+          if (path = Rails.root.join("bin", "dev")).exist?
+            lines = File.read(path).lines
+
+            # Insert the task after the shebang line (the first line)
+            lines.insert(1, "bundle exec rake avo:sym_link")
+
+            File.write(path, lines.join)
+          end
         end
 
         no_tasks do

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

@@ -1,15 +1,19 @@
 # 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
 
   ## == Licensing ==
-  config.license = 'community' # change this to 'pro' when you add the license key
   # config.license_key = ENV['AVO_LICENSE_KEY']
 
   ## == Set the context ==
@@ -66,6 +70,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

data/lib/generators/avo/templates/tailwindcss/avo.tailwind.css

@@ -1,6 +1,8 @@
-@tailwind base;
-@tailwind components;
-@tailwind utilities;
+@import 'tailwindcss/base';
+# Have all of Avo's custom and plugins styles available.
+@import '../../../../tmp/avo/base.css';
+@import 'tailwindcss/components';
+@import 'tailwindcss/utilities';
 
 /*
 

data/lib/generators/avo/templates/tailwindcss/tailwind.config.js

@@ -0,0 +1,11 @@
+const avoPreset = require('../../tmp/avo/tailwind.preset.js')
+
+module.exports = {
+  presets: [avoPreset],
+  content: [
+    ...avoPreset.content,
+    './app/views/**/*.html.erb',
+    './app/helpers/**/*.rb',
+    './app/javascript/**/*.js',
+  ]
+}

data/lib/tasks/avo_tasks.rake

@@ -1,8 +1,3 @@
-# desc 'Explaining what the task does'
-# task :avo do
-#   # Task goes here
-# end
-
 desc "Runs the update command for all Avo gems."
 task "avo:update" do
   system "bundle update avo avo-pro avo-advanced avo-dashboards avo_filters avo-menu avo_upgrade"
@@ -63,3 +58,36 @@ task "avo:gem_paths" do
   # avo:/Users/adrian/work/avocado/avo-3,avo_filters:/Users/adrian/work/avocado/advanced/avo_filters
   puts result
 end
+
+desc "Symlinks all Avo gems to tmp/avo/packages"
+task "avo:sym_link" do
+  base_path = Rails.root.join("tmp", "avo").to_s.gsub("/spec/dummy", "")
+  packages_path = "#{base_path}/packages"
+  if Dir.exist?(packages_path)
+    `rm -rf #{packages_path}/*`
+  else
+    `mkdir -p #{packages_path}`
+    `touch #{packages_path}/.keep`
+  end
+
+  ["avo", "avo-advanced", "avo-pro", "avo-dynamic_filters", "avo-dashboards", "avo-menu"].each do |gem|
+    path = `bundle show #{gem} 2> /dev/null`.chomp
+
+    unless path.empty?
+      puts "[Avo->] Linking #{gem} to #{path}"
+      `ln -s #{path} #{packages_path}/#{gem}`
+    end
+  end
+
+  base_css_path = Avo::Engine.root.join("app", "assets", "builds", "avo.base.css")
+  dest_css_path = "#{base_path}/base.css"
+  `rm #{dest_css_path}` if File.exist?("#{dest_css_path}")
+  puts "[Avo->] Linking avo.base.css to #{base_css_path}"
+  `ln -s #{base_css_path} #{dest_css_path}`
+
+  base_preset_path = Avo::Engine.root.join("tailwind.preset.js")
+  dest_preset_path = "#{base_path}/tailwind.preset.js"
+  `rm #{dest_preset_path}` if File.exist?("#{dest_preset_path}")
+  puts "[Avo->] Linking tailwind.preset.js to #{base_preset_path}"
+  `ln -s #{base_preset_path} #{dest_preset_path}`
+end