jav 2.55.4

data/lib/jav/concerns/has_resource_stimulus_controllers.rb

@@ -0,0 +1,42 @@
+module Jav
+  module Concerns
+    module HasResourceStimulusControllers
+      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/jav/concerns/is_resource_item.rb

@@ -0,0 +1,44 @@
+# This concern helps us figure out what kind of items (field, tool, tab_group, or panel) have been passed to the resource or action.
+module Jav
+  module Concerns
+    module IsResourceItem
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :item_type, default: nil
+      end
+
+      def is_field?
+        self.class.item_type == :field
+      end
+
+      def is_panel?
+        self.class.item_type == :panel || self.class.item_type == :main_panel
+      end
+
+      def is_main_panel?
+        self.class.item_type == :main_panel
+      end
+
+      def is_tool?
+        self.class.item_type == :tool
+      end
+
+      def is_tab?
+        self.class.item_type == :tab
+      end
+
+      def is_tab_group?
+        self.class.item_type == :tab_group
+      end
+
+      def is_sidebar?
+        self.class.item_type == :sidebar
+      end
+
+      def is_row?
+        self.class.item_type == :row
+      end
+    end
+  end
+end

data/lib/jav/concerns/model_class_constantized.rb

@@ -0,0 +1,23 @@
+module Jav
+  module Concerns
+    module ModelClassConstantized
+      extend ActiveSupport::Concern
+
+      class_methods do
+        attr_reader :model_class
+
+        # Cast the model class to a constantized version and memoize it like that
+        def model_class=(value)
+          @model_class = case value
+                         when Class
+                           value
+                         when String, Symbol
+                           value.to_s.safe_constantize
+                         else
+                           raise ArgumentError, "Failed to find a proper model class for #{self}"
+                         end
+        end
+      end
+    end
+  end
+end

data/lib/jav/concerns/pagination.rb

@@ -0,0 +1,55 @@
+module Jav
+  module Concerns
+    module Pagination
+      extend ActiveSupport::Concern
+
+      included do
+        include Pagy::Backend
+
+        class_attribute :pagination, default: {}
+
+        unless defined? PAGINATION_METHOD
+          PAGINATION_METHOD = {
+            default: :pagy,
+            countless: :pagy_countless
+          }
+        end
+
+        unless defined? PAGINATION_DEFAULTS
+          PAGINATION_DEFAULTS = {
+            type: :default,
+            size: 7
+          }
+        end
+      end
+
+      def pagination_type
+        @pagination_type ||= ActiveSupport::StringInquirer.new(pagination_hash[:type].to_s)
+      end
+
+      def apply_pagination(index_params:, query:)
+        extra_pagy_params = {}
+
+        # Reset open filters when a user navigates to a new page
+        extra_pagy_params[:keep_filters_panel_open] = ("0" if params[:keep_filters_panel_open] == "1")
+
+        send PAGINATION_METHOD[pagination_type.to_sym],
+             query,
+             limit: index_params[:per_page],
+             anchor_string: "data-turbo-frame=\"#{params[:turbo_frame]}\"",
+             params: extra_pagy_params,
+             size: pagination_hash[:size]
+      end
+
+      private
+
+      def pagination_hash
+        @pagination ||= PAGINATION_DEFAULTS.merge Jav::ExecutionContext.new(
+          target: pagination,
+          resource: self,
+          view: @view
+        ).handle
+      end
+    end
+  end
+end

data/lib/jav/concerns/policy_helpers.rb

@@ -0,0 +1,31 @@
+module Jav
+  module Concerns
+    module PolicyHelpers
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def inherit_association_from_policy(association_name, policy_class)
+          %i[create edit update destroy show reorder act_on].each do |method_action|
+            define_policy_method(method_action, association_name, policy_class)
+          end
+
+          define_policy_method("view", association_name, policy_class, "index")
+        end
+
+        private
+
+        # Define a method for the given action and association name.
+        # Call the policy class with the given action passing the user and record.
+        # Example:
+        #  def create_team_members?
+        #   TeamMemberPolicy.new(user, record).create?
+        #  end
+        def define_policy_method(method_action, association_name, policy_class, policy_action = method_action)
+          define_method :"#{method_action}_#{association_name}?" do
+            policy_class.new(user, record).send :"#{policy_action}?"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jav/concerns/visible_in_dashboard.rb

@@ -0,0 +1,31 @@
+module Jav
+  module Concerns
+    module VisibleInDashboard
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :visible, default: true
+      end
+
+      def is_visible?
+        # Default is true
+        return true if visible == true
+
+        # Hide if false
+        return false if visible == false
+
+        return false unless visible.respond_to? :call
+
+        call_block
+      end
+
+      def is_hidden?
+        !is_visible?
+      end
+
+      def call_block
+        ::Jav::Hosts::DashboardVisibility.new(block: visible, dashboard: self).handle
+      end
+    end
+  end
+end

data/lib/jav/concerns/visible_items.rb

@@ -0,0 +1,45 @@
+# This concern helps us figure out what items are visible for each tab, panel or sidebar
+module Jav
+  module Concerns
+    module VisibleItems
+      extend ActiveSupport::Concern
+      def items
+        if items_holder.present?
+          items_holder.items
+        else
+          []
+        end
+      end
+
+      def visible_items
+        items.map do |item|
+          item.hydrate(view: view) if item.respond_to? :hydrate
+
+          visible(item) ? item : nil
+        end
+          .compact
+      end
+
+      def visible(item)
+        return item.visible? unless item.is_field?
+
+        return false if item.respond_to?(:authorized?) && item.resource.present? && !item.authorized?
+
+        item.visible? && item.visible_on?(view)
+      end
+
+      def visible?
+        any_item_visible = visible_items.any?
+        return any_item_visible unless respond_to?(:visible_on?)
+
+        visible_on?(view) && any_item_visible
+      end
+
+      def hydrate(view: nil)
+        @view = view
+
+        self
+      end
+    end
+  end
+end

data/lib/jav/configuration/branding.rb

@@ -0,0 +1,74 @@
+class Jav::Configuration::Branding
+  def initialize(colors: nil, chart_colors: nil, logo: nil, logomark: nil, placeholder: nil, favicon: nil)
+    @colors = colors || {}
+    @chart_colors = chart_colors
+    @logo = logo
+    @logomark = logomark
+    @placeholder = placeholder
+    @favicon = favicon
+
+    @default_colors = {
+      background: "#F6F6F7",
+      100 => "206 231 248",
+      400 => "57 158 229",
+      500 => "8 134 222",
+      600 => "6 107 178"
+    }
+    @default_chart_colors = ["#0B8AE2", "#34C683", "#2AB1EE", "#34C6A8"]
+    @default_logo = "/jav-assets/logo.png"
+    @default_logomark = "/jav-assets/logomark.png"
+    @default_placeholder = "/jav-assets/placeholder.svg"
+    @default_favicon = "/jav-assets/favicon.ico"
+  end
+
+  def css_colors
+    rgb_colors.map do |color, value|
+      if color == :background
+        "--color-application-#{color}: #{value};"
+      else
+        "--color-primary-#{color}: #{value};"
+      end
+    end.join("\n")
+  end
+
+  def logo
+    @logo || @default_logo
+  end
+
+  def logomark
+    @logomark || @default_logomark
+  end
+
+  def placeholder
+    @placeholder || @default_placeholder
+  end
+
+  def chart_colors
+    @chart_colors || @default_chart_colors
+  end
+
+  def favicon
+    @favicon || @default_favicon
+  end
+
+  private
+
+  def colors
+    @default_colors.merge(@colors) || @default_colors
+  end
+
+  def rgb_colors
+    colors.to_h do |key, value|
+      rgb_value = is_hex?(value) ? hex_to_rgb(value) : value
+      [key, rgb_value]
+    end
+  end
+
+  def is_hex?(value)
+    value.include? "#"
+  end
+
+  def hex_to_rgb(value)
+    value.to_s.match(/^#(..)(..)(..)$/).captures.map(&:hex).join(" ")
+  end
+end

data/lib/jav/configuration/resource_configuration.rb

@@ -0,0 +1,21 @@
+module Jav
+  class Configuration
+    module ResourceConfiguration
+      def resource_controls_placement=(val)
+        @resource_controls_placement_instance = val
+      end
+
+      def resource_controls_placement
+        @resource_controls_placement_instance || :right
+      end
+
+      def resource_controls_on_the_left?
+        resource_controls_placement == :left
+      end
+
+      def resource_controls_on_the_right?
+        resource_controls_placement == :right
+      end
+    end
+  end
+end

data/lib/jav/configuration.rb

@@ -0,0 +1,151 @@
+module Jav
+  class Configuration
+    include ResourceConfiguration
+
+    attr_writer :app_name, :branding, :root_path, :cache_store
+    attr_accessor :timezone, :per_page, :per_page_steps, :via_per_page, :locale, :currency, :default_view_type, :license, :license_key, :authorization_methods, :authenticate, :current_user, :id_links_to_resource, :full_width_container, :full_width_index_view, :cache_resources_on_index_view, :cache_resource_filters, :context, :display_breadcrumbs, :hide_layout_when_printing, :initial_breadcrumbs, :home_path, :search_debounce, :view_component_path, :display_license_request_timeout_error, :current_user_resource_name, :raise_error_on_missing_policy, :disabled_features, :buttons_on_form_footers, :main_menu, :profile_menu, :model_resource_mapping, :tabs_style, :resource_default_view, :authorization_client, :field_wrapper_layout, :sign_out_path_name, :resources, :prefix_path
+
+    def initialize
+      @root_path = "/jav"
+      @app_name = ::Rails.application.class.to_s.split("::").first.underscore.humanize(keep_id_suffix: true)
+      @timezone = "UTC"
+      @per_page = 24
+      @per_page_steps = [12, 24, 48, 72]
+      @via_per_page = 8
+      @locale = nil
+      @currency = "USD"
+      @default_view_type = :table
+      @license = "community"
+      @license_key = nil
+      @current_user = proc {}
+      @authenticate = proc {}
+      @authorization_methods = {
+        index: "index?",
+        show: "show?",
+        edit: "edit?",
+        new: "new?",
+        update: "update?",
+        create: "create?",
+        destroy: "destroy?"
+      }
+      @id_links_to_resource = false
+      @full_width_container = false
+      @full_width_index_view = false
+      @cache_resources_on_index_view = Jav::PACKED
+      @cache_resource_filters = false
+      @context = proc {}
+      @initial_breadcrumbs = proc {
+        add_breadcrumb I18n.t("jav.home").humanize, jav.root_path
+      }
+      @display_breadcrumbs = true
+      @hide_layout_when_printing = false
+      @home_path = nil
+      @search_debounce = 300
+      @view_component_path = "app/components"
+      @display_license_request_timeout_error = true
+      @current_user_resource_name = "user"
+      @raise_error_on_missing_policy = false
+      @disabled_features = []
+      @buttons_on_form_footers = false
+      @main_menu = nil
+      @profile_menu = nil
+      @model_resource_mapping = {}
+      @tabs_style = :tabs
+      @resource_default_view = :show
+      @authorization_client = :pundit
+      @field_wrapper_layout = :inline
+      @resources = nil
+      @prefix_path = nil
+      @cache_store = computed_cache_store
+    end
+
+    def current_user_method(&block)
+      @current_user = block if block.present?
+    end
+
+    def current_user_method=(method)
+      @current_user = method if method.present?
+    end
+
+    def authenticate_with(&block)
+      @authenticate = block if block.present?
+    end
+
+    def set_context(&block)
+      @context = block if block.present?
+    end
+
+    def set_initial_breadcrumbs(&block)
+      @initial_breadcrumbs = block if block.present?
+    end
+
+    def namespace
+      if Jav.configuration.root_path.present?
+        Jav.configuration.root_path.delete "/"
+      else
+        root_path.delete "/"
+      end
+    end
+
+    def root_path
+      return "" if @root_path == "/"
+
+      @root_path
+    end
+
+    def feature_enabled?(feature)
+      @disabled_features.map(&:to_sym).exclude?(feature.to_sym)
+    end
+
+    def branding
+      Jav::Configuration::Branding.new(**@branding || {})
+    end
+
+    def app_name
+      if @app_name.respond_to? :call
+        Jav::Hosts::BaseHost.new(block: @app_name).handle
+      else
+        @app_name
+      end
+    end
+
+    def cache_store
+      Jav::ExecutionContext.new(
+        target: @cache_store,
+        production_rejected_cache_stores: %w[ActiveSupport::Cache::MemoryStore ActiveSupport::Cache::NullStore]
+      ).handle
+    end
+
+    # When not in production or test we'll just use the MemoryStore which is good enough.
+    # When running in production we'll use Rails.cache if it's not ActiveSupport::Cache::MemoryStore or ActiveSupport::Cache::NullStore.
+    # If it's one of rejected cache stores, we'll use the FileStore.
+    # We decided against the MemoryStore in production because it will not be shared between multiple processes (when using Puma).
+    def computed_cache_store
+      lambda {
+        if Rails.env.production?
+          if Rails.cache.class.to_s.in?(production_rejected_cache_stores)
+            ActiveSupport::Cache.lookup_store(:file_store, Rails.root.join("tmp/cache"))
+          else
+            Rails.cache
+          end
+        elsif Rails.env.test?
+          Rails.cache
+        else
+          ActiveSupport::Cache.lookup_store(:memory_store)
+        end
+      }
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configuration=(config)
+    @configuration = config
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

data/lib/jav/dashboards/base_dashboard.rb

@@ -0,0 +1,87 @@
+module Jav
+  module Dashboards
+    class BaseDashboard
+      # TODO: convert the dashboards from classes to instances.
+      extend Jav::Concerns::VisibleInDashboard
+      extend ActiveSupport::DescendantsTracker
+
+      class_attribute :id
+      class_attribute :name
+      class_attribute :description
+      class_attribute :items_holder
+      class_attribute :grid_cols, default: 3
+      # TODO: remove this when you make the conversion.
+      class_attribute :visible, default: true
+      class_attribute :index, default: 0
+      class_attribute :authorize, default: -> { true }
+
+      class << self
+        def options_deprecation_message
+          Rails.logger.warn "DEPRECATION WARNING: Card options parameter is deprecated in favor of arguments parameter and will be removed from Jav version 3.0.0"
+        end
+
+        def card(klass, label: nil, description: nil, cols: nil, rows: nil, refresh_every: nil, options: {}, arguments: {}, visible: nil)
+          options_deprecation_message if options.present?
+          self.items_holder ||= []
+
+          self.items_holder << klass.new(
+            dashboard: self,
+            label: label,
+            description: description,
+            cols: cols,
+            rows: rows,
+            refresh_every: refresh_every,
+            options: options,
+            arguments: arguments,
+            index: index,
+            visible: visible
+          )
+          self.index += 1
+        end
+
+        def item_at_index(index)
+          items.find do |item|
+            next if item.index.blank?
+
+            item.index == index
+          end
+        end
+
+        def divider(**args)
+          self.items_holder ||= []
+
+          self.items_holder << BaseDivider.new(dashboard: self, **args)
+        end
+
+        def items
+          items = self.items_holder || []
+
+          items.filter(&:is_visible?)
+        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
+          Jav::App.view_context.jav.dashboard_path id
+        end
+      end
+    end
+  end
+end

data/lib/jav/dashboards/base_divider.rb

@@ -0,0 +1,31 @@
+module Jav
+  module Dashboards
+    class BaseDivider
+      include Jav::Concerns::VisibleInDashboard
+
+      attr_reader :dashboard, :label, :invisible, :index, :visible
+
+      class_attribute :id
+
+      def initialize(dashboard: nil, label: nil, invisible: false, index: nil, visible: true)
+        @dashboard = dashboard
+        @label = label
+        @invisible = invisible
+        @index = index
+        @visible = visible
+      end
+
+      def is_divider?
+        true
+      end
+
+      def is_card?
+        false
+      end
+
+      def call_block
+        ::Jav::Hosts::CardVisibility.new(block: visible, card: self, parent: dashboard).handle
+      end
+    end
+  end
+end