easol-canvas 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cc9522b87ab434f7121dfd557aa987b820c9934486da6c96e8c7706ac4f92b4
-  data.tar.gz: e922ef25a0d8a916a82a7b9c4d8b4faf342088f6da65077518d72b68bf64eeab
+  metadata.gz: c61a6785fbf34da110e1fe2b01a9f096ff4aaf8ea3cfbef780491b5e94e68998
+  data.tar.gz: 3acb2a3215a5fd874ad5e54cc719204cb0a4698218935f2546ce5cacf3f73777
 SHA512:
-  metadata.gz: c33da855f7ad39a4dad8172fc0942c9c60d4af81acf6c677bddb9c55dcacd9759392fa9c24e65910d76228a760bad31c244b865e8f83e52623ffdf26282f99b6
-  data.tar.gz: e4d2f3ebae85a1ed14716a1f5514bd3211ae130b973475bbcaf3b52c946cb25db90cdcfbd75143db9984600e3604071d153eb1766e79388e172a2307e09abcfb
+  metadata.gz: 660512a56bea758cae95483fdaefd41a75156a7c15723e661749a64feb6dbc847bab31e279fecd733af807c33491a138b9c4afc850bfd2db84e8b1ae5d3c848a
+  data.tar.gz: 75fdbbefd7cfccc1849bf26e1c42e9f24f274c1d1ed27774d6b1a5085a5caafd30b4b8a0499d418686320157b6335116e0a25bf973b24fedee60210bb64c8d0d

data/lib/canvas/validators/layout_schema.rb

@@ -9,23 +9,39 @@ module Canvas
     # This class is used to validate a layout definition, part of block schema.
     # Example of a valid layout definition:
     # {
+    #   "attributes" => [
+    #     {
+    #       "name" => "title",
+    #       "type" => "string"
+    #     }
+    #     ...
+    #   ],
     #   "layout" => [
-    #   {
-    #      "label" => "Design",
-    #      "type" => "tab",
-    #     "elements" => [
-    #       "heading",
-    #       {
-    #         "type" => "accordion",
-    #         "label" => "Logo",
+    #     {
+    #       "label" => "Design",
+    #       "type" => "tab",
     #         "elements" => [
-    #           "description",
-    #           { "type" => "attribute", "name" => "logo_alt" },
-    #           "title"
-    #         ]
-    #       }
-    #     ]
-    #   }]
+    #         "heading",
+    #         {
+    #           "type" => "accordion",
+    #           "label" => "Logo",
+    #           "elements" => [
+    #             "description",
+    #             { "type" => "attribute", "name" => "logo_alt" },
+    #             "title"
+    #           ]
+    #         },
+    #         {
+    #           "type" => "accordion_toggle",
+    #           "toggle_attribute" => "cta_enabled",
+    #           "elements" => [
+    #             "cta_text",
+    #             "cta_target"
+    #           ]
+    #         }
+    #       ]
+    #     }
+    #   ]
     # }
     class LayoutSchema
       attr_reader :errors
@@ -41,6 +57,7 @@ module Canvas
         if ensure_valid_format
           ensure_no_unrecognized_keys
           ensure_no_duplicate_keys
+          ensure_accordion_toggles_are_valid
         end
 
         @errors.empty?
@@ -48,8 +65,10 @@ module Canvas
 
       private
 
+      attr_reader :schema
+
       def ensure_no_duplicate_keys
-        attributes = gather_attributes_from_layout_schema
+        attributes = fetch_all_attribute_names
         duplicates =
           attributes
           .group_by { |(key)| key }
@@ -63,37 +82,54 @@ module Canvas
       end
 
       def ensure_no_unrecognized_keys
-        attributes = gather_attributes_from_layout_schema
-        defined_attributes = @schema["attributes"]&.map { |definition| normalize_attribute(definition["name"]) } || []
+        attributes = fetch_all_attribute_names
+        defined_attributes = schema["attributes"]&.map { |definition| normalize_attribute(definition["name"]) } || []
 
         attributes.each do |attribute, location|
           @errors << "Unrecognized attribute `#{attribute}`. Location: #{location}" unless defined_attributes.include?(attribute)
         end
       end
 
-      def gather_attributes_from_layout_schema
-        attribute_keys = []
+      # @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 = ->(node, path) {
+          if type == "attribute" && node.is_a?(String)
+            elements << [node, path]
+          elsif node["type"] == type
+            elements << [node, path]
+          end
 
-        fetch_attribute_type = ->(node, path) {
           if node.is_a?(Hash) && node.key?("elements")
             node["elements"].each_with_index do |element, i|
               current_path = "#{path}/elements/#{i}"
-              fetch_attribute_type.call(element, current_path)
+              fetch_element.call(element, current_path)
             end
-          else
-            attribute_keys << [
-              normalize_attribute(node.is_a?(Hash) ? node["name"] : node),
-              path
-            ]
           end
         }
 
         layout_schema.each_with_index do |tab, i|
           current_path = "layout/#{i}"
-          fetch_attribute_type.call(tab, current_path)
+          fetch_element.call(tab, current_path)
         end
 
-        attribute_keys
+        elements
       end
 
       def ensure_valid_format
@@ -105,8 +141,23 @@ module Canvas
         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"] != "boolean"
+            @errors << "The toggle_attribute in accordion_toggle must be a boolean. Location: #{location}"
+          end
+        end
+      end
+
       def layout_schema
-        @schema["layout"] || []
+        schema["layout"] || []
       end
 
       def schema_definition

data/lib/canvas/version.rb

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

data/schema_definitions/block_layout.json

@@ -24,20 +24,21 @@
           "items": {
             "oneOf": [
               { "type": "string" },
-              { "$ref": "#/$defs/component" },
+              { "$ref": "#/$defs/accordion" },
+              { "$ref": "#/$defs/accordion_toggle" },
               { "$ref": "#/$defs/attribute" }
             ]
           }
         }
       }
     },
-    "component": {
+    "accordion": {
       "type": "object",
       "required": ["label", "type"],
       "properties": {
         "type": {
           "type": "string",
-          "enum": ["accordion"]
+          "const": "accordion"
         },
         "label": {
           "type": "string"
@@ -50,6 +51,25 @@
         }
       }
     },
+    "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" }]
+          }
+        }
+      }
+    },
     "attribute": {
       "type": "object",
       "required": ["name", "type"],

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: easol-canvas
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Kyle Byrne
 - Ian Mooney
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-15 00:00:00.000000000 Z
+date: 2022-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -155,7 +155,7 @@ homepage: https://rubygems.org/gems/easol-canvas
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -170,8 +170,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: CLI to help with building themes for Easol
 test_files: []