easol-canvas 4.20.0 → 4.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa515bf37be7d80d67de3a67e92d6097e17d7298fc436a916acf0ca04687d78c
-  data.tar.gz: bbc64745d8df45188a081795995e0c92fc86b99f53beef20a69b72741657dd91
+  metadata.gz: c37703170f2a9f0870de51fa994e8929d1ed3a53ebe7f510c27ab943bddf9b6c
+  data.tar.gz: 1ccfe78c1b4aaaf9cb4bcbbd1d0afc062b63e94d93b41e162174aedff5fe9832
 SHA512:
-  metadata.gz: c91c9b333de32d036428dd9bd0c88840e57ea37c3509bb266440ffa6df89fd50d7161edf155ea40f4e22898a0ff1e0a55e0c9900f03fc67a33e0eebf3dbaed19
-  data.tar.gz: 2a8d559a57048b770104a5a3faf5536539c081571f37f44717b2850bd4f9ab7e2975f897f87da1b34014e42d5de7ed11712a9ba90b062a8cb6b3cd6676dafd98
+  metadata.gz: 9f2ca1fc7300356060311c3e1622b05df28e9d9e48985a8d50a40319c83d15a882a4ac7174c9f39bdc501f47e2988e8a9e9980187dbf513d03b6c8193f927f62
+  data.tar.gz: 883efd325fda12742d09a6ae3b30c102c51406fec1caf10f112d1ee8ce6ea9f145de80e9c1a4d6dd2f8562c7b5909aee99895a72207108c610d735a89a318db6

data/lib/canvas/validators/custom_type.rb

@@ -25,6 +25,7 @@ module Canvas
     #
     class CustomType
       REQUIRED_KEYS = %w[key name attributes].freeze
+      OPTIONAL_KEYS = %w[layout].freeze
 
       attr_reader :schema, :errors, :custom_types
 
@@ -43,7 +44,8 @@ module Canvas
           ensure_key_value_is_not_reserved &&
           ensure_no_duplicate_attributes &&
           ensure_attributes_are_valid &&
-          ensure_first_attribute_not_array
+          ensure_first_attribute_not_array &&
+          ensure_layout_is_valid
 
         errors.empty?
       end
@@ -66,7 +68,7 @@ module Canvas
       end
 
       def ensure_no_unrecognized_keys
-        unrecognized_keys = schema.keys - REQUIRED_KEYS
+        unrecognized_keys = schema.keys - REQUIRED_KEYS - OPTIONAL_KEYS
         return true if unrecognized_keys.empty?
 
         @errors << "Unrecognized keys: #{unrecognized_keys.join(', ')}"
@@ -145,6 +147,16 @@ module Canvas
         @errors << "The first attribute cannot be an array"
         false
       end
+
+      def ensure_layout_is_valid
+        return true unless schema["layout"]
+
+        layout_validator = CustomTypeLayoutSchema.new(schema:)
+        return true if layout_validator.validate
+
+        @errors += layout_validator.errors
+        false
+      end
     end
   end
 end

data/lib/canvas/validators/custom_type_layout_schema.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require "json"
+require "json-schema"
+
+module Canvas
+  module Validator
+    # :documented:
+    # This class is used to validate a layout definition for a custom type.
+    # Custom type layouts use a flat array of elements (unlike block layouts which use tabs).
+    #
+    # Example of a valid custom type layout definition:
+    # {
+    #   "attributes" => [
+    #     { "name" => "question", "type" => "string" },
+    #     { "name" => "answer", "type" => "text" },
+    #     { "name" => "show_icon", "type" => "boolean" }
+    #   ],
+    #   "layout" => [
+    #     "question",
+    #     {
+    #       "type" => "accordion",
+    #       "label" => "Advanced",
+    #       "elements" => [
+    #         "answer",
+    #         { "type" => "attribute", "name" => "show_icon" }
+    #       ]
+    #     }
+    #   ]
+    # }
+    class CustomTypeLayoutSchema
+      attr_reader :errors
+
+      def initialize(schema:)
+        @schema = schema
+        @errors = []
+      end
+
+      def validate
+        @errors = []
+
+        if ensure_valid_format
+          ensure_no_unrecognized_keys
+          ensure_no_duplicate_keys
+          ensure_accordion_toggles_are_valid
+        end
+
+        @errors.empty?
+      end
+
+      private
+
+      attr_reader :schema
+
+      def ensure_no_duplicate_keys
+        attributes = fetch_all_attribute_names
+        duplicates =
+          attributes
+            .group_by { |(key)| key }
+            .filter { |_key, usage| usage.size > 1 }
+
+        return if duplicates.empty?
+
+        duplicates.each do |attribute, usage|
+          @errors << "Duplicated attribute key `#{attribute}` found. "\
+                     "Location: #{usage.map { |(_, location)| location }.join(', ')}"
+        end
+      end
+
+      def ensure_no_unrecognized_keys
+        attributes = fetch_all_attribute_names
+        defined_attributes = schema_attributes.map { |attr| normalize_attribute(attr["name"]) }
+
+        attributes.each do |attribute, location|
+          unless defined_attributes.include?(attribute)
+            @errors << "Unrecognized attribute `#{attribute}`. Location: #{location}"
+          end
+        end
+      end
+
+      # @return [Array<Array(String, String)>] an array of all the attribute names that
+      #         are mentioned in the layout schema, along with its path. The names are
+      #         normalized, i.e. downcased.
+      def fetch_all_attribute_names
+        attributes = fetch_elements_of_type("attribute")
+        attributes.map do |(node, path)|
+          [
+            normalize_attribute(node.is_a?(Hash) ? node["name"] : node),
+            path
+          ]
+        end
+      end
+
+      # @param type [String] the element type to fetch
+      # @return [Array<Array(<Hash, String>, String)] an array of elements that match
+      #   the given type. Each element is an array containing the node and its path.
+      def fetch_elements_of_type(type)
+        elements = []
+
+        fetch_element = lambda { |node, path|
+          if type == "attribute" && node.is_a?(String)
+            elements << [node, path]
+          elsif node.is_a?(Hash) && node["type"] == type
+            elements << [node, path]
+          end
+
+          if node.is_a?(Hash) && node.key?("elements")
+            node["elements"].each_with_index do |element, i|
+              current_path = "#{path}/elements/#{i}"
+              fetch_element.call(element, current_path)
+            end
+          end
+        }
+
+        # Flat layout: iterate directly over layout elements
+        layout_schema.each_with_index do |element, i|
+          current_path = "layout/#{i}"
+          fetch_element.call(element, current_path)
+        end
+
+        elements
+      end
+
+      def ensure_valid_format
+        result = JSON::Validator.fully_validate(
+          schema_definition,
+          { "layout" => layout_schema },
+          strict: true,
+          clear_cache: true
+        )
+
+        return true if result.empty?
+
+        @errors += result
+        false
+      end
+
+      def ensure_accordion_toggles_are_valid
+        accordion_toggles = fetch_elements_of_type("accordion_toggle")
+        accordion_toggles.each do |accordion_toggle, location|
+          toggle_attribute = schema_attributes.detect { |attr|
+            attr["name"] == accordion_toggle["toggle_attribute"]
+          }
+
+          if toggle_attribute.nil?
+            @errors << "The toggle_attribute in accordion_toggle is unrecognized. Location: #{location}"
+          elsif toggle_attribute["type"]&.downcase != "boolean"
+            @errors << "The toggle_attribute in accordion_toggle must be a boolean. Location: #{location}"
+          end
+        end
+      end
+
+      def layout_schema
+        schema["layout"] || []
+      end
+
+      def schema_definition
+        File.read(
+          File.join(File.dirname(__FILE__), "../../../", "schema_definitions", "custom_type_layout.json")
+        )
+      end
+
+      def normalize_attribute(name)
+        name.to_s.strip.downcase
+      end
+
+      def schema_attributes
+        schema["attributes"] || []
+      end
+    end
+  end
+end

data/lib/canvas/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Canvas
-  VERSION = "4.20.0"
+  VERSION = "4.21.0"
 end

data/schema_definitions/custom_type_layout.json

@@ -0,0 +1,79 @@
+{
+  "type": "object",
+  "properties": {
+    "layout": {
+      "type": "array",
+      "items": {
+        "oneOf": [
+          { "type": "string" },
+          { "$ref": "#/$defs/accordion" },
+          { "$ref": "#/$defs/accordion_toggle" },
+          { "$ref": "#/$defs/attribute" }
+        ]
+      }
+    }
+  },
+  "$defs": {
+    "accordion": {
+      "type": "object",
+      "required": ["label", "type"],
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "accordion"
+        },
+        "label": {
+          "type": "string"
+        },
+        "elements": {
+          "type": "array",
+          "items": {
+            "oneOf": [
+              { "type": "string" },
+              { "$ref": "#/$defs/accordion_toggle" },
+              { "$ref": "#/$defs/attribute" }
+            ]
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "accordion_toggle": {
+      "type": "object",
+      "required": ["type", "toggle_attribute", "elements"],
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "accordion_toggle"
+        },
+        "toggle_attribute": {
+          "type": "string"
+        },
+        "elements": {
+          "type": "array",
+          "items": {
+            "oneOf": [
+              { "type": "string" },
+              { "$ref": "#/$defs/attribute" }
+            ]
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "attribute": {
+      "type": "object",
+      "required": ["name", "type"],
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "attribute"
+        },
+        "name": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    }
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easol-canvas
 version: !ruby/object:Gem::Version
-  version: 4.20.0
+  version: 4.21.0
 platform: ruby
 authors:
 - Kyle Byrne
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-15 00:00:00.000000000 Z
+date: 2026-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -129,6 +129,7 @@ files:
 - lib/canvas/services/front_matter_extractor.rb
 - lib/canvas/validators/block_schema.rb
 - lib/canvas/validators/custom_type.rb
+- lib/canvas/validators/custom_type_layout_schema.rb
 - lib/canvas/validators/footer_schema.rb
 - lib/canvas/validators/html.rb
 - lib/canvas/validators/json.rb
@@ -157,6 +158,7 @@ files:
 - lib/canvas/validators/schema_attributes/variant.rb
 - lib/canvas/version.rb
 - lib/easol/canvas.rb
+- schema_definitions/custom_type_layout.json
 - schema_definitions/layout.json
 homepage: https://rubygems.org/gems/easol-canvas
 licenses: