avo 2.7.1.pre.1 → 2.8.0

data/lib/avo/base_action.rb

@@ -1,8 +1,9 @@
 module Avo
   class BaseAction
-    extend FieldsCollector
     extend HasContext
 
+    include Avo::Concerns::HasFields
+
     class_attribute :name, default: nil
     class_attribute :message
     class_attribute :confirm_button_label
@@ -12,7 +13,6 @@ module Avo
     class_attribute :view
     class_attribute :user
     class_attribute :resource
-    class_attribute :fields
     class_attribute :invalid_fields
     class_attribute :standalone, default: false
     class_attribute :visible
@@ -153,6 +153,13 @@ module Avo
       self
     end
 
+    # Add a placeholder silent message from when a user wants to do a redirect action or something similar
+    def silent
+      add_message nil, :silent
+
+      self
+    end
+
     def redirect_to(path = nil, &block)
       response[:type] = :redirect
       response[:path] = if block.present?

data/lib/avo/base_card.rb

@@ -52,29 +52,6 @@ module Avo
       @refresh_every || self.class.refresh_every
     end
 
-    def translated_range(range)
-      return "#{range} days" if range.is_a? Integer
-
-      case range
-      when "MTD"
-        "Month to date"
-      when "QTD"
-        "Quarter to date"
-      when "YTD"
-        "Year to date"
-      when "TODAY"
-        "Today"
-      else
-        range
-      end
-    end
-
-    def parsed_ranges
-      return unless ranges.present?
-
-      ranges.map { |range| [translated_range(range), range] }
-    end
-
     def turbo_frame
       "#{dashboard.id}_#{id}"
     end

data/lib/avo/base_resource.rb

@@ -1,13 +1,15 @@
 module Avo
   class BaseResource
     extend ActiveSupport::DescendantsTracker
-    extend FieldsCollector
     extend HasContext
 
     include ActionView::Helpers::UrlHelper
     include Avo::Concerns::HasTools
+    include Avo::Concerns::HasFields
+    include Avo::Concerns::HasStimulusControllers
 
-    delegate :view_context, to: "Avo::App"
+    delegate :view_context, to: ::Avo::App
+    delegate :simple_format, :content_tag, to: :view_context
     delegate :main_app, to: :view_context
     delegate :avo, to: :view_context
     delegate :resource_path, to: :view_context
@@ -28,12 +30,10 @@ module Avo
     class_attribute :includes, default: []
     class_attribute :model_class
     class_attribute :translation_key
-    class_attribute :translation_enabled, default: false
     class_attribute :default_view_type, default: :table
     class_attribute :devise_password_optional, default: false
     class_attribute :actions_loader
     class_attribute :filters_loader
-    class_attribute :fields
     class_attribute :grid_loader
     class_attribute :visible_on_sidebar, default: true
     class_attribute :unscoped_queries_on_index, default: false
@@ -106,8 +106,6 @@ module Avo
           self.class.model_class = model_class.base_class
         end
       end
-
-      self.class.translation_enabled = ::Avo::App.translation_enabled
     end
 
     def hydrate(model: nil, view: nil, user: nil, params: nil)
@@ -128,7 +126,7 @@ module Avo
       return [] if self.class.fields.blank?
 
       fields = self.class.fields.map do |field|
-        field.hydrate(resource: self, panel_name: default_panel_name, user: user, translation_enabled: translation_enabled)
+        field.hydrate(resource: self, panel_name: default_panel_name, user: user)
       end
 
       if Avo::App.license.lacks_with_trial(:custom_fields)
@@ -139,7 +137,7 @@ module Avo
 
       if Avo::App.license.lacks_with_trial(:advanced_fields)
         fields = fields.reject do |field|
-          field.type == 'tags'
+          field.type == "tags"
         end
       end
 
@@ -288,7 +286,7 @@ module Avo
     end
 
     def translation_key
-      return "avo.resource_translations.#{class_name_without_resource.underscore}" if self.class.translation_enabled
+      return "avo.resource_translations.#{class_name_without_resource.underscore}" if ::Avo::App.translation_enabled
 
       self.class.translation_key
     end
@@ -298,9 +296,11 @@ module Avo
 
       return @name if @name.present?
 
-      return t(translation_key, count: 1, default: default).capitalize if translation_key
-
-      default
+      if translation_key && ::Avo::App.translation_enabled
+        t(translation_key, count: 1, default: default).capitalize
+      else
+        default
+      end
     end
 
     def singular_name
@@ -310,9 +310,11 @@ module Avo
     def plural_name
       default = name.pluralize
 
-      return t(translation_key, count: 2, default: default).capitalize if translation_key
-
-      default
+      if translation_key && ::Avo::App.translation_enabled
+        t(translation_key, count: 2, default: default).capitalize
+      else
+        default
+      end
     end
 
     def underscore_name

data/lib/avo/concerns/has_fields.rb

@@ -0,0 +1,93 @@
+module Avo
+  module Concerns
+    module HasFields
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :fields
+        class_attribute :fields_index, default: 0
+      end
+
+      class_methods do
+        def field(field_name, as:, **args, &block)
+          self.invalid_fields ||= []
+
+          field_instance = parse_field(field_name, as: as, order_index: fields_index, **args, &block)
+
+          if field_instance.present?
+            add_to_fields field_instance
+          else
+            self.invalid_fields << ({
+              name: field_name,
+              as: as,
+              resource: name,
+              message: "There's an invalid field configuration for this resource. <br/> <code class='px-1 py-px rounded bg-red-600'>field :#{field_name}, as: #{as}</code>"
+            })
+          end
+        end
+
+        def parse_field(field_name, as:, **args, &block)
+          # The field is passed as a symbol eg: :text, :color_picker, :trix
+          if as.is_a? Symbol
+            parse_symbol field_name, as: as, **args, &block
+          elsif as.is_a? Class
+            parse_class field_name, as: as, **args, &block
+          end
+        end
+
+        def heading(body, **args)
+          add_to_fields Avo::Fields::HeadingField.new(body, order_index: fields_index, **args)
+        end
+
+        private
+
+        def add_to_fields(instance)
+          self.fields ||= []
+          self.fields << instance
+          self.fields_index += 1
+        end
+
+        def instantiate_field(field_name, klass:, **args, &block)
+          if block
+            klass.new(field_name, **args || {}, &block)
+          else
+            klass.new(field_name, **args || {})
+          end
+        end
+
+        def field_class_from_symbol(symbol)
+          matched_field = Avo::App.fields.find do |field|
+            field[:name].to_s == symbol.to_s
+          end
+
+          return matched_field[:class] if matched_field.present? && matched_field[:class].present?
+        end
+
+        def parse_symbol(field_name, as:, **args, &block)
+          field_class = field_class_from_symbol(as)
+
+          if field_class.present?
+            # The field has been registered before.
+            instantiate_field(field_name, klass: field_class, **args, &block)
+          else
+            # The symbol can be transformed to a class and found.
+            class_name = as.to_s.camelize
+            field_class = "#{class_name}Field"
+
+            # Discover & load custom field classes
+            if Object.const_defined? field_class
+              instantiate_field(field_name, klass: field_class.safe_constantize, **args, &block)
+            end
+          end
+        end
+
+        def parse_class(field_name, as:, **args, &block)
+          # The field has been passed as a class.
+          if Object.const_defined? as.to_s
+            instantiate_field(field_name, klass: as, **args, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avo/concerns/has_html_attributes.rb

@@ -0,0 +1,110 @@
+module Avo
+  module Concerns
+    module HasHTMLAttributes
+      extend ActiveSupport::Concern
+
+      attr_reader :html
+
+      # Used to get attributes for elements and views
+      #
+      # examples:
+      # get_html :data, view: :edit, element: :input
+      # get_html :classes, view: :show, element: :wrapper
+      # get_html :styles, view: :index, element: :wrapper
+      def get_html(name = nil, element:, view:)
+        if [view, element].any?(&:nil?) || Avo::App.license.lacks_with_trial(:stimulus_js_integration)
+          default_attribute_value name
+        end
+
+        attributes = if html_builder.is_a? Hash
+          get_html_from_hash name, element: element, view: view
+        elsif html_builder.is_a? Avo::HTML::Builder
+          get_html_from_block name, element: element, view: view
+        elsif html_builder.nil?
+          # Handle empty html_builder by returning an empty state
+          default_attribute_value name
+        end
+
+        add_default_data_attributes attributes, name, element, view
+      end
+
+      private
+
+      def html_builder
+        return @parsed_html if @parsed_html.present?
+
+        return if @html.nil?
+
+        # Memoize the value
+        @parsed_html = if @html.is_a? Hash
+          @html
+        elsif @html.respond_to? :call
+          Avo::HTML::Builder.parse_block(record: model, resource: resource, &@html)
+        end
+
+        @parsed_html
+      end
+
+      def default_attribute_value(name)
+        name == :data ? {} : ""
+      end
+
+      def add_default_data_attributes(attributes, name, element, view)
+        if !attributes.nil? && name == :data && element == :input && view.in?([:edit, :new]) && resource.present?
+          extra_attributes = resource.get_stimulus_controllers
+            .split(" ")
+            .map do |controller|
+              [:"#{controller}-target", "#{id.to_s.underscore}_#{type.to_s.underscore}_input".camelize(:lower)]
+            end
+            .to_h
+
+          extra_attributes.merge attributes
+        else
+          attributes
+        end
+      end
+
+      def get_html_from_block(name = nil, element:, view:)
+        values = []
+
+        # get view ancestor
+        values << html_builder.dig_stack(view, element, name)
+        # get element ancestor
+        values << html_builder.dig_stack(element, name)
+        # get direct ancestor
+        values << html_builder.dig_stack(name)
+
+        values_type = if name == :data
+          :hash
+        else
+          :string
+        end
+
+        merge_values_as(as: values_type, values: values)
+      end
+
+      def get_html_from_hash(name = nil, element:, view:)
+        # @todo: what if this is not a Hash but a string?
+        html_builder.dig(view, element, name) || {}
+      end
+
+      # Merge the values from all possible locations.
+      # If the result is "blank", return nil so the attributes are not outputted to the DOM.
+      #
+      # Ex: if the style attribute is empty return `nil` instead of an empty space `" "`
+      def merge_values_as(as: :array, values: [])
+        result = if as == :array
+          values.flatten
+        elsif as == :string
+          values.select do |value|
+            value.is_a? String
+          end.join " "
+        elsif as == :hash
+          values.reduce({}, :merge)
+        end
+
+        result if result.present?
+      end
+    end
+  end
+end

data/lib/avo/concerns/has_stimulus_controllers.rb

@@ -0,0 +1,42 @@
+module Avo
+  module Concerns
+    module HasStimulusControllers
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :stimulus_controllers, default: ""
+      end
+
+      def get_stimulus_controllers
+        return "" if view.nil?
+
+        controllers = []
+
+        case view.to_sym
+        when :show
+          controllers << "resource-show"
+        when :new, :edit
+          controllers << "resource-edit"
+        when :index
+          controllers << "resource-index"
+        end
+
+        controllers << self.class.stimulus_controllers
+
+        controllers.join " "
+      end
+
+      def stimulus_data_attributes
+        attributes = {
+          controller: get_stimulus_controllers,
+        }
+
+        get_stimulus_controllers.split(" ").each do |controller|
+          attributes["#{controller}-view-value"] = view
+        end
+
+        attributes
+      end
+    end
+  end
+end

data/lib/avo/fields/base_field.rb

@@ -5,10 +5,13 @@ module Avo
       extend Avo::Fields::FieldExtensions::HasFieldName
 
       include Avo::Fields::FieldExtensions::VisibleInDifferentViews
-      include Avo::Concerns::HandlesFieldArgs
       include ActionView::Helpers::UrlHelper
 
-      delegate :view_context, to: "Avo::App"
+      include Avo::Concerns::HandlesFieldArgs
+      include Avo::Concerns::HasHTMLAttributes
+
+      delegate :view_context, to: ::Avo::App
+      delegate :simple_format, :content_tag, to: :view_context
       delegate :main_app, to: :view_context
       delegate :avo, to: :view_context
       delegate :t, to: ::I18n
@@ -51,7 +54,6 @@ module Avo
         @id = id
         @name = args[:name]
         @translation_key = args[:translation_key]
-        @translation_enabled = ::Avo::App.translation_enabled
         @block = block
         @required = args[:required] || false
         @readonly = args[:readonly] || false
@@ -67,6 +69,7 @@ module Avo
         @as_avatar = args[:as_avatar] || false
         @as_description = args[:as_description] || false
         @index_text_align = args[:index_text_align] || :left
+        @html = args[:html] || nil
 
         @updatable = true
         @computable = true
@@ -80,22 +83,21 @@ module Avo
         except_on args[:except_on] if args[:except_on].present?
       end
 
-      def hydrate(model: nil, resource: nil, action: nil, view: nil, panel_name: nil, user: nil, translation_enabled: nil)
+      def hydrate(model: nil, resource: nil, action: nil, view: nil, panel_name: nil, user: nil)
         @model = model if model.present?
         @view = view if view.present?
         @resource = resource if resource.present?
         @action = action if action.present?
         @user = user if user.present?
         @panel_name = panel_name if panel_name.present?
-        @translation_enabled = translation_enabled if translation_enabled.present?
 
         self
       end
 
       def translation_key
-        return "avo.field_translations.#{@id}" if @translation_enabled
+        return @translation_key if @translation_key.present?
 
-        @translation_key
+        "avo.field_translations.#{@id}"
       end
 
       # Getting the name of the resource (user/users, post/posts)
@@ -105,19 +107,27 @@ module Avo
       def name
         default = @id.to_s.humanize(keep_id_suffix: true)
 
-        return @name if @name.present?
+        return @name if custom_name?
 
-        return t(translation_key, count: 1, default: default).capitalize if translation_key
-
-        default
+        if translation_key && ::Avo::App.translation_enabled
+          t(translation_key, count: 1, default: default).capitalize
+        else
+          default
+        end
       end
 
       def plural_name
         default = name.pluralize
 
-        return t(translation_key, count: 2, default: default).capitalize if translation_key
+        if translation_key && ::Avo::App.translation_enabled
+          t(translation_key, count: 2, default: default).capitalize
+        else
+          default
+        end
+      end
 
-        default
+      def custom_name?
+        @name.present?
       end
 
       def placeholder

data/lib/avo/fields/select_field.rb

@@ -10,7 +10,7 @@ module Avo
 
         super(id, **args, &block)
 
-        @options = args[:options].present? ? args[:options] : args[:enum]
+        @options = args[:options] || args[:enum]
         @options = ActiveSupport::HashWithIndifferentAccess.new @options if @options.is_a? Hash
         @enum = args[:enum].present? ? args[:enum] : nil
         @display_value = args[:display_value].present? ? args[:display_value] : false

data/lib/avo/grid_collector.rb

@@ -1,6 +1,6 @@
 module Avo
   class GridCollector
-    include FieldsCollector
+    include Avo::Concerns::HasFields
 
     attr_accessor :cover_field
     attr_accessor :title_field
@@ -13,15 +13,15 @@ module Avo
     end
 
     def cover(field_name, as:, **args, &block)
-      self.cover_field = parse_field(field_name, as: as, **args, &block)
+      self.cover_field = self.class.parse_field(field_name, as: as, **args, &block)
     end
 
     def title(field_name, as:, **args, &block)
-      self.title_field = parse_field(field_name, as: as, **args, &block)
+      self.title_field = self.class.parse_field(field_name, as: as, **args, &block)
     end
 
     def body(field_name, as:, **args, &block)
-      self.body_field = parse_field(field_name, as: as, **args, &block)
+      self.body_field = self.class.parse_field(field_name, as: as, **args, &block)
     end
 
     def hydrate(model:, view:, resource:)

data/lib/avo/html/builder.rb

@@ -0,0 +1,117 @@
+class Avo::HTML::Builder
+  class << self
+    def parse_block(record: nil, resource: nil, &block)
+      Docile.dsl_eval(Avo::HTML::Builder.new(record: record, resource: resource), &block).build
+    end
+  end
+
+  attr_accessor :wrapper_stack
+  attr_accessor :data_stack
+  attr_accessor :style_stack
+  attr_accessor :classes_stack
+  attr_accessor :show_stack
+  attr_accessor :edit_stack
+  attr_accessor :index_stack
+  attr_accessor :input_stack
+
+  attr_accessor :record
+  attr_accessor :resource
+
+  delegate :root_path, to: Avo::App
+  delegate :params, to: Avo::App
+  delegate :current_user, to: Avo::App
+
+  def initialize(record: nil, resource: nil)
+    @wrapper_stack = {}
+    @data_stack = {}
+    @style_stack = ""
+    @classes_stack = ""
+    @show_stack = {}
+    @edit_stack = {}
+    @index_stack = {}
+    @input_stack = {}
+
+    @record = record
+    @resource = resource
+  end
+
+  def get_stack(name = nil)
+    # We don't have an edit component for new so we should use edit
+    name = :edit if name == :new
+
+    send "#{name}_stack"
+  end
+
+  def dig_stack(*names)
+    value = get_stack names.shift
+
+    if value.is_a? self.class
+      value.dig_stack(*names)
+    else
+      value
+    end
+  end
+
+  # payload or block
+  def data(payload = nil, &block)
+    assign_property :data, payload, &block
+  end
+
+  # payload or block
+  def style(payload = nil, &block)
+    assign_property :style, payload, &block
+  end
+
+  # payload or block
+  def classes(payload = nil, &block)
+    assign_property :classes, payload, &block
+  end
+
+  # Takes a block
+  def wrapper(&block)
+    capture_block :wrapper, &block
+  end
+
+  # Takes a block
+  def input(&block)
+    capture_block :input, &block
+  end
+
+  # Takes a block
+  def show(&block)
+    capture_block :show, &block
+  end
+
+  # Takes a block
+  def edit(&block)
+    capture_block :edit, &block
+  end
+
+  # Takes a block
+  def index(&block)
+    capture_block :index, &block
+  end
+
+  # Fetch the menu
+  def build
+    self
+  end
+
+  protected
+
+  # Capture and parse the blocks for the nested structure
+  def capture_block(property = nil, &block)
+    send("#{property}_stack=", self.class.parse_block(record: record, resource: resource, &block).build)
+  end
+
+  # Parse the properties and assign them to the blocks
+  def assign_property(property = :data, payload = nil, &block)
+    value = if block.present?
+      Avo::Hosts::RecordHost.new(block: block, record: record).handle
+    else
+      payload
+    end
+
+    send("#{property}_stack=", value)
+  end
+end

data/lib/avo/licensing/pro_license.rb

@@ -14,6 +14,7 @@ module Avo
           :resource_ordering,
           :dashboards,
           :menu_editor,
+          :stimulus_js_integration,
           :advanced_fields
         ]
       end

data/lib/avo/version.rb

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

data/lib/avo.rb

@@ -3,6 +3,10 @@ require_relative "avo/version"
 require_relative "avo/engine" if defined?(Rails)
 
 loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect(
+  "html" => "HTML",
+  "has_html_attributes" => "HasHTMLAttributes"
+)
 loader.setup
 
 #                                      .//*,,.....,,*/(*

data/lib/generators/avo/templates/cards/chartkick_card_sample.tt

@@ -5,7 +5,17 @@ class <%= class_name.camelize %> < Avo::Dashboards::ChartkickCard
   # self.description = "Some tiny description"
   # self.cols = 2
   # self.initial_range = 30
-  # self.ranges = [7, 30, 60, 365, "TODAY", "MTD", "QTD", "YTD", "ALL"]
+  # self.ranges = {
+  #   "7 days": 7,
+  #   "30 days": 30,
+  #   "60 days": 60,
+  #   "365 days": 365,
+  #   Today: "TODAY",
+  #   "Month to date": "MTD",
+  #   "Quarter to date": "QTD",
+  #   "Year to date": "YTD",
+  #   All: "ALL",
+  # }
   # self.chart_options = { library: { plugins: { legend: { display: true } } } }
   # self.flush = true