glib-web 4.39.1 → 4.39.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acbdde8fcc5033a60d976bf56fc3222d3ab1e7e9a138c65c326e3e16912ed729
-  data.tar.gz: 0b4ab5237c244659ddd40351b3b480fcb76a04e103aa1660e8c63f246d72333b
+  metadata.gz: 93226f57a31d7506df878201485705c4bddf72c12e76701cf256dbcbea1b9f50
+  data.tar.gz: 535de1bcc5ffcee41c5296425d69e10bbaf86a9cd76920396e876ac7be3a2416
 SHA512:
-  metadata.gz: 5b68ef7f7342522130b45f15b5216d07ae9df74d2267b5590ae3a7ed049d97419b4e599ba6db66bc5ba2f21d41a58afe653a547216194b331a28b2996d376287
-  data.tar.gz: 6d6d29eb399863ca102ad6658f39f78f5b69bd7c6353b14be961270de7f5ecf07b6906899e3e8bc2630f1d744e09929efe4ac2a3910a78c4a2b7ec6feb7ec110
+  metadata.gz: 1939b128493528c5281b6d93af4b792d3301905b8ccdc771886e42d5be153f193f39f6dee34c14c6d59562b813aedf50e8dde913baff7ac81c5322c1e7f6ab9f
+  data.tar.gz: 6c8b6491839e5185076831ba5d21bf27901322de5ef8ee7f3e3df71c6751ce95371d91a72af070fe7339d23b246369c13181ba08d8c995c55cc71866ea494806

data/app/controllers/glib/api_docs_controller.rb

@@ -0,0 +1,145 @@
+module Glib
+  class ApiDocsController < ApplicationController
+    prepend_before_action do
+      params[:_skip_custom_render] = 'true' if params[:custom_render] != 'true'
+    end
+
+    if try(:glib_auth_inited?)
+      skip_before_action :glib_load_resource
+      skip_before_action :glib_authorize_resource
+    end
+
+    # Skip JSON injections from the host app
+    skip_after_action :json_inject_left_menu, raise: false
+    skip_after_action :json_inject_feature_usage_analytics, raise: false
+    skip_after_action :json_inject_flash_actions, raise: false
+
+    before_action :set_path_prefix
+    layout false
+
+    # Override injection methods to do nothing
+    def json_inject_left_menu; end
+    def json_inject_feature_usage_analytics; end
+    def json_inject_flash_actions; end
+
+    def set_path_prefix
+      @path_prefix = 'glib/api_docs'
+    end
+
+    # GET /glib/json_ui_api
+    def index
+      @categories = load_all_categories
+    end
+
+    # GET /glib/json_ui_api/:category
+    def show
+      @category = params[:category]
+      @doc = load_documentation(@category)
+
+      unless @doc
+        render plain: "Category '#{@category}' not found", status: :not_found
+        return
+      end
+
+      @components = @doc['components'] || {}
+    end
+
+    # GET /glib/json_ui_api/:category/:component
+    def component
+      @category = params[:category]
+      @component_key = params[:component]
+      @doc = load_documentation(@category)
+
+      unless @doc
+        render plain: "Category '#{@category}' not found", status: :not_found
+        return
+      end
+
+      @component = @doc['components'][@component_key]
+
+      unless @component
+        render plain: "Component '#{@component_key}' not found in category '#{@category}'", status: :not_found
+        return
+      end
+    end
+
+    private
+
+    def load_all_categories
+      # Try to find the doc/components directory
+      # First try the gem's path
+      doc_path = Glib::Web::Engine.root.join('doc', 'components')
+
+      # If not found, try relative to Rails root (for development in host app)
+      unless Dir.exist?(doc_path)
+        doc_path = Rails.root.join('..', 'glib-web', 'doc', 'components')
+      end
+
+      return [] unless Dir.exist?(doc_path)
+
+      categories = []
+      Dir.glob(doc_path.join('*.yml')).each do |file|
+        next if File.basename(file) == 'README.md'
+
+        basename = File.basename(file, '.yml')
+        doc = YAML.load_file(file)
+
+        categories << {
+          'key' => basename,
+          'name' => basename.titleize,
+          'file' => file,
+          'component_count' => doc['components']&.size || 0,
+          'source_file' => doc.dig('meta', 'source_file')
+        }
+      end
+
+      categories.sort_by { |c| c['name'] }
+    end
+
+    def load_documentation(category)
+      # Try to find the YAML file
+      # First try the gem's path
+      doc_path = Glib::Web::Engine.root.join('doc', 'components', "#{category}.yml")
+
+      # If not found, try relative to Rails root (for development in host app)
+      unless File.exist?(doc_path)
+        doc_path = Rails.root.join('..', 'glib-web', 'doc', 'components', "#{category}.yml")
+      end
+
+      return nil unless File.exist?(doc_path)
+
+      YAML.load_file(doc_path)
+    end
+
+    helper_method :json_ui_api_url
+    def json_ui_api_url(category: nil, component: nil)
+      if component && category
+        "/glib/json_ui_api/#{category}/#{component}"
+      elsif category
+        "/glib/json_ui_api/#{category}"
+      else
+        "/glib/json_ui_api"
+      end
+    end
+
+    helper_method :property_type_badge_class
+    def property_type_badge_class(type)
+      case type
+      when 'string', 'text'
+        'badge-primary'
+      when 'int', 'float'
+        'badge-success'
+      when 'bool'
+        'badge-info'
+      when 'action'
+        'badge-warning'
+      when 'views', 'panels_builder'
+        'badge-secondary'
+      when 'hash', 'array'
+        'badge-dark'
+      else
+        'badge-light'
+      end
+    end
+  end
+end

data/app/helpers/glib/json_ui/abstract_builder.rb

@@ -162,6 +162,22 @@ module Glib
           end
         end
 
+        def self.enum(propName, options = {})
+          define_method(propName) do |value|
+            str = to_string(value)
+
+            if !Rails.env.production?
+              allowed_options = options[:options] || []
+              if allowed_options.present? && !allowed_options.map(&:to_s).include?(str)
+                raise "Invalid value for #{propName}: '#{str}'. Allowed values: #{allowed_options.map(&:inspect).join(', ')}"
+              end
+            end
+
+            instance_variable_set("@#{propName}", str) if options[:cache]
+            json.set! propName, str
+          end
+        end
+
         # Support either string or dynamic_text hash
         def self.text(propName, options = {})
           define_method(propName) do |value|

data/app/helpers/glib/json_ui/action_builder/dialogs.rb

@@ -2,7 +2,11 @@ class Glib::JsonUi::ActionBuilder
   module Dialogs
     class Alert < Action
       string :title
+
+      # Alert message text to display.
+      # @note Does not support markdown formatting. For markdown support, use dialogs/show with a custom body instead.
       string :message
+
       action :onLoad
       action :onClose
       singleton_array :styleClass, :styleClasses

data/app/helpers/glib/json_ui/list_builders.rb

@@ -48,6 +48,8 @@ module Glib
           string :paramNameForNewSectionedRowIndex
 
           panels_builder :accessory, :header, :body, :footer
+
+          enum :textFormat, options: [:plain, :markdown]
         end
 
         class Featured < Standard

data/app/helpers/glib/json_ui/view_builder/fields.rb

@@ -18,9 +18,24 @@ class Glib::JsonUi::ViewBuilder
         { only_path: true }
       end
 
+      # Validates field input according to specified rules.
+      # @param validation [Hash] Hash of validation types and their options
+      # @example
+      #   validation presence: { message: 'Required' }
+      #   validation format: { with: /\A\d+\z/, message: 'Must be a number' }
+      #   validation length: { minimum: 3, maximum: 20, message: { too_short: 'Too short', too_long: 'Too long' } }
+      # @note Supported validation types: presence, required, absence, acceptance, numericality, format, inclusion, exclusion, length
+      # @see /home/hgani/workspace/glib-web-npm/components/validation.js Frontend validation implementation
       def validation(validation)
         return if validation.blank?
 
+        # Validate that all keys are supported validation types
+        supported_validations = %i[presence required absence acceptance numericality format inclusion exclusion length]
+        invalid_keys = validation.keys - supported_validations
+        if invalid_keys.any?
+          raise ArgumentError, "Unsupported validation type(s): #{invalid_keys.join(', ')}. Supported types: #{supported_validations.join(', ')}"
+        end
+
         if validation[:format].present?
           context.cast_to_js_regex(validation[:format])
         end