avo 2.14.3.pre.4.tosqlfix → 2.14.3.pre.5.nosprockets

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ca2d8bf622f2be404af63aba48284bd741bdc3b77731f8e365921ffd274e7af
-  data.tar.gz: 65bb6d4b73155e0ad8e0c8efb3d6aaed6985ad0e97b2ff2bdda3af95933ec04c
+  metadata.gz: b277fe8fdc0cd240ea697b7d68a43af06761d12d5be000c6717da4eda00e5a88
+  data.tar.gz: 9e9fad003131d2188bec5eee8358571e2ccb841c4fb9fc3f8f03f17688cf177a
 SHA512:
-  metadata.gz: 4a081b4459f0773f7a9e9932632efe96e67c3a96265331e241280d5e883b93f9d1910ec391792ebe4ad3076fd522d6ac62e159bf0df7a196d96d1d48aff4d2a6
-  data.tar.gz: 1167d44bde57b81f5b9159dd6658a7352f3a00f252c327762c2f21bba487dc0549a7a77c79ddeab34180463a46c42e11fb834ba51f3704d228250380de32e824
+  metadata.gz: 17f9bfe06002beb679269d7011f94ab229fa27b48edb6a7bec44f5e5e59fa0ec2593c2b94da575bfc419bd814f99f4ca7451cddb1240ce96b56936a43437bd2f
+  data.tar.gz: 26fd511e67b214f81959f404272cd4878d1f8d6396fd2b3e886a7fd985cf7bc9892ac8abb55ea61d9bee8aef0e8844d56f6bbe4adc0d5b42b0e4b6b978075df1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    avo (2.14.3.pre.4.tosqlfix)
+    avo (2.14.3.pre.5.nosprockets)
       active_link_to
       addressable
       breadcrumbs_on_rails

data/app/components/avo/base_component.rb

@@ -9,10 +9,9 @@ class Avo::BaseComponent < ViewComponent::Base
 
   private
 
-  # Figure out what is the corresponding field for this @reflection
+  # Use the @parent_resource to fetch the field using the @reflection name.
   def field
-    fields = ::Avo::App.get_resource_by_model_name(@reflection.active_record.name).get_field_definitions
-    fields.find { |f| f.id == @reflection.name }
+    @parent_resource.get_field_definitions.find { |f| f.id == @reflection.name }
   rescue
     nil
   end

data/app/components/avo/resource_component.rb

@@ -4,6 +4,7 @@ class Avo::ResourceComponent < Avo::BaseComponent
   attr_reader :has_many_panels
   attr_reader :has_as_belongs_to_many_panels
   attr_reader :resource_tools
+  attr_reader :resource
   attr_reader :view
 
   def can_create?
@@ -19,7 +20,7 @@ class Avo::ResourceComponent < Avo::BaseComponent
   end
 
   def can_detach?
-    authorize_association_for("detach")
+    authorize_association_for(:detach)
   end
 
   def detach_path
@@ -53,7 +54,7 @@ class Avo::ResourceComponent < Avo::BaseComponent
 
     if @reflection.present?
       # Fetch the appropiate resource
-      reflection_resource = ::Avo::App.get_resource_by_model_name(@reflection.active_record.name)
+      reflection_resource = field.resource
       # Fetch the model
       # Hydrate the resource with the model if we have one
       reflection_resource.hydrate(model: @parent_model) if @parent_model.present?

data/app/components/avo/sidebar_component.html.erb

@@ -57,7 +57,7 @@
         <%= render partial: "/avo/partials/sidebar_extra" %>
       </div>
     </div>
-    <%= helpers.render_license_warnings %>
+    <%= helpers.render_license_warnings unless Rails.env.production? %>
     <%= render Avo::SidebarProfileComponent.new user: helpers._current_user %>
   </div>
 </div>

data/app/components/avo/views/resource_edit_component.rb

@@ -4,8 +4,6 @@ class Avo::Views::ResourceEditComponent < Avo::ResourceComponent
   include Avo::ResourcesHelper
   include Avo::ApplicationHelper
 
-  attr_reader :view
-
   def initialize(resource: nil, model: nil, actions: [], view: :edit)
     @resource = resource
     @model = model

data/app/controllers/avo/debug_controller.rb

@@ -13,12 +13,10 @@ module Avo
 
       if license.valid?
         flash[:notice] = "avohq.io responded: \"#{license.id.humanize} license is valid\"."
+      elsif license.response['reason'].present?
+        flash[:error] = "avohq.io responded: \"#{license.response['reason']}\"."
       else
-        if license.response['reason'].present?
-          flash[:error] = "avohq.io responded: \"#{license.response['reason']}\"."
-        else
-          flash[:error] = license.response['error']
-        end
+        flash[:error] = license.response['error']
       end
 
       redirect_back fallback_location: avo.avo_private_debug_index_path

data/app/controllers/avo/team_users_controller.rb

@@ -0,0 +1,4 @@
+# This controller has been generated to enable Rails' resource routes.
+# You shouldn't need to modify it in order to use Avo.
+class Avo::TeamUsersController < Avo::ResourcesController
+end

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

@@ -20,7 +20,20 @@
     <% c.bare_content do %>
       <div class="grid gap-4 sm:grid-cols-3">
         <div class="relative flex flex-col bg-white rounded shadow-panel p-4 space-y-4 h-full col-span-1">
+        <div class="flex justify-between w-full">
           <div class="font-semibold">License info</div>
+            <div class="flex justify-self-end">
+              <%= a_button style: :outline,
+                color: :blue,
+                url: "#{root_path}avo_private/debug/refresh_license",
+                method: :post,
+                loading: true,
+                size: :xs,
+                icon: 'heroicons/outline/refresh' do %>
+                Refresh license
+              <% end %>
+            </div>
+        </div>
           <div class="flex flex-col flex-1">
             <div>
               <div class="text-xl font-semibold"><%= license.name %></div>
@@ -54,16 +67,6 @@
                 </dl>
               </div>
             </div>
-            <div class="flex justify-end mt-4">
-              <%= a_button style: :outline,
-                color: :blue,
-                url: "#{root_path}avo_private/debug/refresh_license",
-                method: :post,
-                loading: true,
-                icon: 'heroicons/outline/refresh' do %>
-                Refresh license
-              <% end %>
-            </div>
           </div>
         </div>
         <div class="relative bg-white rounded shadow-panel p-4 space-y-4 col-span-2">

data/app/views/avo/sidebar/_license_warnings.html.erb

@@ -2,5 +2,5 @@
   <%= render_license_warning title: 'Trial Mode', message: 'You are experiencing paid features that need to be licensed before deploying this site. Enjoy!' %>
 <% end %>
 <% if license[:error].present? && !(Avo.configuration.display_license_request_timeout_error === false && license[:error] === "Request timeout.") %>
-  <%= render_license_warning title: 'Avo HQ Error', message: "#{license[:error]}. Checking back every 5 minutes." %>
+  <%= render_license_warning title: 'Avo HQ Error', message: "#{license[:error]} Checking back every 5 minutes." %>
 <% end %>

data/app/views/layouts/avo/application.html.erb

@@ -6,17 +6,17 @@
     <%= csrf_meta_tags %>
     <%= csp_meta_tag %>
     <%= render partial: 'avo/partials/javascript' %>
-    <%= render partial: 'avo/partials/head' %>
     <% if Avo::PACKED %>
-      <%= javascript_include_tag "/avo-assets/avo", "data-turbo-track": "reload", defer: true %>
-      <%= stylesheet_link_tag "/avo-assets/avo", "data-turbo-track": "reload", defer: true %>
+      <%= javascript_include_tag "/avo-assets/avo.base", "data-turbo-track": "reload", defer: true %>
+      <%= stylesheet_link_tag "/avo-assets/avo.base", "data-turbo-track": "reload", defer: true %>
     <% else %>
-      <%= javascript_include_tag "avo", "data-turbo-track": "reload", defer: true %>
-      <%= stylesheet_link_tag "avo", "data-turbo-track": "reload", defer: true %>
+      <%= javascript_include_tag "avo.base", "data-turbo-track": "reload", defer: true %>
+      <%= stylesheet_link_tag "avo.base", "data-turbo-track": "reload", defer: true %>
       <% if Rails.env.development? %>
         <%= javascript_include_tag "hotwire-livereload", defer: true %>
       <% end %>
     <% end %>
+    <%= render partial: 'avo/partials/head' %>
   </head>
   <body class="bg-application os-mac">
     <div class="relative flex flex-1 w-full min-h-full" data-controller="sidebar" data-sidebar-open-value="<%= @sidebar_open %>">

data/lib/avo/app.rb

@@ -161,12 +161,12 @@ module Avo
 
         hq = Avo::Licensing::HQ.new(request)
 
-        payload[:thread_count] = get_thread_count
-        payload[:hq_payload] = hq&.payload
         payload[:license_id] = Avo::App&.license&.id
         payload[:license_valid] = Avo::App&.license&.valid?
         payload[:license_payload] = Avo::App&.license&.payload
         payload[:license_response] = Avo::App&.license&.response
+        payload[:hq_payload] = hq&.payload
+        payload[:thread_count] = get_thread_count
         payload[:license_abilities] = Avo::App&.license&.abilities
         payload[:cache_store] = self.cache_store&.class&.to_s
         payload[:avo_metadata] = hq&.avo_metadata

data/lib/avo/base_resource.rb

@@ -20,7 +20,6 @@ module Avo
     delegate :context, to: ::Avo::App
 
     attr_accessor :view
-    attr_accessor :model
     attr_accessor :reflection
     attr_accessor :user
     attr_accessor :params
@@ -111,6 +110,11 @@ module Avo
       end
     end
 
+    def record
+      @model
+    end
+    alias :model :record
+
     def hydrate(model: nil, view: nil, user: nil, params: nil)
       @view = view if view.present?
       @user = user if user.present?

data/lib/avo/concerns/fetches_things.rb

@@ -51,10 +51,15 @@ module Avo
         #
         # get_resource_by_name('User') => UserResource
         # get_resource_by_name(User) => UserResource
-        def get_resource_by_model_name(name)
+        def get_resource_by_model_name(klass)
+          # Fetch the mappings imposed by the user.
+          # If they are present, use those ones.
+          mapping = get_mapping_for_model klass
+          return get_resource(mapping) if mapping.present?
+
           valid_resources
             .find do |resource|
-              resource.model_class.model_name.name == name.to_s
+              resource.model_class.model_name.name == klass.to_s
             end
         end
 
@@ -128,6 +133,12 @@ module Avo
 
           get_sidebar_partials
         end
+
+        private
+
+        def get_mapping_for_model(klass)
+          (Avo.configuration.model_resource_mapping || {}).stringify_keys.transform_values(&:to_s)[klass.to_s]
+        end
       end
     end
   end

data/lib/avo/configuration.rb

@@ -34,6 +34,7 @@ module Avo
     attr_accessor :buttons_on_form_footers
     attr_accessor :main_menu
     attr_accessor :profile_menu
+    attr_accessor :model_resource_mapping
     attr_accessor :tabs_style
 
     def initialize
@@ -79,6 +80,7 @@ module Avo
       @buttons_on_form_footers = false
       @main_menu = nil
       @profile_menu = nil
+      @model_resource_mapping = {}
       @tabs_style = :tabs
     end
 

data/lib/avo/licensing/h_q.rb

@@ -153,6 +153,8 @@ module Avo
       end
 
       def cache_response(response: nil, time: CACHE_TIME)
+        response = normalize_response response
+
         response.merge!(
           expiry: time,
           fetched_at: Time.now,
@@ -164,6 +166,21 @@ module Avo
         response
       end
 
+      def normalize_response(response)
+        if response.is_a? Hash
+          response
+        else
+          {
+            normalized_response: JSON.stringify(response)
+          }
+        end
+        response.merge({})
+      rescue
+        {
+          normalized_response: "rescued"
+        }
+      end
+
       def perform_request
         ::Rails.logger.debug "[Avo] Performing request to avohq.io API to check license availability." if Rails.env.development?
 
@@ -199,7 +216,12 @@ module Avo
       end
 
       def cache_and_return_error(error, exception_message = "")
-        cache_response response: {error: error, exception_message: exception_message}.stringify_keys, time: 5.minutes.to_i
+        cache_response response: {
+          id: Avo.configuration.license,
+          valid: true,
+          error: error,
+          exception_message: exception_message
+        }.stringify_keys, time: 5.minutes.to_i
       end
 
       def has_cached_response

data/lib/avo/licensing/license_manager.rb

@@ -17,7 +17,7 @@ module Avo
       end
 
       def self.refresh_license(request)
-        self.new(Licensing::HQ.new(request).fresh_response).license
+        new(Licensing::HQ.new(request).fresh_response).license
       end
     end
   end

data/lib/avo/svg_finder.rb

@@ -22,18 +22,22 @@ class Avo::SvgFinder
       Avo::Engine.root.join(@filename).to_s,
     ]
 
-    path = paths.find do |path|
+    paths.find do |path|
       File.exist? path
     end
-
-    path
   end
 
   def default_strategy
-    if ::Rails.application.config.assets.compile
+    # If the app uses Propshaft, grab it from there
+    if defined?(Propshaft)
+      asset_path = ::Rails.application.assets.load_path.find(@filename)
+      asset_path&.path
+    elsif ::Rails.application.config.assets.compile
+      # Grab the asset from the compiled asset manifest
       asset = ::Rails.application.assets[@filename]
       Pathname.new(asset.filename) if asset.present?
     else
+      # Grab the asset from the manifest
       manifest = ::Rails.application.assets_manifest
       asset_path = manifest.assets[@filename]
       unless asset_path.nil?
@@ -42,4 +46,3 @@ class Avo::SvgFinder
     end
   end
 end
-

data/lib/avo/version.rb

@@ -1,3 +1,3 @@
 module Avo
-  VERSION = "2.14.3.pre.4.tosqlfix" unless const_defined?(:VERSION)
+  VERSION = "2.14.3.pre.5.nosprockets" unless const_defined?(:VERSION)
 end

data/lib/generators/avo/base_generator.rb

@@ -7,7 +7,11 @@ module Generators
 
       def initialize(*args)
         super(*args)
-        invoke "avo:version", *args
+
+        # Don't output the version if requested so
+        unless args.include?(["--no-avo-version"])
+          invoke "avo:version", *args
+        end
       end
     end
   end

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

@@ -0,0 +1,64 @@
+require_relative "../base_generator"
+
+module Generators
+  module Avo
+    module Js
+      class InstallGenerator < BaseGenerator
+        source_root File.expand_path("../templates", __dir__)
+
+        namespace "avo:js:install"
+        desc "Add custom JavaScript assets to your Avo project."
+
+        # possible values: importmap or esbuild
+        class_option :bundler, type: :string, default: "importmap"
+
+        def create_files
+          case options[:bundler].to_s
+          when "importmap"
+            install_for_importmap
+          when "esbuild"
+            install_for_esbuild
+          else
+            say "We don't know how to install Avo JS for this bundler \"#{options[:bundler]}\""
+          end
+        end
+
+        no_tasks do
+          def install_for_importmap
+            unless Rails.root.join("app", "javascript", "avo.custom.js").exist?
+              say "Add default app/javascript/avo.custom.js"
+              copy_file template_path("avo.custom.js"), "app/javascript/avo.custom.js"
+            end
+
+            say "Ejecting the _head.html.erb partial"
+            Rails::Generators.invoke("avo:eject", [":head", "--no-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\" %>"
+
+            # pin to importmap
+            say "Pin the new entrypoint to your importmap config"
+            append_to_file Rails.root.join("config", "importmap.rb"), "\n# Avo custom JS entrypoint\npin \"avo.custom\", preload: true\n"
+          end
+
+          def install_for_esbuild
+            unless Rails.root.join("app", "javascript", "avo.custom.js").exist?
+              say "Add default app/javascript/avo.custom.js"
+              copy_file template_path("avo.custom.js"), "app/javascript/avo.custom.js"
+            end
+
+            say "Ejecting the _head.html.erb partial"
+            Rails::Generators.invoke("avo:eject", [":head", "--no-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 %>"
+          end
+
+          def template_path(filename)
+            Pathname.new(__dir__).join("..", "templates", "js", filename).to_s
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+require_relative "../base_generator"
+
+module Generators
+  module Avo
+    module Tailwindcss
+      class InstallGenerator < BaseGenerator
+        source_root File.expand_path("../templates", __dir__)
+
+        namespace "avo:tailwindcss:install"
+        desc "Add Tailwindcss to your Avo project."
+
+        def create_files
+          unless tailwindcss_installed?
+            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"
+          end
+
+          if Rails.root.join("Procfile.dev").exist?
+            append_to_file "Procfile.dev", "css: bin/rails avo:tailwindcss:watch\n"
+          else
+            say "Add default Procfile.dev"
+            copy_file template_path("Procfile.dev"), "Procfile.dev"
+
+            say "Ensure foreman is installed"
+            run "gem install foreman"
+          end
+
+          append_to_file "Procfile.dev", "avo_css: bin/rails tailwindcss:watch\n"
+
+          say "Ejecting the _head.html.erb partial"
+          Rails::Generators.invoke("avo:eject", [":head", "--no-avo-version"], {destination_root: Rails.root})
+
+          say "Adding the CSS asset to the partial"
+          prepend_to_file Rails.root.join("app", "views", "avo", "partials", "_head.html.erb"), "<%= stylesheet_link_tag \"avo.tailwind.css\", media: \"all\" %>"
+        end
+
+        no_tasks do
+          def template_path(filename)
+            Pathname.new(__dir__).join("..", "templates", "tailwindcss", filename).to_s
+          end
+
+          def tailwindcss_installed?
+            Rails.root.join("config", "tailwind.config.js").exist? || Rails.root.join("tailwind.config.js").exist?
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -34,19 +34,23 @@ Avo.configure do |config|
   ## == Localization ==
   # config.locale = 'en-US'
 
+  ## == Resource options ==
+  # config.resource_controls = :right
+  # config.model_resource_mapping = {}
+  # config.default_view_type = :table
+  # config.per_page = 24
+  # config.per_page_steps = [12, 24, 48, 72]
+  # config.via_per_page = 8
+  # config.id_links_to_resource = false
+  # config.cache_resources_on_index_view = true
+
   ## == Customization ==
   # config.app_name = 'Avocadelicious'
   # config.timezone = 'UTC'
   # config.currency = 'USD'
-  # config.per_page = 24
-  # config.per_page_steps = [12, 24, 48, 72]
-  # config.via_per_page = 8
-  # config.default_view_type = :table
   # config.hide_layout_when_printing = false
-  # config.id_links_to_resource = false
   # config.full_width_container = false
   # config.full_width_index_view = false
-  # config.cache_resources_on_index_view = true
   # config.search_debounce = 300
   # config.view_component_path = "app/components"
   # config.display_license_request_timeout_error = true
@@ -54,7 +58,6 @@ Avo.configure do |config|
   # config.resource_controls = :right
   # config.tabs_style = :tabs # can be :tabs or :pills
 
-
   ## == Breadcrumbs ==
   # config.display_breadcrumbs = true
   # config.set_initial_breadcrumbs do

data/lib/generators/avo/templates/js/avo.custom.js

@@ -0,0 +1,2 @@
+// eslint-disable-next-line no-console
+console.log('Hi from Avo custom JS 👋')

data/lib/generators/avo/templates/tailwindcss/Procfile.dev

@@ -0,0 +1,2 @@
+web: bin/rails server -p 3000
+css: bin/rails avo:tailwindcss:watch

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

@@ -0,0 +1,13 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+
+/*
+
+@layer components {
+  .btn-primary {
+    @apply py-2 px-4 bg-blue-200;
+  }
+}
+
+*/

data/lib/tasks/avo_tasks.rake

@@ -3,9 +3,9 @@
 #   # Task goes here
 # end
 
-desc 'Installs Avo assets and bundles them for when you want to use the GitHub repo in your app'
-task 'avo:build-assets' do
-  spec = get_gem_spec 'avo'
+desc "Installs Avo assets and bundles them for when you want to use the GitHub repo in your app"
+task "avo:build-assets" do
+  spec = get_gem_spec "avo"
   # Uncomment to enable only when the source is github.com
   # enabled = spec.source.to_s.include?('https://github.com/avo-hq/avo')
   enabled = true
@@ -15,8 +15,8 @@ task 'avo:build-assets' do
     path = spec.full_gem_path
 
     Dir.chdir(path) do
-      system 'yarn'
-      system 'yarn prod:build'
+      system "yarn"
+      system "yarn prod:build"
     end
 
     puts "Done"
@@ -28,10 +28,10 @@ end
 # From
 # https://stackoverflow.com/questions/9322078/programmatically-determine-gems-path-using-bundler
 def get_gem_spec(name)
-  spec = Bundler.load.specs.find{|s| s.name == name }
+  spec = Bundler.load.specs.find { |s| s.name == name }
   raise GemNotFound, "Could not find gem '#{name}' in the current bundle." unless spec
-  if spec.name == 'bundler'
-    return File.expand_path('../../../', __FILE__)
+  if spec.name == "bundler"
+    return File.expand_path("../../../", __FILE__)
   end
 
   spec

data/lib/tasks/tailwindcss_rails.rake

@@ -0,0 +1,24 @@
+# Use the user provided asset or use the default
+ASSET_FILE = ARGV[0] || "app/assets/builds/avo.tailwind.css"
+# Se the tailwindcss-rails package name
+TAILWINDCSS_RAILS = "tailwindcss-rails"
+
+# Check if tailwindcss-rails is being used
+if Gem.loaded_specs.key? TAILWINDCSS_RAILS
+  # Get the path
+  GEM_PATH = Gem.loaded_specs[TAILWINDCSS_RAILS].full_gem_path
+  # Compose the compile command
+  AVO_TAILWIND_COMPILE_COMMAND = "#{RbConfig.ruby} #{Pathname.new(GEM_PATH)}/exe/tailwindcss -i '#{Rails.root.join("app/assets/stylesheets/avo.css")}' -o '#{Rails.root.join(ASSET_FILE)}' -c '#{Rails.root.join("config/tailwind.config.js")}' --minify"
+
+  namespace "avo:tailwindcss" do
+    desc "Build your Tailwind CSS"
+    task :build do
+      system(AVO_TAILWIND_COMPILE_COMMAND, exception: true)
+    end
+
+    desc "Watch and build your Tailwind CSS on file changes"
+    task :watch do
+      system "#{AVO_TAILWIND_COMPILE_COMMAND} -w"
+    end
+  end
+end

data/public/avo-assets/{avo.js → avo.base.js}

@@ -510,4 +510,4 @@ PERFORMANCE OF THIS SOFTWARE.
  * Based on Underscore.js 1.8.3 <http://underscorejs.org/LICENSE>
  * Copyright Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors
  */
-//# sourceMappingURL=avo.js.map
+//# sourceMappingURL=avo.base.js.map