habarico 7.2.0.pre.beta.5

data/config/locales/nl.yml

@@ -0,0 +1,39 @@
+nl:
+  # Default labels for Habarico's standard actions. Host apps override any key in
+  # their own config/locales (per-resource via `actions.<resource_path>.<action>`).
+  actions:
+    common:
+      show: "Detail"
+      create: "Aanmaken"
+      edit: "Bewerken"
+      delete: "Verwijderen"
+      save: "Opslaan"
+
+  # Default confirmation dialog for the standard delete action (delete_action.rb).
+  confirmations:
+    common:
+      delete:
+        title: "Weet u zeker dat u dit record wilt verwijderen?"
+        message: "Deze actie veroorzaakt onherstelbaar gegevensverlies."
+
+  # Default label for the generic full-text search filter (search_filter_schema_generator.rb).
+  # Override per model via `activerecord.attributes.<model>.search`.
+  filters:
+    common:
+      search: "Zoeken"
+
+  # Human-readable boolean labels used by the search highlighter (search_highlighter.rb) when a
+  # matched search field is a boolean column.
+  search:
+    "yes": "Ja"
+    "no": "Nee"
+
+  # Validation error messages for the order_by and filter query params (controller.rb). The
+  # `order_by` notation itself is validated by eluvia-base, which ships its own translations
+  # under `eluvia.errors.ordering` (HAB-915).
+  habarico:
+    errors:
+      order_by:
+        unknown_field: "Onbekende veldnaam."
+      filter:
+        unknown_term: "Onbekende filterterm."

data/config/locales/pl.yml

@@ -0,0 +1,39 @@
+pl:
+  # Default labels for Habarico's standard actions. Host apps override any key in
+  # their own config/locales (per-resource via `actions.<resource_path>.<action>`).
+  actions:
+    common:
+      show: "Szczegóły"
+      create: "Utwórz"
+      edit: "Edytuj"
+      delete: "Usuń"
+      save: "Zapisz"
+
+  # Default confirmation dialog for the standard delete action (delete_action.rb).
+  confirmations:
+    common:
+      delete:
+        title: "Czy na pewno chcesz usunąć ten rekord?"
+        message: "Ta akcja spowoduje utratę danych, których nie będzie można odzyskać."
+
+  # Default label for the generic full-text search filter (search_filter_schema_generator.rb).
+  # Override per model via `activerecord.attributes.<model>.search`.
+  filters:
+    common:
+      search: "Szukaj"
+
+  # Human-readable boolean labels used by the search highlighter (search_highlighter.rb) when a
+  # matched search field is a boolean column.
+  search:
+    "yes": "Tak"
+    "no": "Nie"
+
+  # Validation error messages for the order_by and filter query params (controller.rb). The
+  # `order_by` notation itself is validated by eluvia-base, which ships its own translations
+  # under `eluvia.errors.ordering` (HAB-915).
+  habarico:
+    errors:
+      order_by:
+        unknown_field: "Nieznana nazwa pola."
+      filter:
+        unknown_term: "Nieznany termin filtra."

data/config/locales/pt.yml

@@ -0,0 +1,39 @@
+pt:
+  # Default labels for Habarico's standard actions. Host apps override any key in
+  # their own config/locales (per-resource via `actions.<resource_path>.<action>`).
+  actions:
+    common:
+      show: "Detalhe"
+      create: "Criar"
+      edit: "Editar"
+      delete: "Eliminar"
+      save: "Guardar"
+
+  # Default confirmation dialog for the standard delete action (delete_action.rb).
+  confirmations:
+    common:
+      delete:
+        title: "Tem a certeza de que pretende eliminar este registo?"
+        message: "Esta ação irá causar uma perda de dados que não pode ser desfeita."
+
+  # Default label for the generic full-text search filter (search_filter_schema_generator.rb).
+  # Override per model via `activerecord.attributes.<model>.search`.
+  filters:
+    common:
+      search: "Pesquisar"
+
+  # Human-readable boolean labels used by the search highlighter (search_highlighter.rb) when a
+  # matched search field is a boolean column.
+  search:
+    "yes": "Sim"
+    "no": "Não"
+
+  # Validation error messages for the order_by and filter query params (controller.rb). The
+  # `order_by` notation itself is validated by eluvia-base, which ships its own translations
+  # under `eluvia.errors.ordering` (HAB-915).
+  habarico:
+    errors:
+      order_by:
+        unknown_field: "Nome de campo desconhecido."
+      filter:
+        unknown_term: "Termo de filtro desconhecido."

data/config/locales/ro.yml

@@ -0,0 +1,39 @@
+ro:
+  # Default labels for Habarico's standard actions. Host apps override any key in
+  # their own config/locales (per-resource via `actions.<resource_path>.<action>`).
+  actions:
+    common:
+      show: "Detaliu"
+      create: "Creare"
+      edit: "Editare"
+      delete: "Ștergere"
+      save: "Salvare"
+
+  # Default confirmation dialog for the standard delete action (delete_action.rb).
+  confirmations:
+    common:
+      delete:
+        title: "Sigur doriți să ștergeți această înregistrare?"
+        message: "Această acțiune va provoca o pierdere de date care nu poate fi anulată."
+
+  # Default label for the generic full-text search filter (search_filter_schema_generator.rb).
+  # Override per model via `activerecord.attributes.<model>.search`.
+  filters:
+    common:
+      search: "Căutare"
+
+  # Human-readable boolean labels used by the search highlighter (search_highlighter.rb) when a
+  # matched search field is a boolean column.
+  search:
+    "yes": "Da"
+    "no": "Nu"
+
+  # Validation error messages for the order_by and filter query params (controller.rb). The
+  # `order_by` notation itself is validated by eluvia-base, which ships its own translations
+  # under `eluvia.errors.ordering` (HAB-915).
+  habarico:
+    errors:
+      order_by:
+        unknown_field: "Nume de câmp necunoscut."
+      filter:
+        unknown_term: "Termen de filtrare necunoscut."

data/config/locales/sk.yml

@@ -0,0 +1,39 @@
+sk:
+  # Default labels for Habarico's standard actions. Host apps override any key in
+  # their own config/locales (per-resource via `actions.<resource_path>.<action>`).
+  actions:
+    common:
+      show: "Detail"
+      create: "Vytvoriť"
+      edit: "Upraviť"
+      delete: "Zmazať"
+      save: "Uložiť"
+
+  # Default confirmation dialog for the standard delete action (delete_action.rb).
+  confirmations:
+    common:
+      delete:
+        title: "Naozaj chcete zmazať tento záznam?"
+        message: "Táto akcia spôsobí stratu dát, ktoré už nebude možné obnoviť."
+
+  # Default label for the generic full-text search filter (search_filter_schema_generator.rb).
+  # Override per model via `activerecord.attributes.<model>.search`.
+  filters:
+    common:
+      search: "Hľadať"
+
+  # Human-readable boolean labels used by the search highlighter (search_highlighter.rb) when a
+  # matched search field is a boolean column.
+  search:
+    "yes": "Áno"
+    "no": "Nie"
+
+  # Validation error messages for the order_by and filter query params (controller.rb). The
+  # `order_by` notation itself is validated by eluvia-base, which ships its own translations
+  # under `eluvia.errors.ordering` (HAB-915).
+  habarico:
+    errors:
+      order_by:
+        unknown_field: "Neznámy názov poľa."
+      filter:
+        unknown_term: "Neznámy filtrovací výraz."

data/config/locales/uk.yml

@@ -0,0 +1,39 @@
+uk:
+  # Default labels for Habarico's standard actions. Host apps override any key in
+  # their own config/locales (per-resource via `actions.<resource_path>.<action>`).
+  actions:
+    common:
+      show: "Деталі"
+      create: "Створити"
+      edit: "Редагувати"
+      delete: "Видалити"
+      save: "Зберегти"
+
+  # Default confirmation dialog for the standard delete action (delete_action.rb).
+  confirmations:
+    common:
+      delete:
+        title: "Ви впевнені, що хочете видалити цей запис?"
+        message: "Ця дія призведе до втрати даних, яку неможливо скасувати."
+
+  # Default label for the generic full-text search filter (search_filter_schema_generator.rb).
+  # Override per model via `activerecord.attributes.<model>.search`.
+  filters:
+    common:
+      search: "Пошук"
+
+  # Human-readable boolean labels used by the search highlighter (search_highlighter.rb) when a
+  # matched search field is a boolean column.
+  search:
+    "yes": "Так"
+    "no": "Ні"
+
+  # Validation error messages for the order_by and filter query params (controller.rb). The
+  # `order_by` notation itself is validated by eluvia-base, which ships its own translations
+  # under `eluvia.errors.ordering` (HAB-915).
+  habarico:
+    errors:
+      order_by:
+        unknown_field: "Невідома назва поля."
+      filter:
+        unknown_term: "Невідомий термін фільтра."

data/config/routes.rb

@@ -0,0 +1 @@
+Habarico::RoutingService.instance.draw_routes

data/lib/generators/habarico/preferences/install_generator.rb

@@ -0,0 +1,27 @@
+require "rails/generators"
+require "rails/generators/migration"
+
+module Habarico
+  module Preferences
+    module Generators
+      # Copies the habarico_user_preferences migration into the host app:
+      #   rails g habarico:preferences:install
+      class InstallGenerator < Rails::Generators::Base
+        include Rails::Generators::Migration
+
+        source_root File.expand_path("templates", __dir__)
+
+        def self.next_migration_number(dirname)
+          ActiveRecord::Generators::Base.next_migration_number(dirname)
+        end
+
+        def create_migration_file
+          migration_template(
+            "create_habarico_user_preferences.rb.tt",
+            "db/migrate/create_habarico_user_preferences.rb"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/generators/habarico/preferences/templates/create_habarico_user_preferences.rb.tt

@@ -0,0 +1,15 @@
+class CreateHabaricoUserPreferences < ActiveRecord::Migration[7.0]
+  def change
+    create_table :habarico_user_preferences, id: :uuid do |t|
+      # Auth token subject (current_user.id). Stored as a scalar string - no FK, because the
+      # user may live in another service. Add a FK here yourself if your app has a local users table.
+      t.string :user_id, null: false
+      t.string :key, null: false
+      t.jsonb :value, null: false
+      t.datetime :updated_at, null: false
+    end
+
+    add_index :habarico_user_preferences, %i[user_id key], unique: true,
+              name: "idx_habarico_user_prefs_user_key"
+  end
+end

data/lib/habarico/active_model/references.rb

@@ -0,0 +1,68 @@
+module Habarico
+  module ActiveModel
+    module References
+      extend ::ActiveSupport::Concern
+      include Eluvia::ActiveModel::Attributes
+      include Eluvia::ActiveModel::ArrayAttribute
+
+      class_methods do
+
+        def _references
+          @references ||= {}
+        end
+
+        def references(type: nil)
+          result = _references.values
+          return result unless type
+          result.select { |r| r[:type] == type }
+        end
+
+        def reference_names(type: nil)
+          references(type: type).map { |r| r[:reference_name] }
+        end
+
+        def has_reference?(reference_name, type: nil)
+          find_reference(reference_name, type: type).present?
+        end
+
+        def find_reference(reference_name, type: nil)
+          result = _references.fetch(reference_name.to_sym, nil)
+          return result unless type
+          if result.nil? || result[:type] != type
+            nil
+          else
+            result
+          end
+        end
+
+        def has_one_reference(reference_name, class_name)
+          reference_name = reference_name.to_sym
+
+          string_attr reference_name # -> we need some underlying attribute to hold the data
+
+          _references[reference_name] = {
+            reference_name: reference_name,
+            type: :has_one,
+            class_name: class_name
+          }
+        end
+
+        def has_many_reference(reference_name, class_name)
+          reference_name = reference_name.to_sym
+
+          any_attr reference_name # -> we need some underlying attribute to hold the data
+          array_attr reference_name, type: :string # -> now we declare it as an array of strings
+          has_one_reference :"#{reference_name}__items", class_name # -> we need to hold metadata about the contained items
+
+          _references[reference_name] = {
+            reference_name: reference_name,
+            type: :has_many,
+            class_name: class_name
+          }
+        end
+
+      end
+
+    end
+  end
+end

data/lib/habarico/authenticatable.rb

@@ -0,0 +1,31 @@
+module Habarico
+  module Authenticatable
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :run_authentication
+    end
+
+    private
+
+    # Calls `Habarico::Config.authenticate_method` (`:authenticate_request` by default) on the
+    # controller. Deliberately does NOT define a fallback `authenticate_request` method itself:
+    # since this module is `include`d directly into `Habarico::Controller`/`Habarico::ApplicationController`,
+    # any method defined here would sit ahead of your ApplicationController in the ancestor chain
+    # (`include`d modules resolve before the superclass) and would silently shadow your override.
+    # Checking `respond_to?` first, instead of defining a raising default, avoids that.
+    #
+    # See https://docs.habarico.com/ruby/authentication for how to implement `authenticate_request`
+    # (or configure `config.authenticate_method`) in your own ApplicationController.
+    def run_authentication
+      method_name = Habarico::Config.authenticate_method
+      unless respond_to?(method_name, true)
+        raise NotImplementedError, "Habarico authentication is not configured: configure " \
+                                   "config.authenticate_method or implement ##{method_name} (and #current_user) in your " \
+                                   'ApplicationController.'
+      end
+      send(method_name)
+    end
+
+  end
+end

data/lib/habarico/config.rb

@@ -0,0 +1,71 @@
+module Habarico
+  module Config
+    mattr_accessor :resources
+    @@resources = []
+
+    mattr_accessor :routing_url_prefix
+    @@routing_url_prefix = ''
+
+    mattr_accessor :routing_scope
+    @@routing_scope = nil
+
+    mattr_accessor :currency
+    @@currency = 'CZK'
+
+    # Enables diacritics-insensitive (unaccent) fulltext search matching and highlighting by
+    # default. Mirrors the Python `SEARCH_UNACCENT_ENABLED` setting. Off by default; requires the
+    # PostgreSQL `unaccent` extension when the matcher relies on it.
+    mattr_accessor :search_unaccent_enabled
+    @@search_unaccent_enabled = false
+
+    # Parent class for Habarico's own engine controllers (schema/search endpoints). Defaults to a
+    # plain API controller with no authentication. Set this to your app's own `'ApplicationController'`
+    # to inherit its authentication before_actions instead of implementing `authenticate_method`
+    # again for the engine controllers.
+    mattr_accessor :base_controller_class
+    @@base_controller_class = 'ActionController::API'
+
+    # Page size of a list endpoint when the request sends no `limit`. `nil` (the default) leaves
+    # the decision to `set_pagination` in eluvia-base, which paginates by 20. A resource overrides
+    # this with `default_page_limit` in its DSL. Mirrors the Python `DEFAULT_PAGE_LIMIT` key of the
+    # `ADMIN_REST_FRAMEWORK` settings block (HAB-946).
+    mattr_accessor :default_page_limit
+    @@default_page_limit = nil
+
+    # Upper bound for the `limit` query parameter of a list endpoint; above it the request is
+    # refused with 422. `nil` (the default) leaves the decision to
+    # `Eluvia::Base::Config.max_page_limit` (1000), which is also the only place the bound can be
+    # removed altogether - a resource declares a number or nothing at all. Mirrors the Python
+    # `MAX_PAGE_LIMIT` key (HAB-946).
+    mattr_accessor :max_page_limit
+    @@max_page_limit = nil
+
+    # Class building the `meta.highlights` payload of a search-filtered list response, as a class
+    # or its name. `nil` by default - match highlighting is a paid feature, so the free gem ships
+    # no highlighter and simply omits the key. `habarico-enterprise` points this at its
+    # `SearchHighlighter` when the gem is loaded (HAB-812).
+    #
+    # Per-resource search (`search_fields`, `Search::SearchMatcher`) is free and unaffected: the
+    # list stays filtered, it just carries no highlighted snippets.
+    mattr_accessor :search_highlighter_class
+    @@search_highlighter_class = nil
+
+    # Name of the method Habarico calls (via `send`) as its authentication before_action, on both
+    # Habarico::Controller and Habarico::ApplicationController. Point this at an existing no-argument
+    # auth method on your ApplicationController (e.g. `:authenticate_user!`) to reuse it directly. If
+    # your auth method needs arguments (e.g. eluvia-auth's `authenticate(['public'])`), define a
+    # one-line wrapper method instead and point this at that.
+    mattr_accessor :authenticate_method
+    @@authenticate_method = :authenticate_request
+
+    # Resolves `search_highlighter_class` to a class, or nil when no highlighter is registered.
+    # Accepts a class or a string so the setting can be written in an initializer before the
+    # constant is loaded, matching how `base_controller_class` is handled.
+    def self.search_highlighter_class!
+      value = search_highlighter_class
+      return nil if value.nil?
+
+      value.is_a?(String) ? value.constantize : value
+    end
+  end
+end

data/lib/habarico/context.rb

@@ -0,0 +1,126 @@
+module Habarico
+  class Context
+    include ::ActiveModel::Model
+
+    # Definition of the resource on which the action is performed
+    attr_accessor :definition
+
+    # Under which user is the action performed
+    attr_accessor :current_user
+
+    # On which record primary key is the action performed
+    attr_accessor :record_pk
+
+    # On which record is the action performed
+    attr_writer :record
+
+    # Lazy load the record
+    def record
+      @record ||= if self.record_pk
+                    self.definition.model.find_by(self.definition.model.primary_key => self.record_pk)
+                  end
+    end
+
+    # In what target is the action performed (e.g. ID of the parent record)
+    attr_accessor :target
+
+    # From which source the action/schema is requested (e.g. `{ "prototype/employees" => 7 }`).
+    # Used by context-aware schemas to resolve the originating resource/record.
+    attr_accessor :source
+
+    # *************************************************************************
+    # Authorization
+    # *************************************************************************
+
+    STANDARD_PERMISSIONS = %i[read create update delete].freeze
+
+    # Chooses the appropriate permission check depending on whether a record is
+    # available in context.
+    #
+    # When a record_pk is present (e.g. the detail schema endpoint) the full
+    # can_with_record? check is used so that callable permissions are evaluated
+    # against the actual record. When no record is present (e.g. the global or
+    # list schema endpoint) can_wo_record? is used instead.
+    def can?(permission)
+      record_pk.present? ? can_with_record?(permission) : can_wo_record?(permission)
+    end
+
+    def policy
+      @policy ||= if self.current_user && self.record
+                    Pundit.policy(self.current_user, self.record)
+                  elsif self.current_user
+                    Pundit.policy(self.current_user, self.definition.model)
+                  end
+    end
+
+    # *************************************************************************
+    # Reset
+    # *************************************************************************
+
+    def reset
+      @policy = nil
+      @record = nil
+    end
+
+    private
+
+    def can_with_record?(permission)
+      permission = :read if permission.blank?
+      permission = permission.to_sym
+      if STANDARD_PERMISSIONS.include?(permission)
+        value = definition.send("can_#{permission}")
+        if value.respond_to?(:call)
+          !!value.call(self)
+        else
+          !!value
+        end
+      else
+        value = definition.send("can")
+        if value.respond_to?(:call)
+          !!value.call(permission, self)
+        else
+          false
+        end
+      end
+    end
+
+    # Permission check used when generating the global or list schema, where no
+    # specific record is in context.
+    #
+    # Static booleans are evaluated as-is — false means the action is never
+    # available on this resource and should not appear in the schema at all.
+    #
+    # Callables are invoked with a nil record. Consumers commonly express
+    # role-based restrictions as callables that depend only on current_user
+    # (e.g. `can_read { |c| c.current_user.has_role?(...) }`), and these must be
+    # honoured already at the global/list schema level so a restricted role does
+    # not receive the whole resource. Pundit-based callables also resolve
+    # without a record — Context#policy falls back to a class-level policy.
+    #
+    # Callables that genuinely read the concrete record simply see nil here; the
+    # action may then be omitted from the list schema and its real, per-record
+    # visibility is determined later by ObjectResourceSchemaGenerator (which
+    # calls can? with a real record). The controller enforces the actual
+    # permission on every mutating request regardless of what the schema says.
+    def can_wo_record?(permission)
+      permission = :read if permission.blank?
+      permission = permission.to_sym
+      if STANDARD_PERMISSIONS.include?(permission)
+        value = definition.send("can_#{permission}")
+        if value.respond_to?(:call)
+          !!value.call(self)
+        else
+          !!value
+        end
+      else
+        value = definition.send("can")
+        if value.respond_to?(:call)
+          !!value.call(permission, self)
+        else
+          false
+        end
+      end
+    end
+
+  end
+end

data/lib/habarico/contrib/preferences/base_preferences.rb

@@ -0,0 +1,40 @@
+module Habarico
+  module Contrib
+    module Preferences
+      # Exact base preference keys -> schema (mirrors Python base.py BASE_PREFERENCES).
+      BASE_PREFERENCES = {
+        "theme" => Schemas::THEME,
+        "locale" => Schemas::LOCALE,
+        "preferences.dashboard" => Schemas::DASHBOARD,
+        "preferences.layout.app.pageWidth" => Schemas::APP_PAGE_WIDTH,
+        "preferences.layout.app.contrastMode" => Schemas::CONTRAST_MODE,
+        "preferences.layout.app.stripedRows" => Schemas::STRIPED_ROWS,
+        "preferences.layout.app.density" => Schemas::APP_DENSITY,
+      }.freeze
+
+      # Pattern base keys -> schema (mirrors Python base.py PATTERN_PREFERENCES).
+      PATTERN_PREFERENCES = {
+        %r{[a-zA-Z][a-zA-Z0-9_./-]*\.savedQueries} => Schemas::SAVED_QUERIES,
+        %r{[a-zA-Z][a-zA-Z0-9_./-]*\.columns} => Schemas::COLUMNS,
+        %r{[a-zA-Z][a-zA-Z0-9_./-]*\.columnWidths} => Schemas::COLUMN_WIDTHS,
+      }.freeze
+
+      # Registers all base preferences. A default is applied to an exact key only when present
+      # in Preferences.defaults; otherwise the key is registered with no default. Pattern keys
+      # never carry a built-in default. Mirrors Python register_base_preferences.
+      def self.register_base_preferences
+        defaults = Preferences.defaults || {}
+        BASE_PREFERENCES.each do |key, schema|
+          if defaults.key?(key)
+            register_preference(key, schema: schema, default: defaults[key])
+          else
+            register_preference(key, schema: schema)
+          end
+        end
+        PATTERN_PREFERENCES.each do |pattern, schema|
+          register_preference_pattern(pattern, schema: schema)
+        end
+      end
+    end
+  end
+end

data/lib/habarico/contrib/preferences/config.rb

@@ -0,0 +1,31 @@
+module Habarico
+  module Contrib
+    module Preferences
+      # Per-key default values for base preferences, mirroring the Python
+      # `HABARICO_PREFERENCES["DEFAULTS"]` setting. A base key gets a default only when
+      # present here (see base_preferences.rb). Host apps set this in an initializer:
+      #   Habarico::Contrib::Preferences.defaults = { "theme" => "light" }
+      mattr_accessor :defaults, default: {}
+
+      # Largest serialized size (bytes) one preference value may have. Looked up by the exact
+      # key -- or the pattern, as a Regexp or its source string -- a preference was registered
+      # under, falling back to "default". `nil` (for one entry or for the whole setting) means
+      # no limit. Mirrors the Python `HABARICO_PREFERENCES["MAX_VALUE_BYTES"]` setting.
+      #
+      # The values below sit an order of magnitude above what the frontend actually writes:
+      # 100 datagrid columns are ~2 KB of `columns`/`columnWidths`, a 30-widget dashboard
+      # ~19 KB and 20 saved queries ~11 KB at their fullest.
+      mattr_accessor :max_value_bytes, default: {
+        "default" => 16 * 1024,
+        "preferences.dashboard" => 32 * 1024,
+        %r{[a-zA-Z][a-zA-Z0-9_./-]*\.savedQueries} => 32 * 1024,
+      }
+
+      # Largest number of preference rows one user may hold, or `nil` for no limit. Checked only
+      # when a NEW key is created, so a user already past the limit can still overwrite or shrink
+      # what they already have. The cap is needed because the pattern keys match an unbounded set
+      # of names, so the per-value limit alone does not bound the per-user total.
+      mattr_accessor :max_keys_per_user, default: 2000
+    end
+  end
+end