avo 1.24.2 → 2.1.0

data/lib/avo/engine.rb

@@ -24,7 +24,9 @@ module Avo
         ["app", "avo", "fields"],
         ["app", "avo", "filters"],
         ["app", "avo", "actions"],
-        ["app", "avo", "resources"]
+        ["app", "avo", "resources"],
+        ["app", "avo", "dashboards"],
+        ["app", "avo", "cards"]
       ].each do |path_params|
         path = Rails.root.join(*path_params)
 
@@ -42,6 +44,8 @@ module Avo
     initializer "avo.reload_avo_files" do |app|
       if Avo::IN_DEVELOPMENT && ENV["RELOAD_AVO_FILES"]
         avo_root_path = Avo::Engine.root.to_s
+        # This should only be happening when ENV["RELOAD_AVO_FILES"] is true because it loads all the files into memory on every change and makes rails sluggish.
+        app.config.autoload_paths += [Avo::Engine.root.join("lib", "avo").to_s]
         # Register reloader
         app.reloaders << app.config.file_watcher.new([], {
           Avo::Engine.root.join("lib", "avo").to_s => ["rb"]

data/lib/avo/fields/base_field.rb

@@ -7,9 +7,10 @@ module Avo
       include ActionView::Helpers::UrlHelper
       include Avo::Fields::FieldExtensions::VisibleInDifferentViews
 
-      delegate :view_context, to: 'Avo::App'
+      delegate :view_context, to: "Avo::App"
       delegate :main_app, to: :view_context
       delegate :avo, to: :view_context
+      delegate :t, to: ::I18n
 
       attr_reader :id
       attr_reader :block
@@ -48,7 +49,7 @@ module Avo
         @id = id
         @name = args[:name]
         @translation_key = args[:translation_key]
-        @translation_enabled = false
+        @translation_enabled = ::Avo::App.translation_enabled
         @block = block
         @required = args[:required] || false
         @readonly = args[:readonly] || false
@@ -94,18 +95,26 @@ module Avo
         @translation_key
       end
 
+      # Getting the name of the resource (user/users, post/posts)
+      # We'll first check to see if the user passed a name
+      # Secondly we'll try to find a translation key
+      # We'll fallback to humanizing the id
       def name
+        default = @id.to_s.humanize(keep_id_suffix: true)
+
         return @name if @name.present?
 
-        return I18n.t(translation_key, count: 1).capitalize if translation_key
+        return t(translation_key, count: 1, default: default).capitalize if @translation_key
 
-        @id.to_s.humanize(keep_id_suffix: true)
+        default
       end
 
       def plural_name
-        return I18n.t(translation_key, count: 2).capitalize if translation_key
+        default = name.pluralize
+
+        return t(translation_key, count: 2, default: default).capitalize if @translation_key
 
-        name.pluralize
+        default
       end
 
       def placeholder
@@ -181,8 +190,12 @@ module Avo
         "#{type.camelize}Field"
       end
 
+      # Try and build the component class or fallback to a blank one
       def component_for_view(view = :index)
-        "Avo::Fields::#{view_component_name}::#{view.to_s.camelize}Component".safe_constantize
+        component_class = "::Avo::Fields::#{view_component_name}::#{view.to_s.camelize}Component"
+        component_class.constantize
+      rescue
+        ::Avo::BlankFieldComponent
       end
 
       def model_errors

data/lib/avo/fields/belongs_to_field.rb

@@ -70,11 +70,11 @@ module Avo
         @searchable = args[:searchable] == true
         @polymorphic_as = args[:polymorphic_as]
         @types = args[:types]
-        @relation_method = name.to_s.parameterize.underscore
+        @relation_method = id.to_s.parameterize.underscore
       end
 
       def searchable
-        @searchable && ::Avo::App.license.has_with_trial(:searchable_belongs_to)
+        @searchable && ::Avo::App.license.has_with_trial(:searchable_associations)
       end
 
       def value

data/lib/avo/fields/external_image_field.rb

@@ -11,8 +11,8 @@ module Avo
 
         @link_to_resource = args[:link_to_resource].present? ? args[:link_to_resource] : false
 
-        @width = args[:width].present? ? args[:width] : 32
-        @height = args[:height].present? ? args[:height] : 32
+        @width = args[:width].present? ? args[:width] : 40
+        @height = args[:height].present? ? args[:height] : 40
         @radius = args[:radius].present? ? args[:radius] : 0
       end
 

data/lib/avo/fields/gravatar_field.rb

@@ -17,8 +17,8 @@ module Avo
         hide_on [:edit, :new]
 
         @link_to_resource = args[:link_to_resource].present? ? args[:link_to_resource] : false
-        @rounded = args[:rounded].present? ? args[:rounded] : true
-        @size = args[:size].present? ? args[:size].to_i : 40
+        @rounded = args[:rounded].nil? ? true : args[:rounded]
+        @size = args[:size].present? ? args[:size].to_i : 32
         @default = args[:default].present? ? ERB::Util.url_encode(args[:default]).to_s : ""
       end
 

data/lib/avo/fields/has_base_field.rb

@@ -7,8 +7,13 @@ module Avo
       def initialize(id, **args, &block)
         super(id, **args, &block)
 
-        @display = args[:display].present? ? args[:display] : :show
         @scope = args[:scope].present? ? args[:scope] : nil
+        @display = args[:display].present? ? args[:display] : :show
+        @searchable = args[:searchable] == true
+      end
+
+      def searchable
+        @searchable && ::Avo::App.license.has_with_trial(:searchable_associations)
       end
 
       def resource
@@ -23,6 +28,20 @@ module Avo
         "#{@resource.record_path}/#{id}?turbo_frame=#{turbo_frame}"
       end
 
+      # The value
+      def field_value
+        value.send(database_value)
+      rescue
+        nil
+      end
+
+      # What the user sees in the text field
+      def field_label
+        value.send(target_resource.class.title)
+      rescue
+        nil
+      end
+
       def target_resource
         if @model._reflections[id.to_s].klass.present?
           Avo::App.get_resource_by_model_name @model._reflections[id.to_s].klass.to_s
@@ -32,6 +51,10 @@ module Avo
           Avo::App.get_resource_by_name id.to_s
         end
       end
+
+      def placeholder
+        @placeholder || I18n.t("avo.choose_an_option")
+      end
     end
   end
 end

data/lib/avo/hosts/dashboard_card.rb

@@ -0,0 +1,21 @@
+require "dry-initializer"
+
+module Avo
+  module Hosts
+    class DashboardCard
+      extend Dry::Initializer
+
+      option :context
+      option :range
+      option :dashboard
+      option :card
+      option :params
+
+      delegate :result, to: :card
+
+      def compute_result
+        instance_exec(&card.query_block)
+      end
+    end
+  end
+end

data/lib/avo/hosts/dashboard_visibility.rb

@@ -0,0 +1,19 @@
+require "dry-initializer"
+
+module Avo
+  module Hosts
+    class DashboardVisibility
+      extend Dry::Initializer
+
+      option :block, default: proc { proc {} }
+      option :current_user, default: proc { ::Avo::App.current_user }
+      option :context, default: proc { ::Avo::App.context }
+      option :dashboard
+      option :params, default: proc { ::Avo::App.params }
+
+      def handle
+        instance_exec(&block)
+      end
+    end
+  end
+end

data/lib/avo/hosts/ordering.rb

@@ -1,4 +1,4 @@
-require 'dry-initializer'
+require "dry-initializer"
 
 module Avo
   module Hosts

data/lib/avo/licensing/license.rb

@@ -50,12 +50,14 @@ module Avo
 
       # Returns if has ability and if is a valid license or app is in development.
       def has_with_trial(ability)
-        can(ability) && (valid? || Rails.env.development? || Rails.env.test?)
+        return can(ability) && valid? if Rails.env.production?
+
+        true
       end
 
       # Returns if lacks ability and if is a valid license or app is in development.
       def lacks_with_trial(ability)
-        !can(ability) && (valid? || Rails.env.development? || Rails.env.test?)
+        !has_with_trial ability
       end
     end
   end

data/lib/avo/licensing/pro_license.rb

@@ -4,12 +4,14 @@ module Avo
       def abilities
         [
           :authorization,
+          :localization,
           :custom_tools,
           :custom_fields,
           :global_search,
           :enhanced_search_results,
-          :searchable_belongs_to,
+          :searchable_associations,
           :resource_ordering,
+          :dashboards
         ]
       end
     end

data/lib/avo/version.rb

@@ -1,3 +1,3 @@
 module Avo
-  VERSION = "1.24.2"
+  VERSION = "2.1.0"
 end

data/lib/avo.rb

@@ -5,6 +5,30 @@ require_relative "avo/engine" if defined?(Rails)
 loader = Zeitwerk::Loader.for_gem
 loader.setup
 
+#                                      .//*,,.....,,*/(*
+#                                   **,,..............,*#.
+#                               ,*,,.....         .....*/#.
+#                            **,,....             ....,*/%%
+#                        ,**,,.......           . ....*/#&%
+#                    **,,,...... .             . ....*/#&&%
+#                **,,........ .           .     ...,//#&&&.
+#            */*,,..*//***,,,,*/(,..      .. .....*//%&%&*
+#         ,/**,..**/******,,***/(###,...........,//(%&&%.
+#       /**,,..((//*****////((##%%%%%*.........*//%%&&%
+#     ****,...#/**,,,*,*/(#%##%%%%&&&(*,.....,*/(%&&&/
+#    /**,....(/*,,,,,,,*(##%%%%%&&&&&(,.....,*(#&&&&.
+#  ,//*,.....(/*,,**//(##%%%%&&&&@&&%/,....,*((&&&&*
+# .//*,,.....(((//(((##%%%&&&&&&&&@#/,....,*/#%&&&#
+# (/**,,......###%%%%%&&&&&&&&&&@#/,,...,,*/#&&&&&
+# (/**,,........%%%%%&&&&&&&&@%(*,...,,,*//(&&&&%.
+# ///*,,,.........,*#&&&&#(/,,.....,,,*//(%&&&&%*
+#  (//**,,,.....................,,,,*//(%&&&&&&*
+#   *(///**,,,,............,,,,,,**/((&&&&&&&%.
+#     ((///*****,,,,,,,,,,,,***//((&&&&&%&%&#
+#       .((((////********///(((%&%&&&&%%%%%
+#           (############%%%%%%%%%%%%%%%*
+#               ,(############%%%%%#*
+
 module Avo
   ROOT_PATH = Pathname.new(File.join(__dir__, ".."))
   IN_DEVELOPMENT = ENV["AVO_IN_DEVELOPMENT"] == "1"

data/lib/generators/avo/chartkick_card_generator.rb

@@ -0,0 +1,16 @@
+require "rails/generators"
+
+module Generators
+  module Avo
+    class ChartkickCardGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      namespace "avo:card:chartkick"
+      desc "Add a chartkick card for your Avo dashboard."
+
+      def handle
+        template "cards/chartkick_card_sample.tt", "app/avo/cards/#{name.underscore}.rb"
+      end
+    end
+  end
+end

data/lib/generators/avo/dashboard_generator.rb

@@ -0,0 +1,16 @@
+require "rails/generators"
+
+module Generators
+  module Avo
+    class DashboardGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      namespace "avo:dashboard"
+      desc "Add an Avo dashboard to your project."
+
+      def handle
+        template "dashboards/dashboard.tt", "app/avo/dashboards/#{name.underscore}.rb"
+      end
+    end
+  end
+end

data/lib/generators/avo/metric_card_generator.rb

@@ -0,0 +1,16 @@
+require "rails/generators"
+
+module Generators
+  module Avo
+    class MetricCardGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      namespace "avo:card:metric"
+      desc "Add a metric card for your Avo dashboard."
+
+      def handle
+        template "cards/metric_card_sample.tt", "app/avo/cards/#{name.underscore}.rb"
+      end
+    end
+  end
+end

data/lib/generators/avo/partial_card_generator.rb

@@ -0,0 +1,17 @@
+require "rails/generators"
+
+module Generators
+  module Avo
+    class PartialCardGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      namespace "avo:card:partial"
+      desc "Add a partial card for your Avo dashboard."
+
+      def handle
+        template "cards/partial_card_sample.tt", "app/avo/cards/#{name.underscore}.rb"
+        template "cards/partial_card_partial.tt", "app/views/avo/cards/_#{name.underscore}.html.erb"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+class <%= class_name.camelize %> < Avo::Dashboards::ChartkickCard
+  self.id = "<%= name.underscore %>"
+  self.label = "<%= name.underscore.humanize %>"
+  self.chart_type = :area_chart
+
+  query do
+    data = 3.times.map do |index|
+      {
+        name: "Batch #{index}",
+        data: 17.times.map { |i| [i, Random.rand(32)] }
+      }
+    end
+
+    result data
+  end
+end

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

@@ -0,0 +1,26 @@
+class <%= class_name.camelize %> < Avo::Dashboards::ChartkickCard
+  self.id = "<%= name.underscore %>"
+  self.label = "<%= name.underscore.humanize %>"
+  self.chart_type = :area_chart
+  # self.description = "Some tiny description"
+  # self.cols = 2
+  # self.initial_range = 30
+  # self.ranges = [7, 30, 60, 365, "TODAY", "MTD", "QTD", "YTD", "ALL"]
+  # self.chart_options = { library: { plugins: { legend: { display: true } } } }
+  # self.flush = true
+
+  query do
+    points = 16
+    i = Time.new.year.to_i - points
+    base_data = Array.new(points).map do
+      i += 1
+      [i.to_s, rand(0..20)]
+    end.to_h
+
+    result [
+      { name: "batch 1", data: base_data.map { |k, v| [k, rand(0..20)] }.to_h },
+      { name: "batch 2", data: base_data.map { |k, v| [k, rand(0..40)] }.to_h },
+      { name: "batch 3", data: base_data.map { |k, v| [k, rand(0..10)] }.to_h }
+    ]
+  end
+end

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

@@ -0,0 +1,8 @@
+class <%= class_name.camelize %> < Avo::Dashboards::MetricCard
+  self.id = "<%= name.underscore %>"
+  self.label = "<%= name.underscore.humanize %>"
+
+  query do
+    result 101
+  end
+end

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

@@ -0,0 +1,38 @@
+class <%= class_name.camelize %> < Avo::Dashboards::MetricCard
+  self.id = "<%= name.underscore %>"
+  self.label = "<%= name.underscore.humanize %>"
+  # self.description = "Some description"
+  # self.cols = 1
+  # self.initial_range = 30
+  # self.ranges = [7, 30, 60, 365, "TODAY", "MTD", "QTD", "YTD", "ALL"]
+  # self.prefix = ""
+  # self.suffix = ""
+
+  query do
+    # from = Date.today.midnight - 1.week
+    # to = DateTime.current
+
+    # if range.present?
+    #   if range.to_s == range.to_i.to_s
+    #     from = DateTime.current - range.to_i.days
+    #   else
+    #     case range
+    #     when "TODAY"
+    #       from = DateTime.current.beginning_of_day
+    #     when "MTD"
+    #       from = DateTime.current.beginning_of_month
+    #     when "QTD"
+    #       from = DateTime.current.beginning_of_quarter
+    #     when "YTD"
+    #       from = DateTime.current.beginning_of_year
+    #     when "ALL"
+    #       from = Time.at(0)
+    #     end
+    #   end
+    # end
+
+    # result User.where(created_at: from..to).count
+
+    result 101
+  end
+end

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

@@ -0,0 +1,8 @@
+class <%= class_name.camelize %> < Avo::Dashboards::PartialCard
+  self.id = "<%= name.underscore %>"
+  self.label = "<%= name.underscore.humanize %>"
+  self.partial = "avo/cards/<%= name.underscore %>"
+  # self.display_header = true
+  # self.cols = 1
+  # self.rows = 1
+end

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

@@ -0,0 +1,8 @@
+<div class="flex-1 flex p-4">
+  <div class="place-self-end">
+    Dashboard ID: <%%= @dashboard.id %>
+    <br />
+    <br />
+    Customize this partial under <code class='p-1 rounded bg-gray-500 text-white text-sm'>app/views/avo/cards/_<%= name.underscore %>.html.erb</code>
+  </div>
+</div>

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

@@ -0,0 +1,8 @@
+class <%= class_name.camelize %> < Avo::Dashboards::PartialCard
+  self.id = "<%= name.underscore %>"
+  self.label = "<%= name.underscore.humanize %>"
+  self.partial = "avo/cards/<%= name.underscore %>"
+  # self.display_header = true
+  # self.cols = 1
+  # self.rows = 1
+end

data/lib/generators/avo/templates/dashboards/dashboard.tt

@@ -0,0 +1,12 @@
+class <%= class_name.camelize %> < Avo::Dashboards::BaseDashboard
+  self.id = "<%= name.underscore %>"
+  self.name = "<%= name.underscore.humanize %>"
+  # self.description = "Tiny dashboard description"
+  # self.grid_cols = 3
+  # self.visible = -> do
+  #   true
+  # end
+
+  # cards go here
+  # card UsersCount
+end

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

@@ -1,6 +1,7 @@
 en:
   avo:
     dashboard: 'Dashboard'
+    dashboards: 'Dashboards'
     choose_a_country: 'Choose a country'
     choose_an_option: 'Choose an option'
     are_you_sure_you_want_to_run_this_option: 'Are you sure you want to run this action?'
@@ -8,16 +9,15 @@ en:
     run: 'Run'
     cancel: 'Cancel'
     action_ran_successfully: 'Action ran successfully!'
-    resource_details: '%{item} details: %{title}'
-    update_item: 'update %{item}: %{title}'
+    details: "details"
     unauthorized: 'Unauthorized'
     attachment_class_attached: '%{attachment_class} attached.'
     attachment_class_detached: '%{attachment_class} detached.'
     resource_updated: 'Resource updated'
     resource_created: 'Resource created'
     resource_destroyed: 'Resource destroyed'
-    switch_to_view: 'Switch to %{view_type} view'
-    click_to_reveal_filters: 'Click to reveal filters'
+    switch_to_view: "Switch to %{view_type} view"
+    click_to_reveal_filters: "Click to reveal filters"
     attachment_destroyed: 'Attachment destroyed'
     failed_to_find_attachment: 'Failed to find attachment'
     you_missed_something_check_form: 'You might have missed something. Please check the form.'
@@ -44,6 +44,7 @@ en:
     per_page: 'Per page'
     more: 'More'
     attach: 'Attach'
+    cancel: 'Cancel'
     save: 'Save'
     attach_and_attach_another: 'Attach & Attach another'
     hide_content: 'Hide content'
@@ -73,6 +74,10 @@ en:
         zero: 'files'
         one: 'file'
         other: 'files'
+      people:
+        zero: 'peeps'
+        one: 'peep'
+        other: 'peeps'
     resource_translations:
       user:
         zero: 'users'
@@ -101,3 +106,5 @@ en:
       lower: Move record lower
       to_top: Move record to top
       to_bottom: Move record to bottom
+    empty_dashboard_message: Add cards to this dashboard
+    no_cards_present: 'No cards present'

data/lib/generators/avo/templates/locales/avo.nb-NO.yml

@@ -1,6 +1,7 @@
 nb-NO:
   avo:
     dashboard: 'Dashboard'
+    dashboards: 'Dashboards'
     choose_a_country: 'Velg et land'
     choose_an_option: 'Velg et alternativ'
     are_you_sure_you_want_to_run_this_option: 'Er du sikker?'
@@ -8,8 +9,7 @@ nb-NO:
     run: 'Kjør'
     cancel: 'Avslutt'
     action_ran_successfully: 'Suksess!'
-    resource_details: "%{item} detaljer: %{title}"
-    update_item: 'Oppdatert %{item}: %{title}'
+    details: "detaljer"
     unauthorized: 'Ikke autorisert'
     attachment_class_attached: '%{attachment_class} lagt til.'
     attachment_class_detached: '%{attachment_class} fjernet.'
@@ -82,3 +82,6 @@ nb-NO:
     search_cancel_button: 'Avbryt'
     sign_out: 'Logg ut'
     tools: Redskapene
+    empty_dashboard_message: Legg til kort i dette dashbordet
+    no_cards_present: 'Ingen kort til stede'
+

data/lib/generators/avo/templates/locales/avo.pt-BR.yml

@@ -1,6 +1,7 @@
 pt-BR:
   avo:
     dashboard: 'Painel'
+    dashboards: 'Painéis'
     choose_a_country: 'Escolha um país'
     choose_an_option: 'Escolha uma opção'
     are_you_sure_you_want_to_run_this_option: 'Você tem certeza que deseja executar esta ação?'
@@ -8,8 +9,7 @@ pt-BR:
     run: 'Executar'
     cancel: 'Cancelar'
     action_ran_successfully: 'Ação executada com sucesso!'
-    resource_details: "Detalhe %{item}: %{title}"
-    update_item: 'atualizar %{item}: %{title}'
+    details: "detalhe"
     unauthorized: 'Não autorizado'
     attachment_class_attached: '%{attachment_class} anexado.'
     attachment_class_detached: '%{attachment_class} separado.'
@@ -84,3 +84,5 @@ pt-BR:
       cancel_button: 'Cancelar'
     sign_out: 'sair'
     tools: Ferramentas
+    empty_dashboard_message: Adicionar cartões a este painel
+    no_cards_present: 'Nenhum cartão presente'

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

@@ -1,13 +1,14 @@
 ro:
   avo:
     dashboard: 'Panou de control'
+    dashboards: 'Panouri de control'
     choose_a_country: 'Alege o tara'
     choose_an_option: 'Alege o optiune'
     are_you_sure_you_want_to_run_this_option: 'Esti sigur ca vrei sa rulezi aceasta actiune?'
     run: 'Ruleaza'
     cancel: 'Anuleaza'
     action_ran_successfully: 'Actiunea a rulat cu succes!'
-    resource_details: 'Detalii %{item}'
+    details: "detalii"
     unauthorized: 'Neautorizat'
     attachment_class_attached: '%{attachment_class} anexat.'
     attachment_class_detached: '%{attachment_class} separat.'
@@ -79,3 +80,5 @@ ro:
     was_successfully_created: 'a fost creat'
     was_successfully_updated: 'a fost actualizat'
     tools: Instrumente
+    empty_dashboard_message: Adauga carduri in acest dashboard
+    no_cards_present: 'Niciun card disponibil'

data/lib/generators/avo/templates/tool/sidebar_item.tt

@@ -1 +1 @@
-<%%= render Avo::NavigationLinkComponent.new label: '<%= human_name %>', path: "#{avo.root_path}<%= file_name %>" %>
+<%%= render Avo::SidebarItemComponent.new label: '<%= human_name %>', path: "#{avo.root_path}<%= file_name %>" %>