easol-canvas 1.4.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cc9522b87ab434f7121dfd557aa987b820c9934486da6c96e8c7706ac4f92b4
-  data.tar.gz: e922ef25a0d8a916a82a7b9c4d8b4faf342088f6da65077518d72b68bf64eeab
+  metadata.gz: b20a9e978f946b59d3d3c9e2ee0b6763948c59278cc839bff63931879e3f18bb
+  data.tar.gz: 4dc2f01cbc06e1d60c99fd72211442bddfae47011cae0f237bec5eea12f2dddc
 SHA512:
-  metadata.gz: c33da855f7ad39a4dad8172fc0942c9c60d4af81acf6c677bddb9c55dcacd9759392fa9c24e65910d76228a760bad31c244b865e8f83e52623ffdf26282f99b6
-  data.tar.gz: e4d2f3ebae85a1ed14716a1f5514bd3211ae130b973475bbcaf3b52c946cb25db90cdcfbd75143db9984600e3604071d153eb1766e79388e172a2307e09abcfb
+  metadata.gz: 4ce1b8bab498d701f7ba028879060c7113ae231e59c9eeb2f1efb5d8ec6930043aeb1e6b061a5b121fa7f89ae470520482f8d2521aac7de606c3f2ef45be093e
+  data.tar.gz: cb1d28f8904587f6061ff31914f167cc055bc6bd95eb96f8acd8ff40550e5e2673f4d2386a12cf554f4976d8a5f425453a8e3e9c9ab24260ba05cbdbf93e6c5e

data/lib/canvas/checks/valid_block_schemas_check.rb

@@ -22,8 +22,9 @@ module Canvas
     def run
       custom_types = Canvas::FetchCustomTypes.call
       block_files.each do |filename|
-        file = File.read(filename)
-        front_matter = extract_front_matter(file)
+        front_matter = extract_front_matter(filename)
+        next unless front_matter
+
         validate_format(filename, front_matter) &&
           validate_schema(filename, front_matter, custom_types)
       end
@@ -57,10 +58,18 @@ module Canvas
       end
     end
 
-    def extract_front_matter(file)
+    def extract_front_matter(filename)
+      file = File.read(filename)
+
       extractor = Canvas::FrontMatterExtractor.new(file)
       front_matter = extractor.front_matter
       front_matter.nil? ? {} : YAML.safe_load(front_matter)
+    rescue Psych::SyntaxError
+      @offenses << Offense.new(
+        message: "Invalid Block Schema: #{filename} - \nFront matter's YAML is not in a valid format"
+      )
+
+      nil
     end
   end
 end

data/lib/canvas/checks/valid_footer_schema_check.rb

@@ -51,8 +51,7 @@ module Canvas
         front_matter["attributes"].values.all? { |attr| attr.is_a?(Hash) }
     end
 
-    def validate_schema(front_matter)
-      schema = extract_schema(front_matter)
+    def validate_schema(schema)
       validator = Validator::FooterSchema.new(
         schema: schema,
         custom_types: Canvas::FetchCustomTypes.call
@@ -71,11 +70,5 @@ module Canvas
       front_matter = extractor.front_matter
       front_matter.nil? ? {} : YAML.safe_load(front_matter)
     end
-
-    def extract_schema(front_matter)
-      front_matter.merge(
-        "attributes" => Canvas::ExpandAttributes.call(front_matter["attributes"])
-      )
-    end
   end
 end

data/lib/canvas/checks/valid_menu_schema_check.rb

@@ -51,8 +51,7 @@ module Canvas
         front_matter["attributes"].values.all? { |attr| attr.is_a?(Hash) }
     end
 
-    def validate_schema(front_matter)
-      schema = extract_schema(front_matter)
+    def validate_schema(schema)
       validator = Validator::MenuSchema.new(
         schema: schema,
         custom_types: Canvas::FetchCustomTypes.call
@@ -71,11 +70,5 @@ module Canvas
       front_matter = extractor.front_matter
       front_matter.nil? ? {} : YAML.safe_load(front_matter)
     end
-
-    def extract_schema(front_matter)
-      front_matter.merge(
-        "attributes" => Canvas::ExpandAttributes.call(front_matter["attributes"])
-      )
-    end
   end
 end

data/lib/canvas/validators/block_schema.rb

@@ -9,17 +9,25 @@ module Canvas
     # This class is used to validate a schema for a block.
     # Example of a valid block schema:
     # {
-    #   "attributes" => [
-    #     {
-    #       "name" => "my_title",
+    #   "attributes" => {
+    #     "my_title" => {
     #       "type" => "string"
     #     },
-    #     {
-    #       "name" => "my_color",
+    #     "my_color" => {
     #       "type" => "color",
     #       "label" => "My color",
     #       "hint" => "Select your favourite color"
     #     }
+    #   },
+    #   "layout" => [
+    #     {
+    #       "type" => "tab",
+    #       "label" => "Content",
+    #       "elements" => [
+    #         "my_title",
+    #         "my_color"
+    #       ]
+    #     }
     #   ]
     # }
     class BlockSchema
@@ -51,7 +59,7 @@ module Canvas
 
       def ensure_valid_format
         return true if schema.is_a?(Hash) &&
-                       (schema["attributes"].nil? || attributes_array_of_hashes?(schema))
+                       (schema["attributes"].nil? || attributes_hash_of_hashes?(schema))
 
         @errors << "Schema is not in a valid format"
         false
@@ -78,7 +86,8 @@ module Canvas
       def ensure_attributes_are_valid
         return true unless schema["attributes"]
 
-        schema["attributes"].each do |attribute_schema|
+        attributes = Canvas::ExpandAttributes.call(schema["attributes"])
+        attributes.each do |attribute_schema|
           attr_validator = Validator::SchemaAttribute.new(
             attribute: attribute_schema,
             custom_types: @custom_types
@@ -90,22 +99,17 @@ module Canvas
         end
       end
 
-      def attributes_array_of_hashes?(schema)
-        schema["attributes"].is_a?(Array) &&
-          schema["attributes"].all? { |attr| attr.is_a?(Hash) }
+      def attributes_hash_of_hashes?(schema)
+        schema["attributes"].is_a?(Hash) &&
+          schema["attributes"].values.all? { |attr| attr.is_a?(Hash) }
       end
 
+      # To support older schemas that do not nest the attributes
+      # under the `attributes` key.
       def normalize_schema(schema)
-        if schema.key?("attributes")
-          {
-            **schema,
-            "attributes" => Canvas::ExpandAttributes.call(schema["attributes"])
-          }
-        else
-          {
-            "attributes" => Canvas::ExpandAttributes.call(schema)
-          }
-        end
+        return schema if schema.key?("attributes")
+
+        { "attributes" => schema }
       end
     end
   end

data/lib/canvas/validators/footer_schema.rb

@@ -11,19 +11,27 @@ module Canvas
     #
     # Example:
     # {
-    #   "max_item_levels": 2,
-    #   "supports_open_new_tab": "true",
-    #   "attributes": {
-    #      "fixed": {
-    #         "group": "design",
-    #         "label": "Fixed when scrolling",
-    #         "hint": "The menu will stay fixed to the top when scrolling down the page.",
-    #         "type": "boolean",
-    #         "default: "false"
+    #   "max_item_levels" => 2,
+    #   "supports_open_new_tab" => "true",
+    #   "attributes" => {
+    #      "text_color" => {
+    #        "type" => "color"
+    #      },
+    #      "background_color" => {
+    #        "type" => "color"
     #      }
-    #   }
+    #   },
+    #   "layout" => [
+    #     {
+    #       "type" => "tab",
+    #       "label" => "Content",
+    #       "elements" => [
+    #         "text_color",
+    #         "background_color"
+    #       ]
+    #     }
+    #   ]
     # }
-    #
     class FooterSchema < MenuSchema; end
   end
 end

data/lib/canvas/validators/layout_schema.rb

@@ -9,23 +9,38 @@ module Canvas
     # This class is used to validate a layout definition, part of block schema.
     # Example of a valid layout definition:
     # {
+    #   "attributes" => {
+    #     "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 +56,8 @@ module Canvas
         if ensure_valid_format
           ensure_no_unrecognized_keys
           ensure_no_duplicate_keys
+          ensure_accordion_toggles_are_valid
+          ensure_unique_tabs
         end
 
         @errors.empty?
@@ -48,8 +65,25 @@ module Canvas
 
       private
 
+      attr_reader :schema
+
+      def ensure_unique_tabs
+        tabs = fetch_elements_of_type("tab")
+        duplicates =
+          tabs
+          .map { |item| [item[0]["label"], item[1]] }
+          .group_by { |(key, _)| key }
+          .filter { |key, usage| usage.size > 1 }
+
+        unless duplicates.empty?
+          duplicates.each do |tab, usage|
+            @errors << "Duplicated tab label `#{tab}` found. Location: #{usage.map { |(_, location)| location }.join(", ")}"
+          end
+        end
+      end
+
       def ensure_no_duplicate_keys
-        attributes = gather_attributes_from_layout_schema
+        attributes = fetch_all_attribute_names
         duplicates =
           attributes
           .group_by { |(key)| key }
@@ -63,37 +97,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 = expanded_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,19 +156,40 @@ 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 = expanded_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"] || []
+        schema["layout"] || []
       end
 
       def schema_definition
         File.read(
-          File.join(File.dirname(__FILE__), "../../../", "schema_definitions", "block_layout.json")
+          File.join(File.dirname(__FILE__), "../../../", "schema_definitions", "layout.json")
         )
       end
 
       def normalize_attribute(name)
         name.strip.downcase
       end
+
+      def expanded_attributes
+        return [] if schema["attributes"].nil?
+
+        @_expanded_attributes ||= Canvas::ExpandAttributes.call(schema["attributes"])
+      end
     end
   end
 end

data/lib/canvas/validators/menu_schema.rb

@@ -7,21 +7,33 @@ module Canvas
     #
     # Example:
     # {
-    #   "max_item_levels": 2,
-    #   "supports_open_new_tab": "true",
-    #   "attributes": {
-    #      "fixed": {
-    #         "group": "design",
-    #         "label": "Fixed when scrolling",
-    #         "hint": "The menu will stay fixed to the top when scrolling down the page.",
-    #         "type": "boolean",
-    #         "default: "false"
+    #   "max_item_levels" => 2,
+    #   "supports_open_new_tab" => "true",
+    #   "attributes" => {
+    #      "fixed" => {
+    #         "group" => "design",
+    #         "label" => "Fixed when scrolling",
+    #         "hint" => "The menu will stay fixed to the top when scrolling down the page.",
+    #         "type" => "boolean",
+    #         "default" => "false"
+    #      },
+    #      "background_color" => {
+    #        "type" => "color"
     #      }
-    #   }
+    #   },
+    #   "layout" => [
+    #     {
+    #       "type" => "tab",
+    #       "label" => "Content",
+    #       "elements" => [
+    #         "fixed",
+    #         "background_color"
+    #       ]
+    #     }
+    #   ]
     # }
-    #
     class MenuSchema
-      PERMITTED_KEYS = %w[max_item_levels supports_open_new_tab attributes].freeze
+      PERMITTED_KEYS = %w[max_item_levels supports_open_new_tab attributes layout].freeze
       ADDITIONAL_RESERVED_NAMES = %w[items type].freeze
 
       attr_reader :schema, :errors
@@ -38,6 +50,7 @@ module Canvas
         if ensure_valid_format
           ensure_no_unrecognized_keys
           ensure_max_item_levels_is_valid
+          ensure_layout_is_valid
           ensure_attributes_are_valid
         end
 
@@ -48,7 +61,7 @@ module Canvas
 
       def ensure_valid_format
         return true if schema.is_a?(Hash) &&
-                       (schema["attributes"].nil? || attributes_array_of_hashes?(schema))
+                       (schema["attributes"].nil? || attributes_hash_of_hashes?(schema))
 
         @errors << "Schema is not in a valid format"
         false
@@ -70,10 +83,21 @@ module Canvas
         false
       end
 
+      def ensure_layout_is_valid
+        return true unless schema["layout"]
+
+        layout_validator = LayoutSchema.new(schema: @schema)
+        return true if layout_validator.validate
+
+        @errors += layout_validator.errors
+        false
+      end
+
       def ensure_attributes_are_valid
         return true unless schema["attributes"]
 
-        schema["attributes"].each do |attribute_schema|
+        attributes = Canvas::ExpandAttributes.call(schema["attributes"])
+        attributes.each do |attribute_schema|
           attr_validator = Validator::SchemaAttribute.new(
             attribute: attribute_schema,
             custom_types: @custom_types,
@@ -86,9 +110,9 @@ module Canvas
         end
       end
 
-      def attributes_array_of_hashes?(schema)
-        schema["attributes"].is_a?(Array) &&
-          schema["attributes"].all? { |attr| attr.is_a?(Hash) }
+      def attributes_hash_of_hashes?(schema)
+        schema["attributes"].is_a?(Hash) &&
+          schema["attributes"].values.all? { |attr| attr.is_a?(Hash) }
       end
     end
   end

data/lib/canvas/version.rb

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

data/schema_definitions/{block_layout.json → 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easol-canvas
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Kyle Byrne
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-15 00:00:00.000000000 Z
+date: 2022-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -150,7 +150,7 @@ files:
 - lib/canvas/validators/schema_attributes/variant.rb
 - lib/canvas/version.rb
 - lib/easol/canvas.rb
-- schema_definitions/block_layout.json
+- schema_definitions/layout.json
 homepage: https://rubygems.org/gems/easol-canvas
 licenses:
 - MIT
@@ -170,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: CLI to help with building themes for Easol