avo 1.25.2 → 2.0.0

data/lib/avo/app.rb

@@ -1,6 +1,7 @@
 module Avo
   class App
     class_attribute :resources, default: []
+    class_attribute :dashboards, default: []
     class_attribute :cache_store, default: nil
     class_attribute :fields, default: []
     class_attribute :request, default: nil
@@ -44,6 +45,7 @@ module Avo
         end
 
         init_resources
+        init_dashboards if license.has_with_trial(:dashboards)
       end
 
       # This method will find all fields available in the Avo::Fields namespace and add them to the fields class_variable array
@@ -82,6 +84,20 @@ module Avo
           end
       end
 
+      def init_dashboards
+        self.dashboards = Dashboards::BaseDashboard.descendants
+          .select do |dashboard|
+            dashboard != Dashboards::BaseDashboard
+          end
+      end
+
+      # Returns the Avo dashboard by id
+      def get_dashboard_by_id(id)
+        dashboards.find do |dashboard|
+          dashboard.id == id
+        end
+      end
+
       # Returns the Avo resource by camelized name
       #
       # get_resource_by_name('User') => UserResource
@@ -132,15 +148,26 @@ module Avo
           .sort_by { |r| r.name }
       end
 
+      def get_available_dashboards(user = nil)
+        dashboards.sort_by { |r| r.name }
+      end
+
       def resources_navigation(user = nil)
-        get_available_resources(user).select do |resource|
-          resource.model_class.present?
-        end
+        get_available_resources(user)
+          .select do |resource|
+            resource.model_class.present?
+          end
           .select do |resource|
             resource.visible_on_sidebar
           end
       end
 
+      def get_dashboards(user = nil)
+        return [] unless App.license.has_with_trial(:resource_ordering)
+
+        get_available_dashboards(user)
+      end
+
       # Insert any partials that we find in app/views/avo/sidebar/items.
       def get_sidebar_partials
         Dir.glob(Rails.root.join("app", "views", "avo", "sidebar", "items", "*.html.erb"))

data/lib/avo/base_resource.rb

@@ -92,7 +92,9 @@ module Avo
 
     def initialize
       unless self.class.model_class.present?
-        self.class.model_class = model_class.base_class
+        if model_class.present?
+          self.class.model_class = model_class.base_class
+        end
       end
     end
 
@@ -209,9 +211,9 @@ module Avo
 
       case @view
       when :show
-        I18n.t("avo.resource_details", item: name.downcase, title: model_title).upcase_first
+        model_title
       when :edit
-        I18n.t("avo.update_item", item: name.downcase, title: model_title).upcase_first
+        model_title
       when :new
         I18n.t("avo.create_new_item", item: name.downcase).upcase_first
       end
@@ -406,15 +408,11 @@ module Avo
     # This is used as the model class ID
     # We use this instead of the route_key to maintain compatibility with uncountable models
     # With uncountable models route key appends an _index suffix (Fish->fish_index)
-    # Example: User->users, MediaItem->media_items, Fish->fish
+    # Example: User->users, MediaItem->medie_items, Fish->fish
     def model_key
       model_class.model_name.plural
     end
 
-    def model_name
-      model_class.model_name
-    end
-
     def singular_model_key
       model_class.model_name.singular
     end

data/lib/avo/dashboards/base_card.rb

@@ -0,0 +1,151 @@
+module Avo
+  module Dashboards
+    class BaseCard
+      class_attribute :id
+      class_attribute :label
+      class_attribute :description
+      class_attribute :cols, default: 1
+      class_attribute :rows, default: 1
+      class_attribute :initial_range
+      class_attribute :ranges, default: []
+      class_attribute :refresh_every
+      class_attribute :display_header, default: true
+      # private
+      class_attribute :result_data
+      class_attribute :query_block
+
+      attr_accessor :dashboard
+      attr_accessor :params
+
+      delegate :context, to: ::Avo::App
+
+      class << self
+        def query(&block)
+          self.query_block = block
+        end
+      end
+
+      def initialize(dashboard:)
+        @dashboard = dashboard
+      end
+
+      def label
+        return self.class.label.to_s if self.class.label.to_s.present?
+
+        self.class.id.to_s.humanize
+      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
+
+      def frame_url(enforced_range: nil)
+        enforced_range ||= initial_range || ranges.first
+        "#{Avo::App.root_path}/dashboards/#{dashboard.id}/cards/#{id}?turbo_frame=#{turbo_frame}&range=#{enforced_range}"
+      end
+
+      def card_classes
+        result = ""
+
+        result += case self.class.cols.to_i
+        when 1
+          " sm:col-span-1"
+        when 2
+          " sm:col-span-2"
+        when 3
+          " sm:col-span-3"
+        when 4
+          " sm:col-span-4"
+        when 5
+          " sm:col-span-5"
+        when 6
+          " sm:col-span-6"
+        else
+          " sm:col-span-1"
+        end
+
+        result += case self.class.rows.to_i
+        when 1
+          " h-36"
+        when 2
+          " h-72"
+        when 3
+          " h-[27rem]"
+        when 4
+          " h-[36rem]"
+        when 5
+          " h-[45rem]"
+        when 6
+          " h-[54rem]"
+        end
+
+        result
+      end
+
+      def type
+        return :metric if self.class.superclass == ::Avo::Dashboards::MetricCard
+        return :chartkick if self.class.superclass == ::Avo::Dashboards::ChartkickCard
+        return :partial if self.class.superclass == ::Avo::Dashboards::PartialCard
+      end
+
+      def compute_result
+        Avo::Hosts::DashboardCard.new(card: self, dashboard: dashboard, params: params, context: context, range: range)
+          .compute_result
+
+        self
+      end
+
+      def hydrate(dashboard: nil, params: nil)
+        @dashboard = dashboard if dashboard.present?
+        @params = params if params.present?
+
+        self
+      end
+
+      def range
+        return params[:range] if params.present? && params[:range].present?
+
+        return initial_range if initial_range.present?
+
+        ranges.first
+      end
+
+      def result(data)
+        self.result_data = data
+
+        self
+      end
+
+      def is_card?
+        true
+      end
+
+      def is_divider?
+        false
+      end
+    end
+  end
+end

data/lib/avo/dashboards/base_dashboard.rb

@@ -0,0 +1,54 @@
+module Avo
+  module Dashboards
+    class BaseDashboard
+      extend ActiveSupport::DescendantsTracker
+
+      class_attribute :id
+      class_attribute :name
+      class_attribute :description
+      class_attribute :items_holder
+      class_attribute :grid_cols, default: 3
+
+      class << self
+        def card(klass)
+          self.items_holder ||= []
+
+          self.items_holder << klass.new(dashboard: self)
+        end
+
+        def divider(**args)
+          self.items_holder ||= []
+
+          self.items_holder << BaseDivider.new(**args)
+        end
+
+        def items
+          self.items_holder
+        end
+
+        def classes
+          case grid_cols
+          when 3
+            "sm:grid-cols-3"
+          when 4
+            "sm:grid-cols-4"
+          when 5
+            "sm:grid-cols-5"
+          when 6
+            "sm:grid-cols-6"
+          else
+            "sm:grid-cols-3"
+          end
+        end
+
+        def navigation_label
+          name
+        end
+
+        def navigation_path
+          "#{Avo::App.root_path}/dashboards/#{id}"
+        end
+      end
+    end
+  end
+end

data/lib/avo/dashboards/base_divider.rb

@@ -0,0 +1,23 @@
+module Avo
+  module Dashboards
+    class BaseDivider
+      attr_reader :label
+      attr_reader :invisible
+
+      class_attribute :id
+
+      def initialize(label: nil, invisible: false)
+        @label = label
+        @invisible = invisible
+      end
+
+      def is_divider?
+        true
+      end
+
+      def is_card?
+        false
+      end
+    end
+  end
+end

data/lib/avo/dashboards/chartkick_card.rb

@@ -0,0 +1,77 @@
+module Avo
+  module Dashboards
+    class ChartkickCard < BaseCard
+      class_attribute :chart_type
+      class_attribute :chart_options, default: {}
+      class_attribute :flush, default: true
+      class_attribute :legend, default: false
+      class_attribute :scale, default: false
+      class_attribute :legend_on_left, default: false
+      class_attribute :legend_on_right, default: false
+
+      def chartkick_classes
+        case chart_type
+        when :area_chart, :line_chart, :scatter_chart, :bar_chart, :column_chart
+          if self.class.flush
+            "-mx-1.5 top-auto -bottom-1.5"
+          else
+            "px-2"
+          end
+        else
+          ""
+        end
+      end
+
+      def chartkick_options
+        card_height = 144
+        card_heading = 32
+
+        default = {
+          # figure our the available height for the chart
+          height: "#{(rows * card_height) - card_heading}px",
+          colors: %w[#0B8AE2 #34C683 #2AB1EE #34C6A8],
+          library: {
+            discrete: false,
+            points: false,
+            animation: true
+          },
+          id: "#{dashboard.id}-#{rand(10_000..99_999)}"
+        }
+
+        no_scale_options = {display: false}
+        no_scale = {
+          library: {
+            scales: {
+              x: no_scale_options,
+              y: no_scale_options
+            }
+          }
+        }
+
+        no_legend = {library: {plugins: {legend: {display: false}}}}
+        legend_on_left = {library: {plugins: {legend: {position: "left"}}}}
+        legend_on_right = {library: {plugins: {legend: {position: "right"}}}}
+
+        # Add chart.js configuration for the different states
+        unless self.class.legend
+          default = default.deep_merge(no_legend)
+        end
+
+        unless self.class.scale
+          default = default.deep_merge(no_scale)
+        end
+
+        if self.class.legend_on_left
+          default = default.deep_merge(legend_on_left)
+        end
+
+        if self.class.legend_on_right
+          default = default.deep_merge(legend_on_right)
+        end
+
+        # Add the custom chart options at the end
+        default.deep_merge(self.class.chart_options)
+      end
+    end
+  end
+end

data/lib/avo/dashboards/metric_card.rb

@@ -0,0 +1,9 @@
+module Avo
+  module Dashboards
+    class MetricCard < BaseCard
+      class_attribute :prefix
+      class_attribute :suffix
+      # @todo: transform 1234 to 1.2K
+    end
+  end
+end

data/lib/avo/dashboards/partial_card.rb

@@ -0,0 +1,7 @@
+module Avo
+  module Dashboards
+    class PartialCard < BaseCard
+      class_attribute :partial
+    end
+  end
+end

data/lib/avo/dynamic_router.rb

@@ -10,6 +10,9 @@ module Avo
         .select do |resource|
           resource.is_a? Class
         end
+        # .select do |resource|
+        #   resource.model_class.present?
+        # end
         .map do |resource|
           router.resources resource.new.model_key
         end

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/date_field.rb

@@ -19,7 +19,7 @@ module Avo
         return if value.blank?
 
         if @format.is_a?(Symbol)
-          value.to_formatted_s(@format)
+          value.to_s(@format)
         else
           value.strftime(@format)
         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/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/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

@@ -9,7 +9,8 @@ module Avo
           :global_search,
           :enhanced_search_results,
           :searchable_associations,
-          :resource_ordering
+          :resource_ordering,
+          :dashboards
         ]
       end
     end

data/lib/avo/version.rb

@@ -1,3 +1,3 @@
 module Avo
-  VERSION = "1.25.2"
+  VERSION = "2.0.0"
 end

data/lib/avo.rb

@@ -3,9 +3,32 @@ require_relative "avo/version"
 require_relative "avo/engine" if defined?(Rails)
 
 loader = Zeitwerk::Loader.for_gem
-loader.ignore("#{__dir__}/generators")
 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