avo 1.3.2 → 1.4.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22e7f22b1d55919ed5ebbe5d897a8f66d3ca99d43023d153bdafe4efe47ee33c
-  data.tar.gz: e4661ca6f110549d66b84969e333ac5276a8635e1ae76a73e5625fce618d02a1
+  metadata.gz: cc2704b71b6989b5f292a21a2f906d05df0240764a9caffb39e6a89e8a52e1bc
+  data.tar.gz: 2cf8653fc50133c1618f891cb618c934bf195c510098f95ed3ca19488585518f
 SHA512:
-  metadata.gz: 025b7a93bb030fff2f20c52d5908a8548e9e8e75070b0dbd057ed5baac9b34fbf780dd6594fb94085b339ca92c89ff931c088bb5176f010ff8fa3cc5e9b6e2e0
-  data.tar.gz: b4308eb61733a31c3e3279e3d08484d54926444bc3411daf73cfd6bb5872af1832a275e626122ae678a83fd7a5b784ad87ccf1ebb6b2ef21b68bfa04c0778bba
+  metadata.gz: 6206068ce49294ee565b56a08ebf1fb3c0595ebf1fa3379ed19cb2672db28d59b02ad6a1d3e11f19303dbd643d4a98ce3d82c2539f1e7d4cea4fa981c98c17c8
+  data.tar.gz: 71a144f0942247c4e9ca8f4d48adb48755d25d1f93642afc793ef826a49e7810bed17fb4d3e0b21905e5bf5aff3c564b47f9095ab3bb6f95b0f6d3a0fcdaf67f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    avo (1.3.2)
+    avo (1.4.0.pre.1)
       active_link_to
       addressable
       breadcrumbs_on_rails
@@ -11,7 +11,7 @@ PATH
       image_processing
       manifester
       meta-tags
-      pagy
+      pagy (>= 3.1.3, < 4.0)
       pundit
       rails (>= 6.0)
       view_component
@@ -187,7 +187,7 @@ GEM
     nokogiri (1.11.3-x86_64-linux)
       racc (~> 1.4)
     orm_adapter (0.5.0)
-    pagy (3.12.0)
+    pagy (3.13.0)
     parallel (1.20.1)
     parser (3.0.0.0)
       ast (~> 2.4.1)

data/app/components/avo/common/key_value_component.html.erb

@@ -0,0 +1,53 @@
+<div class="w-full shadow-lg rounded-lg overflow-hidden"
+  data-controller="key-value"
+  data-key-value-target="controller"
+  data-options="<%= @field.options.to_json %>"
+  data-input-classes="<%= input_classes %>"
+  data-editable="<%= @view.in?([:edit, :create]) %>"
+>
+  <div class="w-full flex flex-col">
+    <div class="flex w-full">
+      <div class="flex w-full bg-gray-800 shadow overflow-hidden">
+        <div class="w-1/2 py-3 px-3 uppercase font-semibold text-xs text-white border-gray-600 border-r">
+          <%= @field.key_label %>
+        </div>
+        <div class="w-1/2 py-3 px-3 uppercase font-semibold text-xs text-white">
+          <%= @field.value_label %>
+        </div>
+        <% if @view.in?([:edit, :create]) %>
+          <div class="flex items-center justify-center p-2 px-3 border-l border-gray-600">
+            <a href="javascript:void(0);"
+              title="<%= @field.action_text %>"
+              data-tippy="tooltip"
+              data-button="add-row"
+              data-action="click->key-value#addRow"
+              <% if @field.disable_adding_rows %>
+                class="cursor-not-allowed"
+              <% end %>
+            >
+              <%= svg 'plus-circle', class: 'text-gray-400 h-5 hover:text-gray-500' %>
+            </a>
+          </div>
+        <% end %>
+      </div>
+    </div>
+    <div data-key-value-target="rows"></div>
+  </div>
+  <% if @form.present? %>
+    <%= @form.text_area @field.id,
+      value: @field.parsed_value,
+      class: 'hidden',
+      placeholder: @field.placeholder,
+      'data-key-value-target': 'input',
+      'data-view': :edit
+    %>
+  <% else %>
+    <%= text_area_tag @field.id,
+      @field.parsed_value,
+      class: 'hidden',
+      placeholder: @field.placeholder,
+      'data-key-value-target': 'input',
+      'data-view': :edit
+    %>
+  <% end %>
+</div>

data/app/components/avo/common/key_value_component.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Avo::Common::KeyValueComponent < ViewComponent::Base
+  include Avo::ApplicationHelper
+
+  def initialize(field:, form: nil, view: :show)
+    @field = field
+    @form = form
+    @view = view
+  end
+end

data/app/components/avo/edit/fields/key_value_field_component.html.erb

@@ -0,0 +1,3 @@
+<%= edit_field_wrapper field: @field, index: @index, form: @form, resource: @resource, displayed_in_modal: @displayed_in_modal, full_width: true do %>
+  <%= render Avo::Common::KeyValueComponent.new field: @field, form: @form, view: :edit %>
+<% end %>

data/app/components/avo/edit/fields/key_value_field_component.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class Avo::Edit::Fields::KeyValueFieldComponent < Avo::Edit::Fields::FieldComponent
+end

data/app/components/avo/edit/fields/trix_field_component.html.erb

@@ -1,11 +1,20 @@
-<%= edit_field_wrapper field: @field, index: @index, form: @form, resource: @resource, displayed_in_modal: @displayed_in_modal do %>
-  <% trix_id = "trix_#{@resource.name.underscore}_#{@field.id}" %>
-  <trix-editor input="<%= trix_id %>" placeholder="<%= @field.placeholder %>"><%== @field.value %></trix-editor>
-  <%= @form.text_area @field.id,
-    id: trix_id,
-    class: helpers.input_classes('w-full hidden', has_error: (@resource.model.present? and @resource.model.errors.include?(@field.id))),
-    placeholder: @field.placeholder,
-    disabled: @field.readonly,
-    rows: @field.meta[:rows]
-  %>
+<%= edit_field_wrapper field: @field, index: @index, form: @form, resource: @resource, displayed_in_modal: @displayed_in_modal, full_width: true do %>
+  <div
+    data-controller="trix-field"
+    data-trix-field-target="controller"
+    data-resource-name="<%= @resource.model_class.model_name.route_key %>"
+    data-resource-id="<%= @resource.model.id %>"
+    data-attachments-disabled="<%= @field.attachments_disabled %>"
+    data-attachment-key="<%= @field.attachment_key %>"
+  >
+    <% trix_id = "trix_#{@resource.name.underscore}_#{@field.id}" %>
+    <trix-editor data-trix-field-target="editor" input="<%= trix_id %>" placeholder="<%= @field.placeholder %>"><%== @field.value %></trix-editor>
+    <%= @form.text_area @field.id,
+      id: trix_id,
+      class: helpers.input_classes('w-full hidden', has_error: (@resource.model.present? and @resource.model.errors.include?(@field.id))),
+      placeholder: @field.placeholder,
+      disabled: @field.readonly,
+      rows: @field.meta[:rows]
+    %>
+  </div>
 <% end %>

data/app/components/avo/show/fields/key_value_field_component.html.erb

@@ -0,0 +1,3 @@
+<%= show_field_wrapper field: @field, index: @index, full_width: true do %>
+  <%= render Avo::Common::KeyValueComponent.new field: @field, view: :show %>
+<% end %>

data/app/components/avo/show/fields/key_value_field_component.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class Avo::Show::Fields::KeyValueFieldComponent < Avo::Show::Fields::FieldComponent
+end

data/app/controllers/avo/application_controller.rb

@@ -42,7 +42,7 @@ module Avo
     end
 
     def check_avo_license
-      unless on_root_path || on_resources_path
+      unless on_root_path || on_resources_path || on_api_path
         if @license.invalid? || @license.lacks(:custom_tools)
           if Rails.env.development?
             @custom_tools_alert_visible = true
@@ -272,5 +272,9 @@ module Avo
     def on_resources_path
       request.original_url.match?(/.*\/#{Avo.configuration.namespace}\/resources\/.*/)
     end
+
+    def on_api_path
+      request.original_url.match?(/.*\/#{Avo.configuration.namespace}\/avo_api\/.*/)
+    end
   end
 end

data/app/controllers/avo/attachments_controller.rb

@@ -2,9 +2,20 @@ require_dependency "avo/application_controller"
 
 module Avo
   class AttachmentsController < ApplicationController
-    before_action :set_resource_name, only: :destroy
-    before_action :set_resource, only: :destroy
-    before_action :set_model, only: :destroy
+    before_action :set_resource_name, only: [:destroy, :create]
+    before_action :set_resource, only: [:destroy, :create]
+    before_action :set_model, only: [:destroy, :create]
+
+    def create
+      blob = ActiveStorage::Blob.create_and_upload! io: params[:file], filename: params[:filename]
+
+      @model.send(params[:attachment_key]).attach blob
+
+      render json: {
+        url: main_app.url_for(blob),
+        href: main_app.url_for(blob)
+      }
+    end
 
     def show
     end

data/app/helpers/avo/application_helper.rb

@@ -4,7 +4,7 @@ module Avo
     include ::Pagy::Frontend
 
     def current_webpacker_instance
-      return Avo.webpacker if Avo::IN_DEVELOPMENT || Rails.env.test?
+      return Avo.webpacker if Avo::IN_DEVELOPMENT
 
       super
     end

data/app/packs/entrypoints/application.js

@@ -2,7 +2,6 @@
 import 'core-js/stable'
 // eslint-disable-next-line import/no-extraneous-dependencies
 import 'regenerator-runtime/runtime'
-import 'trix'
 import * as Mousetrap from 'mousetrap'
 import { Application } from 'stimulus'
 import { Turbo } from '@hotwired/turbo-rails'
@@ -19,6 +18,19 @@ window.Turbolinks = Turbo
 
 Mousetrap.bind('r r r', () => Turbo.visit(window.location.href, { action: 'replace' }))
 
+function initTippy() {
+  tippy('[data-tippy="tooltip"]', {
+    theme: 'light',
+    content(reference) {
+      const title = reference.getAttribute('title')
+      reference.removeAttribute('title')
+
+      return title
+    },
+  })
+}
+window.initTippy = initTippy
+
 const application = Application.start()
 
 const context = require.context('./../js/controllers', true, /\.js$/)
@@ -29,16 +41,7 @@ application.load(definitionsFromContext(fieldsContext))
 
 document.addEventListener('turbo:load', () => {
   document.body.classList.remove('turbo-loading')
-
-  tippy('[data-tippy="tooltip"]', {
-    theme: 'light',
-    content(reference) {
-      const title = reference.getAttribute('title')
-      reference.removeAttribute('title')
-
-      return title
-    },
-  })
+  initTippy()
 })
 document.addEventListener('turbo:visit', () => document.body.classList.add('turbo-loading'))
 document.addEventListener('turbo:submit-start', () => document.body.classList.add('turbo-loading'))

data/app/packs/js/controllers/fields/code_field_controller.js

@@ -12,6 +12,7 @@ import 'codemirror/mode/shell/shell'
 import 'codemirror/mode/sql/sql'
 import 'codemirror/mode/vue/vue'
 import 'codemirror/mode/xml/xml'
+import 'codemirror/mode/yaml/yaml'
 
 import { Controller } from 'stimulus'
 import { castBoolean } from '@/js/helpers/cast_boolean'

data/app/packs/js/controllers/fields/date_field_controller.js

@@ -33,7 +33,7 @@ export default class extends Controller {
 
     // enable timezone display
     if (enableTime) {
-      currentValue = DateTime.fromISO(this.inputTarget.value, { zone: window.timezone })
+      currentValue = DateTime.fromISO(this.inputTarget.value, { zone: window.Avo.configuration.timezone })
       currentValue = currentValue.setZone(this.inputTarget.dataset.timezone)
       currentValue = currentValue.toISO()
 

data/app/packs/js/controllers/fields/key_value_controller.js

@@ -0,0 +1,137 @@
+/* eslint-disable max-len */
+import { Controller } from 'stimulus'
+import { castBoolean } from '@/js/helpers/cast_boolean'
+
+export default class extends Controller {
+  static targets = ['input', 'controller', 'rows']
+
+  fieldValue = []
+
+  options = {}
+
+  get keyInputDisabled() {
+    return !this.options.editable || this.options.disable_editing_keys
+  }
+
+  get valueInputDisabled() {
+    return !this.options.editable
+  }
+
+  connect() {
+    this.setOptions()
+
+    try {
+      const objectValue = JSON.parse(this.inputTarget.value)
+      Object.keys(objectValue).forEach((key) => this.fieldValue.push([key, objectValue[key]]))
+    } catch (error) {
+      this.fieldValue = []
+    }
+
+    this.updateKeyValueComponent()
+  }
+
+  addRow() {
+    if (this.options.disable_adding_rows || !this.options.editable) return
+    this.fieldValue.push(['', ''])
+    this.updateKeyValueComponent()
+    this.focusLastRow()
+  }
+
+  deleteRow(event) {
+    if (this.options.disable_deleting_rows || !this.options.editable) return
+    const { index } = event.target.dataset
+    this.fieldValue.splice(index, 1)
+    this.updateTextareaInput()
+    this.updateKeyValueComponent()
+  }
+
+  focusLastRow() {
+    return this.rowsTarget.querySelector('.flex.key-value-row:last-child .key-value-input-key').focus()
+  }
+
+  valueFieldUpdated(event) {
+    const { value } = event.target
+    const { index } = event.target.dataset
+    this.fieldValue[index][1] = value
+
+    this.updateTextareaInput()
+  }
+
+  keyFieldUpdated(event) {
+    const { value } = event.target
+    const { index } = event.target.dataset
+    this.fieldValue[index][0] = value
+
+    this.updateTextareaInput()
+  }
+
+  updateTextareaInput() {
+    if (!this.hasInputTarget) return
+    let result = {}
+    if (this.fieldValue && this.fieldValue.length > 0) {
+      result = Object.assign(...this.fieldValue.map(([key, val]) => ({ [key]: val })))
+    }
+    this.inputTarget.innerText = JSON.stringify(result)
+  }
+
+  updateKeyValueComponent() {
+    let result = ''
+    let index = 0
+    this.fieldValue.forEach((row) => {
+      const [key, value] = row
+      result += this.interpolatedRow(key, value, index)
+      index++
+    })
+    this.rowsTarget.innerHTML = result
+    window.initTippy()
+  }
+
+  interpolatedRow(key, value, index) {
+    let result = `<div class="flex key-value-row">
+      ${this.inputField('key', index, key, value)}
+      ${this.inputField('value', index, key, value)}`
+    if (this.options.editable) {
+      result += `<a
+  href="javascript:void(0);"
+  data-index="${index}"
+  data-action="click->key-value#deleteRow"
+  title="${this.options.delete_text}"
+  data-tippy="tooltip"
+  data-button="delete-row"
+  tabindex="-1"
+  ${this.options.disable_deleting_rows ? "disabled='disabled'" : ''}
+  class="flex items-center justify-center p-2 px-3 border-none ${this.options.disable_deleting_rows ? 'cursor-not-allowed' : ''}"
+><svg class="pointer-events-none text-gray-500 h-5 hover:text-gray-500" fill="none" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" viewBox="0 0 24 24" stroke="currentColor"><path d="M19 7l-.867 12.142A2 2 0 0116.138 21H7.862a2 2 0 01-1.995-1.858L5 7m5 4v6m4-6v6m1-10V4a1 1 0 00-1-1h-4a1 1 0 00-1 1v3M4 7h16"></path></svg></a>`
+    }
+    result += '</div>'
+
+    return result
+  }
+
+  inputField(id = 'key', index, key, value) {
+    return `<input
+  class="${this.options.inputClasses} !rounded-none border-gray-600 border-r border-l-0 border-b-0 border-t-0 focus:border-gray-300 w-1/2 focus:outline-none outline-none key-value-input-${id}"
+  data-action="input->key-value#${id}FieldUpdated"
+  placeholder="${this.options[`${id}_label`]}"
+  data-index="${index}"
+  ${this[`${id}InputDisabled`] ? "disabled='disabled'" : ''}
+  value="${id === 'key' ? key : value}"
+  autofocus
+/>`
+  }
+
+  setOptions() {
+    let fieldOptions
+
+    try {
+      fieldOptions = JSON.parse(this.controllerTarget.dataset.options)
+    } catch (error) {
+      fieldOptions = {}
+    }
+    this.options = {
+      ...fieldOptions,
+      inputClasses: this.controllerTarget.dataset.inputClasses,
+      editable: castBoolean(this.controllerTarget.dataset.editable),
+    }
+  }
+}

data/app/packs/js/controllers/fields/trix_field_controller.js

@@ -0,0 +1,121 @@
+import 'trix'
+import { Controller } from 'stimulus'
+import { castBoolean } from '@/js/helpers/cast_boolean'
+
+export default class extends Controller {
+  static targets = ['editor', 'controller']
+
+  get resourceId() {
+    return this.controllerTarget.dataset.resourceId
+  }
+
+  get resourceName() {
+    return this.controllerTarget.dataset.resourceName
+  }
+
+  get attachmentKey() {
+    return this.controllerTarget.dataset.attachmentKey
+  }
+
+  get attachmentsDisabled() {
+    return castBoolean(this.controllerTarget.dataset.attachmentsDisabled)
+  }
+
+  get uploadUrl() {
+    return `${window.location.origin}${window.Avo.configuration.root_path}/avo_api/resources/${this.resourceName}/${this.resourceId}/attachments`
+  }
+
+  connect() {
+    if (this.attachmentsDisabled) {
+      // Remove the attachments button
+      this.controllerTarget.querySelector('.trix-button-group--file-tools').remove()
+    }
+
+    window.addEventListener('trix-file-accept', (event) => {
+      if (event.target === this.editorTarget) {
+        // Prevent file uploads for fields that have attachments disabled.
+        if (this.attachmentsDisabled) {
+          event.preventDefault()
+          window.toastr.warning('This field has attachments disabled.')
+
+          return
+        }
+
+        // Prevent file uploads for resources that haven't been saved yet.
+        if (this.resourceId === '') {
+          event.preventDefault()
+          window.toastr.warning("You can't upload files into the Trix editor until you save the resource.")
+
+          return
+        }
+
+        // Prevent file uploads for fields without an attachment key.
+        if (this.attachmentKey === '') {
+          event.preventDefault()
+          window.toastr.warning("You haven't set an <a href='https://google.com' class='!text-blue-700 underline'>attachment_key</a> to this Trix field.")
+        }
+      }
+    })
+
+    window.addEventListener('trix-attachment-add', (event) => {
+      if (event.target === this.editorTarget) {
+        if (event.attachment.file) {
+          this.uploadFileAttachment(event.attachment)
+        }
+      }
+    })
+  }
+
+  uploadFileAttachment(attachment) {
+    this.uploadFile(
+      attachment.file,
+      (progress) => attachment.setUploadProgress(progress),
+      (attributes) => attachment.setAttributes(attributes),
+    )
+  }
+
+  uploadFile(file, progressCallback, successCallback) {
+    const formData = this.createFormData(file)
+    const xhr = new XMLHttpRequest()
+
+    xhr.open('POST', this.uploadUrl, true)
+
+    xhr.setRequestHeader('X-CSRF-Token', document.querySelector('meta[name="csrf-token"]').content)
+
+    xhr.upload.addEventListener('progress', (event) => {
+      // eslint-disable-next-line no-mixed-operators
+      const progress = event.loaded / event.total * 100
+      progressCallback(progress)
+    })
+
+    xhr.addEventListener('load', () => {
+      if (xhr.status === 200) {
+        let response
+        try {
+          response = JSON.parse(xhr.response)
+        } catch (error) {
+          response = {}
+        }
+
+        const attributes = {
+          url: response.url,
+          href: response.href,
+        }
+
+        successCallback(attributes)
+      }
+    })
+
+    xhr.send(formData)
+  }
+
+  createFormData(file) {
+    const data = new FormData()
+    data.append('Content-Type', file.type)
+    data.append('file', file)
+    data.append('filename', file.name)
+    data.append('attachment_key', this.attachmentKey)
+
+    return data
+  }
+}