avo 2.16.1.pre.1.nativefields → 2.17.0

data/app/javascript/js/controllers/action_controller.js

@@ -1,5 +1,5 @@
-import { castBoolean } from '../helpers/cast_boolean'
 import { Controller } from '@hotwired/stimulus'
+import { castBoolean } from '../helpers/cast_boolean'
 
 export default class extends Controller {
   static targets = ['controllerDiv', 'resourceIds', 'form', 'selectedAllQuery']
@@ -7,8 +7,6 @@ export default class extends Controller {
   connect() {
     this.resourceIdsTarget.value = this.resourceIds
 
-    console.log('something')
-
     // This value is picked up from the DOM so we check true/false as strings
     if (this.selectionOptions.itemSelectAllSelectedAllValue === 'true') {
       this.selectedAllQueryTarget.value = this.selectionOptions.itemSelectAllSelectedAllQueryValue
@@ -43,6 +41,5 @@ export default class extends Controller {
     } catch (error) {
       return []
     }
-
   }
 }

data/app/javascript/js/controllers/actions_picker_controller.js

@@ -1,4 +1,3 @@
-import { AttributeObserver } from '@stimulus/mutation-observers'
 import { Controller } from '@hotwired/stimulus'
 
 export default class extends Controller {
@@ -12,6 +11,10 @@ export default class extends Controller {
     return this.target.dataset.disabled === 'true'
   }
 
+  get actionsShowTurboFrame() {
+    return document.querySelector('turbo-frame#actions_show')
+  }
+
   enableTarget() {
     if (this.targetIsDisabled) {
       this.target.classList.remove(...this.disabledClasses)
@@ -36,13 +39,9 @@ export default class extends Controller {
     }
 
     this.disableTarget()
-
-    const observer = new AttributeObserver(document.querySelector('turbo-frame#actions_show'), 'busy', {
-      elementUnmatchedAttribute: () => {
-        this.enableTarget(this.target)
-        if (observer) observer.stop()
-      },
-    })
-    observer.start()
+    const that = this
+    setTimeout(() => {
+      this.actionsShowTurboFrame.loaded.then(() => that.enableTarget(that.target))
+    }, 1)
   }
 }

data/app/javascript/js/controllers/tabs_controller.js

@@ -1,4 +1,3 @@
-import { AttributeObserver } from '@stimulus/mutation-observers'
 import { Controller } from '@hotwired/stimulus'
 import { castBoolean } from '../helpers/cast_boolean'
 
@@ -16,24 +15,22 @@ export default class extends Controller {
     )
   }
 
-  targetTab(id) {
-    return this.tabTargets.find((element) => element.dataset.tabsIdParam === id)
-  }
-
   targetTabPanel(id) {
     return this.tabPanelTargets.find((element) => element.dataset.tabId === id)
   }
 
-  changeTab(e) {
+  async changeTab(e) {
+    // Stopping the link execution.
+    // We're going to reveal a lazy-loaded frame to fulfill the tab change.
     e.preventDefault()
 
     const { params } = e
     const { id } = params
 
-    this.setTheTargetPanelHeight(id)
+    await this.setTheTargetPanelHeight(id)
 
-    this.hideTabs()
-    this.showTab(id)
+    this.hideAllTabs()
+    this.revealTab(id)
     this.markTabLoaded(id)
 
     this.activeTabValue = id
@@ -42,7 +39,7 @@ export default class extends Controller {
   /**
    * Sets the target container height to the previous panel height so we don't get jerky tab changes.
    */
-  setTheTargetPanelHeight(id) {
+  async setTheTargetPanelHeight(id) {
     // Ignore this on edit.
     // All tabs are loaded beforehand, they have their own height, and the page won't jiggle when the user toggles between them.
     if (this.viewValue === 'edit' || this.viewValue === 'new') {
@@ -60,31 +57,21 @@ export default class extends Controller {
     this.targetTabPanel(id).style.height = `${height}px`
 
     // Wait until the panel loaded it's content and then remove the forced height
-    const observer = new AttributeObserver(this.targetTabPanel(id), 'busy', {
-      elementUnmatchedAttribute: () => {
-        // The content is not available in an instant so delay the height reset a bit.
-        setTimeout(() => {
-          this.targetTab(id).style.height = ''
-        }, 300)
-        if (observer) observer.stop()
-      },
-    })
-    observer.start()
+    await this.targetTabPanel(id).loaded
+    this.targetTabPanel(id).style.height = ''
   }
 
+  // Marking tab as loaded so we know to skip some things the next time the user clicks on it
   markTabLoaded(id) {
     this.targetTabPanel(id).dataset.loaded = true
   }
 
-  showTab(id) {
-    this.tabPanelTargets.forEach((element) => {
-      if (element.dataset.tabId === id) {
-        element.classList.remove('hidden')
-      }
-    })
+  // We're revealing the new tab that's lazy loaded by Turbo.
+  revealTab(id) {
+    this.targetTabPanel(id).classList.remove('hidden')
   }
 
-  hideTabs() {
+  hideAllTabs() {
     this.tabPanelTargets.map((element) => element.classList.add('hidden'))
   }
 }

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

@@ -23,12 +23,12 @@
       <%= form.hidden_field :avo_resource_ids, value: params[:resource_ids], 'data-action-target': 'resourceIds' %>
       <%= form.hidden_field :avo_selected_query, 'data-action-target': 'selectedAllQuery' %>
       <% if @action.get_fields.present? %>
-        <div class="mt-4">
+        <div class="my-4 -mx-6">
           <% @action.get_fields.each_with_index do |field, index| %>
             <%= render field
               .hydrate(resource: @resource, model: @resource.model, user: @resource.user, view: @view)
               .component_for_view(:edit)
-              .new(field: field, resource: @resource, index: index, form: form, displayed_in_modal: true)
+              .new(field: field, resource: @resource, index: index, form: form, compact: true)
             %>
           <% end %>
         </div>

data/app/views/avo/home/failed_to_load.html.erb

@@ -2,15 +2,16 @@
   <%
   classes = 'absolute inset-auto left-1/2 top-1/2 transform -translate-x-1/2 -translate-y-1/2'
   label = t 'avo.failed_to_load'
+  src_url = params[:src].present? && !params[:src].starts_with?('http://') ? params.permit(:src).fetch(:src) : nil
 %>
   <div class="relative flex-1 py-4">
     <div class="relative block text-gray-300 h-64 w-full">
       <%= svg 'failed_to_load', class: "#{classes} h-52 text-gray-400" %>
     </div>
     <div class="relative block text-center text-lg text-gray-400 font-semibold pb-6"><%= label %> <span class="border-b-2 border-dashed"><%= params[:turbo_frame].to_s.humanize.downcase if params[:turbo_frame].present? %></span> frame</div>
-    <% if Rails.env.development? %>
+    <% if Rails.env.development? && src_url %>
       <div class="text-center text-sm w-full pb-3">
-        This is not an issue with Avo. Use <%= link_to 'this page', params[:src], target: :_blank %> to see why this frame failed to load.
+        This is not an issue with Avo. Use <%= link_to 'this page', src_url, target: :_blank %> to see why this frame failed to load.
       </div>
     <% end %>
   </div>

data/config/brakeman.ignore

@@ -0,0 +1,40 @@
+{
+  "ignored_warnings": [
+    {
+      "warning_type": "Cross-Site Scripting",
+      "warning_code": 4,
+      "fingerprint": "590cf164dd928ef0bd277c5369426130af896d9fdec6389084d9d4a27076ef13",
+      "check_name": "LinkToHref",
+      "message": "Unsafe parameter value in `link_to` href",
+      "file": "app/views/avo/home/failed_to_load.html.erb",
+      "line": 15,
+      "link": "https://brakemanscanner.org/docs/warning_types/link_to_href",
+      "code": "link_to(\"this page\", (params.permit(:src).fetch(:src) or nil), :target => :_blank)",
+      "render_path": [
+        {
+          "type": "controller",
+          "class": "Avo::HomeController",
+          "method": "failed_to_load",
+          "line": 23,
+          "file": "app/controllers/avo/home_controller.rb",
+          "rendered": {
+            "name": "avo/home/failed_to_load",
+            "file": "app/views/avo/home/failed_to_load.html.erb"
+          }
+        }
+      ],
+      "location": {
+        "type": "template",
+        "template": "avo/home/failed_to_load"
+      },
+      "user_input": "params.permit(:src).fetch(:src)",
+      "confidence": "High",
+      "cwe_id": [
+        79
+      ],
+      "note": ""
+    }
+  ],
+  "updated": "2022-10-05 13:24:40 +0300",
+  "brakeman_version": "5.3.1"
+}

data/db/factories.rb

@@ -75,4 +75,24 @@ FactoryBot.define do
     link { Faker::Internet.url }
     course { create :course }
   end
+
+  factory :city do
+    name { Faker::Address.city }
+    population { rand(10000..999000) }
+    is_capital { [true, false].sample }
+    features { Faker::Address.community }
+    metadata { Faker::Address.community }
+    # image_url { "MyString" }
+    description { Faker::Address.community }
+    status { ["open", "closed"].sample }
+    tiny_description { Faker::Address.community }
+  end
+
+  factory :product do
+    title { "MyString" }
+    description { "MyText" }
+    price { 1 }
+    status { "MyString" }
+    category { "MyString" }
+  end
 end

data/lib/avo/base_resource.rb

@@ -101,6 +101,32 @@ module Avo
 
         ordering.dig(:actions) || {}
       end
+
+      def get_record_associations(record)
+        record._reflections
+      end
+
+      def valid_association_name(record, association_name)
+        get_record_associations(record).keys.find do |name|
+          name == association_name
+        end
+      end
+
+      def valid_attachment_name(record, association_name)
+        get_record_associations(record).keys.each do |name|
+          return association_name if name == "#{association_name}_attachment" || name == "#{association_name}_attachments"
+        end
+      end
+
+      def get_available_models
+        ApplicationRecord.descendants
+      end
+
+      def valid_model_class(model_class)
+        get_available_models.find do |m|
+          m.to_s == model_class.to_s
+        end
+      end
     end
 
     def initialize

data/lib/avo/concerns/fetches_things.rb

@@ -36,7 +36,7 @@ module Avo
           possible_resource = "#{resource}Resource".gsub "ResourceResource", "Resource"
 
           resources.find do |available_resource|
-            possible_resource.safe_constantize == available_resource.class
+            possible_resource.to_s == available_resource.class.to_s
           end
         end
 

data/lib/avo/concerns/has_fields.rb

@@ -43,6 +43,12 @@ module Avo
 
           items_holder.heading body, **args
         end
+
+        def sidebar(**args, &block)
+          ensure_items_holder_initialized
+
+          items_holder.sidebar Avo::SidebarBuilder.parse_block(**args, &block)
+        end
         # END DSL methods
 
         def items
@@ -76,6 +82,11 @@ module Avo
                   fields << extract_fields_from_items(tab)
                 end
               end
+
+              # Dive into sidebar to fetch their fields
+              if item.is_sidebar?
+                fields << extract_fields_from_items(item)
+              end
             end
 
             if item.is_field?
@@ -277,6 +288,17 @@ module Avo
           end
         end
 
+        # Make sure all tabs panelfull_items are setted as inside tabs
+        panelfull_items.grep(Avo::TabGroup).each do |tab_group|
+          tab_group.items.grep(Avo::Tab).each do |tab|
+            tab.items.grep(Avo::Panel).each do |panel|
+              panel.items.grep(Avo::Fields::BelongsToField).each do |field|
+                field.target = :_top
+              end
+            end
+          end
+        end
+
         # Add all the panelles fields to a new panel
         main_panel_holder = Avo::ItemsHolder.new
         main_panel_holder.items = panelless_items

data/lib/avo/concerns/is_resource_item.rb

@@ -31,6 +31,10 @@ module Avo
       def is_tab_group?
         self.class.item_type == :tab_group
       end
+
+      def is_sidebar?
+        self.class.item_type == :sidebar
+      end
     end
   end
 end

data/lib/avo/configuration/branding.rb

@@ -1,9 +1,10 @@
 class Avo::Configuration::Branding
-  def initialize(colors: nil, chart_colors: nil, logo: nil, logomark: nil)
+  def initialize(colors: nil, chart_colors: nil, logo: nil, logomark: nil, placeholder: nil)
     @colors = colors || {}
     @chart_colors = chart_colors
     @logo = logo
     @logomark = logomark
+    @placeholder = placeholder
 
     @default_colors = {
       background: "#F6F6F7",
@@ -15,6 +16,7 @@ class Avo::Configuration::Branding
     @default_chart_colors = ["#0B8AE2", "#34C683", "#2AB1EE", "#34C6A8"]
     @default_logo = "/avo-assets/logo.png"
     @default_logomark = "/avo-assets/logomark.png"
+    @default_placeholder = "placeholder.svg"
   end
 
   def css_colors
@@ -39,6 +41,12 @@ class Avo::Configuration::Branding
     @logomark || @default_logomark
   end
 
+  def placeholder
+    return @default_placeholder if Avo::App.license.lacks_with_trial(:branding)
+
+    @placeholder || @default_placeholder
+  end
+
   def chart_colors
     return @default_chart_colors if Avo::App.license.lacks_with_trial(:branding)
 

data/lib/avo/fields/belongs_to_field.rb

@@ -58,6 +58,8 @@ module Avo
     # - is_disabled?
 
     class BelongsToField < BaseField
+      attr_accessor :target
+
       attr_reader :polymorphic_as
       attr_reader :relation_method
       attr_reader :types # for Polymorphic associations
@@ -77,6 +79,7 @@ module Avo
         @allow_via_detaching = args[:allow_via_detaching] == true
         @attach_scope = args[:attach_scope]
         @polymorphic_help = args[:polymorphic_help]
+        @target = args[:target]
       end
 
       def searchable

data/lib/avo/fields/heading_field.rb

@@ -1,9 +1,17 @@
+require 'securerandom'
+
 module Avo
   module Fields
     class HeadingField < BaseField
       attr_reader :as_html
+      attr_reader :empty
 
       def initialize(content, **args, &block)
+        # Mark the field as empty if there's no content passed
+        @empty = content.blank?
+        # Add dummy content
+        content ||= SecureRandom.hex
+
         args[:updatable] = false
 
         super(content, **args, &block)
@@ -16,6 +24,13 @@ module Avo
       def id
         "heading_#{name.to_s.parameterize.underscore}"
       end
+
+      # Override the value method if the field is empty
+      def value
+        return nil if empty
+
+        super
+      end
     end
   end
 end

data/lib/avo/items_holder.rb

@@ -55,6 +55,10 @@ module Avo
       add_item field
     end
 
+    def sidebar(instance)
+      add_item instance
+    end
+
     def add_item(instance)
       @items << instance
 

data/lib/avo/licensing/pro_license.rb

@@ -17,6 +17,7 @@ module Avo
           :stimulus_js_integration,
           :resource_show_controls,
           :branding,
+          :resource_sidebar,
           :advanced_fields
         ]
       end

data/lib/avo/menu/builder.rb

@@ -57,7 +57,7 @@ class Avo::Menu::Builder
   # Add all the resources
   def all_resources(**args)
     Avo::App.resources_for_navigation.each do |res|
-      resource res.model_class, **args
+      resource res.route_key, **args
     end
   end
 

data/lib/avo/menu/menu.rb

@@ -1,4 +1,2 @@
 class Avo::Menu::Menu < OpenStruct
-
-
 end

data/lib/avo/reloader.rb

@@ -20,40 +20,41 @@ class Avo::Reloader
   end
 
   private
-    def updater
-      @updater ||= config.file_watcher.new(files, directories) { reload! }
-    end
 
-    def files
-      # we want to watch some files no matter what
-      paths = [
-        Rails.root.join("config", "initializers", "avo.rb"),
-      ]
+  def updater
+    @updater ||= config.file_watcher.new(files, directories) { reload! }
+  end
 
-      # we want to watch some files only in Avo development
-      if reload_lib?
-        paths += []
-      end
+  def files
+    # we want to watch some files no matter what
+    paths = [
+      Rails.root.join("config", "initializers", "avo.rb"),
+    ]
 
-      paths
+    # we want to watch some files only in Avo development
+    if reload_lib?
+      paths += []
     end
 
-    def directories
-      dirs = {}
+    paths
+  end
 
-      # watch the lib directory in Avo development
-      if reload_lib?
-        dirs[Avo::Engine.root.join("lib", "avo").to_s] = ["rb"]
-      end
+  def directories
+    dirs = {}
 
-      dirs
+    # watch the lib directory in Avo development
+    if reload_lib?
+      dirs[Avo::Engine.root.join("lib", "avo").to_s] = ["rb"]
     end
 
-    def config
-      Rails.application.config
-    end
+    dirs
+  end
 
-    def reload_lib?
-      Avo::IN_DEVELOPMENT || ENV['AVO_RELOAD_LIB_DIR']
-    end
+  def config
+    Rails.application.config
+  end
+
+  def reload_lib?
+    Avo::IN_DEVELOPMENT || ENV["AVO_RELOAD_LIB_DIR"]
+  end
 end

data/lib/avo/services/encryption_service.rb

@@ -40,7 +40,7 @@ module Avo
       end
 
       def secret_key_base
-        ENV['SECRET_KEY_BASE'] || Rails.application.credentials.secret_key_base || Rails.application.secrets.secret_key_base
+        ENV["SECRET_KEY_BASE"] || Rails.application.credentials.secret_key_base || Rails.application.secrets.secret_key_base
       end
     end
   end

data/lib/avo/sidebar.rb

@@ -0,0 +1,60 @@
+class Avo::Sidebar
+  include Avo::Concerns::IsResourceItem
+  include Avo::Fields::FieldExtensions::VisibleInDifferentViews
+
+  class_attribute :item_type, default: :sidebar
+  delegate :items, :add_item, to: :items_holder
+
+  attr_reader :name
+  attr_reader :view
+  attr_accessor :items_holder
+
+  def initialize(name: nil, view: nil, **args)
+    # Initialize the visibility markers
+    super
+
+    @name = name
+    @items_holder = Avo::ItemsHolder.new
+    @view = view
+
+    show_on args[:show_on] if args[:show_on].present?
+    hide_on args[:hide_on] if args[:hide_on].present?
+    only_on args[:only_on] if args[:only_on].present?
+    except_on args[:except_on] if args[:except_on].present?
+  end
+
+  def hydrate(view: nil)
+    @view = view
+
+    self
+  end
+
+  def empty?
+    visible_items.blank?
+  end
+
+  def items
+    if self.items_holder.present?
+      self.items_holder.items
+    else
+      []
+    end
+  end
+
+  def visible_items
+    items.map do |item|
+      # Remove the fields that shouldn't be visible in this view
+      # eg: has_many fields on edit
+      if not_visible_field(item)
+        nil
+      else
+        item
+      end
+    end
+    .compact
+  end
+
+  def not_visible_field(item)
+    item.is_field? && !item.visible_on?(view)
+  end
+end

data/lib/avo/sidebar_builder.rb

@@ -0,0 +1,24 @@
+class Avo::SidebarBuilder
+  class << self
+    def parse_block(**args, &block)
+      Docile.dsl_eval(new(**args), &block).build
+    end
+  end
+
+  attr_reader :items_holder
+
+  delegate :field, to: :items_holder
+  delegate :items, to: :items_holder
+  delegate :heading, to: :items_holder
+
+  def initialize(name: nil, **args)
+    @sidebar = Avo::Sidebar.new(**args)
+    @items_holder = Avo::ItemsHolder.new
+  end
+
+  # Fetch the sidebar
+  def build
+    @sidebar.items_holder = @items_holder
+    @sidebar
+  end
+end

data/lib/avo/version.rb

@@ -1,3 +1,3 @@
 module Avo
-  VERSION = "2.16.1.pre.1.nativefields" unless const_defined?(:VERSION)
+  VERSION = "2.17.0" unless const_defined?(:VERSION)
 end

data/lib/generators/avo/templates/field/components/index_component.html.erb.tt

@@ -1,3 +1,3 @@
-<%%= index_field_wrapper field: @field, resource: @resource do %>
+<%%= index_field_wrapper **field_wrapper_args do %>
   <%%= @field.value %>
 <%% end %>

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

@@ -35,7 +35,7 @@ Avo.configure do |config|
   # config.locale = 'en-US'
 
   ## == Resource options ==
-  # config.resource_controls = :right
+  # config.resource_controls_placement = :right
   # config.model_resource_mapping = {}
   # config.default_view_type = :table
   # config.per_page = 24
@@ -71,6 +71,7 @@ Avo.configure do |config|
   #   chart_colors: ["#0B8AE2", "#34C683", "#2AB1EE", "#34C6A8"],
   #   logo: "/avo-assets/logo.png",
   #   logomark: "/avo-assets/logomark.png"
+  #   placeholder: "/avo-assets/placeholder.svg"
   # }
 
   ## == Breadcrumbs ==

data/lib/generators/avo/templates/locales/avo.en.yml

@@ -50,7 +50,6 @@ en:
     per_page: 'Per page'
     more: 'More'
     attach: 'Attach'
-    cancel: 'Cancel'
     save: 'Save'
     attach_and_attach_another: 'Attach & Attach another'
     hide_content: 'Hide content'